blob: cc4f9a721e7a2482f89f80c4ccd82f3af2484ad2 [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**
drh3b59a5c2006-01-15 20:28:28 +000021** @(#) $Id: pager.c,v 1.237 2006/01/15 20:28:28 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*/
drh9cbe6352005-11-29 03:13:21 +000055#define PAGERID(p) FILEHANDLEID(&(p)->fd)
drh054889e2005-11-30 03:20:31 +000056#define FILEHANDLEID(fd) (sqlite3OsFileHandle(&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
193# define CODEC(P,D,N,X) if( P->xCodec ){ P->xCodec(P->pCodecArg,D,N,X); }
194#else
195# define CODEC(P,D,N,X)
196#endif
197
drhed7c8552001-04-11 14:29:21 +0000198/*
drh69688d52001-04-14 16:38:23 +0000199** Convert a pointer to a PgHdr into a pointer to its data
200** and back again.
drhed7c8552001-04-11 14:29:21 +0000201*/
202#define PGHDR_TO_DATA(P) ((void*)(&(P)[1]))
203#define DATA_TO_PGHDR(D) (&((PgHdr*)(D))[-1])
drh1c7880e2005-05-20 20:01:55 +0000204#define PGHDR_TO_EXTRA(G,P) ((void*)&((char*)(&(G)[1]))[(P)->pageSize])
drhac69b052004-05-12 13:30:07 +0000205#define PGHDR_TO_HIST(P,PGR) \
drh1c7880e2005-05-20 20:01:55 +0000206 ((PgHistory*)&((char*)(&(P)[1]))[(PGR)->pageSize+(PGR)->nExtra])
drhed7c8552001-04-11 14:29:21 +0000207
208/*
drhed7c8552001-04-11 14:29:21 +0000209** How big to make the hash table used for locating in-memory pages
danielk1977634f2982005-03-28 08:44:07 +0000210** by page number. This macro looks a little silly, but is evaluated
211** at compile-time, not run-time (at least for gcc this is true).
drhed7c8552001-04-11 14:29:21 +0000212*/
danielk1977634f2982005-03-28 08:44:07 +0000213#define N_PG_HASH (\
214 (MAX_PAGES>1024)?2048: \
215 (MAX_PAGES>512)?1024: \
216 (MAX_PAGES>256)?512: \
217 (MAX_PAGES>128)?256: \
218 (MAX_PAGES>64)?128:64 \
219)
drh836faa42003-01-11 13:30:57 +0000220
221/*
222** Hash a page number
223*/
224#define pager_hash(PN) ((PN)&(N_PG_HASH-1))
drhed7c8552001-04-11 14:29:21 +0000225
226/*
227** A open page cache is an instance of the following structure.
228*/
229struct Pager {
drh603240c2002-03-05 01:11:12 +0000230 u8 journalOpen; /* True if journal file descriptors is valid */
drh34e79ce2004-02-08 06:05:46 +0000231 u8 journalStarted; /* True if header of journal is synced */
232 u8 useJournal; /* Use a rollback journal on this file */
drh7bec5052005-02-06 02:45:41 +0000233 u8 noReadlock; /* Do not bother to obtain readlocks */
drhac69b052004-05-12 13:30:07 +0000234 u8 stmtOpen; /* True if the statement subjournal is open */
235 u8 stmtInUse; /* True we are in a statement subtransaction */
236 u8 stmtAutoopen; /* Open stmt journal when main journal is opened*/
drh603240c2002-03-05 01:11:12 +0000237 u8 noSync; /* Do not sync the journal if true */
drh968af522003-02-11 14:55:40 +0000238 u8 fullSync; /* Do extra syncs of the journal for robustness */
drha6abd042004-06-09 17:37:22 +0000239 u8 state; /* PAGER_UNLOCK, _SHARED, _RESERVED, etc. */
drh603240c2002-03-05 01:11:12 +0000240 u8 errMask; /* One of several kinds of errors */
241 u8 tempFile; /* zFilename is a temporary file */
242 u8 readOnly; /* True for a read-only database */
243 u8 needSync; /* True if an fsync() is needed on the journal */
drha6abd042004-06-09 17:37:22 +0000244 u8 dirtyCache; /* True if cached pages have changed */
drh193a6b42002-07-07 16:52:46 +0000245 u8 alwaysRollback; /* Disable dont_rollback() for all pages */
drhac69b052004-05-12 13:30:07 +0000246 u8 memDb; /* True to inhibit all file I/O */
drh6d156e42005-05-20 20:11:20 +0000247 u8 setMaster; /* True if a m-j name has been written to jrnl */
drhfcd35c72005-05-21 02:48:08 +0000248 int dbSize; /* Number of pages in the file */
249 int origDbSize; /* dbSize before the current change */
250 int stmtSize; /* Size of database (in pages) at stmt_begin() */
251 int nRec; /* Number of pages written to the journal */
252 u32 cksumInit; /* Quasi-random value added to every checksum */
253 int stmtNRec; /* Number of records in stmt subjournal */
254 int nExtra; /* Add this many bytes to each in-memory page */
255 int pageSize; /* Number of bytes in a page */
256 int nPage; /* Total number of in-memory pages */
257 int nMaxPage; /* High water mark of nPage */
258 int nRef; /* Number of in-memory pages with PgHdr.nRef>0 */
259 int mxPage; /* Maximum number of pages to hold in cache */
drh603240c2002-03-05 01:11:12 +0000260 u8 *aInJournal; /* One bit for each page in the database file */
drhac69b052004-05-12 13:30:07 +0000261 u8 *aInStmt; /* One bit for each page in the database */
drhfcd35c72005-05-21 02:48:08 +0000262 char *zFilename; /* Name of the database file */
263 char *zJournal; /* Name of the journal file */
264 char *zDirectory; /* Directory hold database and journal files */
drh9cbe6352005-11-29 03:13:21 +0000265 OsFile *fd, *jfd; /* File descriptors for database and journal */
266 OsFile *stfd; /* File descriptor for the statement subjournal*/
drh726de592004-06-10 23:35:50 +0000267 BusyHandler *pBusyHandler; /* Pointer to sqlite.busyHandler */
drhed7c8552001-04-11 14:29:21 +0000268 PgHdr *pFirst, *pLast; /* List of free pages */
drh341eae82003-01-21 02:39:36 +0000269 PgHdr *pFirstSynced; /* First free page with PgHdr.needSync==0 */
drhd9b02572001-04-15 00:37:09 +0000270 PgHdr *pAll; /* List of all pages */
drhac69b052004-05-12 13:30:07 +0000271 PgHdr *pStmt; /* List of pages in the statement subjournal */
drheb206252004-10-01 02:00:31 +0000272 i64 journalOff; /* Current byte offset in the journal file */
273 i64 journalHdr; /* Byte offset to previous journal header */
274 i64 stmtHdrOff; /* First journal header written this statement */
275 i64 stmtCksum; /* cksumInit when statement was started */
drh6d156e42005-05-20 20:11:20 +0000276 i64 stmtJSize; /* Size of journal at stmt_begin() */
danielk197776572402004-06-25 02:38:54 +0000277 int sectorSize; /* Assumed sector size during rollback */
drhfcd35c72005-05-21 02:48:08 +0000278#ifdef SQLITE_TEST
drh6d156e42005-05-20 20:11:20 +0000279 int nHit, nMiss, nOvfl; /* Cache hits, missing, and LRU overflows */
280 int nRead,nWrite; /* Database pages read/written */
drhfcd35c72005-05-21 02:48:08 +0000281#endif
drh6d156e42005-05-20 20:11:20 +0000282 void (*xDestructor)(void*,int); /* Call this routine when freeing pages */
283 void (*xReiniter)(void*,int); /* Call this routine when reloading pages */
284 void (*xCodec)(void*,void*,Pgno,int); /* Routine for en/decoding data */
285 void *pCodecArg; /* First argument to xCodec() */
drh76ff3a02004-09-24 22:32:30 +0000286 PgHdr *aHash[N_PG_HASH]; /* Hash table to map page number to PgHdr */
drh6f7adc82006-01-11 21:41:20 +0000287#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
danielk197713f72992005-12-18 08:51:22 +0000288 Pager *pNext; /* Linked list of pagers in this thread */
289#endif
drhd9b02572001-04-15 00:37:09 +0000290};
291
292/*
drhfcd35c72005-05-21 02:48:08 +0000293** If SQLITE_TEST is defined then increment the variable given in
294** the argument
295*/
296#ifdef SQLITE_TEST
297# define TEST_INCR(x) x++
298#else
299# define TEST_INCR(x)
300#endif
301
302/*
drhd9b02572001-04-15 00:37:09 +0000303** These are bits that can be set in Pager.errMask.
danielk1977aef0bf62005-12-30 16:28:01 +0000304**
305** TODO: Maybe we just want a variable - Pager.errCode. Can we really
306** have two simultaneous error conditions?
307**
308** Recovering from an SQLITE_FULL, SQLITE_LOCK, SQLITE_CORRUPT or
309** SQLITE_IOERR error is not a simple matter, particularly if the pager
310** cache is shared between multiple connections.
311**
312** SQLITE_FULL (PAGER_ERR_FULL):
313** Cleared when the transaction is rolled back.
314**
315** SQLITE_CORRUPT (PAGER_ERR_CORRUPT):
316** Cannot be cleared. The upper layer must close the current pager
317** and open a new one on the same file to continue.
318**
319** SQLITE_PROTOCOL (PAGER_ERR_LOCK):
320** This error only occurs if an internal error occurs or another process
321** is not following the sqlite locking protocol (i.e. someone is
322** manipulating the database file using something other than sqlite).
323** This is handled in the same way as database corruption - the error
324** cannot be cleared except by closing the current pager and opening
325** a brand new one on the same file.
326**
327** SQLITE_IOERR (PAGER_ERR_DISK):
328** Cleared when the transaction is rolled back.
drhd9b02572001-04-15 00:37:09 +0000329*/
330#define PAGER_ERR_FULL 0x01 /* a write() failed */
danielk1977aef0bf62005-12-30 16:28:01 +0000331#define PAGER_ERR_LOCK 0x02 /* error in the locking protocol */
332#define PAGER_ERR_CORRUPT 0x04 /* database or journal corruption */
333#define PAGER_ERR_DISK 0x08 /* general disk I/O error - bad hard drive? */
drhd9b02572001-04-15 00:37:09 +0000334
335/*
drh5e00f6c2001-09-13 13:46:56 +0000336** Journal files begin with the following magic string. The data
337** was obtained from /dev/random. It is used only as a sanity check.
drh94f33312002-08-12 12:29:56 +0000338**
drhae2b40c2004-06-09 19:03:54 +0000339** Since version 2.8.0, the journal format contains additional sanity
340** checking information. If the power fails while the journal is begin
341** written, semi-random garbage data might appear in the journal
342** file after power is restored. If an attempt is then made
drh968af522003-02-11 14:55:40 +0000343** to roll the journal back, the database could be corrupted. The additional
344** sanity checking data is an attempt to discover the garbage in the
345** journal and ignore it.
346**
drhae2b40c2004-06-09 19:03:54 +0000347** The sanity checking information for the new journal format consists
drh968af522003-02-11 14:55:40 +0000348** of a 32-bit checksum on each page of data. The checksum covers both
drh90f5ecb2004-07-22 01:19:35 +0000349** the page number and the pPager->pageSize bytes of data for the page.
drh968af522003-02-11 14:55:40 +0000350** This cksum is initialized to a 32-bit random value that appears in the
351** journal file right after the header. The random initializer is important,
352** because garbage data that appears at the end of a journal is likely
353** data that was once in other files that have now been deleted. If the
354** garbage data came from an obsolete journal file, the checksums might
355** be correct. But by initializing the checksum to random value which
356** is different for every journal, we minimize that risk.
drhd9b02572001-04-15 00:37:09 +0000357*/
drhae2b40c2004-06-09 19:03:54 +0000358static const unsigned char aJournalMagic[] = {
359 0xd9, 0xd5, 0x05, 0xf9, 0x20, 0xa1, 0x63, 0xd7,
drhed7c8552001-04-11 14:29:21 +0000360};
361
362/*
drh726de592004-06-10 23:35:50 +0000363** The size of the header and of each page in the journal is determined
364** by the following macros.
drh968af522003-02-11 14:55:40 +0000365*/
drhae2b40c2004-06-09 19:03:54 +0000366#define JOURNAL_PG_SZ(pPager) ((pPager->pageSize) + 8)
drh968af522003-02-11 14:55:40 +0000367
danielk197776572402004-06-25 02:38:54 +0000368/*
369** The journal header size for this pager. In the future, this could be
370** set to some value read from the disk controller. The important
371** characteristic is that it is the same size as a disk sector.
372*/
373#define JOURNAL_HDR_SZ(pPager) (pPager->sectorSize)
374
drhb7f91642004-10-31 02:22:47 +0000375/*
376** The macro MEMDB is true if we are dealing with an in-memory database.
377** We do this as a macro so that if the SQLITE_OMIT_MEMORYDB macro is set,
378** the value of MEMDB will be a constant and the compiler will optimize
379** out code that would never execute.
380*/
381#ifdef SQLITE_OMIT_MEMORYDB
382# define MEMDB 0
383#else
384# define MEMDB pPager->memDb
385#endif
386
387/*
388** The default size of a disk sector
389*/
danielk197776572402004-06-25 02:38:54 +0000390#define PAGER_SECTOR_SIZE 512
391
392/*
393** Page number PAGER_MJ_PGNO is never used in an SQLite database (it is
394** reserved for working around a windows/posix incompatibility). It is
395** used in the journal to signify that the remainder of the journal file
396** is devoted to storing a master journal name - there are no more pages to
397** roll back. See comments for function writeMasterJournal() for details.
398*/
danielk1977599fcba2004-11-08 07:13:13 +0000399/* #define PAGER_MJ_PGNO(x) (PENDING_BYTE/((x)->pageSize)) */
400#define PAGER_MJ_PGNO(x) ((PENDING_BYTE/((x)->pageSize))+1)
danielk197713adf8a2004-06-03 16:08:41 +0000401
drh968af522003-02-11 14:55:40 +0000402/*
danielk197726836652005-01-17 01:33:13 +0000403** The maximum legal page number is (2^31 - 1).
404*/
405#define PAGER_MAX_PGNO 2147483647
406
407/*
drh726de592004-06-10 23:35:50 +0000408** Enable reference count tracking (for debugging) here:
drhdd793422001-06-28 01:54:48 +0000409*/
danielk1977aca790a2005-01-13 11:07:52 +0000410#ifdef SQLITE_DEBUG
drh3aac2dd2004-04-26 14:10:20 +0000411 int pager3_refinfo_enable = 0;
drhdd793422001-06-28 01:54:48 +0000412 static void pager_refinfo(PgHdr *p){
413 static int cnt = 0;
drh3aac2dd2004-04-26 14:10:20 +0000414 if( !pager3_refinfo_enable ) return;
drhfe63d1c2004-09-08 20:13:04 +0000415 sqlite3DebugPrintf(
416 "REFCNT: %4d addr=%p nRef=%d\n",
417 p->pgno, PGHDR_TO_DATA(p), p->nRef
drhdd793422001-06-28 01:54:48 +0000418 );
419 cnt++; /* Something to set a breakpoint on */
420 }
421# define REFINFO(X) pager_refinfo(X)
422#else
423# define REFINFO(X)
424#endif
425
426/*
drh34e79ce2004-02-08 06:05:46 +0000427** Read a 32-bit integer from the given file descriptor. Store the integer
428** that is read in *pRes. Return SQLITE_OK if everything worked, or an
429** error code is something goes wrong.
drh726de592004-06-10 23:35:50 +0000430**
431** All values are stored on disk as big-endian.
drh94f33312002-08-12 12:29:56 +0000432*/
drhae2b40c2004-06-09 19:03:54 +0000433static int read32bits(OsFile *fd, u32 *pRes){
drh3b59a5c2006-01-15 20:28:28 +0000434 unsigned char ac[4];
435 int rc = sqlite3OsRead(fd, ac, sizeof(ac));
drhae2b40c2004-06-09 19:03:54 +0000436 if( rc==SQLITE_OK ){
drh3b59a5c2006-01-15 20:28:28 +0000437 *pRes = (ac[0]<<24) | (ac[1]<<16) | (ac[2]<<8) | ac[3];
drh94f33312002-08-12 12:29:56 +0000438 }
drh94f33312002-08-12 12:29:56 +0000439 return rc;
440}
441
442/*
drh97b57482006-01-10 20:32:32 +0000443** Write a 32-bit integer into a string buffer in big-endian byte order.
444*/
445static void put32bits(char *ac, u32 val){
446 ac[0] = (val>>24) & 0xff;
447 ac[1] = (val>>16) & 0xff;
448 ac[2] = (val>>8) & 0xff;
449 ac[3] = val & 0xff;
450}
451
452/*
drh34e79ce2004-02-08 06:05:46 +0000453** Write a 32-bit integer into the given file descriptor. Return SQLITE_OK
454** on success or an error code is something goes wrong.
drh94f33312002-08-12 12:29:56 +0000455*/
456static int write32bits(OsFile *fd, u32 val){
457 unsigned char ac[4];
drh97b57482006-01-10 20:32:32 +0000458 put32bits(ac, val);
drh054889e2005-11-30 03:20:31 +0000459 return sqlite3OsWrite(fd, ac, 4);
drh94f33312002-08-12 12:29:56 +0000460}
461
drh2554f8b2003-01-22 01:26:44 +0000462/*
danielk1977aa5ccdf2004-06-14 05:10:42 +0000463** Write the 32-bit integer 'val' into the page identified by page header
464** 'p' at offset 'offset'.
drh2554f8b2003-01-22 01:26:44 +0000465*/
drh968af522003-02-11 14:55:40 +0000466static void store32bits(u32 val, PgHdr *p, int offset){
drh2554f8b2003-01-22 01:26:44 +0000467 unsigned char *ac;
drhec1bd0b2003-08-26 11:41:27 +0000468 ac = &((unsigned char*)PGHDR_TO_DATA(p))[offset];
drh97b57482006-01-10 20:32:32 +0000469 put32bits(ac, val);
drh2554f8b2003-01-22 01:26:44 +0000470}
471
danielk1977aa5ccdf2004-06-14 05:10:42 +0000472/*
473** Read a 32-bit integer at offset 'offset' from the page identified by
474** page header 'p'.
475*/
476static u32 retrieve32bits(PgHdr *p, int offset){
477 unsigned char *ac;
478 ac = &((unsigned char*)PGHDR_TO_DATA(p))[offset];
479 return (ac[0]<<24) | (ac[1]<<16) | (ac[2]<<8) | ac[3];
480}
481
drh94f33312002-08-12 12:29:56 +0000482
483/*
drhd9b02572001-04-15 00:37:09 +0000484** Convert the bits in the pPager->errMask into an approprate
485** return code.
486*/
487static int pager_errcode(Pager *pPager){
488 int rc = SQLITE_OK;
489 if( pPager->errMask & PAGER_ERR_LOCK ) rc = SQLITE_PROTOCOL;
drh81a20f22001-10-12 17:30:04 +0000490 if( pPager->errMask & PAGER_ERR_DISK ) rc = SQLITE_IOERR;
drhd9b02572001-04-15 00:37:09 +0000491 if( pPager->errMask & PAGER_ERR_FULL ) rc = SQLITE_FULL;
drhd9b02572001-04-15 00:37:09 +0000492 if( pPager->errMask & PAGER_ERR_CORRUPT ) rc = SQLITE_CORRUPT;
493 return rc;
drhed7c8552001-04-11 14:29:21 +0000494}
495
danielk1977aef0bf62005-12-30 16:28:01 +0000496/*
497** This function should be called when an error occurs within the pager
498** code to set the appropriate bits in Pager.errMask.
499*/
500static int pager_error(Pager *pPager, int rc){
501 switch( rc ){
502 case SQLITE_PROTOCOL:
503 pPager->errMask |= PAGER_ERR_LOCK;
504 break;
505 case SQLITE_IOERR:
506 pPager->errMask |= PAGER_ERR_DISK;
507 break;
508 case SQLITE_FULL:
509 pPager->errMask |= PAGER_ERR_FULL;
510 break;
511 case SQLITE_CORRUPT:
512 pPager->errMask |= PAGER_ERR_CORRUPT;
513 break;
514 }
515 return rc;
516}
517
danielk19773c407372005-02-15 02:54:14 +0000518#ifdef SQLITE_CHECK_PAGES
519/*
520** Return a 32-bit hash of the page data for pPage.
521*/
522static u32 pager_pagehash(PgHdr *pPage){
523 u32 hash = 0;
524 int i;
525 unsigned char *pData = (unsigned char *)PGHDR_TO_DATA(pPage);
526 for(i=0; i<pPage->pPager->pageSize; i++){
527 hash = (hash+i)^pData[i];
528 }
529 return hash;
530}
531
532/*
533** The CHECK_PAGE macro takes a PgHdr* as an argument. If SQLITE_CHECK_PAGES
534** is defined, and NDEBUG is not defined, an assert() statement checks
535** that the page is either dirty or still matches the calculated page-hash.
536*/
537#define CHECK_PAGE(x) checkPage(x)
538static void checkPage(PgHdr *pPg){
539 Pager *pPager = pPg->pPager;
540 assert( !pPg->pageHash || pPager->errMask || MEMDB || pPg->dirty ||
541 pPg->pageHash==pager_pagehash(pPg) );
542}
543
544#else
545#define CHECK_PAGE(x)
546#endif
547
drhed7c8552001-04-11 14:29:21 +0000548/*
danielk197776572402004-06-25 02:38:54 +0000549** When this is called the journal file for pager pPager must be open.
550** The master journal file name is read from the end of the file and
551** written into memory obtained from sqliteMalloc(). *pzMaster is
552** set to point at the memory and SQLITE_OK returned. The caller must
553** sqliteFree() *pzMaster.
554**
555** If no master journal file name is present *pzMaster is set to 0 and
556** SQLITE_OK returned.
557*/
558static int readMasterJournal(OsFile *pJrnl, char **pzMaster){
559 int rc;
560 u32 len;
drheb206252004-10-01 02:00:31 +0000561 i64 szJ;
danielk1977c3e8f5e2004-06-28 01:16:46 +0000562 u32 cksum;
danielk1977cafadba2004-06-25 11:11:54 +0000563 int i;
danielk197776572402004-06-25 02:38:54 +0000564 unsigned char aMagic[8]; /* A buffer to hold the magic header */
565
566 *pzMaster = 0;
567
drh054889e2005-11-30 03:20:31 +0000568 rc = sqlite3OsFileSize(pJrnl, &szJ);
danielk1977cafadba2004-06-25 11:11:54 +0000569 if( rc!=SQLITE_OK || szJ<16 ) return rc;
danielk197776572402004-06-25 02:38:54 +0000570
drh054889e2005-11-30 03:20:31 +0000571 rc = sqlite3OsSeek(pJrnl, szJ-16);
danielk197776572402004-06-25 02:38:54 +0000572 if( rc!=SQLITE_OK ) return rc;
573
574 rc = read32bits(pJrnl, &len);
575 if( rc!=SQLITE_OK ) return rc;
576
danielk1977cafadba2004-06-25 11:11:54 +0000577 rc = read32bits(pJrnl, &cksum);
578 if( rc!=SQLITE_OK ) return rc;
579
drh054889e2005-11-30 03:20:31 +0000580 rc = sqlite3OsRead(pJrnl, aMagic, 8);
danielk197776572402004-06-25 02:38:54 +0000581 if( rc!=SQLITE_OK || memcmp(aMagic, aJournalMagic, 8) ) return rc;
582
drh054889e2005-11-30 03:20:31 +0000583 rc = sqlite3OsSeek(pJrnl, szJ-16-len);
danielk197776572402004-06-25 02:38:54 +0000584 if( rc!=SQLITE_OK ) return rc;
585
danielk19778191bff2004-06-28 04:52:30 +0000586 *pzMaster = (char *)sqliteMalloc(len+1);
danielk197776572402004-06-25 02:38:54 +0000587 if( !*pzMaster ){
588 return SQLITE_NOMEM;
589 }
drh054889e2005-11-30 03:20:31 +0000590 rc = sqlite3OsRead(pJrnl, *pzMaster, len);
danielk197776572402004-06-25 02:38:54 +0000591 if( rc!=SQLITE_OK ){
592 sqliteFree(*pzMaster);
593 *pzMaster = 0;
594 return rc;
595 }
danielk1977cafadba2004-06-25 11:11:54 +0000596
597 /* See if the checksum matches the master journal name */
598 for(i=0; i<len; i++){
danielk19778191bff2004-06-28 04:52:30 +0000599 cksum -= (*pzMaster)[i];
danielk1977cafadba2004-06-25 11:11:54 +0000600 }
danielk19778191bff2004-06-28 04:52:30 +0000601 if( cksum ){
602 /* If the checksum doesn't add up, then one or more of the disk sectors
603 ** containing the master journal filename is corrupted. This means
604 ** definitely roll back, so just return SQLITE_OK and report a (nul)
605 ** master-journal filename.
606 */
danielk1977cafadba2004-06-25 11:11:54 +0000607 sqliteFree(*pzMaster);
608 *pzMaster = 0;
danielk1977aca790a2005-01-13 11:07:52 +0000609 }else{
610 (*pzMaster)[len] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000611 }
danielk197776572402004-06-25 02:38:54 +0000612
613 return SQLITE_OK;
614}
615
616/*
617** Seek the journal file descriptor to the next sector boundary where a
618** journal header may be read or written. Pager.journalOff is updated with
619** the new seek offset.
620**
621** i.e for a sector size of 512:
622**
623** Input Offset Output Offset
624** ---------------------------------------
625** 0 0
626** 512 512
627** 100 512
628** 2000 2048
629**
630*/
631static int seekJournalHdr(Pager *pPager){
drheb206252004-10-01 02:00:31 +0000632 i64 offset = 0;
633 i64 c = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000634 if( c ){
635 offset = ((c-1)/JOURNAL_HDR_SZ(pPager) + 1) * JOURNAL_HDR_SZ(pPager);
636 }
637 assert( offset%JOURNAL_HDR_SZ(pPager)==0 );
638 assert( offset>=c );
639 assert( (offset-c)<JOURNAL_HDR_SZ(pPager) );
640 pPager->journalOff = offset;
drh054889e2005-11-30 03:20:31 +0000641 return sqlite3OsSeek(pPager->jfd, pPager->journalOff);
danielk197776572402004-06-25 02:38:54 +0000642}
643
644/*
645** The journal file must be open when this routine is called. A journal
646** header (JOURNAL_HDR_SZ bytes) is written into the journal file at the
647** current location.
648**
649** The format for the journal header is as follows:
650** - 8 bytes: Magic identifying journal format.
651** - 4 bytes: Number of records in journal, or -1 no-sync mode is on.
652** - 4 bytes: Random number used for page hash.
653** - 4 bytes: Initial database page count.
654** - 4 bytes: Sector size used by the process that wrote this journal.
655**
danielk1977f42f25c2004-06-25 07:21:28 +0000656** Followed by (JOURNAL_HDR_SZ - 24) bytes of unused space.
danielk197776572402004-06-25 02:38:54 +0000657*/
658static int writeJournalHdr(Pager *pPager){
drh97b57482006-01-10 20:32:32 +0000659 char zHeader[sizeof(aJournalMagic)+16];
danielk197776572402004-06-25 02:38:54 +0000660
661 int rc = seekJournalHdr(pPager);
662 if( rc ) return rc;
663
664 pPager->journalHdr = pPager->journalOff;
665 if( pPager->stmtHdrOff==0 ){
666 pPager->stmtHdrOff = pPager->journalHdr;
667 }
668 pPager->journalOff += JOURNAL_HDR_SZ(pPager);
669
670 /* FIX ME:
671 **
672 ** Possibly for a pager not in no-sync mode, the journal magic should not
673 ** be written until nRec is filled in as part of next syncJournal().
674 **
675 ** Actually maybe the whole journal header should be delayed until that
676 ** point. Think about this.
677 */
drh97b57482006-01-10 20:32:32 +0000678 memcpy(zHeader, aJournalMagic, sizeof(aJournalMagic));
679 /* The nRec Field. 0xFFFFFFFF for no-sync journals. */
680 put32bits(&zHeader[sizeof(aJournalMagic)], pPager->noSync ? 0xffffffff : 0);
681 /* The random check-hash initialiser */
682 sqlite3Randomness(sizeof(pPager->cksumInit), &pPager->cksumInit);
683 put32bits(&zHeader[sizeof(aJournalMagic)+4], pPager->cksumInit);
684 /* The initial database size */
685 put32bits(&zHeader[sizeof(aJournalMagic)+8], pPager->dbSize);
686 /* The assumed sector size for this process */
687 put32bits(&zHeader[sizeof(aJournalMagic)+12], pPager->sectorSize);
688 rc = sqlite3OsWrite(pPager->jfd, zHeader, sizeof(zHeader));
danielk197776572402004-06-25 02:38:54 +0000689
690 /* The journal header has been written successfully. Seek the journal
691 ** file descriptor to the end of the journal header sector.
692 */
693 if( rc==SQLITE_OK ){
drh054889e2005-11-30 03:20:31 +0000694 rc = sqlite3OsSeek(pPager->jfd, pPager->journalOff-1);
drhb4746b92005-09-09 01:32:06 +0000695 if( rc==SQLITE_OK ){
drh054889e2005-11-30 03:20:31 +0000696 rc = sqlite3OsWrite(pPager->jfd, "\000", 1);
drhb4746b92005-09-09 01:32:06 +0000697 }
danielk197776572402004-06-25 02:38:54 +0000698 }
699 return rc;
700}
701
702/*
703** The journal file must be open when this is called. A journal header file
704** (JOURNAL_HDR_SZ bytes) is read from the current location in the journal
705** file. See comments above function writeJournalHdr() for a description of
706** the journal header format.
707**
708** If the header is read successfully, *nRec is set to the number of
709** page records following this header and *dbSize is set to the size of the
710** database before the transaction began, in pages. Also, pPager->cksumInit
711** is set to the value read from the journal header. SQLITE_OK is returned
712** in this case.
713**
714** If the journal header file appears to be corrupted, SQLITE_DONE is
715** returned and *nRec and *dbSize are not set. If JOURNAL_HDR_SZ bytes
716** cannot be read from the journal file an error code is returned.
717*/
718static int readJournalHdr(
719 Pager *pPager,
drheb206252004-10-01 02:00:31 +0000720 i64 journalSize,
danielk197776572402004-06-25 02:38:54 +0000721 u32 *pNRec,
722 u32 *pDbSize
723){
724 int rc;
725 unsigned char aMagic[8]; /* A buffer to hold the magic header */
726
727 rc = seekJournalHdr(pPager);
728 if( rc ) return rc;
729
730 if( pPager->journalOff+JOURNAL_HDR_SZ(pPager) > journalSize ){
731 return SQLITE_DONE;
732 }
733
drh054889e2005-11-30 03:20:31 +0000734 rc = sqlite3OsRead(pPager->jfd, aMagic, sizeof(aMagic));
danielk197776572402004-06-25 02:38:54 +0000735 if( rc ) return rc;
736
737 if( memcmp(aMagic, aJournalMagic, sizeof(aMagic))!=0 ){
738 return SQLITE_DONE;
739 }
740
drh9cbe6352005-11-29 03:13:21 +0000741 rc = read32bits(pPager->jfd, pNRec);
danielk197776572402004-06-25 02:38:54 +0000742 if( rc ) return rc;
743
drh9cbe6352005-11-29 03:13:21 +0000744 rc = read32bits(pPager->jfd, &pPager->cksumInit);
danielk197776572402004-06-25 02:38:54 +0000745 if( rc ) return rc;
746
drh9cbe6352005-11-29 03:13:21 +0000747 rc = read32bits(pPager->jfd, pDbSize);
danielk197776572402004-06-25 02:38:54 +0000748 if( rc ) return rc;
749
750 /* Update the assumed sector-size to match the value used by
751 ** the process that created this journal. If this journal was
752 ** created by a process other than this one, then this routine
753 ** is being called from within pager_playback(). The local value
754 ** of Pager.sectorSize is restored at the end of that routine.
755 */
drh9cbe6352005-11-29 03:13:21 +0000756 rc = read32bits(pPager->jfd, (u32 *)&pPager->sectorSize);
danielk197776572402004-06-25 02:38:54 +0000757 if( rc ) return rc;
758
759 pPager->journalOff += JOURNAL_HDR_SZ(pPager);
drh054889e2005-11-30 03:20:31 +0000760 rc = sqlite3OsSeek(pPager->jfd, pPager->journalOff);
danielk197776572402004-06-25 02:38:54 +0000761 return rc;
762}
763
764
765/*
766** Write the supplied master journal name into the journal file for pager
danielk1977cafadba2004-06-25 11:11:54 +0000767** pPager at the current location. The master journal name must be the last
768** thing written to a journal file. If the pager is in full-sync mode, the
769** journal file descriptor is advanced to the next sector boundary before
770** anything is written. The format is:
771**
772** + 4 bytes: PAGER_MJ_PGNO.
773** + N bytes: length of master journal name.
774** + 4 bytes: N
775** + 4 bytes: Master journal name checksum.
776** + 8 bytes: aJournalMagic[].
777**
778** The master journal page checksum is the sum of the bytes in the master
779** journal name.
danielk1977aef0bf62005-12-30 16:28:01 +0000780**
781** If zMaster is a NULL pointer (occurs for a single database transaction),
782** this call is a no-op.
danielk197776572402004-06-25 02:38:54 +0000783*/
784static int writeMasterJournal(Pager *pPager, const char *zMaster){
785 int rc;
786 int len;
danielk1977cafadba2004-06-25 11:11:54 +0000787 int i;
drh97b57482006-01-10 20:32:32 +0000788 u32 cksum = 0;
789 char zBuf[sizeof(aJournalMagic)+2*4];
danielk197776572402004-06-25 02:38:54 +0000790
791 if( !zMaster || pPager->setMaster) return SQLITE_OK;
792 pPager->setMaster = 1;
793
794 len = strlen(zMaster);
danielk1977cafadba2004-06-25 11:11:54 +0000795 for(i=0; i<len; i++){
796 cksum += zMaster[i];
797 }
danielk197776572402004-06-25 02:38:54 +0000798
799 /* If in full-sync mode, advance to the next disk sector before writing
800 ** the master journal name. This is in case the previous page written to
801 ** the journal has already been synced.
802 */
803 if( pPager->fullSync ){
804 rc = seekJournalHdr(pPager);
805 if( rc!=SQLITE_OK ) return rc;
806 }
danielk1977cafadba2004-06-25 11:11:54 +0000807 pPager->journalOff += (len+20);
danielk197776572402004-06-25 02:38:54 +0000808
drh9cbe6352005-11-29 03:13:21 +0000809 rc = write32bits(pPager->jfd, PAGER_MJ_PGNO(pPager));
danielk197776572402004-06-25 02:38:54 +0000810 if( rc!=SQLITE_OK ) return rc;
811
drh054889e2005-11-30 03:20:31 +0000812 rc = sqlite3OsWrite(pPager->jfd, zMaster, len);
danielk197776572402004-06-25 02:38:54 +0000813 if( rc!=SQLITE_OK ) return rc;
814
drh97b57482006-01-10 20:32:32 +0000815 put32bits(zBuf, len);
816 put32bits(&zBuf[4], cksum);
817 memcpy(&zBuf[8], aJournalMagic, sizeof(aJournalMagic));
818 rc = sqlite3OsWrite(pPager->jfd, zBuf, 8+sizeof(aJournalMagic));
drh2c8997b2005-08-27 16:36:48 +0000819 pPager->needSync = !pPager->noSync;
danielk197776572402004-06-25 02:38:54 +0000820 return rc;
821}
822
823/*
drh03eb96a2002-11-10 23:32:56 +0000824** Add or remove a page from the list of all pages that are in the
drhac69b052004-05-12 13:30:07 +0000825** statement journal.
drh03eb96a2002-11-10 23:32:56 +0000826**
827** The Pager keeps a separate list of pages that are currently in
drhac69b052004-05-12 13:30:07 +0000828** the statement journal. This helps the sqlite3pager_stmt_commit()
drh03eb96a2002-11-10 23:32:56 +0000829** routine run MUCH faster for the common case where there are many
drhac69b052004-05-12 13:30:07 +0000830** pages in memory but only a few are in the statement journal.
drh03eb96a2002-11-10 23:32:56 +0000831*/
drh3aac2dd2004-04-26 14:10:20 +0000832static void page_add_to_stmt_list(PgHdr *pPg){
drh03eb96a2002-11-10 23:32:56 +0000833 Pager *pPager = pPg->pPager;
drhac69b052004-05-12 13:30:07 +0000834 if( pPg->inStmt ) return;
835 assert( pPg->pPrevStmt==0 && pPg->pNextStmt==0 );
836 pPg->pPrevStmt = 0;
837 if( pPager->pStmt ){
838 pPager->pStmt->pPrevStmt = pPg;
drh03eb96a2002-11-10 23:32:56 +0000839 }
drhac69b052004-05-12 13:30:07 +0000840 pPg->pNextStmt = pPager->pStmt;
841 pPager->pStmt = pPg;
842 pPg->inStmt = 1;
drh03eb96a2002-11-10 23:32:56 +0000843}
drh3aac2dd2004-04-26 14:10:20 +0000844static void page_remove_from_stmt_list(PgHdr *pPg){
drhac69b052004-05-12 13:30:07 +0000845 if( !pPg->inStmt ) return;
846 if( pPg->pPrevStmt ){
847 assert( pPg->pPrevStmt->pNextStmt==pPg );
848 pPg->pPrevStmt->pNextStmt = pPg->pNextStmt;
drh03eb96a2002-11-10 23:32:56 +0000849 }else{
drhac69b052004-05-12 13:30:07 +0000850 assert( pPg->pPager->pStmt==pPg );
851 pPg->pPager->pStmt = pPg->pNextStmt;
drh03eb96a2002-11-10 23:32:56 +0000852 }
drhac69b052004-05-12 13:30:07 +0000853 if( pPg->pNextStmt ){
854 assert( pPg->pNextStmt->pPrevStmt==pPg );
855 pPg->pNextStmt->pPrevStmt = pPg->pPrevStmt;
drh03eb96a2002-11-10 23:32:56 +0000856 }
drhac69b052004-05-12 13:30:07 +0000857 pPg->pNextStmt = 0;
858 pPg->pPrevStmt = 0;
859 pPg->inStmt = 0;
drh03eb96a2002-11-10 23:32:56 +0000860}
861
862/*
drhed7c8552001-04-11 14:29:21 +0000863** Find a page in the hash table given its page number. Return
864** a pointer to the page or NULL if not found.
865*/
drhd9b02572001-04-15 00:37:09 +0000866static PgHdr *pager_lookup(Pager *pPager, Pgno pgno){
drh836faa42003-01-11 13:30:57 +0000867 PgHdr *p = pPager->aHash[pager_hash(pgno)];
drhed7c8552001-04-11 14:29:21 +0000868 while( p && p->pgno!=pgno ){
869 p = p->pNextHash;
870 }
871 return p;
872}
873
874/*
875** Unlock the database and clear the in-memory cache. This routine
876** sets the state of the pager back to what it was when it was first
877** opened. Any outstanding pages are invalidated and subsequent attempts
878** to access those pages will likely result in a coredump.
879*/
drhd9b02572001-04-15 00:37:09 +0000880static void pager_reset(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +0000881 PgHdr *pPg, *pNext;
danielk1977e94ddc92005-03-21 03:53:38 +0000882 if( pPager->errMask ) return;
drhd9b02572001-04-15 00:37:09 +0000883 for(pPg=pPager->pAll; pPg; pPg=pNext){
884 pNext = pPg->pNextAll;
885 sqliteFree(pPg);
drhed7c8552001-04-11 14:29:21 +0000886 }
887 pPager->pFirst = 0;
drh341eae82003-01-21 02:39:36 +0000888 pPager->pFirstSynced = 0;
drhd9b02572001-04-15 00:37:09 +0000889 pPager->pLast = 0;
890 pPager->pAll = 0;
drhed7c8552001-04-11 14:29:21 +0000891 memset(pPager->aHash, 0, sizeof(pPager->aHash));
892 pPager->nPage = 0;
drha6abd042004-06-09 17:37:22 +0000893 if( pPager->state>=PAGER_RESERVED ){
drh3aac2dd2004-04-26 14:10:20 +0000894 sqlite3pager_rollback(pPager);
drhed7c8552001-04-11 14:29:21 +0000895 }
drh054889e2005-11-30 03:20:31 +0000896 sqlite3OsUnlock(pPager->fd, NO_LOCK);
drha6abd042004-06-09 17:37:22 +0000897 pPager->state = PAGER_UNLOCK;
drhd9b02572001-04-15 00:37:09 +0000898 pPager->dbSize = -1;
drhed7c8552001-04-11 14:29:21 +0000899 pPager->nRef = 0;
drh8cfbf082001-09-19 13:22:39 +0000900 assert( pPager->journalOpen==0 );
drhed7c8552001-04-11 14:29:21 +0000901}
902
danielk19776b456a22005-03-21 04:04:02 +0000903/*
drhed7c8552001-04-11 14:29:21 +0000904** When this routine is called, the pager has the journal file open and
drha6abd042004-06-09 17:37:22 +0000905** a RESERVED or EXCLUSIVE lock on the database. This routine releases
906** the database lock and acquires a SHARED lock in its place. The journal
907** file is deleted and closed.
drh50457892003-09-06 01:10:47 +0000908**
909** TODO: Consider keeping the journal file open for temporary databases.
910** This might give a performance improvement on windows where opening
911** a file is an expensive operation.
drhed7c8552001-04-11 14:29:21 +0000912*/
drhd9b02572001-04-15 00:37:09 +0000913static int pager_unwritelock(Pager *pPager){
drhd9b02572001-04-15 00:37:09 +0000914 PgHdr *pPg;
drh9c105bb2004-10-02 20:38:28 +0000915 int rc;
drhb7f91642004-10-31 02:22:47 +0000916 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +0000917 if( pPager->state<PAGER_RESERVED ){
918 return SQLITE_OK;
919 }
drh3aac2dd2004-04-26 14:10:20 +0000920 sqlite3pager_stmt_commit(pPager);
drhac69b052004-05-12 13:30:07 +0000921 if( pPager->stmtOpen ){
drh054889e2005-11-30 03:20:31 +0000922 sqlite3OsClose(&pPager->stfd);
drhac69b052004-05-12 13:30:07 +0000923 pPager->stmtOpen = 0;
drh0f892532002-05-30 12:27:03 +0000924 }
drhda47d772002-12-02 04:25:19 +0000925 if( pPager->journalOpen ){
drh054889e2005-11-30 03:20:31 +0000926 sqlite3OsClose(&pPager->jfd);
drhda47d772002-12-02 04:25:19 +0000927 pPager->journalOpen = 0;
drh66560ad2006-01-06 14:32:19 +0000928 sqlite3OsDelete(pPager->zJournal);
drhda47d772002-12-02 04:25:19 +0000929 sqliteFree( pPager->aInJournal );
930 pPager->aInJournal = 0;
931 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
932 pPg->inJournal = 0;
933 pPg->dirty = 0;
drhdb48ee02003-01-16 13:42:43 +0000934 pPg->needSync = 0;
danielk19773c407372005-02-15 02:54:14 +0000935#ifdef SQLITE_CHECK_PAGES
936 pPg->pageHash = pager_pagehash(pPg);
937#endif
drhda47d772002-12-02 04:25:19 +0000938 }
danielk1977ef317ab2004-06-23 10:43:10 +0000939 pPager->dirtyCache = 0;
danielk1977ef317ab2004-06-23 10:43:10 +0000940 pPager->nRec = 0;
drhda47d772002-12-02 04:25:19 +0000941 }else{
drh88b01a12005-03-28 18:04:27 +0000942 assert( pPager->aInJournal==0 );
drha6abd042004-06-09 17:37:22 +0000943 assert( pPager->dirtyCache==0 || pPager->useJournal==0 );
drhd9b02572001-04-15 00:37:09 +0000944 }
drh054889e2005-11-30 03:20:31 +0000945 rc = sqlite3OsUnlock(pPager->fd, SHARED_LOCK);
drha6abd042004-06-09 17:37:22 +0000946 pPager->state = PAGER_SHARED;
danielk1977ef317ab2004-06-23 10:43:10 +0000947 pPager->origDbSize = 0;
danielk197776572402004-06-25 02:38:54 +0000948 pPager->setMaster = 0;
drh9c105bb2004-10-02 20:38:28 +0000949 return rc;
drhed7c8552001-04-11 14:29:21 +0000950}
951
drhed7c8552001-04-11 14:29:21 +0000952/*
drh968af522003-02-11 14:55:40 +0000953** Compute and return a checksum for the page of data.
drh34e79ce2004-02-08 06:05:46 +0000954**
955** This is not a real checksum. It is really just the sum of the
drh726de592004-06-10 23:35:50 +0000956** random initial value and the page number. We experimented with
957** a checksum of the entire data, but that was found to be too slow.
958**
959** Note that the page number is stored at the beginning of data and
960** the checksum is stored at the end. This is important. If journal
961** corruption occurs due to a power failure, the most likely scenario
962** is that one end or the other of the record will be changed. It is
963** much less likely that the two ends of the journal record will be
964** correct and the middle be corrupt. Thus, this "checksum" scheme,
965** though fast and simple, catches the mostly likely kind of corruption.
966**
967** FIX ME: Consider adding every 200th (or so) byte of the data to the
968** checksum. That way if a single page spans 3 or more disk sectors and
969** only the middle sector is corrupt, we will still have a reasonable
970** chance of failing the checksum and thus detecting the problem.
drh968af522003-02-11 14:55:40 +0000971*/
drh2646da72005-12-09 20:02:05 +0000972static u32 pager_cksum(Pager *pPager, Pgno pgno, const u8 *aData){
danielk1977ef317ab2004-06-23 10:43:10 +0000973 u32 cksum = pPager->cksumInit;
974 int i = pPager->pageSize-200;
975 while( i>0 ){
976 cksum += aData[i];
977 i -= 200;
978 }
drh968af522003-02-11 14:55:40 +0000979 return cksum;
980}
981
982/*
drhfa86c412002-02-02 15:01:15 +0000983** Read a single page from the journal file opened on file descriptor
984** jfd. Playback this one page.
drh968af522003-02-11 14:55:40 +0000985**
drh726de592004-06-10 23:35:50 +0000986** If useCksum==0 it means this journal does not use checksums. Checksums
987** are not used in statement journals because statement journals do not
988** need to survive power failures.
drhfa86c412002-02-02 15:01:15 +0000989*/
drhae2b40c2004-06-09 19:03:54 +0000990static int pager_playback_one_page(Pager *pPager, OsFile *jfd, int useCksum){
drhfa86c412002-02-02 15:01:15 +0000991 int rc;
drhae2b40c2004-06-09 19:03:54 +0000992 PgHdr *pPg; /* An existing page in the cache */
993 Pgno pgno; /* The page number of a page in journal */
994 u32 cksum; /* Checksum used for sanity checking */
drh90f5ecb2004-07-22 01:19:35 +0000995 u8 aData[SQLITE_MAX_PAGE_SIZE]; /* Temp storage for a page */
drhfa86c412002-02-02 15:01:15 +0000996
drh96362842005-03-20 22:47:56 +0000997 /* useCksum should be true for the main journal and false for
998 ** statement journals. Verify that this is always the case
999 */
drh9cbe6352005-11-29 03:13:21 +00001000 assert( jfd == (useCksum ? pPager->jfd : pPager->stfd) );
drh96362842005-03-20 22:47:56 +00001001
1002
drhae2b40c2004-06-09 19:03:54 +00001003 rc = read32bits(jfd, &pgno);
drh99ee3602003-02-16 19:13:36 +00001004 if( rc!=SQLITE_OK ) return rc;
drh054889e2005-11-30 03:20:31 +00001005 rc = sqlite3OsRead(jfd, &aData, pPager->pageSize);
drh99ee3602003-02-16 19:13:36 +00001006 if( rc!=SQLITE_OK ) return rc;
danielk197776572402004-06-25 02:38:54 +00001007 pPager->journalOff += pPager->pageSize + 4;
drhfa86c412002-02-02 15:01:15 +00001008
drh968af522003-02-11 14:55:40 +00001009 /* Sanity checking on the page. This is more important that I originally
1010 ** thought. If a power failure occurs while the journal is being written,
1011 ** it could cause invalid data to be written into the journal. We need to
1012 ** detect this invalid data (with high probability) and ignore it.
1013 */
danielk197775edc162004-06-26 01:48:18 +00001014 if( pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh968af522003-02-11 14:55:40 +00001015 return SQLITE_DONE;
1016 }
drhae2b40c2004-06-09 19:03:54 +00001017 if( pgno>(unsigned)pPager->dbSize ){
drh968af522003-02-11 14:55:40 +00001018 return SQLITE_OK;
1019 }
drhae2b40c2004-06-09 19:03:54 +00001020 if( useCksum ){
1021 rc = read32bits(jfd, &cksum);
drh99ee3602003-02-16 19:13:36 +00001022 if( rc ) return rc;
danielk197776572402004-06-25 02:38:54 +00001023 pPager->journalOff += 4;
drhae2b40c2004-06-09 19:03:54 +00001024 if( pager_cksum(pPager, pgno, aData)!=cksum ){
drh968af522003-02-11 14:55:40 +00001025 return SQLITE_DONE;
1026 }
1027 }
drhfa86c412002-02-02 15:01:15 +00001028
danielk1977aa5ccdf2004-06-14 05:10:42 +00001029 assert( pPager->state==PAGER_RESERVED || pPager->state>=PAGER_EXCLUSIVE );
danielk1977a3f3a5f2004-06-10 04:32:16 +00001030
1031 /* If the pager is in RESERVED state, then there must be a copy of this
1032 ** page in the pager cache. In this case just update the pager cache,
danielk19770de0bb32004-06-10 05:59:24 +00001033 ** not the database file. The page is left marked dirty in this case.
1034 **
danielk1977a3f3a5f2004-06-10 04:32:16 +00001035 ** If in EXCLUSIVE state, then we update the pager cache if it exists
1036 ** and the main file. The page is then marked not dirty.
drh96362842005-03-20 22:47:56 +00001037 **
1038 ** Ticket #1171: The statement journal might contain page content that is
1039 ** different from the page content at the start of the transaction.
1040 ** This occurs when a page is changed prior to the start of a statement
1041 ** then changed again within the statement. When rolling back such a
1042 ** statement we must not write to the original database unless we know
1043 ** for certain that original page contents are in the main rollback
1044 ** journal. Otherwise, if a full ROLLBACK occurs after the statement
1045 ** rollback the full ROLLBACK will not restore the page to its original
1046 ** content. Two conditions must be met before writing to the database
1047 ** files. (1) the database must be locked. (2) we know that the original
1048 ** page content is in the main journal either because the page is not in
1049 ** cache or else it is marked as needSync==0.
drhfa86c412002-02-02 15:01:15 +00001050 */
drhae2b40c2004-06-09 19:03:54 +00001051 pPg = pager_lookup(pPager, pgno);
drh96362842005-03-20 22:47:56 +00001052 assert( pPager->state>=PAGER_EXCLUSIVE || pPg!=0 );
danielk1977ef73ee92004-11-06 12:26:07 +00001053 TRACE3("PLAYBACK %d page %d\n", PAGERID(pPager), pgno);
drh96362842005-03-20 22:47:56 +00001054 if( pPager->state>=PAGER_EXCLUSIVE && (pPg==0 || pPg->needSync==0) ){
drh054889e2005-11-30 03:20:31 +00001055 rc = sqlite3OsSeek(pPager->fd, (pgno-1)*(i64)pPager->pageSize);
drhb4746b92005-09-09 01:32:06 +00001056 if( rc==SQLITE_OK ){
drh054889e2005-11-30 03:20:31 +00001057 rc = sqlite3OsWrite(pPager->fd, aData, pPager->pageSize);
drhb4746b92005-09-09 01:32:06 +00001058 }
drh96362842005-03-20 22:47:56 +00001059 if( pPg ) pPg->dirty = 0;
danielk1977a3f3a5f2004-06-10 04:32:16 +00001060 }
drhfa86c412002-02-02 15:01:15 +00001061 if( pPg ){
danielk197728129562005-01-11 10:25:06 +00001062 /* No page should ever be explicitly rolled back that is in use, except
1063 ** for page 1 which is held in use in order to keep the lock on the
1064 ** database active. However such a page may be rolled back as a result
1065 ** of an internal error resulting in an automatic call to
1066 ** sqlite3pager_rollback().
drhacf4ac92003-12-17 23:57:34 +00001067 */
drhb6f41482004-05-14 01:58:11 +00001068 void *pData;
danielk197728129562005-01-11 10:25:06 +00001069 /* assert( pPg->nRef==0 || pPg->pgno==1 ); */
drhb6f41482004-05-14 01:58:11 +00001070 pData = PGHDR_TO_DATA(pPg);
drhae2b40c2004-06-09 19:03:54 +00001071 memcpy(pData, aData, pPager->pageSize);
drh726de592004-06-10 23:35:50 +00001072 if( pPager->xDestructor ){ /*** FIX ME: Should this be xReinit? ***/
drhb6f41482004-05-14 01:58:11 +00001073 pPager->xDestructor(pData, pPager->pageSize);
drhde647132004-05-07 17:57:49 +00001074 }
danielk19773c407372005-02-15 02:54:14 +00001075#ifdef SQLITE_CHECK_PAGES
drh96362842005-03-20 22:47:56 +00001076 pPg->pageHash = pager_pagehash(pPg);
danielk19773c407372005-02-15 02:54:14 +00001077#endif
drhb6f41482004-05-14 01:58:11 +00001078 CODEC(pPager, pData, pPg->pgno, 3);
drhfa86c412002-02-02 15:01:15 +00001079 }
1080 return rc;
1081}
1082
1083/*
danielk197713adf8a2004-06-03 16:08:41 +00001084** Parameter zMaster is the name of a master journal file. A single journal
1085** file that referred to the master journal file has just been rolled back.
1086** This routine checks if it is possible to delete the master journal file,
1087** and does so if it is.
drh726de592004-06-10 23:35:50 +00001088**
1089** The master journal file contains the names of all child journals.
1090** To tell if a master journal can be deleted, check to each of the
1091** children. If all children are either missing or do not refer to
1092** a different master journal, then this master journal can be deleted.
danielk197713adf8a2004-06-03 16:08:41 +00001093*/
1094static int pager_delmaster(const char *zMaster){
1095 int rc;
1096 int master_open = 0;
drh9cbe6352005-11-29 03:13:21 +00001097 OsFile *master = 0;
danielk197713adf8a2004-06-03 16:08:41 +00001098 char *zMasterJournal = 0; /* Contents of master journal file */
drheb206252004-10-01 02:00:31 +00001099 i64 nMasterJournal; /* Size of master journal file */
danielk197713adf8a2004-06-03 16:08:41 +00001100
1101 /* Open the master journal file exclusively in case some other process
1102 ** is running this routine also. Not that it makes too much difference.
1103 */
drh66560ad2006-01-06 14:32:19 +00001104 rc = sqlite3OsOpenReadOnly(zMaster, &master);
danielk197713adf8a2004-06-03 16:08:41 +00001105 if( rc!=SQLITE_OK ) goto delmaster_out;
1106 master_open = 1;
drh054889e2005-11-30 03:20:31 +00001107 rc = sqlite3OsFileSize(master, &nMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001108 if( rc!=SQLITE_OK ) goto delmaster_out;
1109
1110 if( nMasterJournal>0 ){
danielk19775865e3d2004-06-14 06:03:57 +00001111 char *zJournal;
danielk197776572402004-06-25 02:38:54 +00001112 char *zMasterPtr = 0;
danielk19775865e3d2004-06-14 06:03:57 +00001113
1114 /* Load the entire master journal file into space obtained from
1115 ** sqliteMalloc() and pointed to by zMasterJournal.
danielk19775865e3d2004-06-14 06:03:57 +00001116 */
danielk197776572402004-06-25 02:38:54 +00001117 zMasterJournal = (char *)sqliteMalloc(nMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001118 if( !zMasterJournal ){
1119 rc = SQLITE_NOMEM;
1120 goto delmaster_out;
1121 }
drh054889e2005-11-30 03:20:31 +00001122 rc = sqlite3OsRead(master, zMasterJournal, nMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001123 if( rc!=SQLITE_OK ) goto delmaster_out;
1124
danielk19775865e3d2004-06-14 06:03:57 +00001125 zJournal = zMasterJournal;
1126 while( (zJournal-zMasterJournal)<nMasterJournal ){
drh66560ad2006-01-06 14:32:19 +00001127 if( sqlite3OsFileExists(zJournal) ){
danielk197713adf8a2004-06-03 16:08:41 +00001128 /* One of the journals pointed to by the master journal exists.
1129 ** Open it and check if it points at the master journal. If
1130 ** so, return without deleting the master journal file.
1131 */
drh9cbe6352005-11-29 03:13:21 +00001132 OsFile *journal = 0;
drh3b7b78b2004-11-24 01:16:43 +00001133 int c;
danielk197713adf8a2004-06-03 16:08:41 +00001134
drh66560ad2006-01-06 14:32:19 +00001135 rc = sqlite3OsOpenReadOnly(zJournal, &journal);
danielk197713adf8a2004-06-03 16:08:41 +00001136 if( rc!=SQLITE_OK ){
danielk197713adf8a2004-06-03 16:08:41 +00001137 goto delmaster_out;
1138 }
danielk197713adf8a2004-06-03 16:08:41 +00001139
drh9cbe6352005-11-29 03:13:21 +00001140 rc = readMasterJournal(journal, &zMasterPtr);
drh054889e2005-11-30 03:20:31 +00001141 sqlite3OsClose(&journal);
danielk19779eed5052004-06-04 10:38:30 +00001142 if( rc!=SQLITE_OK ){
danielk19779eed5052004-06-04 10:38:30 +00001143 goto delmaster_out;
1144 }
danielk197776572402004-06-25 02:38:54 +00001145
drh3b7b78b2004-11-24 01:16:43 +00001146 c = zMasterPtr!=0 && strcmp(zMasterPtr, zMaster)==0;
1147 sqliteFree(zMasterPtr);
1148 if( c ){
danielk197776572402004-06-25 02:38:54 +00001149 /* We have a match. Do not delete the master journal file. */
1150 goto delmaster_out;
danielk197713adf8a2004-06-03 16:08:41 +00001151 }
1152 }
danielk19775865e3d2004-06-14 06:03:57 +00001153 zJournal += (strlen(zJournal)+1);
danielk197713adf8a2004-06-03 16:08:41 +00001154 }
1155 }
1156
drh66560ad2006-01-06 14:32:19 +00001157 sqlite3OsDelete(zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001158
1159delmaster_out:
1160 if( zMasterJournal ){
1161 sqliteFree(zMasterJournal);
1162 }
1163 if( master_open ){
drh054889e2005-11-30 03:20:31 +00001164 sqlite3OsClose(&master);
danielk197713adf8a2004-06-03 16:08:41 +00001165 }
1166 return rc;
1167}
1168
1169/*
drha6abd042004-06-09 17:37:22 +00001170** Make every page in the cache agree with what is on disk. In other words,
1171** reread the disk to reset the state of the cache.
1172**
1173** This routine is called after a rollback in which some of the dirty cache
1174** pages had never been written out to disk. We need to roll back the
1175** cache content and the easiest way to do that is to reread the old content
1176** back from the disk.
1177*/
1178static int pager_reload_cache(Pager *pPager){
1179 PgHdr *pPg;
1180 int rc = SQLITE_OK;
1181 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
drh90f5ecb2004-07-22 01:19:35 +00001182 char zBuf[SQLITE_MAX_PAGE_SIZE];
drha6abd042004-06-09 17:37:22 +00001183 if( !pPg->dirty ) continue;
1184 if( (int)pPg->pgno <= pPager->origDbSize ){
drh054889e2005-11-30 03:20:31 +00001185 rc = sqlite3OsSeek(pPager->fd, pPager->pageSize*(i64)(pPg->pgno-1));
drhb4746b92005-09-09 01:32:06 +00001186 if( rc==SQLITE_OK ){
drh054889e2005-11-30 03:20:31 +00001187 rc = sqlite3OsRead(pPager->fd, zBuf, pPager->pageSize);
drhb4746b92005-09-09 01:32:06 +00001188 }
danielk1977ef73ee92004-11-06 12:26:07 +00001189 TRACE3("REFETCH %d page %d\n", PAGERID(pPager), pPg->pgno);
drha6abd042004-06-09 17:37:22 +00001190 if( rc ) break;
drh25d65432004-07-22 15:02:25 +00001191 CODEC(pPager, zBuf, pPg->pgno, 2);
drha6abd042004-06-09 17:37:22 +00001192 }else{
drh90f5ecb2004-07-22 01:19:35 +00001193 memset(zBuf, 0, pPager->pageSize);
drha6abd042004-06-09 17:37:22 +00001194 }
drh90f5ecb2004-07-22 01:19:35 +00001195 if( pPg->nRef==0 || memcmp(zBuf, PGHDR_TO_DATA(pPg), pPager->pageSize) ){
1196 memcpy(PGHDR_TO_DATA(pPg), zBuf, pPager->pageSize);
drha6abd042004-06-09 17:37:22 +00001197 if( pPager->xReiniter ){
1198 pPager->xReiniter(PGHDR_TO_DATA(pPg), pPager->pageSize);
1199 }else{
drh90f5ecb2004-07-22 01:19:35 +00001200 memset(PGHDR_TO_EXTRA(pPg, pPager), 0, pPager->nExtra);
drha6abd042004-06-09 17:37:22 +00001201 }
1202 }
1203 pPg->needSync = 0;
1204 pPg->dirty = 0;
danielk19773c407372005-02-15 02:54:14 +00001205#ifdef SQLITE_CHECK_PAGES
1206 pPg->pageHash = pager_pagehash(pPg);
1207#endif
drha6abd042004-06-09 17:37:22 +00001208 }
1209 return rc;
1210}
1211
drha6abd042004-06-09 17:37:22 +00001212/*
drhcb4c40b2004-08-18 19:09:43 +00001213** Truncate the main file of the given pager to the number of pages
1214** indicated.
1215*/
1216static int pager_truncate(Pager *pPager, int nPage){
danielk197717221812005-02-15 03:38:05 +00001217 assert( pPager->state>=PAGER_EXCLUSIVE );
drh054889e2005-11-30 03:20:31 +00001218 return sqlite3OsTruncate(pPager->fd, pPager->pageSize*(i64)nPage);
drhcb4c40b2004-08-18 19:09:43 +00001219}
1220
1221/*
drhed7c8552001-04-11 14:29:21 +00001222** Playback the journal and thus restore the database file to
1223** the state it was in before we started making changes.
1224**
drh34e79ce2004-02-08 06:05:46 +00001225** The journal file format is as follows:
1226**
drhae2b40c2004-06-09 19:03:54 +00001227** (1) 8 byte prefix. A copy of aJournalMagic[].
1228** (2) 4 byte big-endian integer which is the number of valid page records
drh34e79ce2004-02-08 06:05:46 +00001229** in the journal. If this value is 0xffffffff, then compute the
drhae2b40c2004-06-09 19:03:54 +00001230** number of page records from the journal size.
1231** (3) 4 byte big-endian integer which is the initial value for the
1232** sanity checksum.
1233** (4) 4 byte integer which is the number of pages to truncate the
drh34e79ce2004-02-08 06:05:46 +00001234** database to during a rollback.
drhae2b40c2004-06-09 19:03:54 +00001235** (5) 4 byte integer which is the number of bytes in the master journal
1236** name. The value may be zero (indicate that there is no master
1237** journal.)
1238** (6) N bytes of the master journal name. The name will be nul-terminated
1239** and might be shorter than the value read from (5). If the first byte
1240** of the name is \000 then there is no master journal. The master
1241** journal name is stored in UTF-8.
1242** (7) Zero or more pages instances, each as follows:
drh34e79ce2004-02-08 06:05:46 +00001243** + 4 byte page number.
drhae2b40c2004-06-09 19:03:54 +00001244** + pPager->pageSize bytes of data.
1245** + 4 byte checksum
drh34e79ce2004-02-08 06:05:46 +00001246**
drhae2b40c2004-06-09 19:03:54 +00001247** When we speak of the journal header, we mean the first 6 items above.
1248** Each entry in the journal is an instance of the 7th item.
drh34e79ce2004-02-08 06:05:46 +00001249**
1250** Call the value from the second bullet "nRec". nRec is the number of
1251** valid page entries in the journal. In most cases, you can compute the
1252** value of nRec from the size of the journal file. But if a power
1253** failure occurred while the journal was being written, it could be the
1254** case that the size of the journal file had already been increased but
1255** the extra entries had not yet made it safely to disk. In such a case,
1256** the value of nRec computed from the file size would be too large. For
1257** that reason, we always use the nRec value in the header.
1258**
1259** If the nRec value is 0xffffffff it means that nRec should be computed
1260** from the file size. This value is used when the user selects the
1261** no-sync option for the journal. A power failure could lead to corruption
1262** in this case. But for things like temporary table (which will be
1263** deleted when the power is restored) we don't care.
1264**
drhd9b02572001-04-15 00:37:09 +00001265** If the file opened as the journal file is not a well-formed
danielk1977ece80f12004-06-23 01:05:26 +00001266** journal file then all pages up to the first corrupted page are rolled
1267** back (or no pages if the journal header is corrupted). The journal file
1268** is then deleted and SQLITE_OK returned, just as if no corruption had
1269** been encountered.
1270**
1271** If an I/O or malloc() error occurs, the journal-file is not deleted
1272** and an error code is returned.
drhed7c8552001-04-11 14:29:21 +00001273*/
danielk197776572402004-06-25 02:38:54 +00001274static int pager_playback(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001275 i64 szJ; /* Size of the journal file in bytes */
danielk1977c3e8f5e2004-06-28 01:16:46 +00001276 u32 nRec; /* Number of Records in the journal */
drhd9b02572001-04-15 00:37:09 +00001277 int i; /* Loop counter */
1278 Pgno mxPg = 0; /* Size of the original file in pages */
drhae2b40c2004-06-09 19:03:54 +00001279 int rc; /* Result code of a subroutine */
danielk197713adf8a2004-06-03 16:08:41 +00001280 char *zMaster = 0; /* Name of master journal file if any */
drhed7c8552001-04-11 14:29:21 +00001281
drhc3a64ba2001-11-22 00:01:27 +00001282 /* Figure out how many records are in the journal. Abort early if
1283 ** the journal is empty.
drhed7c8552001-04-11 14:29:21 +00001284 */
drh8cfbf082001-09-19 13:22:39 +00001285 assert( pPager->journalOpen );
drh054889e2005-11-30 03:20:31 +00001286 rc = sqlite3OsFileSize(pPager->jfd, &szJ);
drhc3a64ba2001-11-22 00:01:27 +00001287 if( rc!=SQLITE_OK ){
1288 goto end_playback;
1289 }
drh240c5792004-02-08 00:40:52 +00001290
danielk197776572402004-06-25 02:38:54 +00001291 /* Read the master journal name from the journal, if it is present.
1292 ** If a master journal file name is specified, but the file is not
1293 ** present on disk, then the journal is not hot and does not need to be
1294 ** played back.
drh240c5792004-02-08 00:40:52 +00001295 */
drh9cbe6352005-11-29 03:13:21 +00001296 rc = readMasterJournal(pPager->jfd, &zMaster);
danielk197776572402004-06-25 02:38:54 +00001297 assert( rc!=SQLITE_DONE );
drh66560ad2006-01-06 14:32:19 +00001298 if( rc!=SQLITE_OK || (zMaster && !sqlite3OsFileExists(zMaster)) ){
danielk197776572402004-06-25 02:38:54 +00001299 sqliteFree(zMaster);
1300 zMaster = 0;
1301 if( rc==SQLITE_DONE ) rc = SQLITE_OK;
drhc3a64ba2001-11-22 00:01:27 +00001302 goto end_playback;
1303 }
drh054889e2005-11-30 03:20:31 +00001304 sqlite3OsSeek(pPager->jfd, 0);
danielk197776572402004-06-25 02:38:54 +00001305 pPager->journalOff = 0;
drhc3a64ba2001-11-22 00:01:27 +00001306
danielk197776572402004-06-25 02:38:54 +00001307 /* This loop terminates either when the readJournalHdr() call returns
1308 ** SQLITE_DONE or an IO error occurs. */
1309 while( 1 ){
drhae2b40c2004-06-09 19:03:54 +00001310
danielk197776572402004-06-25 02:38:54 +00001311 /* Read the next journal header from the journal file. If there are
1312 ** not enough bytes left in the journal file for a complete header, or
1313 ** it is corrupted, then a process must of failed while writing it.
1314 ** This indicates nothing more needs to be rolled back.
1315 */
1316 rc = readJournalHdr(pPager, szJ, &nRec, &mxPg);
1317 if( rc!=SQLITE_OK ){
drh968af522003-02-11 14:55:40 +00001318 if( rc==SQLITE_DONE ){
drh968af522003-02-11 14:55:40 +00001319 rc = SQLITE_OK;
1320 }
danielk197776572402004-06-25 02:38:54 +00001321 goto end_playback;
1322 }
1323
1324 /* If nRec is 0xffffffff, then this journal was created by a process
1325 ** working in no-sync mode. This means that the rest of the journal
1326 ** file consists of pages, there are no more journal headers. Compute
1327 ** the value of nRec based on this assumption.
1328 */
1329 if( nRec==0xffffffff ){
1330 assert( pPager->journalOff==JOURNAL_HDR_SZ(pPager) );
1331 nRec = (szJ - JOURNAL_HDR_SZ(pPager))/JOURNAL_PG_SZ(pPager);
1332 }
1333
1334 /* If this is the first header read from the journal, truncate the
1335 ** database file back to it's original size.
1336 */
danielk197717221812005-02-15 03:38:05 +00001337 if( pPager->state>=PAGER_EXCLUSIVE &&
1338 pPager->journalOff==JOURNAL_HDR_SZ(pPager) ){
danielk197776572402004-06-25 02:38:54 +00001339 assert( pPager->origDbSize==0 || pPager->origDbSize==mxPg );
drhcb4c40b2004-08-18 19:09:43 +00001340 rc = pager_truncate(pPager, mxPg);
danielk197776572402004-06-25 02:38:54 +00001341 if( rc!=SQLITE_OK ){
1342 goto end_playback;
1343 }
1344 pPager->dbSize = mxPg;
1345 }
1346
drh054889e2005-11-30 03:20:31 +00001347 /* rc = sqlite3OsSeek(pPager->jfd, JOURNAL_HDR_SZ(pPager)); */
danielk197776572402004-06-25 02:38:54 +00001348 if( rc!=SQLITE_OK ) goto end_playback;
1349
1350 /* Copy original pages out of the journal and back into the database file.
1351 */
1352 for(i=0; i<nRec; i++){
drh9cbe6352005-11-29 03:13:21 +00001353 rc = pager_playback_one_page(pPager, pPager->jfd, 1);
danielk197776572402004-06-25 02:38:54 +00001354 if( rc!=SQLITE_OK ){
1355 if( rc==SQLITE_DONE ){
1356 rc = SQLITE_OK;
1357 pPager->journalOff = szJ;
1358 break;
1359 }else{
1360 goto end_playback;
1361 }
1362 }
drh968af522003-02-11 14:55:40 +00001363 }
drhed7c8552001-04-11 14:29:21 +00001364 }
drh81a20f22001-10-12 17:30:04 +00001365
drh4a0681e2003-02-13 01:58:20 +00001366 /* Pages that have been written to the journal but never synced
1367 ** where not restored by the loop above. We have to restore those
drh240c5792004-02-08 00:40:52 +00001368 ** pages by reading them back from the original database.
drhdb48ee02003-01-16 13:42:43 +00001369 */
danielk197776572402004-06-25 02:38:54 +00001370 assert( rc==SQLITE_OK );
1371 pager_reload_cache(pPager);
drh4a0681e2003-02-13 01:58:20 +00001372
1373end_playback:
danielk19778191bff2004-06-28 04:52:30 +00001374 if( rc==SQLITE_OK ){
1375 rc = pager_unwritelock(pPager);
1376 }
danielk197713adf8a2004-06-03 16:08:41 +00001377 if( zMaster ){
1378 /* If there was a master journal and this routine will return true,
danielk197732554c12005-01-22 03:39:39 +00001379 ** see if it is possible to delete the master journal.
danielk197713adf8a2004-06-03 16:08:41 +00001380 */
1381 if( rc==SQLITE_OK ){
danielk197732554c12005-01-22 03:39:39 +00001382 rc = pager_delmaster(zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001383 }
1384 sqliteFree(zMaster);
1385 }
danielk197776572402004-06-25 02:38:54 +00001386
1387 /* The Pager.sectorSize variable may have been updated while rolling
1388 ** back a journal created by a process with a different PAGER_SECTOR_SIZE
1389 ** value. Reset it to the correct value for this process.
1390 */
1391 pPager->sectorSize = PAGER_SECTOR_SIZE;
drhd9b02572001-04-15 00:37:09 +00001392 return rc;
drhed7c8552001-04-11 14:29:21 +00001393}
1394
1395/*
drhac69b052004-05-12 13:30:07 +00001396** Playback the statement journal.
drhfa86c412002-02-02 15:01:15 +00001397**
1398** This is similar to playing back the transaction journal but with
1399** a few extra twists.
1400**
drh663fc632002-02-02 18:49:19 +00001401** (1) The number of pages in the database file at the start of
drhac69b052004-05-12 13:30:07 +00001402** the statement is stored in pPager->stmtSize, not in the
drh663fc632002-02-02 18:49:19 +00001403** journal file itself.
drhfa86c412002-02-02 15:01:15 +00001404**
drhac69b052004-05-12 13:30:07 +00001405** (2) In addition to playing back the statement journal, also
drhfa86c412002-02-02 15:01:15 +00001406** playback all pages of the transaction journal beginning
drhac69b052004-05-12 13:30:07 +00001407** at offset pPager->stmtJSize.
drhfa86c412002-02-02 15:01:15 +00001408*/
drh3aac2dd2004-04-26 14:10:20 +00001409static int pager_stmt_playback(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001410 i64 szJ; /* Size of the full journal */
1411 i64 hdrOff;
drh968af522003-02-11 14:55:40 +00001412 int nRec; /* Number of Records */
drhfa86c412002-02-02 15:01:15 +00001413 int i; /* Loop counter */
1414 int rc;
1415
danielk197776572402004-06-25 02:38:54 +00001416 szJ = pPager->journalOff;
1417#ifndef NDEBUG
1418 {
drheb206252004-10-01 02:00:31 +00001419 i64 os_szJ;
drh054889e2005-11-30 03:20:31 +00001420 rc = sqlite3OsFileSize(pPager->jfd, &os_szJ);
danielk197776572402004-06-25 02:38:54 +00001421 if( rc!=SQLITE_OK ) return rc;
1422 assert( szJ==os_szJ );
1423 }
1424#endif
1425
1426 /* Set hdrOff to be the offset to the first journal header written
1427 ** this statement transaction, or the end of the file if no journal
1428 ** header was written.
1429 */
1430 hdrOff = pPager->stmtHdrOff;
1431 assert( pPager->fullSync || !hdrOff );
1432 if( !hdrOff ){
1433 hdrOff = szJ;
1434 }
1435
drhfa86c412002-02-02 15:01:15 +00001436 /* Truncate the database back to its original size.
1437 */
danielk197717221812005-02-15 03:38:05 +00001438 if( pPager->state>=PAGER_EXCLUSIVE ){
1439 rc = pager_truncate(pPager, pPager->stmtSize);
1440 }
drhac69b052004-05-12 13:30:07 +00001441 pPager->dbSize = pPager->stmtSize;
drhfa86c412002-02-02 15:01:15 +00001442
drhac69b052004-05-12 13:30:07 +00001443 /* Figure out how many records are in the statement journal.
drhfa86c412002-02-02 15:01:15 +00001444 */
drhac69b052004-05-12 13:30:07 +00001445 assert( pPager->stmtInUse && pPager->journalOpen );
drh054889e2005-11-30 03:20:31 +00001446 sqlite3OsSeek(pPager->stfd, 0);
drhac69b052004-05-12 13:30:07 +00001447 nRec = pPager->stmtNRec;
drhfa86c412002-02-02 15:01:15 +00001448
drhac69b052004-05-12 13:30:07 +00001449 /* Copy original pages out of the statement journal and back into the
drhae2b40c2004-06-09 19:03:54 +00001450 ** database file. Note that the statement journal omits checksums from
1451 ** each record since power-failure recovery is not important to statement
1452 ** journals.
drhfa86c412002-02-02 15:01:15 +00001453 */
1454 for(i=nRec-1; i>=0; i--){
drh9cbe6352005-11-29 03:13:21 +00001455 rc = pager_playback_one_page(pPager, pPager->stfd, 0);
drh968af522003-02-11 14:55:40 +00001456 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001457 if( rc!=SQLITE_OK ) goto end_stmt_playback;
drhfa86c412002-02-02 15:01:15 +00001458 }
1459
danielk197776572402004-06-25 02:38:54 +00001460 /* Now roll some pages back from the transaction journal. Pager.stmtJSize
1461 ** was the size of the journal file when this statement was started, so
1462 ** everything after that needs to be rolled back, either into the
1463 ** database, the memory cache, or both.
1464 **
1465 ** If it is not zero, then Pager.stmtHdrOff is the offset to the start
1466 ** of the first journal header written during this statement transaction.
drhfa86c412002-02-02 15:01:15 +00001467 */
drh054889e2005-11-30 03:20:31 +00001468 rc = sqlite3OsSeek(pPager->jfd, pPager->stmtJSize);
drhfa86c412002-02-02 15:01:15 +00001469 if( rc!=SQLITE_OK ){
drh3aac2dd2004-04-26 14:10:20 +00001470 goto end_stmt_playback;
drhfa86c412002-02-02 15:01:15 +00001471 }
danielk197776572402004-06-25 02:38:54 +00001472 pPager->journalOff = pPager->stmtJSize;
danielk197775edc162004-06-26 01:48:18 +00001473 pPager->cksumInit = pPager->stmtCksum;
1474 assert( JOURNAL_HDR_SZ(pPager)<(pPager->pageSize+8) );
1475 while( pPager->journalOff <= (hdrOff-(pPager->pageSize+8)) ){
drh9cbe6352005-11-29 03:13:21 +00001476 rc = pager_playback_one_page(pPager, pPager->jfd, 1);
danielk197776572402004-06-25 02:38:54 +00001477 assert( rc!=SQLITE_DONE );
1478 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1479 }
1480
1481 while( pPager->journalOff < szJ ){
1482 u32 nRec;
1483 u32 dummy;
1484 rc = readJournalHdr(pPager, szJ, &nRec, &dummy);
drh968af522003-02-11 14:55:40 +00001485 if( rc!=SQLITE_OK ){
1486 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001487 goto end_stmt_playback;
drh968af522003-02-11 14:55:40 +00001488 }
danielk197775edc162004-06-26 01:48:18 +00001489 if( nRec==0 ){
1490 nRec = (szJ - pPager->journalOff) / (pPager->pageSize+8);
1491 }
danielk197776572402004-06-25 02:38:54 +00001492 for(i=nRec-1; i>=0 && pPager->journalOff < szJ; i--){
drh9cbe6352005-11-29 03:13:21 +00001493 rc = pager_playback_one_page(pPager, pPager->jfd, 1);
danielk197776572402004-06-25 02:38:54 +00001494 assert( rc!=SQLITE_DONE );
1495 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1496 }
drhfa86c412002-02-02 15:01:15 +00001497 }
danielk197776572402004-06-25 02:38:54 +00001498
1499 pPager->journalOff = szJ;
drhfa86c412002-02-02 15:01:15 +00001500
drh3aac2dd2004-04-26 14:10:20 +00001501end_stmt_playback:
drhfa86c412002-02-02 15:01:15 +00001502 if( rc!=SQLITE_OK ){
drhfa86c412002-02-02 15:01:15 +00001503 pPager->errMask |= PAGER_ERR_CORRUPT;
drh49285702005-09-17 15:20:26 +00001504 rc = SQLITE_CORRUPT;
danielk197775edc162004-06-26 01:48:18 +00001505 }else{
1506 pPager->journalOff = szJ;
1507 /* pager_reload_cache(pPager); */
drhfa86c412002-02-02 15:01:15 +00001508 }
1509 return rc;
1510}
1511
1512/*
drhf57b14a2001-09-14 18:54:08 +00001513** Change the maximum number of in-memory pages that are allowed.
1514*/
drh3aac2dd2004-04-26 14:10:20 +00001515void sqlite3pager_set_cachesize(Pager *pPager, int mxPage){
drhf57b14a2001-09-14 18:54:08 +00001516 if( mxPage>10 ){
1517 pPager->mxPage = mxPage;
danielk1977ef317ab2004-06-23 10:43:10 +00001518 }else{
1519 pPager->mxPage = 10;
drhf57b14a2001-09-14 18:54:08 +00001520 }
1521}
1522
1523/*
drh973b6e32003-02-12 14:09:42 +00001524** Adjust the robustness of the database to damage due to OS crashes
1525** or power failures by changing the number of syncs()s when writing
1526** the rollback journal. There are three levels:
1527**
drh054889e2005-11-30 03:20:31 +00001528** OFF sqlite3OsSync() is never called. This is the default
drh973b6e32003-02-12 14:09:42 +00001529** for temporary and transient files.
1530**
1531** NORMAL The journal is synced once before writes begin on the
1532** database. This is normally adequate protection, but
1533** it is theoretically possible, though very unlikely,
1534** that an inopertune power failure could leave the journal
1535** in a state which would cause damage to the database
1536** when it is rolled back.
1537**
1538** FULL The journal is synced twice before writes begin on the
drh34e79ce2004-02-08 06:05:46 +00001539** database (with some additional information - the nRec field
1540** of the journal header - being written in between the two
1541** syncs). If we assume that writing a
drh973b6e32003-02-12 14:09:42 +00001542** single disk sector is atomic, then this mode provides
1543** assurance that the journal will not be corrupted to the
1544** point of causing damage to the database during rollback.
1545**
1546** Numeric values associated with these states are OFF==1, NORMAL=2,
1547** and FULL=3.
1548*/
danielk197793758c82005-01-21 08:13:14 +00001549#ifndef SQLITE_OMIT_PAGER_PRAGMAS
drh3aac2dd2004-04-26 14:10:20 +00001550void sqlite3pager_set_safety_level(Pager *pPager, int level){
drh973b6e32003-02-12 14:09:42 +00001551 pPager->noSync = level==1 || pPager->tempFile;
1552 pPager->fullSync = level==3 && !pPager->tempFile;
danielk19771d850a72004-05-31 08:26:49 +00001553 if( pPager->noSync ) pPager->needSync = 0;
drh973b6e32003-02-12 14:09:42 +00001554}
danielk197793758c82005-01-21 08:13:14 +00001555#endif
drh973b6e32003-02-12 14:09:42 +00001556
1557/*
drhaf6df112005-06-07 02:12:30 +00001558** The following global variable is incremented whenever the library
1559** attempts to open a temporary file. This information is used for
1560** testing and analysis only.
1561*/
1562int sqlite3_opentemp_count = 0;
1563
1564/*
1565** Open a temporary file. Write the name of the file into zFile
1566** (zFile must be at least SQLITE_TEMPNAME_SIZE bytes long.) Write
drhfa86c412002-02-02 15:01:15 +00001567** the file descriptor into *fd. Return SQLITE_OK on success or some
1568** other error code if we fail.
1569**
1570** The OS will automatically delete the temporary file when it is
1571** closed.
1572*/
drh9cbe6352005-11-29 03:13:21 +00001573static int sqlite3pager_opentemp(char *zFile, OsFile **pFd){
drhfa86c412002-02-02 15:01:15 +00001574 int cnt = 8;
1575 int rc;
drhaf6df112005-06-07 02:12:30 +00001576 sqlite3_opentemp_count++; /* Used for testing and analysis only */
drhfa86c412002-02-02 15:01:15 +00001577 do{
1578 cnt--;
drh66560ad2006-01-06 14:32:19 +00001579 sqlite3OsTempFileName(zFile);
1580 rc = sqlite3OsOpenExclusive(zFile, pFd, 1);
danielk197713073932004-06-30 11:54:06 +00001581 }while( cnt>0 && rc!=SQLITE_OK && rc!=SQLITE_NOMEM );
drhfa86c412002-02-02 15:01:15 +00001582 return rc;
1583}
1584
1585/*
drhed7c8552001-04-11 14:29:21 +00001586** Create a new page cache and put a pointer to the page cache in *ppPager.
drh5e00f6c2001-09-13 13:46:56 +00001587** The file to be cached need not exist. The file is not locked until
drh3aac2dd2004-04-26 14:10:20 +00001588** the first call to sqlite3pager_get() and is only held open until the
1589** last page is released using sqlite3pager_unref().
drh382c0242001-10-06 16:33:02 +00001590**
drh6446c4d2001-12-15 14:22:18 +00001591** If zFilename is NULL then a randomly-named temporary file is created
1592** and used as the file to be cached. The file will be deleted
1593** automatically when it is closed.
drh90f5ecb2004-07-22 01:19:35 +00001594**
1595** If zFilename is ":memory:" then all information is held in cache.
1596** It is never written to disk. This can be used to implement an
1597** in-memory database.
drhed7c8552001-04-11 14:29:21 +00001598*/
drh3aac2dd2004-04-26 14:10:20 +00001599int sqlite3pager_open(
drh7e3b0a02001-04-28 16:52:40 +00001600 Pager **ppPager, /* Return the Pager structure here */
1601 const char *zFilename, /* Name of the database file to open */
drhda47d772002-12-02 04:25:19 +00001602 int nExtra, /* Extra bytes append to each in-memory page */
drh7bec5052005-02-06 02:45:41 +00001603 int flags /* flags controlling this file */
drh7e3b0a02001-04-28 16:52:40 +00001604){
danielk1977aef0bf62005-12-30 16:28:01 +00001605 Pager *pPager = 0;
danielk19778def5ea2004-06-16 10:39:52 +00001606 char *zFullPathname = 0;
drhed7c8552001-04-11 14:29:21 +00001607 int nameLen;
drh9cbe6352005-11-29 03:13:21 +00001608 OsFile *fd;
danielk1977cfe9a692004-06-16 12:00:29 +00001609 int rc = SQLITE_OK;
1610 int i;
danielk19778def5ea2004-06-16 10:39:52 +00001611 int tempFile = 0;
drhac69b052004-05-12 13:30:07 +00001612 int memDb = 0;
drh5e00f6c2001-09-13 13:46:56 +00001613 int readOnly = 0;
drh7bec5052005-02-06 02:45:41 +00001614 int useJournal = (flags & PAGER_OMIT_JOURNAL)==0;
1615 int noReadlock = (flags & PAGER_NO_READLOCK)!=0;
drh8cfbf082001-09-19 13:22:39 +00001616 char zTemp[SQLITE_TEMPNAME_SIZE];
drh6f7adc82006-01-11 21:41:20 +00001617#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
1618 const ThreadData *pTsdro = sqlite3ThreadDataReadOnly();
danielk197752622822006-01-09 09:59:49 +00001619#endif
drhed7c8552001-04-11 14:29:21 +00001620
danielk1977aef0bf62005-12-30 16:28:01 +00001621 /* If malloc() has already failed return SQLITE_NOMEM. Before even
1622 ** testing for this, set *ppPager to NULL so the caller knows the pager
1623 ** structure was never allocated.
1624 */
drhd9b02572001-04-15 00:37:09 +00001625 *ppPager = 0;
drh6f7adc82006-01-11 21:41:20 +00001626 if( sqlite3ThreadDataReadOnly()->mallocFailed ){
drhd9b02572001-04-15 00:37:09 +00001627 return SQLITE_NOMEM;
1628 }
danielk1977aef0bf62005-12-30 16:28:01 +00001629 memset(&fd, 0, sizeof(fd));
1630
1631 /* Open the pager file and set zFullPathname to point at malloc()ed
1632 ** memory containing the complete filename (i.e. including the directory).
1633 */
drh901afd42003-08-26 11:25:58 +00001634 if( zFilename && zFilename[0] ){
drhb7f91642004-10-31 02:22:47 +00001635#ifndef SQLITE_OMIT_MEMORYDB
drhac69b052004-05-12 13:30:07 +00001636 if( strcmp(zFilename,":memory:")==0 ){
1637 memDb = 1;
drhda71ce12004-06-21 18:14:45 +00001638 zFullPathname = sqliteStrDup("");
drhb7f91642004-10-31 02:22:47 +00001639 }else
1640#endif
1641 {
drh66560ad2006-01-06 14:32:19 +00001642 zFullPathname = sqlite3OsFullPathname(zFilename);
danielk19778def5ea2004-06-16 10:39:52 +00001643 if( zFullPathname ){
drh66560ad2006-01-06 14:32:19 +00001644 rc = sqlite3OsOpenReadWrite(zFullPathname, &fd, &readOnly);
danielk19778def5ea2004-06-16 10:39:52 +00001645 }
drhac69b052004-05-12 13:30:07 +00001646 }
drh5e00f6c2001-09-13 13:46:56 +00001647 }else{
drh3aac2dd2004-04-26 14:10:20 +00001648 rc = sqlite3pager_opentemp(zTemp, &fd);
drh5e00f6c2001-09-13 13:46:56 +00001649 zFilename = zTemp;
drh66560ad2006-01-06 14:32:19 +00001650 zFullPathname = sqlite3OsFullPathname(zFilename);
danielk19778def5ea2004-06-16 10:39:52 +00001651 if( rc==SQLITE_OK ){
1652 tempFile = 1;
1653 }
drh5e00f6c2001-09-13 13:46:56 +00001654 }
danielk1977aef0bf62005-12-30 16:28:01 +00001655
1656 /* Allocate the Pager structure. As part of the same allocation, allocate
1657 ** space for the full paths of the file, directory and journal
1658 ** (Pager.zFilename, Pager.zDirectory and Pager.zJournal).
1659 */
1660 if( zFullPathname ){
1661 nameLen = strlen(zFullPathname);
1662 pPager = sqliteMalloc( sizeof(*pPager) + nameLen*3 + 30 );
drh3e7a6092002-12-07 21:45:14 +00001663 }
danielk1977aef0bf62005-12-30 16:28:01 +00001664
1665 /* If an error occured in either of the blocks above, free the memory
1666 ** pointed to by zFullPathname, free the Pager structure and close the
1667 ** file. Since the pager is not allocated there is no need to set
1668 ** any Pager.errMask variables.
1669 */
1670 if( !pPager || !zFullPathname || rc!=SQLITE_OK ){
drh054889e2005-11-30 03:20:31 +00001671 sqlite3OsClose(&fd);
drhda71ce12004-06-21 18:14:45 +00001672 sqliteFree(zFullPathname);
danielk1977aef0bf62005-12-30 16:28:01 +00001673 sqliteFree(pPager);
1674 return ((rc==SQLITE_OK)?SQLITE_NOMEM:rc);
drhed7c8552001-04-11 14:29:21 +00001675 }
danielk1977aef0bf62005-12-30 16:28:01 +00001676
danielk1977ef73ee92004-11-06 12:26:07 +00001677 TRACE3("OPEN %d %s\n", FILEHANDLEID(fd), zFullPathname);
drhed7c8552001-04-11 14:29:21 +00001678 pPager->zFilename = (char*)&pPager[1];
drha76c82e2003-07-27 18:59:42 +00001679 pPager->zDirectory = &pPager->zFilename[nameLen+1];
1680 pPager->zJournal = &pPager->zDirectory[nameLen+1];
drh3e7a6092002-12-07 21:45:14 +00001681 strcpy(pPager->zFilename, zFullPathname);
drha76c82e2003-07-27 18:59:42 +00001682 strcpy(pPager->zDirectory, zFullPathname);
danielk1977aef0bf62005-12-30 16:28:01 +00001683
drha76c82e2003-07-27 18:59:42 +00001684 for(i=nameLen; i>0 && pPager->zDirectory[i-1]!='/'; i--){}
1685 if( i>0 ) pPager->zDirectory[i-1] = 0;
drh3e7a6092002-12-07 21:45:14 +00001686 strcpy(pPager->zJournal, zFullPathname);
1687 sqliteFree(zFullPathname);
drhed7c8552001-04-11 14:29:21 +00001688 strcpy(&pPager->zJournal[nameLen], "-journal");
drh9cbe6352005-11-29 03:13:21 +00001689 pPager->fd = fd;
drh3b59a5c2006-01-15 20:28:28 +00001690 /* pPager->journalOpen = 0; */
drhac69b052004-05-12 13:30:07 +00001691 pPager->useJournal = useJournal && !memDb;
drh7bec5052005-02-06 02:45:41 +00001692 pPager->noReadlock = noReadlock && readOnly;
drh3b59a5c2006-01-15 20:28:28 +00001693 /* pPager->stmtOpen = 0; */
1694 /* pPager->stmtInUse = 0; */
1695 /* pPager->nRef = 0; */
drhac69b052004-05-12 13:30:07 +00001696 pPager->dbSize = memDb-1;
drh90f5ecb2004-07-22 01:19:35 +00001697 pPager->pageSize = SQLITE_DEFAULT_PAGE_SIZE;
drh3b59a5c2006-01-15 20:28:28 +00001698 /* pPager->stmtSize = 0; */
1699 /* pPager->stmtJSize = 0; */
1700 /* pPager->nPage = 0; */
1701 /* pPager->nMaxPage = 0; */
drh90f5ecb2004-07-22 01:19:35 +00001702 pPager->mxPage = 100;
drh3b59a5c2006-01-15 20:28:28 +00001703 assert( PAGER_UNLOCK==0 );
1704 /* pPager->state = PAGER_UNLOCK; */
1705 /* pPager->errMask = 0; */
drh5e00f6c2001-09-13 13:46:56 +00001706 pPager->tempFile = tempFile;
drhac69b052004-05-12 13:30:07 +00001707 pPager->memDb = memDb;
drh5e00f6c2001-09-13 13:46:56 +00001708 pPager->readOnly = readOnly;
drh3b59a5c2006-01-15 20:28:28 +00001709 /* pPager->needSync = 0; */
drhda47d772002-12-02 04:25:19 +00001710 pPager->noSync = pPager->tempFile || !useJournal;
danielk197775edc162004-06-26 01:48:18 +00001711 pPager->fullSync = (pPager->noSync?0:1);
drh3b59a5c2006-01-15 20:28:28 +00001712 /* pPager->pFirst = 0; */
1713 /* pPager->pFirstSynced = 0; */
1714 /* pPager->pLast = 0; */
drh887dc4c2004-10-22 16:22:57 +00001715 pPager->nExtra = FORCE_ALIGNMENT(nExtra);
danielk197776572402004-06-25 02:38:54 +00001716 pPager->sectorSize = PAGER_SECTOR_SIZE;
drh3b59a5c2006-01-15 20:28:28 +00001717 /* pPager->pBusyHandler = 0; */
1718 /* memset(pPager->aHash, 0, sizeof(pPager->aHash)); */
drhed7c8552001-04-11 14:29:21 +00001719 *ppPager = pPager;
drh6f7adc82006-01-11 21:41:20 +00001720#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
1721 if( pTsdro->useMemoryManagement ){
1722 ThreadData *pTsd = sqlite3ThreadData();
danielk197752622822006-01-09 09:59:49 +00001723 pPager->pNext = pTsd->pPager;
1724 pTsd->pPager = pPager;
1725 }
1726#endif
drhed7c8552001-04-11 14:29:21 +00001727 return SQLITE_OK;
1728}
1729
1730/*
drh90f5ecb2004-07-22 01:19:35 +00001731** Set the busy handler function.
1732*/
1733void sqlite3pager_set_busyhandler(Pager *pPager, BusyHandler *pBusyHandler){
1734 pPager->pBusyHandler = pBusyHandler;
1735}
1736
1737/*
drh72f82862001-05-24 21:06:34 +00001738** Set the destructor for this pager. If not NULL, the destructor is called
drh5e00f6c2001-09-13 13:46:56 +00001739** when the reference count on each page reaches zero. The destructor can
1740** be used to clean up information in the extra segment appended to each page.
drh72f82862001-05-24 21:06:34 +00001741**
drh3aac2dd2004-04-26 14:10:20 +00001742** The destructor is not called as a result sqlite3pager_close().
1743** Destructors are only called by sqlite3pager_unref().
drh72f82862001-05-24 21:06:34 +00001744*/
drhb6f41482004-05-14 01:58:11 +00001745void sqlite3pager_set_destructor(Pager *pPager, void (*xDesc)(void*,int)){
drh72f82862001-05-24 21:06:34 +00001746 pPager->xDestructor = xDesc;
1747}
1748
1749/*
drha6abd042004-06-09 17:37:22 +00001750** Set the reinitializer for this pager. If not NULL, the reinitializer
1751** is called when the content of a page in cache is restored to its original
1752** value as a result of a rollback. The callback gives higher-level code
1753** an opportunity to restore the EXTRA section to agree with the restored
1754** page data.
1755*/
1756void sqlite3pager_set_reiniter(Pager *pPager, void (*xReinit)(void*,int)){
1757 pPager->xReiniter = xReinit;
1758}
1759
1760/*
drh1c7880e2005-05-20 20:01:55 +00001761** Set the page size. Return the new size. If the suggest new page
1762** size is inappropriate, then an alternative page size is selected
1763** and returned.
drh90f5ecb2004-07-22 01:19:35 +00001764*/
drh1c7880e2005-05-20 20:01:55 +00001765int sqlite3pager_set_pagesize(Pager *pPager, int pageSize){
drh90f5ecb2004-07-22 01:19:35 +00001766 assert( pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE );
drh1c7880e2005-05-20 20:01:55 +00001767 if( !pPager->memDb ){
1768 pPager->pageSize = pageSize;
1769 }
1770 return pPager->pageSize;
drh90f5ecb2004-07-22 01:19:35 +00001771}
1772
1773/*
drhc9ac5ca2005-11-04 22:03:30 +00001774** The following set of routines are used to disable the simulated
1775** I/O error mechanism. These routines are used to avoid simulated
1776** errors in places where we do not care about errors.
1777**
1778** Unless -DSQLITE_TEST=1 is used, these routines are all no-ops
1779** and generate no code.
1780*/
1781#ifdef SQLITE_TEST
1782extern int sqlite3_io_error_pending;
1783extern int sqlite3_io_error_hit;
1784static int saved_cnt;
1785void clear_simulated_io_error(){
1786 sqlite3_io_error_hit = 0;
1787}
1788void disable_simulated_io_errors(void){
1789 saved_cnt = sqlite3_io_error_pending;
1790 sqlite3_io_error_pending = -1;
1791}
1792void enable_simulated_io_errors(void){
1793 sqlite3_io_error_pending = saved_cnt;
1794}
1795#else
drh152410f2005-11-05 15:11:22 +00001796# define clear_simulated_io_error()
1797# define disable_simulated_io_errors()
1798# define enable_simulated_io_errors()
drhc9ac5ca2005-11-04 22:03:30 +00001799#endif
1800
1801/*
drh90f5ecb2004-07-22 01:19:35 +00001802** Read the first N bytes from the beginning of the file into memory
danielk1977aef0bf62005-12-30 16:28:01 +00001803** that pDest points to.
1804**
1805** No error checking is done. The rational for this is that this function
1806** may be called even if the file does not exist or contain a header. In
1807** these cases sqlite3OsRead() will return an error, to which the correct
1808** response is to zero the memory at pDest and continue. A real IO error
1809** will presumably recur and be picked up later (Todo: Think about this).
drh90f5ecb2004-07-22 01:19:35 +00001810*/
1811void sqlite3pager_read_fileheader(Pager *pPager, int N, unsigned char *pDest){
1812 memset(pDest, 0, N);
drhb7f91642004-10-31 02:22:47 +00001813 if( MEMDB==0 ){
drh054889e2005-11-30 03:20:31 +00001814 sqlite3OsSeek(pPager->fd, 0);
1815 sqlite3OsRead(pPager->fd, pDest, N);
drhc9ac5ca2005-11-04 22:03:30 +00001816 clear_simulated_io_error();
drh90f5ecb2004-07-22 01:19:35 +00001817 }
1818}
1819
1820/*
drh5e00f6c2001-09-13 13:46:56 +00001821** Return the total number of pages in the disk file associated with
danielk197715f411d2005-09-16 10:18:45 +00001822** pPager.
1823**
1824** If the PENDING_BYTE lies on the page directly after the end of the
1825** file, then consider this page part of the file too. For example, if
1826** PENDING_BYTE is byte 4096 (the first byte of page 5) and the size of the
1827** file is 4096 bytes, 5 is returned instead of 4.
drhed7c8552001-04-11 14:29:21 +00001828*/
drh3aac2dd2004-04-26 14:10:20 +00001829int sqlite3pager_pagecount(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001830 i64 n;
drhd9b02572001-04-15 00:37:09 +00001831 assert( pPager!=0 );
drhed7c8552001-04-11 14:29:21 +00001832 if( pPager->dbSize>=0 ){
danielk197715f411d2005-09-16 10:18:45 +00001833 n = pPager->dbSize;
1834 } else {
drh054889e2005-11-30 03:20:31 +00001835 if( sqlite3OsFileSize(pPager->fd, &n)!=SQLITE_OK ){
danielk197715f411d2005-09-16 10:18:45 +00001836 pPager->errMask |= PAGER_ERR_DISK;
1837 return 0;
1838 }
1839 if( n>0 && n<pPager->pageSize ){
1840 n = 1;
1841 }else{
1842 n /= pPager->pageSize;
1843 }
1844 if( pPager->state!=PAGER_UNLOCK ){
1845 pPager->dbSize = n;
1846 }
drhed7c8552001-04-11 14:29:21 +00001847 }
danielk197715f411d2005-09-16 10:18:45 +00001848 if( n==(PENDING_BYTE/pPager->pageSize) ){
drh1f595712004-06-15 01:40:29 +00001849 n++;
1850 }
drhed7c8552001-04-11 14:29:21 +00001851 return n;
1852}
1853
1854/*
drhf7c57532003-04-25 13:22:51 +00001855** Forward declaration
1856*/
danielk197776572402004-06-25 02:38:54 +00001857static int syncJournal(Pager*);
drhf7c57532003-04-25 13:22:51 +00001858
drhac69b052004-05-12 13:30:07 +00001859
1860/*
danielk1977f5fdda82004-11-03 08:44:05 +00001861** Unlink pPg from it's hash chain. Also set the page number to 0 to indicate
1862** that the page is not part of any hash chain. This is required because the
1863** sqlite3pager_movepage() routine can leave a page in the
1864** pNextFree/pPrevFree list that is not a part of any hash-chain.
1865*/
1866static void unlinkHashChain(Pager *pPager, PgHdr *pPg){
1867 if( pPg->pgno==0 ){
1868 /* If the page number is zero, then this page is not in any hash chain. */
1869 return;
1870 }
1871 if( pPg->pNextHash ){
1872 pPg->pNextHash->pPrevHash = pPg->pPrevHash;
1873 }
1874 if( pPg->pPrevHash ){
1875 assert( pPager->aHash[pager_hash(pPg->pgno)]!=pPg );
1876 pPg->pPrevHash->pNextHash = pPg->pNextHash;
1877 }else{
1878 int h = pager_hash(pPg->pgno);
1879 assert( pPager->aHash[h]==pPg );
1880 pPager->aHash[h] = pPg->pNextHash;
1881 }
1882
1883 pPg->pgno = 0;
1884 pPg->pNextHash = pPg->pPrevHash = 0;
1885}
1886
1887/*
drhac69b052004-05-12 13:30:07 +00001888** Unlink a page from the free list (the list of all pages where nRef==0)
1889** and from its hash collision chain.
1890*/
1891static void unlinkPage(PgHdr *pPg){
1892 Pager *pPager = pPg->pPager;
1893
1894 /* Keep the pFirstSynced pointer pointing at the first synchronized page */
1895 if( pPg==pPager->pFirstSynced ){
1896 PgHdr *p = pPg->pNextFree;
1897 while( p && p->needSync ){ p = p->pNextFree; }
1898 pPager->pFirstSynced = p;
1899 }
1900
1901 /* Unlink from the freelist */
1902 if( pPg->pPrevFree ){
1903 pPg->pPrevFree->pNextFree = pPg->pNextFree;
1904 }else{
1905 assert( pPager->pFirst==pPg );
1906 pPager->pFirst = pPg->pNextFree;
1907 }
1908 if( pPg->pNextFree ){
1909 pPg->pNextFree->pPrevFree = pPg->pPrevFree;
1910 }else{
1911 assert( pPager->pLast==pPg );
1912 pPager->pLast = pPg->pPrevFree;
1913 }
1914 pPg->pNextFree = pPg->pPrevFree = 0;
1915
1916 /* Unlink from the pgno hash table */
danielk1977f5fdda82004-11-03 08:44:05 +00001917 unlinkHashChain(pPager, pPg);
drhac69b052004-05-12 13:30:07 +00001918}
1919
danielk1977b84f96f2005-01-20 11:32:23 +00001920#ifndef SQLITE_OMIT_MEMORYDB
drhac69b052004-05-12 13:30:07 +00001921/*
1922** This routine is used to truncate an in-memory database. Delete
danielk1977369f27e2004-06-15 11:40:04 +00001923** all pages whose pgno is larger than pPager->dbSize and is unreferenced.
drhac69b052004-05-12 13:30:07 +00001924** Referenced pages larger than pPager->dbSize are zeroed.
1925*/
1926static void memoryTruncate(Pager *pPager){
1927 PgHdr *pPg;
1928 PgHdr **ppPg;
1929 int dbSize = pPager->dbSize;
1930
1931 ppPg = &pPager->pAll;
1932 while( (pPg = *ppPg)!=0 ){
1933 if( pPg->pgno<=dbSize ){
1934 ppPg = &pPg->pNextAll;
1935 }else if( pPg->nRef>0 ){
1936 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
1937 ppPg = &pPg->pNextAll;
1938 }else{
1939 *ppPg = pPg->pNextAll;
1940 unlinkPage(pPg);
1941 sqliteFree(pPg);
1942 pPager->nPage--;
1943 }
1944 }
1945}
danielk1977b84f96f2005-01-20 11:32:23 +00001946#else
1947#define memoryTruncate(p)
1948#endif
drhac69b052004-05-12 13:30:07 +00001949
drhf7c57532003-04-25 13:22:51 +00001950/*
danielk197717221812005-02-15 03:38:05 +00001951** Try to obtain a lock on a file. Invoke the busy callback if the lock
drha4afb652005-07-09 02:16:02 +00001952** is currently not available. Repeat until the busy callback returns
danielk197717221812005-02-15 03:38:05 +00001953** false or until the lock succeeds.
1954**
1955** Return SQLITE_OK on success and an error code if we cannot obtain
1956** the lock.
1957*/
1958static int pager_wait_on_lock(Pager *pPager, int locktype){
1959 int rc;
1960 assert( PAGER_SHARED==SHARED_LOCK );
1961 assert( PAGER_RESERVED==RESERVED_LOCK );
1962 assert( PAGER_EXCLUSIVE==EXCLUSIVE_LOCK );
1963 if( pPager->state>=locktype ){
1964 rc = SQLITE_OK;
1965 }else{
danielk197717221812005-02-15 03:38:05 +00001966 do {
drh054889e2005-11-30 03:20:31 +00001967 rc = sqlite3OsLock(pPager->fd, locktype);
drha4afb652005-07-09 02:16:02 +00001968 }while( rc==SQLITE_BUSY && sqlite3InvokeBusyHandler(pPager->pBusyHandler) );
danielk197717221812005-02-15 03:38:05 +00001969 if( rc==SQLITE_OK ){
1970 pPager->state = locktype;
1971 }
1972 }
1973 return rc;
1974}
1975
1976/*
drhf7c57532003-04-25 13:22:51 +00001977** Truncate the file to the number of pages specified.
1978*/
drh3aac2dd2004-04-26 14:10:20 +00001979int sqlite3pager_truncate(Pager *pPager, Pgno nPage){
drhf7c57532003-04-25 13:22:51 +00001980 int rc;
drhdc3ff9c2004-08-18 02:10:15 +00001981 sqlite3pager_pagecount(pPager);
drh2e6d11b2003-04-25 15:37:57 +00001982 if( pPager->errMask!=0 ){
1983 rc = pager_errcode(pPager);
1984 return rc;
1985 }
drh7d02cb72003-06-04 16:24:39 +00001986 if( nPage>=(unsigned)pPager->dbSize ){
drhf7c57532003-04-25 13:22:51 +00001987 return SQLITE_OK;
1988 }
drhb7f91642004-10-31 02:22:47 +00001989 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00001990 pPager->dbSize = nPage;
1991 memoryTruncate(pPager);
1992 return SQLITE_OK;
1993 }
danielk197776572402004-06-25 02:38:54 +00001994 rc = syncJournal(pPager);
danielk1977369f27e2004-06-15 11:40:04 +00001995 if( rc!=SQLITE_OK ){
1996 return rc;
1997 }
danielk197717221812005-02-15 03:38:05 +00001998
1999 /* Get an exclusive lock on the database before truncating. */
2000 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
2001 if( rc!=SQLITE_OK ){
2002 return rc;
2003 }
2004
drhcb4c40b2004-08-18 19:09:43 +00002005 rc = pager_truncate(pPager, nPage);
drhf7c57532003-04-25 13:22:51 +00002006 if( rc==SQLITE_OK ){
2007 pPager->dbSize = nPage;
2008 }
2009 return rc;
2010}
2011
2012/*
drhed7c8552001-04-11 14:29:21 +00002013** Shutdown the page cache. Free all memory and close all files.
2014**
2015** If a transaction was in progress when this routine is called, that
2016** transaction is rolled back. All outstanding pages are invalidated
2017** and their memory is freed. Any attempt to use a page associated
2018** with this page cache after this function returns will likely
2019** result in a coredump.
danielk1977aef0bf62005-12-30 16:28:01 +00002020**
2021** This function always succeeds. If a transaction is active an attempt
2022** is made to roll it back. If an error occurs during the rollback
2023** a hot journal may be left in the filesystem but no error is returned
2024** to the caller.
drhed7c8552001-04-11 14:29:21 +00002025*/
drh3aac2dd2004-04-26 14:10:20 +00002026int sqlite3pager_close(Pager *pPager){
drhd9b02572001-04-15 00:37:09 +00002027 PgHdr *pPg, *pNext;
drh6f7adc82006-01-11 21:41:20 +00002028#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
2029 const ThreadData *pTsd = sqlite3ThreadDataReadOnly();
danielk197713f72992005-12-18 08:51:22 +00002030#endif
2031
drhed7c8552001-04-11 14:29:21 +00002032 switch( pPager->state ){
drha6abd042004-06-09 17:37:22 +00002033 case PAGER_RESERVED:
danielk1977aa5ccdf2004-06-14 05:10:42 +00002034 case PAGER_SYNCED:
drha6abd042004-06-09 17:37:22 +00002035 case PAGER_EXCLUSIVE: {
danielk1977b3bce662005-01-29 08:32:43 +00002036 /* We ignore any IO errors that occur during the rollback
2037 ** operation. So disable IO error simulation so that testing
2038 ** works more easily.
2039 */
drhc9ac5ca2005-11-04 22:03:30 +00002040 disable_simulated_io_errors();
drh3aac2dd2004-04-26 14:10:20 +00002041 sqlite3pager_rollback(pPager);
drhc9ac5ca2005-11-04 22:03:30 +00002042 enable_simulated_io_errors();
drhb7f91642004-10-31 02:22:47 +00002043 if( !MEMDB ){
drh054889e2005-11-30 03:20:31 +00002044 sqlite3OsUnlock(pPager->fd, NO_LOCK);
drhac69b052004-05-12 13:30:07 +00002045 }
danielk1977e94ddc92005-03-21 03:53:38 +00002046 assert( pPager->errMask || pPager->journalOpen==0 );
drhed7c8552001-04-11 14:29:21 +00002047 break;
2048 }
drha6abd042004-06-09 17:37:22 +00002049 case PAGER_SHARED: {
drhb7f91642004-10-31 02:22:47 +00002050 if( !MEMDB ){
drh054889e2005-11-30 03:20:31 +00002051 sqlite3OsUnlock(pPager->fd, NO_LOCK);
drhac69b052004-05-12 13:30:07 +00002052 }
drhed7c8552001-04-11 14:29:21 +00002053 break;
2054 }
2055 default: {
2056 /* Do nothing */
2057 break;
2058 }
2059 }
drhd9b02572001-04-15 00:37:09 +00002060 for(pPg=pPager->pAll; pPg; pPg=pNext){
danielk1977eac7a362004-06-16 07:45:24 +00002061#ifndef NDEBUG
drhb7f91642004-10-31 02:22:47 +00002062 if( MEMDB ){
danielk1977eac7a362004-06-16 07:45:24 +00002063 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
2064 assert( !pPg->alwaysRollback );
2065 assert( !pHist->pOrig );
2066 assert( !pHist->pStmt );
2067 }
2068#endif
drhd9b02572001-04-15 00:37:09 +00002069 pNext = pPg->pNextAll;
2070 sqliteFree(pPg);
drhed7c8552001-04-11 14:29:21 +00002071 }
danielk1977ef73ee92004-11-06 12:26:07 +00002072 TRACE2("CLOSE %d\n", PAGERID(pPager));
danielk1977e94ddc92005-03-21 03:53:38 +00002073 assert( pPager->errMask || (pPager->journalOpen==0 && pPager->stmtOpen==0) );
2074 if( pPager->journalOpen ){
drh054889e2005-11-30 03:20:31 +00002075 sqlite3OsClose(&pPager->jfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002076 }
drh88b01a12005-03-28 18:04:27 +00002077 sqliteFree(pPager->aInJournal);
danielk1977e94ddc92005-03-21 03:53:38 +00002078 if( pPager->stmtOpen ){
drh054889e2005-11-30 03:20:31 +00002079 sqlite3OsClose(&pPager->stfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002080 }
drh054889e2005-11-30 03:20:31 +00002081 sqlite3OsClose(&pPager->fd);
drh0f892532002-05-30 12:27:03 +00002082 /* Temp files are automatically deleted by the OS
2083 ** if( pPager->tempFile ){
drh66560ad2006-01-06 14:32:19 +00002084 ** sqlite3OsDelete(pPager->zFilename);
drh0f892532002-05-30 12:27:03 +00002085 ** }
2086 */
danielk1977aca790a2005-01-13 11:07:52 +00002087
drh6f7adc82006-01-11 21:41:20 +00002088#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
danielk1977aef0bf62005-12-30 16:28:01 +00002089 /* Remove the pager from the linked list of pagers starting at
danielk197752622822006-01-09 09:59:49 +00002090 ** ThreadData.pPager if memory-management is enabled.
danielk1977aef0bf62005-12-30 16:28:01 +00002091 */
danielk197752622822006-01-09 09:59:49 +00002092 if( pTsd->useMemoryManagement ){
2093 if( pPager==pTsd->pPager ){
2094 pTsd->pPager = pPager->pNext;
2095 }else{
2096 Pager *pTmp;
2097 for(pTmp = pTsd->pPager; pTmp->pNext!=pPager; pTmp=pTmp->pNext);
2098 pTmp->pNext = pPager->pNext;
2099 }
danielk197713f72992005-12-18 08:51:22 +00002100 }
2101#endif
2102
drhed7c8552001-04-11 14:29:21 +00002103 sqliteFree(pPager);
2104 return SQLITE_OK;
2105}
2106
2107/*
drh5e00f6c2001-09-13 13:46:56 +00002108** Return the page number for the given page data.
drhed7c8552001-04-11 14:29:21 +00002109*/
drh3aac2dd2004-04-26 14:10:20 +00002110Pgno sqlite3pager_pagenumber(void *pData){
drhed7c8552001-04-11 14:29:21 +00002111 PgHdr *p = DATA_TO_PGHDR(pData);
2112 return p->pgno;
2113}
2114
2115/*
drhc8629a12004-05-08 20:07:40 +00002116** The page_ref() function increments the reference count for a page.
2117** If the page is currently on the freelist (the reference count is zero) then
drh7e3b0a02001-04-28 16:52:40 +00002118** remove it from the freelist.
drhc8629a12004-05-08 20:07:40 +00002119**
2120** For non-test systems, page_ref() is a macro that calls _page_ref()
2121** online of the reference count is zero. For test systems, page_ref()
2122** is a real function so that we can set breakpoints and trace it.
drh7e3b0a02001-04-28 16:52:40 +00002123*/
drh836faa42003-01-11 13:30:57 +00002124static void _page_ref(PgHdr *pPg){
drh7e3b0a02001-04-28 16:52:40 +00002125 if( pPg->nRef==0 ){
2126 /* The page is currently on the freelist. Remove it. */
drh341eae82003-01-21 02:39:36 +00002127 if( pPg==pPg->pPager->pFirstSynced ){
2128 PgHdr *p = pPg->pNextFree;
2129 while( p && p->needSync ){ p = p->pNextFree; }
2130 pPg->pPager->pFirstSynced = p;
2131 }
drh7e3b0a02001-04-28 16:52:40 +00002132 if( pPg->pPrevFree ){
2133 pPg->pPrevFree->pNextFree = pPg->pNextFree;
2134 }else{
2135 pPg->pPager->pFirst = pPg->pNextFree;
2136 }
2137 if( pPg->pNextFree ){
2138 pPg->pNextFree->pPrevFree = pPg->pPrevFree;
2139 }else{
2140 pPg->pPager->pLast = pPg->pPrevFree;
2141 }
2142 pPg->pPager->nRef++;
2143 }
2144 pPg->nRef++;
drhdd793422001-06-28 01:54:48 +00002145 REFINFO(pPg);
drhdf0b3b02001-06-23 11:36:20 +00002146}
danielk1977aca790a2005-01-13 11:07:52 +00002147#ifdef SQLITE_DEBUG
drhc8629a12004-05-08 20:07:40 +00002148 static void page_ref(PgHdr *pPg){
2149 if( pPg->nRef==0 ){
2150 _page_ref(pPg);
2151 }else{
2152 pPg->nRef++;
2153 REFINFO(pPg);
2154 }
2155 }
2156#else
2157# define page_ref(P) ((P)->nRef==0?_page_ref(P):(void)(P)->nRef++)
2158#endif
drhdf0b3b02001-06-23 11:36:20 +00002159
2160/*
2161** Increment the reference count for a page. The input pointer is
2162** a reference to the page data.
2163*/
drh3aac2dd2004-04-26 14:10:20 +00002164int sqlite3pager_ref(void *pData){
drhdf0b3b02001-06-23 11:36:20 +00002165 PgHdr *pPg = DATA_TO_PGHDR(pData);
2166 page_ref(pPg);
drh8c42ca92001-06-22 19:15:00 +00002167 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +00002168}
2169
2170/*
drh34e79ce2004-02-08 06:05:46 +00002171** Sync the journal. In other words, make sure all the pages that have
2172** been written to the journal have actually reached the surface of the
2173** disk. It is not safe to modify the original database file until after
2174** the journal has been synced. If the original database is modified before
2175** the journal is synced and a power failure occurs, the unsynced journal
2176** data would be lost and we would be unable to completely rollback the
2177** database changes. Database corruption would occur.
2178**
2179** This routine also updates the nRec field in the header of the journal.
2180** (See comments on the pager_playback() routine for additional information.)
2181** If the sync mode is FULL, two syncs will occur. First the whole journal
2182** is synced, then the nRec field is updated, then a second sync occurs.
drhb19a2bc2001-09-16 00:13:26 +00002183**
drh34e79ce2004-02-08 06:05:46 +00002184** For temporary databases, we do not care if we are able to rollback
2185** after a power failure, so sync occurs.
drhfa86c412002-02-02 15:01:15 +00002186**
drh34e79ce2004-02-08 06:05:46 +00002187** This routine clears the needSync field of every page current held in
2188** memory.
drh50e5dad2001-09-15 00:57:28 +00002189*/
danielk197776572402004-06-25 02:38:54 +00002190static int syncJournal(Pager *pPager){
drh50e5dad2001-09-15 00:57:28 +00002191 PgHdr *pPg;
2192 int rc = SQLITE_OK;
drh03eb96a2002-11-10 23:32:56 +00002193
2194 /* Sync the journal before modifying the main database
2195 ** (assuming there is a journal and it needs to be synced.)
2196 */
danielk197776572402004-06-25 02:38:54 +00002197 if( pPager->needSync ){
drhfa86c412002-02-02 15:01:15 +00002198 if( !pPager->tempFile ){
drhdb48ee02003-01-16 13:42:43 +00002199 assert( pPager->journalOpen );
drh946966f2004-02-25 02:20:41 +00002200 /* assert( !pPager->noSync ); // noSync might be set if synchronous
2201 ** was turned off after the transaction was started. Ticket #615 */
drh968af522003-02-11 14:55:40 +00002202#ifndef NDEBUG
2203 {
drh34e79ce2004-02-08 06:05:46 +00002204 /* Make sure the pPager->nRec counter we are keeping agrees
2205 ** with the nRec computed from the size of the journal file.
2206 */
drheb206252004-10-01 02:00:31 +00002207 i64 jSz;
drh054889e2005-11-30 03:20:31 +00002208 rc = sqlite3OsFileSize(pPager->jfd, &jSz);
drh968af522003-02-11 14:55:40 +00002209 if( rc!=0 ) return rc;
danielk197776572402004-06-25 02:38:54 +00002210 assert( pPager->journalOff==jSz );
drh968af522003-02-11 14:55:40 +00002211 }
2212#endif
drhae2b40c2004-06-09 19:03:54 +00002213 {
danielk197776572402004-06-25 02:38:54 +00002214 /* Write the nRec value into the journal file header. If in
2215 ** full-synchronous mode, sync the journal first. This ensures that
2216 ** all data has really hit the disk before nRec is updated to mark
2217 ** it as a candidate for rollback.
2218 */
drhd8d66e82003-02-12 02:10:15 +00002219 if( pPager->fullSync ){
danielk1977ef73ee92004-11-06 12:26:07 +00002220 TRACE2("SYNC journal of %d\n", PAGERID(pPager));
drh054889e2005-11-30 03:20:31 +00002221 rc = sqlite3OsSync(pPager->jfd, 0);
drhd8d66e82003-02-12 02:10:15 +00002222 if( rc!=0 ) return rc;
2223 }
drh054889e2005-11-30 03:20:31 +00002224 rc = sqlite3OsSeek(pPager->jfd,
drhb4746b92005-09-09 01:32:06 +00002225 pPager->journalHdr + sizeof(aJournalMagic));
2226 if( rc ) return rc;
drh9cbe6352005-11-29 03:13:21 +00002227 rc = write32bits(pPager->jfd, pPager->nRec);
drh99ee3602003-02-16 19:13:36 +00002228 if( rc ) return rc;
danielk197713adf8a2004-06-03 16:08:41 +00002229
drh054889e2005-11-30 03:20:31 +00002230 rc = sqlite3OsSeek(pPager->jfd, pPager->journalOff);
drhb4746b92005-09-09 01:32:06 +00002231 if( rc ) return rc;
drh968af522003-02-11 14:55:40 +00002232 }
danielk1977ef73ee92004-11-06 12:26:07 +00002233 TRACE2("SYNC journal of %d\n", PAGERID(pPager));
drh054889e2005-11-30 03:20:31 +00002234 rc = sqlite3OsSync(pPager->jfd, pPager->fullSync);
drhfa86c412002-02-02 15:01:15 +00002235 if( rc!=0 ) return rc;
drhdb48ee02003-01-16 13:42:43 +00002236 pPager->journalStarted = 1;
drhfa86c412002-02-02 15:01:15 +00002237 }
drh50e5dad2001-09-15 00:57:28 +00002238 pPager->needSync = 0;
drh341eae82003-01-21 02:39:36 +00002239
2240 /* Erase the needSync flag from every page.
2241 */
2242 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2243 pPg->needSync = 0;
2244 }
2245 pPager->pFirstSynced = pPager->pFirst;
drh50e5dad2001-09-15 00:57:28 +00002246 }
drh03eb96a2002-11-10 23:32:56 +00002247
drh341eae82003-01-21 02:39:36 +00002248#ifndef NDEBUG
2249 /* If the Pager.needSync flag is clear then the PgHdr.needSync
2250 ** flag must also be clear for all pages. Verify that this
2251 ** invariant is true.
drh03eb96a2002-11-10 23:32:56 +00002252 */
drh341eae82003-01-21 02:39:36 +00002253 else{
2254 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2255 assert( pPg->needSync==0 );
2256 }
2257 assert( pPager->pFirstSynced==pPager->pFirst );
drh03eb96a2002-11-10 23:32:56 +00002258 }
drh341eae82003-01-21 02:39:36 +00002259#endif
drhdb48ee02003-01-16 13:42:43 +00002260
drh81a20f22001-10-12 17:30:04 +00002261 return rc;
drh50e5dad2001-09-15 00:57:28 +00002262}
2263
2264/*
drh2554f8b2003-01-22 01:26:44 +00002265** Given a list of pages (connected by the PgHdr.pDirty pointer) write
2266** every one of those pages out to the database file and mark them all
2267** as clean.
2268*/
2269static int pager_write_pagelist(PgHdr *pList){
2270 Pager *pPager;
2271 int rc;
2272
2273 if( pList==0 ) return SQLITE_OK;
2274 pPager = pList->pPager;
danielk19779eed5052004-06-04 10:38:30 +00002275
2276 /* At this point there may be either a RESERVED or EXCLUSIVE lock on the
2277 ** database file. If there is already an EXCLUSIVE lock, the following
drh054889e2005-11-30 03:20:31 +00002278 ** calls to sqlite3OsLock() are no-ops.
danielk19779eed5052004-06-04 10:38:30 +00002279 **
drha6abd042004-06-09 17:37:22 +00002280 ** Moving the lock from RESERVED to EXCLUSIVE actually involves going
2281 ** through an intermediate state PENDING. A PENDING lock prevents new
2282 ** readers from attaching to the database but is unsufficient for us to
2283 ** write. The idea of a PENDING lock is to prevent new readers from
2284 ** coming in while we wait for existing readers to clear.
danielk19779eed5052004-06-04 10:38:30 +00002285 **
drha6abd042004-06-09 17:37:22 +00002286 ** While the pager is in the RESERVED state, the original database file
2287 ** is unchanged and we can rollback without having to playback the
2288 ** journal into the original database file. Once we transition to
2289 ** EXCLUSIVE, it means the database file has been changed and any rollback
2290 ** will require a journal playback.
danielk19779eed5052004-06-04 10:38:30 +00002291 */
drh684917c2004-10-05 02:41:42 +00002292 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
danielk19779eed5052004-06-04 10:38:30 +00002293 if( rc!=SQLITE_OK ){
2294 return rc;
2295 }
2296
drh2554f8b2003-01-22 01:26:44 +00002297 while( pList ){
2298 assert( pList->dirty );
drh054889e2005-11-30 03:20:31 +00002299 rc = sqlite3OsSeek(pPager->fd, (pList->pgno-1)*(i64)pPager->pageSize);
drhb4746b92005-09-09 01:32:06 +00002300 if( rc ) return rc;
danielk1977687566d2004-11-02 12:56:41 +00002301 /* If there are dirty pages in the page cache with page numbers greater
2302 ** than Pager.dbSize, this means sqlite3pager_truncate() was called to
2303 ** make the file smaller (presumably by auto-vacuum code). Do not write
2304 ** any such pages to the file.
2305 */
2306 if( pList->pgno<=pPager->dbSize ){
2307 CODEC(pPager, PGHDR_TO_DATA(pList), pList->pgno, 6);
danielk1977ef73ee92004-11-06 12:26:07 +00002308 TRACE3("STORE %d page %d\n", PAGERID(pPager), pList->pgno);
drh054889e2005-11-30 03:20:31 +00002309 rc = sqlite3OsWrite(pPager->fd, PGHDR_TO_DATA(pList),
drh9c06c952005-11-26 00:25:00 +00002310 pPager->pageSize);
danielk1977687566d2004-11-02 12:56:41 +00002311 CODEC(pPager, PGHDR_TO_DATA(pList), pList->pgno, 0);
drhfcd35c72005-05-21 02:48:08 +00002312 TEST_INCR(pPager->nWrite);
danielk1977687566d2004-11-02 12:56:41 +00002313 }
2314#ifndef NDEBUG
2315 else{
danielk1977ef73ee92004-11-06 12:26:07 +00002316 TRACE3("NOSTORE %d page %d\n", PAGERID(pPager), pList->pgno);
danielk1977687566d2004-11-02 12:56:41 +00002317 }
2318#endif
drh2554f8b2003-01-22 01:26:44 +00002319 if( rc ) return rc;
2320 pList->dirty = 0;
danielk19773c407372005-02-15 02:54:14 +00002321#ifdef SQLITE_CHECK_PAGES
2322 pList->pageHash = pager_pagehash(pList);
2323#endif
drh2554f8b2003-01-22 01:26:44 +00002324 pList = pList->pDirty;
2325 }
2326 return SQLITE_OK;
2327}
2328
2329/*
2330** Collect every dirty page into a dirty list and
2331** return a pointer to the head of that list. All pages are
2332** collected even if they are still in use.
2333*/
2334static PgHdr *pager_get_all_dirty_pages(Pager *pPager){
2335 PgHdr *p, *pList;
2336 pList = 0;
2337 for(p=pPager->pAll; p; p=p->pNextAll){
2338 if( p->dirty ){
2339 p->pDirty = pList;
2340 pList = p;
2341 }
2342 }
2343 return pList;
2344}
2345
2346/*
drh165ffe92005-03-15 17:09:30 +00002347** Return TRUE if there is a hot journal on the given pager.
2348** A hot journal is one that needs to be played back.
2349**
2350** If the current size of the database file is 0 but a journal file
2351** exists, that is probably an old journal left over from a prior
2352** database with the same name. Just delete the journal.
2353*/
2354static int hasHotJournal(Pager *pPager){
2355 if( !pPager->useJournal ) return 0;
drh66560ad2006-01-06 14:32:19 +00002356 if( !sqlite3OsFileExists(pPager->zJournal) ) return 0;
drh054889e2005-11-30 03:20:31 +00002357 if( sqlite3OsCheckReservedLock(pPager->fd) ) return 0;
drh165ffe92005-03-15 17:09:30 +00002358 if( sqlite3pager_pagecount(pPager)==0 ){
drh66560ad2006-01-06 14:32:19 +00002359 sqlite3OsDelete(pPager->zJournal);
drh165ffe92005-03-15 17:09:30 +00002360 return 0;
2361 }else{
2362 return 1;
2363 }
2364}
2365
danielk19775591df52005-12-20 09:19:37 +00002366/*
danielk1977aef0bf62005-12-30 16:28:01 +00002367** Try to find a page in the cache that can be recycled.
2368**
2369** This routine may return SQLITE_IOERR, SQLITE_FULL or SQLITE_OK. It
2370** does not set the pPager->errMask variable.
danielk19775591df52005-12-20 09:19:37 +00002371*/
danielk197713f72992005-12-18 08:51:22 +00002372static int pager_recycle(Pager *pPager, int syncOk, PgHdr **ppPg){
2373 PgHdr *pPg;
2374 *ppPg = 0;
2375
2376 /* Find a page to recycle. Try to locate a page that does not
2377 ** require us to do an fsync() on the journal.
2378 */
2379 pPg = pPager->pFirstSynced;
2380
2381 /* If we could not find a page that does not require an fsync()
2382 ** on the journal file then fsync the journal file. This is a
2383 ** very slow operation, so we work hard to avoid it. But sometimes
2384 ** it can't be helped.
2385 */
danielk19775591df52005-12-20 09:19:37 +00002386 if( pPg==0 && pPager->pFirst && syncOk && !MEMDB){
danielk197713f72992005-12-18 08:51:22 +00002387 int rc = syncJournal(pPager);
2388 if( rc!=0 ){
danielk1977aef0bf62005-12-30 16:28:01 +00002389 return rc;
danielk197713f72992005-12-18 08:51:22 +00002390 }
2391 if( pPager->fullSync ){
2392 /* If in full-sync mode, write a new journal header into the
2393 ** journal file. This is done to avoid ever modifying a journal
2394 ** header that is involved in the rollback of pages that have
2395 ** already been written to the database (in case the header is
2396 ** trashed when the nRec field is updated).
2397 */
2398 pPager->nRec = 0;
2399 assert( pPager->journalOff > 0 );
2400 rc = writeJournalHdr(pPager);
2401 if( rc!=0 ){
danielk1977aef0bf62005-12-30 16:28:01 +00002402 return rc;
danielk197713f72992005-12-18 08:51:22 +00002403 }
2404 }
2405 pPg = pPager->pFirst;
2406 }
2407 if( pPg==0 ){
2408 return SQLITE_OK;
2409 }
2410
2411 assert( pPg->nRef==0 );
2412
2413 /* Write the page to the database file if it is dirty.
2414 */
2415 if( pPg->dirty ){
2416 int rc;
2417 assert( pPg->needSync==0 );
2418 pPg->pDirty = 0;
2419 rc = pager_write_pagelist( pPg );
2420 if( rc!=SQLITE_OK ){
danielk1977aef0bf62005-12-30 16:28:01 +00002421 return rc;
danielk197713f72992005-12-18 08:51:22 +00002422 }
2423 }
2424 assert( pPg->dirty==0 );
2425
2426 /* If the page we are recycling is marked as alwaysRollback, then
2427 ** set the global alwaysRollback flag, thus disabling the
2428 ** sqlite_dont_rollback() optimization for the rest of this transaction.
2429 ** It is necessary to do this because the page marked alwaysRollback
2430 ** might be reloaded at a later time but at that point we won't remember
2431 ** that is was marked alwaysRollback. This means that all pages must
2432 ** be marked as alwaysRollback from here on out.
2433 */
2434 if( pPg->alwaysRollback ){
2435 pPager->alwaysRollback = 1;
2436 }
2437
2438 /* Unlink the old page from the free list and the hash table
2439 */
2440 unlinkPage(pPg);
2441 TEST_INCR(pPager->nOvfl);
2442
2443 *ppPg = pPg;
2444 return SQLITE_OK;
2445}
2446
2447/*
2448** This function is called to free superfluous dynamically allocated memory
2449** held by the pager system. Memory in use by any SQLite pager allocated
2450** by the current thread may be sqliteFree()ed.
2451**
2452** nReq is the number of bytes of memory required. Once this much has
danielk19770190d1d2005-12-19 14:18:11 +00002453** been released, the function returns. A negative value for nReq means
2454** free as much memory as possible. The return value is the total number
danielk197713f72992005-12-18 08:51:22 +00002455** of bytes of memory released.
2456*/
drh6f7adc82006-01-11 21:41:20 +00002457#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
danielk197713f72992005-12-18 08:51:22 +00002458int sqlite3pager_release_memory(int nReq){
drh6f7adc82006-01-11 21:41:20 +00002459 const ThreadData *pTsdro = sqlite3ThreadDataReadOnly();
danielk19770190d1d2005-12-19 14:18:11 +00002460 Pager *p;
danielk197713f72992005-12-18 08:51:22 +00002461 int nReleased = 0;
2462 int i;
2463
drh29c636b2006-01-09 23:40:25 +00002464 /* If the the global mutex is held, this subroutine becomes a
2465 ** o-op; zero bytes of memory are freed. This is because
2466 ** some of the code invoked by this function may also
2467 ** try to obtain the mutex, resulting in a deadlock.
danielk1977441b09a2006-01-05 13:48:29 +00002468 */
drh29c636b2006-01-09 23:40:25 +00002469 if( sqlite3OsInMutex() ){
danielk1977441b09a2006-01-05 13:48:29 +00002470 return 0;
2471 }
2472
danielk197713f72992005-12-18 08:51:22 +00002473 /* Outermost loop runs for at most two iterations. First iteration we
2474 ** try to find memory that can be released without calling fsync(). Second
2475 ** iteration (which only runs if the first failed to free nReq bytes of
2476 ** memory) is permitted to call fsync(). This is of course much more
2477 ** expensive.
2478 */
drh29c636b2006-01-09 23:40:25 +00002479 for(i=0; i<=1; i++){
danielk197713f72992005-12-18 08:51:22 +00002480
2481 /* Loop through all the SQLite pagers opened by the current thread. */
drh6f7adc82006-01-11 21:41:20 +00002482 for(p=pTsdro->pPager; p && (nReq<0 || nReleased<nReq); p=p->pNext){
danielk197713f72992005-12-18 08:51:22 +00002483 PgHdr *pPg;
2484 int rc;
2485
2486 /* For each pager, try to free as many pages as possible (without
2487 ** calling fsync() if this is the first iteration of the outermost
2488 ** loop).
2489 */
danielk19770190d1d2005-12-19 14:18:11 +00002490 while( SQLITE_OK==(rc = pager_recycle(p, i, &pPg)) && pPg) {
danielk1977aef0bf62005-12-30 16:28:01 +00002491 /* We've found a page to free. At this point the page has been
danielk197713f72992005-12-18 08:51:22 +00002492 ** removed from the page hash-table, free-list and synced-list
danielk1977aef0bf62005-12-30 16:28:01 +00002493 ** (pFirstSynced). It is still in the all pages (pAll) list.
danielk197713f72992005-12-18 08:51:22 +00002494 ** Remove it from this list before freeing.
2495 **
2496 ** Todo: Check the Pager.pStmt list to make sure this is Ok. It
2497 ** probably is though.
2498 */
2499 PgHdr *pTmp;
danielk19770190d1d2005-12-19 14:18:11 +00002500 assert( pPg );
danielk1977aef0bf62005-12-30 16:28:01 +00002501 page_remove_from_stmt_list(pPg);
danielk19770190d1d2005-12-19 14:18:11 +00002502 if( pPg==p->pAll ){
2503 p->pAll = pPg->pNextAll;
danielk197713f72992005-12-18 08:51:22 +00002504 }else{
danielk19770190d1d2005-12-19 14:18:11 +00002505 for( pTmp=p->pAll; pTmp->pNextAll!=pPg; pTmp=pTmp->pNextAll );
danielk197713f72992005-12-18 08:51:22 +00002506 pTmp->pNextAll = pPg->pNextAll;
2507 }
2508 nReleased += sqliteAllocSize(pPg);
2509 sqliteFree(pPg);
2510 }
2511
2512 if( rc!=SQLITE_OK ){
danielk1977aef0bf62005-12-30 16:28:01 +00002513 /* An error occured whilst writing to the database file or
2514 ** journal in pager_recycle(). The error is not returned to the
2515 ** caller of this function. Instead, set the Pager.errMask variable.
2516 ** The error will be returned to the user (or users, in the case
2517 ** of a shared pager cache) of the pager for which the error occured.
danielk197713f72992005-12-18 08:51:22 +00002518 */
danielk1977aef0bf62005-12-30 16:28:01 +00002519 assert( rc==SQLITE_IOERR || rc==SQLITE_FULL );
2520 assert( p->state>=PAGER_RESERVED );
2521 pager_error(p, rc);
danielk197713f72992005-12-18 08:51:22 +00002522 }
2523 }
2524 }
danielk1977aef0bf62005-12-30 16:28:01 +00002525
danielk197713f72992005-12-18 08:51:22 +00002526 return nReleased;
2527}
drh6f7adc82006-01-11 21:41:20 +00002528#endif /* SQLITE_ENABLE_MEMORY_MANAGEMENT */
danielk197713f72992005-12-18 08:51:22 +00002529
drh165ffe92005-03-15 17:09:30 +00002530/*
drhd9b02572001-04-15 00:37:09 +00002531** Acquire a page.
2532**
drh58a11682001-11-10 13:51:08 +00002533** A read lock on the disk file is obtained when the first page is acquired.
drh5e00f6c2001-09-13 13:46:56 +00002534** This read lock is dropped when the last page is released.
drhd9b02572001-04-15 00:37:09 +00002535**
drh306dc212001-05-21 13:45:10 +00002536** A _get works for any page number greater than 0. If the database
2537** file is smaller than the requested page, then no actual disk
2538** read occurs and the memory image of the page is initialized to
2539** all zeros. The extra data appended to a page is always initialized
2540** to zeros the first time a page is loaded into memory.
2541**
drhd9b02572001-04-15 00:37:09 +00002542** The acquisition might fail for several reasons. In all cases,
2543** an appropriate error code is returned and *ppPage is set to NULL.
drh7e3b0a02001-04-28 16:52:40 +00002544**
drh3aac2dd2004-04-26 14:10:20 +00002545** See also sqlite3pager_lookup(). Both this routine and _lookup() attempt
drh7e3b0a02001-04-28 16:52:40 +00002546** to find a page in the in-memory cache first. If the page is not already
drh5e00f6c2001-09-13 13:46:56 +00002547** in memory, this routine goes to disk to read it in whereas _lookup()
drh7e3b0a02001-04-28 16:52:40 +00002548** just returns 0. This routine acquires a read-lock the first time it
2549** has to go to disk, and could also playback an old journal if necessary.
2550** Since _lookup() never goes to disk, it never has to deal with locks
2551** or journal files.
drhed7c8552001-04-11 14:29:21 +00002552*/
drh3aac2dd2004-04-26 14:10:20 +00002553int sqlite3pager_get(Pager *pPager, Pgno pgno, void **ppPage){
drhed7c8552001-04-11 14:29:21 +00002554 PgHdr *pPg;
drh165ffe92005-03-15 17:09:30 +00002555 int rc;
drhed7c8552001-04-11 14:29:21 +00002556
danielk197726836652005-01-17 01:33:13 +00002557 /* The maximum page number is 2^31. Return SQLITE_CORRUPT if a page
2558 ** number greater than this, or zero, is requested.
2559 */
drh267cb322005-09-16 17:16:52 +00002560 if( pgno>PAGER_MAX_PGNO || pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh49285702005-09-17 15:20:26 +00002561 return SQLITE_CORRUPT_BKPT;
danielk197726836652005-01-17 01:33:13 +00002562 }
2563
drhd9b02572001-04-15 00:37:09 +00002564 /* Make sure we have not hit any critical errors.
2565 */
drh836faa42003-01-11 13:30:57 +00002566 assert( pPager!=0 );
drh2e6d11b2003-04-25 15:37:57 +00002567 *ppPage = 0;
drhd9b02572001-04-15 00:37:09 +00002568 if( pPager->errMask & ~(PAGER_ERR_FULL) ){
2569 return pager_errcode(pPager);
2570 }
2571
danielk197713adf8a2004-06-03 16:08:41 +00002572 /* If this is the first page accessed, then get a SHARED lock
drhed7c8552001-04-11 14:29:21 +00002573 ** on the database file.
2574 */
drhb7f91642004-10-31 02:22:47 +00002575 if( pPager->nRef==0 && !MEMDB ){
drh7bec5052005-02-06 02:45:41 +00002576 if( !pPager->noReadlock ){
2577 rc = pager_wait_on_lock(pPager, SHARED_LOCK);
2578 if( rc!=SQLITE_OK ){
danielk1977aef0bf62005-12-30 16:28:01 +00002579 return pager_error(pPager, rc);
drh7bec5052005-02-06 02:45:41 +00002580 }
drhed7c8552001-04-11 14:29:21 +00002581 }
2582
danielk197713adf8a2004-06-03 16:08:41 +00002583 /* If a journal file exists, and there is no RESERVED lock on the
2584 ** database file, then it either needs to be played back or deleted.
drhed7c8552001-04-11 14:29:21 +00002585 */
drh165ffe92005-03-15 17:09:30 +00002586 if( hasHotJournal(pPager) ){
drhe2227f02003-06-14 11:42:57 +00002587 int rc;
drhed7c8552001-04-11 14:29:21 +00002588
danielk197790ba3bd2004-06-25 08:32:25 +00002589 /* Get an EXCLUSIVE lock on the database file. At this point it is
2590 ** important that a RESERVED lock is not obtained on the way to the
2591 ** EXCLUSIVE lock. If it were, another process might open the
2592 ** database file, detect the RESERVED lock, and conclude that the
2593 ** database is safe to read while this process is still rolling it
2594 ** back.
2595 **
2596 ** Because the intermediate RESERVED lock is not requested, the
2597 ** second process will get to this point in the code and fail to
2598 ** obtain it's own EXCLUSIVE lock on the database file.
2599 */
drh054889e2005-11-30 03:20:31 +00002600 rc = sqlite3OsLock(pPager->fd, EXCLUSIVE_LOCK);
drha7fcb052001-12-14 15:09:55 +00002601 if( rc!=SQLITE_OK ){
drh054889e2005-11-30 03:20:31 +00002602 sqlite3OsUnlock(pPager->fd, NO_LOCK);
drha6abd042004-06-09 17:37:22 +00002603 pPager->state = PAGER_UNLOCK;
danielk1977aef0bf62005-12-30 16:28:01 +00002604 return pager_error(pPager, rc);
drha7fcb052001-12-14 15:09:55 +00002605 }
drha6abd042004-06-09 17:37:22 +00002606 pPager->state = PAGER_EXCLUSIVE;
drha7fcb052001-12-14 15:09:55 +00002607
drhe2227f02003-06-14 11:42:57 +00002608 /* Open the journal for reading only. Return SQLITE_BUSY if
2609 ** we are unable to open the journal file.
drhf57b3392001-10-08 13:22:32 +00002610 **
drhe2227f02003-06-14 11:42:57 +00002611 ** The journal file does not need to be locked itself. The
2612 ** journal file is never open unless the main database file holds
2613 ** a write lock, so there is never any chance of two or more
2614 ** processes opening the journal at the same time.
drhed7c8552001-04-11 14:29:21 +00002615 */
drh66560ad2006-01-06 14:32:19 +00002616 rc = sqlite3OsOpenReadOnly(pPager->zJournal, &pPager->jfd);
drha7fcb052001-12-14 15:09:55 +00002617 if( rc!=SQLITE_OK ){
drh054889e2005-11-30 03:20:31 +00002618 sqlite3OsUnlock(pPager->fd, NO_LOCK);
drha6abd042004-06-09 17:37:22 +00002619 pPager->state = PAGER_UNLOCK;
drhed7c8552001-04-11 14:29:21 +00002620 return SQLITE_BUSY;
2621 }
drha7fcb052001-12-14 15:09:55 +00002622 pPager->journalOpen = 1;
drhdb48ee02003-01-16 13:42:43 +00002623 pPager->journalStarted = 0;
danielk197776572402004-06-25 02:38:54 +00002624 pPager->journalOff = 0;
2625 pPager->setMaster = 0;
2626 pPager->journalHdr = 0;
drhed7c8552001-04-11 14:29:21 +00002627
2628 /* Playback and delete the journal. Drop the database write
2629 ** lock and reacquire the read lock.
2630 */
danielk197776572402004-06-25 02:38:54 +00002631 rc = pager_playback(pPager);
drhd9b02572001-04-15 00:37:09 +00002632 if( rc!=SQLITE_OK ){
danielk1977aef0bf62005-12-30 16:28:01 +00002633 return pager_error(pPager, rc);
drhd9b02572001-04-15 00:37:09 +00002634 }
drhed7c8552001-04-11 14:29:21 +00002635 }
2636 pPg = 0;
2637 }else{
2638 /* Search for page in cache */
drhd9b02572001-04-15 00:37:09 +00002639 pPg = pager_lookup(pPager, pgno);
drhb7f91642004-10-31 02:22:47 +00002640 if( MEMDB && pPager->state==PAGER_UNLOCK ){
drha6abd042004-06-09 17:37:22 +00002641 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00002642 }
drhed7c8552001-04-11 14:29:21 +00002643 }
2644 if( pPg==0 ){
drhd9b02572001-04-15 00:37:09 +00002645 /* The requested page is not in the page cache. */
drhed7c8552001-04-11 14:29:21 +00002646 int h;
drhfcd35c72005-05-21 02:48:08 +00002647 TEST_INCR(pPager->nMiss);
drhb7f91642004-10-31 02:22:47 +00002648 if( pPager->nPage<pPager->mxPage || pPager->pFirst==0 || MEMDB ){
drhed7c8552001-04-11 14:29:21 +00002649 /* Create a new page */
drh1c7880e2005-05-20 20:01:55 +00002650 pPg = sqliteMallocRaw( sizeof(*pPg) + pPager->pageSize
drhac69b052004-05-12 13:30:07 +00002651 + sizeof(u32) + pPager->nExtra
drhb7f91642004-10-31 02:22:47 +00002652 + MEMDB*sizeof(PgHistory) );
drhd9b02572001-04-15 00:37:09 +00002653 if( pPg==0 ){
drhd9b02572001-04-15 00:37:09 +00002654 return SQLITE_NOMEM;
2655 }
drh8c1238a2003-01-02 14:43:55 +00002656 memset(pPg, 0, sizeof(*pPg));
drhb7f91642004-10-31 02:22:47 +00002657 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00002658 memset(PGHDR_TO_HIST(pPg, pPager), 0, sizeof(PgHistory));
2659 }
drhed7c8552001-04-11 14:29:21 +00002660 pPg->pPager = pPager;
drhd9b02572001-04-15 00:37:09 +00002661 pPg->pNextAll = pPager->pAll;
drhd79caeb2001-04-15 02:27:24 +00002662 pPager->pAll = pPg;
drhd9b02572001-04-15 00:37:09 +00002663 pPager->nPage++;
danielk1977e94ddc92005-03-21 03:53:38 +00002664 if( pPager->nPage>pPager->nMaxPage ){
2665 assert( pPager->nMaxPage==(pPager->nPage-1) );
2666 pPager->nMaxPage++;
2667 }
drhed7c8552001-04-11 14:29:21 +00002668 }else{
danielk197713f72992005-12-18 08:51:22 +00002669 rc = pager_recycle(pPager, 1, &pPg);
2670 if( rc!=SQLITE_OK ){
danielk1977aef0bf62005-12-30 16:28:01 +00002671 return pager_error(pPager, rc);
drh50e5dad2001-09-15 00:57:28 +00002672 }
danielk197713f72992005-12-18 08:51:22 +00002673 assert(pPg) ;
drhed7c8552001-04-11 14:29:21 +00002674 }
2675 pPg->pgno = pgno;
drh1ab43002002-01-14 09:28:19 +00002676 if( pPager->aInJournal && (int)pgno<=pPager->origDbSize ){
danielk19774adee202004-05-08 08:23:19 +00002677 sqlite3CheckMemory(pPager->aInJournal, pgno/8);
drhdb48ee02003-01-16 13:42:43 +00002678 assert( pPager->journalOpen );
drh6019e162001-07-02 17:51:45 +00002679 pPg->inJournal = (pPager->aInJournal[pgno/8] & (1<<(pgno&7)))!=0;
drhdb48ee02003-01-16 13:42:43 +00002680 pPg->needSync = 0;
drh6019e162001-07-02 17:51:45 +00002681 }else{
2682 pPg->inJournal = 0;
drhdb48ee02003-01-16 13:42:43 +00002683 pPg->needSync = 0;
drh6019e162001-07-02 17:51:45 +00002684 }
drhac69b052004-05-12 13:30:07 +00002685 if( pPager->aInStmt && (int)pgno<=pPager->stmtSize
2686 && (pPager->aInStmt[pgno/8] & (1<<(pgno&7)))!=0 ){
drh3aac2dd2004-04-26 14:10:20 +00002687 page_add_to_stmt_list(pPg);
drhfa86c412002-02-02 15:01:15 +00002688 }else{
drh3aac2dd2004-04-26 14:10:20 +00002689 page_remove_from_stmt_list(pPg);
drhfa86c412002-02-02 15:01:15 +00002690 }
drhed7c8552001-04-11 14:29:21 +00002691 pPg->dirty = 0;
2692 pPg->nRef = 1;
drhdd793422001-06-28 01:54:48 +00002693 REFINFO(pPg);
drhd9b02572001-04-15 00:37:09 +00002694 pPager->nRef++;
2695 h = pager_hash(pgno);
drhed7c8552001-04-11 14:29:21 +00002696 pPg->pNextHash = pPager->aHash[h];
2697 pPager->aHash[h] = pPg;
2698 if( pPg->pNextHash ){
2699 assert( pPg->pNextHash->pPrevHash==0 );
2700 pPg->pNextHash->pPrevHash = pPg;
2701 }
drh2e6d11b2003-04-25 15:37:57 +00002702 if( pPager->nExtra>0 ){
drh90f5ecb2004-07-22 01:19:35 +00002703 memset(PGHDR_TO_EXTRA(pPg, pPager), 0, pPager->nExtra);
drh2e6d11b2003-04-25 15:37:57 +00002704 }
drh2e6d11b2003-04-25 15:37:57 +00002705 if( pPager->errMask!=0 ){
drh3aac2dd2004-04-26 14:10:20 +00002706 sqlite3pager_unref(PGHDR_TO_DATA(pPg));
drh2e6d11b2003-04-25 15:37:57 +00002707 rc = pager_errcode(pPager);
2708 return rc;
2709 }
drh165ffe92005-03-15 17:09:30 +00002710 if( sqlite3pager_pagecount(pPager)<(int)pgno ){
drh90f5ecb2004-07-22 01:19:35 +00002711 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
drh306dc212001-05-21 13:45:10 +00002712 }else{
drh81a20f22001-10-12 17:30:04 +00002713 int rc;
drhb7f91642004-10-31 02:22:47 +00002714 assert( MEMDB==0 );
drh054889e2005-11-30 03:20:31 +00002715 rc = sqlite3OsSeek(pPager->fd, (pgno-1)*(i64)pPager->pageSize);
drhb4746b92005-09-09 01:32:06 +00002716 if( rc==SQLITE_OK ){
drh054889e2005-11-30 03:20:31 +00002717 rc = sqlite3OsRead(pPager->fd, PGHDR_TO_DATA(pPg),
drh9c06c952005-11-26 00:25:00 +00002718 pPager->pageSize);
drhb4746b92005-09-09 01:32:06 +00002719 }
danielk1977ef73ee92004-11-06 12:26:07 +00002720 TRACE3("FETCH %d page %d\n", PAGERID(pPager), pPg->pgno);
drh9eb9e262004-02-11 02:18:05 +00002721 CODEC(pPager, PGHDR_TO_DATA(pPg), pPg->pgno, 3);
drh81a20f22001-10-12 17:30:04 +00002722 if( rc!=SQLITE_OK ){
drheb206252004-10-01 02:00:31 +00002723 i64 fileSize;
drh054889e2005-11-30 03:20:31 +00002724 if( sqlite3OsFileSize(pPager->fd,&fileSize)!=SQLITE_OK
drh90f5ecb2004-07-22 01:19:35 +00002725 || fileSize>=pgno*pPager->pageSize ){
drh3aac2dd2004-04-26 14:10:20 +00002726 sqlite3pager_unref(PGHDR_TO_DATA(pPg));
danielk1977aef0bf62005-12-30 16:28:01 +00002727 return pager_error(pPager, rc);
drh4e371ee2002-09-05 16:08:27 +00002728 }else{
drhc9ac5ca2005-11-04 22:03:30 +00002729 clear_simulated_io_error();
drh90f5ecb2004-07-22 01:19:35 +00002730 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
drh4e371ee2002-09-05 16:08:27 +00002731 }
danielk197742741be2005-01-08 12:42:39 +00002732 }else{
drhfcd35c72005-05-21 02:48:08 +00002733 TEST_INCR(pPager->nRead);
drh81a20f22001-10-12 17:30:04 +00002734 }
drh306dc212001-05-21 13:45:10 +00002735 }
danielk19773c407372005-02-15 02:54:14 +00002736#ifdef SQLITE_CHECK_PAGES
2737 pPg->pageHash = pager_pagehash(pPg);
2738#endif
drhed7c8552001-04-11 14:29:21 +00002739 }else{
drhd9b02572001-04-15 00:37:09 +00002740 /* The requested page is in the page cache. */
drhfcd35c72005-05-21 02:48:08 +00002741 TEST_INCR(pPager->nHit);
drhdf0b3b02001-06-23 11:36:20 +00002742 page_ref(pPg);
drhed7c8552001-04-11 14:29:21 +00002743 }
2744 *ppPage = PGHDR_TO_DATA(pPg);
2745 return SQLITE_OK;
2746}
2747
2748/*
drh7e3b0a02001-04-28 16:52:40 +00002749** Acquire a page if it is already in the in-memory cache. Do
2750** not read the page from disk. Return a pointer to the page,
2751** or 0 if the page is not in cache.
2752**
drh3aac2dd2004-04-26 14:10:20 +00002753** See also sqlite3pager_get(). The difference between this routine
2754** and sqlite3pager_get() is that _get() will go to the disk and read
drh7e3b0a02001-04-28 16:52:40 +00002755** in the page if the page is not already in cache. This routine
drh5e00f6c2001-09-13 13:46:56 +00002756** returns NULL if the page is not in cache or if a disk I/O error
2757** has ever happened.
drh7e3b0a02001-04-28 16:52:40 +00002758*/
drh3aac2dd2004-04-26 14:10:20 +00002759void *sqlite3pager_lookup(Pager *pPager, Pgno pgno){
drh7e3b0a02001-04-28 16:52:40 +00002760 PgHdr *pPg;
2761
drh836faa42003-01-11 13:30:57 +00002762 assert( pPager!=0 );
2763 assert( pgno!=0 );
drh7e3b0a02001-04-28 16:52:40 +00002764 if( pPager->errMask & ~(PAGER_ERR_FULL) ){
2765 return 0;
2766 }
drh7e3b0a02001-04-28 16:52:40 +00002767 pPg = pager_lookup(pPager, pgno);
2768 if( pPg==0 ) return 0;
drhdf0b3b02001-06-23 11:36:20 +00002769 page_ref(pPg);
drh7e3b0a02001-04-28 16:52:40 +00002770 return PGHDR_TO_DATA(pPg);
2771}
2772
2773/*
drhed7c8552001-04-11 14:29:21 +00002774** Release a page.
2775**
2776** If the number of references to the page drop to zero, then the
2777** page is added to the LRU list. When all references to all pages
drhd9b02572001-04-15 00:37:09 +00002778** are released, a rollback occurs and the lock on the database is
drhed7c8552001-04-11 14:29:21 +00002779** removed.
2780*/
drh3aac2dd2004-04-26 14:10:20 +00002781int sqlite3pager_unref(void *pData){
drhed7c8552001-04-11 14:29:21 +00002782 PgHdr *pPg;
drhd9b02572001-04-15 00:37:09 +00002783
2784 /* Decrement the reference count for this page
2785 */
drhed7c8552001-04-11 14:29:21 +00002786 pPg = DATA_TO_PGHDR(pData);
2787 assert( pPg->nRef>0 );
drhed7c8552001-04-11 14:29:21 +00002788 pPg->nRef--;
drhdd793422001-06-28 01:54:48 +00002789 REFINFO(pPg);
drhd9b02572001-04-15 00:37:09 +00002790
danielk19773c407372005-02-15 02:54:14 +00002791 CHECK_PAGE(pPg);
2792
drh72f82862001-05-24 21:06:34 +00002793 /* When the number of references to a page reach 0, call the
2794 ** destructor and add the page to the freelist.
drhd9b02572001-04-15 00:37:09 +00002795 */
drhed7c8552001-04-11 14:29:21 +00002796 if( pPg->nRef==0 ){
drh1eaa2692001-09-18 02:02:23 +00002797 Pager *pPager;
2798 pPager = pPg->pPager;
drhd9b02572001-04-15 00:37:09 +00002799 pPg->pNextFree = 0;
2800 pPg->pPrevFree = pPager->pLast;
drhed7c8552001-04-11 14:29:21 +00002801 pPager->pLast = pPg;
drhd9b02572001-04-15 00:37:09 +00002802 if( pPg->pPrevFree ){
2803 pPg->pPrevFree->pNextFree = pPg;
drhed7c8552001-04-11 14:29:21 +00002804 }else{
2805 pPager->pFirst = pPg;
2806 }
drh341eae82003-01-21 02:39:36 +00002807 if( pPg->needSync==0 && pPager->pFirstSynced==0 ){
2808 pPager->pFirstSynced = pPg;
2809 }
drh72f82862001-05-24 21:06:34 +00002810 if( pPager->xDestructor ){
drhb6f41482004-05-14 01:58:11 +00002811 pPager->xDestructor(pData, pPager->pageSize);
drh72f82862001-05-24 21:06:34 +00002812 }
drhd9b02572001-04-15 00:37:09 +00002813
2814 /* When all pages reach the freelist, drop the read lock from
2815 ** the database file.
2816 */
2817 pPager->nRef--;
2818 assert( pPager->nRef>=0 );
drhb7f91642004-10-31 02:22:47 +00002819 if( pPager->nRef==0 && !MEMDB ){
drhd9b02572001-04-15 00:37:09 +00002820 pager_reset(pPager);
2821 }
drhed7c8552001-04-11 14:29:21 +00002822 }
drhd9b02572001-04-15 00:37:09 +00002823 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +00002824}
2825
2826/*
drha6abd042004-06-09 17:37:22 +00002827** Create a journal file for pPager. There should already be a RESERVED
2828** or EXCLUSIVE lock on the database file when this routine is called.
drhda47d772002-12-02 04:25:19 +00002829**
2830** Return SQLITE_OK if everything. Return an error code and release the
2831** write lock if anything goes wrong.
2832*/
2833static int pager_open_journal(Pager *pPager){
2834 int rc;
drhb7f91642004-10-31 02:22:47 +00002835 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +00002836 assert( pPager->state>=PAGER_RESERVED );
drhda47d772002-12-02 04:25:19 +00002837 assert( pPager->journalOpen==0 );
2838 assert( pPager->useJournal );
drh88b01a12005-03-28 18:04:27 +00002839 assert( pPager->aInJournal==0 );
drh3aac2dd2004-04-26 14:10:20 +00002840 sqlite3pager_pagecount(pPager);
drhda47d772002-12-02 04:25:19 +00002841 pPager->aInJournal = sqliteMalloc( pPager->dbSize/8 + 1 );
2842 if( pPager->aInJournal==0 ){
drh9c105bb2004-10-02 20:38:28 +00002843 rc = SQLITE_NOMEM;
2844 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00002845 }
drh66560ad2006-01-06 14:32:19 +00002846 rc = sqlite3OsOpenExclusive(pPager->zJournal, &pPager->jfd,
drh9c06c952005-11-26 00:25:00 +00002847 pPager->tempFile);
danielk197776572402004-06-25 02:38:54 +00002848 pPager->journalOff = 0;
2849 pPager->setMaster = 0;
2850 pPager->journalHdr = 0;
drhda47d772002-12-02 04:25:19 +00002851 if( rc!=SQLITE_OK ){
drh9c105bb2004-10-02 20:38:28 +00002852 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00002853 }
drh054889e2005-11-30 03:20:31 +00002854 sqlite3OsSetFullSync(pPager->jfd, pPager->fullSync);
2855 sqlite3OsSetFullSync(pPager->fd, pPager->fullSync);
2856 sqlite3OsOpenDirectory(pPager->jfd, pPager->zDirectory);
drhda47d772002-12-02 04:25:19 +00002857 pPager->journalOpen = 1;
drhdb48ee02003-01-16 13:42:43 +00002858 pPager->journalStarted = 0;
drhda47d772002-12-02 04:25:19 +00002859 pPager->needSync = 0;
2860 pPager->alwaysRollback = 0;
drh968af522003-02-11 14:55:40 +00002861 pPager->nRec = 0;
drh2e6d11b2003-04-25 15:37:57 +00002862 if( pPager->errMask!=0 ){
2863 rc = pager_errcode(pPager);
drhdd5b2fa2005-03-28 03:39:55 +00002864 goto failed_to_open_journal;
drh2e6d11b2003-04-25 15:37:57 +00002865 }
drhda47d772002-12-02 04:25:19 +00002866 pPager->origDbSize = pPager->dbSize;
drhae2b40c2004-06-09 19:03:54 +00002867
danielk197776572402004-06-25 02:38:54 +00002868 rc = writeJournalHdr(pPager);
2869
drhac69b052004-05-12 13:30:07 +00002870 if( pPager->stmtAutoopen && rc==SQLITE_OK ){
drh3aac2dd2004-04-26 14:10:20 +00002871 rc = sqlite3pager_stmt_begin(pPager);
drhda47d772002-12-02 04:25:19 +00002872 }
danielk1977261919c2005-12-06 12:52:59 +00002873 if( rc!=SQLITE_OK && rc!=SQLITE_NOMEM ){
drhda47d772002-12-02 04:25:19 +00002874 rc = pager_unwritelock(pPager);
2875 if( rc==SQLITE_OK ){
2876 rc = SQLITE_FULL;
2877 }
2878 }
drh9c105bb2004-10-02 20:38:28 +00002879 return rc;
2880
2881failed_to_open_journal:
2882 sqliteFree(pPager->aInJournal);
2883 pPager->aInJournal = 0;
danielk1977261919c2005-12-06 12:52:59 +00002884 if( rc==SQLITE_NOMEM ){
2885 /* If this was a malloc() failure, then we will not be closing the pager
2886 ** file. So delete any journal file we may have just created. Otherwise,
2887 ** the system will get confused, we have a read-lock on the file and a
2888 ** mysterious journal has appeared in the filesystem.
2889 */
drh66560ad2006-01-06 14:32:19 +00002890 sqlite3OsDelete(pPager->zJournal);
danielk1977261919c2005-12-06 12:52:59 +00002891 }else{
2892 sqlite3OsUnlock(pPager->fd, NO_LOCK);
2893 pPager->state = PAGER_UNLOCK;
2894 }
drh9c105bb2004-10-02 20:38:28 +00002895 return rc;
drhda47d772002-12-02 04:25:19 +00002896}
2897
2898/*
drh4b845d72002-03-05 12:41:19 +00002899** Acquire a write-lock on the database. The lock is removed when
2900** the any of the following happen:
2901**
drh3aac2dd2004-04-26 14:10:20 +00002902** * sqlite3pager_commit() is called.
2903** * sqlite3pager_rollback() is called.
2904** * sqlite3pager_close() is called.
2905** * sqlite3pager_unref() is called to on every outstanding page.
drh4b845d72002-03-05 12:41:19 +00002906**
danielk197713adf8a2004-06-03 16:08:41 +00002907** The first parameter to this routine is a pointer to any open page of the
2908** database file. Nothing changes about the page - it is used merely to
2909** acquire a pointer to the Pager structure and as proof that there is
2910** already a read-lock on the database.
drh4b845d72002-03-05 12:41:19 +00002911**
danielk197713adf8a2004-06-03 16:08:41 +00002912** The second parameter indicates how much space in bytes to reserve for a
2913** master journal file-name at the start of the journal when it is created.
2914**
2915** A journal file is opened if this is not a temporary file. For temporary
2916** files, the opening of the journal file is deferred until there is an
2917** actual need to write to the journal.
drhda47d772002-12-02 04:25:19 +00002918**
drha6abd042004-06-09 17:37:22 +00002919** If the database is already reserved for writing, this routine is a no-op.
drh684917c2004-10-05 02:41:42 +00002920**
2921** If exFlag is true, go ahead and get an EXCLUSIVE lock on the file
2922** immediately instead of waiting until we try to flush the cache. The
2923** exFlag is ignored if a transaction is already active.
drh4b845d72002-03-05 12:41:19 +00002924*/
drh684917c2004-10-05 02:41:42 +00002925int sqlite3pager_begin(void *pData, int exFlag){
drh4b845d72002-03-05 12:41:19 +00002926 PgHdr *pPg = DATA_TO_PGHDR(pData);
2927 Pager *pPager = pPg->pPager;
2928 int rc = SQLITE_OK;
2929 assert( pPg->nRef>0 );
drha6abd042004-06-09 17:37:22 +00002930 assert( pPager->state!=PAGER_UNLOCK );
2931 if( pPager->state==PAGER_SHARED ){
drh4b845d72002-03-05 12:41:19 +00002932 assert( pPager->aInJournal==0 );
drhb7f91642004-10-31 02:22:47 +00002933 if( MEMDB ){
drha6abd042004-06-09 17:37:22 +00002934 pPager->state = PAGER_EXCLUSIVE;
drhac69b052004-05-12 13:30:07 +00002935 pPager->origDbSize = pPager->dbSize;
2936 }else{
drh054889e2005-11-30 03:20:31 +00002937 rc = sqlite3OsLock(pPager->fd, RESERVED_LOCK);
drh684917c2004-10-05 02:41:42 +00002938 if( rc==SQLITE_OK ){
2939 pPager->state = PAGER_RESERVED;
2940 if( exFlag ){
2941 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
2942 }
2943 }
danielk19779eed5052004-06-04 10:38:30 +00002944 if( rc!=SQLITE_OK ){
2945 return rc;
drhac69b052004-05-12 13:30:07 +00002946 }
drha6abd042004-06-09 17:37:22 +00002947 pPager->dirtyCache = 0;
danielk1977ef73ee92004-11-06 12:26:07 +00002948 TRACE2("TRANSACTION %d\n", PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00002949 if( pPager->useJournal && !pPager->tempFile ){
2950 rc = pager_open_journal(pPager);
2951 }
drh4b845d72002-03-05 12:41:19 +00002952 }
2953 }
2954 return rc;
2955}
2956
2957/*
drhed7c8552001-04-11 14:29:21 +00002958** Mark a data page as writeable. The page is written into the journal
2959** if it is not there already. This routine must be called before making
2960** changes to a page.
2961**
2962** The first time this routine is called, the pager creates a new
drha6abd042004-06-09 17:37:22 +00002963** journal and acquires a RESERVED lock on the database. If the RESERVED
drhed7c8552001-04-11 14:29:21 +00002964** lock could not be acquired, this routine returns SQLITE_BUSY. The
drh306dc212001-05-21 13:45:10 +00002965** calling routine must check for that return value and be careful not to
drhed7c8552001-04-11 14:29:21 +00002966** change any page data until this routine returns SQLITE_OK.
drhd9b02572001-04-15 00:37:09 +00002967**
2968** If the journal file could not be written because the disk is full,
2969** then this routine returns SQLITE_FULL and does an immediate rollback.
2970** All subsequent write attempts also return SQLITE_FULL until there
drh3aac2dd2004-04-26 14:10:20 +00002971** is a call to sqlite3pager_commit() or sqlite3pager_rollback() to
drhd9b02572001-04-15 00:37:09 +00002972** reset.
drhed7c8552001-04-11 14:29:21 +00002973*/
drh3aac2dd2004-04-26 14:10:20 +00002974int sqlite3pager_write(void *pData){
drh69688d52001-04-14 16:38:23 +00002975 PgHdr *pPg = DATA_TO_PGHDR(pData);
2976 Pager *pPager = pPg->pPager;
drhd79caeb2001-04-15 02:27:24 +00002977 int rc = SQLITE_OK;
drh69688d52001-04-14 16:38:23 +00002978
drh6446c4d2001-12-15 14:22:18 +00002979 /* Check for errors
2980 */
drhd9b02572001-04-15 00:37:09 +00002981 if( pPager->errMask ){
2982 return pager_errcode(pPager);
2983 }
drh5e00f6c2001-09-13 13:46:56 +00002984 if( pPager->readOnly ){
2985 return SQLITE_PERM;
2986 }
drh6446c4d2001-12-15 14:22:18 +00002987
danielk197776572402004-06-25 02:38:54 +00002988 assert( !pPager->setMaster );
2989
danielk19773c407372005-02-15 02:54:14 +00002990 CHECK_PAGE(pPg);
2991
drh6446c4d2001-12-15 14:22:18 +00002992 /* Mark the page as dirty. If the page has already been written
2993 ** to the journal then we can return right away.
2994 */
drhd9b02572001-04-15 00:37:09 +00002995 pPg->dirty = 1;
drhac69b052004-05-12 13:30:07 +00002996 if( pPg->inJournal && (pPg->inStmt || pPager->stmtInUse==0) ){
drha6abd042004-06-09 17:37:22 +00002997 pPager->dirtyCache = 1;
danielk1977a0bf2652004-11-04 14:30:04 +00002998 }else{
drh6446c4d2001-12-15 14:22:18 +00002999
danielk1977a0bf2652004-11-04 14:30:04 +00003000 /* If we get this far, it means that the page needs to be
3001 ** written to the transaction journal or the ckeckpoint journal
3002 ** or both.
3003 **
3004 ** First check to see that the transaction journal exists and
3005 ** create it if it does not.
3006 */
3007 assert( pPager->state!=PAGER_UNLOCK );
3008 rc = sqlite3pager_begin(pData, 0);
3009 if( rc!=SQLITE_OK ){
3010 return rc;
3011 }
3012 assert( pPager->state>=PAGER_RESERVED );
3013 if( !pPager->journalOpen && pPager->useJournal ){
3014 rc = pager_open_journal(pPager);
3015 if( rc!=SQLITE_OK ) return rc;
3016 }
3017 assert( pPager->journalOpen || !pPager->useJournal );
3018 pPager->dirtyCache = 1;
3019
3020 /* The transaction journal now exists and we have a RESERVED or an
3021 ** EXCLUSIVE lock on the main database file. Write the current page to
3022 ** the transaction journal if it is not there already.
3023 */
3024 if( !pPg->inJournal && (pPager->useJournal || MEMDB) ){
3025 if( (int)pPg->pgno <= pPager->origDbSize ){
3026 int szPg;
3027 u32 saved;
3028 if( MEMDB ){
3029 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
danielk1977ef73ee92004-11-06 12:26:07 +00003030 TRACE3("JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00003031 assert( pHist->pOrig==0 );
3032 pHist->pOrig = sqliteMallocRaw( pPager->pageSize );
3033 if( pHist->pOrig ){
3034 memcpy(pHist->pOrig, PGHDR_TO_DATA(pPg), pPager->pageSize);
3035 }
3036 }else{
3037 u32 cksum;
drh267cb322005-09-16 17:16:52 +00003038 /* We should never write to the journal file the page that
3039 ** contains the database locks. The following assert verifies
3040 ** that we do not. */
3041 assert( pPg->pgno!=PAGER_MJ_PGNO(pPager) );
danielk1977a0bf2652004-11-04 14:30:04 +00003042 CODEC(pPager, pData, pPg->pgno, 7);
3043 cksum = pager_cksum(pPager, pPg->pgno, pData);
3044 saved = *(u32*)PGHDR_TO_EXTRA(pPg, pPager);
3045 store32bits(cksum, pPg, pPager->pageSize);
3046 szPg = pPager->pageSize+8;
3047 store32bits(pPg->pgno, pPg, -4);
drh054889e2005-11-30 03:20:31 +00003048 rc = sqlite3OsWrite(pPager->jfd, &((char*)pData)[-4], szPg);
danielk1977a0bf2652004-11-04 14:30:04 +00003049 pPager->journalOff += szPg;
3050 TRACE4("JOURNAL %d page %d needSync=%d\n",
danielk1977ef73ee92004-11-06 12:26:07 +00003051 PAGERID(pPager), pPg->pgno, pPg->needSync);
danielk1977a0bf2652004-11-04 14:30:04 +00003052 CODEC(pPager, pData, pPg->pgno, 0);
3053 *(u32*)PGHDR_TO_EXTRA(pPg, pPager) = saved;
3054 if( rc!=SQLITE_OK ){
3055 sqlite3pager_rollback(pPager);
3056 pPager->errMask |= PAGER_ERR_FULL;
3057 return rc;
3058 }
3059 pPager->nRec++;
3060 assert( pPager->aInJournal!=0 );
3061 pPager->aInJournal[pPg->pgno/8] |= 1<<(pPg->pgno&7);
3062 pPg->needSync = !pPager->noSync;
3063 if( pPager->stmtInUse ){
3064 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
3065 page_add_to_stmt_list(pPg);
3066 }
drhac69b052004-05-12 13:30:07 +00003067 }
danielk197713adf8a2004-06-03 16:08:41 +00003068 }else{
danielk1977a0bf2652004-11-04 14:30:04 +00003069 pPg->needSync = !pPager->journalStarted && !pPager->noSync;
3070 TRACE4("APPEND %d page %d needSync=%d\n",
danielk1977ef73ee92004-11-06 12:26:07 +00003071 PAGERID(pPager), pPg->pgno, pPg->needSync);
danielk1977a0bf2652004-11-04 14:30:04 +00003072 }
3073 if( pPg->needSync ){
3074 pPager->needSync = 1;
3075 }
3076 pPg->inJournal = 1;
3077 }
3078
3079 /* If the statement journal is open and the page is not in it,
3080 ** then write the current page to the statement journal. Note that
3081 ** the statement journal format differs from the standard journal format
3082 ** in that it omits the checksums and the header.
3083 */
3084 if( pPager->stmtInUse && !pPg->inStmt && (int)pPg->pgno<=pPager->stmtSize ){
3085 assert( pPg->inJournal || (int)pPg->pgno>pPager->origDbSize );
3086 if( MEMDB ){
3087 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
3088 assert( pHist->pStmt==0 );
3089 pHist->pStmt = sqliteMallocRaw( pPager->pageSize );
3090 if( pHist->pStmt ){
3091 memcpy(pHist->pStmt, PGHDR_TO_DATA(pPg), pPager->pageSize);
3092 }
danielk1977ef73ee92004-11-06 12:26:07 +00003093 TRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00003094 }else{
3095 store32bits(pPg->pgno, pPg, -4);
3096 CODEC(pPager, pData, pPg->pgno, 7);
drh054889e2005-11-30 03:20:31 +00003097 rc = sqlite3OsWrite(pPager->stfd,((char*)pData)-4,
drh9c06c952005-11-26 00:25:00 +00003098 pPager->pageSize+4);
danielk1977ef73ee92004-11-06 12:26:07 +00003099 TRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
drhac69b052004-05-12 13:30:07 +00003100 CODEC(pPager, pData, pPg->pgno, 0);
drhac69b052004-05-12 13:30:07 +00003101 if( rc!=SQLITE_OK ){
3102 sqlite3pager_rollback(pPager);
3103 pPager->errMask |= PAGER_ERR_FULL;
3104 return rc;
3105 }
danielk1977a0bf2652004-11-04 14:30:04 +00003106 pPager->stmtNRec++;
3107 assert( pPager->aInStmt!=0 );
3108 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drhdb48ee02003-01-16 13:42:43 +00003109 }
danielk1977a0bf2652004-11-04 14:30:04 +00003110 page_add_to_stmt_list(pPg);
drhd9b02572001-04-15 00:37:09 +00003111 }
drhfa86c412002-02-02 15:01:15 +00003112 }
3113
3114 /* Update the database size and return.
3115 */
drh1ab43002002-01-14 09:28:19 +00003116 if( pPager->dbSize<(int)pPg->pgno ){
drh306dc212001-05-21 13:45:10 +00003117 pPager->dbSize = pPg->pgno;
drhb7f91642004-10-31 02:22:47 +00003118 if( !MEMDB && pPager->dbSize==PENDING_BYTE/pPager->pageSize ){
drh1f595712004-06-15 01:40:29 +00003119 pPager->dbSize++;
3120 }
drh306dc212001-05-21 13:45:10 +00003121 }
drh69688d52001-04-14 16:38:23 +00003122 return rc;
drhed7c8552001-04-11 14:29:21 +00003123}
3124
3125/*
drhaacc5432002-01-06 17:07:40 +00003126** Return TRUE if the page given in the argument was previously passed
drh3aac2dd2004-04-26 14:10:20 +00003127** to sqlite3pager_write(). In other words, return TRUE if it is ok
drh6019e162001-07-02 17:51:45 +00003128** to change the content of the page.
3129*/
drh3aac2dd2004-04-26 14:10:20 +00003130int sqlite3pager_iswriteable(void *pData){
drh6019e162001-07-02 17:51:45 +00003131 PgHdr *pPg = DATA_TO_PGHDR(pData);
3132 return pPg->dirty;
3133}
3134
danielk1977b84f96f2005-01-20 11:32:23 +00003135#ifndef SQLITE_OMIT_VACUUM
drh6019e162001-07-02 17:51:45 +00003136/*
drh001bbcb2003-03-19 03:14:00 +00003137** Replace the content of a single page with the information in the third
3138** argument.
3139*/
drh3aac2dd2004-04-26 14:10:20 +00003140int sqlite3pager_overwrite(Pager *pPager, Pgno pgno, void *pData){
drh001bbcb2003-03-19 03:14:00 +00003141 void *pPage;
3142 int rc;
3143
drh3aac2dd2004-04-26 14:10:20 +00003144 rc = sqlite3pager_get(pPager, pgno, &pPage);
drh001bbcb2003-03-19 03:14:00 +00003145 if( rc==SQLITE_OK ){
drh3aac2dd2004-04-26 14:10:20 +00003146 rc = sqlite3pager_write(pPage);
drh001bbcb2003-03-19 03:14:00 +00003147 if( rc==SQLITE_OK ){
drh90f5ecb2004-07-22 01:19:35 +00003148 memcpy(pPage, pData, pPager->pageSize);
drh001bbcb2003-03-19 03:14:00 +00003149 }
drh3aac2dd2004-04-26 14:10:20 +00003150 sqlite3pager_unref(pPage);
drh001bbcb2003-03-19 03:14:00 +00003151 }
3152 return rc;
3153}
danielk1977b84f96f2005-01-20 11:32:23 +00003154#endif
drh001bbcb2003-03-19 03:14:00 +00003155
3156/*
drh30e58752002-03-02 20:41:57 +00003157** A call to this routine tells the pager that it is not necessary to
3158** write the information on page "pgno" back to the disk, even though
3159** that page might be marked as dirty.
3160**
3161** The overlying software layer calls this routine when all of the data
3162** on the given page is unused. The pager marks the page as clean so
3163** that it does not get written to disk.
3164**
3165** Tests show that this optimization, together with the
drh3aac2dd2004-04-26 14:10:20 +00003166** sqlite3pager_dont_rollback() below, more than double the speed
drh30e58752002-03-02 20:41:57 +00003167** of large INSERT operations and quadruple the speed of large DELETEs.
drh8e298f92002-07-06 16:28:47 +00003168**
3169** When this routine is called, set the alwaysRollback flag to true.
drh3aac2dd2004-04-26 14:10:20 +00003170** Subsequent calls to sqlite3pager_dont_rollback() for the same page
drh8e298f92002-07-06 16:28:47 +00003171** will thereafter be ignored. This is necessary to avoid a problem
3172** where a page with data is added to the freelist during one part of
3173** a transaction then removed from the freelist during a later part
3174** of the same transaction and reused for some other purpose. When it
3175** is first added to the freelist, this routine is called. When reused,
3176** the dont_rollback() routine is called. But because the page contains
3177** critical data, we still need to be sure it gets rolled back in spite
3178** of the dont_rollback() call.
drh30e58752002-03-02 20:41:57 +00003179*/
drh3aac2dd2004-04-26 14:10:20 +00003180void sqlite3pager_dont_write(Pager *pPager, Pgno pgno){
drh30e58752002-03-02 20:41:57 +00003181 PgHdr *pPg;
drh8e298f92002-07-06 16:28:47 +00003182
drhb7f91642004-10-31 02:22:47 +00003183 if( MEMDB ) return;
danielk1977eac7a362004-06-16 07:45:24 +00003184
drh30e58752002-03-02 20:41:57 +00003185 pPg = pager_lookup(pPager, pgno);
drh8e298f92002-07-06 16:28:47 +00003186 pPg->alwaysRollback = 1;
drh8f9b7282005-12-19 16:15:31 +00003187 if( pPg && pPg->dirty && !pPager->stmtInUse ){
drh8124a302002-06-25 14:43:57 +00003188 if( pPager->dbSize==(int)pPg->pgno && pPager->origDbSize<pPager->dbSize ){
3189 /* If this pages is the last page in the file and the file has grown
3190 ** during the current transaction, then do NOT mark the page as clean.
3191 ** When the database file grows, we must make sure that the last page
3192 ** gets written at least once so that the disk file will be the correct
3193 ** size. If you do not write this page and the size of the file
3194 ** on the disk ends up being too small, that can lead to database
3195 ** corruption during the next transaction.
3196 */
3197 }else{
danielk1977ef73ee92004-11-06 12:26:07 +00003198 TRACE3("DONT_WRITE page %d of %d\n", pgno, PAGERID(pPager));
drh8124a302002-06-25 14:43:57 +00003199 pPg->dirty = 0;
danielk19773c407372005-02-15 02:54:14 +00003200#ifdef SQLITE_CHECK_PAGES
3201 pPg->pageHash = pager_pagehash(pPg);
3202#endif
drh8124a302002-06-25 14:43:57 +00003203 }
drh30e58752002-03-02 20:41:57 +00003204 }
3205}
3206
3207/*
3208** A call to this routine tells the pager that if a rollback occurs,
3209** it is not necessary to restore the data on the given page. This
3210** means that the pager does not have to record the given page in the
3211** rollback journal.
3212*/
drh3aac2dd2004-04-26 14:10:20 +00003213void sqlite3pager_dont_rollback(void *pData){
drh30e58752002-03-02 20:41:57 +00003214 PgHdr *pPg = DATA_TO_PGHDR(pData);
3215 Pager *pPager = pPg->pPager;
3216
drha6abd042004-06-09 17:37:22 +00003217 if( pPager->state!=PAGER_EXCLUSIVE || pPager->journalOpen==0 ) return;
drhb7f91642004-10-31 02:22:47 +00003218 if( pPg->alwaysRollback || pPager->alwaysRollback || MEMDB ) return;
drh30e58752002-03-02 20:41:57 +00003219 if( !pPg->inJournal && (int)pPg->pgno <= pPager->origDbSize ){
3220 assert( pPager->aInJournal!=0 );
3221 pPager->aInJournal[pPg->pgno/8] |= 1<<(pPg->pgno&7);
3222 pPg->inJournal = 1;
drhac69b052004-05-12 13:30:07 +00003223 if( pPager->stmtInUse ){
3224 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drh3aac2dd2004-04-26 14:10:20 +00003225 page_add_to_stmt_list(pPg);
drh30e58752002-03-02 20:41:57 +00003226 }
danielk1977ef73ee92004-11-06 12:26:07 +00003227 TRACE3("DONT_ROLLBACK page %d of %d\n", pPg->pgno, PAGERID(pPager));
drh30e58752002-03-02 20:41:57 +00003228 }
drhac69b052004-05-12 13:30:07 +00003229 if( pPager->stmtInUse && !pPg->inStmt && (int)pPg->pgno<=pPager->stmtSize ){
drh30e58752002-03-02 20:41:57 +00003230 assert( pPg->inJournal || (int)pPg->pgno>pPager->origDbSize );
drhac69b052004-05-12 13:30:07 +00003231 assert( pPager->aInStmt!=0 );
3232 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drh3aac2dd2004-04-26 14:10:20 +00003233 page_add_to_stmt_list(pPg);
drh30e58752002-03-02 20:41:57 +00003234 }
3235}
3236
drhac69b052004-05-12 13:30:07 +00003237
danielk197793758c82005-01-21 08:13:14 +00003238#ifndef SQLITE_OMIT_MEMORYDB
drhac69b052004-05-12 13:30:07 +00003239/*
3240** Clear a PgHistory block
3241*/
3242static void clearHistory(PgHistory *pHist){
3243 sqliteFree(pHist->pOrig);
3244 sqliteFree(pHist->pStmt);
3245 pHist->pOrig = 0;
3246 pHist->pStmt = 0;
3247}
danielk197793758c82005-01-21 08:13:14 +00003248#else
3249#define clearHistory(x)
3250#endif
drhac69b052004-05-12 13:30:07 +00003251
drh30e58752002-03-02 20:41:57 +00003252/*
drhed7c8552001-04-11 14:29:21 +00003253** Commit all changes to the database and release the write lock.
drhd9b02572001-04-15 00:37:09 +00003254**
3255** If the commit fails for any reason, a rollback attempt is made
3256** and an error code is returned. If the commit worked, SQLITE_OK
3257** is returned.
drhed7c8552001-04-11 14:29:21 +00003258*/
drh3aac2dd2004-04-26 14:10:20 +00003259int sqlite3pager_commit(Pager *pPager){
drha1b351a2001-09-14 16:42:12 +00003260 int rc;
drhed7c8552001-04-11 14:29:21 +00003261 PgHdr *pPg;
drhd9b02572001-04-15 00:37:09 +00003262
3263 if( pPager->errMask==PAGER_ERR_FULL ){
drh3aac2dd2004-04-26 14:10:20 +00003264 rc = sqlite3pager_rollback(pPager);
drh4e371ee2002-09-05 16:08:27 +00003265 if( rc==SQLITE_OK ){
3266 rc = SQLITE_FULL;
3267 }
drhd9b02572001-04-15 00:37:09 +00003268 return rc;
3269 }
3270 if( pPager->errMask!=0 ){
3271 rc = pager_errcode(pPager);
3272 return rc;
3273 }
drha6abd042004-06-09 17:37:22 +00003274 if( pPager->state<PAGER_RESERVED ){
drhd9b02572001-04-15 00:37:09 +00003275 return SQLITE_ERROR;
3276 }
danielk1977ef73ee92004-11-06 12:26:07 +00003277 TRACE2("COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003278 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00003279 pPg = pager_get_all_dirty_pages(pPager);
3280 while( pPg ){
3281 clearHistory(PGHDR_TO_HIST(pPg, pPager));
3282 pPg->dirty = 0;
3283 pPg->inJournal = 0;
3284 pPg->inStmt = 0;
3285 pPg->pPrevStmt = pPg->pNextStmt = 0;
3286 pPg = pPg->pDirty;
3287 }
danielk1977eac7a362004-06-16 07:45:24 +00003288#ifndef NDEBUG
3289 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
3290 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
3291 assert( !pPg->alwaysRollback );
3292 assert( !pHist->pOrig );
3293 assert( !pHist->pStmt );
3294 }
3295#endif
drhac69b052004-05-12 13:30:07 +00003296 pPager->pStmt = 0;
drha6abd042004-06-09 17:37:22 +00003297 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00003298 return SQLITE_OK;
3299 }
drha6abd042004-06-09 17:37:22 +00003300 if( pPager->dirtyCache==0 ){
drh054889e2005-11-30 03:20:31 +00003301 /* Exit early (without doing the time-consuming sqlite3OsSync() calls)
drha1680452002-04-18 01:56:57 +00003302 ** if there have been no changes to the database file. */
drh341eae82003-01-21 02:39:36 +00003303 assert( pPager->needSync==0 );
drha1680452002-04-18 01:56:57 +00003304 rc = pager_unwritelock(pPager);
3305 pPager->dbSize = -1;
3306 return rc;
3307 }
drhda47d772002-12-02 04:25:19 +00003308 assert( pPager->journalOpen );
danielk1977d761c0c2004-11-05 16:37:02 +00003309 rc = sqlite3pager_sync(pPager, 0, 0);
drha6abd042004-06-09 17:37:22 +00003310 if( rc!=SQLITE_OK ){
3311 goto commit_abort;
3312 }
drhd9b02572001-04-15 00:37:09 +00003313 rc = pager_unwritelock(pPager);
3314 pPager->dbSize = -1;
3315 return rc;
3316
3317 /* Jump here if anything goes wrong during the commit process.
3318 */
3319commit_abort:
drh92f02c32004-09-02 14:57:08 +00003320 sqlite3pager_rollback(pPager);
drhed7c8552001-04-11 14:29:21 +00003321 return rc;
3322}
3323
3324/*
drha6abd042004-06-09 17:37:22 +00003325** Rollback all changes. The database falls back to PAGER_SHARED mode.
drhed7c8552001-04-11 14:29:21 +00003326** All in-memory cache pages revert to their original data contents.
3327** The journal is deleted.
drhd9b02572001-04-15 00:37:09 +00003328**
3329** This routine cannot fail unless some other process is not following
3330** the correct locking protocol (SQLITE_PROTOCOL) or unless some other
3331** process is writing trash into the journal file (SQLITE_CORRUPT) or
3332** unless a prior malloc() failed (SQLITE_NOMEM). Appropriate error
3333** codes are returned for all these occasions. Otherwise,
3334** SQLITE_OK is returned.
drhed7c8552001-04-11 14:29:21 +00003335*/
drh3aac2dd2004-04-26 14:10:20 +00003336int sqlite3pager_rollback(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +00003337 int rc;
danielk1977ef73ee92004-11-06 12:26:07 +00003338 TRACE2("ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003339 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00003340 PgHdr *p;
3341 for(p=pPager->pAll; p; p=p->pNextAll){
3342 PgHistory *pHist;
danielk1977eac7a362004-06-16 07:45:24 +00003343 assert( !p->alwaysRollback );
3344 if( !p->dirty ){
3345 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pOrig );
3346 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pStmt );
3347 continue;
3348 }
3349
drhac69b052004-05-12 13:30:07 +00003350 pHist = PGHDR_TO_HIST(p, pPager);
3351 if( pHist->pOrig ){
3352 memcpy(PGHDR_TO_DATA(p), pHist->pOrig, pPager->pageSize);
danielk1977ef73ee92004-11-06 12:26:07 +00003353 TRACE3("ROLLBACK-PAGE %d of %d\n", p->pgno, PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00003354 }else{
danielk1977ef73ee92004-11-06 12:26:07 +00003355 TRACE3("PAGE %d is clean on %d\n", p->pgno, PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00003356 }
3357 clearHistory(pHist);
3358 p->dirty = 0;
3359 p->inJournal = 0;
3360 p->inStmt = 0;
3361 p->pPrevStmt = p->pNextStmt = 0;
danielk1977369f27e2004-06-15 11:40:04 +00003362
3363 if( pPager->xReiniter ){
3364 pPager->xReiniter(PGHDR_TO_DATA(p), pPager->pageSize);
3365 }
3366
drhac69b052004-05-12 13:30:07 +00003367 }
3368 pPager->pStmt = 0;
3369 pPager->dbSize = pPager->origDbSize;
3370 memoryTruncate(pPager);
3371 pPager->stmtInUse = 0;
drha6abd042004-06-09 17:37:22 +00003372 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00003373 return SQLITE_OK;
3374 }
3375
drha6abd042004-06-09 17:37:22 +00003376 if( !pPager->dirtyCache || !pPager->journalOpen ){
drhda47d772002-12-02 04:25:19 +00003377 rc = pager_unwritelock(pPager);
3378 pPager->dbSize = -1;
3379 return rc;
3380 }
drhdb48ee02003-01-16 13:42:43 +00003381
drhd9b02572001-04-15 00:37:09 +00003382 if( pPager->errMask!=0 && pPager->errMask!=PAGER_ERR_FULL ){
drha6abd042004-06-09 17:37:22 +00003383 if( pPager->state>=PAGER_EXCLUSIVE ){
danielk197776572402004-06-25 02:38:54 +00003384 pager_playback(pPager);
drh4b845d72002-03-05 12:41:19 +00003385 }
drhd9b02572001-04-15 00:37:09 +00003386 return pager_errcode(pPager);
drhed7c8552001-04-11 14:29:21 +00003387 }
drha6abd042004-06-09 17:37:22 +00003388 if( pPager->state==PAGER_RESERVED ){
danielk197717221812005-02-15 03:38:05 +00003389 int rc2;
drha6abd042004-06-09 17:37:22 +00003390 rc = pager_reload_cache(pPager);
danielk197717221812005-02-15 03:38:05 +00003391 rc2 = pager_unwritelock(pPager);
drha6abd042004-06-09 17:37:22 +00003392 if( rc==SQLITE_OK ){
3393 rc = rc2;
3394 }
3395 }else{
danielk197776572402004-06-25 02:38:54 +00003396 rc = pager_playback(pPager);
drhd9b02572001-04-15 00:37:09 +00003397 }
drhd9b02572001-04-15 00:37:09 +00003398 if( rc!=SQLITE_OK ){
drh49285702005-09-17 15:20:26 +00003399 rc = SQLITE_CORRUPT_BKPT;
drhd9b02572001-04-15 00:37:09 +00003400 pPager->errMask |= PAGER_ERR_CORRUPT;
3401 }
3402 pPager->dbSize = -1;
drhed7c8552001-04-11 14:29:21 +00003403 return rc;
drh98808ba2001-10-18 12:34:46 +00003404}
drhd9b02572001-04-15 00:37:09 +00003405
3406/*
drh5e00f6c2001-09-13 13:46:56 +00003407** Return TRUE if the database file is opened read-only. Return FALSE
3408** if the database is (in theory) writable.
3409*/
drh3aac2dd2004-04-26 14:10:20 +00003410int sqlite3pager_isreadonly(Pager *pPager){
drhbe0072d2001-09-13 14:46:09 +00003411 return pPager->readOnly;
drh5e00f6c2001-09-13 13:46:56 +00003412}
3413
3414/*
drhd9b02572001-04-15 00:37:09 +00003415** This routine is used for testing and analysis only.
3416*/
drh3aac2dd2004-04-26 14:10:20 +00003417int *sqlite3pager_stats(Pager *pPager){
danielk197742741be2005-01-08 12:42:39 +00003418 static int a[11];
drhd9b02572001-04-15 00:37:09 +00003419 a[0] = pPager->nRef;
3420 a[1] = pPager->nPage;
3421 a[2] = pPager->mxPage;
3422 a[3] = pPager->dbSize;
3423 a[4] = pPager->state;
3424 a[5] = pPager->errMask;
drhfcd35c72005-05-21 02:48:08 +00003425#ifdef SQLITE_TEST
drhd9b02572001-04-15 00:37:09 +00003426 a[6] = pPager->nHit;
3427 a[7] = pPager->nMiss;
3428 a[8] = pPager->nOvfl;
danielk197742741be2005-01-08 12:42:39 +00003429 a[9] = pPager->nRead;
3430 a[10] = pPager->nWrite;
drhfcd35c72005-05-21 02:48:08 +00003431#endif
drhd9b02572001-04-15 00:37:09 +00003432 return a;
3433}
drhdd793422001-06-28 01:54:48 +00003434
drhfa86c412002-02-02 15:01:15 +00003435/*
drhac69b052004-05-12 13:30:07 +00003436** Set the statement rollback point.
drhfa86c412002-02-02 15:01:15 +00003437**
3438** This routine should be called with the transaction journal already
drhac69b052004-05-12 13:30:07 +00003439** open. A new statement journal is created that can be used to rollback
drhaaab5722002-02-19 13:39:21 +00003440** changes of a single SQL command within a larger transaction.
drhfa86c412002-02-02 15:01:15 +00003441*/
drh3aac2dd2004-04-26 14:10:20 +00003442int sqlite3pager_stmt_begin(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00003443 int rc;
3444 char zTemp[SQLITE_TEMPNAME_SIZE];
drhac69b052004-05-12 13:30:07 +00003445 assert( !pPager->stmtInUse );
drhdc3ff9c2004-08-18 02:10:15 +00003446 assert( pPager->dbSize>=0 );
danielk1977ef73ee92004-11-06 12:26:07 +00003447 TRACE2("STMT-BEGIN %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003448 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00003449 pPager->stmtInUse = 1;
3450 pPager->stmtSize = pPager->dbSize;
3451 return SQLITE_OK;
3452 }
drhda47d772002-12-02 04:25:19 +00003453 if( !pPager->journalOpen ){
drhac69b052004-05-12 13:30:07 +00003454 pPager->stmtAutoopen = 1;
drhda47d772002-12-02 04:25:19 +00003455 return SQLITE_OK;
3456 }
drhfa86c412002-02-02 15:01:15 +00003457 assert( pPager->journalOpen );
drhac69b052004-05-12 13:30:07 +00003458 pPager->aInStmt = sqliteMalloc( pPager->dbSize/8 + 1 );
3459 if( pPager->aInStmt==0 ){
danielk1977261919c2005-12-06 12:52:59 +00003460 /* sqlite3OsLock(pPager->fd, SHARED_LOCK); */
drhfa86c412002-02-02 15:01:15 +00003461 return SQLITE_NOMEM;
3462 }
drh968af522003-02-11 14:55:40 +00003463#ifndef NDEBUG
drh054889e2005-11-30 03:20:31 +00003464 rc = sqlite3OsFileSize(pPager->jfd, &pPager->stmtJSize);
drhac69b052004-05-12 13:30:07 +00003465 if( rc ) goto stmt_begin_failed;
danielk197776572402004-06-25 02:38:54 +00003466 assert( pPager->stmtJSize == pPager->journalOff );
drh968af522003-02-11 14:55:40 +00003467#endif
danielk197776572402004-06-25 02:38:54 +00003468 pPager->stmtJSize = pPager->journalOff;
drhac69b052004-05-12 13:30:07 +00003469 pPager->stmtSize = pPager->dbSize;
danielk197776572402004-06-25 02:38:54 +00003470 pPager->stmtHdrOff = 0;
danielk197775edc162004-06-26 01:48:18 +00003471 pPager->stmtCksum = pPager->cksumInit;
drhac69b052004-05-12 13:30:07 +00003472 if( !pPager->stmtOpen ){
3473 rc = sqlite3pager_opentemp(zTemp, &pPager->stfd);
3474 if( rc ) goto stmt_begin_failed;
3475 pPager->stmtOpen = 1;
3476 pPager->stmtNRec = 0;
drh0f892532002-05-30 12:27:03 +00003477 }
drhac69b052004-05-12 13:30:07 +00003478 pPager->stmtInUse = 1;
drhfa86c412002-02-02 15:01:15 +00003479 return SQLITE_OK;
3480
drhac69b052004-05-12 13:30:07 +00003481stmt_begin_failed:
3482 if( pPager->aInStmt ){
3483 sqliteFree(pPager->aInStmt);
3484 pPager->aInStmt = 0;
drhfa86c412002-02-02 15:01:15 +00003485 }
3486 return rc;
3487}
3488
3489/*
drhac69b052004-05-12 13:30:07 +00003490** Commit a statement.
drhfa86c412002-02-02 15:01:15 +00003491*/
drh3aac2dd2004-04-26 14:10:20 +00003492int sqlite3pager_stmt_commit(Pager *pPager){
drhac69b052004-05-12 13:30:07 +00003493 if( pPager->stmtInUse ){
drh03eb96a2002-11-10 23:32:56 +00003494 PgHdr *pPg, *pNext;
danielk1977ef73ee92004-11-06 12:26:07 +00003495 TRACE2("STMT-COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003496 if( !MEMDB ){
drh054889e2005-11-30 03:20:31 +00003497 sqlite3OsSeek(pPager->stfd, 0);
3498 /* sqlite3OsTruncate(pPager->stfd, 0); */
drhac69b052004-05-12 13:30:07 +00003499 sqliteFree( pPager->aInStmt );
3500 pPager->aInStmt = 0;
drh663fc632002-02-02 18:49:19 +00003501 }
drhac69b052004-05-12 13:30:07 +00003502 for(pPg=pPager->pStmt; pPg; pPg=pNext){
3503 pNext = pPg->pNextStmt;
3504 assert( pPg->inStmt );
3505 pPg->inStmt = 0;
3506 pPg->pPrevStmt = pPg->pNextStmt = 0;
drhb7f91642004-10-31 02:22:47 +00003507 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00003508 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
3509 sqliteFree(pHist->pStmt);
3510 pHist->pStmt = 0;
3511 }
3512 }
3513 pPager->stmtNRec = 0;
3514 pPager->stmtInUse = 0;
3515 pPager->pStmt = 0;
drh663fc632002-02-02 18:49:19 +00003516 }
drhac69b052004-05-12 13:30:07 +00003517 pPager->stmtAutoopen = 0;
drhfa86c412002-02-02 15:01:15 +00003518 return SQLITE_OK;
3519}
3520
3521/*
drhac69b052004-05-12 13:30:07 +00003522** Rollback a statement.
drhfa86c412002-02-02 15:01:15 +00003523*/
drh3aac2dd2004-04-26 14:10:20 +00003524int sqlite3pager_stmt_rollback(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00003525 int rc;
drhac69b052004-05-12 13:30:07 +00003526 if( pPager->stmtInUse ){
danielk1977ef73ee92004-11-06 12:26:07 +00003527 TRACE2("STMT-ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003528 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00003529 PgHdr *pPg;
3530 for(pPg=pPager->pStmt; pPg; pPg=pPg->pNextStmt){
3531 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
3532 if( pHist->pStmt ){
3533 memcpy(PGHDR_TO_DATA(pPg), pHist->pStmt, pPager->pageSize);
3534 sqliteFree(pHist->pStmt);
3535 pHist->pStmt = 0;
3536 }
3537 }
3538 pPager->dbSize = pPager->stmtSize;
3539 memoryTruncate(pPager);
3540 rc = SQLITE_OK;
3541 }else{
3542 rc = pager_stmt_playback(pPager);
3543 }
drh3aac2dd2004-04-26 14:10:20 +00003544 sqlite3pager_stmt_commit(pPager);
drh663fc632002-02-02 18:49:19 +00003545 }else{
3546 rc = SQLITE_OK;
3547 }
drhac69b052004-05-12 13:30:07 +00003548 pPager->stmtAutoopen = 0;
drhfa86c412002-02-02 15:01:15 +00003549 return rc;
3550}
3551
drh73509ee2003-04-06 20:44:45 +00003552/*
3553** Return the full pathname of the database file.
3554*/
drh3aac2dd2004-04-26 14:10:20 +00003555const char *sqlite3pager_filename(Pager *pPager){
drh73509ee2003-04-06 20:44:45 +00003556 return pPager->zFilename;
3557}
3558
drhb20ea9d2004-02-09 01:20:36 +00003559/*
danielk19775865e3d2004-06-14 06:03:57 +00003560** Return the directory of the database file.
3561*/
3562const char *sqlite3pager_dirname(Pager *pPager){
3563 return pPager->zDirectory;
3564}
3565
3566/*
3567** Return the full pathname of the journal file.
3568*/
3569const char *sqlite3pager_journalname(Pager *pPager){
3570 return pPager->zJournal;
3571}
3572
3573/*
drh2c8997b2005-08-27 16:36:48 +00003574** Return true if fsync() calls are disabled for this pager. Return FALSE
3575** if fsync()s are executed normally.
3576*/
3577int sqlite3pager_nosync(Pager *pPager){
3578 return pPager->noSync;
3579}
3580
3581/*
drhb20ea9d2004-02-09 01:20:36 +00003582** Set the codec for this pager
3583*/
drh3aac2dd2004-04-26 14:10:20 +00003584void sqlite3pager_set_codec(
drhb20ea9d2004-02-09 01:20:36 +00003585 Pager *pPager,
drh9eb9e262004-02-11 02:18:05 +00003586 void (*xCodec)(void*,void*,Pgno,int),
drhb20ea9d2004-02-09 01:20:36 +00003587 void *pCodecArg
3588){
3589 pPager->xCodec = xCodec;
3590 pPager->pCodecArg = pCodecArg;
3591}
3592
danielk197713adf8a2004-06-03 16:08:41 +00003593/*
danielk1977aa5ccdf2004-06-14 05:10:42 +00003594** This routine is called to increment the database file change-counter,
3595** stored at byte 24 of the pager file.
3596*/
3597static int pager_incr_changecounter(Pager *pPager){
3598 void *pPage;
3599 PgHdr *pPgHdr;
3600 u32 change_counter;
3601 int rc;
3602
3603 /* Open page 1 of the file for writing. */
3604 rc = sqlite3pager_get(pPager, 1, &pPage);
3605 if( rc!=SQLITE_OK ) return rc;
3606 rc = sqlite3pager_write(pPage);
3607 if( rc!=SQLITE_OK ) return rc;
3608
3609 /* Read the current value at byte 24. */
3610 pPgHdr = DATA_TO_PGHDR(pPage);
3611 change_counter = retrieve32bits(pPgHdr, 24);
3612
3613 /* Increment the value just read and write it back to byte 24. */
3614 change_counter++;
3615 store32bits(change_counter, pPgHdr, 24);
3616
3617 /* Release the page reference. */
3618 sqlite3pager_unref(pPage);
3619 return SQLITE_OK;
3620}
3621
3622/*
danielk197713adf8a2004-06-03 16:08:41 +00003623** Sync the database file for the pager pPager. zMaster points to the name
3624** of a master journal file that should be written into the individual
3625** journal file. zMaster may be NULL, which is interpreted as no master
3626** journal (a single database transaction).
3627**
3628** This routine ensures that the journal is synced, all dirty pages written
3629** to the database file and the database file synced. The only thing that
3630** remains to commit the transaction is to delete the journal file (or
3631** master journal file if specified).
3632**
3633** Note that if zMaster==NULL, this does not overwrite a previous value
3634** passed to an sqlite3pager_sync() call.
danielk1977d761c0c2004-11-05 16:37:02 +00003635**
3636** If parameter nTrunc is non-zero, then the pager file is truncated to
3637** nTrunc pages (this is used by auto-vacuum databases).
danielk197713adf8a2004-06-03 16:08:41 +00003638*/
danielk1977d761c0c2004-11-05 16:37:02 +00003639int sqlite3pager_sync(Pager *pPager, const char *zMaster, Pgno nTrunc){
danielk197713adf8a2004-06-03 16:08:41 +00003640 int rc = SQLITE_OK;
3641
danielk1977ef73ee92004-11-06 12:26:07 +00003642 TRACE4("DATABASE SYNC: File=%s zMaster=%s nTrunc=%d\n",
3643 pPager->zFilename, zMaster, nTrunc);
3644
danielk1977aa5ccdf2004-06-14 05:10:42 +00003645 /* If this is an in-memory db, or no pages have been written to, or this
3646 ** function has already been called, it is a no-op.
danielk197713adf8a2004-06-03 16:08:41 +00003647 */
drhb7f91642004-10-31 02:22:47 +00003648 if( pPager->state!=PAGER_SYNCED && !MEMDB && pPager->dirtyCache ){
danielk197713adf8a2004-06-03 16:08:41 +00003649 PgHdr *pPg;
3650 assert( pPager->journalOpen );
3651
danielk197776572402004-06-25 02:38:54 +00003652 /* If a master journal file name has already been written to the
3653 ** journal file, then no sync is required. This happens when it is
3654 ** written, then the process fails to upgrade from a RESERVED to an
3655 ** EXCLUSIVE lock. The next time the process tries to commit the
3656 ** transaction the m-j name will have already been written.
3657 */
3658 if( !pPager->setMaster ){
3659 rc = pager_incr_changecounter(pPager);
3660 if( rc!=SQLITE_OK ) goto sync_exit;
danielk1977ef73ee92004-11-06 12:26:07 +00003661#ifndef SQLITE_OMIT_AUTOVACUUM
3662 if( nTrunc!=0 ){
3663 /* If this transaction has made the database smaller, then all pages
3664 ** being discarded by the truncation must be written to the journal
3665 ** file.
3666 */
3667 Pgno i;
3668 void *pPage;
drh267cb322005-09-16 17:16:52 +00003669 int iSkip = PAGER_MJ_PGNO(pPager);
danielk1977ef73ee92004-11-06 12:26:07 +00003670 for( i=nTrunc+1; i<=pPager->origDbSize; i++ ){
drh267cb322005-09-16 17:16:52 +00003671 if( !(pPager->aInJournal[i/8] & (1<<(i&7))) && i!=iSkip ){
danielk1977ef73ee92004-11-06 12:26:07 +00003672 rc = sqlite3pager_get(pPager, i, &pPage);
3673 if( rc!=SQLITE_OK ) goto sync_exit;
3674 rc = sqlite3pager_write(pPage);
3675 sqlite3pager_unref(pPage);
3676 if( rc!=SQLITE_OK ) goto sync_exit;
3677 }
3678 }
3679 }
3680#endif
danielk197776572402004-06-25 02:38:54 +00003681 rc = writeMasterJournal(pPager, zMaster);
3682 if( rc!=SQLITE_OK ) goto sync_exit;
3683 rc = syncJournal(pPager);
3684 if( rc!=SQLITE_OK ) goto sync_exit;
3685 }
danielk197713adf8a2004-06-03 16:08:41 +00003686
danielk1977d761c0c2004-11-05 16:37:02 +00003687#ifndef SQLITE_OMIT_AUTOVACUUM
3688 if( nTrunc!=0 ){
3689 rc = sqlite3pager_truncate(pPager, nTrunc);
3690 if( rc!=SQLITE_OK ) goto sync_exit;
3691 }
3692#endif
3693
danielk197713adf8a2004-06-03 16:08:41 +00003694 /* Write all dirty pages to the database file */
3695 pPg = pager_get_all_dirty_pages(pPager);
3696 rc = pager_write_pagelist(pPg);
3697 if( rc!=SQLITE_OK ) goto sync_exit;
3698
danielk1977aa5ccdf2004-06-14 05:10:42 +00003699 /* Sync the database file. */
3700 if( !pPager->noSync ){
drh054889e2005-11-30 03:20:31 +00003701 rc = sqlite3OsSync(pPager->fd, 0);
danielk197713adf8a2004-06-03 16:08:41 +00003702 }
danielk1977aa5ccdf2004-06-14 05:10:42 +00003703
3704 pPager->state = PAGER_SYNCED;
danielk197713adf8a2004-06-03 16:08:41 +00003705 }
3706
3707sync_exit:
3708 return rc;
3709}
3710
danielk1977687566d2004-11-02 12:56:41 +00003711#ifndef SQLITE_OMIT_AUTOVACUUM
3712/*
3713** Move the page identified by pData to location pgno in the file.
3714**
3715** There must be no references to the current page pgno. If current page
3716** pgno is not already in the rollback journal, it is not written there by
3717** by this routine. The same applies to the page pData refers to on entry to
3718** this routine.
3719**
3720** References to the page refered to by pData remain valid. Updating any
3721** meta-data associated with page pData (i.e. data stored in the nExtra bytes
3722** allocated along with the page) is the responsibility of the caller.
3723**
danielk19775fd057a2005-03-09 13:09:43 +00003724** A transaction must be active when this routine is called. It used to be
3725** required that a statement transaction was not active, but this restriction
3726** has been removed (CREATE INDEX needs to move a page when a statement
3727** transaction is active).
danielk1977687566d2004-11-02 12:56:41 +00003728*/
3729int sqlite3pager_movepage(Pager *pPager, void *pData, Pgno pgno){
3730 PgHdr *pPg = DATA_TO_PGHDR(pData);
3731 PgHdr *pPgOld;
danielk1977f5fdda82004-11-03 08:44:05 +00003732 int h;
danielk197794daf7f2004-11-08 09:26:09 +00003733 Pgno needSyncPgno = 0;
danielk1977687566d2004-11-02 12:56:41 +00003734
danielk1977687566d2004-11-02 12:56:41 +00003735 assert( pPg->nRef>0 );
3736
danielk1977599fcba2004-11-08 07:13:13 +00003737 TRACE5("MOVE %d page %d (needSync=%d) moves to %d\n",
3738 PAGERID(pPager), pPg->pgno, pPg->needSync, pgno);
danielk1977ef73ee92004-11-06 12:26:07 +00003739
danielk197794daf7f2004-11-08 09:26:09 +00003740 if( pPg->needSync ){
3741 needSyncPgno = pPg->pgno;
3742 assert( pPg->inJournal );
3743 assert( pPg->dirty );
danielk1977ae825582004-11-23 09:06:55 +00003744 assert( pPager->needSync );
danielk197794daf7f2004-11-08 09:26:09 +00003745 }
3746
danielk1977687566d2004-11-02 12:56:41 +00003747 /* Unlink pPg from it's hash-chain */
danielk1977f5fdda82004-11-03 08:44:05 +00003748 unlinkHashChain(pPager, pPg);
danielk1977687566d2004-11-02 12:56:41 +00003749
danielk1977ef73ee92004-11-06 12:26:07 +00003750 /* If the cache contains a page with page-number pgno, remove it
danielk1977599fcba2004-11-08 07:13:13 +00003751 ** from it's hash chain. Also, if the PgHdr.needSync was set for
3752 ** page pgno before the 'move' operation, it needs to be retained
3753 ** for the page moved there.
danielk1977f5fdda82004-11-03 08:44:05 +00003754 */
danielk1977687566d2004-11-02 12:56:41 +00003755 pPgOld = pager_lookup(pPager, pgno);
3756 if( pPgOld ){
danielk1977f5fdda82004-11-03 08:44:05 +00003757 assert( pPgOld->nRef==0 );
3758 unlinkHashChain(pPager, pPgOld);
3759 pPgOld->dirty = 0;
danielk1977ef73ee92004-11-06 12:26:07 +00003760 if( pPgOld->needSync ){
danielk197745901d62004-11-10 15:27:38 +00003761 assert( pPgOld->inJournal );
3762 pPg->inJournal = 1;
danielk1977ef73ee92004-11-06 12:26:07 +00003763 pPg->needSync = 1;
danielk1977ae825582004-11-23 09:06:55 +00003764 assert( pPager->needSync );
danielk1977ef73ee92004-11-06 12:26:07 +00003765 }
danielk1977687566d2004-11-02 12:56:41 +00003766 }
3767
danielk1977f5fdda82004-11-03 08:44:05 +00003768 /* Change the page number for pPg and insert it into the new hash-chain. */
3769 pPg->pgno = pgno;
3770 h = pager_hash(pgno);
3771 if( pPager->aHash[h] ){
3772 assert( pPager->aHash[h]->pPrevHash==0 );
3773 pPager->aHash[h]->pPrevHash = pPg;
3774 }
3775 pPg->pNextHash = pPager->aHash[h];
3776 pPager->aHash[h] = pPg;
3777 pPg->pPrevHash = 0;
3778
danielk1977687566d2004-11-02 12:56:41 +00003779 pPg->dirty = 1;
3780 pPager->dirtyCache = 1;
3781
danielk197794daf7f2004-11-08 09:26:09 +00003782 if( needSyncPgno ){
3783 /* If needSyncPgno is non-zero, then the journal file needs to be
3784 ** sync()ed before any data is written to database file page needSyncPgno.
3785 ** Currently, no such page exists in the page-cache and the
3786 ** Pager.aInJournal bit has been set. This needs to be remedied by loading
3787 ** the page into the pager-cache and setting the PgHdr.needSync flag.
danielk1977ae825582004-11-23 09:06:55 +00003788 **
3789 ** The sqlite3pager_get() call may cause the journal to sync. So make
3790 ** sure the Pager.needSync flag is set too.
danielk197794daf7f2004-11-08 09:26:09 +00003791 */
3792 int rc;
3793 void *pNeedSync;
danielk1977ae825582004-11-23 09:06:55 +00003794 assert( pPager->needSync );
danielk197794daf7f2004-11-08 09:26:09 +00003795 rc = sqlite3pager_get(pPager, needSyncPgno, &pNeedSync);
3796 if( rc!=SQLITE_OK ) return rc;
danielk1977ae825582004-11-23 09:06:55 +00003797 pPager->needSync = 1;
danielk197794daf7f2004-11-08 09:26:09 +00003798 DATA_TO_PGHDR(pNeedSync)->needSync = 1;
3799 DATA_TO_PGHDR(pNeedSync)->inJournal = 1;
3800 DATA_TO_PGHDR(pNeedSync)->dirty = 1;
3801 sqlite3pager_unref(pNeedSync);
3802 }
3803
danielk1977687566d2004-11-02 12:56:41 +00003804 return SQLITE_OK;
3805}
3806#endif
3807
dougcurrie81c95ef2004-06-18 23:21:47 +00003808#if defined(SQLITE_DEBUG) || defined(SQLITE_TEST)
drh89ac8c12004-06-09 14:17:20 +00003809/*
3810** Return the current state of the file lock for the given pager.
3811** The return value is one of NO_LOCK, SHARED_LOCK, RESERVED_LOCK,
3812** PENDING_LOCK, or EXCLUSIVE_LOCK.
3813*/
3814int sqlite3pager_lockstate(Pager *pPager){
drh054889e2005-11-30 03:20:31 +00003815 return sqlite3OsLockState(pPager->fd);
drh89ac8c12004-06-09 14:17:20 +00003816}
3817#endif
3818
danielk197793758c82005-01-21 08:13:14 +00003819#ifdef SQLITE_DEBUG
drhdd793422001-06-28 01:54:48 +00003820/*
3821** Print a listing of all referenced pages and their ref count.
3822*/
drh3aac2dd2004-04-26 14:10:20 +00003823void sqlite3pager_refdump(Pager *pPager){
drhdd793422001-06-28 01:54:48 +00003824 PgHdr *pPg;
3825 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
3826 if( pPg->nRef<=0 ) continue;
drhfe63d1c2004-09-08 20:13:04 +00003827 sqlite3DebugPrintf("PAGE %3d addr=%p nRef=%d\n",
3828 pPg->pgno, PGHDR_TO_DATA(pPg), pPg->nRef);
drhdd793422001-06-28 01:54:48 +00003829 }
3830}
3831#endif
drh2e66f0b2005-04-28 17:18:48 +00003832
3833#endif /* SQLITE_OMIT_DISKIO */