blob: b005a230a61aba0b42e7b4b0e7b9bb4fe4798b9f [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**
danielk197734cf35d2008-12-18 18:31:38 +000021** @(#) $Id: pager.c,v 1.517 2008/12/18 18:31:39 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;
941}
942
danielk197734cf35d2008-12-18 18:31:38 +0000943/*
944** Set the bit number pgno in the PagerSavepoint.pInSavepoint bitvecs of
945** all open savepoints.
946*/
danielk1977fd7f0452008-12-17 17:30:26 +0000947static int addToSavepointBitvecs(Pager *pPager, Pgno pgno){
948 int ii;
949 for(ii=0; ii<pPager->nSavepoint; ii++){
950 PagerSavepoint *p = &pPager->aSavepoint[ii];
951 if( pgno<=p->nOrig ){
952 /* TODO: malloc() failure handling */
953 sqlite3BitvecSet(p->pInSavepoint, pgno);
954 }
955 }
956 return SQLITE_OK;
957}
958
danielk1977e277be02007-03-23 18:12:06 +0000959/*
danielk1977ae72d982007-10-03 08:46:44 +0000960** Unlock the database file.
961**
962** If the pager is currently in error state, discard the contents of
963** the cache and reset the Pager structure internal state. If there is
964** an open journal-file, then the next time a shared-lock is obtained
965** on the pager file (by this or any other process), it will be
966** treated as a hot-journal and rolled back.
967*/
968static void pager_unlock(Pager *pPager){
969 if( !pPager->exclusiveMode ){
danielk1977b3175382008-10-17 18:51:52 +0000970 int rc = osUnlock(pPager->fd, NO_LOCK);
971 if( rc ) pPager->errCode = rc;
danielk1977d92db532008-11-17 04:56:24 +0000972 pPager->dbSizeValid = 0;
danielk1977b3175382008-10-17 18:51:52 +0000973 IOTRACE(("UNLOCK %p\n", pPager))
danielk1977ae72d982007-10-03 08:46:44 +0000974
danielk1977b3175382008-10-17 18:51:52 +0000975 /* Always close the journal file when dropping the database lock.
976 ** Otherwise, another connection with journal_mode=delete might
977 ** delete the file out from under us.
978 */
979 if( pPager->journalOpen ){
980 sqlite3OsClose(pPager->jfd);
981 pPager->journalOpen = 0;
982 sqlite3BitvecDestroy(pPager->pInJournal);
983 pPager->pInJournal = 0;
984 sqlite3BitvecDestroy(pPager->pAlwaysRollback);
985 pPager->pAlwaysRollback = 0;
danielk1977ae72d982007-10-03 08:46:44 +0000986 }
987
danielk1977b3175382008-10-17 18:51:52 +0000988 /* If Pager.errCode is set, the contents of the pager cache cannot be
989 ** trusted. Now that the pager file is unlocked, the contents of the
990 ** cache can be discarded and the error code safely cleared.
991 */
992 if( pPager->errCode ){
993 if( rc==SQLITE_OK ) pPager->errCode = SQLITE_OK;
994 pager_reset(pPager);
danielk1977fd7f0452008-12-17 17:30:26 +0000995 releaseAllSavepoint(pPager);
danielk1977b3175382008-10-17 18:51:52 +0000996 pPager->journalOff = 0;
997 pPager->journalStarted = 0;
danielk1977b3175382008-10-17 18:51:52 +0000998 pPager->origDbSize = 0;
danielk1977ae72d982007-10-03 08:46:44 +0000999 }
danielk1977b3175382008-10-17 18:51:52 +00001000
1001 pPager->state = PAGER_UNLOCK;
1002 pPager->changeCountDone = 0;
danielk1977ae72d982007-10-03 08:46:44 +00001003 }
1004}
1005
1006/*
1007** Execute a rollback if a transaction is active and unlock the
1008** database file. If the pager has already entered the error state,
1009** do not attempt the rollback.
1010*/
1011static void pagerUnlockAndRollback(Pager *p){
danielk1977ae72d982007-10-03 08:46:44 +00001012 if( p->errCode==SQLITE_OK && p->state>=PAGER_RESERVED ){
danielk19772d1d86f2008-06-20 14:59:51 +00001013 sqlite3BeginBenignMalloc();
danielk1977ae72d982007-10-03 08:46:44 +00001014 sqlite3PagerRollback(p);
danielk19772d1d86f2008-06-20 14:59:51 +00001015 sqlite3EndBenignMalloc();
danielk1977ae72d982007-10-03 08:46:44 +00001016 }
1017 pager_unlock(p);
danielk1977ae72d982007-10-03 08:46:44 +00001018}
1019
1020/*
drh80e35f42007-03-30 14:06:34 +00001021** This routine ends a transaction. A transaction is ended by either
1022** a COMMIT or a ROLLBACK.
1023**
drhed7c8552001-04-11 14:29:21 +00001024** When this routine is called, the pager has the journal file open and
drh80e35f42007-03-30 14:06:34 +00001025** a RESERVED or EXCLUSIVE lock on the database. This routine will release
1026** the database lock and acquires a SHARED lock in its place if that is
1027** the appropriate thing to do. Release locks usually is appropriate,
1028** unless we are in exclusive access mode or unless this is a
1029** COMMIT AND BEGIN or ROLLBACK AND BEGIN operation.
1030**
1031** The journal file is either deleted or truncated.
drh50457892003-09-06 01:10:47 +00001032**
1033** TODO: Consider keeping the journal file open for temporary databases.
1034** This might give a performance improvement on windows where opening
1035** a file is an expensive operation.
drhed7c8552001-04-11 14:29:21 +00001036*/
danielk1977df2566a2008-05-07 19:11:03 +00001037static int pager_end_transaction(Pager *pPager, int hasMaster){
danielk197741483462007-03-24 16:45:04 +00001038 int rc = SQLITE_OK;
danielk1977979f38e2007-03-27 16:19:51 +00001039 int rc2 = SQLITE_OK;
drha6abd042004-06-09 17:37:22 +00001040 if( pPager->state<PAGER_RESERVED ){
1041 return SQLITE_OK;
1042 }
danielk1977fd7f0452008-12-17 17:30:26 +00001043 releaseAllSavepoint(pPager);
drhda47d772002-12-02 04:25:19 +00001044 if( pPager->journalOpen ){
danielk1977b3175382008-10-17 18:51:52 +00001045 if( pPager->journalMode==PAGER_JOURNALMODE_MEMORY ){
1046 int isMemoryJournal = sqlite3IsMemJournal(pPager->jfd);
1047 sqlite3OsClose(pPager->jfd);
1048 pPager->journalOpen = 0;
1049 if( !isMemoryJournal ){
1050 rc = sqlite3OsDelete(pPager->pVfs, pPager->zJournal, 0);
1051 }
1052 }else if( pPager->journalMode==PAGER_JOURNALMODE_TRUNCATE
drh04335882008-09-26 21:08:08 +00001053 && (rc = sqlite3OsTruncate(pPager->jfd, 0))==SQLITE_OK ){
1054 pPager->journalOff = 0;
1055 pPager->journalStarted = 0;
1056 }else if( pPager->exclusiveMode
danielk197793f7af92008-05-09 16:57:50 +00001057 || pPager->journalMode==PAGER_JOURNALMODE_PERSIST
1058 ){
1059 rc = zeroJournalHdr(pPager, hasMaster);
1060 pager_error(pPager, rc);
danielk197741483462007-03-24 16:45:04 +00001061 pPager->journalOff = 0;
danielk1977334cdb62007-03-26 08:05:12 +00001062 pPager->journalStarted = 0;
danielk197741483462007-03-24 16:45:04 +00001063 }else{
drh04335882008-09-26 21:08:08 +00001064 assert( pPager->journalMode==PAGER_JOURNALMODE_DELETE || rc );
danielk1977b4b47412007-08-17 15:53:36 +00001065 sqlite3OsClose(pPager->jfd);
danielk197741483462007-03-24 16:45:04 +00001066 pPager->journalOpen = 0;
danielk19770f01fda2008-06-06 16:14:02 +00001067 if( rc==SQLITE_OK && !pPager->tempFile ){
danielk1977fee2d252007-08-18 10:59:19 +00001068 rc = sqlite3OsDelete(pPager->pVfs, pPager->zJournal, 0);
danielk19777152de82007-03-29 17:28:14 +00001069 }
danielk197741483462007-03-24 16:45:04 +00001070 }
drhf5e7bb52008-02-18 14:47:33 +00001071 sqlite3BitvecDestroy(pPager->pInJournal);
1072 pPager->pInJournal = 0;
danielk1977a1fa00d2008-08-27 15:16:33 +00001073 sqlite3BitvecDestroy(pPager->pAlwaysRollback);
1074 pPager->pAlwaysRollback = 0;
danielk19773c407372005-02-15 02:54:14 +00001075#ifdef SQLITE_CHECK_PAGES
danielk1977bc2ca9e2008-11-13 14:28:28 +00001076 sqlite3PcacheIterateDirty(pPager->pPCache, pager_set_pagehash);
danielk19773c407372005-02-15 02:54:14 +00001077#endif
danielk1977bc2ca9e2008-11-13 14:28:28 +00001078 sqlite3PcacheCleanAll(pPager->pPCache);
danielk1977ef317ab2004-06-23 10:43:10 +00001079 pPager->dirtyCache = 0;
danielk1977ef317ab2004-06-23 10:43:10 +00001080 pPager->nRec = 0;
drhda47d772002-12-02 04:25:19 +00001081 }else{
drhf5e7bb52008-02-18 14:47:33 +00001082 assert( pPager->pInJournal==0 );
drhd9b02572001-04-15 00:37:09 +00001083 }
danielk1977979f38e2007-03-27 16:19:51 +00001084
danielk197741483462007-03-24 16:45:04 +00001085 if( !pPager->exclusiveMode ){
danielk19777a2b1ee2007-08-21 14:27:01 +00001086 rc2 = osUnlock(pPager->fd, SHARED_LOCK);
danielk197741483462007-03-24 16:45:04 +00001087 pPager->state = PAGER_SHARED;
danielk1977334cdb62007-03-26 08:05:12 +00001088 }else if( pPager->state==PAGER_SYNCED ){
1089 pPager->state = PAGER_EXCLUSIVE;
danielk197741483462007-03-24 16:45:04 +00001090 }
danielk1977334cdb62007-03-26 08:05:12 +00001091 pPager->origDbSize = 0;
danielk197776572402004-06-25 02:38:54 +00001092 pPager->setMaster = 0;
danielk1977c4da5b92006-01-21 12:08:54 +00001093 pPager->needSync = 0;
danielk19778c0a7912008-08-20 14:49:23 +00001094 /* lruListSetFirstSynced(pPager); */
danielk1977b3175382008-10-17 18:51:52 +00001095 if( !MEMDB ){
danielk1977d92db532008-11-17 04:56:24 +00001096 pPager->dbSizeValid = 0;
danielk1977b3175382008-10-17 18:51:52 +00001097 }
drhd138c012008-05-13 00:58:18 +00001098 pPager->dbModified = 0;
danielk1977979f38e2007-03-27 16:19:51 +00001099
1100 return (rc==SQLITE_OK?rc2:rc);
drhed7c8552001-04-11 14:29:21 +00001101}
1102
drhed7c8552001-04-11 14:29:21 +00001103/*
drh968af522003-02-11 14:55:40 +00001104** Compute and return a checksum for the page of data.
drh34e79ce2004-02-08 06:05:46 +00001105**
1106** This is not a real checksum. It is really just the sum of the
drh726de592004-06-10 23:35:50 +00001107** random initial value and the page number. We experimented with
1108** a checksum of the entire data, but that was found to be too slow.
1109**
1110** Note that the page number is stored at the beginning of data and
1111** the checksum is stored at the end. This is important. If journal
1112** corruption occurs due to a power failure, the most likely scenario
1113** is that one end or the other of the record will be changed. It is
1114** much less likely that the two ends of the journal record will be
1115** correct and the middle be corrupt. Thus, this "checksum" scheme,
1116** though fast and simple, catches the mostly likely kind of corruption.
1117**
1118** FIX ME: Consider adding every 200th (or so) byte of the data to the
1119** checksum. That way if a single page spans 3 or more disk sectors and
1120** only the middle sector is corrupt, we will still have a reasonable
1121** chance of failing the checksum and thus detecting the problem.
drh968af522003-02-11 14:55:40 +00001122*/
drh74161702006-02-24 02:53:49 +00001123static u32 pager_cksum(Pager *pPager, const u8 *aData){
danielk1977ef317ab2004-06-23 10:43:10 +00001124 u32 cksum = pPager->cksumInit;
1125 int i = pPager->pageSize-200;
1126 while( i>0 ){
1127 cksum += aData[i];
1128 i -= 200;
1129 }
drh968af522003-02-11 14:55:40 +00001130 return cksum;
1131}
1132
1133/*
drhfa86c412002-02-02 15:01:15 +00001134** Read a single page from the journal file opened on file descriptor
1135** jfd. Playback this one page.
drh968af522003-02-11 14:55:40 +00001136**
drhc13148f2008-08-27 18:03:20 +00001137** The isMainJrnl flag is true if this is the main rollback journal and
1138** false for the statement journal. The main rollback journal uses
1139** checksums - the statement journal does not.
drhfa86c412002-02-02 15:01:15 +00001140*/
danielk197762079062007-08-15 17:08:46 +00001141static int pager_playback_one_page(
danielk1977fd7f0452008-12-17 17:30:26 +00001142 Pager *pPager, /* The pager being played back */
1143 int isMainJrnl, /* 1 -> main journal. 0 -> sub-journal. */
1144 i64 offset, /* Offset of record to playback */
1145 Bitvec *pDone /* Bitvec of pages already played back */
danielk197762079062007-08-15 17:08:46 +00001146){
drhfa86c412002-02-02 15:01:15 +00001147 int rc;
drhae2b40c2004-06-09 19:03:54 +00001148 PgHdr *pPg; /* An existing page in the cache */
1149 Pgno pgno; /* The page number of a page in journal */
1150 u32 cksum; /* Checksum used for sanity checking */
danielk19778186df82007-03-06 13:45:59 +00001151 u8 *aData = (u8 *)pPager->pTmpSpace; /* Temp storage for a page */
danielk1977fd7f0452008-12-17 17:30:26 +00001152 sqlite3_file *jfd = (isMainJrnl ? pPager->jfd : pPager->sjfd);
drhfa86c412002-02-02 15:01:15 +00001153
danielk1977fd7f0452008-12-17 17:30:26 +00001154 /* The temp storage must be allocated at this point */
danielk19778186df82007-03-06 13:45:59 +00001155 assert( aData );
drh96362842005-03-20 22:47:56 +00001156
danielk197762079062007-08-15 17:08:46 +00001157 rc = read32bits(jfd, offset, &pgno);
drh99ee3602003-02-16 19:13:36 +00001158 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +00001159 rc = sqlite3OsRead(jfd, aData, pPager->pageSize, offset+4);
drh99ee3602003-02-16 19:13:36 +00001160 if( rc!=SQLITE_OK ) return rc;
danielk197776572402004-06-25 02:38:54 +00001161 pPager->journalOff += pPager->pageSize + 4;
drhfa86c412002-02-02 15:01:15 +00001162
drh968af522003-02-11 14:55:40 +00001163 /* Sanity checking on the page. This is more important that I originally
1164 ** thought. If a power failure occurs while the journal is being written,
1165 ** it could cause invalid data to be written into the journal. We need to
1166 ** detect this invalid data (with high probability) and ignore it.
1167 */
danielk197775edc162004-06-26 01:48:18 +00001168 if( pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh968af522003-02-11 14:55:40 +00001169 return SQLITE_DONE;
1170 }
danielk1977fd7f0452008-12-17 17:30:26 +00001171 if( pgno>(Pgno)pPager->dbSize || sqlite3BitvecTest(pDone, pgno) ){
drh968af522003-02-11 14:55:40 +00001172 return SQLITE_OK;
1173 }
drhc13148f2008-08-27 18:03:20 +00001174 if( isMainJrnl ){
danielk197762079062007-08-15 17:08:46 +00001175 rc = read32bits(jfd, offset+pPager->pageSize+4, &cksum);
drh99ee3602003-02-16 19:13:36 +00001176 if( rc ) return rc;
danielk197776572402004-06-25 02:38:54 +00001177 pPager->journalOff += 4;
danielk1977fd7f0452008-12-17 17:30:26 +00001178 if( !pDone && pager_cksum(pPager, aData)!=cksum ){
drh968af522003-02-11 14:55:40 +00001179 return SQLITE_DONE;
1180 }
1181 }
danielk1977fd7f0452008-12-17 17:30:26 +00001182 if( pDone && (rc = sqlite3BitvecSet(pDone, pgno)) ){
1183 return rc;
1184 }
drhfa86c412002-02-02 15:01:15 +00001185
danielk1977aa5ccdf2004-06-14 05:10:42 +00001186 assert( pPager->state==PAGER_RESERVED || pPager->state>=PAGER_EXCLUSIVE );
danielk1977a3f3a5f2004-06-10 04:32:16 +00001187
1188 /* If the pager is in RESERVED state, then there must be a copy of this
1189 ** page in the pager cache. In this case just update the pager cache,
danielk19770de0bb32004-06-10 05:59:24 +00001190 ** not the database file. The page is left marked dirty in this case.
1191 **
danielk19772df71c72007-05-24 07:22:42 +00001192 ** An exception to the above rule: If the database is in no-sync mode
1193 ** and a page is moved during an incremental vacuum then the page may
danielk1977369f3a02007-05-24 09:41:20 +00001194 ** not be in the pager cache. Later: if a malloc() or IO error occurs
1195 ** during a Movepage() call, then the page may not be in the cache
1196 ** either. So the condition described in the above paragraph is not
1197 ** assert()able.
danielk19772df71c72007-05-24 07:22:42 +00001198 **
danielk1977a3f3a5f2004-06-10 04:32:16 +00001199 ** If in EXCLUSIVE state, then we update the pager cache if it exists
1200 ** and the main file. The page is then marked not dirty.
drh96362842005-03-20 22:47:56 +00001201 **
1202 ** Ticket #1171: The statement journal might contain page content that is
1203 ** different from the page content at the start of the transaction.
1204 ** This occurs when a page is changed prior to the start of a statement
1205 ** then changed again within the statement. When rolling back such a
1206 ** statement we must not write to the original database unless we know
drh5e385312007-06-16 04:42:12 +00001207 ** for certain that original page contents are synced into the main rollback
1208 ** journal. Otherwise, a power loss might leave modified data in the
1209 ** database file without an entry in the rollback journal that can
1210 ** restore the database to its original form. Two conditions must be
1211 ** met before writing to the database files. (1) the database must be
1212 ** locked. (2) we know that the original page content is fully synced
1213 ** in the main journal either because the page is not in cache or else
1214 ** the page is marked as needSync==0.
drh4c02a232008-04-14 23:13:45 +00001215 **
1216 ** 2008-04-14: When attempting to vacuum a corrupt database file, it
1217 ** is possible to fail a statement on a database that does not yet exist.
1218 ** Do not attempt to write if database file has never been opened.
drhfa86c412002-02-02 15:01:15 +00001219 */
drhae2b40c2004-06-09 19:03:54 +00001220 pPg = pager_lookup(pPager, pgno);
drh477731b2007-06-16 03:06:27 +00001221 PAGERTRACE4("PLAYBACK %d page %d hash(%08x)\n",
1222 PAGERID(pPager), pgno, pager_datahash(pPager->pageSize, aData));
danielk19778c0a7912008-08-20 14:49:23 +00001223 if( (pPager->state>=PAGER_EXCLUSIVE)
1224 && (pPg==0 || 0==(pPg->flags&PGHDR_NEED_SYNC))
1225 && (pPager->fd->pMethods)
1226 ){
drh281b21d2008-08-22 12:57:08 +00001227 i64 ofst = (pgno-1)*(i64)pPager->pageSize;
1228 rc = sqlite3OsWrite(pPager->fd, aData, pPager->pageSize, ofst);
danielk1977a3f3a5f2004-06-10 04:32:16 +00001229 }
drhfa86c412002-02-02 15:01:15 +00001230 if( pPg ){
danielk197728129562005-01-11 10:25:06 +00001231 /* No page should ever be explicitly rolled back that is in use, except
1232 ** for page 1 which is held in use in order to keep the lock on the
1233 ** database active. However such a page may be rolled back as a result
1234 ** of an internal error resulting in an automatic call to
danielk19773b8a05f2007-03-19 17:44:26 +00001235 ** sqlite3PagerRollback().
drhacf4ac92003-12-17 23:57:34 +00001236 */
drhb6f41482004-05-14 01:58:11 +00001237 void *pData;
danielk19778c0a7912008-08-20 14:49:23 +00001238 pData = pPg->pData;
drhae2b40c2004-06-09 19:03:54 +00001239 memcpy(pData, aData, pPager->pageSize);
danielk19779038bb62007-04-09 11:20:54 +00001240 if( pPager->xReiniter ){
danielk1977eaa06f62008-09-18 17:34:44 +00001241 pPager->xReiniter(pPg);
drhde647132004-05-07 17:57:49 +00001242 }
drhc047b9f2008-11-21 03:23:43 +00001243 if( isMainJrnl ){
1244 sqlite3PcacheMakeClean(pPg);
1245 }
danielk19773c407372005-02-15 02:54:14 +00001246#ifdef SQLITE_CHECK_PAGES
drh96362842005-03-20 22:47:56 +00001247 pPg->pageHash = pager_pagehash(pPg);
danielk19773c407372005-02-15 02:54:14 +00001248#endif
drh86a88112007-04-16 15:02:19 +00001249 /* If this was page 1, then restore the value of Pager.dbFileVers.
1250 ** Do this before any decoding. */
danielk197741483462007-03-24 16:45:04 +00001251 if( pgno==1 ){
drh86a88112007-04-16 15:02:19 +00001252 memcpy(&pPager->dbFileVers, &((u8*)pData)[24],sizeof(pPager->dbFileVers));
danielk197741483462007-03-24 16:45:04 +00001253 }
drh86a88112007-04-16 15:02:19 +00001254
1255 /* Decode the page just read from disk */
1256 CODEC1(pPager, pData, pPg->pgno, 3);
danielk19778c0a7912008-08-20 14:49:23 +00001257 sqlite3PcacheRelease(pPg);
drhfa86c412002-02-02 15:01:15 +00001258 }
1259 return rc;
1260}
1261
1262/*
danielk197713adf8a2004-06-03 16:08:41 +00001263** Parameter zMaster is the name of a master journal file. A single journal
1264** file that referred to the master journal file has just been rolled back.
1265** This routine checks if it is possible to delete the master journal file,
1266** and does so if it is.
drh726de592004-06-10 23:35:50 +00001267**
danielk197765839c62007-08-30 08:08:17 +00001268** Argument zMaster may point to Pager.pTmpSpace. So that buffer is not
1269** available for use within this function.
1270**
1271**
drh726de592004-06-10 23:35:50 +00001272** The master journal file contains the names of all child journals.
1273** To tell if a master journal can be deleted, check to each of the
1274** children. If all children are either missing or do not refer to
1275** a different master journal, then this master journal can be deleted.
danielk197713adf8a2004-06-03 16:08:41 +00001276*/
danielk1977b4b47412007-08-17 15:53:36 +00001277static int pager_delmaster(Pager *pPager, const char *zMaster){
1278 sqlite3_vfs *pVfs = pPager->pVfs;
danielk197713adf8a2004-06-03 16:08:41 +00001279 int rc;
1280 int master_open = 0;
danielk1977b4b47412007-08-17 15:53:36 +00001281 sqlite3_file *pMaster;
1282 sqlite3_file *pJournal;
danielk197713adf8a2004-06-03 16:08:41 +00001283 char *zMasterJournal = 0; /* Contents of master journal file */
drheb206252004-10-01 02:00:31 +00001284 i64 nMasterJournal; /* Size of master journal file */
danielk197713adf8a2004-06-03 16:08:41 +00001285
1286 /* Open the master journal file exclusively in case some other process
1287 ** is running this routine also. Not that it makes too much difference.
1288 */
drhe5ae5732008-06-15 02:51:47 +00001289 pMaster = (sqlite3_file *)sqlite3Malloc(pVfs->szOsFile * 2);
danielk1977fee2d252007-08-18 10:59:19 +00001290 pJournal = (sqlite3_file *)(((u8 *)pMaster) + pVfs->szOsFile);
danielk1977b4b47412007-08-17 15:53:36 +00001291 if( !pMaster ){
1292 rc = SQLITE_NOMEM;
1293 }else{
danielk1977fee2d252007-08-18 10:59:19 +00001294 int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MASTER_JOURNAL);
1295 rc = sqlite3OsOpen(pVfs, zMaster, pMaster, flags, 0);
danielk1977b4b47412007-08-17 15:53:36 +00001296 }
danielk197713adf8a2004-06-03 16:08:41 +00001297 if( rc!=SQLITE_OK ) goto delmaster_out;
1298 master_open = 1;
danielk1977b4b47412007-08-17 15:53:36 +00001299
1300 rc = sqlite3OsFileSize(pMaster, &nMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001301 if( rc!=SQLITE_OK ) goto delmaster_out;
1302
1303 if( nMasterJournal>0 ){
danielk19775865e3d2004-06-14 06:03:57 +00001304 char *zJournal;
danielk197776572402004-06-25 02:38:54 +00001305 char *zMasterPtr = 0;
danielk197765839c62007-08-30 08:08:17 +00001306 int nMasterPtr = pPager->pVfs->mxPathname+1;
danielk19775865e3d2004-06-14 06:03:57 +00001307
1308 /* Load the entire master journal file into space obtained from
drh17435752007-08-16 04:30:38 +00001309 ** sqlite3_malloc() and pointed to by zMasterJournal.
danielk19775865e3d2004-06-14 06:03:57 +00001310 */
drh4f21c4a2008-12-10 22:15:00 +00001311 zMasterJournal = (char *)sqlite3Malloc((int)nMasterJournal + nMasterPtr);
danielk197713adf8a2004-06-03 16:08:41 +00001312 if( !zMasterJournal ){
1313 rc = SQLITE_NOMEM;
1314 goto delmaster_out;
1315 }
danielk197765839c62007-08-30 08:08:17 +00001316 zMasterPtr = &zMasterJournal[nMasterJournal];
drh4f21c4a2008-12-10 22:15:00 +00001317 rc = sqlite3OsRead(pMaster, zMasterJournal, (int)nMasterJournal, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001318 if( rc!=SQLITE_OK ) goto delmaster_out;
1319
danielk19775865e3d2004-06-14 06:03:57 +00001320 zJournal = zMasterJournal;
1321 while( (zJournal-zMasterJournal)<nMasterJournal ){
danielk1977861f7452008-06-05 11:39:11 +00001322 int exists;
1323 rc = sqlite3OsAccess(pVfs, zJournal, SQLITE_ACCESS_EXISTS, &exists);
1324 if( rc!=SQLITE_OK ){
drh19db9352008-03-27 22:42:51 +00001325 goto delmaster_out;
1326 }
danielk1977861f7452008-06-05 11:39:11 +00001327 if( exists ){
danielk197713adf8a2004-06-03 16:08:41 +00001328 /* One of the journals pointed to by the master journal exists.
1329 ** Open it and check if it points at the master journal. If
1330 ** so, return without deleting the master journal file.
1331 */
drh3b7b78b2004-11-24 01:16:43 +00001332 int c;
danielk1977fee2d252007-08-18 10:59:19 +00001333 int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MAIN_JOURNAL);
1334 rc = sqlite3OsOpen(pVfs, zJournal, pJournal, flags, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001335 if( rc!=SQLITE_OK ){
danielk197713adf8a2004-06-03 16:08:41 +00001336 goto delmaster_out;
1337 }
danielk197713adf8a2004-06-03 16:08:41 +00001338
danielk197765839c62007-08-30 08:08:17 +00001339 rc = readMasterJournal(pJournal, zMasterPtr, nMasterPtr);
danielk1977b4b47412007-08-17 15:53:36 +00001340 sqlite3OsClose(pJournal);
danielk19779eed5052004-06-04 10:38:30 +00001341 if( rc!=SQLITE_OK ){
danielk19779eed5052004-06-04 10:38:30 +00001342 goto delmaster_out;
1343 }
danielk197776572402004-06-25 02:38:54 +00001344
danielk197765839c62007-08-30 08:08:17 +00001345 c = zMasterPtr[0]!=0 && strcmp(zMasterPtr, zMaster)==0;
drh3b7b78b2004-11-24 01:16:43 +00001346 if( c ){
danielk197776572402004-06-25 02:38:54 +00001347 /* We have a match. Do not delete the master journal file. */
1348 goto delmaster_out;
danielk197713adf8a2004-06-03 16:08:41 +00001349 }
1350 }
drhea678832008-12-10 19:26:22 +00001351 zJournal += (sqlite3Strlen30(zJournal)+1);
danielk197713adf8a2004-06-03 16:08:41 +00001352 }
1353 }
1354
danielk1977fee2d252007-08-18 10:59:19 +00001355 rc = sqlite3OsDelete(pVfs, zMaster, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001356
1357delmaster_out:
1358 if( zMasterJournal ){
drh17435752007-08-16 04:30:38 +00001359 sqlite3_free(zMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001360 }
1361 if( master_open ){
danielk1977b4b47412007-08-17 15:53:36 +00001362 sqlite3OsClose(pMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001363 }
danielk1977b4b47412007-08-17 15:53:36 +00001364 sqlite3_free(pMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001365 return rc;
1366}
1367
drha6abd042004-06-09 17:37:22 +00001368
danielk1977e180dd92007-04-05 17:15:52 +00001369static void pager_truncate_cache(Pager *pPager);
1370
drha6abd042004-06-09 17:37:22 +00001371/*
drhcb4c40b2004-08-18 19:09:43 +00001372** Truncate the main file of the given pager to the number of pages
danielk1977e180dd92007-04-05 17:15:52 +00001373** indicated. Also truncate the cached representation of the file.
drh7fe3f7e2007-11-29 18:44:27 +00001374**
1375** Might might be the case that the file on disk is smaller than nPage.
1376** This can happen, for example, if we are in the middle of a transaction
1377** which has extended the file size and the new pages are still all held
1378** in cache, then an INSERT or UPDATE does a statement rollback. Some
1379** operating system implementations can get confused if you try to
1380** truncate a file to some size that is larger than it currently is,
danielk197706e11af2008-05-06 18:13:26 +00001381** so detect this case and write a single zero byte to the end of the new
1382** file instead.
drhcb4c40b2004-08-18 19:09:43 +00001383*/
danielk1977d92db532008-11-17 04:56:24 +00001384static int pager_truncate(Pager *pPager, Pgno nPage){
danielk1977e180dd92007-04-05 17:15:52 +00001385 int rc = SQLITE_OK;
danielk19777a2b1ee2007-08-21 14:27:01 +00001386 if( pPager->state>=PAGER_EXCLUSIVE && pPager->fd->pMethods ){
drh7fe3f7e2007-11-29 18:44:27 +00001387 i64 currentSize, newSize;
1388 rc = sqlite3OsFileSize(pPager->fd, &currentSize);
1389 newSize = pPager->pageSize*(i64)nPage;
danielk197706e11af2008-05-06 18:13:26 +00001390 if( rc==SQLITE_OK && currentSize!=newSize ){
1391 if( currentSize>newSize ){
1392 rc = sqlite3OsTruncate(pPager->fd, newSize);
1393 }else{
1394 rc = sqlite3OsWrite(pPager->fd, "", 1, newSize-1);
1395 }
drh7fe3f7e2007-11-29 18:44:27 +00001396 }
danielk1977e180dd92007-04-05 17:15:52 +00001397 }
1398 if( rc==SQLITE_OK ){
1399 pPager->dbSize = nPage;
1400 pager_truncate_cache(pPager);
1401 }
1402 return rc;
drhcb4c40b2004-08-18 19:09:43 +00001403}
1404
1405/*
drhc80f0582007-05-01 16:59:48 +00001406** Set the sectorSize for the given pager.
1407**
drh334c80d2008-03-28 17:41:13 +00001408** The sector size is at least as big as the sector size reported
1409** by sqlite3OsSectorSize(). The minimum sector size is 512.
drhc80f0582007-05-01 16:59:48 +00001410*/
1411static void setSectorSize(Pager *pPager){
danielk19777a2b1ee2007-08-21 14:27:01 +00001412 assert(pPager->fd->pMethods||pPager->tempFile);
1413 if( !pPager->tempFile ){
1414 /* Sector size doesn't matter for temporary files. Also, the file
1415 ** may not have been opened yet, in whcih case the OsSectorSize()
1416 ** call will segfault.
1417 */
1418 pPager->sectorSize = sqlite3OsSectorSize(pPager->fd);
1419 }
drh334c80d2008-03-28 17:41:13 +00001420 if( pPager->sectorSize<512 ){
1421 pPager->sectorSize = 512;
drhc80f0582007-05-01 16:59:48 +00001422 }
1423}
1424
1425/*
drhed7c8552001-04-11 14:29:21 +00001426** Playback the journal and thus restore the database file to
1427** the state it was in before we started making changes.
1428**
drh34e79ce2004-02-08 06:05:46 +00001429** The journal file format is as follows:
1430**
drhae2b40c2004-06-09 19:03:54 +00001431** (1) 8 byte prefix. A copy of aJournalMagic[].
1432** (2) 4 byte big-endian integer which is the number of valid page records
drh34e79ce2004-02-08 06:05:46 +00001433** in the journal. If this value is 0xffffffff, then compute the
drhae2b40c2004-06-09 19:03:54 +00001434** number of page records from the journal size.
1435** (3) 4 byte big-endian integer which is the initial value for the
1436** sanity checksum.
1437** (4) 4 byte integer which is the number of pages to truncate the
drh34e79ce2004-02-08 06:05:46 +00001438** database to during a rollback.
drh334c80d2008-03-28 17:41:13 +00001439** (5) 4 byte big-endian integer which is the sector size. The header
1440** is this many bytes in size.
1441** (6) 4 byte big-endian integer which is the page case.
1442** (7) 4 byte integer which is the number of bytes in the master journal
drhae2b40c2004-06-09 19:03:54 +00001443** name. The value may be zero (indicate that there is no master
1444** journal.)
drh334c80d2008-03-28 17:41:13 +00001445** (8) N bytes of the master journal name. The name will be nul-terminated
drhae2b40c2004-06-09 19:03:54 +00001446** and might be shorter than the value read from (5). If the first byte
1447** of the name is \000 then there is no master journal. The master
1448** journal name is stored in UTF-8.
drh334c80d2008-03-28 17:41:13 +00001449** (9) Zero or more pages instances, each as follows:
drh34e79ce2004-02-08 06:05:46 +00001450** + 4 byte page number.
drhae2b40c2004-06-09 19:03:54 +00001451** + pPager->pageSize bytes of data.
1452** + 4 byte checksum
drh34e79ce2004-02-08 06:05:46 +00001453**
drh334c80d2008-03-28 17:41:13 +00001454** When we speak of the journal header, we mean the first 8 items above.
1455** Each entry in the journal is an instance of the 9th item.
drh34e79ce2004-02-08 06:05:46 +00001456**
1457** Call the value from the second bullet "nRec". nRec is the number of
1458** valid page entries in the journal. In most cases, you can compute the
1459** value of nRec from the size of the journal file. But if a power
1460** failure occurred while the journal was being written, it could be the
1461** case that the size of the journal file had already been increased but
1462** the extra entries had not yet made it safely to disk. In such a case,
1463** the value of nRec computed from the file size would be too large. For
1464** that reason, we always use the nRec value in the header.
1465**
1466** If the nRec value is 0xffffffff it means that nRec should be computed
1467** from the file size. This value is used when the user selects the
1468** no-sync option for the journal. A power failure could lead to corruption
1469** in this case. But for things like temporary table (which will be
1470** deleted when the power is restored) we don't care.
1471**
drhd9b02572001-04-15 00:37:09 +00001472** If the file opened as the journal file is not a well-formed
danielk1977ece80f12004-06-23 01:05:26 +00001473** journal file then all pages up to the first corrupted page are rolled
1474** back (or no pages if the journal header is corrupted). The journal file
1475** is then deleted and SQLITE_OK returned, just as if no corruption had
1476** been encountered.
1477**
1478** If an I/O or malloc() error occurs, the journal-file is not deleted
1479** and an error code is returned.
drhed7c8552001-04-11 14:29:21 +00001480*/
danielk1977e277be02007-03-23 18:12:06 +00001481static int pager_playback(Pager *pPager, int isHot){
danielk1977b4b47412007-08-17 15:53:36 +00001482 sqlite3_vfs *pVfs = pPager->pVfs;
drheb206252004-10-01 02:00:31 +00001483 i64 szJ; /* Size of the journal file in bytes */
danielk1977c3e8f5e2004-06-28 01:16:46 +00001484 u32 nRec; /* Number of Records in the journal */
shane0b8d2762008-07-22 05:18:00 +00001485 u32 u; /* Unsigned loop counter */
drhd9b02572001-04-15 00:37:09 +00001486 Pgno mxPg = 0; /* Size of the original file in pages */
drhae2b40c2004-06-09 19:03:54 +00001487 int rc; /* Result code of a subroutine */
danielk1977861f7452008-06-05 11:39:11 +00001488 int res = 1; /* Value returned by sqlite3OsAccess() */
danielk197713adf8a2004-06-03 16:08:41 +00001489 char *zMaster = 0; /* Name of master journal file if any */
drhed7c8552001-04-11 14:29:21 +00001490
drhc3a64ba2001-11-22 00:01:27 +00001491 /* Figure out how many records are in the journal. Abort early if
1492 ** the journal is empty.
drhed7c8552001-04-11 14:29:21 +00001493 */
drh8cfbf082001-09-19 13:22:39 +00001494 assert( pPager->journalOpen );
drh054889e2005-11-30 03:20:31 +00001495 rc = sqlite3OsFileSize(pPager->jfd, &szJ);
danielk1977334cdb62007-03-26 08:05:12 +00001496 if( rc!=SQLITE_OK || szJ==0 ){
drhc3a64ba2001-11-22 00:01:27 +00001497 goto end_playback;
1498 }
drh240c5792004-02-08 00:40:52 +00001499
danielk197776572402004-06-25 02:38:54 +00001500 /* Read the master journal name from the journal, if it is present.
1501 ** If a master journal file name is specified, but the file is not
1502 ** present on disk, then the journal is not hot and does not need to be
1503 ** played back.
drh240c5792004-02-08 00:40:52 +00001504 */
danielk197765839c62007-08-30 08:08:17 +00001505 zMaster = pPager->pTmpSpace;
1506 rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1);
danielk1977861f7452008-06-05 11:39:11 +00001507 if( rc==SQLITE_OK && zMaster[0] ){
1508 rc = sqlite3OsAccess(pVfs, zMaster, SQLITE_ACCESS_EXISTS, &res);
drhc3a64ba2001-11-22 00:01:27 +00001509 }
danielk197765839c62007-08-30 08:08:17 +00001510 zMaster = 0;
danielk1977861f7452008-06-05 11:39:11 +00001511 if( rc!=SQLITE_OK || !res ){
danielk1977ce98bba2008-04-03 10:13:01 +00001512 goto end_playback;
1513 }
1514 pPager->journalOff = 0;
drhc3a64ba2001-11-22 00:01:27 +00001515
danielk197776572402004-06-25 02:38:54 +00001516 /* This loop terminates either when the readJournalHdr() call returns
1517 ** SQLITE_DONE or an IO error occurs. */
1518 while( 1 ){
drhae2b40c2004-06-09 19:03:54 +00001519
danielk197776572402004-06-25 02:38:54 +00001520 /* Read the next journal header from the journal file. If there are
1521 ** not enough bytes left in the journal file for a complete header, or
1522 ** it is corrupted, then a process must of failed while writing it.
1523 ** This indicates nothing more needs to be rolled back.
1524 */
1525 rc = readJournalHdr(pPager, szJ, &nRec, &mxPg);
1526 if( rc!=SQLITE_OK ){
drh968af522003-02-11 14:55:40 +00001527 if( rc==SQLITE_DONE ){
drh968af522003-02-11 14:55:40 +00001528 rc = SQLITE_OK;
1529 }
danielk197776572402004-06-25 02:38:54 +00001530 goto end_playback;
1531 }
1532
1533 /* If nRec is 0xffffffff, then this journal was created by a process
1534 ** working in no-sync mode. This means that the rest of the journal
1535 ** file consists of pages, there are no more journal headers. Compute
1536 ** the value of nRec based on this assumption.
1537 */
1538 if( nRec==0xffffffff ){
1539 assert( pPager->journalOff==JOURNAL_HDR_SZ(pPager) );
drh4f21c4a2008-12-10 22:15:00 +00001540 nRec = (int)((szJ - JOURNAL_HDR_SZ(pPager))/JOURNAL_PG_SZ(pPager));
danielk197776572402004-06-25 02:38:54 +00001541 }
1542
danielk1977e277be02007-03-23 18:12:06 +00001543 /* If nRec is 0 and this rollback is of a transaction created by this
drh8940f4e2007-08-11 00:26:20 +00001544 ** process and if this is the final header in the journal, then it means
1545 ** that this part of the journal was being filled but has not yet been
1546 ** synced to disk. Compute the number of pages based on the remaining
1547 ** size of the file.
1548 **
1549 ** The third term of the test was added to fix ticket #2565.
danielk1977e277be02007-03-23 18:12:06 +00001550 */
drh8940f4e2007-08-11 00:26:20 +00001551 if( nRec==0 && !isHot &&
1552 pPager->journalHdr+JOURNAL_HDR_SZ(pPager)==pPager->journalOff ){
drh4f21c4a2008-12-10 22:15:00 +00001553 nRec = (int)((szJ - pPager->journalOff) / JOURNAL_PG_SZ(pPager));
danielk1977e277be02007-03-23 18:12:06 +00001554 }
1555
danielk197776572402004-06-25 02:38:54 +00001556 /* If this is the first header read from the journal, truncate the
drh85b623f2007-12-13 21:54:09 +00001557 ** database file back to its original size.
danielk197776572402004-06-25 02:38:54 +00001558 */
danielk1977e180dd92007-04-05 17:15:52 +00001559 if( pPager->journalOff==JOURNAL_HDR_SZ(pPager) ){
drhcb4c40b2004-08-18 19:09:43 +00001560 rc = pager_truncate(pPager, mxPg);
danielk197776572402004-06-25 02:38:54 +00001561 if( rc!=SQLITE_OK ){
1562 goto end_playback;
1563 }
danielk197776572402004-06-25 02:38:54 +00001564 }
1565
danielk197776572402004-06-25 02:38:54 +00001566 /* Copy original pages out of the journal and back into the database file.
1567 */
shane0b8d2762008-07-22 05:18:00 +00001568 for(u=0; u<nRec; u++){
danielk1977fd7f0452008-12-17 17:30:26 +00001569 rc = pager_playback_one_page(pPager, 1, pPager->journalOff, 0);
danielk197776572402004-06-25 02:38:54 +00001570 if( rc!=SQLITE_OK ){
1571 if( rc==SQLITE_DONE ){
1572 rc = SQLITE_OK;
1573 pPager->journalOff = szJ;
1574 break;
1575 }else{
drha9625ea2008-09-03 00:08:29 +00001576 /* If we are unable to rollback, then the database is probably
1577 ** going to end up being corrupt. It is corrupt to us, anyhow.
1578 ** Perhaps the next process to come along can fix it....
1579 */
danielk197798c21902008-09-23 16:41:29 +00001580 rc = SQLITE_CORRUPT_BKPT;
danielk197776572402004-06-25 02:38:54 +00001581 goto end_playback;
1582 }
1583 }
drh968af522003-02-11 14:55:40 +00001584 }
drhed7c8552001-04-11 14:29:21 +00001585 }
drh580eeaf2006-02-24 03:09:37 +00001586 /*NOTREACHED*/
1587 assert( 0 );
drh4a0681e2003-02-13 01:58:20 +00001588
1589end_playback:
danielk19778191bff2004-06-28 04:52:30 +00001590 if( rc==SQLITE_OK ){
danielk197765839c62007-08-30 08:08:17 +00001591 zMaster = pPager->pTmpSpace;
1592 rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1);
1593 }
1594 if( rc==SQLITE_OK ){
danielk1977df2566a2008-05-07 19:11:03 +00001595 rc = pager_end_transaction(pPager, zMaster[0]!='\0');
danielk19778191bff2004-06-28 04:52:30 +00001596 }
danielk1977c56774e2008-10-07 11:51:20 +00001597 if( rc==SQLITE_OK && zMaster[0] && res ){
danielk1977979f38e2007-03-27 16:19:51 +00001598 /* If there was a master journal and this routine will return success,
danielk197732554c12005-01-22 03:39:39 +00001599 ** see if it is possible to delete the master journal.
danielk197713adf8a2004-06-03 16:08:41 +00001600 */
danielk197765839c62007-08-30 08:08:17 +00001601 rc = pager_delmaster(pPager, zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001602 }
danielk197776572402004-06-25 02:38:54 +00001603
1604 /* The Pager.sectorSize variable may have been updated while rolling
drh3ceeb752007-03-29 18:19:52 +00001605 ** back a journal created by a process with a different sector size
danielk197776572402004-06-25 02:38:54 +00001606 ** value. Reset it to the correct value for this process.
1607 */
drhc80f0582007-05-01 16:59:48 +00001608 setSectorSize(pPager);
drhd9b02572001-04-15 00:37:09 +00001609 return rc;
drhed7c8552001-04-11 14:29:21 +00001610}
1611
1612/*
danielk1977fd7f0452008-12-17 17:30:26 +00001613** Playback a savepoint.
drhfa86c412002-02-02 15:01:15 +00001614*/
danielk1977fd7f0452008-12-17 17:30:26 +00001615static int pagerPlaybackSavepoint(Pager *pPager, PagerSavepoint *pSavepoint){
drheb206252004-10-01 02:00:31 +00001616 i64 szJ; /* Size of the full journal */
danielk1977fd7f0452008-12-17 17:30:26 +00001617 i64 iHdrOff; /* End of first segment of main-journal records */
1618 Pgno ii; /* Loop counter */
1619 int rc; /* Return code */
1620 Bitvec *pDone = 0; /* Bitvec to ensure pages played back only once */
drhfa86c412002-02-02 15:01:15 +00001621
danielk1977fd7f0452008-12-17 17:30:26 +00001622 /* Allocate a bitvec to use to store the set of pages rolled back */
1623 if( pSavepoint ){
1624 pDone = sqlite3BitvecCreate(pSavepoint->nOrig);
1625 if( !pDone ){
1626 return SQLITE_NOMEM;
1627 }
danielk197776572402004-06-25 02:38:54 +00001628 }
danielk1977fd7f0452008-12-17 17:30:26 +00001629
1630 /* Truncate the database back to the size it was before the
1631 ** savepoint being reverted was opened.
drhfa86c412002-02-02 15:01:15 +00001632 */
danielk1977fd7f0452008-12-17 17:30:26 +00001633 rc = pager_truncate(pPager, pSavepoint?pSavepoint->nOrig:pPager->origDbSize);
drh1aa2d8b2007-01-03 15:34:29 +00001634 assert( pPager->state>=PAGER_SHARED );
drhfa86c412002-02-02 15:01:15 +00001635
danielk1977fd7f0452008-12-17 17:30:26 +00001636 /* Now roll back all main journal file records that occur after byte
1637 ** byte offset PagerSavepoint.iOffset that have a page number less than
1638 ** or equal to PagerSavepoint.nOrig. As each record is played back,
1639 ** the corresponding bit in bitvec PagerSavepoint.pInSavepoint is
1640 ** cleared.
drhfa86c412002-02-02 15:01:15 +00001641 */
danielk1977fd7f0452008-12-17 17:30:26 +00001642 szJ = pPager->journalOff;
1643 if( pSavepoint ){
1644 iHdrOff = pSavepoint->iHdrOffset ? pSavepoint->iHdrOffset : szJ;
1645 pPager->journalOff = pSavepoint->iOffset;
1646 while( rc==SQLITE_OK && pPager->journalOff<iHdrOff ){
1647 rc = pager_playback_one_page(pPager, 1, pPager->journalOff, pDone);
1648 assert( rc!=SQLITE_DONE );
1649 }
1650 }else{
1651 pPager->journalOff = 0;
drhfa86c412002-02-02 15:01:15 +00001652 }
danielk1977fd7f0452008-12-17 17:30:26 +00001653 while( rc==SQLITE_OK && pPager->journalOff<szJ ){
danielk1977f0113002006-01-24 12:09:17 +00001654 u32 nJRec; /* Number of Journal Records */
danielk197776572402004-06-25 02:38:54 +00001655 u32 dummy;
danielk1977f0113002006-01-24 12:09:17 +00001656 rc = readJournalHdr(pPager, szJ, &nJRec, &dummy);
danielk1977fd7f0452008-12-17 17:30:26 +00001657 assert( rc!=SQLITE_DONE );
danielk1977f0113002006-01-24 12:09:17 +00001658 if( nJRec==0 ){
danielk1977fd7f0452008-12-17 17:30:26 +00001659 nJRec = (szJ - pPager->journalOff) / (pPager->pageSize+8);
danielk197775edc162004-06-26 01:48:18 +00001660 }
danielk197712dd5492008-12-18 15:45:07 +00001661 for(ii=0; rc==SQLITE_OK && ii<nJRec && pPager->journalOff<szJ; ii++){
danielk1977fd7f0452008-12-17 17:30:26 +00001662 rc = pager_playback_one_page(pPager, 1, pPager->journalOff, pDone);
danielk197776572402004-06-25 02:38:54 +00001663 assert( rc!=SQLITE_DONE );
danielk1977fd7f0452008-12-17 17:30:26 +00001664 }
1665 }
1666 assert( rc!=SQLITE_OK || pPager->journalOff==szJ );
1667
1668 /* Now roll back pages from the sub-journal. */
1669 if( pSavepoint ){
1670 for(ii=pSavepoint->iSubRec; rc==SQLITE_OK && ii<pPager->stmtNRec; ii++){
1671 i64 offset = ii*(4+pPager->pageSize);
1672 rc = pager_playback_one_page(pPager, 0, offset, pDone);
1673 assert( rc!=SQLITE_DONE );
danielk197776572402004-06-25 02:38:54 +00001674 }
drhfa86c412002-02-02 15:01:15 +00001675 }
danielk197776572402004-06-25 02:38:54 +00001676
danielk1977fd7f0452008-12-17 17:30:26 +00001677 sqlite3BitvecDestroy(pDone);
1678 if( rc==SQLITE_OK ){
danielk197775edc162004-06-26 01:48:18 +00001679 pPager->journalOff = szJ;
drhfa86c412002-02-02 15:01:15 +00001680 }
1681 return rc;
1682}
1683
1684/*
drhf57b14a2001-09-14 18:54:08 +00001685** Change the maximum number of in-memory pages that are allowed.
1686*/
danielk19773b8a05f2007-03-19 17:44:26 +00001687void sqlite3PagerSetCachesize(Pager *pPager, int mxPage){
danielk19778c0a7912008-08-20 14:49:23 +00001688 sqlite3PcacheSetCachesize(pPager->pPCache, mxPage);
drhf57b14a2001-09-14 18:54:08 +00001689}
1690
1691/*
drh973b6e32003-02-12 14:09:42 +00001692** Adjust the robustness of the database to damage due to OS crashes
1693** or power failures by changing the number of syncs()s when writing
1694** the rollback journal. There are three levels:
1695**
drh054889e2005-11-30 03:20:31 +00001696** OFF sqlite3OsSync() is never called. This is the default
drh973b6e32003-02-12 14:09:42 +00001697** for temporary and transient files.
1698**
1699** NORMAL The journal is synced once before writes begin on the
1700** database. This is normally adequate protection, but
1701** it is theoretically possible, though very unlikely,
1702** that an inopertune power failure could leave the journal
1703** in a state which would cause damage to the database
1704** when it is rolled back.
1705**
1706** FULL The journal is synced twice before writes begin on the
drh34e79ce2004-02-08 06:05:46 +00001707** database (with some additional information - the nRec field
1708** of the journal header - being written in between the two
1709** syncs). If we assume that writing a
drh973b6e32003-02-12 14:09:42 +00001710** single disk sector is atomic, then this mode provides
1711** assurance that the journal will not be corrupted to the
1712** point of causing damage to the database during rollback.
1713**
1714** Numeric values associated with these states are OFF==1, NORMAL=2,
1715** and FULL=3.
1716*/
danielk197793758c82005-01-21 08:13:14 +00001717#ifndef SQLITE_OMIT_PAGER_PRAGMAS
drh281b21d2008-08-22 12:57:08 +00001718void sqlite3PagerSetSafetyLevel(Pager *pPager, int level, int bFullFsync){
drh4f21c4a2008-12-10 22:15:00 +00001719 pPager->noSync = (level==1 || pPager->tempFile) ?1:0;
1720 pPager->fullSync = (level==3 && !pPager->tempFile) ?1:0;
drh281b21d2008-08-22 12:57:08 +00001721 pPager->sync_flags = (bFullFsync?SQLITE_SYNC_FULL:SQLITE_SYNC_NORMAL);
danielk19771d850a72004-05-31 08:26:49 +00001722 if( pPager->noSync ) pPager->needSync = 0;
drh973b6e32003-02-12 14:09:42 +00001723}
danielk197793758c82005-01-21 08:13:14 +00001724#endif
drh973b6e32003-02-12 14:09:42 +00001725
1726/*
drhaf6df112005-06-07 02:12:30 +00001727** The following global variable is incremented whenever the library
1728** attempts to open a temporary file. This information is used for
1729** testing and analysis only.
1730*/
drh0f7eb612006-08-08 13:51:43 +00001731#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00001732int sqlite3_opentemp_count = 0;
drh0f7eb612006-08-08 13:51:43 +00001733#endif
drhaf6df112005-06-07 02:12:30 +00001734
1735/*
drh3f56e6e2007-03-15 01:16:47 +00001736** Open a temporary file.
1737**
1738** Write the file descriptor into *fd. Return SQLITE_OK on success or some
danielk1977fee2d252007-08-18 10:59:19 +00001739** other error code if we fail. The OS will automatically delete the temporary
1740** file when it is closed.
drhfa86c412002-02-02 15:01:15 +00001741*/
danielk1977b4b47412007-08-17 15:53:36 +00001742static int sqlite3PagerOpentemp(
danielk197717b90b52008-06-06 11:11:25 +00001743 Pager *pPager, /* The pager object */
drh33f4e022007-09-03 15:19:34 +00001744 sqlite3_file *pFile, /* Write the file descriptor here */
drh33f4e022007-09-03 15:19:34 +00001745 int vfsFlags /* Flags passed through to the VFS */
danielk1977b4b47412007-08-17 15:53:36 +00001746){
drhfa86c412002-02-02 15:01:15 +00001747 int rc;
drh3f56e6e2007-03-15 01:16:47 +00001748
drh0f7eb612006-08-08 13:51:43 +00001749#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00001750 sqlite3_opentemp_count++; /* Used for testing and analysis only */
drh0f7eb612006-08-08 13:51:43 +00001751#endif
danielk1977b4b47412007-08-17 15:53:36 +00001752
drh33f4e022007-09-03 15:19:34 +00001753 vfsFlags |= SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE |
1754 SQLITE_OPEN_EXCLUSIVE | SQLITE_OPEN_DELETEONCLOSE;
danielk197717b90b52008-06-06 11:11:25 +00001755 rc = sqlite3OsOpen(pPager->pVfs, 0, pFile, vfsFlags, 0);
drhae28c012007-08-24 16:29:23 +00001756 assert( rc!=SQLITE_OK || pFile->pMethods );
drhfa86c412002-02-02 15:01:15 +00001757 return rc;
1758}
1759
danielk1977a858aa22008-08-22 16:22:17 +00001760static int pagerStress(void *,PgHdr *);
danielk19778c0a7912008-08-20 14:49:23 +00001761
drhfa86c412002-02-02 15:01:15 +00001762/*
drhed7c8552001-04-11 14:29:21 +00001763** Create a new page cache and put a pointer to the page cache in *ppPager.
drh5e00f6c2001-09-13 13:46:56 +00001764** The file to be cached need not exist. The file is not locked until
danielk19773b8a05f2007-03-19 17:44:26 +00001765** the first call to sqlite3PagerGet() and is only held open until the
1766** last page is released using sqlite3PagerUnref().
drh382c0242001-10-06 16:33:02 +00001767**
drh6446c4d2001-12-15 14:22:18 +00001768** If zFilename is NULL then a randomly-named temporary file is created
drh1cc8c442007-08-24 16:08:29 +00001769** and used as the file to be cached. The file will be deleted
drh6446c4d2001-12-15 14:22:18 +00001770** automatically when it is closed.
drh90f5ecb2004-07-22 01:19:35 +00001771**
1772** If zFilename is ":memory:" then all information is held in cache.
1773** It is never written to disk. This can be used to implement an
1774** in-memory database.
drhed7c8552001-04-11 14:29:21 +00001775*/
danielk19773b8a05f2007-03-19 17:44:26 +00001776int sqlite3PagerOpen(
drh86f8c192007-08-22 00:39:19 +00001777 sqlite3_vfs *pVfs, /* The virtual file system to use */
drh7e3b0a02001-04-28 16:52:40 +00001778 Pager **ppPager, /* Return the Pager structure here */
1779 const char *zFilename, /* Name of the database file to open */
drhda47d772002-12-02 04:25:19 +00001780 int nExtra, /* Extra bytes append to each in-memory page */
drh33f4e022007-09-03 15:19:34 +00001781 int flags, /* flags controlling this file */
1782 int vfsFlags /* flags passed through to sqlite3_vfs.xOpen() */
drh7e3b0a02001-04-28 16:52:40 +00001783){
danielk1977b4b47412007-08-17 15:53:36 +00001784 u8 *pPtr;
danielk1977aef0bf62005-12-30 16:28:01 +00001785 Pager *pPager = 0;
danielk1977cfe9a692004-06-16 12:00:29 +00001786 int rc = SQLITE_OK;
1787 int i;
danielk19778def5ea2004-06-16 10:39:52 +00001788 int tempFile = 0;
drhac69b052004-05-12 13:30:07 +00001789 int memDb = 0;
drh5e00f6c2001-09-13 13:46:56 +00001790 int readOnly = 0;
drh7bec5052005-02-06 02:45:41 +00001791 int useJournal = (flags & PAGER_OMIT_JOURNAL)==0;
1792 int noReadlock = (flags & PAGER_NO_READLOCK)!=0;
danielk1977b3175382008-10-17 18:51:52 +00001793 int journalFileSize;
danielk19778c0a7912008-08-20 14:49:23 +00001794 int pcacheSize = sqlite3PcacheSize();
drhfacf0302008-06-17 15:12:00 +00001795 int szPageDflt = SQLITE_DEFAULT_PAGE_SIZE;
danielk197717b90b52008-06-06 11:11:25 +00001796 char *zPathname = 0;
1797 int nPathname = 0;
danielk1977b4b47412007-08-17 15:53:36 +00001798
danielk1977b3175382008-10-17 18:51:52 +00001799 if( sqlite3JournalSize(pVfs)>sqlite3MemJournalSize() ){
1800 journalFileSize = sqlite3JournalSize(pVfs);
1801 }else{
1802 journalFileSize = sqlite3MemJournalSize();
1803 }
1804
drh86f8c192007-08-22 00:39:19 +00001805 /* The default return is a NULL pointer */
drhd9b02572001-04-15 00:37:09 +00001806 *ppPager = 0;
danielk1977aef0bf62005-12-30 16:28:01 +00001807
danielk197717b90b52008-06-06 11:11:25 +00001808 /* Compute and store the full pathname in an allocated buffer pointed
1809 ** to by zPathname, length nPathname. Or, if this is a temporary file,
1810 ** leave both nPathname and zPathname set to 0.
1811 */
drh1cc8c442007-08-24 16:08:29 +00001812 if( zFilename && zFilename[0] ){
danielk197717b90b52008-06-06 11:11:25 +00001813 nPathname = pVfs->mxPathname+1;
drhe5ae5732008-06-15 02:51:47 +00001814 zPathname = sqlite3Malloc(nPathname*2);
danielk197717b90b52008-06-06 11:11:25 +00001815 if( zPathname==0 ){
1816 return SQLITE_NOMEM;
1817 }
drh1cc8c442007-08-24 16:08:29 +00001818#ifndef SQLITE_OMIT_MEMORYDB
1819 if( strcmp(zFilename,":memory:")==0 ){
1820 memDb = 1;
1821 zPathname[0] = 0;
1822 }else
1823#endif
1824 {
danielk1977adfb9b02007-09-17 07:02:56 +00001825 rc = sqlite3OsFullPathname(pVfs, zFilename, nPathname, zPathname);
drh1cc8c442007-08-24 16:08:29 +00001826 }
danielk197717b90b52008-06-06 11:11:25 +00001827 if( rc!=SQLITE_OK ){
1828 sqlite3_free(zPathname);
1829 return rc;
1830 }
drhea678832008-12-10 19:26:22 +00001831 nPathname = sqlite3Strlen30(zPathname);
drhae28c012007-08-24 16:29:23 +00001832 }
drh99b90c32008-03-17 13:50:58 +00001833
danielk1977b4b47412007-08-17 15:53:36 +00001834 /* Allocate memory for the pager structure */
1835 pPager = sqlite3MallocZero(
1836 sizeof(*pPager) + /* Pager structure */
danielk19778c0a7912008-08-20 14:49:23 +00001837 pcacheSize + /* PCache object */
danielk1977c7b60172007-08-22 11:22:03 +00001838 journalFileSize + /* The journal file structure */
danielk1977b3175382008-10-17 18:51:52 +00001839 pVfs->szOsFile + /* The main db file */
1840 journalFileSize * 2 + /* The two journal files */
danielk197717b90b52008-06-06 11:11:25 +00001841 3*nPathname + 40 /* zFilename, zDirectory, zJournal */
danielk1977b4b47412007-08-17 15:53:36 +00001842 );
1843 if( !pPager ){
drh1cc8c442007-08-24 16:08:29 +00001844 sqlite3_free(zPathname);
danielk1977b4b47412007-08-17 15:53:36 +00001845 return SQLITE_NOMEM;
1846 }
danielk19778c0a7912008-08-20 14:49:23 +00001847 pPager->pPCache = (PCache *)&pPager[1];
1848 pPtr = ((u8 *)&pPager[1]) + pcacheSize;
drh33f4e022007-09-03 15:19:34 +00001849 pPager->vfsFlags = vfsFlags;
danielk1977b4b47412007-08-17 15:53:36 +00001850 pPager->fd = (sqlite3_file*)&pPtr[pVfs->szOsFile*0];
danielk1977fd7f0452008-12-17 17:30:26 +00001851 pPager->sjfd = (sqlite3_file*)&pPtr[pVfs->szOsFile];
danielk1977b3175382008-10-17 18:51:52 +00001852 pPager->jfd = (sqlite3_file*)&pPtr[pVfs->szOsFile+journalFileSize];
1853 pPager->zFilename = (char*)&pPtr[pVfs->szOsFile+2*journalFileSize];
drh1cc8c442007-08-24 16:08:29 +00001854 pPager->zDirectory = &pPager->zFilename[nPathname+1];
1855 pPager->zJournal = &pPager->zDirectory[nPathname+1];
danielk1977b4b47412007-08-17 15:53:36 +00001856 pPager->pVfs = pVfs;
danielk197717b90b52008-06-06 11:11:25 +00001857 if( zPathname ){
1858 memcpy(pPager->zFilename, zPathname, nPathname+1);
1859 sqlite3_free(zPathname);
1860 }
danielk1977b4b47412007-08-17 15:53:36 +00001861
drh153c62c2007-08-24 03:51:33 +00001862 /* Open the pager file.
danielk1977aef0bf62005-12-30 16:28:01 +00001863 */
drhae28c012007-08-24 16:29:23 +00001864 if( zFilename && zFilename[0] && !memDb ){
danielk1977d92db532008-11-17 04:56:24 +00001865 if( nPathname>(pVfs->mxPathname - (int)sizeof("-journal")) ){
drh1cc8c442007-08-24 16:08:29 +00001866 rc = SQLITE_CANTOPEN;
1867 }else{
drh1cc8c442007-08-24 16:08:29 +00001868 int fout = 0;
drh33f4e022007-09-03 15:19:34 +00001869 rc = sqlite3OsOpen(pVfs, pPager->zFilename, pPager->fd,
1870 pPager->vfsFlags, &fout);
drh1cc8c442007-08-24 16:08:29 +00001871 readOnly = (fout&SQLITE_OPEN_READONLY);
1872
1873 /* If the file was successfully opened for read/write access,
1874 ** choose a default page size in case we have to create the
1875 ** database file. The default page size is the maximum of:
1876 **
1877 ** + SQLITE_DEFAULT_PAGE_SIZE,
1878 ** + The value returned by sqlite3OsSectorSize()
1879 ** + The largest page size that can be written atomically.
1880 */
1881 if( rc==SQLITE_OK && !readOnly ){
1882 int iSectorSize = sqlite3OsSectorSize(pPager->fd);
drhfacf0302008-06-17 15:12:00 +00001883 if( szPageDflt<iSectorSize ){
1884 szPageDflt = iSectorSize;
drh1cc8c442007-08-24 16:08:29 +00001885 }
danielk19779663b8f2007-08-24 11:52:28 +00001886#ifdef SQLITE_ENABLE_ATOMIC_WRITE
drh1cc8c442007-08-24 16:08:29 +00001887 {
1888 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
1889 int ii;
1890 assert(SQLITE_IOCAP_ATOMIC512==(512>>8));
1891 assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8));
1892 assert(SQLITE_MAX_DEFAULT_PAGE_SIZE<=65536);
drhfacf0302008-06-17 15:12:00 +00001893 for(ii=szPageDflt; ii<=SQLITE_MAX_DEFAULT_PAGE_SIZE; ii=ii*2){
1894 if( iDc&(SQLITE_IOCAP_ATOMIC|(ii>>8)) ) szPageDflt = ii;
danielk19779663b8f2007-08-24 11:52:28 +00001895 }
danielk1977b4b47412007-08-17 15:53:36 +00001896 }
drh1cc8c442007-08-24 16:08:29 +00001897#endif
drhfacf0302008-06-17 15:12:00 +00001898 if( szPageDflt>SQLITE_MAX_DEFAULT_PAGE_SIZE ){
1899 szPageDflt = SQLITE_MAX_DEFAULT_PAGE_SIZE;
drh1cc8c442007-08-24 16:08:29 +00001900 }
danielk19778def5ea2004-06-16 10:39:52 +00001901 }
drhac69b052004-05-12 13:30:07 +00001902 }
danielk1977b3175382008-10-17 18:51:52 +00001903 }else{
danielk19777a2b1ee2007-08-21 14:27:01 +00001904 /* If a temporary file is requested, it is not opened immediately.
1905 ** In this case we accept the default page size and delay actually
1906 ** opening the file until the first call to OsWrite().
danielk1977b3175382008-10-17 18:51:52 +00001907 **
1908 ** This branch is also run for an in-memory database. An in-memory
1909 ** database is the same as a temp-file that is never written out to
1910 ** disk and uses an in-memory rollback journal.
danielk19777a2b1ee2007-08-21 14:27:01 +00001911 */
danielk19777a2b1ee2007-08-21 14:27:01 +00001912 tempFile = 1;
1913 pPager->state = PAGER_EXCLUSIVE;
drh5e00f6c2001-09-13 13:46:56 +00001914 }
danielk1977aef0bf62005-12-30 16:28:01 +00001915
danielk1977b4b47412007-08-17 15:53:36 +00001916 if( pPager && rc==SQLITE_OK ){
drhfacf0302008-06-17 15:12:00 +00001917 pPager->pTmpSpace = sqlite3PageMalloc(szPageDflt);
drh3e7a6092002-12-07 21:45:14 +00001918 }
danielk1977aef0bf62005-12-30 16:28:01 +00001919
drh153c62c2007-08-24 03:51:33 +00001920 /* If an error occured in either of the blocks above.
1921 ** Free the Pager structure and close the file.
1922 ** Since the pager is not allocated there is no need to set
danielk1977aef0bf62005-12-30 16:28:01 +00001923 ** any Pager.errMask variables.
1924 */
danielk1977b4b47412007-08-17 15:53:36 +00001925 if( !pPager || !pPager->pTmpSpace ){
1926 sqlite3OsClose(pPager->fd);
drh17435752007-08-16 04:30:38 +00001927 sqlite3_free(pPager);
danielk1977aef0bf62005-12-30 16:28:01 +00001928 return ((rc==SQLITE_OK)?SQLITE_NOMEM:rc);
drhed7c8552001-04-11 14:29:21 +00001929 }
danielk19778c0a7912008-08-20 14:49:23 +00001930 nExtra = FORCE_ALIGNMENT(nExtra);
danielk197771d5d2c2008-09-29 11:49:47 +00001931 sqlite3PcacheOpen(szPageDflt, nExtra, !memDb,
drh41d30272008-08-20 21:47:45 +00001932 !memDb?pagerStress:0, (void *)pPager, pPager->pPCache);
danielk1977aef0bf62005-12-30 16:28:01 +00001933
drh153c62c2007-08-24 03:51:33 +00001934 PAGERTRACE3("OPEN %d %s\n", FILEHANDLEID(pPager->fd), pPager->zFilename);
1935 IOTRACE(("OPEN %p %s\n", pPager, pPager->zFilename))
danielk1977aef0bf62005-12-30 16:28:01 +00001936
danielk1977b4b47412007-08-17 15:53:36 +00001937 /* Fill in Pager.zDirectory[] */
drh1cc8c442007-08-24 16:08:29 +00001938 memcpy(pPager->zDirectory, pPager->zFilename, nPathname+1);
drhea678832008-12-10 19:26:22 +00001939 for(i=sqlite3Strlen30(pPager->zDirectory);
1940 i>0 && pPager->zDirectory[i-1]!='/'; i--){}
drha76c82e2003-07-27 18:59:42 +00001941 if( i>0 ) pPager->zDirectory[i-1] = 0;
danielk1977b4b47412007-08-17 15:53:36 +00001942
drh99b90c32008-03-17 13:50:58 +00001943 /* Fill in Pager.zJournal[] */
danielk197717b90b52008-06-06 11:11:25 +00001944 if( zPathname ){
1945 memcpy(pPager->zJournal, pPager->zFilename, nPathname);
1946 memcpy(&pPager->zJournal[nPathname], "-journal", 9);
1947 }else{
1948 pPager->zJournal = 0;
1949 }
danielk1977b4b47412007-08-17 15:53:36 +00001950
drh3b59a5c2006-01-15 20:28:28 +00001951 /* pPager->journalOpen = 0; */
drh4f21c4a2008-12-10 22:15:00 +00001952 pPager->useJournal = (u8)useJournal;
1953 pPager->noReadlock = (noReadlock && readOnly) ?1:0;
drh3b59a5c2006-01-15 20:28:28 +00001954 /* pPager->stmtOpen = 0; */
1955 /* pPager->stmtInUse = 0; */
1956 /* pPager->nRef = 0; */
drh4f21c4a2008-12-10 22:15:00 +00001957 pPager->dbSizeValid = (u8)memDb;
drhfacf0302008-06-17 15:12:00 +00001958 pPager->pageSize = szPageDflt;
drh3b59a5c2006-01-15 20:28:28 +00001959 /* pPager->stmtSize = 0; */
1960 /* pPager->stmtJSize = 0; */
1961 /* pPager->nPage = 0; */
drh90f5ecb2004-07-22 01:19:35 +00001962 pPager->mxPage = 100;
drhf8e632b2007-05-08 14:51:36 +00001963 pPager->mxPgno = SQLITE_MAX_PAGE_COUNT;
drh3b59a5c2006-01-15 20:28:28 +00001964 /* pPager->state = PAGER_UNLOCK; */
drh1cc8c442007-08-24 16:08:29 +00001965 assert( pPager->state == (tempFile ? PAGER_EXCLUSIVE : PAGER_UNLOCK) );
drh3b59a5c2006-01-15 20:28:28 +00001966 /* pPager->errMask = 0; */
drh4f21c4a2008-12-10 22:15:00 +00001967 pPager->tempFile = (u8)tempFile;
drh369339d2007-03-30 16:01:55 +00001968 assert( tempFile==PAGER_LOCKINGMODE_NORMAL
1969 || tempFile==PAGER_LOCKINGMODE_EXCLUSIVE );
1970 assert( PAGER_LOCKINGMODE_EXCLUSIVE==1 );
drh4f21c4a2008-12-10 22:15:00 +00001971 pPager->exclusiveMode = (u8)tempFile;
1972 pPager->memDb = (u8)memDb;
1973 pPager->readOnly = (u8)readOnly;
drh3b59a5c2006-01-15 20:28:28 +00001974 /* pPager->needSync = 0; */
drh4f21c4a2008-12-10 22:15:00 +00001975 pPager->noSync = (pPager->tempFile || !useJournal) ?1:0;
1976 pPager->fullSync = pPager->noSync ?0:1;
danielk1977f036aef2007-08-20 05:36:51 +00001977 pPager->sync_flags = SQLITE_SYNC_NORMAL;
drh3b59a5c2006-01-15 20:28:28 +00001978 /* pPager->pFirst = 0; */
1979 /* pPager->pFirstSynced = 0; */
1980 /* pPager->pLast = 0; */
danielk19778c0a7912008-08-20 14:49:23 +00001981 pPager->nExtra = nExtra;
danielk1977b53e4962008-06-04 06:45:59 +00001982 pPager->journalSizeLimit = SQLITE_DEFAULT_JOURNAL_SIZE_LIMIT;
danielk1977b3175382008-10-17 18:51:52 +00001983 assert(pPager->fd->pMethods||tempFile);
1984 setSectorSize(pPager);
1985 if( memDb ){
1986 pPager->journalMode = PAGER_JOURNALMODE_MEMORY;
danielk1977b4721172007-03-19 05:54:48 +00001987 }
danielk19771ceedd32008-11-19 10:22:33 +00001988 /* pPager->xBusyHandler = 0; */
1989 /* pPager->pBusyHandlerArg = 0; */
drh3b59a5c2006-01-15 20:28:28 +00001990 /* memset(pPager->aHash, 0, sizeof(pPager->aHash)); */
drhed7c8552001-04-11 14:29:21 +00001991 *ppPager = pPager;
1992 return SQLITE_OK;
1993}
1994
1995/*
drh90f5ecb2004-07-22 01:19:35 +00001996** Set the busy handler function.
1997*/
danielk19771ceedd32008-11-19 10:22:33 +00001998void sqlite3PagerSetBusyhandler(
1999 Pager *pPager,
2000 int (*xBusyHandler)(void *),
2001 void *pBusyHandlerArg
2002){
2003 pPager->xBusyHandler = xBusyHandler;
2004 pPager->pBusyHandlerArg = pBusyHandlerArg;
drh90f5ecb2004-07-22 01:19:35 +00002005}
2006
2007/*
drha6abd042004-06-09 17:37:22 +00002008** Set the reinitializer for this pager. If not NULL, the reinitializer
2009** is called when the content of a page in cache is restored to its original
2010** value as a result of a rollback. The callback gives higher-level code
2011** an opportunity to restore the EXTRA section to agree with the restored
2012** page data.
2013*/
danielk1977eaa06f62008-09-18 17:34:44 +00002014void sqlite3PagerSetReiniter(Pager *pPager, void (*xReinit)(DbPage*)){
drha6abd042004-06-09 17:37:22 +00002015 pPager->xReiniter = xReinit;
2016}
2017
2018/*
danielk1977a1644fd2007-08-29 12:31:25 +00002019** Set the page size to *pPageSize. If the suggest new page size is
2020** inappropriate, then an alternative page size is set to that
2021** value before returning.
drh90f5ecb2004-07-22 01:19:35 +00002022*/
danielk1977a1644fd2007-08-29 12:31:25 +00002023int sqlite3PagerSetPagesize(Pager *pPager, u16 *pPageSize){
danielk19771357d9f2008-09-16 05:12:24 +00002024 int rc = pPager->errCode;
2025 if( rc==SQLITE_OK ){
2026 u16 pageSize = *pPageSize;
2027 assert( pageSize==0 || (pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE) );
2028 if( pageSize && pageSize!=pPager->pageSize
2029 && (pPager->memDb==0 || pPager->dbSize==0)
2030 && sqlite3PcacheRefCount(pPager->pPCache)==0
2031 ){
2032 char *pNew = (char *)sqlite3PageMalloc(pageSize);
2033 if( !pNew ){
2034 rc = SQLITE_NOMEM;
2035 }else{
2036 pager_reset(pPager);
2037 pPager->pageSize = pageSize;
2038 if( !pPager->memDb ) setSectorSize(pPager);
2039 sqlite3PageFree(pPager->pTmpSpace);
2040 pPager->pTmpSpace = pNew;
2041 sqlite3PcacheSetPageSize(pPager->pPCache, pageSize);
2042 }
danielk1977a1644fd2007-08-29 12:31:25 +00002043 }
drh4f21c4a2008-12-10 22:15:00 +00002044 *pPageSize = (u16)pPager->pageSize;
drh1c7880e2005-05-20 20:01:55 +00002045 }
danielk1977a1644fd2007-08-29 12:31:25 +00002046 return rc;
drh90f5ecb2004-07-22 01:19:35 +00002047}
2048
2049/*
drh26b79942007-11-28 16:19:56 +00002050** Return a pointer to the "temporary page" buffer held internally
2051** by the pager. This is a buffer that is big enough to hold the
2052** entire content of a database page. This buffer is used internally
2053** during rollback and will be overwritten whenever a rollback
2054** occurs. But other modules are free to use it too, as long as
2055** no rollbacks are happening.
2056*/
2057void *sqlite3PagerTempSpace(Pager *pPager){
2058 return pPager->pTmpSpace;
2059}
2060
2061/*
drhf8e632b2007-05-08 14:51:36 +00002062** Attempt to set the maximum database page count if mxPage is positive.
2063** Make no changes if mxPage is zero or negative. And never reduce the
2064** maximum page count below the current size of the database.
2065**
2066** Regardless of mxPage, return the current maximum page count.
2067*/
2068int sqlite3PagerMaxPageCount(Pager *pPager, int mxPage){
2069 if( mxPage>0 ){
2070 pPager->mxPgno = mxPage;
2071 }
danielk1977ad0132d2008-06-07 08:58:22 +00002072 sqlite3PagerPagecount(pPager, 0);
drhf8e632b2007-05-08 14:51:36 +00002073 return pPager->mxPgno;
2074}
2075
2076/*
drhc9ac5ca2005-11-04 22:03:30 +00002077** The following set of routines are used to disable the simulated
2078** I/O error mechanism. These routines are used to avoid simulated
2079** errors in places where we do not care about errors.
2080**
2081** Unless -DSQLITE_TEST=1 is used, these routines are all no-ops
2082** and generate no code.
2083*/
2084#ifdef SQLITE_TEST
2085extern int sqlite3_io_error_pending;
2086extern int sqlite3_io_error_hit;
2087static int saved_cnt;
drhc9ac5ca2005-11-04 22:03:30 +00002088void disable_simulated_io_errors(void){
2089 saved_cnt = sqlite3_io_error_pending;
2090 sqlite3_io_error_pending = -1;
2091}
2092void enable_simulated_io_errors(void){
2093 sqlite3_io_error_pending = saved_cnt;
2094}
2095#else
drh152410f2005-11-05 15:11:22 +00002096# define disable_simulated_io_errors()
2097# define enable_simulated_io_errors()
drhc9ac5ca2005-11-04 22:03:30 +00002098#endif
2099
2100/*
drh90f5ecb2004-07-22 01:19:35 +00002101** Read the first N bytes from the beginning of the file into memory
danielk1977aef0bf62005-12-30 16:28:01 +00002102** that pDest points to.
2103**
2104** No error checking is done. The rational for this is that this function
2105** may be called even if the file does not exist or contain a header. In
2106** these cases sqlite3OsRead() will return an error, to which the correct
2107** response is to zero the memory at pDest and continue. A real IO error
2108** will presumably recur and be picked up later (Todo: Think about this).
drh90f5ecb2004-07-22 01:19:35 +00002109*/
danielk19773b8a05f2007-03-19 17:44:26 +00002110int sqlite3PagerReadFileheader(Pager *pPager, int N, unsigned char *pDest){
drh551b7732006-11-06 21:20:25 +00002111 int rc = SQLITE_OK;
drh90f5ecb2004-07-22 01:19:35 +00002112 memset(pDest, 0, N);
danielk1977b3175382008-10-17 18:51:52 +00002113 assert(pPager->fd->pMethods||pPager->tempFile);
danielk19777a2b1ee2007-08-21 14:27:01 +00002114 if( pPager->fd->pMethods ){
drhb0603412007-02-28 04:47:26 +00002115 IOTRACE(("DBHDR %p 0 %d\n", pPager, N))
danielk197762079062007-08-15 17:08:46 +00002116 rc = sqlite3OsRead(pPager->fd, pDest, N, 0);
drh551b7732006-11-06 21:20:25 +00002117 if( rc==SQLITE_IOERR_SHORT_READ ){
2118 rc = SQLITE_OK;
2119 }
drh90f5ecb2004-07-22 01:19:35 +00002120 }
drh551b7732006-11-06 21:20:25 +00002121 return rc;
drh90f5ecb2004-07-22 01:19:35 +00002122}
2123
2124/*
drh5e00f6c2001-09-13 13:46:56 +00002125** Return the total number of pages in the disk file associated with
danielk197715f411d2005-09-16 10:18:45 +00002126** pPager.
2127**
2128** If the PENDING_BYTE lies on the page directly after the end of the
2129** file, then consider this page part of the file too. For example, if
2130** PENDING_BYTE is byte 4096 (the first byte of page 5) and the size of the
2131** file is 4096 bytes, 5 is returned instead of 4.
drhed7c8552001-04-11 14:29:21 +00002132*/
danielk1977ad0132d2008-06-07 08:58:22 +00002133int sqlite3PagerPagecount(Pager *pPager, int *pnPage){
danielk19777a2b1ee2007-08-21 14:27:01 +00002134 i64 n = 0;
drhe49f9822006-09-15 12:29:16 +00002135 int rc;
drhd9b02572001-04-15 00:37:09 +00002136 assert( pPager!=0 );
drha7aea3d2007-03-15 12:51:16 +00002137 if( pPager->errCode ){
danielk19778c0a7912008-08-20 14:49:23 +00002138 rc = pPager->errCode;
danielk19778c0a7912008-08-20 14:49:23 +00002139 return rc;
drha7aea3d2007-03-15 12:51:16 +00002140 }
danielk1977d92db532008-11-17 04:56:24 +00002141 if( pPager->dbSizeValid ){
danielk197715f411d2005-09-16 10:18:45 +00002142 n = pPager->dbSize;
2143 } else {
danielk19777a2b1ee2007-08-21 14:27:01 +00002144 assert(pPager->fd->pMethods||pPager->tempFile);
2145 if( (pPager->fd->pMethods)
2146 && (rc = sqlite3OsFileSize(pPager->fd, &n))!=SQLITE_OK ){
drhe49f9822006-09-15 12:29:16 +00002147 pager_error(pPager, rc);
danielk1977ad0132d2008-06-07 08:58:22 +00002148 return rc;
danielk197715f411d2005-09-16 10:18:45 +00002149 }
2150 if( n>0 && n<pPager->pageSize ){
2151 n = 1;
2152 }else{
2153 n /= pPager->pageSize;
2154 }
2155 if( pPager->state!=PAGER_UNLOCK ){
drh4f21c4a2008-12-10 22:15:00 +00002156 pPager->dbSize = (int)n;
danielk1977d92db532008-11-17 04:56:24 +00002157 pPager->dbSizeValid = 1;
danielk197715f411d2005-09-16 10:18:45 +00002158 }
drhed7c8552001-04-11 14:29:21 +00002159 }
danielk197715f411d2005-09-16 10:18:45 +00002160 if( n==(PENDING_BYTE/pPager->pageSize) ){
drh1f595712004-06-15 01:40:29 +00002161 n++;
2162 }
drhf8e632b2007-05-08 14:51:36 +00002163 if( n>pPager->mxPgno ){
drh4f21c4a2008-12-10 22:15:00 +00002164 pPager->mxPgno = (Pgno)n;
drhf8e632b2007-05-08 14:51:36 +00002165 }
danielk1977ad0132d2008-06-07 08:58:22 +00002166 if( pnPage ){
drh4f21c4a2008-12-10 22:15:00 +00002167 *pnPage = (int)n;
danielk1977ad0132d2008-06-07 08:58:22 +00002168 }
2169 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +00002170}
2171
2172/*
drhf7c57532003-04-25 13:22:51 +00002173** Forward declaration
2174*/
danielk197776572402004-06-25 02:38:54 +00002175static int syncJournal(Pager*);
drhac69b052004-05-12 13:30:07 +00002176
2177/*
danielk1977e180dd92007-04-05 17:15:52 +00002178** This routine is used to truncate the cache when a database
2179** is truncated. Drop from the cache all pages whose pgno is
2180** larger than pPager->dbSize and is unreferenced.
2181**
drhac69b052004-05-12 13:30:07 +00002182** Referenced pages larger than pPager->dbSize are zeroed.
danielk1977e180dd92007-04-05 17:15:52 +00002183**
2184** Actually, at the point this routine is called, it would be
2185** an error to have a referenced page. But rather than delete
2186** that page and guarantee a subsequent segfault, it seems better
2187** to zero it and hope that we error out sanely.
drhac69b052004-05-12 13:30:07 +00002188*/
danielk1977e180dd92007-04-05 17:15:52 +00002189static void pager_truncate_cache(Pager *pPager){
danielk19778c0a7912008-08-20 14:49:23 +00002190 sqlite3PcacheTruncate(pPager->pPCache, pPager->dbSize);
drhac69b052004-05-12 13:30:07 +00002191}
2192
drhf7c57532003-04-25 13:22:51 +00002193/*
danielk197717221812005-02-15 03:38:05 +00002194** Try to obtain a lock on a file. Invoke the busy callback if the lock
drha4afb652005-07-09 02:16:02 +00002195** is currently not available. Repeat until the busy callback returns
danielk197717221812005-02-15 03:38:05 +00002196** false or until the lock succeeds.
2197**
2198** Return SQLITE_OK on success and an error code if we cannot obtain
2199** the lock.
2200*/
2201static int pager_wait_on_lock(Pager *pPager, int locktype){
2202 int rc;
drh1aa2d8b2007-01-03 15:34:29 +00002203
2204 /* The OS lock values must be the same as the Pager lock values */
danielk197717221812005-02-15 03:38:05 +00002205 assert( PAGER_SHARED==SHARED_LOCK );
2206 assert( PAGER_RESERVED==RESERVED_LOCK );
2207 assert( PAGER_EXCLUSIVE==EXCLUSIVE_LOCK );
drh1aa2d8b2007-01-03 15:34:29 +00002208
2209 /* If the file is currently unlocked then the size must be unknown */
danielk1977d92db532008-11-17 04:56:24 +00002210 assert( pPager->state>=PAGER_SHARED || pPager->dbSizeValid==0 );
drh1aa2d8b2007-01-03 15:34:29 +00002211
danielk197717221812005-02-15 03:38:05 +00002212 if( pPager->state>=locktype ){
2213 rc = SQLITE_OK;
2214 }else{
danielk197717221812005-02-15 03:38:05 +00002215 do {
drh054889e2005-11-30 03:20:31 +00002216 rc = sqlite3OsLock(pPager->fd, locktype);
danielk19771ceedd32008-11-19 10:22:33 +00002217 }while( rc==SQLITE_BUSY && pPager->xBusyHandler(pPager->pBusyHandlerArg) );
danielk197717221812005-02-15 03:38:05 +00002218 if( rc==SQLITE_OK ){
drh4f21c4a2008-12-10 22:15:00 +00002219 pPager->state = (u8)locktype;
drhb0603412007-02-28 04:47:26 +00002220 IOTRACE(("LOCK %p %d\n", pPager, locktype))
danielk197717221812005-02-15 03:38:05 +00002221 }
2222 }
2223 return rc;
2224}
2225
2226/*
drhf7c57532003-04-25 13:22:51 +00002227** Truncate the file to the number of pages specified.
2228*/
danielk19773b8a05f2007-03-19 17:44:26 +00002229int sqlite3PagerTruncate(Pager *pPager, Pgno nPage){
danielk19778c0a7912008-08-20 14:49:23 +00002230 int rc = SQLITE_OK;
danielk1977b3175382008-10-17 18:51:52 +00002231 assert( pPager->state>=PAGER_SHARED );
danielk19778c0a7912008-08-20 14:49:23 +00002232
danielk1977ad0132d2008-06-07 08:58:22 +00002233 sqlite3PagerPagecount(pPager, 0);
danielk1977efaaf572006-01-16 11:29:19 +00002234 if( pPager->errCode ){
2235 rc = pPager->errCode;
danielk1977d92db532008-11-17 04:56:24 +00002236 }else if( nPage<pPager->dbSize ){
danielk1977b3175382008-10-17 18:51:52 +00002237 rc = syncJournal(pPager);
2238 if( rc==SQLITE_OK ){
2239 /* Get an exclusive lock on the database before truncating. */
2240 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
2241 }
2242 if( rc==SQLITE_OK ){
2243 rc = pager_truncate(pPager, nPage);
danielk19778c0a7912008-08-20 14:49:23 +00002244 }
danielk1977369f27e2004-06-15 11:40:04 +00002245 }
danielk197717221812005-02-15 03:38:05 +00002246
drhf7c57532003-04-25 13:22:51 +00002247 return rc;
2248}
2249
2250/*
drhed7c8552001-04-11 14:29:21 +00002251** Shutdown the page cache. Free all memory and close all files.
2252**
2253** If a transaction was in progress when this routine is called, that
2254** transaction is rolled back. All outstanding pages are invalidated
2255** and their memory is freed. Any attempt to use a page associated
2256** with this page cache after this function returns will likely
2257** result in a coredump.
danielk1977aef0bf62005-12-30 16:28:01 +00002258**
2259** This function always succeeds. If a transaction is active an attempt
2260** is made to roll it back. If an error occurs during the rollback
2261** a hot journal may be left in the filesystem but no error is returned
2262** to the caller.
drhed7c8552001-04-11 14:29:21 +00002263*/
danielk19773b8a05f2007-03-19 17:44:26 +00002264int sqlite3PagerClose(Pager *pPager){
danielk197713f72992005-12-18 08:51:22 +00002265
drhbafda092007-01-03 23:36:22 +00002266 disable_simulated_io_errors();
danielk19772d1d86f2008-06-20 14:59:51 +00002267 sqlite3BeginBenignMalloc();
drhc2ee76c2007-01-04 14:58:14 +00002268 pPager->errCode = 0;
danielk197741483462007-03-24 16:45:04 +00002269 pPager->exclusiveMode = 0;
drhbafda092007-01-03 23:36:22 +00002270 pager_reset(pPager);
danielk1977b3175382008-10-17 18:51:52 +00002271 if( !MEMDB ){
2272 pagerUnlockAndRollback(pPager);
2273 }
drhbafda092007-01-03 23:36:22 +00002274 enable_simulated_io_errors();
danielk19772d1d86f2008-06-20 14:59:51 +00002275 sqlite3EndBenignMalloc();
drh4f0c5872007-03-26 22:05:01 +00002276 PAGERTRACE2("CLOSE %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002277 IOTRACE(("CLOSE %p\n", pPager))
danielk1977e94ddc92005-03-21 03:53:38 +00002278 if( pPager->journalOpen ){
danielk1977b4b47412007-08-17 15:53:36 +00002279 sqlite3OsClose(pPager->jfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002280 }
drhf5e7bb52008-02-18 14:47:33 +00002281 sqlite3BitvecDestroy(pPager->pInJournal);
danielk1977a1fa00d2008-08-27 15:16:33 +00002282 sqlite3BitvecDestroy(pPager->pAlwaysRollback);
danielk1977fd7f0452008-12-17 17:30:26 +00002283 releaseAllSavepoint(pPager);
danielk1977b4b47412007-08-17 15:53:36 +00002284 sqlite3OsClose(pPager->fd);
drh0f892532002-05-30 12:27:03 +00002285 /* Temp files are automatically deleted by the OS
2286 ** if( pPager->tempFile ){
drh66560ad2006-01-06 14:32:19 +00002287 ** sqlite3OsDelete(pPager->zFilename);
drh0f892532002-05-30 12:27:03 +00002288 ** }
2289 */
danielk1977aca790a2005-01-13 11:07:52 +00002290
drhfacf0302008-06-17 15:12:00 +00002291 sqlite3PageFree(pPager->pTmpSpace);
danielk19778c0a7912008-08-20 14:49:23 +00002292 sqlite3PcacheClose(pPager->pPCache);
drh17435752007-08-16 04:30:38 +00002293 sqlite3_free(pPager);
drhed7c8552001-04-11 14:29:21 +00002294 return SQLITE_OK;
2295}
2296
drh87cc3b32007-05-08 21:45:27 +00002297#if !defined(NDEBUG) || defined(SQLITE_TEST)
drhed7c8552001-04-11 14:29:21 +00002298/*
drh5e00f6c2001-09-13 13:46:56 +00002299** Return the page number for the given page data.
drhed7c8552001-04-11 14:29:21 +00002300*/
danielk19773b8a05f2007-03-19 17:44:26 +00002301Pgno sqlite3PagerPagenumber(DbPage *p){
drhed7c8552001-04-11 14:29:21 +00002302 return p->pgno;
2303}
drh87cc3b32007-05-08 21:45:27 +00002304#endif
drhed7c8552001-04-11 14:29:21 +00002305
2306/*
drhdf0b3b02001-06-23 11:36:20 +00002307** Increment the reference count for a page. The input pointer is
2308** a reference to the page data.
2309*/
danielk19773b8a05f2007-03-19 17:44:26 +00002310int sqlite3PagerRef(DbPage *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00002311 sqlite3PcacheRef(pPg);
drh8c42ca92001-06-22 19:15:00 +00002312 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +00002313}
2314
2315/*
drh34e79ce2004-02-08 06:05:46 +00002316** Sync the journal. In other words, make sure all the pages that have
2317** been written to the journal have actually reached the surface of the
2318** disk. It is not safe to modify the original database file until after
2319** the journal has been synced. If the original database is modified before
2320** the journal is synced and a power failure occurs, the unsynced journal
2321** data would be lost and we would be unable to completely rollback the
2322** database changes. Database corruption would occur.
2323**
2324** This routine also updates the nRec field in the header of the journal.
2325** (See comments on the pager_playback() routine for additional information.)
2326** If the sync mode is FULL, two syncs will occur. First the whole journal
2327** is synced, then the nRec field is updated, then a second sync occurs.
drhb19a2bc2001-09-16 00:13:26 +00002328**
drh34e79ce2004-02-08 06:05:46 +00002329** For temporary databases, we do not care if we are able to rollback
danielk19774cd2cd52007-08-23 14:48:23 +00002330** after a power failure, so no sync occurs.
2331**
2332** If the IOCAP_SEQUENTIAL flag is set for the persistent media on which
2333** the database is stored, then OsSync() is never called on the journal
2334** file. In this case all that is required is to update the nRec field in
2335** the journal header.
drhfa86c412002-02-02 15:01:15 +00002336**
drh34e79ce2004-02-08 06:05:46 +00002337** This routine clears the needSync field of every page current held in
2338** memory.
drh50e5dad2001-09-15 00:57:28 +00002339*/
danielk197776572402004-06-25 02:38:54 +00002340static int syncJournal(Pager *pPager){
drh50e5dad2001-09-15 00:57:28 +00002341 int rc = SQLITE_OK;
drh03eb96a2002-11-10 23:32:56 +00002342
2343 /* Sync the journal before modifying the main database
2344 ** (assuming there is a journal and it needs to be synced.)
2345 */
danielk197776572402004-06-25 02:38:54 +00002346 if( pPager->needSync ){
danielk1977b3175382008-10-17 18:51:52 +00002347 assert( !pPager->tempFile );
2348 if( pPager->journalMode!=PAGER_JOURNALMODE_MEMORY ){
danielk19774cd2cd52007-08-23 14:48:23 +00002349 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
drhdb48ee02003-01-16 13:42:43 +00002350 assert( pPager->journalOpen );
danielk19774cd2cd52007-08-23 14:48:23 +00002351
danielk19774cd2cd52007-08-23 14:48:23 +00002352 if( 0==(iDc&SQLITE_IOCAP_SAFE_APPEND) ){
danielk197776572402004-06-25 02:38:54 +00002353 /* Write the nRec value into the journal file header. If in
2354 ** full-synchronous mode, sync the journal first. This ensures that
2355 ** all data has really hit the disk before nRec is updated to mark
danielk19774cd2cd52007-08-23 14:48:23 +00002356 ** it as a candidate for rollback.
2357 **
2358 ** This is not required if the persistent media supports the
2359 ** SAFE_APPEND property. Because in this case it is not possible
2360 ** for garbage data to be appended to the file, the nRec field
2361 ** is populated with 0xFFFFFFFF when the journal header is written
2362 ** and never needs to be updated.
danielk197776572402004-06-25 02:38:54 +00002363 */
danielk19774cd2cd52007-08-23 14:48:23 +00002364 i64 jrnlOff;
2365 if( pPager->fullSync && 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
drh4f0c5872007-03-26 22:05:01 +00002366 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002367 IOTRACE(("JSYNC %p\n", pPager))
danielk1977f036aef2007-08-20 05:36:51 +00002368 rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags);
drhd8d66e82003-02-12 02:10:15 +00002369 if( rc!=0 ) return rc;
2370 }
danielk197713adf8a2004-06-03 16:08:41 +00002371
danielk197762079062007-08-15 17:08:46 +00002372 jrnlOff = pPager->journalHdr + sizeof(aJournalMagic);
2373 IOTRACE(("JHDR %p %lld %d\n", pPager, jrnlOff, 4));
2374 rc = write32bits(pPager->jfd, jrnlOff, pPager->nRec);
drhb4746b92005-09-09 01:32:06 +00002375 if( rc ) return rc;
drh968af522003-02-11 14:55:40 +00002376 }
danielk19774cd2cd52007-08-23 14:48:23 +00002377 if( 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
2378 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
2379 IOTRACE(("JSYNC %p\n", pPager))
2380 rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags|
2381 (pPager->sync_flags==SQLITE_SYNC_FULL?SQLITE_SYNC_DATAONLY:0)
2382 );
2383 if( rc!=0 ) return rc;
2384 }
drhdb48ee02003-01-16 13:42:43 +00002385 pPager->journalStarted = 1;
drhfa86c412002-02-02 15:01:15 +00002386 }
drh50e5dad2001-09-15 00:57:28 +00002387 pPager->needSync = 0;
drh341eae82003-01-21 02:39:36 +00002388
2389 /* Erase the needSync flag from every page.
2390 */
danielk1977bc2ca9e2008-11-13 14:28:28 +00002391 sqlite3PcacheClearSyncFlags(pPager->pPCache);
drh50e5dad2001-09-15 00:57:28 +00002392 }
drh03eb96a2002-11-10 23:32:56 +00002393
drh81a20f22001-10-12 17:30:04 +00002394 return rc;
drh50e5dad2001-09-15 00:57:28 +00002395}
2396
2397/*
drh2554f8b2003-01-22 01:26:44 +00002398** Given a list of pages (connected by the PgHdr.pDirty pointer) write
danielk1977a858aa22008-08-22 16:22:17 +00002399** every one of those pages out to the database file. No calls are made
2400** to the page-cache to mark the pages as clean. It is the responsibility
2401** of the caller to use PcacheCleanAll() or PcacheMakeClean() to mark
2402** the pages as clean.
drh2554f8b2003-01-22 01:26:44 +00002403*/
2404static int pager_write_pagelist(PgHdr *pList){
2405 Pager *pPager;
2406 int rc;
2407
2408 if( pList==0 ) return SQLITE_OK;
2409 pPager = pList->pPager;
danielk19779eed5052004-06-04 10:38:30 +00002410
2411 /* At this point there may be either a RESERVED or EXCLUSIVE lock on the
2412 ** database file. If there is already an EXCLUSIVE lock, the following
drh054889e2005-11-30 03:20:31 +00002413 ** calls to sqlite3OsLock() are no-ops.
danielk19779eed5052004-06-04 10:38:30 +00002414 **
drha6abd042004-06-09 17:37:22 +00002415 ** Moving the lock from RESERVED to EXCLUSIVE actually involves going
2416 ** through an intermediate state PENDING. A PENDING lock prevents new
2417 ** readers from attaching to the database but is unsufficient for us to
2418 ** write. The idea of a PENDING lock is to prevent new readers from
2419 ** coming in while we wait for existing readers to clear.
danielk19779eed5052004-06-04 10:38:30 +00002420 **
drha6abd042004-06-09 17:37:22 +00002421 ** While the pager is in the RESERVED state, the original database file
2422 ** is unchanged and we can rollback without having to playback the
2423 ** journal into the original database file. Once we transition to
2424 ** EXCLUSIVE, it means the database file has been changed and any rollback
2425 ** will require a journal playback.
danielk19779eed5052004-06-04 10:38:30 +00002426 */
drh684917c2004-10-05 02:41:42 +00002427 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
danielk19779eed5052004-06-04 10:38:30 +00002428 if( rc!=SQLITE_OK ){
2429 return rc;
2430 }
2431
drh2554f8b2003-01-22 01:26:44 +00002432 while( pList ){
danielk19777a2b1ee2007-08-21 14:27:01 +00002433
2434 /* If the file has not yet been opened, open it now. */
2435 if( !pPager->fd->pMethods ){
2436 assert(pPager->tempFile);
danielk197717b90b52008-06-06 11:11:25 +00002437 rc = sqlite3PagerOpentemp(pPager, pPager->fd, pPager->vfsFlags);
danielk19777a2b1ee2007-08-21 14:27:01 +00002438 if( rc ) return rc;
2439 }
2440
danielk1977687566d2004-11-02 12:56:41 +00002441 /* If there are dirty pages in the page cache with page numbers greater
danielk19773b8a05f2007-03-19 17:44:26 +00002442 ** than Pager.dbSize, this means sqlite3PagerTruncate() was called to
danielk1977687566d2004-11-02 12:56:41 +00002443 ** make the file smaller (presumably by auto-vacuum code). Do not write
2444 ** any such pages to the file.
2445 */
danielk197733e32162008-08-23 18:53:08 +00002446 if( pList->pgno<=pPager->dbSize && 0==(pList->flags&PGHDR_DONT_WRITE) ){
danielk197762079062007-08-15 17:08:46 +00002447 i64 offset = (pList->pgno-1)*(i64)pPager->pageSize;
danielk19778c0a7912008-08-20 14:49:23 +00002448 char *pData = CODEC2(pPager, pList->pData, pList->pgno, 6);
danielk197712dd5492008-12-18 15:45:07 +00002449
drh477731b2007-06-16 03:06:27 +00002450 PAGERTRACE4("STORE %d page %d hash(%08x)\n",
2451 PAGERID(pPager), pList->pgno, pager_pagehash(pList));
drh538f5702007-04-13 02:14:30 +00002452 IOTRACE(("PGOUT %p %d\n", pPager, pList->pgno));
danielk197762079062007-08-15 17:08:46 +00002453 rc = sqlite3OsWrite(pPager->fd, pData, pPager->pageSize, offset);
drh538f5702007-04-13 02:14:30 +00002454 PAGER_INCR(sqlite3_pager_writedb_count);
2455 PAGER_INCR(pPager->nWrite);
drh86a88112007-04-16 15:02:19 +00002456 if( pList->pgno==1 ){
2457 memcpy(&pPager->dbFileVers, &pData[24], sizeof(pPager->dbFileVers));
2458 }
danielk1977687566d2004-11-02 12:56:41 +00002459 }
2460#ifndef NDEBUG
2461 else{
drh4f0c5872007-03-26 22:05:01 +00002462 PAGERTRACE3("NOSTORE %d page %d\n", PAGERID(pPager), pList->pgno);
danielk1977687566d2004-11-02 12:56:41 +00002463 }
2464#endif
drh2554f8b2003-01-22 01:26:44 +00002465 if( rc ) return rc;
danielk19773c407372005-02-15 02:54:14 +00002466#ifdef SQLITE_CHECK_PAGES
2467 pList->pageHash = pager_pagehash(pList);
2468#endif
drh2554f8b2003-01-22 01:26:44 +00002469 pList = pList->pDirty;
2470 }
danielk19778c0a7912008-08-20 14:49:23 +00002471
drh2554f8b2003-01-22 01:26:44 +00002472 return SQLITE_OK;
2473}
2474
2475/*
danielk19778c0a7912008-08-20 14:49:23 +00002476** This function is called by the pcache layer when it has reached some
2477** soft memory limit. The argument is a pointer to a purgeable Pager
2478** object. This function attempts to make a single dirty page that has no
2479** outstanding references (if one exists) clean so that it can be recycled
2480** by the pcache layer.
drh2554f8b2003-01-22 01:26:44 +00002481*/
danielk1977a858aa22008-08-22 16:22:17 +00002482static int pagerStress(void *p, PgHdr *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00002483 Pager *pPager = (Pager *)p;
danielk19778c0a7912008-08-20 14:49:23 +00002484 int rc = SQLITE_OK;
drh8f2e9a12008-02-26 14:46:04 +00002485
danielk19778c200142008-08-25 07:12:28 +00002486 if( pPager->doNotSync ){
2487 return SQLITE_OK;
2488 }
2489
danielk1977a858aa22008-08-22 16:22:17 +00002490 assert( pPg->flags&PGHDR_DIRTY );
2491 if( pPager->errCode==SQLITE_OK ){
2492 if( pPg->flags&PGHDR_NEED_SYNC ){
2493 rc = syncJournal(pPager);
2494 if( rc==SQLITE_OK && pPager->fullSync &&
danielk1977b3175382008-10-17 18:51:52 +00002495 !(pPager->journalMode==PAGER_JOURNALMODE_MEMORY) &&
danielk1977a858aa22008-08-22 16:22:17 +00002496 !(sqlite3OsDeviceCharacteristics(pPager->fd)&SQLITE_IOCAP_SAFE_APPEND)
2497 ){
2498 pPager->nRec = 0;
2499 rc = writeJournalHdr(pPager);
danielk19778c0a7912008-08-20 14:49:23 +00002500 }
danielk19778c0a7912008-08-20 14:49:23 +00002501 }
danielk1977a858aa22008-08-22 16:22:17 +00002502 if( rc==SQLITE_OK ){
2503 pPg->pDirty = 0;
2504 rc = pager_write_pagelist(pPg);
2505 }
2506 if( rc!=SQLITE_OK ){
2507 pager_error(pPager, rc);
2508 }
2509 }
2510
2511 if( rc==SQLITE_OK ){
2512 sqlite3PcacheMakeClean(pPg);
danielk19778c0a7912008-08-20 14:49:23 +00002513 }
2514 return rc;
drh2554f8b2003-01-22 01:26:44 +00002515}
2516
danielk19778c0a7912008-08-20 14:49:23 +00002517
drh2554f8b2003-01-22 01:26:44 +00002518/*
drh19db9352008-03-27 22:42:51 +00002519** Return 1 if there is a hot journal on the given pager.
drh165ffe92005-03-15 17:09:30 +00002520** A hot journal is one that needs to be played back.
2521**
2522** If the current size of the database file is 0 but a journal file
2523** exists, that is probably an old journal left over from a prior
2524** database with the same name. Just delete the journal.
drh19db9352008-03-27 22:42:51 +00002525**
2526** Return negative if unable to determine the status of the journal.
drh82ed1e52008-04-25 12:25:42 +00002527**
2528** This routine does not open the journal file to examine its
2529** content. Hence, the journal might contain the name of a master
2530** journal file that has been deleted, and hence not be hot. Or
2531** the header of the journal might be zeroed out. This routine
2532** does not discover these cases of a non-hot journal - if the
2533** journal file exists and is not empty this routine assumes it
2534** is hot. The pager_playback() routine will discover that the
2535** journal file is not really hot and will no-op.
drh165ffe92005-03-15 17:09:30 +00002536*/
danielk1977d300b8a2008-08-01 10:50:23 +00002537static int hasHotJournal(Pager *pPager, int *pExists){
danielk1977b4b47412007-08-17 15:53:36 +00002538 sqlite3_vfs *pVfs = pPager->pVfs;
danielk1977d300b8a2008-08-01 10:50:23 +00002539 int rc = SQLITE_OK;
drhea678832008-12-10 19:26:22 +00002540 int exists = 0;
2541 int locked = 0;
drh0a846f92008-08-25 17:23:29 +00002542 assert( pPager!=0 );
2543 assert( pPager->useJournal );
2544 assert( pPager->fd->pMethods );
danielk1977d300b8a2008-08-01 10:50:23 +00002545 *pExists = 0;
drh0a846f92008-08-25 17:23:29 +00002546 rc = sqlite3OsAccess(pVfs, pPager->zJournal, SQLITE_ACCESS_EXISTS, &exists);
2547 if( rc==SQLITE_OK && exists ){
2548 rc = sqlite3OsCheckReservedLock(pPager->fd, &locked);
2549 }
2550 if( rc==SQLITE_OK && exists && !locked ){
2551 int nPage;
2552 rc = sqlite3PagerPagecount(pPager, &nPage);
2553 if( rc==SQLITE_OK ){
2554 if( nPage==0 ){
2555 sqlite3OsDelete(pVfs, pPager->zJournal, 0);
2556 }else{
2557 *pExists = 1;
danielk1977861f7452008-06-05 11:39:11 +00002558 }
2559 }
drhbb5f18d2007-04-06 18:23:17 +00002560 }
danielk1977d300b8a2008-08-01 10:50:23 +00002561 return rc;
drh165ffe92005-03-15 17:09:30 +00002562}
2563
2564/*
danielk1977e180dd92007-04-05 17:15:52 +00002565** Read the content of page pPg out of the database file.
2566*/
2567static int readDbPage(Pager *pPager, PgHdr *pPg, Pgno pgno){
2568 int rc;
danielk197762079062007-08-15 17:08:46 +00002569 i64 offset;
danielk1977e180dd92007-04-05 17:15:52 +00002570 assert( MEMDB==0 );
danielk19777a2b1ee2007-08-21 14:27:01 +00002571 assert(pPager->fd->pMethods||pPager->tempFile);
2572 if( !pPager->fd->pMethods ){
2573 return SQLITE_IOERR_SHORT_READ;
2574 }
danielk197762079062007-08-15 17:08:46 +00002575 offset = (pgno-1)*(i64)pPager->pageSize;
danielk19778c0a7912008-08-20 14:49:23 +00002576 rc = sqlite3OsRead(pPager->fd, pPg->pData, pPager->pageSize, offset);
drh538f5702007-04-13 02:14:30 +00002577 PAGER_INCR(sqlite3_pager_readdb_count);
2578 PAGER_INCR(pPager->nRead);
2579 IOTRACE(("PGIN %p %d\n", pPager, pgno));
drh86a88112007-04-16 15:02:19 +00002580 if( pgno==1 ){
danielk19778c0a7912008-08-20 14:49:23 +00002581 memcpy(&pPager->dbFileVers, &((u8*)pPg->pData)[24],
drh86a88112007-04-16 15:02:19 +00002582 sizeof(pPager->dbFileVers));
2583 }
danielk197730849522008-08-21 04:35:18 +00002584 CODEC1(pPager, pPg->pData, pPg->pgno, 3);
drh477731b2007-06-16 03:06:27 +00002585 PAGERTRACE4("FETCH %d page %d hash(%08x)\n",
2586 PAGERID(pPager), pPg->pgno, pager_pagehash(pPg));
danielk1977e180dd92007-04-05 17:15:52 +00002587 return rc;
2588}
2589
2590
2591/*
danielk1977e277be02007-03-23 18:12:06 +00002592** This function is called to obtain the shared lock required before
2593** data may be read from the pager cache. If the shared lock has already
2594** been obtained, this function is a no-op.
danielk1977393f0682007-03-31 10:00:48 +00002595**
2596** Immediately after obtaining the shared lock (if required), this function
2597** checks for a hot-journal file. If one is found, an emergency rollback
2598** is performed immediately.
danielk1977e277be02007-03-23 18:12:06 +00002599*/
2600static int pagerSharedLock(Pager *pPager){
2601 int rc = SQLITE_OK;
danielk1977d300b8a2008-08-01 10:50:23 +00002602 int isErrorReset = 0;
danielk1977e277be02007-03-23 18:12:06 +00002603
danielk1977ae72d982007-10-03 08:46:44 +00002604 /* If this database is opened for exclusive access, has no outstanding
2605 ** page references and is in an error-state, now is the chance to clear
2606 ** the error. Discard the contents of the pager-cache and treat any
2607 ** open journal file as a hot-journal.
2608 */
danielk19778c0a7912008-08-20 14:49:23 +00002609 if( !MEMDB && pPager->exclusiveMode
2610 && sqlite3PcacheRefCount(pPager->pPCache)==0 && pPager->errCode
2611 ){
danielk1977ae72d982007-10-03 08:46:44 +00002612 if( pPager->journalOpen ){
danielk1977d300b8a2008-08-01 10:50:23 +00002613 isErrorReset = 1;
danielk1977ae72d982007-10-03 08:46:44 +00002614 }
danielk1977ae72d982007-10-03 08:46:44 +00002615 pPager->errCode = SQLITE_OK;
danielk197793f7af92008-05-09 16:57:50 +00002616 pager_reset(pPager);
danielk1977ae72d982007-10-03 08:46:44 +00002617 }
2618
2619 /* If the pager is still in an error state, do not proceed. The error
2620 ** state will be cleared at some point in the future when all page
2621 ** references are dropped and the cache can be discarded.
2622 */
2623 if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
2624 return pPager->errCode;
2625 }
2626
danielk1977d300b8a2008-08-01 10:50:23 +00002627 if( pPager->state==PAGER_UNLOCK || isErrorReset ){
danielk1977b4b47412007-08-17 15:53:36 +00002628 sqlite3_vfs *pVfs = pPager->pVfs;
drh4f21c4a2008-12-10 22:15:00 +00002629 int isHotJournal = 0;
shane049fc212008-10-22 16:26:47 +00002630 assert( !MEMDB );
danielk1977b3175382008-10-17 18:51:52 +00002631 assert( sqlite3PcacheRefCount(pPager->pPCache)==0 );
2632 if( !pPager->noReadlock ){
2633 rc = pager_wait_on_lock(pPager, SHARED_LOCK);
2634 if( rc!=SQLITE_OK ){
2635 assert( pPager->state==PAGER_UNLOCK );
2636 return pager_error(pPager, rc);
danielk1977e277be02007-03-23 18:12:06 +00002637 }
danielk1977b3175382008-10-17 18:51:52 +00002638 assert( pPager->state>=SHARED_LOCK );
2639 }
2640
2641 /* If a journal file exists, and there is no RESERVED lock on the
2642 ** database file, then it either needs to be played back or deleted.
2643 */
2644 if( !isErrorReset ){
2645 rc = hasHotJournal(pPager, &isHotJournal);
2646 if( rc!=SQLITE_OK ){
2647 goto failed;
2648 }
2649 }
2650 if( isErrorReset || isHotJournal ){
2651 /* Get an EXCLUSIVE lock on the database file. At this point it is
2652 ** important that a RESERVED lock is not obtained on the way to the
2653 ** EXCLUSIVE lock. If it were, another process might open the
2654 ** database file, detect the RESERVED lock, and conclude that the
2655 ** database is safe to read while this process is still rolling it
2656 ** back.
2657 **
2658 ** Because the intermediate RESERVED lock is not requested, the
2659 ** second process will get to this point in the code and fail to
2660 ** obtain its own EXCLUSIVE lock on the database file.
danielk1977e277be02007-03-23 18:12:06 +00002661 */
danielk1977b3175382008-10-17 18:51:52 +00002662 if( pPager->state<EXCLUSIVE_LOCK ){
2663 rc = sqlite3OsLock(pPager->fd, EXCLUSIVE_LOCK);
danielk1977e277be02007-03-23 18:12:06 +00002664 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00002665 rc = pager_error(pPager, rc);
2666 goto failed;
danielk1977e277be02007-03-23 18:12:06 +00002667 }
danielk1977b3175382008-10-17 18:51:52 +00002668 pPager->state = PAGER_EXCLUSIVE;
2669 }
2670
2671 /* Open the journal for read/write access. This is because in
2672 ** exclusive-access mode the file descriptor will be kept open and
2673 ** possibly used for a transaction later on. On some systems, the
2674 ** OsTruncate() call used in exclusive-access mode also requires
2675 ** a read/write file handle.
2676 */
2677 if( !isErrorReset && pPager->journalOpen==0 ){
2678 int res;
2679 rc = sqlite3OsAccess(pVfs,pPager->zJournal,SQLITE_ACCESS_EXISTS,&res);
2680 if( rc==SQLITE_OK ){
2681 if( res ){
2682 int fout = 0;
2683 int f = SQLITE_OPEN_READWRITE|SQLITE_OPEN_MAIN_JOURNAL;
2684 assert( !pPager->tempFile );
2685 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, f, &fout);
2686 assert( rc!=SQLITE_OK || pPager->jfd->pMethods );
danielk1977281d8bd2008-10-29 07:01:56 +00002687 if( rc==SQLITE_OK && fout&SQLITE_OPEN_READONLY ){
2688 rc = SQLITE_CANTOPEN;
danielk1977b3175382008-10-17 18:51:52 +00002689 sqlite3OsClose(pPager->jfd);
2690 }
2691 }else{
2692 /* If the journal does not exist, that means some other process
2693 ** has already rolled it back */
2694 rc = SQLITE_BUSY;
2695 }
2696 }
2697 }
2698 if( rc!=SQLITE_OK ){
danielk1977b3175382008-10-17 18:51:52 +00002699 goto failed;
2700 }
2701 pPager->journalOpen = 1;
2702 pPager->journalStarted = 0;
2703 pPager->journalOff = 0;
2704 pPager->setMaster = 0;
2705 pPager->journalHdr = 0;
2706
2707 /* Playback and delete the journal. Drop the database write
2708 ** lock and reacquire the read lock.
2709 */
2710 rc = pager_playback(pPager, 1);
2711 if( rc!=SQLITE_OK ){
2712 rc = pager_error(pPager, rc);
2713 goto failed;
2714 }
2715 assert(pPager->state==PAGER_SHARED ||
2716 (pPager->exclusiveMode && pPager->state>PAGER_SHARED)
2717 );
2718 }
2719
2720 if( sqlite3PcachePagecount(pPager->pPCache)>0 ){
2721 /* The shared-lock has just been acquired on the database file
2722 ** and there are already pages in the cache (from a previous
2723 ** read or write transaction). Check to see if the database
2724 ** has been modified. If the database has changed, flush the
2725 ** cache.
2726 **
2727 ** Database changes is detected by looking at 15 bytes beginning
2728 ** at offset 24 into the file. The first 4 of these 16 bytes are
2729 ** a 32-bit counter that is incremented with each change. The
2730 ** other bytes change randomly with each file change when
2731 ** a codec is in use.
2732 **
2733 ** There is a vanishingly small chance that a change will not be
2734 ** detected. The chance of an undetected change is so small that
2735 ** it can be neglected.
2736 */
2737 char dbFileVers[sizeof(pPager->dbFileVers)];
2738 sqlite3PagerPagecount(pPager, 0);
2739
2740 if( pPager->errCode ){
2741 rc = pPager->errCode;
2742 goto failed;
danielk1977e277be02007-03-23 18:12:06 +00002743 }
2744
danielk1977d92db532008-11-17 04:56:24 +00002745 assert( pPager->dbSizeValid );
danielk1977b3175382008-10-17 18:51:52 +00002746 if( pPager->dbSize>0 ){
2747 IOTRACE(("CKVERS %p %d\n", pPager, sizeof(dbFileVers)));
2748 rc = sqlite3OsRead(pPager->fd, &dbFileVers, sizeof(dbFileVers), 24);
2749 if( rc!=SQLITE_OK ){
danielk197752b472a2008-05-05 16:23:55 +00002750 goto failed;
danielk1977e277be02007-03-23 18:12:06 +00002751 }
danielk1977b3175382008-10-17 18:51:52 +00002752 }else{
2753 memset(dbFileVers, 0, sizeof(dbFileVers));
2754 }
danielk1977e277be02007-03-23 18:12:06 +00002755
danielk1977b3175382008-10-17 18:51:52 +00002756 if( memcmp(pPager->dbFileVers, dbFileVers, sizeof(dbFileVers))!=0 ){
2757 pager_reset(pPager);
danielk1977e277be02007-03-23 18:12:06 +00002758 }
2759 }
danielk1977c5859712007-03-26 12:26:27 +00002760 assert( pPager->exclusiveMode || pPager->state<=PAGER_SHARED );
2761 if( pPager->state==PAGER_UNLOCK ){
2762 pPager->state = PAGER_SHARED;
2763 }
danielk1977e277be02007-03-23 18:12:06 +00002764 }
2765
danielk197752b472a2008-05-05 16:23:55 +00002766 failed:
2767 if( rc!=SQLITE_OK ){
2768 /* pager_unlock() is a no-op for exclusive mode and in-memory databases. */
2769 pager_unlock(pPager);
2770 }
danielk1977e277be02007-03-23 18:12:06 +00002771 return rc;
2772}
2773
2774/*
drhd33d5a82007-04-26 12:11:28 +00002775** Make sure we have the content for a page. If the page was
2776** previously acquired with noContent==1, then the content was
2777** just initialized to zeros instead of being read from disk.
2778** But now we need the real data off of disk. So make sure we
2779** have it. Read it in if we do not have it already.
2780*/
2781static int pager_get_content(PgHdr *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00002782 if( pPg->flags&PGHDR_NEED_READ ){
drhd33d5a82007-04-26 12:11:28 +00002783 int rc = readDbPage(pPg->pPager, pPg, pPg->pgno);
2784 if( rc==SQLITE_OK ){
danielk19778c0a7912008-08-20 14:49:23 +00002785 pPg->flags &= ~PGHDR_NEED_READ;
drhd33d5a82007-04-26 12:11:28 +00002786 }else{
2787 return rc;
2788 }
2789 }
2790 return SQLITE_OK;
2791}
2792
2793/*
danielk19778c0a7912008-08-20 14:49:23 +00002794** If the reference count has reached zero, and the pager is not in the
2795** middle of a write transaction or opened in exclusive mode, unlock it.
2796*/
2797static void pagerUnlockIfUnused(Pager *pPager){
2798 if( (sqlite3PcacheRefCount(pPager->pPCache)==0)
2799 && (!pPager->exclusiveMode || pPager->journalOff>0)
2800 ){
2801 pagerUnlockAndRollback(pPager);
2802 }
2803}
2804
2805/*
2806** Drop a page from the cache using sqlite3PcacheDrop().
2807**
2808** If this means there are now no pages with references to them, a rollback
2809** occurs and the lock on the database is removed.
2810*/
2811static void pagerDropPage(DbPage *pPg){
2812 Pager *pPager = pPg->pPager;
2813 sqlite3PcacheDrop(pPg);
2814 pagerUnlockIfUnused(pPager);
2815}
2816
2817/*
drhd9b02572001-04-15 00:37:09 +00002818** Acquire a page.
2819**
drh58a11682001-11-10 13:51:08 +00002820** A read lock on the disk file is obtained when the first page is acquired.
drh5e00f6c2001-09-13 13:46:56 +00002821** This read lock is dropped when the last page is released.
drhd9b02572001-04-15 00:37:09 +00002822**
drhd33d5a82007-04-26 12:11:28 +00002823** This routine works for any page number greater than 0. If the database
drh306dc212001-05-21 13:45:10 +00002824** file is smaller than the requested page, then no actual disk
2825** read occurs and the memory image of the page is initialized to
2826** all zeros. The extra data appended to a page is always initialized
2827** to zeros the first time a page is loaded into memory.
2828**
drhd9b02572001-04-15 00:37:09 +00002829** The acquisition might fail for several reasons. In all cases,
2830** an appropriate error code is returned and *ppPage is set to NULL.
drh7e3b0a02001-04-28 16:52:40 +00002831**
drhd33d5a82007-04-26 12:11:28 +00002832** See also sqlite3PagerLookup(). Both this routine and Lookup() attempt
drh7e3b0a02001-04-28 16:52:40 +00002833** to find a page in the in-memory cache first. If the page is not already
drhd33d5a82007-04-26 12:11:28 +00002834** in memory, this routine goes to disk to read it in whereas Lookup()
drh7e3b0a02001-04-28 16:52:40 +00002835** just returns 0. This routine acquires a read-lock the first time it
2836** has to go to disk, and could also playback an old journal if necessary.
drhd33d5a82007-04-26 12:11:28 +00002837** Since Lookup() never goes to disk, it never has to deal with locks
drh7e3b0a02001-04-28 16:52:40 +00002838** or journal files.
drh0787db62007-03-04 13:15:27 +00002839**
drh538f5702007-04-13 02:14:30 +00002840** If noContent is false, the page contents are actually read from disk.
2841** If noContent is true, it means that we do not care about the contents
2842** of the page at this time, so do not do a disk read. Just fill in the
2843** page content with zeros. But mark the fact that we have not read the
2844** content by setting the PgHdr.needRead flag. Later on, if
drhd33d5a82007-04-26 12:11:28 +00002845** sqlite3PagerWrite() is called on this page or if this routine is
2846** called again with noContent==0, that means that the content is needed
2847** and the disk read should occur at that point.
drhed7c8552001-04-11 14:29:21 +00002848*/
danielk197765e0ff32008-09-19 09:14:43 +00002849int sqlite3PagerAcquire(
drh538f5702007-04-13 02:14:30 +00002850 Pager *pPager, /* The pager open on the database file */
2851 Pgno pgno, /* Page number to fetch */
2852 DbPage **ppPage, /* Write a pointer to the page here */
2853 int noContent /* Do not bother reading content from disk if true */
2854){
danielk19778c0a7912008-08-20 14:49:23 +00002855 PgHdr *pPg = 0;
drh165ffe92005-03-15 17:09:30 +00002856 int rc;
drhed7c8552001-04-11 14:29:21 +00002857
danielk19778c0a7912008-08-20 14:49:23 +00002858 assert( pPager->state==PAGER_UNLOCK
2859 || sqlite3PcacheRefCount(pPager->pPCache)>0
danielk1977b3175382008-10-17 18:51:52 +00002860 || pgno==1
danielk19778c0a7912008-08-20 14:49:23 +00002861 );
danielk1977e277be02007-03-23 18:12:06 +00002862
danielk197726836652005-01-17 01:33:13 +00002863 /* The maximum page number is 2^31. Return SQLITE_CORRUPT if a page
2864 ** number greater than this, or zero, is requested.
2865 */
drh267cb322005-09-16 17:16:52 +00002866 if( pgno>PAGER_MAX_PGNO || pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh49285702005-09-17 15:20:26 +00002867 return SQLITE_CORRUPT_BKPT;
danielk197726836652005-01-17 01:33:13 +00002868 }
2869
drhd9b02572001-04-15 00:37:09 +00002870 /* Make sure we have not hit any critical errors.
2871 */
drh836faa42003-01-11 13:30:57 +00002872 assert( pPager!=0 );
drh2e6d11b2003-04-25 15:37:57 +00002873 *ppPage = 0;
drhd9b02572001-04-15 00:37:09 +00002874
danielk197713adf8a2004-06-03 16:08:41 +00002875 /* If this is the first page accessed, then get a SHARED lock
danielk1977334cdb62007-03-26 08:05:12 +00002876 ** on the database file. pagerSharedLock() is a no-op if
2877 ** a database lock is already held.
drhed7c8552001-04-11 14:29:21 +00002878 */
danielk1977e277be02007-03-23 18:12:06 +00002879 rc = pagerSharedLock(pPager);
2880 if( rc!=SQLITE_OK ){
2881 return rc;
drhed7c8552001-04-11 14:29:21 +00002882 }
danielk1977e277be02007-03-23 18:12:06 +00002883 assert( pPager->state!=PAGER_UNLOCK );
2884
danielk19778c0a7912008-08-20 14:49:23 +00002885 rc = sqlite3PcacheFetch(pPager->pPCache, pgno, 1, &pPg);
2886 if( rc!=SQLITE_OK ){
2887 return rc;
2888 }
danielk19778c0a7912008-08-20 14:49:23 +00002889 if( pPg->pPager==0 ){
2890 /* The pager cache has created a new page. Its content needs to
2891 ** be initialized.
2892 */
danielk1977979f38e2007-03-27 16:19:51 +00002893 int nMax;
drh538f5702007-04-13 02:14:30 +00002894 PAGER_INCR(pPager->nMiss);
danielk19778c0a7912008-08-20 14:49:23 +00002895 pPg->pPager = pPager;
danielk19778c0a7912008-08-20 14:49:23 +00002896 memset(pPg->pExtra, 0, pPager->nExtra);
danielk197724168722007-04-02 05:07:47 +00002897
danielk1977ad0132d2008-06-07 08:58:22 +00002898 rc = sqlite3PagerPagecount(pPager, &nMax);
2899 if( rc!=SQLITE_OK ){
danielk1977ae72d982007-10-03 08:46:44 +00002900 sqlite3PagerUnref(pPg);
drh2e6d11b2003-04-25 15:37:57 +00002901 return rc;
2902 }
danielk197775bab7d2006-01-23 13:09:45 +00002903
danielk1977a1fa00d2008-08-27 15:16:33 +00002904 if( nMax<(int)pgno || MEMDB || noContent ){
drhf8e632b2007-05-08 14:51:36 +00002905 if( pgno>pPager->mxPgno ){
danielk1977de3bea72007-05-09 15:56:39 +00002906 sqlite3PagerUnref(pPg);
drhf8e632b2007-05-08 14:51:36 +00002907 return SQLITE_FULL;
2908 }
danielk19778c0a7912008-08-20 14:49:23 +00002909 memset(pPg->pData, 0, pPager->pageSize);
danielk1977a1fa00d2008-08-27 15:16:33 +00002910 if( noContent ){
danielk19778c0a7912008-08-20 14:49:23 +00002911 pPg->flags |= PGHDR_NEED_READ;
2912 }
drh538f5702007-04-13 02:14:30 +00002913 IOTRACE(("ZERO %p %d\n", pPager, pgno));
drh306dc212001-05-21 13:45:10 +00002914 }else{
danielk1977e180dd92007-04-05 17:15:52 +00002915 rc = readDbPage(pPager, pPg, pgno);
drh551b7732006-11-06 21:20:25 +00002916 if( rc!=SQLITE_OK && rc!=SQLITE_IOERR_SHORT_READ ){
danielk19778c0a7912008-08-20 14:49:23 +00002917 /* sqlite3PagerUnref(pPg); */
2918 pagerDropPage(pPg);
drh551b7732006-11-06 21:20:25 +00002919 return rc;
drh81a20f22001-10-12 17:30:04 +00002920 }
drh306dc212001-05-21 13:45:10 +00002921 }
danielk19773c407372005-02-15 02:54:14 +00002922#ifdef SQLITE_CHECK_PAGES
2923 pPg->pageHash = pager_pagehash(pPg);
2924#endif
drhed7c8552001-04-11 14:29:21 +00002925 }else{
drhd9b02572001-04-15 00:37:09 +00002926 /* The requested page is in the page cache. */
danielk19778c0a7912008-08-20 14:49:23 +00002927 assert(sqlite3PcacheRefCount(pPager->pPCache)>0 || pgno==1);
drh538f5702007-04-13 02:14:30 +00002928 PAGER_INCR(pPager->nHit);
drhd33d5a82007-04-26 12:11:28 +00002929 if( !noContent ){
2930 rc = pager_get_content(pPg);
2931 if( rc ){
danielk19778c0a7912008-08-20 14:49:23 +00002932 sqlite3PagerUnref(pPg);
drhd33d5a82007-04-26 12:11:28 +00002933 return rc;
2934 }
2935 }
drhed7c8552001-04-11 14:29:21 +00002936 }
danielk19778c0a7912008-08-20 14:49:23 +00002937
danielk19773b8a05f2007-03-19 17:44:26 +00002938 *ppPage = pPg;
drhed7c8552001-04-11 14:29:21 +00002939 return SQLITE_OK;
2940}
danielk19778c0a7912008-08-20 14:49:23 +00002941
drhed7c8552001-04-11 14:29:21 +00002942/*
drh7e3b0a02001-04-28 16:52:40 +00002943** Acquire a page if it is already in the in-memory cache. Do
2944** not read the page from disk. Return a pointer to the page,
2945** or 0 if the page is not in cache.
2946**
danielk19773b8a05f2007-03-19 17:44:26 +00002947** See also sqlite3PagerGet(). The difference between this routine
2948** and sqlite3PagerGet() is that _get() will go to the disk and read
drh7e3b0a02001-04-28 16:52:40 +00002949** in the page if the page is not already in cache. This routine
drh5e00f6c2001-09-13 13:46:56 +00002950** returns NULL if the page is not in cache or if a disk I/O error
2951** has ever happened.
drh7e3b0a02001-04-28 16:52:40 +00002952*/
danielk19773b8a05f2007-03-19 17:44:26 +00002953DbPage *sqlite3PagerLookup(Pager *pPager, Pgno pgno){
drh86f8c192007-08-22 00:39:19 +00002954 PgHdr *pPg = 0;
drh836faa42003-01-11 13:30:57 +00002955 assert( pPager!=0 );
2956 assert( pgno!=0 );
danielk1977e277be02007-03-23 18:12:06 +00002957
danielk19778c0a7912008-08-20 14:49:23 +00002958 if( (pPager->state!=PAGER_UNLOCK)
2959 && (pPager->errCode==SQLITE_OK || pPager->errCode==SQLITE_FULL)
2960 ){
2961 sqlite3PcacheFetch(pPager->pPCache, pgno, 0, &pPg);
danielk1977e277be02007-03-23 18:12:06 +00002962 }
danielk19778c0a7912008-08-20 14:49:23 +00002963
danielk19773b8a05f2007-03-19 17:44:26 +00002964 return pPg;
drh7e3b0a02001-04-28 16:52:40 +00002965}
2966
2967/*
drhed7c8552001-04-11 14:29:21 +00002968** Release a page.
2969**
2970** If the number of references to the page drop to zero, then the
2971** page is added to the LRU list. When all references to all pages
drhd9b02572001-04-15 00:37:09 +00002972** are released, a rollback occurs and the lock on the database is
drhed7c8552001-04-11 14:29:21 +00002973** removed.
2974*/
danielk19773b8a05f2007-03-19 17:44:26 +00002975int sqlite3PagerUnref(DbPage *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00002976 if( pPg ){
2977 Pager *pPager = pPg->pPager;
danielk19778c0a7912008-08-20 14:49:23 +00002978 sqlite3PcacheRelease(pPg);
2979 pagerUnlockIfUnused(pPager);
drhed7c8552001-04-11 14:29:21 +00002980 }
drhd9b02572001-04-15 00:37:09 +00002981 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +00002982}
2983
danielk1977fd7f0452008-12-17 17:30:26 +00002984static int openSubJournal(Pager *pPager){
2985 int rc = SQLITE_OK;
2986 if( pPager->journalOpen && !pPager->sjfd->pMethods ){
2987 if( pPager->journalMode==PAGER_JOURNALMODE_MEMORY ){
2988 sqlite3MemJournalOpen(pPager->sjfd);
2989 }else{
2990 rc = sqlite3PagerOpentemp(pPager, pPager->sjfd, SQLITE_OPEN_SUBJOURNAL);
2991 }
2992 }
2993 return rc;
2994}
2995
drhed7c8552001-04-11 14:29:21 +00002996/*
drha6abd042004-06-09 17:37:22 +00002997** Create a journal file for pPager. There should already be a RESERVED
2998** or EXCLUSIVE lock on the database file when this routine is called.
drhda47d772002-12-02 04:25:19 +00002999**
3000** Return SQLITE_OK if everything. Return an error code and release the
3001** write lock if anything goes wrong.
3002*/
3003static int pager_open_journal(Pager *pPager){
danielk1977b4b47412007-08-17 15:53:36 +00003004 sqlite3_vfs *pVfs = pPager->pVfs;
3005 int flags = (SQLITE_OPEN_READWRITE|SQLITE_OPEN_EXCLUSIVE|SQLITE_OPEN_CREATE);
3006
drhda47d772002-12-02 04:25:19 +00003007 int rc;
drha6abd042004-06-09 17:37:22 +00003008 assert( pPager->state>=PAGER_RESERVED );
drhda47d772002-12-02 04:25:19 +00003009 assert( pPager->useJournal );
drhf5e7bb52008-02-18 14:47:33 +00003010 assert( pPager->pInJournal==0 );
danielk1977ad0132d2008-06-07 08:58:22 +00003011 sqlite3PagerPagecount(pPager, 0);
drhf5e7bb52008-02-18 14:47:33 +00003012 pPager->pInJournal = sqlite3BitvecCreate(pPager->dbSize);
drhf5e7bb52008-02-18 14:47:33 +00003013 if( pPager->pInJournal==0 ){
drh9c105bb2004-10-02 20:38:28 +00003014 rc = SQLITE_NOMEM;
3015 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00003016 }
danielk1977b4b47412007-08-17 15:53:36 +00003017
drhfdc40e92008-04-17 20:59:37 +00003018 if( pPager->journalOpen==0 ){
3019 if( pPager->tempFile ){
3020 flags |= (SQLITE_OPEN_DELETEONCLOSE|SQLITE_OPEN_TEMP_JOURNAL);
3021 }else{
3022 flags |= (SQLITE_OPEN_MAIN_JOURNAL);
drh600e46a2007-03-28 01:59:33 +00003023 }
danielk1977b3175382008-10-17 18:51:52 +00003024 if( pPager->journalMode==PAGER_JOURNALMODE_MEMORY ){
3025 sqlite3MemJournalOpen(pPager->jfd);
3026 rc = SQLITE_OK;
3027 }else{
drhfdc40e92008-04-17 20:59:37 +00003028#ifdef SQLITE_ENABLE_ATOMIC_WRITE
danielk1977b3175382008-10-17 18:51:52 +00003029 rc = sqlite3JournalOpen(
3030 pVfs, pPager->zJournal, pPager->jfd, flags, jrnlBufferSize(pPager)
3031 );
drhfdc40e92008-04-17 20:59:37 +00003032#else
danielk1977b3175382008-10-17 18:51:52 +00003033 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, flags, 0);
drhfdc40e92008-04-17 20:59:37 +00003034#endif
danielk1977b3175382008-10-17 18:51:52 +00003035 }
drhfdc40e92008-04-17 20:59:37 +00003036 assert( rc!=SQLITE_OK || pPager->jfd->pMethods );
3037 pPager->journalOff = 0;
3038 pPager->setMaster = 0;
3039 pPager->journalHdr = 0;
3040 if( rc!=SQLITE_OK ){
3041 if( rc==SQLITE_NOMEM ){
3042 sqlite3OsDelete(pVfs, pPager->zJournal, 0);
3043 }
3044 goto failed_to_open_journal;
3045 }
drhda47d772002-12-02 04:25:19 +00003046 }
3047 pPager->journalOpen = 1;
drhdb48ee02003-01-16 13:42:43 +00003048 pPager->journalStarted = 0;
drhda47d772002-12-02 04:25:19 +00003049 pPager->needSync = 0;
drh968af522003-02-11 14:55:40 +00003050 pPager->nRec = 0;
danielk1977efaaf572006-01-16 11:29:19 +00003051 if( pPager->errCode ){
3052 rc = pPager->errCode;
drhdd5b2fa2005-03-28 03:39:55 +00003053 goto failed_to_open_journal;
drh2e6d11b2003-04-25 15:37:57 +00003054 }
drhda47d772002-12-02 04:25:19 +00003055 pPager->origDbSize = pPager->dbSize;
drhae2b40c2004-06-09 19:03:54 +00003056
danielk197776572402004-06-25 02:38:54 +00003057 rc = writeJournalHdr(pPager);
3058
danielk1977fd7f0452008-12-17 17:30:26 +00003059 if( pPager->nSavepoint && rc==SQLITE_OK ){
3060 rc = openSubJournal(pPager);
drhda47d772002-12-02 04:25:19 +00003061 }
danielk1977ae72d982007-10-03 08:46:44 +00003062 if( rc!=SQLITE_OK && rc!=SQLITE_NOMEM && rc!=SQLITE_IOERR_NOMEM ){
danielk1977df2566a2008-05-07 19:11:03 +00003063 rc = pager_end_transaction(pPager, 0);
drhda47d772002-12-02 04:25:19 +00003064 if( rc==SQLITE_OK ){
3065 rc = SQLITE_FULL;
3066 }
3067 }
drh9c105bb2004-10-02 20:38:28 +00003068 return rc;
3069
3070failed_to_open_journal:
drhf5e7bb52008-02-18 14:47:33 +00003071 sqlite3BitvecDestroy(pPager->pInJournal);
3072 pPager->pInJournal = 0;
drh9c105bb2004-10-02 20:38:28 +00003073 return rc;
drhda47d772002-12-02 04:25:19 +00003074}
3075
3076/*
drh4b845d72002-03-05 12:41:19 +00003077** Acquire a write-lock on the database. The lock is removed when
3078** the any of the following happen:
3079**
drh80e35f42007-03-30 14:06:34 +00003080** * sqlite3PagerCommitPhaseTwo() is called.
danielk19773b8a05f2007-03-19 17:44:26 +00003081** * sqlite3PagerRollback() is called.
3082** * sqlite3PagerClose() is called.
3083** * sqlite3PagerUnref() is called to on every outstanding page.
drh4b845d72002-03-05 12:41:19 +00003084**
danielk197713adf8a2004-06-03 16:08:41 +00003085** The first parameter to this routine is a pointer to any open page of the
3086** database file. Nothing changes about the page - it is used merely to
3087** acquire a pointer to the Pager structure and as proof that there is
3088** already a read-lock on the database.
drh4b845d72002-03-05 12:41:19 +00003089**
danielk197713adf8a2004-06-03 16:08:41 +00003090** The second parameter indicates how much space in bytes to reserve for a
3091** master journal file-name at the start of the journal when it is created.
3092**
3093** A journal file is opened if this is not a temporary file. For temporary
3094** files, the opening of the journal file is deferred until there is an
3095** actual need to write to the journal.
drhda47d772002-12-02 04:25:19 +00003096**
drha6abd042004-06-09 17:37:22 +00003097** If the database is already reserved for writing, this routine is a no-op.
drh684917c2004-10-05 02:41:42 +00003098**
3099** If exFlag is true, go ahead and get an EXCLUSIVE lock on the file
3100** immediately instead of waiting until we try to flush the cache. The
3101** exFlag is ignored if a transaction is already active.
drh4b845d72002-03-05 12:41:19 +00003102*/
danielk19773b8a05f2007-03-19 17:44:26 +00003103int sqlite3PagerBegin(DbPage *pPg, int exFlag){
drh4b845d72002-03-05 12:41:19 +00003104 Pager *pPager = pPg->pPager;
3105 int rc = SQLITE_OK;
3106 assert( pPg->nRef>0 );
drha6abd042004-06-09 17:37:22 +00003107 assert( pPager->state!=PAGER_UNLOCK );
3108 if( pPager->state==PAGER_SHARED ){
drhf5e7bb52008-02-18 14:47:33 +00003109 assert( pPager->pInJournal==0 );
danielk1977b3175382008-10-17 18:51:52 +00003110 assert( !MEMDB );
danielk1977b3175382008-10-17 18:51:52 +00003111 rc = sqlite3OsLock(pPager->fd, RESERVED_LOCK);
3112 if( rc==SQLITE_OK ){
3113 pPager->state = PAGER_RESERVED;
3114 if( exFlag ){
3115 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
drh684917c2004-10-05 02:41:42 +00003116 }
danielk1977b3175382008-10-17 18:51:52 +00003117 }
3118 if( rc!=SQLITE_OK ){
3119 return rc;
3120 }
3121 pPager->dirtyCache = 0;
3122 PAGERTRACE2("TRANSACTION %d\n", PAGERID(pPager));
3123 if( pPager->useJournal && !pPager->tempFile
3124 && pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
3125 rc = pager_open_journal(pPager);
drh4b845d72002-03-05 12:41:19 +00003126 }
danielk1977334cdb62007-03-26 08:05:12 +00003127 }else if( pPager->journalOpen && pPager->journalOff==0 ){
drhd138c012008-05-13 00:58:18 +00003128 /* This happens when the pager was in exclusive-access mode the last
danielk1977334cdb62007-03-26 08:05:12 +00003129 ** time a (read or write) transaction was successfully concluded
3130 ** by this connection. Instead of deleting the journal file it was
drhd138c012008-05-13 00:58:18 +00003131 ** kept open and either was truncated to 0 bytes or its header was
3132 ** overwritten with zeros.
danielk1977334cdb62007-03-26 08:05:12 +00003133 */
3134 assert( pPager->nRec==0 );
3135 assert( pPager->origDbSize==0 );
drhf5e7bb52008-02-18 14:47:33 +00003136 assert( pPager->pInJournal==0 );
danielk1977ad0132d2008-06-07 08:58:22 +00003137 sqlite3PagerPagecount(pPager, 0);
drhf5e7bb52008-02-18 14:47:33 +00003138 pPager->pInJournal = sqlite3BitvecCreate( pPager->dbSize );
drhf5e7bb52008-02-18 14:47:33 +00003139 if( !pPager->pInJournal ){
danielk1977334cdb62007-03-26 08:05:12 +00003140 rc = SQLITE_NOMEM;
3141 }else{
drh369339d2007-03-30 16:01:55 +00003142 pPager->origDbSize = pPager->dbSize;
danielk1977334cdb62007-03-26 08:05:12 +00003143 rc = writeJournalHdr(pPager);
3144 }
drh4b845d72002-03-05 12:41:19 +00003145 }
danielk1977334cdb62007-03-26 08:05:12 +00003146 assert( !pPager->journalOpen || pPager->journalOff>0 || rc!=SQLITE_OK );
drh4b845d72002-03-05 12:41:19 +00003147 return rc;
3148}
3149
3150/*
drhed7c8552001-04-11 14:29:21 +00003151** Mark a data page as writeable. The page is written into the journal
3152** if it is not there already. This routine must be called before making
3153** changes to a page.
3154**
3155** The first time this routine is called, the pager creates a new
drha6abd042004-06-09 17:37:22 +00003156** journal and acquires a RESERVED lock on the database. If the RESERVED
drhed7c8552001-04-11 14:29:21 +00003157** lock could not be acquired, this routine returns SQLITE_BUSY. The
drh306dc212001-05-21 13:45:10 +00003158** calling routine must check for that return value and be careful not to
drhed7c8552001-04-11 14:29:21 +00003159** change any page data until this routine returns SQLITE_OK.
drhd9b02572001-04-15 00:37:09 +00003160**
3161** If the journal file could not be written because the disk is full,
3162** then this routine returns SQLITE_FULL and does an immediate rollback.
3163** All subsequent write attempts also return SQLITE_FULL until there
danielk19773b8a05f2007-03-19 17:44:26 +00003164** is a call to sqlite3PagerCommit() or sqlite3PagerRollback() to
drhd9b02572001-04-15 00:37:09 +00003165** reset.
drhed7c8552001-04-11 14:29:21 +00003166*/
danielk19773b8a05f2007-03-19 17:44:26 +00003167static int pager_write(PgHdr *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00003168 void *pData = pPg->pData;
drh69688d52001-04-14 16:38:23 +00003169 Pager *pPager = pPg->pPager;
drhd79caeb2001-04-15 02:27:24 +00003170 int rc = SQLITE_OK;
drh69688d52001-04-14 16:38:23 +00003171
drh6446c4d2001-12-15 14:22:18 +00003172 /* Check for errors
3173 */
danielk1977efaaf572006-01-16 11:29:19 +00003174 if( pPager->errCode ){
3175 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00003176 }
drh5e00f6c2001-09-13 13:46:56 +00003177 if( pPager->readOnly ){
3178 return SQLITE_PERM;
3179 }
drh6446c4d2001-12-15 14:22:18 +00003180
danielk197776572402004-06-25 02:38:54 +00003181 assert( !pPager->setMaster );
3182
danielk19773c407372005-02-15 02:54:14 +00003183 CHECK_PAGE(pPg);
3184
drh538f5702007-04-13 02:14:30 +00003185 /* If this page was previously acquired with noContent==1, that means
3186 ** we didn't really read in the content of the page. This can happen
3187 ** (for example) when the page is being moved to the freelist. But
3188 ** now we are (perhaps) moving the page off of the freelist for
3189 ** reuse and we need to know its original content so that content
3190 ** can be stored in the rollback journal. So do the read at this
3191 ** time.
3192 */
drhd33d5a82007-04-26 12:11:28 +00003193 rc = pager_get_content(pPg);
3194 if( rc ){
3195 return rc;
drh538f5702007-04-13 02:14:30 +00003196 }
3197
drh6446c4d2001-12-15 14:22:18 +00003198 /* Mark the page as dirty. If the page has already been written
3199 ** to the journal then we can return right away.
3200 */
drhc047b9f2008-11-21 03:23:43 +00003201 sqlite3PcacheMakeDirty(pPg);
danielk1977fd7f0452008-12-17 17:30:26 +00003202 if( pageInJournal(pPg) && pageInSavepoint(pPg) ){
drha6abd042004-06-09 17:37:22 +00003203 pPager->dirtyCache = 1;
drhd138c012008-05-13 00:58:18 +00003204 pPager->dbModified = 1;
danielk1977a0bf2652004-11-04 14:30:04 +00003205 }else{
drh6446c4d2001-12-15 14:22:18 +00003206
danielk1977a0bf2652004-11-04 14:30:04 +00003207 /* If we get this far, it means that the page needs to be
3208 ** written to the transaction journal or the ckeckpoint journal
3209 ** or both.
3210 **
3211 ** First check to see that the transaction journal exists and
3212 ** create it if it does not.
3213 */
3214 assert( pPager->state!=PAGER_UNLOCK );
danielk19773b8a05f2007-03-19 17:44:26 +00003215 rc = sqlite3PagerBegin(pPg, 0);
danielk1977a0bf2652004-11-04 14:30:04 +00003216 if( rc!=SQLITE_OK ){
3217 return rc;
3218 }
3219 assert( pPager->state>=PAGER_RESERVED );
drhfdc40e92008-04-17 20:59:37 +00003220 if( !pPager->journalOpen && pPager->useJournal
3221 && pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
danielk1977a0bf2652004-11-04 14:30:04 +00003222 rc = pager_open_journal(pPager);
3223 if( rc!=SQLITE_OK ) return rc;
3224 }
danielk1977a0bf2652004-11-04 14:30:04 +00003225 pPager->dirtyCache = 1;
drhd138c012008-05-13 00:58:18 +00003226 pPager->dbModified = 1;
danielk1977a0bf2652004-11-04 14:30:04 +00003227
3228 /* The transaction journal now exists and we have a RESERVED or an
3229 ** EXCLUSIVE lock on the main database file. Write the current page to
3230 ** the transaction journal if it is not there already.
3231 */
danielk1977bc2ca9e2008-11-13 14:28:28 +00003232 if( !pageInJournal(pPg) && pPager->journalOpen ){
danielk1977d92db532008-11-17 04:56:24 +00003233 if( pPg->pgno<=pPager->origDbSize ){
danielk1977b3175382008-10-17 18:51:52 +00003234 u32 cksum;
3235 char *pData2;
danielk1977dd97a492007-08-22 18:54:32 +00003236
danielk1977b3175382008-10-17 18:51:52 +00003237 /* We should never write to the journal file the page that
3238 ** contains the database locks. The following assert verifies
3239 ** that we do not. */
3240 assert( pPg->pgno!=PAGER_MJ_PGNO(pPager) );
3241 pData2 = CODEC2(pPager, pData, pPg->pgno, 7);
3242 cksum = pager_cksum(pPager, (u8*)pData2);
3243 rc = write32bits(pPager->jfd, pPager->journalOff, pPg->pgno);
3244 if( rc==SQLITE_OK ){
3245 rc = sqlite3OsWrite(pPager->jfd, pData2, pPager->pageSize,
3246 pPager->journalOff + 4);
3247 pPager->journalOff += pPager->pageSize+4;
3248 }
3249 if( rc==SQLITE_OK ){
3250 rc = write32bits(pPager->jfd, pPager->journalOff, cksum);
3251 pPager->journalOff += 4;
3252 }
3253 IOTRACE(("JOUT %p %d %lld %d\n", pPager, pPg->pgno,
3254 pPager->journalOff, pPager->pageSize));
3255 PAGER_INCR(sqlite3_pager_writej_count);
3256 PAGERTRACE5("JOURNAL %d page %d needSync=%d hash(%08x)\n",
3257 PAGERID(pPager), pPg->pgno,
3258 ((pPg->flags&PGHDR_NEED_SYNC)?1:0), pager_pagehash(pPg));
danielk197707cb5602006-01-20 10:55:05 +00003259
danielk1977b3175382008-10-17 18:51:52 +00003260 /* An error has occured writing to the journal file. The
3261 ** transaction will be rolled back by the layer above.
3262 */
3263 if( rc!=SQLITE_OK ){
3264 return rc;
3265 }
danielk197707cb5602006-01-20 10:55:05 +00003266
danielk1977b3175382008-10-17 18:51:52 +00003267 pPager->nRec++;
3268 assert( pPager->pInJournal!=0 );
3269 sqlite3BitvecSet(pPager->pInJournal, pPg->pgno);
3270 if( !pPager->noSync ){
3271 pPg->flags |= PGHDR_NEED_SYNC;
3272 }
danielk1977fd7f0452008-12-17 17:30:26 +00003273 addToSavepointBitvecs(pPager, pPg->pgno);
danielk197713adf8a2004-06-03 16:08:41 +00003274 }else{
danielk19778c0a7912008-08-20 14:49:23 +00003275 if( !pPager->journalStarted && !pPager->noSync ){
3276 pPg->flags |= PGHDR_NEED_SYNC;
3277 }
drh4f0c5872007-03-26 22:05:01 +00003278 PAGERTRACE4("APPEND %d page %d needSync=%d\n",
danielk19778c0a7912008-08-20 14:49:23 +00003279 PAGERID(pPager), pPg->pgno,
3280 ((pPg->flags&PGHDR_NEED_SYNC)?1:0));
danielk1977a0bf2652004-11-04 14:30:04 +00003281 }
danielk19778c0a7912008-08-20 14:49:23 +00003282 if( pPg->flags&PGHDR_NEED_SYNC ){
danielk1977a0bf2652004-11-04 14:30:04 +00003283 pPager->needSync = 1;
3284 }
danielk1977a0bf2652004-11-04 14:30:04 +00003285 }
3286
3287 /* If the statement journal is open and the page is not in it,
3288 ** then write the current page to the statement journal. Note that
3289 ** the statement journal format differs from the standard journal format
3290 ** in that it omits the checksums and the header.
3291 */
danielk1977fd7f0452008-12-17 17:30:26 +00003292 if( !pageInSavepoint(pPg) ){
danielk1977b3175382008-10-17 18:51:52 +00003293 i64 offset = pPager->stmtNRec*(4+pPager->pageSize);
3294 char *pData2 = CODEC2(pPager, pData, pPg->pgno, 7);
danielk1977d92db532008-11-17 04:56:24 +00003295 assert( pageInJournal(pPg) || pPg->pgno>pPager->origDbSize );
danielk1977fd7f0452008-12-17 17:30:26 +00003296 rc = write32bits(pPager->sjfd, offset, pPg->pgno);
danielk1977b3175382008-10-17 18:51:52 +00003297 if( rc==SQLITE_OK ){
danielk1977fd7f0452008-12-17 17:30:26 +00003298 rc = sqlite3OsWrite(pPager->sjfd, pData2, pPager->pageSize, offset+4);
drhdb48ee02003-01-16 13:42:43 +00003299 }
danielk1977b3175382008-10-17 18:51:52 +00003300 PAGERTRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
3301 if( rc!=SQLITE_OK ){
3302 return rc;
3303 }
3304 pPager->stmtNRec++;
danielk1977fd7f0452008-12-17 17:30:26 +00003305 assert( pPager->nSavepoint>0 );
3306 addToSavepointBitvecs(pPager, pPg->pgno);
drhd9b02572001-04-15 00:37:09 +00003307 }
drhfa86c412002-02-02 15:01:15 +00003308 }
3309
3310 /* Update the database size and return.
3311 */
drh1aa2d8b2007-01-03 15:34:29 +00003312 assert( pPager->state>=PAGER_SHARED );
danielk1977d92db532008-11-17 04:56:24 +00003313 if( pPager->dbSize<pPg->pgno ){
drh306dc212001-05-21 13:45:10 +00003314 pPager->dbSize = pPg->pgno;
danielk1977d92db532008-11-17 04:56:24 +00003315 if( pPager->dbSize==(PAGER_MJ_PGNO(pPager)-1) ){
drh1f595712004-06-15 01:40:29 +00003316 pPager->dbSize++;
3317 }
drh306dc212001-05-21 13:45:10 +00003318 }
drh69688d52001-04-14 16:38:23 +00003319 return rc;
drhed7c8552001-04-11 14:29:21 +00003320}
3321
3322/*
danielk19774099f6e2007-03-19 11:25:20 +00003323** This function is used to mark a data-page as writable. It uses
3324** pager_write() to open a journal file (if it is not already open)
3325** and write the page *pData to the journal.
3326**
3327** The difference between this function and pager_write() is that this
3328** function also deals with the special case where 2 or more pages
3329** fit on a single disk sector. In this case all co-resident pages
3330** must have been written to the journal file before returning.
3331*/
danielk19773b8a05f2007-03-19 17:44:26 +00003332int sqlite3PagerWrite(DbPage *pDbPage){
danielk19774099f6e2007-03-19 11:25:20 +00003333 int rc = SQLITE_OK;
3334
danielk19773b8a05f2007-03-19 17:44:26 +00003335 PgHdr *pPg = pDbPage;
danielk19774099f6e2007-03-19 11:25:20 +00003336 Pager *pPager = pPg->pPager;
3337 Pgno nPagePerSector = (pPager->sectorSize/pPager->pageSize);
3338
danielk1977b3175382008-10-17 18:51:52 +00003339 if( nPagePerSector>1 ){
danielk19774099f6e2007-03-19 11:25:20 +00003340 Pgno nPageCount; /* Total number of pages in database file */
3341 Pgno pg1; /* First page of the sector pPg is located on. */
3342 int nPage; /* Number of pages starting at pg1 to journal */
3343 int ii;
danielk1977dd97a492007-08-22 18:54:32 +00003344 int needSync = 0;
danielk19774099f6e2007-03-19 11:25:20 +00003345
3346 /* Set the doNotSync flag to 1. This is because we cannot allow a journal
3347 ** header to be written between the pages journaled by this function.
3348 */
danielk1977b3175382008-10-17 18:51:52 +00003349 assert( !MEMDB );
danielk19774099f6e2007-03-19 11:25:20 +00003350 assert( pPager->doNotSync==0 );
3351 pPager->doNotSync = 1;
3352
3353 /* This trick assumes that both the page-size and sector-size are
3354 ** an integer power of 2. It sets variable pg1 to the identifier
3355 ** of the first page of the sector pPg is located on.
3356 */
3357 pg1 = ((pPg->pgno-1) & ~(nPagePerSector-1)) + 1;
3358
danielk1977ad0132d2008-06-07 08:58:22 +00003359 sqlite3PagerPagecount(pPager, (int *)&nPageCount);
danielk19774099f6e2007-03-19 11:25:20 +00003360 if( pPg->pgno>nPageCount ){
3361 nPage = (pPg->pgno - pg1)+1;
3362 }else if( (pg1+nPagePerSector-1)>nPageCount ){
3363 nPage = nPageCount+1-pg1;
3364 }else{
3365 nPage = nPagePerSector;
3366 }
3367 assert(nPage>0);
3368 assert(pg1<=pPg->pgno);
3369 assert((pg1+nPage)>pPg->pgno);
3370
3371 for(ii=0; ii<nPage && rc==SQLITE_OK; ii++){
3372 Pgno pg = pg1+ii;
danielk1977dd97a492007-08-22 18:54:32 +00003373 PgHdr *pPage;
drhf5e7bb52008-02-18 14:47:33 +00003374 if( pg==pPg->pgno || !sqlite3BitvecTest(pPager->pInJournal, pg) ){
danielk19774099f6e2007-03-19 11:25:20 +00003375 if( pg!=PAGER_MJ_PGNO(pPager) ){
danielk19773b8a05f2007-03-19 17:44:26 +00003376 rc = sqlite3PagerGet(pPager, pg, &pPage);
danielk19774099f6e2007-03-19 11:25:20 +00003377 if( rc==SQLITE_OK ){
3378 rc = pager_write(pPage);
danielk19778c0a7912008-08-20 14:49:23 +00003379 if( pPage->flags&PGHDR_NEED_SYNC ){
danielk1977dd97a492007-08-22 18:54:32 +00003380 needSync = 1;
3381 }
danielk19773b8a05f2007-03-19 17:44:26 +00003382 sqlite3PagerUnref(pPage);
danielk19774099f6e2007-03-19 11:25:20 +00003383 }
3384 }
drhc81945e2008-03-10 14:12:53 +00003385 }else if( (pPage = pager_lookup(pPager, pg))!=0 ){
danielk19778c0a7912008-08-20 14:49:23 +00003386 if( pPage->flags&PGHDR_NEED_SYNC ){
danielk1977dd97a492007-08-22 18:54:32 +00003387 needSync = 1;
3388 }
danielk19778c0a7912008-08-20 14:49:23 +00003389 sqlite3PagerUnref(pPage);
danielk19774099f6e2007-03-19 11:25:20 +00003390 }
3391 }
3392
danielk1977dd97a492007-08-22 18:54:32 +00003393 /* If the PgHdr.needSync flag is set for any of the nPage pages
3394 ** starting at pg1, then it needs to be set for all of them. Because
3395 ** writing to any of these nPage pages may damage the others, the
3396 ** journal file must contain sync()ed copies of all of them
3397 ** before any of them can be written out to the database file.
3398 */
3399 if( needSync ){
drhb3df2e12008-09-17 20:06:26 +00003400 assert( !MEMDB && pPager->noSync==0 );
danielk1977dd97a492007-08-22 18:54:32 +00003401 for(ii=0; ii<nPage && needSync; ii++){
3402 PgHdr *pPage = pager_lookup(pPager, pg1+ii);
danielk19778c0a7912008-08-20 14:49:23 +00003403 if( pPage ) pPage->flags |= PGHDR_NEED_SYNC;
3404 sqlite3PagerUnref(pPage);
danielk1977dd97a492007-08-22 18:54:32 +00003405 }
3406 assert(pPager->needSync);
3407 }
3408
danielk19774099f6e2007-03-19 11:25:20 +00003409 assert( pPager->doNotSync==1 );
3410 pPager->doNotSync = 0;
3411 }else{
danielk19773b8a05f2007-03-19 17:44:26 +00003412 rc = pager_write(pDbPage);
danielk19774099f6e2007-03-19 11:25:20 +00003413 }
3414 return rc;
3415}
3416
3417/*
drhaacc5432002-01-06 17:07:40 +00003418** Return TRUE if the page given in the argument was previously passed
danielk19773b8a05f2007-03-19 17:44:26 +00003419** to sqlite3PagerWrite(). In other words, return TRUE if it is ok
drh6019e162001-07-02 17:51:45 +00003420** to change the content of the page.
3421*/
danielk19777d3a6662006-01-23 16:21:05 +00003422#ifndef NDEBUG
danielk19773b8a05f2007-03-19 17:44:26 +00003423int sqlite3PagerIswriteable(DbPage *pPg){
danielk19778c0a7912008-08-20 14:49:23 +00003424 return pPg->flags&PGHDR_DIRTY;
drh6019e162001-07-02 17:51:45 +00003425}
danielk19777d3a6662006-01-23 16:21:05 +00003426#endif
drh6019e162001-07-02 17:51:45 +00003427
drh001bbcb2003-03-19 03:14:00 +00003428/*
drh30e58752002-03-02 20:41:57 +00003429** A call to this routine tells the pager that it is not necessary to
drh538f5702007-04-13 02:14:30 +00003430** write the information on page pPg back to the disk, even though
drhdfe88ec2008-11-03 20:55:06 +00003431** that page might be marked as dirty. This happens, for example, when
3432** the page has been added as a leaf of the freelist and so its
3433** content no longer matters.
drh30e58752002-03-02 20:41:57 +00003434**
3435** The overlying software layer calls this routine when all of the data
3436** on the given page is unused. The pager marks the page as clean so
3437** that it does not get written to disk.
3438**
3439** Tests show that this optimization, together with the
danielk19773b8a05f2007-03-19 17:44:26 +00003440** sqlite3PagerDontRollback() below, more than double the speed
drh30e58752002-03-02 20:41:57 +00003441** of large INSERT operations and quadruple the speed of large DELETEs.
drh8e298f92002-07-06 16:28:47 +00003442**
3443** When this routine is called, set the alwaysRollback flag to true.
danielk19773b8a05f2007-03-19 17:44:26 +00003444** Subsequent calls to sqlite3PagerDontRollback() for the same page
drh8e298f92002-07-06 16:28:47 +00003445** will thereafter be ignored. This is necessary to avoid a problem
3446** where a page with data is added to the freelist during one part of
3447** a transaction then removed from the freelist during a later part
3448** of the same transaction and reused for some other purpose. When it
3449** is first added to the freelist, this routine is called. When reused,
drh80e35f42007-03-30 14:06:34 +00003450** the sqlite3PagerDontRollback() routine is called. But because the
3451** page contains critical data, we still need to be sure it gets
3452** rolled back in spite of the sqlite3PagerDontRollback() call.
drh30e58752002-03-02 20:41:57 +00003453*/
danielk1977a1fa00d2008-08-27 15:16:33 +00003454int sqlite3PagerDontWrite(DbPage *pDbPage){
drh538f5702007-04-13 02:14:30 +00003455 PgHdr *pPg = pDbPage;
3456 Pager *pPager = pPg->pPager;
danielk1977a1fa00d2008-08-27 15:16:33 +00003457 int rc;
drh8e298f92002-07-06 16:28:47 +00003458
danielk1977b3175382008-10-17 18:51:52 +00003459 if( pPg->pgno>pPager->origDbSize ){
danielk1977a1fa00d2008-08-27 15:16:33 +00003460 return SQLITE_OK;
3461 }
3462 if( pPager->pAlwaysRollback==0 ){
3463 assert( pPager->pInJournal );
3464 pPager->pAlwaysRollback = sqlite3BitvecCreate(pPager->origDbSize);
3465 if( !pPager->pAlwaysRollback ){
3466 return SQLITE_NOMEM;
3467 }
3468 }
3469 rc = sqlite3BitvecSet(pPager->pAlwaysRollback, pPg->pgno);
3470
danielk1977fd7f0452008-12-17 17:30:26 +00003471 if( rc==SQLITE_OK && (pPg->flags&PGHDR_DIRTY) && pPager->nSavepoint==0 ){
drh1aa2d8b2007-01-03 15:34:29 +00003472 assert( pPager->state>=PAGER_SHARED );
danielk1977d92db532008-11-17 04:56:24 +00003473 if( pPager->dbSize==pPg->pgno && pPager->origDbSize<pPager->dbSize ){
drh8124a302002-06-25 14:43:57 +00003474 /* If this pages is the last page in the file and the file has grown
3475 ** during the current transaction, then do NOT mark the page as clean.
3476 ** When the database file grows, we must make sure that the last page
3477 ** gets written at least once so that the disk file will be the correct
3478 ** size. If you do not write this page and the size of the file
3479 ** on the disk ends up being too small, that can lead to database
3480 ** corruption during the next transaction.
3481 */
3482 }else{
drh538f5702007-04-13 02:14:30 +00003483 PAGERTRACE3("DONT_WRITE page %d of %d\n", pPg->pgno, PAGERID(pPager));
3484 IOTRACE(("CLEAN %p %d\n", pPager, pPg->pgno))
danielk197733e32162008-08-23 18:53:08 +00003485 pPg->flags |= PGHDR_DONT_WRITE;
danielk19773c407372005-02-15 02:54:14 +00003486#ifdef SQLITE_CHECK_PAGES
3487 pPg->pageHash = pager_pagehash(pPg);
3488#endif
drh8124a302002-06-25 14:43:57 +00003489 }
drh30e58752002-03-02 20:41:57 +00003490 }
danielk1977a1fa00d2008-08-27 15:16:33 +00003491 return rc;
drh30e58752002-03-02 20:41:57 +00003492}
3493
3494/*
3495** A call to this routine tells the pager that if a rollback occurs,
3496** it is not necessary to restore the data on the given page. This
3497** means that the pager does not have to record the given page in the
3498** rollback journal.
drh538f5702007-04-13 02:14:30 +00003499**
3500** If we have not yet actually read the content of this page (if
3501** the PgHdr.needRead flag is set) then this routine acts as a promise
3502** that we will never need to read the page content in the future.
3503** so the needRead flag can be cleared at this point.
drh30e58752002-03-02 20:41:57 +00003504*/
danielk19773b8a05f2007-03-19 17:44:26 +00003505void sqlite3PagerDontRollback(DbPage *pPg){
drh30e58752002-03-02 20:41:57 +00003506 Pager *pPager = pPg->pPager;
3507
drhd3627af2006-12-18 18:34:51 +00003508 assert( pPager->state>=PAGER_RESERVED );
danielk1977a55e9352008-01-21 13:04:34 +00003509
3510 /* If the journal file is not open, or DontWrite() has been called on
3511 ** this page (DontWrite() sets the alwaysRollback flag), then this
3512 ** function is a no-op.
3513 */
danielk1977a1fa00d2008-08-27 15:16:33 +00003514 if( pPager->journalOpen==0
3515 || sqlite3BitvecTest(pPager->pAlwaysRollback, pPg->pgno)
3516 || pPg->pgno>pPager->origDbSize
danielk19778c0a7912008-08-20 14:49:23 +00003517 ){
danielk197787c29a92008-01-18 11:33:16 +00003518 return;
3519 }
danielk1977a55e9352008-01-21 13:04:34 +00003520
drhc5d0bd92008-04-14 01:00:57 +00003521#ifdef SQLITE_SECURE_DELETE
drh1feb7dd2008-11-19 18:30:29 +00003522 if( sqlite3BitvecTest(pPager->pInJournal, pPg->pgno)!=0
3523 || pPg->pgno>pPager->origDbSize ){
drhc5d0bd92008-04-14 01:00:57 +00003524 return;
3525 }
3526#endif
3527
3528 /* If SECURE_DELETE is disabled, then there is no way that this
3529 ** routine can be called on a page for which sqlite3PagerDontWrite()
3530 ** has not been previously called during the same transaction.
3531 ** And if DontWrite() has previously been called, the following
3532 ** conditions must be met.
drh10131482008-07-11 03:34:09 +00003533 **
3534 ** (Later:) Not true. If the database is corrupted by having duplicate
3535 ** pages on the freelist (ex: corrupt9.test) then the following is not
3536 ** necessarily true:
danielk1977a55e9352008-01-21 13:04:34 +00003537 */
drh10131482008-07-11 03:34:09 +00003538 /* assert( !pPg->inJournal && (int)pPg->pgno <= pPager->origDbSize ); */
danielk1977a55e9352008-01-21 13:04:34 +00003539
drhf5e7bb52008-02-18 14:47:33 +00003540 assert( pPager->pInJournal!=0 );
3541 sqlite3BitvecSet(pPager->pInJournal, pPg->pgno);
danielk19778c0a7912008-08-20 14:49:23 +00003542 pPg->flags &= ~PGHDR_NEED_READ;
danielk1977fd7f0452008-12-17 17:30:26 +00003543 addToSavepointBitvecs(pPager, pPg->pgno);
danielk1977a55e9352008-01-21 13:04:34 +00003544 PAGERTRACE3("DONT_ROLLBACK page %d of %d\n", pPg->pgno, PAGERID(pPager));
3545 IOTRACE(("GARBAGE %p %d\n", pPager, pPg->pgno))
drh30e58752002-03-02 20:41:57 +00003546}
3547
drhac69b052004-05-12 13:30:07 +00003548
drh30e58752002-03-02 20:41:57 +00003549/*
drh80e35f42007-03-30 14:06:34 +00003550** This routine is called to increment the database file change-counter,
3551** stored at byte 24 of the pager file.
3552*/
danielk1977c7b60172007-08-22 11:22:03 +00003553static int pager_incr_changecounter(Pager *pPager, int isDirect){
drh80e35f42007-03-30 14:06:34 +00003554 PgHdr *pPgHdr;
3555 u32 change_counter;
danielk1977c7b60172007-08-22 11:22:03 +00003556 int rc = SQLITE_OK;
drh80e35f42007-03-30 14:06:34 +00003557
drh701bb3b2008-08-02 03:50:39 +00003558#ifndef SQLITE_ENABLE_ATOMIC_WRITE
3559 assert( isDirect==0 ); /* isDirect is only true for atomic writes */
3560#endif
danielk197712dd5492008-12-18 15:45:07 +00003561 if( !pPager->changeCountDone && pPager->dbSize>0 ){
drh80e35f42007-03-30 14:06:34 +00003562 /* Open page 1 of the file for writing. */
3563 rc = sqlite3PagerGet(pPager, 1, &pPgHdr);
3564 if( rc!=SQLITE_OK ) return rc;
danielk1977c7b60172007-08-22 11:22:03 +00003565
3566 if( !isDirect ){
3567 rc = sqlite3PagerWrite(pPgHdr);
danielk1977ae72d982007-10-03 08:46:44 +00003568 if( rc!=SQLITE_OK ){
3569 sqlite3PagerUnref(pPgHdr);
3570 return rc;
3571 }
danielk1977c7b60172007-08-22 11:22:03 +00003572 }
3573
drh80e35f42007-03-30 14:06:34 +00003574 /* Increment the value just read and write it back to byte 24. */
drhb1003912007-07-20 00:33:36 +00003575 change_counter = sqlite3Get4byte((u8*)pPager->dbFileVers);
drh80e35f42007-03-30 14:06:34 +00003576 change_counter++;
danielk19778c0a7912008-08-20 14:49:23 +00003577 put32bits(((char*)pPgHdr->pData)+24, change_counter);
danielk1977c7b60172007-08-22 11:22:03 +00003578
drh701bb3b2008-08-02 03:50:39 +00003579#ifdef SQLITE_ENABLE_ATOMIC_WRITE
danielk1977c7b60172007-08-22 11:22:03 +00003580 if( isDirect && pPager->fd->pMethods ){
danielk19778c0a7912008-08-20 14:49:23 +00003581 const void *zBuf = pPgHdr->pData;
danielk1977c7b60172007-08-22 11:22:03 +00003582 rc = sqlite3OsWrite(pPager->fd, zBuf, pPager->pageSize, 0);
3583 }
drh701bb3b2008-08-02 03:50:39 +00003584#endif
danielk1977c7b60172007-08-22 11:22:03 +00003585
drh80e35f42007-03-30 14:06:34 +00003586 /* Release the page reference. */
3587 sqlite3PagerUnref(pPgHdr);
3588 pPager->changeCountDone = 1;
3589 }
danielk1977c7b60172007-08-22 11:22:03 +00003590 return rc;
drh80e35f42007-03-30 14:06:34 +00003591}
3592
3593/*
danielk1977f653d782008-03-20 11:04:21 +00003594** Sync the pager file to disk.
3595*/
3596int sqlite3PagerSync(Pager *pPager){
3597 int rc;
drh7426f862008-08-26 21:07:26 +00003598 if( MEMDB ){
3599 rc = SQLITE_OK;
3600 }else{
3601 rc = sqlite3OsSync(pPager->fd, pPager->sync_flags);
3602 }
danielk1977f653d782008-03-20 11:04:21 +00003603 return rc;
3604}
3605
3606/*
drh80e35f42007-03-30 14:06:34 +00003607** Sync the database file for the pager pPager. zMaster points to the name
3608** of a master journal file that should be written into the individual
3609** journal file. zMaster may be NULL, which is interpreted as no master
3610** journal (a single database transaction).
3611**
3612** This routine ensures that the journal is synced, all dirty pages written
3613** to the database file and the database file synced. The only thing that
3614** remains to commit the transaction is to delete the journal file (or
3615** master journal file if specified).
3616**
3617** Note that if zMaster==NULL, this does not overwrite a previous value
3618** passed to an sqlite3PagerCommitPhaseOne() call.
3619**
3620** If parameter nTrunc is non-zero, then the pager file is truncated to
3621** nTrunc pages (this is used by auto-vacuum databases).
danielk1977f653d782008-03-20 11:04:21 +00003622**
3623** If the final parameter - noSync - is true, then the database file itself
3624** is not synced. The caller must call sqlite3PagerSync() directly to
3625** sync the database file before calling CommitPhaseTwo() to delete the
3626** journal file in this case.
drh80e35f42007-03-30 14:06:34 +00003627*/
danielk1977f653d782008-03-20 11:04:21 +00003628int sqlite3PagerCommitPhaseOne(
3629 Pager *pPager,
3630 const char *zMaster,
3631 Pgno nTrunc,
3632 int noSync
3633){
drh80e35f42007-03-30 14:06:34 +00003634 int rc = SQLITE_OK;
3635
danielk1977dad31b52008-05-15 11:08:07 +00003636 if( pPager->errCode ){
3637 return pPager->errCode;
3638 }
3639
drhd138c012008-05-13 00:58:18 +00003640 /* If no changes have been made, we can leave the transaction early.
3641 */
3642 if( pPager->dbModified==0 &&
3643 (pPager->journalMode!=PAGER_JOURNALMODE_DELETE ||
3644 pPager->exclusiveMode!=0) ){
3645 assert( pPager->dirtyCache==0 || pPager->journalOpen==0 );
3646 return SQLITE_OK;
3647 }
3648
drh80e35f42007-03-30 14:06:34 +00003649 PAGERTRACE4("DATABASE SYNC: File=%s zMaster=%s nTrunc=%d\n",
3650 pPager->zFilename, zMaster, nTrunc);
3651
3652 /* If this is an in-memory db, or no pages have been written to, or this
3653 ** function has already been called, it is a no-op.
3654 */
3655 if( pPager->state!=PAGER_SYNCED && !MEMDB && pPager->dirtyCache ){
3656 PgHdr *pPg;
drh80e35f42007-03-30 14:06:34 +00003657
danielk1977c7b60172007-08-22 11:22:03 +00003658#ifdef SQLITE_ENABLE_ATOMIC_WRITE
3659 /* The atomic-write optimization can be used if all of the
3660 ** following are true:
3661 **
3662 ** + The file-system supports the atomic-write property for
3663 ** blocks of size page-size, and
3664 ** + This commit is not part of a multi-file transaction, and
3665 ** + Exactly one page has been modified and store in the journal file.
3666 **
3667 ** If the optimization can be used, then the journal file will never
3668 ** be created for this transaction.
3669 */
danielk19774d60af92008-09-08 15:35:06 +00003670 int useAtomicWrite;
danielk19778c0a7912008-08-20 14:49:23 +00003671 pPg = sqlite3PcacheDirtyList(pPager->pPCache);
danielk19774d60af92008-09-08 15:35:06 +00003672 useAtomicWrite = (
danielk1977f55b8992007-08-24 08:15:53 +00003673 !zMaster &&
danielk1977700b9c52008-04-24 12:37:40 +00003674 pPager->journalOpen &&
danielk1977f55b8992007-08-24 08:15:53 +00003675 pPager->journalOff==jrnlBufferSize(pPager) &&
3676 nTrunc==0 &&
danielk19778c0a7912008-08-20 14:49:23 +00003677 (pPg==0 || pPg->pDirty==0)
danielk1977f55b8992007-08-24 08:15:53 +00003678 );
danielk1977700b9c52008-04-24 12:37:40 +00003679 assert( pPager->journalOpen || pPager->journalMode==PAGER_JOURNALMODE_OFF );
danielk1977f55b8992007-08-24 08:15:53 +00003680 if( useAtomicWrite ){
danielk1977c7b60172007-08-22 11:22:03 +00003681 /* Update the nRec field in the journal file. */
3682 int offset = pPager->journalHdr + sizeof(aJournalMagic);
3683 assert(pPager->nRec==1);
3684 rc = write32bits(pPager->jfd, offset, pPager->nRec);
3685
3686 /* Update the db file change counter. The following call will modify
3687 ** the in-memory representation of page 1 to include the updated
3688 ** change counter and then write page 1 directly to the database
3689 ** file. Because of the atomic-write property of the host file-system,
3690 ** this is safe.
3691 */
danielk1977ae72d982007-10-03 08:46:44 +00003692 if( rc==SQLITE_OK ){
3693 rc = pager_incr_changecounter(pPager, 1);
3694 }
danielk1977f55b8992007-08-24 08:15:53 +00003695 }else{
3696 rc = sqlite3JournalCreate(pPager->jfd);
danielk1977f55b8992007-08-24 08:15:53 +00003697 }
3698
danielk1977ae72d982007-10-03 08:46:44 +00003699 if( !useAtomicWrite && rc==SQLITE_OK )
danielk1977c7b60172007-08-22 11:22:03 +00003700#endif
3701
drh80e35f42007-03-30 14:06:34 +00003702 /* If a master journal file name has already been written to the
3703 ** journal file, then no sync is required. This happens when it is
3704 ** written, then the process fails to upgrade from a RESERVED to an
3705 ** EXCLUSIVE lock. The next time the process tries to commit the
3706 ** transaction the m-j name will have already been written.
3707 */
3708 if( !pPager->setMaster ){
danielk1977c7b60172007-08-22 11:22:03 +00003709 rc = pager_incr_changecounter(pPager, 0);
drh80e35f42007-03-30 14:06:34 +00003710 if( rc!=SQLITE_OK ) goto sync_exit;
danielk197771aa7ff2008-05-20 07:05:09 +00003711 if( pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
drh80e35f42007-03-30 14:06:34 +00003712#ifndef SQLITE_OMIT_AUTOVACUUM
danielk197771aa7ff2008-05-20 07:05:09 +00003713 if( nTrunc!=0 ){
3714 /* If this transaction has made the database smaller, then all pages
3715 ** being discarded by the truncation must be written to the journal
3716 ** file.
3717 */
3718 Pgno i;
danielk1977d92db532008-11-17 04:56:24 +00003719 Pgno iSkip = PAGER_MJ_PGNO(pPager);
danielk197771aa7ff2008-05-20 07:05:09 +00003720 for( i=nTrunc+1; i<=pPager->origDbSize; i++ ){
3721 if( !sqlite3BitvecTest(pPager->pInJournal, i) && i!=iSkip ){
3722 rc = sqlite3PagerGet(pPager, i, &pPg);
3723 if( rc!=SQLITE_OK ) goto sync_exit;
3724 rc = sqlite3PagerWrite(pPg);
3725 sqlite3PagerUnref(pPg);
3726 if( rc!=SQLITE_OK ) goto sync_exit;
3727 }
3728 }
3729 }
drh80e35f42007-03-30 14:06:34 +00003730#endif
danielk197771aa7ff2008-05-20 07:05:09 +00003731 rc = writeMasterJournal(pPager, zMaster);
3732 if( rc!=SQLITE_OK ) goto sync_exit;
3733 rc = syncJournal(pPager);
3734 }
drh80e35f42007-03-30 14:06:34 +00003735 }
danielk1977c7b60172007-08-22 11:22:03 +00003736 if( rc!=SQLITE_OK ) goto sync_exit;
drh80e35f42007-03-30 14:06:34 +00003737
3738#ifndef SQLITE_OMIT_AUTOVACUUM
3739 if( nTrunc!=0 ){
3740 rc = sqlite3PagerTruncate(pPager, nTrunc);
3741 if( rc!=SQLITE_OK ) goto sync_exit;
3742 }
3743#endif
3744
3745 /* Write all dirty pages to the database file */
danielk19778c0a7912008-08-20 14:49:23 +00003746 pPg = sqlite3PcacheDirtyList(pPager->pPCache);
drh80e35f42007-03-30 14:06:34 +00003747 rc = pager_write_pagelist(pPg);
drh153c62c2007-08-24 03:51:33 +00003748 if( rc!=SQLITE_OK ){
drh04c3a462008-02-26 16:16:45 +00003749 assert( rc!=SQLITE_IOERR_BLOCKED );
3750 /* The error might have left the dirty list all fouled up here,
3751 ** but that does not matter because if the if the dirty list did
3752 ** get corrupted, then the transaction will roll back and
3753 ** discard the dirty list. There is an assert in
3754 ** pager_get_all_dirty_pages() that verifies that no attempt
3755 ** is made to use an invalid dirty list.
3756 */
drh153c62c2007-08-24 03:51:33 +00003757 goto sync_exit;
3758 }
danielk19778c0a7912008-08-20 14:49:23 +00003759 sqlite3PcacheCleanAll(pPager->pPCache);
drh80e35f42007-03-30 14:06:34 +00003760
3761 /* Sync the database file. */
danielk1977f653d782008-03-20 11:04:21 +00003762 if( !pPager->noSync && !noSync ){
danielk1977f036aef2007-08-20 05:36:51 +00003763 rc = sqlite3OsSync(pPager->fd, pPager->sync_flags);
drh80e35f42007-03-30 14:06:34 +00003764 }
3765 IOTRACE(("DBSYNC %p\n", pPager))
3766
3767 pPager->state = PAGER_SYNCED;
3768 }else if( MEMDB && nTrunc!=0 ){
3769 rc = sqlite3PagerTruncate(pPager, nTrunc);
3770 }
3771
3772sync_exit:
danielk1977e965ac72007-06-13 15:22:28 +00003773 if( rc==SQLITE_IOERR_BLOCKED ){
3774 /* pager_incr_changecounter() may attempt to obtain an exclusive
3775 * lock to spill the cache and return IOERR_BLOCKED. But since
drh85b623f2007-12-13 21:54:09 +00003776 * there is no chance the cache is inconsistent, it is
danielk1977e965ac72007-06-13 15:22:28 +00003777 * better to return SQLITE_BUSY.
3778 */
3779 rc = SQLITE_BUSY;
3780 }
drh80e35f42007-03-30 14:06:34 +00003781 return rc;
3782}
3783
3784
3785/*
drhed7c8552001-04-11 14:29:21 +00003786** Commit all changes to the database and release the write lock.
drhd9b02572001-04-15 00:37:09 +00003787**
3788** If the commit fails for any reason, a rollback attempt is made
3789** and an error code is returned. If the commit worked, SQLITE_OK
3790** is returned.
drhed7c8552001-04-11 14:29:21 +00003791*/
drh80e35f42007-03-30 14:06:34 +00003792int sqlite3PagerCommitPhaseTwo(Pager *pPager){
danielk19778c0a7912008-08-20 14:49:23 +00003793 int rc = SQLITE_OK;
drhd9b02572001-04-15 00:37:09 +00003794
danielk1977efaaf572006-01-16 11:29:19 +00003795 if( pPager->errCode ){
danielk19777f7bc662006-01-23 13:47:47 +00003796 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00003797 }
drha6abd042004-06-09 17:37:22 +00003798 if( pPager->state<PAGER_RESERVED ){
drhd9b02572001-04-15 00:37:09 +00003799 return SQLITE_ERROR;
3800 }
drhd138c012008-05-13 00:58:18 +00003801 if( pPager->dbModified==0 &&
3802 (pPager->journalMode!=PAGER_JOURNALMODE_DELETE ||
3803 pPager->exclusiveMode!=0) ){
3804 assert( pPager->dirtyCache==0 || pPager->journalOpen==0 );
3805 return SQLITE_OK;
3806 }
drh4f0c5872007-03-26 22:05:01 +00003807 PAGERTRACE2("COMMIT %d\n", PAGERID(pPager));
danielk1977b3175382008-10-17 18:51:52 +00003808 assert( pPager->state==PAGER_SYNCED || MEMDB || !pPager->dirtyCache );
3809 rc = pager_end_transaction(pPager, pPager->setMaster);
3810 rc = pager_error(pPager, rc);
drh86f8c192007-08-22 00:39:19 +00003811 return rc;
drhed7c8552001-04-11 14:29:21 +00003812}
3813
3814/*
drha6abd042004-06-09 17:37:22 +00003815** Rollback all changes. The database falls back to PAGER_SHARED mode.
drhed7c8552001-04-11 14:29:21 +00003816** All in-memory cache pages revert to their original data contents.
3817** The journal is deleted.
drhd9b02572001-04-15 00:37:09 +00003818**
3819** This routine cannot fail unless some other process is not following
drh4f0ee682007-03-30 20:43:40 +00003820** the correct locking protocol or unless some other
drhd9b02572001-04-15 00:37:09 +00003821** process is writing trash into the journal file (SQLITE_CORRUPT) or
3822** unless a prior malloc() failed (SQLITE_NOMEM). Appropriate error
3823** codes are returned for all these occasions. Otherwise,
3824** SQLITE_OK is returned.
drhed7c8552001-04-11 14:29:21 +00003825*/
danielk19773b8a05f2007-03-19 17:44:26 +00003826int sqlite3PagerRollback(Pager *pPager){
danielk19778c0a7912008-08-20 14:49:23 +00003827 int rc = SQLITE_OK;
drh4f0c5872007-03-26 22:05:01 +00003828 PAGERTRACE2("ROLLBACK %d\n", PAGERID(pPager));
danielk1977b3175382008-10-17 18:51:52 +00003829 if( !pPager->dirtyCache || !pPager->journalOpen ){
danielk1977df2566a2008-05-07 19:11:03 +00003830 rc = pager_end_transaction(pPager, pPager->setMaster);
danielk19778c0a7912008-08-20 14:49:23 +00003831 }else if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
drha6abd042004-06-09 17:37:22 +00003832 if( pPager->state>=PAGER_EXCLUSIVE ){
danielk1977e277be02007-03-23 18:12:06 +00003833 pager_playback(pPager, 0);
drh4b845d72002-03-05 12:41:19 +00003834 }
danielk19778c0a7912008-08-20 14:49:23 +00003835 rc = pPager->errCode;
drha6abd042004-06-09 17:37:22 +00003836 }else{
danielk19778c0a7912008-08-20 14:49:23 +00003837 if( pPager->state==PAGER_RESERVED ){
3838 int rc2;
3839 rc = pager_playback(pPager, 0);
3840 rc2 = pager_end_transaction(pPager, pPager->setMaster);
3841 if( rc==SQLITE_OK ){
3842 rc = rc2;
3843 }
3844 }else{
3845 rc = pager_playback(pPager, 0);
3846 }
danielk197707cb5602006-01-20 10:55:05 +00003847
danielk1977b3175382008-10-17 18:51:52 +00003848 if( !MEMDB ){
danielk1977d92db532008-11-17 04:56:24 +00003849 pPager->dbSizeValid = 0;
danielk1977b3175382008-10-17 18:51:52 +00003850 }
danielk19778c0a7912008-08-20 14:49:23 +00003851
3852 /* If an error occurs during a ROLLBACK, we can no longer trust the pager
3853 ** cache. So call pager_error() on the way out to make any error
3854 ** persistent.
3855 */
3856 rc = pager_error(pPager, rc);
3857 }
drh86f8c192007-08-22 00:39:19 +00003858 return rc;
drh98808ba2001-10-18 12:34:46 +00003859}
drhd9b02572001-04-15 00:37:09 +00003860
3861/*
drh5e00f6c2001-09-13 13:46:56 +00003862** Return TRUE if the database file is opened read-only. Return FALSE
3863** if the database is (in theory) writable.
3864*/
drhf49661a2008-12-10 16:45:50 +00003865u8 sqlite3PagerIsreadonly(Pager *pPager){
drhbe0072d2001-09-13 14:46:09 +00003866 return pPager->readOnly;
drh5e00f6c2001-09-13 13:46:56 +00003867}
3868
3869/*
drh0f7eb612006-08-08 13:51:43 +00003870** Return the number of references to the pager.
3871*/
danielk19773b8a05f2007-03-19 17:44:26 +00003872int sqlite3PagerRefcount(Pager *pPager){
danielk19778c0a7912008-08-20 14:49:23 +00003873 return sqlite3PcacheRefCount(pPager->pPCache);
drh0f7eb612006-08-08 13:51:43 +00003874}
3875
danielk197771d5d2c2008-09-29 11:49:47 +00003876/*
3877** Return the number of references to the specified page.
3878*/
3879int sqlite3PagerPageRefcount(DbPage *pPage){
3880 return sqlite3PcachePageRefcount(pPage);
3881}
3882
drh0f7eb612006-08-08 13:51:43 +00003883#ifdef SQLITE_TEST
3884/*
drhd9b02572001-04-15 00:37:09 +00003885** This routine is used for testing and analysis only.
3886*/
danielk19773b8a05f2007-03-19 17:44:26 +00003887int *sqlite3PagerStats(Pager *pPager){
danielk197742741be2005-01-08 12:42:39 +00003888 static int a[11];
danielk19778c0a7912008-08-20 14:49:23 +00003889 a[0] = sqlite3PcacheRefCount(pPager->pPCache);
3890 a[1] = sqlite3PcachePagecount(pPager->pPCache);
3891 a[2] = sqlite3PcacheGetCachesize(pPager->pPCache);
danielk1977d92db532008-11-17 04:56:24 +00003892 a[3] = pPager->dbSizeValid ? (int) pPager->dbSize : -1;
drhd9b02572001-04-15 00:37:09 +00003893 a[4] = pPager->state;
danielk1977efaaf572006-01-16 11:29:19 +00003894 a[5] = pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00003895 a[6] = pPager->nHit;
3896 a[7] = pPager->nMiss;
drh7c4ac0c2007-04-05 11:25:58 +00003897 a[8] = 0; /* Used to be pPager->nOvfl */
danielk197742741be2005-01-08 12:42:39 +00003898 a[9] = pPager->nRead;
3899 a[10] = pPager->nWrite;
drhd9b02572001-04-15 00:37:09 +00003900 return a;
3901}
danielk197717b90b52008-06-06 11:11:25 +00003902int sqlite3PagerIsMemdb(Pager *pPager){
3903 return MEMDB;
3904}
drh0f7eb612006-08-08 13:51:43 +00003905#endif
drhdd793422001-06-28 01:54:48 +00003906
drhfa86c412002-02-02 15:01:15 +00003907/*
danielk1977fd7f0452008-12-17 17:30:26 +00003908** Ensure that there are at least nSavepoint savepoints open.
drhfa86c412002-02-02 15:01:15 +00003909*/
danielk1977fd7f0452008-12-17 17:30:26 +00003910int sqlite3PagerOpenSavepoint(Pager *pPager, int nSavepoint){
3911 int rc = SQLITE_OK;
3912
danielk197712dd5492008-12-18 15:45:07 +00003913 if( nSavepoint>pPager->nSavepoint && pPager->useJournal ){
danielk1977fd7f0452008-12-17 17:30:26 +00003914 int ii;
3915
3916 /* Either the sub-journal is open or there are no active savepoints. */
3917 assert( pPager->nSavepoint==0 || pPager->sjfd->pMethods );
3918
3919 /* Grow the Pager.aSavepoint array using realloc(). Return SQLITE_NOMEM
3920 ** if the allocation fails. Otherwise, zero the new portion in case a
3921 ** malloc failure occurs while populating it in the for(...) loop below.
3922 */
3923 PagerSavepoint *aNew = (PagerSavepoint *)sqlite3Realloc(
3924 pPager->aSavepoint, sizeof(PagerSavepoint)*nSavepoint
3925 );
3926 if( !aNew ){
3927 return SQLITE_NOMEM;
3928 }
3929 memset(&aNew[pPager->nSavepoint], 0,
3930 (nSavepoint - pPager->nSavepoint) * sizeof(PagerSavepoint)
3931 );
3932 pPager->aSavepoint = aNew;
3933 ii = pPager->nSavepoint;
3934 pPager->nSavepoint = nSavepoint;
3935
3936 /* Populate the PagerSavepoint structures just allocated. */
3937 for(/* no-op */; ii<nSavepoint; ii++){
danielk197712dd5492008-12-18 15:45:07 +00003938 assert( pPager->dbSizeValid );
danielk1977fd7f0452008-12-17 17:30:26 +00003939 aNew[ii].nOrig = pPager->dbSize;
3940 aNew[ii].iOffset = (pPager->journalOpen ? pPager->journalOff : 0);
3941 aNew[ii].iSubRec = pPager->stmtNRec;
3942 aNew[ii].pInSavepoint = sqlite3BitvecCreate(pPager->dbSize);
3943 if( !aNew[ii].pInSavepoint ){
3944 return SQLITE_NOMEM;
danielk1977b3175382008-10-17 18:51:52 +00003945 }
drh334b2992007-09-06 23:28:23 +00003946 }
danielk1977fd7f0452008-12-17 17:30:26 +00003947
3948 /* Open the sub-journal, if it is not already opened. */
3949 rc = openSubJournal(pPager);
drh0f892532002-05-30 12:27:03 +00003950 }
danielk1977fd7f0452008-12-17 17:30:26 +00003951
drh86f8c192007-08-22 00:39:19 +00003952 return rc;
3953}
drhfa86c412002-02-02 15:01:15 +00003954
3955/*
danielk1977fd7f0452008-12-17 17:30:26 +00003956** Parameter op is always either SAVEPOINT_ROLLBACK or SAVEPOINT_RELEASE.
3957** If it is SAVEPOINT_RELEASE, then release and destroy the savepoint with
3958** index iSavepoint. If it is SAVEPOINT_ROLLBACK, then rollback all changes
3959** that have occured since savepoint iSavepoint was created.
3960**
3961** In either case, all savepoints with an index greater than iSavepoint
3962** are destroyed.
3963**
3964** If there are less than (iSavepoint+1) active savepoints when this
3965** function is called it is a no-op.
3966*/
3967int sqlite3PagerSavepoint(Pager *pPager, int op, int iSavepoint){
3968 int rc = SQLITE_OK;
3969
3970 assert( op==SAVEPOINT_RELEASE || op==SAVEPOINT_ROLLBACK );
3971
3972 if( iSavepoint<pPager->nSavepoint ){
3973 int ii;
3974 int nNew = iSavepoint + (op==SAVEPOINT_ROLLBACK);
3975 for(ii=nNew; ii<pPager->nSavepoint; ii++){
3976 sqlite3BitvecDestroy(pPager->aSavepoint[ii].pInSavepoint);
3977 }
3978 pPager->nSavepoint = nNew;
3979
3980 if( op==SAVEPOINT_ROLLBACK ){
3981 PagerSavepoint *pSavepoint = (nNew==0) ? 0 : &pPager->aSavepoint[nNew-1];
3982 rc = pagerPlaybackSavepoint(pPager, pSavepoint);
3983 assert(rc!=SQLITE_DONE);
3984 }
3985
3986 /* If this is a release of the outermost savepoint, truncate
3987 ** the sub-journal. */
3988 if( nNew==0 && op==SAVEPOINT_RELEASE && pPager->sjfd->pMethods ){
3989 assert( rc==SQLITE_OK );
3990 rc = sqlite3OsTruncate(pPager->sjfd, 0);
3991 pPager->stmtNRec = 0;
danielk1977b3175382008-10-17 18:51:52 +00003992 }
drh663fc632002-02-02 18:49:19 +00003993 }
drhfa86c412002-02-02 15:01:15 +00003994 return rc;
3995}
3996
drh73509ee2003-04-06 20:44:45 +00003997/*
3998** Return the full pathname of the database file.
3999*/
danielk19773b8a05f2007-03-19 17:44:26 +00004000const char *sqlite3PagerFilename(Pager *pPager){
drh73509ee2003-04-06 20:44:45 +00004001 return pPager->zFilename;
4002}
4003
drhb20ea9d2004-02-09 01:20:36 +00004004/*
drhd0679ed2007-08-28 22:24:34 +00004005** Return the VFS structure for the pager.
4006*/
4007const sqlite3_vfs *sqlite3PagerVfs(Pager *pPager){
4008 return pPager->pVfs;
4009}
4010
4011/*
drhcc6bb3e2007-08-31 16:11:35 +00004012** Return the file handle for the database file associated
4013** with the pager. This might return NULL if the file has
4014** not yet been opened.
4015*/
4016sqlite3_file *sqlite3PagerFile(Pager *pPager){
4017 return pPager->fd;
4018}
4019
4020/*
danielk19775865e3d2004-06-14 06:03:57 +00004021** Return the directory of the database file.
4022*/
danielk19773b8a05f2007-03-19 17:44:26 +00004023const char *sqlite3PagerDirname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00004024 return pPager->zDirectory;
4025}
4026
4027/*
4028** Return the full pathname of the journal file.
4029*/
danielk19773b8a05f2007-03-19 17:44:26 +00004030const char *sqlite3PagerJournalname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00004031 return pPager->zJournal;
4032}
4033
4034/*
drh2c8997b2005-08-27 16:36:48 +00004035** Return true if fsync() calls are disabled for this pager. Return FALSE
4036** if fsync()s are executed normally.
4037*/
danielk19773b8a05f2007-03-19 17:44:26 +00004038int sqlite3PagerNosync(Pager *pPager){
drh2c8997b2005-08-27 16:36:48 +00004039 return pPager->noSync;
4040}
4041
drh7c4ac0c2007-04-05 11:25:58 +00004042#ifdef SQLITE_HAS_CODEC
drh2c8997b2005-08-27 16:36:48 +00004043/*
drhb20ea9d2004-02-09 01:20:36 +00004044** Set the codec for this pager
4045*/
danielk19773b8a05f2007-03-19 17:44:26 +00004046void sqlite3PagerSetCodec(
drhb20ea9d2004-02-09 01:20:36 +00004047 Pager *pPager,
drhc001c582006-03-06 18:23:16 +00004048 void *(*xCodec)(void*,void*,Pgno,int),
drhb20ea9d2004-02-09 01:20:36 +00004049 void *pCodecArg
4050){
4051 pPager->xCodec = xCodec;
4052 pPager->pCodecArg = pCodecArg;
4053}
drh7c4ac0c2007-04-05 11:25:58 +00004054#endif
drhb20ea9d2004-02-09 01:20:36 +00004055
danielk1977687566d2004-11-02 12:56:41 +00004056#ifndef SQLITE_OMIT_AUTOVACUUM
4057/*
danielk197787c29a92008-01-18 11:33:16 +00004058** Move the page pPg to location pgno in the file.
danielk1977687566d2004-11-02 12:56:41 +00004059**
drh5e385312007-06-16 04:42:12 +00004060** There must be no references to the page previously located at
4061** pgno (which we call pPgOld) though that page is allowed to be
drhb3df2e12008-09-17 20:06:26 +00004062** in cache. If the page previously located at pgno is not already
drh5e385312007-06-16 04:42:12 +00004063** in the rollback journal, it is not put there by by this routine.
danielk1977687566d2004-11-02 12:56:41 +00004064**
drh5e385312007-06-16 04:42:12 +00004065** References to the page pPg remain valid. Updating any
4066** meta-data associated with pPg (i.e. data stored in the nExtra bytes
danielk1977687566d2004-11-02 12:56:41 +00004067** allocated along with the page) is the responsibility of the caller.
4068**
danielk19775fd057a2005-03-09 13:09:43 +00004069** A transaction must be active when this routine is called. It used to be
4070** required that a statement transaction was not active, but this restriction
4071** has been removed (CREATE INDEX needs to move a page when a statement
4072** transaction is active).
danielk19774c999992008-07-16 18:17:55 +00004073**
4074** If the fourth argument, isCommit, is non-zero, then this page is being
4075** moved as part of a database reorganization just before the transaction
4076** is being committed. In this case, it is guaranteed that the database page
4077** pPg refers to will not be written to again within this transaction.
danielk1977687566d2004-11-02 12:56:41 +00004078*/
danielk19774c999992008-07-16 18:17:55 +00004079int sqlite3PagerMovepage(Pager *pPager, DbPage *pPg, Pgno pgno, int isCommit){
drh5e385312007-06-16 04:42:12 +00004080 PgHdr *pPgOld; /* The page being overwritten. */
danielk197794daf7f2004-11-08 09:26:09 +00004081 Pgno needSyncPgno = 0;
danielk1977687566d2004-11-02 12:56:41 +00004082
danielk1977687566d2004-11-02 12:56:41 +00004083 assert( pPg->nRef>0 );
4084
drh4f0c5872007-03-26 22:05:01 +00004085 PAGERTRACE5("MOVE %d page %d (needSync=%d) moves to %d\n",
danielk19778c0a7912008-08-20 14:49:23 +00004086 PAGERID(pPager), pPg->pgno, (pPg->flags&PGHDR_NEED_SYNC)?1:0, pgno);
drhb0603412007-02-28 04:47:26 +00004087 IOTRACE(("MOVE %p %d %d\n", pPager, pPg->pgno, pgno))
danielk1977ef73ee92004-11-06 12:26:07 +00004088
danielk1977b4626a32007-04-28 15:47:43 +00004089 pager_get_content(pPg);
danielk19774c999992008-07-16 18:17:55 +00004090
4091 /* If the journal needs to be sync()ed before page pPg->pgno can
4092 ** be written to, store pPg->pgno in local variable needSyncPgno.
4093 **
4094 ** If the isCommit flag is set, there is no need to remember that
4095 ** the journal needs to be sync()ed before database page pPg->pgno
4096 ** can be written to. The caller has already promised not to write to it.
4097 */
danielk19778c0a7912008-08-20 14:49:23 +00004098 if( (pPg->flags&PGHDR_NEED_SYNC) && !isCommit ){
danielk197794daf7f2004-11-08 09:26:09 +00004099 needSyncPgno = pPg->pgno;
danielk19770cd1bbd2008-11-26 07:25:52 +00004100 assert( pageInJournal(pPg) || pPg->pgno>pPager->origDbSize );
danielk19778c0a7912008-08-20 14:49:23 +00004101 assert( pPg->flags&PGHDR_DIRTY );
danielk1977ae825582004-11-23 09:06:55 +00004102 assert( pPager->needSync );
danielk197794daf7f2004-11-08 09:26:09 +00004103 }
4104
danielk1977ef73ee92004-11-06 12:26:07 +00004105 /* If the cache contains a page with page-number pgno, remove it
drh85b623f2007-12-13 21:54:09 +00004106 ** from its hash chain. Also, if the PgHdr.needSync was set for
danielk1977599fcba2004-11-08 07:13:13 +00004107 ** page pgno before the 'move' operation, it needs to be retained
4108 ** for the page moved there.
danielk1977f5fdda82004-11-03 08:44:05 +00004109 */
danielk1977bc2ca9e2008-11-13 14:28:28 +00004110 pPg->flags &= ~PGHDR_NEED_SYNC;
danielk1977687566d2004-11-02 12:56:41 +00004111 pPgOld = pager_lookup(pPager, pgno);
danielk19778c0a7912008-08-20 14:49:23 +00004112 assert( !pPgOld || pPgOld->nRef==1 );
danielk1977687566d2004-11-02 12:56:41 +00004113 if( pPgOld ){
danielk19778c0a7912008-08-20 14:49:23 +00004114 pPg->flags |= (pPgOld->flags&PGHDR_NEED_SYNC);
drh5e385312007-06-16 04:42:12 +00004115 }
danielk1977687566d2004-11-02 12:56:41 +00004116
danielk19778c0a7912008-08-20 14:49:23 +00004117 sqlite3PcacheMove(pPg, pgno);
4118 if( pPgOld ){
danielk1977bc2ca9e2008-11-13 14:28:28 +00004119 sqlite3PcacheDrop(pPgOld);
danielk1977f5fdda82004-11-03 08:44:05 +00004120 }
danielk1977f5fdda82004-11-03 08:44:05 +00004121
drhc047b9f2008-11-21 03:23:43 +00004122 sqlite3PcacheMakeDirty(pPg);
danielk1977687566d2004-11-02 12:56:41 +00004123 pPager->dirtyCache = 1;
drhd138c012008-05-13 00:58:18 +00004124 pPager->dbModified = 1;
danielk1977687566d2004-11-02 12:56:41 +00004125
danielk197794daf7f2004-11-08 09:26:09 +00004126 if( needSyncPgno ){
4127 /* If needSyncPgno is non-zero, then the journal file needs to be
4128 ** sync()ed before any data is written to database file page needSyncPgno.
4129 ** Currently, no such page exists in the page-cache and the
danielk19774c999992008-07-16 18:17:55 +00004130 ** "is journaled" bitvec flag has been set. This needs to be remedied by
4131 ** loading the page into the pager-cache and setting the PgHdr.needSync
4132 ** flag.
danielk1977ae825582004-11-23 09:06:55 +00004133 **
danielk1977a98d7b42008-01-18 13:42:54 +00004134 ** If the attempt to load the page into the page-cache fails, (due
drhf5e7bb52008-02-18 14:47:33 +00004135 ** to a malloc() or IO failure), clear the bit in the pInJournal[]
danielk1977a98d7b42008-01-18 13:42:54 +00004136 ** array. Otherwise, if the page is loaded and written again in
4137 ** this transaction, it may be written to the database file before
4138 ** it is synced into the journal file. This way, it may end up in
4139 ** the journal file twice, but that is not a problem.
4140 **
danielk19773b8a05f2007-03-19 17:44:26 +00004141 ** The sqlite3PagerGet() call may cause the journal to sync. So make
danielk1977ae825582004-11-23 09:06:55 +00004142 ** sure the Pager.needSync flag is set too.
danielk197794daf7f2004-11-08 09:26:09 +00004143 */
4144 int rc;
danielk19773b8a05f2007-03-19 17:44:26 +00004145 PgHdr *pPgHdr;
danielk1977ae825582004-11-23 09:06:55 +00004146 assert( pPager->needSync );
danielk19773b8a05f2007-03-19 17:44:26 +00004147 rc = sqlite3PagerGet(pPager, needSyncPgno, &pPgHdr);
danielk197787c29a92008-01-18 11:33:16 +00004148 if( rc!=SQLITE_OK ){
danielk1977d92db532008-11-17 04:56:24 +00004149 if( pPager->pInJournal && needSyncPgno<=pPager->origDbSize ){
drhf5e7bb52008-02-18 14:47:33 +00004150 sqlite3BitvecClear(pPager->pInJournal, needSyncPgno);
danielk1977a98d7b42008-01-18 13:42:54 +00004151 }
danielk197787c29a92008-01-18 11:33:16 +00004152 return rc;
4153 }
danielk1977ae825582004-11-23 09:06:55 +00004154 pPager->needSync = 1;
drhb3df2e12008-09-17 20:06:26 +00004155 assert( pPager->noSync==0 && !MEMDB );
danielk19778c0a7912008-08-20 14:49:23 +00004156 pPgHdr->flags |= PGHDR_NEED_SYNC;
drhc047b9f2008-11-21 03:23:43 +00004157 sqlite3PcacheMakeDirty(pPgHdr);
danielk19773b8a05f2007-03-19 17:44:26 +00004158 sqlite3PagerUnref(pPgHdr);
danielk197794daf7f2004-11-08 09:26:09 +00004159 }
4160
danielk1977687566d2004-11-02 12:56:41 +00004161 return SQLITE_OK;
4162}
4163#endif
4164
danielk19773b8a05f2007-03-19 17:44:26 +00004165/*
4166** Return a pointer to the data for the specified page.
4167*/
4168void *sqlite3PagerGetData(DbPage *pPg){
danielk197771d5d2c2008-09-29 11:49:47 +00004169 assert( pPg->nRef>0 || pPg->pPager->memDb );
danielk19778c0a7912008-08-20 14:49:23 +00004170 return pPg->pData;
danielk19773b8a05f2007-03-19 17:44:26 +00004171}
4172
4173/*
4174** Return a pointer to the Pager.nExtra bytes of "extra" space
4175** allocated along with the specified page.
4176*/
4177void *sqlite3PagerGetExtra(DbPage *pPg){
4178 Pager *pPager = pPg->pPager;
danielk19778c0a7912008-08-20 14:49:23 +00004179 return (pPager?pPg->pExtra:0);
danielk19773b8a05f2007-03-19 17:44:26 +00004180}
4181
danielk197741483462007-03-24 16:45:04 +00004182/*
4183** Get/set the locking-mode for this pager. Parameter eMode must be one
4184** of PAGER_LOCKINGMODE_QUERY, PAGER_LOCKINGMODE_NORMAL or
4185** PAGER_LOCKINGMODE_EXCLUSIVE. If the parameter is not _QUERY, then
4186** the locking-mode is set to the value specified.
4187**
4188** The returned value is either PAGER_LOCKINGMODE_NORMAL or
4189** PAGER_LOCKINGMODE_EXCLUSIVE, indicating the current (possibly updated)
4190** locking-mode.
4191*/
4192int sqlite3PagerLockingMode(Pager *pPager, int eMode){
drh369339d2007-03-30 16:01:55 +00004193 assert( eMode==PAGER_LOCKINGMODE_QUERY
4194 || eMode==PAGER_LOCKINGMODE_NORMAL
4195 || eMode==PAGER_LOCKINGMODE_EXCLUSIVE );
4196 assert( PAGER_LOCKINGMODE_QUERY<0 );
4197 assert( PAGER_LOCKINGMODE_NORMAL>=0 && PAGER_LOCKINGMODE_EXCLUSIVE>=0 );
4198 if( eMode>=0 && !pPager->tempFile ){
drh1bd10f82008-12-10 21:19:56 +00004199 pPager->exclusiveMode = (u8)eMode;
danielk197741483462007-03-24 16:45:04 +00004200 }
4201 return (int)pPager->exclusiveMode;
4202}
4203
drh3b020132008-04-17 17:02:01 +00004204/*
drh04335882008-09-26 21:08:08 +00004205** Get/set the journal-mode for this pager. Parameter eMode must be one of:
drh3b020132008-04-17 17:02:01 +00004206**
drh04335882008-09-26 21:08:08 +00004207** PAGER_JOURNALMODE_QUERY
4208** PAGER_JOURNALMODE_DELETE
4209** PAGER_JOURNALMODE_TRUNCATE
4210** PAGER_JOURNALMODE_PERSIST
4211** PAGER_JOURNALMODE_OFF
4212**
4213** If the parameter is not _QUERY, then the journal-mode is set to the
4214** value specified.
4215**
4216** The returned indicate the current (possibly updated)
drh3b020132008-04-17 17:02:01 +00004217** journal-mode.
4218*/
4219int sqlite3PagerJournalMode(Pager *pPager, int eMode){
danielk1977b3175382008-10-17 18:51:52 +00004220 if( !MEMDB ){
4221 assert( eMode==PAGER_JOURNALMODE_QUERY
4222 || eMode==PAGER_JOURNALMODE_DELETE
4223 || eMode==PAGER_JOURNALMODE_TRUNCATE
4224 || eMode==PAGER_JOURNALMODE_PERSIST
4225 || eMode==PAGER_JOURNALMODE_OFF
4226 || eMode==PAGER_JOURNALMODE_MEMORY );
4227 assert( PAGER_JOURNALMODE_QUERY<0 );
4228 if( eMode>=0 ){
drh1bd10f82008-12-10 21:19:56 +00004229 pPager->journalMode = (u8)eMode;
danielk1977b3175382008-10-17 18:51:52 +00004230 }else{
4231 assert( eMode==PAGER_JOURNALMODE_QUERY );
4232 }
drh3b020132008-04-17 17:02:01 +00004233 }
drhfdc40e92008-04-17 20:59:37 +00004234 return (int)pPager->journalMode;
drh3b020132008-04-17 17:02:01 +00004235}
4236
danielk1977b53e4962008-06-04 06:45:59 +00004237/*
4238** Get/set the size-limit used for persistent journal files.
4239*/
4240i64 sqlite3PagerJournalSizeLimit(Pager *pPager, i64 iLimit){
4241 if( iLimit>=-1 ){
4242 pPager->journalSizeLimit = iLimit;
4243 }
4244 return pPager->journalSizeLimit;
4245}
4246
drh2e66f0b2005-04-28 17:18:48 +00004247#endif /* SQLITE_OMIT_DISKIO */