blob: d6c2d329945010b23cdc9424982dd0b08ec1dcda [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**
drhf07e7d52006-04-07 13:54:46 +000021** @(#) $Id: pager.c,v 1.266 2006/04/07 13:54:47 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
drhd86959f2005-11-26 03:51:18 +000049** to print out file-descriptors.
danielk1977599fcba2004-11-08 07:13:13 +000050**
51** PAGERID() takes a pointer to a Pager struct as it's argument. The
52** associated file-descriptor is returned. FILEHANDLEID() takes an OsFile
53** struct as it's argument.
54*/
drhc001c582006-03-06 18:23:16 +000055#define PAGERID(p) ((int)(p->fd))
56#define FILEHANDLEID(fd) ((int)fd)
drhdb48ee02003-01-16 13:42:43 +000057
58/*
drhed7c8552001-04-11 14:29:21 +000059** The page cache as a whole is always in one of the following
60** states:
61**
drha6abd042004-06-09 17:37:22 +000062** PAGER_UNLOCK The page cache is not currently reading or
drhed7c8552001-04-11 14:29:21 +000063** writing the database file. There is no
64** data held in memory. This is the initial
65** state.
66**
drha6abd042004-06-09 17:37:22 +000067** PAGER_SHARED The page cache is reading the database.
drhed7c8552001-04-11 14:29:21 +000068** Writing is not permitted. There can be
69** multiple readers accessing the same database
drh69688d52001-04-14 16:38:23 +000070** file at the same time.
drhed7c8552001-04-11 14:29:21 +000071**
drh726de592004-06-10 23:35:50 +000072** PAGER_RESERVED This process has reserved the database for writing
73** but has not yet made any changes. Only one process
74** at a time can reserve the database. The original
75** database file has not been modified so other
76** processes may still be reading the on-disk
drha6abd042004-06-09 17:37:22 +000077** database file.
78**
79** PAGER_EXCLUSIVE The page cache is writing the database.
drhed7c8552001-04-11 14:29:21 +000080** Access is exclusive. No other processes or
81** threads can be reading or writing while one
82** process is writing.
83**
danielk1977aa5ccdf2004-06-14 05:10:42 +000084** PAGER_SYNCED The pager moves to this state from PAGER_EXCLUSIVE
85** after all dirty pages have been written to the
86** database file and the file has been synced to
87** disk. All that remains to do is to remove the
88** journal file and the transaction will be
89** committed.
90**
drha6abd042004-06-09 17:37:22 +000091** The page cache comes up in PAGER_UNLOCK. The first time a
drh726de592004-06-10 23:35:50 +000092** sqlite3pager_get() occurs, the state transitions to PAGER_SHARED.
drhed7c8552001-04-11 14:29:21 +000093** After all pages have been released using sqlite_page_unref(),
drha6abd042004-06-09 17:37:22 +000094** the state transitions back to PAGER_UNLOCK. The first time
drh726de592004-06-10 23:35:50 +000095** that sqlite3pager_write() is called, the state transitions to
drha6abd042004-06-09 17:37:22 +000096** PAGER_RESERVED. (Note that sqlite_page_write() can only be
drh306dc212001-05-21 13:45:10 +000097** called on an outstanding page which means that the pager must
drha6abd042004-06-09 17:37:22 +000098** be in PAGER_SHARED before it transitions to PAGER_RESERVED.)
drh726de592004-06-10 23:35:50 +000099** The transition to PAGER_EXCLUSIVE occurs when before any changes
100** are made to the database file. After an sqlite3pager_rollback()
101** or sqlite_pager_commit(), the state goes back to PAGER_SHARED.
drhed7c8552001-04-11 14:29:21 +0000102*/
drha6abd042004-06-09 17:37:22 +0000103#define PAGER_UNLOCK 0
drh684917c2004-10-05 02:41:42 +0000104#define PAGER_SHARED 1 /* same as SHARED_LOCK */
105#define PAGER_RESERVED 2 /* same as RESERVED_LOCK */
106#define PAGER_EXCLUSIVE 4 /* same as EXCLUSIVE_LOCK */
107#define PAGER_SYNCED 5
drhed7c8552001-04-11 14:29:21 +0000108
drh684917c2004-10-05 02:41:42 +0000109/*
110** If the SQLITE_BUSY_RESERVED_LOCK macro is set to true at compile-time,
111** then failed attempts to get a reserved lock will invoke the busy callback.
112** This is off by default. To see why, consider the following scenario:
113**
114** Suppose thread A already has a shared lock and wants a reserved lock.
115** Thread B already has a reserved lock and wants an exclusive lock. If
116** both threads are using their busy callbacks, it might be a long time
117** be for one of the threads give up and allows the other to proceed.
118** But if the thread trying to get the reserved lock gives up quickly
119** (if it never invokes its busy callback) then the contention will be
120** resolved quickly.
121*/
122#ifndef SQLITE_BUSY_RESERVED_LOCK
123# define SQLITE_BUSY_RESERVED_LOCK 0
124#endif
drhd9b02572001-04-15 00:37:09 +0000125
drhed7c8552001-04-11 14:29:21 +0000126/*
drh887dc4c2004-10-22 16:22:57 +0000127** This macro rounds values up so that if the value is an address it
128** is guaranteed to be an address that is aligned to an 8-byte boundary.
129*/
130#define FORCE_ALIGNMENT(X) (((X)+7)&~7)
131
132/*
drhed7c8552001-04-11 14:29:21 +0000133** Each in-memory image of a page begins with the following header.
drhbd03cae2001-06-02 02:40:57 +0000134** This header is only visible to this pager module. The client
135** code that calls pager sees only the data that follows the header.
drhf6038712004-02-08 18:07:34 +0000136**
drh3aac2dd2004-04-26 14:10:20 +0000137** Client code should call sqlite3pager_write() on a page prior to making
138** any modifications to that page. The first time sqlite3pager_write()
drhf6038712004-02-08 18:07:34 +0000139** is called, the original page contents are written into the rollback
140** journal and PgHdr.inJournal and PgHdr.needSync are set. Later, once
141** the journal page has made it onto the disk surface, PgHdr.needSync
142** is cleared. The modified page cannot be written back into the original
143** database file until the journal pages has been synced to disk and the
144** PgHdr.needSync has been cleared.
145**
drh3aac2dd2004-04-26 14:10:20 +0000146** The PgHdr.dirty flag is set when sqlite3pager_write() is called and
drhf6038712004-02-08 18:07:34 +0000147** is cleared again when the page content is written back to the original
148** database file.
drhed7c8552001-04-11 14:29:21 +0000149*/
drhd9b02572001-04-15 00:37:09 +0000150typedef struct PgHdr PgHdr;
drhed7c8552001-04-11 14:29:21 +0000151struct PgHdr {
152 Pager *pPager; /* The pager to which this page belongs */
153 Pgno pgno; /* The page number for this page */
drh69688d52001-04-14 16:38:23 +0000154 PgHdr *pNextHash, *pPrevHash; /* Hash collision chain for PgHdr.pgno */
drhd9b02572001-04-15 00:37:09 +0000155 PgHdr *pNextFree, *pPrevFree; /* Freelist of pages where nRef==0 */
drhac69b052004-05-12 13:30:07 +0000156 PgHdr *pNextAll; /* A list of all pages */
157 PgHdr *pNextStmt, *pPrevStmt; /* List of pages in the statement journal */
drh193a6b42002-07-07 16:52:46 +0000158 u8 inJournal; /* TRUE if has been written to journal */
drhac69b052004-05-12 13:30:07 +0000159 u8 inStmt; /* TRUE if in the statement subjournal */
drh193a6b42002-07-07 16:52:46 +0000160 u8 dirty; /* TRUE if we need to write back changes */
drhdb48ee02003-01-16 13:42:43 +0000161 u8 needSync; /* Sync journal before writing this page */
drh193a6b42002-07-07 16:52:46 +0000162 u8 alwaysRollback; /* Disable dont_rollback() for this page */
drhac69b052004-05-12 13:30:07 +0000163 short int nRef; /* Number of users of this page */
drh2554f8b2003-01-22 01:26:44 +0000164 PgHdr *pDirty; /* Dirty pages sorted by PgHdr.pgno */
danielk19773c407372005-02-15 02:54:14 +0000165#ifdef SQLITE_CHECK_PAGES
166 u32 pageHash;
167#endif
drh1c7880e2005-05-20 20:01:55 +0000168 /* pPager->pageSize bytes of page data follow this header */
drh973b6e32003-02-12 14:09:42 +0000169 /* Pager.nExtra bytes of local data follow the page data */
drhed7c8552001-04-11 14:29:21 +0000170};
171
drhac69b052004-05-12 13:30:07 +0000172/*
173** For an in-memory only database, some extra information is recorded about
174** each page so that changes can be rolled back. (Journal files are not
175** used for in-memory databases.) The following information is added to
176** the end of every EXTRA block for in-memory databases.
177**
178** This information could have been added directly to the PgHdr structure.
179** But then it would take up an extra 8 bytes of storage on every PgHdr
180** even for disk-based databases. Splitting it out saves 8 bytes. This
181** is only a savings of 0.8% but those percentages add up.
182*/
183typedef struct PgHistory PgHistory;
184struct PgHistory {
185 u8 *pOrig; /* Original page text. Restore to this on a full rollback */
186 u8 *pStmt; /* Text as it was at the beginning of the current statement */
187};
drh9eb9e262004-02-11 02:18:05 +0000188
189/*
190** A macro used for invoking the codec if there is one
191*/
192#ifdef SQLITE_HAS_CODEC
drhc001c582006-03-06 18:23:16 +0000193# define CODEC1(P,D,N,X) if( P->xCodec!=0 ){ P->xCodec(P->pCodecArg,D,N,X); }
194# define CODEC2(P,D,N,X) ((char*)(P->xCodec!=0?P->xCodec(P->pCodecArg,D,N,X):D))
drh9eb9e262004-02-11 02:18:05 +0000195#else
drhc001c582006-03-06 18:23:16 +0000196# define CODEC1(P,D,N,X) /* NO-OP */
197# define CODEC2(P,D,N,X) ((char*)D)
drh9eb9e262004-02-11 02:18:05 +0000198#endif
199
drhed7c8552001-04-11 14:29:21 +0000200/*
drh69688d52001-04-14 16:38:23 +0000201** Convert a pointer to a PgHdr into a pointer to its data
202** and back again.
drhed7c8552001-04-11 14:29:21 +0000203*/
204#define PGHDR_TO_DATA(P) ((void*)(&(P)[1]))
205#define DATA_TO_PGHDR(D) (&((PgHdr*)(D))[-1])
drh1c7880e2005-05-20 20:01:55 +0000206#define PGHDR_TO_EXTRA(G,P) ((void*)&((char*)(&(G)[1]))[(P)->pageSize])
drhac69b052004-05-12 13:30:07 +0000207#define PGHDR_TO_HIST(P,PGR) \
drh1c7880e2005-05-20 20:01:55 +0000208 ((PgHistory*)&((char*)(&(P)[1]))[(PGR)->pageSize+(PGR)->nExtra])
drhed7c8552001-04-11 14:29:21 +0000209
210/*
drhed7c8552001-04-11 14:29:21 +0000211** How big to make the hash table used for locating in-memory pages
danielk1977634f2982005-03-28 08:44:07 +0000212** by page number. This macro looks a little silly, but is evaluated
213** at compile-time, not run-time (at least for gcc this is true).
drhed7c8552001-04-11 14:29:21 +0000214*/
danielk1977634f2982005-03-28 08:44:07 +0000215#define N_PG_HASH (\
216 (MAX_PAGES>1024)?2048: \
217 (MAX_PAGES>512)?1024: \
218 (MAX_PAGES>256)?512: \
219 (MAX_PAGES>128)?256: \
220 (MAX_PAGES>64)?128:64 \
221)
drh836faa42003-01-11 13:30:57 +0000222
223/*
224** Hash a page number
225*/
226#define pager_hash(PN) ((PN)&(N_PG_HASH-1))
drhed7c8552001-04-11 14:29:21 +0000227
228/*
229** A open page cache is an instance of the following structure.
danielk1977efaaf572006-01-16 11:29:19 +0000230**
231** Pager.errCode may be set to SQLITE_IOERR, SQLITE_CORRUPT, SQLITE_PROTOCOL
232** or SQLITE_FULL. Once one of the first three errors occurs, it persists
233** and is returned as the result of every major pager API call. The
234** SQLITE_FULL return code is slightly different. It persists only until the
235** next successful rollback is performed on the pager cache. Also,
236** SQLITE_FULL does not affect the sqlite3pager_get() and sqlite3pager_lookup()
237** APIs, they may still be used successfully.
drhed7c8552001-04-11 14:29:21 +0000238*/
239struct Pager {
drh603240c2002-03-05 01:11:12 +0000240 u8 journalOpen; /* True if journal file descriptors is valid */
drh34e79ce2004-02-08 06:05:46 +0000241 u8 journalStarted; /* True if header of journal is synced */
242 u8 useJournal; /* Use a rollback journal on this file */
drh7bec5052005-02-06 02:45:41 +0000243 u8 noReadlock; /* Do not bother to obtain readlocks */
drhac69b052004-05-12 13:30:07 +0000244 u8 stmtOpen; /* True if the statement subjournal is open */
245 u8 stmtInUse; /* True we are in a statement subtransaction */
246 u8 stmtAutoopen; /* Open stmt journal when main journal is opened*/
drh603240c2002-03-05 01:11:12 +0000247 u8 noSync; /* Do not sync the journal if true */
drh968af522003-02-11 14:55:40 +0000248 u8 fullSync; /* Do extra syncs of the journal for robustness */
drhac530b12006-02-11 01:25:50 +0000249 u8 full_fsync; /* Use F_FULLFSYNC when available */
drha6abd042004-06-09 17:37:22 +0000250 u8 state; /* PAGER_UNLOCK, _SHARED, _RESERVED, etc. */
danielk1977efaaf572006-01-16 11:29:19 +0000251 u8 errCode; /* One of several kinds of errors */
drh603240c2002-03-05 01:11:12 +0000252 u8 tempFile; /* zFilename is a temporary file */
253 u8 readOnly; /* True for a read-only database */
254 u8 needSync; /* True if an fsync() is needed on the journal */
drha6abd042004-06-09 17:37:22 +0000255 u8 dirtyCache; /* True if cached pages have changed */
drh193a6b42002-07-07 16:52:46 +0000256 u8 alwaysRollback; /* Disable dont_rollback() for all pages */
drhac69b052004-05-12 13:30:07 +0000257 u8 memDb; /* True to inhibit all file I/O */
drh6d156e42005-05-20 20:11:20 +0000258 u8 setMaster; /* True if a m-j name has been written to jrnl */
drhfcd35c72005-05-21 02:48:08 +0000259 int dbSize; /* Number of pages in the file */
260 int origDbSize; /* dbSize before the current change */
261 int stmtSize; /* Size of database (in pages) at stmt_begin() */
262 int nRec; /* Number of pages written to the journal */
263 u32 cksumInit; /* Quasi-random value added to every checksum */
264 int stmtNRec; /* Number of records in stmt subjournal */
265 int nExtra; /* Add this many bytes to each in-memory page */
266 int pageSize; /* Number of bytes in a page */
267 int nPage; /* Total number of in-memory pages */
268 int nMaxPage; /* High water mark of nPage */
269 int nRef; /* Number of in-memory pages with PgHdr.nRef>0 */
270 int mxPage; /* Maximum number of pages to hold in cache */
drh603240c2002-03-05 01:11:12 +0000271 u8 *aInJournal; /* One bit for each page in the database file */
drhac69b052004-05-12 13:30:07 +0000272 u8 *aInStmt; /* One bit for each page in the database */
drhfcd35c72005-05-21 02:48:08 +0000273 char *zFilename; /* Name of the database file */
274 char *zJournal; /* Name of the journal file */
275 char *zDirectory; /* Directory hold database and journal files */
drh9cbe6352005-11-29 03:13:21 +0000276 OsFile *fd, *jfd; /* File descriptors for database and journal */
277 OsFile *stfd; /* File descriptor for the statement subjournal*/
drh726de592004-06-10 23:35:50 +0000278 BusyHandler *pBusyHandler; /* Pointer to sqlite.busyHandler */
drhed7c8552001-04-11 14:29:21 +0000279 PgHdr *pFirst, *pLast; /* List of free pages */
drh341eae82003-01-21 02:39:36 +0000280 PgHdr *pFirstSynced; /* First free page with PgHdr.needSync==0 */
drhd9b02572001-04-15 00:37:09 +0000281 PgHdr *pAll; /* List of all pages */
drhac69b052004-05-12 13:30:07 +0000282 PgHdr *pStmt; /* List of pages in the statement subjournal */
drheb206252004-10-01 02:00:31 +0000283 i64 journalOff; /* Current byte offset in the journal file */
284 i64 journalHdr; /* Byte offset to previous journal header */
285 i64 stmtHdrOff; /* First journal header written this statement */
286 i64 stmtCksum; /* cksumInit when statement was started */
drh6d156e42005-05-20 20:11:20 +0000287 i64 stmtJSize; /* Size of journal at stmt_begin() */
danielk197776572402004-06-25 02:38:54 +0000288 int sectorSize; /* Assumed sector size during rollback */
drhfcd35c72005-05-21 02:48:08 +0000289#ifdef SQLITE_TEST
drh6d156e42005-05-20 20:11:20 +0000290 int nHit, nMiss, nOvfl; /* Cache hits, missing, and LRU overflows */
291 int nRead,nWrite; /* Database pages read/written */
drhfcd35c72005-05-21 02:48:08 +0000292#endif
drh6d156e42005-05-20 20:11:20 +0000293 void (*xDestructor)(void*,int); /* Call this routine when freeing pages */
294 void (*xReiniter)(void*,int); /* Call this routine when reloading pages */
drhc001c582006-03-06 18:23:16 +0000295 void *(*xCodec)(void*,void*,Pgno,int); /* Routine for en/decoding data */
drh6d156e42005-05-20 20:11:20 +0000296 void *pCodecArg; /* First argument to xCodec() */
drh76ff3a02004-09-24 22:32:30 +0000297 PgHdr *aHash[N_PG_HASH]; /* Hash table to map page number to PgHdr */
drh6f7adc82006-01-11 21:41:20 +0000298#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
danielk197713f72992005-12-18 08:51:22 +0000299 Pager *pNext; /* Linked list of pagers in this thread */
300#endif
drhd9b02572001-04-15 00:37:09 +0000301};
302
303/*
drhfcd35c72005-05-21 02:48:08 +0000304** If SQLITE_TEST is defined then increment the variable given in
305** the argument
306*/
307#ifdef SQLITE_TEST
308# define TEST_INCR(x) x++
309#else
310# define TEST_INCR(x)
311#endif
312
313/*
drh5e00f6c2001-09-13 13:46:56 +0000314** Journal files begin with the following magic string. The data
315** was obtained from /dev/random. It is used only as a sanity check.
drh94f33312002-08-12 12:29:56 +0000316**
drhae2b40c2004-06-09 19:03:54 +0000317** Since version 2.8.0, the journal format contains additional sanity
318** checking information. If the power fails while the journal is begin
319** written, semi-random garbage data might appear in the journal
320** file after power is restored. If an attempt is then made
drh968af522003-02-11 14:55:40 +0000321** to roll the journal back, the database could be corrupted. The additional
322** sanity checking data is an attempt to discover the garbage in the
323** journal and ignore it.
324**
drhae2b40c2004-06-09 19:03:54 +0000325** The sanity checking information for the new journal format consists
drh968af522003-02-11 14:55:40 +0000326** of a 32-bit checksum on each page of data. The checksum covers both
drh90f5ecb2004-07-22 01:19:35 +0000327** the page number and the pPager->pageSize bytes of data for the page.
drh968af522003-02-11 14:55:40 +0000328** This cksum is initialized to a 32-bit random value that appears in the
329** journal file right after the header. The random initializer is important,
330** because garbage data that appears at the end of a journal is likely
331** data that was once in other files that have now been deleted. If the
332** garbage data came from an obsolete journal file, the checksums might
333** be correct. But by initializing the checksum to random value which
334** is different for every journal, we minimize that risk.
drhd9b02572001-04-15 00:37:09 +0000335*/
drhae2b40c2004-06-09 19:03:54 +0000336static const unsigned char aJournalMagic[] = {
337 0xd9, 0xd5, 0x05, 0xf9, 0x20, 0xa1, 0x63, 0xd7,
drhed7c8552001-04-11 14:29:21 +0000338};
339
340/*
drh726de592004-06-10 23:35:50 +0000341** The size of the header and of each page in the journal is determined
342** by the following macros.
drh968af522003-02-11 14:55:40 +0000343*/
drhae2b40c2004-06-09 19:03:54 +0000344#define JOURNAL_PG_SZ(pPager) ((pPager->pageSize) + 8)
drh968af522003-02-11 14:55:40 +0000345
danielk197776572402004-06-25 02:38:54 +0000346/*
347** The journal header size for this pager. In the future, this could be
348** set to some value read from the disk controller. The important
349** characteristic is that it is the same size as a disk sector.
350*/
351#define JOURNAL_HDR_SZ(pPager) (pPager->sectorSize)
352
drhb7f91642004-10-31 02:22:47 +0000353/*
354** The macro MEMDB is true if we are dealing with an in-memory database.
355** We do this as a macro so that if the SQLITE_OMIT_MEMORYDB macro is set,
356** the value of MEMDB will be a constant and the compiler will optimize
357** out code that would never execute.
358*/
359#ifdef SQLITE_OMIT_MEMORYDB
360# define MEMDB 0
361#else
362# define MEMDB pPager->memDb
363#endif
364
365/*
366** The default size of a disk sector
367*/
danielk197776572402004-06-25 02:38:54 +0000368#define PAGER_SECTOR_SIZE 512
369
370/*
371** Page number PAGER_MJ_PGNO is never used in an SQLite database (it is
372** reserved for working around a windows/posix incompatibility). It is
373** used in the journal to signify that the remainder of the journal file
374** is devoted to storing a master journal name - there are no more pages to
375** roll back. See comments for function writeMasterJournal() for details.
376*/
danielk1977599fcba2004-11-08 07:13:13 +0000377/* #define PAGER_MJ_PGNO(x) (PENDING_BYTE/((x)->pageSize)) */
378#define PAGER_MJ_PGNO(x) ((PENDING_BYTE/((x)->pageSize))+1)
danielk197713adf8a2004-06-03 16:08:41 +0000379
drh968af522003-02-11 14:55:40 +0000380/*
danielk197726836652005-01-17 01:33:13 +0000381** The maximum legal page number is (2^31 - 1).
382*/
383#define PAGER_MAX_PGNO 2147483647
384
385/*
drh726de592004-06-10 23:35:50 +0000386** Enable reference count tracking (for debugging) here:
drhdd793422001-06-28 01:54:48 +0000387*/
danielk1977aca790a2005-01-13 11:07:52 +0000388#ifdef SQLITE_DEBUG
drh3aac2dd2004-04-26 14:10:20 +0000389 int pager3_refinfo_enable = 0;
drhdd793422001-06-28 01:54:48 +0000390 static void pager_refinfo(PgHdr *p){
391 static int cnt = 0;
drh3aac2dd2004-04-26 14:10:20 +0000392 if( !pager3_refinfo_enable ) return;
drhfe63d1c2004-09-08 20:13:04 +0000393 sqlite3DebugPrintf(
394 "REFCNT: %4d addr=%p nRef=%d\n",
395 p->pgno, PGHDR_TO_DATA(p), p->nRef
drhdd793422001-06-28 01:54:48 +0000396 );
397 cnt++; /* Something to set a breakpoint on */
398 }
399# define REFINFO(X) pager_refinfo(X)
400#else
401# define REFINFO(X)
402#endif
403
404/*
drh34e79ce2004-02-08 06:05:46 +0000405** Read a 32-bit integer from the given file descriptor. Store the integer
406** that is read in *pRes. Return SQLITE_OK if everything worked, or an
407** error code is something goes wrong.
drh726de592004-06-10 23:35:50 +0000408**
409** All values are stored on disk as big-endian.
drh94f33312002-08-12 12:29:56 +0000410*/
drhae2b40c2004-06-09 19:03:54 +0000411static int read32bits(OsFile *fd, u32 *pRes){
drh3b59a5c2006-01-15 20:28:28 +0000412 unsigned char ac[4];
413 int rc = sqlite3OsRead(fd, ac, sizeof(ac));
drhae2b40c2004-06-09 19:03:54 +0000414 if( rc==SQLITE_OK ){
drh3b59a5c2006-01-15 20:28:28 +0000415 *pRes = (ac[0]<<24) | (ac[1]<<16) | (ac[2]<<8) | ac[3];
drh94f33312002-08-12 12:29:56 +0000416 }
drh94f33312002-08-12 12:29:56 +0000417 return rc;
418}
419
420/*
drh97b57482006-01-10 20:32:32 +0000421** Write a 32-bit integer into a string buffer in big-endian byte order.
422*/
423static void put32bits(char *ac, u32 val){
424 ac[0] = (val>>24) & 0xff;
425 ac[1] = (val>>16) & 0xff;
426 ac[2] = (val>>8) & 0xff;
427 ac[3] = val & 0xff;
428}
429
430/*
drh34e79ce2004-02-08 06:05:46 +0000431** Write a 32-bit integer into the given file descriptor. Return SQLITE_OK
432** on success or an error code is something goes wrong.
drh94f33312002-08-12 12:29:56 +0000433*/
434static int write32bits(OsFile *fd, u32 val){
danielk1977bab45c62006-01-16 15:14:27 +0000435 char ac[4];
drh97b57482006-01-10 20:32:32 +0000436 put32bits(ac, val);
drh054889e2005-11-30 03:20:31 +0000437 return sqlite3OsWrite(fd, ac, 4);
drh94f33312002-08-12 12:29:56 +0000438}
439
drh2554f8b2003-01-22 01:26:44 +0000440/*
danielk1977aa5ccdf2004-06-14 05:10:42 +0000441** Read a 32-bit integer at offset 'offset' from the page identified by
442** page header 'p'.
443*/
444static u32 retrieve32bits(PgHdr *p, int offset){
445 unsigned char *ac;
446 ac = &((unsigned char*)PGHDR_TO_DATA(p))[offset];
447 return (ac[0]<<24) | (ac[1]<<16) | (ac[2]<<8) | ac[3];
448}
449
drh94f33312002-08-12 12:29:56 +0000450
451/*
danielk1977aef0bf62005-12-30 16:28:01 +0000452** This function should be called when an error occurs within the pager
danielk1977a96a7102006-01-16 12:46:41 +0000453** code. The first argument is a pointer to the pager structure, the
454** second the error-code about to be returned by a pager API function.
455** The value returned is a copy of the second argument to this function.
456**
457** If the second argument is SQLITE_IOERR, SQLITE_CORRUPT or SQLITE_PROTOCOL,
458** the error becomes persistent. All subsequent API calls on this Pager
459** will immediately return the same error code.
danielk1977aef0bf62005-12-30 16:28:01 +0000460*/
461static int pager_error(Pager *pPager, int rc){
danielk1977efaaf572006-01-16 11:29:19 +0000462 assert( pPager->errCode==SQLITE_FULL || pPager->errCode==SQLITE_OK );
463 if(
danielk197707cb5602006-01-20 10:55:05 +0000464 rc==SQLITE_FULL ||
465 rc==SQLITE_IOERR ||
danielk1977efaaf572006-01-16 11:29:19 +0000466 rc==SQLITE_CORRUPT ||
467 rc==SQLITE_PROTOCOL
468 ){
469 pPager->errCode = rc;
danielk1977aef0bf62005-12-30 16:28:01 +0000470 }
471 return rc;
472}
473
danielk19773c407372005-02-15 02:54:14 +0000474#ifdef SQLITE_CHECK_PAGES
475/*
476** Return a 32-bit hash of the page data for pPage.
477*/
478static u32 pager_pagehash(PgHdr *pPage){
479 u32 hash = 0;
480 int i;
481 unsigned char *pData = (unsigned char *)PGHDR_TO_DATA(pPage);
482 for(i=0; i<pPage->pPager->pageSize; i++){
483 hash = (hash+i)^pData[i];
484 }
485 return hash;
486}
487
488/*
489** The CHECK_PAGE macro takes a PgHdr* as an argument. If SQLITE_CHECK_PAGES
490** is defined, and NDEBUG is not defined, an assert() statement checks
491** that the page is either dirty or still matches the calculated page-hash.
492*/
493#define CHECK_PAGE(x) checkPage(x)
494static void checkPage(PgHdr *pPg){
495 Pager *pPager = pPg->pPager;
danielk1977efaaf572006-01-16 11:29:19 +0000496 assert( !pPg->pageHash || pPager->errCode || MEMDB || pPg->dirty ||
danielk19773c407372005-02-15 02:54:14 +0000497 pPg->pageHash==pager_pagehash(pPg) );
498}
499
500#else
501#define CHECK_PAGE(x)
502#endif
503
drhed7c8552001-04-11 14:29:21 +0000504/*
danielk197776572402004-06-25 02:38:54 +0000505** When this is called the journal file for pager pPager must be open.
506** The master journal file name is read from the end of the file and
507** written into memory obtained from sqliteMalloc(). *pzMaster is
508** set to point at the memory and SQLITE_OK returned. The caller must
509** sqliteFree() *pzMaster.
510**
511** If no master journal file name is present *pzMaster is set to 0 and
512** SQLITE_OK returned.
513*/
514static int readMasterJournal(OsFile *pJrnl, char **pzMaster){
515 int rc;
516 u32 len;
drheb206252004-10-01 02:00:31 +0000517 i64 szJ;
danielk1977c3e8f5e2004-06-28 01:16:46 +0000518 u32 cksum;
danielk1977cafadba2004-06-25 11:11:54 +0000519 int i;
danielk197776572402004-06-25 02:38:54 +0000520 unsigned char aMagic[8]; /* A buffer to hold the magic header */
521
522 *pzMaster = 0;
523
drh054889e2005-11-30 03:20:31 +0000524 rc = sqlite3OsFileSize(pJrnl, &szJ);
danielk1977cafadba2004-06-25 11:11:54 +0000525 if( rc!=SQLITE_OK || szJ<16 ) return rc;
danielk197776572402004-06-25 02:38:54 +0000526
drh054889e2005-11-30 03:20:31 +0000527 rc = sqlite3OsSeek(pJrnl, szJ-16);
danielk197776572402004-06-25 02:38:54 +0000528 if( rc!=SQLITE_OK ) return rc;
529
530 rc = read32bits(pJrnl, &len);
531 if( rc!=SQLITE_OK ) return rc;
532
danielk1977cafadba2004-06-25 11:11:54 +0000533 rc = read32bits(pJrnl, &cksum);
534 if( rc!=SQLITE_OK ) return rc;
535
drh054889e2005-11-30 03:20:31 +0000536 rc = sqlite3OsRead(pJrnl, aMagic, 8);
danielk197776572402004-06-25 02:38:54 +0000537 if( rc!=SQLITE_OK || memcmp(aMagic, aJournalMagic, 8) ) return rc;
538
drh054889e2005-11-30 03:20:31 +0000539 rc = sqlite3OsSeek(pJrnl, szJ-16-len);
danielk197776572402004-06-25 02:38:54 +0000540 if( rc!=SQLITE_OK ) return rc;
541
danielk19778191bff2004-06-28 04:52:30 +0000542 *pzMaster = (char *)sqliteMalloc(len+1);
danielk197776572402004-06-25 02:38:54 +0000543 if( !*pzMaster ){
544 return SQLITE_NOMEM;
545 }
drh054889e2005-11-30 03:20:31 +0000546 rc = sqlite3OsRead(pJrnl, *pzMaster, len);
danielk197776572402004-06-25 02:38:54 +0000547 if( rc!=SQLITE_OK ){
548 sqliteFree(*pzMaster);
549 *pzMaster = 0;
550 return rc;
551 }
danielk1977cafadba2004-06-25 11:11:54 +0000552
553 /* See if the checksum matches the master journal name */
554 for(i=0; i<len; i++){
danielk19778191bff2004-06-28 04:52:30 +0000555 cksum -= (*pzMaster)[i];
danielk1977cafadba2004-06-25 11:11:54 +0000556 }
danielk19778191bff2004-06-28 04:52:30 +0000557 if( cksum ){
558 /* If the checksum doesn't add up, then one or more of the disk sectors
559 ** containing the master journal filename is corrupted. This means
560 ** definitely roll back, so just return SQLITE_OK and report a (nul)
561 ** master-journal filename.
562 */
danielk1977cafadba2004-06-25 11:11:54 +0000563 sqliteFree(*pzMaster);
564 *pzMaster = 0;
danielk1977aca790a2005-01-13 11:07:52 +0000565 }else{
566 (*pzMaster)[len] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000567 }
danielk197776572402004-06-25 02:38:54 +0000568
569 return SQLITE_OK;
570}
571
572/*
573** Seek the journal file descriptor to the next sector boundary where a
574** journal header may be read or written. Pager.journalOff is updated with
575** the new seek offset.
576**
577** i.e for a sector size of 512:
578**
579** Input Offset Output Offset
580** ---------------------------------------
581** 0 0
582** 512 512
583** 100 512
584** 2000 2048
585**
586*/
587static int seekJournalHdr(Pager *pPager){
drheb206252004-10-01 02:00:31 +0000588 i64 offset = 0;
589 i64 c = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000590 if( c ){
591 offset = ((c-1)/JOURNAL_HDR_SZ(pPager) + 1) * JOURNAL_HDR_SZ(pPager);
592 }
593 assert( offset%JOURNAL_HDR_SZ(pPager)==0 );
594 assert( offset>=c );
595 assert( (offset-c)<JOURNAL_HDR_SZ(pPager) );
596 pPager->journalOff = offset;
drh054889e2005-11-30 03:20:31 +0000597 return sqlite3OsSeek(pPager->jfd, pPager->journalOff);
danielk197776572402004-06-25 02:38:54 +0000598}
599
600/*
601** The journal file must be open when this routine is called. A journal
602** header (JOURNAL_HDR_SZ bytes) is written into the journal file at the
603** current location.
604**
605** The format for the journal header is as follows:
606** - 8 bytes: Magic identifying journal format.
607** - 4 bytes: Number of records in journal, or -1 no-sync mode is on.
608** - 4 bytes: Random number used for page hash.
609** - 4 bytes: Initial database page count.
610** - 4 bytes: Sector size used by the process that wrote this journal.
611**
danielk1977f42f25c2004-06-25 07:21:28 +0000612** Followed by (JOURNAL_HDR_SZ - 24) bytes of unused space.
danielk197776572402004-06-25 02:38:54 +0000613*/
614static int writeJournalHdr(Pager *pPager){
drh97b57482006-01-10 20:32:32 +0000615 char zHeader[sizeof(aJournalMagic)+16];
danielk197776572402004-06-25 02:38:54 +0000616
617 int rc = seekJournalHdr(pPager);
618 if( rc ) return rc;
619
620 pPager->journalHdr = pPager->journalOff;
621 if( pPager->stmtHdrOff==0 ){
622 pPager->stmtHdrOff = pPager->journalHdr;
623 }
624 pPager->journalOff += JOURNAL_HDR_SZ(pPager);
625
626 /* FIX ME:
627 **
628 ** Possibly for a pager not in no-sync mode, the journal magic should not
629 ** be written until nRec is filled in as part of next syncJournal().
630 **
631 ** Actually maybe the whole journal header should be delayed until that
632 ** point. Think about this.
633 */
drh97b57482006-01-10 20:32:32 +0000634 memcpy(zHeader, aJournalMagic, sizeof(aJournalMagic));
635 /* The nRec Field. 0xFFFFFFFF for no-sync journals. */
636 put32bits(&zHeader[sizeof(aJournalMagic)], pPager->noSync ? 0xffffffff : 0);
637 /* The random check-hash initialiser */
638 sqlite3Randomness(sizeof(pPager->cksumInit), &pPager->cksumInit);
639 put32bits(&zHeader[sizeof(aJournalMagic)+4], pPager->cksumInit);
640 /* The initial database size */
641 put32bits(&zHeader[sizeof(aJournalMagic)+8], pPager->dbSize);
642 /* The assumed sector size for this process */
643 put32bits(&zHeader[sizeof(aJournalMagic)+12], pPager->sectorSize);
644 rc = sqlite3OsWrite(pPager->jfd, zHeader, sizeof(zHeader));
danielk197776572402004-06-25 02:38:54 +0000645
646 /* The journal header has been written successfully. Seek the journal
647 ** file descriptor to the end of the journal header sector.
648 */
649 if( rc==SQLITE_OK ){
drh054889e2005-11-30 03:20:31 +0000650 rc = sqlite3OsSeek(pPager->jfd, pPager->journalOff-1);
drhb4746b92005-09-09 01:32:06 +0000651 if( rc==SQLITE_OK ){
drh054889e2005-11-30 03:20:31 +0000652 rc = sqlite3OsWrite(pPager->jfd, "\000", 1);
drhb4746b92005-09-09 01:32:06 +0000653 }
danielk197776572402004-06-25 02:38:54 +0000654 }
655 return rc;
656}
657
658/*
659** The journal file must be open when this is called. A journal header file
660** (JOURNAL_HDR_SZ bytes) is read from the current location in the journal
661** file. See comments above function writeJournalHdr() for a description of
662** the journal header format.
663**
664** If the header is read successfully, *nRec is set to the number of
665** page records following this header and *dbSize is set to the size of the
666** database before the transaction began, in pages. Also, pPager->cksumInit
667** is set to the value read from the journal header. SQLITE_OK is returned
668** in this case.
669**
670** If the journal header file appears to be corrupted, SQLITE_DONE is
671** returned and *nRec and *dbSize are not set. If JOURNAL_HDR_SZ bytes
672** cannot be read from the journal file an error code is returned.
673*/
674static int readJournalHdr(
675 Pager *pPager,
drheb206252004-10-01 02:00:31 +0000676 i64 journalSize,
danielk197776572402004-06-25 02:38:54 +0000677 u32 *pNRec,
678 u32 *pDbSize
679){
680 int rc;
681 unsigned char aMagic[8]; /* A buffer to hold the magic header */
682
683 rc = seekJournalHdr(pPager);
684 if( rc ) return rc;
685
686 if( pPager->journalOff+JOURNAL_HDR_SZ(pPager) > journalSize ){
687 return SQLITE_DONE;
688 }
689
drh054889e2005-11-30 03:20:31 +0000690 rc = sqlite3OsRead(pPager->jfd, aMagic, sizeof(aMagic));
danielk197776572402004-06-25 02:38:54 +0000691 if( rc ) return rc;
692
693 if( memcmp(aMagic, aJournalMagic, sizeof(aMagic))!=0 ){
694 return SQLITE_DONE;
695 }
696
drh9cbe6352005-11-29 03:13:21 +0000697 rc = read32bits(pPager->jfd, pNRec);
danielk197776572402004-06-25 02:38:54 +0000698 if( rc ) return rc;
699
drh9cbe6352005-11-29 03:13:21 +0000700 rc = read32bits(pPager->jfd, &pPager->cksumInit);
danielk197776572402004-06-25 02:38:54 +0000701 if( rc ) return rc;
702
drh9cbe6352005-11-29 03:13:21 +0000703 rc = read32bits(pPager->jfd, pDbSize);
danielk197776572402004-06-25 02:38:54 +0000704 if( rc ) return rc;
705
706 /* Update the assumed sector-size to match the value used by
707 ** the process that created this journal. If this journal was
708 ** created by a process other than this one, then this routine
709 ** is being called from within pager_playback(). The local value
710 ** of Pager.sectorSize is restored at the end of that routine.
711 */
drh9cbe6352005-11-29 03:13:21 +0000712 rc = read32bits(pPager->jfd, (u32 *)&pPager->sectorSize);
danielk197776572402004-06-25 02:38:54 +0000713 if( rc ) return rc;
714
715 pPager->journalOff += JOURNAL_HDR_SZ(pPager);
drh054889e2005-11-30 03:20:31 +0000716 rc = sqlite3OsSeek(pPager->jfd, pPager->journalOff);
danielk197776572402004-06-25 02:38:54 +0000717 return rc;
718}
719
720
721/*
722** Write the supplied master journal name into the journal file for pager
danielk1977cafadba2004-06-25 11:11:54 +0000723** pPager at the current location. The master journal name must be the last
724** thing written to a journal file. If the pager is in full-sync mode, the
725** journal file descriptor is advanced to the next sector boundary before
726** anything is written. The format is:
727**
728** + 4 bytes: PAGER_MJ_PGNO.
729** + N bytes: length of master journal name.
730** + 4 bytes: N
731** + 4 bytes: Master journal name checksum.
732** + 8 bytes: aJournalMagic[].
733**
734** The master journal page checksum is the sum of the bytes in the master
735** journal name.
danielk1977aef0bf62005-12-30 16:28:01 +0000736**
737** If zMaster is a NULL pointer (occurs for a single database transaction),
738** this call is a no-op.
danielk197776572402004-06-25 02:38:54 +0000739*/
740static int writeMasterJournal(Pager *pPager, const char *zMaster){
741 int rc;
742 int len;
danielk1977cafadba2004-06-25 11:11:54 +0000743 int i;
drh97b57482006-01-10 20:32:32 +0000744 u32 cksum = 0;
745 char zBuf[sizeof(aJournalMagic)+2*4];
danielk197776572402004-06-25 02:38:54 +0000746
747 if( !zMaster || pPager->setMaster) return SQLITE_OK;
748 pPager->setMaster = 1;
749
750 len = strlen(zMaster);
danielk1977cafadba2004-06-25 11:11:54 +0000751 for(i=0; i<len; i++){
752 cksum += zMaster[i];
753 }
danielk197776572402004-06-25 02:38:54 +0000754
755 /* If in full-sync mode, advance to the next disk sector before writing
756 ** the master journal name. This is in case the previous page written to
757 ** the journal has already been synced.
758 */
759 if( pPager->fullSync ){
760 rc = seekJournalHdr(pPager);
761 if( rc!=SQLITE_OK ) return rc;
762 }
danielk1977cafadba2004-06-25 11:11:54 +0000763 pPager->journalOff += (len+20);
danielk197776572402004-06-25 02:38:54 +0000764
drh9cbe6352005-11-29 03:13:21 +0000765 rc = write32bits(pPager->jfd, PAGER_MJ_PGNO(pPager));
danielk197776572402004-06-25 02:38:54 +0000766 if( rc!=SQLITE_OK ) return rc;
767
drh054889e2005-11-30 03:20:31 +0000768 rc = sqlite3OsWrite(pPager->jfd, zMaster, len);
danielk197776572402004-06-25 02:38:54 +0000769 if( rc!=SQLITE_OK ) return rc;
770
drh97b57482006-01-10 20:32:32 +0000771 put32bits(zBuf, len);
772 put32bits(&zBuf[4], cksum);
773 memcpy(&zBuf[8], aJournalMagic, sizeof(aJournalMagic));
774 rc = sqlite3OsWrite(pPager->jfd, zBuf, 8+sizeof(aJournalMagic));
drh2c8997b2005-08-27 16:36:48 +0000775 pPager->needSync = !pPager->noSync;
danielk197776572402004-06-25 02:38:54 +0000776 return rc;
777}
778
779/*
drh03eb96a2002-11-10 23:32:56 +0000780** Add or remove a page from the list of all pages that are in the
drhac69b052004-05-12 13:30:07 +0000781** statement journal.
drh03eb96a2002-11-10 23:32:56 +0000782**
783** The Pager keeps a separate list of pages that are currently in
drhac69b052004-05-12 13:30:07 +0000784** the statement journal. This helps the sqlite3pager_stmt_commit()
drh03eb96a2002-11-10 23:32:56 +0000785** routine run MUCH faster for the common case where there are many
drhac69b052004-05-12 13:30:07 +0000786** pages in memory but only a few are in the statement journal.
drh03eb96a2002-11-10 23:32:56 +0000787*/
drh3aac2dd2004-04-26 14:10:20 +0000788static void page_add_to_stmt_list(PgHdr *pPg){
drh03eb96a2002-11-10 23:32:56 +0000789 Pager *pPager = pPg->pPager;
drhac69b052004-05-12 13:30:07 +0000790 if( pPg->inStmt ) return;
791 assert( pPg->pPrevStmt==0 && pPg->pNextStmt==0 );
792 pPg->pPrevStmt = 0;
793 if( pPager->pStmt ){
794 pPager->pStmt->pPrevStmt = pPg;
drh03eb96a2002-11-10 23:32:56 +0000795 }
drhac69b052004-05-12 13:30:07 +0000796 pPg->pNextStmt = pPager->pStmt;
797 pPager->pStmt = pPg;
798 pPg->inStmt = 1;
drh03eb96a2002-11-10 23:32:56 +0000799}
drh3aac2dd2004-04-26 14:10:20 +0000800static void page_remove_from_stmt_list(PgHdr *pPg){
drhac69b052004-05-12 13:30:07 +0000801 if( !pPg->inStmt ) return;
802 if( pPg->pPrevStmt ){
803 assert( pPg->pPrevStmt->pNextStmt==pPg );
804 pPg->pPrevStmt->pNextStmt = pPg->pNextStmt;
drh03eb96a2002-11-10 23:32:56 +0000805 }else{
drhac69b052004-05-12 13:30:07 +0000806 assert( pPg->pPager->pStmt==pPg );
807 pPg->pPager->pStmt = pPg->pNextStmt;
drh03eb96a2002-11-10 23:32:56 +0000808 }
drhac69b052004-05-12 13:30:07 +0000809 if( pPg->pNextStmt ){
810 assert( pPg->pNextStmt->pPrevStmt==pPg );
811 pPg->pNextStmt->pPrevStmt = pPg->pPrevStmt;
drh03eb96a2002-11-10 23:32:56 +0000812 }
drhac69b052004-05-12 13:30:07 +0000813 pPg->pNextStmt = 0;
814 pPg->pPrevStmt = 0;
815 pPg->inStmt = 0;
drh03eb96a2002-11-10 23:32:56 +0000816}
817
818/*
drhed7c8552001-04-11 14:29:21 +0000819** Find a page in the hash table given its page number. Return
820** a pointer to the page or NULL if not found.
821*/
drhd9b02572001-04-15 00:37:09 +0000822static PgHdr *pager_lookup(Pager *pPager, Pgno pgno){
drh836faa42003-01-11 13:30:57 +0000823 PgHdr *p = pPager->aHash[pager_hash(pgno)];
drhed7c8552001-04-11 14:29:21 +0000824 while( p && p->pgno!=pgno ){
825 p = p->pNextHash;
826 }
827 return p;
828}
829
830/*
831** Unlock the database and clear the in-memory cache. This routine
832** sets the state of the pager back to what it was when it was first
833** opened. Any outstanding pages are invalidated and subsequent attempts
834** to access those pages will likely result in a coredump.
835*/
drhd9b02572001-04-15 00:37:09 +0000836static void pager_reset(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +0000837 PgHdr *pPg, *pNext;
danielk1977efaaf572006-01-16 11:29:19 +0000838 if( pPager->errCode ) return;
drhd9b02572001-04-15 00:37:09 +0000839 for(pPg=pPager->pAll; pPg; pPg=pNext){
840 pNext = pPg->pNextAll;
841 sqliteFree(pPg);
drhed7c8552001-04-11 14:29:21 +0000842 }
843 pPager->pFirst = 0;
drh341eae82003-01-21 02:39:36 +0000844 pPager->pFirstSynced = 0;
drhd9b02572001-04-15 00:37:09 +0000845 pPager->pLast = 0;
846 pPager->pAll = 0;
drhed7c8552001-04-11 14:29:21 +0000847 memset(pPager->aHash, 0, sizeof(pPager->aHash));
848 pPager->nPage = 0;
drha6abd042004-06-09 17:37:22 +0000849 if( pPager->state>=PAGER_RESERVED ){
drh3aac2dd2004-04-26 14:10:20 +0000850 sqlite3pager_rollback(pPager);
drhed7c8552001-04-11 14:29:21 +0000851 }
drh054889e2005-11-30 03:20:31 +0000852 sqlite3OsUnlock(pPager->fd, NO_LOCK);
drha6abd042004-06-09 17:37:22 +0000853 pPager->state = PAGER_UNLOCK;
drhd9b02572001-04-15 00:37:09 +0000854 pPager->dbSize = -1;
drhed7c8552001-04-11 14:29:21 +0000855 pPager->nRef = 0;
drh8cfbf082001-09-19 13:22:39 +0000856 assert( pPager->journalOpen==0 );
drhed7c8552001-04-11 14:29:21 +0000857}
858
danielk19776b456a22005-03-21 04:04:02 +0000859/*
drhed7c8552001-04-11 14:29:21 +0000860** When this routine is called, the pager has the journal file open and
drha6abd042004-06-09 17:37:22 +0000861** a RESERVED or EXCLUSIVE lock on the database. This routine releases
862** the database lock and acquires a SHARED lock in its place. The journal
863** file is deleted and closed.
drh50457892003-09-06 01:10:47 +0000864**
865** TODO: Consider keeping the journal file open for temporary databases.
866** This might give a performance improvement on windows where opening
867** a file is an expensive operation.
drhed7c8552001-04-11 14:29:21 +0000868*/
drhd9b02572001-04-15 00:37:09 +0000869static int pager_unwritelock(Pager *pPager){
drhd9b02572001-04-15 00:37:09 +0000870 PgHdr *pPg;
drh9c105bb2004-10-02 20:38:28 +0000871 int rc;
drhb7f91642004-10-31 02:22:47 +0000872 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +0000873 if( pPager->state<PAGER_RESERVED ){
874 return SQLITE_OK;
875 }
drh3aac2dd2004-04-26 14:10:20 +0000876 sqlite3pager_stmt_commit(pPager);
drhac69b052004-05-12 13:30:07 +0000877 if( pPager->stmtOpen ){
drh054889e2005-11-30 03:20:31 +0000878 sqlite3OsClose(&pPager->stfd);
drhac69b052004-05-12 13:30:07 +0000879 pPager->stmtOpen = 0;
drh0f892532002-05-30 12:27:03 +0000880 }
drhda47d772002-12-02 04:25:19 +0000881 if( pPager->journalOpen ){
drh054889e2005-11-30 03:20:31 +0000882 sqlite3OsClose(&pPager->jfd);
drhda47d772002-12-02 04:25:19 +0000883 pPager->journalOpen = 0;
drh66560ad2006-01-06 14:32:19 +0000884 sqlite3OsDelete(pPager->zJournal);
drhda47d772002-12-02 04:25:19 +0000885 sqliteFree( pPager->aInJournal );
886 pPager->aInJournal = 0;
887 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
888 pPg->inJournal = 0;
889 pPg->dirty = 0;
drhdb48ee02003-01-16 13:42:43 +0000890 pPg->needSync = 0;
danielk19773c407372005-02-15 02:54:14 +0000891#ifdef SQLITE_CHECK_PAGES
892 pPg->pageHash = pager_pagehash(pPg);
893#endif
drhda47d772002-12-02 04:25:19 +0000894 }
danielk1977ef317ab2004-06-23 10:43:10 +0000895 pPager->dirtyCache = 0;
danielk1977ef317ab2004-06-23 10:43:10 +0000896 pPager->nRec = 0;
drhda47d772002-12-02 04:25:19 +0000897 }else{
drh88b01a12005-03-28 18:04:27 +0000898 assert( pPager->aInJournal==0 );
drha6abd042004-06-09 17:37:22 +0000899 assert( pPager->dirtyCache==0 || pPager->useJournal==0 );
drhd9b02572001-04-15 00:37:09 +0000900 }
drh054889e2005-11-30 03:20:31 +0000901 rc = sqlite3OsUnlock(pPager->fd, SHARED_LOCK);
drha6abd042004-06-09 17:37:22 +0000902 pPager->state = PAGER_SHARED;
danielk1977ef317ab2004-06-23 10:43:10 +0000903 pPager->origDbSize = 0;
danielk197776572402004-06-25 02:38:54 +0000904 pPager->setMaster = 0;
danielk1977c4da5b92006-01-21 12:08:54 +0000905 pPager->needSync = 0;
906 pPager->pFirstSynced = pPager->pFirst;
drh9c105bb2004-10-02 20:38:28 +0000907 return rc;
drhed7c8552001-04-11 14:29:21 +0000908}
909
drhed7c8552001-04-11 14:29:21 +0000910/*
drh968af522003-02-11 14:55:40 +0000911** Compute and return a checksum for the page of data.
drh34e79ce2004-02-08 06:05:46 +0000912**
913** This is not a real checksum. It is really just the sum of the
drh726de592004-06-10 23:35:50 +0000914** random initial value and the page number. We experimented with
915** a checksum of the entire data, but that was found to be too slow.
916**
917** Note that the page number is stored at the beginning of data and
918** the checksum is stored at the end. This is important. If journal
919** corruption occurs due to a power failure, the most likely scenario
920** is that one end or the other of the record will be changed. It is
921** much less likely that the two ends of the journal record will be
922** correct and the middle be corrupt. Thus, this "checksum" scheme,
923** though fast and simple, catches the mostly likely kind of corruption.
924**
925** FIX ME: Consider adding every 200th (or so) byte of the data to the
926** checksum. That way if a single page spans 3 or more disk sectors and
927** only the middle sector is corrupt, we will still have a reasonable
928** chance of failing the checksum and thus detecting the problem.
drh968af522003-02-11 14:55:40 +0000929*/
drh74161702006-02-24 02:53:49 +0000930static u32 pager_cksum(Pager *pPager, const u8 *aData){
danielk1977ef317ab2004-06-23 10:43:10 +0000931 u32 cksum = pPager->cksumInit;
932 int i = pPager->pageSize-200;
933 while( i>0 ){
934 cksum += aData[i];
935 i -= 200;
936 }
drh968af522003-02-11 14:55:40 +0000937 return cksum;
938}
939
940/*
drhfa86c412002-02-02 15:01:15 +0000941** Read a single page from the journal file opened on file descriptor
942** jfd. Playback this one page.
drh968af522003-02-11 14:55:40 +0000943**
drh726de592004-06-10 23:35:50 +0000944** If useCksum==0 it means this journal does not use checksums. Checksums
945** are not used in statement journals because statement journals do not
946** need to survive power failures.
drhfa86c412002-02-02 15:01:15 +0000947*/
drhae2b40c2004-06-09 19:03:54 +0000948static int pager_playback_one_page(Pager *pPager, OsFile *jfd, int useCksum){
drhfa86c412002-02-02 15:01:15 +0000949 int rc;
drhae2b40c2004-06-09 19:03:54 +0000950 PgHdr *pPg; /* An existing page in the cache */
951 Pgno pgno; /* The page number of a page in journal */
952 u32 cksum; /* Checksum used for sanity checking */
drh90f5ecb2004-07-22 01:19:35 +0000953 u8 aData[SQLITE_MAX_PAGE_SIZE]; /* Temp storage for a page */
drhfa86c412002-02-02 15:01:15 +0000954
drh96362842005-03-20 22:47:56 +0000955 /* useCksum should be true for the main journal and false for
956 ** statement journals. Verify that this is always the case
957 */
drh9cbe6352005-11-29 03:13:21 +0000958 assert( jfd == (useCksum ? pPager->jfd : pPager->stfd) );
drh96362842005-03-20 22:47:56 +0000959
960
drhae2b40c2004-06-09 19:03:54 +0000961 rc = read32bits(jfd, &pgno);
drh99ee3602003-02-16 19:13:36 +0000962 if( rc!=SQLITE_OK ) return rc;
drh054889e2005-11-30 03:20:31 +0000963 rc = sqlite3OsRead(jfd, &aData, pPager->pageSize);
drh99ee3602003-02-16 19:13:36 +0000964 if( rc!=SQLITE_OK ) return rc;
danielk197776572402004-06-25 02:38:54 +0000965 pPager->journalOff += pPager->pageSize + 4;
drhfa86c412002-02-02 15:01:15 +0000966
drh968af522003-02-11 14:55:40 +0000967 /* Sanity checking on the page. This is more important that I originally
968 ** thought. If a power failure occurs while the journal is being written,
969 ** it could cause invalid data to be written into the journal. We need to
970 ** detect this invalid data (with high probability) and ignore it.
971 */
danielk197775edc162004-06-26 01:48:18 +0000972 if( pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh968af522003-02-11 14:55:40 +0000973 return SQLITE_DONE;
974 }
drhae2b40c2004-06-09 19:03:54 +0000975 if( pgno>(unsigned)pPager->dbSize ){
drh968af522003-02-11 14:55:40 +0000976 return SQLITE_OK;
977 }
drhae2b40c2004-06-09 19:03:54 +0000978 if( useCksum ){
979 rc = read32bits(jfd, &cksum);
drh99ee3602003-02-16 19:13:36 +0000980 if( rc ) return rc;
danielk197776572402004-06-25 02:38:54 +0000981 pPager->journalOff += 4;
drh74161702006-02-24 02:53:49 +0000982 if( pager_cksum(pPager, aData)!=cksum ){
drh968af522003-02-11 14:55:40 +0000983 return SQLITE_DONE;
984 }
985 }
drhfa86c412002-02-02 15:01:15 +0000986
danielk1977aa5ccdf2004-06-14 05:10:42 +0000987 assert( pPager->state==PAGER_RESERVED || pPager->state>=PAGER_EXCLUSIVE );
danielk1977a3f3a5f2004-06-10 04:32:16 +0000988
989 /* If the pager is in RESERVED state, then there must be a copy of this
990 ** page in the pager cache. In this case just update the pager cache,
danielk19770de0bb32004-06-10 05:59:24 +0000991 ** not the database file. The page is left marked dirty in this case.
992 **
danielk1977a3f3a5f2004-06-10 04:32:16 +0000993 ** If in EXCLUSIVE state, then we update the pager cache if it exists
994 ** and the main file. The page is then marked not dirty.
drh96362842005-03-20 22:47:56 +0000995 **
996 ** Ticket #1171: The statement journal might contain page content that is
997 ** different from the page content at the start of the transaction.
998 ** This occurs when a page is changed prior to the start of a statement
999 ** then changed again within the statement. When rolling back such a
1000 ** statement we must not write to the original database unless we know
1001 ** for certain that original page contents are in the main rollback
1002 ** journal. Otherwise, if a full ROLLBACK occurs after the statement
1003 ** rollback the full ROLLBACK will not restore the page to its original
1004 ** content. Two conditions must be met before writing to the database
1005 ** files. (1) the database must be locked. (2) we know that the original
1006 ** page content is in the main journal either because the page is not in
1007 ** cache or else it is marked as needSync==0.
drhfa86c412002-02-02 15:01:15 +00001008 */
drhae2b40c2004-06-09 19:03:54 +00001009 pPg = pager_lookup(pPager, pgno);
drh96362842005-03-20 22:47:56 +00001010 assert( pPager->state>=PAGER_EXCLUSIVE || pPg!=0 );
danielk1977ef73ee92004-11-06 12:26:07 +00001011 TRACE3("PLAYBACK %d page %d\n", PAGERID(pPager), pgno);
drh96362842005-03-20 22:47:56 +00001012 if( pPager->state>=PAGER_EXCLUSIVE && (pPg==0 || pPg->needSync==0) ){
drh054889e2005-11-30 03:20:31 +00001013 rc = sqlite3OsSeek(pPager->fd, (pgno-1)*(i64)pPager->pageSize);
drhb4746b92005-09-09 01:32:06 +00001014 if( rc==SQLITE_OK ){
drh054889e2005-11-30 03:20:31 +00001015 rc = sqlite3OsWrite(pPager->fd, aData, pPager->pageSize);
drhb4746b92005-09-09 01:32:06 +00001016 }
drh96362842005-03-20 22:47:56 +00001017 if( pPg ) pPg->dirty = 0;
danielk1977a3f3a5f2004-06-10 04:32:16 +00001018 }
drhfa86c412002-02-02 15:01:15 +00001019 if( pPg ){
danielk197728129562005-01-11 10:25:06 +00001020 /* No page should ever be explicitly rolled back that is in use, except
1021 ** for page 1 which is held in use in order to keep the lock on the
1022 ** database active. However such a page may be rolled back as a result
1023 ** of an internal error resulting in an automatic call to
1024 ** sqlite3pager_rollback().
drhacf4ac92003-12-17 23:57:34 +00001025 */
drhb6f41482004-05-14 01:58:11 +00001026 void *pData;
danielk197728129562005-01-11 10:25:06 +00001027 /* assert( pPg->nRef==0 || pPg->pgno==1 ); */
drhb6f41482004-05-14 01:58:11 +00001028 pData = PGHDR_TO_DATA(pPg);
drhae2b40c2004-06-09 19:03:54 +00001029 memcpy(pData, aData, pPager->pageSize);
drh726de592004-06-10 23:35:50 +00001030 if( pPager->xDestructor ){ /*** FIX ME: Should this be xReinit? ***/
drhb6f41482004-05-14 01:58:11 +00001031 pPager->xDestructor(pData, pPager->pageSize);
drhde647132004-05-07 17:57:49 +00001032 }
danielk19773c407372005-02-15 02:54:14 +00001033#ifdef SQLITE_CHECK_PAGES
drh96362842005-03-20 22:47:56 +00001034 pPg->pageHash = pager_pagehash(pPg);
danielk19773c407372005-02-15 02:54:14 +00001035#endif
drhc001c582006-03-06 18:23:16 +00001036 CODEC1(pPager, pData, pPg->pgno, 3);
drhfa86c412002-02-02 15:01:15 +00001037 }
1038 return rc;
1039}
1040
1041/*
danielk197713adf8a2004-06-03 16:08:41 +00001042** Parameter zMaster is the name of a master journal file. A single journal
1043** file that referred to the master journal file has just been rolled back.
1044** This routine checks if it is possible to delete the master journal file,
1045** and does so if it is.
drh726de592004-06-10 23:35:50 +00001046**
1047** The master journal file contains the names of all child journals.
1048** To tell if a master journal can be deleted, check to each of the
1049** children. If all children are either missing or do not refer to
1050** a different master journal, then this master journal can be deleted.
danielk197713adf8a2004-06-03 16:08:41 +00001051*/
1052static int pager_delmaster(const char *zMaster){
1053 int rc;
1054 int master_open = 0;
drh9cbe6352005-11-29 03:13:21 +00001055 OsFile *master = 0;
danielk197713adf8a2004-06-03 16:08:41 +00001056 char *zMasterJournal = 0; /* Contents of master journal file */
drheb206252004-10-01 02:00:31 +00001057 i64 nMasterJournal; /* Size of master journal file */
danielk197713adf8a2004-06-03 16:08:41 +00001058
1059 /* Open the master journal file exclusively in case some other process
1060 ** is running this routine also. Not that it makes too much difference.
1061 */
drh66560ad2006-01-06 14:32:19 +00001062 rc = sqlite3OsOpenReadOnly(zMaster, &master);
danielk197713adf8a2004-06-03 16:08:41 +00001063 if( rc!=SQLITE_OK ) goto delmaster_out;
1064 master_open = 1;
drh054889e2005-11-30 03:20:31 +00001065 rc = sqlite3OsFileSize(master, &nMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001066 if( rc!=SQLITE_OK ) goto delmaster_out;
1067
1068 if( nMasterJournal>0 ){
danielk19775865e3d2004-06-14 06:03:57 +00001069 char *zJournal;
danielk197776572402004-06-25 02:38:54 +00001070 char *zMasterPtr = 0;
danielk19775865e3d2004-06-14 06:03:57 +00001071
1072 /* Load the entire master journal file into space obtained from
1073 ** sqliteMalloc() and pointed to by zMasterJournal.
danielk19775865e3d2004-06-14 06:03:57 +00001074 */
danielk197776572402004-06-25 02:38:54 +00001075 zMasterJournal = (char *)sqliteMalloc(nMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001076 if( !zMasterJournal ){
1077 rc = SQLITE_NOMEM;
1078 goto delmaster_out;
1079 }
drh054889e2005-11-30 03:20:31 +00001080 rc = sqlite3OsRead(master, zMasterJournal, nMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001081 if( rc!=SQLITE_OK ) goto delmaster_out;
1082
danielk19775865e3d2004-06-14 06:03:57 +00001083 zJournal = zMasterJournal;
1084 while( (zJournal-zMasterJournal)<nMasterJournal ){
drh66560ad2006-01-06 14:32:19 +00001085 if( sqlite3OsFileExists(zJournal) ){
danielk197713adf8a2004-06-03 16:08:41 +00001086 /* One of the journals pointed to by the master journal exists.
1087 ** Open it and check if it points at the master journal. If
1088 ** so, return without deleting the master journal file.
1089 */
drh9cbe6352005-11-29 03:13:21 +00001090 OsFile *journal = 0;
drh3b7b78b2004-11-24 01:16:43 +00001091 int c;
danielk197713adf8a2004-06-03 16:08:41 +00001092
drh66560ad2006-01-06 14:32:19 +00001093 rc = sqlite3OsOpenReadOnly(zJournal, &journal);
danielk197713adf8a2004-06-03 16:08:41 +00001094 if( rc!=SQLITE_OK ){
danielk197713adf8a2004-06-03 16:08:41 +00001095 goto delmaster_out;
1096 }
danielk197713adf8a2004-06-03 16:08:41 +00001097
drh9cbe6352005-11-29 03:13:21 +00001098 rc = readMasterJournal(journal, &zMasterPtr);
drh054889e2005-11-30 03:20:31 +00001099 sqlite3OsClose(&journal);
danielk19779eed5052004-06-04 10:38:30 +00001100 if( rc!=SQLITE_OK ){
danielk19779eed5052004-06-04 10:38:30 +00001101 goto delmaster_out;
1102 }
danielk197776572402004-06-25 02:38:54 +00001103
drh3b7b78b2004-11-24 01:16:43 +00001104 c = zMasterPtr!=0 && strcmp(zMasterPtr, zMaster)==0;
1105 sqliteFree(zMasterPtr);
1106 if( c ){
danielk197776572402004-06-25 02:38:54 +00001107 /* We have a match. Do not delete the master journal file. */
1108 goto delmaster_out;
danielk197713adf8a2004-06-03 16:08:41 +00001109 }
1110 }
danielk19775865e3d2004-06-14 06:03:57 +00001111 zJournal += (strlen(zJournal)+1);
danielk197713adf8a2004-06-03 16:08:41 +00001112 }
1113 }
1114
drh66560ad2006-01-06 14:32:19 +00001115 sqlite3OsDelete(zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001116
1117delmaster_out:
1118 if( zMasterJournal ){
1119 sqliteFree(zMasterJournal);
1120 }
1121 if( master_open ){
drh054889e2005-11-30 03:20:31 +00001122 sqlite3OsClose(&master);
danielk197713adf8a2004-06-03 16:08:41 +00001123 }
1124 return rc;
1125}
1126
1127/*
drha6abd042004-06-09 17:37:22 +00001128** Make every page in the cache agree with what is on disk. In other words,
1129** reread the disk to reset the state of the cache.
1130**
1131** This routine is called after a rollback in which some of the dirty cache
1132** pages had never been written out to disk. We need to roll back the
1133** cache content and the easiest way to do that is to reread the old content
1134** back from the disk.
1135*/
1136static int pager_reload_cache(Pager *pPager){
1137 PgHdr *pPg;
1138 int rc = SQLITE_OK;
1139 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
drh90f5ecb2004-07-22 01:19:35 +00001140 char zBuf[SQLITE_MAX_PAGE_SIZE];
drha6abd042004-06-09 17:37:22 +00001141 if( !pPg->dirty ) continue;
1142 if( (int)pPg->pgno <= pPager->origDbSize ){
drh054889e2005-11-30 03:20:31 +00001143 rc = sqlite3OsSeek(pPager->fd, pPager->pageSize*(i64)(pPg->pgno-1));
drhb4746b92005-09-09 01:32:06 +00001144 if( rc==SQLITE_OK ){
drh054889e2005-11-30 03:20:31 +00001145 rc = sqlite3OsRead(pPager->fd, zBuf, pPager->pageSize);
drhb4746b92005-09-09 01:32:06 +00001146 }
danielk1977ef73ee92004-11-06 12:26:07 +00001147 TRACE3("REFETCH %d page %d\n", PAGERID(pPager), pPg->pgno);
drha6abd042004-06-09 17:37:22 +00001148 if( rc ) break;
drhc001c582006-03-06 18:23:16 +00001149 CODEC1(pPager, zBuf, pPg->pgno, 2);
drha6abd042004-06-09 17:37:22 +00001150 }else{
drh90f5ecb2004-07-22 01:19:35 +00001151 memset(zBuf, 0, pPager->pageSize);
drha6abd042004-06-09 17:37:22 +00001152 }
drh90f5ecb2004-07-22 01:19:35 +00001153 if( pPg->nRef==0 || memcmp(zBuf, PGHDR_TO_DATA(pPg), pPager->pageSize) ){
1154 memcpy(PGHDR_TO_DATA(pPg), zBuf, pPager->pageSize);
drha6abd042004-06-09 17:37:22 +00001155 if( pPager->xReiniter ){
1156 pPager->xReiniter(PGHDR_TO_DATA(pPg), pPager->pageSize);
1157 }else{
drh90f5ecb2004-07-22 01:19:35 +00001158 memset(PGHDR_TO_EXTRA(pPg, pPager), 0, pPager->nExtra);
drha6abd042004-06-09 17:37:22 +00001159 }
1160 }
1161 pPg->needSync = 0;
1162 pPg->dirty = 0;
danielk19773c407372005-02-15 02:54:14 +00001163#ifdef SQLITE_CHECK_PAGES
1164 pPg->pageHash = pager_pagehash(pPg);
1165#endif
drha6abd042004-06-09 17:37:22 +00001166 }
1167 return rc;
1168}
1169
drha6abd042004-06-09 17:37:22 +00001170/*
drhcb4c40b2004-08-18 19:09:43 +00001171** Truncate the main file of the given pager to the number of pages
1172** indicated.
1173*/
1174static int pager_truncate(Pager *pPager, int nPage){
danielk197717221812005-02-15 03:38:05 +00001175 assert( pPager->state>=PAGER_EXCLUSIVE );
drh054889e2005-11-30 03:20:31 +00001176 return sqlite3OsTruncate(pPager->fd, pPager->pageSize*(i64)nPage);
drhcb4c40b2004-08-18 19:09:43 +00001177}
1178
1179/*
drhed7c8552001-04-11 14:29:21 +00001180** Playback the journal and thus restore the database file to
1181** the state it was in before we started making changes.
1182**
drh34e79ce2004-02-08 06:05:46 +00001183** The journal file format is as follows:
1184**
drhae2b40c2004-06-09 19:03:54 +00001185** (1) 8 byte prefix. A copy of aJournalMagic[].
1186** (2) 4 byte big-endian integer which is the number of valid page records
drh34e79ce2004-02-08 06:05:46 +00001187** in the journal. If this value is 0xffffffff, then compute the
drhae2b40c2004-06-09 19:03:54 +00001188** number of page records from the journal size.
1189** (3) 4 byte big-endian integer which is the initial value for the
1190** sanity checksum.
1191** (4) 4 byte integer which is the number of pages to truncate the
drh34e79ce2004-02-08 06:05:46 +00001192** database to during a rollback.
drhae2b40c2004-06-09 19:03:54 +00001193** (5) 4 byte integer which is the number of bytes in the master journal
1194** name. The value may be zero (indicate that there is no master
1195** journal.)
1196** (6) N bytes of the master journal name. The name will be nul-terminated
1197** and might be shorter than the value read from (5). If the first byte
1198** of the name is \000 then there is no master journal. The master
1199** journal name is stored in UTF-8.
1200** (7) Zero or more pages instances, each as follows:
drh34e79ce2004-02-08 06:05:46 +00001201** + 4 byte page number.
drhae2b40c2004-06-09 19:03:54 +00001202** + pPager->pageSize bytes of data.
1203** + 4 byte checksum
drh34e79ce2004-02-08 06:05:46 +00001204**
drhae2b40c2004-06-09 19:03:54 +00001205** When we speak of the journal header, we mean the first 6 items above.
1206** Each entry in the journal is an instance of the 7th item.
drh34e79ce2004-02-08 06:05:46 +00001207**
1208** Call the value from the second bullet "nRec". nRec is the number of
1209** valid page entries in the journal. In most cases, you can compute the
1210** value of nRec from the size of the journal file. But if a power
1211** failure occurred while the journal was being written, it could be the
1212** case that the size of the journal file had already been increased but
1213** the extra entries had not yet made it safely to disk. In such a case,
1214** the value of nRec computed from the file size would be too large. For
1215** that reason, we always use the nRec value in the header.
1216**
1217** If the nRec value is 0xffffffff it means that nRec should be computed
1218** from the file size. This value is used when the user selects the
1219** no-sync option for the journal. A power failure could lead to corruption
1220** in this case. But for things like temporary table (which will be
1221** deleted when the power is restored) we don't care.
1222**
drhd9b02572001-04-15 00:37:09 +00001223** If the file opened as the journal file is not a well-formed
danielk1977ece80f12004-06-23 01:05:26 +00001224** journal file then all pages up to the first corrupted page are rolled
1225** back (or no pages if the journal header is corrupted). The journal file
1226** is then deleted and SQLITE_OK returned, just as if no corruption had
1227** been encountered.
1228**
1229** If an I/O or malloc() error occurs, the journal-file is not deleted
1230** and an error code is returned.
drhed7c8552001-04-11 14:29:21 +00001231*/
danielk197776572402004-06-25 02:38:54 +00001232static int pager_playback(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001233 i64 szJ; /* Size of the journal file in bytes */
danielk1977c3e8f5e2004-06-28 01:16:46 +00001234 u32 nRec; /* Number of Records in the journal */
drhd9b02572001-04-15 00:37:09 +00001235 int i; /* Loop counter */
1236 Pgno mxPg = 0; /* Size of the original file in pages */
drhae2b40c2004-06-09 19:03:54 +00001237 int rc; /* Result code of a subroutine */
danielk197713adf8a2004-06-03 16:08:41 +00001238 char *zMaster = 0; /* Name of master journal file if any */
drhed7c8552001-04-11 14:29:21 +00001239
drhc3a64ba2001-11-22 00:01:27 +00001240 /* Figure out how many records are in the journal. Abort early if
1241 ** the journal is empty.
drhed7c8552001-04-11 14:29:21 +00001242 */
drh8cfbf082001-09-19 13:22:39 +00001243 assert( pPager->journalOpen );
drh054889e2005-11-30 03:20:31 +00001244 rc = sqlite3OsFileSize(pPager->jfd, &szJ);
drhc3a64ba2001-11-22 00:01:27 +00001245 if( rc!=SQLITE_OK ){
1246 goto end_playback;
1247 }
drh240c5792004-02-08 00:40:52 +00001248
danielk197776572402004-06-25 02:38:54 +00001249 /* Read the master journal name from the journal, if it is present.
1250 ** If a master journal file name is specified, but the file is not
1251 ** present on disk, then the journal is not hot and does not need to be
1252 ** played back.
drh240c5792004-02-08 00:40:52 +00001253 */
drh9cbe6352005-11-29 03:13:21 +00001254 rc = readMasterJournal(pPager->jfd, &zMaster);
danielk197776572402004-06-25 02:38:54 +00001255 assert( rc!=SQLITE_DONE );
drh66560ad2006-01-06 14:32:19 +00001256 if( rc!=SQLITE_OK || (zMaster && !sqlite3OsFileExists(zMaster)) ){
danielk197776572402004-06-25 02:38:54 +00001257 sqliteFree(zMaster);
1258 zMaster = 0;
1259 if( rc==SQLITE_DONE ) rc = SQLITE_OK;
drhc3a64ba2001-11-22 00:01:27 +00001260 goto end_playback;
1261 }
drh054889e2005-11-30 03:20:31 +00001262 sqlite3OsSeek(pPager->jfd, 0);
danielk197776572402004-06-25 02:38:54 +00001263 pPager->journalOff = 0;
drhc3a64ba2001-11-22 00:01:27 +00001264
danielk197776572402004-06-25 02:38:54 +00001265 /* This loop terminates either when the readJournalHdr() call returns
1266 ** SQLITE_DONE or an IO error occurs. */
1267 while( 1 ){
drhae2b40c2004-06-09 19:03:54 +00001268
danielk197776572402004-06-25 02:38:54 +00001269 /* Read the next journal header from the journal file. If there are
1270 ** not enough bytes left in the journal file for a complete header, or
1271 ** it is corrupted, then a process must of failed while writing it.
1272 ** This indicates nothing more needs to be rolled back.
1273 */
1274 rc = readJournalHdr(pPager, szJ, &nRec, &mxPg);
1275 if( rc!=SQLITE_OK ){
drh968af522003-02-11 14:55:40 +00001276 if( rc==SQLITE_DONE ){
drh968af522003-02-11 14:55:40 +00001277 rc = SQLITE_OK;
1278 }
danielk197776572402004-06-25 02:38:54 +00001279 goto end_playback;
1280 }
1281
1282 /* If nRec is 0xffffffff, then this journal was created by a process
1283 ** working in no-sync mode. This means that the rest of the journal
1284 ** file consists of pages, there are no more journal headers. Compute
1285 ** the value of nRec based on this assumption.
1286 */
1287 if( nRec==0xffffffff ){
1288 assert( pPager->journalOff==JOURNAL_HDR_SZ(pPager) );
1289 nRec = (szJ - JOURNAL_HDR_SZ(pPager))/JOURNAL_PG_SZ(pPager);
1290 }
1291
1292 /* If this is the first header read from the journal, truncate the
1293 ** database file back to it's original size.
1294 */
danielk197717221812005-02-15 03:38:05 +00001295 if( pPager->state>=PAGER_EXCLUSIVE &&
1296 pPager->journalOff==JOURNAL_HDR_SZ(pPager) ){
danielk197776572402004-06-25 02:38:54 +00001297 assert( pPager->origDbSize==0 || pPager->origDbSize==mxPg );
drhcb4c40b2004-08-18 19:09:43 +00001298 rc = pager_truncate(pPager, mxPg);
danielk197776572402004-06-25 02:38:54 +00001299 if( rc!=SQLITE_OK ){
1300 goto end_playback;
1301 }
1302 pPager->dbSize = mxPg;
1303 }
1304
danielk197776572402004-06-25 02:38:54 +00001305 /* Copy original pages out of the journal and back into the database file.
1306 */
1307 for(i=0; i<nRec; i++){
drh9cbe6352005-11-29 03:13:21 +00001308 rc = pager_playback_one_page(pPager, pPager->jfd, 1);
danielk197776572402004-06-25 02:38:54 +00001309 if( rc!=SQLITE_OK ){
1310 if( rc==SQLITE_DONE ){
1311 rc = SQLITE_OK;
1312 pPager->journalOff = szJ;
1313 break;
1314 }else{
1315 goto end_playback;
1316 }
1317 }
drh968af522003-02-11 14:55:40 +00001318 }
drhed7c8552001-04-11 14:29:21 +00001319 }
drh580eeaf2006-02-24 03:09:37 +00001320 /*NOTREACHED*/
1321 assert( 0 );
drh4a0681e2003-02-13 01:58:20 +00001322
1323end_playback:
danielk19778191bff2004-06-28 04:52:30 +00001324 if( rc==SQLITE_OK ){
1325 rc = pager_unwritelock(pPager);
1326 }
danielk197713adf8a2004-06-03 16:08:41 +00001327 if( zMaster ){
1328 /* If there was a master journal and this routine will return true,
danielk197732554c12005-01-22 03:39:39 +00001329 ** see if it is possible to delete the master journal.
danielk197713adf8a2004-06-03 16:08:41 +00001330 */
1331 if( rc==SQLITE_OK ){
danielk197732554c12005-01-22 03:39:39 +00001332 rc = pager_delmaster(zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001333 }
1334 sqliteFree(zMaster);
1335 }
danielk197776572402004-06-25 02:38:54 +00001336
1337 /* The Pager.sectorSize variable may have been updated while rolling
1338 ** back a journal created by a process with a different PAGER_SECTOR_SIZE
1339 ** value. Reset it to the correct value for this process.
1340 */
1341 pPager->sectorSize = PAGER_SECTOR_SIZE;
drhd9b02572001-04-15 00:37:09 +00001342 return rc;
drhed7c8552001-04-11 14:29:21 +00001343}
1344
1345/*
drhac69b052004-05-12 13:30:07 +00001346** Playback the statement journal.
drhfa86c412002-02-02 15:01:15 +00001347**
1348** This is similar to playing back the transaction journal but with
1349** a few extra twists.
1350**
drh663fc632002-02-02 18:49:19 +00001351** (1) The number of pages in the database file at the start of
drhac69b052004-05-12 13:30:07 +00001352** the statement is stored in pPager->stmtSize, not in the
drh663fc632002-02-02 18:49:19 +00001353** journal file itself.
drhfa86c412002-02-02 15:01:15 +00001354**
drhac69b052004-05-12 13:30:07 +00001355** (2) In addition to playing back the statement journal, also
drhfa86c412002-02-02 15:01:15 +00001356** playback all pages of the transaction journal beginning
drhac69b052004-05-12 13:30:07 +00001357** at offset pPager->stmtJSize.
drhfa86c412002-02-02 15:01:15 +00001358*/
drh3aac2dd2004-04-26 14:10:20 +00001359static int pager_stmt_playback(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001360 i64 szJ; /* Size of the full journal */
1361 i64 hdrOff;
drh968af522003-02-11 14:55:40 +00001362 int nRec; /* Number of Records */
drhfa86c412002-02-02 15:01:15 +00001363 int i; /* Loop counter */
1364 int rc;
1365
danielk197776572402004-06-25 02:38:54 +00001366 szJ = pPager->journalOff;
1367#ifndef NDEBUG
1368 {
drheb206252004-10-01 02:00:31 +00001369 i64 os_szJ;
drh054889e2005-11-30 03:20:31 +00001370 rc = sqlite3OsFileSize(pPager->jfd, &os_szJ);
danielk197776572402004-06-25 02:38:54 +00001371 if( rc!=SQLITE_OK ) return rc;
1372 assert( szJ==os_szJ );
1373 }
1374#endif
1375
1376 /* Set hdrOff to be the offset to the first journal header written
1377 ** this statement transaction, or the end of the file if no journal
1378 ** header was written.
1379 */
1380 hdrOff = pPager->stmtHdrOff;
1381 assert( pPager->fullSync || !hdrOff );
1382 if( !hdrOff ){
1383 hdrOff = szJ;
1384 }
1385
drhfa86c412002-02-02 15:01:15 +00001386 /* Truncate the database back to its original size.
1387 */
danielk197717221812005-02-15 03:38:05 +00001388 if( pPager->state>=PAGER_EXCLUSIVE ){
1389 rc = pager_truncate(pPager, pPager->stmtSize);
1390 }
drhac69b052004-05-12 13:30:07 +00001391 pPager->dbSize = pPager->stmtSize;
drhfa86c412002-02-02 15:01:15 +00001392
drhac69b052004-05-12 13:30:07 +00001393 /* Figure out how many records are in the statement journal.
drhfa86c412002-02-02 15:01:15 +00001394 */
drhac69b052004-05-12 13:30:07 +00001395 assert( pPager->stmtInUse && pPager->journalOpen );
drh054889e2005-11-30 03:20:31 +00001396 sqlite3OsSeek(pPager->stfd, 0);
drhac69b052004-05-12 13:30:07 +00001397 nRec = pPager->stmtNRec;
drhfa86c412002-02-02 15:01:15 +00001398
drhac69b052004-05-12 13:30:07 +00001399 /* Copy original pages out of the statement journal and back into the
drhae2b40c2004-06-09 19:03:54 +00001400 ** database file. Note that the statement journal omits checksums from
1401 ** each record since power-failure recovery is not important to statement
1402 ** journals.
drhfa86c412002-02-02 15:01:15 +00001403 */
1404 for(i=nRec-1; i>=0; i--){
drh9cbe6352005-11-29 03:13:21 +00001405 rc = pager_playback_one_page(pPager, pPager->stfd, 0);
drh968af522003-02-11 14:55:40 +00001406 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001407 if( rc!=SQLITE_OK ) goto end_stmt_playback;
drhfa86c412002-02-02 15:01:15 +00001408 }
1409
danielk197776572402004-06-25 02:38:54 +00001410 /* Now roll some pages back from the transaction journal. Pager.stmtJSize
1411 ** was the size of the journal file when this statement was started, so
1412 ** everything after that needs to be rolled back, either into the
1413 ** database, the memory cache, or both.
1414 **
1415 ** If it is not zero, then Pager.stmtHdrOff is the offset to the start
1416 ** of the first journal header written during this statement transaction.
drhfa86c412002-02-02 15:01:15 +00001417 */
drh054889e2005-11-30 03:20:31 +00001418 rc = sqlite3OsSeek(pPager->jfd, pPager->stmtJSize);
drhfa86c412002-02-02 15:01:15 +00001419 if( rc!=SQLITE_OK ){
drh3aac2dd2004-04-26 14:10:20 +00001420 goto end_stmt_playback;
drhfa86c412002-02-02 15:01:15 +00001421 }
danielk197776572402004-06-25 02:38:54 +00001422 pPager->journalOff = pPager->stmtJSize;
danielk197775edc162004-06-26 01:48:18 +00001423 pPager->cksumInit = pPager->stmtCksum;
1424 assert( JOURNAL_HDR_SZ(pPager)<(pPager->pageSize+8) );
1425 while( pPager->journalOff <= (hdrOff-(pPager->pageSize+8)) ){
drh9cbe6352005-11-29 03:13:21 +00001426 rc = pager_playback_one_page(pPager, pPager->jfd, 1);
danielk197776572402004-06-25 02:38:54 +00001427 assert( rc!=SQLITE_DONE );
1428 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1429 }
1430
1431 while( pPager->journalOff < szJ ){
danielk1977f0113002006-01-24 12:09:17 +00001432 u32 nJRec; /* Number of Journal Records */
danielk197776572402004-06-25 02:38:54 +00001433 u32 dummy;
danielk1977f0113002006-01-24 12:09:17 +00001434 rc = readJournalHdr(pPager, szJ, &nJRec, &dummy);
drh968af522003-02-11 14:55:40 +00001435 if( rc!=SQLITE_OK ){
1436 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001437 goto end_stmt_playback;
drh968af522003-02-11 14:55:40 +00001438 }
danielk1977f0113002006-01-24 12:09:17 +00001439 if( nJRec==0 ){
1440 nJRec = (szJ - pPager->journalOff) / (pPager->pageSize+8);
danielk197775edc162004-06-26 01:48:18 +00001441 }
danielk1977f0113002006-01-24 12:09:17 +00001442 for(i=nJRec-1; i>=0 && pPager->journalOff < szJ; i--){
drh9cbe6352005-11-29 03:13:21 +00001443 rc = pager_playback_one_page(pPager, pPager->jfd, 1);
danielk197776572402004-06-25 02:38:54 +00001444 assert( rc!=SQLITE_DONE );
1445 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1446 }
drhfa86c412002-02-02 15:01:15 +00001447 }
danielk197776572402004-06-25 02:38:54 +00001448
1449 pPager->journalOff = szJ;
drhfa86c412002-02-02 15:01:15 +00001450
drh3aac2dd2004-04-26 14:10:20 +00001451end_stmt_playback:
danielk19778a7aea32006-01-23 15:25:48 +00001452 if( rc==SQLITE_OK) {
danielk197775edc162004-06-26 01:48:18 +00001453 pPager->journalOff = szJ;
1454 /* pager_reload_cache(pPager); */
drhfa86c412002-02-02 15:01:15 +00001455 }
1456 return rc;
1457}
1458
1459/*
drhf57b14a2001-09-14 18:54:08 +00001460** Change the maximum number of in-memory pages that are allowed.
1461*/
drh3aac2dd2004-04-26 14:10:20 +00001462void sqlite3pager_set_cachesize(Pager *pPager, int mxPage){
drhf57b14a2001-09-14 18:54:08 +00001463 if( mxPage>10 ){
1464 pPager->mxPage = mxPage;
danielk1977ef317ab2004-06-23 10:43:10 +00001465 }else{
1466 pPager->mxPage = 10;
drhf57b14a2001-09-14 18:54:08 +00001467 }
1468}
1469
1470/*
drh973b6e32003-02-12 14:09:42 +00001471** Adjust the robustness of the database to damage due to OS crashes
1472** or power failures by changing the number of syncs()s when writing
1473** the rollback journal. There are three levels:
1474**
drh054889e2005-11-30 03:20:31 +00001475** OFF sqlite3OsSync() is never called. This is the default
drh973b6e32003-02-12 14:09:42 +00001476** for temporary and transient files.
1477**
1478** NORMAL The journal is synced once before writes begin on the
1479** database. This is normally adequate protection, but
1480** it is theoretically possible, though very unlikely,
1481** that an inopertune power failure could leave the journal
1482** in a state which would cause damage to the database
1483** when it is rolled back.
1484**
1485** FULL The journal is synced twice before writes begin on the
drh34e79ce2004-02-08 06:05:46 +00001486** database (with some additional information - the nRec field
1487** of the journal header - being written in between the two
1488** syncs). If we assume that writing a
drh973b6e32003-02-12 14:09:42 +00001489** single disk sector is atomic, then this mode provides
1490** assurance that the journal will not be corrupted to the
1491** point of causing damage to the database during rollback.
1492**
1493** Numeric values associated with these states are OFF==1, NORMAL=2,
1494** and FULL=3.
1495*/
danielk197793758c82005-01-21 08:13:14 +00001496#ifndef SQLITE_OMIT_PAGER_PRAGMAS
drhac530b12006-02-11 01:25:50 +00001497void sqlite3pager_set_safety_level(Pager *pPager, int level, int full_fsync){
drh973b6e32003-02-12 14:09:42 +00001498 pPager->noSync = level==1 || pPager->tempFile;
1499 pPager->fullSync = level==3 && !pPager->tempFile;
drhac530b12006-02-11 01:25:50 +00001500 pPager->full_fsync = full_fsync;
danielk19771d850a72004-05-31 08:26:49 +00001501 if( pPager->noSync ) pPager->needSync = 0;
drh973b6e32003-02-12 14:09:42 +00001502}
danielk197793758c82005-01-21 08:13:14 +00001503#endif
drh973b6e32003-02-12 14:09:42 +00001504
1505/*
drhaf6df112005-06-07 02:12:30 +00001506** The following global variable is incremented whenever the library
1507** attempts to open a temporary file. This information is used for
1508** testing and analysis only.
1509*/
1510int sqlite3_opentemp_count = 0;
1511
1512/*
1513** Open a temporary file. Write the name of the file into zFile
1514** (zFile must be at least SQLITE_TEMPNAME_SIZE bytes long.) Write
drhfa86c412002-02-02 15:01:15 +00001515** the file descriptor into *fd. Return SQLITE_OK on success or some
1516** other error code if we fail.
1517**
1518** The OS will automatically delete the temporary file when it is
1519** closed.
1520*/
drh9cbe6352005-11-29 03:13:21 +00001521static int sqlite3pager_opentemp(char *zFile, OsFile **pFd){
drhfa86c412002-02-02 15:01:15 +00001522 int cnt = 8;
1523 int rc;
drhaf6df112005-06-07 02:12:30 +00001524 sqlite3_opentemp_count++; /* Used for testing and analysis only */
drhfa86c412002-02-02 15:01:15 +00001525 do{
1526 cnt--;
drh66560ad2006-01-06 14:32:19 +00001527 sqlite3OsTempFileName(zFile);
1528 rc = sqlite3OsOpenExclusive(zFile, pFd, 1);
danielk197713073932004-06-30 11:54:06 +00001529 }while( cnt>0 && rc!=SQLITE_OK && rc!=SQLITE_NOMEM );
drhfa86c412002-02-02 15:01:15 +00001530 return rc;
1531}
1532
1533/*
drhed7c8552001-04-11 14:29:21 +00001534** Create a new page cache and put a pointer to the page cache in *ppPager.
drh5e00f6c2001-09-13 13:46:56 +00001535** The file to be cached need not exist. The file is not locked until
drh3aac2dd2004-04-26 14:10:20 +00001536** the first call to sqlite3pager_get() and is only held open until the
1537** last page is released using sqlite3pager_unref().
drh382c0242001-10-06 16:33:02 +00001538**
drh6446c4d2001-12-15 14:22:18 +00001539** If zFilename is NULL then a randomly-named temporary file is created
1540** and used as the file to be cached. The file will be deleted
1541** automatically when it is closed.
drh90f5ecb2004-07-22 01:19:35 +00001542**
1543** If zFilename is ":memory:" then all information is held in cache.
1544** It is never written to disk. This can be used to implement an
1545** in-memory database.
drhed7c8552001-04-11 14:29:21 +00001546*/
drh3aac2dd2004-04-26 14:10:20 +00001547int sqlite3pager_open(
drh7e3b0a02001-04-28 16:52:40 +00001548 Pager **ppPager, /* Return the Pager structure here */
1549 const char *zFilename, /* Name of the database file to open */
drhda47d772002-12-02 04:25:19 +00001550 int nExtra, /* Extra bytes append to each in-memory page */
drh7bec5052005-02-06 02:45:41 +00001551 int flags /* flags controlling this file */
drh7e3b0a02001-04-28 16:52:40 +00001552){
danielk1977aef0bf62005-12-30 16:28:01 +00001553 Pager *pPager = 0;
danielk19778def5ea2004-06-16 10:39:52 +00001554 char *zFullPathname = 0;
drh02afc862006-01-20 18:10:57 +00001555 int nameLen; /* Compiler is wrong. This is always initialized before use */
drh9cbe6352005-11-29 03:13:21 +00001556 OsFile *fd;
danielk1977cfe9a692004-06-16 12:00:29 +00001557 int rc = SQLITE_OK;
1558 int i;
danielk19778def5ea2004-06-16 10:39:52 +00001559 int tempFile = 0;
drhac69b052004-05-12 13:30:07 +00001560 int memDb = 0;
drh5e00f6c2001-09-13 13:46:56 +00001561 int readOnly = 0;
drh7bec5052005-02-06 02:45:41 +00001562 int useJournal = (flags & PAGER_OMIT_JOURNAL)==0;
1563 int noReadlock = (flags & PAGER_NO_READLOCK)!=0;
drh8cfbf082001-09-19 13:22:39 +00001564 char zTemp[SQLITE_TEMPNAME_SIZE];
drh6f7adc82006-01-11 21:41:20 +00001565#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
danielk197754f01982006-01-18 15:25:17 +00001566 /* A malloc() cannot fail in sqlite3ThreadData() as one or more calls to
1567 ** malloc() must have already been made by this thread before it gets
1568 ** to this point. This means the ThreadData must have been allocated already
1569 ** so that ThreadData.nAlloc can be set. It would be nice to assert
1570 ** that ThreadData.nAlloc is non-zero, but alas this breaks test cases
1571 ** written to invoke the pager directly.
1572 */
danielk19778212def2006-01-16 15:32:23 +00001573 ThreadData *pTsd = sqlite3ThreadData();
danielk197754f01982006-01-18 15:25:17 +00001574 assert( pTsd );
danielk197752622822006-01-09 09:59:49 +00001575#endif
drhed7c8552001-04-11 14:29:21 +00001576
danielk1977aef0bf62005-12-30 16:28:01 +00001577 /* If malloc() has already failed return SQLITE_NOMEM. Before even
1578 ** testing for this, set *ppPager to NULL so the caller knows the pager
1579 ** structure was never allocated.
1580 */
drhd9b02572001-04-15 00:37:09 +00001581 *ppPager = 0;
danielk19779e128002006-01-18 16:51:35 +00001582 if( sqlite3MallocFailed() ){
drhd9b02572001-04-15 00:37:09 +00001583 return SQLITE_NOMEM;
1584 }
danielk1977aef0bf62005-12-30 16:28:01 +00001585 memset(&fd, 0, sizeof(fd));
1586
1587 /* Open the pager file and set zFullPathname to point at malloc()ed
1588 ** memory containing the complete filename (i.e. including the directory).
1589 */
drh901afd42003-08-26 11:25:58 +00001590 if( zFilename && zFilename[0] ){
drhb7f91642004-10-31 02:22:47 +00001591#ifndef SQLITE_OMIT_MEMORYDB
drhac69b052004-05-12 13:30:07 +00001592 if( strcmp(zFilename,":memory:")==0 ){
1593 memDb = 1;
drhda71ce12004-06-21 18:14:45 +00001594 zFullPathname = sqliteStrDup("");
drhb7f91642004-10-31 02:22:47 +00001595 }else
1596#endif
1597 {
drh66560ad2006-01-06 14:32:19 +00001598 zFullPathname = sqlite3OsFullPathname(zFilename);
danielk19778def5ea2004-06-16 10:39:52 +00001599 if( zFullPathname ){
drh66560ad2006-01-06 14:32:19 +00001600 rc = sqlite3OsOpenReadWrite(zFullPathname, &fd, &readOnly);
danielk19778def5ea2004-06-16 10:39:52 +00001601 }
drhac69b052004-05-12 13:30:07 +00001602 }
drh5e00f6c2001-09-13 13:46:56 +00001603 }else{
drh3aac2dd2004-04-26 14:10:20 +00001604 rc = sqlite3pager_opentemp(zTemp, &fd);
drh5e00f6c2001-09-13 13:46:56 +00001605 zFilename = zTemp;
drh66560ad2006-01-06 14:32:19 +00001606 zFullPathname = sqlite3OsFullPathname(zFilename);
danielk19778def5ea2004-06-16 10:39:52 +00001607 if( rc==SQLITE_OK ){
1608 tempFile = 1;
1609 }
drh5e00f6c2001-09-13 13:46:56 +00001610 }
danielk1977aef0bf62005-12-30 16:28:01 +00001611
1612 /* Allocate the Pager structure. As part of the same allocation, allocate
1613 ** space for the full paths of the file, directory and journal
1614 ** (Pager.zFilename, Pager.zDirectory and Pager.zJournal).
1615 */
1616 if( zFullPathname ){
1617 nameLen = strlen(zFullPathname);
1618 pPager = sqliteMalloc( sizeof(*pPager) + nameLen*3 + 30 );
drh3e7a6092002-12-07 21:45:14 +00001619 }
danielk1977aef0bf62005-12-30 16:28:01 +00001620
1621 /* If an error occured in either of the blocks above, free the memory
1622 ** pointed to by zFullPathname, free the Pager structure and close the
1623 ** file. Since the pager is not allocated there is no need to set
1624 ** any Pager.errMask variables.
1625 */
1626 if( !pPager || !zFullPathname || rc!=SQLITE_OK ){
drh054889e2005-11-30 03:20:31 +00001627 sqlite3OsClose(&fd);
drhda71ce12004-06-21 18:14:45 +00001628 sqliteFree(zFullPathname);
danielk1977aef0bf62005-12-30 16:28:01 +00001629 sqliteFree(pPager);
1630 return ((rc==SQLITE_OK)?SQLITE_NOMEM:rc);
drhed7c8552001-04-11 14:29:21 +00001631 }
danielk1977aef0bf62005-12-30 16:28:01 +00001632
danielk1977ef73ee92004-11-06 12:26:07 +00001633 TRACE3("OPEN %d %s\n", FILEHANDLEID(fd), zFullPathname);
drhed7c8552001-04-11 14:29:21 +00001634 pPager->zFilename = (char*)&pPager[1];
drha76c82e2003-07-27 18:59:42 +00001635 pPager->zDirectory = &pPager->zFilename[nameLen+1];
1636 pPager->zJournal = &pPager->zDirectory[nameLen+1];
drh3e7a6092002-12-07 21:45:14 +00001637 strcpy(pPager->zFilename, zFullPathname);
drha76c82e2003-07-27 18:59:42 +00001638 strcpy(pPager->zDirectory, zFullPathname);
danielk1977aef0bf62005-12-30 16:28:01 +00001639
drha76c82e2003-07-27 18:59:42 +00001640 for(i=nameLen; i>0 && pPager->zDirectory[i-1]!='/'; i--){}
1641 if( i>0 ) pPager->zDirectory[i-1] = 0;
drh3e7a6092002-12-07 21:45:14 +00001642 strcpy(pPager->zJournal, zFullPathname);
1643 sqliteFree(zFullPathname);
drhed7c8552001-04-11 14:29:21 +00001644 strcpy(&pPager->zJournal[nameLen], "-journal");
drh9cbe6352005-11-29 03:13:21 +00001645 pPager->fd = fd;
drh3b59a5c2006-01-15 20:28:28 +00001646 /* pPager->journalOpen = 0; */
drhac69b052004-05-12 13:30:07 +00001647 pPager->useJournal = useJournal && !memDb;
drh7bec5052005-02-06 02:45:41 +00001648 pPager->noReadlock = noReadlock && readOnly;
drh3b59a5c2006-01-15 20:28:28 +00001649 /* pPager->stmtOpen = 0; */
1650 /* pPager->stmtInUse = 0; */
1651 /* pPager->nRef = 0; */
drhac69b052004-05-12 13:30:07 +00001652 pPager->dbSize = memDb-1;
drh90f5ecb2004-07-22 01:19:35 +00001653 pPager->pageSize = SQLITE_DEFAULT_PAGE_SIZE;
drh3b59a5c2006-01-15 20:28:28 +00001654 /* pPager->stmtSize = 0; */
1655 /* pPager->stmtJSize = 0; */
1656 /* pPager->nPage = 0; */
1657 /* pPager->nMaxPage = 0; */
drh90f5ecb2004-07-22 01:19:35 +00001658 pPager->mxPage = 100;
drh3b59a5c2006-01-15 20:28:28 +00001659 assert( PAGER_UNLOCK==0 );
1660 /* pPager->state = PAGER_UNLOCK; */
1661 /* pPager->errMask = 0; */
drh5e00f6c2001-09-13 13:46:56 +00001662 pPager->tempFile = tempFile;
drhac69b052004-05-12 13:30:07 +00001663 pPager->memDb = memDb;
drh5e00f6c2001-09-13 13:46:56 +00001664 pPager->readOnly = readOnly;
drh3b59a5c2006-01-15 20:28:28 +00001665 /* pPager->needSync = 0; */
drhda47d772002-12-02 04:25:19 +00001666 pPager->noSync = pPager->tempFile || !useJournal;
danielk197775edc162004-06-26 01:48:18 +00001667 pPager->fullSync = (pPager->noSync?0:1);
drh3b59a5c2006-01-15 20:28:28 +00001668 /* pPager->pFirst = 0; */
1669 /* pPager->pFirstSynced = 0; */
1670 /* pPager->pLast = 0; */
drh887dc4c2004-10-22 16:22:57 +00001671 pPager->nExtra = FORCE_ALIGNMENT(nExtra);
danielk197776572402004-06-25 02:38:54 +00001672 pPager->sectorSize = PAGER_SECTOR_SIZE;
drh3b59a5c2006-01-15 20:28:28 +00001673 /* pPager->pBusyHandler = 0; */
1674 /* memset(pPager->aHash, 0, sizeof(pPager->aHash)); */
drhed7c8552001-04-11 14:29:21 +00001675 *ppPager = pPager;
drh6f7adc82006-01-11 21:41:20 +00001676#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
danielk19778212def2006-01-16 15:32:23 +00001677 pPager->pNext = pTsd->pPager;
1678 pTsd->pPager = pPager;
danielk197752622822006-01-09 09:59:49 +00001679#endif
drhed7c8552001-04-11 14:29:21 +00001680 return SQLITE_OK;
1681}
1682
1683/*
drh90f5ecb2004-07-22 01:19:35 +00001684** Set the busy handler function.
1685*/
1686void sqlite3pager_set_busyhandler(Pager *pPager, BusyHandler *pBusyHandler){
1687 pPager->pBusyHandler = pBusyHandler;
1688}
1689
1690/*
drh72f82862001-05-24 21:06:34 +00001691** Set the destructor for this pager. If not NULL, the destructor is called
drh5e00f6c2001-09-13 13:46:56 +00001692** when the reference count on each page reaches zero. The destructor can
1693** be used to clean up information in the extra segment appended to each page.
drh72f82862001-05-24 21:06:34 +00001694**
drh3aac2dd2004-04-26 14:10:20 +00001695** The destructor is not called as a result sqlite3pager_close().
1696** Destructors are only called by sqlite3pager_unref().
drh72f82862001-05-24 21:06:34 +00001697*/
drhb6f41482004-05-14 01:58:11 +00001698void sqlite3pager_set_destructor(Pager *pPager, void (*xDesc)(void*,int)){
drh72f82862001-05-24 21:06:34 +00001699 pPager->xDestructor = xDesc;
1700}
1701
1702/*
drha6abd042004-06-09 17:37:22 +00001703** Set the reinitializer for this pager. If not NULL, the reinitializer
1704** is called when the content of a page in cache is restored to its original
1705** value as a result of a rollback. The callback gives higher-level code
1706** an opportunity to restore the EXTRA section to agree with the restored
1707** page data.
1708*/
1709void sqlite3pager_set_reiniter(Pager *pPager, void (*xReinit)(void*,int)){
1710 pPager->xReiniter = xReinit;
1711}
1712
1713/*
drh1c7880e2005-05-20 20:01:55 +00001714** Set the page size. Return the new size. If the suggest new page
1715** size is inappropriate, then an alternative page size is selected
1716** and returned.
drh90f5ecb2004-07-22 01:19:35 +00001717*/
drh1c7880e2005-05-20 20:01:55 +00001718int sqlite3pager_set_pagesize(Pager *pPager, int pageSize){
drh90f5ecb2004-07-22 01:19:35 +00001719 assert( pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE );
drh1c7880e2005-05-20 20:01:55 +00001720 if( !pPager->memDb ){
1721 pPager->pageSize = pageSize;
1722 }
1723 return pPager->pageSize;
drh90f5ecb2004-07-22 01:19:35 +00001724}
1725
1726/*
drhc9ac5ca2005-11-04 22:03:30 +00001727** The following set of routines are used to disable the simulated
1728** I/O error mechanism. These routines are used to avoid simulated
1729** errors in places where we do not care about errors.
1730**
1731** Unless -DSQLITE_TEST=1 is used, these routines are all no-ops
1732** and generate no code.
1733*/
1734#ifdef SQLITE_TEST
1735extern int sqlite3_io_error_pending;
1736extern int sqlite3_io_error_hit;
1737static int saved_cnt;
1738void clear_simulated_io_error(){
1739 sqlite3_io_error_hit = 0;
1740}
1741void disable_simulated_io_errors(void){
1742 saved_cnt = sqlite3_io_error_pending;
1743 sqlite3_io_error_pending = -1;
1744}
1745void enable_simulated_io_errors(void){
1746 sqlite3_io_error_pending = saved_cnt;
1747}
1748#else
drh152410f2005-11-05 15:11:22 +00001749# define clear_simulated_io_error()
1750# define disable_simulated_io_errors()
1751# define enable_simulated_io_errors()
drhc9ac5ca2005-11-04 22:03:30 +00001752#endif
1753
1754/*
drh90f5ecb2004-07-22 01:19:35 +00001755** Read the first N bytes from the beginning of the file into memory
danielk1977aef0bf62005-12-30 16:28:01 +00001756** that pDest points to.
1757**
1758** No error checking is done. The rational for this is that this function
1759** may be called even if the file does not exist or contain a header. In
1760** these cases sqlite3OsRead() will return an error, to which the correct
1761** response is to zero the memory at pDest and continue. A real IO error
1762** will presumably recur and be picked up later (Todo: Think about this).
drh90f5ecb2004-07-22 01:19:35 +00001763*/
1764void sqlite3pager_read_fileheader(Pager *pPager, int N, unsigned char *pDest){
1765 memset(pDest, 0, N);
drhb7f91642004-10-31 02:22:47 +00001766 if( MEMDB==0 ){
danielk1977f2fa8312006-01-24 13:09:33 +00001767 disable_simulated_io_errors();
drh054889e2005-11-30 03:20:31 +00001768 sqlite3OsSeek(pPager->fd, 0);
1769 sqlite3OsRead(pPager->fd, pDest, N);
danielk1977f2fa8312006-01-24 13:09:33 +00001770 enable_simulated_io_errors();
drh90f5ecb2004-07-22 01:19:35 +00001771 }
1772}
1773
1774/*
drh5e00f6c2001-09-13 13:46:56 +00001775** Return the total number of pages in the disk file associated with
danielk197715f411d2005-09-16 10:18:45 +00001776** pPager.
1777**
1778** If the PENDING_BYTE lies on the page directly after the end of the
1779** file, then consider this page part of the file too. For example, if
1780** PENDING_BYTE is byte 4096 (the first byte of page 5) and the size of the
1781** file is 4096 bytes, 5 is returned instead of 4.
drhed7c8552001-04-11 14:29:21 +00001782*/
drh3aac2dd2004-04-26 14:10:20 +00001783int sqlite3pager_pagecount(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001784 i64 n;
drhd9b02572001-04-15 00:37:09 +00001785 assert( pPager!=0 );
drhed7c8552001-04-11 14:29:21 +00001786 if( pPager->dbSize>=0 ){
danielk197715f411d2005-09-16 10:18:45 +00001787 n = pPager->dbSize;
1788 } else {
drh054889e2005-11-30 03:20:31 +00001789 if( sqlite3OsFileSize(pPager->fd, &n)!=SQLITE_OK ){
danielk1977efaaf572006-01-16 11:29:19 +00001790 pager_error(pPager, SQLITE_IOERR);
danielk197715f411d2005-09-16 10:18:45 +00001791 return 0;
1792 }
1793 if( n>0 && n<pPager->pageSize ){
1794 n = 1;
1795 }else{
1796 n /= pPager->pageSize;
1797 }
1798 if( pPager->state!=PAGER_UNLOCK ){
1799 pPager->dbSize = n;
1800 }
drhed7c8552001-04-11 14:29:21 +00001801 }
danielk197715f411d2005-09-16 10:18:45 +00001802 if( n==(PENDING_BYTE/pPager->pageSize) ){
drh1f595712004-06-15 01:40:29 +00001803 n++;
1804 }
drhed7c8552001-04-11 14:29:21 +00001805 return n;
1806}
1807
drhf07e7d52006-04-07 13:54:46 +00001808
1809#ifndef SQLITE_OMIT_MEMORYDB
1810/*
1811** Clear a PgHistory block
1812*/
1813static void clearHistory(PgHistory *pHist){
1814 sqliteFree(pHist->pOrig);
1815 sqliteFree(pHist->pStmt);
1816 pHist->pOrig = 0;
1817 pHist->pStmt = 0;
1818}
1819#else
1820#define clearHistory(x)
1821#endif
1822
drhed7c8552001-04-11 14:29:21 +00001823/*
drhf7c57532003-04-25 13:22:51 +00001824** Forward declaration
1825*/
danielk197776572402004-06-25 02:38:54 +00001826static int syncJournal(Pager*);
drhac69b052004-05-12 13:30:07 +00001827
1828/*
danielk1977f5fdda82004-11-03 08:44:05 +00001829** Unlink pPg from it's hash chain. Also set the page number to 0 to indicate
1830** that the page is not part of any hash chain. This is required because the
1831** sqlite3pager_movepage() routine can leave a page in the
1832** pNextFree/pPrevFree list that is not a part of any hash-chain.
1833*/
1834static void unlinkHashChain(Pager *pPager, PgHdr *pPg){
1835 if( pPg->pgno==0 ){
1836 /* If the page number is zero, then this page is not in any hash chain. */
1837 return;
1838 }
1839 if( pPg->pNextHash ){
1840 pPg->pNextHash->pPrevHash = pPg->pPrevHash;
1841 }
1842 if( pPg->pPrevHash ){
1843 assert( pPager->aHash[pager_hash(pPg->pgno)]!=pPg );
1844 pPg->pPrevHash->pNextHash = pPg->pNextHash;
1845 }else{
1846 int h = pager_hash(pPg->pgno);
1847 assert( pPager->aHash[h]==pPg );
1848 pPager->aHash[h] = pPg->pNextHash;
1849 }
drh5229ae42006-03-23 23:29:04 +00001850 if( MEMDB ){
drh5229ae42006-03-23 23:29:04 +00001851 clearHistory(PGHDR_TO_HIST(pPg, pPager));
1852 }
danielk1977f5fdda82004-11-03 08:44:05 +00001853 pPg->pgno = 0;
1854 pPg->pNextHash = pPg->pPrevHash = 0;
1855}
1856
1857/*
drhac69b052004-05-12 13:30:07 +00001858** Unlink a page from the free list (the list of all pages where nRef==0)
1859** and from its hash collision chain.
1860*/
1861static void unlinkPage(PgHdr *pPg){
1862 Pager *pPager = pPg->pPager;
1863
1864 /* Keep the pFirstSynced pointer pointing at the first synchronized page */
1865 if( pPg==pPager->pFirstSynced ){
1866 PgHdr *p = pPg->pNextFree;
1867 while( p && p->needSync ){ p = p->pNextFree; }
1868 pPager->pFirstSynced = p;
1869 }
1870
1871 /* Unlink from the freelist */
1872 if( pPg->pPrevFree ){
1873 pPg->pPrevFree->pNextFree = pPg->pNextFree;
1874 }else{
1875 assert( pPager->pFirst==pPg );
1876 pPager->pFirst = pPg->pNextFree;
1877 }
1878 if( pPg->pNextFree ){
1879 pPg->pNextFree->pPrevFree = pPg->pPrevFree;
1880 }else{
1881 assert( pPager->pLast==pPg );
1882 pPager->pLast = pPg->pPrevFree;
1883 }
1884 pPg->pNextFree = pPg->pPrevFree = 0;
1885
1886 /* Unlink from the pgno hash table */
danielk1977f5fdda82004-11-03 08:44:05 +00001887 unlinkHashChain(pPager, pPg);
drhac69b052004-05-12 13:30:07 +00001888}
1889
danielk1977b84f96f2005-01-20 11:32:23 +00001890#ifndef SQLITE_OMIT_MEMORYDB
drhac69b052004-05-12 13:30:07 +00001891/*
1892** This routine is used to truncate an in-memory database. Delete
danielk1977369f27e2004-06-15 11:40:04 +00001893** all pages whose pgno is larger than pPager->dbSize and is unreferenced.
drhac69b052004-05-12 13:30:07 +00001894** Referenced pages larger than pPager->dbSize are zeroed.
1895*/
1896static void memoryTruncate(Pager *pPager){
1897 PgHdr *pPg;
1898 PgHdr **ppPg;
1899 int dbSize = pPager->dbSize;
1900
1901 ppPg = &pPager->pAll;
1902 while( (pPg = *ppPg)!=0 ){
1903 if( pPg->pgno<=dbSize ){
1904 ppPg = &pPg->pNextAll;
1905 }else if( pPg->nRef>0 ){
1906 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
1907 ppPg = &pPg->pNextAll;
1908 }else{
1909 *ppPg = pPg->pNextAll;
1910 unlinkPage(pPg);
1911 sqliteFree(pPg);
1912 pPager->nPage--;
1913 }
1914 }
1915}
danielk1977b84f96f2005-01-20 11:32:23 +00001916#else
1917#define memoryTruncate(p)
1918#endif
drhac69b052004-05-12 13:30:07 +00001919
drhf7c57532003-04-25 13:22:51 +00001920/*
danielk197717221812005-02-15 03:38:05 +00001921** Try to obtain a lock on a file. Invoke the busy callback if the lock
drha4afb652005-07-09 02:16:02 +00001922** is currently not available. Repeat until the busy callback returns
danielk197717221812005-02-15 03:38:05 +00001923** false or until the lock succeeds.
1924**
1925** Return SQLITE_OK on success and an error code if we cannot obtain
1926** the lock.
1927*/
1928static int pager_wait_on_lock(Pager *pPager, int locktype){
1929 int rc;
1930 assert( PAGER_SHARED==SHARED_LOCK );
1931 assert( PAGER_RESERVED==RESERVED_LOCK );
1932 assert( PAGER_EXCLUSIVE==EXCLUSIVE_LOCK );
1933 if( pPager->state>=locktype ){
1934 rc = SQLITE_OK;
1935 }else{
danielk197717221812005-02-15 03:38:05 +00001936 do {
drh054889e2005-11-30 03:20:31 +00001937 rc = sqlite3OsLock(pPager->fd, locktype);
drha4afb652005-07-09 02:16:02 +00001938 }while( rc==SQLITE_BUSY && sqlite3InvokeBusyHandler(pPager->pBusyHandler) );
danielk197717221812005-02-15 03:38:05 +00001939 if( rc==SQLITE_OK ){
1940 pPager->state = locktype;
1941 }
1942 }
1943 return rc;
1944}
1945
1946/*
drhf7c57532003-04-25 13:22:51 +00001947** Truncate the file to the number of pages specified.
1948*/
drh3aac2dd2004-04-26 14:10:20 +00001949int sqlite3pager_truncate(Pager *pPager, Pgno nPage){
drhf7c57532003-04-25 13:22:51 +00001950 int rc;
drhdc3ff9c2004-08-18 02:10:15 +00001951 sqlite3pager_pagecount(pPager);
danielk1977efaaf572006-01-16 11:29:19 +00001952 if( pPager->errCode ){
1953 rc = pPager->errCode;
drh2e6d11b2003-04-25 15:37:57 +00001954 return rc;
1955 }
drh7d02cb72003-06-04 16:24:39 +00001956 if( nPage>=(unsigned)pPager->dbSize ){
drhf7c57532003-04-25 13:22:51 +00001957 return SQLITE_OK;
1958 }
drhb7f91642004-10-31 02:22:47 +00001959 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00001960 pPager->dbSize = nPage;
1961 memoryTruncate(pPager);
1962 return SQLITE_OK;
1963 }
danielk197776572402004-06-25 02:38:54 +00001964 rc = syncJournal(pPager);
danielk1977369f27e2004-06-15 11:40:04 +00001965 if( rc!=SQLITE_OK ){
1966 return rc;
1967 }
danielk197717221812005-02-15 03:38:05 +00001968
1969 /* Get an exclusive lock on the database before truncating. */
1970 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
1971 if( rc!=SQLITE_OK ){
1972 return rc;
1973 }
1974
drhcb4c40b2004-08-18 19:09:43 +00001975 rc = pager_truncate(pPager, nPage);
drhf7c57532003-04-25 13:22:51 +00001976 if( rc==SQLITE_OK ){
1977 pPager->dbSize = nPage;
1978 }
1979 return rc;
1980}
1981
1982/*
drhed7c8552001-04-11 14:29:21 +00001983** Shutdown the page cache. Free all memory and close all files.
1984**
1985** If a transaction was in progress when this routine is called, that
1986** transaction is rolled back. All outstanding pages are invalidated
1987** and their memory is freed. Any attempt to use a page associated
1988** with this page cache after this function returns will likely
1989** result in a coredump.
danielk1977aef0bf62005-12-30 16:28:01 +00001990**
1991** This function always succeeds. If a transaction is active an attempt
1992** is made to roll it back. If an error occurs during the rollback
1993** a hot journal may be left in the filesystem but no error is returned
1994** to the caller.
drhed7c8552001-04-11 14:29:21 +00001995*/
drh3aac2dd2004-04-26 14:10:20 +00001996int sqlite3pager_close(Pager *pPager){
drhd9b02572001-04-15 00:37:09 +00001997 PgHdr *pPg, *pNext;
drh6f7adc82006-01-11 21:41:20 +00001998#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
danielk197754f01982006-01-18 15:25:17 +00001999 /* A malloc() cannot fail in sqlite3ThreadData() as one or more calls to
2000 ** malloc() must have already been made by this thread before it gets
2001 ** to this point. This means the ThreadData must have been allocated already
2002 ** so that ThreadData.nAlloc can be set.
2003 */
danielk19778212def2006-01-16 15:32:23 +00002004 ThreadData *pTsd = sqlite3ThreadData();
danielk197776e8d1a2006-01-18 18:22:43 +00002005 assert( pPager );
danielk197754f01982006-01-18 15:25:17 +00002006 assert( pTsd && pTsd->nAlloc );
danielk197713f72992005-12-18 08:51:22 +00002007#endif
2008
drhed7c8552001-04-11 14:29:21 +00002009 switch( pPager->state ){
drha6abd042004-06-09 17:37:22 +00002010 case PAGER_RESERVED:
danielk1977aa5ccdf2004-06-14 05:10:42 +00002011 case PAGER_SYNCED:
drha6abd042004-06-09 17:37:22 +00002012 case PAGER_EXCLUSIVE: {
danielk1977b3bce662005-01-29 08:32:43 +00002013 /* We ignore any IO errors that occur during the rollback
2014 ** operation. So disable IO error simulation so that testing
2015 ** works more easily.
2016 */
drhc9ac5ca2005-11-04 22:03:30 +00002017 disable_simulated_io_errors();
drh3aac2dd2004-04-26 14:10:20 +00002018 sqlite3pager_rollback(pPager);
drhc9ac5ca2005-11-04 22:03:30 +00002019 enable_simulated_io_errors();
drhb7f91642004-10-31 02:22:47 +00002020 if( !MEMDB ){
drh054889e2005-11-30 03:20:31 +00002021 sqlite3OsUnlock(pPager->fd, NO_LOCK);
drhac69b052004-05-12 13:30:07 +00002022 }
danielk1977efaaf572006-01-16 11:29:19 +00002023 assert( pPager->errCode || pPager->journalOpen==0 );
drhed7c8552001-04-11 14:29:21 +00002024 break;
2025 }
drha6abd042004-06-09 17:37:22 +00002026 case PAGER_SHARED: {
drhb7f91642004-10-31 02:22:47 +00002027 if( !MEMDB ){
drh054889e2005-11-30 03:20:31 +00002028 sqlite3OsUnlock(pPager->fd, NO_LOCK);
drhac69b052004-05-12 13:30:07 +00002029 }
drhed7c8552001-04-11 14:29:21 +00002030 break;
2031 }
2032 default: {
2033 /* Do nothing */
2034 break;
2035 }
2036 }
drhd9b02572001-04-15 00:37:09 +00002037 for(pPg=pPager->pAll; pPg; pPg=pNext){
danielk1977eac7a362004-06-16 07:45:24 +00002038#ifndef NDEBUG
drhb7f91642004-10-31 02:22:47 +00002039 if( MEMDB ){
danielk1977eac7a362004-06-16 07:45:24 +00002040 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
2041 assert( !pPg->alwaysRollback );
2042 assert( !pHist->pOrig );
2043 assert( !pHist->pStmt );
2044 }
2045#endif
drhd9b02572001-04-15 00:37:09 +00002046 pNext = pPg->pNextAll;
2047 sqliteFree(pPg);
drhed7c8552001-04-11 14:29:21 +00002048 }
danielk1977ef73ee92004-11-06 12:26:07 +00002049 TRACE2("CLOSE %d\n", PAGERID(pPager));
danielk1977efaaf572006-01-16 11:29:19 +00002050 assert( pPager->errCode || (pPager->journalOpen==0 && pPager->stmtOpen==0) );
danielk1977e94ddc92005-03-21 03:53:38 +00002051 if( pPager->journalOpen ){
drh054889e2005-11-30 03:20:31 +00002052 sqlite3OsClose(&pPager->jfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002053 }
drh88b01a12005-03-28 18:04:27 +00002054 sqliteFree(pPager->aInJournal);
danielk1977e94ddc92005-03-21 03:53:38 +00002055 if( pPager->stmtOpen ){
drh054889e2005-11-30 03:20:31 +00002056 sqlite3OsClose(&pPager->stfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002057 }
drh054889e2005-11-30 03:20:31 +00002058 sqlite3OsClose(&pPager->fd);
drh0f892532002-05-30 12:27:03 +00002059 /* Temp files are automatically deleted by the OS
2060 ** if( pPager->tempFile ){
drh66560ad2006-01-06 14:32:19 +00002061 ** sqlite3OsDelete(pPager->zFilename);
drh0f892532002-05-30 12:27:03 +00002062 ** }
2063 */
danielk1977aca790a2005-01-13 11:07:52 +00002064
drh6f7adc82006-01-11 21:41:20 +00002065#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
danielk1977aef0bf62005-12-30 16:28:01 +00002066 /* Remove the pager from the linked list of pagers starting at
danielk197752622822006-01-09 09:59:49 +00002067 ** ThreadData.pPager if memory-management is enabled.
danielk1977aef0bf62005-12-30 16:28:01 +00002068 */
danielk19778212def2006-01-16 15:32:23 +00002069 if( pPager==pTsd->pPager ){
2070 pTsd->pPager = pPager->pNext;
2071 }else{
2072 Pager *pTmp;
drh74161702006-02-24 02:53:49 +00002073 for(pTmp = pTsd->pPager; pTmp->pNext!=pPager; pTmp=pTmp->pNext){}
danielk19778212def2006-01-16 15:32:23 +00002074 pTmp->pNext = pPager->pNext;
danielk197713f72992005-12-18 08:51:22 +00002075 }
2076#endif
2077
drhed7c8552001-04-11 14:29:21 +00002078 sqliteFree(pPager);
2079 return SQLITE_OK;
2080}
2081
2082/*
drh5e00f6c2001-09-13 13:46:56 +00002083** Return the page number for the given page data.
drhed7c8552001-04-11 14:29:21 +00002084*/
drh3aac2dd2004-04-26 14:10:20 +00002085Pgno sqlite3pager_pagenumber(void *pData){
drhed7c8552001-04-11 14:29:21 +00002086 PgHdr *p = DATA_TO_PGHDR(pData);
2087 return p->pgno;
2088}
2089
2090/*
drhc8629a12004-05-08 20:07:40 +00002091** The page_ref() function increments the reference count for a page.
2092** If the page is currently on the freelist (the reference count is zero) then
drh7e3b0a02001-04-28 16:52:40 +00002093** remove it from the freelist.
drhc8629a12004-05-08 20:07:40 +00002094**
2095** For non-test systems, page_ref() is a macro that calls _page_ref()
2096** online of the reference count is zero. For test systems, page_ref()
2097** is a real function so that we can set breakpoints and trace it.
drh7e3b0a02001-04-28 16:52:40 +00002098*/
drh836faa42003-01-11 13:30:57 +00002099static void _page_ref(PgHdr *pPg){
drh7e3b0a02001-04-28 16:52:40 +00002100 if( pPg->nRef==0 ){
2101 /* The page is currently on the freelist. Remove it. */
drh341eae82003-01-21 02:39:36 +00002102 if( pPg==pPg->pPager->pFirstSynced ){
2103 PgHdr *p = pPg->pNextFree;
2104 while( p && p->needSync ){ p = p->pNextFree; }
2105 pPg->pPager->pFirstSynced = p;
2106 }
drh7e3b0a02001-04-28 16:52:40 +00002107 if( pPg->pPrevFree ){
2108 pPg->pPrevFree->pNextFree = pPg->pNextFree;
2109 }else{
2110 pPg->pPager->pFirst = pPg->pNextFree;
2111 }
2112 if( pPg->pNextFree ){
2113 pPg->pNextFree->pPrevFree = pPg->pPrevFree;
2114 }else{
2115 pPg->pPager->pLast = pPg->pPrevFree;
2116 }
2117 pPg->pPager->nRef++;
2118 }
2119 pPg->nRef++;
drhdd793422001-06-28 01:54:48 +00002120 REFINFO(pPg);
drhdf0b3b02001-06-23 11:36:20 +00002121}
danielk1977aca790a2005-01-13 11:07:52 +00002122#ifdef SQLITE_DEBUG
drhc8629a12004-05-08 20:07:40 +00002123 static void page_ref(PgHdr *pPg){
2124 if( pPg->nRef==0 ){
2125 _page_ref(pPg);
2126 }else{
2127 pPg->nRef++;
2128 REFINFO(pPg);
2129 }
2130 }
2131#else
2132# define page_ref(P) ((P)->nRef==0?_page_ref(P):(void)(P)->nRef++)
2133#endif
drhdf0b3b02001-06-23 11:36:20 +00002134
2135/*
2136** Increment the reference count for a page. The input pointer is
2137** a reference to the page data.
2138*/
drh3aac2dd2004-04-26 14:10:20 +00002139int sqlite3pager_ref(void *pData){
drhdf0b3b02001-06-23 11:36:20 +00002140 PgHdr *pPg = DATA_TO_PGHDR(pData);
2141 page_ref(pPg);
drh8c42ca92001-06-22 19:15:00 +00002142 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +00002143}
2144
2145/*
drh34e79ce2004-02-08 06:05:46 +00002146** Sync the journal. In other words, make sure all the pages that have
2147** been written to the journal have actually reached the surface of the
2148** disk. It is not safe to modify the original database file until after
2149** the journal has been synced. If the original database is modified before
2150** the journal is synced and a power failure occurs, the unsynced journal
2151** data would be lost and we would be unable to completely rollback the
2152** database changes. Database corruption would occur.
2153**
2154** This routine also updates the nRec field in the header of the journal.
2155** (See comments on the pager_playback() routine for additional information.)
2156** If the sync mode is FULL, two syncs will occur. First the whole journal
2157** is synced, then the nRec field is updated, then a second sync occurs.
drhb19a2bc2001-09-16 00:13:26 +00002158**
drh34e79ce2004-02-08 06:05:46 +00002159** For temporary databases, we do not care if we are able to rollback
2160** after a power failure, so sync occurs.
drhfa86c412002-02-02 15:01:15 +00002161**
drh34e79ce2004-02-08 06:05:46 +00002162** This routine clears the needSync field of every page current held in
2163** memory.
drh50e5dad2001-09-15 00:57:28 +00002164*/
danielk197776572402004-06-25 02:38:54 +00002165static int syncJournal(Pager *pPager){
drh50e5dad2001-09-15 00:57:28 +00002166 PgHdr *pPg;
2167 int rc = SQLITE_OK;
drh03eb96a2002-11-10 23:32:56 +00002168
2169 /* Sync the journal before modifying the main database
2170 ** (assuming there is a journal and it needs to be synced.)
2171 */
danielk197776572402004-06-25 02:38:54 +00002172 if( pPager->needSync ){
drhfa86c412002-02-02 15:01:15 +00002173 if( !pPager->tempFile ){
drhdb48ee02003-01-16 13:42:43 +00002174 assert( pPager->journalOpen );
drh946966f2004-02-25 02:20:41 +00002175 /* assert( !pPager->noSync ); // noSync might be set if synchronous
2176 ** was turned off after the transaction was started. Ticket #615 */
drh968af522003-02-11 14:55:40 +00002177#ifndef NDEBUG
2178 {
drh34e79ce2004-02-08 06:05:46 +00002179 /* Make sure the pPager->nRec counter we are keeping agrees
2180 ** with the nRec computed from the size of the journal file.
2181 */
drheb206252004-10-01 02:00:31 +00002182 i64 jSz;
drh054889e2005-11-30 03:20:31 +00002183 rc = sqlite3OsFileSize(pPager->jfd, &jSz);
drh968af522003-02-11 14:55:40 +00002184 if( rc!=0 ) return rc;
danielk197776572402004-06-25 02:38:54 +00002185 assert( pPager->journalOff==jSz );
drh968af522003-02-11 14:55:40 +00002186 }
2187#endif
drhae2b40c2004-06-09 19:03:54 +00002188 {
danielk197776572402004-06-25 02:38:54 +00002189 /* Write the nRec value into the journal file header. If in
2190 ** full-synchronous mode, sync the journal first. This ensures that
2191 ** all data has really hit the disk before nRec is updated to mark
2192 ** it as a candidate for rollback.
2193 */
drhd8d66e82003-02-12 02:10:15 +00002194 if( pPager->fullSync ){
danielk1977ef73ee92004-11-06 12:26:07 +00002195 TRACE2("SYNC journal of %d\n", PAGERID(pPager));
drh054889e2005-11-30 03:20:31 +00002196 rc = sqlite3OsSync(pPager->jfd, 0);
drhd8d66e82003-02-12 02:10:15 +00002197 if( rc!=0 ) return rc;
2198 }
drh054889e2005-11-30 03:20:31 +00002199 rc = sqlite3OsSeek(pPager->jfd,
drhb4746b92005-09-09 01:32:06 +00002200 pPager->journalHdr + sizeof(aJournalMagic));
2201 if( rc ) return rc;
drh9cbe6352005-11-29 03:13:21 +00002202 rc = write32bits(pPager->jfd, pPager->nRec);
drh99ee3602003-02-16 19:13:36 +00002203 if( rc ) return rc;
danielk197713adf8a2004-06-03 16:08:41 +00002204
drh054889e2005-11-30 03:20:31 +00002205 rc = sqlite3OsSeek(pPager->jfd, pPager->journalOff);
drhb4746b92005-09-09 01:32:06 +00002206 if( rc ) return rc;
drh968af522003-02-11 14:55:40 +00002207 }
danielk1977ef73ee92004-11-06 12:26:07 +00002208 TRACE2("SYNC journal of %d\n", PAGERID(pPager));
drhac530b12006-02-11 01:25:50 +00002209 rc = sqlite3OsSync(pPager->jfd, pPager->full_fsync);
drhfa86c412002-02-02 15:01:15 +00002210 if( rc!=0 ) return rc;
drhdb48ee02003-01-16 13:42:43 +00002211 pPager->journalStarted = 1;
drhfa86c412002-02-02 15:01:15 +00002212 }
drh50e5dad2001-09-15 00:57:28 +00002213 pPager->needSync = 0;
drh341eae82003-01-21 02:39:36 +00002214
2215 /* Erase the needSync flag from every page.
2216 */
2217 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2218 pPg->needSync = 0;
2219 }
2220 pPager->pFirstSynced = pPager->pFirst;
drh50e5dad2001-09-15 00:57:28 +00002221 }
drh03eb96a2002-11-10 23:32:56 +00002222
drh341eae82003-01-21 02:39:36 +00002223#ifndef NDEBUG
2224 /* If the Pager.needSync flag is clear then the PgHdr.needSync
2225 ** flag must also be clear for all pages. Verify that this
2226 ** invariant is true.
drh03eb96a2002-11-10 23:32:56 +00002227 */
drh341eae82003-01-21 02:39:36 +00002228 else{
2229 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2230 assert( pPg->needSync==0 );
2231 }
2232 assert( pPager->pFirstSynced==pPager->pFirst );
drh03eb96a2002-11-10 23:32:56 +00002233 }
drh341eae82003-01-21 02:39:36 +00002234#endif
drhdb48ee02003-01-16 13:42:43 +00002235
drh81a20f22001-10-12 17:30:04 +00002236 return rc;
drh50e5dad2001-09-15 00:57:28 +00002237}
2238
2239/*
drh2554f8b2003-01-22 01:26:44 +00002240** Given a list of pages (connected by the PgHdr.pDirty pointer) write
2241** every one of those pages out to the database file and mark them all
2242** as clean.
2243*/
2244static int pager_write_pagelist(PgHdr *pList){
2245 Pager *pPager;
2246 int rc;
2247
2248 if( pList==0 ) return SQLITE_OK;
2249 pPager = pList->pPager;
danielk19779eed5052004-06-04 10:38:30 +00002250
2251 /* At this point there may be either a RESERVED or EXCLUSIVE lock on the
2252 ** database file. If there is already an EXCLUSIVE lock, the following
drh054889e2005-11-30 03:20:31 +00002253 ** calls to sqlite3OsLock() are no-ops.
danielk19779eed5052004-06-04 10:38:30 +00002254 **
drha6abd042004-06-09 17:37:22 +00002255 ** Moving the lock from RESERVED to EXCLUSIVE actually involves going
2256 ** through an intermediate state PENDING. A PENDING lock prevents new
2257 ** readers from attaching to the database but is unsufficient for us to
2258 ** write. The idea of a PENDING lock is to prevent new readers from
2259 ** coming in while we wait for existing readers to clear.
danielk19779eed5052004-06-04 10:38:30 +00002260 **
drha6abd042004-06-09 17:37:22 +00002261 ** While the pager is in the RESERVED state, the original database file
2262 ** is unchanged and we can rollback without having to playback the
2263 ** journal into the original database file. Once we transition to
2264 ** EXCLUSIVE, it means the database file has been changed and any rollback
2265 ** will require a journal playback.
danielk19779eed5052004-06-04 10:38:30 +00002266 */
drh684917c2004-10-05 02:41:42 +00002267 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
danielk19779eed5052004-06-04 10:38:30 +00002268 if( rc!=SQLITE_OK ){
2269 return rc;
2270 }
2271
drh2554f8b2003-01-22 01:26:44 +00002272 while( pList ){
2273 assert( pList->dirty );
drh054889e2005-11-30 03:20:31 +00002274 rc = sqlite3OsSeek(pPager->fd, (pList->pgno-1)*(i64)pPager->pageSize);
drhb4746b92005-09-09 01:32:06 +00002275 if( rc ) return rc;
danielk1977687566d2004-11-02 12:56:41 +00002276 /* If there are dirty pages in the page cache with page numbers greater
2277 ** than Pager.dbSize, this means sqlite3pager_truncate() was called to
2278 ** make the file smaller (presumably by auto-vacuum code). Do not write
2279 ** any such pages to the file.
2280 */
2281 if( pList->pgno<=pPager->dbSize ){
drhc001c582006-03-06 18:23:16 +00002282 char *pData = CODEC2(pPager, PGHDR_TO_DATA(pList), pList->pgno, 6);
danielk1977ef73ee92004-11-06 12:26:07 +00002283 TRACE3("STORE %d page %d\n", PAGERID(pPager), pList->pgno);
drhc001c582006-03-06 18:23:16 +00002284 rc = sqlite3OsWrite(pPager->fd, pData, pPager->pageSize);
drhfcd35c72005-05-21 02:48:08 +00002285 TEST_INCR(pPager->nWrite);
danielk1977687566d2004-11-02 12:56:41 +00002286 }
2287#ifndef NDEBUG
2288 else{
danielk1977ef73ee92004-11-06 12:26:07 +00002289 TRACE3("NOSTORE %d page %d\n", PAGERID(pPager), pList->pgno);
danielk1977687566d2004-11-02 12:56:41 +00002290 }
2291#endif
drh2554f8b2003-01-22 01:26:44 +00002292 if( rc ) return rc;
2293 pList->dirty = 0;
danielk19773c407372005-02-15 02:54:14 +00002294#ifdef SQLITE_CHECK_PAGES
2295 pList->pageHash = pager_pagehash(pList);
2296#endif
drh2554f8b2003-01-22 01:26:44 +00002297 pList = pList->pDirty;
2298 }
2299 return SQLITE_OK;
2300}
2301
2302/*
2303** Collect every dirty page into a dirty list and
2304** return a pointer to the head of that list. All pages are
2305** collected even if they are still in use.
2306*/
2307static PgHdr *pager_get_all_dirty_pages(Pager *pPager){
2308 PgHdr *p, *pList;
2309 pList = 0;
2310 for(p=pPager->pAll; p; p=p->pNextAll){
2311 if( p->dirty ){
2312 p->pDirty = pList;
2313 pList = p;
2314 }
2315 }
2316 return pList;
2317}
2318
2319/*
drh165ffe92005-03-15 17:09:30 +00002320** Return TRUE if there is a hot journal on the given pager.
2321** A hot journal is one that needs to be played back.
2322**
2323** If the current size of the database file is 0 but a journal file
2324** exists, that is probably an old journal left over from a prior
2325** database with the same name. Just delete the journal.
2326*/
2327static int hasHotJournal(Pager *pPager){
2328 if( !pPager->useJournal ) return 0;
drh66560ad2006-01-06 14:32:19 +00002329 if( !sqlite3OsFileExists(pPager->zJournal) ) return 0;
drh054889e2005-11-30 03:20:31 +00002330 if( sqlite3OsCheckReservedLock(pPager->fd) ) return 0;
drh165ffe92005-03-15 17:09:30 +00002331 if( sqlite3pager_pagecount(pPager)==0 ){
drh66560ad2006-01-06 14:32:19 +00002332 sqlite3OsDelete(pPager->zJournal);
drh165ffe92005-03-15 17:09:30 +00002333 return 0;
2334 }else{
2335 return 1;
2336 }
2337}
2338
danielk19775591df52005-12-20 09:19:37 +00002339/*
danielk1977aef0bf62005-12-30 16:28:01 +00002340** Try to find a page in the cache that can be recycled.
2341**
2342** This routine may return SQLITE_IOERR, SQLITE_FULL or SQLITE_OK. It
danielk1977efaaf572006-01-16 11:29:19 +00002343** does not set the pPager->errCode variable.
danielk19775591df52005-12-20 09:19:37 +00002344*/
danielk197713f72992005-12-18 08:51:22 +00002345static int pager_recycle(Pager *pPager, int syncOk, PgHdr **ppPg){
2346 PgHdr *pPg;
2347 *ppPg = 0;
2348
2349 /* Find a page to recycle. Try to locate a page that does not
2350 ** require us to do an fsync() on the journal.
2351 */
2352 pPg = pPager->pFirstSynced;
2353
2354 /* If we could not find a page that does not require an fsync()
2355 ** on the journal file then fsync the journal file. This is a
2356 ** very slow operation, so we work hard to avoid it. But sometimes
2357 ** it can't be helped.
2358 */
danielk19775591df52005-12-20 09:19:37 +00002359 if( pPg==0 && pPager->pFirst && syncOk && !MEMDB){
danielk197713f72992005-12-18 08:51:22 +00002360 int rc = syncJournal(pPager);
2361 if( rc!=0 ){
danielk1977aef0bf62005-12-30 16:28:01 +00002362 return rc;
danielk197713f72992005-12-18 08:51:22 +00002363 }
2364 if( pPager->fullSync ){
2365 /* If in full-sync mode, write a new journal header into the
2366 ** journal file. This is done to avoid ever modifying a journal
2367 ** header that is involved in the rollback of pages that have
2368 ** already been written to the database (in case the header is
2369 ** trashed when the nRec field is updated).
2370 */
2371 pPager->nRec = 0;
2372 assert( pPager->journalOff > 0 );
2373 rc = writeJournalHdr(pPager);
2374 if( rc!=0 ){
danielk1977aef0bf62005-12-30 16:28:01 +00002375 return rc;
danielk197713f72992005-12-18 08:51:22 +00002376 }
2377 }
2378 pPg = pPager->pFirst;
2379 }
2380 if( pPg==0 ){
2381 return SQLITE_OK;
2382 }
2383
2384 assert( pPg->nRef==0 );
2385
2386 /* Write the page to the database file if it is dirty.
2387 */
2388 if( pPg->dirty ){
2389 int rc;
2390 assert( pPg->needSync==0 );
2391 pPg->pDirty = 0;
2392 rc = pager_write_pagelist( pPg );
2393 if( rc!=SQLITE_OK ){
danielk1977aef0bf62005-12-30 16:28:01 +00002394 return rc;
danielk197713f72992005-12-18 08:51:22 +00002395 }
2396 }
2397 assert( pPg->dirty==0 );
2398
2399 /* If the page we are recycling is marked as alwaysRollback, then
2400 ** set the global alwaysRollback flag, thus disabling the
2401 ** sqlite_dont_rollback() optimization for the rest of this transaction.
2402 ** It is necessary to do this because the page marked alwaysRollback
2403 ** might be reloaded at a later time but at that point we won't remember
2404 ** that is was marked alwaysRollback. This means that all pages must
2405 ** be marked as alwaysRollback from here on out.
2406 */
2407 if( pPg->alwaysRollback ){
2408 pPager->alwaysRollback = 1;
2409 }
2410
2411 /* Unlink the old page from the free list and the hash table
2412 */
2413 unlinkPage(pPg);
2414 TEST_INCR(pPager->nOvfl);
2415
2416 *ppPg = pPg;
2417 return SQLITE_OK;
2418}
2419
2420/*
2421** This function is called to free superfluous dynamically allocated memory
2422** held by the pager system. Memory in use by any SQLite pager allocated
2423** by the current thread may be sqliteFree()ed.
2424**
2425** nReq is the number of bytes of memory required. Once this much has
danielk19770190d1d2005-12-19 14:18:11 +00002426** been released, the function returns. A negative value for nReq means
2427** free as much memory as possible. The return value is the total number
danielk197713f72992005-12-18 08:51:22 +00002428** of bytes of memory released.
2429*/
drh6f7adc82006-01-11 21:41:20 +00002430#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
danielk197713f72992005-12-18 08:51:22 +00002431int sqlite3pager_release_memory(int nReq){
drh6f7adc82006-01-11 21:41:20 +00002432 const ThreadData *pTsdro = sqlite3ThreadDataReadOnly();
danielk19770190d1d2005-12-19 14:18:11 +00002433 Pager *p;
danielk197713f72992005-12-18 08:51:22 +00002434 int nReleased = 0;
2435 int i;
2436
drh29c636b2006-01-09 23:40:25 +00002437 /* If the the global mutex is held, this subroutine becomes a
2438 ** o-op; zero bytes of memory are freed. This is because
2439 ** some of the code invoked by this function may also
2440 ** try to obtain the mutex, resulting in a deadlock.
danielk1977441b09a2006-01-05 13:48:29 +00002441 */
drh757b04e2006-01-18 17:25:45 +00002442 if( sqlite3OsInMutex(0) ){
danielk1977441b09a2006-01-05 13:48:29 +00002443 return 0;
2444 }
2445
danielk197713f72992005-12-18 08:51:22 +00002446 /* Outermost loop runs for at most two iterations. First iteration we
2447 ** try to find memory that can be released without calling fsync(). Second
2448 ** iteration (which only runs if the first failed to free nReq bytes of
2449 ** memory) is permitted to call fsync(). This is of course much more
2450 ** expensive.
2451 */
drh29c636b2006-01-09 23:40:25 +00002452 for(i=0; i<=1; i++){
danielk197713f72992005-12-18 08:51:22 +00002453
2454 /* Loop through all the SQLite pagers opened by the current thread. */
drh6f7adc82006-01-11 21:41:20 +00002455 for(p=pTsdro->pPager; p && (nReq<0 || nReleased<nReq); p=p->pNext){
danielk197713f72992005-12-18 08:51:22 +00002456 PgHdr *pPg;
2457 int rc;
2458
2459 /* For each pager, try to free as many pages as possible (without
2460 ** calling fsync() if this is the first iteration of the outermost
2461 ** loop).
2462 */
danielk19770190d1d2005-12-19 14:18:11 +00002463 while( SQLITE_OK==(rc = pager_recycle(p, i, &pPg)) && pPg) {
danielk1977aef0bf62005-12-30 16:28:01 +00002464 /* We've found a page to free. At this point the page has been
danielk197713f72992005-12-18 08:51:22 +00002465 ** removed from the page hash-table, free-list and synced-list
danielk1977aef0bf62005-12-30 16:28:01 +00002466 ** (pFirstSynced). It is still in the all pages (pAll) list.
danielk197713f72992005-12-18 08:51:22 +00002467 ** Remove it from this list before freeing.
2468 **
2469 ** Todo: Check the Pager.pStmt list to make sure this is Ok. It
2470 ** probably is though.
2471 */
2472 PgHdr *pTmp;
danielk19770190d1d2005-12-19 14:18:11 +00002473 assert( pPg );
danielk1977aef0bf62005-12-30 16:28:01 +00002474 page_remove_from_stmt_list(pPg);
danielk19770190d1d2005-12-19 14:18:11 +00002475 if( pPg==p->pAll ){
2476 p->pAll = pPg->pNextAll;
danielk197713f72992005-12-18 08:51:22 +00002477 }else{
drh74161702006-02-24 02:53:49 +00002478 for( pTmp=p->pAll; pTmp->pNextAll!=pPg; pTmp=pTmp->pNextAll ){}
danielk197713f72992005-12-18 08:51:22 +00002479 pTmp->pNextAll = pPg->pNextAll;
2480 }
2481 nReleased += sqliteAllocSize(pPg);
2482 sqliteFree(pPg);
2483 }
2484
2485 if( rc!=SQLITE_OK ){
danielk1977aef0bf62005-12-30 16:28:01 +00002486 /* An error occured whilst writing to the database file or
2487 ** journal in pager_recycle(). The error is not returned to the
danielk1977efaaf572006-01-16 11:29:19 +00002488 ** caller of this function. Instead, set the Pager.errCode variable.
danielk1977aef0bf62005-12-30 16:28:01 +00002489 ** The error will be returned to the user (or users, in the case
2490 ** of a shared pager cache) of the pager for which the error occured.
danielk197713f72992005-12-18 08:51:22 +00002491 */
danielk1977aef0bf62005-12-30 16:28:01 +00002492 assert( rc==SQLITE_IOERR || rc==SQLITE_FULL );
2493 assert( p->state>=PAGER_RESERVED );
2494 pager_error(p, rc);
danielk197713f72992005-12-18 08:51:22 +00002495 }
2496 }
2497 }
danielk1977aef0bf62005-12-30 16:28:01 +00002498
danielk197713f72992005-12-18 08:51:22 +00002499 return nReleased;
2500}
drh6f7adc82006-01-11 21:41:20 +00002501#endif /* SQLITE_ENABLE_MEMORY_MANAGEMENT */
danielk197713f72992005-12-18 08:51:22 +00002502
drh165ffe92005-03-15 17:09:30 +00002503/*
drhd9b02572001-04-15 00:37:09 +00002504** Acquire a page.
2505**
drh58a11682001-11-10 13:51:08 +00002506** A read lock on the disk file is obtained when the first page is acquired.
drh5e00f6c2001-09-13 13:46:56 +00002507** This read lock is dropped when the last page is released.
drhd9b02572001-04-15 00:37:09 +00002508**
drh306dc212001-05-21 13:45:10 +00002509** A _get works for any page number greater than 0. If the database
2510** file is smaller than the requested page, then no actual disk
2511** read occurs and the memory image of the page is initialized to
2512** all zeros. The extra data appended to a page is always initialized
2513** to zeros the first time a page is loaded into memory.
2514**
drhd9b02572001-04-15 00:37:09 +00002515** The acquisition might fail for several reasons. In all cases,
2516** an appropriate error code is returned and *ppPage is set to NULL.
drh7e3b0a02001-04-28 16:52:40 +00002517**
drh3aac2dd2004-04-26 14:10:20 +00002518** See also sqlite3pager_lookup(). Both this routine and _lookup() attempt
drh7e3b0a02001-04-28 16:52:40 +00002519** to find a page in the in-memory cache first. If the page is not already
drh5e00f6c2001-09-13 13:46:56 +00002520** in memory, this routine goes to disk to read it in whereas _lookup()
drh7e3b0a02001-04-28 16:52:40 +00002521** just returns 0. This routine acquires a read-lock the first time it
2522** has to go to disk, and could also playback an old journal if necessary.
2523** Since _lookup() never goes to disk, it never has to deal with locks
2524** or journal files.
drhed7c8552001-04-11 14:29:21 +00002525*/
drh3aac2dd2004-04-26 14:10:20 +00002526int sqlite3pager_get(Pager *pPager, Pgno pgno, void **ppPage){
drhed7c8552001-04-11 14:29:21 +00002527 PgHdr *pPg;
drh165ffe92005-03-15 17:09:30 +00002528 int rc;
drhed7c8552001-04-11 14:29:21 +00002529
danielk197726836652005-01-17 01:33:13 +00002530 /* The maximum page number is 2^31. Return SQLITE_CORRUPT if a page
2531 ** number greater than this, or zero, is requested.
2532 */
drh267cb322005-09-16 17:16:52 +00002533 if( pgno>PAGER_MAX_PGNO || pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh49285702005-09-17 15:20:26 +00002534 return SQLITE_CORRUPT_BKPT;
danielk197726836652005-01-17 01:33:13 +00002535 }
2536
drhd9b02572001-04-15 00:37:09 +00002537 /* Make sure we have not hit any critical errors.
2538 */
drh836faa42003-01-11 13:30:57 +00002539 assert( pPager!=0 );
drh2e6d11b2003-04-25 15:37:57 +00002540 *ppPage = 0;
danielk1977efaaf572006-01-16 11:29:19 +00002541 if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
2542 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00002543 }
2544
danielk197713adf8a2004-06-03 16:08:41 +00002545 /* If this is the first page accessed, then get a SHARED lock
drhed7c8552001-04-11 14:29:21 +00002546 ** on the database file.
2547 */
drhb7f91642004-10-31 02:22:47 +00002548 if( pPager->nRef==0 && !MEMDB ){
drh7bec5052005-02-06 02:45:41 +00002549 if( !pPager->noReadlock ){
2550 rc = pager_wait_on_lock(pPager, SHARED_LOCK);
2551 if( rc!=SQLITE_OK ){
danielk1977aef0bf62005-12-30 16:28:01 +00002552 return pager_error(pPager, rc);
drh7bec5052005-02-06 02:45:41 +00002553 }
drhed7c8552001-04-11 14:29:21 +00002554 }
2555
danielk197713adf8a2004-06-03 16:08:41 +00002556 /* If a journal file exists, and there is no RESERVED lock on the
2557 ** database file, then it either needs to be played back or deleted.
drhed7c8552001-04-11 14:29:21 +00002558 */
drh165ffe92005-03-15 17:09:30 +00002559 if( hasHotJournal(pPager) ){
danielk197790ba3bd2004-06-25 08:32:25 +00002560 /* Get an EXCLUSIVE lock on the database file. At this point it is
2561 ** important that a RESERVED lock is not obtained on the way to the
2562 ** EXCLUSIVE lock. If it were, another process might open the
2563 ** database file, detect the RESERVED lock, and conclude that the
2564 ** database is safe to read while this process is still rolling it
2565 ** back.
2566 **
2567 ** Because the intermediate RESERVED lock is not requested, the
2568 ** second process will get to this point in the code and fail to
2569 ** obtain it's own EXCLUSIVE lock on the database file.
2570 */
drh054889e2005-11-30 03:20:31 +00002571 rc = sqlite3OsLock(pPager->fd, EXCLUSIVE_LOCK);
drha7fcb052001-12-14 15:09:55 +00002572 if( rc!=SQLITE_OK ){
drh054889e2005-11-30 03:20:31 +00002573 sqlite3OsUnlock(pPager->fd, NO_LOCK);
drha6abd042004-06-09 17:37:22 +00002574 pPager->state = PAGER_UNLOCK;
danielk1977aef0bf62005-12-30 16:28:01 +00002575 return pager_error(pPager, rc);
drha7fcb052001-12-14 15:09:55 +00002576 }
drha6abd042004-06-09 17:37:22 +00002577 pPager->state = PAGER_EXCLUSIVE;
drha7fcb052001-12-14 15:09:55 +00002578
drhe2227f02003-06-14 11:42:57 +00002579 /* Open the journal for reading only. Return SQLITE_BUSY if
2580 ** we are unable to open the journal file.
drhf57b3392001-10-08 13:22:32 +00002581 **
drhe2227f02003-06-14 11:42:57 +00002582 ** The journal file does not need to be locked itself. The
2583 ** journal file is never open unless the main database file holds
2584 ** a write lock, so there is never any chance of two or more
2585 ** processes opening the journal at the same time.
drhed7c8552001-04-11 14:29:21 +00002586 */
drh66560ad2006-01-06 14:32:19 +00002587 rc = sqlite3OsOpenReadOnly(pPager->zJournal, &pPager->jfd);
drha7fcb052001-12-14 15:09:55 +00002588 if( rc!=SQLITE_OK ){
drh054889e2005-11-30 03:20:31 +00002589 sqlite3OsUnlock(pPager->fd, NO_LOCK);
drha6abd042004-06-09 17:37:22 +00002590 pPager->state = PAGER_UNLOCK;
drhed7c8552001-04-11 14:29:21 +00002591 return SQLITE_BUSY;
2592 }
drha7fcb052001-12-14 15:09:55 +00002593 pPager->journalOpen = 1;
drhdb48ee02003-01-16 13:42:43 +00002594 pPager->journalStarted = 0;
danielk197776572402004-06-25 02:38:54 +00002595 pPager->journalOff = 0;
2596 pPager->setMaster = 0;
2597 pPager->journalHdr = 0;
drhed7c8552001-04-11 14:29:21 +00002598
2599 /* Playback and delete the journal. Drop the database write
2600 ** lock and reacquire the read lock.
2601 */
danielk197776572402004-06-25 02:38:54 +00002602 rc = pager_playback(pPager);
drhd9b02572001-04-15 00:37:09 +00002603 if( rc!=SQLITE_OK ){
danielk1977aef0bf62005-12-30 16:28:01 +00002604 return pager_error(pPager, rc);
drhd9b02572001-04-15 00:37:09 +00002605 }
drhed7c8552001-04-11 14:29:21 +00002606 }
2607 pPg = 0;
2608 }else{
2609 /* Search for page in cache */
drhd9b02572001-04-15 00:37:09 +00002610 pPg = pager_lookup(pPager, pgno);
drhb7f91642004-10-31 02:22:47 +00002611 if( MEMDB && pPager->state==PAGER_UNLOCK ){
drha6abd042004-06-09 17:37:22 +00002612 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00002613 }
drhed7c8552001-04-11 14:29:21 +00002614 }
2615 if( pPg==0 ){
drhd9b02572001-04-15 00:37:09 +00002616 /* The requested page is not in the page cache. */
drhed7c8552001-04-11 14:29:21 +00002617 int h;
drhfcd35c72005-05-21 02:48:08 +00002618 TEST_INCR(pPager->nMiss);
drhb7f91642004-10-31 02:22:47 +00002619 if( pPager->nPage<pPager->mxPage || pPager->pFirst==0 || MEMDB ){
drhed7c8552001-04-11 14:29:21 +00002620 /* Create a new page */
drh1c7880e2005-05-20 20:01:55 +00002621 pPg = sqliteMallocRaw( sizeof(*pPg) + pPager->pageSize
drhac69b052004-05-12 13:30:07 +00002622 + sizeof(u32) + pPager->nExtra
drhb7f91642004-10-31 02:22:47 +00002623 + MEMDB*sizeof(PgHistory) );
drhd9b02572001-04-15 00:37:09 +00002624 if( pPg==0 ){
drhd9b02572001-04-15 00:37:09 +00002625 return SQLITE_NOMEM;
2626 }
drh8c1238a2003-01-02 14:43:55 +00002627 memset(pPg, 0, sizeof(*pPg));
drhb7f91642004-10-31 02:22:47 +00002628 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00002629 memset(PGHDR_TO_HIST(pPg, pPager), 0, sizeof(PgHistory));
2630 }
drhed7c8552001-04-11 14:29:21 +00002631 pPg->pPager = pPager;
drhd9b02572001-04-15 00:37:09 +00002632 pPg->pNextAll = pPager->pAll;
drhd79caeb2001-04-15 02:27:24 +00002633 pPager->pAll = pPg;
drhd9b02572001-04-15 00:37:09 +00002634 pPager->nPage++;
danielk1977e94ddc92005-03-21 03:53:38 +00002635 if( pPager->nPage>pPager->nMaxPage ){
2636 assert( pPager->nMaxPage==(pPager->nPage-1) );
2637 pPager->nMaxPage++;
2638 }
drhed7c8552001-04-11 14:29:21 +00002639 }else{
danielk197713f72992005-12-18 08:51:22 +00002640 rc = pager_recycle(pPager, 1, &pPg);
2641 if( rc!=SQLITE_OK ){
danielk197775bab7d2006-01-23 13:09:45 +00002642 return rc;
drh50e5dad2001-09-15 00:57:28 +00002643 }
danielk197713f72992005-12-18 08:51:22 +00002644 assert(pPg) ;
drhed7c8552001-04-11 14:29:21 +00002645 }
2646 pPg->pgno = pgno;
drh1ab43002002-01-14 09:28:19 +00002647 if( pPager->aInJournal && (int)pgno<=pPager->origDbSize ){
danielk19774adee202004-05-08 08:23:19 +00002648 sqlite3CheckMemory(pPager->aInJournal, pgno/8);
drhdb48ee02003-01-16 13:42:43 +00002649 assert( pPager->journalOpen );
drh6019e162001-07-02 17:51:45 +00002650 pPg->inJournal = (pPager->aInJournal[pgno/8] & (1<<(pgno&7)))!=0;
drhdb48ee02003-01-16 13:42:43 +00002651 pPg->needSync = 0;
drh6019e162001-07-02 17:51:45 +00002652 }else{
2653 pPg->inJournal = 0;
drhdb48ee02003-01-16 13:42:43 +00002654 pPg->needSync = 0;
drh6019e162001-07-02 17:51:45 +00002655 }
drhac69b052004-05-12 13:30:07 +00002656 if( pPager->aInStmt && (int)pgno<=pPager->stmtSize
2657 && (pPager->aInStmt[pgno/8] & (1<<(pgno&7)))!=0 ){
drh3aac2dd2004-04-26 14:10:20 +00002658 page_add_to_stmt_list(pPg);
drhfa86c412002-02-02 15:01:15 +00002659 }else{
drh3aac2dd2004-04-26 14:10:20 +00002660 page_remove_from_stmt_list(pPg);
drhfa86c412002-02-02 15:01:15 +00002661 }
drhed7c8552001-04-11 14:29:21 +00002662 pPg->dirty = 0;
2663 pPg->nRef = 1;
drhdd793422001-06-28 01:54:48 +00002664 REFINFO(pPg);
danielk197775bab7d2006-01-23 13:09:45 +00002665
drhd9b02572001-04-15 00:37:09 +00002666 pPager->nRef++;
drh2e6d11b2003-04-25 15:37:57 +00002667 if( pPager->nExtra>0 ){
drh90f5ecb2004-07-22 01:19:35 +00002668 memset(PGHDR_TO_EXTRA(pPg, pPager), 0, pPager->nExtra);
drh2e6d11b2003-04-25 15:37:57 +00002669 }
danielk1977efaaf572006-01-16 11:29:19 +00002670 if( pPager->errCode ){
drh3aac2dd2004-04-26 14:10:20 +00002671 sqlite3pager_unref(PGHDR_TO_DATA(pPg));
danielk1977efaaf572006-01-16 11:29:19 +00002672 rc = pPager->errCode;
drh2e6d11b2003-04-25 15:37:57 +00002673 return rc;
2674 }
danielk197775bab7d2006-01-23 13:09:45 +00002675
2676 /* Populate the page with data, either by reading from the database
2677 ** file, or by setting the entire page to zero.
2678 */
drh3caf58e2006-01-30 22:48:44 +00002679 if( sqlite3pager_pagecount(pPager)<(int)pgno || MEMDB ){
drh90f5ecb2004-07-22 01:19:35 +00002680 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
drh306dc212001-05-21 13:45:10 +00002681 }else{
drhb7f91642004-10-31 02:22:47 +00002682 assert( MEMDB==0 );
drh054889e2005-11-30 03:20:31 +00002683 rc = sqlite3OsSeek(pPager->fd, (pgno-1)*(i64)pPager->pageSize);
drhb4746b92005-09-09 01:32:06 +00002684 if( rc==SQLITE_OK ){
drh054889e2005-11-30 03:20:31 +00002685 rc = sqlite3OsRead(pPager->fd, PGHDR_TO_DATA(pPg),
drh9c06c952005-11-26 00:25:00 +00002686 pPager->pageSize);
drhb4746b92005-09-09 01:32:06 +00002687 }
danielk1977ef73ee92004-11-06 12:26:07 +00002688 TRACE3("FETCH %d page %d\n", PAGERID(pPager), pPg->pgno);
drhc001c582006-03-06 18:23:16 +00002689 CODEC1(pPager, PGHDR_TO_DATA(pPg), pPg->pgno, 3);
drh81a20f22001-10-12 17:30:04 +00002690 if( rc!=SQLITE_OK ){
drheb206252004-10-01 02:00:31 +00002691 i64 fileSize;
danielk197797a227c2006-01-20 16:32:04 +00002692 int rc2 = sqlite3OsFileSize(pPager->fd, &fileSize);
2693 if( rc2!=SQLITE_OK || fileSize>=pgno*pPager->pageSize ){
2694 /* An IO error occured in one of the the sqlite3OsSeek() or
drh6245e0d2006-01-23 15:39:58 +00002695 ** sqlite3OsRead() calls above. */
danielk19777d3a6662006-01-23 16:21:05 +00002696 pPg->pgno = 0;
drh3aac2dd2004-04-26 14:10:20 +00002697 sqlite3pager_unref(PGHDR_TO_DATA(pPg));
danielk197797a227c2006-01-20 16:32:04 +00002698 return rc;
drh4e371ee2002-09-05 16:08:27 +00002699 }else{
drhc9ac5ca2005-11-04 22:03:30 +00002700 clear_simulated_io_error();
drh90f5ecb2004-07-22 01:19:35 +00002701 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
drh4e371ee2002-09-05 16:08:27 +00002702 }
danielk197742741be2005-01-08 12:42:39 +00002703 }else{
drhfcd35c72005-05-21 02:48:08 +00002704 TEST_INCR(pPager->nRead);
drh81a20f22001-10-12 17:30:04 +00002705 }
drh306dc212001-05-21 13:45:10 +00002706 }
danielk197775bab7d2006-01-23 13:09:45 +00002707
2708 /* Link the page into the page hash table */
2709 h = pager_hash(pgno);
2710 pPg->pNextHash = pPager->aHash[h];
2711 pPager->aHash[h] = pPg;
2712 if( pPg->pNextHash ){
2713 assert( pPg->pNextHash->pPrevHash==0 );
2714 pPg->pNextHash->pPrevHash = pPg;
2715 }
2716
danielk19773c407372005-02-15 02:54:14 +00002717#ifdef SQLITE_CHECK_PAGES
2718 pPg->pageHash = pager_pagehash(pPg);
2719#endif
drhed7c8552001-04-11 14:29:21 +00002720 }else{
drhd9b02572001-04-15 00:37:09 +00002721 /* The requested page is in the page cache. */
drhfcd35c72005-05-21 02:48:08 +00002722 TEST_INCR(pPager->nHit);
drhdf0b3b02001-06-23 11:36:20 +00002723 page_ref(pPg);
drhed7c8552001-04-11 14:29:21 +00002724 }
2725 *ppPage = PGHDR_TO_DATA(pPg);
2726 return SQLITE_OK;
2727}
2728
2729/*
drh7e3b0a02001-04-28 16:52:40 +00002730** Acquire a page if it is already in the in-memory cache. Do
2731** not read the page from disk. Return a pointer to the page,
2732** or 0 if the page is not in cache.
2733**
drh3aac2dd2004-04-26 14:10:20 +00002734** See also sqlite3pager_get(). The difference between this routine
2735** and sqlite3pager_get() is that _get() will go to the disk and read
drh7e3b0a02001-04-28 16:52:40 +00002736** in the page if the page is not already in cache. This routine
drh5e00f6c2001-09-13 13:46:56 +00002737** returns NULL if the page is not in cache or if a disk I/O error
2738** has ever happened.
drh7e3b0a02001-04-28 16:52:40 +00002739*/
drh3aac2dd2004-04-26 14:10:20 +00002740void *sqlite3pager_lookup(Pager *pPager, Pgno pgno){
drh7e3b0a02001-04-28 16:52:40 +00002741 PgHdr *pPg;
2742
drh836faa42003-01-11 13:30:57 +00002743 assert( pPager!=0 );
2744 assert( pgno!=0 );
danielk1977efaaf572006-01-16 11:29:19 +00002745 if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
drh7e3b0a02001-04-28 16:52:40 +00002746 return 0;
2747 }
drh7e3b0a02001-04-28 16:52:40 +00002748 pPg = pager_lookup(pPager, pgno);
2749 if( pPg==0 ) return 0;
drhdf0b3b02001-06-23 11:36:20 +00002750 page_ref(pPg);
drh7e3b0a02001-04-28 16:52:40 +00002751 return PGHDR_TO_DATA(pPg);
2752}
2753
2754/*
drhed7c8552001-04-11 14:29:21 +00002755** Release a page.
2756**
2757** If the number of references to the page drop to zero, then the
2758** page is added to the LRU list. When all references to all pages
drhd9b02572001-04-15 00:37:09 +00002759** are released, a rollback occurs and the lock on the database is
drhed7c8552001-04-11 14:29:21 +00002760** removed.
2761*/
drh3aac2dd2004-04-26 14:10:20 +00002762int sqlite3pager_unref(void *pData){
drhed7c8552001-04-11 14:29:21 +00002763 PgHdr *pPg;
drhd9b02572001-04-15 00:37:09 +00002764
2765 /* Decrement the reference count for this page
2766 */
drhed7c8552001-04-11 14:29:21 +00002767 pPg = DATA_TO_PGHDR(pData);
2768 assert( pPg->nRef>0 );
drhed7c8552001-04-11 14:29:21 +00002769 pPg->nRef--;
drhdd793422001-06-28 01:54:48 +00002770 REFINFO(pPg);
drhd9b02572001-04-15 00:37:09 +00002771
danielk19773c407372005-02-15 02:54:14 +00002772 CHECK_PAGE(pPg);
2773
drh72f82862001-05-24 21:06:34 +00002774 /* When the number of references to a page reach 0, call the
2775 ** destructor and add the page to the freelist.
drhd9b02572001-04-15 00:37:09 +00002776 */
drhed7c8552001-04-11 14:29:21 +00002777 if( pPg->nRef==0 ){
drh1eaa2692001-09-18 02:02:23 +00002778 Pager *pPager;
2779 pPager = pPg->pPager;
drhd9b02572001-04-15 00:37:09 +00002780 pPg->pNextFree = 0;
2781 pPg->pPrevFree = pPager->pLast;
drhed7c8552001-04-11 14:29:21 +00002782 pPager->pLast = pPg;
drhd9b02572001-04-15 00:37:09 +00002783 if( pPg->pPrevFree ){
2784 pPg->pPrevFree->pNextFree = pPg;
drhed7c8552001-04-11 14:29:21 +00002785 }else{
2786 pPager->pFirst = pPg;
2787 }
drh341eae82003-01-21 02:39:36 +00002788 if( pPg->needSync==0 && pPager->pFirstSynced==0 ){
2789 pPager->pFirstSynced = pPg;
2790 }
drh72f82862001-05-24 21:06:34 +00002791 if( pPager->xDestructor ){
drhb6f41482004-05-14 01:58:11 +00002792 pPager->xDestructor(pData, pPager->pageSize);
drh72f82862001-05-24 21:06:34 +00002793 }
drhd9b02572001-04-15 00:37:09 +00002794
2795 /* When all pages reach the freelist, drop the read lock from
2796 ** the database file.
2797 */
2798 pPager->nRef--;
2799 assert( pPager->nRef>=0 );
drhb7f91642004-10-31 02:22:47 +00002800 if( pPager->nRef==0 && !MEMDB ){
drhd9b02572001-04-15 00:37:09 +00002801 pager_reset(pPager);
2802 }
drhed7c8552001-04-11 14:29:21 +00002803 }
drhd9b02572001-04-15 00:37:09 +00002804 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +00002805}
2806
2807/*
drha6abd042004-06-09 17:37:22 +00002808** Create a journal file for pPager. There should already be a RESERVED
2809** or EXCLUSIVE lock on the database file when this routine is called.
drhda47d772002-12-02 04:25:19 +00002810**
2811** Return SQLITE_OK if everything. Return an error code and release the
2812** write lock if anything goes wrong.
2813*/
2814static int pager_open_journal(Pager *pPager){
2815 int rc;
drhb7f91642004-10-31 02:22:47 +00002816 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +00002817 assert( pPager->state>=PAGER_RESERVED );
drhda47d772002-12-02 04:25:19 +00002818 assert( pPager->journalOpen==0 );
2819 assert( pPager->useJournal );
drh88b01a12005-03-28 18:04:27 +00002820 assert( pPager->aInJournal==0 );
drh3aac2dd2004-04-26 14:10:20 +00002821 sqlite3pager_pagecount(pPager);
drhda47d772002-12-02 04:25:19 +00002822 pPager->aInJournal = sqliteMalloc( pPager->dbSize/8 + 1 );
2823 if( pPager->aInJournal==0 ){
drh9c105bb2004-10-02 20:38:28 +00002824 rc = SQLITE_NOMEM;
2825 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00002826 }
drh66560ad2006-01-06 14:32:19 +00002827 rc = sqlite3OsOpenExclusive(pPager->zJournal, &pPager->jfd,
drh9c06c952005-11-26 00:25:00 +00002828 pPager->tempFile);
danielk197776572402004-06-25 02:38:54 +00002829 pPager->journalOff = 0;
2830 pPager->setMaster = 0;
2831 pPager->journalHdr = 0;
drhda47d772002-12-02 04:25:19 +00002832 if( rc!=SQLITE_OK ){
drh9c105bb2004-10-02 20:38:28 +00002833 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00002834 }
drhac530b12006-02-11 01:25:50 +00002835 sqlite3OsSetFullSync(pPager->jfd, pPager->full_fsync);
2836 sqlite3OsSetFullSync(pPager->fd, pPager->full_fsync);
drh054889e2005-11-30 03:20:31 +00002837 sqlite3OsOpenDirectory(pPager->jfd, pPager->zDirectory);
drhda47d772002-12-02 04:25:19 +00002838 pPager->journalOpen = 1;
drhdb48ee02003-01-16 13:42:43 +00002839 pPager->journalStarted = 0;
drhda47d772002-12-02 04:25:19 +00002840 pPager->needSync = 0;
2841 pPager->alwaysRollback = 0;
drh968af522003-02-11 14:55:40 +00002842 pPager->nRec = 0;
danielk1977efaaf572006-01-16 11:29:19 +00002843 if( pPager->errCode ){
2844 rc = pPager->errCode;
drhdd5b2fa2005-03-28 03:39:55 +00002845 goto failed_to_open_journal;
drh2e6d11b2003-04-25 15:37:57 +00002846 }
drhda47d772002-12-02 04:25:19 +00002847 pPager->origDbSize = pPager->dbSize;
drhae2b40c2004-06-09 19:03:54 +00002848
danielk197776572402004-06-25 02:38:54 +00002849 rc = writeJournalHdr(pPager);
2850
drhac69b052004-05-12 13:30:07 +00002851 if( pPager->stmtAutoopen && rc==SQLITE_OK ){
drh3aac2dd2004-04-26 14:10:20 +00002852 rc = sqlite3pager_stmt_begin(pPager);
drhda47d772002-12-02 04:25:19 +00002853 }
danielk1977261919c2005-12-06 12:52:59 +00002854 if( rc!=SQLITE_OK && rc!=SQLITE_NOMEM ){
drhda47d772002-12-02 04:25:19 +00002855 rc = pager_unwritelock(pPager);
2856 if( rc==SQLITE_OK ){
2857 rc = SQLITE_FULL;
2858 }
2859 }
drh9c105bb2004-10-02 20:38:28 +00002860 return rc;
2861
2862failed_to_open_journal:
2863 sqliteFree(pPager->aInJournal);
2864 pPager->aInJournal = 0;
danielk1977261919c2005-12-06 12:52:59 +00002865 if( rc==SQLITE_NOMEM ){
2866 /* If this was a malloc() failure, then we will not be closing the pager
2867 ** file. So delete any journal file we may have just created. Otherwise,
2868 ** the system will get confused, we have a read-lock on the file and a
2869 ** mysterious journal has appeared in the filesystem.
2870 */
drh66560ad2006-01-06 14:32:19 +00002871 sqlite3OsDelete(pPager->zJournal);
danielk1977261919c2005-12-06 12:52:59 +00002872 }else{
2873 sqlite3OsUnlock(pPager->fd, NO_LOCK);
2874 pPager->state = PAGER_UNLOCK;
2875 }
drh9c105bb2004-10-02 20:38:28 +00002876 return rc;
drhda47d772002-12-02 04:25:19 +00002877}
2878
2879/*
drh4b845d72002-03-05 12:41:19 +00002880** Acquire a write-lock on the database. The lock is removed when
2881** the any of the following happen:
2882**
drh3aac2dd2004-04-26 14:10:20 +00002883** * sqlite3pager_commit() is called.
2884** * sqlite3pager_rollback() is called.
2885** * sqlite3pager_close() is called.
2886** * sqlite3pager_unref() is called to on every outstanding page.
drh4b845d72002-03-05 12:41:19 +00002887**
danielk197713adf8a2004-06-03 16:08:41 +00002888** The first parameter to this routine is a pointer to any open page of the
2889** database file. Nothing changes about the page - it is used merely to
2890** acquire a pointer to the Pager structure and as proof that there is
2891** already a read-lock on the database.
drh4b845d72002-03-05 12:41:19 +00002892**
danielk197713adf8a2004-06-03 16:08:41 +00002893** The second parameter indicates how much space in bytes to reserve for a
2894** master journal file-name at the start of the journal when it is created.
2895**
2896** A journal file is opened if this is not a temporary file. For temporary
2897** files, the opening of the journal file is deferred until there is an
2898** actual need to write to the journal.
drhda47d772002-12-02 04:25:19 +00002899**
drha6abd042004-06-09 17:37:22 +00002900** If the database is already reserved for writing, this routine is a no-op.
drh684917c2004-10-05 02:41:42 +00002901**
2902** If exFlag is true, go ahead and get an EXCLUSIVE lock on the file
2903** immediately instead of waiting until we try to flush the cache. The
2904** exFlag is ignored if a transaction is already active.
drh4b845d72002-03-05 12:41:19 +00002905*/
drh684917c2004-10-05 02:41:42 +00002906int sqlite3pager_begin(void *pData, int exFlag){
drh4b845d72002-03-05 12:41:19 +00002907 PgHdr *pPg = DATA_TO_PGHDR(pData);
2908 Pager *pPager = pPg->pPager;
2909 int rc = SQLITE_OK;
2910 assert( pPg->nRef>0 );
drha6abd042004-06-09 17:37:22 +00002911 assert( pPager->state!=PAGER_UNLOCK );
2912 if( pPager->state==PAGER_SHARED ){
drh4b845d72002-03-05 12:41:19 +00002913 assert( pPager->aInJournal==0 );
drhb7f91642004-10-31 02:22:47 +00002914 if( MEMDB ){
drha6abd042004-06-09 17:37:22 +00002915 pPager->state = PAGER_EXCLUSIVE;
drhac69b052004-05-12 13:30:07 +00002916 pPager->origDbSize = pPager->dbSize;
2917 }else{
drh054889e2005-11-30 03:20:31 +00002918 rc = sqlite3OsLock(pPager->fd, RESERVED_LOCK);
drh684917c2004-10-05 02:41:42 +00002919 if( rc==SQLITE_OK ){
2920 pPager->state = PAGER_RESERVED;
2921 if( exFlag ){
2922 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
2923 }
2924 }
danielk19779eed5052004-06-04 10:38:30 +00002925 if( rc!=SQLITE_OK ){
2926 return rc;
drhac69b052004-05-12 13:30:07 +00002927 }
drha6abd042004-06-09 17:37:22 +00002928 pPager->dirtyCache = 0;
danielk1977ef73ee92004-11-06 12:26:07 +00002929 TRACE2("TRANSACTION %d\n", PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00002930 if( pPager->useJournal && !pPager->tempFile ){
2931 rc = pager_open_journal(pPager);
2932 }
drh4b845d72002-03-05 12:41:19 +00002933 }
2934 }
2935 return rc;
2936}
2937
2938/*
drhed7c8552001-04-11 14:29:21 +00002939** Mark a data page as writeable. The page is written into the journal
2940** if it is not there already. This routine must be called before making
2941** changes to a page.
2942**
2943** The first time this routine is called, the pager creates a new
drha6abd042004-06-09 17:37:22 +00002944** journal and acquires a RESERVED lock on the database. If the RESERVED
drhed7c8552001-04-11 14:29:21 +00002945** lock could not be acquired, this routine returns SQLITE_BUSY. The
drh306dc212001-05-21 13:45:10 +00002946** calling routine must check for that return value and be careful not to
drhed7c8552001-04-11 14:29:21 +00002947** change any page data until this routine returns SQLITE_OK.
drhd9b02572001-04-15 00:37:09 +00002948**
2949** If the journal file could not be written because the disk is full,
2950** then this routine returns SQLITE_FULL and does an immediate rollback.
2951** All subsequent write attempts also return SQLITE_FULL until there
drh3aac2dd2004-04-26 14:10:20 +00002952** is a call to sqlite3pager_commit() or sqlite3pager_rollback() to
drhd9b02572001-04-15 00:37:09 +00002953** reset.
drhed7c8552001-04-11 14:29:21 +00002954*/
drh3aac2dd2004-04-26 14:10:20 +00002955int sqlite3pager_write(void *pData){
drh69688d52001-04-14 16:38:23 +00002956 PgHdr *pPg = DATA_TO_PGHDR(pData);
2957 Pager *pPager = pPg->pPager;
drhd79caeb2001-04-15 02:27:24 +00002958 int rc = SQLITE_OK;
drh69688d52001-04-14 16:38:23 +00002959
drh6446c4d2001-12-15 14:22:18 +00002960 /* Check for errors
2961 */
danielk1977efaaf572006-01-16 11:29:19 +00002962 if( pPager->errCode ){
2963 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00002964 }
drh5e00f6c2001-09-13 13:46:56 +00002965 if( pPager->readOnly ){
2966 return SQLITE_PERM;
2967 }
drh6446c4d2001-12-15 14:22:18 +00002968
danielk197776572402004-06-25 02:38:54 +00002969 assert( !pPager->setMaster );
2970
danielk19773c407372005-02-15 02:54:14 +00002971 CHECK_PAGE(pPg);
2972
drh6446c4d2001-12-15 14:22:18 +00002973 /* Mark the page as dirty. If the page has already been written
2974 ** to the journal then we can return right away.
2975 */
drhd9b02572001-04-15 00:37:09 +00002976 pPg->dirty = 1;
drhac69b052004-05-12 13:30:07 +00002977 if( pPg->inJournal && (pPg->inStmt || pPager->stmtInUse==0) ){
drha6abd042004-06-09 17:37:22 +00002978 pPager->dirtyCache = 1;
danielk1977a0bf2652004-11-04 14:30:04 +00002979 }else{
drh6446c4d2001-12-15 14:22:18 +00002980
danielk1977a0bf2652004-11-04 14:30:04 +00002981 /* If we get this far, it means that the page needs to be
2982 ** written to the transaction journal or the ckeckpoint journal
2983 ** or both.
2984 **
2985 ** First check to see that the transaction journal exists and
2986 ** create it if it does not.
2987 */
2988 assert( pPager->state!=PAGER_UNLOCK );
2989 rc = sqlite3pager_begin(pData, 0);
2990 if( rc!=SQLITE_OK ){
2991 return rc;
2992 }
2993 assert( pPager->state>=PAGER_RESERVED );
2994 if( !pPager->journalOpen && pPager->useJournal ){
2995 rc = pager_open_journal(pPager);
2996 if( rc!=SQLITE_OK ) return rc;
2997 }
2998 assert( pPager->journalOpen || !pPager->useJournal );
2999 pPager->dirtyCache = 1;
3000
3001 /* The transaction journal now exists and we have a RESERVED or an
3002 ** EXCLUSIVE lock on the main database file. Write the current page to
3003 ** the transaction journal if it is not there already.
3004 */
3005 if( !pPg->inJournal && (pPager->useJournal || MEMDB) ){
3006 if( (int)pPg->pgno <= pPager->origDbSize ){
3007 int szPg;
danielk1977a0bf2652004-11-04 14:30:04 +00003008 if( MEMDB ){
3009 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
danielk1977ef73ee92004-11-06 12:26:07 +00003010 TRACE3("JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00003011 assert( pHist->pOrig==0 );
3012 pHist->pOrig = sqliteMallocRaw( pPager->pageSize );
3013 if( pHist->pOrig ){
3014 memcpy(pHist->pOrig, PGHDR_TO_DATA(pPg), pPager->pageSize);
3015 }
3016 }else{
drhc001c582006-03-06 18:23:16 +00003017 u32 cksum, saved;
3018 char *pData2, *pEnd;
drh267cb322005-09-16 17:16:52 +00003019 /* We should never write to the journal file the page that
3020 ** contains the database locks. The following assert verifies
3021 ** that we do not. */
3022 assert( pPg->pgno!=PAGER_MJ_PGNO(pPager) );
drhc001c582006-03-06 18:23:16 +00003023 pData2 = CODEC2(pPager, pData, pPg->pgno, 7);
drh37527852006-03-16 16:19:56 +00003024 cksum = pager_cksum(pPager, (u8*)pData2);
drhc001c582006-03-06 18:23:16 +00003025 pEnd = pData2 + pPager->pageSize;
3026 pData2 -= 4;
3027 saved = *(u32*)pEnd;
3028 put32bits(pEnd, cksum);
danielk1977a0bf2652004-11-04 14:30:04 +00003029 szPg = pPager->pageSize+8;
drhc001c582006-03-06 18:23:16 +00003030 put32bits(pData2, pPg->pgno);
3031 rc = sqlite3OsWrite(pPager->jfd, pData2, szPg);
danielk1977a0bf2652004-11-04 14:30:04 +00003032 pPager->journalOff += szPg;
3033 TRACE4("JOURNAL %d page %d needSync=%d\n",
danielk1977ef73ee92004-11-06 12:26:07 +00003034 PAGERID(pPager), pPg->pgno, pPg->needSync);
drhc001c582006-03-06 18:23:16 +00003035 *(u32*)pEnd = saved;
danielk197707cb5602006-01-20 10:55:05 +00003036
3037 /* An error has occured writing to the journal file. The
3038 ** transaction will be rolled back by the layer above.
3039 */
danielk1977a0bf2652004-11-04 14:30:04 +00003040 if( rc!=SQLITE_OK ){
danielk1977a0bf2652004-11-04 14:30:04 +00003041 return rc;
3042 }
danielk197707cb5602006-01-20 10:55:05 +00003043
danielk1977a0bf2652004-11-04 14:30:04 +00003044 pPager->nRec++;
3045 assert( pPager->aInJournal!=0 );
3046 pPager->aInJournal[pPg->pgno/8] |= 1<<(pPg->pgno&7);
3047 pPg->needSync = !pPager->noSync;
3048 if( pPager->stmtInUse ){
3049 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
3050 page_add_to_stmt_list(pPg);
3051 }
drhac69b052004-05-12 13:30:07 +00003052 }
danielk197713adf8a2004-06-03 16:08:41 +00003053 }else{
danielk1977a0bf2652004-11-04 14:30:04 +00003054 pPg->needSync = !pPager->journalStarted && !pPager->noSync;
3055 TRACE4("APPEND %d page %d needSync=%d\n",
danielk1977ef73ee92004-11-06 12:26:07 +00003056 PAGERID(pPager), pPg->pgno, pPg->needSync);
danielk1977a0bf2652004-11-04 14:30:04 +00003057 }
3058 if( pPg->needSync ){
3059 pPager->needSync = 1;
3060 }
3061 pPg->inJournal = 1;
3062 }
3063
3064 /* If the statement journal is open and the page is not in it,
3065 ** then write the current page to the statement journal. Note that
3066 ** the statement journal format differs from the standard journal format
3067 ** in that it omits the checksums and the header.
3068 */
3069 if( pPager->stmtInUse && !pPg->inStmt && (int)pPg->pgno<=pPager->stmtSize ){
3070 assert( pPg->inJournal || (int)pPg->pgno>pPager->origDbSize );
3071 if( MEMDB ){
3072 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
3073 assert( pHist->pStmt==0 );
3074 pHist->pStmt = sqliteMallocRaw( pPager->pageSize );
3075 if( pHist->pStmt ){
3076 memcpy(pHist->pStmt, PGHDR_TO_DATA(pPg), pPager->pageSize);
3077 }
danielk1977ef73ee92004-11-06 12:26:07 +00003078 TRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00003079 }else{
drhc001c582006-03-06 18:23:16 +00003080 char *pData2 = CODEC2(pPager, pData, pPg->pgno, 7)-4;
3081 put32bits(pData2, pPg->pgno);
3082 rc = sqlite3OsWrite(pPager->stfd, pData2, pPager->pageSize+4);
danielk1977ef73ee92004-11-06 12:26:07 +00003083 TRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
drhac69b052004-05-12 13:30:07 +00003084 if( rc!=SQLITE_OK ){
drhac69b052004-05-12 13:30:07 +00003085 return rc;
3086 }
danielk1977a0bf2652004-11-04 14:30:04 +00003087 pPager->stmtNRec++;
3088 assert( pPager->aInStmt!=0 );
3089 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drhdb48ee02003-01-16 13:42:43 +00003090 }
danielk1977a0bf2652004-11-04 14:30:04 +00003091 page_add_to_stmt_list(pPg);
drhd9b02572001-04-15 00:37:09 +00003092 }
drhfa86c412002-02-02 15:01:15 +00003093 }
3094
3095 /* Update the database size and return.
3096 */
drh1ab43002002-01-14 09:28:19 +00003097 if( pPager->dbSize<(int)pPg->pgno ){
drh306dc212001-05-21 13:45:10 +00003098 pPager->dbSize = pPg->pgno;
drhb7f91642004-10-31 02:22:47 +00003099 if( !MEMDB && pPager->dbSize==PENDING_BYTE/pPager->pageSize ){
drh1f595712004-06-15 01:40:29 +00003100 pPager->dbSize++;
3101 }
drh306dc212001-05-21 13:45:10 +00003102 }
drh69688d52001-04-14 16:38:23 +00003103 return rc;
drhed7c8552001-04-11 14:29:21 +00003104}
3105
3106/*
drhaacc5432002-01-06 17:07:40 +00003107** Return TRUE if the page given in the argument was previously passed
drh3aac2dd2004-04-26 14:10:20 +00003108** to sqlite3pager_write(). In other words, return TRUE if it is ok
drh6019e162001-07-02 17:51:45 +00003109** to change the content of the page.
3110*/
danielk19777d3a6662006-01-23 16:21:05 +00003111#ifndef NDEBUG
drh3aac2dd2004-04-26 14:10:20 +00003112int sqlite3pager_iswriteable(void *pData){
drh6019e162001-07-02 17:51:45 +00003113 PgHdr *pPg = DATA_TO_PGHDR(pData);
3114 return pPg->dirty;
3115}
danielk19777d3a6662006-01-23 16:21:05 +00003116#endif
drh6019e162001-07-02 17:51:45 +00003117
danielk1977b84f96f2005-01-20 11:32:23 +00003118#ifndef SQLITE_OMIT_VACUUM
drh6019e162001-07-02 17:51:45 +00003119/*
drh001bbcb2003-03-19 03:14:00 +00003120** Replace the content of a single page with the information in the third
3121** argument.
3122*/
drh3aac2dd2004-04-26 14:10:20 +00003123int sqlite3pager_overwrite(Pager *pPager, Pgno pgno, void *pData){
drh001bbcb2003-03-19 03:14:00 +00003124 void *pPage;
3125 int rc;
3126
drh3aac2dd2004-04-26 14:10:20 +00003127 rc = sqlite3pager_get(pPager, pgno, &pPage);
drh001bbcb2003-03-19 03:14:00 +00003128 if( rc==SQLITE_OK ){
drh3aac2dd2004-04-26 14:10:20 +00003129 rc = sqlite3pager_write(pPage);
drh001bbcb2003-03-19 03:14:00 +00003130 if( rc==SQLITE_OK ){
drh90f5ecb2004-07-22 01:19:35 +00003131 memcpy(pPage, pData, pPager->pageSize);
drh001bbcb2003-03-19 03:14:00 +00003132 }
drh3aac2dd2004-04-26 14:10:20 +00003133 sqlite3pager_unref(pPage);
drh001bbcb2003-03-19 03:14:00 +00003134 }
3135 return rc;
3136}
danielk1977b84f96f2005-01-20 11:32:23 +00003137#endif
drh001bbcb2003-03-19 03:14:00 +00003138
3139/*
drh30e58752002-03-02 20:41:57 +00003140** A call to this routine tells the pager that it is not necessary to
3141** write the information on page "pgno" back to the disk, even though
3142** that page might be marked as dirty.
3143**
3144** The overlying software layer calls this routine when all of the data
3145** on the given page is unused. The pager marks the page as clean so
3146** that it does not get written to disk.
3147**
3148** Tests show that this optimization, together with the
drh3aac2dd2004-04-26 14:10:20 +00003149** sqlite3pager_dont_rollback() below, more than double the speed
drh30e58752002-03-02 20:41:57 +00003150** of large INSERT operations and quadruple the speed of large DELETEs.
drh8e298f92002-07-06 16:28:47 +00003151**
3152** When this routine is called, set the alwaysRollback flag to true.
drh3aac2dd2004-04-26 14:10:20 +00003153** Subsequent calls to sqlite3pager_dont_rollback() for the same page
drh8e298f92002-07-06 16:28:47 +00003154** will thereafter be ignored. This is necessary to avoid a problem
3155** where a page with data is added to the freelist during one part of
3156** a transaction then removed from the freelist during a later part
3157** of the same transaction and reused for some other purpose. When it
3158** is first added to the freelist, this routine is called. When reused,
3159** the dont_rollback() routine is called. But because the page contains
3160** critical data, we still need to be sure it gets rolled back in spite
3161** of the dont_rollback() call.
drh30e58752002-03-02 20:41:57 +00003162*/
drh3aac2dd2004-04-26 14:10:20 +00003163void sqlite3pager_dont_write(Pager *pPager, Pgno pgno){
drh30e58752002-03-02 20:41:57 +00003164 PgHdr *pPg;
drh8e298f92002-07-06 16:28:47 +00003165
drhb7f91642004-10-31 02:22:47 +00003166 if( MEMDB ) return;
danielk1977eac7a362004-06-16 07:45:24 +00003167
drh30e58752002-03-02 20:41:57 +00003168 pPg = pager_lookup(pPager, pgno);
drh43617e92006-03-06 20:55:46 +00003169 assert( pPg!=0 ); /* We never call _dont_write unless the page is in mem */
drh8e298f92002-07-06 16:28:47 +00003170 pPg->alwaysRollback = 1;
drh43617e92006-03-06 20:55:46 +00003171 if( pPg->dirty && !pPager->stmtInUse ){
drh8124a302002-06-25 14:43:57 +00003172 if( pPager->dbSize==(int)pPg->pgno && pPager->origDbSize<pPager->dbSize ){
3173 /* If this pages is the last page in the file and the file has grown
3174 ** during the current transaction, then do NOT mark the page as clean.
3175 ** When the database file grows, we must make sure that the last page
3176 ** gets written at least once so that the disk file will be the correct
3177 ** size. If you do not write this page and the size of the file
3178 ** on the disk ends up being too small, that can lead to database
3179 ** corruption during the next transaction.
3180 */
3181 }else{
danielk1977ef73ee92004-11-06 12:26:07 +00003182 TRACE3("DONT_WRITE page %d of %d\n", pgno, PAGERID(pPager));
drh8124a302002-06-25 14:43:57 +00003183 pPg->dirty = 0;
danielk19773c407372005-02-15 02:54:14 +00003184#ifdef SQLITE_CHECK_PAGES
3185 pPg->pageHash = pager_pagehash(pPg);
3186#endif
drh8124a302002-06-25 14:43:57 +00003187 }
drh30e58752002-03-02 20:41:57 +00003188 }
3189}
3190
3191/*
3192** A call to this routine tells the pager that if a rollback occurs,
3193** it is not necessary to restore the data on the given page. This
3194** means that the pager does not have to record the given page in the
3195** rollback journal.
3196*/
drh3aac2dd2004-04-26 14:10:20 +00003197void sqlite3pager_dont_rollback(void *pData){
drh30e58752002-03-02 20:41:57 +00003198 PgHdr *pPg = DATA_TO_PGHDR(pData);
3199 Pager *pPager = pPg->pPager;
3200
drha6abd042004-06-09 17:37:22 +00003201 if( pPager->state!=PAGER_EXCLUSIVE || pPager->journalOpen==0 ) return;
drhb7f91642004-10-31 02:22:47 +00003202 if( pPg->alwaysRollback || pPager->alwaysRollback || MEMDB ) return;
drh30e58752002-03-02 20:41:57 +00003203 if( !pPg->inJournal && (int)pPg->pgno <= pPager->origDbSize ){
3204 assert( pPager->aInJournal!=0 );
3205 pPager->aInJournal[pPg->pgno/8] |= 1<<(pPg->pgno&7);
3206 pPg->inJournal = 1;
drhac69b052004-05-12 13:30:07 +00003207 if( pPager->stmtInUse ){
3208 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drh3aac2dd2004-04-26 14:10:20 +00003209 page_add_to_stmt_list(pPg);
drh30e58752002-03-02 20:41:57 +00003210 }
danielk1977ef73ee92004-11-06 12:26:07 +00003211 TRACE3("DONT_ROLLBACK page %d of %d\n", pPg->pgno, PAGERID(pPager));
drh30e58752002-03-02 20:41:57 +00003212 }
drhac69b052004-05-12 13:30:07 +00003213 if( pPager->stmtInUse && !pPg->inStmt && (int)pPg->pgno<=pPager->stmtSize ){
drh30e58752002-03-02 20:41:57 +00003214 assert( pPg->inJournal || (int)pPg->pgno>pPager->origDbSize );
drhac69b052004-05-12 13:30:07 +00003215 assert( pPager->aInStmt!=0 );
3216 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drh3aac2dd2004-04-26 14:10:20 +00003217 page_add_to_stmt_list(pPg);
drh30e58752002-03-02 20:41:57 +00003218 }
3219}
3220
drhac69b052004-05-12 13:30:07 +00003221
drh30e58752002-03-02 20:41:57 +00003222/*
drhed7c8552001-04-11 14:29:21 +00003223** Commit all changes to the database and release the write lock.
drhd9b02572001-04-15 00:37:09 +00003224**
3225** If the commit fails for any reason, a rollback attempt is made
3226** and an error code is returned. If the commit worked, SQLITE_OK
3227** is returned.
drhed7c8552001-04-11 14:29:21 +00003228*/
drh3aac2dd2004-04-26 14:10:20 +00003229int sqlite3pager_commit(Pager *pPager){
drha1b351a2001-09-14 16:42:12 +00003230 int rc;
drhed7c8552001-04-11 14:29:21 +00003231 PgHdr *pPg;
drhd9b02572001-04-15 00:37:09 +00003232
danielk1977efaaf572006-01-16 11:29:19 +00003233 if( pPager->errCode ){
danielk19777f7bc662006-01-23 13:47:47 +00003234 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00003235 }
drha6abd042004-06-09 17:37:22 +00003236 if( pPager->state<PAGER_RESERVED ){
drhd9b02572001-04-15 00:37:09 +00003237 return SQLITE_ERROR;
3238 }
danielk1977ef73ee92004-11-06 12:26:07 +00003239 TRACE2("COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003240 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00003241 pPg = pager_get_all_dirty_pages(pPager);
3242 while( pPg ){
3243 clearHistory(PGHDR_TO_HIST(pPg, pPager));
3244 pPg->dirty = 0;
3245 pPg->inJournal = 0;
3246 pPg->inStmt = 0;
drh5229ae42006-03-23 23:29:04 +00003247 pPg->needSync = 0;
drhac69b052004-05-12 13:30:07 +00003248 pPg->pPrevStmt = pPg->pNextStmt = 0;
3249 pPg = pPg->pDirty;
3250 }
danielk1977eac7a362004-06-16 07:45:24 +00003251#ifndef NDEBUG
3252 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
3253 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
3254 assert( !pPg->alwaysRollback );
3255 assert( !pHist->pOrig );
3256 assert( !pHist->pStmt );
3257 }
3258#endif
drhac69b052004-05-12 13:30:07 +00003259 pPager->pStmt = 0;
drha6abd042004-06-09 17:37:22 +00003260 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00003261 return SQLITE_OK;
3262 }
drha6abd042004-06-09 17:37:22 +00003263 if( pPager->dirtyCache==0 ){
drh054889e2005-11-30 03:20:31 +00003264 /* Exit early (without doing the time-consuming sqlite3OsSync() calls)
drha1680452002-04-18 01:56:57 +00003265 ** if there have been no changes to the database file. */
drh341eae82003-01-21 02:39:36 +00003266 assert( pPager->needSync==0 );
drha1680452002-04-18 01:56:57 +00003267 rc = pager_unwritelock(pPager);
3268 pPager->dbSize = -1;
3269 return rc;
3270 }
drhda47d772002-12-02 04:25:19 +00003271 assert( pPager->journalOpen );
danielk1977d761c0c2004-11-05 16:37:02 +00003272 rc = sqlite3pager_sync(pPager, 0, 0);
danielk19777f7bc662006-01-23 13:47:47 +00003273 if( rc==SQLITE_OK ){
3274 rc = pager_unwritelock(pPager);
3275 pPager->dbSize = -1;
drha6abd042004-06-09 17:37:22 +00003276 }
drhed7c8552001-04-11 14:29:21 +00003277 return rc;
3278}
3279
3280/*
drha6abd042004-06-09 17:37:22 +00003281** Rollback all changes. The database falls back to PAGER_SHARED mode.
drhed7c8552001-04-11 14:29:21 +00003282** All in-memory cache pages revert to their original data contents.
3283** The journal is deleted.
drhd9b02572001-04-15 00:37:09 +00003284**
3285** This routine cannot fail unless some other process is not following
3286** the correct locking protocol (SQLITE_PROTOCOL) or unless some other
3287** process is writing trash into the journal file (SQLITE_CORRUPT) or
3288** unless a prior malloc() failed (SQLITE_NOMEM). Appropriate error
3289** codes are returned for all these occasions. Otherwise,
3290** SQLITE_OK is returned.
drhed7c8552001-04-11 14:29:21 +00003291*/
drh3aac2dd2004-04-26 14:10:20 +00003292int sqlite3pager_rollback(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +00003293 int rc;
danielk1977ef73ee92004-11-06 12:26:07 +00003294 TRACE2("ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003295 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00003296 PgHdr *p;
3297 for(p=pPager->pAll; p; p=p->pNextAll){
3298 PgHistory *pHist;
danielk1977eac7a362004-06-16 07:45:24 +00003299 assert( !p->alwaysRollback );
3300 if( !p->dirty ){
3301 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pOrig );
3302 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pStmt );
3303 continue;
3304 }
3305
drhac69b052004-05-12 13:30:07 +00003306 pHist = PGHDR_TO_HIST(p, pPager);
3307 if( pHist->pOrig ){
3308 memcpy(PGHDR_TO_DATA(p), pHist->pOrig, pPager->pageSize);
danielk1977ef73ee92004-11-06 12:26:07 +00003309 TRACE3("ROLLBACK-PAGE %d of %d\n", p->pgno, PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00003310 }else{
danielk1977ef73ee92004-11-06 12:26:07 +00003311 TRACE3("PAGE %d is clean on %d\n", p->pgno, PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00003312 }
3313 clearHistory(pHist);
3314 p->dirty = 0;
3315 p->inJournal = 0;
3316 p->inStmt = 0;
3317 p->pPrevStmt = p->pNextStmt = 0;
danielk1977369f27e2004-06-15 11:40:04 +00003318
3319 if( pPager->xReiniter ){
3320 pPager->xReiniter(PGHDR_TO_DATA(p), pPager->pageSize);
3321 }
3322
drhac69b052004-05-12 13:30:07 +00003323 }
3324 pPager->pStmt = 0;
3325 pPager->dbSize = pPager->origDbSize;
3326 memoryTruncate(pPager);
3327 pPager->stmtInUse = 0;
drha6abd042004-06-09 17:37:22 +00003328 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00003329 return SQLITE_OK;
3330 }
3331
drha6abd042004-06-09 17:37:22 +00003332 if( !pPager->dirtyCache || !pPager->journalOpen ){
drhda47d772002-12-02 04:25:19 +00003333 rc = pager_unwritelock(pPager);
3334 pPager->dbSize = -1;
3335 return rc;
3336 }
drhdb48ee02003-01-16 13:42:43 +00003337
danielk1977efaaf572006-01-16 11:29:19 +00003338 if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
drha6abd042004-06-09 17:37:22 +00003339 if( pPager->state>=PAGER_EXCLUSIVE ){
danielk197776572402004-06-25 02:38:54 +00003340 pager_playback(pPager);
drh4b845d72002-03-05 12:41:19 +00003341 }
danielk1977efaaf572006-01-16 11:29:19 +00003342 return pPager->errCode;
drhed7c8552001-04-11 14:29:21 +00003343 }
drha6abd042004-06-09 17:37:22 +00003344 if( pPager->state==PAGER_RESERVED ){
danielk197717221812005-02-15 03:38:05 +00003345 int rc2;
drha6abd042004-06-09 17:37:22 +00003346 rc = pager_reload_cache(pPager);
danielk197717221812005-02-15 03:38:05 +00003347 rc2 = pager_unwritelock(pPager);
drha6abd042004-06-09 17:37:22 +00003348 if( rc==SQLITE_OK ){
3349 rc = rc2;
3350 }
3351 }else{
danielk197776572402004-06-25 02:38:54 +00003352 rc = pager_playback(pPager);
drhd9b02572001-04-15 00:37:09 +00003353 }
drhd9b02572001-04-15 00:37:09 +00003354 pPager->dbSize = -1;
danielk197707cb5602006-01-20 10:55:05 +00003355
3356 /* If an error occurs during a ROLLBACK, we can no longer trust the pager
3357 ** cache. So call pager_error() on the way out to make any error
3358 ** persistent.
3359 */
3360 return pager_error(pPager, rc);
drh98808ba2001-10-18 12:34:46 +00003361}
drhd9b02572001-04-15 00:37:09 +00003362
3363/*
drh5e00f6c2001-09-13 13:46:56 +00003364** Return TRUE if the database file is opened read-only. Return FALSE
3365** if the database is (in theory) writable.
3366*/
drh3aac2dd2004-04-26 14:10:20 +00003367int sqlite3pager_isreadonly(Pager *pPager){
drhbe0072d2001-09-13 14:46:09 +00003368 return pPager->readOnly;
drh5e00f6c2001-09-13 13:46:56 +00003369}
3370
3371/*
drhd9b02572001-04-15 00:37:09 +00003372** This routine is used for testing and analysis only.
3373*/
drh3aac2dd2004-04-26 14:10:20 +00003374int *sqlite3pager_stats(Pager *pPager){
danielk197742741be2005-01-08 12:42:39 +00003375 static int a[11];
drhd9b02572001-04-15 00:37:09 +00003376 a[0] = pPager->nRef;
3377 a[1] = pPager->nPage;
3378 a[2] = pPager->mxPage;
3379 a[3] = pPager->dbSize;
3380 a[4] = pPager->state;
danielk1977efaaf572006-01-16 11:29:19 +00003381 a[5] = pPager->errCode;
drhfcd35c72005-05-21 02:48:08 +00003382#ifdef SQLITE_TEST
drhd9b02572001-04-15 00:37:09 +00003383 a[6] = pPager->nHit;
3384 a[7] = pPager->nMiss;
3385 a[8] = pPager->nOvfl;
danielk197742741be2005-01-08 12:42:39 +00003386 a[9] = pPager->nRead;
3387 a[10] = pPager->nWrite;
drhfcd35c72005-05-21 02:48:08 +00003388#endif
drhd9b02572001-04-15 00:37:09 +00003389 return a;
3390}
drhdd793422001-06-28 01:54:48 +00003391
drhfa86c412002-02-02 15:01:15 +00003392/*
drhac69b052004-05-12 13:30:07 +00003393** Set the statement rollback point.
drhfa86c412002-02-02 15:01:15 +00003394**
3395** This routine should be called with the transaction journal already
drhac69b052004-05-12 13:30:07 +00003396** open. A new statement journal is created that can be used to rollback
drhaaab5722002-02-19 13:39:21 +00003397** changes of a single SQL command within a larger transaction.
drhfa86c412002-02-02 15:01:15 +00003398*/
drh3aac2dd2004-04-26 14:10:20 +00003399int sqlite3pager_stmt_begin(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00003400 int rc;
3401 char zTemp[SQLITE_TEMPNAME_SIZE];
drhac69b052004-05-12 13:30:07 +00003402 assert( !pPager->stmtInUse );
drhdc3ff9c2004-08-18 02:10:15 +00003403 assert( pPager->dbSize>=0 );
danielk1977ef73ee92004-11-06 12:26:07 +00003404 TRACE2("STMT-BEGIN %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003405 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00003406 pPager->stmtInUse = 1;
3407 pPager->stmtSize = pPager->dbSize;
3408 return SQLITE_OK;
3409 }
drhda47d772002-12-02 04:25:19 +00003410 if( !pPager->journalOpen ){
drhac69b052004-05-12 13:30:07 +00003411 pPager->stmtAutoopen = 1;
drhda47d772002-12-02 04:25:19 +00003412 return SQLITE_OK;
3413 }
drhfa86c412002-02-02 15:01:15 +00003414 assert( pPager->journalOpen );
drhac69b052004-05-12 13:30:07 +00003415 pPager->aInStmt = sqliteMalloc( pPager->dbSize/8 + 1 );
3416 if( pPager->aInStmt==0 ){
danielk1977261919c2005-12-06 12:52:59 +00003417 /* sqlite3OsLock(pPager->fd, SHARED_LOCK); */
drhfa86c412002-02-02 15:01:15 +00003418 return SQLITE_NOMEM;
3419 }
drh968af522003-02-11 14:55:40 +00003420#ifndef NDEBUG
drh054889e2005-11-30 03:20:31 +00003421 rc = sqlite3OsFileSize(pPager->jfd, &pPager->stmtJSize);
drhac69b052004-05-12 13:30:07 +00003422 if( rc ) goto stmt_begin_failed;
danielk197776572402004-06-25 02:38:54 +00003423 assert( pPager->stmtJSize == pPager->journalOff );
drh968af522003-02-11 14:55:40 +00003424#endif
danielk197776572402004-06-25 02:38:54 +00003425 pPager->stmtJSize = pPager->journalOff;
drhac69b052004-05-12 13:30:07 +00003426 pPager->stmtSize = pPager->dbSize;
danielk197776572402004-06-25 02:38:54 +00003427 pPager->stmtHdrOff = 0;
danielk197775edc162004-06-26 01:48:18 +00003428 pPager->stmtCksum = pPager->cksumInit;
drhac69b052004-05-12 13:30:07 +00003429 if( !pPager->stmtOpen ){
3430 rc = sqlite3pager_opentemp(zTemp, &pPager->stfd);
3431 if( rc ) goto stmt_begin_failed;
3432 pPager->stmtOpen = 1;
3433 pPager->stmtNRec = 0;
drh0f892532002-05-30 12:27:03 +00003434 }
drhac69b052004-05-12 13:30:07 +00003435 pPager->stmtInUse = 1;
drhfa86c412002-02-02 15:01:15 +00003436 return SQLITE_OK;
3437
drhac69b052004-05-12 13:30:07 +00003438stmt_begin_failed:
3439 if( pPager->aInStmt ){
3440 sqliteFree(pPager->aInStmt);
3441 pPager->aInStmt = 0;
drhfa86c412002-02-02 15:01:15 +00003442 }
3443 return rc;
3444}
3445
3446/*
drhac69b052004-05-12 13:30:07 +00003447** Commit a statement.
drhfa86c412002-02-02 15:01:15 +00003448*/
drh3aac2dd2004-04-26 14:10:20 +00003449int sqlite3pager_stmt_commit(Pager *pPager){
drhac69b052004-05-12 13:30:07 +00003450 if( pPager->stmtInUse ){
drh03eb96a2002-11-10 23:32:56 +00003451 PgHdr *pPg, *pNext;
danielk1977ef73ee92004-11-06 12:26:07 +00003452 TRACE2("STMT-COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003453 if( !MEMDB ){
drh054889e2005-11-30 03:20:31 +00003454 sqlite3OsSeek(pPager->stfd, 0);
3455 /* sqlite3OsTruncate(pPager->stfd, 0); */
drhac69b052004-05-12 13:30:07 +00003456 sqliteFree( pPager->aInStmt );
3457 pPager->aInStmt = 0;
drh663fc632002-02-02 18:49:19 +00003458 }
drhac69b052004-05-12 13:30:07 +00003459 for(pPg=pPager->pStmt; pPg; pPg=pNext){
3460 pNext = pPg->pNextStmt;
3461 assert( pPg->inStmt );
3462 pPg->inStmt = 0;
3463 pPg->pPrevStmt = pPg->pNextStmt = 0;
drhb7f91642004-10-31 02:22:47 +00003464 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00003465 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
3466 sqliteFree(pHist->pStmt);
3467 pHist->pStmt = 0;
3468 }
3469 }
3470 pPager->stmtNRec = 0;
3471 pPager->stmtInUse = 0;
3472 pPager->pStmt = 0;
drh663fc632002-02-02 18:49:19 +00003473 }
drhac69b052004-05-12 13:30:07 +00003474 pPager->stmtAutoopen = 0;
drhfa86c412002-02-02 15:01:15 +00003475 return SQLITE_OK;
3476}
3477
3478/*
drhac69b052004-05-12 13:30:07 +00003479** Rollback a statement.
drhfa86c412002-02-02 15:01:15 +00003480*/
drh3aac2dd2004-04-26 14:10:20 +00003481int sqlite3pager_stmt_rollback(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00003482 int rc;
drhac69b052004-05-12 13:30:07 +00003483 if( pPager->stmtInUse ){
danielk1977ef73ee92004-11-06 12:26:07 +00003484 TRACE2("STMT-ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003485 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00003486 PgHdr *pPg;
3487 for(pPg=pPager->pStmt; pPg; pPg=pPg->pNextStmt){
3488 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
3489 if( pHist->pStmt ){
3490 memcpy(PGHDR_TO_DATA(pPg), pHist->pStmt, pPager->pageSize);
3491 sqliteFree(pHist->pStmt);
3492 pHist->pStmt = 0;
3493 }
3494 }
3495 pPager->dbSize = pPager->stmtSize;
3496 memoryTruncate(pPager);
3497 rc = SQLITE_OK;
3498 }else{
3499 rc = pager_stmt_playback(pPager);
3500 }
drh3aac2dd2004-04-26 14:10:20 +00003501 sqlite3pager_stmt_commit(pPager);
drh663fc632002-02-02 18:49:19 +00003502 }else{
3503 rc = SQLITE_OK;
3504 }
drhac69b052004-05-12 13:30:07 +00003505 pPager->stmtAutoopen = 0;
drhfa86c412002-02-02 15:01:15 +00003506 return rc;
3507}
3508
drh73509ee2003-04-06 20:44:45 +00003509/*
3510** Return the full pathname of the database file.
3511*/
drh3aac2dd2004-04-26 14:10:20 +00003512const char *sqlite3pager_filename(Pager *pPager){
drh73509ee2003-04-06 20:44:45 +00003513 return pPager->zFilename;
3514}
3515
drhb20ea9d2004-02-09 01:20:36 +00003516/*
danielk19775865e3d2004-06-14 06:03:57 +00003517** Return the directory of the database file.
3518*/
3519const char *sqlite3pager_dirname(Pager *pPager){
3520 return pPager->zDirectory;
3521}
3522
3523/*
3524** Return the full pathname of the journal file.
3525*/
3526const char *sqlite3pager_journalname(Pager *pPager){
3527 return pPager->zJournal;
3528}
3529
3530/*
drh2c8997b2005-08-27 16:36:48 +00003531** Return true if fsync() calls are disabled for this pager. Return FALSE
3532** if fsync()s are executed normally.
3533*/
3534int sqlite3pager_nosync(Pager *pPager){
3535 return pPager->noSync;
3536}
3537
3538/*
drhb20ea9d2004-02-09 01:20:36 +00003539** Set the codec for this pager
3540*/
drh3aac2dd2004-04-26 14:10:20 +00003541void sqlite3pager_set_codec(
drhb20ea9d2004-02-09 01:20:36 +00003542 Pager *pPager,
drhc001c582006-03-06 18:23:16 +00003543 void *(*xCodec)(void*,void*,Pgno,int),
drhb20ea9d2004-02-09 01:20:36 +00003544 void *pCodecArg
3545){
3546 pPager->xCodec = xCodec;
3547 pPager->pCodecArg = pCodecArg;
3548}
3549
danielk197713adf8a2004-06-03 16:08:41 +00003550/*
danielk1977aa5ccdf2004-06-14 05:10:42 +00003551** This routine is called to increment the database file change-counter,
3552** stored at byte 24 of the pager file.
3553*/
3554static int pager_incr_changecounter(Pager *pPager){
3555 void *pPage;
3556 PgHdr *pPgHdr;
3557 u32 change_counter;
3558 int rc;
3559
3560 /* Open page 1 of the file for writing. */
3561 rc = sqlite3pager_get(pPager, 1, &pPage);
3562 if( rc!=SQLITE_OK ) return rc;
3563 rc = sqlite3pager_write(pPage);
3564 if( rc!=SQLITE_OK ) return rc;
3565
3566 /* Read the current value at byte 24. */
3567 pPgHdr = DATA_TO_PGHDR(pPage);
3568 change_counter = retrieve32bits(pPgHdr, 24);
3569
3570 /* Increment the value just read and write it back to byte 24. */
3571 change_counter++;
drhc001c582006-03-06 18:23:16 +00003572 put32bits(((char*)PGHDR_TO_DATA(pPgHdr))+24, change_counter);
danielk1977aa5ccdf2004-06-14 05:10:42 +00003573
3574 /* Release the page reference. */
3575 sqlite3pager_unref(pPage);
3576 return SQLITE_OK;
3577}
3578
3579/*
danielk197713adf8a2004-06-03 16:08:41 +00003580** Sync the database file for the pager pPager. zMaster points to the name
3581** of a master journal file that should be written into the individual
3582** journal file. zMaster may be NULL, which is interpreted as no master
3583** journal (a single database transaction).
3584**
3585** This routine ensures that the journal is synced, all dirty pages written
3586** to the database file and the database file synced. The only thing that
3587** remains to commit the transaction is to delete the journal file (or
3588** master journal file if specified).
3589**
3590** Note that if zMaster==NULL, this does not overwrite a previous value
3591** passed to an sqlite3pager_sync() call.
danielk1977d761c0c2004-11-05 16:37:02 +00003592**
3593** If parameter nTrunc is non-zero, then the pager file is truncated to
3594** nTrunc pages (this is used by auto-vacuum databases).
danielk197713adf8a2004-06-03 16:08:41 +00003595*/
danielk1977d761c0c2004-11-05 16:37:02 +00003596int sqlite3pager_sync(Pager *pPager, const char *zMaster, Pgno nTrunc){
danielk197713adf8a2004-06-03 16:08:41 +00003597 int rc = SQLITE_OK;
3598
danielk1977ef73ee92004-11-06 12:26:07 +00003599 TRACE4("DATABASE SYNC: File=%s zMaster=%s nTrunc=%d\n",
3600 pPager->zFilename, zMaster, nTrunc);
3601
danielk1977aa5ccdf2004-06-14 05:10:42 +00003602 /* If this is an in-memory db, or no pages have been written to, or this
3603 ** function has already been called, it is a no-op.
danielk197713adf8a2004-06-03 16:08:41 +00003604 */
drhb7f91642004-10-31 02:22:47 +00003605 if( pPager->state!=PAGER_SYNCED && !MEMDB && pPager->dirtyCache ){
danielk197713adf8a2004-06-03 16:08:41 +00003606 PgHdr *pPg;
3607 assert( pPager->journalOpen );
3608
danielk197776572402004-06-25 02:38:54 +00003609 /* If a master journal file name has already been written to the
3610 ** journal file, then no sync is required. This happens when it is
3611 ** written, then the process fails to upgrade from a RESERVED to an
3612 ** EXCLUSIVE lock. The next time the process tries to commit the
3613 ** transaction the m-j name will have already been written.
3614 */
3615 if( !pPager->setMaster ){
3616 rc = pager_incr_changecounter(pPager);
3617 if( rc!=SQLITE_OK ) goto sync_exit;
danielk1977ef73ee92004-11-06 12:26:07 +00003618#ifndef SQLITE_OMIT_AUTOVACUUM
3619 if( nTrunc!=0 ){
3620 /* If this transaction has made the database smaller, then all pages
3621 ** being discarded by the truncation must be written to the journal
3622 ** file.
3623 */
3624 Pgno i;
3625 void *pPage;
drh267cb322005-09-16 17:16:52 +00003626 int iSkip = PAGER_MJ_PGNO(pPager);
danielk1977ef73ee92004-11-06 12:26:07 +00003627 for( i=nTrunc+1; i<=pPager->origDbSize; i++ ){
drh267cb322005-09-16 17:16:52 +00003628 if( !(pPager->aInJournal[i/8] & (1<<(i&7))) && i!=iSkip ){
danielk1977ef73ee92004-11-06 12:26:07 +00003629 rc = sqlite3pager_get(pPager, i, &pPage);
3630 if( rc!=SQLITE_OK ) goto sync_exit;
3631 rc = sqlite3pager_write(pPage);
3632 sqlite3pager_unref(pPage);
3633 if( rc!=SQLITE_OK ) goto sync_exit;
3634 }
3635 }
3636 }
3637#endif
danielk197776572402004-06-25 02:38:54 +00003638 rc = writeMasterJournal(pPager, zMaster);
3639 if( rc!=SQLITE_OK ) goto sync_exit;
3640 rc = syncJournal(pPager);
3641 if( rc!=SQLITE_OK ) goto sync_exit;
3642 }
danielk197713adf8a2004-06-03 16:08:41 +00003643
danielk1977d761c0c2004-11-05 16:37:02 +00003644#ifndef SQLITE_OMIT_AUTOVACUUM
3645 if( nTrunc!=0 ){
3646 rc = sqlite3pager_truncate(pPager, nTrunc);
3647 if( rc!=SQLITE_OK ) goto sync_exit;
3648 }
3649#endif
3650
danielk197713adf8a2004-06-03 16:08:41 +00003651 /* Write all dirty pages to the database file */
3652 pPg = pager_get_all_dirty_pages(pPager);
3653 rc = pager_write_pagelist(pPg);
3654 if( rc!=SQLITE_OK ) goto sync_exit;
3655
danielk1977aa5ccdf2004-06-14 05:10:42 +00003656 /* Sync the database file. */
3657 if( !pPager->noSync ){
drh054889e2005-11-30 03:20:31 +00003658 rc = sqlite3OsSync(pPager->fd, 0);
danielk197713adf8a2004-06-03 16:08:41 +00003659 }
danielk1977aa5ccdf2004-06-14 05:10:42 +00003660
3661 pPager->state = PAGER_SYNCED;
drh5229ae42006-03-23 23:29:04 +00003662 }else if( MEMDB && nTrunc!=0 ){
3663 rc = sqlite3pager_truncate(pPager, nTrunc);
danielk197713adf8a2004-06-03 16:08:41 +00003664 }
3665
3666sync_exit:
3667 return rc;
3668}
3669
danielk1977687566d2004-11-02 12:56:41 +00003670#ifndef SQLITE_OMIT_AUTOVACUUM
3671/*
3672** Move the page identified by pData to location pgno in the file.
3673**
3674** There must be no references to the current page pgno. If current page
3675** pgno is not already in the rollback journal, it is not written there by
3676** by this routine. The same applies to the page pData refers to on entry to
3677** this routine.
3678**
3679** References to the page refered to by pData remain valid. Updating any
3680** meta-data associated with page pData (i.e. data stored in the nExtra bytes
3681** allocated along with the page) is the responsibility of the caller.
3682**
danielk19775fd057a2005-03-09 13:09:43 +00003683** A transaction must be active when this routine is called. It used to be
3684** required that a statement transaction was not active, but this restriction
3685** has been removed (CREATE INDEX needs to move a page when a statement
3686** transaction is active).
danielk1977687566d2004-11-02 12:56:41 +00003687*/
3688int sqlite3pager_movepage(Pager *pPager, void *pData, Pgno pgno){
3689 PgHdr *pPg = DATA_TO_PGHDR(pData);
3690 PgHdr *pPgOld;
danielk1977f5fdda82004-11-03 08:44:05 +00003691 int h;
danielk197794daf7f2004-11-08 09:26:09 +00003692 Pgno needSyncPgno = 0;
danielk1977687566d2004-11-02 12:56:41 +00003693
danielk1977687566d2004-11-02 12:56:41 +00003694 assert( pPg->nRef>0 );
3695
danielk1977599fcba2004-11-08 07:13:13 +00003696 TRACE5("MOVE %d page %d (needSync=%d) moves to %d\n",
3697 PAGERID(pPager), pPg->pgno, pPg->needSync, pgno);
danielk1977ef73ee92004-11-06 12:26:07 +00003698
danielk197794daf7f2004-11-08 09:26:09 +00003699 if( pPg->needSync ){
3700 needSyncPgno = pPg->pgno;
3701 assert( pPg->inJournal );
3702 assert( pPg->dirty );
danielk1977ae825582004-11-23 09:06:55 +00003703 assert( pPager->needSync );
danielk197794daf7f2004-11-08 09:26:09 +00003704 }
3705
danielk1977687566d2004-11-02 12:56:41 +00003706 /* Unlink pPg from it's hash-chain */
danielk1977f5fdda82004-11-03 08:44:05 +00003707 unlinkHashChain(pPager, pPg);
danielk1977687566d2004-11-02 12:56:41 +00003708
danielk1977ef73ee92004-11-06 12:26:07 +00003709 /* If the cache contains a page with page-number pgno, remove it
danielk1977599fcba2004-11-08 07:13:13 +00003710 ** from it's hash chain. Also, if the PgHdr.needSync was set for
3711 ** page pgno before the 'move' operation, it needs to be retained
3712 ** for the page moved there.
danielk1977f5fdda82004-11-03 08:44:05 +00003713 */
danielk1977687566d2004-11-02 12:56:41 +00003714 pPgOld = pager_lookup(pPager, pgno);
3715 if( pPgOld ){
danielk1977f5fdda82004-11-03 08:44:05 +00003716 assert( pPgOld->nRef==0 );
3717 unlinkHashChain(pPager, pPgOld);
3718 pPgOld->dirty = 0;
danielk1977ef73ee92004-11-06 12:26:07 +00003719 if( pPgOld->needSync ){
danielk197745901d62004-11-10 15:27:38 +00003720 assert( pPgOld->inJournal );
3721 pPg->inJournal = 1;
danielk1977ef73ee92004-11-06 12:26:07 +00003722 pPg->needSync = 1;
danielk1977ae825582004-11-23 09:06:55 +00003723 assert( pPager->needSync );
danielk1977ef73ee92004-11-06 12:26:07 +00003724 }
danielk1977687566d2004-11-02 12:56:41 +00003725 }
3726
danielk1977f5fdda82004-11-03 08:44:05 +00003727 /* Change the page number for pPg and insert it into the new hash-chain. */
3728 pPg->pgno = pgno;
3729 h = pager_hash(pgno);
3730 if( pPager->aHash[h] ){
3731 assert( pPager->aHash[h]->pPrevHash==0 );
3732 pPager->aHash[h]->pPrevHash = pPg;
3733 }
3734 pPg->pNextHash = pPager->aHash[h];
3735 pPager->aHash[h] = pPg;
3736 pPg->pPrevHash = 0;
3737
danielk1977687566d2004-11-02 12:56:41 +00003738 pPg->dirty = 1;
3739 pPager->dirtyCache = 1;
3740
danielk197794daf7f2004-11-08 09:26:09 +00003741 if( needSyncPgno ){
3742 /* If needSyncPgno is non-zero, then the journal file needs to be
3743 ** sync()ed before any data is written to database file page needSyncPgno.
3744 ** Currently, no such page exists in the page-cache and the
3745 ** Pager.aInJournal bit has been set. This needs to be remedied by loading
3746 ** the page into the pager-cache and setting the PgHdr.needSync flag.
danielk1977ae825582004-11-23 09:06:55 +00003747 **
3748 ** The sqlite3pager_get() call may cause the journal to sync. So make
3749 ** sure the Pager.needSync flag is set too.
danielk197794daf7f2004-11-08 09:26:09 +00003750 */
3751 int rc;
3752 void *pNeedSync;
danielk1977ae825582004-11-23 09:06:55 +00003753 assert( pPager->needSync );
danielk197794daf7f2004-11-08 09:26:09 +00003754 rc = sqlite3pager_get(pPager, needSyncPgno, &pNeedSync);
3755 if( rc!=SQLITE_OK ) return rc;
danielk1977ae825582004-11-23 09:06:55 +00003756 pPager->needSync = 1;
danielk197794daf7f2004-11-08 09:26:09 +00003757 DATA_TO_PGHDR(pNeedSync)->needSync = 1;
3758 DATA_TO_PGHDR(pNeedSync)->inJournal = 1;
3759 DATA_TO_PGHDR(pNeedSync)->dirty = 1;
3760 sqlite3pager_unref(pNeedSync);
3761 }
3762
danielk1977687566d2004-11-02 12:56:41 +00003763 return SQLITE_OK;
3764}
3765#endif
3766
dougcurrie81c95ef2004-06-18 23:21:47 +00003767#if defined(SQLITE_DEBUG) || defined(SQLITE_TEST)
drh89ac8c12004-06-09 14:17:20 +00003768/*
3769** Return the current state of the file lock for the given pager.
3770** The return value is one of NO_LOCK, SHARED_LOCK, RESERVED_LOCK,
3771** PENDING_LOCK, or EXCLUSIVE_LOCK.
3772*/
3773int sqlite3pager_lockstate(Pager *pPager){
drh054889e2005-11-30 03:20:31 +00003774 return sqlite3OsLockState(pPager->fd);
drh89ac8c12004-06-09 14:17:20 +00003775}
3776#endif
3777
danielk197793758c82005-01-21 08:13:14 +00003778#ifdef SQLITE_DEBUG
drhdd793422001-06-28 01:54:48 +00003779/*
3780** Print a listing of all referenced pages and their ref count.
3781*/
drh3aac2dd2004-04-26 14:10:20 +00003782void sqlite3pager_refdump(Pager *pPager){
drhdd793422001-06-28 01:54:48 +00003783 PgHdr *pPg;
3784 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
3785 if( pPg->nRef<=0 ) continue;
drhfe63d1c2004-09-08 20:13:04 +00003786 sqlite3DebugPrintf("PAGE %3d addr=%p nRef=%d\n",
3787 pPg->pgno, PGHDR_TO_DATA(pPg), pPg->nRef);
drhdd793422001-06-28 01:54:48 +00003788 }
3789}
3790#endif
drh2e66f0b2005-04-28 17:18:48 +00003791
3792#endif /* SQLITE_OMIT_DISKIO */