blob: 4a65af72c17d0b7454f19260bc6f426ca4ce8162 [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**
danielk197717221812005-02-15 03:38:05 +000021** @(#) $Id: pager.c,v 1.190 2005/02/15 03:38:06 danielk1977 Exp $
drhed7c8552001-04-11 14:29:21 +000022*/
drhd9b02572001-04-15 00:37:09 +000023#include "sqliteInt.h"
drheb206252004-10-01 02:00:31 +000024#include "os.h"
drhed7c8552001-04-11 14:29:21 +000025#include "pager.h"
drhed7c8552001-04-11 14:29:21 +000026#include <assert.h>
drhd9b02572001-04-15 00:37:09 +000027#include <string.h>
drhed7c8552001-04-11 14:29:21 +000028
29/*
drhdb48ee02003-01-16 13:42:43 +000030** Macros for troubleshooting. Normally turned off
31*/
danielk1977466be562004-06-10 02:16:01 +000032#if 0
drh34f47322004-08-18 15:58:22 +000033#define TRACE1(X) sqlite3DebugPrintf(X)
34#define TRACE2(X,Y) sqlite3DebugPrintf(X,Y)
35#define TRACE3(X,Y,Z) sqlite3DebugPrintf(X,Y,Z)
36#define TRACE4(X,Y,Z,W) sqlite3DebugPrintf(X,Y,Z,W)
danielk197794daf7f2004-11-08 09:26:09 +000037#define TRACE5(X,Y,Z,W,V) sqlite3DebugPrintf(X,Y,Z,W,V)
drhdb48ee02003-01-16 13:42:43 +000038#else
drhdb48ee02003-01-16 13:42:43 +000039#define TRACE1(X)
40#define TRACE2(X,Y)
41#define TRACE3(X,Y,Z)
drh34f47322004-08-18 15:58:22 +000042#define TRACE4(X,Y,Z,W)
danielk1977599fcba2004-11-08 07:13:13 +000043#define TRACE5(X,Y,Z,W,V)
drhdb48ee02003-01-16 13:42:43 +000044#endif
45
danielk1977599fcba2004-11-08 07:13:13 +000046/*
47** The following two macros are used within the TRACEX() macros above
48** to print out file-descriptors. They are required so that tracing
49** can be turned on when using both the regular os_unix.c and os_test.c
50** backends.
51**
52** PAGERID() takes a pointer to a Pager struct as it's argument. The
53** associated file-descriptor is returned. FILEHANDLEID() takes an OsFile
54** struct as it's argument.
55*/
danielk1977ef73ee92004-11-06 12:26:07 +000056#ifdef OS_TEST
57#define PAGERID(p) (p->fd->fd.h)
58#define FILEHANDLEID(fd) (fd->fd.h)
59#else
60#define PAGERID(p) (p->fd.h)
61#define FILEHANDLEID(fd) (fd.h)
62#endif
drhdb48ee02003-01-16 13:42:43 +000063
64/*
drhed7c8552001-04-11 14:29:21 +000065** The page cache as a whole is always in one of the following
66** states:
67**
drha6abd042004-06-09 17:37:22 +000068** PAGER_UNLOCK The page cache is not currently reading or
drhed7c8552001-04-11 14:29:21 +000069** writing the database file. There is no
70** data held in memory. This is the initial
71** state.
72**
drha6abd042004-06-09 17:37:22 +000073** PAGER_SHARED The page cache is reading the database.
drhed7c8552001-04-11 14:29:21 +000074** Writing is not permitted. There can be
75** multiple readers accessing the same database
drh69688d52001-04-14 16:38:23 +000076** file at the same time.
drhed7c8552001-04-11 14:29:21 +000077**
drh726de592004-06-10 23:35:50 +000078** PAGER_RESERVED This process has reserved the database for writing
79** but has not yet made any changes. Only one process
80** at a time can reserve the database. The original
81** database file has not been modified so other
82** processes may still be reading the on-disk
drha6abd042004-06-09 17:37:22 +000083** database file.
84**
85** PAGER_EXCLUSIVE The page cache is writing the database.
drhed7c8552001-04-11 14:29:21 +000086** Access is exclusive. No other processes or
87** threads can be reading or writing while one
88** process is writing.
89**
danielk1977aa5ccdf2004-06-14 05:10:42 +000090** PAGER_SYNCED The pager moves to this state from PAGER_EXCLUSIVE
91** after all dirty pages have been written to the
92** database file and the file has been synced to
93** disk. All that remains to do is to remove the
94** journal file and the transaction will be
95** committed.
96**
drha6abd042004-06-09 17:37:22 +000097** The page cache comes up in PAGER_UNLOCK. The first time a
drh726de592004-06-10 23:35:50 +000098** sqlite3pager_get() occurs, the state transitions to PAGER_SHARED.
drhed7c8552001-04-11 14:29:21 +000099** After all pages have been released using sqlite_page_unref(),
drha6abd042004-06-09 17:37:22 +0000100** the state transitions back to PAGER_UNLOCK. The first time
drh726de592004-06-10 23:35:50 +0000101** that sqlite3pager_write() is called, the state transitions to
drha6abd042004-06-09 17:37:22 +0000102** PAGER_RESERVED. (Note that sqlite_page_write() can only be
drh306dc212001-05-21 13:45:10 +0000103** called on an outstanding page which means that the pager must
drha6abd042004-06-09 17:37:22 +0000104** be in PAGER_SHARED before it transitions to PAGER_RESERVED.)
drh726de592004-06-10 23:35:50 +0000105** The transition to PAGER_EXCLUSIVE occurs when before any changes
106** are made to the database file. After an sqlite3pager_rollback()
107** or sqlite_pager_commit(), the state goes back to PAGER_SHARED.
drhed7c8552001-04-11 14:29:21 +0000108*/
drha6abd042004-06-09 17:37:22 +0000109#define PAGER_UNLOCK 0
drh684917c2004-10-05 02:41:42 +0000110#define PAGER_SHARED 1 /* same as SHARED_LOCK */
111#define PAGER_RESERVED 2 /* same as RESERVED_LOCK */
112#define PAGER_EXCLUSIVE 4 /* same as EXCLUSIVE_LOCK */
113#define PAGER_SYNCED 5
drhed7c8552001-04-11 14:29:21 +0000114
drh684917c2004-10-05 02:41:42 +0000115/*
116** If the SQLITE_BUSY_RESERVED_LOCK macro is set to true at compile-time,
117** then failed attempts to get a reserved lock will invoke the busy callback.
118** This is off by default. To see why, consider the following scenario:
119**
120** Suppose thread A already has a shared lock and wants a reserved lock.
121** Thread B already has a reserved lock and wants an exclusive lock. If
122** both threads are using their busy callbacks, it might be a long time
123** be for one of the threads give up and allows the other to proceed.
124** But if the thread trying to get the reserved lock gives up quickly
125** (if it never invokes its busy callback) then the contention will be
126** resolved quickly.
127*/
128#ifndef SQLITE_BUSY_RESERVED_LOCK
129# define SQLITE_BUSY_RESERVED_LOCK 0
130#endif
drhd9b02572001-04-15 00:37:09 +0000131
drhed7c8552001-04-11 14:29:21 +0000132/*
drh887dc4c2004-10-22 16:22:57 +0000133** This macro rounds values up so that if the value is an address it
134** is guaranteed to be an address that is aligned to an 8-byte boundary.
135*/
136#define FORCE_ALIGNMENT(X) (((X)+7)&~7)
137
138/*
drhed7c8552001-04-11 14:29:21 +0000139** Each in-memory image of a page begins with the following header.
drhbd03cae2001-06-02 02:40:57 +0000140** This header is only visible to this pager module. The client
141** code that calls pager sees only the data that follows the header.
drhf6038712004-02-08 18:07:34 +0000142**
drh3aac2dd2004-04-26 14:10:20 +0000143** Client code should call sqlite3pager_write() on a page prior to making
144** any modifications to that page. The first time sqlite3pager_write()
drhf6038712004-02-08 18:07:34 +0000145** is called, the original page contents are written into the rollback
146** journal and PgHdr.inJournal and PgHdr.needSync are set. Later, once
147** the journal page has made it onto the disk surface, PgHdr.needSync
148** is cleared. The modified page cannot be written back into the original
149** database file until the journal pages has been synced to disk and the
150** PgHdr.needSync has been cleared.
151**
drh3aac2dd2004-04-26 14:10:20 +0000152** The PgHdr.dirty flag is set when sqlite3pager_write() is called and
drhf6038712004-02-08 18:07:34 +0000153** is cleared again when the page content is written back to the original
154** database file.
drhed7c8552001-04-11 14:29:21 +0000155*/
drhd9b02572001-04-15 00:37:09 +0000156typedef struct PgHdr PgHdr;
drhed7c8552001-04-11 14:29:21 +0000157struct PgHdr {
158 Pager *pPager; /* The pager to which this page belongs */
159 Pgno pgno; /* The page number for this page */
drh69688d52001-04-14 16:38:23 +0000160 PgHdr *pNextHash, *pPrevHash; /* Hash collision chain for PgHdr.pgno */
drhd9b02572001-04-15 00:37:09 +0000161 PgHdr *pNextFree, *pPrevFree; /* Freelist of pages where nRef==0 */
drhac69b052004-05-12 13:30:07 +0000162 PgHdr *pNextAll; /* A list of all pages */
163 PgHdr *pNextStmt, *pPrevStmt; /* List of pages in the statement journal */
drh193a6b42002-07-07 16:52:46 +0000164 u8 inJournal; /* TRUE if has been written to journal */
drhac69b052004-05-12 13:30:07 +0000165 u8 inStmt; /* TRUE if in the statement subjournal */
drh193a6b42002-07-07 16:52:46 +0000166 u8 dirty; /* TRUE if we need to write back changes */
drhdb48ee02003-01-16 13:42:43 +0000167 u8 needSync; /* Sync journal before writing this page */
drh193a6b42002-07-07 16:52:46 +0000168 u8 alwaysRollback; /* Disable dont_rollback() for this page */
drhac69b052004-05-12 13:30:07 +0000169 short int nRef; /* Number of users of this page */
drh2554f8b2003-01-22 01:26:44 +0000170 PgHdr *pDirty; /* Dirty pages sorted by PgHdr.pgno */
danielk19773c407372005-02-15 02:54:14 +0000171#ifdef SQLITE_CHECK_PAGES
172 u32 pageHash;
173#endif
drh887dc4c2004-10-22 16:22:57 +0000174 /* pPager->psAligned bytes of page data follow this header */
drh973b6e32003-02-12 14:09:42 +0000175 /* Pager.nExtra bytes of local data follow the page data */
drhed7c8552001-04-11 14:29:21 +0000176};
177
drhac69b052004-05-12 13:30:07 +0000178/*
179** For an in-memory only database, some extra information is recorded about
180** each page so that changes can be rolled back. (Journal files are not
181** used for in-memory databases.) The following information is added to
182** the end of every EXTRA block for in-memory databases.
183**
184** This information could have been added directly to the PgHdr structure.
185** But then it would take up an extra 8 bytes of storage on every PgHdr
186** even for disk-based databases. Splitting it out saves 8 bytes. This
187** is only a savings of 0.8% but those percentages add up.
188*/
189typedef struct PgHistory PgHistory;
190struct PgHistory {
191 u8 *pOrig; /* Original page text. Restore to this on a full rollback */
192 u8 *pStmt; /* Text as it was at the beginning of the current statement */
193};
drh9eb9e262004-02-11 02:18:05 +0000194
195/*
196** A macro used for invoking the codec if there is one
197*/
198#ifdef SQLITE_HAS_CODEC
199# define CODEC(P,D,N,X) if( P->xCodec ){ P->xCodec(P->pCodecArg,D,N,X); }
200#else
201# define CODEC(P,D,N,X)
202#endif
203
drhed7c8552001-04-11 14:29:21 +0000204/*
drh69688d52001-04-14 16:38:23 +0000205** Convert a pointer to a PgHdr into a pointer to its data
206** and back again.
drhed7c8552001-04-11 14:29:21 +0000207*/
208#define PGHDR_TO_DATA(P) ((void*)(&(P)[1]))
209#define DATA_TO_PGHDR(D) (&((PgHdr*)(D))[-1])
drh887dc4c2004-10-22 16:22:57 +0000210#define PGHDR_TO_EXTRA(G,P) ((void*)&((char*)(&(G)[1]))[(P)->psAligned])
drhac69b052004-05-12 13:30:07 +0000211#define PGHDR_TO_HIST(P,PGR) \
drh887dc4c2004-10-22 16:22:57 +0000212 ((PgHistory*)&((char*)(&(P)[1]))[(PGR)->psAligned+(PGR)->nExtra])
drhed7c8552001-04-11 14:29:21 +0000213
214/*
drhed7c8552001-04-11 14:29:21 +0000215** How big to make the hash table used for locating in-memory pages
drh836faa42003-01-11 13:30:57 +0000216** by page number.
drhed7c8552001-04-11 14:29:21 +0000217*/
drh836faa42003-01-11 13:30:57 +0000218#define N_PG_HASH 2048
219
220/*
221** Hash a page number
222*/
223#define pager_hash(PN) ((PN)&(N_PG_HASH-1))
drhed7c8552001-04-11 14:29:21 +0000224
225/*
226** A open page cache is an instance of the following structure.
227*/
228struct Pager {
229 char *zFilename; /* Name of the database file */
230 char *zJournal; /* Name of the journal file */
drha76c82e2003-07-27 18:59:42 +0000231 char *zDirectory; /* Directory hold database and journal files */
drh8cfbf082001-09-19 13:22:39 +0000232 OsFile fd, jfd; /* File descriptors for database and journal */
drhac69b052004-05-12 13:30:07 +0000233 OsFile stfd; /* File descriptor for the statement subjournal*/
drhed7c8552001-04-11 14:29:21 +0000234 int dbSize; /* Number of pages in the file */
drh69688d52001-04-14 16:38:23 +0000235 int origDbSize; /* dbSize before the current change */
drhac69b052004-05-12 13:30:07 +0000236 int stmtSize; /* Size of database (in pages) at stmt_begin() */
drheb206252004-10-01 02:00:31 +0000237 i64 stmtJSize; /* Size of journal at stmt_begin() */
drh968af522003-02-11 14:55:40 +0000238 int nRec; /* Number of pages written to the journal */
239 u32 cksumInit; /* Quasi-random value added to every checksum */
drhac69b052004-05-12 13:30:07 +0000240 int stmtNRec; /* Number of records in stmt subjournal */
drh7e3b0a02001-04-28 16:52:40 +0000241 int nExtra; /* Add this many bytes to each in-memory page */
drhb6f41482004-05-14 01:58:11 +0000242 void (*xDestructor)(void*,int); /* Call this routine when freeing pages */
drha6abd042004-06-09 17:37:22 +0000243 void (*xReiniter)(void*,int); /* Call this routine when reloading pages */
drhb6f41482004-05-14 01:58:11 +0000244 int pageSize; /* Number of bytes in a page */
drh887dc4c2004-10-22 16:22:57 +0000245 int psAligned; /* pageSize rounded up to a multiple of 8 */
drhed7c8552001-04-11 14:29:21 +0000246 int nPage; /* Total number of in-memory pages */
drhd9b02572001-04-15 00:37:09 +0000247 int nRef; /* Number of in-memory pages with PgHdr.nRef>0 */
drhed7c8552001-04-11 14:29:21 +0000248 int mxPage; /* Maximum number of pages to hold in cache */
drhd9b02572001-04-15 00:37:09 +0000249 int nHit, nMiss, nOvfl; /* Cache hits, missing, and LRU overflows */
danielk197742741be2005-01-08 12:42:39 +0000250 int nRead,nWrite; /* Database pages read/written */
drh9eb9e262004-02-11 02:18:05 +0000251 void (*xCodec)(void*,void*,Pgno,int); /* Routine for en/decoding data */
drhb20ea9d2004-02-09 01:20:36 +0000252 void *pCodecArg; /* First argument to xCodec() */
drh603240c2002-03-05 01:11:12 +0000253 u8 journalOpen; /* True if journal file descriptors is valid */
drh34e79ce2004-02-08 06:05:46 +0000254 u8 journalStarted; /* True if header of journal is synced */
255 u8 useJournal; /* Use a rollback journal on this file */
drh7bec5052005-02-06 02:45:41 +0000256 u8 noReadlock; /* Do not bother to obtain readlocks */
drhac69b052004-05-12 13:30:07 +0000257 u8 stmtOpen; /* True if the statement subjournal is open */
258 u8 stmtInUse; /* True we are in a statement subtransaction */
259 u8 stmtAutoopen; /* Open stmt journal when main journal is opened*/
drh603240c2002-03-05 01:11:12 +0000260 u8 noSync; /* Do not sync the journal if true */
drh968af522003-02-11 14:55:40 +0000261 u8 fullSync; /* Do extra syncs of the journal for robustness */
drha6abd042004-06-09 17:37:22 +0000262 u8 state; /* PAGER_UNLOCK, _SHARED, _RESERVED, etc. */
drh603240c2002-03-05 01:11:12 +0000263 u8 errMask; /* One of several kinds of errors */
264 u8 tempFile; /* zFilename is a temporary file */
265 u8 readOnly; /* True for a read-only database */
266 u8 needSync; /* True if an fsync() is needed on the journal */
drha6abd042004-06-09 17:37:22 +0000267 u8 dirtyCache; /* True if cached pages have changed */
drh193a6b42002-07-07 16:52:46 +0000268 u8 alwaysRollback; /* Disable dont_rollback() for all pages */
drhac69b052004-05-12 13:30:07 +0000269 u8 memDb; /* True to inhibit all file I/O */
drh603240c2002-03-05 01:11:12 +0000270 u8 *aInJournal; /* One bit for each page in the database file */
drhac69b052004-05-12 13:30:07 +0000271 u8 *aInStmt; /* One bit for each page in the database */
drhfdb38062004-08-21 19:20:42 +0000272 u8 setMaster; /* True if a m-j name has been written to jrnl */
drh726de592004-06-10 23:35:50 +0000273 BusyHandler *pBusyHandler; /* Pointer to sqlite.busyHandler */
drhed7c8552001-04-11 14:29:21 +0000274 PgHdr *pFirst, *pLast; /* List of free pages */
drh341eae82003-01-21 02:39:36 +0000275 PgHdr *pFirstSynced; /* First free page with PgHdr.needSync==0 */
drhd9b02572001-04-15 00:37:09 +0000276 PgHdr *pAll; /* List of all pages */
drhac69b052004-05-12 13:30:07 +0000277 PgHdr *pStmt; /* List of pages in the statement subjournal */
drheb206252004-10-01 02:00:31 +0000278 i64 journalOff; /* Current byte offset in the journal file */
279 i64 journalHdr; /* Byte offset to previous journal header */
280 i64 stmtHdrOff; /* First journal header written this statement */
281 i64 stmtCksum; /* cksumInit when statement was started */
danielk197776572402004-06-25 02:38:54 +0000282 int sectorSize; /* Assumed sector size during rollback */
drh76ff3a02004-09-24 22:32:30 +0000283 PgHdr *aHash[N_PG_HASH]; /* Hash table to map page number to PgHdr */
drhd9b02572001-04-15 00:37:09 +0000284};
285
286/*
287** These are bits that can be set in Pager.errMask.
288*/
289#define PAGER_ERR_FULL 0x01 /* a write() failed */
290#define PAGER_ERR_MEM 0x02 /* malloc() failed */
291#define PAGER_ERR_LOCK 0x04 /* error in the locking protocol */
292#define PAGER_ERR_CORRUPT 0x08 /* database or journal corruption */
drh81a20f22001-10-12 17:30:04 +0000293#define PAGER_ERR_DISK 0x10 /* general disk I/O error - bad hard drive? */
drhd9b02572001-04-15 00:37:09 +0000294
295/*
drh5e00f6c2001-09-13 13:46:56 +0000296** Journal files begin with the following magic string. The data
297** was obtained from /dev/random. It is used only as a sanity check.
drh94f33312002-08-12 12:29:56 +0000298**
drhae2b40c2004-06-09 19:03:54 +0000299** Since version 2.8.0, the journal format contains additional sanity
300** checking information. If the power fails while the journal is begin
301** written, semi-random garbage data might appear in the journal
302** file after power is restored. If an attempt is then made
drh968af522003-02-11 14:55:40 +0000303** to roll the journal back, the database could be corrupted. The additional
304** sanity checking data is an attempt to discover the garbage in the
305** journal and ignore it.
306**
drhae2b40c2004-06-09 19:03:54 +0000307** The sanity checking information for the new journal format consists
drh968af522003-02-11 14:55:40 +0000308** of a 32-bit checksum on each page of data. The checksum covers both
drh90f5ecb2004-07-22 01:19:35 +0000309** the page number and the pPager->pageSize bytes of data for the page.
drh968af522003-02-11 14:55:40 +0000310** This cksum is initialized to a 32-bit random value that appears in the
311** journal file right after the header. The random initializer is important,
312** because garbage data that appears at the end of a journal is likely
313** data that was once in other files that have now been deleted. If the
314** garbage data came from an obsolete journal file, the checksums might
315** be correct. But by initializing the checksum to random value which
316** is different for every journal, we minimize that risk.
drhd9b02572001-04-15 00:37:09 +0000317*/
drhae2b40c2004-06-09 19:03:54 +0000318static const unsigned char aJournalMagic[] = {
319 0xd9, 0xd5, 0x05, 0xf9, 0x20, 0xa1, 0x63, 0xd7,
drhed7c8552001-04-11 14:29:21 +0000320};
321
322/*
drh726de592004-06-10 23:35:50 +0000323** The size of the header and of each page in the journal is determined
324** by the following macros.
drh968af522003-02-11 14:55:40 +0000325*/
drhae2b40c2004-06-09 19:03:54 +0000326#define JOURNAL_PG_SZ(pPager) ((pPager->pageSize) + 8)
drh968af522003-02-11 14:55:40 +0000327
danielk197776572402004-06-25 02:38:54 +0000328/*
329** The journal header size for this pager. In the future, this could be
330** set to some value read from the disk controller. The important
331** characteristic is that it is the same size as a disk sector.
332*/
333#define JOURNAL_HDR_SZ(pPager) (pPager->sectorSize)
334
drhb7f91642004-10-31 02:22:47 +0000335/*
336** The macro MEMDB is true if we are dealing with an in-memory database.
337** We do this as a macro so that if the SQLITE_OMIT_MEMORYDB macro is set,
338** the value of MEMDB will be a constant and the compiler will optimize
339** out code that would never execute.
340*/
341#ifdef SQLITE_OMIT_MEMORYDB
342# define MEMDB 0
343#else
344# define MEMDB pPager->memDb
345#endif
346
347/*
348** The default size of a disk sector
349*/
danielk197776572402004-06-25 02:38:54 +0000350#define PAGER_SECTOR_SIZE 512
351
352/*
353** Page number PAGER_MJ_PGNO is never used in an SQLite database (it is
354** reserved for working around a windows/posix incompatibility). It is
355** used in the journal to signify that the remainder of the journal file
356** is devoted to storing a master journal name - there are no more pages to
357** roll back. See comments for function writeMasterJournal() for details.
358*/
danielk1977599fcba2004-11-08 07:13:13 +0000359/* #define PAGER_MJ_PGNO(x) (PENDING_BYTE/((x)->pageSize)) */
360#define PAGER_MJ_PGNO(x) ((PENDING_BYTE/((x)->pageSize))+1)
danielk197713adf8a2004-06-03 16:08:41 +0000361
drh968af522003-02-11 14:55:40 +0000362/*
danielk197726836652005-01-17 01:33:13 +0000363** The maximum legal page number is (2^31 - 1).
364*/
365#define PAGER_MAX_PGNO 2147483647
366
367/*
drh726de592004-06-10 23:35:50 +0000368** Enable reference count tracking (for debugging) here:
drhdd793422001-06-28 01:54:48 +0000369*/
danielk1977aca790a2005-01-13 11:07:52 +0000370#ifdef SQLITE_DEBUG
drh3aac2dd2004-04-26 14:10:20 +0000371 int pager3_refinfo_enable = 0;
drhdd793422001-06-28 01:54:48 +0000372 static void pager_refinfo(PgHdr *p){
373 static int cnt = 0;
drh3aac2dd2004-04-26 14:10:20 +0000374 if( !pager3_refinfo_enable ) return;
drhfe63d1c2004-09-08 20:13:04 +0000375 sqlite3DebugPrintf(
376 "REFCNT: %4d addr=%p nRef=%d\n",
377 p->pgno, PGHDR_TO_DATA(p), p->nRef
drhdd793422001-06-28 01:54:48 +0000378 );
379 cnt++; /* Something to set a breakpoint on */
380 }
381# define REFINFO(X) pager_refinfo(X)
382#else
383# define REFINFO(X)
384#endif
385
386/*
drh34e79ce2004-02-08 06:05:46 +0000387** Read a 32-bit integer from the given file descriptor. Store the integer
388** that is read in *pRes. Return SQLITE_OK if everything worked, or an
389** error code is something goes wrong.
drh726de592004-06-10 23:35:50 +0000390**
391** All values are stored on disk as big-endian.
drh94f33312002-08-12 12:29:56 +0000392*/
drhae2b40c2004-06-09 19:03:54 +0000393static int read32bits(OsFile *fd, u32 *pRes){
drh94f33312002-08-12 12:29:56 +0000394 u32 res;
395 int rc;
danielk19774adee202004-05-08 08:23:19 +0000396 rc = sqlite3OsRead(fd, &res, sizeof(res));
drhae2b40c2004-06-09 19:03:54 +0000397 if( rc==SQLITE_OK ){
drh94f33312002-08-12 12:29:56 +0000398 unsigned char ac[4];
399 memcpy(ac, &res, 4);
400 res = (ac[0]<<24) | (ac[1]<<16) | (ac[2]<<8) | ac[3];
401 }
402 *pRes = res;
403 return rc;
404}
405
406/*
drh34e79ce2004-02-08 06:05:46 +0000407** Write a 32-bit integer into the given file descriptor. Return SQLITE_OK
408** on success or an error code is something goes wrong.
drh94f33312002-08-12 12:29:56 +0000409*/
410static int write32bits(OsFile *fd, u32 val){
411 unsigned char ac[4];
drh94f33312002-08-12 12:29:56 +0000412 ac[0] = (val>>24) & 0xff;
413 ac[1] = (val>>16) & 0xff;
414 ac[2] = (val>>8) & 0xff;
415 ac[3] = val & 0xff;
danielk19774adee202004-05-08 08:23:19 +0000416 return sqlite3OsWrite(fd, ac, 4);
drh94f33312002-08-12 12:29:56 +0000417}
418
drh2554f8b2003-01-22 01:26:44 +0000419/*
danielk1977aa5ccdf2004-06-14 05:10:42 +0000420** Write the 32-bit integer 'val' into the page identified by page header
421** 'p' at offset 'offset'.
drh2554f8b2003-01-22 01:26:44 +0000422*/
drh968af522003-02-11 14:55:40 +0000423static void store32bits(u32 val, PgHdr *p, int offset){
drh2554f8b2003-01-22 01:26:44 +0000424 unsigned char *ac;
drhec1bd0b2003-08-26 11:41:27 +0000425 ac = &((unsigned char*)PGHDR_TO_DATA(p))[offset];
drhae2b40c2004-06-09 19:03:54 +0000426 ac[0] = (val>>24) & 0xff;
427 ac[1] = (val>>16) & 0xff;
428 ac[2] = (val>>8) & 0xff;
429 ac[3] = val & 0xff;
drh2554f8b2003-01-22 01:26:44 +0000430}
431
danielk1977aa5ccdf2004-06-14 05:10:42 +0000432/*
433** Read a 32-bit integer at offset 'offset' from the page identified by
434** page header 'p'.
435*/
436static u32 retrieve32bits(PgHdr *p, int offset){
437 unsigned char *ac;
438 ac = &((unsigned char*)PGHDR_TO_DATA(p))[offset];
439 return (ac[0]<<24) | (ac[1]<<16) | (ac[2]<<8) | ac[3];
440}
441
drh94f33312002-08-12 12:29:56 +0000442
443/*
drhd9b02572001-04-15 00:37:09 +0000444** Convert the bits in the pPager->errMask into an approprate
445** return code.
446*/
447static int pager_errcode(Pager *pPager){
448 int rc = SQLITE_OK;
449 if( pPager->errMask & PAGER_ERR_LOCK ) rc = SQLITE_PROTOCOL;
drh81a20f22001-10-12 17:30:04 +0000450 if( pPager->errMask & PAGER_ERR_DISK ) rc = SQLITE_IOERR;
drhd9b02572001-04-15 00:37:09 +0000451 if( pPager->errMask & PAGER_ERR_FULL ) rc = SQLITE_FULL;
452 if( pPager->errMask & PAGER_ERR_MEM ) rc = SQLITE_NOMEM;
453 if( pPager->errMask & PAGER_ERR_CORRUPT ) rc = SQLITE_CORRUPT;
454 return rc;
drhed7c8552001-04-11 14:29:21 +0000455}
456
danielk19773c407372005-02-15 02:54:14 +0000457#ifdef SQLITE_CHECK_PAGES
458/*
459** Return a 32-bit hash of the page data for pPage.
460*/
461static u32 pager_pagehash(PgHdr *pPage){
462 u32 hash = 0;
463 int i;
464 unsigned char *pData = (unsigned char *)PGHDR_TO_DATA(pPage);
465 for(i=0; i<pPage->pPager->pageSize; i++){
466 hash = (hash+i)^pData[i];
467 }
468 return hash;
469}
470
471/*
472** The CHECK_PAGE macro takes a PgHdr* as an argument. If SQLITE_CHECK_PAGES
473** is defined, and NDEBUG is not defined, an assert() statement checks
474** that the page is either dirty or still matches the calculated page-hash.
475*/
476#define CHECK_PAGE(x) checkPage(x)
477static void checkPage(PgHdr *pPg){
478 Pager *pPager = pPg->pPager;
479 assert( !pPg->pageHash || pPager->errMask || MEMDB || pPg->dirty ||
480 pPg->pageHash==pager_pagehash(pPg) );
481}
482
483#else
484#define CHECK_PAGE(x)
485#endif
486
drhed7c8552001-04-11 14:29:21 +0000487/*
danielk197776572402004-06-25 02:38:54 +0000488** When this is called the journal file for pager pPager must be open.
489** The master journal file name is read from the end of the file and
490** written into memory obtained from sqliteMalloc(). *pzMaster is
491** set to point at the memory and SQLITE_OK returned. The caller must
492** sqliteFree() *pzMaster.
493**
494** If no master journal file name is present *pzMaster is set to 0 and
495** SQLITE_OK returned.
496*/
497static int readMasterJournal(OsFile *pJrnl, char **pzMaster){
498 int rc;
499 u32 len;
drheb206252004-10-01 02:00:31 +0000500 i64 szJ;
danielk1977c3e8f5e2004-06-28 01:16:46 +0000501 u32 cksum;
danielk1977cafadba2004-06-25 11:11:54 +0000502 int i;
danielk197776572402004-06-25 02:38:54 +0000503 unsigned char aMagic[8]; /* A buffer to hold the magic header */
504
505 *pzMaster = 0;
506
507 rc = sqlite3OsFileSize(pJrnl, &szJ);
danielk1977cafadba2004-06-25 11:11:54 +0000508 if( rc!=SQLITE_OK || szJ<16 ) return rc;
danielk197776572402004-06-25 02:38:54 +0000509
danielk1977cafadba2004-06-25 11:11:54 +0000510 rc = sqlite3OsSeek(pJrnl, szJ-16);
danielk197776572402004-06-25 02:38:54 +0000511 if( rc!=SQLITE_OK ) return rc;
512
513 rc = read32bits(pJrnl, &len);
514 if( rc!=SQLITE_OK ) return rc;
515
danielk1977cafadba2004-06-25 11:11:54 +0000516 rc = read32bits(pJrnl, &cksum);
517 if( rc!=SQLITE_OK ) return rc;
518
danielk197776572402004-06-25 02:38:54 +0000519 rc = sqlite3OsRead(pJrnl, aMagic, 8);
520 if( rc!=SQLITE_OK || memcmp(aMagic, aJournalMagic, 8) ) return rc;
521
danielk19778191bff2004-06-28 04:52:30 +0000522 rc = sqlite3OsSeek(pJrnl, szJ-16-len);
danielk197776572402004-06-25 02:38:54 +0000523 if( rc!=SQLITE_OK ) return rc;
524
danielk19778191bff2004-06-28 04:52:30 +0000525 *pzMaster = (char *)sqliteMalloc(len+1);
danielk197776572402004-06-25 02:38:54 +0000526 if( !*pzMaster ){
527 return SQLITE_NOMEM;
528 }
529 rc = sqlite3OsRead(pJrnl, *pzMaster, len);
530 if( rc!=SQLITE_OK ){
531 sqliteFree(*pzMaster);
532 *pzMaster = 0;
533 return rc;
534 }
danielk1977cafadba2004-06-25 11:11:54 +0000535
536 /* See if the checksum matches the master journal name */
537 for(i=0; i<len; i++){
danielk19778191bff2004-06-28 04:52:30 +0000538 cksum -= (*pzMaster)[i];
danielk1977cafadba2004-06-25 11:11:54 +0000539 }
danielk19778191bff2004-06-28 04:52:30 +0000540 if( cksum ){
541 /* If the checksum doesn't add up, then one or more of the disk sectors
542 ** containing the master journal filename is corrupted. This means
543 ** definitely roll back, so just return SQLITE_OK and report a (nul)
544 ** master-journal filename.
545 */
danielk1977cafadba2004-06-25 11:11:54 +0000546 sqliteFree(*pzMaster);
547 *pzMaster = 0;
danielk1977aca790a2005-01-13 11:07:52 +0000548 }else{
549 (*pzMaster)[len] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000550 }
danielk197776572402004-06-25 02:38:54 +0000551
552 return SQLITE_OK;
553}
554
555/*
556** Seek the journal file descriptor to the next sector boundary where a
557** journal header may be read or written. Pager.journalOff is updated with
558** the new seek offset.
559**
560** i.e for a sector size of 512:
561**
562** Input Offset Output Offset
563** ---------------------------------------
564** 0 0
565** 512 512
566** 100 512
567** 2000 2048
568**
569*/
570static int seekJournalHdr(Pager *pPager){
drheb206252004-10-01 02:00:31 +0000571 i64 offset = 0;
572 i64 c = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000573 if( c ){
574 offset = ((c-1)/JOURNAL_HDR_SZ(pPager) + 1) * JOURNAL_HDR_SZ(pPager);
575 }
576 assert( offset%JOURNAL_HDR_SZ(pPager)==0 );
577 assert( offset>=c );
578 assert( (offset-c)<JOURNAL_HDR_SZ(pPager) );
579 pPager->journalOff = offset;
580 return sqlite3OsSeek(&pPager->jfd, pPager->journalOff);
581}
582
583/*
584** The journal file must be open when this routine is called. A journal
585** header (JOURNAL_HDR_SZ bytes) is written into the journal file at the
586** current location.
587**
588** The format for the journal header is as follows:
589** - 8 bytes: Magic identifying journal format.
590** - 4 bytes: Number of records in journal, or -1 no-sync mode is on.
591** - 4 bytes: Random number used for page hash.
592** - 4 bytes: Initial database page count.
593** - 4 bytes: Sector size used by the process that wrote this journal.
594**
danielk1977f42f25c2004-06-25 07:21:28 +0000595** Followed by (JOURNAL_HDR_SZ - 24) bytes of unused space.
danielk197776572402004-06-25 02:38:54 +0000596*/
597static int writeJournalHdr(Pager *pPager){
598
599 int rc = seekJournalHdr(pPager);
600 if( rc ) return rc;
601
602 pPager->journalHdr = pPager->journalOff;
603 if( pPager->stmtHdrOff==0 ){
604 pPager->stmtHdrOff = pPager->journalHdr;
605 }
606 pPager->journalOff += JOURNAL_HDR_SZ(pPager);
607
608 /* FIX ME:
609 **
610 ** Possibly for a pager not in no-sync mode, the journal magic should not
611 ** be written until nRec is filled in as part of next syncJournal().
612 **
613 ** Actually maybe the whole journal header should be delayed until that
614 ** point. Think about this.
615 */
616 rc = sqlite3OsWrite(&pPager->jfd, aJournalMagic, sizeof(aJournalMagic));
617
618 if( rc==SQLITE_OK ){
619 /* The nRec Field. 0xFFFFFFFF for no-sync journals. */
620 rc = write32bits(&pPager->jfd, pPager->noSync ? 0xffffffff : 0);
621 }
622 if( rc==SQLITE_OK ){
623 /* The random check-hash initialiser */
624 sqlite3Randomness(sizeof(pPager->cksumInit), &pPager->cksumInit);
625 rc = write32bits(&pPager->jfd, pPager->cksumInit);
626 }
627 if( rc==SQLITE_OK ){
628 /* The initial database size */
629 rc = write32bits(&pPager->jfd, pPager->dbSize);
630 }
631 if( rc==SQLITE_OK ){
632 /* The assumed sector size for this process */
633 rc = write32bits(&pPager->jfd, pPager->sectorSize);
634 }
635
636 /* The journal header has been written successfully. Seek the journal
637 ** file descriptor to the end of the journal header sector.
638 */
639 if( rc==SQLITE_OK ){
640 sqlite3OsSeek(&pPager->jfd, pPager->journalOff-1);
641 rc = sqlite3OsWrite(&pPager->jfd, "\000", 1);
642 }
643 return rc;
644}
645
646/*
647** The journal file must be open when this is called. A journal header file
648** (JOURNAL_HDR_SZ bytes) is read from the current location in the journal
649** file. See comments above function writeJournalHdr() for a description of
650** the journal header format.
651**
652** If the header is read successfully, *nRec is set to the number of
653** page records following this header and *dbSize is set to the size of the
654** database before the transaction began, in pages. Also, pPager->cksumInit
655** is set to the value read from the journal header. SQLITE_OK is returned
656** in this case.
657**
658** If the journal header file appears to be corrupted, SQLITE_DONE is
659** returned and *nRec and *dbSize are not set. If JOURNAL_HDR_SZ bytes
660** cannot be read from the journal file an error code is returned.
661*/
662static int readJournalHdr(
663 Pager *pPager,
drheb206252004-10-01 02:00:31 +0000664 i64 journalSize,
danielk197776572402004-06-25 02:38:54 +0000665 u32 *pNRec,
666 u32 *pDbSize
667){
668 int rc;
669 unsigned char aMagic[8]; /* A buffer to hold the magic header */
670
671 rc = seekJournalHdr(pPager);
672 if( rc ) return rc;
673
674 if( pPager->journalOff+JOURNAL_HDR_SZ(pPager) > journalSize ){
675 return SQLITE_DONE;
676 }
677
678 rc = sqlite3OsRead(&pPager->jfd, aMagic, sizeof(aMagic));
679 if( rc ) return rc;
680
681 if( memcmp(aMagic, aJournalMagic, sizeof(aMagic))!=0 ){
682 return SQLITE_DONE;
683 }
684
685 rc = read32bits(&pPager->jfd, pNRec);
686 if( rc ) return rc;
687
688 rc = read32bits(&pPager->jfd, &pPager->cksumInit);
689 if( rc ) return rc;
690
691 rc = read32bits(&pPager->jfd, pDbSize);
692 if( rc ) return rc;
693
694 /* Update the assumed sector-size to match the value used by
695 ** the process that created this journal. If this journal was
696 ** created by a process other than this one, then this routine
697 ** is being called from within pager_playback(). The local value
698 ** of Pager.sectorSize is restored at the end of that routine.
699 */
danielk1977c3e8f5e2004-06-28 01:16:46 +0000700 rc = read32bits(&pPager->jfd, (u32 *)&pPager->sectorSize);
danielk197776572402004-06-25 02:38:54 +0000701 if( rc ) return rc;
702
703 pPager->journalOff += JOURNAL_HDR_SZ(pPager);
704 rc = sqlite3OsSeek(&pPager->jfd, pPager->journalOff);
705 return rc;
706}
707
708
709/*
710** Write the supplied master journal name into the journal file for pager
danielk1977cafadba2004-06-25 11:11:54 +0000711** pPager at the current location. The master journal name must be the last
712** thing written to a journal file. If the pager is in full-sync mode, the
713** journal file descriptor is advanced to the next sector boundary before
714** anything is written. The format is:
715**
716** + 4 bytes: PAGER_MJ_PGNO.
717** + N bytes: length of master journal name.
718** + 4 bytes: N
719** + 4 bytes: Master journal name checksum.
720** + 8 bytes: aJournalMagic[].
721**
722** The master journal page checksum is the sum of the bytes in the master
723** journal name.
danielk197776572402004-06-25 02:38:54 +0000724*/
725static int writeMasterJournal(Pager *pPager, const char *zMaster){
726 int rc;
727 int len;
danielk1977cafadba2004-06-25 11:11:54 +0000728 int i;
danielk1977c3e8f5e2004-06-28 01:16:46 +0000729 u32 cksum = 0;
danielk197776572402004-06-25 02:38:54 +0000730
731 if( !zMaster || pPager->setMaster) return SQLITE_OK;
732 pPager->setMaster = 1;
733
734 len = strlen(zMaster);
danielk1977cafadba2004-06-25 11:11:54 +0000735 for(i=0; i<len; i++){
736 cksum += zMaster[i];
737 }
danielk197776572402004-06-25 02:38:54 +0000738
739 /* If in full-sync mode, advance to the next disk sector before writing
740 ** the master journal name. This is in case the previous page written to
741 ** the journal has already been synced.
742 */
743 if( pPager->fullSync ){
744 rc = seekJournalHdr(pPager);
745 if( rc!=SQLITE_OK ) return rc;
746 }
danielk1977cafadba2004-06-25 11:11:54 +0000747 pPager->journalOff += (len+20);
danielk197776572402004-06-25 02:38:54 +0000748
749 rc = write32bits(&pPager->jfd, PAGER_MJ_PGNO(pPager));
750 if( rc!=SQLITE_OK ) return rc;
751
752 rc = sqlite3OsWrite(&pPager->jfd, zMaster, len);
753 if( rc!=SQLITE_OK ) return rc;
754
755 rc = write32bits(&pPager->jfd, len);
756 if( rc!=SQLITE_OK ) return rc;
757
danielk1977cafadba2004-06-25 11:11:54 +0000758 rc = write32bits(&pPager->jfd, cksum);
759 if( rc!=SQLITE_OK ) return rc;
760
danielk197776572402004-06-25 02:38:54 +0000761 rc = sqlite3OsWrite(&pPager->jfd, aJournalMagic, sizeof(aJournalMagic));
drhfdb38062004-08-21 19:20:42 +0000762 pPager->needSync = 1;
danielk197776572402004-06-25 02:38:54 +0000763 return rc;
764}
765
766/*
drh03eb96a2002-11-10 23:32:56 +0000767** Add or remove a page from the list of all pages that are in the
drhac69b052004-05-12 13:30:07 +0000768** statement journal.
drh03eb96a2002-11-10 23:32:56 +0000769**
770** The Pager keeps a separate list of pages that are currently in
drhac69b052004-05-12 13:30:07 +0000771** the statement journal. This helps the sqlite3pager_stmt_commit()
drh03eb96a2002-11-10 23:32:56 +0000772** routine run MUCH faster for the common case where there are many
drhac69b052004-05-12 13:30:07 +0000773** pages in memory but only a few are in the statement journal.
drh03eb96a2002-11-10 23:32:56 +0000774*/
drh3aac2dd2004-04-26 14:10:20 +0000775static void page_add_to_stmt_list(PgHdr *pPg){
drh03eb96a2002-11-10 23:32:56 +0000776 Pager *pPager = pPg->pPager;
drhac69b052004-05-12 13:30:07 +0000777 if( pPg->inStmt ) return;
778 assert( pPg->pPrevStmt==0 && pPg->pNextStmt==0 );
779 pPg->pPrevStmt = 0;
780 if( pPager->pStmt ){
781 pPager->pStmt->pPrevStmt = pPg;
drh03eb96a2002-11-10 23:32:56 +0000782 }
drhac69b052004-05-12 13:30:07 +0000783 pPg->pNextStmt = pPager->pStmt;
784 pPager->pStmt = pPg;
785 pPg->inStmt = 1;
drh03eb96a2002-11-10 23:32:56 +0000786}
drh3aac2dd2004-04-26 14:10:20 +0000787static void page_remove_from_stmt_list(PgHdr *pPg){
drhac69b052004-05-12 13:30:07 +0000788 if( !pPg->inStmt ) return;
789 if( pPg->pPrevStmt ){
790 assert( pPg->pPrevStmt->pNextStmt==pPg );
791 pPg->pPrevStmt->pNextStmt = pPg->pNextStmt;
drh03eb96a2002-11-10 23:32:56 +0000792 }else{
drhac69b052004-05-12 13:30:07 +0000793 assert( pPg->pPager->pStmt==pPg );
794 pPg->pPager->pStmt = pPg->pNextStmt;
drh03eb96a2002-11-10 23:32:56 +0000795 }
drhac69b052004-05-12 13:30:07 +0000796 if( pPg->pNextStmt ){
797 assert( pPg->pNextStmt->pPrevStmt==pPg );
798 pPg->pNextStmt->pPrevStmt = pPg->pPrevStmt;
drh03eb96a2002-11-10 23:32:56 +0000799 }
drhac69b052004-05-12 13:30:07 +0000800 pPg->pNextStmt = 0;
801 pPg->pPrevStmt = 0;
802 pPg->inStmt = 0;
drh03eb96a2002-11-10 23:32:56 +0000803}
804
805/*
drhed7c8552001-04-11 14:29:21 +0000806** Find a page in the hash table given its page number. Return
807** a pointer to the page or NULL if not found.
808*/
drhd9b02572001-04-15 00:37:09 +0000809static PgHdr *pager_lookup(Pager *pPager, Pgno pgno){
drh836faa42003-01-11 13:30:57 +0000810 PgHdr *p = pPager->aHash[pager_hash(pgno)];
drhed7c8552001-04-11 14:29:21 +0000811 while( p && p->pgno!=pgno ){
812 p = p->pNextHash;
813 }
814 return p;
815}
816
817/*
818** Unlock the database and clear the in-memory cache. This routine
819** sets the state of the pager back to what it was when it was first
820** opened. Any outstanding pages are invalidated and subsequent attempts
821** to access those pages will likely result in a coredump.
822*/
drhd9b02572001-04-15 00:37:09 +0000823static void pager_reset(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +0000824 PgHdr *pPg, *pNext;
drhd9b02572001-04-15 00:37:09 +0000825 for(pPg=pPager->pAll; pPg; pPg=pNext){
826 pNext = pPg->pNextAll;
827 sqliteFree(pPg);
drhed7c8552001-04-11 14:29:21 +0000828 }
829 pPager->pFirst = 0;
drh341eae82003-01-21 02:39:36 +0000830 pPager->pFirstSynced = 0;
drhd9b02572001-04-15 00:37:09 +0000831 pPager->pLast = 0;
832 pPager->pAll = 0;
drhed7c8552001-04-11 14:29:21 +0000833 memset(pPager->aHash, 0, sizeof(pPager->aHash));
834 pPager->nPage = 0;
drha6abd042004-06-09 17:37:22 +0000835 if( pPager->state>=PAGER_RESERVED ){
drh3aac2dd2004-04-26 14:10:20 +0000836 sqlite3pager_rollback(pPager);
drhed7c8552001-04-11 14:29:21 +0000837 }
drha6abd042004-06-09 17:37:22 +0000838 sqlite3OsUnlock(&pPager->fd, NO_LOCK);
839 pPager->state = PAGER_UNLOCK;
drhd9b02572001-04-15 00:37:09 +0000840 pPager->dbSize = -1;
drhed7c8552001-04-11 14:29:21 +0000841 pPager->nRef = 0;
drh8cfbf082001-09-19 13:22:39 +0000842 assert( pPager->journalOpen==0 );
drhed7c8552001-04-11 14:29:21 +0000843}
844
845/*
846** When this routine is called, the pager has the journal file open and
drha6abd042004-06-09 17:37:22 +0000847** a RESERVED or EXCLUSIVE lock on the database. This routine releases
848** the database lock and acquires a SHARED lock in its place. The journal
849** file is deleted and closed.
drh50457892003-09-06 01:10:47 +0000850**
851** TODO: Consider keeping the journal file open for temporary databases.
852** This might give a performance improvement on windows where opening
853** a file is an expensive operation.
drhed7c8552001-04-11 14:29:21 +0000854*/
drhd9b02572001-04-15 00:37:09 +0000855static int pager_unwritelock(Pager *pPager){
drhd9b02572001-04-15 00:37:09 +0000856 PgHdr *pPg;
drh9c105bb2004-10-02 20:38:28 +0000857 int rc;
drhb7f91642004-10-31 02:22:47 +0000858 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +0000859 if( pPager->state<PAGER_RESERVED ){
860 return SQLITE_OK;
861 }
drh3aac2dd2004-04-26 14:10:20 +0000862 sqlite3pager_stmt_commit(pPager);
drhac69b052004-05-12 13:30:07 +0000863 if( pPager->stmtOpen ){
864 sqlite3OsClose(&pPager->stfd);
865 pPager->stmtOpen = 0;
drh0f892532002-05-30 12:27:03 +0000866 }
drhda47d772002-12-02 04:25:19 +0000867 if( pPager->journalOpen ){
danielk19774adee202004-05-08 08:23:19 +0000868 sqlite3OsClose(&pPager->jfd);
drhda47d772002-12-02 04:25:19 +0000869 pPager->journalOpen = 0;
danielk19774adee202004-05-08 08:23:19 +0000870 sqlite3OsDelete(pPager->zJournal);
drhda47d772002-12-02 04:25:19 +0000871 sqliteFree( pPager->aInJournal );
872 pPager->aInJournal = 0;
873 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
874 pPg->inJournal = 0;
875 pPg->dirty = 0;
drhdb48ee02003-01-16 13:42:43 +0000876 pPg->needSync = 0;
danielk19773c407372005-02-15 02:54:14 +0000877#ifdef SQLITE_CHECK_PAGES
878 pPg->pageHash = pager_pagehash(pPg);
879#endif
drhda47d772002-12-02 04:25:19 +0000880 }
danielk1977ef317ab2004-06-23 10:43:10 +0000881 pPager->dirtyCache = 0;
danielk1977ef317ab2004-06-23 10:43:10 +0000882 pPager->nRec = 0;
drhda47d772002-12-02 04:25:19 +0000883 }else{
drha6abd042004-06-09 17:37:22 +0000884 assert( pPager->dirtyCache==0 || pPager->useJournal==0 );
drhd9b02572001-04-15 00:37:09 +0000885 }
drh9c105bb2004-10-02 20:38:28 +0000886 rc = sqlite3OsUnlock(&pPager->fd, SHARED_LOCK);
drha6abd042004-06-09 17:37:22 +0000887 pPager->state = PAGER_SHARED;
danielk1977ef317ab2004-06-23 10:43:10 +0000888 pPager->origDbSize = 0;
danielk197776572402004-06-25 02:38:54 +0000889 pPager->setMaster = 0;
drh9c105bb2004-10-02 20:38:28 +0000890 return rc;
drhed7c8552001-04-11 14:29:21 +0000891}
892
drhed7c8552001-04-11 14:29:21 +0000893/*
drh968af522003-02-11 14:55:40 +0000894** Compute and return a checksum for the page of data.
drh34e79ce2004-02-08 06:05:46 +0000895**
896** This is not a real checksum. It is really just the sum of the
drh726de592004-06-10 23:35:50 +0000897** random initial value and the page number. We experimented with
898** a checksum of the entire data, but that was found to be too slow.
899**
900** Note that the page number is stored at the beginning of data and
901** the checksum is stored at the end. This is important. If journal
902** corruption occurs due to a power failure, the most likely scenario
903** is that one end or the other of the record will be changed. It is
904** much less likely that the two ends of the journal record will be
905** correct and the middle be corrupt. Thus, this "checksum" scheme,
906** though fast and simple, catches the mostly likely kind of corruption.
907**
908** FIX ME: Consider adding every 200th (or so) byte of the data to the
909** checksum. That way if a single page spans 3 or more disk sectors and
910** only the middle sector is corrupt, we will still have a reasonable
911** chance of failing the checksum and thus detecting the problem.
drh968af522003-02-11 14:55:40 +0000912*/
913static u32 pager_cksum(Pager *pPager, Pgno pgno, const char *aData){
danielk1977ef317ab2004-06-23 10:43:10 +0000914 u32 cksum = pPager->cksumInit;
915 int i = pPager->pageSize-200;
916 while( i>0 ){
917 cksum += aData[i];
918 i -= 200;
919 }
drh968af522003-02-11 14:55:40 +0000920 return cksum;
921}
922
923/*
drhfa86c412002-02-02 15:01:15 +0000924** Read a single page from the journal file opened on file descriptor
925** jfd. Playback this one page.
drh968af522003-02-11 14:55:40 +0000926**
drh726de592004-06-10 23:35:50 +0000927** If useCksum==0 it means this journal does not use checksums. Checksums
928** are not used in statement journals because statement journals do not
929** need to survive power failures.
drhfa86c412002-02-02 15:01:15 +0000930*/
drhae2b40c2004-06-09 19:03:54 +0000931static int pager_playback_one_page(Pager *pPager, OsFile *jfd, int useCksum){
drhfa86c412002-02-02 15:01:15 +0000932 int rc;
drhae2b40c2004-06-09 19:03:54 +0000933 PgHdr *pPg; /* An existing page in the cache */
934 Pgno pgno; /* The page number of a page in journal */
935 u32 cksum; /* Checksum used for sanity checking */
drh90f5ecb2004-07-22 01:19:35 +0000936 u8 aData[SQLITE_MAX_PAGE_SIZE]; /* Temp storage for a page */
drhfa86c412002-02-02 15:01:15 +0000937
drhae2b40c2004-06-09 19:03:54 +0000938 rc = read32bits(jfd, &pgno);
drh99ee3602003-02-16 19:13:36 +0000939 if( rc!=SQLITE_OK ) return rc;
drhae2b40c2004-06-09 19:03:54 +0000940 rc = sqlite3OsRead(jfd, &aData, pPager->pageSize);
drh99ee3602003-02-16 19:13:36 +0000941 if( rc!=SQLITE_OK ) return rc;
danielk197776572402004-06-25 02:38:54 +0000942 pPager->journalOff += pPager->pageSize + 4;
drhfa86c412002-02-02 15:01:15 +0000943
drh968af522003-02-11 14:55:40 +0000944 /* Sanity checking on the page. This is more important that I originally
945 ** thought. If a power failure occurs while the journal is being written,
946 ** it could cause invalid data to be written into the journal. We need to
947 ** detect this invalid data (with high probability) and ignore it.
948 */
danielk197775edc162004-06-26 01:48:18 +0000949 if( pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh968af522003-02-11 14:55:40 +0000950 return SQLITE_DONE;
951 }
drhae2b40c2004-06-09 19:03:54 +0000952 if( pgno>(unsigned)pPager->dbSize ){
drh968af522003-02-11 14:55:40 +0000953 return SQLITE_OK;
954 }
drhae2b40c2004-06-09 19:03:54 +0000955 if( useCksum ){
956 rc = read32bits(jfd, &cksum);
drh99ee3602003-02-16 19:13:36 +0000957 if( rc ) return rc;
danielk197776572402004-06-25 02:38:54 +0000958 pPager->journalOff += 4;
drhae2b40c2004-06-09 19:03:54 +0000959 if( pager_cksum(pPager, pgno, aData)!=cksum ){
drh968af522003-02-11 14:55:40 +0000960 return SQLITE_DONE;
961 }
962 }
drhfa86c412002-02-02 15:01:15 +0000963
danielk1977aa5ccdf2004-06-14 05:10:42 +0000964 assert( pPager->state==PAGER_RESERVED || pPager->state>=PAGER_EXCLUSIVE );
danielk1977a3f3a5f2004-06-10 04:32:16 +0000965
966 /* If the pager is in RESERVED state, then there must be a copy of this
967 ** page in the pager cache. In this case just update the pager cache,
danielk19770de0bb32004-06-10 05:59:24 +0000968 ** not the database file. The page is left marked dirty in this case.
969 **
danielk1977a3f3a5f2004-06-10 04:32:16 +0000970 ** If in EXCLUSIVE state, then we update the pager cache if it exists
971 ** and the main file. The page is then marked not dirty.
drhfa86c412002-02-02 15:01:15 +0000972 */
drhae2b40c2004-06-09 19:03:54 +0000973 pPg = pager_lookup(pPager, pgno);
danielk1977aa5ccdf2004-06-14 05:10:42 +0000974 assert( pPager->state>=PAGER_EXCLUSIVE || pPg );
danielk1977ef73ee92004-11-06 12:26:07 +0000975 TRACE3("PLAYBACK %d page %d\n", PAGERID(pPager), pgno);
danielk1977aa5ccdf2004-06-14 05:10:42 +0000976 if( pPager->state>=PAGER_EXCLUSIVE ){
drheb206252004-10-01 02:00:31 +0000977 sqlite3OsSeek(&pPager->fd, (pgno-1)*(i64)pPager->pageSize);
drh90f5ecb2004-07-22 01:19:35 +0000978 rc = sqlite3OsWrite(&pPager->fd, aData, pPager->pageSize);
danielk1977a3f3a5f2004-06-10 04:32:16 +0000979 }
drhfa86c412002-02-02 15:01:15 +0000980 if( pPg ){
danielk197728129562005-01-11 10:25:06 +0000981 /* No page should ever be explicitly rolled back that is in use, except
982 ** for page 1 which is held in use in order to keep the lock on the
983 ** database active. However such a page may be rolled back as a result
984 ** of an internal error resulting in an automatic call to
985 ** sqlite3pager_rollback().
drhacf4ac92003-12-17 23:57:34 +0000986 */
drhb6f41482004-05-14 01:58:11 +0000987 void *pData;
danielk197728129562005-01-11 10:25:06 +0000988 /* assert( pPg->nRef==0 || pPg->pgno==1 ); */
drhb6f41482004-05-14 01:58:11 +0000989 pData = PGHDR_TO_DATA(pPg);
drhae2b40c2004-06-09 19:03:54 +0000990 memcpy(pData, aData, pPager->pageSize);
drh726de592004-06-10 23:35:50 +0000991 if( pPager->xDestructor ){ /*** FIX ME: Should this be xReinit? ***/
drhb6f41482004-05-14 01:58:11 +0000992 pPager->xDestructor(pData, pPager->pageSize);
drhde647132004-05-07 17:57:49 +0000993 }
danielk1977aa5ccdf2004-06-14 05:10:42 +0000994 if( pPager->state>=PAGER_EXCLUSIVE ){
danielk19770de0bb32004-06-10 05:59:24 +0000995 pPg->dirty = 0;
996 pPg->needSync = 0;
danielk19773c407372005-02-15 02:54:14 +0000997#ifdef SQLITE_CHECK_PAGES
998 pPg->pageHash = pager_pagehash(pPg);
999#endif
danielk19770de0bb32004-06-10 05:59:24 +00001000 }
drhb6f41482004-05-14 01:58:11 +00001001 CODEC(pPager, pData, pPg->pgno, 3);
drhfa86c412002-02-02 15:01:15 +00001002 }
1003 return rc;
1004}
1005
1006/*
danielk197713adf8a2004-06-03 16:08:41 +00001007** Parameter zMaster is the name of a master journal file. A single journal
1008** file that referred to the master journal file has just been rolled back.
1009** This routine checks if it is possible to delete the master journal file,
1010** and does so if it is.
drh726de592004-06-10 23:35:50 +00001011**
1012** The master journal file contains the names of all child journals.
1013** To tell if a master journal can be deleted, check to each of the
1014** children. If all children are either missing or do not refer to
1015** a different master journal, then this master journal can be deleted.
danielk197713adf8a2004-06-03 16:08:41 +00001016*/
1017static int pager_delmaster(const char *zMaster){
1018 int rc;
1019 int master_open = 0;
1020 OsFile master;
1021 char *zMasterJournal = 0; /* Contents of master journal file */
drheb206252004-10-01 02:00:31 +00001022 i64 nMasterJournal; /* Size of master journal file */
danielk197713adf8a2004-06-03 16:08:41 +00001023
1024 /* Open the master journal file exclusively in case some other process
1025 ** is running this routine also. Not that it makes too much difference.
1026 */
drhda71ce12004-06-21 18:14:45 +00001027 memset(&master, 0, sizeof(master));
danielk19778191bff2004-06-28 04:52:30 +00001028 rc = sqlite3OsOpenReadOnly(zMaster, &master);
danielk197713adf8a2004-06-03 16:08:41 +00001029 if( rc!=SQLITE_OK ) goto delmaster_out;
1030 master_open = 1;
danielk197713adf8a2004-06-03 16:08:41 +00001031 rc = sqlite3OsFileSize(&master, &nMasterJournal);
1032 if( rc!=SQLITE_OK ) goto delmaster_out;
1033
1034 if( nMasterJournal>0 ){
danielk19775865e3d2004-06-14 06:03:57 +00001035 char *zJournal;
danielk197776572402004-06-25 02:38:54 +00001036 char *zMasterPtr = 0;
danielk19775865e3d2004-06-14 06:03:57 +00001037
1038 /* Load the entire master journal file into space obtained from
1039 ** sqliteMalloc() and pointed to by zMasterJournal.
danielk19775865e3d2004-06-14 06:03:57 +00001040 */
danielk197776572402004-06-25 02:38:54 +00001041 zMasterJournal = (char *)sqliteMalloc(nMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001042 if( !zMasterJournal ){
1043 rc = SQLITE_NOMEM;
1044 goto delmaster_out;
1045 }
1046 rc = sqlite3OsRead(&master, zMasterJournal, nMasterJournal);
1047 if( rc!=SQLITE_OK ) goto delmaster_out;
1048
danielk19775865e3d2004-06-14 06:03:57 +00001049 zJournal = zMasterJournal;
1050 while( (zJournal-zMasterJournal)<nMasterJournal ){
danielk197713adf8a2004-06-03 16:08:41 +00001051 if( sqlite3OsFileExists(zJournal) ){
1052 /* One of the journals pointed to by the master journal exists.
1053 ** Open it and check if it points at the master journal. If
1054 ** so, return without deleting the master journal file.
1055 */
1056 OsFile journal;
drh3b7b78b2004-11-24 01:16:43 +00001057 int c;
danielk197713adf8a2004-06-03 16:08:41 +00001058
drhda71ce12004-06-21 18:14:45 +00001059 memset(&journal, 0, sizeof(journal));
danielk197713adf8a2004-06-03 16:08:41 +00001060 rc = sqlite3OsOpenReadOnly(zJournal, &journal);
1061 if( rc!=SQLITE_OK ){
danielk197713adf8a2004-06-03 16:08:41 +00001062 goto delmaster_out;
1063 }
danielk197713adf8a2004-06-03 16:08:41 +00001064
danielk197776572402004-06-25 02:38:54 +00001065 rc = readMasterJournal(&journal, &zMasterPtr);
1066 sqlite3OsClose(&journal);
danielk19779eed5052004-06-04 10:38:30 +00001067 if( rc!=SQLITE_OK ){
danielk19779eed5052004-06-04 10:38:30 +00001068 goto delmaster_out;
1069 }
danielk197776572402004-06-25 02:38:54 +00001070
drh3b7b78b2004-11-24 01:16:43 +00001071 c = zMasterPtr!=0 && strcmp(zMasterPtr, zMaster)==0;
1072 sqliteFree(zMasterPtr);
1073 if( c ){
danielk197776572402004-06-25 02:38:54 +00001074 /* We have a match. Do not delete the master journal file. */
1075 goto delmaster_out;
danielk197713adf8a2004-06-03 16:08:41 +00001076 }
1077 }
danielk19775865e3d2004-06-14 06:03:57 +00001078 zJournal += (strlen(zJournal)+1);
danielk197713adf8a2004-06-03 16:08:41 +00001079 }
1080 }
1081
1082 sqlite3OsDelete(zMaster);
1083
1084delmaster_out:
1085 if( zMasterJournal ){
1086 sqliteFree(zMasterJournal);
1087 }
1088 if( master_open ){
1089 sqlite3OsClose(&master);
1090 }
1091 return rc;
1092}
1093
1094/*
drha6abd042004-06-09 17:37:22 +00001095** Make every page in the cache agree with what is on disk. In other words,
1096** reread the disk to reset the state of the cache.
1097**
1098** This routine is called after a rollback in which some of the dirty cache
1099** pages had never been written out to disk. We need to roll back the
1100** cache content and the easiest way to do that is to reread the old content
1101** back from the disk.
1102*/
1103static int pager_reload_cache(Pager *pPager){
1104 PgHdr *pPg;
1105 int rc = SQLITE_OK;
1106 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
drh90f5ecb2004-07-22 01:19:35 +00001107 char zBuf[SQLITE_MAX_PAGE_SIZE];
drha6abd042004-06-09 17:37:22 +00001108 if( !pPg->dirty ) continue;
1109 if( (int)pPg->pgno <= pPager->origDbSize ){
drheb206252004-10-01 02:00:31 +00001110 sqlite3OsSeek(&pPager->fd, pPager->pageSize*(i64)(pPg->pgno-1));
drh90f5ecb2004-07-22 01:19:35 +00001111 rc = sqlite3OsRead(&pPager->fd, zBuf, pPager->pageSize);
danielk1977ef73ee92004-11-06 12:26:07 +00001112 TRACE3("REFETCH %d page %d\n", PAGERID(pPager), pPg->pgno);
drha6abd042004-06-09 17:37:22 +00001113 if( rc ) break;
drh25d65432004-07-22 15:02:25 +00001114 CODEC(pPager, zBuf, pPg->pgno, 2);
drha6abd042004-06-09 17:37:22 +00001115 }else{
drh90f5ecb2004-07-22 01:19:35 +00001116 memset(zBuf, 0, pPager->pageSize);
drha6abd042004-06-09 17:37:22 +00001117 }
drh90f5ecb2004-07-22 01:19:35 +00001118 if( pPg->nRef==0 || memcmp(zBuf, PGHDR_TO_DATA(pPg), pPager->pageSize) ){
1119 memcpy(PGHDR_TO_DATA(pPg), zBuf, pPager->pageSize);
drha6abd042004-06-09 17:37:22 +00001120 if( pPager->xReiniter ){
1121 pPager->xReiniter(PGHDR_TO_DATA(pPg), pPager->pageSize);
1122 }else{
drh90f5ecb2004-07-22 01:19:35 +00001123 memset(PGHDR_TO_EXTRA(pPg, pPager), 0, pPager->nExtra);
drha6abd042004-06-09 17:37:22 +00001124 }
1125 }
1126 pPg->needSync = 0;
1127 pPg->dirty = 0;
danielk19773c407372005-02-15 02:54:14 +00001128#ifdef SQLITE_CHECK_PAGES
1129 pPg->pageHash = pager_pagehash(pPg);
1130#endif
drha6abd042004-06-09 17:37:22 +00001131 }
1132 return rc;
1133}
1134
drha6abd042004-06-09 17:37:22 +00001135/*
drhcb4c40b2004-08-18 19:09:43 +00001136** Truncate the main file of the given pager to the number of pages
1137** indicated.
1138*/
1139static int pager_truncate(Pager *pPager, int nPage){
danielk197717221812005-02-15 03:38:05 +00001140 assert( pPager->state>=PAGER_EXCLUSIVE );
drheb206252004-10-01 02:00:31 +00001141 return sqlite3OsTruncate(&pPager->fd, pPager->pageSize*(i64)nPage);
drhcb4c40b2004-08-18 19:09:43 +00001142}
1143
1144/*
drhed7c8552001-04-11 14:29:21 +00001145** Playback the journal and thus restore the database file to
1146** the state it was in before we started making changes.
1147**
drh34e79ce2004-02-08 06:05:46 +00001148** The journal file format is as follows:
1149**
drhae2b40c2004-06-09 19:03:54 +00001150** (1) 8 byte prefix. A copy of aJournalMagic[].
1151** (2) 4 byte big-endian integer which is the number of valid page records
drh34e79ce2004-02-08 06:05:46 +00001152** in the journal. If this value is 0xffffffff, then compute the
drhae2b40c2004-06-09 19:03:54 +00001153** number of page records from the journal size.
1154** (3) 4 byte big-endian integer which is the initial value for the
1155** sanity checksum.
1156** (4) 4 byte integer which is the number of pages to truncate the
drh34e79ce2004-02-08 06:05:46 +00001157** database to during a rollback.
drhae2b40c2004-06-09 19:03:54 +00001158** (5) 4 byte integer which is the number of bytes in the master journal
1159** name. The value may be zero (indicate that there is no master
1160** journal.)
1161** (6) N bytes of the master journal name. The name will be nul-terminated
1162** and might be shorter than the value read from (5). If the first byte
1163** of the name is \000 then there is no master journal. The master
1164** journal name is stored in UTF-8.
1165** (7) Zero or more pages instances, each as follows:
drh34e79ce2004-02-08 06:05:46 +00001166** + 4 byte page number.
drhae2b40c2004-06-09 19:03:54 +00001167** + pPager->pageSize bytes of data.
1168** + 4 byte checksum
drh34e79ce2004-02-08 06:05:46 +00001169**
drhae2b40c2004-06-09 19:03:54 +00001170** When we speak of the journal header, we mean the first 6 items above.
1171** Each entry in the journal is an instance of the 7th item.
drh34e79ce2004-02-08 06:05:46 +00001172**
1173** Call the value from the second bullet "nRec". nRec is the number of
1174** valid page entries in the journal. In most cases, you can compute the
1175** value of nRec from the size of the journal file. But if a power
1176** failure occurred while the journal was being written, it could be the
1177** case that the size of the journal file had already been increased but
1178** the extra entries had not yet made it safely to disk. In such a case,
1179** the value of nRec computed from the file size would be too large. For
1180** that reason, we always use the nRec value in the header.
1181**
1182** If the nRec value is 0xffffffff it means that nRec should be computed
1183** from the file size. This value is used when the user selects the
1184** no-sync option for the journal. A power failure could lead to corruption
1185** in this case. But for things like temporary table (which will be
1186** deleted when the power is restored) we don't care.
1187**
drhd9b02572001-04-15 00:37:09 +00001188** If the file opened as the journal file is not a well-formed
danielk1977ece80f12004-06-23 01:05:26 +00001189** journal file then all pages up to the first corrupted page are rolled
1190** back (or no pages if the journal header is corrupted). The journal file
1191** is then deleted and SQLITE_OK returned, just as if no corruption had
1192** been encountered.
1193**
1194** If an I/O or malloc() error occurs, the journal-file is not deleted
1195** and an error code is returned.
drhed7c8552001-04-11 14:29:21 +00001196*/
danielk197776572402004-06-25 02:38:54 +00001197static int pager_playback(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001198 i64 szJ; /* Size of the journal file in bytes */
danielk1977c3e8f5e2004-06-28 01:16:46 +00001199 u32 nRec; /* Number of Records in the journal */
drhd9b02572001-04-15 00:37:09 +00001200 int i; /* Loop counter */
1201 Pgno mxPg = 0; /* Size of the original file in pages */
drhae2b40c2004-06-09 19:03:54 +00001202 int rc; /* Result code of a subroutine */
danielk197713adf8a2004-06-03 16:08:41 +00001203 char *zMaster = 0; /* Name of master journal file if any */
drhed7c8552001-04-11 14:29:21 +00001204
drhc3a64ba2001-11-22 00:01:27 +00001205 /* Figure out how many records are in the journal. Abort early if
1206 ** the journal is empty.
drhed7c8552001-04-11 14:29:21 +00001207 */
drh8cfbf082001-09-19 13:22:39 +00001208 assert( pPager->journalOpen );
danielk19774adee202004-05-08 08:23:19 +00001209 rc = sqlite3OsFileSize(&pPager->jfd, &szJ);
drhc3a64ba2001-11-22 00:01:27 +00001210 if( rc!=SQLITE_OK ){
1211 goto end_playback;
1212 }
drh240c5792004-02-08 00:40:52 +00001213
danielk197776572402004-06-25 02:38:54 +00001214 /* Read the master journal name from the journal, if it is present.
1215 ** If a master journal file name is specified, but the file is not
1216 ** present on disk, then the journal is not hot and does not need to be
1217 ** played back.
drh240c5792004-02-08 00:40:52 +00001218 */
danielk197776572402004-06-25 02:38:54 +00001219 rc = readMasterJournal(&pPager->jfd, &zMaster);
1220 assert( rc!=SQLITE_DONE );
1221 if( rc!=SQLITE_OK || (zMaster && !sqlite3OsFileExists(zMaster)) ){
1222 sqliteFree(zMaster);
1223 zMaster = 0;
1224 if( rc==SQLITE_DONE ) rc = SQLITE_OK;
drhc3a64ba2001-11-22 00:01:27 +00001225 goto end_playback;
1226 }
danielk197776572402004-06-25 02:38:54 +00001227 sqlite3OsSeek(&pPager->jfd, 0);
1228 pPager->journalOff = 0;
drhc3a64ba2001-11-22 00:01:27 +00001229
danielk197776572402004-06-25 02:38:54 +00001230 /* This loop terminates either when the readJournalHdr() call returns
1231 ** SQLITE_DONE or an IO error occurs. */
1232 while( 1 ){
drhae2b40c2004-06-09 19:03:54 +00001233
danielk197776572402004-06-25 02:38:54 +00001234 /* Read the next journal header from the journal file. If there are
1235 ** not enough bytes left in the journal file for a complete header, or
1236 ** it is corrupted, then a process must of failed while writing it.
1237 ** This indicates nothing more needs to be rolled back.
1238 */
1239 rc = readJournalHdr(pPager, szJ, &nRec, &mxPg);
1240 if( rc!=SQLITE_OK ){
drh968af522003-02-11 14:55:40 +00001241 if( rc==SQLITE_DONE ){
drh968af522003-02-11 14:55:40 +00001242 rc = SQLITE_OK;
1243 }
danielk197776572402004-06-25 02:38:54 +00001244 goto end_playback;
1245 }
1246
1247 /* If nRec is 0xffffffff, then this journal was created by a process
1248 ** working in no-sync mode. This means that the rest of the journal
1249 ** file consists of pages, there are no more journal headers. Compute
1250 ** the value of nRec based on this assumption.
1251 */
1252 if( nRec==0xffffffff ){
1253 assert( pPager->journalOff==JOURNAL_HDR_SZ(pPager) );
1254 nRec = (szJ - JOURNAL_HDR_SZ(pPager))/JOURNAL_PG_SZ(pPager);
1255 }
1256
1257 /* If this is the first header read from the journal, truncate the
1258 ** database file back to it's original size.
1259 */
danielk197717221812005-02-15 03:38:05 +00001260 if( pPager->state>=PAGER_EXCLUSIVE &&
1261 pPager->journalOff==JOURNAL_HDR_SZ(pPager) ){
danielk197776572402004-06-25 02:38:54 +00001262 assert( pPager->origDbSize==0 || pPager->origDbSize==mxPg );
drhcb4c40b2004-08-18 19:09:43 +00001263 rc = pager_truncate(pPager, mxPg);
danielk197776572402004-06-25 02:38:54 +00001264 if( rc!=SQLITE_OK ){
1265 goto end_playback;
1266 }
1267 pPager->dbSize = mxPg;
1268 }
1269
1270 /* rc = sqlite3OsSeek(&pPager->jfd, JOURNAL_HDR_SZ(pPager)); */
1271 if( rc!=SQLITE_OK ) goto end_playback;
1272
1273 /* Copy original pages out of the journal and back into the database file.
1274 */
1275 for(i=0; i<nRec; i++){
1276 rc = pager_playback_one_page(pPager, &pPager->jfd, 1);
1277 if( rc!=SQLITE_OK ){
1278 if( rc==SQLITE_DONE ){
1279 rc = SQLITE_OK;
1280 pPager->journalOff = szJ;
1281 break;
1282 }else{
1283 goto end_playback;
1284 }
1285 }
drh968af522003-02-11 14:55:40 +00001286 }
drhed7c8552001-04-11 14:29:21 +00001287 }
drh81a20f22001-10-12 17:30:04 +00001288
drh4a0681e2003-02-13 01:58:20 +00001289 /* Pages that have been written to the journal but never synced
1290 ** where not restored by the loop above. We have to restore those
drh240c5792004-02-08 00:40:52 +00001291 ** pages by reading them back from the original database.
drhdb48ee02003-01-16 13:42:43 +00001292 */
danielk197776572402004-06-25 02:38:54 +00001293 assert( rc==SQLITE_OK );
1294 pager_reload_cache(pPager);
drh4a0681e2003-02-13 01:58:20 +00001295
1296end_playback:
danielk19778191bff2004-06-28 04:52:30 +00001297 if( rc==SQLITE_OK ){
1298 rc = pager_unwritelock(pPager);
1299 }
danielk197713adf8a2004-06-03 16:08:41 +00001300 if( zMaster ){
1301 /* If there was a master journal and this routine will return true,
danielk197732554c12005-01-22 03:39:39 +00001302 ** see if it is possible to delete the master journal.
danielk197713adf8a2004-06-03 16:08:41 +00001303 */
1304 if( rc==SQLITE_OK ){
danielk197732554c12005-01-22 03:39:39 +00001305 rc = pager_delmaster(zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001306 }
1307 sqliteFree(zMaster);
1308 }
danielk197776572402004-06-25 02:38:54 +00001309
1310 /* The Pager.sectorSize variable may have been updated while rolling
1311 ** back a journal created by a process with a different PAGER_SECTOR_SIZE
1312 ** value. Reset it to the correct value for this process.
1313 */
1314 pPager->sectorSize = PAGER_SECTOR_SIZE;
drhd9b02572001-04-15 00:37:09 +00001315 return rc;
drhed7c8552001-04-11 14:29:21 +00001316}
1317
1318/*
drhac69b052004-05-12 13:30:07 +00001319** Playback the statement journal.
drhfa86c412002-02-02 15:01:15 +00001320**
1321** This is similar to playing back the transaction journal but with
1322** a few extra twists.
1323**
drh663fc632002-02-02 18:49:19 +00001324** (1) The number of pages in the database file at the start of
drhac69b052004-05-12 13:30:07 +00001325** the statement is stored in pPager->stmtSize, not in the
drh663fc632002-02-02 18:49:19 +00001326** journal file itself.
drhfa86c412002-02-02 15:01:15 +00001327**
drhac69b052004-05-12 13:30:07 +00001328** (2) In addition to playing back the statement journal, also
drhfa86c412002-02-02 15:01:15 +00001329** playback all pages of the transaction journal beginning
drhac69b052004-05-12 13:30:07 +00001330** at offset pPager->stmtJSize.
drhfa86c412002-02-02 15:01:15 +00001331*/
drh3aac2dd2004-04-26 14:10:20 +00001332static int pager_stmt_playback(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001333 i64 szJ; /* Size of the full journal */
1334 i64 hdrOff;
drh968af522003-02-11 14:55:40 +00001335 int nRec; /* Number of Records */
drhfa86c412002-02-02 15:01:15 +00001336 int i; /* Loop counter */
1337 int rc;
1338
danielk197776572402004-06-25 02:38:54 +00001339 szJ = pPager->journalOff;
1340#ifndef NDEBUG
1341 {
drheb206252004-10-01 02:00:31 +00001342 i64 os_szJ;
danielk197776572402004-06-25 02:38:54 +00001343 rc = sqlite3OsFileSize(&pPager->jfd, &os_szJ);
1344 if( rc!=SQLITE_OK ) return rc;
1345 assert( szJ==os_szJ );
1346 }
1347#endif
1348
1349 /* Set hdrOff to be the offset to the first journal header written
1350 ** this statement transaction, or the end of the file if no journal
1351 ** header was written.
1352 */
1353 hdrOff = pPager->stmtHdrOff;
1354 assert( pPager->fullSync || !hdrOff );
1355 if( !hdrOff ){
1356 hdrOff = szJ;
1357 }
1358
drhfa86c412002-02-02 15:01:15 +00001359 /* Truncate the database back to its original size.
1360 */
danielk197717221812005-02-15 03:38:05 +00001361 if( pPager->state>=PAGER_EXCLUSIVE ){
1362 rc = pager_truncate(pPager, pPager->stmtSize);
1363 }
drhac69b052004-05-12 13:30:07 +00001364 pPager->dbSize = pPager->stmtSize;
drhfa86c412002-02-02 15:01:15 +00001365
drhac69b052004-05-12 13:30:07 +00001366 /* Figure out how many records are in the statement journal.
drhfa86c412002-02-02 15:01:15 +00001367 */
drhac69b052004-05-12 13:30:07 +00001368 assert( pPager->stmtInUse && pPager->journalOpen );
1369 sqlite3OsSeek(&pPager->stfd, 0);
1370 nRec = pPager->stmtNRec;
drhfa86c412002-02-02 15:01:15 +00001371
drhac69b052004-05-12 13:30:07 +00001372 /* Copy original pages out of the statement journal and back into the
drhae2b40c2004-06-09 19:03:54 +00001373 ** database file. Note that the statement journal omits checksums from
1374 ** each record since power-failure recovery is not important to statement
1375 ** journals.
drhfa86c412002-02-02 15:01:15 +00001376 */
1377 for(i=nRec-1; i>=0; i--){
drhae2b40c2004-06-09 19:03:54 +00001378 rc = pager_playback_one_page(pPager, &pPager->stfd, 0);
drh968af522003-02-11 14:55:40 +00001379 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001380 if( rc!=SQLITE_OK ) goto end_stmt_playback;
drhfa86c412002-02-02 15:01:15 +00001381 }
1382
danielk197776572402004-06-25 02:38:54 +00001383 /* Now roll some pages back from the transaction journal. Pager.stmtJSize
1384 ** was the size of the journal file when this statement was started, so
1385 ** everything after that needs to be rolled back, either into the
1386 ** database, the memory cache, or both.
1387 **
1388 ** If it is not zero, then Pager.stmtHdrOff is the offset to the start
1389 ** of the first journal header written during this statement transaction.
drhfa86c412002-02-02 15:01:15 +00001390 */
drhac69b052004-05-12 13:30:07 +00001391 rc = sqlite3OsSeek(&pPager->jfd, pPager->stmtJSize);
drhfa86c412002-02-02 15:01:15 +00001392 if( rc!=SQLITE_OK ){
drh3aac2dd2004-04-26 14:10:20 +00001393 goto end_stmt_playback;
drhfa86c412002-02-02 15:01:15 +00001394 }
danielk197776572402004-06-25 02:38:54 +00001395 pPager->journalOff = pPager->stmtJSize;
danielk197775edc162004-06-26 01:48:18 +00001396 pPager->cksumInit = pPager->stmtCksum;
1397 assert( JOURNAL_HDR_SZ(pPager)<(pPager->pageSize+8) );
1398 while( pPager->journalOff <= (hdrOff-(pPager->pageSize+8)) ){
drhae2b40c2004-06-09 19:03:54 +00001399 rc = pager_playback_one_page(pPager, &pPager->jfd, 1);
danielk197776572402004-06-25 02:38:54 +00001400 assert( rc!=SQLITE_DONE );
1401 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1402 }
1403
1404 while( pPager->journalOff < szJ ){
1405 u32 nRec;
1406 u32 dummy;
1407 rc = readJournalHdr(pPager, szJ, &nRec, &dummy);
drh968af522003-02-11 14:55:40 +00001408 if( rc!=SQLITE_OK ){
1409 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001410 goto end_stmt_playback;
drh968af522003-02-11 14:55:40 +00001411 }
danielk197775edc162004-06-26 01:48:18 +00001412 if( nRec==0 ){
1413 nRec = (szJ - pPager->journalOff) / (pPager->pageSize+8);
1414 }
danielk197776572402004-06-25 02:38:54 +00001415 for(i=nRec-1; i>=0 && pPager->journalOff < szJ; i--){
1416 rc = pager_playback_one_page(pPager, &pPager->jfd, 1);
1417 assert( rc!=SQLITE_DONE );
1418 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1419 }
drhfa86c412002-02-02 15:01:15 +00001420 }
danielk197776572402004-06-25 02:38:54 +00001421
1422 pPager->journalOff = szJ;
drhfa86c412002-02-02 15:01:15 +00001423
drh3aac2dd2004-04-26 14:10:20 +00001424end_stmt_playback:
drhfa86c412002-02-02 15:01:15 +00001425 if( rc!=SQLITE_OK ){
drhfa86c412002-02-02 15:01:15 +00001426 pPager->errMask |= PAGER_ERR_CORRUPT;
drhee696e22004-08-30 16:52:17 +00001427 rc = SQLITE_CORRUPT; /* bkpt-CORRUPT */
danielk197775edc162004-06-26 01:48:18 +00001428 }else{
1429 pPager->journalOff = szJ;
1430 /* pager_reload_cache(pPager); */
drhfa86c412002-02-02 15:01:15 +00001431 }
1432 return rc;
1433}
1434
1435/*
drhf57b14a2001-09-14 18:54:08 +00001436** Change the maximum number of in-memory pages that are allowed.
drhcd61c282002-03-06 22:01:34 +00001437**
1438** The maximum number is the absolute value of the mxPage parameter.
1439** If mxPage is negative, the noSync flag is also set. noSync bypasses
danielk19774adee202004-05-08 08:23:19 +00001440** calls to sqlite3OsSync(). The pager runs much faster with noSync on,
drhcd61c282002-03-06 22:01:34 +00001441** but if the operating system crashes or there is an abrupt power
1442** failure, the database file might be left in an inconsistent and
1443** unrepairable state.
drhf57b14a2001-09-14 18:54:08 +00001444*/
drh3aac2dd2004-04-26 14:10:20 +00001445void sqlite3pager_set_cachesize(Pager *pPager, int mxPage){
drh603240c2002-03-05 01:11:12 +00001446 if( mxPage>=0 ){
drha1680452002-04-18 01:56:57 +00001447 pPager->noSync = pPager->tempFile;
danielk19771d850a72004-05-31 08:26:49 +00001448 if( pPager->noSync ) pPager->needSync = 0;
drh603240c2002-03-05 01:11:12 +00001449 }else{
1450 pPager->noSync = 1;
1451 mxPage = -mxPage;
1452 }
drhf57b14a2001-09-14 18:54:08 +00001453 if( mxPage>10 ){
1454 pPager->mxPage = mxPage;
danielk1977ef317ab2004-06-23 10:43:10 +00001455 }else{
1456 pPager->mxPage = 10;
drhf57b14a2001-09-14 18:54:08 +00001457 }
1458}
1459
1460/*
drh973b6e32003-02-12 14:09:42 +00001461** Adjust the robustness of the database to damage due to OS crashes
1462** or power failures by changing the number of syncs()s when writing
1463** the rollback journal. There are three levels:
1464**
danielk19774adee202004-05-08 08:23:19 +00001465** OFF sqlite3OsSync() is never called. This is the default
drh973b6e32003-02-12 14:09:42 +00001466** for temporary and transient files.
1467**
1468** NORMAL The journal is synced once before writes begin on the
1469** database. This is normally adequate protection, but
1470** it is theoretically possible, though very unlikely,
1471** that an inopertune power failure could leave the journal
1472** in a state which would cause damage to the database
1473** when it is rolled back.
1474**
1475** FULL The journal is synced twice before writes begin on the
drh34e79ce2004-02-08 06:05:46 +00001476** database (with some additional information - the nRec field
1477** of the journal header - being written in between the two
1478** syncs). If we assume that writing a
drh973b6e32003-02-12 14:09:42 +00001479** single disk sector is atomic, then this mode provides
1480** assurance that the journal will not be corrupted to the
1481** point of causing damage to the database during rollback.
1482**
1483** Numeric values associated with these states are OFF==1, NORMAL=2,
1484** and FULL=3.
1485*/
danielk197793758c82005-01-21 08:13:14 +00001486#ifndef SQLITE_OMIT_PAGER_PRAGMAS
drh3aac2dd2004-04-26 14:10:20 +00001487void sqlite3pager_set_safety_level(Pager *pPager, int level){
drh973b6e32003-02-12 14:09:42 +00001488 pPager->noSync = level==1 || pPager->tempFile;
1489 pPager->fullSync = level==3 && !pPager->tempFile;
danielk19771d850a72004-05-31 08:26:49 +00001490 if( pPager->noSync ) pPager->needSync = 0;
drh973b6e32003-02-12 14:09:42 +00001491}
danielk197793758c82005-01-21 08:13:14 +00001492#endif
drh973b6e32003-02-12 14:09:42 +00001493
1494/*
drhfa86c412002-02-02 15:01:15 +00001495** Open a temporary file. Write the name of the file into zName
1496** (zName must be at least SQLITE_TEMPNAME_SIZE bytes long.) Write
1497** the file descriptor into *fd. Return SQLITE_OK on success or some
1498** other error code if we fail.
1499**
1500** The OS will automatically delete the temporary file when it is
1501** closed.
1502*/
drh3aac2dd2004-04-26 14:10:20 +00001503static int sqlite3pager_opentemp(char *zFile, OsFile *fd){
drhfa86c412002-02-02 15:01:15 +00001504 int cnt = 8;
1505 int rc;
1506 do{
1507 cnt--;
danielk19774adee202004-05-08 08:23:19 +00001508 sqlite3OsTempFileName(zFile);
1509 rc = sqlite3OsOpenExclusive(zFile, fd, 1);
danielk197713073932004-06-30 11:54:06 +00001510 }while( cnt>0 && rc!=SQLITE_OK && rc!=SQLITE_NOMEM );
drhfa86c412002-02-02 15:01:15 +00001511 return rc;
1512}
1513
1514/*
drhed7c8552001-04-11 14:29:21 +00001515** Create a new page cache and put a pointer to the page cache in *ppPager.
drh5e00f6c2001-09-13 13:46:56 +00001516** The file to be cached need not exist. The file is not locked until
drh3aac2dd2004-04-26 14:10:20 +00001517** the first call to sqlite3pager_get() and is only held open until the
1518** last page is released using sqlite3pager_unref().
drh382c0242001-10-06 16:33:02 +00001519**
drh6446c4d2001-12-15 14:22:18 +00001520** If zFilename is NULL then a randomly-named temporary file is created
1521** and used as the file to be cached. The file will be deleted
1522** automatically when it is closed.
drh90f5ecb2004-07-22 01:19:35 +00001523**
1524** If zFilename is ":memory:" then all information is held in cache.
1525** It is never written to disk. This can be used to implement an
1526** in-memory database.
drhed7c8552001-04-11 14:29:21 +00001527*/
drh3aac2dd2004-04-26 14:10:20 +00001528int sqlite3pager_open(
drh7e3b0a02001-04-28 16:52:40 +00001529 Pager **ppPager, /* Return the Pager structure here */
1530 const char *zFilename, /* Name of the database file to open */
drhda47d772002-12-02 04:25:19 +00001531 int nExtra, /* Extra bytes append to each in-memory page */
drh7bec5052005-02-06 02:45:41 +00001532 int flags /* flags controlling this file */
drh7e3b0a02001-04-28 16:52:40 +00001533){
drhed7c8552001-04-11 14:29:21 +00001534 Pager *pPager;
danielk19778def5ea2004-06-16 10:39:52 +00001535 char *zFullPathname = 0;
drhed7c8552001-04-11 14:29:21 +00001536 int nameLen;
drh8cfbf082001-09-19 13:22:39 +00001537 OsFile fd;
danielk1977cfe9a692004-06-16 12:00:29 +00001538 int rc = SQLITE_OK;
1539 int i;
danielk19778def5ea2004-06-16 10:39:52 +00001540 int tempFile = 0;
drhac69b052004-05-12 13:30:07 +00001541 int memDb = 0;
drh5e00f6c2001-09-13 13:46:56 +00001542 int readOnly = 0;
drh7bec5052005-02-06 02:45:41 +00001543 int useJournal = (flags & PAGER_OMIT_JOURNAL)==0;
1544 int noReadlock = (flags & PAGER_NO_READLOCK)!=0;
drh8cfbf082001-09-19 13:22:39 +00001545 char zTemp[SQLITE_TEMPNAME_SIZE];
drhed7c8552001-04-11 14:29:21 +00001546
drhd9b02572001-04-15 00:37:09 +00001547 *ppPager = 0;
drhda71ce12004-06-21 18:14:45 +00001548 memset(&fd, 0, sizeof(fd));
danielk19776f8a5032004-05-10 10:34:51 +00001549 if( sqlite3_malloc_failed ){
drhd9b02572001-04-15 00:37:09 +00001550 return SQLITE_NOMEM;
1551 }
drh901afd42003-08-26 11:25:58 +00001552 if( zFilename && zFilename[0] ){
drhb7f91642004-10-31 02:22:47 +00001553#ifndef SQLITE_OMIT_MEMORYDB
drhac69b052004-05-12 13:30:07 +00001554 if( strcmp(zFilename,":memory:")==0 ){
1555 memDb = 1;
drhda71ce12004-06-21 18:14:45 +00001556 zFullPathname = sqliteStrDup("");
drhac69b052004-05-12 13:30:07 +00001557 rc = SQLITE_OK;
drhb7f91642004-10-31 02:22:47 +00001558 }else
1559#endif
1560 {
drhac69b052004-05-12 13:30:07 +00001561 zFullPathname = sqlite3OsFullPathname(zFilename);
danielk19778def5ea2004-06-16 10:39:52 +00001562 if( zFullPathname ){
1563 rc = sqlite3OsOpenReadWrite(zFullPathname, &fd, &readOnly);
1564 }
drhac69b052004-05-12 13:30:07 +00001565 }
drh5e00f6c2001-09-13 13:46:56 +00001566 }else{
drh3aac2dd2004-04-26 14:10:20 +00001567 rc = sqlite3pager_opentemp(zTemp, &fd);
drh5e00f6c2001-09-13 13:46:56 +00001568 zFilename = zTemp;
danielk19774adee202004-05-08 08:23:19 +00001569 zFullPathname = sqlite3OsFullPathname(zFilename);
danielk19778def5ea2004-06-16 10:39:52 +00001570 if( rc==SQLITE_OK ){
1571 tempFile = 1;
1572 }
drh5e00f6c2001-09-13 13:46:56 +00001573 }
danielk19778def5ea2004-06-16 10:39:52 +00001574 if( !zFullPathname ){
danielk1977b5548a82004-06-26 13:51:33 +00001575 sqlite3OsClose(&fd);
drh3e7a6092002-12-07 21:45:14 +00001576 return SQLITE_NOMEM;
1577 }
drh8cfbf082001-09-19 13:22:39 +00001578 if( rc!=SQLITE_OK ){
drhda71ce12004-06-21 18:14:45 +00001579 sqlite3OsClose(&fd);
1580 sqliteFree(zFullPathname);
danielk19778def5ea2004-06-16 10:39:52 +00001581 return rc;
drhed7c8552001-04-11 14:29:21 +00001582 }
drh3e7a6092002-12-07 21:45:14 +00001583 nameLen = strlen(zFullPathname);
drha76c82e2003-07-27 18:59:42 +00001584 pPager = sqliteMalloc( sizeof(*pPager) + nameLen*3 + 30 );
drhd9b02572001-04-15 00:37:09 +00001585 if( pPager==0 ){
drhda71ce12004-06-21 18:14:45 +00001586 sqlite3OsClose(&fd);
1587 sqliteFree(zFullPathname);
drhd9b02572001-04-15 00:37:09 +00001588 return SQLITE_NOMEM;
1589 }
danielk1977ef73ee92004-11-06 12:26:07 +00001590 TRACE3("OPEN %d %s\n", FILEHANDLEID(fd), zFullPathname);
drhed7c8552001-04-11 14:29:21 +00001591 pPager->zFilename = (char*)&pPager[1];
drha76c82e2003-07-27 18:59:42 +00001592 pPager->zDirectory = &pPager->zFilename[nameLen+1];
1593 pPager->zJournal = &pPager->zDirectory[nameLen+1];
drh3e7a6092002-12-07 21:45:14 +00001594 strcpy(pPager->zFilename, zFullPathname);
drha76c82e2003-07-27 18:59:42 +00001595 strcpy(pPager->zDirectory, zFullPathname);
1596 for(i=nameLen; i>0 && pPager->zDirectory[i-1]!='/'; i--){}
1597 if( i>0 ) pPager->zDirectory[i-1] = 0;
drh3e7a6092002-12-07 21:45:14 +00001598 strcpy(pPager->zJournal, zFullPathname);
1599 sqliteFree(zFullPathname);
drhed7c8552001-04-11 14:29:21 +00001600 strcpy(&pPager->zJournal[nameLen], "-journal");
1601 pPager->fd = fd;
drh6d08b4d2004-07-20 12:45:22 +00001602#if OS_UNIX
drhd5b447d2004-07-19 22:08:09 +00001603 pPager->fd.pPager = pPager;
drh6d08b4d2004-07-20 12:45:22 +00001604#endif
drh8cfbf082001-09-19 13:22:39 +00001605 pPager->journalOpen = 0;
drhac69b052004-05-12 13:30:07 +00001606 pPager->useJournal = useJournal && !memDb;
drh7bec5052005-02-06 02:45:41 +00001607 pPager->noReadlock = noReadlock && readOnly;
drhac69b052004-05-12 13:30:07 +00001608 pPager->stmtOpen = 0;
1609 pPager->stmtInUse = 0;
drhed7c8552001-04-11 14:29:21 +00001610 pPager->nRef = 0;
drhac69b052004-05-12 13:30:07 +00001611 pPager->dbSize = memDb-1;
drh90f5ecb2004-07-22 01:19:35 +00001612 pPager->pageSize = SQLITE_DEFAULT_PAGE_SIZE;
drh887dc4c2004-10-22 16:22:57 +00001613 pPager->psAligned = FORCE_ALIGNMENT(pPager->pageSize);
drhac69b052004-05-12 13:30:07 +00001614 pPager->stmtSize = 0;
1615 pPager->stmtJSize = 0;
drhed7c8552001-04-11 14:29:21 +00001616 pPager->nPage = 0;
drh90f5ecb2004-07-22 01:19:35 +00001617 pPager->mxPage = 100;
drha6abd042004-06-09 17:37:22 +00001618 pPager->state = PAGER_UNLOCK;
drhd9b02572001-04-15 00:37:09 +00001619 pPager->errMask = 0;
drh5e00f6c2001-09-13 13:46:56 +00001620 pPager->tempFile = tempFile;
drhac69b052004-05-12 13:30:07 +00001621 pPager->memDb = memDb;
drh5e00f6c2001-09-13 13:46:56 +00001622 pPager->readOnly = readOnly;
drhf57b14a2001-09-14 18:54:08 +00001623 pPager->needSync = 0;
drhda47d772002-12-02 04:25:19 +00001624 pPager->noSync = pPager->tempFile || !useJournal;
danielk197775edc162004-06-26 01:48:18 +00001625 pPager->fullSync = (pPager->noSync?0:1);
drhed7c8552001-04-11 14:29:21 +00001626 pPager->pFirst = 0;
drh341eae82003-01-21 02:39:36 +00001627 pPager->pFirstSynced = 0;
drhed7c8552001-04-11 14:29:21 +00001628 pPager->pLast = 0;
drh887dc4c2004-10-22 16:22:57 +00001629 pPager->nExtra = FORCE_ALIGNMENT(nExtra);
danielk197776572402004-06-25 02:38:54 +00001630 pPager->sectorSize = PAGER_SECTOR_SIZE;
drh90f5ecb2004-07-22 01:19:35 +00001631 pPager->pBusyHandler = 0;
drhed7c8552001-04-11 14:29:21 +00001632 memset(pPager->aHash, 0, sizeof(pPager->aHash));
1633 *ppPager = pPager;
1634 return SQLITE_OK;
1635}
1636
1637/*
drh90f5ecb2004-07-22 01:19:35 +00001638** Set the busy handler function.
1639*/
1640void sqlite3pager_set_busyhandler(Pager *pPager, BusyHandler *pBusyHandler){
1641 pPager->pBusyHandler = pBusyHandler;
1642}
1643
1644/*
drh72f82862001-05-24 21:06:34 +00001645** Set the destructor for this pager. If not NULL, the destructor is called
drh5e00f6c2001-09-13 13:46:56 +00001646** when the reference count on each page reaches zero. The destructor can
1647** be used to clean up information in the extra segment appended to each page.
drh72f82862001-05-24 21:06:34 +00001648**
drh3aac2dd2004-04-26 14:10:20 +00001649** The destructor is not called as a result sqlite3pager_close().
1650** Destructors are only called by sqlite3pager_unref().
drh72f82862001-05-24 21:06:34 +00001651*/
drhb6f41482004-05-14 01:58:11 +00001652void sqlite3pager_set_destructor(Pager *pPager, void (*xDesc)(void*,int)){
drh72f82862001-05-24 21:06:34 +00001653 pPager->xDestructor = xDesc;
1654}
1655
1656/*
drha6abd042004-06-09 17:37:22 +00001657** Set the reinitializer for this pager. If not NULL, the reinitializer
1658** is called when the content of a page in cache is restored to its original
1659** value as a result of a rollback. The callback gives higher-level code
1660** an opportunity to restore the EXTRA section to agree with the restored
1661** page data.
1662*/
1663void sqlite3pager_set_reiniter(Pager *pPager, void (*xReinit)(void*,int)){
1664 pPager->xReiniter = xReinit;
1665}
1666
1667/*
drh90f5ecb2004-07-22 01:19:35 +00001668** Set the page size.
1669**
1670** The page size must only be changed when the cache is empty.
1671*/
1672void sqlite3pager_set_pagesize(Pager *pPager, int pageSize){
1673 assert( pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE );
1674 pPager->pageSize = pageSize;
drh887dc4c2004-10-22 16:22:57 +00001675 pPager->psAligned = FORCE_ALIGNMENT(pageSize);
drh90f5ecb2004-07-22 01:19:35 +00001676}
1677
1678/*
1679** Read the first N bytes from the beginning of the file into memory
1680** that pDest points to. No error checking is done.
1681*/
1682void sqlite3pager_read_fileheader(Pager *pPager, int N, unsigned char *pDest){
1683 memset(pDest, 0, N);
drhb7f91642004-10-31 02:22:47 +00001684 if( MEMDB==0 ){
drh90f5ecb2004-07-22 01:19:35 +00001685 sqlite3OsSeek(&pPager->fd, 0);
1686 sqlite3OsRead(&pPager->fd, pDest, N);
1687 }
1688}
1689
1690/*
drh5e00f6c2001-09-13 13:46:56 +00001691** Return the total number of pages in the disk file associated with
1692** pPager.
drhed7c8552001-04-11 14:29:21 +00001693*/
drh3aac2dd2004-04-26 14:10:20 +00001694int sqlite3pager_pagecount(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001695 i64 n;
drhd9b02572001-04-15 00:37:09 +00001696 assert( pPager!=0 );
drhed7c8552001-04-11 14:29:21 +00001697 if( pPager->dbSize>=0 ){
1698 return pPager->dbSize;
1699 }
danielk19774adee202004-05-08 08:23:19 +00001700 if( sqlite3OsFileSize(&pPager->fd, &n)!=SQLITE_OK ){
drh81a20f22001-10-12 17:30:04 +00001701 pPager->errMask |= PAGER_ERR_DISK;
drh8cfbf082001-09-19 13:22:39 +00001702 return 0;
drhed7c8552001-04-11 14:29:21 +00001703 }
drh90f5ecb2004-07-22 01:19:35 +00001704 n /= pPager->pageSize;
drhb7f91642004-10-31 02:22:47 +00001705 if( !MEMDB && n==PENDING_BYTE/pPager->pageSize ){
drh1f595712004-06-15 01:40:29 +00001706 n++;
1707 }
drha6abd042004-06-09 17:37:22 +00001708 if( pPager->state!=PAGER_UNLOCK ){
drhed7c8552001-04-11 14:29:21 +00001709 pPager->dbSize = n;
1710 }
1711 return n;
1712}
1713
1714/*
drhf7c57532003-04-25 13:22:51 +00001715** Forward declaration
1716*/
danielk197776572402004-06-25 02:38:54 +00001717static int syncJournal(Pager*);
drhf7c57532003-04-25 13:22:51 +00001718
drhac69b052004-05-12 13:30:07 +00001719
1720/*
danielk1977f5fdda82004-11-03 08:44:05 +00001721** Unlink pPg from it's hash chain. Also set the page number to 0 to indicate
1722** that the page is not part of any hash chain. This is required because the
1723** sqlite3pager_movepage() routine can leave a page in the
1724** pNextFree/pPrevFree list that is not a part of any hash-chain.
1725*/
1726static void unlinkHashChain(Pager *pPager, PgHdr *pPg){
1727 if( pPg->pgno==0 ){
1728 /* If the page number is zero, then this page is not in any hash chain. */
1729 return;
1730 }
1731 if( pPg->pNextHash ){
1732 pPg->pNextHash->pPrevHash = pPg->pPrevHash;
1733 }
1734 if( pPg->pPrevHash ){
1735 assert( pPager->aHash[pager_hash(pPg->pgno)]!=pPg );
1736 pPg->pPrevHash->pNextHash = pPg->pNextHash;
1737 }else{
1738 int h = pager_hash(pPg->pgno);
1739 assert( pPager->aHash[h]==pPg );
1740 pPager->aHash[h] = pPg->pNextHash;
1741 }
1742
1743 pPg->pgno = 0;
1744 pPg->pNextHash = pPg->pPrevHash = 0;
1745}
1746
1747/*
drhac69b052004-05-12 13:30:07 +00001748** Unlink a page from the free list (the list of all pages where nRef==0)
1749** and from its hash collision chain.
1750*/
1751static void unlinkPage(PgHdr *pPg){
1752 Pager *pPager = pPg->pPager;
1753
1754 /* Keep the pFirstSynced pointer pointing at the first synchronized page */
1755 if( pPg==pPager->pFirstSynced ){
1756 PgHdr *p = pPg->pNextFree;
1757 while( p && p->needSync ){ p = p->pNextFree; }
1758 pPager->pFirstSynced = p;
1759 }
1760
1761 /* Unlink from the freelist */
1762 if( pPg->pPrevFree ){
1763 pPg->pPrevFree->pNextFree = pPg->pNextFree;
1764 }else{
1765 assert( pPager->pFirst==pPg );
1766 pPager->pFirst = pPg->pNextFree;
1767 }
1768 if( pPg->pNextFree ){
1769 pPg->pNextFree->pPrevFree = pPg->pPrevFree;
1770 }else{
1771 assert( pPager->pLast==pPg );
1772 pPager->pLast = pPg->pPrevFree;
1773 }
1774 pPg->pNextFree = pPg->pPrevFree = 0;
1775
1776 /* Unlink from the pgno hash table */
danielk1977f5fdda82004-11-03 08:44:05 +00001777 unlinkHashChain(pPager, pPg);
drhac69b052004-05-12 13:30:07 +00001778}
1779
danielk1977b84f96f2005-01-20 11:32:23 +00001780#ifndef SQLITE_OMIT_MEMORYDB
drhac69b052004-05-12 13:30:07 +00001781/*
1782** This routine is used to truncate an in-memory database. Delete
danielk1977369f27e2004-06-15 11:40:04 +00001783** all pages whose pgno is larger than pPager->dbSize and is unreferenced.
drhac69b052004-05-12 13:30:07 +00001784** Referenced pages larger than pPager->dbSize are zeroed.
1785*/
1786static void memoryTruncate(Pager *pPager){
1787 PgHdr *pPg;
1788 PgHdr **ppPg;
1789 int dbSize = pPager->dbSize;
1790
1791 ppPg = &pPager->pAll;
1792 while( (pPg = *ppPg)!=0 ){
1793 if( pPg->pgno<=dbSize ){
1794 ppPg = &pPg->pNextAll;
1795 }else if( pPg->nRef>0 ){
1796 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
1797 ppPg = &pPg->pNextAll;
1798 }else{
1799 *ppPg = pPg->pNextAll;
1800 unlinkPage(pPg);
1801 sqliteFree(pPg);
1802 pPager->nPage--;
1803 }
1804 }
1805}
danielk1977b84f96f2005-01-20 11:32:23 +00001806#else
1807#define memoryTruncate(p)
1808#endif
drhac69b052004-05-12 13:30:07 +00001809
drhf7c57532003-04-25 13:22:51 +00001810/*
danielk197717221812005-02-15 03:38:05 +00001811** Try to obtain a lock on a file. Invoke the busy callback if the lock
1812** is currently not available. Repeate until the busy callback returns
1813** false or until the lock succeeds.
1814**
1815** Return SQLITE_OK on success and an error code if we cannot obtain
1816** the lock.
1817*/
1818static int pager_wait_on_lock(Pager *pPager, int locktype){
1819 int rc;
1820 assert( PAGER_SHARED==SHARED_LOCK );
1821 assert( PAGER_RESERVED==RESERVED_LOCK );
1822 assert( PAGER_EXCLUSIVE==EXCLUSIVE_LOCK );
1823 if( pPager->state>=locktype ){
1824 rc = SQLITE_OK;
1825 }else{
1826 int busy = 1;
1827 do {
1828 rc = sqlite3OsLock(&pPager->fd, locktype);
1829 }while( rc==SQLITE_BUSY &&
1830 pPager->pBusyHandler &&
1831 pPager->pBusyHandler->xFunc &&
1832 pPager->pBusyHandler->xFunc(pPager->pBusyHandler->pArg, busy++)
1833 );
1834 if( rc==SQLITE_OK ){
1835 pPager->state = locktype;
1836 }
1837 }
1838 return rc;
1839}
1840
1841/*
drhf7c57532003-04-25 13:22:51 +00001842** Truncate the file to the number of pages specified.
1843*/
drh3aac2dd2004-04-26 14:10:20 +00001844int sqlite3pager_truncate(Pager *pPager, Pgno nPage){
drhf7c57532003-04-25 13:22:51 +00001845 int rc;
drhdc3ff9c2004-08-18 02:10:15 +00001846 sqlite3pager_pagecount(pPager);
drh2e6d11b2003-04-25 15:37:57 +00001847 if( pPager->errMask!=0 ){
1848 rc = pager_errcode(pPager);
1849 return rc;
1850 }
drh7d02cb72003-06-04 16:24:39 +00001851 if( nPage>=(unsigned)pPager->dbSize ){
drhf7c57532003-04-25 13:22:51 +00001852 return SQLITE_OK;
1853 }
drhb7f91642004-10-31 02:22:47 +00001854 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00001855 pPager->dbSize = nPage;
1856 memoryTruncate(pPager);
1857 return SQLITE_OK;
1858 }
danielk197776572402004-06-25 02:38:54 +00001859 rc = syncJournal(pPager);
danielk1977369f27e2004-06-15 11:40:04 +00001860 if( rc!=SQLITE_OK ){
1861 return rc;
1862 }
danielk197717221812005-02-15 03:38:05 +00001863
1864 /* Get an exclusive lock on the database before truncating. */
1865 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
1866 if( rc!=SQLITE_OK ){
1867 return rc;
1868 }
1869
drhcb4c40b2004-08-18 19:09:43 +00001870 rc = pager_truncate(pPager, nPage);
drhf7c57532003-04-25 13:22:51 +00001871 if( rc==SQLITE_OK ){
1872 pPager->dbSize = nPage;
1873 }
1874 return rc;
1875}
1876
1877/*
drhed7c8552001-04-11 14:29:21 +00001878** Shutdown the page cache. Free all memory and close all files.
1879**
1880** If a transaction was in progress when this routine is called, that
1881** transaction is rolled back. All outstanding pages are invalidated
1882** and their memory is freed. Any attempt to use a page associated
1883** with this page cache after this function returns will likely
1884** result in a coredump.
1885*/
drh3aac2dd2004-04-26 14:10:20 +00001886int sqlite3pager_close(Pager *pPager){
drhd9b02572001-04-15 00:37:09 +00001887 PgHdr *pPg, *pNext;
drhed7c8552001-04-11 14:29:21 +00001888 switch( pPager->state ){
drha6abd042004-06-09 17:37:22 +00001889 case PAGER_RESERVED:
danielk1977aa5ccdf2004-06-14 05:10:42 +00001890 case PAGER_SYNCED:
drha6abd042004-06-09 17:37:22 +00001891 case PAGER_EXCLUSIVE: {
danielk1977b3bce662005-01-29 08:32:43 +00001892 /* We ignore any IO errors that occur during the rollback
1893 ** operation. So disable IO error simulation so that testing
1894 ** works more easily.
1895 */
1896#if defined(SQLITE_TEST) && (defined(OS_UNIX) || defined(OS_WIN))
1897 extern int sqlite3_io_error_pending;
1898 int ioerr_cnt = sqlite3_io_error_pending;
1899 sqlite3_io_error_pending = -1;
1900#endif
drh3aac2dd2004-04-26 14:10:20 +00001901 sqlite3pager_rollback(pPager);
danielk1977b3bce662005-01-29 08:32:43 +00001902#if defined(SQLITE_TEST) && (defined(OS_UNIX) || defined(OS_WIN))
1903 sqlite3_io_error_pending = ioerr_cnt;
1904#endif
drhb7f91642004-10-31 02:22:47 +00001905 if( !MEMDB ){
drha6abd042004-06-09 17:37:22 +00001906 sqlite3OsUnlock(&pPager->fd, NO_LOCK);
drhac69b052004-05-12 13:30:07 +00001907 }
drh8cfbf082001-09-19 13:22:39 +00001908 assert( pPager->journalOpen==0 );
drhed7c8552001-04-11 14:29:21 +00001909 break;
1910 }
drha6abd042004-06-09 17:37:22 +00001911 case PAGER_SHARED: {
drhb7f91642004-10-31 02:22:47 +00001912 if( !MEMDB ){
drha6abd042004-06-09 17:37:22 +00001913 sqlite3OsUnlock(&pPager->fd, NO_LOCK);
drhac69b052004-05-12 13:30:07 +00001914 }
drhed7c8552001-04-11 14:29:21 +00001915 break;
1916 }
1917 default: {
1918 /* Do nothing */
1919 break;
1920 }
1921 }
drhd9b02572001-04-15 00:37:09 +00001922 for(pPg=pPager->pAll; pPg; pPg=pNext){
danielk1977eac7a362004-06-16 07:45:24 +00001923#ifndef NDEBUG
drhb7f91642004-10-31 02:22:47 +00001924 if( MEMDB ){
danielk1977eac7a362004-06-16 07:45:24 +00001925 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
1926 assert( !pPg->alwaysRollback );
1927 assert( !pHist->pOrig );
1928 assert( !pHist->pStmt );
1929 }
1930#endif
drhd9b02572001-04-15 00:37:09 +00001931 pNext = pPg->pNextAll;
1932 sqliteFree(pPg);
drhed7c8552001-04-11 14:29:21 +00001933 }
danielk1977ef73ee92004-11-06 12:26:07 +00001934 TRACE2("CLOSE %d\n", PAGERID(pPager));
drhda71ce12004-06-21 18:14:45 +00001935 sqlite3OsClose(&pPager->fd);
drh8cfbf082001-09-19 13:22:39 +00001936 assert( pPager->journalOpen==0 );
drh0f892532002-05-30 12:27:03 +00001937 /* Temp files are automatically deleted by the OS
1938 ** if( pPager->tempFile ){
danielk19774adee202004-05-08 08:23:19 +00001939 ** sqlite3OsDelete(pPager->zFilename);
drh0f892532002-05-30 12:27:03 +00001940 ** }
1941 */
danielk1977aca790a2005-01-13 11:07:52 +00001942
drhed7c8552001-04-11 14:29:21 +00001943 sqliteFree(pPager);
1944 return SQLITE_OK;
1945}
1946
1947/*
drh5e00f6c2001-09-13 13:46:56 +00001948** Return the page number for the given page data.
drhed7c8552001-04-11 14:29:21 +00001949*/
drh3aac2dd2004-04-26 14:10:20 +00001950Pgno sqlite3pager_pagenumber(void *pData){
drhed7c8552001-04-11 14:29:21 +00001951 PgHdr *p = DATA_TO_PGHDR(pData);
1952 return p->pgno;
1953}
1954
1955/*
drhc8629a12004-05-08 20:07:40 +00001956** The page_ref() function increments the reference count for a page.
1957** If the page is currently on the freelist (the reference count is zero) then
drh7e3b0a02001-04-28 16:52:40 +00001958** remove it from the freelist.
drhc8629a12004-05-08 20:07:40 +00001959**
1960** For non-test systems, page_ref() is a macro that calls _page_ref()
1961** online of the reference count is zero. For test systems, page_ref()
1962** is a real function so that we can set breakpoints and trace it.
drh7e3b0a02001-04-28 16:52:40 +00001963*/
drh836faa42003-01-11 13:30:57 +00001964static void _page_ref(PgHdr *pPg){
drh7e3b0a02001-04-28 16:52:40 +00001965 if( pPg->nRef==0 ){
1966 /* The page is currently on the freelist. Remove it. */
drh341eae82003-01-21 02:39:36 +00001967 if( pPg==pPg->pPager->pFirstSynced ){
1968 PgHdr *p = pPg->pNextFree;
1969 while( p && p->needSync ){ p = p->pNextFree; }
1970 pPg->pPager->pFirstSynced = p;
1971 }
drh7e3b0a02001-04-28 16:52:40 +00001972 if( pPg->pPrevFree ){
1973 pPg->pPrevFree->pNextFree = pPg->pNextFree;
1974 }else{
1975 pPg->pPager->pFirst = pPg->pNextFree;
1976 }
1977 if( pPg->pNextFree ){
1978 pPg->pNextFree->pPrevFree = pPg->pPrevFree;
1979 }else{
1980 pPg->pPager->pLast = pPg->pPrevFree;
1981 }
1982 pPg->pPager->nRef++;
1983 }
1984 pPg->nRef++;
drhdd793422001-06-28 01:54:48 +00001985 REFINFO(pPg);
drhdf0b3b02001-06-23 11:36:20 +00001986}
danielk1977aca790a2005-01-13 11:07:52 +00001987#ifdef SQLITE_DEBUG
drhc8629a12004-05-08 20:07:40 +00001988 static void page_ref(PgHdr *pPg){
1989 if( pPg->nRef==0 ){
1990 _page_ref(pPg);
1991 }else{
1992 pPg->nRef++;
1993 REFINFO(pPg);
1994 }
1995 }
1996#else
1997# define page_ref(P) ((P)->nRef==0?_page_ref(P):(void)(P)->nRef++)
1998#endif
drhdf0b3b02001-06-23 11:36:20 +00001999
2000/*
2001** Increment the reference count for a page. The input pointer is
2002** a reference to the page data.
2003*/
drh3aac2dd2004-04-26 14:10:20 +00002004int sqlite3pager_ref(void *pData){
drhdf0b3b02001-06-23 11:36:20 +00002005 PgHdr *pPg = DATA_TO_PGHDR(pData);
2006 page_ref(pPg);
drh8c42ca92001-06-22 19:15:00 +00002007 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +00002008}
2009
2010/*
drh34e79ce2004-02-08 06:05:46 +00002011** Sync the journal. In other words, make sure all the pages that have
2012** been written to the journal have actually reached the surface of the
2013** disk. It is not safe to modify the original database file until after
2014** the journal has been synced. If the original database is modified before
2015** the journal is synced and a power failure occurs, the unsynced journal
2016** data would be lost and we would be unable to completely rollback the
2017** database changes. Database corruption would occur.
2018**
2019** This routine also updates the nRec field in the header of the journal.
2020** (See comments on the pager_playback() routine for additional information.)
2021** If the sync mode is FULL, two syncs will occur. First the whole journal
2022** is synced, then the nRec field is updated, then a second sync occurs.
drhb19a2bc2001-09-16 00:13:26 +00002023**
drh34e79ce2004-02-08 06:05:46 +00002024** For temporary databases, we do not care if we are able to rollback
2025** after a power failure, so sync occurs.
drhfa86c412002-02-02 15:01:15 +00002026**
drh34e79ce2004-02-08 06:05:46 +00002027** This routine clears the needSync field of every page current held in
2028** memory.
drh50e5dad2001-09-15 00:57:28 +00002029*/
danielk197776572402004-06-25 02:38:54 +00002030static int syncJournal(Pager *pPager){
drh50e5dad2001-09-15 00:57:28 +00002031 PgHdr *pPg;
2032 int rc = SQLITE_OK;
drh03eb96a2002-11-10 23:32:56 +00002033
2034 /* Sync the journal before modifying the main database
2035 ** (assuming there is a journal and it needs to be synced.)
2036 */
danielk197776572402004-06-25 02:38:54 +00002037 if( pPager->needSync ){
drhfa86c412002-02-02 15:01:15 +00002038 if( !pPager->tempFile ){
drhdb48ee02003-01-16 13:42:43 +00002039 assert( pPager->journalOpen );
drh946966f2004-02-25 02:20:41 +00002040 /* assert( !pPager->noSync ); // noSync might be set if synchronous
2041 ** was turned off after the transaction was started. Ticket #615 */
drh968af522003-02-11 14:55:40 +00002042#ifndef NDEBUG
2043 {
drh34e79ce2004-02-08 06:05:46 +00002044 /* Make sure the pPager->nRec counter we are keeping agrees
2045 ** with the nRec computed from the size of the journal file.
2046 */
drheb206252004-10-01 02:00:31 +00002047 i64 jSz;
danielk19774adee202004-05-08 08:23:19 +00002048 rc = sqlite3OsFileSize(&pPager->jfd, &jSz);
drh968af522003-02-11 14:55:40 +00002049 if( rc!=0 ) return rc;
danielk197776572402004-06-25 02:38:54 +00002050 assert( pPager->journalOff==jSz );
drh968af522003-02-11 14:55:40 +00002051 }
2052#endif
drhae2b40c2004-06-09 19:03:54 +00002053 {
danielk197776572402004-06-25 02:38:54 +00002054 /* Write the nRec value into the journal file header. If in
2055 ** full-synchronous mode, sync the journal first. This ensures that
2056 ** all data has really hit the disk before nRec is updated to mark
2057 ** it as a candidate for rollback.
2058 */
drhd8d66e82003-02-12 02:10:15 +00002059 if( pPager->fullSync ){
danielk1977ef73ee92004-11-06 12:26:07 +00002060 TRACE2("SYNC journal of %d\n", PAGERID(pPager));
danielk19774adee202004-05-08 08:23:19 +00002061 rc = sqlite3OsSync(&pPager->jfd);
drhd8d66e82003-02-12 02:10:15 +00002062 if( rc!=0 ) return rc;
2063 }
danielk197776572402004-06-25 02:38:54 +00002064 sqlite3OsSeek(&pPager->jfd, pPager->journalHdr + sizeof(aJournalMagic));
drh99ee3602003-02-16 19:13:36 +00002065 rc = write32bits(&pPager->jfd, pPager->nRec);
2066 if( rc ) return rc;
danielk197713adf8a2004-06-03 16:08:41 +00002067
danielk197776572402004-06-25 02:38:54 +00002068 sqlite3OsSeek(&pPager->jfd, pPager->journalOff);
drh968af522003-02-11 14:55:40 +00002069 }
danielk1977ef73ee92004-11-06 12:26:07 +00002070 TRACE2("SYNC journal of %d\n", PAGERID(pPager));
danielk19774adee202004-05-08 08:23:19 +00002071 rc = sqlite3OsSync(&pPager->jfd);
drhfa86c412002-02-02 15:01:15 +00002072 if( rc!=0 ) return rc;
drhdb48ee02003-01-16 13:42:43 +00002073 pPager->journalStarted = 1;
drhfa86c412002-02-02 15:01:15 +00002074 }
drh50e5dad2001-09-15 00:57:28 +00002075 pPager->needSync = 0;
drh341eae82003-01-21 02:39:36 +00002076
2077 /* Erase the needSync flag from every page.
2078 */
2079 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2080 pPg->needSync = 0;
2081 }
2082 pPager->pFirstSynced = pPager->pFirst;
drh50e5dad2001-09-15 00:57:28 +00002083 }
drh03eb96a2002-11-10 23:32:56 +00002084
drh341eae82003-01-21 02:39:36 +00002085#ifndef NDEBUG
2086 /* If the Pager.needSync flag is clear then the PgHdr.needSync
2087 ** flag must also be clear for all pages. Verify that this
2088 ** invariant is true.
drh03eb96a2002-11-10 23:32:56 +00002089 */
drh341eae82003-01-21 02:39:36 +00002090 else{
2091 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2092 assert( pPg->needSync==0 );
2093 }
2094 assert( pPager->pFirstSynced==pPager->pFirst );
drh03eb96a2002-11-10 23:32:56 +00002095 }
drh341eae82003-01-21 02:39:36 +00002096#endif
drhdb48ee02003-01-16 13:42:43 +00002097
drh81a20f22001-10-12 17:30:04 +00002098 return rc;
drh50e5dad2001-09-15 00:57:28 +00002099}
2100
2101/*
drh2554f8b2003-01-22 01:26:44 +00002102** Given a list of pages (connected by the PgHdr.pDirty pointer) write
2103** every one of those pages out to the database file and mark them all
2104** as clean.
2105*/
2106static int pager_write_pagelist(PgHdr *pList){
2107 Pager *pPager;
2108 int rc;
2109
2110 if( pList==0 ) return SQLITE_OK;
2111 pPager = pList->pPager;
danielk19779eed5052004-06-04 10:38:30 +00002112
2113 /* At this point there may be either a RESERVED or EXCLUSIVE lock on the
2114 ** database file. If there is already an EXCLUSIVE lock, the following
2115 ** calls to sqlite3OsLock() are no-ops.
2116 **
drha6abd042004-06-09 17:37:22 +00002117 ** Moving the lock from RESERVED to EXCLUSIVE actually involves going
2118 ** through an intermediate state PENDING. A PENDING lock prevents new
2119 ** readers from attaching to the database but is unsufficient for us to
2120 ** write. The idea of a PENDING lock is to prevent new readers from
2121 ** coming in while we wait for existing readers to clear.
danielk19779eed5052004-06-04 10:38:30 +00002122 **
drha6abd042004-06-09 17:37:22 +00002123 ** While the pager is in the RESERVED state, the original database file
2124 ** is unchanged and we can rollback without having to playback the
2125 ** journal into the original database file. Once we transition to
2126 ** EXCLUSIVE, it means the database file has been changed and any rollback
2127 ** will require a journal playback.
danielk19779eed5052004-06-04 10:38:30 +00002128 */
drh684917c2004-10-05 02:41:42 +00002129 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
danielk19779eed5052004-06-04 10:38:30 +00002130 if( rc!=SQLITE_OK ){
2131 return rc;
2132 }
2133
drh2554f8b2003-01-22 01:26:44 +00002134 while( pList ){
2135 assert( pList->dirty );
drheb206252004-10-01 02:00:31 +00002136 sqlite3OsSeek(&pPager->fd, (pList->pgno-1)*(i64)pPager->pageSize);
danielk1977687566d2004-11-02 12:56:41 +00002137 /* If there are dirty pages in the page cache with page numbers greater
2138 ** than Pager.dbSize, this means sqlite3pager_truncate() was called to
2139 ** make the file smaller (presumably by auto-vacuum code). Do not write
2140 ** any such pages to the file.
2141 */
2142 if( pList->pgno<=pPager->dbSize ){
2143 CODEC(pPager, PGHDR_TO_DATA(pList), pList->pgno, 6);
danielk1977ef73ee92004-11-06 12:26:07 +00002144 TRACE3("STORE %d page %d\n", PAGERID(pPager), pList->pgno);
danielk1977687566d2004-11-02 12:56:41 +00002145 rc = sqlite3OsWrite(&pPager->fd, PGHDR_TO_DATA(pList), pPager->pageSize);
2146 CODEC(pPager, PGHDR_TO_DATA(pList), pList->pgno, 0);
danielk197742741be2005-01-08 12:42:39 +00002147 pPager->nWrite++;
danielk1977687566d2004-11-02 12:56:41 +00002148 }
2149#ifndef NDEBUG
2150 else{
danielk1977ef73ee92004-11-06 12:26:07 +00002151 TRACE3("NOSTORE %d page %d\n", PAGERID(pPager), pList->pgno);
danielk1977687566d2004-11-02 12:56:41 +00002152 }
2153#endif
drh2554f8b2003-01-22 01:26:44 +00002154 if( rc ) return rc;
2155 pList->dirty = 0;
danielk19773c407372005-02-15 02:54:14 +00002156#ifdef SQLITE_CHECK_PAGES
2157 pList->pageHash = pager_pagehash(pList);
2158#endif
drh2554f8b2003-01-22 01:26:44 +00002159 pList = pList->pDirty;
2160 }
2161 return SQLITE_OK;
2162}
2163
2164/*
2165** Collect every dirty page into a dirty list and
2166** return a pointer to the head of that list. All pages are
2167** collected even if they are still in use.
2168*/
2169static PgHdr *pager_get_all_dirty_pages(Pager *pPager){
2170 PgHdr *p, *pList;
2171 pList = 0;
2172 for(p=pPager->pAll; p; p=p->pNextAll){
2173 if( p->dirty ){
2174 p->pDirty = pList;
2175 pList = p;
2176 }
2177 }
2178 return pList;
2179}
2180
2181/*
drhd9b02572001-04-15 00:37:09 +00002182** Acquire a page.
2183**
drh58a11682001-11-10 13:51:08 +00002184** A read lock on the disk file is obtained when the first page is acquired.
drh5e00f6c2001-09-13 13:46:56 +00002185** This read lock is dropped when the last page is released.
drhd9b02572001-04-15 00:37:09 +00002186**
drh306dc212001-05-21 13:45:10 +00002187** A _get works for any page number greater than 0. If the database
2188** file is smaller than the requested page, then no actual disk
2189** read occurs and the memory image of the page is initialized to
2190** all zeros. The extra data appended to a page is always initialized
2191** to zeros the first time a page is loaded into memory.
2192**
drhd9b02572001-04-15 00:37:09 +00002193** The acquisition might fail for several reasons. In all cases,
2194** an appropriate error code is returned and *ppPage is set to NULL.
drh7e3b0a02001-04-28 16:52:40 +00002195**
drh3aac2dd2004-04-26 14:10:20 +00002196** See also sqlite3pager_lookup(). Both this routine and _lookup() attempt
drh7e3b0a02001-04-28 16:52:40 +00002197** to find a page in the in-memory cache first. If the page is not already
drh5e00f6c2001-09-13 13:46:56 +00002198** in memory, this routine goes to disk to read it in whereas _lookup()
drh7e3b0a02001-04-28 16:52:40 +00002199** just returns 0. This routine acquires a read-lock the first time it
2200** has to go to disk, and could also playback an old journal if necessary.
2201** Since _lookup() never goes to disk, it never has to deal with locks
2202** or journal files.
drhed7c8552001-04-11 14:29:21 +00002203*/
drh3aac2dd2004-04-26 14:10:20 +00002204int sqlite3pager_get(Pager *pPager, Pgno pgno, void **ppPage){
drhed7c8552001-04-11 14:29:21 +00002205 PgHdr *pPg;
drh7bec5052005-02-06 02:45:41 +00002206 int rc, n;
drhed7c8552001-04-11 14:29:21 +00002207
danielk197726836652005-01-17 01:33:13 +00002208 /* The maximum page number is 2^31. Return SQLITE_CORRUPT if a page
2209 ** number greater than this, or zero, is requested.
2210 */
2211 if( pgno>PAGER_MAX_PGNO || pgno==0 ){
2212 return SQLITE_CORRUPT;
2213 }
2214
drhd9b02572001-04-15 00:37:09 +00002215 /* Make sure we have not hit any critical errors.
2216 */
drh836faa42003-01-11 13:30:57 +00002217 assert( pPager!=0 );
drh2e6d11b2003-04-25 15:37:57 +00002218 *ppPage = 0;
drhd9b02572001-04-15 00:37:09 +00002219 if( pPager->errMask & ~(PAGER_ERR_FULL) ){
2220 return pager_errcode(pPager);
2221 }
2222
danielk197713adf8a2004-06-03 16:08:41 +00002223 /* If this is the first page accessed, then get a SHARED lock
drhed7c8552001-04-11 14:29:21 +00002224 ** on the database file.
2225 */
drhb7f91642004-10-31 02:22:47 +00002226 if( pPager->nRef==0 && !MEMDB ){
drh7bec5052005-02-06 02:45:41 +00002227 if( !pPager->noReadlock ){
2228 rc = pager_wait_on_lock(pPager, SHARED_LOCK);
2229 if( rc!=SQLITE_OK ){
2230 return rc;
2231 }
drhed7c8552001-04-11 14:29:21 +00002232 }
2233
danielk197713adf8a2004-06-03 16:08:41 +00002234 /* If a journal file exists, and there is no RESERVED lock on the
2235 ** database file, then it either needs to be played back or deleted.
drhed7c8552001-04-11 14:29:21 +00002236 */
danielk197713adf8a2004-06-03 16:08:41 +00002237 if( pPager->useJournal &&
2238 sqlite3OsFileExists(pPager->zJournal) &&
drha6abd042004-06-09 17:37:22 +00002239 !sqlite3OsCheckReservedLock(&pPager->fd)
danielk197713adf8a2004-06-03 16:08:41 +00002240 ){
drhe2227f02003-06-14 11:42:57 +00002241 int rc;
drhed7c8552001-04-11 14:29:21 +00002242
danielk197790ba3bd2004-06-25 08:32:25 +00002243 /* Get an EXCLUSIVE lock on the database file. At this point it is
2244 ** important that a RESERVED lock is not obtained on the way to the
2245 ** EXCLUSIVE lock. If it were, another process might open the
2246 ** database file, detect the RESERVED lock, and conclude that the
2247 ** database is safe to read while this process is still rolling it
2248 ** back.
2249 **
2250 ** Because the intermediate RESERVED lock is not requested, the
2251 ** second process will get to this point in the code and fail to
2252 ** obtain it's own EXCLUSIVE lock on the database file.
2253 */
danielk197713adf8a2004-06-03 16:08:41 +00002254 rc = sqlite3OsLock(&pPager->fd, EXCLUSIVE_LOCK);
drha7fcb052001-12-14 15:09:55 +00002255 if( rc!=SQLITE_OK ){
drha6abd042004-06-09 17:37:22 +00002256 sqlite3OsUnlock(&pPager->fd, NO_LOCK);
2257 pPager->state = PAGER_UNLOCK;
drh8766c342002-11-09 00:33:15 +00002258 return rc;
drha7fcb052001-12-14 15:09:55 +00002259 }
drha6abd042004-06-09 17:37:22 +00002260 pPager->state = PAGER_EXCLUSIVE;
drha7fcb052001-12-14 15:09:55 +00002261
drhe2227f02003-06-14 11:42:57 +00002262 /* Open the journal for reading only. Return SQLITE_BUSY if
2263 ** we are unable to open the journal file.
drhf57b3392001-10-08 13:22:32 +00002264 **
drhe2227f02003-06-14 11:42:57 +00002265 ** The journal file does not need to be locked itself. The
2266 ** journal file is never open unless the main database file holds
2267 ** a write lock, so there is never any chance of two or more
2268 ** processes opening the journal at the same time.
drhed7c8552001-04-11 14:29:21 +00002269 */
danielk19774adee202004-05-08 08:23:19 +00002270 rc = sqlite3OsOpenReadOnly(pPager->zJournal, &pPager->jfd);
drha7fcb052001-12-14 15:09:55 +00002271 if( rc!=SQLITE_OK ){
drha6abd042004-06-09 17:37:22 +00002272 sqlite3OsUnlock(&pPager->fd, NO_LOCK);
2273 pPager->state = PAGER_UNLOCK;
drhed7c8552001-04-11 14:29:21 +00002274 return SQLITE_BUSY;
2275 }
drha7fcb052001-12-14 15:09:55 +00002276 pPager->journalOpen = 1;
drhdb48ee02003-01-16 13:42:43 +00002277 pPager->journalStarted = 0;
danielk197776572402004-06-25 02:38:54 +00002278 pPager->journalOff = 0;
2279 pPager->setMaster = 0;
2280 pPager->journalHdr = 0;
drhed7c8552001-04-11 14:29:21 +00002281
2282 /* Playback and delete the journal. Drop the database write
2283 ** lock and reacquire the read lock.
2284 */
danielk197776572402004-06-25 02:38:54 +00002285 rc = pager_playback(pPager);
drhd9b02572001-04-15 00:37:09 +00002286 if( rc!=SQLITE_OK ){
2287 return rc;
2288 }
drhed7c8552001-04-11 14:29:21 +00002289 }
2290 pPg = 0;
2291 }else{
2292 /* Search for page in cache */
drhd9b02572001-04-15 00:37:09 +00002293 pPg = pager_lookup(pPager, pgno);
drhb7f91642004-10-31 02:22:47 +00002294 if( MEMDB && pPager->state==PAGER_UNLOCK ){
drha6abd042004-06-09 17:37:22 +00002295 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00002296 }
drhed7c8552001-04-11 14:29:21 +00002297 }
2298 if( pPg==0 ){
drhd9b02572001-04-15 00:37:09 +00002299 /* The requested page is not in the page cache. */
drhed7c8552001-04-11 14:29:21 +00002300 int h;
drh7e3b0a02001-04-28 16:52:40 +00002301 pPager->nMiss++;
drhb7f91642004-10-31 02:22:47 +00002302 if( pPager->nPage<pPager->mxPage || pPager->pFirst==0 || MEMDB ){
drhed7c8552001-04-11 14:29:21 +00002303 /* Create a new page */
drh887dc4c2004-10-22 16:22:57 +00002304 pPg = sqliteMallocRaw( sizeof(*pPg) + pPager->psAligned
drhac69b052004-05-12 13:30:07 +00002305 + sizeof(u32) + pPager->nExtra
drhb7f91642004-10-31 02:22:47 +00002306 + MEMDB*sizeof(PgHistory) );
drhd9b02572001-04-15 00:37:09 +00002307 if( pPg==0 ){
drhb7f91642004-10-31 02:22:47 +00002308 if( !MEMDB ){
danielk19778def5ea2004-06-16 10:39:52 +00002309 pager_unwritelock(pPager);
2310 }
drhd9b02572001-04-15 00:37:09 +00002311 pPager->errMask |= PAGER_ERR_MEM;
2312 return SQLITE_NOMEM;
2313 }
drh8c1238a2003-01-02 14:43:55 +00002314 memset(pPg, 0, sizeof(*pPg));
drhb7f91642004-10-31 02:22:47 +00002315 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00002316 memset(PGHDR_TO_HIST(pPg, pPager), 0, sizeof(PgHistory));
2317 }
drhed7c8552001-04-11 14:29:21 +00002318 pPg->pPager = pPager;
drhd9b02572001-04-15 00:37:09 +00002319 pPg->pNextAll = pPager->pAll;
drhd79caeb2001-04-15 02:27:24 +00002320 pPager->pAll = pPg;
drhd9b02572001-04-15 00:37:09 +00002321 pPager->nPage++;
drhed7c8552001-04-11 14:29:21 +00002322 }else{
drhdb48ee02003-01-16 13:42:43 +00002323 /* Find a page to recycle. Try to locate a page that does not
2324 ** require us to do an fsync() on the journal.
2325 */
drh341eae82003-01-21 02:39:36 +00002326 pPg = pPager->pFirstSynced;
drhb19a2bc2001-09-16 00:13:26 +00002327
drhdb48ee02003-01-16 13:42:43 +00002328 /* If we could not find a page that does not require an fsync()
2329 ** on the journal file then fsync the journal file. This is a
2330 ** very slow operation, so we work hard to avoid it. But sometimes
2331 ** it can't be helped.
drhb19a2bc2001-09-16 00:13:26 +00002332 */
drh603240c2002-03-05 01:11:12 +00002333 if( pPg==0 ){
danielk197776572402004-06-25 02:38:54 +00002334 int rc = syncJournal(pPager);
drh50e5dad2001-09-15 00:57:28 +00002335 if( rc!=0 ){
drh3aac2dd2004-04-26 14:10:20 +00002336 sqlite3pager_rollback(pPager);
drh50e5dad2001-09-15 00:57:28 +00002337 return SQLITE_IOERR;
2338 }
danielk197776572402004-06-25 02:38:54 +00002339 if( pPager->fullSync ){
2340 /* If in full-sync mode, write a new journal header into the
2341 ** journal file. This is done to avoid ever modifying a journal
2342 ** header that is involved in the rollback of pages that have
2343 ** already been written to the database (in case the header is
2344 ** trashed when the nRec field is updated).
2345 */
2346 pPager->nRec = 0;
danielk1977f187bd92004-06-25 06:23:22 +00002347 assert( pPager->journalOff > 0 );
danielk197776572402004-06-25 02:38:54 +00002348 rc = writeJournalHdr(pPager);
2349 if( rc!=0 ){
2350 sqlite3pager_rollback(pPager);
2351 return SQLITE_IOERR;
2352 }
2353 }
drh50e5dad2001-09-15 00:57:28 +00002354 pPg = pPager->pFirst;
2355 }
drhd9b02572001-04-15 00:37:09 +00002356 assert( pPg->nRef==0 );
drhdb48ee02003-01-16 13:42:43 +00002357
2358 /* Write the page to the database file if it is dirty.
2359 */
2360 if( pPg->dirty ){
2361 assert( pPg->needSync==0 );
drh2554f8b2003-01-22 01:26:44 +00002362 pPg->pDirty = 0;
2363 rc = pager_write_pagelist( pPg );
drhdb48ee02003-01-16 13:42:43 +00002364 if( rc!=SQLITE_OK ){
drh3aac2dd2004-04-26 14:10:20 +00002365 sqlite3pager_rollback(pPager);
drhdb48ee02003-01-16 13:42:43 +00002366 return SQLITE_IOERR;
2367 }
drhdb48ee02003-01-16 13:42:43 +00002368 }
drh50e5dad2001-09-15 00:57:28 +00002369 assert( pPg->dirty==0 );
drhd9b02572001-04-15 00:37:09 +00002370
drhdb48ee02003-01-16 13:42:43 +00002371 /* If the page we are recycling is marked as alwaysRollback, then
drh193a6b42002-07-07 16:52:46 +00002372 ** set the global alwaysRollback flag, thus disabling the
2373 ** sqlite_dont_rollback() optimization for the rest of this transaction.
2374 ** It is necessary to do this because the page marked alwaysRollback
2375 ** might be reloaded at a later time but at that point we won't remember
2376 ** that is was marked alwaysRollback. This means that all pages must
2377 ** be marked as alwaysRollback from here on out.
2378 */
2379 if( pPg->alwaysRollback ){
2380 pPager->alwaysRollback = 1;
2381 }
2382
drhd9b02572001-04-15 00:37:09 +00002383 /* Unlink the old page from the free list and the hash table
2384 */
drhac69b052004-05-12 13:30:07 +00002385 unlinkPage(pPg);
drhd9b02572001-04-15 00:37:09 +00002386 pPager->nOvfl++;
drhed7c8552001-04-11 14:29:21 +00002387 }
2388 pPg->pgno = pgno;
drh1ab43002002-01-14 09:28:19 +00002389 if( pPager->aInJournal && (int)pgno<=pPager->origDbSize ){
danielk19774adee202004-05-08 08:23:19 +00002390 sqlite3CheckMemory(pPager->aInJournal, pgno/8);
drhdb48ee02003-01-16 13:42:43 +00002391 assert( pPager->journalOpen );
drh6019e162001-07-02 17:51:45 +00002392 pPg->inJournal = (pPager->aInJournal[pgno/8] & (1<<(pgno&7)))!=0;
drhdb48ee02003-01-16 13:42:43 +00002393 pPg->needSync = 0;
drh6019e162001-07-02 17:51:45 +00002394 }else{
2395 pPg->inJournal = 0;
drhdb48ee02003-01-16 13:42:43 +00002396 pPg->needSync = 0;
drh6019e162001-07-02 17:51:45 +00002397 }
drhac69b052004-05-12 13:30:07 +00002398 if( pPager->aInStmt && (int)pgno<=pPager->stmtSize
2399 && (pPager->aInStmt[pgno/8] & (1<<(pgno&7)))!=0 ){
drh3aac2dd2004-04-26 14:10:20 +00002400 page_add_to_stmt_list(pPg);
drhfa86c412002-02-02 15:01:15 +00002401 }else{
drh3aac2dd2004-04-26 14:10:20 +00002402 page_remove_from_stmt_list(pPg);
drhfa86c412002-02-02 15:01:15 +00002403 }
drhed7c8552001-04-11 14:29:21 +00002404 pPg->dirty = 0;
2405 pPg->nRef = 1;
drhdd793422001-06-28 01:54:48 +00002406 REFINFO(pPg);
drhd9b02572001-04-15 00:37:09 +00002407 pPager->nRef++;
2408 h = pager_hash(pgno);
drhed7c8552001-04-11 14:29:21 +00002409 pPg->pNextHash = pPager->aHash[h];
2410 pPager->aHash[h] = pPg;
2411 if( pPg->pNextHash ){
2412 assert( pPg->pNextHash->pPrevHash==0 );
2413 pPg->pNextHash->pPrevHash = pPg;
2414 }
drh2e6d11b2003-04-25 15:37:57 +00002415 if( pPager->nExtra>0 ){
drh90f5ecb2004-07-22 01:19:35 +00002416 memset(PGHDR_TO_EXTRA(pPg, pPager), 0, pPager->nExtra);
drh2e6d11b2003-04-25 15:37:57 +00002417 }
drh7bec5052005-02-06 02:45:41 +00002418 n = sqlite3pager_pagecount(pPager);
drh2e6d11b2003-04-25 15:37:57 +00002419 if( pPager->errMask!=0 ){
drh3aac2dd2004-04-26 14:10:20 +00002420 sqlite3pager_unref(PGHDR_TO_DATA(pPg));
drh2e6d11b2003-04-25 15:37:57 +00002421 rc = pager_errcode(pPager);
2422 return rc;
2423 }
drh7bec5052005-02-06 02:45:41 +00002424 if( n<(int)pgno ){
drh90f5ecb2004-07-22 01:19:35 +00002425 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
drh306dc212001-05-21 13:45:10 +00002426 }else{
drh81a20f22001-10-12 17:30:04 +00002427 int rc;
drhb7f91642004-10-31 02:22:47 +00002428 assert( MEMDB==0 );
drheb206252004-10-01 02:00:31 +00002429 sqlite3OsSeek(&pPager->fd, (pgno-1)*(i64)pPager->pageSize);
drh90f5ecb2004-07-22 01:19:35 +00002430 rc = sqlite3OsRead(&pPager->fd, PGHDR_TO_DATA(pPg), pPager->pageSize);
danielk1977ef73ee92004-11-06 12:26:07 +00002431 TRACE3("FETCH %d page %d\n", PAGERID(pPager), pPg->pgno);
drh9eb9e262004-02-11 02:18:05 +00002432 CODEC(pPager, PGHDR_TO_DATA(pPg), pPg->pgno, 3);
drh81a20f22001-10-12 17:30:04 +00002433 if( rc!=SQLITE_OK ){
drheb206252004-10-01 02:00:31 +00002434 i64 fileSize;
danielk19774adee202004-05-08 08:23:19 +00002435 if( sqlite3OsFileSize(&pPager->fd,&fileSize)!=SQLITE_OK
drh90f5ecb2004-07-22 01:19:35 +00002436 || fileSize>=pgno*pPager->pageSize ){
drh3aac2dd2004-04-26 14:10:20 +00002437 sqlite3pager_unref(PGHDR_TO_DATA(pPg));
drh4e371ee2002-09-05 16:08:27 +00002438 return rc;
2439 }else{
drh90f5ecb2004-07-22 01:19:35 +00002440 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
drh4e371ee2002-09-05 16:08:27 +00002441 }
danielk197742741be2005-01-08 12:42:39 +00002442 }else{
2443 pPager->nRead++;
drh81a20f22001-10-12 17:30:04 +00002444 }
drh306dc212001-05-21 13:45:10 +00002445 }
danielk19773c407372005-02-15 02:54:14 +00002446#ifdef SQLITE_CHECK_PAGES
2447 pPg->pageHash = pager_pagehash(pPg);
2448#endif
drhed7c8552001-04-11 14:29:21 +00002449 }else{
drhd9b02572001-04-15 00:37:09 +00002450 /* The requested page is in the page cache. */
drh7e3b0a02001-04-28 16:52:40 +00002451 pPager->nHit++;
drhdf0b3b02001-06-23 11:36:20 +00002452 page_ref(pPg);
drhed7c8552001-04-11 14:29:21 +00002453 }
2454 *ppPage = PGHDR_TO_DATA(pPg);
2455 return SQLITE_OK;
2456}
2457
2458/*
drh7e3b0a02001-04-28 16:52:40 +00002459** Acquire a page if it is already in the in-memory cache. Do
2460** not read the page from disk. Return a pointer to the page,
2461** or 0 if the page is not in cache.
2462**
drh3aac2dd2004-04-26 14:10:20 +00002463** See also sqlite3pager_get(). The difference between this routine
2464** and sqlite3pager_get() is that _get() will go to the disk and read
drh7e3b0a02001-04-28 16:52:40 +00002465** in the page if the page is not already in cache. This routine
drh5e00f6c2001-09-13 13:46:56 +00002466** returns NULL if the page is not in cache or if a disk I/O error
2467** has ever happened.
drh7e3b0a02001-04-28 16:52:40 +00002468*/
drh3aac2dd2004-04-26 14:10:20 +00002469void *sqlite3pager_lookup(Pager *pPager, Pgno pgno){
drh7e3b0a02001-04-28 16:52:40 +00002470 PgHdr *pPg;
2471
drh836faa42003-01-11 13:30:57 +00002472 assert( pPager!=0 );
2473 assert( pgno!=0 );
drh7e3b0a02001-04-28 16:52:40 +00002474 if( pPager->errMask & ~(PAGER_ERR_FULL) ){
2475 return 0;
2476 }
drh7e3b0a02001-04-28 16:52:40 +00002477 pPg = pager_lookup(pPager, pgno);
2478 if( pPg==0 ) return 0;
drhdf0b3b02001-06-23 11:36:20 +00002479 page_ref(pPg);
drh7e3b0a02001-04-28 16:52:40 +00002480 return PGHDR_TO_DATA(pPg);
2481}
2482
2483/*
drhed7c8552001-04-11 14:29:21 +00002484** Release a page.
2485**
2486** If the number of references to the page drop to zero, then the
2487** page is added to the LRU list. When all references to all pages
drhd9b02572001-04-15 00:37:09 +00002488** are released, a rollback occurs and the lock on the database is
drhed7c8552001-04-11 14:29:21 +00002489** removed.
2490*/
drh3aac2dd2004-04-26 14:10:20 +00002491int sqlite3pager_unref(void *pData){
drhed7c8552001-04-11 14:29:21 +00002492 PgHdr *pPg;
drhd9b02572001-04-15 00:37:09 +00002493
2494 /* Decrement the reference count for this page
2495 */
drhed7c8552001-04-11 14:29:21 +00002496 pPg = DATA_TO_PGHDR(pData);
2497 assert( pPg->nRef>0 );
drhed7c8552001-04-11 14:29:21 +00002498 pPg->nRef--;
drhdd793422001-06-28 01:54:48 +00002499 REFINFO(pPg);
drhd9b02572001-04-15 00:37:09 +00002500
danielk19773c407372005-02-15 02:54:14 +00002501 CHECK_PAGE(pPg);
2502
drh72f82862001-05-24 21:06:34 +00002503 /* When the number of references to a page reach 0, call the
2504 ** destructor and add the page to the freelist.
drhd9b02572001-04-15 00:37:09 +00002505 */
drhed7c8552001-04-11 14:29:21 +00002506 if( pPg->nRef==0 ){
drh1eaa2692001-09-18 02:02:23 +00002507 Pager *pPager;
2508 pPager = pPg->pPager;
drhd9b02572001-04-15 00:37:09 +00002509 pPg->pNextFree = 0;
2510 pPg->pPrevFree = pPager->pLast;
drhed7c8552001-04-11 14:29:21 +00002511 pPager->pLast = pPg;
drhd9b02572001-04-15 00:37:09 +00002512 if( pPg->pPrevFree ){
2513 pPg->pPrevFree->pNextFree = pPg;
drhed7c8552001-04-11 14:29:21 +00002514 }else{
2515 pPager->pFirst = pPg;
2516 }
drh341eae82003-01-21 02:39:36 +00002517 if( pPg->needSync==0 && pPager->pFirstSynced==0 ){
2518 pPager->pFirstSynced = pPg;
2519 }
drh72f82862001-05-24 21:06:34 +00002520 if( pPager->xDestructor ){
drhb6f41482004-05-14 01:58:11 +00002521 pPager->xDestructor(pData, pPager->pageSize);
drh72f82862001-05-24 21:06:34 +00002522 }
drhd9b02572001-04-15 00:37:09 +00002523
2524 /* When all pages reach the freelist, drop the read lock from
2525 ** the database file.
2526 */
2527 pPager->nRef--;
2528 assert( pPager->nRef>=0 );
drhb7f91642004-10-31 02:22:47 +00002529 if( pPager->nRef==0 && !MEMDB ){
drhd9b02572001-04-15 00:37:09 +00002530 pager_reset(pPager);
2531 }
drhed7c8552001-04-11 14:29:21 +00002532 }
drhd9b02572001-04-15 00:37:09 +00002533 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +00002534}
2535
2536/*
drha6abd042004-06-09 17:37:22 +00002537** Create a journal file for pPager. There should already be a RESERVED
2538** or EXCLUSIVE lock on the database file when this routine is called.
drhda47d772002-12-02 04:25:19 +00002539**
2540** Return SQLITE_OK if everything. Return an error code and release the
2541** write lock if anything goes wrong.
2542*/
2543static int pager_open_journal(Pager *pPager){
2544 int rc;
drhb7f91642004-10-31 02:22:47 +00002545 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +00002546 assert( pPager->state>=PAGER_RESERVED );
drhda47d772002-12-02 04:25:19 +00002547 assert( pPager->journalOpen==0 );
2548 assert( pPager->useJournal );
drh3aac2dd2004-04-26 14:10:20 +00002549 sqlite3pager_pagecount(pPager);
drhda47d772002-12-02 04:25:19 +00002550 pPager->aInJournal = sqliteMalloc( pPager->dbSize/8 + 1 );
2551 if( pPager->aInJournal==0 ){
drh9c105bb2004-10-02 20:38:28 +00002552 rc = SQLITE_NOMEM;
2553 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00002554 }
danielk19774adee202004-05-08 08:23:19 +00002555 rc = sqlite3OsOpenExclusive(pPager->zJournal, &pPager->jfd,pPager->tempFile);
danielk197776572402004-06-25 02:38:54 +00002556 pPager->journalOff = 0;
2557 pPager->setMaster = 0;
2558 pPager->journalHdr = 0;
drhda47d772002-12-02 04:25:19 +00002559 if( rc!=SQLITE_OK ){
drh9c105bb2004-10-02 20:38:28 +00002560 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00002561 }
danielk19774adee202004-05-08 08:23:19 +00002562 sqlite3OsOpenDirectory(pPager->zDirectory, &pPager->jfd);
drhda47d772002-12-02 04:25:19 +00002563 pPager->journalOpen = 1;
drhdb48ee02003-01-16 13:42:43 +00002564 pPager->journalStarted = 0;
drhda47d772002-12-02 04:25:19 +00002565 pPager->needSync = 0;
2566 pPager->alwaysRollback = 0;
drh968af522003-02-11 14:55:40 +00002567 pPager->nRec = 0;
drh2e6d11b2003-04-25 15:37:57 +00002568 if( pPager->errMask!=0 ){
2569 rc = pager_errcode(pPager);
2570 return rc;
2571 }
drhda47d772002-12-02 04:25:19 +00002572 pPager->origDbSize = pPager->dbSize;
drhae2b40c2004-06-09 19:03:54 +00002573
danielk197776572402004-06-25 02:38:54 +00002574 rc = writeJournalHdr(pPager);
2575
drhac69b052004-05-12 13:30:07 +00002576 if( pPager->stmtAutoopen && rc==SQLITE_OK ){
drh3aac2dd2004-04-26 14:10:20 +00002577 rc = sqlite3pager_stmt_begin(pPager);
drhda47d772002-12-02 04:25:19 +00002578 }
2579 if( rc!=SQLITE_OK ){
2580 rc = pager_unwritelock(pPager);
2581 if( rc==SQLITE_OK ){
2582 rc = SQLITE_FULL;
2583 }
2584 }
drh9c105bb2004-10-02 20:38:28 +00002585 return rc;
2586
2587failed_to_open_journal:
2588 sqliteFree(pPager->aInJournal);
2589 pPager->aInJournal = 0;
2590 sqlite3OsUnlock(&pPager->fd, NO_LOCK);
2591 pPager->state = PAGER_UNLOCK;
2592 return rc;
drhda47d772002-12-02 04:25:19 +00002593}
2594
2595/*
drh4b845d72002-03-05 12:41:19 +00002596** Acquire a write-lock on the database. The lock is removed when
2597** the any of the following happen:
2598**
drh3aac2dd2004-04-26 14:10:20 +00002599** * sqlite3pager_commit() is called.
2600** * sqlite3pager_rollback() is called.
2601** * sqlite3pager_close() is called.
2602** * sqlite3pager_unref() is called to on every outstanding page.
drh4b845d72002-03-05 12:41:19 +00002603**
danielk197713adf8a2004-06-03 16:08:41 +00002604** The first parameter to this routine is a pointer to any open page of the
2605** database file. Nothing changes about the page - it is used merely to
2606** acquire a pointer to the Pager structure and as proof that there is
2607** already a read-lock on the database.
drh4b845d72002-03-05 12:41:19 +00002608**
danielk197713adf8a2004-06-03 16:08:41 +00002609** The second parameter indicates how much space in bytes to reserve for a
2610** master journal file-name at the start of the journal when it is created.
2611**
2612** A journal file is opened if this is not a temporary file. For temporary
2613** files, the opening of the journal file is deferred until there is an
2614** actual need to write to the journal.
drhda47d772002-12-02 04:25:19 +00002615**
drha6abd042004-06-09 17:37:22 +00002616** If the database is already reserved for writing, this routine is a no-op.
drh684917c2004-10-05 02:41:42 +00002617**
2618** If exFlag is true, go ahead and get an EXCLUSIVE lock on the file
2619** immediately instead of waiting until we try to flush the cache. The
2620** exFlag is ignored if a transaction is already active.
drh4b845d72002-03-05 12:41:19 +00002621*/
drh684917c2004-10-05 02:41:42 +00002622int sqlite3pager_begin(void *pData, int exFlag){
drh4b845d72002-03-05 12:41:19 +00002623 PgHdr *pPg = DATA_TO_PGHDR(pData);
2624 Pager *pPager = pPg->pPager;
2625 int rc = SQLITE_OK;
2626 assert( pPg->nRef>0 );
drha6abd042004-06-09 17:37:22 +00002627 assert( pPager->state!=PAGER_UNLOCK );
2628 if( pPager->state==PAGER_SHARED ){
drh4b845d72002-03-05 12:41:19 +00002629 assert( pPager->aInJournal==0 );
drhb7f91642004-10-31 02:22:47 +00002630 if( MEMDB ){
drha6abd042004-06-09 17:37:22 +00002631 pPager->state = PAGER_EXCLUSIVE;
drhac69b052004-05-12 13:30:07 +00002632 pPager->origDbSize = pPager->dbSize;
2633 }else{
drh684917c2004-10-05 02:41:42 +00002634 if( SQLITE_BUSY_RESERVED_LOCK || exFlag ){
2635 rc = pager_wait_on_lock(pPager, RESERVED_LOCK);
2636 }else{
danielk19779eed5052004-06-04 10:38:30 +00002637 rc = sqlite3OsLock(&pPager->fd, RESERVED_LOCK);
drh684917c2004-10-05 02:41:42 +00002638 }
2639 if( rc==SQLITE_OK ){
2640 pPager->state = PAGER_RESERVED;
2641 if( exFlag ){
2642 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
2643 }
2644 }
danielk19779eed5052004-06-04 10:38:30 +00002645 if( rc!=SQLITE_OK ){
2646 return rc;
drhac69b052004-05-12 13:30:07 +00002647 }
drha6abd042004-06-09 17:37:22 +00002648 pPager->dirtyCache = 0;
danielk1977ef73ee92004-11-06 12:26:07 +00002649 TRACE2("TRANSACTION %d\n", PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00002650 if( pPager->useJournal && !pPager->tempFile ){
2651 rc = pager_open_journal(pPager);
2652 }
drh4b845d72002-03-05 12:41:19 +00002653 }
2654 }
2655 return rc;
2656}
2657
2658/*
drhed7c8552001-04-11 14:29:21 +00002659** Mark a data page as writeable. The page is written into the journal
2660** if it is not there already. This routine must be called before making
2661** changes to a page.
2662**
2663** The first time this routine is called, the pager creates a new
drha6abd042004-06-09 17:37:22 +00002664** journal and acquires a RESERVED lock on the database. If the RESERVED
drhed7c8552001-04-11 14:29:21 +00002665** lock could not be acquired, this routine returns SQLITE_BUSY. The
drh306dc212001-05-21 13:45:10 +00002666** calling routine must check for that return value and be careful not to
drhed7c8552001-04-11 14:29:21 +00002667** change any page data until this routine returns SQLITE_OK.
drhd9b02572001-04-15 00:37:09 +00002668**
2669** If the journal file could not be written because the disk is full,
2670** then this routine returns SQLITE_FULL and does an immediate rollback.
2671** All subsequent write attempts also return SQLITE_FULL until there
drh3aac2dd2004-04-26 14:10:20 +00002672** is a call to sqlite3pager_commit() or sqlite3pager_rollback() to
drhd9b02572001-04-15 00:37:09 +00002673** reset.
drhed7c8552001-04-11 14:29:21 +00002674*/
drh3aac2dd2004-04-26 14:10:20 +00002675int sqlite3pager_write(void *pData){
drh69688d52001-04-14 16:38:23 +00002676 PgHdr *pPg = DATA_TO_PGHDR(pData);
2677 Pager *pPager = pPg->pPager;
drhd79caeb2001-04-15 02:27:24 +00002678 int rc = SQLITE_OK;
drh69688d52001-04-14 16:38:23 +00002679
drh6446c4d2001-12-15 14:22:18 +00002680 /* Check for errors
2681 */
drhd9b02572001-04-15 00:37:09 +00002682 if( pPager->errMask ){
2683 return pager_errcode(pPager);
2684 }
drh5e00f6c2001-09-13 13:46:56 +00002685 if( pPager->readOnly ){
2686 return SQLITE_PERM;
2687 }
drh6446c4d2001-12-15 14:22:18 +00002688
danielk197776572402004-06-25 02:38:54 +00002689 assert( !pPager->setMaster );
2690
danielk19773c407372005-02-15 02:54:14 +00002691 CHECK_PAGE(pPg);
2692
drh6446c4d2001-12-15 14:22:18 +00002693 /* Mark the page as dirty. If the page has already been written
2694 ** to the journal then we can return right away.
2695 */
drhd9b02572001-04-15 00:37:09 +00002696 pPg->dirty = 1;
drhac69b052004-05-12 13:30:07 +00002697 if( pPg->inJournal && (pPg->inStmt || pPager->stmtInUse==0) ){
drha6abd042004-06-09 17:37:22 +00002698 pPager->dirtyCache = 1;
danielk1977a0bf2652004-11-04 14:30:04 +00002699 }else{
drh6446c4d2001-12-15 14:22:18 +00002700
danielk1977a0bf2652004-11-04 14:30:04 +00002701 /* If we get this far, it means that the page needs to be
2702 ** written to the transaction journal or the ckeckpoint journal
2703 ** or both.
2704 **
2705 ** First check to see that the transaction journal exists and
2706 ** create it if it does not.
2707 */
2708 assert( pPager->state!=PAGER_UNLOCK );
2709 rc = sqlite3pager_begin(pData, 0);
2710 if( rc!=SQLITE_OK ){
2711 return rc;
2712 }
2713 assert( pPager->state>=PAGER_RESERVED );
2714 if( !pPager->journalOpen && pPager->useJournal ){
2715 rc = pager_open_journal(pPager);
2716 if( rc!=SQLITE_OK ) return rc;
2717 }
2718 assert( pPager->journalOpen || !pPager->useJournal );
2719 pPager->dirtyCache = 1;
2720
2721 /* The transaction journal now exists and we have a RESERVED or an
2722 ** EXCLUSIVE lock on the main database file. Write the current page to
2723 ** the transaction journal if it is not there already.
2724 */
2725 if( !pPg->inJournal && (pPager->useJournal || MEMDB) ){
2726 if( (int)pPg->pgno <= pPager->origDbSize ){
2727 int szPg;
2728 u32 saved;
2729 if( MEMDB ){
2730 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
danielk1977ef73ee92004-11-06 12:26:07 +00002731 TRACE3("JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00002732 assert( pHist->pOrig==0 );
2733 pHist->pOrig = sqliteMallocRaw( pPager->pageSize );
2734 if( pHist->pOrig ){
2735 memcpy(pHist->pOrig, PGHDR_TO_DATA(pPg), pPager->pageSize);
2736 }
2737 }else{
2738 u32 cksum;
2739 CODEC(pPager, pData, pPg->pgno, 7);
2740 cksum = pager_cksum(pPager, pPg->pgno, pData);
2741 saved = *(u32*)PGHDR_TO_EXTRA(pPg, pPager);
2742 store32bits(cksum, pPg, pPager->pageSize);
2743 szPg = pPager->pageSize+8;
2744 store32bits(pPg->pgno, pPg, -4);
2745 rc = sqlite3OsWrite(&pPager->jfd, &((char*)pData)[-4], szPg);
2746 pPager->journalOff += szPg;
2747 TRACE4("JOURNAL %d page %d needSync=%d\n",
danielk1977ef73ee92004-11-06 12:26:07 +00002748 PAGERID(pPager), pPg->pgno, pPg->needSync);
danielk1977a0bf2652004-11-04 14:30:04 +00002749 CODEC(pPager, pData, pPg->pgno, 0);
2750 *(u32*)PGHDR_TO_EXTRA(pPg, pPager) = saved;
2751 if( rc!=SQLITE_OK ){
2752 sqlite3pager_rollback(pPager);
2753 pPager->errMask |= PAGER_ERR_FULL;
2754 return rc;
2755 }
2756 pPager->nRec++;
2757 assert( pPager->aInJournal!=0 );
2758 pPager->aInJournal[pPg->pgno/8] |= 1<<(pPg->pgno&7);
2759 pPg->needSync = !pPager->noSync;
2760 if( pPager->stmtInUse ){
2761 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
2762 page_add_to_stmt_list(pPg);
2763 }
drhac69b052004-05-12 13:30:07 +00002764 }
danielk197713adf8a2004-06-03 16:08:41 +00002765 }else{
danielk1977a0bf2652004-11-04 14:30:04 +00002766 pPg->needSync = !pPager->journalStarted && !pPager->noSync;
2767 TRACE4("APPEND %d page %d needSync=%d\n",
danielk1977ef73ee92004-11-06 12:26:07 +00002768 PAGERID(pPager), pPg->pgno, pPg->needSync);
danielk1977a0bf2652004-11-04 14:30:04 +00002769 }
2770 if( pPg->needSync ){
2771 pPager->needSync = 1;
2772 }
2773 pPg->inJournal = 1;
2774 }
2775
2776 /* If the statement journal is open and the page is not in it,
2777 ** then write the current page to the statement journal. Note that
2778 ** the statement journal format differs from the standard journal format
2779 ** in that it omits the checksums and the header.
2780 */
2781 if( pPager->stmtInUse && !pPg->inStmt && (int)pPg->pgno<=pPager->stmtSize ){
2782 assert( pPg->inJournal || (int)pPg->pgno>pPager->origDbSize );
2783 if( MEMDB ){
2784 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
2785 assert( pHist->pStmt==0 );
2786 pHist->pStmt = sqliteMallocRaw( pPager->pageSize );
2787 if( pHist->pStmt ){
2788 memcpy(pHist->pStmt, PGHDR_TO_DATA(pPg), pPager->pageSize);
2789 }
danielk1977ef73ee92004-11-06 12:26:07 +00002790 TRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00002791 }else{
2792 store32bits(pPg->pgno, pPg, -4);
2793 CODEC(pPager, pData, pPg->pgno, 7);
2794 rc = sqlite3OsWrite(&pPager->stfd,((char*)pData)-4, pPager->pageSize+4);
danielk1977ef73ee92004-11-06 12:26:07 +00002795 TRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
drhac69b052004-05-12 13:30:07 +00002796 CODEC(pPager, pData, pPg->pgno, 0);
drhac69b052004-05-12 13:30:07 +00002797 if( rc!=SQLITE_OK ){
2798 sqlite3pager_rollback(pPager);
2799 pPager->errMask |= PAGER_ERR_FULL;
2800 return rc;
2801 }
danielk1977a0bf2652004-11-04 14:30:04 +00002802 pPager->stmtNRec++;
2803 assert( pPager->aInStmt!=0 );
2804 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drhdb48ee02003-01-16 13:42:43 +00002805 }
danielk1977a0bf2652004-11-04 14:30:04 +00002806 page_add_to_stmt_list(pPg);
drhd9b02572001-04-15 00:37:09 +00002807 }
drhfa86c412002-02-02 15:01:15 +00002808 }
2809
2810 /* Update the database size and return.
2811 */
drh1ab43002002-01-14 09:28:19 +00002812 if( pPager->dbSize<(int)pPg->pgno ){
drh306dc212001-05-21 13:45:10 +00002813 pPager->dbSize = pPg->pgno;
drhb7f91642004-10-31 02:22:47 +00002814 if( !MEMDB && pPager->dbSize==PENDING_BYTE/pPager->pageSize ){
drh1f595712004-06-15 01:40:29 +00002815 pPager->dbSize++;
2816 }
drh306dc212001-05-21 13:45:10 +00002817 }
drh69688d52001-04-14 16:38:23 +00002818 return rc;
drhed7c8552001-04-11 14:29:21 +00002819}
2820
2821/*
drhaacc5432002-01-06 17:07:40 +00002822** Return TRUE if the page given in the argument was previously passed
drh3aac2dd2004-04-26 14:10:20 +00002823** to sqlite3pager_write(). In other words, return TRUE if it is ok
drh6019e162001-07-02 17:51:45 +00002824** to change the content of the page.
2825*/
drh3aac2dd2004-04-26 14:10:20 +00002826int sqlite3pager_iswriteable(void *pData){
drh6019e162001-07-02 17:51:45 +00002827 PgHdr *pPg = DATA_TO_PGHDR(pData);
2828 return pPg->dirty;
2829}
2830
danielk1977b84f96f2005-01-20 11:32:23 +00002831#ifndef SQLITE_OMIT_VACUUM
drh6019e162001-07-02 17:51:45 +00002832/*
drh001bbcb2003-03-19 03:14:00 +00002833** Replace the content of a single page with the information in the third
2834** argument.
2835*/
drh3aac2dd2004-04-26 14:10:20 +00002836int sqlite3pager_overwrite(Pager *pPager, Pgno pgno, void *pData){
drh001bbcb2003-03-19 03:14:00 +00002837 void *pPage;
2838 int rc;
2839
drh3aac2dd2004-04-26 14:10:20 +00002840 rc = sqlite3pager_get(pPager, pgno, &pPage);
drh001bbcb2003-03-19 03:14:00 +00002841 if( rc==SQLITE_OK ){
drh3aac2dd2004-04-26 14:10:20 +00002842 rc = sqlite3pager_write(pPage);
drh001bbcb2003-03-19 03:14:00 +00002843 if( rc==SQLITE_OK ){
drh90f5ecb2004-07-22 01:19:35 +00002844 memcpy(pPage, pData, pPager->pageSize);
drh001bbcb2003-03-19 03:14:00 +00002845 }
drh3aac2dd2004-04-26 14:10:20 +00002846 sqlite3pager_unref(pPage);
drh001bbcb2003-03-19 03:14:00 +00002847 }
2848 return rc;
2849}
danielk1977b84f96f2005-01-20 11:32:23 +00002850#endif
drh001bbcb2003-03-19 03:14:00 +00002851
2852/*
drh30e58752002-03-02 20:41:57 +00002853** A call to this routine tells the pager that it is not necessary to
2854** write the information on page "pgno" back to the disk, even though
2855** that page might be marked as dirty.
2856**
2857** The overlying software layer calls this routine when all of the data
2858** on the given page is unused. The pager marks the page as clean so
2859** that it does not get written to disk.
2860**
2861** Tests show that this optimization, together with the
drh3aac2dd2004-04-26 14:10:20 +00002862** sqlite3pager_dont_rollback() below, more than double the speed
drh30e58752002-03-02 20:41:57 +00002863** of large INSERT operations and quadruple the speed of large DELETEs.
drh8e298f92002-07-06 16:28:47 +00002864**
2865** When this routine is called, set the alwaysRollback flag to true.
drh3aac2dd2004-04-26 14:10:20 +00002866** Subsequent calls to sqlite3pager_dont_rollback() for the same page
drh8e298f92002-07-06 16:28:47 +00002867** will thereafter be ignored. This is necessary to avoid a problem
2868** where a page with data is added to the freelist during one part of
2869** a transaction then removed from the freelist during a later part
2870** of the same transaction and reused for some other purpose. When it
2871** is first added to the freelist, this routine is called. When reused,
2872** the dont_rollback() routine is called. But because the page contains
2873** critical data, we still need to be sure it gets rolled back in spite
2874** of the dont_rollback() call.
drh30e58752002-03-02 20:41:57 +00002875*/
drh3aac2dd2004-04-26 14:10:20 +00002876void sqlite3pager_dont_write(Pager *pPager, Pgno pgno){
drh30e58752002-03-02 20:41:57 +00002877 PgHdr *pPg;
drh8e298f92002-07-06 16:28:47 +00002878
drhb7f91642004-10-31 02:22:47 +00002879 if( MEMDB ) return;
danielk1977eac7a362004-06-16 07:45:24 +00002880
drh30e58752002-03-02 20:41:57 +00002881 pPg = pager_lookup(pPager, pgno);
drh8e298f92002-07-06 16:28:47 +00002882 pPg->alwaysRollback = 1;
drh30e58752002-03-02 20:41:57 +00002883 if( pPg && pPg->dirty ){
drh8124a302002-06-25 14:43:57 +00002884 if( pPager->dbSize==(int)pPg->pgno && pPager->origDbSize<pPager->dbSize ){
2885 /* If this pages is the last page in the file and the file has grown
2886 ** during the current transaction, then do NOT mark the page as clean.
2887 ** When the database file grows, we must make sure that the last page
2888 ** gets written at least once so that the disk file will be the correct
2889 ** size. If you do not write this page and the size of the file
2890 ** on the disk ends up being too small, that can lead to database
2891 ** corruption during the next transaction.
2892 */
2893 }else{
danielk1977ef73ee92004-11-06 12:26:07 +00002894 TRACE3("DONT_WRITE page %d of %d\n", pgno, PAGERID(pPager));
drh8124a302002-06-25 14:43:57 +00002895 pPg->dirty = 0;
danielk19773c407372005-02-15 02:54:14 +00002896#ifdef SQLITE_CHECK_PAGES
2897 pPg->pageHash = pager_pagehash(pPg);
2898#endif
drh8124a302002-06-25 14:43:57 +00002899 }
drh30e58752002-03-02 20:41:57 +00002900 }
2901}
2902
2903/*
2904** A call to this routine tells the pager that if a rollback occurs,
2905** it is not necessary to restore the data on the given page. This
2906** means that the pager does not have to record the given page in the
2907** rollback journal.
2908*/
drh3aac2dd2004-04-26 14:10:20 +00002909void sqlite3pager_dont_rollback(void *pData){
drh30e58752002-03-02 20:41:57 +00002910 PgHdr *pPg = DATA_TO_PGHDR(pData);
2911 Pager *pPager = pPg->pPager;
2912
drha6abd042004-06-09 17:37:22 +00002913 if( pPager->state!=PAGER_EXCLUSIVE || pPager->journalOpen==0 ) return;
drhb7f91642004-10-31 02:22:47 +00002914 if( pPg->alwaysRollback || pPager->alwaysRollback || MEMDB ) return;
drh30e58752002-03-02 20:41:57 +00002915 if( !pPg->inJournal && (int)pPg->pgno <= pPager->origDbSize ){
2916 assert( pPager->aInJournal!=0 );
2917 pPager->aInJournal[pPg->pgno/8] |= 1<<(pPg->pgno&7);
2918 pPg->inJournal = 1;
drhac69b052004-05-12 13:30:07 +00002919 if( pPager->stmtInUse ){
2920 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drh3aac2dd2004-04-26 14:10:20 +00002921 page_add_to_stmt_list(pPg);
drh30e58752002-03-02 20:41:57 +00002922 }
danielk1977ef73ee92004-11-06 12:26:07 +00002923 TRACE3("DONT_ROLLBACK page %d of %d\n", pPg->pgno, PAGERID(pPager));
drh30e58752002-03-02 20:41:57 +00002924 }
drhac69b052004-05-12 13:30:07 +00002925 if( pPager->stmtInUse && !pPg->inStmt && (int)pPg->pgno<=pPager->stmtSize ){
drh30e58752002-03-02 20:41:57 +00002926 assert( pPg->inJournal || (int)pPg->pgno>pPager->origDbSize );
drhac69b052004-05-12 13:30:07 +00002927 assert( pPager->aInStmt!=0 );
2928 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drh3aac2dd2004-04-26 14:10:20 +00002929 page_add_to_stmt_list(pPg);
drh30e58752002-03-02 20:41:57 +00002930 }
2931}
2932
drhac69b052004-05-12 13:30:07 +00002933
danielk197793758c82005-01-21 08:13:14 +00002934#ifndef SQLITE_OMIT_MEMORYDB
drhac69b052004-05-12 13:30:07 +00002935/*
2936** Clear a PgHistory block
2937*/
2938static void clearHistory(PgHistory *pHist){
2939 sqliteFree(pHist->pOrig);
2940 sqliteFree(pHist->pStmt);
2941 pHist->pOrig = 0;
2942 pHist->pStmt = 0;
2943}
danielk197793758c82005-01-21 08:13:14 +00002944#else
2945#define clearHistory(x)
2946#endif
drhac69b052004-05-12 13:30:07 +00002947
drh30e58752002-03-02 20:41:57 +00002948/*
drhed7c8552001-04-11 14:29:21 +00002949** Commit all changes to the database and release the write lock.
drhd9b02572001-04-15 00:37:09 +00002950**
2951** If the commit fails for any reason, a rollback attempt is made
2952** and an error code is returned. If the commit worked, SQLITE_OK
2953** is returned.
drhed7c8552001-04-11 14:29:21 +00002954*/
drh3aac2dd2004-04-26 14:10:20 +00002955int sqlite3pager_commit(Pager *pPager){
drha1b351a2001-09-14 16:42:12 +00002956 int rc;
drhed7c8552001-04-11 14:29:21 +00002957 PgHdr *pPg;
drhd9b02572001-04-15 00:37:09 +00002958
2959 if( pPager->errMask==PAGER_ERR_FULL ){
drh3aac2dd2004-04-26 14:10:20 +00002960 rc = sqlite3pager_rollback(pPager);
drh4e371ee2002-09-05 16:08:27 +00002961 if( rc==SQLITE_OK ){
2962 rc = SQLITE_FULL;
2963 }
drhd9b02572001-04-15 00:37:09 +00002964 return rc;
2965 }
2966 if( pPager->errMask!=0 ){
2967 rc = pager_errcode(pPager);
2968 return rc;
2969 }
drha6abd042004-06-09 17:37:22 +00002970 if( pPager->state<PAGER_RESERVED ){
drhd9b02572001-04-15 00:37:09 +00002971 return SQLITE_ERROR;
2972 }
danielk1977ef73ee92004-11-06 12:26:07 +00002973 TRACE2("COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00002974 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00002975 pPg = pager_get_all_dirty_pages(pPager);
2976 while( pPg ){
2977 clearHistory(PGHDR_TO_HIST(pPg, pPager));
2978 pPg->dirty = 0;
2979 pPg->inJournal = 0;
2980 pPg->inStmt = 0;
2981 pPg->pPrevStmt = pPg->pNextStmt = 0;
2982 pPg = pPg->pDirty;
2983 }
danielk1977eac7a362004-06-16 07:45:24 +00002984#ifndef NDEBUG
2985 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2986 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
2987 assert( !pPg->alwaysRollback );
2988 assert( !pHist->pOrig );
2989 assert( !pHist->pStmt );
2990 }
2991#endif
drhac69b052004-05-12 13:30:07 +00002992 pPager->pStmt = 0;
drha6abd042004-06-09 17:37:22 +00002993 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00002994 return SQLITE_OK;
2995 }
drha6abd042004-06-09 17:37:22 +00002996 if( pPager->dirtyCache==0 ){
danielk19774adee202004-05-08 08:23:19 +00002997 /* Exit early (without doing the time-consuming sqlite3OsSync() calls)
drha1680452002-04-18 01:56:57 +00002998 ** if there have been no changes to the database file. */
drh341eae82003-01-21 02:39:36 +00002999 assert( pPager->needSync==0 );
drha1680452002-04-18 01:56:57 +00003000 rc = pager_unwritelock(pPager);
3001 pPager->dbSize = -1;
3002 return rc;
3003 }
drhda47d772002-12-02 04:25:19 +00003004 assert( pPager->journalOpen );
danielk1977d761c0c2004-11-05 16:37:02 +00003005 rc = sqlite3pager_sync(pPager, 0, 0);
drha6abd042004-06-09 17:37:22 +00003006 if( rc!=SQLITE_OK ){
3007 goto commit_abort;
3008 }
drhd9b02572001-04-15 00:37:09 +00003009 rc = pager_unwritelock(pPager);
3010 pPager->dbSize = -1;
3011 return rc;
3012
3013 /* Jump here if anything goes wrong during the commit process.
3014 */
3015commit_abort:
drh92f02c32004-09-02 14:57:08 +00003016 sqlite3pager_rollback(pPager);
drhed7c8552001-04-11 14:29:21 +00003017 return rc;
3018}
3019
3020/*
drha6abd042004-06-09 17:37:22 +00003021** Rollback all changes. The database falls back to PAGER_SHARED mode.
drhed7c8552001-04-11 14:29:21 +00003022** All in-memory cache pages revert to their original data contents.
3023** The journal is deleted.
drhd9b02572001-04-15 00:37:09 +00003024**
3025** This routine cannot fail unless some other process is not following
3026** the correct locking protocol (SQLITE_PROTOCOL) or unless some other
3027** process is writing trash into the journal file (SQLITE_CORRUPT) or
3028** unless a prior malloc() failed (SQLITE_NOMEM). Appropriate error
3029** codes are returned for all these occasions. Otherwise,
3030** SQLITE_OK is returned.
drhed7c8552001-04-11 14:29:21 +00003031*/
drh3aac2dd2004-04-26 14:10:20 +00003032int sqlite3pager_rollback(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +00003033 int rc;
danielk1977ef73ee92004-11-06 12:26:07 +00003034 TRACE2("ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003035 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00003036 PgHdr *p;
3037 for(p=pPager->pAll; p; p=p->pNextAll){
3038 PgHistory *pHist;
danielk1977eac7a362004-06-16 07:45:24 +00003039 assert( !p->alwaysRollback );
3040 if( !p->dirty ){
3041 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pOrig );
3042 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pStmt );
3043 continue;
3044 }
3045
drhac69b052004-05-12 13:30:07 +00003046 pHist = PGHDR_TO_HIST(p, pPager);
3047 if( pHist->pOrig ){
3048 memcpy(PGHDR_TO_DATA(p), pHist->pOrig, pPager->pageSize);
danielk1977ef73ee92004-11-06 12:26:07 +00003049 TRACE3("ROLLBACK-PAGE %d of %d\n", p->pgno, PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00003050 }else{
danielk1977ef73ee92004-11-06 12:26:07 +00003051 TRACE3("PAGE %d is clean on %d\n", p->pgno, PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00003052 }
3053 clearHistory(pHist);
3054 p->dirty = 0;
3055 p->inJournal = 0;
3056 p->inStmt = 0;
3057 p->pPrevStmt = p->pNextStmt = 0;
danielk1977369f27e2004-06-15 11:40:04 +00003058
3059 if( pPager->xReiniter ){
3060 pPager->xReiniter(PGHDR_TO_DATA(p), pPager->pageSize);
3061 }
3062
drhac69b052004-05-12 13:30:07 +00003063 }
3064 pPager->pStmt = 0;
3065 pPager->dbSize = pPager->origDbSize;
3066 memoryTruncate(pPager);
3067 pPager->stmtInUse = 0;
drha6abd042004-06-09 17:37:22 +00003068 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00003069 return SQLITE_OK;
3070 }
3071
drha6abd042004-06-09 17:37:22 +00003072 if( !pPager->dirtyCache || !pPager->journalOpen ){
drhda47d772002-12-02 04:25:19 +00003073 rc = pager_unwritelock(pPager);
3074 pPager->dbSize = -1;
3075 return rc;
3076 }
drhdb48ee02003-01-16 13:42:43 +00003077
drhd9b02572001-04-15 00:37:09 +00003078 if( pPager->errMask!=0 && pPager->errMask!=PAGER_ERR_FULL ){
drha6abd042004-06-09 17:37:22 +00003079 if( pPager->state>=PAGER_EXCLUSIVE ){
danielk197776572402004-06-25 02:38:54 +00003080 pager_playback(pPager);
drh4b845d72002-03-05 12:41:19 +00003081 }
drhd9b02572001-04-15 00:37:09 +00003082 return pager_errcode(pPager);
drhed7c8552001-04-11 14:29:21 +00003083 }
drha6abd042004-06-09 17:37:22 +00003084 if( pPager->state==PAGER_RESERVED ){
danielk197717221812005-02-15 03:38:05 +00003085 int rc2;
drha6abd042004-06-09 17:37:22 +00003086 rc = pager_reload_cache(pPager);
danielk197717221812005-02-15 03:38:05 +00003087 rc2 = pager_unwritelock(pPager);
drha6abd042004-06-09 17:37:22 +00003088 if( rc==SQLITE_OK ){
3089 rc = rc2;
3090 }
3091 }else{
danielk197776572402004-06-25 02:38:54 +00003092 rc = pager_playback(pPager);
drhd9b02572001-04-15 00:37:09 +00003093 }
drhd9b02572001-04-15 00:37:09 +00003094 if( rc!=SQLITE_OK ){
drhee696e22004-08-30 16:52:17 +00003095 rc = SQLITE_CORRUPT; /* bkpt-CORRUPT */
drhd9b02572001-04-15 00:37:09 +00003096 pPager->errMask |= PAGER_ERR_CORRUPT;
3097 }
3098 pPager->dbSize = -1;
drhed7c8552001-04-11 14:29:21 +00003099 return rc;
drh98808ba2001-10-18 12:34:46 +00003100}
drhd9b02572001-04-15 00:37:09 +00003101
3102/*
drh5e00f6c2001-09-13 13:46:56 +00003103** Return TRUE if the database file is opened read-only. Return FALSE
3104** if the database is (in theory) writable.
3105*/
drh3aac2dd2004-04-26 14:10:20 +00003106int sqlite3pager_isreadonly(Pager *pPager){
drhbe0072d2001-09-13 14:46:09 +00003107 return pPager->readOnly;
drh5e00f6c2001-09-13 13:46:56 +00003108}
3109
3110/*
drhd9b02572001-04-15 00:37:09 +00003111** This routine is used for testing and analysis only.
3112*/
drh3aac2dd2004-04-26 14:10:20 +00003113int *sqlite3pager_stats(Pager *pPager){
danielk197742741be2005-01-08 12:42:39 +00003114 static int a[11];
drhd9b02572001-04-15 00:37:09 +00003115 a[0] = pPager->nRef;
3116 a[1] = pPager->nPage;
3117 a[2] = pPager->mxPage;
3118 a[3] = pPager->dbSize;
3119 a[4] = pPager->state;
3120 a[5] = pPager->errMask;
3121 a[6] = pPager->nHit;
3122 a[7] = pPager->nMiss;
3123 a[8] = pPager->nOvfl;
danielk197742741be2005-01-08 12:42:39 +00003124 a[9] = pPager->nRead;
3125 a[10] = pPager->nWrite;
drhd9b02572001-04-15 00:37:09 +00003126 return a;
3127}
drhdd793422001-06-28 01:54:48 +00003128
drhfa86c412002-02-02 15:01:15 +00003129/*
drhac69b052004-05-12 13:30:07 +00003130** Set the statement rollback point.
drhfa86c412002-02-02 15:01:15 +00003131**
3132** This routine should be called with the transaction journal already
drhac69b052004-05-12 13:30:07 +00003133** open. A new statement journal is created that can be used to rollback
drhaaab5722002-02-19 13:39:21 +00003134** changes of a single SQL command within a larger transaction.
drhfa86c412002-02-02 15:01:15 +00003135*/
drh3aac2dd2004-04-26 14:10:20 +00003136int sqlite3pager_stmt_begin(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00003137 int rc;
3138 char zTemp[SQLITE_TEMPNAME_SIZE];
drhac69b052004-05-12 13:30:07 +00003139 assert( !pPager->stmtInUse );
drhdc3ff9c2004-08-18 02:10:15 +00003140 assert( pPager->dbSize>=0 );
danielk1977ef73ee92004-11-06 12:26:07 +00003141 TRACE2("STMT-BEGIN %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003142 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00003143 pPager->stmtInUse = 1;
3144 pPager->stmtSize = pPager->dbSize;
3145 return SQLITE_OK;
3146 }
drhda47d772002-12-02 04:25:19 +00003147 if( !pPager->journalOpen ){
drhac69b052004-05-12 13:30:07 +00003148 pPager->stmtAutoopen = 1;
drhda47d772002-12-02 04:25:19 +00003149 return SQLITE_OK;
3150 }
drhfa86c412002-02-02 15:01:15 +00003151 assert( pPager->journalOpen );
drhac69b052004-05-12 13:30:07 +00003152 pPager->aInStmt = sqliteMalloc( pPager->dbSize/8 + 1 );
3153 if( pPager->aInStmt==0 ){
danielk19779eed5052004-06-04 10:38:30 +00003154 sqlite3OsLock(&pPager->fd, SHARED_LOCK);
drhfa86c412002-02-02 15:01:15 +00003155 return SQLITE_NOMEM;
3156 }
drh968af522003-02-11 14:55:40 +00003157#ifndef NDEBUG
drhac69b052004-05-12 13:30:07 +00003158 rc = sqlite3OsFileSize(&pPager->jfd, &pPager->stmtJSize);
3159 if( rc ) goto stmt_begin_failed;
danielk197776572402004-06-25 02:38:54 +00003160 assert( pPager->stmtJSize == pPager->journalOff );
drh968af522003-02-11 14:55:40 +00003161#endif
danielk197776572402004-06-25 02:38:54 +00003162 pPager->stmtJSize = pPager->journalOff;
drhac69b052004-05-12 13:30:07 +00003163 pPager->stmtSize = pPager->dbSize;
danielk197776572402004-06-25 02:38:54 +00003164 pPager->stmtHdrOff = 0;
danielk197775edc162004-06-26 01:48:18 +00003165 pPager->stmtCksum = pPager->cksumInit;
drhac69b052004-05-12 13:30:07 +00003166 if( !pPager->stmtOpen ){
3167 rc = sqlite3pager_opentemp(zTemp, &pPager->stfd);
3168 if( rc ) goto stmt_begin_failed;
3169 pPager->stmtOpen = 1;
3170 pPager->stmtNRec = 0;
drh0f892532002-05-30 12:27:03 +00003171 }
drhac69b052004-05-12 13:30:07 +00003172 pPager->stmtInUse = 1;
drhfa86c412002-02-02 15:01:15 +00003173 return SQLITE_OK;
3174
drhac69b052004-05-12 13:30:07 +00003175stmt_begin_failed:
3176 if( pPager->aInStmt ){
3177 sqliteFree(pPager->aInStmt);
3178 pPager->aInStmt = 0;
drhfa86c412002-02-02 15:01:15 +00003179 }
3180 return rc;
3181}
3182
3183/*
drhac69b052004-05-12 13:30:07 +00003184** Commit a statement.
drhfa86c412002-02-02 15:01:15 +00003185*/
drh3aac2dd2004-04-26 14:10:20 +00003186int sqlite3pager_stmt_commit(Pager *pPager){
drhac69b052004-05-12 13:30:07 +00003187 if( pPager->stmtInUse ){
drh03eb96a2002-11-10 23:32:56 +00003188 PgHdr *pPg, *pNext;
danielk1977ef73ee92004-11-06 12:26:07 +00003189 TRACE2("STMT-COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003190 if( !MEMDB ){
drhac69b052004-05-12 13:30:07 +00003191 sqlite3OsSeek(&pPager->stfd, 0);
3192 /* sqlite3OsTruncate(&pPager->stfd, 0); */
3193 sqliteFree( pPager->aInStmt );
3194 pPager->aInStmt = 0;
drh663fc632002-02-02 18:49:19 +00003195 }
drhac69b052004-05-12 13:30:07 +00003196 for(pPg=pPager->pStmt; pPg; pPg=pNext){
3197 pNext = pPg->pNextStmt;
3198 assert( pPg->inStmt );
3199 pPg->inStmt = 0;
3200 pPg->pPrevStmt = pPg->pNextStmt = 0;
drhb7f91642004-10-31 02:22:47 +00003201 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00003202 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
3203 sqliteFree(pHist->pStmt);
3204 pHist->pStmt = 0;
3205 }
3206 }
3207 pPager->stmtNRec = 0;
3208 pPager->stmtInUse = 0;
3209 pPager->pStmt = 0;
drh663fc632002-02-02 18:49:19 +00003210 }
drhac69b052004-05-12 13:30:07 +00003211 pPager->stmtAutoopen = 0;
drhfa86c412002-02-02 15:01:15 +00003212 return SQLITE_OK;
3213}
3214
3215/*
drhac69b052004-05-12 13:30:07 +00003216** Rollback a statement.
drhfa86c412002-02-02 15:01:15 +00003217*/
drh3aac2dd2004-04-26 14:10:20 +00003218int sqlite3pager_stmt_rollback(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00003219 int rc;
drhac69b052004-05-12 13:30:07 +00003220 if( pPager->stmtInUse ){
danielk1977ef73ee92004-11-06 12:26:07 +00003221 TRACE2("STMT-ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003222 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00003223 PgHdr *pPg;
3224 for(pPg=pPager->pStmt; pPg; pPg=pPg->pNextStmt){
3225 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
3226 if( pHist->pStmt ){
3227 memcpy(PGHDR_TO_DATA(pPg), pHist->pStmt, pPager->pageSize);
3228 sqliteFree(pHist->pStmt);
3229 pHist->pStmt = 0;
3230 }
3231 }
3232 pPager->dbSize = pPager->stmtSize;
3233 memoryTruncate(pPager);
3234 rc = SQLITE_OK;
3235 }else{
3236 rc = pager_stmt_playback(pPager);
3237 }
drh3aac2dd2004-04-26 14:10:20 +00003238 sqlite3pager_stmt_commit(pPager);
drh663fc632002-02-02 18:49:19 +00003239 }else{
3240 rc = SQLITE_OK;
3241 }
drhac69b052004-05-12 13:30:07 +00003242 pPager->stmtAutoopen = 0;
drhfa86c412002-02-02 15:01:15 +00003243 return rc;
3244}
3245
drh73509ee2003-04-06 20:44:45 +00003246/*
3247** Return the full pathname of the database file.
3248*/
drh3aac2dd2004-04-26 14:10:20 +00003249const char *sqlite3pager_filename(Pager *pPager){
drh73509ee2003-04-06 20:44:45 +00003250 return pPager->zFilename;
3251}
3252
drhb20ea9d2004-02-09 01:20:36 +00003253/*
danielk19775865e3d2004-06-14 06:03:57 +00003254** Return the directory of the database file.
3255*/
3256const char *sqlite3pager_dirname(Pager *pPager){
3257 return pPager->zDirectory;
3258}
3259
3260/*
3261** Return the full pathname of the journal file.
3262*/
3263const char *sqlite3pager_journalname(Pager *pPager){
3264 return pPager->zJournal;
3265}
3266
3267/*
drhb20ea9d2004-02-09 01:20:36 +00003268** Set the codec for this pager
3269*/
drh3aac2dd2004-04-26 14:10:20 +00003270void sqlite3pager_set_codec(
drhb20ea9d2004-02-09 01:20:36 +00003271 Pager *pPager,
drh9eb9e262004-02-11 02:18:05 +00003272 void (*xCodec)(void*,void*,Pgno,int),
drhb20ea9d2004-02-09 01:20:36 +00003273 void *pCodecArg
3274){
3275 pPager->xCodec = xCodec;
3276 pPager->pCodecArg = pCodecArg;
3277}
3278
danielk197713adf8a2004-06-03 16:08:41 +00003279/*
danielk1977aa5ccdf2004-06-14 05:10:42 +00003280** This routine is called to increment the database file change-counter,
3281** stored at byte 24 of the pager file.
3282*/
3283static int pager_incr_changecounter(Pager *pPager){
3284 void *pPage;
3285 PgHdr *pPgHdr;
3286 u32 change_counter;
3287 int rc;
3288
3289 /* Open page 1 of the file for writing. */
3290 rc = sqlite3pager_get(pPager, 1, &pPage);
3291 if( rc!=SQLITE_OK ) return rc;
3292 rc = sqlite3pager_write(pPage);
3293 if( rc!=SQLITE_OK ) return rc;
3294
3295 /* Read the current value at byte 24. */
3296 pPgHdr = DATA_TO_PGHDR(pPage);
3297 change_counter = retrieve32bits(pPgHdr, 24);
3298
3299 /* Increment the value just read and write it back to byte 24. */
3300 change_counter++;
3301 store32bits(change_counter, pPgHdr, 24);
3302
3303 /* Release the page reference. */
3304 sqlite3pager_unref(pPage);
3305 return SQLITE_OK;
3306}
3307
3308/*
danielk197713adf8a2004-06-03 16:08:41 +00003309** Sync the database file for the pager pPager. zMaster points to the name
3310** of a master journal file that should be written into the individual
3311** journal file. zMaster may be NULL, which is interpreted as no master
3312** journal (a single database transaction).
3313**
3314** This routine ensures that the journal is synced, all dirty pages written
3315** to the database file and the database file synced. The only thing that
3316** remains to commit the transaction is to delete the journal file (or
3317** master journal file if specified).
3318**
3319** Note that if zMaster==NULL, this does not overwrite a previous value
3320** passed to an sqlite3pager_sync() call.
danielk1977d761c0c2004-11-05 16:37:02 +00003321**
3322** If parameter nTrunc is non-zero, then the pager file is truncated to
3323** nTrunc pages (this is used by auto-vacuum databases).
danielk197713adf8a2004-06-03 16:08:41 +00003324*/
danielk1977d761c0c2004-11-05 16:37:02 +00003325int sqlite3pager_sync(Pager *pPager, const char *zMaster, Pgno nTrunc){
danielk197713adf8a2004-06-03 16:08:41 +00003326 int rc = SQLITE_OK;
3327
danielk1977ef73ee92004-11-06 12:26:07 +00003328 TRACE4("DATABASE SYNC: File=%s zMaster=%s nTrunc=%d\n",
3329 pPager->zFilename, zMaster, nTrunc);
3330
danielk1977aa5ccdf2004-06-14 05:10:42 +00003331 /* If this is an in-memory db, or no pages have been written to, or this
3332 ** function has already been called, it is a no-op.
danielk197713adf8a2004-06-03 16:08:41 +00003333 */
drhb7f91642004-10-31 02:22:47 +00003334 if( pPager->state!=PAGER_SYNCED && !MEMDB && pPager->dirtyCache ){
danielk197713adf8a2004-06-03 16:08:41 +00003335 PgHdr *pPg;
3336 assert( pPager->journalOpen );
3337
danielk197776572402004-06-25 02:38:54 +00003338 /* If a master journal file name has already been written to the
3339 ** journal file, then no sync is required. This happens when it is
3340 ** written, then the process fails to upgrade from a RESERVED to an
3341 ** EXCLUSIVE lock. The next time the process tries to commit the
3342 ** transaction the m-j name will have already been written.
3343 */
3344 if( !pPager->setMaster ){
3345 rc = pager_incr_changecounter(pPager);
3346 if( rc!=SQLITE_OK ) goto sync_exit;
danielk1977ef73ee92004-11-06 12:26:07 +00003347#ifndef SQLITE_OMIT_AUTOVACUUM
3348 if( nTrunc!=0 ){
3349 /* If this transaction has made the database smaller, then all pages
3350 ** being discarded by the truncation must be written to the journal
3351 ** file.
3352 */
3353 Pgno i;
3354 void *pPage;
3355 for( i=nTrunc+1; i<=pPager->origDbSize; i++ ){
3356 if( !(pPager->aInJournal[i/8] & (1<<(i&7))) ){
3357 rc = sqlite3pager_get(pPager, i, &pPage);
3358 if( rc!=SQLITE_OK ) goto sync_exit;
3359 rc = sqlite3pager_write(pPage);
3360 sqlite3pager_unref(pPage);
3361 if( rc!=SQLITE_OK ) goto sync_exit;
3362 }
3363 }
3364 }
3365#endif
danielk197776572402004-06-25 02:38:54 +00003366 rc = writeMasterJournal(pPager, zMaster);
3367 if( rc!=SQLITE_OK ) goto sync_exit;
3368 rc = syncJournal(pPager);
3369 if( rc!=SQLITE_OK ) goto sync_exit;
3370 }
danielk197713adf8a2004-06-03 16:08:41 +00003371
danielk1977d761c0c2004-11-05 16:37:02 +00003372#ifndef SQLITE_OMIT_AUTOVACUUM
3373 if( nTrunc!=0 ){
3374 rc = sqlite3pager_truncate(pPager, nTrunc);
3375 if( rc!=SQLITE_OK ) goto sync_exit;
3376 }
3377#endif
3378
danielk197713adf8a2004-06-03 16:08:41 +00003379 /* Write all dirty pages to the database file */
3380 pPg = pager_get_all_dirty_pages(pPager);
3381 rc = pager_write_pagelist(pPg);
3382 if( rc!=SQLITE_OK ) goto sync_exit;
3383
danielk1977aa5ccdf2004-06-14 05:10:42 +00003384 /* Sync the database file. */
3385 if( !pPager->noSync ){
danielk197713adf8a2004-06-03 16:08:41 +00003386 rc = sqlite3OsSync(&pPager->fd);
3387 }
danielk1977aa5ccdf2004-06-14 05:10:42 +00003388
3389 pPager->state = PAGER_SYNCED;
danielk197713adf8a2004-06-03 16:08:41 +00003390 }
3391
3392sync_exit:
3393 return rc;
3394}
3395
danielk1977687566d2004-11-02 12:56:41 +00003396#ifndef SQLITE_OMIT_AUTOVACUUM
3397/*
3398** Move the page identified by pData to location pgno in the file.
3399**
3400** There must be no references to the current page pgno. If current page
3401** pgno is not already in the rollback journal, it is not written there by
3402** by this routine. The same applies to the page pData refers to on entry to
3403** this routine.
3404**
3405** References to the page refered to by pData remain valid. Updating any
3406** meta-data associated with page pData (i.e. data stored in the nExtra bytes
3407** allocated along with the page) is the responsibility of the caller.
3408**
3409** A transaction must be active when this routine is called, however it is
3410** illegal to call this routine if a statment transaction is active.
3411*/
3412int sqlite3pager_movepage(Pager *pPager, void *pData, Pgno pgno){
3413 PgHdr *pPg = DATA_TO_PGHDR(pData);
3414 PgHdr *pPgOld;
danielk1977f5fdda82004-11-03 08:44:05 +00003415 int h;
danielk197794daf7f2004-11-08 09:26:09 +00003416 Pgno needSyncPgno = 0;
danielk1977687566d2004-11-02 12:56:41 +00003417
3418 assert( !pPager->stmtInUse );
danielk1977687566d2004-11-02 12:56:41 +00003419 assert( pPg->nRef>0 );
3420
danielk1977599fcba2004-11-08 07:13:13 +00003421 TRACE5("MOVE %d page %d (needSync=%d) moves to %d\n",
3422 PAGERID(pPager), pPg->pgno, pPg->needSync, pgno);
danielk1977ef73ee92004-11-06 12:26:07 +00003423
danielk197794daf7f2004-11-08 09:26:09 +00003424 if( pPg->needSync ){
3425 needSyncPgno = pPg->pgno;
3426 assert( pPg->inJournal );
3427 assert( pPg->dirty );
danielk1977ae825582004-11-23 09:06:55 +00003428 assert( pPager->needSync );
danielk197794daf7f2004-11-08 09:26:09 +00003429 }
3430
danielk1977687566d2004-11-02 12:56:41 +00003431 /* Unlink pPg from it's hash-chain */
danielk1977f5fdda82004-11-03 08:44:05 +00003432 unlinkHashChain(pPager, pPg);
danielk1977687566d2004-11-02 12:56:41 +00003433
danielk1977ef73ee92004-11-06 12:26:07 +00003434 /* If the cache contains a page with page-number pgno, remove it
danielk1977599fcba2004-11-08 07:13:13 +00003435 ** from it's hash chain. Also, if the PgHdr.needSync was set for
3436 ** page pgno before the 'move' operation, it needs to be retained
3437 ** for the page moved there.
danielk1977f5fdda82004-11-03 08:44:05 +00003438 */
danielk1977687566d2004-11-02 12:56:41 +00003439 pPgOld = pager_lookup(pPager, pgno);
3440 if( pPgOld ){
danielk1977f5fdda82004-11-03 08:44:05 +00003441 assert( pPgOld->nRef==0 );
3442 unlinkHashChain(pPager, pPgOld);
3443 pPgOld->dirty = 0;
danielk1977ef73ee92004-11-06 12:26:07 +00003444 if( pPgOld->needSync ){
danielk197745901d62004-11-10 15:27:38 +00003445 assert( pPgOld->inJournal );
3446 pPg->inJournal = 1;
danielk1977ef73ee92004-11-06 12:26:07 +00003447 pPg->needSync = 1;
danielk1977ae825582004-11-23 09:06:55 +00003448 assert( pPager->needSync );
danielk1977ef73ee92004-11-06 12:26:07 +00003449 }
danielk1977687566d2004-11-02 12:56:41 +00003450 }
3451
danielk1977f5fdda82004-11-03 08:44:05 +00003452 /* Change the page number for pPg and insert it into the new hash-chain. */
3453 pPg->pgno = pgno;
3454 h = pager_hash(pgno);
3455 if( pPager->aHash[h] ){
3456 assert( pPager->aHash[h]->pPrevHash==0 );
3457 pPager->aHash[h]->pPrevHash = pPg;
3458 }
3459 pPg->pNextHash = pPager->aHash[h];
3460 pPager->aHash[h] = pPg;
3461 pPg->pPrevHash = 0;
3462
danielk1977687566d2004-11-02 12:56:41 +00003463 pPg->dirty = 1;
3464 pPager->dirtyCache = 1;
3465
danielk197794daf7f2004-11-08 09:26:09 +00003466 if( needSyncPgno ){
3467 /* If needSyncPgno is non-zero, then the journal file needs to be
3468 ** sync()ed before any data is written to database file page needSyncPgno.
3469 ** Currently, no such page exists in the page-cache and the
3470 ** Pager.aInJournal bit has been set. This needs to be remedied by loading
3471 ** the page into the pager-cache and setting the PgHdr.needSync flag.
danielk1977ae825582004-11-23 09:06:55 +00003472 **
3473 ** The sqlite3pager_get() call may cause the journal to sync. So make
3474 ** sure the Pager.needSync flag is set too.
danielk197794daf7f2004-11-08 09:26:09 +00003475 */
3476 int rc;
3477 void *pNeedSync;
danielk1977ae825582004-11-23 09:06:55 +00003478 assert( pPager->needSync );
danielk197794daf7f2004-11-08 09:26:09 +00003479 rc = sqlite3pager_get(pPager, needSyncPgno, &pNeedSync);
3480 if( rc!=SQLITE_OK ) return rc;
danielk1977ae825582004-11-23 09:06:55 +00003481 pPager->needSync = 1;
danielk197794daf7f2004-11-08 09:26:09 +00003482 DATA_TO_PGHDR(pNeedSync)->needSync = 1;
3483 DATA_TO_PGHDR(pNeedSync)->inJournal = 1;
3484 DATA_TO_PGHDR(pNeedSync)->dirty = 1;
3485 sqlite3pager_unref(pNeedSync);
3486 }
3487
danielk1977687566d2004-11-02 12:56:41 +00003488 return SQLITE_OK;
3489}
3490#endif
3491
dougcurrie81c95ef2004-06-18 23:21:47 +00003492#if defined(SQLITE_DEBUG) || defined(SQLITE_TEST)
drh89ac8c12004-06-09 14:17:20 +00003493/*
3494** Return the current state of the file lock for the given pager.
3495** The return value is one of NO_LOCK, SHARED_LOCK, RESERVED_LOCK,
3496** PENDING_LOCK, or EXCLUSIVE_LOCK.
3497*/
3498int sqlite3pager_lockstate(Pager *pPager){
danielk1977e3026632004-06-22 11:29:02 +00003499#ifdef OS_TEST
danielk19778a6c5502004-06-22 12:18:32 +00003500 return pPager->fd->fd.locktype;
danielk1977e3026632004-06-22 11:29:02 +00003501#else
drh89ac8c12004-06-09 14:17:20 +00003502 return pPager->fd.locktype;
danielk1977e3026632004-06-22 11:29:02 +00003503#endif
drh89ac8c12004-06-09 14:17:20 +00003504}
3505#endif
3506
danielk197793758c82005-01-21 08:13:14 +00003507#ifdef SQLITE_DEBUG
drhdd793422001-06-28 01:54:48 +00003508/*
3509** Print a listing of all referenced pages and their ref count.
3510*/
drh3aac2dd2004-04-26 14:10:20 +00003511void sqlite3pager_refdump(Pager *pPager){
drhdd793422001-06-28 01:54:48 +00003512 PgHdr *pPg;
3513 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
3514 if( pPg->nRef<=0 ) continue;
drhfe63d1c2004-09-08 20:13:04 +00003515 sqlite3DebugPrintf("PAGE %3d addr=%p nRef=%d\n",
3516 pPg->pgno, PGHDR_TO_DATA(pPg), pPg->nRef);
drhdd793422001-06-28 01:54:48 +00003517 }
3518}
3519#endif