blob: d1b5779d46e173f036421dc96d7c0be00319574b [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**
drhaf6df112005-06-07 02:12:30 +000021** @(#) $Id: pager.c,v 1.207 2005/06/07 02:12:30 drh Exp $
drhed7c8552001-04-11 14:29:21 +000022*/
drh2e66f0b2005-04-28 17:18:48 +000023#ifndef SQLITE_OMIT_DISKIO
drhd9b02572001-04-15 00:37:09 +000024#include "sqliteInt.h"
drheb206252004-10-01 02:00:31 +000025#include "os.h"
drhed7c8552001-04-11 14:29:21 +000026#include "pager.h"
drhed7c8552001-04-11 14:29:21 +000027#include <assert.h>
drhd9b02572001-04-15 00:37:09 +000028#include <string.h>
drhed7c8552001-04-11 14:29:21 +000029
30/*
drhdb48ee02003-01-16 13:42:43 +000031** Macros for troubleshooting. Normally turned off
32*/
danielk1977466be562004-06-10 02:16:01 +000033#if 0
drh34f47322004-08-18 15:58:22 +000034#define TRACE1(X) sqlite3DebugPrintf(X)
35#define TRACE2(X,Y) sqlite3DebugPrintf(X,Y)
36#define TRACE3(X,Y,Z) sqlite3DebugPrintf(X,Y,Z)
37#define TRACE4(X,Y,Z,W) sqlite3DebugPrintf(X,Y,Z,W)
danielk197794daf7f2004-11-08 09:26:09 +000038#define TRACE5(X,Y,Z,W,V) sqlite3DebugPrintf(X,Y,Z,W,V)
drhdb48ee02003-01-16 13:42:43 +000039#else
drhdb48ee02003-01-16 13:42:43 +000040#define TRACE1(X)
41#define TRACE2(X,Y)
42#define TRACE3(X,Y,Z)
drh34f47322004-08-18 15:58:22 +000043#define TRACE4(X,Y,Z,W)
danielk1977599fcba2004-11-08 07:13:13 +000044#define TRACE5(X,Y,Z,W,V)
drhdb48ee02003-01-16 13:42:43 +000045#endif
46
danielk1977599fcba2004-11-08 07:13:13 +000047/*
48** The following two macros are used within the TRACEX() macros above
49** to print out file-descriptors. They are required so that tracing
50** can be turned on when using both the regular os_unix.c and os_test.c
51** backends.
52**
53** PAGERID() takes a pointer to a Pager struct as it's argument. The
54** associated file-descriptor is returned. FILEHANDLEID() takes an OsFile
55** struct as it's argument.
56*/
danielk1977ef73ee92004-11-06 12:26:07 +000057#ifdef OS_TEST
58#define PAGERID(p) (p->fd->fd.h)
59#define FILEHANDLEID(fd) (fd->fd.h)
60#else
61#define PAGERID(p) (p->fd.h)
62#define FILEHANDLEID(fd) (fd.h)
63#endif
drhdb48ee02003-01-16 13:42:43 +000064
65/*
drhed7c8552001-04-11 14:29:21 +000066** The page cache as a whole is always in one of the following
67** states:
68**
drha6abd042004-06-09 17:37:22 +000069** PAGER_UNLOCK The page cache is not currently reading or
drhed7c8552001-04-11 14:29:21 +000070** writing the database file. There is no
71** data held in memory. This is the initial
72** state.
73**
drha6abd042004-06-09 17:37:22 +000074** PAGER_SHARED The page cache is reading the database.
drhed7c8552001-04-11 14:29:21 +000075** Writing is not permitted. There can be
76** multiple readers accessing the same database
drh69688d52001-04-14 16:38:23 +000077** file at the same time.
drhed7c8552001-04-11 14:29:21 +000078**
drh726de592004-06-10 23:35:50 +000079** PAGER_RESERVED This process has reserved the database for writing
80** but has not yet made any changes. Only one process
81** at a time can reserve the database. The original
82** database file has not been modified so other
83** processes may still be reading the on-disk
drha6abd042004-06-09 17:37:22 +000084** database file.
85**
86** PAGER_EXCLUSIVE The page cache is writing the database.
drhed7c8552001-04-11 14:29:21 +000087** Access is exclusive. No other processes or
88** threads can be reading or writing while one
89** process is writing.
90**
danielk1977aa5ccdf2004-06-14 05:10:42 +000091** PAGER_SYNCED The pager moves to this state from PAGER_EXCLUSIVE
92** after all dirty pages have been written to the
93** database file and the file has been synced to
94** disk. All that remains to do is to remove the
95** journal file and the transaction will be
96** committed.
97**
drha6abd042004-06-09 17:37:22 +000098** The page cache comes up in PAGER_UNLOCK. The first time a
drh726de592004-06-10 23:35:50 +000099** sqlite3pager_get() occurs, the state transitions to PAGER_SHARED.
drhed7c8552001-04-11 14:29:21 +0000100** After all pages have been released using sqlite_page_unref(),
drha6abd042004-06-09 17:37:22 +0000101** the state transitions back to PAGER_UNLOCK. The first time
drh726de592004-06-10 23:35:50 +0000102** that sqlite3pager_write() is called, the state transitions to
drha6abd042004-06-09 17:37:22 +0000103** PAGER_RESERVED. (Note that sqlite_page_write() can only be
drh306dc212001-05-21 13:45:10 +0000104** called on an outstanding page which means that the pager must
drha6abd042004-06-09 17:37:22 +0000105** be in PAGER_SHARED before it transitions to PAGER_RESERVED.)
drh726de592004-06-10 23:35:50 +0000106** The transition to PAGER_EXCLUSIVE occurs when before any changes
107** are made to the database file. After an sqlite3pager_rollback()
108** or sqlite_pager_commit(), the state goes back to PAGER_SHARED.
drhed7c8552001-04-11 14:29:21 +0000109*/
drha6abd042004-06-09 17:37:22 +0000110#define PAGER_UNLOCK 0
drh684917c2004-10-05 02:41:42 +0000111#define PAGER_SHARED 1 /* same as SHARED_LOCK */
112#define PAGER_RESERVED 2 /* same as RESERVED_LOCK */
113#define PAGER_EXCLUSIVE 4 /* same as EXCLUSIVE_LOCK */
114#define PAGER_SYNCED 5
drhed7c8552001-04-11 14:29:21 +0000115
drh684917c2004-10-05 02:41:42 +0000116/*
117** If the SQLITE_BUSY_RESERVED_LOCK macro is set to true at compile-time,
118** then failed attempts to get a reserved lock will invoke the busy callback.
119** This is off by default. To see why, consider the following scenario:
120**
121** Suppose thread A already has a shared lock and wants a reserved lock.
122** Thread B already has a reserved lock and wants an exclusive lock. If
123** both threads are using their busy callbacks, it might be a long time
124** be for one of the threads give up and allows the other to proceed.
125** But if the thread trying to get the reserved lock gives up quickly
126** (if it never invokes its busy callback) then the contention will be
127** resolved quickly.
128*/
129#ifndef SQLITE_BUSY_RESERVED_LOCK
130# define SQLITE_BUSY_RESERVED_LOCK 0
131#endif
drhd9b02572001-04-15 00:37:09 +0000132
drhed7c8552001-04-11 14:29:21 +0000133/*
drh887dc4c2004-10-22 16:22:57 +0000134** This macro rounds values up so that if the value is an address it
135** is guaranteed to be an address that is aligned to an 8-byte boundary.
136*/
137#define FORCE_ALIGNMENT(X) (((X)+7)&~7)
138
139/*
drhed7c8552001-04-11 14:29:21 +0000140** Each in-memory image of a page begins with the following header.
drhbd03cae2001-06-02 02:40:57 +0000141** This header is only visible to this pager module. The client
142** code that calls pager sees only the data that follows the header.
drhf6038712004-02-08 18:07:34 +0000143**
drh3aac2dd2004-04-26 14:10:20 +0000144** Client code should call sqlite3pager_write() on a page prior to making
145** any modifications to that page. The first time sqlite3pager_write()
drhf6038712004-02-08 18:07:34 +0000146** is called, the original page contents are written into the rollback
147** journal and PgHdr.inJournal and PgHdr.needSync are set. Later, once
148** the journal page has made it onto the disk surface, PgHdr.needSync
149** is cleared. The modified page cannot be written back into the original
150** database file until the journal pages has been synced to disk and the
151** PgHdr.needSync has been cleared.
152**
drh3aac2dd2004-04-26 14:10:20 +0000153** The PgHdr.dirty flag is set when sqlite3pager_write() is called and
drhf6038712004-02-08 18:07:34 +0000154** is cleared again when the page content is written back to the original
155** database file.
drhed7c8552001-04-11 14:29:21 +0000156*/
drhd9b02572001-04-15 00:37:09 +0000157typedef struct PgHdr PgHdr;
drhed7c8552001-04-11 14:29:21 +0000158struct PgHdr {
159 Pager *pPager; /* The pager to which this page belongs */
160 Pgno pgno; /* The page number for this page */
drh69688d52001-04-14 16:38:23 +0000161 PgHdr *pNextHash, *pPrevHash; /* Hash collision chain for PgHdr.pgno */
drhd9b02572001-04-15 00:37:09 +0000162 PgHdr *pNextFree, *pPrevFree; /* Freelist of pages where nRef==0 */
drhac69b052004-05-12 13:30:07 +0000163 PgHdr *pNextAll; /* A list of all pages */
164 PgHdr *pNextStmt, *pPrevStmt; /* List of pages in the statement journal */
drh193a6b42002-07-07 16:52:46 +0000165 u8 inJournal; /* TRUE if has been written to journal */
drhac69b052004-05-12 13:30:07 +0000166 u8 inStmt; /* TRUE if in the statement subjournal */
drh193a6b42002-07-07 16:52:46 +0000167 u8 dirty; /* TRUE if we need to write back changes */
drhdb48ee02003-01-16 13:42:43 +0000168 u8 needSync; /* Sync journal before writing this page */
drh193a6b42002-07-07 16:52:46 +0000169 u8 alwaysRollback; /* Disable dont_rollback() for this page */
drhac69b052004-05-12 13:30:07 +0000170 short int nRef; /* Number of users of this page */
drh2554f8b2003-01-22 01:26:44 +0000171 PgHdr *pDirty; /* Dirty pages sorted by PgHdr.pgno */
danielk19773c407372005-02-15 02:54:14 +0000172#ifdef SQLITE_CHECK_PAGES
173 u32 pageHash;
174#endif
drh1c7880e2005-05-20 20:01:55 +0000175 /* pPager->pageSize bytes of page data follow this header */
drh973b6e32003-02-12 14:09:42 +0000176 /* Pager.nExtra bytes of local data follow the page data */
drhed7c8552001-04-11 14:29:21 +0000177};
178
drhac69b052004-05-12 13:30:07 +0000179/*
180** For an in-memory only database, some extra information is recorded about
181** each page so that changes can be rolled back. (Journal files are not
182** used for in-memory databases.) The following information is added to
183** the end of every EXTRA block for in-memory databases.
184**
185** This information could have been added directly to the PgHdr structure.
186** But then it would take up an extra 8 bytes of storage on every PgHdr
187** even for disk-based databases. Splitting it out saves 8 bytes. This
188** is only a savings of 0.8% but those percentages add up.
189*/
190typedef struct PgHistory PgHistory;
191struct PgHistory {
192 u8 *pOrig; /* Original page text. Restore to this on a full rollback */
193 u8 *pStmt; /* Text as it was at the beginning of the current statement */
194};
drh9eb9e262004-02-11 02:18:05 +0000195
196/*
197** A macro used for invoking the codec if there is one
198*/
199#ifdef SQLITE_HAS_CODEC
200# define CODEC(P,D,N,X) if( P->xCodec ){ P->xCodec(P->pCodecArg,D,N,X); }
201#else
202# define CODEC(P,D,N,X)
203#endif
204
drhed7c8552001-04-11 14:29:21 +0000205/*
drh69688d52001-04-14 16:38:23 +0000206** Convert a pointer to a PgHdr into a pointer to its data
207** and back again.
drhed7c8552001-04-11 14:29:21 +0000208*/
209#define PGHDR_TO_DATA(P) ((void*)(&(P)[1]))
210#define DATA_TO_PGHDR(D) (&((PgHdr*)(D))[-1])
drh1c7880e2005-05-20 20:01:55 +0000211#define PGHDR_TO_EXTRA(G,P) ((void*)&((char*)(&(G)[1]))[(P)->pageSize])
drhac69b052004-05-12 13:30:07 +0000212#define PGHDR_TO_HIST(P,PGR) \
drh1c7880e2005-05-20 20:01:55 +0000213 ((PgHistory*)&((char*)(&(P)[1]))[(PGR)->pageSize+(PGR)->nExtra])
drhed7c8552001-04-11 14:29:21 +0000214
215/*
drhed7c8552001-04-11 14:29:21 +0000216** How big to make the hash table used for locating in-memory pages
danielk1977634f2982005-03-28 08:44:07 +0000217** by page number. This macro looks a little silly, but is evaluated
218** at compile-time, not run-time (at least for gcc this is true).
drhed7c8552001-04-11 14:29:21 +0000219*/
danielk1977634f2982005-03-28 08:44:07 +0000220#define N_PG_HASH (\
221 (MAX_PAGES>1024)?2048: \
222 (MAX_PAGES>512)?1024: \
223 (MAX_PAGES>256)?512: \
224 (MAX_PAGES>128)?256: \
225 (MAX_PAGES>64)?128:64 \
226)
drh836faa42003-01-11 13:30:57 +0000227
228/*
229** Hash a page number
230*/
231#define pager_hash(PN) ((PN)&(N_PG_HASH-1))
drhed7c8552001-04-11 14:29:21 +0000232
233/*
234** A open page cache is an instance of the following structure.
235*/
236struct Pager {
drh603240c2002-03-05 01:11:12 +0000237 u8 journalOpen; /* True if journal file descriptors is valid */
drh34e79ce2004-02-08 06:05:46 +0000238 u8 journalStarted; /* True if header of journal is synced */
239 u8 useJournal; /* Use a rollback journal on this file */
drh7bec5052005-02-06 02:45:41 +0000240 u8 noReadlock; /* Do not bother to obtain readlocks */
drhac69b052004-05-12 13:30:07 +0000241 u8 stmtOpen; /* True if the statement subjournal is open */
242 u8 stmtInUse; /* True we are in a statement subtransaction */
243 u8 stmtAutoopen; /* Open stmt journal when main journal is opened*/
drh603240c2002-03-05 01:11:12 +0000244 u8 noSync; /* Do not sync the journal if true */
drh968af522003-02-11 14:55:40 +0000245 u8 fullSync; /* Do extra syncs of the journal for robustness */
drha6abd042004-06-09 17:37:22 +0000246 u8 state; /* PAGER_UNLOCK, _SHARED, _RESERVED, etc. */
drh603240c2002-03-05 01:11:12 +0000247 u8 errMask; /* One of several kinds of errors */
248 u8 tempFile; /* zFilename is a temporary file */
249 u8 readOnly; /* True for a read-only database */
250 u8 needSync; /* True if an fsync() is needed on the journal */
drha6abd042004-06-09 17:37:22 +0000251 u8 dirtyCache; /* True if cached pages have changed */
drh193a6b42002-07-07 16:52:46 +0000252 u8 alwaysRollback; /* Disable dont_rollback() for all pages */
drhac69b052004-05-12 13:30:07 +0000253 u8 memDb; /* True to inhibit all file I/O */
drh6d156e42005-05-20 20:11:20 +0000254 u8 setMaster; /* True if a m-j name has been written to jrnl */
drhfcd35c72005-05-21 02:48:08 +0000255 int dbSize; /* Number of pages in the file */
256 int origDbSize; /* dbSize before the current change */
257 int stmtSize; /* Size of database (in pages) at stmt_begin() */
258 int nRec; /* Number of pages written to the journal */
259 u32 cksumInit; /* Quasi-random value added to every checksum */
260 int stmtNRec; /* Number of records in stmt subjournal */
261 int nExtra; /* Add this many bytes to each in-memory page */
262 int pageSize; /* Number of bytes in a page */
263 int nPage; /* Total number of in-memory pages */
264 int nMaxPage; /* High water mark of nPage */
265 int nRef; /* Number of in-memory pages with PgHdr.nRef>0 */
266 int mxPage; /* Maximum number of pages to hold in cache */
drh603240c2002-03-05 01:11:12 +0000267 u8 *aInJournal; /* One bit for each page in the database file */
drhac69b052004-05-12 13:30:07 +0000268 u8 *aInStmt; /* One bit for each page in the database */
drhfcd35c72005-05-21 02:48:08 +0000269 char *zFilename; /* Name of the database file */
270 char *zJournal; /* Name of the journal file */
271 char *zDirectory; /* Directory hold database and journal files */
272 OsFile fd, jfd; /* File descriptors for database and journal */
273 OsFile stfd; /* File descriptor for the statement subjournal*/
drh726de592004-06-10 23:35:50 +0000274 BusyHandler *pBusyHandler; /* Pointer to sqlite.busyHandler */
drhed7c8552001-04-11 14:29:21 +0000275 PgHdr *pFirst, *pLast; /* List of free pages */
drh341eae82003-01-21 02:39:36 +0000276 PgHdr *pFirstSynced; /* First free page with PgHdr.needSync==0 */
drhd9b02572001-04-15 00:37:09 +0000277 PgHdr *pAll; /* List of all pages */
drhac69b052004-05-12 13:30:07 +0000278 PgHdr *pStmt; /* List of pages in the statement subjournal */
drheb206252004-10-01 02:00:31 +0000279 i64 journalOff; /* Current byte offset in the journal file */
280 i64 journalHdr; /* Byte offset to previous journal header */
281 i64 stmtHdrOff; /* First journal header written this statement */
282 i64 stmtCksum; /* cksumInit when statement was started */
drh6d156e42005-05-20 20:11:20 +0000283 i64 stmtJSize; /* Size of journal at stmt_begin() */
danielk197776572402004-06-25 02:38:54 +0000284 int sectorSize; /* Assumed sector size during rollback */
drhfcd35c72005-05-21 02:48:08 +0000285#ifdef SQLITE_TEST
drh6d156e42005-05-20 20:11:20 +0000286 int nHit, nMiss, nOvfl; /* Cache hits, missing, and LRU overflows */
287 int nRead,nWrite; /* Database pages read/written */
drhfcd35c72005-05-21 02:48:08 +0000288#endif
drh6d156e42005-05-20 20:11:20 +0000289 void (*xDestructor)(void*,int); /* Call this routine when freeing pages */
290 void (*xReiniter)(void*,int); /* Call this routine when reloading pages */
291 void (*xCodec)(void*,void*,Pgno,int); /* Routine for en/decoding data */
292 void *pCodecArg; /* First argument to xCodec() */
drh76ff3a02004-09-24 22:32:30 +0000293 PgHdr *aHash[N_PG_HASH]; /* Hash table to map page number to PgHdr */
drhd9b02572001-04-15 00:37:09 +0000294};
295
296/*
drhfcd35c72005-05-21 02:48:08 +0000297** If SQLITE_TEST is defined then increment the variable given in
298** the argument
299*/
300#ifdef SQLITE_TEST
301# define TEST_INCR(x) x++
302#else
303# define TEST_INCR(x)
304#endif
305
306/*
drhd9b02572001-04-15 00:37:09 +0000307** These are bits that can be set in Pager.errMask.
308*/
309#define PAGER_ERR_FULL 0x01 /* a write() failed */
310#define PAGER_ERR_MEM 0x02 /* malloc() failed */
311#define PAGER_ERR_LOCK 0x04 /* error in the locking protocol */
312#define PAGER_ERR_CORRUPT 0x08 /* database or journal corruption */
drh81a20f22001-10-12 17:30:04 +0000313#define PAGER_ERR_DISK 0x10 /* general disk I/O error - bad hard drive? */
drhd9b02572001-04-15 00:37:09 +0000314
315/*
drh5e00f6c2001-09-13 13:46:56 +0000316** Journal files begin with the following magic string. The data
317** was obtained from /dev/random. It is used only as a sanity check.
drh94f33312002-08-12 12:29:56 +0000318**
drhae2b40c2004-06-09 19:03:54 +0000319** Since version 2.8.0, the journal format contains additional sanity
320** checking information. If the power fails while the journal is begin
321** written, semi-random garbage data might appear in the journal
322** file after power is restored. If an attempt is then made
drh968af522003-02-11 14:55:40 +0000323** to roll the journal back, the database could be corrupted. The additional
324** sanity checking data is an attempt to discover the garbage in the
325** journal and ignore it.
326**
drhae2b40c2004-06-09 19:03:54 +0000327** The sanity checking information for the new journal format consists
drh968af522003-02-11 14:55:40 +0000328** of a 32-bit checksum on each page of data. The checksum covers both
drh90f5ecb2004-07-22 01:19:35 +0000329** the page number and the pPager->pageSize bytes of data for the page.
drh968af522003-02-11 14:55:40 +0000330** This cksum is initialized to a 32-bit random value that appears in the
331** journal file right after the header. The random initializer is important,
332** because garbage data that appears at the end of a journal is likely
333** data that was once in other files that have now been deleted. If the
334** garbage data came from an obsolete journal file, the checksums might
335** be correct. But by initializing the checksum to random value which
336** is different for every journal, we minimize that risk.
drhd9b02572001-04-15 00:37:09 +0000337*/
drhae2b40c2004-06-09 19:03:54 +0000338static const unsigned char aJournalMagic[] = {
339 0xd9, 0xd5, 0x05, 0xf9, 0x20, 0xa1, 0x63, 0xd7,
drhed7c8552001-04-11 14:29:21 +0000340};
341
342/*
drh726de592004-06-10 23:35:50 +0000343** The size of the header and of each page in the journal is determined
344** by the following macros.
drh968af522003-02-11 14:55:40 +0000345*/
drhae2b40c2004-06-09 19:03:54 +0000346#define JOURNAL_PG_SZ(pPager) ((pPager->pageSize) + 8)
drh968af522003-02-11 14:55:40 +0000347
danielk197776572402004-06-25 02:38:54 +0000348/*
349** The journal header size for this pager. In the future, this could be
350** set to some value read from the disk controller. The important
351** characteristic is that it is the same size as a disk sector.
352*/
353#define JOURNAL_HDR_SZ(pPager) (pPager->sectorSize)
354
drhb7f91642004-10-31 02:22:47 +0000355/*
356** The macro MEMDB is true if we are dealing with an in-memory database.
357** We do this as a macro so that if the SQLITE_OMIT_MEMORYDB macro is set,
358** the value of MEMDB will be a constant and the compiler will optimize
359** out code that would never execute.
360*/
361#ifdef SQLITE_OMIT_MEMORYDB
362# define MEMDB 0
363#else
364# define MEMDB pPager->memDb
365#endif
366
367/*
368** The default size of a disk sector
369*/
danielk197776572402004-06-25 02:38:54 +0000370#define PAGER_SECTOR_SIZE 512
371
372/*
373** Page number PAGER_MJ_PGNO is never used in an SQLite database (it is
374** reserved for working around a windows/posix incompatibility). It is
375** used in the journal to signify that the remainder of the journal file
376** is devoted to storing a master journal name - there are no more pages to
377** roll back. See comments for function writeMasterJournal() for details.
378*/
danielk1977599fcba2004-11-08 07:13:13 +0000379/* #define PAGER_MJ_PGNO(x) (PENDING_BYTE/((x)->pageSize)) */
380#define PAGER_MJ_PGNO(x) ((PENDING_BYTE/((x)->pageSize))+1)
danielk197713adf8a2004-06-03 16:08:41 +0000381
drh968af522003-02-11 14:55:40 +0000382/*
danielk197726836652005-01-17 01:33:13 +0000383** The maximum legal page number is (2^31 - 1).
384*/
385#define PAGER_MAX_PGNO 2147483647
386
387/*
drh726de592004-06-10 23:35:50 +0000388** Enable reference count tracking (for debugging) here:
drhdd793422001-06-28 01:54:48 +0000389*/
danielk1977aca790a2005-01-13 11:07:52 +0000390#ifdef SQLITE_DEBUG
drh3aac2dd2004-04-26 14:10:20 +0000391 int pager3_refinfo_enable = 0;
drhdd793422001-06-28 01:54:48 +0000392 static void pager_refinfo(PgHdr *p){
393 static int cnt = 0;
drh3aac2dd2004-04-26 14:10:20 +0000394 if( !pager3_refinfo_enable ) return;
drhfe63d1c2004-09-08 20:13:04 +0000395 sqlite3DebugPrintf(
396 "REFCNT: %4d addr=%p nRef=%d\n",
397 p->pgno, PGHDR_TO_DATA(p), p->nRef
drhdd793422001-06-28 01:54:48 +0000398 );
399 cnt++; /* Something to set a breakpoint on */
400 }
401# define REFINFO(X) pager_refinfo(X)
402#else
403# define REFINFO(X)
404#endif
405
406/*
drh34e79ce2004-02-08 06:05:46 +0000407** Read a 32-bit integer from the given file descriptor. Store the integer
408** that is read in *pRes. Return SQLITE_OK if everything worked, or an
409** error code is something goes wrong.
drh726de592004-06-10 23:35:50 +0000410**
411** All values are stored on disk as big-endian.
drh94f33312002-08-12 12:29:56 +0000412*/
drhae2b40c2004-06-09 19:03:54 +0000413static int read32bits(OsFile *fd, u32 *pRes){
drh94f33312002-08-12 12:29:56 +0000414 u32 res;
415 int rc;
danielk19774adee202004-05-08 08:23:19 +0000416 rc = sqlite3OsRead(fd, &res, sizeof(res));
drhae2b40c2004-06-09 19:03:54 +0000417 if( rc==SQLITE_OK ){
drh94f33312002-08-12 12:29:56 +0000418 unsigned char ac[4];
419 memcpy(ac, &res, 4);
420 res = (ac[0]<<24) | (ac[1]<<16) | (ac[2]<<8) | ac[3];
421 }
422 *pRes = res;
423 return rc;
424}
425
426/*
drh34e79ce2004-02-08 06:05:46 +0000427** Write a 32-bit integer into the given file descriptor. Return SQLITE_OK
428** on success or an error code is something goes wrong.
drh94f33312002-08-12 12:29:56 +0000429*/
430static int write32bits(OsFile *fd, u32 val){
431 unsigned char ac[4];
drh94f33312002-08-12 12:29:56 +0000432 ac[0] = (val>>24) & 0xff;
433 ac[1] = (val>>16) & 0xff;
434 ac[2] = (val>>8) & 0xff;
435 ac[3] = val & 0xff;
danielk19774adee202004-05-08 08:23:19 +0000436 return sqlite3OsWrite(fd, ac, 4);
drh94f33312002-08-12 12:29:56 +0000437}
438
drh2554f8b2003-01-22 01:26:44 +0000439/*
danielk1977aa5ccdf2004-06-14 05:10:42 +0000440** Write the 32-bit integer 'val' into the page identified by page header
441** 'p' at offset 'offset'.
drh2554f8b2003-01-22 01:26:44 +0000442*/
drh968af522003-02-11 14:55:40 +0000443static void store32bits(u32 val, PgHdr *p, int offset){
drh2554f8b2003-01-22 01:26:44 +0000444 unsigned char *ac;
drhec1bd0b2003-08-26 11:41:27 +0000445 ac = &((unsigned char*)PGHDR_TO_DATA(p))[offset];
drhae2b40c2004-06-09 19:03:54 +0000446 ac[0] = (val>>24) & 0xff;
447 ac[1] = (val>>16) & 0xff;
448 ac[2] = (val>>8) & 0xff;
449 ac[3] = val & 0xff;
drh2554f8b2003-01-22 01:26:44 +0000450}
451
danielk1977aa5ccdf2004-06-14 05:10:42 +0000452/*
453** Read a 32-bit integer at offset 'offset' from the page identified by
454** page header 'p'.
455*/
456static u32 retrieve32bits(PgHdr *p, int offset){
457 unsigned char *ac;
458 ac = &((unsigned char*)PGHDR_TO_DATA(p))[offset];
459 return (ac[0]<<24) | (ac[1]<<16) | (ac[2]<<8) | ac[3];
460}
461
drh94f33312002-08-12 12:29:56 +0000462
463/*
drhd9b02572001-04-15 00:37:09 +0000464** Convert the bits in the pPager->errMask into an approprate
465** return code.
466*/
467static int pager_errcode(Pager *pPager){
468 int rc = SQLITE_OK;
469 if( pPager->errMask & PAGER_ERR_LOCK ) rc = SQLITE_PROTOCOL;
drh81a20f22001-10-12 17:30:04 +0000470 if( pPager->errMask & PAGER_ERR_DISK ) rc = SQLITE_IOERR;
drhd9b02572001-04-15 00:37:09 +0000471 if( pPager->errMask & PAGER_ERR_FULL ) rc = SQLITE_FULL;
472 if( pPager->errMask & PAGER_ERR_MEM ) rc = SQLITE_NOMEM;
473 if( pPager->errMask & PAGER_ERR_CORRUPT ) rc = SQLITE_CORRUPT;
474 return rc;
drhed7c8552001-04-11 14:29:21 +0000475}
476
danielk19773c407372005-02-15 02:54:14 +0000477#ifdef SQLITE_CHECK_PAGES
478/*
479** Return a 32-bit hash of the page data for pPage.
480*/
481static u32 pager_pagehash(PgHdr *pPage){
482 u32 hash = 0;
483 int i;
484 unsigned char *pData = (unsigned char *)PGHDR_TO_DATA(pPage);
485 for(i=0; i<pPage->pPager->pageSize; i++){
486 hash = (hash+i)^pData[i];
487 }
488 return hash;
489}
490
491/*
492** The CHECK_PAGE macro takes a PgHdr* as an argument. If SQLITE_CHECK_PAGES
493** is defined, and NDEBUG is not defined, an assert() statement checks
494** that the page is either dirty or still matches the calculated page-hash.
495*/
496#define CHECK_PAGE(x) checkPage(x)
497static void checkPage(PgHdr *pPg){
498 Pager *pPager = pPg->pPager;
499 assert( !pPg->pageHash || pPager->errMask || MEMDB || pPg->dirty ||
500 pPg->pageHash==pager_pagehash(pPg) );
501}
502
503#else
504#define CHECK_PAGE(x)
505#endif
506
drhed7c8552001-04-11 14:29:21 +0000507/*
danielk197776572402004-06-25 02:38:54 +0000508** When this is called the journal file for pager pPager must be open.
509** The master journal file name is read from the end of the file and
510** written into memory obtained from sqliteMalloc(). *pzMaster is
511** set to point at the memory and SQLITE_OK returned. The caller must
512** sqliteFree() *pzMaster.
513**
514** If no master journal file name is present *pzMaster is set to 0 and
515** SQLITE_OK returned.
516*/
517static int readMasterJournal(OsFile *pJrnl, char **pzMaster){
518 int rc;
519 u32 len;
drheb206252004-10-01 02:00:31 +0000520 i64 szJ;
danielk1977c3e8f5e2004-06-28 01:16:46 +0000521 u32 cksum;
danielk1977cafadba2004-06-25 11:11:54 +0000522 int i;
danielk197776572402004-06-25 02:38:54 +0000523 unsigned char aMagic[8]; /* A buffer to hold the magic header */
524
525 *pzMaster = 0;
526
527 rc = sqlite3OsFileSize(pJrnl, &szJ);
danielk1977cafadba2004-06-25 11:11:54 +0000528 if( rc!=SQLITE_OK || szJ<16 ) return rc;
danielk197776572402004-06-25 02:38:54 +0000529
danielk1977cafadba2004-06-25 11:11:54 +0000530 rc = sqlite3OsSeek(pJrnl, szJ-16);
danielk197776572402004-06-25 02:38:54 +0000531 if( rc!=SQLITE_OK ) return rc;
532
533 rc = read32bits(pJrnl, &len);
534 if( rc!=SQLITE_OK ) return rc;
535
danielk1977cafadba2004-06-25 11:11:54 +0000536 rc = read32bits(pJrnl, &cksum);
537 if( rc!=SQLITE_OK ) return rc;
538
danielk197776572402004-06-25 02:38:54 +0000539 rc = sqlite3OsRead(pJrnl, aMagic, 8);
540 if( rc!=SQLITE_OK || memcmp(aMagic, aJournalMagic, 8) ) return rc;
541
danielk19778191bff2004-06-28 04:52:30 +0000542 rc = sqlite3OsSeek(pJrnl, szJ-16-len);
danielk197776572402004-06-25 02:38:54 +0000543 if( rc!=SQLITE_OK ) return rc;
544
danielk19778191bff2004-06-28 04:52:30 +0000545 *pzMaster = (char *)sqliteMalloc(len+1);
danielk197776572402004-06-25 02:38:54 +0000546 if( !*pzMaster ){
547 return SQLITE_NOMEM;
548 }
549 rc = sqlite3OsRead(pJrnl, *pzMaster, len);
550 if( rc!=SQLITE_OK ){
551 sqliteFree(*pzMaster);
552 *pzMaster = 0;
553 return rc;
554 }
danielk1977cafadba2004-06-25 11:11:54 +0000555
556 /* See if the checksum matches the master journal name */
557 for(i=0; i<len; i++){
danielk19778191bff2004-06-28 04:52:30 +0000558 cksum -= (*pzMaster)[i];
danielk1977cafadba2004-06-25 11:11:54 +0000559 }
danielk19778191bff2004-06-28 04:52:30 +0000560 if( cksum ){
561 /* If the checksum doesn't add up, then one or more of the disk sectors
562 ** containing the master journal filename is corrupted. This means
563 ** definitely roll back, so just return SQLITE_OK and report a (nul)
564 ** master-journal filename.
565 */
danielk1977cafadba2004-06-25 11:11:54 +0000566 sqliteFree(*pzMaster);
567 *pzMaster = 0;
danielk1977aca790a2005-01-13 11:07:52 +0000568 }else{
569 (*pzMaster)[len] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000570 }
danielk197776572402004-06-25 02:38:54 +0000571
572 return SQLITE_OK;
573}
574
575/*
576** Seek the journal file descriptor to the next sector boundary where a
577** journal header may be read or written. Pager.journalOff is updated with
578** the new seek offset.
579**
580** i.e for a sector size of 512:
581**
582** Input Offset Output Offset
583** ---------------------------------------
584** 0 0
585** 512 512
586** 100 512
587** 2000 2048
588**
589*/
590static int seekJournalHdr(Pager *pPager){
drheb206252004-10-01 02:00:31 +0000591 i64 offset = 0;
592 i64 c = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000593 if( c ){
594 offset = ((c-1)/JOURNAL_HDR_SZ(pPager) + 1) * JOURNAL_HDR_SZ(pPager);
595 }
596 assert( offset%JOURNAL_HDR_SZ(pPager)==0 );
597 assert( offset>=c );
598 assert( (offset-c)<JOURNAL_HDR_SZ(pPager) );
599 pPager->journalOff = offset;
600 return sqlite3OsSeek(&pPager->jfd, pPager->journalOff);
601}
602
603/*
604** The journal file must be open when this routine is called. A journal
605** header (JOURNAL_HDR_SZ bytes) is written into the journal file at the
606** current location.
607**
608** The format for the journal header is as follows:
609** - 8 bytes: Magic identifying journal format.
610** - 4 bytes: Number of records in journal, or -1 no-sync mode is on.
611** - 4 bytes: Random number used for page hash.
612** - 4 bytes: Initial database page count.
613** - 4 bytes: Sector size used by the process that wrote this journal.
614**
danielk1977f42f25c2004-06-25 07:21:28 +0000615** Followed by (JOURNAL_HDR_SZ - 24) bytes of unused space.
danielk197776572402004-06-25 02:38:54 +0000616*/
617static int writeJournalHdr(Pager *pPager){
618
619 int rc = seekJournalHdr(pPager);
620 if( rc ) return rc;
621
622 pPager->journalHdr = pPager->journalOff;
623 if( pPager->stmtHdrOff==0 ){
624 pPager->stmtHdrOff = pPager->journalHdr;
625 }
626 pPager->journalOff += JOURNAL_HDR_SZ(pPager);
627
628 /* FIX ME:
629 **
630 ** Possibly for a pager not in no-sync mode, the journal magic should not
631 ** be written until nRec is filled in as part of next syncJournal().
632 **
633 ** Actually maybe the whole journal header should be delayed until that
634 ** point. Think about this.
635 */
636 rc = sqlite3OsWrite(&pPager->jfd, aJournalMagic, sizeof(aJournalMagic));
637
638 if( rc==SQLITE_OK ){
639 /* The nRec Field. 0xFFFFFFFF for no-sync journals. */
640 rc = write32bits(&pPager->jfd, pPager->noSync ? 0xffffffff : 0);
641 }
642 if( rc==SQLITE_OK ){
643 /* The random check-hash initialiser */
644 sqlite3Randomness(sizeof(pPager->cksumInit), &pPager->cksumInit);
645 rc = write32bits(&pPager->jfd, pPager->cksumInit);
646 }
647 if( rc==SQLITE_OK ){
648 /* The initial database size */
649 rc = write32bits(&pPager->jfd, pPager->dbSize);
650 }
651 if( rc==SQLITE_OK ){
652 /* The assumed sector size for this process */
653 rc = write32bits(&pPager->jfd, pPager->sectorSize);
654 }
655
656 /* The journal header has been written successfully. Seek the journal
657 ** file descriptor to the end of the journal header sector.
658 */
659 if( rc==SQLITE_OK ){
660 sqlite3OsSeek(&pPager->jfd, pPager->journalOff-1);
661 rc = sqlite3OsWrite(&pPager->jfd, "\000", 1);
662 }
663 return rc;
664}
665
666/*
667** The journal file must be open when this is called. A journal header file
668** (JOURNAL_HDR_SZ bytes) is read from the current location in the journal
669** file. See comments above function writeJournalHdr() for a description of
670** the journal header format.
671**
672** If the header is read successfully, *nRec is set to the number of
673** page records following this header and *dbSize is set to the size of the
674** database before the transaction began, in pages. Also, pPager->cksumInit
675** is set to the value read from the journal header. SQLITE_OK is returned
676** in this case.
677**
678** If the journal header file appears to be corrupted, SQLITE_DONE is
679** returned and *nRec and *dbSize are not set. If JOURNAL_HDR_SZ bytes
680** cannot be read from the journal file an error code is returned.
681*/
682static int readJournalHdr(
683 Pager *pPager,
drheb206252004-10-01 02:00:31 +0000684 i64 journalSize,
danielk197776572402004-06-25 02:38:54 +0000685 u32 *pNRec,
686 u32 *pDbSize
687){
688 int rc;
689 unsigned char aMagic[8]; /* A buffer to hold the magic header */
690
691 rc = seekJournalHdr(pPager);
692 if( rc ) return rc;
693
694 if( pPager->journalOff+JOURNAL_HDR_SZ(pPager) > journalSize ){
695 return SQLITE_DONE;
696 }
697
698 rc = sqlite3OsRead(&pPager->jfd, aMagic, sizeof(aMagic));
699 if( rc ) return rc;
700
701 if( memcmp(aMagic, aJournalMagic, sizeof(aMagic))!=0 ){
702 return SQLITE_DONE;
703 }
704
705 rc = read32bits(&pPager->jfd, pNRec);
706 if( rc ) return rc;
707
708 rc = read32bits(&pPager->jfd, &pPager->cksumInit);
709 if( rc ) return rc;
710
711 rc = read32bits(&pPager->jfd, pDbSize);
712 if( rc ) return rc;
713
714 /* Update the assumed sector-size to match the value used by
715 ** the process that created this journal. If this journal was
716 ** created by a process other than this one, then this routine
717 ** is being called from within pager_playback(). The local value
718 ** of Pager.sectorSize is restored at the end of that routine.
719 */
danielk1977c3e8f5e2004-06-28 01:16:46 +0000720 rc = read32bits(&pPager->jfd, (u32 *)&pPager->sectorSize);
danielk197776572402004-06-25 02:38:54 +0000721 if( rc ) return rc;
722
723 pPager->journalOff += JOURNAL_HDR_SZ(pPager);
724 rc = sqlite3OsSeek(&pPager->jfd, pPager->journalOff);
725 return rc;
726}
727
728
729/*
730** Write the supplied master journal name into the journal file for pager
danielk1977cafadba2004-06-25 11:11:54 +0000731** pPager at the current location. The master journal name must be the last
732** thing written to a journal file. If the pager is in full-sync mode, the
733** journal file descriptor is advanced to the next sector boundary before
734** anything is written. The format is:
735**
736** + 4 bytes: PAGER_MJ_PGNO.
737** + N bytes: length of master journal name.
738** + 4 bytes: N
739** + 4 bytes: Master journal name checksum.
740** + 8 bytes: aJournalMagic[].
741**
742** The master journal page checksum is the sum of the bytes in the master
743** journal name.
danielk197776572402004-06-25 02:38:54 +0000744*/
745static int writeMasterJournal(Pager *pPager, const char *zMaster){
746 int rc;
747 int len;
danielk1977cafadba2004-06-25 11:11:54 +0000748 int i;
danielk1977c3e8f5e2004-06-28 01:16:46 +0000749 u32 cksum = 0;
danielk197776572402004-06-25 02:38:54 +0000750
751 if( !zMaster || pPager->setMaster) return SQLITE_OK;
752 pPager->setMaster = 1;
753
754 len = strlen(zMaster);
danielk1977cafadba2004-06-25 11:11:54 +0000755 for(i=0; i<len; i++){
756 cksum += zMaster[i];
757 }
danielk197776572402004-06-25 02:38:54 +0000758
759 /* If in full-sync mode, advance to the next disk sector before writing
760 ** the master journal name. This is in case the previous page written to
761 ** the journal has already been synced.
762 */
763 if( pPager->fullSync ){
764 rc = seekJournalHdr(pPager);
765 if( rc!=SQLITE_OK ) return rc;
766 }
danielk1977cafadba2004-06-25 11:11:54 +0000767 pPager->journalOff += (len+20);
danielk197776572402004-06-25 02:38:54 +0000768
769 rc = write32bits(&pPager->jfd, PAGER_MJ_PGNO(pPager));
770 if( rc!=SQLITE_OK ) return rc;
771
772 rc = sqlite3OsWrite(&pPager->jfd, zMaster, len);
773 if( rc!=SQLITE_OK ) return rc;
774
775 rc = write32bits(&pPager->jfd, len);
776 if( rc!=SQLITE_OK ) return rc;
777
danielk1977cafadba2004-06-25 11:11:54 +0000778 rc = write32bits(&pPager->jfd, cksum);
779 if( rc!=SQLITE_OK ) return rc;
780
danielk197776572402004-06-25 02:38:54 +0000781 rc = sqlite3OsWrite(&pPager->jfd, aJournalMagic, sizeof(aJournalMagic));
drhfdb38062004-08-21 19:20:42 +0000782 pPager->needSync = 1;
danielk197776572402004-06-25 02:38:54 +0000783 return rc;
784}
785
786/*
drh03eb96a2002-11-10 23:32:56 +0000787** Add or remove a page from the list of all pages that are in the
drhac69b052004-05-12 13:30:07 +0000788** statement journal.
drh03eb96a2002-11-10 23:32:56 +0000789**
790** The Pager keeps a separate list of pages that are currently in
drhac69b052004-05-12 13:30:07 +0000791** the statement journal. This helps the sqlite3pager_stmt_commit()
drh03eb96a2002-11-10 23:32:56 +0000792** routine run MUCH faster for the common case where there are many
drhac69b052004-05-12 13:30:07 +0000793** pages in memory but only a few are in the statement journal.
drh03eb96a2002-11-10 23:32:56 +0000794*/
drh3aac2dd2004-04-26 14:10:20 +0000795static void page_add_to_stmt_list(PgHdr *pPg){
drh03eb96a2002-11-10 23:32:56 +0000796 Pager *pPager = pPg->pPager;
drhac69b052004-05-12 13:30:07 +0000797 if( pPg->inStmt ) return;
798 assert( pPg->pPrevStmt==0 && pPg->pNextStmt==0 );
799 pPg->pPrevStmt = 0;
800 if( pPager->pStmt ){
801 pPager->pStmt->pPrevStmt = pPg;
drh03eb96a2002-11-10 23:32:56 +0000802 }
drhac69b052004-05-12 13:30:07 +0000803 pPg->pNextStmt = pPager->pStmt;
804 pPager->pStmt = pPg;
805 pPg->inStmt = 1;
drh03eb96a2002-11-10 23:32:56 +0000806}
drh3aac2dd2004-04-26 14:10:20 +0000807static void page_remove_from_stmt_list(PgHdr *pPg){
drhac69b052004-05-12 13:30:07 +0000808 if( !pPg->inStmt ) return;
809 if( pPg->pPrevStmt ){
810 assert( pPg->pPrevStmt->pNextStmt==pPg );
811 pPg->pPrevStmt->pNextStmt = pPg->pNextStmt;
drh03eb96a2002-11-10 23:32:56 +0000812 }else{
drhac69b052004-05-12 13:30:07 +0000813 assert( pPg->pPager->pStmt==pPg );
814 pPg->pPager->pStmt = pPg->pNextStmt;
drh03eb96a2002-11-10 23:32:56 +0000815 }
drhac69b052004-05-12 13:30:07 +0000816 if( pPg->pNextStmt ){
817 assert( pPg->pNextStmt->pPrevStmt==pPg );
818 pPg->pNextStmt->pPrevStmt = pPg->pPrevStmt;
drh03eb96a2002-11-10 23:32:56 +0000819 }
drhac69b052004-05-12 13:30:07 +0000820 pPg->pNextStmt = 0;
821 pPg->pPrevStmt = 0;
822 pPg->inStmt = 0;
drh03eb96a2002-11-10 23:32:56 +0000823}
824
825/*
drhed7c8552001-04-11 14:29:21 +0000826** Find a page in the hash table given its page number. Return
827** a pointer to the page or NULL if not found.
828*/
drhd9b02572001-04-15 00:37:09 +0000829static PgHdr *pager_lookup(Pager *pPager, Pgno pgno){
drh836faa42003-01-11 13:30:57 +0000830 PgHdr *p = pPager->aHash[pager_hash(pgno)];
drhed7c8552001-04-11 14:29:21 +0000831 while( p && p->pgno!=pgno ){
832 p = p->pNextHash;
833 }
834 return p;
835}
836
837/*
838** Unlock the database and clear the in-memory cache. This routine
839** sets the state of the pager back to what it was when it was first
840** opened. Any outstanding pages are invalidated and subsequent attempts
841** to access those pages will likely result in a coredump.
842*/
drhd9b02572001-04-15 00:37:09 +0000843static void pager_reset(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +0000844 PgHdr *pPg, *pNext;
danielk1977e94ddc92005-03-21 03:53:38 +0000845 if( pPager->errMask ) return;
drhd9b02572001-04-15 00:37:09 +0000846 for(pPg=pPager->pAll; pPg; pPg=pNext){
847 pNext = pPg->pNextAll;
848 sqliteFree(pPg);
drhed7c8552001-04-11 14:29:21 +0000849 }
850 pPager->pFirst = 0;
drh341eae82003-01-21 02:39:36 +0000851 pPager->pFirstSynced = 0;
drhd9b02572001-04-15 00:37:09 +0000852 pPager->pLast = 0;
853 pPager->pAll = 0;
drhed7c8552001-04-11 14:29:21 +0000854 memset(pPager->aHash, 0, sizeof(pPager->aHash));
855 pPager->nPage = 0;
drha6abd042004-06-09 17:37:22 +0000856 if( pPager->state>=PAGER_RESERVED ){
drh3aac2dd2004-04-26 14:10:20 +0000857 sqlite3pager_rollback(pPager);
drhed7c8552001-04-11 14:29:21 +0000858 }
drha6abd042004-06-09 17:37:22 +0000859 sqlite3OsUnlock(&pPager->fd, NO_LOCK);
860 pPager->state = PAGER_UNLOCK;
drhd9b02572001-04-15 00:37:09 +0000861 pPager->dbSize = -1;
drhed7c8552001-04-11 14:29:21 +0000862 pPager->nRef = 0;
drh8cfbf082001-09-19 13:22:39 +0000863 assert( pPager->journalOpen==0 );
drhed7c8552001-04-11 14:29:21 +0000864}
865
danielk19776b456a22005-03-21 04:04:02 +0000866/*
867** This function is used to reset the pager after a malloc() failure. This
868** doesn't work with in-memory databases. If a malloc() fails when an
869** in-memory database is in use it is not possible to recover.
870**
871** If a transaction or statement transaction is active, it is rolled back.
872**
873** It is an error to call this function if any pages are in use.
874*/
875#ifndef SQLITE_OMIT_GLOBALRECOVER
876int sqlite3pager_reset(Pager *pPager){
877 if( pPager ){
878 if( pPager->nRef || MEMDB ){
879 return SQLITE_ERROR;
880 }
881 pPager->errMask &= ~(PAGER_ERR_MEM);
882 pager_reset(pPager);
883 }
884 return SQLITE_OK;
885}
886#endif
887
danielk1977e94ddc92005-03-21 03:53:38 +0000888
drhed7c8552001-04-11 14:29:21 +0000889/*
890** When this routine is called, the pager has the journal file open and
drha6abd042004-06-09 17:37:22 +0000891** a RESERVED or EXCLUSIVE lock on the database. This routine releases
892** the database lock and acquires a SHARED lock in its place. The journal
893** file is deleted and closed.
drh50457892003-09-06 01:10:47 +0000894**
895** TODO: Consider keeping the journal file open for temporary databases.
896** This might give a performance improvement on windows where opening
897** a file is an expensive operation.
drhed7c8552001-04-11 14:29:21 +0000898*/
drhd9b02572001-04-15 00:37:09 +0000899static int pager_unwritelock(Pager *pPager){
drhd9b02572001-04-15 00:37:09 +0000900 PgHdr *pPg;
drh9c105bb2004-10-02 20:38:28 +0000901 int rc;
drhb7f91642004-10-31 02:22:47 +0000902 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +0000903 if( pPager->state<PAGER_RESERVED ){
904 return SQLITE_OK;
905 }
drh3aac2dd2004-04-26 14:10:20 +0000906 sqlite3pager_stmt_commit(pPager);
drhac69b052004-05-12 13:30:07 +0000907 if( pPager->stmtOpen ){
908 sqlite3OsClose(&pPager->stfd);
909 pPager->stmtOpen = 0;
drh0f892532002-05-30 12:27:03 +0000910 }
drhda47d772002-12-02 04:25:19 +0000911 if( pPager->journalOpen ){
danielk19774adee202004-05-08 08:23:19 +0000912 sqlite3OsClose(&pPager->jfd);
drhda47d772002-12-02 04:25:19 +0000913 pPager->journalOpen = 0;
danielk19774adee202004-05-08 08:23:19 +0000914 sqlite3OsDelete(pPager->zJournal);
drhda47d772002-12-02 04:25:19 +0000915 sqliteFree( pPager->aInJournal );
916 pPager->aInJournal = 0;
917 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
918 pPg->inJournal = 0;
919 pPg->dirty = 0;
drhdb48ee02003-01-16 13:42:43 +0000920 pPg->needSync = 0;
danielk19773c407372005-02-15 02:54:14 +0000921#ifdef SQLITE_CHECK_PAGES
922 pPg->pageHash = pager_pagehash(pPg);
923#endif
drhda47d772002-12-02 04:25:19 +0000924 }
danielk1977ef317ab2004-06-23 10:43:10 +0000925 pPager->dirtyCache = 0;
danielk1977ef317ab2004-06-23 10:43:10 +0000926 pPager->nRec = 0;
drhda47d772002-12-02 04:25:19 +0000927 }else{
drh88b01a12005-03-28 18:04:27 +0000928 assert( pPager->aInJournal==0 );
drha6abd042004-06-09 17:37:22 +0000929 assert( pPager->dirtyCache==0 || pPager->useJournal==0 );
drhd9b02572001-04-15 00:37:09 +0000930 }
drh9c105bb2004-10-02 20:38:28 +0000931 rc = sqlite3OsUnlock(&pPager->fd, SHARED_LOCK);
drha6abd042004-06-09 17:37:22 +0000932 pPager->state = PAGER_SHARED;
danielk1977ef317ab2004-06-23 10:43:10 +0000933 pPager->origDbSize = 0;
danielk197776572402004-06-25 02:38:54 +0000934 pPager->setMaster = 0;
drh9c105bb2004-10-02 20:38:28 +0000935 return rc;
drhed7c8552001-04-11 14:29:21 +0000936}
937
drhed7c8552001-04-11 14:29:21 +0000938/*
drh968af522003-02-11 14:55:40 +0000939** Compute and return a checksum for the page of data.
drh34e79ce2004-02-08 06:05:46 +0000940**
941** This is not a real checksum. It is really just the sum of the
drh726de592004-06-10 23:35:50 +0000942** random initial value and the page number. We experimented with
943** a checksum of the entire data, but that was found to be too slow.
944**
945** Note that the page number is stored at the beginning of data and
946** the checksum is stored at the end. This is important. If journal
947** corruption occurs due to a power failure, the most likely scenario
948** is that one end or the other of the record will be changed. It is
949** much less likely that the two ends of the journal record will be
950** correct and the middle be corrupt. Thus, this "checksum" scheme,
951** though fast and simple, catches the mostly likely kind of corruption.
952**
953** FIX ME: Consider adding every 200th (or so) byte of the data to the
954** checksum. That way if a single page spans 3 or more disk sectors and
955** only the middle sector is corrupt, we will still have a reasonable
956** chance of failing the checksum and thus detecting the problem.
drh968af522003-02-11 14:55:40 +0000957*/
958static u32 pager_cksum(Pager *pPager, Pgno pgno, const char *aData){
danielk1977ef317ab2004-06-23 10:43:10 +0000959 u32 cksum = pPager->cksumInit;
960 int i = pPager->pageSize-200;
961 while( i>0 ){
962 cksum += aData[i];
963 i -= 200;
964 }
drh968af522003-02-11 14:55:40 +0000965 return cksum;
966}
967
968/*
drhfa86c412002-02-02 15:01:15 +0000969** Read a single page from the journal file opened on file descriptor
970** jfd. Playback this one page.
drh968af522003-02-11 14:55:40 +0000971**
drh726de592004-06-10 23:35:50 +0000972** If useCksum==0 it means this journal does not use checksums. Checksums
973** are not used in statement journals because statement journals do not
974** need to survive power failures.
drhfa86c412002-02-02 15:01:15 +0000975*/
drhae2b40c2004-06-09 19:03:54 +0000976static int pager_playback_one_page(Pager *pPager, OsFile *jfd, int useCksum){
drhfa86c412002-02-02 15:01:15 +0000977 int rc;
drhae2b40c2004-06-09 19:03:54 +0000978 PgHdr *pPg; /* An existing page in the cache */
979 Pgno pgno; /* The page number of a page in journal */
980 u32 cksum; /* Checksum used for sanity checking */
drh90f5ecb2004-07-22 01:19:35 +0000981 u8 aData[SQLITE_MAX_PAGE_SIZE]; /* Temp storage for a page */
drhfa86c412002-02-02 15:01:15 +0000982
drh96362842005-03-20 22:47:56 +0000983 /* useCksum should be true for the main journal and false for
984 ** statement journals. Verify that this is always the case
985 */
986 assert( jfd == (useCksum ? &pPager->jfd : &pPager->stfd) );
987
988
drhae2b40c2004-06-09 19:03:54 +0000989 rc = read32bits(jfd, &pgno);
drh99ee3602003-02-16 19:13:36 +0000990 if( rc!=SQLITE_OK ) return rc;
drhae2b40c2004-06-09 19:03:54 +0000991 rc = sqlite3OsRead(jfd, &aData, pPager->pageSize);
drh99ee3602003-02-16 19:13:36 +0000992 if( rc!=SQLITE_OK ) return rc;
danielk197776572402004-06-25 02:38:54 +0000993 pPager->journalOff += pPager->pageSize + 4;
drhfa86c412002-02-02 15:01:15 +0000994
drh968af522003-02-11 14:55:40 +0000995 /* Sanity checking on the page. This is more important that I originally
996 ** thought. If a power failure occurs while the journal is being written,
997 ** it could cause invalid data to be written into the journal. We need to
998 ** detect this invalid data (with high probability) and ignore it.
999 */
danielk197775edc162004-06-26 01:48:18 +00001000 if( pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh968af522003-02-11 14:55:40 +00001001 return SQLITE_DONE;
1002 }
drhae2b40c2004-06-09 19:03:54 +00001003 if( pgno>(unsigned)pPager->dbSize ){
drh968af522003-02-11 14:55:40 +00001004 return SQLITE_OK;
1005 }
drhae2b40c2004-06-09 19:03:54 +00001006 if( useCksum ){
1007 rc = read32bits(jfd, &cksum);
drh99ee3602003-02-16 19:13:36 +00001008 if( rc ) return rc;
danielk197776572402004-06-25 02:38:54 +00001009 pPager->journalOff += 4;
drhae2b40c2004-06-09 19:03:54 +00001010 if( pager_cksum(pPager, pgno, aData)!=cksum ){
drh968af522003-02-11 14:55:40 +00001011 return SQLITE_DONE;
1012 }
1013 }
drhfa86c412002-02-02 15:01:15 +00001014
danielk1977aa5ccdf2004-06-14 05:10:42 +00001015 assert( pPager->state==PAGER_RESERVED || pPager->state>=PAGER_EXCLUSIVE );
danielk1977a3f3a5f2004-06-10 04:32:16 +00001016
1017 /* If the pager is in RESERVED state, then there must be a copy of this
1018 ** page in the pager cache. In this case just update the pager cache,
danielk19770de0bb32004-06-10 05:59:24 +00001019 ** not the database file. The page is left marked dirty in this case.
1020 **
danielk1977a3f3a5f2004-06-10 04:32:16 +00001021 ** If in EXCLUSIVE state, then we update the pager cache if it exists
1022 ** and the main file. The page is then marked not dirty.
drh96362842005-03-20 22:47:56 +00001023 **
1024 ** Ticket #1171: The statement journal might contain page content that is
1025 ** different from the page content at the start of the transaction.
1026 ** This occurs when a page is changed prior to the start of a statement
1027 ** then changed again within the statement. When rolling back such a
1028 ** statement we must not write to the original database unless we know
1029 ** for certain that original page contents are in the main rollback
1030 ** journal. Otherwise, if a full ROLLBACK occurs after the statement
1031 ** rollback the full ROLLBACK will not restore the page to its original
1032 ** content. Two conditions must be met before writing to the database
1033 ** files. (1) the database must be locked. (2) we know that the original
1034 ** page content is in the main journal either because the page is not in
1035 ** cache or else it is marked as needSync==0.
drhfa86c412002-02-02 15:01:15 +00001036 */
drhae2b40c2004-06-09 19:03:54 +00001037 pPg = pager_lookup(pPager, pgno);
drh96362842005-03-20 22:47:56 +00001038 assert( pPager->state>=PAGER_EXCLUSIVE || pPg!=0 );
danielk1977ef73ee92004-11-06 12:26:07 +00001039 TRACE3("PLAYBACK %d page %d\n", PAGERID(pPager), pgno);
drh96362842005-03-20 22:47:56 +00001040 if( pPager->state>=PAGER_EXCLUSIVE && (pPg==0 || pPg->needSync==0) ){
drheb206252004-10-01 02:00:31 +00001041 sqlite3OsSeek(&pPager->fd, (pgno-1)*(i64)pPager->pageSize);
drh90f5ecb2004-07-22 01:19:35 +00001042 rc = sqlite3OsWrite(&pPager->fd, aData, pPager->pageSize);
drh96362842005-03-20 22:47:56 +00001043 if( pPg ) pPg->dirty = 0;
danielk1977a3f3a5f2004-06-10 04:32:16 +00001044 }
drhfa86c412002-02-02 15:01:15 +00001045 if( pPg ){
danielk197728129562005-01-11 10:25:06 +00001046 /* No page should ever be explicitly rolled back that is in use, except
1047 ** for page 1 which is held in use in order to keep the lock on the
1048 ** database active. However such a page may be rolled back as a result
1049 ** of an internal error resulting in an automatic call to
1050 ** sqlite3pager_rollback().
drhacf4ac92003-12-17 23:57:34 +00001051 */
drhb6f41482004-05-14 01:58:11 +00001052 void *pData;
danielk197728129562005-01-11 10:25:06 +00001053 /* assert( pPg->nRef==0 || pPg->pgno==1 ); */
drhb6f41482004-05-14 01:58:11 +00001054 pData = PGHDR_TO_DATA(pPg);
drhae2b40c2004-06-09 19:03:54 +00001055 memcpy(pData, aData, pPager->pageSize);
drh726de592004-06-10 23:35:50 +00001056 if( pPager->xDestructor ){ /*** FIX ME: Should this be xReinit? ***/
drhb6f41482004-05-14 01:58:11 +00001057 pPager->xDestructor(pData, pPager->pageSize);
drhde647132004-05-07 17:57:49 +00001058 }
danielk19773c407372005-02-15 02:54:14 +00001059#ifdef SQLITE_CHECK_PAGES
drh96362842005-03-20 22:47:56 +00001060 pPg->pageHash = pager_pagehash(pPg);
danielk19773c407372005-02-15 02:54:14 +00001061#endif
drhb6f41482004-05-14 01:58:11 +00001062 CODEC(pPager, pData, pPg->pgno, 3);
drhfa86c412002-02-02 15:01:15 +00001063 }
1064 return rc;
1065}
1066
1067/*
danielk197713adf8a2004-06-03 16:08:41 +00001068** Parameter zMaster is the name of a master journal file. A single journal
1069** file that referred to the master journal file has just been rolled back.
1070** This routine checks if it is possible to delete the master journal file,
1071** and does so if it is.
drh726de592004-06-10 23:35:50 +00001072**
1073** The master journal file contains the names of all child journals.
1074** To tell if a master journal can be deleted, check to each of the
1075** children. If all children are either missing or do not refer to
1076** a different master journal, then this master journal can be deleted.
danielk197713adf8a2004-06-03 16:08:41 +00001077*/
1078static int pager_delmaster(const char *zMaster){
1079 int rc;
1080 int master_open = 0;
1081 OsFile master;
1082 char *zMasterJournal = 0; /* Contents of master journal file */
drheb206252004-10-01 02:00:31 +00001083 i64 nMasterJournal; /* Size of master journal file */
danielk197713adf8a2004-06-03 16:08:41 +00001084
1085 /* Open the master journal file exclusively in case some other process
1086 ** is running this routine also. Not that it makes too much difference.
1087 */
drhda71ce12004-06-21 18:14:45 +00001088 memset(&master, 0, sizeof(master));
danielk19778191bff2004-06-28 04:52:30 +00001089 rc = sqlite3OsOpenReadOnly(zMaster, &master);
danielk197713adf8a2004-06-03 16:08:41 +00001090 if( rc!=SQLITE_OK ) goto delmaster_out;
1091 master_open = 1;
danielk197713adf8a2004-06-03 16:08:41 +00001092 rc = sqlite3OsFileSize(&master, &nMasterJournal);
1093 if( rc!=SQLITE_OK ) goto delmaster_out;
1094
1095 if( nMasterJournal>0 ){
danielk19775865e3d2004-06-14 06:03:57 +00001096 char *zJournal;
danielk197776572402004-06-25 02:38:54 +00001097 char *zMasterPtr = 0;
danielk19775865e3d2004-06-14 06:03:57 +00001098
1099 /* Load the entire master journal file into space obtained from
1100 ** sqliteMalloc() and pointed to by zMasterJournal.
danielk19775865e3d2004-06-14 06:03:57 +00001101 */
danielk197776572402004-06-25 02:38:54 +00001102 zMasterJournal = (char *)sqliteMalloc(nMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001103 if( !zMasterJournal ){
1104 rc = SQLITE_NOMEM;
1105 goto delmaster_out;
1106 }
1107 rc = sqlite3OsRead(&master, zMasterJournal, nMasterJournal);
1108 if( rc!=SQLITE_OK ) goto delmaster_out;
1109
danielk19775865e3d2004-06-14 06:03:57 +00001110 zJournal = zMasterJournal;
1111 while( (zJournal-zMasterJournal)<nMasterJournal ){
danielk197713adf8a2004-06-03 16:08:41 +00001112 if( sqlite3OsFileExists(zJournal) ){
1113 /* One of the journals pointed to by the master journal exists.
1114 ** Open it and check if it points at the master journal. If
1115 ** so, return without deleting the master journal file.
1116 */
1117 OsFile journal;
drh3b7b78b2004-11-24 01:16:43 +00001118 int c;
danielk197713adf8a2004-06-03 16:08:41 +00001119
drhda71ce12004-06-21 18:14:45 +00001120 memset(&journal, 0, sizeof(journal));
danielk197713adf8a2004-06-03 16:08:41 +00001121 rc = sqlite3OsOpenReadOnly(zJournal, &journal);
1122 if( rc!=SQLITE_OK ){
danielk197713adf8a2004-06-03 16:08:41 +00001123 goto delmaster_out;
1124 }
danielk197713adf8a2004-06-03 16:08:41 +00001125
danielk197776572402004-06-25 02:38:54 +00001126 rc = readMasterJournal(&journal, &zMasterPtr);
1127 sqlite3OsClose(&journal);
danielk19779eed5052004-06-04 10:38:30 +00001128 if( rc!=SQLITE_OK ){
danielk19779eed5052004-06-04 10:38:30 +00001129 goto delmaster_out;
1130 }
danielk197776572402004-06-25 02:38:54 +00001131
drh3b7b78b2004-11-24 01:16:43 +00001132 c = zMasterPtr!=0 && strcmp(zMasterPtr, zMaster)==0;
1133 sqliteFree(zMasterPtr);
1134 if( c ){
danielk197776572402004-06-25 02:38:54 +00001135 /* We have a match. Do not delete the master journal file. */
1136 goto delmaster_out;
danielk197713adf8a2004-06-03 16:08:41 +00001137 }
1138 }
danielk19775865e3d2004-06-14 06:03:57 +00001139 zJournal += (strlen(zJournal)+1);
danielk197713adf8a2004-06-03 16:08:41 +00001140 }
1141 }
1142
1143 sqlite3OsDelete(zMaster);
1144
1145delmaster_out:
1146 if( zMasterJournal ){
1147 sqliteFree(zMasterJournal);
1148 }
1149 if( master_open ){
1150 sqlite3OsClose(&master);
1151 }
1152 return rc;
1153}
1154
1155/*
drha6abd042004-06-09 17:37:22 +00001156** Make every page in the cache agree with what is on disk. In other words,
1157** reread the disk to reset the state of the cache.
1158**
1159** This routine is called after a rollback in which some of the dirty cache
1160** pages had never been written out to disk. We need to roll back the
1161** cache content and the easiest way to do that is to reread the old content
1162** back from the disk.
1163*/
1164static int pager_reload_cache(Pager *pPager){
1165 PgHdr *pPg;
1166 int rc = SQLITE_OK;
1167 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
drh90f5ecb2004-07-22 01:19:35 +00001168 char zBuf[SQLITE_MAX_PAGE_SIZE];
drha6abd042004-06-09 17:37:22 +00001169 if( !pPg->dirty ) continue;
1170 if( (int)pPg->pgno <= pPager->origDbSize ){
drheb206252004-10-01 02:00:31 +00001171 sqlite3OsSeek(&pPager->fd, pPager->pageSize*(i64)(pPg->pgno-1));
drh90f5ecb2004-07-22 01:19:35 +00001172 rc = sqlite3OsRead(&pPager->fd, zBuf, pPager->pageSize);
danielk1977ef73ee92004-11-06 12:26:07 +00001173 TRACE3("REFETCH %d page %d\n", PAGERID(pPager), pPg->pgno);
drha6abd042004-06-09 17:37:22 +00001174 if( rc ) break;
drh25d65432004-07-22 15:02:25 +00001175 CODEC(pPager, zBuf, pPg->pgno, 2);
drha6abd042004-06-09 17:37:22 +00001176 }else{
drh90f5ecb2004-07-22 01:19:35 +00001177 memset(zBuf, 0, pPager->pageSize);
drha6abd042004-06-09 17:37:22 +00001178 }
drh90f5ecb2004-07-22 01:19:35 +00001179 if( pPg->nRef==0 || memcmp(zBuf, PGHDR_TO_DATA(pPg), pPager->pageSize) ){
1180 memcpy(PGHDR_TO_DATA(pPg), zBuf, pPager->pageSize);
drha6abd042004-06-09 17:37:22 +00001181 if( pPager->xReiniter ){
1182 pPager->xReiniter(PGHDR_TO_DATA(pPg), pPager->pageSize);
1183 }else{
drh90f5ecb2004-07-22 01:19:35 +00001184 memset(PGHDR_TO_EXTRA(pPg, pPager), 0, pPager->nExtra);
drha6abd042004-06-09 17:37:22 +00001185 }
1186 }
1187 pPg->needSync = 0;
1188 pPg->dirty = 0;
danielk19773c407372005-02-15 02:54:14 +00001189#ifdef SQLITE_CHECK_PAGES
1190 pPg->pageHash = pager_pagehash(pPg);
1191#endif
drha6abd042004-06-09 17:37:22 +00001192 }
1193 return rc;
1194}
1195
drha6abd042004-06-09 17:37:22 +00001196/*
drhcb4c40b2004-08-18 19:09:43 +00001197** Truncate the main file of the given pager to the number of pages
1198** indicated.
1199*/
1200static int pager_truncate(Pager *pPager, int nPage){
danielk197717221812005-02-15 03:38:05 +00001201 assert( pPager->state>=PAGER_EXCLUSIVE );
drheb206252004-10-01 02:00:31 +00001202 return sqlite3OsTruncate(&pPager->fd, pPager->pageSize*(i64)nPage);
drhcb4c40b2004-08-18 19:09:43 +00001203}
1204
1205/*
drhed7c8552001-04-11 14:29:21 +00001206** Playback the journal and thus restore the database file to
1207** the state it was in before we started making changes.
1208**
drh34e79ce2004-02-08 06:05:46 +00001209** The journal file format is as follows:
1210**
drhae2b40c2004-06-09 19:03:54 +00001211** (1) 8 byte prefix. A copy of aJournalMagic[].
1212** (2) 4 byte big-endian integer which is the number of valid page records
drh34e79ce2004-02-08 06:05:46 +00001213** in the journal. If this value is 0xffffffff, then compute the
drhae2b40c2004-06-09 19:03:54 +00001214** number of page records from the journal size.
1215** (3) 4 byte big-endian integer which is the initial value for the
1216** sanity checksum.
1217** (4) 4 byte integer which is the number of pages to truncate the
drh34e79ce2004-02-08 06:05:46 +00001218** database to during a rollback.
drhae2b40c2004-06-09 19:03:54 +00001219** (5) 4 byte integer which is the number of bytes in the master journal
1220** name. The value may be zero (indicate that there is no master
1221** journal.)
1222** (6) N bytes of the master journal name. The name will be nul-terminated
1223** and might be shorter than the value read from (5). If the first byte
1224** of the name is \000 then there is no master journal. The master
1225** journal name is stored in UTF-8.
1226** (7) Zero or more pages instances, each as follows:
drh34e79ce2004-02-08 06:05:46 +00001227** + 4 byte page number.
drhae2b40c2004-06-09 19:03:54 +00001228** + pPager->pageSize bytes of data.
1229** + 4 byte checksum
drh34e79ce2004-02-08 06:05:46 +00001230**
drhae2b40c2004-06-09 19:03:54 +00001231** When we speak of the journal header, we mean the first 6 items above.
1232** Each entry in the journal is an instance of the 7th item.
drh34e79ce2004-02-08 06:05:46 +00001233**
1234** Call the value from the second bullet "nRec". nRec is the number of
1235** valid page entries in the journal. In most cases, you can compute the
1236** value of nRec from the size of the journal file. But if a power
1237** failure occurred while the journal was being written, it could be the
1238** case that the size of the journal file had already been increased but
1239** the extra entries had not yet made it safely to disk. In such a case,
1240** the value of nRec computed from the file size would be too large. For
1241** that reason, we always use the nRec value in the header.
1242**
1243** If the nRec value is 0xffffffff it means that nRec should be computed
1244** from the file size. This value is used when the user selects the
1245** no-sync option for the journal. A power failure could lead to corruption
1246** in this case. But for things like temporary table (which will be
1247** deleted when the power is restored) we don't care.
1248**
drhd9b02572001-04-15 00:37:09 +00001249** If the file opened as the journal file is not a well-formed
danielk1977ece80f12004-06-23 01:05:26 +00001250** journal file then all pages up to the first corrupted page are rolled
1251** back (or no pages if the journal header is corrupted). The journal file
1252** is then deleted and SQLITE_OK returned, just as if no corruption had
1253** been encountered.
1254**
1255** If an I/O or malloc() error occurs, the journal-file is not deleted
1256** and an error code is returned.
drhed7c8552001-04-11 14:29:21 +00001257*/
danielk197776572402004-06-25 02:38:54 +00001258static int pager_playback(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001259 i64 szJ; /* Size of the journal file in bytes */
danielk1977c3e8f5e2004-06-28 01:16:46 +00001260 u32 nRec; /* Number of Records in the journal */
drhd9b02572001-04-15 00:37:09 +00001261 int i; /* Loop counter */
1262 Pgno mxPg = 0; /* Size of the original file in pages */
drhae2b40c2004-06-09 19:03:54 +00001263 int rc; /* Result code of a subroutine */
danielk197713adf8a2004-06-03 16:08:41 +00001264 char *zMaster = 0; /* Name of master journal file if any */
drhed7c8552001-04-11 14:29:21 +00001265
drhc3a64ba2001-11-22 00:01:27 +00001266 /* Figure out how many records are in the journal. Abort early if
1267 ** the journal is empty.
drhed7c8552001-04-11 14:29:21 +00001268 */
drh8cfbf082001-09-19 13:22:39 +00001269 assert( pPager->journalOpen );
danielk19774adee202004-05-08 08:23:19 +00001270 rc = sqlite3OsFileSize(&pPager->jfd, &szJ);
drhc3a64ba2001-11-22 00:01:27 +00001271 if( rc!=SQLITE_OK ){
1272 goto end_playback;
1273 }
drh240c5792004-02-08 00:40:52 +00001274
danielk197776572402004-06-25 02:38:54 +00001275 /* Read the master journal name from the journal, if it is present.
1276 ** If a master journal file name is specified, but the file is not
1277 ** present on disk, then the journal is not hot and does not need to be
1278 ** played back.
drh240c5792004-02-08 00:40:52 +00001279 */
danielk197776572402004-06-25 02:38:54 +00001280 rc = readMasterJournal(&pPager->jfd, &zMaster);
1281 assert( rc!=SQLITE_DONE );
1282 if( rc!=SQLITE_OK || (zMaster && !sqlite3OsFileExists(zMaster)) ){
1283 sqliteFree(zMaster);
1284 zMaster = 0;
1285 if( rc==SQLITE_DONE ) rc = SQLITE_OK;
drhc3a64ba2001-11-22 00:01:27 +00001286 goto end_playback;
1287 }
danielk197776572402004-06-25 02:38:54 +00001288 sqlite3OsSeek(&pPager->jfd, 0);
1289 pPager->journalOff = 0;
drhc3a64ba2001-11-22 00:01:27 +00001290
danielk197776572402004-06-25 02:38:54 +00001291 /* This loop terminates either when the readJournalHdr() call returns
1292 ** SQLITE_DONE or an IO error occurs. */
1293 while( 1 ){
drhae2b40c2004-06-09 19:03:54 +00001294
danielk197776572402004-06-25 02:38:54 +00001295 /* Read the next journal header from the journal file. If there are
1296 ** not enough bytes left in the journal file for a complete header, or
1297 ** it is corrupted, then a process must of failed while writing it.
1298 ** This indicates nothing more needs to be rolled back.
1299 */
1300 rc = readJournalHdr(pPager, szJ, &nRec, &mxPg);
1301 if( rc!=SQLITE_OK ){
drh968af522003-02-11 14:55:40 +00001302 if( rc==SQLITE_DONE ){
drh968af522003-02-11 14:55:40 +00001303 rc = SQLITE_OK;
1304 }
danielk197776572402004-06-25 02:38:54 +00001305 goto end_playback;
1306 }
1307
1308 /* If nRec is 0xffffffff, then this journal was created by a process
1309 ** working in no-sync mode. This means that the rest of the journal
1310 ** file consists of pages, there are no more journal headers. Compute
1311 ** the value of nRec based on this assumption.
1312 */
1313 if( nRec==0xffffffff ){
1314 assert( pPager->journalOff==JOURNAL_HDR_SZ(pPager) );
1315 nRec = (szJ - JOURNAL_HDR_SZ(pPager))/JOURNAL_PG_SZ(pPager);
1316 }
1317
1318 /* If this is the first header read from the journal, truncate the
1319 ** database file back to it's original size.
1320 */
danielk197717221812005-02-15 03:38:05 +00001321 if( pPager->state>=PAGER_EXCLUSIVE &&
1322 pPager->journalOff==JOURNAL_HDR_SZ(pPager) ){
danielk197776572402004-06-25 02:38:54 +00001323 assert( pPager->origDbSize==0 || pPager->origDbSize==mxPg );
drhcb4c40b2004-08-18 19:09:43 +00001324 rc = pager_truncate(pPager, mxPg);
danielk197776572402004-06-25 02:38:54 +00001325 if( rc!=SQLITE_OK ){
1326 goto end_playback;
1327 }
1328 pPager->dbSize = mxPg;
1329 }
1330
1331 /* rc = sqlite3OsSeek(&pPager->jfd, JOURNAL_HDR_SZ(pPager)); */
1332 if( rc!=SQLITE_OK ) goto end_playback;
1333
1334 /* Copy original pages out of the journal and back into the database file.
1335 */
1336 for(i=0; i<nRec; i++){
1337 rc = pager_playback_one_page(pPager, &pPager->jfd, 1);
1338 if( rc!=SQLITE_OK ){
1339 if( rc==SQLITE_DONE ){
1340 rc = SQLITE_OK;
1341 pPager->journalOff = szJ;
1342 break;
1343 }else{
1344 goto end_playback;
1345 }
1346 }
drh968af522003-02-11 14:55:40 +00001347 }
drhed7c8552001-04-11 14:29:21 +00001348 }
drh81a20f22001-10-12 17:30:04 +00001349
drh4a0681e2003-02-13 01:58:20 +00001350 /* Pages that have been written to the journal but never synced
1351 ** where not restored by the loop above. We have to restore those
drh240c5792004-02-08 00:40:52 +00001352 ** pages by reading them back from the original database.
drhdb48ee02003-01-16 13:42:43 +00001353 */
danielk197776572402004-06-25 02:38:54 +00001354 assert( rc==SQLITE_OK );
1355 pager_reload_cache(pPager);
drh4a0681e2003-02-13 01:58:20 +00001356
1357end_playback:
danielk19778191bff2004-06-28 04:52:30 +00001358 if( rc==SQLITE_OK ){
1359 rc = pager_unwritelock(pPager);
1360 }
danielk197713adf8a2004-06-03 16:08:41 +00001361 if( zMaster ){
1362 /* If there was a master journal and this routine will return true,
danielk197732554c12005-01-22 03:39:39 +00001363 ** see if it is possible to delete the master journal.
danielk197713adf8a2004-06-03 16:08:41 +00001364 */
1365 if( rc==SQLITE_OK ){
danielk197732554c12005-01-22 03:39:39 +00001366 rc = pager_delmaster(zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001367 }
1368 sqliteFree(zMaster);
1369 }
danielk197776572402004-06-25 02:38:54 +00001370
1371 /* The Pager.sectorSize variable may have been updated while rolling
1372 ** back a journal created by a process with a different PAGER_SECTOR_SIZE
1373 ** value. Reset it to the correct value for this process.
1374 */
1375 pPager->sectorSize = PAGER_SECTOR_SIZE;
drhd9b02572001-04-15 00:37:09 +00001376 return rc;
drhed7c8552001-04-11 14:29:21 +00001377}
1378
1379/*
drhac69b052004-05-12 13:30:07 +00001380** Playback the statement journal.
drhfa86c412002-02-02 15:01:15 +00001381**
1382** This is similar to playing back the transaction journal but with
1383** a few extra twists.
1384**
drh663fc632002-02-02 18:49:19 +00001385** (1) The number of pages in the database file at the start of
drhac69b052004-05-12 13:30:07 +00001386** the statement is stored in pPager->stmtSize, not in the
drh663fc632002-02-02 18:49:19 +00001387** journal file itself.
drhfa86c412002-02-02 15:01:15 +00001388**
drhac69b052004-05-12 13:30:07 +00001389** (2) In addition to playing back the statement journal, also
drhfa86c412002-02-02 15:01:15 +00001390** playback all pages of the transaction journal beginning
drhac69b052004-05-12 13:30:07 +00001391** at offset pPager->stmtJSize.
drhfa86c412002-02-02 15:01:15 +00001392*/
drh3aac2dd2004-04-26 14:10:20 +00001393static int pager_stmt_playback(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001394 i64 szJ; /* Size of the full journal */
1395 i64 hdrOff;
drh968af522003-02-11 14:55:40 +00001396 int nRec; /* Number of Records */
drhfa86c412002-02-02 15:01:15 +00001397 int i; /* Loop counter */
1398 int rc;
1399
danielk197776572402004-06-25 02:38:54 +00001400 szJ = pPager->journalOff;
1401#ifndef NDEBUG
1402 {
drheb206252004-10-01 02:00:31 +00001403 i64 os_szJ;
danielk197776572402004-06-25 02:38:54 +00001404 rc = sqlite3OsFileSize(&pPager->jfd, &os_szJ);
1405 if( rc!=SQLITE_OK ) return rc;
1406 assert( szJ==os_szJ );
1407 }
1408#endif
1409
1410 /* Set hdrOff to be the offset to the first journal header written
1411 ** this statement transaction, or the end of the file if no journal
1412 ** header was written.
1413 */
1414 hdrOff = pPager->stmtHdrOff;
1415 assert( pPager->fullSync || !hdrOff );
1416 if( !hdrOff ){
1417 hdrOff = szJ;
1418 }
1419
drhfa86c412002-02-02 15:01:15 +00001420 /* Truncate the database back to its original size.
1421 */
danielk197717221812005-02-15 03:38:05 +00001422 if( pPager->state>=PAGER_EXCLUSIVE ){
1423 rc = pager_truncate(pPager, pPager->stmtSize);
1424 }
drhac69b052004-05-12 13:30:07 +00001425 pPager->dbSize = pPager->stmtSize;
drhfa86c412002-02-02 15:01:15 +00001426
drhac69b052004-05-12 13:30:07 +00001427 /* Figure out how many records are in the statement journal.
drhfa86c412002-02-02 15:01:15 +00001428 */
drhac69b052004-05-12 13:30:07 +00001429 assert( pPager->stmtInUse && pPager->journalOpen );
1430 sqlite3OsSeek(&pPager->stfd, 0);
1431 nRec = pPager->stmtNRec;
drhfa86c412002-02-02 15:01:15 +00001432
drhac69b052004-05-12 13:30:07 +00001433 /* Copy original pages out of the statement journal and back into the
drhae2b40c2004-06-09 19:03:54 +00001434 ** database file. Note that the statement journal omits checksums from
1435 ** each record since power-failure recovery is not important to statement
1436 ** journals.
drhfa86c412002-02-02 15:01:15 +00001437 */
1438 for(i=nRec-1; i>=0; i--){
drhae2b40c2004-06-09 19:03:54 +00001439 rc = pager_playback_one_page(pPager, &pPager->stfd, 0);
drh968af522003-02-11 14:55:40 +00001440 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001441 if( rc!=SQLITE_OK ) goto end_stmt_playback;
drhfa86c412002-02-02 15:01:15 +00001442 }
1443
danielk197776572402004-06-25 02:38:54 +00001444 /* Now roll some pages back from the transaction journal. Pager.stmtJSize
1445 ** was the size of the journal file when this statement was started, so
1446 ** everything after that needs to be rolled back, either into the
1447 ** database, the memory cache, or both.
1448 **
1449 ** If it is not zero, then Pager.stmtHdrOff is the offset to the start
1450 ** of the first journal header written during this statement transaction.
drhfa86c412002-02-02 15:01:15 +00001451 */
drhac69b052004-05-12 13:30:07 +00001452 rc = sqlite3OsSeek(&pPager->jfd, pPager->stmtJSize);
drhfa86c412002-02-02 15:01:15 +00001453 if( rc!=SQLITE_OK ){
drh3aac2dd2004-04-26 14:10:20 +00001454 goto end_stmt_playback;
drhfa86c412002-02-02 15:01:15 +00001455 }
danielk197776572402004-06-25 02:38:54 +00001456 pPager->journalOff = pPager->stmtJSize;
danielk197775edc162004-06-26 01:48:18 +00001457 pPager->cksumInit = pPager->stmtCksum;
1458 assert( JOURNAL_HDR_SZ(pPager)<(pPager->pageSize+8) );
1459 while( pPager->journalOff <= (hdrOff-(pPager->pageSize+8)) ){
drhae2b40c2004-06-09 19:03:54 +00001460 rc = pager_playback_one_page(pPager, &pPager->jfd, 1);
danielk197776572402004-06-25 02:38:54 +00001461 assert( rc!=SQLITE_DONE );
1462 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1463 }
1464
1465 while( pPager->journalOff < szJ ){
1466 u32 nRec;
1467 u32 dummy;
1468 rc = readJournalHdr(pPager, szJ, &nRec, &dummy);
drh968af522003-02-11 14:55:40 +00001469 if( rc!=SQLITE_OK ){
1470 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001471 goto end_stmt_playback;
drh968af522003-02-11 14:55:40 +00001472 }
danielk197775edc162004-06-26 01:48:18 +00001473 if( nRec==0 ){
1474 nRec = (szJ - pPager->journalOff) / (pPager->pageSize+8);
1475 }
danielk197776572402004-06-25 02:38:54 +00001476 for(i=nRec-1; i>=0 && pPager->journalOff < szJ; i--){
1477 rc = pager_playback_one_page(pPager, &pPager->jfd, 1);
1478 assert( rc!=SQLITE_DONE );
1479 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1480 }
drhfa86c412002-02-02 15:01:15 +00001481 }
danielk197776572402004-06-25 02:38:54 +00001482
1483 pPager->journalOff = szJ;
drhfa86c412002-02-02 15:01:15 +00001484
drh3aac2dd2004-04-26 14:10:20 +00001485end_stmt_playback:
drhfa86c412002-02-02 15:01:15 +00001486 if( rc!=SQLITE_OK ){
drhfa86c412002-02-02 15:01:15 +00001487 pPager->errMask |= PAGER_ERR_CORRUPT;
drhee696e22004-08-30 16:52:17 +00001488 rc = SQLITE_CORRUPT; /* bkpt-CORRUPT */
danielk197775edc162004-06-26 01:48:18 +00001489 }else{
1490 pPager->journalOff = szJ;
1491 /* pager_reload_cache(pPager); */
drhfa86c412002-02-02 15:01:15 +00001492 }
1493 return rc;
1494}
1495
1496/*
drhf57b14a2001-09-14 18:54:08 +00001497** Change the maximum number of in-memory pages that are allowed.
1498*/
drh3aac2dd2004-04-26 14:10:20 +00001499void sqlite3pager_set_cachesize(Pager *pPager, int mxPage){
drhf57b14a2001-09-14 18:54:08 +00001500 if( mxPage>10 ){
1501 pPager->mxPage = mxPage;
danielk1977ef317ab2004-06-23 10:43:10 +00001502 }else{
1503 pPager->mxPage = 10;
drhf57b14a2001-09-14 18:54:08 +00001504 }
1505}
1506
1507/*
drh973b6e32003-02-12 14:09:42 +00001508** Adjust the robustness of the database to damage due to OS crashes
1509** or power failures by changing the number of syncs()s when writing
1510** the rollback journal. There are three levels:
1511**
danielk19774adee202004-05-08 08:23:19 +00001512** OFF sqlite3OsSync() is never called. This is the default
drh973b6e32003-02-12 14:09:42 +00001513** for temporary and transient files.
1514**
1515** NORMAL The journal is synced once before writes begin on the
1516** database. This is normally adequate protection, but
1517** it is theoretically possible, though very unlikely,
1518** that an inopertune power failure could leave the journal
1519** in a state which would cause damage to the database
1520** when it is rolled back.
1521**
1522** FULL The journal is synced twice before writes begin on the
drh34e79ce2004-02-08 06:05:46 +00001523** database (with some additional information - the nRec field
1524** of the journal header - being written in between the two
1525** syncs). If we assume that writing a
drh973b6e32003-02-12 14:09:42 +00001526** single disk sector is atomic, then this mode provides
1527** assurance that the journal will not be corrupted to the
1528** point of causing damage to the database during rollback.
1529**
1530** Numeric values associated with these states are OFF==1, NORMAL=2,
1531** and FULL=3.
1532*/
danielk197793758c82005-01-21 08:13:14 +00001533#ifndef SQLITE_OMIT_PAGER_PRAGMAS
drh3aac2dd2004-04-26 14:10:20 +00001534void sqlite3pager_set_safety_level(Pager *pPager, int level){
drh973b6e32003-02-12 14:09:42 +00001535 pPager->noSync = level==1 || pPager->tempFile;
1536 pPager->fullSync = level==3 && !pPager->tempFile;
danielk19771d850a72004-05-31 08:26:49 +00001537 if( pPager->noSync ) pPager->needSync = 0;
drh973b6e32003-02-12 14:09:42 +00001538}
danielk197793758c82005-01-21 08:13:14 +00001539#endif
drh973b6e32003-02-12 14:09:42 +00001540
1541/*
drhaf6df112005-06-07 02:12:30 +00001542** The following global variable is incremented whenever the library
1543** attempts to open a temporary file. This information is used for
1544** testing and analysis only.
1545*/
1546int sqlite3_opentemp_count = 0;
1547
1548/*
1549** Open a temporary file. Write the name of the file into zFile
1550** (zFile must be at least SQLITE_TEMPNAME_SIZE bytes long.) Write
drhfa86c412002-02-02 15:01:15 +00001551** the file descriptor into *fd. Return SQLITE_OK on success or some
1552** other error code if we fail.
1553**
1554** The OS will automatically delete the temporary file when it is
1555** closed.
1556*/
drh3aac2dd2004-04-26 14:10:20 +00001557static int sqlite3pager_opentemp(char *zFile, OsFile *fd){
drhfa86c412002-02-02 15:01:15 +00001558 int cnt = 8;
1559 int rc;
drhaf6df112005-06-07 02:12:30 +00001560 sqlite3_opentemp_count++; /* Used for testing and analysis only */
drhfa86c412002-02-02 15:01:15 +00001561 do{
1562 cnt--;
danielk19774adee202004-05-08 08:23:19 +00001563 sqlite3OsTempFileName(zFile);
1564 rc = sqlite3OsOpenExclusive(zFile, fd, 1);
danielk197713073932004-06-30 11:54:06 +00001565 }while( cnt>0 && rc!=SQLITE_OK && rc!=SQLITE_NOMEM );
drhfa86c412002-02-02 15:01:15 +00001566 return rc;
1567}
1568
1569/*
drhed7c8552001-04-11 14:29:21 +00001570** Create a new page cache and put a pointer to the page cache in *ppPager.
drh5e00f6c2001-09-13 13:46:56 +00001571** The file to be cached need not exist. The file is not locked until
drh3aac2dd2004-04-26 14:10:20 +00001572** the first call to sqlite3pager_get() and is only held open until the
1573** last page is released using sqlite3pager_unref().
drh382c0242001-10-06 16:33:02 +00001574**
drh6446c4d2001-12-15 14:22:18 +00001575** If zFilename is NULL then a randomly-named temporary file is created
1576** and used as the file to be cached. The file will be deleted
1577** automatically when it is closed.
drh90f5ecb2004-07-22 01:19:35 +00001578**
1579** If zFilename is ":memory:" then all information is held in cache.
1580** It is never written to disk. This can be used to implement an
1581** in-memory database.
drhed7c8552001-04-11 14:29:21 +00001582*/
drh3aac2dd2004-04-26 14:10:20 +00001583int sqlite3pager_open(
drh7e3b0a02001-04-28 16:52:40 +00001584 Pager **ppPager, /* Return the Pager structure here */
1585 const char *zFilename, /* Name of the database file to open */
drhda47d772002-12-02 04:25:19 +00001586 int nExtra, /* Extra bytes append to each in-memory page */
drh7bec5052005-02-06 02:45:41 +00001587 int flags /* flags controlling this file */
drh7e3b0a02001-04-28 16:52:40 +00001588){
drhed7c8552001-04-11 14:29:21 +00001589 Pager *pPager;
danielk19778def5ea2004-06-16 10:39:52 +00001590 char *zFullPathname = 0;
drhed7c8552001-04-11 14:29:21 +00001591 int nameLen;
drh8cfbf082001-09-19 13:22:39 +00001592 OsFile fd;
danielk1977cfe9a692004-06-16 12:00:29 +00001593 int rc = SQLITE_OK;
1594 int i;
danielk19778def5ea2004-06-16 10:39:52 +00001595 int tempFile = 0;
drhac69b052004-05-12 13:30:07 +00001596 int memDb = 0;
drh5e00f6c2001-09-13 13:46:56 +00001597 int readOnly = 0;
drh7bec5052005-02-06 02:45:41 +00001598 int useJournal = (flags & PAGER_OMIT_JOURNAL)==0;
1599 int noReadlock = (flags & PAGER_NO_READLOCK)!=0;
drh8cfbf082001-09-19 13:22:39 +00001600 char zTemp[SQLITE_TEMPNAME_SIZE];
drhed7c8552001-04-11 14:29:21 +00001601
drhd9b02572001-04-15 00:37:09 +00001602 *ppPager = 0;
drhda71ce12004-06-21 18:14:45 +00001603 memset(&fd, 0, sizeof(fd));
danielk19776f8a5032004-05-10 10:34:51 +00001604 if( sqlite3_malloc_failed ){
drhd9b02572001-04-15 00:37:09 +00001605 return SQLITE_NOMEM;
1606 }
drh901afd42003-08-26 11:25:58 +00001607 if( zFilename && zFilename[0] ){
drhb7f91642004-10-31 02:22:47 +00001608#ifndef SQLITE_OMIT_MEMORYDB
drhac69b052004-05-12 13:30:07 +00001609 if( strcmp(zFilename,":memory:")==0 ){
1610 memDb = 1;
drhda71ce12004-06-21 18:14:45 +00001611 zFullPathname = sqliteStrDup("");
drhac69b052004-05-12 13:30:07 +00001612 rc = SQLITE_OK;
drhb7f91642004-10-31 02:22:47 +00001613 }else
1614#endif
1615 {
drhac69b052004-05-12 13:30:07 +00001616 zFullPathname = sqlite3OsFullPathname(zFilename);
danielk19778def5ea2004-06-16 10:39:52 +00001617 if( zFullPathname ){
1618 rc = sqlite3OsOpenReadWrite(zFullPathname, &fd, &readOnly);
1619 }
drhac69b052004-05-12 13:30:07 +00001620 }
drh5e00f6c2001-09-13 13:46:56 +00001621 }else{
drh3aac2dd2004-04-26 14:10:20 +00001622 rc = sqlite3pager_opentemp(zTemp, &fd);
drh5e00f6c2001-09-13 13:46:56 +00001623 zFilename = zTemp;
danielk19774adee202004-05-08 08:23:19 +00001624 zFullPathname = sqlite3OsFullPathname(zFilename);
danielk19778def5ea2004-06-16 10:39:52 +00001625 if( rc==SQLITE_OK ){
1626 tempFile = 1;
1627 }
drh5e00f6c2001-09-13 13:46:56 +00001628 }
danielk19778def5ea2004-06-16 10:39:52 +00001629 if( !zFullPathname ){
danielk1977b5548a82004-06-26 13:51:33 +00001630 sqlite3OsClose(&fd);
drh3e7a6092002-12-07 21:45:14 +00001631 return SQLITE_NOMEM;
1632 }
drh8cfbf082001-09-19 13:22:39 +00001633 if( rc!=SQLITE_OK ){
drhda71ce12004-06-21 18:14:45 +00001634 sqlite3OsClose(&fd);
1635 sqliteFree(zFullPathname);
danielk19778def5ea2004-06-16 10:39:52 +00001636 return rc;
drhed7c8552001-04-11 14:29:21 +00001637 }
drh3e7a6092002-12-07 21:45:14 +00001638 nameLen = strlen(zFullPathname);
drha76c82e2003-07-27 18:59:42 +00001639 pPager = sqliteMalloc( sizeof(*pPager) + nameLen*3 + 30 );
drhd9b02572001-04-15 00:37:09 +00001640 if( pPager==0 ){
drhda71ce12004-06-21 18:14:45 +00001641 sqlite3OsClose(&fd);
1642 sqliteFree(zFullPathname);
drhd9b02572001-04-15 00:37:09 +00001643 return SQLITE_NOMEM;
1644 }
danielk1977ef73ee92004-11-06 12:26:07 +00001645 TRACE3("OPEN %d %s\n", FILEHANDLEID(fd), zFullPathname);
drhed7c8552001-04-11 14:29:21 +00001646 pPager->zFilename = (char*)&pPager[1];
drha76c82e2003-07-27 18:59:42 +00001647 pPager->zDirectory = &pPager->zFilename[nameLen+1];
1648 pPager->zJournal = &pPager->zDirectory[nameLen+1];
drh3e7a6092002-12-07 21:45:14 +00001649 strcpy(pPager->zFilename, zFullPathname);
drha76c82e2003-07-27 18:59:42 +00001650 strcpy(pPager->zDirectory, zFullPathname);
1651 for(i=nameLen; i>0 && pPager->zDirectory[i-1]!='/'; i--){}
1652 if( i>0 ) pPager->zDirectory[i-1] = 0;
drh3e7a6092002-12-07 21:45:14 +00001653 strcpy(pPager->zJournal, zFullPathname);
1654 sqliteFree(zFullPathname);
drhed7c8552001-04-11 14:29:21 +00001655 strcpy(&pPager->zJournal[nameLen], "-journal");
1656 pPager->fd = fd;
drh6d08b4d2004-07-20 12:45:22 +00001657#if OS_UNIX
drhd5b447d2004-07-19 22:08:09 +00001658 pPager->fd.pPager = pPager;
drh6d08b4d2004-07-20 12:45:22 +00001659#endif
drh8cfbf082001-09-19 13:22:39 +00001660 pPager->journalOpen = 0;
drhac69b052004-05-12 13:30:07 +00001661 pPager->useJournal = useJournal && !memDb;
drh7bec5052005-02-06 02:45:41 +00001662 pPager->noReadlock = noReadlock && readOnly;
drhac69b052004-05-12 13:30:07 +00001663 pPager->stmtOpen = 0;
1664 pPager->stmtInUse = 0;
drhed7c8552001-04-11 14:29:21 +00001665 pPager->nRef = 0;
drhac69b052004-05-12 13:30:07 +00001666 pPager->dbSize = memDb-1;
drh90f5ecb2004-07-22 01:19:35 +00001667 pPager->pageSize = SQLITE_DEFAULT_PAGE_SIZE;
drhac69b052004-05-12 13:30:07 +00001668 pPager->stmtSize = 0;
1669 pPager->stmtJSize = 0;
drhed7c8552001-04-11 14:29:21 +00001670 pPager->nPage = 0;
danielk1977e94ddc92005-03-21 03:53:38 +00001671 pPager->nMaxPage = 0;
drh90f5ecb2004-07-22 01:19:35 +00001672 pPager->mxPage = 100;
drha6abd042004-06-09 17:37:22 +00001673 pPager->state = PAGER_UNLOCK;
drhd9b02572001-04-15 00:37:09 +00001674 pPager->errMask = 0;
drh5e00f6c2001-09-13 13:46:56 +00001675 pPager->tempFile = tempFile;
drhac69b052004-05-12 13:30:07 +00001676 pPager->memDb = memDb;
drh5e00f6c2001-09-13 13:46:56 +00001677 pPager->readOnly = readOnly;
drhf57b14a2001-09-14 18:54:08 +00001678 pPager->needSync = 0;
drhda47d772002-12-02 04:25:19 +00001679 pPager->noSync = pPager->tempFile || !useJournal;
danielk197775edc162004-06-26 01:48:18 +00001680 pPager->fullSync = (pPager->noSync?0:1);
drhed7c8552001-04-11 14:29:21 +00001681 pPager->pFirst = 0;
drh341eae82003-01-21 02:39:36 +00001682 pPager->pFirstSynced = 0;
drhed7c8552001-04-11 14:29:21 +00001683 pPager->pLast = 0;
drh887dc4c2004-10-22 16:22:57 +00001684 pPager->nExtra = FORCE_ALIGNMENT(nExtra);
danielk197776572402004-06-25 02:38:54 +00001685 pPager->sectorSize = PAGER_SECTOR_SIZE;
drh90f5ecb2004-07-22 01:19:35 +00001686 pPager->pBusyHandler = 0;
drhed7c8552001-04-11 14:29:21 +00001687 memset(pPager->aHash, 0, sizeof(pPager->aHash));
1688 *ppPager = pPager;
1689 return SQLITE_OK;
1690}
1691
1692/*
drh90f5ecb2004-07-22 01:19:35 +00001693** Set the busy handler function.
1694*/
1695void sqlite3pager_set_busyhandler(Pager *pPager, BusyHandler *pBusyHandler){
1696 pPager->pBusyHandler = pBusyHandler;
1697}
1698
1699/*
drh72f82862001-05-24 21:06:34 +00001700** Set the destructor for this pager. If not NULL, the destructor is called
drh5e00f6c2001-09-13 13:46:56 +00001701** when the reference count on each page reaches zero. The destructor can
1702** be used to clean up information in the extra segment appended to each page.
drh72f82862001-05-24 21:06:34 +00001703**
drh3aac2dd2004-04-26 14:10:20 +00001704** The destructor is not called as a result sqlite3pager_close().
1705** Destructors are only called by sqlite3pager_unref().
drh72f82862001-05-24 21:06:34 +00001706*/
drhb6f41482004-05-14 01:58:11 +00001707void sqlite3pager_set_destructor(Pager *pPager, void (*xDesc)(void*,int)){
drh72f82862001-05-24 21:06:34 +00001708 pPager->xDestructor = xDesc;
1709}
1710
1711/*
drha6abd042004-06-09 17:37:22 +00001712** Set the reinitializer for this pager. If not NULL, the reinitializer
1713** is called when the content of a page in cache is restored to its original
1714** value as a result of a rollback. The callback gives higher-level code
1715** an opportunity to restore the EXTRA section to agree with the restored
1716** page data.
1717*/
1718void sqlite3pager_set_reiniter(Pager *pPager, void (*xReinit)(void*,int)){
1719 pPager->xReiniter = xReinit;
1720}
1721
1722/*
drh1c7880e2005-05-20 20:01:55 +00001723** Set the page size. Return the new size. If the suggest new page
1724** size is inappropriate, then an alternative page size is selected
1725** and returned.
drh90f5ecb2004-07-22 01:19:35 +00001726*/
drh1c7880e2005-05-20 20:01:55 +00001727int sqlite3pager_set_pagesize(Pager *pPager, int pageSize){
drh90f5ecb2004-07-22 01:19:35 +00001728 assert( pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE );
drh1c7880e2005-05-20 20:01:55 +00001729 if( !pPager->memDb ){
1730 pPager->pageSize = pageSize;
1731 }
1732 return pPager->pageSize;
drh90f5ecb2004-07-22 01:19:35 +00001733}
1734
1735/*
1736** Read the first N bytes from the beginning of the file into memory
1737** that pDest points to. No error checking is done.
1738*/
1739void sqlite3pager_read_fileheader(Pager *pPager, int N, unsigned char *pDest){
1740 memset(pDest, 0, N);
drhb7f91642004-10-31 02:22:47 +00001741 if( MEMDB==0 ){
drh90f5ecb2004-07-22 01:19:35 +00001742 sqlite3OsSeek(&pPager->fd, 0);
1743 sqlite3OsRead(&pPager->fd, pDest, N);
1744 }
1745}
1746
1747/*
drh5e00f6c2001-09-13 13:46:56 +00001748** Return the total number of pages in the disk file associated with
1749** pPager.
drhed7c8552001-04-11 14:29:21 +00001750*/
drh3aac2dd2004-04-26 14:10:20 +00001751int sqlite3pager_pagecount(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001752 i64 n;
drhd9b02572001-04-15 00:37:09 +00001753 assert( pPager!=0 );
drhed7c8552001-04-11 14:29:21 +00001754 if( pPager->dbSize>=0 ){
1755 return pPager->dbSize;
1756 }
danielk19774adee202004-05-08 08:23:19 +00001757 if( sqlite3OsFileSize(&pPager->fd, &n)!=SQLITE_OK ){
drh81a20f22001-10-12 17:30:04 +00001758 pPager->errMask |= PAGER_ERR_DISK;
drh8cfbf082001-09-19 13:22:39 +00001759 return 0;
drhed7c8552001-04-11 14:29:21 +00001760 }
drh90f5ecb2004-07-22 01:19:35 +00001761 n /= pPager->pageSize;
drhb7f91642004-10-31 02:22:47 +00001762 if( !MEMDB && n==PENDING_BYTE/pPager->pageSize ){
drh1f595712004-06-15 01:40:29 +00001763 n++;
1764 }
drha6abd042004-06-09 17:37:22 +00001765 if( pPager->state!=PAGER_UNLOCK ){
drhed7c8552001-04-11 14:29:21 +00001766 pPager->dbSize = n;
1767 }
1768 return n;
1769}
1770
1771/*
drhf7c57532003-04-25 13:22:51 +00001772** Forward declaration
1773*/
danielk197776572402004-06-25 02:38:54 +00001774static int syncJournal(Pager*);
drhf7c57532003-04-25 13:22:51 +00001775
drhac69b052004-05-12 13:30:07 +00001776
1777/*
danielk1977f5fdda82004-11-03 08:44:05 +00001778** Unlink pPg from it's hash chain. Also set the page number to 0 to indicate
1779** that the page is not part of any hash chain. This is required because the
1780** sqlite3pager_movepage() routine can leave a page in the
1781** pNextFree/pPrevFree list that is not a part of any hash-chain.
1782*/
1783static void unlinkHashChain(Pager *pPager, PgHdr *pPg){
1784 if( pPg->pgno==0 ){
1785 /* If the page number is zero, then this page is not in any hash chain. */
1786 return;
1787 }
1788 if( pPg->pNextHash ){
1789 pPg->pNextHash->pPrevHash = pPg->pPrevHash;
1790 }
1791 if( pPg->pPrevHash ){
1792 assert( pPager->aHash[pager_hash(pPg->pgno)]!=pPg );
1793 pPg->pPrevHash->pNextHash = pPg->pNextHash;
1794 }else{
1795 int h = pager_hash(pPg->pgno);
1796 assert( pPager->aHash[h]==pPg );
1797 pPager->aHash[h] = pPg->pNextHash;
1798 }
1799
1800 pPg->pgno = 0;
1801 pPg->pNextHash = pPg->pPrevHash = 0;
1802}
1803
1804/*
drhac69b052004-05-12 13:30:07 +00001805** Unlink a page from the free list (the list of all pages where nRef==0)
1806** and from its hash collision chain.
1807*/
1808static void unlinkPage(PgHdr *pPg){
1809 Pager *pPager = pPg->pPager;
1810
1811 /* Keep the pFirstSynced pointer pointing at the first synchronized page */
1812 if( pPg==pPager->pFirstSynced ){
1813 PgHdr *p = pPg->pNextFree;
1814 while( p && p->needSync ){ p = p->pNextFree; }
1815 pPager->pFirstSynced = p;
1816 }
1817
1818 /* Unlink from the freelist */
1819 if( pPg->pPrevFree ){
1820 pPg->pPrevFree->pNextFree = pPg->pNextFree;
1821 }else{
1822 assert( pPager->pFirst==pPg );
1823 pPager->pFirst = pPg->pNextFree;
1824 }
1825 if( pPg->pNextFree ){
1826 pPg->pNextFree->pPrevFree = pPg->pPrevFree;
1827 }else{
1828 assert( pPager->pLast==pPg );
1829 pPager->pLast = pPg->pPrevFree;
1830 }
1831 pPg->pNextFree = pPg->pPrevFree = 0;
1832
1833 /* Unlink from the pgno hash table */
danielk1977f5fdda82004-11-03 08:44:05 +00001834 unlinkHashChain(pPager, pPg);
drhac69b052004-05-12 13:30:07 +00001835}
1836
danielk1977b84f96f2005-01-20 11:32:23 +00001837#ifndef SQLITE_OMIT_MEMORYDB
drhac69b052004-05-12 13:30:07 +00001838/*
1839** This routine is used to truncate an in-memory database. Delete
danielk1977369f27e2004-06-15 11:40:04 +00001840** all pages whose pgno is larger than pPager->dbSize and is unreferenced.
drhac69b052004-05-12 13:30:07 +00001841** Referenced pages larger than pPager->dbSize are zeroed.
1842*/
1843static void memoryTruncate(Pager *pPager){
1844 PgHdr *pPg;
1845 PgHdr **ppPg;
1846 int dbSize = pPager->dbSize;
1847
1848 ppPg = &pPager->pAll;
1849 while( (pPg = *ppPg)!=0 ){
1850 if( pPg->pgno<=dbSize ){
1851 ppPg = &pPg->pNextAll;
1852 }else if( pPg->nRef>0 ){
1853 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
1854 ppPg = &pPg->pNextAll;
1855 }else{
1856 *ppPg = pPg->pNextAll;
1857 unlinkPage(pPg);
1858 sqliteFree(pPg);
1859 pPager->nPage--;
1860 }
1861 }
1862}
danielk1977b84f96f2005-01-20 11:32:23 +00001863#else
1864#define memoryTruncate(p)
1865#endif
drhac69b052004-05-12 13:30:07 +00001866
drhf7c57532003-04-25 13:22:51 +00001867/*
danielk197717221812005-02-15 03:38:05 +00001868** Try to obtain a lock on a file. Invoke the busy callback if the lock
1869** is currently not available. Repeate until the busy callback returns
1870** false or until the lock succeeds.
1871**
1872** Return SQLITE_OK on success and an error code if we cannot obtain
1873** the lock.
1874*/
1875static int pager_wait_on_lock(Pager *pPager, int locktype){
1876 int rc;
1877 assert( PAGER_SHARED==SHARED_LOCK );
1878 assert( PAGER_RESERVED==RESERVED_LOCK );
1879 assert( PAGER_EXCLUSIVE==EXCLUSIVE_LOCK );
1880 if( pPager->state>=locktype ){
1881 rc = SQLITE_OK;
1882 }else{
1883 int busy = 1;
drhb8ef32c2005-03-14 02:01:49 +00001884 BusyHandler *pH;
danielk197717221812005-02-15 03:38:05 +00001885 do {
1886 rc = sqlite3OsLock(&pPager->fd, locktype);
1887 }while( rc==SQLITE_BUSY &&
drhb8ef32c2005-03-14 02:01:49 +00001888 (pH = pPager->pBusyHandler)!=0 &&
1889 pH->xFunc && pH->xFunc(pH->pArg, busy++)
danielk197717221812005-02-15 03:38:05 +00001890 );
1891 if( rc==SQLITE_OK ){
1892 pPager->state = locktype;
1893 }
1894 }
1895 return rc;
1896}
1897
1898/*
drhf7c57532003-04-25 13:22:51 +00001899** Truncate the file to the number of pages specified.
1900*/
drh3aac2dd2004-04-26 14:10:20 +00001901int sqlite3pager_truncate(Pager *pPager, Pgno nPage){
drhf7c57532003-04-25 13:22:51 +00001902 int rc;
drhdc3ff9c2004-08-18 02:10:15 +00001903 sqlite3pager_pagecount(pPager);
drh2e6d11b2003-04-25 15:37:57 +00001904 if( pPager->errMask!=0 ){
1905 rc = pager_errcode(pPager);
1906 return rc;
1907 }
drh7d02cb72003-06-04 16:24:39 +00001908 if( nPage>=(unsigned)pPager->dbSize ){
drhf7c57532003-04-25 13:22:51 +00001909 return SQLITE_OK;
1910 }
drhb7f91642004-10-31 02:22:47 +00001911 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00001912 pPager->dbSize = nPage;
1913 memoryTruncate(pPager);
1914 return SQLITE_OK;
1915 }
danielk197776572402004-06-25 02:38:54 +00001916 rc = syncJournal(pPager);
danielk1977369f27e2004-06-15 11:40:04 +00001917 if( rc!=SQLITE_OK ){
1918 return rc;
1919 }
danielk197717221812005-02-15 03:38:05 +00001920
1921 /* Get an exclusive lock on the database before truncating. */
1922 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
1923 if( rc!=SQLITE_OK ){
1924 return rc;
1925 }
1926
drhcb4c40b2004-08-18 19:09:43 +00001927 rc = pager_truncate(pPager, nPage);
drhf7c57532003-04-25 13:22:51 +00001928 if( rc==SQLITE_OK ){
1929 pPager->dbSize = nPage;
1930 }
1931 return rc;
1932}
1933
1934/*
drhed7c8552001-04-11 14:29:21 +00001935** Shutdown the page cache. Free all memory and close all files.
1936**
1937** If a transaction was in progress when this routine is called, that
1938** transaction is rolled back. All outstanding pages are invalidated
1939** and their memory is freed. Any attempt to use a page associated
1940** with this page cache after this function returns will likely
1941** result in a coredump.
1942*/
drh3aac2dd2004-04-26 14:10:20 +00001943int sqlite3pager_close(Pager *pPager){
drhd9b02572001-04-15 00:37:09 +00001944 PgHdr *pPg, *pNext;
drhed7c8552001-04-11 14:29:21 +00001945 switch( pPager->state ){
drha6abd042004-06-09 17:37:22 +00001946 case PAGER_RESERVED:
danielk1977aa5ccdf2004-06-14 05:10:42 +00001947 case PAGER_SYNCED:
drha6abd042004-06-09 17:37:22 +00001948 case PAGER_EXCLUSIVE: {
danielk1977b3bce662005-01-29 08:32:43 +00001949 /* We ignore any IO errors that occur during the rollback
1950 ** operation. So disable IO error simulation so that testing
1951 ** works more easily.
1952 */
1953#if defined(SQLITE_TEST) && (defined(OS_UNIX) || defined(OS_WIN))
1954 extern int sqlite3_io_error_pending;
1955 int ioerr_cnt = sqlite3_io_error_pending;
1956 sqlite3_io_error_pending = -1;
1957#endif
drh3aac2dd2004-04-26 14:10:20 +00001958 sqlite3pager_rollback(pPager);
danielk1977b3bce662005-01-29 08:32:43 +00001959#if defined(SQLITE_TEST) && (defined(OS_UNIX) || defined(OS_WIN))
1960 sqlite3_io_error_pending = ioerr_cnt;
1961#endif
drhb7f91642004-10-31 02:22:47 +00001962 if( !MEMDB ){
drha6abd042004-06-09 17:37:22 +00001963 sqlite3OsUnlock(&pPager->fd, NO_LOCK);
drhac69b052004-05-12 13:30:07 +00001964 }
danielk1977e94ddc92005-03-21 03:53:38 +00001965 assert( pPager->errMask || pPager->journalOpen==0 );
drhed7c8552001-04-11 14:29:21 +00001966 break;
1967 }
drha6abd042004-06-09 17:37:22 +00001968 case PAGER_SHARED: {
drhb7f91642004-10-31 02:22:47 +00001969 if( !MEMDB ){
drha6abd042004-06-09 17:37:22 +00001970 sqlite3OsUnlock(&pPager->fd, NO_LOCK);
drhac69b052004-05-12 13:30:07 +00001971 }
drhed7c8552001-04-11 14:29:21 +00001972 break;
1973 }
1974 default: {
1975 /* Do nothing */
1976 break;
1977 }
1978 }
drhd9b02572001-04-15 00:37:09 +00001979 for(pPg=pPager->pAll; pPg; pPg=pNext){
danielk1977eac7a362004-06-16 07:45:24 +00001980#ifndef NDEBUG
drhb7f91642004-10-31 02:22:47 +00001981 if( MEMDB ){
danielk1977eac7a362004-06-16 07:45:24 +00001982 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
1983 assert( !pPg->alwaysRollback );
1984 assert( !pHist->pOrig );
1985 assert( !pHist->pStmt );
1986 }
1987#endif
drhd9b02572001-04-15 00:37:09 +00001988 pNext = pPg->pNextAll;
1989 sqliteFree(pPg);
drhed7c8552001-04-11 14:29:21 +00001990 }
danielk1977ef73ee92004-11-06 12:26:07 +00001991 TRACE2("CLOSE %d\n", PAGERID(pPager));
danielk1977e94ddc92005-03-21 03:53:38 +00001992 assert( pPager->errMask || (pPager->journalOpen==0 && pPager->stmtOpen==0) );
1993 if( pPager->journalOpen ){
1994 sqlite3OsClose(&pPager->jfd);
1995 }
drh88b01a12005-03-28 18:04:27 +00001996 sqliteFree(pPager->aInJournal);
danielk1977e94ddc92005-03-21 03:53:38 +00001997 if( pPager->stmtOpen ){
1998 sqlite3OsClose(&pPager->stfd);
1999 }
drhda71ce12004-06-21 18:14:45 +00002000 sqlite3OsClose(&pPager->fd);
drh0f892532002-05-30 12:27:03 +00002001 /* Temp files are automatically deleted by the OS
2002 ** if( pPager->tempFile ){
danielk19774adee202004-05-08 08:23:19 +00002003 ** sqlite3OsDelete(pPager->zFilename);
drh0f892532002-05-30 12:27:03 +00002004 ** }
2005 */
danielk1977aca790a2005-01-13 11:07:52 +00002006
drhed7c8552001-04-11 14:29:21 +00002007 sqliteFree(pPager);
2008 return SQLITE_OK;
2009}
2010
2011/*
drh5e00f6c2001-09-13 13:46:56 +00002012** Return the page number for the given page data.
drhed7c8552001-04-11 14:29:21 +00002013*/
drh3aac2dd2004-04-26 14:10:20 +00002014Pgno sqlite3pager_pagenumber(void *pData){
drhed7c8552001-04-11 14:29:21 +00002015 PgHdr *p = DATA_TO_PGHDR(pData);
2016 return p->pgno;
2017}
2018
2019/*
drhc8629a12004-05-08 20:07:40 +00002020** The page_ref() function increments the reference count for a page.
2021** If the page is currently on the freelist (the reference count is zero) then
drh7e3b0a02001-04-28 16:52:40 +00002022** remove it from the freelist.
drhc8629a12004-05-08 20:07:40 +00002023**
2024** For non-test systems, page_ref() is a macro that calls _page_ref()
2025** online of the reference count is zero. For test systems, page_ref()
2026** is a real function so that we can set breakpoints and trace it.
drh7e3b0a02001-04-28 16:52:40 +00002027*/
drh836faa42003-01-11 13:30:57 +00002028static void _page_ref(PgHdr *pPg){
drh7e3b0a02001-04-28 16:52:40 +00002029 if( pPg->nRef==0 ){
2030 /* The page is currently on the freelist. Remove it. */
drh341eae82003-01-21 02:39:36 +00002031 if( pPg==pPg->pPager->pFirstSynced ){
2032 PgHdr *p = pPg->pNextFree;
2033 while( p && p->needSync ){ p = p->pNextFree; }
2034 pPg->pPager->pFirstSynced = p;
2035 }
drh7e3b0a02001-04-28 16:52:40 +00002036 if( pPg->pPrevFree ){
2037 pPg->pPrevFree->pNextFree = pPg->pNextFree;
2038 }else{
2039 pPg->pPager->pFirst = pPg->pNextFree;
2040 }
2041 if( pPg->pNextFree ){
2042 pPg->pNextFree->pPrevFree = pPg->pPrevFree;
2043 }else{
2044 pPg->pPager->pLast = pPg->pPrevFree;
2045 }
2046 pPg->pPager->nRef++;
2047 }
2048 pPg->nRef++;
drhdd793422001-06-28 01:54:48 +00002049 REFINFO(pPg);
drhdf0b3b02001-06-23 11:36:20 +00002050}
danielk1977aca790a2005-01-13 11:07:52 +00002051#ifdef SQLITE_DEBUG
drhc8629a12004-05-08 20:07:40 +00002052 static void page_ref(PgHdr *pPg){
2053 if( pPg->nRef==0 ){
2054 _page_ref(pPg);
2055 }else{
2056 pPg->nRef++;
2057 REFINFO(pPg);
2058 }
2059 }
2060#else
2061# define page_ref(P) ((P)->nRef==0?_page_ref(P):(void)(P)->nRef++)
2062#endif
drhdf0b3b02001-06-23 11:36:20 +00002063
2064/*
2065** Increment the reference count for a page. The input pointer is
2066** a reference to the page data.
2067*/
drh3aac2dd2004-04-26 14:10:20 +00002068int sqlite3pager_ref(void *pData){
drhdf0b3b02001-06-23 11:36:20 +00002069 PgHdr *pPg = DATA_TO_PGHDR(pData);
2070 page_ref(pPg);
drh8c42ca92001-06-22 19:15:00 +00002071 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +00002072}
2073
2074/*
drh34e79ce2004-02-08 06:05:46 +00002075** Sync the journal. In other words, make sure all the pages that have
2076** been written to the journal have actually reached the surface of the
2077** disk. It is not safe to modify the original database file until after
2078** the journal has been synced. If the original database is modified before
2079** the journal is synced and a power failure occurs, the unsynced journal
2080** data would be lost and we would be unable to completely rollback the
2081** database changes. Database corruption would occur.
2082**
2083** This routine also updates the nRec field in the header of the journal.
2084** (See comments on the pager_playback() routine for additional information.)
2085** If the sync mode is FULL, two syncs will occur. First the whole journal
2086** is synced, then the nRec field is updated, then a second sync occurs.
drhb19a2bc2001-09-16 00:13:26 +00002087**
drh34e79ce2004-02-08 06:05:46 +00002088** For temporary databases, we do not care if we are able to rollback
2089** after a power failure, so sync occurs.
drhfa86c412002-02-02 15:01:15 +00002090**
drh34e79ce2004-02-08 06:05:46 +00002091** This routine clears the needSync field of every page current held in
2092** memory.
drh50e5dad2001-09-15 00:57:28 +00002093*/
danielk197776572402004-06-25 02:38:54 +00002094static int syncJournal(Pager *pPager){
drh50e5dad2001-09-15 00:57:28 +00002095 PgHdr *pPg;
2096 int rc = SQLITE_OK;
drh03eb96a2002-11-10 23:32:56 +00002097
2098 /* Sync the journal before modifying the main database
2099 ** (assuming there is a journal and it needs to be synced.)
2100 */
danielk197776572402004-06-25 02:38:54 +00002101 if( pPager->needSync ){
drhfa86c412002-02-02 15:01:15 +00002102 if( !pPager->tempFile ){
drhdb48ee02003-01-16 13:42:43 +00002103 assert( pPager->journalOpen );
drh946966f2004-02-25 02:20:41 +00002104 /* assert( !pPager->noSync ); // noSync might be set if synchronous
2105 ** was turned off after the transaction was started. Ticket #615 */
drh968af522003-02-11 14:55:40 +00002106#ifndef NDEBUG
2107 {
drh34e79ce2004-02-08 06:05:46 +00002108 /* Make sure the pPager->nRec counter we are keeping agrees
2109 ** with the nRec computed from the size of the journal file.
2110 */
drheb206252004-10-01 02:00:31 +00002111 i64 jSz;
danielk19774adee202004-05-08 08:23:19 +00002112 rc = sqlite3OsFileSize(&pPager->jfd, &jSz);
drh968af522003-02-11 14:55:40 +00002113 if( rc!=0 ) return rc;
danielk197776572402004-06-25 02:38:54 +00002114 assert( pPager->journalOff==jSz );
drh968af522003-02-11 14:55:40 +00002115 }
2116#endif
drhae2b40c2004-06-09 19:03:54 +00002117 {
danielk197776572402004-06-25 02:38:54 +00002118 /* Write the nRec value into the journal file header. If in
2119 ** full-synchronous mode, sync the journal first. This ensures that
2120 ** all data has really hit the disk before nRec is updated to mark
2121 ** it as a candidate for rollback.
2122 */
drhd8d66e82003-02-12 02:10:15 +00002123 if( pPager->fullSync ){
danielk1977ef73ee92004-11-06 12:26:07 +00002124 TRACE2("SYNC journal of %d\n", PAGERID(pPager));
danielk19774adee202004-05-08 08:23:19 +00002125 rc = sqlite3OsSync(&pPager->jfd);
drhd8d66e82003-02-12 02:10:15 +00002126 if( rc!=0 ) return rc;
2127 }
danielk197776572402004-06-25 02:38:54 +00002128 sqlite3OsSeek(&pPager->jfd, pPager->journalHdr + sizeof(aJournalMagic));
drh99ee3602003-02-16 19:13:36 +00002129 rc = write32bits(&pPager->jfd, pPager->nRec);
2130 if( rc ) return rc;
danielk197713adf8a2004-06-03 16:08:41 +00002131
danielk197776572402004-06-25 02:38:54 +00002132 sqlite3OsSeek(&pPager->jfd, pPager->journalOff);
drh968af522003-02-11 14:55:40 +00002133 }
danielk1977ef73ee92004-11-06 12:26:07 +00002134 TRACE2("SYNC journal of %d\n", PAGERID(pPager));
danielk19774adee202004-05-08 08:23:19 +00002135 rc = sqlite3OsSync(&pPager->jfd);
drhfa86c412002-02-02 15:01:15 +00002136 if( rc!=0 ) return rc;
drhdb48ee02003-01-16 13:42:43 +00002137 pPager->journalStarted = 1;
drhfa86c412002-02-02 15:01:15 +00002138 }
drh50e5dad2001-09-15 00:57:28 +00002139 pPager->needSync = 0;
drh341eae82003-01-21 02:39:36 +00002140
2141 /* Erase the needSync flag from every page.
2142 */
2143 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2144 pPg->needSync = 0;
2145 }
2146 pPager->pFirstSynced = pPager->pFirst;
drh50e5dad2001-09-15 00:57:28 +00002147 }
drh03eb96a2002-11-10 23:32:56 +00002148
drh341eae82003-01-21 02:39:36 +00002149#ifndef NDEBUG
2150 /* If the Pager.needSync flag is clear then the PgHdr.needSync
2151 ** flag must also be clear for all pages. Verify that this
2152 ** invariant is true.
drh03eb96a2002-11-10 23:32:56 +00002153 */
drh341eae82003-01-21 02:39:36 +00002154 else{
2155 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2156 assert( pPg->needSync==0 );
2157 }
2158 assert( pPager->pFirstSynced==pPager->pFirst );
drh03eb96a2002-11-10 23:32:56 +00002159 }
drh341eae82003-01-21 02:39:36 +00002160#endif
drhdb48ee02003-01-16 13:42:43 +00002161
drh81a20f22001-10-12 17:30:04 +00002162 return rc;
drh50e5dad2001-09-15 00:57:28 +00002163}
2164
2165/*
drh2554f8b2003-01-22 01:26:44 +00002166** Given a list of pages (connected by the PgHdr.pDirty pointer) write
2167** every one of those pages out to the database file and mark them all
2168** as clean.
2169*/
2170static int pager_write_pagelist(PgHdr *pList){
2171 Pager *pPager;
2172 int rc;
2173
2174 if( pList==0 ) return SQLITE_OK;
2175 pPager = pList->pPager;
danielk19779eed5052004-06-04 10:38:30 +00002176
2177 /* At this point there may be either a RESERVED or EXCLUSIVE lock on the
2178 ** database file. If there is already an EXCLUSIVE lock, the following
2179 ** calls to sqlite3OsLock() are no-ops.
2180 **
drha6abd042004-06-09 17:37:22 +00002181 ** Moving the lock from RESERVED to EXCLUSIVE actually involves going
2182 ** through an intermediate state PENDING. A PENDING lock prevents new
2183 ** readers from attaching to the database but is unsufficient for us to
2184 ** write. The idea of a PENDING lock is to prevent new readers from
2185 ** coming in while we wait for existing readers to clear.
danielk19779eed5052004-06-04 10:38:30 +00002186 **
drha6abd042004-06-09 17:37:22 +00002187 ** While the pager is in the RESERVED state, the original database file
2188 ** is unchanged and we can rollback without having to playback the
2189 ** journal into the original database file. Once we transition to
2190 ** EXCLUSIVE, it means the database file has been changed and any rollback
2191 ** will require a journal playback.
danielk19779eed5052004-06-04 10:38:30 +00002192 */
drh684917c2004-10-05 02:41:42 +00002193 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
danielk19779eed5052004-06-04 10:38:30 +00002194 if( rc!=SQLITE_OK ){
2195 return rc;
2196 }
2197
drh2554f8b2003-01-22 01:26:44 +00002198 while( pList ){
2199 assert( pList->dirty );
drheb206252004-10-01 02:00:31 +00002200 sqlite3OsSeek(&pPager->fd, (pList->pgno-1)*(i64)pPager->pageSize);
danielk1977687566d2004-11-02 12:56:41 +00002201 /* If there are dirty pages in the page cache with page numbers greater
2202 ** than Pager.dbSize, this means sqlite3pager_truncate() was called to
2203 ** make the file smaller (presumably by auto-vacuum code). Do not write
2204 ** any such pages to the file.
2205 */
2206 if( pList->pgno<=pPager->dbSize ){
2207 CODEC(pPager, PGHDR_TO_DATA(pList), pList->pgno, 6);
danielk1977ef73ee92004-11-06 12:26:07 +00002208 TRACE3("STORE %d page %d\n", PAGERID(pPager), pList->pgno);
danielk1977687566d2004-11-02 12:56:41 +00002209 rc = sqlite3OsWrite(&pPager->fd, PGHDR_TO_DATA(pList), pPager->pageSize);
2210 CODEC(pPager, PGHDR_TO_DATA(pList), pList->pgno, 0);
drhfcd35c72005-05-21 02:48:08 +00002211 TEST_INCR(pPager->nWrite);
danielk1977687566d2004-11-02 12:56:41 +00002212 }
2213#ifndef NDEBUG
2214 else{
danielk1977ef73ee92004-11-06 12:26:07 +00002215 TRACE3("NOSTORE %d page %d\n", PAGERID(pPager), pList->pgno);
danielk1977687566d2004-11-02 12:56:41 +00002216 }
2217#endif
drh2554f8b2003-01-22 01:26:44 +00002218 if( rc ) return rc;
2219 pList->dirty = 0;
danielk19773c407372005-02-15 02:54:14 +00002220#ifdef SQLITE_CHECK_PAGES
2221 pList->pageHash = pager_pagehash(pList);
2222#endif
drh2554f8b2003-01-22 01:26:44 +00002223 pList = pList->pDirty;
2224 }
2225 return SQLITE_OK;
2226}
2227
2228/*
2229** Collect every dirty page into a dirty list and
2230** return a pointer to the head of that list. All pages are
2231** collected even if they are still in use.
2232*/
2233static PgHdr *pager_get_all_dirty_pages(Pager *pPager){
2234 PgHdr *p, *pList;
2235 pList = 0;
2236 for(p=pPager->pAll; p; p=p->pNextAll){
2237 if( p->dirty ){
2238 p->pDirty = pList;
2239 pList = p;
2240 }
2241 }
2242 return pList;
2243}
2244
2245/*
drh165ffe92005-03-15 17:09:30 +00002246** Return TRUE if there is a hot journal on the given pager.
2247** A hot journal is one that needs to be played back.
2248**
2249** If the current size of the database file is 0 but a journal file
2250** exists, that is probably an old journal left over from a prior
2251** database with the same name. Just delete the journal.
2252*/
2253static int hasHotJournal(Pager *pPager){
2254 if( !pPager->useJournal ) return 0;
2255 if( !sqlite3OsFileExists(pPager->zJournal) ) return 0;
2256 if( sqlite3OsCheckReservedLock(&pPager->fd) ) return 0;
2257 if( sqlite3pager_pagecount(pPager)==0 ){
2258 sqlite3OsDelete(pPager->zJournal);
2259 return 0;
2260 }else{
2261 return 1;
2262 }
2263}
2264
2265/*
drhd9b02572001-04-15 00:37:09 +00002266** Acquire a page.
2267**
drh58a11682001-11-10 13:51:08 +00002268** A read lock on the disk file is obtained when the first page is acquired.
drh5e00f6c2001-09-13 13:46:56 +00002269** This read lock is dropped when the last page is released.
drhd9b02572001-04-15 00:37:09 +00002270**
drh306dc212001-05-21 13:45:10 +00002271** A _get works for any page number greater than 0. If the database
2272** file is smaller than the requested page, then no actual disk
2273** read occurs and the memory image of the page is initialized to
2274** all zeros. The extra data appended to a page is always initialized
2275** to zeros the first time a page is loaded into memory.
2276**
drhd9b02572001-04-15 00:37:09 +00002277** The acquisition might fail for several reasons. In all cases,
2278** an appropriate error code is returned and *ppPage is set to NULL.
drh7e3b0a02001-04-28 16:52:40 +00002279**
drh3aac2dd2004-04-26 14:10:20 +00002280** See also sqlite3pager_lookup(). Both this routine and _lookup() attempt
drh7e3b0a02001-04-28 16:52:40 +00002281** to find a page in the in-memory cache first. If the page is not already
drh5e00f6c2001-09-13 13:46:56 +00002282** in memory, this routine goes to disk to read it in whereas _lookup()
drh7e3b0a02001-04-28 16:52:40 +00002283** just returns 0. This routine acquires a read-lock the first time it
2284** has to go to disk, and could also playback an old journal if necessary.
2285** Since _lookup() never goes to disk, it never has to deal with locks
2286** or journal files.
drhed7c8552001-04-11 14:29:21 +00002287*/
drh3aac2dd2004-04-26 14:10:20 +00002288int sqlite3pager_get(Pager *pPager, Pgno pgno, void **ppPage){
drhed7c8552001-04-11 14:29:21 +00002289 PgHdr *pPg;
drh165ffe92005-03-15 17:09:30 +00002290 int rc;
drhed7c8552001-04-11 14:29:21 +00002291
danielk197726836652005-01-17 01:33:13 +00002292 /* The maximum page number is 2^31. Return SQLITE_CORRUPT if a page
2293 ** number greater than this, or zero, is requested.
2294 */
2295 if( pgno>PAGER_MAX_PGNO || pgno==0 ){
2296 return SQLITE_CORRUPT;
2297 }
2298
drhd9b02572001-04-15 00:37:09 +00002299 /* Make sure we have not hit any critical errors.
2300 */
drh836faa42003-01-11 13:30:57 +00002301 assert( pPager!=0 );
drh2e6d11b2003-04-25 15:37:57 +00002302 *ppPage = 0;
drhd9b02572001-04-15 00:37:09 +00002303 if( pPager->errMask & ~(PAGER_ERR_FULL) ){
2304 return pager_errcode(pPager);
2305 }
2306
danielk197713adf8a2004-06-03 16:08:41 +00002307 /* If this is the first page accessed, then get a SHARED lock
drhed7c8552001-04-11 14:29:21 +00002308 ** on the database file.
2309 */
drhb7f91642004-10-31 02:22:47 +00002310 if( pPager->nRef==0 && !MEMDB ){
drh7bec5052005-02-06 02:45:41 +00002311 if( !pPager->noReadlock ){
2312 rc = pager_wait_on_lock(pPager, SHARED_LOCK);
2313 if( rc!=SQLITE_OK ){
2314 return rc;
2315 }
drhed7c8552001-04-11 14:29:21 +00002316 }
2317
danielk197713adf8a2004-06-03 16:08:41 +00002318 /* If a journal file exists, and there is no RESERVED lock on the
2319 ** database file, then it either needs to be played back or deleted.
drhed7c8552001-04-11 14:29:21 +00002320 */
drh165ffe92005-03-15 17:09:30 +00002321 if( hasHotJournal(pPager) ){
drhe2227f02003-06-14 11:42:57 +00002322 int rc;
drhed7c8552001-04-11 14:29:21 +00002323
danielk197790ba3bd2004-06-25 08:32:25 +00002324 /* Get an EXCLUSIVE lock on the database file. At this point it is
2325 ** important that a RESERVED lock is not obtained on the way to the
2326 ** EXCLUSIVE lock. If it were, another process might open the
2327 ** database file, detect the RESERVED lock, and conclude that the
2328 ** database is safe to read while this process is still rolling it
2329 ** back.
2330 **
2331 ** Because the intermediate RESERVED lock is not requested, the
2332 ** second process will get to this point in the code and fail to
2333 ** obtain it's own EXCLUSIVE lock on the database file.
2334 */
danielk197713adf8a2004-06-03 16:08:41 +00002335 rc = sqlite3OsLock(&pPager->fd, EXCLUSIVE_LOCK);
drha7fcb052001-12-14 15:09:55 +00002336 if( rc!=SQLITE_OK ){
drha6abd042004-06-09 17:37:22 +00002337 sqlite3OsUnlock(&pPager->fd, NO_LOCK);
2338 pPager->state = PAGER_UNLOCK;
drh8766c342002-11-09 00:33:15 +00002339 return rc;
drha7fcb052001-12-14 15:09:55 +00002340 }
drha6abd042004-06-09 17:37:22 +00002341 pPager->state = PAGER_EXCLUSIVE;
drha7fcb052001-12-14 15:09:55 +00002342
drhe2227f02003-06-14 11:42:57 +00002343 /* Open the journal for reading only. Return SQLITE_BUSY if
2344 ** we are unable to open the journal file.
drhf57b3392001-10-08 13:22:32 +00002345 **
drhe2227f02003-06-14 11:42:57 +00002346 ** The journal file does not need to be locked itself. The
2347 ** journal file is never open unless the main database file holds
2348 ** a write lock, so there is never any chance of two or more
2349 ** processes opening the journal at the same time.
drhed7c8552001-04-11 14:29:21 +00002350 */
danielk19774adee202004-05-08 08:23:19 +00002351 rc = sqlite3OsOpenReadOnly(pPager->zJournal, &pPager->jfd);
drha7fcb052001-12-14 15:09:55 +00002352 if( rc!=SQLITE_OK ){
drha6abd042004-06-09 17:37:22 +00002353 sqlite3OsUnlock(&pPager->fd, NO_LOCK);
2354 pPager->state = PAGER_UNLOCK;
drhed7c8552001-04-11 14:29:21 +00002355 return SQLITE_BUSY;
2356 }
drha7fcb052001-12-14 15:09:55 +00002357 pPager->journalOpen = 1;
drhdb48ee02003-01-16 13:42:43 +00002358 pPager->journalStarted = 0;
danielk197776572402004-06-25 02:38:54 +00002359 pPager->journalOff = 0;
2360 pPager->setMaster = 0;
2361 pPager->journalHdr = 0;
drhed7c8552001-04-11 14:29:21 +00002362
2363 /* Playback and delete the journal. Drop the database write
2364 ** lock and reacquire the read lock.
2365 */
danielk197776572402004-06-25 02:38:54 +00002366 rc = pager_playback(pPager);
drhd9b02572001-04-15 00:37:09 +00002367 if( rc!=SQLITE_OK ){
2368 return rc;
2369 }
drhed7c8552001-04-11 14:29:21 +00002370 }
2371 pPg = 0;
2372 }else{
2373 /* Search for page in cache */
drhd9b02572001-04-15 00:37:09 +00002374 pPg = pager_lookup(pPager, pgno);
drhb7f91642004-10-31 02:22:47 +00002375 if( MEMDB && pPager->state==PAGER_UNLOCK ){
drha6abd042004-06-09 17:37:22 +00002376 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00002377 }
drhed7c8552001-04-11 14:29:21 +00002378 }
2379 if( pPg==0 ){
drhd9b02572001-04-15 00:37:09 +00002380 /* The requested page is not in the page cache. */
drhed7c8552001-04-11 14:29:21 +00002381 int h;
drhfcd35c72005-05-21 02:48:08 +00002382 TEST_INCR(pPager->nMiss);
drhb7f91642004-10-31 02:22:47 +00002383 if( pPager->nPage<pPager->mxPage || pPager->pFirst==0 || MEMDB ){
drhed7c8552001-04-11 14:29:21 +00002384 /* Create a new page */
drh1c7880e2005-05-20 20:01:55 +00002385 pPg = sqliteMallocRaw( sizeof(*pPg) + pPager->pageSize
drhac69b052004-05-12 13:30:07 +00002386 + sizeof(u32) + pPager->nExtra
drhb7f91642004-10-31 02:22:47 +00002387 + MEMDB*sizeof(PgHistory) );
drhd9b02572001-04-15 00:37:09 +00002388 if( pPg==0 ){
drhd9b02572001-04-15 00:37:09 +00002389 pPager->errMask |= PAGER_ERR_MEM;
2390 return SQLITE_NOMEM;
2391 }
drh8c1238a2003-01-02 14:43:55 +00002392 memset(pPg, 0, sizeof(*pPg));
drhb7f91642004-10-31 02:22:47 +00002393 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00002394 memset(PGHDR_TO_HIST(pPg, pPager), 0, sizeof(PgHistory));
2395 }
drhed7c8552001-04-11 14:29:21 +00002396 pPg->pPager = pPager;
drhd9b02572001-04-15 00:37:09 +00002397 pPg->pNextAll = pPager->pAll;
drhd79caeb2001-04-15 02:27:24 +00002398 pPager->pAll = pPg;
drhd9b02572001-04-15 00:37:09 +00002399 pPager->nPage++;
danielk1977e94ddc92005-03-21 03:53:38 +00002400 if( pPager->nPage>pPager->nMaxPage ){
2401 assert( pPager->nMaxPage==(pPager->nPage-1) );
2402 pPager->nMaxPage++;
2403 }
drhed7c8552001-04-11 14:29:21 +00002404 }else{
drhdb48ee02003-01-16 13:42:43 +00002405 /* Find a page to recycle. Try to locate a page that does not
2406 ** require us to do an fsync() on the journal.
2407 */
drh341eae82003-01-21 02:39:36 +00002408 pPg = pPager->pFirstSynced;
drhb19a2bc2001-09-16 00:13:26 +00002409
drhdb48ee02003-01-16 13:42:43 +00002410 /* If we could not find a page that does not require an fsync()
2411 ** on the journal file then fsync the journal file. This is a
2412 ** very slow operation, so we work hard to avoid it. But sometimes
2413 ** it can't be helped.
drhb19a2bc2001-09-16 00:13:26 +00002414 */
drh603240c2002-03-05 01:11:12 +00002415 if( pPg==0 ){
danielk197776572402004-06-25 02:38:54 +00002416 int rc = syncJournal(pPager);
drh50e5dad2001-09-15 00:57:28 +00002417 if( rc!=0 ){
drh3aac2dd2004-04-26 14:10:20 +00002418 sqlite3pager_rollback(pPager);
drh50e5dad2001-09-15 00:57:28 +00002419 return SQLITE_IOERR;
2420 }
danielk197776572402004-06-25 02:38:54 +00002421 if( pPager->fullSync ){
2422 /* If in full-sync mode, write a new journal header into the
2423 ** journal file. This is done to avoid ever modifying a journal
2424 ** header that is involved in the rollback of pages that have
2425 ** already been written to the database (in case the header is
2426 ** trashed when the nRec field is updated).
2427 */
2428 pPager->nRec = 0;
danielk1977f187bd92004-06-25 06:23:22 +00002429 assert( pPager->journalOff > 0 );
danielk197776572402004-06-25 02:38:54 +00002430 rc = writeJournalHdr(pPager);
2431 if( rc!=0 ){
2432 sqlite3pager_rollback(pPager);
2433 return SQLITE_IOERR;
2434 }
2435 }
drh50e5dad2001-09-15 00:57:28 +00002436 pPg = pPager->pFirst;
2437 }
drhd9b02572001-04-15 00:37:09 +00002438 assert( pPg->nRef==0 );
drhdb48ee02003-01-16 13:42:43 +00002439
2440 /* Write the page to the database file if it is dirty.
2441 */
2442 if( pPg->dirty ){
2443 assert( pPg->needSync==0 );
drh2554f8b2003-01-22 01:26:44 +00002444 pPg->pDirty = 0;
2445 rc = pager_write_pagelist( pPg );
drhdb48ee02003-01-16 13:42:43 +00002446 if( rc!=SQLITE_OK ){
drh3aac2dd2004-04-26 14:10:20 +00002447 sqlite3pager_rollback(pPager);
drhdb48ee02003-01-16 13:42:43 +00002448 return SQLITE_IOERR;
2449 }
drhdb48ee02003-01-16 13:42:43 +00002450 }
drh50e5dad2001-09-15 00:57:28 +00002451 assert( pPg->dirty==0 );
drhd9b02572001-04-15 00:37:09 +00002452
drhdb48ee02003-01-16 13:42:43 +00002453 /* If the page we are recycling is marked as alwaysRollback, then
drh193a6b42002-07-07 16:52:46 +00002454 ** set the global alwaysRollback flag, thus disabling the
2455 ** sqlite_dont_rollback() optimization for the rest of this transaction.
2456 ** It is necessary to do this because the page marked alwaysRollback
2457 ** might be reloaded at a later time but at that point we won't remember
2458 ** that is was marked alwaysRollback. This means that all pages must
2459 ** be marked as alwaysRollback from here on out.
2460 */
2461 if( pPg->alwaysRollback ){
2462 pPager->alwaysRollback = 1;
2463 }
2464
drhd9b02572001-04-15 00:37:09 +00002465 /* Unlink the old page from the free list and the hash table
2466 */
drhac69b052004-05-12 13:30:07 +00002467 unlinkPage(pPg);
drhfcd35c72005-05-21 02:48:08 +00002468 TEST_INCR(pPager->nOvfl);
drhed7c8552001-04-11 14:29:21 +00002469 }
2470 pPg->pgno = pgno;
drh1ab43002002-01-14 09:28:19 +00002471 if( pPager->aInJournal && (int)pgno<=pPager->origDbSize ){
danielk19774adee202004-05-08 08:23:19 +00002472 sqlite3CheckMemory(pPager->aInJournal, pgno/8);
drhdb48ee02003-01-16 13:42:43 +00002473 assert( pPager->journalOpen );
drh6019e162001-07-02 17:51:45 +00002474 pPg->inJournal = (pPager->aInJournal[pgno/8] & (1<<(pgno&7)))!=0;
drhdb48ee02003-01-16 13:42:43 +00002475 pPg->needSync = 0;
drh6019e162001-07-02 17:51:45 +00002476 }else{
2477 pPg->inJournal = 0;
drhdb48ee02003-01-16 13:42:43 +00002478 pPg->needSync = 0;
drh6019e162001-07-02 17:51:45 +00002479 }
drhac69b052004-05-12 13:30:07 +00002480 if( pPager->aInStmt && (int)pgno<=pPager->stmtSize
2481 && (pPager->aInStmt[pgno/8] & (1<<(pgno&7)))!=0 ){
drh3aac2dd2004-04-26 14:10:20 +00002482 page_add_to_stmt_list(pPg);
drhfa86c412002-02-02 15:01:15 +00002483 }else{
drh3aac2dd2004-04-26 14:10:20 +00002484 page_remove_from_stmt_list(pPg);
drhfa86c412002-02-02 15:01:15 +00002485 }
drhed7c8552001-04-11 14:29:21 +00002486 pPg->dirty = 0;
2487 pPg->nRef = 1;
drhdd793422001-06-28 01:54:48 +00002488 REFINFO(pPg);
drhd9b02572001-04-15 00:37:09 +00002489 pPager->nRef++;
2490 h = pager_hash(pgno);
drhed7c8552001-04-11 14:29:21 +00002491 pPg->pNextHash = pPager->aHash[h];
2492 pPager->aHash[h] = pPg;
2493 if( pPg->pNextHash ){
2494 assert( pPg->pNextHash->pPrevHash==0 );
2495 pPg->pNextHash->pPrevHash = pPg;
2496 }
drh2e6d11b2003-04-25 15:37:57 +00002497 if( pPager->nExtra>0 ){
drh90f5ecb2004-07-22 01:19:35 +00002498 memset(PGHDR_TO_EXTRA(pPg, pPager), 0, pPager->nExtra);
drh2e6d11b2003-04-25 15:37:57 +00002499 }
drh2e6d11b2003-04-25 15:37:57 +00002500 if( pPager->errMask!=0 ){
drh3aac2dd2004-04-26 14:10:20 +00002501 sqlite3pager_unref(PGHDR_TO_DATA(pPg));
drh2e6d11b2003-04-25 15:37:57 +00002502 rc = pager_errcode(pPager);
2503 return rc;
2504 }
drh165ffe92005-03-15 17:09:30 +00002505 if( sqlite3pager_pagecount(pPager)<(int)pgno ){
drh90f5ecb2004-07-22 01:19:35 +00002506 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
drh306dc212001-05-21 13:45:10 +00002507 }else{
drh81a20f22001-10-12 17:30:04 +00002508 int rc;
drhb7f91642004-10-31 02:22:47 +00002509 assert( MEMDB==0 );
drheb206252004-10-01 02:00:31 +00002510 sqlite3OsSeek(&pPager->fd, (pgno-1)*(i64)pPager->pageSize);
drh90f5ecb2004-07-22 01:19:35 +00002511 rc = sqlite3OsRead(&pPager->fd, PGHDR_TO_DATA(pPg), pPager->pageSize);
danielk1977ef73ee92004-11-06 12:26:07 +00002512 TRACE3("FETCH %d page %d\n", PAGERID(pPager), pPg->pgno);
drh9eb9e262004-02-11 02:18:05 +00002513 CODEC(pPager, PGHDR_TO_DATA(pPg), pPg->pgno, 3);
drh81a20f22001-10-12 17:30:04 +00002514 if( rc!=SQLITE_OK ){
drheb206252004-10-01 02:00:31 +00002515 i64 fileSize;
danielk19774adee202004-05-08 08:23:19 +00002516 if( sqlite3OsFileSize(&pPager->fd,&fileSize)!=SQLITE_OK
drh90f5ecb2004-07-22 01:19:35 +00002517 || fileSize>=pgno*pPager->pageSize ){
drh3aac2dd2004-04-26 14:10:20 +00002518 sqlite3pager_unref(PGHDR_TO_DATA(pPg));
drh4e371ee2002-09-05 16:08:27 +00002519 return rc;
2520 }else{
drh90f5ecb2004-07-22 01:19:35 +00002521 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
drh4e371ee2002-09-05 16:08:27 +00002522 }
danielk197742741be2005-01-08 12:42:39 +00002523 }else{
drhfcd35c72005-05-21 02:48:08 +00002524 TEST_INCR(pPager->nRead);
drh81a20f22001-10-12 17:30:04 +00002525 }
drh306dc212001-05-21 13:45:10 +00002526 }
danielk19773c407372005-02-15 02:54:14 +00002527#ifdef SQLITE_CHECK_PAGES
2528 pPg->pageHash = pager_pagehash(pPg);
2529#endif
drhed7c8552001-04-11 14:29:21 +00002530 }else{
drhd9b02572001-04-15 00:37:09 +00002531 /* The requested page is in the page cache. */
drhfcd35c72005-05-21 02:48:08 +00002532 TEST_INCR(pPager->nHit);
drhdf0b3b02001-06-23 11:36:20 +00002533 page_ref(pPg);
drhed7c8552001-04-11 14:29:21 +00002534 }
2535 *ppPage = PGHDR_TO_DATA(pPg);
2536 return SQLITE_OK;
2537}
2538
2539/*
drh7e3b0a02001-04-28 16:52:40 +00002540** Acquire a page if it is already in the in-memory cache. Do
2541** not read the page from disk. Return a pointer to the page,
2542** or 0 if the page is not in cache.
2543**
drh3aac2dd2004-04-26 14:10:20 +00002544** See also sqlite3pager_get(). The difference between this routine
2545** and sqlite3pager_get() is that _get() will go to the disk and read
drh7e3b0a02001-04-28 16:52:40 +00002546** in the page if the page is not already in cache. This routine
drh5e00f6c2001-09-13 13:46:56 +00002547** returns NULL if the page is not in cache or if a disk I/O error
2548** has ever happened.
drh7e3b0a02001-04-28 16:52:40 +00002549*/
drh3aac2dd2004-04-26 14:10:20 +00002550void *sqlite3pager_lookup(Pager *pPager, Pgno pgno){
drh7e3b0a02001-04-28 16:52:40 +00002551 PgHdr *pPg;
2552
drh836faa42003-01-11 13:30:57 +00002553 assert( pPager!=0 );
2554 assert( pgno!=0 );
drh7e3b0a02001-04-28 16:52:40 +00002555 if( pPager->errMask & ~(PAGER_ERR_FULL) ){
2556 return 0;
2557 }
drh7e3b0a02001-04-28 16:52:40 +00002558 pPg = pager_lookup(pPager, pgno);
2559 if( pPg==0 ) return 0;
drhdf0b3b02001-06-23 11:36:20 +00002560 page_ref(pPg);
drh7e3b0a02001-04-28 16:52:40 +00002561 return PGHDR_TO_DATA(pPg);
2562}
2563
2564/*
drhed7c8552001-04-11 14:29:21 +00002565** Release a page.
2566**
2567** If the number of references to the page drop to zero, then the
2568** page is added to the LRU list. When all references to all pages
drhd9b02572001-04-15 00:37:09 +00002569** are released, a rollback occurs and the lock on the database is
drhed7c8552001-04-11 14:29:21 +00002570** removed.
2571*/
drh3aac2dd2004-04-26 14:10:20 +00002572int sqlite3pager_unref(void *pData){
drhed7c8552001-04-11 14:29:21 +00002573 PgHdr *pPg;
drhd9b02572001-04-15 00:37:09 +00002574
2575 /* Decrement the reference count for this page
2576 */
drhed7c8552001-04-11 14:29:21 +00002577 pPg = DATA_TO_PGHDR(pData);
2578 assert( pPg->nRef>0 );
drhed7c8552001-04-11 14:29:21 +00002579 pPg->nRef--;
drhdd793422001-06-28 01:54:48 +00002580 REFINFO(pPg);
drhd9b02572001-04-15 00:37:09 +00002581
danielk19773c407372005-02-15 02:54:14 +00002582 CHECK_PAGE(pPg);
2583
drh72f82862001-05-24 21:06:34 +00002584 /* When the number of references to a page reach 0, call the
2585 ** destructor and add the page to the freelist.
drhd9b02572001-04-15 00:37:09 +00002586 */
drhed7c8552001-04-11 14:29:21 +00002587 if( pPg->nRef==0 ){
drh1eaa2692001-09-18 02:02:23 +00002588 Pager *pPager;
2589 pPager = pPg->pPager;
drhd9b02572001-04-15 00:37:09 +00002590 pPg->pNextFree = 0;
2591 pPg->pPrevFree = pPager->pLast;
drhed7c8552001-04-11 14:29:21 +00002592 pPager->pLast = pPg;
drhd9b02572001-04-15 00:37:09 +00002593 if( pPg->pPrevFree ){
2594 pPg->pPrevFree->pNextFree = pPg;
drhed7c8552001-04-11 14:29:21 +00002595 }else{
2596 pPager->pFirst = pPg;
2597 }
drh341eae82003-01-21 02:39:36 +00002598 if( pPg->needSync==0 && pPager->pFirstSynced==0 ){
2599 pPager->pFirstSynced = pPg;
2600 }
drh72f82862001-05-24 21:06:34 +00002601 if( pPager->xDestructor ){
drhb6f41482004-05-14 01:58:11 +00002602 pPager->xDestructor(pData, pPager->pageSize);
drh72f82862001-05-24 21:06:34 +00002603 }
drhd9b02572001-04-15 00:37:09 +00002604
2605 /* When all pages reach the freelist, drop the read lock from
2606 ** the database file.
2607 */
2608 pPager->nRef--;
2609 assert( pPager->nRef>=0 );
drhb7f91642004-10-31 02:22:47 +00002610 if( pPager->nRef==0 && !MEMDB ){
drhd9b02572001-04-15 00:37:09 +00002611 pager_reset(pPager);
2612 }
drhed7c8552001-04-11 14:29:21 +00002613 }
drhd9b02572001-04-15 00:37:09 +00002614 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +00002615}
2616
2617/*
drha6abd042004-06-09 17:37:22 +00002618** Create a journal file for pPager. There should already be a RESERVED
2619** or EXCLUSIVE lock on the database file when this routine is called.
drhda47d772002-12-02 04:25:19 +00002620**
2621** Return SQLITE_OK if everything. Return an error code and release the
2622** write lock if anything goes wrong.
2623*/
2624static int pager_open_journal(Pager *pPager){
2625 int rc;
drhb7f91642004-10-31 02:22:47 +00002626 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +00002627 assert( pPager->state>=PAGER_RESERVED );
drhda47d772002-12-02 04:25:19 +00002628 assert( pPager->journalOpen==0 );
2629 assert( pPager->useJournal );
drh88b01a12005-03-28 18:04:27 +00002630 assert( pPager->aInJournal==0 );
drh3aac2dd2004-04-26 14:10:20 +00002631 sqlite3pager_pagecount(pPager);
drhda47d772002-12-02 04:25:19 +00002632 pPager->aInJournal = sqliteMalloc( pPager->dbSize/8 + 1 );
2633 if( pPager->aInJournal==0 ){
drh9c105bb2004-10-02 20:38:28 +00002634 rc = SQLITE_NOMEM;
2635 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00002636 }
danielk19774adee202004-05-08 08:23:19 +00002637 rc = sqlite3OsOpenExclusive(pPager->zJournal, &pPager->jfd,pPager->tempFile);
danielk197776572402004-06-25 02:38:54 +00002638 pPager->journalOff = 0;
2639 pPager->setMaster = 0;
2640 pPager->journalHdr = 0;
drhda47d772002-12-02 04:25:19 +00002641 if( rc!=SQLITE_OK ){
drh9c105bb2004-10-02 20:38:28 +00002642 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00002643 }
drhb851b2c2005-03-10 14:11:12 +00002644 SET_FULLSYNC(pPager->jfd, pPager->fullSync);
2645 SET_FULLSYNC(pPager->fd, pPager->fullSync);
danielk19774adee202004-05-08 08:23:19 +00002646 sqlite3OsOpenDirectory(pPager->zDirectory, &pPager->jfd);
drhda47d772002-12-02 04:25:19 +00002647 pPager->journalOpen = 1;
drhdb48ee02003-01-16 13:42:43 +00002648 pPager->journalStarted = 0;
drhda47d772002-12-02 04:25:19 +00002649 pPager->needSync = 0;
2650 pPager->alwaysRollback = 0;
drh968af522003-02-11 14:55:40 +00002651 pPager->nRec = 0;
drh2e6d11b2003-04-25 15:37:57 +00002652 if( pPager->errMask!=0 ){
2653 rc = pager_errcode(pPager);
drhdd5b2fa2005-03-28 03:39:55 +00002654 goto failed_to_open_journal;
drh2e6d11b2003-04-25 15:37:57 +00002655 }
drhda47d772002-12-02 04:25:19 +00002656 pPager->origDbSize = pPager->dbSize;
drhae2b40c2004-06-09 19:03:54 +00002657
danielk197776572402004-06-25 02:38:54 +00002658 rc = writeJournalHdr(pPager);
2659
drhac69b052004-05-12 13:30:07 +00002660 if( pPager->stmtAutoopen && rc==SQLITE_OK ){
drh3aac2dd2004-04-26 14:10:20 +00002661 rc = sqlite3pager_stmt_begin(pPager);
drhda47d772002-12-02 04:25:19 +00002662 }
2663 if( rc!=SQLITE_OK ){
2664 rc = pager_unwritelock(pPager);
2665 if( rc==SQLITE_OK ){
2666 rc = SQLITE_FULL;
2667 }
2668 }
drh9c105bb2004-10-02 20:38:28 +00002669 return rc;
2670
2671failed_to_open_journal:
2672 sqliteFree(pPager->aInJournal);
2673 pPager->aInJournal = 0;
2674 sqlite3OsUnlock(&pPager->fd, NO_LOCK);
2675 pPager->state = PAGER_UNLOCK;
2676 return rc;
drhda47d772002-12-02 04:25:19 +00002677}
2678
2679/*
drh4b845d72002-03-05 12:41:19 +00002680** Acquire a write-lock on the database. The lock is removed when
2681** the any of the following happen:
2682**
drh3aac2dd2004-04-26 14:10:20 +00002683** * sqlite3pager_commit() is called.
2684** * sqlite3pager_rollback() is called.
2685** * sqlite3pager_close() is called.
2686** * sqlite3pager_unref() is called to on every outstanding page.
drh4b845d72002-03-05 12:41:19 +00002687**
danielk197713adf8a2004-06-03 16:08:41 +00002688** The first parameter to this routine is a pointer to any open page of the
2689** database file. Nothing changes about the page - it is used merely to
2690** acquire a pointer to the Pager structure and as proof that there is
2691** already a read-lock on the database.
drh4b845d72002-03-05 12:41:19 +00002692**
danielk197713adf8a2004-06-03 16:08:41 +00002693** The second parameter indicates how much space in bytes to reserve for a
2694** master journal file-name at the start of the journal when it is created.
2695**
2696** A journal file is opened if this is not a temporary file. For temporary
2697** files, the opening of the journal file is deferred until there is an
2698** actual need to write to the journal.
drhda47d772002-12-02 04:25:19 +00002699**
drha6abd042004-06-09 17:37:22 +00002700** If the database is already reserved for writing, this routine is a no-op.
drh684917c2004-10-05 02:41:42 +00002701**
2702** If exFlag is true, go ahead and get an EXCLUSIVE lock on the file
2703** immediately instead of waiting until we try to flush the cache. The
2704** exFlag is ignored if a transaction is already active.
drh4b845d72002-03-05 12:41:19 +00002705*/
drh684917c2004-10-05 02:41:42 +00002706int sqlite3pager_begin(void *pData, int exFlag){
drh4b845d72002-03-05 12:41:19 +00002707 PgHdr *pPg = DATA_TO_PGHDR(pData);
2708 Pager *pPager = pPg->pPager;
2709 int rc = SQLITE_OK;
2710 assert( pPg->nRef>0 );
drha6abd042004-06-09 17:37:22 +00002711 assert( pPager->state!=PAGER_UNLOCK );
2712 if( pPager->state==PAGER_SHARED ){
drh4b845d72002-03-05 12:41:19 +00002713 assert( pPager->aInJournal==0 );
drhb7f91642004-10-31 02:22:47 +00002714 if( MEMDB ){
drha6abd042004-06-09 17:37:22 +00002715 pPager->state = PAGER_EXCLUSIVE;
drhac69b052004-05-12 13:30:07 +00002716 pPager->origDbSize = pPager->dbSize;
2717 }else{
drhb8ef32c2005-03-14 02:01:49 +00002718 rc = sqlite3OsLock(&pPager->fd, RESERVED_LOCK);
drh684917c2004-10-05 02:41:42 +00002719 if( rc==SQLITE_OK ){
2720 pPager->state = PAGER_RESERVED;
2721 if( exFlag ){
2722 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
2723 }
2724 }
danielk19779eed5052004-06-04 10:38:30 +00002725 if( rc!=SQLITE_OK ){
2726 return rc;
drhac69b052004-05-12 13:30:07 +00002727 }
drha6abd042004-06-09 17:37:22 +00002728 pPager->dirtyCache = 0;
danielk1977ef73ee92004-11-06 12:26:07 +00002729 TRACE2("TRANSACTION %d\n", PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00002730 if( pPager->useJournal && !pPager->tempFile ){
2731 rc = pager_open_journal(pPager);
2732 }
drh4b845d72002-03-05 12:41:19 +00002733 }
2734 }
2735 return rc;
2736}
2737
2738/*
drhed7c8552001-04-11 14:29:21 +00002739** Mark a data page as writeable. The page is written into the journal
2740** if it is not there already. This routine must be called before making
2741** changes to a page.
2742**
2743** The first time this routine is called, the pager creates a new
drha6abd042004-06-09 17:37:22 +00002744** journal and acquires a RESERVED lock on the database. If the RESERVED
drhed7c8552001-04-11 14:29:21 +00002745** lock could not be acquired, this routine returns SQLITE_BUSY. The
drh306dc212001-05-21 13:45:10 +00002746** calling routine must check for that return value and be careful not to
drhed7c8552001-04-11 14:29:21 +00002747** change any page data until this routine returns SQLITE_OK.
drhd9b02572001-04-15 00:37:09 +00002748**
2749** If the journal file could not be written because the disk is full,
2750** then this routine returns SQLITE_FULL and does an immediate rollback.
2751** All subsequent write attempts also return SQLITE_FULL until there
drh3aac2dd2004-04-26 14:10:20 +00002752** is a call to sqlite3pager_commit() or sqlite3pager_rollback() to
drhd9b02572001-04-15 00:37:09 +00002753** reset.
drhed7c8552001-04-11 14:29:21 +00002754*/
drh3aac2dd2004-04-26 14:10:20 +00002755int sqlite3pager_write(void *pData){
drh69688d52001-04-14 16:38:23 +00002756 PgHdr *pPg = DATA_TO_PGHDR(pData);
2757 Pager *pPager = pPg->pPager;
drhd79caeb2001-04-15 02:27:24 +00002758 int rc = SQLITE_OK;
drh69688d52001-04-14 16:38:23 +00002759
drh6446c4d2001-12-15 14:22:18 +00002760 /* Check for errors
2761 */
drhd9b02572001-04-15 00:37:09 +00002762 if( pPager->errMask ){
2763 return pager_errcode(pPager);
2764 }
drh5e00f6c2001-09-13 13:46:56 +00002765 if( pPager->readOnly ){
2766 return SQLITE_PERM;
2767 }
drh6446c4d2001-12-15 14:22:18 +00002768
danielk197776572402004-06-25 02:38:54 +00002769 assert( !pPager->setMaster );
2770
danielk19773c407372005-02-15 02:54:14 +00002771 CHECK_PAGE(pPg);
2772
drh6446c4d2001-12-15 14:22:18 +00002773 /* Mark the page as dirty. If the page has already been written
2774 ** to the journal then we can return right away.
2775 */
drhd9b02572001-04-15 00:37:09 +00002776 pPg->dirty = 1;
drhac69b052004-05-12 13:30:07 +00002777 if( pPg->inJournal && (pPg->inStmt || pPager->stmtInUse==0) ){
drha6abd042004-06-09 17:37:22 +00002778 pPager->dirtyCache = 1;
danielk1977a0bf2652004-11-04 14:30:04 +00002779 }else{
drh6446c4d2001-12-15 14:22:18 +00002780
danielk1977a0bf2652004-11-04 14:30:04 +00002781 /* If we get this far, it means that the page needs to be
2782 ** written to the transaction journal or the ckeckpoint journal
2783 ** or both.
2784 **
2785 ** First check to see that the transaction journal exists and
2786 ** create it if it does not.
2787 */
2788 assert( pPager->state!=PAGER_UNLOCK );
2789 rc = sqlite3pager_begin(pData, 0);
2790 if( rc!=SQLITE_OK ){
2791 return rc;
2792 }
2793 assert( pPager->state>=PAGER_RESERVED );
2794 if( !pPager->journalOpen && pPager->useJournal ){
2795 rc = pager_open_journal(pPager);
2796 if( rc!=SQLITE_OK ) return rc;
2797 }
2798 assert( pPager->journalOpen || !pPager->useJournal );
2799 pPager->dirtyCache = 1;
2800
2801 /* The transaction journal now exists and we have a RESERVED or an
2802 ** EXCLUSIVE lock on the main database file. Write the current page to
2803 ** the transaction journal if it is not there already.
2804 */
2805 if( !pPg->inJournal && (pPager->useJournal || MEMDB) ){
2806 if( (int)pPg->pgno <= pPager->origDbSize ){
2807 int szPg;
2808 u32 saved;
2809 if( MEMDB ){
2810 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
danielk1977ef73ee92004-11-06 12:26:07 +00002811 TRACE3("JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00002812 assert( pHist->pOrig==0 );
2813 pHist->pOrig = sqliteMallocRaw( pPager->pageSize );
2814 if( pHist->pOrig ){
2815 memcpy(pHist->pOrig, PGHDR_TO_DATA(pPg), pPager->pageSize);
2816 }
2817 }else{
2818 u32 cksum;
2819 CODEC(pPager, pData, pPg->pgno, 7);
2820 cksum = pager_cksum(pPager, pPg->pgno, pData);
2821 saved = *(u32*)PGHDR_TO_EXTRA(pPg, pPager);
2822 store32bits(cksum, pPg, pPager->pageSize);
2823 szPg = pPager->pageSize+8;
2824 store32bits(pPg->pgno, pPg, -4);
2825 rc = sqlite3OsWrite(&pPager->jfd, &((char*)pData)[-4], szPg);
2826 pPager->journalOff += szPg;
2827 TRACE4("JOURNAL %d page %d needSync=%d\n",
danielk1977ef73ee92004-11-06 12:26:07 +00002828 PAGERID(pPager), pPg->pgno, pPg->needSync);
danielk1977a0bf2652004-11-04 14:30:04 +00002829 CODEC(pPager, pData, pPg->pgno, 0);
2830 *(u32*)PGHDR_TO_EXTRA(pPg, pPager) = saved;
2831 if( rc!=SQLITE_OK ){
2832 sqlite3pager_rollback(pPager);
2833 pPager->errMask |= PAGER_ERR_FULL;
2834 return rc;
2835 }
2836 pPager->nRec++;
2837 assert( pPager->aInJournal!=0 );
2838 pPager->aInJournal[pPg->pgno/8] |= 1<<(pPg->pgno&7);
2839 pPg->needSync = !pPager->noSync;
2840 if( pPager->stmtInUse ){
2841 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
2842 page_add_to_stmt_list(pPg);
2843 }
drhac69b052004-05-12 13:30:07 +00002844 }
danielk197713adf8a2004-06-03 16:08:41 +00002845 }else{
danielk1977a0bf2652004-11-04 14:30:04 +00002846 pPg->needSync = !pPager->journalStarted && !pPager->noSync;
2847 TRACE4("APPEND %d page %d needSync=%d\n",
danielk1977ef73ee92004-11-06 12:26:07 +00002848 PAGERID(pPager), pPg->pgno, pPg->needSync);
danielk1977a0bf2652004-11-04 14:30:04 +00002849 }
2850 if( pPg->needSync ){
2851 pPager->needSync = 1;
2852 }
2853 pPg->inJournal = 1;
2854 }
2855
2856 /* If the statement journal is open and the page is not in it,
2857 ** then write the current page to the statement journal. Note that
2858 ** the statement journal format differs from the standard journal format
2859 ** in that it omits the checksums and the header.
2860 */
2861 if( pPager->stmtInUse && !pPg->inStmt && (int)pPg->pgno<=pPager->stmtSize ){
2862 assert( pPg->inJournal || (int)pPg->pgno>pPager->origDbSize );
2863 if( MEMDB ){
2864 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
2865 assert( pHist->pStmt==0 );
2866 pHist->pStmt = sqliteMallocRaw( pPager->pageSize );
2867 if( pHist->pStmt ){
2868 memcpy(pHist->pStmt, PGHDR_TO_DATA(pPg), pPager->pageSize);
2869 }
danielk1977ef73ee92004-11-06 12:26:07 +00002870 TRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00002871 }else{
2872 store32bits(pPg->pgno, pPg, -4);
2873 CODEC(pPager, pData, pPg->pgno, 7);
2874 rc = sqlite3OsWrite(&pPager->stfd,((char*)pData)-4, pPager->pageSize+4);
danielk1977ef73ee92004-11-06 12:26:07 +00002875 TRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
drhac69b052004-05-12 13:30:07 +00002876 CODEC(pPager, pData, pPg->pgno, 0);
drhac69b052004-05-12 13:30:07 +00002877 if( rc!=SQLITE_OK ){
2878 sqlite3pager_rollback(pPager);
2879 pPager->errMask |= PAGER_ERR_FULL;
2880 return rc;
2881 }
danielk1977a0bf2652004-11-04 14:30:04 +00002882 pPager->stmtNRec++;
2883 assert( pPager->aInStmt!=0 );
2884 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drhdb48ee02003-01-16 13:42:43 +00002885 }
danielk1977a0bf2652004-11-04 14:30:04 +00002886 page_add_to_stmt_list(pPg);
drhd9b02572001-04-15 00:37:09 +00002887 }
drhfa86c412002-02-02 15:01:15 +00002888 }
2889
2890 /* Update the database size and return.
2891 */
drh1ab43002002-01-14 09:28:19 +00002892 if( pPager->dbSize<(int)pPg->pgno ){
drh306dc212001-05-21 13:45:10 +00002893 pPager->dbSize = pPg->pgno;
drhb7f91642004-10-31 02:22:47 +00002894 if( !MEMDB && pPager->dbSize==PENDING_BYTE/pPager->pageSize ){
drh1f595712004-06-15 01:40:29 +00002895 pPager->dbSize++;
2896 }
drh306dc212001-05-21 13:45:10 +00002897 }
drh69688d52001-04-14 16:38:23 +00002898 return rc;
drhed7c8552001-04-11 14:29:21 +00002899}
2900
2901/*
drhaacc5432002-01-06 17:07:40 +00002902** Return TRUE if the page given in the argument was previously passed
drh3aac2dd2004-04-26 14:10:20 +00002903** to sqlite3pager_write(). In other words, return TRUE if it is ok
drh6019e162001-07-02 17:51:45 +00002904** to change the content of the page.
2905*/
drh3aac2dd2004-04-26 14:10:20 +00002906int sqlite3pager_iswriteable(void *pData){
drh6019e162001-07-02 17:51:45 +00002907 PgHdr *pPg = DATA_TO_PGHDR(pData);
2908 return pPg->dirty;
2909}
2910
danielk1977b84f96f2005-01-20 11:32:23 +00002911#ifndef SQLITE_OMIT_VACUUM
drh6019e162001-07-02 17:51:45 +00002912/*
drh001bbcb2003-03-19 03:14:00 +00002913** Replace the content of a single page with the information in the third
2914** argument.
2915*/
drh3aac2dd2004-04-26 14:10:20 +00002916int sqlite3pager_overwrite(Pager *pPager, Pgno pgno, void *pData){
drh001bbcb2003-03-19 03:14:00 +00002917 void *pPage;
2918 int rc;
2919
drh3aac2dd2004-04-26 14:10:20 +00002920 rc = sqlite3pager_get(pPager, pgno, &pPage);
drh001bbcb2003-03-19 03:14:00 +00002921 if( rc==SQLITE_OK ){
drh3aac2dd2004-04-26 14:10:20 +00002922 rc = sqlite3pager_write(pPage);
drh001bbcb2003-03-19 03:14:00 +00002923 if( rc==SQLITE_OK ){
drh90f5ecb2004-07-22 01:19:35 +00002924 memcpy(pPage, pData, pPager->pageSize);
drh001bbcb2003-03-19 03:14:00 +00002925 }
drh3aac2dd2004-04-26 14:10:20 +00002926 sqlite3pager_unref(pPage);
drh001bbcb2003-03-19 03:14:00 +00002927 }
2928 return rc;
2929}
danielk1977b84f96f2005-01-20 11:32:23 +00002930#endif
drh001bbcb2003-03-19 03:14:00 +00002931
2932/*
drh30e58752002-03-02 20:41:57 +00002933** A call to this routine tells the pager that it is not necessary to
2934** write the information on page "pgno" back to the disk, even though
2935** that page might be marked as dirty.
2936**
2937** The overlying software layer calls this routine when all of the data
2938** on the given page is unused. The pager marks the page as clean so
2939** that it does not get written to disk.
2940**
2941** Tests show that this optimization, together with the
drh3aac2dd2004-04-26 14:10:20 +00002942** sqlite3pager_dont_rollback() below, more than double the speed
drh30e58752002-03-02 20:41:57 +00002943** of large INSERT operations and quadruple the speed of large DELETEs.
drh8e298f92002-07-06 16:28:47 +00002944**
2945** When this routine is called, set the alwaysRollback flag to true.
drh3aac2dd2004-04-26 14:10:20 +00002946** Subsequent calls to sqlite3pager_dont_rollback() for the same page
drh8e298f92002-07-06 16:28:47 +00002947** will thereafter be ignored. This is necessary to avoid a problem
2948** where a page with data is added to the freelist during one part of
2949** a transaction then removed from the freelist during a later part
2950** of the same transaction and reused for some other purpose. When it
2951** is first added to the freelist, this routine is called. When reused,
2952** the dont_rollback() routine is called. But because the page contains
2953** critical data, we still need to be sure it gets rolled back in spite
2954** of the dont_rollback() call.
drh30e58752002-03-02 20:41:57 +00002955*/
drh3aac2dd2004-04-26 14:10:20 +00002956void sqlite3pager_dont_write(Pager *pPager, Pgno pgno){
drh30e58752002-03-02 20:41:57 +00002957 PgHdr *pPg;
drh8e298f92002-07-06 16:28:47 +00002958
drhb7f91642004-10-31 02:22:47 +00002959 if( MEMDB ) return;
danielk1977eac7a362004-06-16 07:45:24 +00002960
drh30e58752002-03-02 20:41:57 +00002961 pPg = pager_lookup(pPager, pgno);
drh8e298f92002-07-06 16:28:47 +00002962 pPg->alwaysRollback = 1;
drh30e58752002-03-02 20:41:57 +00002963 if( pPg && pPg->dirty ){
drh8124a302002-06-25 14:43:57 +00002964 if( pPager->dbSize==(int)pPg->pgno && pPager->origDbSize<pPager->dbSize ){
2965 /* If this pages is the last page in the file and the file has grown
2966 ** during the current transaction, then do NOT mark the page as clean.
2967 ** When the database file grows, we must make sure that the last page
2968 ** gets written at least once so that the disk file will be the correct
2969 ** size. If you do not write this page and the size of the file
2970 ** on the disk ends up being too small, that can lead to database
2971 ** corruption during the next transaction.
2972 */
2973 }else{
danielk1977ef73ee92004-11-06 12:26:07 +00002974 TRACE3("DONT_WRITE page %d of %d\n", pgno, PAGERID(pPager));
drh8124a302002-06-25 14:43:57 +00002975 pPg->dirty = 0;
danielk19773c407372005-02-15 02:54:14 +00002976#ifdef SQLITE_CHECK_PAGES
2977 pPg->pageHash = pager_pagehash(pPg);
2978#endif
drh8124a302002-06-25 14:43:57 +00002979 }
drh30e58752002-03-02 20:41:57 +00002980 }
2981}
2982
2983/*
2984** A call to this routine tells the pager that if a rollback occurs,
2985** it is not necessary to restore the data on the given page. This
2986** means that the pager does not have to record the given page in the
2987** rollback journal.
2988*/
drh3aac2dd2004-04-26 14:10:20 +00002989void sqlite3pager_dont_rollback(void *pData){
drh30e58752002-03-02 20:41:57 +00002990 PgHdr *pPg = DATA_TO_PGHDR(pData);
2991 Pager *pPager = pPg->pPager;
2992
drha6abd042004-06-09 17:37:22 +00002993 if( pPager->state!=PAGER_EXCLUSIVE || pPager->journalOpen==0 ) return;
drhb7f91642004-10-31 02:22:47 +00002994 if( pPg->alwaysRollback || pPager->alwaysRollback || MEMDB ) return;
drh30e58752002-03-02 20:41:57 +00002995 if( !pPg->inJournal && (int)pPg->pgno <= pPager->origDbSize ){
2996 assert( pPager->aInJournal!=0 );
2997 pPager->aInJournal[pPg->pgno/8] |= 1<<(pPg->pgno&7);
2998 pPg->inJournal = 1;
drhac69b052004-05-12 13:30:07 +00002999 if( pPager->stmtInUse ){
3000 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drh3aac2dd2004-04-26 14:10:20 +00003001 page_add_to_stmt_list(pPg);
drh30e58752002-03-02 20:41:57 +00003002 }
danielk1977ef73ee92004-11-06 12:26:07 +00003003 TRACE3("DONT_ROLLBACK page %d of %d\n", pPg->pgno, PAGERID(pPager));
drh30e58752002-03-02 20:41:57 +00003004 }
drhac69b052004-05-12 13:30:07 +00003005 if( pPager->stmtInUse && !pPg->inStmt && (int)pPg->pgno<=pPager->stmtSize ){
drh30e58752002-03-02 20:41:57 +00003006 assert( pPg->inJournal || (int)pPg->pgno>pPager->origDbSize );
drhac69b052004-05-12 13:30:07 +00003007 assert( pPager->aInStmt!=0 );
3008 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drh3aac2dd2004-04-26 14:10:20 +00003009 page_add_to_stmt_list(pPg);
drh30e58752002-03-02 20:41:57 +00003010 }
3011}
3012
drhac69b052004-05-12 13:30:07 +00003013
danielk197793758c82005-01-21 08:13:14 +00003014#ifndef SQLITE_OMIT_MEMORYDB
drhac69b052004-05-12 13:30:07 +00003015/*
3016** Clear a PgHistory block
3017*/
3018static void clearHistory(PgHistory *pHist){
3019 sqliteFree(pHist->pOrig);
3020 sqliteFree(pHist->pStmt);
3021 pHist->pOrig = 0;
3022 pHist->pStmt = 0;
3023}
danielk197793758c82005-01-21 08:13:14 +00003024#else
3025#define clearHistory(x)
3026#endif
drhac69b052004-05-12 13:30:07 +00003027
drh30e58752002-03-02 20:41:57 +00003028/*
drhed7c8552001-04-11 14:29:21 +00003029** Commit all changes to the database and release the write lock.
drhd9b02572001-04-15 00:37:09 +00003030**
3031** If the commit fails for any reason, a rollback attempt is made
3032** and an error code is returned. If the commit worked, SQLITE_OK
3033** is returned.
drhed7c8552001-04-11 14:29:21 +00003034*/
drh3aac2dd2004-04-26 14:10:20 +00003035int sqlite3pager_commit(Pager *pPager){
drha1b351a2001-09-14 16:42:12 +00003036 int rc;
drhed7c8552001-04-11 14:29:21 +00003037 PgHdr *pPg;
drhd9b02572001-04-15 00:37:09 +00003038
3039 if( pPager->errMask==PAGER_ERR_FULL ){
drh3aac2dd2004-04-26 14:10:20 +00003040 rc = sqlite3pager_rollback(pPager);
drh4e371ee2002-09-05 16:08:27 +00003041 if( rc==SQLITE_OK ){
3042 rc = SQLITE_FULL;
3043 }
drhd9b02572001-04-15 00:37:09 +00003044 return rc;
3045 }
3046 if( pPager->errMask!=0 ){
3047 rc = pager_errcode(pPager);
3048 return rc;
3049 }
drha6abd042004-06-09 17:37:22 +00003050 if( pPager->state<PAGER_RESERVED ){
drhd9b02572001-04-15 00:37:09 +00003051 return SQLITE_ERROR;
3052 }
danielk1977ef73ee92004-11-06 12:26:07 +00003053 TRACE2("COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003054 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00003055 pPg = pager_get_all_dirty_pages(pPager);
3056 while( pPg ){
3057 clearHistory(PGHDR_TO_HIST(pPg, pPager));
3058 pPg->dirty = 0;
3059 pPg->inJournal = 0;
3060 pPg->inStmt = 0;
3061 pPg->pPrevStmt = pPg->pNextStmt = 0;
3062 pPg = pPg->pDirty;
3063 }
danielk1977eac7a362004-06-16 07:45:24 +00003064#ifndef NDEBUG
3065 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
3066 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
3067 assert( !pPg->alwaysRollback );
3068 assert( !pHist->pOrig );
3069 assert( !pHist->pStmt );
3070 }
3071#endif
drhac69b052004-05-12 13:30:07 +00003072 pPager->pStmt = 0;
drha6abd042004-06-09 17:37:22 +00003073 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00003074 return SQLITE_OK;
3075 }
drha6abd042004-06-09 17:37:22 +00003076 if( pPager->dirtyCache==0 ){
danielk19774adee202004-05-08 08:23:19 +00003077 /* Exit early (without doing the time-consuming sqlite3OsSync() calls)
drha1680452002-04-18 01:56:57 +00003078 ** if there have been no changes to the database file. */
drh341eae82003-01-21 02:39:36 +00003079 assert( pPager->needSync==0 );
drha1680452002-04-18 01:56:57 +00003080 rc = pager_unwritelock(pPager);
3081 pPager->dbSize = -1;
3082 return rc;
3083 }
drhda47d772002-12-02 04:25:19 +00003084 assert( pPager->journalOpen );
danielk1977d761c0c2004-11-05 16:37:02 +00003085 rc = sqlite3pager_sync(pPager, 0, 0);
drha6abd042004-06-09 17:37:22 +00003086 if( rc!=SQLITE_OK ){
3087 goto commit_abort;
3088 }
drhd9b02572001-04-15 00:37:09 +00003089 rc = pager_unwritelock(pPager);
3090 pPager->dbSize = -1;
3091 return rc;
3092
3093 /* Jump here if anything goes wrong during the commit process.
3094 */
3095commit_abort:
drh92f02c32004-09-02 14:57:08 +00003096 sqlite3pager_rollback(pPager);
drhed7c8552001-04-11 14:29:21 +00003097 return rc;
3098}
3099
3100/*
drha6abd042004-06-09 17:37:22 +00003101** Rollback all changes. The database falls back to PAGER_SHARED mode.
drhed7c8552001-04-11 14:29:21 +00003102** All in-memory cache pages revert to their original data contents.
3103** The journal is deleted.
drhd9b02572001-04-15 00:37:09 +00003104**
3105** This routine cannot fail unless some other process is not following
3106** the correct locking protocol (SQLITE_PROTOCOL) or unless some other
3107** process is writing trash into the journal file (SQLITE_CORRUPT) or
3108** unless a prior malloc() failed (SQLITE_NOMEM). Appropriate error
3109** codes are returned for all these occasions. Otherwise,
3110** SQLITE_OK is returned.
drhed7c8552001-04-11 14:29:21 +00003111*/
drh3aac2dd2004-04-26 14:10:20 +00003112int sqlite3pager_rollback(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +00003113 int rc;
danielk1977ef73ee92004-11-06 12:26:07 +00003114 TRACE2("ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003115 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00003116 PgHdr *p;
3117 for(p=pPager->pAll; p; p=p->pNextAll){
3118 PgHistory *pHist;
danielk1977eac7a362004-06-16 07:45:24 +00003119 assert( !p->alwaysRollback );
3120 if( !p->dirty ){
3121 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pOrig );
3122 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pStmt );
3123 continue;
3124 }
3125
drhac69b052004-05-12 13:30:07 +00003126 pHist = PGHDR_TO_HIST(p, pPager);
3127 if( pHist->pOrig ){
3128 memcpy(PGHDR_TO_DATA(p), pHist->pOrig, pPager->pageSize);
danielk1977ef73ee92004-11-06 12:26:07 +00003129 TRACE3("ROLLBACK-PAGE %d of %d\n", p->pgno, PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00003130 }else{
danielk1977ef73ee92004-11-06 12:26:07 +00003131 TRACE3("PAGE %d is clean on %d\n", p->pgno, PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00003132 }
3133 clearHistory(pHist);
3134 p->dirty = 0;
3135 p->inJournal = 0;
3136 p->inStmt = 0;
3137 p->pPrevStmt = p->pNextStmt = 0;
danielk1977369f27e2004-06-15 11:40:04 +00003138
3139 if( pPager->xReiniter ){
3140 pPager->xReiniter(PGHDR_TO_DATA(p), pPager->pageSize);
3141 }
3142
drhac69b052004-05-12 13:30:07 +00003143 }
3144 pPager->pStmt = 0;
3145 pPager->dbSize = pPager->origDbSize;
3146 memoryTruncate(pPager);
3147 pPager->stmtInUse = 0;
drha6abd042004-06-09 17:37:22 +00003148 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00003149 return SQLITE_OK;
3150 }
3151
drha6abd042004-06-09 17:37:22 +00003152 if( !pPager->dirtyCache || !pPager->journalOpen ){
drhda47d772002-12-02 04:25:19 +00003153 rc = pager_unwritelock(pPager);
3154 pPager->dbSize = -1;
3155 return rc;
3156 }
drhdb48ee02003-01-16 13:42:43 +00003157
drhd9b02572001-04-15 00:37:09 +00003158 if( pPager->errMask!=0 && pPager->errMask!=PAGER_ERR_FULL ){
drha6abd042004-06-09 17:37:22 +00003159 if( pPager->state>=PAGER_EXCLUSIVE ){
danielk197776572402004-06-25 02:38:54 +00003160 pager_playback(pPager);
drh4b845d72002-03-05 12:41:19 +00003161 }
drhd9b02572001-04-15 00:37:09 +00003162 return pager_errcode(pPager);
drhed7c8552001-04-11 14:29:21 +00003163 }
drha6abd042004-06-09 17:37:22 +00003164 if( pPager->state==PAGER_RESERVED ){
danielk197717221812005-02-15 03:38:05 +00003165 int rc2;
drha6abd042004-06-09 17:37:22 +00003166 rc = pager_reload_cache(pPager);
danielk197717221812005-02-15 03:38:05 +00003167 rc2 = pager_unwritelock(pPager);
drha6abd042004-06-09 17:37:22 +00003168 if( rc==SQLITE_OK ){
3169 rc = rc2;
3170 }
3171 }else{
danielk197776572402004-06-25 02:38:54 +00003172 rc = pager_playback(pPager);
drhd9b02572001-04-15 00:37:09 +00003173 }
drhd9b02572001-04-15 00:37:09 +00003174 if( rc!=SQLITE_OK ){
drhee696e22004-08-30 16:52:17 +00003175 rc = SQLITE_CORRUPT; /* bkpt-CORRUPT */
drhd9b02572001-04-15 00:37:09 +00003176 pPager->errMask |= PAGER_ERR_CORRUPT;
3177 }
3178 pPager->dbSize = -1;
drhed7c8552001-04-11 14:29:21 +00003179 return rc;
drh98808ba2001-10-18 12:34:46 +00003180}
drhd9b02572001-04-15 00:37:09 +00003181
3182/*
drh5e00f6c2001-09-13 13:46:56 +00003183** Return TRUE if the database file is opened read-only. Return FALSE
3184** if the database is (in theory) writable.
3185*/
drh3aac2dd2004-04-26 14:10:20 +00003186int sqlite3pager_isreadonly(Pager *pPager){
drhbe0072d2001-09-13 14:46:09 +00003187 return pPager->readOnly;
drh5e00f6c2001-09-13 13:46:56 +00003188}
3189
3190/*
drhd9b02572001-04-15 00:37:09 +00003191** This routine is used for testing and analysis only.
3192*/
drh3aac2dd2004-04-26 14:10:20 +00003193int *sqlite3pager_stats(Pager *pPager){
danielk197742741be2005-01-08 12:42:39 +00003194 static int a[11];
drhd9b02572001-04-15 00:37:09 +00003195 a[0] = pPager->nRef;
3196 a[1] = pPager->nPage;
3197 a[2] = pPager->mxPage;
3198 a[3] = pPager->dbSize;
3199 a[4] = pPager->state;
3200 a[5] = pPager->errMask;
drhfcd35c72005-05-21 02:48:08 +00003201#ifdef SQLITE_TEST
drhd9b02572001-04-15 00:37:09 +00003202 a[6] = pPager->nHit;
3203 a[7] = pPager->nMiss;
3204 a[8] = pPager->nOvfl;
danielk197742741be2005-01-08 12:42:39 +00003205 a[9] = pPager->nRead;
3206 a[10] = pPager->nWrite;
drhfcd35c72005-05-21 02:48:08 +00003207#endif
drhd9b02572001-04-15 00:37:09 +00003208 return a;
3209}
drhdd793422001-06-28 01:54:48 +00003210
drhfa86c412002-02-02 15:01:15 +00003211/*
drhac69b052004-05-12 13:30:07 +00003212** Set the statement rollback point.
drhfa86c412002-02-02 15:01:15 +00003213**
3214** This routine should be called with the transaction journal already
drhac69b052004-05-12 13:30:07 +00003215** open. A new statement journal is created that can be used to rollback
drhaaab5722002-02-19 13:39:21 +00003216** changes of a single SQL command within a larger transaction.
drhfa86c412002-02-02 15:01:15 +00003217*/
drh3aac2dd2004-04-26 14:10:20 +00003218int sqlite3pager_stmt_begin(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00003219 int rc;
3220 char zTemp[SQLITE_TEMPNAME_SIZE];
drhac69b052004-05-12 13:30:07 +00003221 assert( !pPager->stmtInUse );
drhdc3ff9c2004-08-18 02:10:15 +00003222 assert( pPager->dbSize>=0 );
danielk1977ef73ee92004-11-06 12:26:07 +00003223 TRACE2("STMT-BEGIN %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003224 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00003225 pPager->stmtInUse = 1;
3226 pPager->stmtSize = pPager->dbSize;
3227 return SQLITE_OK;
3228 }
drhda47d772002-12-02 04:25:19 +00003229 if( !pPager->journalOpen ){
drhac69b052004-05-12 13:30:07 +00003230 pPager->stmtAutoopen = 1;
drhda47d772002-12-02 04:25:19 +00003231 return SQLITE_OK;
3232 }
drhfa86c412002-02-02 15:01:15 +00003233 assert( pPager->journalOpen );
drhac69b052004-05-12 13:30:07 +00003234 pPager->aInStmt = sqliteMalloc( pPager->dbSize/8 + 1 );
3235 if( pPager->aInStmt==0 ){
danielk19779eed5052004-06-04 10:38:30 +00003236 sqlite3OsLock(&pPager->fd, SHARED_LOCK);
drhfa86c412002-02-02 15:01:15 +00003237 return SQLITE_NOMEM;
3238 }
drh968af522003-02-11 14:55:40 +00003239#ifndef NDEBUG
drhac69b052004-05-12 13:30:07 +00003240 rc = sqlite3OsFileSize(&pPager->jfd, &pPager->stmtJSize);
3241 if( rc ) goto stmt_begin_failed;
danielk197776572402004-06-25 02:38:54 +00003242 assert( pPager->stmtJSize == pPager->journalOff );
drh968af522003-02-11 14:55:40 +00003243#endif
danielk197776572402004-06-25 02:38:54 +00003244 pPager->stmtJSize = pPager->journalOff;
drhac69b052004-05-12 13:30:07 +00003245 pPager->stmtSize = pPager->dbSize;
danielk197776572402004-06-25 02:38:54 +00003246 pPager->stmtHdrOff = 0;
danielk197775edc162004-06-26 01:48:18 +00003247 pPager->stmtCksum = pPager->cksumInit;
drhac69b052004-05-12 13:30:07 +00003248 if( !pPager->stmtOpen ){
3249 rc = sqlite3pager_opentemp(zTemp, &pPager->stfd);
3250 if( rc ) goto stmt_begin_failed;
3251 pPager->stmtOpen = 1;
3252 pPager->stmtNRec = 0;
drh0f892532002-05-30 12:27:03 +00003253 }
drhac69b052004-05-12 13:30:07 +00003254 pPager->stmtInUse = 1;
drhfa86c412002-02-02 15:01:15 +00003255 return SQLITE_OK;
3256
drhac69b052004-05-12 13:30:07 +00003257stmt_begin_failed:
3258 if( pPager->aInStmt ){
3259 sqliteFree(pPager->aInStmt);
3260 pPager->aInStmt = 0;
drhfa86c412002-02-02 15:01:15 +00003261 }
3262 return rc;
3263}
3264
3265/*
drhac69b052004-05-12 13:30:07 +00003266** Commit a statement.
drhfa86c412002-02-02 15:01:15 +00003267*/
drh3aac2dd2004-04-26 14:10:20 +00003268int sqlite3pager_stmt_commit(Pager *pPager){
drhac69b052004-05-12 13:30:07 +00003269 if( pPager->stmtInUse ){
drh03eb96a2002-11-10 23:32:56 +00003270 PgHdr *pPg, *pNext;
danielk1977ef73ee92004-11-06 12:26:07 +00003271 TRACE2("STMT-COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003272 if( !MEMDB ){
drhac69b052004-05-12 13:30:07 +00003273 sqlite3OsSeek(&pPager->stfd, 0);
3274 /* sqlite3OsTruncate(&pPager->stfd, 0); */
3275 sqliteFree( pPager->aInStmt );
3276 pPager->aInStmt = 0;
drh663fc632002-02-02 18:49:19 +00003277 }
drhac69b052004-05-12 13:30:07 +00003278 for(pPg=pPager->pStmt; pPg; pPg=pNext){
3279 pNext = pPg->pNextStmt;
3280 assert( pPg->inStmt );
3281 pPg->inStmt = 0;
3282 pPg->pPrevStmt = pPg->pNextStmt = 0;
drhb7f91642004-10-31 02:22:47 +00003283 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00003284 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
3285 sqliteFree(pHist->pStmt);
3286 pHist->pStmt = 0;
3287 }
3288 }
3289 pPager->stmtNRec = 0;
3290 pPager->stmtInUse = 0;
3291 pPager->pStmt = 0;
drh663fc632002-02-02 18:49:19 +00003292 }
drhac69b052004-05-12 13:30:07 +00003293 pPager->stmtAutoopen = 0;
drhfa86c412002-02-02 15:01:15 +00003294 return SQLITE_OK;
3295}
3296
3297/*
drhac69b052004-05-12 13:30:07 +00003298** Rollback a statement.
drhfa86c412002-02-02 15:01:15 +00003299*/
drh3aac2dd2004-04-26 14:10:20 +00003300int sqlite3pager_stmt_rollback(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00003301 int rc;
drhac69b052004-05-12 13:30:07 +00003302 if( pPager->stmtInUse ){
danielk1977ef73ee92004-11-06 12:26:07 +00003303 TRACE2("STMT-ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003304 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00003305 PgHdr *pPg;
3306 for(pPg=pPager->pStmt; pPg; pPg=pPg->pNextStmt){
3307 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
3308 if( pHist->pStmt ){
3309 memcpy(PGHDR_TO_DATA(pPg), pHist->pStmt, pPager->pageSize);
3310 sqliteFree(pHist->pStmt);
3311 pHist->pStmt = 0;
3312 }
3313 }
3314 pPager->dbSize = pPager->stmtSize;
3315 memoryTruncate(pPager);
3316 rc = SQLITE_OK;
3317 }else{
3318 rc = pager_stmt_playback(pPager);
3319 }
drh3aac2dd2004-04-26 14:10:20 +00003320 sqlite3pager_stmt_commit(pPager);
drh663fc632002-02-02 18:49:19 +00003321 }else{
3322 rc = SQLITE_OK;
3323 }
drhac69b052004-05-12 13:30:07 +00003324 pPager->stmtAutoopen = 0;
drhfa86c412002-02-02 15:01:15 +00003325 return rc;
3326}
3327
drh73509ee2003-04-06 20:44:45 +00003328/*
3329** Return the full pathname of the database file.
3330*/
drh3aac2dd2004-04-26 14:10:20 +00003331const char *sqlite3pager_filename(Pager *pPager){
drh73509ee2003-04-06 20:44:45 +00003332 return pPager->zFilename;
3333}
3334
drhb20ea9d2004-02-09 01:20:36 +00003335/*
danielk19775865e3d2004-06-14 06:03:57 +00003336** Return the directory of the database file.
3337*/
3338const char *sqlite3pager_dirname(Pager *pPager){
3339 return pPager->zDirectory;
3340}
3341
3342/*
3343** Return the full pathname of the journal file.
3344*/
3345const char *sqlite3pager_journalname(Pager *pPager){
3346 return pPager->zJournal;
3347}
3348
3349/*
drhb20ea9d2004-02-09 01:20:36 +00003350** Set the codec for this pager
3351*/
drh3aac2dd2004-04-26 14:10:20 +00003352void sqlite3pager_set_codec(
drhb20ea9d2004-02-09 01:20:36 +00003353 Pager *pPager,
drh9eb9e262004-02-11 02:18:05 +00003354 void (*xCodec)(void*,void*,Pgno,int),
drhb20ea9d2004-02-09 01:20:36 +00003355 void *pCodecArg
3356){
3357 pPager->xCodec = xCodec;
3358 pPager->pCodecArg = pCodecArg;
3359}
3360
danielk197713adf8a2004-06-03 16:08:41 +00003361/*
danielk1977aa5ccdf2004-06-14 05:10:42 +00003362** This routine is called to increment the database file change-counter,
3363** stored at byte 24 of the pager file.
3364*/
3365static int pager_incr_changecounter(Pager *pPager){
3366 void *pPage;
3367 PgHdr *pPgHdr;
3368 u32 change_counter;
3369 int rc;
3370
3371 /* Open page 1 of the file for writing. */
3372 rc = sqlite3pager_get(pPager, 1, &pPage);
3373 if( rc!=SQLITE_OK ) return rc;
3374 rc = sqlite3pager_write(pPage);
3375 if( rc!=SQLITE_OK ) return rc;
3376
3377 /* Read the current value at byte 24. */
3378 pPgHdr = DATA_TO_PGHDR(pPage);
3379 change_counter = retrieve32bits(pPgHdr, 24);
3380
3381 /* Increment the value just read and write it back to byte 24. */
3382 change_counter++;
3383 store32bits(change_counter, pPgHdr, 24);
3384
3385 /* Release the page reference. */
3386 sqlite3pager_unref(pPage);
3387 return SQLITE_OK;
3388}
3389
3390/*
danielk197713adf8a2004-06-03 16:08:41 +00003391** Sync the database file for the pager pPager. zMaster points to the name
3392** of a master journal file that should be written into the individual
3393** journal file. zMaster may be NULL, which is interpreted as no master
3394** journal (a single database transaction).
3395**
3396** This routine ensures that the journal is synced, all dirty pages written
3397** to the database file and the database file synced. The only thing that
3398** remains to commit the transaction is to delete the journal file (or
3399** master journal file if specified).
3400**
3401** Note that if zMaster==NULL, this does not overwrite a previous value
3402** passed to an sqlite3pager_sync() call.
danielk1977d761c0c2004-11-05 16:37:02 +00003403**
3404** If parameter nTrunc is non-zero, then the pager file is truncated to
3405** nTrunc pages (this is used by auto-vacuum databases).
danielk197713adf8a2004-06-03 16:08:41 +00003406*/
danielk1977d761c0c2004-11-05 16:37:02 +00003407int sqlite3pager_sync(Pager *pPager, const char *zMaster, Pgno nTrunc){
danielk197713adf8a2004-06-03 16:08:41 +00003408 int rc = SQLITE_OK;
3409
danielk1977ef73ee92004-11-06 12:26:07 +00003410 TRACE4("DATABASE SYNC: File=%s zMaster=%s nTrunc=%d\n",
3411 pPager->zFilename, zMaster, nTrunc);
3412
danielk1977aa5ccdf2004-06-14 05:10:42 +00003413 /* If this is an in-memory db, or no pages have been written to, or this
3414 ** function has already been called, it is a no-op.
danielk197713adf8a2004-06-03 16:08:41 +00003415 */
drhb7f91642004-10-31 02:22:47 +00003416 if( pPager->state!=PAGER_SYNCED && !MEMDB && pPager->dirtyCache ){
danielk197713adf8a2004-06-03 16:08:41 +00003417 PgHdr *pPg;
3418 assert( pPager->journalOpen );
3419
danielk197776572402004-06-25 02:38:54 +00003420 /* If a master journal file name has already been written to the
3421 ** journal file, then no sync is required. This happens when it is
3422 ** written, then the process fails to upgrade from a RESERVED to an
3423 ** EXCLUSIVE lock. The next time the process tries to commit the
3424 ** transaction the m-j name will have already been written.
3425 */
3426 if( !pPager->setMaster ){
3427 rc = pager_incr_changecounter(pPager);
3428 if( rc!=SQLITE_OK ) goto sync_exit;
danielk1977ef73ee92004-11-06 12:26:07 +00003429#ifndef SQLITE_OMIT_AUTOVACUUM
3430 if( nTrunc!=0 ){
3431 /* If this transaction has made the database smaller, then all pages
3432 ** being discarded by the truncation must be written to the journal
3433 ** file.
3434 */
3435 Pgno i;
3436 void *pPage;
3437 for( i=nTrunc+1; i<=pPager->origDbSize; i++ ){
3438 if( !(pPager->aInJournal[i/8] & (1<<(i&7))) ){
3439 rc = sqlite3pager_get(pPager, i, &pPage);
3440 if( rc!=SQLITE_OK ) goto sync_exit;
3441 rc = sqlite3pager_write(pPage);
3442 sqlite3pager_unref(pPage);
3443 if( rc!=SQLITE_OK ) goto sync_exit;
3444 }
3445 }
3446 }
3447#endif
danielk197776572402004-06-25 02:38:54 +00003448 rc = writeMasterJournal(pPager, zMaster);
3449 if( rc!=SQLITE_OK ) goto sync_exit;
3450 rc = syncJournal(pPager);
3451 if( rc!=SQLITE_OK ) goto sync_exit;
3452 }
danielk197713adf8a2004-06-03 16:08:41 +00003453
danielk1977d761c0c2004-11-05 16:37:02 +00003454#ifndef SQLITE_OMIT_AUTOVACUUM
3455 if( nTrunc!=0 ){
3456 rc = sqlite3pager_truncate(pPager, nTrunc);
3457 if( rc!=SQLITE_OK ) goto sync_exit;
3458 }
3459#endif
3460
danielk197713adf8a2004-06-03 16:08:41 +00003461 /* Write all dirty pages to the database file */
3462 pPg = pager_get_all_dirty_pages(pPager);
3463 rc = pager_write_pagelist(pPg);
3464 if( rc!=SQLITE_OK ) goto sync_exit;
3465
danielk1977aa5ccdf2004-06-14 05:10:42 +00003466 /* Sync the database file. */
3467 if( !pPager->noSync ){
danielk197713adf8a2004-06-03 16:08:41 +00003468 rc = sqlite3OsSync(&pPager->fd);
3469 }
danielk1977aa5ccdf2004-06-14 05:10:42 +00003470
3471 pPager->state = PAGER_SYNCED;
danielk197713adf8a2004-06-03 16:08:41 +00003472 }
3473
3474sync_exit:
3475 return rc;
3476}
3477
danielk1977687566d2004-11-02 12:56:41 +00003478#ifndef SQLITE_OMIT_AUTOVACUUM
3479/*
3480** Move the page identified by pData to location pgno in the file.
3481**
3482** There must be no references to the current page pgno. If current page
3483** pgno is not already in the rollback journal, it is not written there by
3484** by this routine. The same applies to the page pData refers to on entry to
3485** this routine.
3486**
3487** References to the page refered to by pData remain valid. Updating any
3488** meta-data associated with page pData (i.e. data stored in the nExtra bytes
3489** allocated along with the page) is the responsibility of the caller.
3490**
danielk19775fd057a2005-03-09 13:09:43 +00003491** A transaction must be active when this routine is called. It used to be
3492** required that a statement transaction was not active, but this restriction
3493** has been removed (CREATE INDEX needs to move a page when a statement
3494** transaction is active).
danielk1977687566d2004-11-02 12:56:41 +00003495*/
3496int sqlite3pager_movepage(Pager *pPager, void *pData, Pgno pgno){
3497 PgHdr *pPg = DATA_TO_PGHDR(pData);
3498 PgHdr *pPgOld;
danielk1977f5fdda82004-11-03 08:44:05 +00003499 int h;
danielk197794daf7f2004-11-08 09:26:09 +00003500 Pgno needSyncPgno = 0;
danielk1977687566d2004-11-02 12:56:41 +00003501
danielk1977687566d2004-11-02 12:56:41 +00003502 assert( pPg->nRef>0 );
3503
danielk1977599fcba2004-11-08 07:13:13 +00003504 TRACE5("MOVE %d page %d (needSync=%d) moves to %d\n",
3505 PAGERID(pPager), pPg->pgno, pPg->needSync, pgno);
danielk1977ef73ee92004-11-06 12:26:07 +00003506
danielk197794daf7f2004-11-08 09:26:09 +00003507 if( pPg->needSync ){
3508 needSyncPgno = pPg->pgno;
3509 assert( pPg->inJournal );
3510 assert( pPg->dirty );
danielk1977ae825582004-11-23 09:06:55 +00003511 assert( pPager->needSync );
danielk197794daf7f2004-11-08 09:26:09 +00003512 }
3513
danielk1977687566d2004-11-02 12:56:41 +00003514 /* Unlink pPg from it's hash-chain */
danielk1977f5fdda82004-11-03 08:44:05 +00003515 unlinkHashChain(pPager, pPg);
danielk1977687566d2004-11-02 12:56:41 +00003516
danielk1977ef73ee92004-11-06 12:26:07 +00003517 /* If the cache contains a page with page-number pgno, remove it
danielk1977599fcba2004-11-08 07:13:13 +00003518 ** from it's hash chain. Also, if the PgHdr.needSync was set for
3519 ** page pgno before the 'move' operation, it needs to be retained
3520 ** for the page moved there.
danielk1977f5fdda82004-11-03 08:44:05 +00003521 */
danielk1977687566d2004-11-02 12:56:41 +00003522 pPgOld = pager_lookup(pPager, pgno);
3523 if( pPgOld ){
danielk1977f5fdda82004-11-03 08:44:05 +00003524 assert( pPgOld->nRef==0 );
3525 unlinkHashChain(pPager, pPgOld);
3526 pPgOld->dirty = 0;
danielk1977ef73ee92004-11-06 12:26:07 +00003527 if( pPgOld->needSync ){
danielk197745901d62004-11-10 15:27:38 +00003528 assert( pPgOld->inJournal );
3529 pPg->inJournal = 1;
danielk1977ef73ee92004-11-06 12:26:07 +00003530 pPg->needSync = 1;
danielk1977ae825582004-11-23 09:06:55 +00003531 assert( pPager->needSync );
danielk1977ef73ee92004-11-06 12:26:07 +00003532 }
danielk1977687566d2004-11-02 12:56:41 +00003533 }
3534
danielk1977f5fdda82004-11-03 08:44:05 +00003535 /* Change the page number for pPg and insert it into the new hash-chain. */
3536 pPg->pgno = pgno;
3537 h = pager_hash(pgno);
3538 if( pPager->aHash[h] ){
3539 assert( pPager->aHash[h]->pPrevHash==0 );
3540 pPager->aHash[h]->pPrevHash = pPg;
3541 }
3542 pPg->pNextHash = pPager->aHash[h];
3543 pPager->aHash[h] = pPg;
3544 pPg->pPrevHash = 0;
3545
danielk1977687566d2004-11-02 12:56:41 +00003546 pPg->dirty = 1;
3547 pPager->dirtyCache = 1;
3548
danielk197794daf7f2004-11-08 09:26:09 +00003549 if( needSyncPgno ){
3550 /* If needSyncPgno is non-zero, then the journal file needs to be
3551 ** sync()ed before any data is written to database file page needSyncPgno.
3552 ** Currently, no such page exists in the page-cache and the
3553 ** Pager.aInJournal bit has been set. This needs to be remedied by loading
3554 ** the page into the pager-cache and setting the PgHdr.needSync flag.
danielk1977ae825582004-11-23 09:06:55 +00003555 **
3556 ** The sqlite3pager_get() call may cause the journal to sync. So make
3557 ** sure the Pager.needSync flag is set too.
danielk197794daf7f2004-11-08 09:26:09 +00003558 */
3559 int rc;
3560 void *pNeedSync;
danielk1977ae825582004-11-23 09:06:55 +00003561 assert( pPager->needSync );
danielk197794daf7f2004-11-08 09:26:09 +00003562 rc = sqlite3pager_get(pPager, needSyncPgno, &pNeedSync);
3563 if( rc!=SQLITE_OK ) return rc;
danielk1977ae825582004-11-23 09:06:55 +00003564 pPager->needSync = 1;
danielk197794daf7f2004-11-08 09:26:09 +00003565 DATA_TO_PGHDR(pNeedSync)->needSync = 1;
3566 DATA_TO_PGHDR(pNeedSync)->inJournal = 1;
3567 DATA_TO_PGHDR(pNeedSync)->dirty = 1;
3568 sqlite3pager_unref(pNeedSync);
3569 }
3570
danielk1977687566d2004-11-02 12:56:41 +00003571 return SQLITE_OK;
3572}
3573#endif
3574
dougcurrie81c95ef2004-06-18 23:21:47 +00003575#if defined(SQLITE_DEBUG) || defined(SQLITE_TEST)
drh89ac8c12004-06-09 14:17:20 +00003576/*
3577** Return the current state of the file lock for the given pager.
3578** The return value is one of NO_LOCK, SHARED_LOCK, RESERVED_LOCK,
3579** PENDING_LOCK, or EXCLUSIVE_LOCK.
3580*/
3581int sqlite3pager_lockstate(Pager *pPager){
danielk1977e3026632004-06-22 11:29:02 +00003582#ifdef OS_TEST
danielk19778a6c5502004-06-22 12:18:32 +00003583 return pPager->fd->fd.locktype;
danielk1977e3026632004-06-22 11:29:02 +00003584#else
drh89ac8c12004-06-09 14:17:20 +00003585 return pPager->fd.locktype;
danielk1977e3026632004-06-22 11:29:02 +00003586#endif
drh89ac8c12004-06-09 14:17:20 +00003587}
3588#endif
3589
danielk197793758c82005-01-21 08:13:14 +00003590#ifdef SQLITE_DEBUG
drhdd793422001-06-28 01:54:48 +00003591/*
3592** Print a listing of all referenced pages and their ref count.
3593*/
drh3aac2dd2004-04-26 14:10:20 +00003594void sqlite3pager_refdump(Pager *pPager){
drhdd793422001-06-28 01:54:48 +00003595 PgHdr *pPg;
3596 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
3597 if( pPg->nRef<=0 ) continue;
drhfe63d1c2004-09-08 20:13:04 +00003598 sqlite3DebugPrintf("PAGE %3d addr=%p nRef=%d\n",
3599 pPg->pgno, PGHDR_TO_DATA(pPg), pPg->nRef);
drhdd793422001-06-28 01:54:48 +00003600 }
3601}
3602#endif
drh2e66f0b2005-04-28 17:18:48 +00003603
3604#endif /* SQLITE_OMIT_DISKIO */