blob: 53c2b84143d35bba74fe7915055241286644aa3a [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**
drh7bec5052005-02-06 02:45:41 +000021** @(#) $Id: pager.c,v 1.188 2005/02/06 02:45:42 drh 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 */
drh887dc4c2004-10-22 16:22:57 +0000171 /* pPager->psAligned bytes of page data follow this header */
drh973b6e32003-02-12 14:09:42 +0000172 /* Pager.nExtra bytes of local data follow the page data */
drhed7c8552001-04-11 14:29:21 +0000173};
174
drhac69b052004-05-12 13:30:07 +0000175/*
176** For an in-memory only database, some extra information is recorded about
177** each page so that changes can be rolled back. (Journal files are not
178** used for in-memory databases.) The following information is added to
179** the end of every EXTRA block for in-memory databases.
180**
181** This information could have been added directly to the PgHdr structure.
182** But then it would take up an extra 8 bytes of storage on every PgHdr
183** even for disk-based databases. Splitting it out saves 8 bytes. This
184** is only a savings of 0.8% but those percentages add up.
185*/
186typedef struct PgHistory PgHistory;
187struct PgHistory {
188 u8 *pOrig; /* Original page text. Restore to this on a full rollback */
189 u8 *pStmt; /* Text as it was at the beginning of the current statement */
190};
drh9eb9e262004-02-11 02:18:05 +0000191
192/*
193** A macro used for invoking the codec if there is one
194*/
195#ifdef SQLITE_HAS_CODEC
196# define CODEC(P,D,N,X) if( P->xCodec ){ P->xCodec(P->pCodecArg,D,N,X); }
197#else
198# define CODEC(P,D,N,X)
199#endif
200
drhed7c8552001-04-11 14:29:21 +0000201/*
drh69688d52001-04-14 16:38:23 +0000202** Convert a pointer to a PgHdr into a pointer to its data
203** and back again.
drhed7c8552001-04-11 14:29:21 +0000204*/
205#define PGHDR_TO_DATA(P) ((void*)(&(P)[1]))
206#define DATA_TO_PGHDR(D) (&((PgHdr*)(D))[-1])
drh887dc4c2004-10-22 16:22:57 +0000207#define PGHDR_TO_EXTRA(G,P) ((void*)&((char*)(&(G)[1]))[(P)->psAligned])
drhac69b052004-05-12 13:30:07 +0000208#define PGHDR_TO_HIST(P,PGR) \
drh887dc4c2004-10-22 16:22:57 +0000209 ((PgHistory*)&((char*)(&(P)[1]))[(PGR)->psAligned+(PGR)->nExtra])
drhed7c8552001-04-11 14:29:21 +0000210
211/*
drhed7c8552001-04-11 14:29:21 +0000212** How big to make the hash table used for locating in-memory pages
drh836faa42003-01-11 13:30:57 +0000213** by page number.
drhed7c8552001-04-11 14:29:21 +0000214*/
drh836faa42003-01-11 13:30:57 +0000215#define N_PG_HASH 2048
216
217/*
218** Hash a page number
219*/
220#define pager_hash(PN) ((PN)&(N_PG_HASH-1))
drhed7c8552001-04-11 14:29:21 +0000221
222/*
223** A open page cache is an instance of the following structure.
224*/
225struct Pager {
226 char *zFilename; /* Name of the database file */
227 char *zJournal; /* Name of the journal file */
drha76c82e2003-07-27 18:59:42 +0000228 char *zDirectory; /* Directory hold database and journal files */
drh8cfbf082001-09-19 13:22:39 +0000229 OsFile fd, jfd; /* File descriptors for database and journal */
drhac69b052004-05-12 13:30:07 +0000230 OsFile stfd; /* File descriptor for the statement subjournal*/
drhed7c8552001-04-11 14:29:21 +0000231 int dbSize; /* Number of pages in the file */
drh69688d52001-04-14 16:38:23 +0000232 int origDbSize; /* dbSize before the current change */
drhac69b052004-05-12 13:30:07 +0000233 int stmtSize; /* Size of database (in pages) at stmt_begin() */
drheb206252004-10-01 02:00:31 +0000234 i64 stmtJSize; /* Size of journal at stmt_begin() */
drh968af522003-02-11 14:55:40 +0000235 int nRec; /* Number of pages written to the journal */
236 u32 cksumInit; /* Quasi-random value added to every checksum */
drhac69b052004-05-12 13:30:07 +0000237 int stmtNRec; /* Number of records in stmt subjournal */
drh7e3b0a02001-04-28 16:52:40 +0000238 int nExtra; /* Add this many bytes to each in-memory page */
drhb6f41482004-05-14 01:58:11 +0000239 void (*xDestructor)(void*,int); /* Call this routine when freeing pages */
drha6abd042004-06-09 17:37:22 +0000240 void (*xReiniter)(void*,int); /* Call this routine when reloading pages */
drhb6f41482004-05-14 01:58:11 +0000241 int pageSize; /* Number of bytes in a page */
drh887dc4c2004-10-22 16:22:57 +0000242 int psAligned; /* pageSize rounded up to a multiple of 8 */
drhed7c8552001-04-11 14:29:21 +0000243 int nPage; /* Total number of in-memory pages */
drhd9b02572001-04-15 00:37:09 +0000244 int nRef; /* Number of in-memory pages with PgHdr.nRef>0 */
drhed7c8552001-04-11 14:29:21 +0000245 int mxPage; /* Maximum number of pages to hold in cache */
drhd9b02572001-04-15 00:37:09 +0000246 int nHit, nMiss, nOvfl; /* Cache hits, missing, and LRU overflows */
danielk197742741be2005-01-08 12:42:39 +0000247 int nRead,nWrite; /* Database pages read/written */
drh9eb9e262004-02-11 02:18:05 +0000248 void (*xCodec)(void*,void*,Pgno,int); /* Routine for en/decoding data */
drhb20ea9d2004-02-09 01:20:36 +0000249 void *pCodecArg; /* First argument to xCodec() */
drh603240c2002-03-05 01:11:12 +0000250 u8 journalOpen; /* True if journal file descriptors is valid */
drh34e79ce2004-02-08 06:05:46 +0000251 u8 journalStarted; /* True if header of journal is synced */
252 u8 useJournal; /* Use a rollback journal on this file */
drh7bec5052005-02-06 02:45:41 +0000253 u8 noReadlock; /* Do not bother to obtain readlocks */
drhac69b052004-05-12 13:30:07 +0000254 u8 stmtOpen; /* True if the statement subjournal is open */
255 u8 stmtInUse; /* True we are in a statement subtransaction */
256 u8 stmtAutoopen; /* Open stmt journal when main journal is opened*/
drh603240c2002-03-05 01:11:12 +0000257 u8 noSync; /* Do not sync the journal if true */
drh968af522003-02-11 14:55:40 +0000258 u8 fullSync; /* Do extra syncs of the journal for robustness */
drha6abd042004-06-09 17:37:22 +0000259 u8 state; /* PAGER_UNLOCK, _SHARED, _RESERVED, etc. */
drh603240c2002-03-05 01:11:12 +0000260 u8 errMask; /* One of several kinds of errors */
261 u8 tempFile; /* zFilename is a temporary file */
262 u8 readOnly; /* True for a read-only database */
263 u8 needSync; /* True if an fsync() is needed on the journal */
drha6abd042004-06-09 17:37:22 +0000264 u8 dirtyCache; /* True if cached pages have changed */
drh193a6b42002-07-07 16:52:46 +0000265 u8 alwaysRollback; /* Disable dont_rollback() for all pages */
drhac69b052004-05-12 13:30:07 +0000266 u8 memDb; /* True to inhibit all file I/O */
drh603240c2002-03-05 01:11:12 +0000267 u8 *aInJournal; /* One bit for each page in the database file */
drhac69b052004-05-12 13:30:07 +0000268 u8 *aInStmt; /* One bit for each page in the database */
drhfdb38062004-08-21 19:20:42 +0000269 u8 setMaster; /* True if a m-j name has been written to jrnl */
drh726de592004-06-10 23:35:50 +0000270 BusyHandler *pBusyHandler; /* Pointer to sqlite.busyHandler */
drhed7c8552001-04-11 14:29:21 +0000271 PgHdr *pFirst, *pLast; /* List of free pages */
drh341eae82003-01-21 02:39:36 +0000272 PgHdr *pFirstSynced; /* First free page with PgHdr.needSync==0 */
drhd9b02572001-04-15 00:37:09 +0000273 PgHdr *pAll; /* List of all pages */
drhac69b052004-05-12 13:30:07 +0000274 PgHdr *pStmt; /* List of pages in the statement subjournal */
drheb206252004-10-01 02:00:31 +0000275 i64 journalOff; /* Current byte offset in the journal file */
276 i64 journalHdr; /* Byte offset to previous journal header */
277 i64 stmtHdrOff; /* First journal header written this statement */
278 i64 stmtCksum; /* cksumInit when statement was started */
danielk197776572402004-06-25 02:38:54 +0000279 int sectorSize; /* Assumed sector size during rollback */
drh76ff3a02004-09-24 22:32:30 +0000280 PgHdr *aHash[N_PG_HASH]; /* Hash table to map page number to PgHdr */
drhd9b02572001-04-15 00:37:09 +0000281};
282
283/*
284** These are bits that can be set in Pager.errMask.
285*/
286#define PAGER_ERR_FULL 0x01 /* a write() failed */
287#define PAGER_ERR_MEM 0x02 /* malloc() failed */
288#define PAGER_ERR_LOCK 0x04 /* error in the locking protocol */
289#define PAGER_ERR_CORRUPT 0x08 /* database or journal corruption */
drh81a20f22001-10-12 17:30:04 +0000290#define PAGER_ERR_DISK 0x10 /* general disk I/O error - bad hard drive? */
drhd9b02572001-04-15 00:37:09 +0000291
292/*
drh5e00f6c2001-09-13 13:46:56 +0000293** Journal files begin with the following magic string. The data
294** was obtained from /dev/random. It is used only as a sanity check.
drh94f33312002-08-12 12:29:56 +0000295**
drhae2b40c2004-06-09 19:03:54 +0000296** Since version 2.8.0, the journal format contains additional sanity
297** checking information. If the power fails while the journal is begin
298** written, semi-random garbage data might appear in the journal
299** file after power is restored. If an attempt is then made
drh968af522003-02-11 14:55:40 +0000300** to roll the journal back, the database could be corrupted. The additional
301** sanity checking data is an attempt to discover the garbage in the
302** journal and ignore it.
303**
drhae2b40c2004-06-09 19:03:54 +0000304** The sanity checking information for the new journal format consists
drh968af522003-02-11 14:55:40 +0000305** of a 32-bit checksum on each page of data. The checksum covers both
drh90f5ecb2004-07-22 01:19:35 +0000306** the page number and the pPager->pageSize bytes of data for the page.
drh968af522003-02-11 14:55:40 +0000307** This cksum is initialized to a 32-bit random value that appears in the
308** journal file right after the header. The random initializer is important,
309** because garbage data that appears at the end of a journal is likely
310** data that was once in other files that have now been deleted. If the
311** garbage data came from an obsolete journal file, the checksums might
312** be correct. But by initializing the checksum to random value which
313** is different for every journal, we minimize that risk.
drhd9b02572001-04-15 00:37:09 +0000314*/
drhae2b40c2004-06-09 19:03:54 +0000315static const unsigned char aJournalMagic[] = {
316 0xd9, 0xd5, 0x05, 0xf9, 0x20, 0xa1, 0x63, 0xd7,
drhed7c8552001-04-11 14:29:21 +0000317};
318
319/*
drh726de592004-06-10 23:35:50 +0000320** The size of the header and of each page in the journal is determined
321** by the following macros.
drh968af522003-02-11 14:55:40 +0000322*/
drhae2b40c2004-06-09 19:03:54 +0000323#define JOURNAL_PG_SZ(pPager) ((pPager->pageSize) + 8)
drh968af522003-02-11 14:55:40 +0000324
danielk197776572402004-06-25 02:38:54 +0000325/*
326** The journal header size for this pager. In the future, this could be
327** set to some value read from the disk controller. The important
328** characteristic is that it is the same size as a disk sector.
329*/
330#define JOURNAL_HDR_SZ(pPager) (pPager->sectorSize)
331
drhb7f91642004-10-31 02:22:47 +0000332/*
333** The macro MEMDB is true if we are dealing with an in-memory database.
334** We do this as a macro so that if the SQLITE_OMIT_MEMORYDB macro is set,
335** the value of MEMDB will be a constant and the compiler will optimize
336** out code that would never execute.
337*/
338#ifdef SQLITE_OMIT_MEMORYDB
339# define MEMDB 0
340#else
341# define MEMDB pPager->memDb
342#endif
343
344/*
345** The default size of a disk sector
346*/
danielk197776572402004-06-25 02:38:54 +0000347#define PAGER_SECTOR_SIZE 512
348
349/*
350** Page number PAGER_MJ_PGNO is never used in an SQLite database (it is
351** reserved for working around a windows/posix incompatibility). It is
352** used in the journal to signify that the remainder of the journal file
353** is devoted to storing a master journal name - there are no more pages to
354** roll back. See comments for function writeMasterJournal() for details.
355*/
danielk1977599fcba2004-11-08 07:13:13 +0000356/* #define PAGER_MJ_PGNO(x) (PENDING_BYTE/((x)->pageSize)) */
357#define PAGER_MJ_PGNO(x) ((PENDING_BYTE/((x)->pageSize))+1)
danielk197713adf8a2004-06-03 16:08:41 +0000358
drh968af522003-02-11 14:55:40 +0000359/*
danielk197726836652005-01-17 01:33:13 +0000360** The maximum legal page number is (2^31 - 1).
361*/
362#define PAGER_MAX_PGNO 2147483647
363
364/*
drh726de592004-06-10 23:35:50 +0000365** Enable reference count tracking (for debugging) here:
drhdd793422001-06-28 01:54:48 +0000366*/
danielk1977aca790a2005-01-13 11:07:52 +0000367#ifdef SQLITE_DEBUG
drh3aac2dd2004-04-26 14:10:20 +0000368 int pager3_refinfo_enable = 0;
drhdd793422001-06-28 01:54:48 +0000369 static void pager_refinfo(PgHdr *p){
370 static int cnt = 0;
drh3aac2dd2004-04-26 14:10:20 +0000371 if( !pager3_refinfo_enable ) return;
drhfe63d1c2004-09-08 20:13:04 +0000372 sqlite3DebugPrintf(
373 "REFCNT: %4d addr=%p nRef=%d\n",
374 p->pgno, PGHDR_TO_DATA(p), p->nRef
drhdd793422001-06-28 01:54:48 +0000375 );
376 cnt++; /* Something to set a breakpoint on */
377 }
378# define REFINFO(X) pager_refinfo(X)
379#else
380# define REFINFO(X)
381#endif
382
383/*
drh34e79ce2004-02-08 06:05:46 +0000384** Read a 32-bit integer from the given file descriptor. Store the integer
385** that is read in *pRes. Return SQLITE_OK if everything worked, or an
386** error code is something goes wrong.
drh726de592004-06-10 23:35:50 +0000387**
388** All values are stored on disk as big-endian.
drh94f33312002-08-12 12:29:56 +0000389*/
drhae2b40c2004-06-09 19:03:54 +0000390static int read32bits(OsFile *fd, u32 *pRes){
drh94f33312002-08-12 12:29:56 +0000391 u32 res;
392 int rc;
danielk19774adee202004-05-08 08:23:19 +0000393 rc = sqlite3OsRead(fd, &res, sizeof(res));
drhae2b40c2004-06-09 19:03:54 +0000394 if( rc==SQLITE_OK ){
drh94f33312002-08-12 12:29:56 +0000395 unsigned char ac[4];
396 memcpy(ac, &res, 4);
397 res = (ac[0]<<24) | (ac[1]<<16) | (ac[2]<<8) | ac[3];
398 }
399 *pRes = res;
400 return rc;
401}
402
403/*
drh34e79ce2004-02-08 06:05:46 +0000404** Write a 32-bit integer into the given file descriptor. Return SQLITE_OK
405** on success or an error code is something goes wrong.
drh94f33312002-08-12 12:29:56 +0000406*/
407static int write32bits(OsFile *fd, u32 val){
408 unsigned char ac[4];
drh94f33312002-08-12 12:29:56 +0000409 ac[0] = (val>>24) & 0xff;
410 ac[1] = (val>>16) & 0xff;
411 ac[2] = (val>>8) & 0xff;
412 ac[3] = val & 0xff;
danielk19774adee202004-05-08 08:23:19 +0000413 return sqlite3OsWrite(fd, ac, 4);
drh94f33312002-08-12 12:29:56 +0000414}
415
drh2554f8b2003-01-22 01:26:44 +0000416/*
danielk1977aa5ccdf2004-06-14 05:10:42 +0000417** Write the 32-bit integer 'val' into the page identified by page header
418** 'p' at offset 'offset'.
drh2554f8b2003-01-22 01:26:44 +0000419*/
drh968af522003-02-11 14:55:40 +0000420static void store32bits(u32 val, PgHdr *p, int offset){
drh2554f8b2003-01-22 01:26:44 +0000421 unsigned char *ac;
drhec1bd0b2003-08-26 11:41:27 +0000422 ac = &((unsigned char*)PGHDR_TO_DATA(p))[offset];
drhae2b40c2004-06-09 19:03:54 +0000423 ac[0] = (val>>24) & 0xff;
424 ac[1] = (val>>16) & 0xff;
425 ac[2] = (val>>8) & 0xff;
426 ac[3] = val & 0xff;
drh2554f8b2003-01-22 01:26:44 +0000427}
428
danielk1977aa5ccdf2004-06-14 05:10:42 +0000429/*
430** Read a 32-bit integer at offset 'offset' from the page identified by
431** page header 'p'.
432*/
433static u32 retrieve32bits(PgHdr *p, int offset){
434 unsigned char *ac;
435 ac = &((unsigned char*)PGHDR_TO_DATA(p))[offset];
436 return (ac[0]<<24) | (ac[1]<<16) | (ac[2]<<8) | ac[3];
437}
438
drh94f33312002-08-12 12:29:56 +0000439
440/*
drhd9b02572001-04-15 00:37:09 +0000441** Convert the bits in the pPager->errMask into an approprate
442** return code.
443*/
444static int pager_errcode(Pager *pPager){
445 int rc = SQLITE_OK;
446 if( pPager->errMask & PAGER_ERR_LOCK ) rc = SQLITE_PROTOCOL;
drh81a20f22001-10-12 17:30:04 +0000447 if( pPager->errMask & PAGER_ERR_DISK ) rc = SQLITE_IOERR;
drhd9b02572001-04-15 00:37:09 +0000448 if( pPager->errMask & PAGER_ERR_FULL ) rc = SQLITE_FULL;
449 if( pPager->errMask & PAGER_ERR_MEM ) rc = SQLITE_NOMEM;
450 if( pPager->errMask & PAGER_ERR_CORRUPT ) rc = SQLITE_CORRUPT;
451 return rc;
drhed7c8552001-04-11 14:29:21 +0000452}
453
454/*
danielk197776572402004-06-25 02:38:54 +0000455** When this is called the journal file for pager pPager must be open.
456** The master journal file name is read from the end of the file and
457** written into memory obtained from sqliteMalloc(). *pzMaster is
458** set to point at the memory and SQLITE_OK returned. The caller must
459** sqliteFree() *pzMaster.
460**
461** If no master journal file name is present *pzMaster is set to 0 and
462** SQLITE_OK returned.
463*/
464static int readMasterJournal(OsFile *pJrnl, char **pzMaster){
465 int rc;
466 u32 len;
drheb206252004-10-01 02:00:31 +0000467 i64 szJ;
danielk1977c3e8f5e2004-06-28 01:16:46 +0000468 u32 cksum;
danielk1977cafadba2004-06-25 11:11:54 +0000469 int i;
danielk197776572402004-06-25 02:38:54 +0000470 unsigned char aMagic[8]; /* A buffer to hold the magic header */
471
472 *pzMaster = 0;
473
474 rc = sqlite3OsFileSize(pJrnl, &szJ);
danielk1977cafadba2004-06-25 11:11:54 +0000475 if( rc!=SQLITE_OK || szJ<16 ) return rc;
danielk197776572402004-06-25 02:38:54 +0000476
danielk1977cafadba2004-06-25 11:11:54 +0000477 rc = sqlite3OsSeek(pJrnl, szJ-16);
danielk197776572402004-06-25 02:38:54 +0000478 if( rc!=SQLITE_OK ) return rc;
479
480 rc = read32bits(pJrnl, &len);
481 if( rc!=SQLITE_OK ) return rc;
482
danielk1977cafadba2004-06-25 11:11:54 +0000483 rc = read32bits(pJrnl, &cksum);
484 if( rc!=SQLITE_OK ) return rc;
485
danielk197776572402004-06-25 02:38:54 +0000486 rc = sqlite3OsRead(pJrnl, aMagic, 8);
487 if( rc!=SQLITE_OK || memcmp(aMagic, aJournalMagic, 8) ) return rc;
488
danielk19778191bff2004-06-28 04:52:30 +0000489 rc = sqlite3OsSeek(pJrnl, szJ-16-len);
danielk197776572402004-06-25 02:38:54 +0000490 if( rc!=SQLITE_OK ) return rc;
491
danielk19778191bff2004-06-28 04:52:30 +0000492 *pzMaster = (char *)sqliteMalloc(len+1);
danielk197776572402004-06-25 02:38:54 +0000493 if( !*pzMaster ){
494 return SQLITE_NOMEM;
495 }
496 rc = sqlite3OsRead(pJrnl, *pzMaster, len);
497 if( rc!=SQLITE_OK ){
498 sqliteFree(*pzMaster);
499 *pzMaster = 0;
500 return rc;
501 }
danielk1977cafadba2004-06-25 11:11:54 +0000502
503 /* See if the checksum matches the master journal name */
504 for(i=0; i<len; i++){
danielk19778191bff2004-06-28 04:52:30 +0000505 cksum -= (*pzMaster)[i];
danielk1977cafadba2004-06-25 11:11:54 +0000506 }
danielk19778191bff2004-06-28 04:52:30 +0000507 if( cksum ){
508 /* If the checksum doesn't add up, then one or more of the disk sectors
509 ** containing the master journal filename is corrupted. This means
510 ** definitely roll back, so just return SQLITE_OK and report a (nul)
511 ** master-journal filename.
512 */
danielk1977cafadba2004-06-25 11:11:54 +0000513 sqliteFree(*pzMaster);
514 *pzMaster = 0;
danielk1977aca790a2005-01-13 11:07:52 +0000515 }else{
516 (*pzMaster)[len] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000517 }
danielk197776572402004-06-25 02:38:54 +0000518
519 return SQLITE_OK;
520}
521
522/*
523** Seek the journal file descriptor to the next sector boundary where a
524** journal header may be read or written. Pager.journalOff is updated with
525** the new seek offset.
526**
527** i.e for a sector size of 512:
528**
529** Input Offset Output Offset
530** ---------------------------------------
531** 0 0
532** 512 512
533** 100 512
534** 2000 2048
535**
536*/
537static int seekJournalHdr(Pager *pPager){
drheb206252004-10-01 02:00:31 +0000538 i64 offset = 0;
539 i64 c = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000540 if( c ){
541 offset = ((c-1)/JOURNAL_HDR_SZ(pPager) + 1) * JOURNAL_HDR_SZ(pPager);
542 }
543 assert( offset%JOURNAL_HDR_SZ(pPager)==0 );
544 assert( offset>=c );
545 assert( (offset-c)<JOURNAL_HDR_SZ(pPager) );
546 pPager->journalOff = offset;
547 return sqlite3OsSeek(&pPager->jfd, pPager->journalOff);
548}
549
550/*
551** The journal file must be open when this routine is called. A journal
552** header (JOURNAL_HDR_SZ bytes) is written into the journal file at the
553** current location.
554**
555** The format for the journal header is as follows:
556** - 8 bytes: Magic identifying journal format.
557** - 4 bytes: Number of records in journal, or -1 no-sync mode is on.
558** - 4 bytes: Random number used for page hash.
559** - 4 bytes: Initial database page count.
560** - 4 bytes: Sector size used by the process that wrote this journal.
561**
danielk1977f42f25c2004-06-25 07:21:28 +0000562** Followed by (JOURNAL_HDR_SZ - 24) bytes of unused space.
danielk197776572402004-06-25 02:38:54 +0000563*/
564static int writeJournalHdr(Pager *pPager){
565
566 int rc = seekJournalHdr(pPager);
567 if( rc ) return rc;
568
569 pPager->journalHdr = pPager->journalOff;
570 if( pPager->stmtHdrOff==0 ){
571 pPager->stmtHdrOff = pPager->journalHdr;
572 }
573 pPager->journalOff += JOURNAL_HDR_SZ(pPager);
574
575 /* FIX ME:
576 **
577 ** Possibly for a pager not in no-sync mode, the journal magic should not
578 ** be written until nRec is filled in as part of next syncJournal().
579 **
580 ** Actually maybe the whole journal header should be delayed until that
581 ** point. Think about this.
582 */
583 rc = sqlite3OsWrite(&pPager->jfd, aJournalMagic, sizeof(aJournalMagic));
584
585 if( rc==SQLITE_OK ){
586 /* The nRec Field. 0xFFFFFFFF for no-sync journals. */
587 rc = write32bits(&pPager->jfd, pPager->noSync ? 0xffffffff : 0);
588 }
589 if( rc==SQLITE_OK ){
590 /* The random check-hash initialiser */
591 sqlite3Randomness(sizeof(pPager->cksumInit), &pPager->cksumInit);
592 rc = write32bits(&pPager->jfd, pPager->cksumInit);
593 }
594 if( rc==SQLITE_OK ){
595 /* The initial database size */
596 rc = write32bits(&pPager->jfd, pPager->dbSize);
597 }
598 if( rc==SQLITE_OK ){
599 /* The assumed sector size for this process */
600 rc = write32bits(&pPager->jfd, pPager->sectorSize);
601 }
602
603 /* The journal header has been written successfully. Seek the journal
604 ** file descriptor to the end of the journal header sector.
605 */
606 if( rc==SQLITE_OK ){
607 sqlite3OsSeek(&pPager->jfd, pPager->journalOff-1);
608 rc = sqlite3OsWrite(&pPager->jfd, "\000", 1);
609 }
610 return rc;
611}
612
613/*
614** The journal file must be open when this is called. A journal header file
615** (JOURNAL_HDR_SZ bytes) is read from the current location in the journal
616** file. See comments above function writeJournalHdr() for a description of
617** the journal header format.
618**
619** If the header is read successfully, *nRec is set to the number of
620** page records following this header and *dbSize is set to the size of the
621** database before the transaction began, in pages. Also, pPager->cksumInit
622** is set to the value read from the journal header. SQLITE_OK is returned
623** in this case.
624**
625** If the journal header file appears to be corrupted, SQLITE_DONE is
626** returned and *nRec and *dbSize are not set. If JOURNAL_HDR_SZ bytes
627** cannot be read from the journal file an error code is returned.
628*/
629static int readJournalHdr(
630 Pager *pPager,
drheb206252004-10-01 02:00:31 +0000631 i64 journalSize,
danielk197776572402004-06-25 02:38:54 +0000632 u32 *pNRec,
633 u32 *pDbSize
634){
635 int rc;
636 unsigned char aMagic[8]; /* A buffer to hold the magic header */
637
638 rc = seekJournalHdr(pPager);
639 if( rc ) return rc;
640
641 if( pPager->journalOff+JOURNAL_HDR_SZ(pPager) > journalSize ){
642 return SQLITE_DONE;
643 }
644
645 rc = sqlite3OsRead(&pPager->jfd, aMagic, sizeof(aMagic));
646 if( rc ) return rc;
647
648 if( memcmp(aMagic, aJournalMagic, sizeof(aMagic))!=0 ){
649 return SQLITE_DONE;
650 }
651
652 rc = read32bits(&pPager->jfd, pNRec);
653 if( rc ) return rc;
654
655 rc = read32bits(&pPager->jfd, &pPager->cksumInit);
656 if( rc ) return rc;
657
658 rc = read32bits(&pPager->jfd, pDbSize);
659 if( rc ) return rc;
660
661 /* Update the assumed sector-size to match the value used by
662 ** the process that created this journal. If this journal was
663 ** created by a process other than this one, then this routine
664 ** is being called from within pager_playback(). The local value
665 ** of Pager.sectorSize is restored at the end of that routine.
666 */
danielk1977c3e8f5e2004-06-28 01:16:46 +0000667 rc = read32bits(&pPager->jfd, (u32 *)&pPager->sectorSize);
danielk197776572402004-06-25 02:38:54 +0000668 if( rc ) return rc;
669
670 pPager->journalOff += JOURNAL_HDR_SZ(pPager);
671 rc = sqlite3OsSeek(&pPager->jfd, pPager->journalOff);
672 return rc;
673}
674
675
676/*
677** Write the supplied master journal name into the journal file for pager
danielk1977cafadba2004-06-25 11:11:54 +0000678** pPager at the current location. The master journal name must be the last
679** thing written to a journal file. If the pager is in full-sync mode, the
680** journal file descriptor is advanced to the next sector boundary before
681** anything is written. The format is:
682**
683** + 4 bytes: PAGER_MJ_PGNO.
684** + N bytes: length of master journal name.
685** + 4 bytes: N
686** + 4 bytes: Master journal name checksum.
687** + 8 bytes: aJournalMagic[].
688**
689** The master journal page checksum is the sum of the bytes in the master
690** journal name.
danielk197776572402004-06-25 02:38:54 +0000691*/
692static int writeMasterJournal(Pager *pPager, const char *zMaster){
693 int rc;
694 int len;
danielk1977cafadba2004-06-25 11:11:54 +0000695 int i;
danielk1977c3e8f5e2004-06-28 01:16:46 +0000696 u32 cksum = 0;
danielk197776572402004-06-25 02:38:54 +0000697
698 if( !zMaster || pPager->setMaster) return SQLITE_OK;
699 pPager->setMaster = 1;
700
701 len = strlen(zMaster);
danielk1977cafadba2004-06-25 11:11:54 +0000702 for(i=0; i<len; i++){
703 cksum += zMaster[i];
704 }
danielk197776572402004-06-25 02:38:54 +0000705
706 /* If in full-sync mode, advance to the next disk sector before writing
707 ** the master journal name. This is in case the previous page written to
708 ** the journal has already been synced.
709 */
710 if( pPager->fullSync ){
711 rc = seekJournalHdr(pPager);
712 if( rc!=SQLITE_OK ) return rc;
713 }
danielk1977cafadba2004-06-25 11:11:54 +0000714 pPager->journalOff += (len+20);
danielk197776572402004-06-25 02:38:54 +0000715
716 rc = write32bits(&pPager->jfd, PAGER_MJ_PGNO(pPager));
717 if( rc!=SQLITE_OK ) return rc;
718
719 rc = sqlite3OsWrite(&pPager->jfd, zMaster, len);
720 if( rc!=SQLITE_OK ) return rc;
721
722 rc = write32bits(&pPager->jfd, len);
723 if( rc!=SQLITE_OK ) return rc;
724
danielk1977cafadba2004-06-25 11:11:54 +0000725 rc = write32bits(&pPager->jfd, cksum);
726 if( rc!=SQLITE_OK ) return rc;
727
danielk197776572402004-06-25 02:38:54 +0000728 rc = sqlite3OsWrite(&pPager->jfd, aJournalMagic, sizeof(aJournalMagic));
drhfdb38062004-08-21 19:20:42 +0000729 pPager->needSync = 1;
danielk197776572402004-06-25 02:38:54 +0000730 return rc;
731}
732
733/*
drh03eb96a2002-11-10 23:32:56 +0000734** Add or remove a page from the list of all pages that are in the
drhac69b052004-05-12 13:30:07 +0000735** statement journal.
drh03eb96a2002-11-10 23:32:56 +0000736**
737** The Pager keeps a separate list of pages that are currently in
drhac69b052004-05-12 13:30:07 +0000738** the statement journal. This helps the sqlite3pager_stmt_commit()
drh03eb96a2002-11-10 23:32:56 +0000739** routine run MUCH faster for the common case where there are many
drhac69b052004-05-12 13:30:07 +0000740** pages in memory but only a few are in the statement journal.
drh03eb96a2002-11-10 23:32:56 +0000741*/
drh3aac2dd2004-04-26 14:10:20 +0000742static void page_add_to_stmt_list(PgHdr *pPg){
drh03eb96a2002-11-10 23:32:56 +0000743 Pager *pPager = pPg->pPager;
drhac69b052004-05-12 13:30:07 +0000744 if( pPg->inStmt ) return;
745 assert( pPg->pPrevStmt==0 && pPg->pNextStmt==0 );
746 pPg->pPrevStmt = 0;
747 if( pPager->pStmt ){
748 pPager->pStmt->pPrevStmt = pPg;
drh03eb96a2002-11-10 23:32:56 +0000749 }
drhac69b052004-05-12 13:30:07 +0000750 pPg->pNextStmt = pPager->pStmt;
751 pPager->pStmt = pPg;
752 pPg->inStmt = 1;
drh03eb96a2002-11-10 23:32:56 +0000753}
drh3aac2dd2004-04-26 14:10:20 +0000754static void page_remove_from_stmt_list(PgHdr *pPg){
drhac69b052004-05-12 13:30:07 +0000755 if( !pPg->inStmt ) return;
756 if( pPg->pPrevStmt ){
757 assert( pPg->pPrevStmt->pNextStmt==pPg );
758 pPg->pPrevStmt->pNextStmt = pPg->pNextStmt;
drh03eb96a2002-11-10 23:32:56 +0000759 }else{
drhac69b052004-05-12 13:30:07 +0000760 assert( pPg->pPager->pStmt==pPg );
761 pPg->pPager->pStmt = pPg->pNextStmt;
drh03eb96a2002-11-10 23:32:56 +0000762 }
drhac69b052004-05-12 13:30:07 +0000763 if( pPg->pNextStmt ){
764 assert( pPg->pNextStmt->pPrevStmt==pPg );
765 pPg->pNextStmt->pPrevStmt = pPg->pPrevStmt;
drh03eb96a2002-11-10 23:32:56 +0000766 }
drhac69b052004-05-12 13:30:07 +0000767 pPg->pNextStmt = 0;
768 pPg->pPrevStmt = 0;
769 pPg->inStmt = 0;
drh03eb96a2002-11-10 23:32:56 +0000770}
771
772/*
drhed7c8552001-04-11 14:29:21 +0000773** Find a page in the hash table given its page number. Return
774** a pointer to the page or NULL if not found.
775*/
drhd9b02572001-04-15 00:37:09 +0000776static PgHdr *pager_lookup(Pager *pPager, Pgno pgno){
drh836faa42003-01-11 13:30:57 +0000777 PgHdr *p = pPager->aHash[pager_hash(pgno)];
drhed7c8552001-04-11 14:29:21 +0000778 while( p && p->pgno!=pgno ){
779 p = p->pNextHash;
780 }
781 return p;
782}
783
784/*
785** Unlock the database and clear the in-memory cache. This routine
786** sets the state of the pager back to what it was when it was first
787** opened. Any outstanding pages are invalidated and subsequent attempts
788** to access those pages will likely result in a coredump.
789*/
drhd9b02572001-04-15 00:37:09 +0000790static void pager_reset(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +0000791 PgHdr *pPg, *pNext;
drhd9b02572001-04-15 00:37:09 +0000792 for(pPg=pPager->pAll; pPg; pPg=pNext){
793 pNext = pPg->pNextAll;
794 sqliteFree(pPg);
drhed7c8552001-04-11 14:29:21 +0000795 }
796 pPager->pFirst = 0;
drh341eae82003-01-21 02:39:36 +0000797 pPager->pFirstSynced = 0;
drhd9b02572001-04-15 00:37:09 +0000798 pPager->pLast = 0;
799 pPager->pAll = 0;
drhed7c8552001-04-11 14:29:21 +0000800 memset(pPager->aHash, 0, sizeof(pPager->aHash));
801 pPager->nPage = 0;
drha6abd042004-06-09 17:37:22 +0000802 if( pPager->state>=PAGER_RESERVED ){
drh3aac2dd2004-04-26 14:10:20 +0000803 sqlite3pager_rollback(pPager);
drhed7c8552001-04-11 14:29:21 +0000804 }
drha6abd042004-06-09 17:37:22 +0000805 sqlite3OsUnlock(&pPager->fd, NO_LOCK);
806 pPager->state = PAGER_UNLOCK;
drhd9b02572001-04-15 00:37:09 +0000807 pPager->dbSize = -1;
drhed7c8552001-04-11 14:29:21 +0000808 pPager->nRef = 0;
drh8cfbf082001-09-19 13:22:39 +0000809 assert( pPager->journalOpen==0 );
drhed7c8552001-04-11 14:29:21 +0000810}
811
812/*
813** When this routine is called, the pager has the journal file open and
drha6abd042004-06-09 17:37:22 +0000814** a RESERVED or EXCLUSIVE lock on the database. This routine releases
815** the database lock and acquires a SHARED lock in its place. The journal
816** file is deleted and closed.
drh50457892003-09-06 01:10:47 +0000817**
818** TODO: Consider keeping the journal file open for temporary databases.
819** This might give a performance improvement on windows where opening
820** a file is an expensive operation.
drhed7c8552001-04-11 14:29:21 +0000821*/
drhd9b02572001-04-15 00:37:09 +0000822static int pager_unwritelock(Pager *pPager){
drhd9b02572001-04-15 00:37:09 +0000823 PgHdr *pPg;
drh9c105bb2004-10-02 20:38:28 +0000824 int rc;
drhb7f91642004-10-31 02:22:47 +0000825 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +0000826 if( pPager->state<PAGER_RESERVED ){
827 return SQLITE_OK;
828 }
drh3aac2dd2004-04-26 14:10:20 +0000829 sqlite3pager_stmt_commit(pPager);
drhac69b052004-05-12 13:30:07 +0000830 if( pPager->stmtOpen ){
831 sqlite3OsClose(&pPager->stfd);
832 pPager->stmtOpen = 0;
drh0f892532002-05-30 12:27:03 +0000833 }
drhda47d772002-12-02 04:25:19 +0000834 if( pPager->journalOpen ){
danielk19774adee202004-05-08 08:23:19 +0000835 sqlite3OsClose(&pPager->jfd);
drhda47d772002-12-02 04:25:19 +0000836 pPager->journalOpen = 0;
danielk19774adee202004-05-08 08:23:19 +0000837 sqlite3OsDelete(pPager->zJournal);
drhda47d772002-12-02 04:25:19 +0000838 sqliteFree( pPager->aInJournal );
839 pPager->aInJournal = 0;
840 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
841 pPg->inJournal = 0;
842 pPg->dirty = 0;
drhdb48ee02003-01-16 13:42:43 +0000843 pPg->needSync = 0;
drhda47d772002-12-02 04:25:19 +0000844 }
danielk1977ef317ab2004-06-23 10:43:10 +0000845 pPager->dirtyCache = 0;
danielk1977ef317ab2004-06-23 10:43:10 +0000846 pPager->nRec = 0;
drhda47d772002-12-02 04:25:19 +0000847 }else{
drha6abd042004-06-09 17:37:22 +0000848 assert( pPager->dirtyCache==0 || pPager->useJournal==0 );
drhd9b02572001-04-15 00:37:09 +0000849 }
drh9c105bb2004-10-02 20:38:28 +0000850 rc = sqlite3OsUnlock(&pPager->fd, SHARED_LOCK);
drha6abd042004-06-09 17:37:22 +0000851 pPager->state = PAGER_SHARED;
danielk1977ef317ab2004-06-23 10:43:10 +0000852 pPager->origDbSize = 0;
danielk197776572402004-06-25 02:38:54 +0000853 pPager->setMaster = 0;
drh9c105bb2004-10-02 20:38:28 +0000854 return rc;
drhed7c8552001-04-11 14:29:21 +0000855}
856
drhed7c8552001-04-11 14:29:21 +0000857/*
drh968af522003-02-11 14:55:40 +0000858** Compute and return a checksum for the page of data.
drh34e79ce2004-02-08 06:05:46 +0000859**
860** This is not a real checksum. It is really just the sum of the
drh726de592004-06-10 23:35:50 +0000861** random initial value and the page number. We experimented with
862** a checksum of the entire data, but that was found to be too slow.
863**
864** Note that the page number is stored at the beginning of data and
865** the checksum is stored at the end. This is important. If journal
866** corruption occurs due to a power failure, the most likely scenario
867** is that one end or the other of the record will be changed. It is
868** much less likely that the two ends of the journal record will be
869** correct and the middle be corrupt. Thus, this "checksum" scheme,
870** though fast and simple, catches the mostly likely kind of corruption.
871**
872** FIX ME: Consider adding every 200th (or so) byte of the data to the
873** checksum. That way if a single page spans 3 or more disk sectors and
874** only the middle sector is corrupt, we will still have a reasonable
875** chance of failing the checksum and thus detecting the problem.
drh968af522003-02-11 14:55:40 +0000876*/
877static u32 pager_cksum(Pager *pPager, Pgno pgno, const char *aData){
danielk1977ef317ab2004-06-23 10:43:10 +0000878 u32 cksum = pPager->cksumInit;
879 int i = pPager->pageSize-200;
880 while( i>0 ){
881 cksum += aData[i];
882 i -= 200;
883 }
drh968af522003-02-11 14:55:40 +0000884 return cksum;
885}
886
887/*
drhfa86c412002-02-02 15:01:15 +0000888** Read a single page from the journal file opened on file descriptor
889** jfd. Playback this one page.
drh968af522003-02-11 14:55:40 +0000890**
drh726de592004-06-10 23:35:50 +0000891** If useCksum==0 it means this journal does not use checksums. Checksums
892** are not used in statement journals because statement journals do not
893** need to survive power failures.
drhfa86c412002-02-02 15:01:15 +0000894*/
drhae2b40c2004-06-09 19:03:54 +0000895static int pager_playback_one_page(Pager *pPager, OsFile *jfd, int useCksum){
drhfa86c412002-02-02 15:01:15 +0000896 int rc;
drhae2b40c2004-06-09 19:03:54 +0000897 PgHdr *pPg; /* An existing page in the cache */
898 Pgno pgno; /* The page number of a page in journal */
899 u32 cksum; /* Checksum used for sanity checking */
drh90f5ecb2004-07-22 01:19:35 +0000900 u8 aData[SQLITE_MAX_PAGE_SIZE]; /* Temp storage for a page */
drhfa86c412002-02-02 15:01:15 +0000901
drhae2b40c2004-06-09 19:03:54 +0000902 rc = read32bits(jfd, &pgno);
drh99ee3602003-02-16 19:13:36 +0000903 if( rc!=SQLITE_OK ) return rc;
drhae2b40c2004-06-09 19:03:54 +0000904 rc = sqlite3OsRead(jfd, &aData, pPager->pageSize);
drh99ee3602003-02-16 19:13:36 +0000905 if( rc!=SQLITE_OK ) return rc;
danielk197776572402004-06-25 02:38:54 +0000906 pPager->journalOff += pPager->pageSize + 4;
drhfa86c412002-02-02 15:01:15 +0000907
drh968af522003-02-11 14:55:40 +0000908 /* Sanity checking on the page. This is more important that I originally
909 ** thought. If a power failure occurs while the journal is being written,
910 ** it could cause invalid data to be written into the journal. We need to
911 ** detect this invalid data (with high probability) and ignore it.
912 */
danielk197775edc162004-06-26 01:48:18 +0000913 if( pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh968af522003-02-11 14:55:40 +0000914 return SQLITE_DONE;
915 }
drhae2b40c2004-06-09 19:03:54 +0000916 if( pgno>(unsigned)pPager->dbSize ){
drh968af522003-02-11 14:55:40 +0000917 return SQLITE_OK;
918 }
drhae2b40c2004-06-09 19:03:54 +0000919 if( useCksum ){
920 rc = read32bits(jfd, &cksum);
drh99ee3602003-02-16 19:13:36 +0000921 if( rc ) return rc;
danielk197776572402004-06-25 02:38:54 +0000922 pPager->journalOff += 4;
drhae2b40c2004-06-09 19:03:54 +0000923 if( pager_cksum(pPager, pgno, aData)!=cksum ){
drh968af522003-02-11 14:55:40 +0000924 return SQLITE_DONE;
925 }
926 }
drhfa86c412002-02-02 15:01:15 +0000927
danielk1977aa5ccdf2004-06-14 05:10:42 +0000928 assert( pPager->state==PAGER_RESERVED || pPager->state>=PAGER_EXCLUSIVE );
danielk1977a3f3a5f2004-06-10 04:32:16 +0000929
930 /* If the pager is in RESERVED state, then there must be a copy of this
931 ** page in the pager cache. In this case just update the pager cache,
danielk19770de0bb32004-06-10 05:59:24 +0000932 ** not the database file. The page is left marked dirty in this case.
933 **
danielk1977a3f3a5f2004-06-10 04:32:16 +0000934 ** If in EXCLUSIVE state, then we update the pager cache if it exists
935 ** and the main file. The page is then marked not dirty.
drhfa86c412002-02-02 15:01:15 +0000936 */
drhae2b40c2004-06-09 19:03:54 +0000937 pPg = pager_lookup(pPager, pgno);
danielk1977aa5ccdf2004-06-14 05:10:42 +0000938 assert( pPager->state>=PAGER_EXCLUSIVE || pPg );
danielk1977ef73ee92004-11-06 12:26:07 +0000939 TRACE3("PLAYBACK %d page %d\n", PAGERID(pPager), pgno);
danielk1977aa5ccdf2004-06-14 05:10:42 +0000940 if( pPager->state>=PAGER_EXCLUSIVE ){
drheb206252004-10-01 02:00:31 +0000941 sqlite3OsSeek(&pPager->fd, (pgno-1)*(i64)pPager->pageSize);
drh90f5ecb2004-07-22 01:19:35 +0000942 rc = sqlite3OsWrite(&pPager->fd, aData, pPager->pageSize);
danielk1977a3f3a5f2004-06-10 04:32:16 +0000943 }
drhfa86c412002-02-02 15:01:15 +0000944 if( pPg ){
danielk197728129562005-01-11 10:25:06 +0000945 /* No page should ever be explicitly rolled back that is in use, except
946 ** for page 1 which is held in use in order to keep the lock on the
947 ** database active. However such a page may be rolled back as a result
948 ** of an internal error resulting in an automatic call to
949 ** sqlite3pager_rollback().
drhacf4ac92003-12-17 23:57:34 +0000950 */
drhb6f41482004-05-14 01:58:11 +0000951 void *pData;
danielk197728129562005-01-11 10:25:06 +0000952 /* assert( pPg->nRef==0 || pPg->pgno==1 ); */
drhb6f41482004-05-14 01:58:11 +0000953 pData = PGHDR_TO_DATA(pPg);
drhae2b40c2004-06-09 19:03:54 +0000954 memcpy(pData, aData, pPager->pageSize);
drh726de592004-06-10 23:35:50 +0000955 if( pPager->xDestructor ){ /*** FIX ME: Should this be xReinit? ***/
drhb6f41482004-05-14 01:58:11 +0000956 pPager->xDestructor(pData, pPager->pageSize);
drhde647132004-05-07 17:57:49 +0000957 }
danielk1977aa5ccdf2004-06-14 05:10:42 +0000958 if( pPager->state>=PAGER_EXCLUSIVE ){
danielk19770de0bb32004-06-10 05:59:24 +0000959 pPg->dirty = 0;
960 pPg->needSync = 0;
961 }
drhb6f41482004-05-14 01:58:11 +0000962 CODEC(pPager, pData, pPg->pgno, 3);
drhfa86c412002-02-02 15:01:15 +0000963 }
964 return rc;
965}
966
967/*
danielk197713adf8a2004-06-03 16:08:41 +0000968** Parameter zMaster is the name of a master journal file. A single journal
969** file that referred to the master journal file has just been rolled back.
970** This routine checks if it is possible to delete the master journal file,
971** and does so if it is.
drh726de592004-06-10 23:35:50 +0000972**
973** The master journal file contains the names of all child journals.
974** To tell if a master journal can be deleted, check to each of the
975** children. If all children are either missing or do not refer to
976** a different master journal, then this master journal can be deleted.
danielk197713adf8a2004-06-03 16:08:41 +0000977*/
978static int pager_delmaster(const char *zMaster){
979 int rc;
980 int master_open = 0;
981 OsFile master;
982 char *zMasterJournal = 0; /* Contents of master journal file */
drheb206252004-10-01 02:00:31 +0000983 i64 nMasterJournal; /* Size of master journal file */
danielk197713adf8a2004-06-03 16:08:41 +0000984
985 /* Open the master journal file exclusively in case some other process
986 ** is running this routine also. Not that it makes too much difference.
987 */
drhda71ce12004-06-21 18:14:45 +0000988 memset(&master, 0, sizeof(master));
danielk19778191bff2004-06-28 04:52:30 +0000989 rc = sqlite3OsOpenReadOnly(zMaster, &master);
danielk197713adf8a2004-06-03 16:08:41 +0000990 if( rc!=SQLITE_OK ) goto delmaster_out;
991 master_open = 1;
danielk197713adf8a2004-06-03 16:08:41 +0000992 rc = sqlite3OsFileSize(&master, &nMasterJournal);
993 if( rc!=SQLITE_OK ) goto delmaster_out;
994
995 if( nMasterJournal>0 ){
danielk19775865e3d2004-06-14 06:03:57 +0000996 char *zJournal;
danielk197776572402004-06-25 02:38:54 +0000997 char *zMasterPtr = 0;
danielk19775865e3d2004-06-14 06:03:57 +0000998
999 /* Load the entire master journal file into space obtained from
1000 ** sqliteMalloc() and pointed to by zMasterJournal.
danielk19775865e3d2004-06-14 06:03:57 +00001001 */
danielk197776572402004-06-25 02:38:54 +00001002 zMasterJournal = (char *)sqliteMalloc(nMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001003 if( !zMasterJournal ){
1004 rc = SQLITE_NOMEM;
1005 goto delmaster_out;
1006 }
1007 rc = sqlite3OsRead(&master, zMasterJournal, nMasterJournal);
1008 if( rc!=SQLITE_OK ) goto delmaster_out;
1009
danielk19775865e3d2004-06-14 06:03:57 +00001010 zJournal = zMasterJournal;
1011 while( (zJournal-zMasterJournal)<nMasterJournal ){
danielk197713adf8a2004-06-03 16:08:41 +00001012 if( sqlite3OsFileExists(zJournal) ){
1013 /* One of the journals pointed to by the master journal exists.
1014 ** Open it and check if it points at the master journal. If
1015 ** so, return without deleting the master journal file.
1016 */
1017 OsFile journal;
drh3b7b78b2004-11-24 01:16:43 +00001018 int c;
danielk197713adf8a2004-06-03 16:08:41 +00001019
drhda71ce12004-06-21 18:14:45 +00001020 memset(&journal, 0, sizeof(journal));
danielk197713adf8a2004-06-03 16:08:41 +00001021 rc = sqlite3OsOpenReadOnly(zJournal, &journal);
1022 if( rc!=SQLITE_OK ){
danielk197713adf8a2004-06-03 16:08:41 +00001023 goto delmaster_out;
1024 }
danielk197713adf8a2004-06-03 16:08:41 +00001025
danielk197776572402004-06-25 02:38:54 +00001026 rc = readMasterJournal(&journal, &zMasterPtr);
1027 sqlite3OsClose(&journal);
danielk19779eed5052004-06-04 10:38:30 +00001028 if( rc!=SQLITE_OK ){
danielk19779eed5052004-06-04 10:38:30 +00001029 goto delmaster_out;
1030 }
danielk197776572402004-06-25 02:38:54 +00001031
drh3b7b78b2004-11-24 01:16:43 +00001032 c = zMasterPtr!=0 && strcmp(zMasterPtr, zMaster)==0;
1033 sqliteFree(zMasterPtr);
1034 if( c ){
danielk197776572402004-06-25 02:38:54 +00001035 /* We have a match. Do not delete the master journal file. */
1036 goto delmaster_out;
danielk197713adf8a2004-06-03 16:08:41 +00001037 }
1038 }
danielk19775865e3d2004-06-14 06:03:57 +00001039 zJournal += (strlen(zJournal)+1);
danielk197713adf8a2004-06-03 16:08:41 +00001040 }
1041 }
1042
1043 sqlite3OsDelete(zMaster);
1044
1045delmaster_out:
1046 if( zMasterJournal ){
1047 sqliteFree(zMasterJournal);
1048 }
1049 if( master_open ){
1050 sqlite3OsClose(&master);
1051 }
1052 return rc;
1053}
1054
1055/*
drha6abd042004-06-09 17:37:22 +00001056** Make every page in the cache agree with what is on disk. In other words,
1057** reread the disk to reset the state of the cache.
1058**
1059** This routine is called after a rollback in which some of the dirty cache
1060** pages had never been written out to disk. We need to roll back the
1061** cache content and the easiest way to do that is to reread the old content
1062** back from the disk.
1063*/
1064static int pager_reload_cache(Pager *pPager){
1065 PgHdr *pPg;
1066 int rc = SQLITE_OK;
1067 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
drh90f5ecb2004-07-22 01:19:35 +00001068 char zBuf[SQLITE_MAX_PAGE_SIZE];
drha6abd042004-06-09 17:37:22 +00001069 if( !pPg->dirty ) continue;
1070 if( (int)pPg->pgno <= pPager->origDbSize ){
drheb206252004-10-01 02:00:31 +00001071 sqlite3OsSeek(&pPager->fd, pPager->pageSize*(i64)(pPg->pgno-1));
drh90f5ecb2004-07-22 01:19:35 +00001072 rc = sqlite3OsRead(&pPager->fd, zBuf, pPager->pageSize);
danielk1977ef73ee92004-11-06 12:26:07 +00001073 TRACE3("REFETCH %d page %d\n", PAGERID(pPager), pPg->pgno);
drha6abd042004-06-09 17:37:22 +00001074 if( rc ) break;
drh25d65432004-07-22 15:02:25 +00001075 CODEC(pPager, zBuf, pPg->pgno, 2);
drha6abd042004-06-09 17:37:22 +00001076 }else{
drh90f5ecb2004-07-22 01:19:35 +00001077 memset(zBuf, 0, pPager->pageSize);
drha6abd042004-06-09 17:37:22 +00001078 }
drh90f5ecb2004-07-22 01:19:35 +00001079 if( pPg->nRef==0 || memcmp(zBuf, PGHDR_TO_DATA(pPg), pPager->pageSize) ){
1080 memcpy(PGHDR_TO_DATA(pPg), zBuf, pPager->pageSize);
drha6abd042004-06-09 17:37:22 +00001081 if( pPager->xReiniter ){
1082 pPager->xReiniter(PGHDR_TO_DATA(pPg), pPager->pageSize);
1083 }else{
drh90f5ecb2004-07-22 01:19:35 +00001084 memset(PGHDR_TO_EXTRA(pPg, pPager), 0, pPager->nExtra);
drha6abd042004-06-09 17:37:22 +00001085 }
1086 }
1087 pPg->needSync = 0;
1088 pPg->dirty = 0;
1089 }
1090 return rc;
1091}
1092
drha6abd042004-06-09 17:37:22 +00001093/*
drhcb4c40b2004-08-18 19:09:43 +00001094** Truncate the main file of the given pager to the number of pages
1095** indicated.
1096*/
1097static int pager_truncate(Pager *pPager, int nPage){
drheb206252004-10-01 02:00:31 +00001098 return sqlite3OsTruncate(&pPager->fd, pPager->pageSize*(i64)nPage);
drhcb4c40b2004-08-18 19:09:43 +00001099}
1100
1101/*
drhed7c8552001-04-11 14:29:21 +00001102** Playback the journal and thus restore the database file to
1103** the state it was in before we started making changes.
1104**
drh34e79ce2004-02-08 06:05:46 +00001105** The journal file format is as follows:
1106**
drhae2b40c2004-06-09 19:03:54 +00001107** (1) 8 byte prefix. A copy of aJournalMagic[].
1108** (2) 4 byte big-endian integer which is the number of valid page records
drh34e79ce2004-02-08 06:05:46 +00001109** in the journal. If this value is 0xffffffff, then compute the
drhae2b40c2004-06-09 19:03:54 +00001110** number of page records from the journal size.
1111** (3) 4 byte big-endian integer which is the initial value for the
1112** sanity checksum.
1113** (4) 4 byte integer which is the number of pages to truncate the
drh34e79ce2004-02-08 06:05:46 +00001114** database to during a rollback.
drhae2b40c2004-06-09 19:03:54 +00001115** (5) 4 byte integer which is the number of bytes in the master journal
1116** name. The value may be zero (indicate that there is no master
1117** journal.)
1118** (6) N bytes of the master journal name. The name will be nul-terminated
1119** and might be shorter than the value read from (5). If the first byte
1120** of the name is \000 then there is no master journal. The master
1121** journal name is stored in UTF-8.
1122** (7) Zero or more pages instances, each as follows:
drh34e79ce2004-02-08 06:05:46 +00001123** + 4 byte page number.
drhae2b40c2004-06-09 19:03:54 +00001124** + pPager->pageSize bytes of data.
1125** + 4 byte checksum
drh34e79ce2004-02-08 06:05:46 +00001126**
drhae2b40c2004-06-09 19:03:54 +00001127** When we speak of the journal header, we mean the first 6 items above.
1128** Each entry in the journal is an instance of the 7th item.
drh34e79ce2004-02-08 06:05:46 +00001129**
1130** Call the value from the second bullet "nRec". nRec is the number of
1131** valid page entries in the journal. In most cases, you can compute the
1132** value of nRec from the size of the journal file. But if a power
1133** failure occurred while the journal was being written, it could be the
1134** case that the size of the journal file had already been increased but
1135** the extra entries had not yet made it safely to disk. In such a case,
1136** the value of nRec computed from the file size would be too large. For
1137** that reason, we always use the nRec value in the header.
1138**
1139** If the nRec value is 0xffffffff it means that nRec should be computed
1140** from the file size. This value is used when the user selects the
1141** no-sync option for the journal. A power failure could lead to corruption
1142** in this case. But for things like temporary table (which will be
1143** deleted when the power is restored) we don't care.
1144**
drhd9b02572001-04-15 00:37:09 +00001145** If the file opened as the journal file is not a well-formed
danielk1977ece80f12004-06-23 01:05:26 +00001146** journal file then all pages up to the first corrupted page are rolled
1147** back (or no pages if the journal header is corrupted). The journal file
1148** is then deleted and SQLITE_OK returned, just as if no corruption had
1149** been encountered.
1150**
1151** If an I/O or malloc() error occurs, the journal-file is not deleted
1152** and an error code is returned.
drhed7c8552001-04-11 14:29:21 +00001153*/
danielk197776572402004-06-25 02:38:54 +00001154static int pager_playback(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001155 i64 szJ; /* Size of the journal file in bytes */
danielk1977c3e8f5e2004-06-28 01:16:46 +00001156 u32 nRec; /* Number of Records in the journal */
drhd9b02572001-04-15 00:37:09 +00001157 int i; /* Loop counter */
1158 Pgno mxPg = 0; /* Size of the original file in pages */
drhae2b40c2004-06-09 19:03:54 +00001159 int rc; /* Result code of a subroutine */
danielk197713adf8a2004-06-03 16:08:41 +00001160 char *zMaster = 0; /* Name of master journal file if any */
drhed7c8552001-04-11 14:29:21 +00001161
drhc3a64ba2001-11-22 00:01:27 +00001162 /* Figure out how many records are in the journal. Abort early if
1163 ** the journal is empty.
drhed7c8552001-04-11 14:29:21 +00001164 */
drh8cfbf082001-09-19 13:22:39 +00001165 assert( pPager->journalOpen );
danielk19774adee202004-05-08 08:23:19 +00001166 rc = sqlite3OsFileSize(&pPager->jfd, &szJ);
drhc3a64ba2001-11-22 00:01:27 +00001167 if( rc!=SQLITE_OK ){
1168 goto end_playback;
1169 }
drh240c5792004-02-08 00:40:52 +00001170
danielk197776572402004-06-25 02:38:54 +00001171 /* Read the master journal name from the journal, if it is present.
1172 ** If a master journal file name is specified, but the file is not
1173 ** present on disk, then the journal is not hot and does not need to be
1174 ** played back.
drh240c5792004-02-08 00:40:52 +00001175 */
danielk197776572402004-06-25 02:38:54 +00001176 rc = readMasterJournal(&pPager->jfd, &zMaster);
1177 assert( rc!=SQLITE_DONE );
1178 if( rc!=SQLITE_OK || (zMaster && !sqlite3OsFileExists(zMaster)) ){
1179 sqliteFree(zMaster);
1180 zMaster = 0;
1181 if( rc==SQLITE_DONE ) rc = SQLITE_OK;
drhc3a64ba2001-11-22 00:01:27 +00001182 goto end_playback;
1183 }
danielk197776572402004-06-25 02:38:54 +00001184 sqlite3OsSeek(&pPager->jfd, 0);
1185 pPager->journalOff = 0;
drhc3a64ba2001-11-22 00:01:27 +00001186
danielk197776572402004-06-25 02:38:54 +00001187 /* This loop terminates either when the readJournalHdr() call returns
1188 ** SQLITE_DONE or an IO error occurs. */
1189 while( 1 ){
drhae2b40c2004-06-09 19:03:54 +00001190
danielk197776572402004-06-25 02:38:54 +00001191 /* Read the next journal header from the journal file. If there are
1192 ** not enough bytes left in the journal file for a complete header, or
1193 ** it is corrupted, then a process must of failed while writing it.
1194 ** This indicates nothing more needs to be rolled back.
1195 */
1196 rc = readJournalHdr(pPager, szJ, &nRec, &mxPg);
1197 if( rc!=SQLITE_OK ){
drh968af522003-02-11 14:55:40 +00001198 if( rc==SQLITE_DONE ){
drh968af522003-02-11 14:55:40 +00001199 rc = SQLITE_OK;
1200 }
danielk197776572402004-06-25 02:38:54 +00001201 goto end_playback;
1202 }
1203
1204 /* If nRec is 0xffffffff, then this journal was created by a process
1205 ** working in no-sync mode. This means that the rest of the journal
1206 ** file consists of pages, there are no more journal headers. Compute
1207 ** the value of nRec based on this assumption.
1208 */
1209 if( nRec==0xffffffff ){
1210 assert( pPager->journalOff==JOURNAL_HDR_SZ(pPager) );
1211 nRec = (szJ - JOURNAL_HDR_SZ(pPager))/JOURNAL_PG_SZ(pPager);
1212 }
1213
1214 /* If this is the first header read from the journal, truncate the
1215 ** database file back to it's original size.
1216 */
1217 if( pPager->journalOff==JOURNAL_HDR_SZ(pPager) ){
1218 assert( pPager->origDbSize==0 || pPager->origDbSize==mxPg );
drhcb4c40b2004-08-18 19:09:43 +00001219 rc = pager_truncate(pPager, mxPg);
danielk197776572402004-06-25 02:38:54 +00001220 if( rc!=SQLITE_OK ){
1221 goto end_playback;
1222 }
1223 pPager->dbSize = mxPg;
1224 }
1225
1226 /* rc = sqlite3OsSeek(&pPager->jfd, JOURNAL_HDR_SZ(pPager)); */
1227 if( rc!=SQLITE_OK ) goto end_playback;
1228
1229 /* Copy original pages out of the journal and back into the database file.
1230 */
1231 for(i=0; i<nRec; i++){
1232 rc = pager_playback_one_page(pPager, &pPager->jfd, 1);
1233 if( rc!=SQLITE_OK ){
1234 if( rc==SQLITE_DONE ){
1235 rc = SQLITE_OK;
1236 pPager->journalOff = szJ;
1237 break;
1238 }else{
1239 goto end_playback;
1240 }
1241 }
drh968af522003-02-11 14:55:40 +00001242 }
drhed7c8552001-04-11 14:29:21 +00001243 }
drh81a20f22001-10-12 17:30:04 +00001244
drh4a0681e2003-02-13 01:58:20 +00001245 /* Pages that have been written to the journal but never synced
1246 ** where not restored by the loop above. We have to restore those
drh240c5792004-02-08 00:40:52 +00001247 ** pages by reading them back from the original database.
drhdb48ee02003-01-16 13:42:43 +00001248 */
danielk197776572402004-06-25 02:38:54 +00001249 assert( rc==SQLITE_OK );
1250 pager_reload_cache(pPager);
drh4a0681e2003-02-13 01:58:20 +00001251
1252end_playback:
danielk19778191bff2004-06-28 04:52:30 +00001253 if( rc==SQLITE_OK ){
1254 rc = pager_unwritelock(pPager);
1255 }
danielk197713adf8a2004-06-03 16:08:41 +00001256 if( zMaster ){
1257 /* If there was a master journal and this routine will return true,
danielk197732554c12005-01-22 03:39:39 +00001258 ** see if it is possible to delete the master journal.
danielk197713adf8a2004-06-03 16:08:41 +00001259 */
1260 if( rc==SQLITE_OK ){
danielk197732554c12005-01-22 03:39:39 +00001261 rc = pager_delmaster(zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001262 }
1263 sqliteFree(zMaster);
1264 }
danielk197776572402004-06-25 02:38:54 +00001265
1266 /* The Pager.sectorSize variable may have been updated while rolling
1267 ** back a journal created by a process with a different PAGER_SECTOR_SIZE
1268 ** value. Reset it to the correct value for this process.
1269 */
1270 pPager->sectorSize = PAGER_SECTOR_SIZE;
drhd9b02572001-04-15 00:37:09 +00001271 return rc;
drhed7c8552001-04-11 14:29:21 +00001272}
1273
1274/*
drhac69b052004-05-12 13:30:07 +00001275** Playback the statement journal.
drhfa86c412002-02-02 15:01:15 +00001276**
1277** This is similar to playing back the transaction journal but with
1278** a few extra twists.
1279**
drh663fc632002-02-02 18:49:19 +00001280** (1) The number of pages in the database file at the start of
drhac69b052004-05-12 13:30:07 +00001281** the statement is stored in pPager->stmtSize, not in the
drh663fc632002-02-02 18:49:19 +00001282** journal file itself.
drhfa86c412002-02-02 15:01:15 +00001283**
drhac69b052004-05-12 13:30:07 +00001284** (2) In addition to playing back the statement journal, also
drhfa86c412002-02-02 15:01:15 +00001285** playback all pages of the transaction journal beginning
drhac69b052004-05-12 13:30:07 +00001286** at offset pPager->stmtJSize.
drhfa86c412002-02-02 15:01:15 +00001287*/
drh3aac2dd2004-04-26 14:10:20 +00001288static int pager_stmt_playback(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001289 i64 szJ; /* Size of the full journal */
1290 i64 hdrOff;
drh968af522003-02-11 14:55:40 +00001291 int nRec; /* Number of Records */
drhfa86c412002-02-02 15:01:15 +00001292 int i; /* Loop counter */
1293 int rc;
1294
danielk197776572402004-06-25 02:38:54 +00001295 szJ = pPager->journalOff;
1296#ifndef NDEBUG
1297 {
drheb206252004-10-01 02:00:31 +00001298 i64 os_szJ;
danielk197776572402004-06-25 02:38:54 +00001299 rc = sqlite3OsFileSize(&pPager->jfd, &os_szJ);
1300 if( rc!=SQLITE_OK ) return rc;
1301 assert( szJ==os_szJ );
1302 }
1303#endif
1304
1305 /* Set hdrOff to be the offset to the first journal header written
1306 ** this statement transaction, or the end of the file if no journal
1307 ** header was written.
1308 */
1309 hdrOff = pPager->stmtHdrOff;
1310 assert( pPager->fullSync || !hdrOff );
1311 if( !hdrOff ){
1312 hdrOff = szJ;
1313 }
1314
1315
drhfa86c412002-02-02 15:01:15 +00001316 /* Truncate the database back to its original size.
1317 */
drhcb4c40b2004-08-18 19:09:43 +00001318 rc = pager_truncate(pPager, pPager->stmtSize);
drhac69b052004-05-12 13:30:07 +00001319 pPager->dbSize = pPager->stmtSize;
drhfa86c412002-02-02 15:01:15 +00001320
drhac69b052004-05-12 13:30:07 +00001321 /* Figure out how many records are in the statement journal.
drhfa86c412002-02-02 15:01:15 +00001322 */
drhac69b052004-05-12 13:30:07 +00001323 assert( pPager->stmtInUse && pPager->journalOpen );
1324 sqlite3OsSeek(&pPager->stfd, 0);
1325 nRec = pPager->stmtNRec;
drhfa86c412002-02-02 15:01:15 +00001326
drhac69b052004-05-12 13:30:07 +00001327 /* Copy original pages out of the statement journal and back into the
drhae2b40c2004-06-09 19:03:54 +00001328 ** database file. Note that the statement journal omits checksums from
1329 ** each record since power-failure recovery is not important to statement
1330 ** journals.
drhfa86c412002-02-02 15:01:15 +00001331 */
1332 for(i=nRec-1; i>=0; i--){
drhae2b40c2004-06-09 19:03:54 +00001333 rc = pager_playback_one_page(pPager, &pPager->stfd, 0);
drh968af522003-02-11 14:55:40 +00001334 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001335 if( rc!=SQLITE_OK ) goto end_stmt_playback;
drhfa86c412002-02-02 15:01:15 +00001336 }
1337
danielk197776572402004-06-25 02:38:54 +00001338 /* Now roll some pages back from the transaction journal. Pager.stmtJSize
1339 ** was the size of the journal file when this statement was started, so
1340 ** everything after that needs to be rolled back, either into the
1341 ** database, the memory cache, or both.
1342 **
1343 ** If it is not zero, then Pager.stmtHdrOff is the offset to the start
1344 ** of the first journal header written during this statement transaction.
drhfa86c412002-02-02 15:01:15 +00001345 */
drhac69b052004-05-12 13:30:07 +00001346 rc = sqlite3OsSeek(&pPager->jfd, pPager->stmtJSize);
drhfa86c412002-02-02 15:01:15 +00001347 if( rc!=SQLITE_OK ){
drh3aac2dd2004-04-26 14:10:20 +00001348 goto end_stmt_playback;
drhfa86c412002-02-02 15:01:15 +00001349 }
danielk197776572402004-06-25 02:38:54 +00001350 pPager->journalOff = pPager->stmtJSize;
danielk197775edc162004-06-26 01:48:18 +00001351 pPager->cksumInit = pPager->stmtCksum;
1352 assert( JOURNAL_HDR_SZ(pPager)<(pPager->pageSize+8) );
1353 while( pPager->journalOff <= (hdrOff-(pPager->pageSize+8)) ){
drhae2b40c2004-06-09 19:03:54 +00001354 rc = pager_playback_one_page(pPager, &pPager->jfd, 1);
danielk197776572402004-06-25 02:38:54 +00001355 assert( rc!=SQLITE_DONE );
1356 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1357 }
1358
1359 while( pPager->journalOff < szJ ){
1360 u32 nRec;
1361 u32 dummy;
1362 rc = readJournalHdr(pPager, szJ, &nRec, &dummy);
drh968af522003-02-11 14:55:40 +00001363 if( rc!=SQLITE_OK ){
1364 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001365 goto end_stmt_playback;
drh968af522003-02-11 14:55:40 +00001366 }
danielk197775edc162004-06-26 01:48:18 +00001367 if( nRec==0 ){
1368 nRec = (szJ - pPager->journalOff) / (pPager->pageSize+8);
1369 }
danielk197776572402004-06-25 02:38:54 +00001370 for(i=nRec-1; i>=0 && pPager->journalOff < szJ; i--){
1371 rc = pager_playback_one_page(pPager, &pPager->jfd, 1);
1372 assert( rc!=SQLITE_DONE );
1373 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1374 }
drhfa86c412002-02-02 15:01:15 +00001375 }
danielk197776572402004-06-25 02:38:54 +00001376
1377 pPager->journalOff = szJ;
drhfa86c412002-02-02 15:01:15 +00001378
drh3aac2dd2004-04-26 14:10:20 +00001379end_stmt_playback:
drhfa86c412002-02-02 15:01:15 +00001380 if( rc!=SQLITE_OK ){
drhfa86c412002-02-02 15:01:15 +00001381 pPager->errMask |= PAGER_ERR_CORRUPT;
drhee696e22004-08-30 16:52:17 +00001382 rc = SQLITE_CORRUPT; /* bkpt-CORRUPT */
danielk197775edc162004-06-26 01:48:18 +00001383 }else{
1384 pPager->journalOff = szJ;
1385 /* pager_reload_cache(pPager); */
drhfa86c412002-02-02 15:01:15 +00001386 }
1387 return rc;
1388}
1389
1390/*
drhf57b14a2001-09-14 18:54:08 +00001391** Change the maximum number of in-memory pages that are allowed.
drhcd61c282002-03-06 22:01:34 +00001392**
1393** The maximum number is the absolute value of the mxPage parameter.
1394** If mxPage is negative, the noSync flag is also set. noSync bypasses
danielk19774adee202004-05-08 08:23:19 +00001395** calls to sqlite3OsSync(). The pager runs much faster with noSync on,
drhcd61c282002-03-06 22:01:34 +00001396** but if the operating system crashes or there is an abrupt power
1397** failure, the database file might be left in an inconsistent and
1398** unrepairable state.
drhf57b14a2001-09-14 18:54:08 +00001399*/
drh3aac2dd2004-04-26 14:10:20 +00001400void sqlite3pager_set_cachesize(Pager *pPager, int mxPage){
drh603240c2002-03-05 01:11:12 +00001401 if( mxPage>=0 ){
drha1680452002-04-18 01:56:57 +00001402 pPager->noSync = pPager->tempFile;
danielk19771d850a72004-05-31 08:26:49 +00001403 if( pPager->noSync ) pPager->needSync = 0;
drh603240c2002-03-05 01:11:12 +00001404 }else{
1405 pPager->noSync = 1;
1406 mxPage = -mxPage;
1407 }
drhf57b14a2001-09-14 18:54:08 +00001408 if( mxPage>10 ){
1409 pPager->mxPage = mxPage;
danielk1977ef317ab2004-06-23 10:43:10 +00001410 }else{
1411 pPager->mxPage = 10;
drhf57b14a2001-09-14 18:54:08 +00001412 }
1413}
1414
1415/*
drh973b6e32003-02-12 14:09:42 +00001416** Adjust the robustness of the database to damage due to OS crashes
1417** or power failures by changing the number of syncs()s when writing
1418** the rollback journal. There are three levels:
1419**
danielk19774adee202004-05-08 08:23:19 +00001420** OFF sqlite3OsSync() is never called. This is the default
drh973b6e32003-02-12 14:09:42 +00001421** for temporary and transient files.
1422**
1423** NORMAL The journal is synced once before writes begin on the
1424** database. This is normally adequate protection, but
1425** it is theoretically possible, though very unlikely,
1426** that an inopertune power failure could leave the journal
1427** in a state which would cause damage to the database
1428** when it is rolled back.
1429**
1430** FULL The journal is synced twice before writes begin on the
drh34e79ce2004-02-08 06:05:46 +00001431** database (with some additional information - the nRec field
1432** of the journal header - being written in between the two
1433** syncs). If we assume that writing a
drh973b6e32003-02-12 14:09:42 +00001434** single disk sector is atomic, then this mode provides
1435** assurance that the journal will not be corrupted to the
1436** point of causing damage to the database during rollback.
1437**
1438** Numeric values associated with these states are OFF==1, NORMAL=2,
1439** and FULL=3.
1440*/
danielk197793758c82005-01-21 08:13:14 +00001441#ifndef SQLITE_OMIT_PAGER_PRAGMAS
drh3aac2dd2004-04-26 14:10:20 +00001442void sqlite3pager_set_safety_level(Pager *pPager, int level){
drh973b6e32003-02-12 14:09:42 +00001443 pPager->noSync = level==1 || pPager->tempFile;
1444 pPager->fullSync = level==3 && !pPager->tempFile;
danielk19771d850a72004-05-31 08:26:49 +00001445 if( pPager->noSync ) pPager->needSync = 0;
drh973b6e32003-02-12 14:09:42 +00001446}
danielk197793758c82005-01-21 08:13:14 +00001447#endif
drh973b6e32003-02-12 14:09:42 +00001448
1449/*
drhfa86c412002-02-02 15:01:15 +00001450** Open a temporary file. Write the name of the file into zName
1451** (zName must be at least SQLITE_TEMPNAME_SIZE bytes long.) Write
1452** the file descriptor into *fd. Return SQLITE_OK on success or some
1453** other error code if we fail.
1454**
1455** The OS will automatically delete the temporary file when it is
1456** closed.
1457*/
drh3aac2dd2004-04-26 14:10:20 +00001458static int sqlite3pager_opentemp(char *zFile, OsFile *fd){
drhfa86c412002-02-02 15:01:15 +00001459 int cnt = 8;
1460 int rc;
1461 do{
1462 cnt--;
danielk19774adee202004-05-08 08:23:19 +00001463 sqlite3OsTempFileName(zFile);
1464 rc = sqlite3OsOpenExclusive(zFile, fd, 1);
danielk197713073932004-06-30 11:54:06 +00001465 }while( cnt>0 && rc!=SQLITE_OK && rc!=SQLITE_NOMEM );
drhfa86c412002-02-02 15:01:15 +00001466 return rc;
1467}
1468
1469/*
drhed7c8552001-04-11 14:29:21 +00001470** Create a new page cache and put a pointer to the page cache in *ppPager.
drh5e00f6c2001-09-13 13:46:56 +00001471** The file to be cached need not exist. The file is not locked until
drh3aac2dd2004-04-26 14:10:20 +00001472** the first call to sqlite3pager_get() and is only held open until the
1473** last page is released using sqlite3pager_unref().
drh382c0242001-10-06 16:33:02 +00001474**
drh6446c4d2001-12-15 14:22:18 +00001475** If zFilename is NULL then a randomly-named temporary file is created
1476** and used as the file to be cached. The file will be deleted
1477** automatically when it is closed.
drh90f5ecb2004-07-22 01:19:35 +00001478**
1479** If zFilename is ":memory:" then all information is held in cache.
1480** It is never written to disk. This can be used to implement an
1481** in-memory database.
drhed7c8552001-04-11 14:29:21 +00001482*/
drh3aac2dd2004-04-26 14:10:20 +00001483int sqlite3pager_open(
drh7e3b0a02001-04-28 16:52:40 +00001484 Pager **ppPager, /* Return the Pager structure here */
1485 const char *zFilename, /* Name of the database file to open */
drhda47d772002-12-02 04:25:19 +00001486 int nExtra, /* Extra bytes append to each in-memory page */
drh7bec5052005-02-06 02:45:41 +00001487 int flags /* flags controlling this file */
drh7e3b0a02001-04-28 16:52:40 +00001488){
drhed7c8552001-04-11 14:29:21 +00001489 Pager *pPager;
danielk19778def5ea2004-06-16 10:39:52 +00001490 char *zFullPathname = 0;
drhed7c8552001-04-11 14:29:21 +00001491 int nameLen;
drh8cfbf082001-09-19 13:22:39 +00001492 OsFile fd;
danielk1977cfe9a692004-06-16 12:00:29 +00001493 int rc = SQLITE_OK;
1494 int i;
danielk19778def5ea2004-06-16 10:39:52 +00001495 int tempFile = 0;
drhac69b052004-05-12 13:30:07 +00001496 int memDb = 0;
drh5e00f6c2001-09-13 13:46:56 +00001497 int readOnly = 0;
drh7bec5052005-02-06 02:45:41 +00001498 int useJournal = (flags & PAGER_OMIT_JOURNAL)==0;
1499 int noReadlock = (flags & PAGER_NO_READLOCK)!=0;
drh8cfbf082001-09-19 13:22:39 +00001500 char zTemp[SQLITE_TEMPNAME_SIZE];
drhed7c8552001-04-11 14:29:21 +00001501
drhd9b02572001-04-15 00:37:09 +00001502 *ppPager = 0;
drhda71ce12004-06-21 18:14:45 +00001503 memset(&fd, 0, sizeof(fd));
danielk19776f8a5032004-05-10 10:34:51 +00001504 if( sqlite3_malloc_failed ){
drhd9b02572001-04-15 00:37:09 +00001505 return SQLITE_NOMEM;
1506 }
drh901afd42003-08-26 11:25:58 +00001507 if( zFilename && zFilename[0] ){
drhb7f91642004-10-31 02:22:47 +00001508#ifndef SQLITE_OMIT_MEMORYDB
drhac69b052004-05-12 13:30:07 +00001509 if( strcmp(zFilename,":memory:")==0 ){
1510 memDb = 1;
drhda71ce12004-06-21 18:14:45 +00001511 zFullPathname = sqliteStrDup("");
drhac69b052004-05-12 13:30:07 +00001512 rc = SQLITE_OK;
drhb7f91642004-10-31 02:22:47 +00001513 }else
1514#endif
1515 {
drhac69b052004-05-12 13:30:07 +00001516 zFullPathname = sqlite3OsFullPathname(zFilename);
danielk19778def5ea2004-06-16 10:39:52 +00001517 if( zFullPathname ){
1518 rc = sqlite3OsOpenReadWrite(zFullPathname, &fd, &readOnly);
1519 }
drhac69b052004-05-12 13:30:07 +00001520 }
drh5e00f6c2001-09-13 13:46:56 +00001521 }else{
drh3aac2dd2004-04-26 14:10:20 +00001522 rc = sqlite3pager_opentemp(zTemp, &fd);
drh5e00f6c2001-09-13 13:46:56 +00001523 zFilename = zTemp;
danielk19774adee202004-05-08 08:23:19 +00001524 zFullPathname = sqlite3OsFullPathname(zFilename);
danielk19778def5ea2004-06-16 10:39:52 +00001525 if( rc==SQLITE_OK ){
1526 tempFile = 1;
1527 }
drh5e00f6c2001-09-13 13:46:56 +00001528 }
danielk19778def5ea2004-06-16 10:39:52 +00001529 if( !zFullPathname ){
danielk1977b5548a82004-06-26 13:51:33 +00001530 sqlite3OsClose(&fd);
drh3e7a6092002-12-07 21:45:14 +00001531 return SQLITE_NOMEM;
1532 }
drh8cfbf082001-09-19 13:22:39 +00001533 if( rc!=SQLITE_OK ){
drhda71ce12004-06-21 18:14:45 +00001534 sqlite3OsClose(&fd);
1535 sqliteFree(zFullPathname);
danielk19778def5ea2004-06-16 10:39:52 +00001536 return rc;
drhed7c8552001-04-11 14:29:21 +00001537 }
drh3e7a6092002-12-07 21:45:14 +00001538 nameLen = strlen(zFullPathname);
drha76c82e2003-07-27 18:59:42 +00001539 pPager = sqliteMalloc( sizeof(*pPager) + nameLen*3 + 30 );
drhd9b02572001-04-15 00:37:09 +00001540 if( pPager==0 ){
drhda71ce12004-06-21 18:14:45 +00001541 sqlite3OsClose(&fd);
1542 sqliteFree(zFullPathname);
drhd9b02572001-04-15 00:37:09 +00001543 return SQLITE_NOMEM;
1544 }
danielk1977ef73ee92004-11-06 12:26:07 +00001545 TRACE3("OPEN %d %s\n", FILEHANDLEID(fd), zFullPathname);
drhed7c8552001-04-11 14:29:21 +00001546 pPager->zFilename = (char*)&pPager[1];
drha76c82e2003-07-27 18:59:42 +00001547 pPager->zDirectory = &pPager->zFilename[nameLen+1];
1548 pPager->zJournal = &pPager->zDirectory[nameLen+1];
drh3e7a6092002-12-07 21:45:14 +00001549 strcpy(pPager->zFilename, zFullPathname);
drha76c82e2003-07-27 18:59:42 +00001550 strcpy(pPager->zDirectory, zFullPathname);
1551 for(i=nameLen; i>0 && pPager->zDirectory[i-1]!='/'; i--){}
1552 if( i>0 ) pPager->zDirectory[i-1] = 0;
drh3e7a6092002-12-07 21:45:14 +00001553 strcpy(pPager->zJournal, zFullPathname);
1554 sqliteFree(zFullPathname);
drhed7c8552001-04-11 14:29:21 +00001555 strcpy(&pPager->zJournal[nameLen], "-journal");
1556 pPager->fd = fd;
drh6d08b4d2004-07-20 12:45:22 +00001557#if OS_UNIX
drhd5b447d2004-07-19 22:08:09 +00001558 pPager->fd.pPager = pPager;
drh6d08b4d2004-07-20 12:45:22 +00001559#endif
drh8cfbf082001-09-19 13:22:39 +00001560 pPager->journalOpen = 0;
drhac69b052004-05-12 13:30:07 +00001561 pPager->useJournal = useJournal && !memDb;
drh7bec5052005-02-06 02:45:41 +00001562 pPager->noReadlock = noReadlock && readOnly;
drhac69b052004-05-12 13:30:07 +00001563 pPager->stmtOpen = 0;
1564 pPager->stmtInUse = 0;
drhed7c8552001-04-11 14:29:21 +00001565 pPager->nRef = 0;
drhac69b052004-05-12 13:30:07 +00001566 pPager->dbSize = memDb-1;
drh90f5ecb2004-07-22 01:19:35 +00001567 pPager->pageSize = SQLITE_DEFAULT_PAGE_SIZE;
drh887dc4c2004-10-22 16:22:57 +00001568 pPager->psAligned = FORCE_ALIGNMENT(pPager->pageSize);
drhac69b052004-05-12 13:30:07 +00001569 pPager->stmtSize = 0;
1570 pPager->stmtJSize = 0;
drhed7c8552001-04-11 14:29:21 +00001571 pPager->nPage = 0;
drh90f5ecb2004-07-22 01:19:35 +00001572 pPager->mxPage = 100;
drha6abd042004-06-09 17:37:22 +00001573 pPager->state = PAGER_UNLOCK;
drhd9b02572001-04-15 00:37:09 +00001574 pPager->errMask = 0;
drh5e00f6c2001-09-13 13:46:56 +00001575 pPager->tempFile = tempFile;
drhac69b052004-05-12 13:30:07 +00001576 pPager->memDb = memDb;
drh5e00f6c2001-09-13 13:46:56 +00001577 pPager->readOnly = readOnly;
drhf57b14a2001-09-14 18:54:08 +00001578 pPager->needSync = 0;
drhda47d772002-12-02 04:25:19 +00001579 pPager->noSync = pPager->tempFile || !useJournal;
danielk197775edc162004-06-26 01:48:18 +00001580 pPager->fullSync = (pPager->noSync?0:1);
drhed7c8552001-04-11 14:29:21 +00001581 pPager->pFirst = 0;
drh341eae82003-01-21 02:39:36 +00001582 pPager->pFirstSynced = 0;
drhed7c8552001-04-11 14:29:21 +00001583 pPager->pLast = 0;
drh887dc4c2004-10-22 16:22:57 +00001584 pPager->nExtra = FORCE_ALIGNMENT(nExtra);
danielk197776572402004-06-25 02:38:54 +00001585 pPager->sectorSize = PAGER_SECTOR_SIZE;
drh90f5ecb2004-07-22 01:19:35 +00001586 pPager->pBusyHandler = 0;
drhed7c8552001-04-11 14:29:21 +00001587 memset(pPager->aHash, 0, sizeof(pPager->aHash));
1588 *ppPager = pPager;
1589 return SQLITE_OK;
1590}
1591
1592/*
drh90f5ecb2004-07-22 01:19:35 +00001593** Set the busy handler function.
1594*/
1595void sqlite3pager_set_busyhandler(Pager *pPager, BusyHandler *pBusyHandler){
1596 pPager->pBusyHandler = pBusyHandler;
1597}
1598
1599/*
drh72f82862001-05-24 21:06:34 +00001600** Set the destructor for this pager. If not NULL, the destructor is called
drh5e00f6c2001-09-13 13:46:56 +00001601** when the reference count on each page reaches zero. The destructor can
1602** be used to clean up information in the extra segment appended to each page.
drh72f82862001-05-24 21:06:34 +00001603**
drh3aac2dd2004-04-26 14:10:20 +00001604** The destructor is not called as a result sqlite3pager_close().
1605** Destructors are only called by sqlite3pager_unref().
drh72f82862001-05-24 21:06:34 +00001606*/
drhb6f41482004-05-14 01:58:11 +00001607void sqlite3pager_set_destructor(Pager *pPager, void (*xDesc)(void*,int)){
drh72f82862001-05-24 21:06:34 +00001608 pPager->xDestructor = xDesc;
1609}
1610
1611/*
drha6abd042004-06-09 17:37:22 +00001612** Set the reinitializer for this pager. If not NULL, the reinitializer
1613** is called when the content of a page in cache is restored to its original
1614** value as a result of a rollback. The callback gives higher-level code
1615** an opportunity to restore the EXTRA section to agree with the restored
1616** page data.
1617*/
1618void sqlite3pager_set_reiniter(Pager *pPager, void (*xReinit)(void*,int)){
1619 pPager->xReiniter = xReinit;
1620}
1621
1622/*
drh90f5ecb2004-07-22 01:19:35 +00001623** Set the page size.
1624**
1625** The page size must only be changed when the cache is empty.
1626*/
1627void sqlite3pager_set_pagesize(Pager *pPager, int pageSize){
1628 assert( pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE );
1629 pPager->pageSize = pageSize;
drh887dc4c2004-10-22 16:22:57 +00001630 pPager->psAligned = FORCE_ALIGNMENT(pageSize);
drh90f5ecb2004-07-22 01:19:35 +00001631}
1632
1633/*
1634** Read the first N bytes from the beginning of the file into memory
1635** that pDest points to. No error checking is done.
1636*/
1637void sqlite3pager_read_fileheader(Pager *pPager, int N, unsigned char *pDest){
1638 memset(pDest, 0, N);
drhb7f91642004-10-31 02:22:47 +00001639 if( MEMDB==0 ){
drh90f5ecb2004-07-22 01:19:35 +00001640 sqlite3OsSeek(&pPager->fd, 0);
1641 sqlite3OsRead(&pPager->fd, pDest, N);
1642 }
1643}
1644
1645/*
drh5e00f6c2001-09-13 13:46:56 +00001646** Return the total number of pages in the disk file associated with
1647** pPager.
drhed7c8552001-04-11 14:29:21 +00001648*/
drh3aac2dd2004-04-26 14:10:20 +00001649int sqlite3pager_pagecount(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001650 i64 n;
drhd9b02572001-04-15 00:37:09 +00001651 assert( pPager!=0 );
drhed7c8552001-04-11 14:29:21 +00001652 if( pPager->dbSize>=0 ){
1653 return pPager->dbSize;
1654 }
danielk19774adee202004-05-08 08:23:19 +00001655 if( sqlite3OsFileSize(&pPager->fd, &n)!=SQLITE_OK ){
drh81a20f22001-10-12 17:30:04 +00001656 pPager->errMask |= PAGER_ERR_DISK;
drh8cfbf082001-09-19 13:22:39 +00001657 return 0;
drhed7c8552001-04-11 14:29:21 +00001658 }
drh90f5ecb2004-07-22 01:19:35 +00001659 n /= pPager->pageSize;
drhb7f91642004-10-31 02:22:47 +00001660 if( !MEMDB && n==PENDING_BYTE/pPager->pageSize ){
drh1f595712004-06-15 01:40:29 +00001661 n++;
1662 }
drha6abd042004-06-09 17:37:22 +00001663 if( pPager->state!=PAGER_UNLOCK ){
drhed7c8552001-04-11 14:29:21 +00001664 pPager->dbSize = n;
1665 }
1666 return n;
1667}
1668
1669/*
drhf7c57532003-04-25 13:22:51 +00001670** Forward declaration
1671*/
danielk197776572402004-06-25 02:38:54 +00001672static int syncJournal(Pager*);
drhf7c57532003-04-25 13:22:51 +00001673
drhac69b052004-05-12 13:30:07 +00001674
1675/*
danielk1977f5fdda82004-11-03 08:44:05 +00001676** Unlink pPg from it's hash chain. Also set the page number to 0 to indicate
1677** that the page is not part of any hash chain. This is required because the
1678** sqlite3pager_movepage() routine can leave a page in the
1679** pNextFree/pPrevFree list that is not a part of any hash-chain.
1680*/
1681static void unlinkHashChain(Pager *pPager, PgHdr *pPg){
1682 if( pPg->pgno==0 ){
1683 /* If the page number is zero, then this page is not in any hash chain. */
1684 return;
1685 }
1686 if( pPg->pNextHash ){
1687 pPg->pNextHash->pPrevHash = pPg->pPrevHash;
1688 }
1689 if( pPg->pPrevHash ){
1690 assert( pPager->aHash[pager_hash(pPg->pgno)]!=pPg );
1691 pPg->pPrevHash->pNextHash = pPg->pNextHash;
1692 }else{
1693 int h = pager_hash(pPg->pgno);
1694 assert( pPager->aHash[h]==pPg );
1695 pPager->aHash[h] = pPg->pNextHash;
1696 }
1697
1698 pPg->pgno = 0;
1699 pPg->pNextHash = pPg->pPrevHash = 0;
1700}
1701
1702/*
drhac69b052004-05-12 13:30:07 +00001703** Unlink a page from the free list (the list of all pages where nRef==0)
1704** and from its hash collision chain.
1705*/
1706static void unlinkPage(PgHdr *pPg){
1707 Pager *pPager = pPg->pPager;
1708
1709 /* Keep the pFirstSynced pointer pointing at the first synchronized page */
1710 if( pPg==pPager->pFirstSynced ){
1711 PgHdr *p = pPg->pNextFree;
1712 while( p && p->needSync ){ p = p->pNextFree; }
1713 pPager->pFirstSynced = p;
1714 }
1715
1716 /* Unlink from the freelist */
1717 if( pPg->pPrevFree ){
1718 pPg->pPrevFree->pNextFree = pPg->pNextFree;
1719 }else{
1720 assert( pPager->pFirst==pPg );
1721 pPager->pFirst = pPg->pNextFree;
1722 }
1723 if( pPg->pNextFree ){
1724 pPg->pNextFree->pPrevFree = pPg->pPrevFree;
1725 }else{
1726 assert( pPager->pLast==pPg );
1727 pPager->pLast = pPg->pPrevFree;
1728 }
1729 pPg->pNextFree = pPg->pPrevFree = 0;
1730
1731 /* Unlink from the pgno hash table */
danielk1977f5fdda82004-11-03 08:44:05 +00001732 unlinkHashChain(pPager, pPg);
drhac69b052004-05-12 13:30:07 +00001733}
1734
danielk1977b84f96f2005-01-20 11:32:23 +00001735#ifndef SQLITE_OMIT_MEMORYDB
drhac69b052004-05-12 13:30:07 +00001736/*
1737** This routine is used to truncate an in-memory database. Delete
danielk1977369f27e2004-06-15 11:40:04 +00001738** all pages whose pgno is larger than pPager->dbSize and is unreferenced.
drhac69b052004-05-12 13:30:07 +00001739** Referenced pages larger than pPager->dbSize are zeroed.
1740*/
1741static void memoryTruncate(Pager *pPager){
1742 PgHdr *pPg;
1743 PgHdr **ppPg;
1744 int dbSize = pPager->dbSize;
1745
1746 ppPg = &pPager->pAll;
1747 while( (pPg = *ppPg)!=0 ){
1748 if( pPg->pgno<=dbSize ){
1749 ppPg = &pPg->pNextAll;
1750 }else if( pPg->nRef>0 ){
1751 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
1752 ppPg = &pPg->pNextAll;
1753 }else{
1754 *ppPg = pPg->pNextAll;
1755 unlinkPage(pPg);
1756 sqliteFree(pPg);
1757 pPager->nPage--;
1758 }
1759 }
1760}
danielk1977b84f96f2005-01-20 11:32:23 +00001761#else
1762#define memoryTruncate(p)
1763#endif
drhac69b052004-05-12 13:30:07 +00001764
drhf7c57532003-04-25 13:22:51 +00001765/*
1766** Truncate the file to the number of pages specified.
1767*/
drh3aac2dd2004-04-26 14:10:20 +00001768int sqlite3pager_truncate(Pager *pPager, Pgno nPage){
drhf7c57532003-04-25 13:22:51 +00001769 int rc;
drhdc3ff9c2004-08-18 02:10:15 +00001770 sqlite3pager_pagecount(pPager);
drh2e6d11b2003-04-25 15:37:57 +00001771 if( pPager->errMask!=0 ){
1772 rc = pager_errcode(pPager);
1773 return rc;
1774 }
drh7d02cb72003-06-04 16:24:39 +00001775 if( nPage>=(unsigned)pPager->dbSize ){
drhf7c57532003-04-25 13:22:51 +00001776 return SQLITE_OK;
1777 }
drhb7f91642004-10-31 02:22:47 +00001778 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00001779 pPager->dbSize = nPage;
1780 memoryTruncate(pPager);
1781 return SQLITE_OK;
1782 }
danielk197776572402004-06-25 02:38:54 +00001783 rc = syncJournal(pPager);
danielk1977369f27e2004-06-15 11:40:04 +00001784 if( rc!=SQLITE_OK ){
1785 return rc;
1786 }
drhcb4c40b2004-08-18 19:09:43 +00001787 rc = pager_truncate(pPager, nPage);
drhf7c57532003-04-25 13:22:51 +00001788 if( rc==SQLITE_OK ){
1789 pPager->dbSize = nPage;
1790 }
1791 return rc;
1792}
1793
1794/*
drhed7c8552001-04-11 14:29:21 +00001795** Shutdown the page cache. Free all memory and close all files.
1796**
1797** If a transaction was in progress when this routine is called, that
1798** transaction is rolled back. All outstanding pages are invalidated
1799** and their memory is freed. Any attempt to use a page associated
1800** with this page cache after this function returns will likely
1801** result in a coredump.
1802*/
drh3aac2dd2004-04-26 14:10:20 +00001803int sqlite3pager_close(Pager *pPager){
drhd9b02572001-04-15 00:37:09 +00001804 PgHdr *pPg, *pNext;
drhed7c8552001-04-11 14:29:21 +00001805 switch( pPager->state ){
drha6abd042004-06-09 17:37:22 +00001806 case PAGER_RESERVED:
danielk1977aa5ccdf2004-06-14 05:10:42 +00001807 case PAGER_SYNCED:
drha6abd042004-06-09 17:37:22 +00001808 case PAGER_EXCLUSIVE: {
danielk1977b3bce662005-01-29 08:32:43 +00001809 /* We ignore any IO errors that occur during the rollback
1810 ** operation. So disable IO error simulation so that testing
1811 ** works more easily.
1812 */
1813#if defined(SQLITE_TEST) && (defined(OS_UNIX) || defined(OS_WIN))
1814 extern int sqlite3_io_error_pending;
1815 int ioerr_cnt = sqlite3_io_error_pending;
1816 sqlite3_io_error_pending = -1;
1817#endif
drh3aac2dd2004-04-26 14:10:20 +00001818 sqlite3pager_rollback(pPager);
danielk1977b3bce662005-01-29 08:32:43 +00001819#if defined(SQLITE_TEST) && (defined(OS_UNIX) || defined(OS_WIN))
1820 sqlite3_io_error_pending = ioerr_cnt;
1821#endif
drhb7f91642004-10-31 02:22:47 +00001822 if( !MEMDB ){
drha6abd042004-06-09 17:37:22 +00001823 sqlite3OsUnlock(&pPager->fd, NO_LOCK);
drhac69b052004-05-12 13:30:07 +00001824 }
drh8cfbf082001-09-19 13:22:39 +00001825 assert( pPager->journalOpen==0 );
drhed7c8552001-04-11 14:29:21 +00001826 break;
1827 }
drha6abd042004-06-09 17:37:22 +00001828 case PAGER_SHARED: {
drhb7f91642004-10-31 02:22:47 +00001829 if( !MEMDB ){
drha6abd042004-06-09 17:37:22 +00001830 sqlite3OsUnlock(&pPager->fd, NO_LOCK);
drhac69b052004-05-12 13:30:07 +00001831 }
drhed7c8552001-04-11 14:29:21 +00001832 break;
1833 }
1834 default: {
1835 /* Do nothing */
1836 break;
1837 }
1838 }
drhd9b02572001-04-15 00:37:09 +00001839 for(pPg=pPager->pAll; pPg; pPg=pNext){
danielk1977eac7a362004-06-16 07:45:24 +00001840#ifndef NDEBUG
drhb7f91642004-10-31 02:22:47 +00001841 if( MEMDB ){
danielk1977eac7a362004-06-16 07:45:24 +00001842 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
1843 assert( !pPg->alwaysRollback );
1844 assert( !pHist->pOrig );
1845 assert( !pHist->pStmt );
1846 }
1847#endif
drhd9b02572001-04-15 00:37:09 +00001848 pNext = pPg->pNextAll;
1849 sqliteFree(pPg);
drhed7c8552001-04-11 14:29:21 +00001850 }
danielk1977ef73ee92004-11-06 12:26:07 +00001851 TRACE2("CLOSE %d\n", PAGERID(pPager));
drhda71ce12004-06-21 18:14:45 +00001852 sqlite3OsClose(&pPager->fd);
drh8cfbf082001-09-19 13:22:39 +00001853 assert( pPager->journalOpen==0 );
drh0f892532002-05-30 12:27:03 +00001854 /* Temp files are automatically deleted by the OS
1855 ** if( pPager->tempFile ){
danielk19774adee202004-05-08 08:23:19 +00001856 ** sqlite3OsDelete(pPager->zFilename);
drh0f892532002-05-30 12:27:03 +00001857 ** }
1858 */
danielk1977aca790a2005-01-13 11:07:52 +00001859
drhed7c8552001-04-11 14:29:21 +00001860 sqliteFree(pPager);
1861 return SQLITE_OK;
1862}
1863
1864/*
drh5e00f6c2001-09-13 13:46:56 +00001865** Return the page number for the given page data.
drhed7c8552001-04-11 14:29:21 +00001866*/
drh3aac2dd2004-04-26 14:10:20 +00001867Pgno sqlite3pager_pagenumber(void *pData){
drhed7c8552001-04-11 14:29:21 +00001868 PgHdr *p = DATA_TO_PGHDR(pData);
1869 return p->pgno;
1870}
1871
1872/*
drhc8629a12004-05-08 20:07:40 +00001873** The page_ref() function increments the reference count for a page.
1874** If the page is currently on the freelist (the reference count is zero) then
drh7e3b0a02001-04-28 16:52:40 +00001875** remove it from the freelist.
drhc8629a12004-05-08 20:07:40 +00001876**
1877** For non-test systems, page_ref() is a macro that calls _page_ref()
1878** online of the reference count is zero. For test systems, page_ref()
1879** is a real function so that we can set breakpoints and trace it.
drh7e3b0a02001-04-28 16:52:40 +00001880*/
drh836faa42003-01-11 13:30:57 +00001881static void _page_ref(PgHdr *pPg){
drh7e3b0a02001-04-28 16:52:40 +00001882 if( pPg->nRef==0 ){
1883 /* The page is currently on the freelist. Remove it. */
drh341eae82003-01-21 02:39:36 +00001884 if( pPg==pPg->pPager->pFirstSynced ){
1885 PgHdr *p = pPg->pNextFree;
1886 while( p && p->needSync ){ p = p->pNextFree; }
1887 pPg->pPager->pFirstSynced = p;
1888 }
drh7e3b0a02001-04-28 16:52:40 +00001889 if( pPg->pPrevFree ){
1890 pPg->pPrevFree->pNextFree = pPg->pNextFree;
1891 }else{
1892 pPg->pPager->pFirst = pPg->pNextFree;
1893 }
1894 if( pPg->pNextFree ){
1895 pPg->pNextFree->pPrevFree = pPg->pPrevFree;
1896 }else{
1897 pPg->pPager->pLast = pPg->pPrevFree;
1898 }
1899 pPg->pPager->nRef++;
1900 }
1901 pPg->nRef++;
drhdd793422001-06-28 01:54:48 +00001902 REFINFO(pPg);
drhdf0b3b02001-06-23 11:36:20 +00001903}
danielk1977aca790a2005-01-13 11:07:52 +00001904#ifdef SQLITE_DEBUG
drhc8629a12004-05-08 20:07:40 +00001905 static void page_ref(PgHdr *pPg){
1906 if( pPg->nRef==0 ){
1907 _page_ref(pPg);
1908 }else{
1909 pPg->nRef++;
1910 REFINFO(pPg);
1911 }
1912 }
1913#else
1914# define page_ref(P) ((P)->nRef==0?_page_ref(P):(void)(P)->nRef++)
1915#endif
drhdf0b3b02001-06-23 11:36:20 +00001916
1917/*
1918** Increment the reference count for a page. The input pointer is
1919** a reference to the page data.
1920*/
drh3aac2dd2004-04-26 14:10:20 +00001921int sqlite3pager_ref(void *pData){
drhdf0b3b02001-06-23 11:36:20 +00001922 PgHdr *pPg = DATA_TO_PGHDR(pData);
1923 page_ref(pPg);
drh8c42ca92001-06-22 19:15:00 +00001924 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +00001925}
1926
1927/*
drh34e79ce2004-02-08 06:05:46 +00001928** Sync the journal. In other words, make sure all the pages that have
1929** been written to the journal have actually reached the surface of the
1930** disk. It is not safe to modify the original database file until after
1931** the journal has been synced. If the original database is modified before
1932** the journal is synced and a power failure occurs, the unsynced journal
1933** data would be lost and we would be unable to completely rollback the
1934** database changes. Database corruption would occur.
1935**
1936** This routine also updates the nRec field in the header of the journal.
1937** (See comments on the pager_playback() routine for additional information.)
1938** If the sync mode is FULL, two syncs will occur. First the whole journal
1939** is synced, then the nRec field is updated, then a second sync occurs.
drhb19a2bc2001-09-16 00:13:26 +00001940**
drh34e79ce2004-02-08 06:05:46 +00001941** For temporary databases, we do not care if we are able to rollback
1942** after a power failure, so sync occurs.
drhfa86c412002-02-02 15:01:15 +00001943**
drh34e79ce2004-02-08 06:05:46 +00001944** This routine clears the needSync field of every page current held in
1945** memory.
drh50e5dad2001-09-15 00:57:28 +00001946*/
danielk197776572402004-06-25 02:38:54 +00001947static int syncJournal(Pager *pPager){
drh50e5dad2001-09-15 00:57:28 +00001948 PgHdr *pPg;
1949 int rc = SQLITE_OK;
drh03eb96a2002-11-10 23:32:56 +00001950
1951 /* Sync the journal before modifying the main database
1952 ** (assuming there is a journal and it needs to be synced.)
1953 */
danielk197776572402004-06-25 02:38:54 +00001954 if( pPager->needSync ){
drhfa86c412002-02-02 15:01:15 +00001955 if( !pPager->tempFile ){
drhdb48ee02003-01-16 13:42:43 +00001956 assert( pPager->journalOpen );
drh946966f2004-02-25 02:20:41 +00001957 /* assert( !pPager->noSync ); // noSync might be set if synchronous
1958 ** was turned off after the transaction was started. Ticket #615 */
drh968af522003-02-11 14:55:40 +00001959#ifndef NDEBUG
1960 {
drh34e79ce2004-02-08 06:05:46 +00001961 /* Make sure the pPager->nRec counter we are keeping agrees
1962 ** with the nRec computed from the size of the journal file.
1963 */
drheb206252004-10-01 02:00:31 +00001964 i64 jSz;
danielk19774adee202004-05-08 08:23:19 +00001965 rc = sqlite3OsFileSize(&pPager->jfd, &jSz);
drh968af522003-02-11 14:55:40 +00001966 if( rc!=0 ) return rc;
danielk197776572402004-06-25 02:38:54 +00001967 assert( pPager->journalOff==jSz );
drh968af522003-02-11 14:55:40 +00001968 }
1969#endif
drhae2b40c2004-06-09 19:03:54 +00001970 {
danielk197776572402004-06-25 02:38:54 +00001971 /* Write the nRec value into the journal file header. If in
1972 ** full-synchronous mode, sync the journal first. This ensures that
1973 ** all data has really hit the disk before nRec is updated to mark
1974 ** it as a candidate for rollback.
1975 */
drhd8d66e82003-02-12 02:10:15 +00001976 if( pPager->fullSync ){
danielk1977ef73ee92004-11-06 12:26:07 +00001977 TRACE2("SYNC journal of %d\n", PAGERID(pPager));
danielk19774adee202004-05-08 08:23:19 +00001978 rc = sqlite3OsSync(&pPager->jfd);
drhd8d66e82003-02-12 02:10:15 +00001979 if( rc!=0 ) return rc;
1980 }
danielk197776572402004-06-25 02:38:54 +00001981 sqlite3OsSeek(&pPager->jfd, pPager->journalHdr + sizeof(aJournalMagic));
drh99ee3602003-02-16 19:13:36 +00001982 rc = write32bits(&pPager->jfd, pPager->nRec);
1983 if( rc ) return rc;
danielk197713adf8a2004-06-03 16:08:41 +00001984
danielk197776572402004-06-25 02:38:54 +00001985 sqlite3OsSeek(&pPager->jfd, pPager->journalOff);
drh968af522003-02-11 14:55:40 +00001986 }
danielk1977ef73ee92004-11-06 12:26:07 +00001987 TRACE2("SYNC journal of %d\n", PAGERID(pPager));
danielk19774adee202004-05-08 08:23:19 +00001988 rc = sqlite3OsSync(&pPager->jfd);
drhfa86c412002-02-02 15:01:15 +00001989 if( rc!=0 ) return rc;
drhdb48ee02003-01-16 13:42:43 +00001990 pPager->journalStarted = 1;
drhfa86c412002-02-02 15:01:15 +00001991 }
drh50e5dad2001-09-15 00:57:28 +00001992 pPager->needSync = 0;
drh341eae82003-01-21 02:39:36 +00001993
1994 /* Erase the needSync flag from every page.
1995 */
1996 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
1997 pPg->needSync = 0;
1998 }
1999 pPager->pFirstSynced = pPager->pFirst;
drh50e5dad2001-09-15 00:57:28 +00002000 }
drh03eb96a2002-11-10 23:32:56 +00002001
drh341eae82003-01-21 02:39:36 +00002002#ifndef NDEBUG
2003 /* If the Pager.needSync flag is clear then the PgHdr.needSync
2004 ** flag must also be clear for all pages. Verify that this
2005 ** invariant is true.
drh03eb96a2002-11-10 23:32:56 +00002006 */
drh341eae82003-01-21 02:39:36 +00002007 else{
2008 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2009 assert( pPg->needSync==0 );
2010 }
2011 assert( pPager->pFirstSynced==pPager->pFirst );
drh03eb96a2002-11-10 23:32:56 +00002012 }
drh341eae82003-01-21 02:39:36 +00002013#endif
drhdb48ee02003-01-16 13:42:43 +00002014
drh81a20f22001-10-12 17:30:04 +00002015 return rc;
drh50e5dad2001-09-15 00:57:28 +00002016}
2017
2018/*
drh684917c2004-10-05 02:41:42 +00002019** Try to obtain a lock on a file. Invoke the busy callback if the lock
2020** is currently not available. Repeate until the busy callback returns
2021** false or until the lock succeeds.
2022**
2023** Return SQLITE_OK on success and an error code if we cannot obtain
2024** the lock.
2025*/
2026static int pager_wait_on_lock(Pager *pPager, int locktype){
2027 int rc;
2028 assert( PAGER_SHARED==SHARED_LOCK );
2029 assert( PAGER_RESERVED==RESERVED_LOCK );
2030 assert( PAGER_EXCLUSIVE==EXCLUSIVE_LOCK );
2031 if( pPager->state>=locktype ){
2032 rc = SQLITE_OK;
2033 }else{
2034 int busy = 1;
2035 do {
2036 rc = sqlite3OsLock(&pPager->fd, locktype);
2037 }while( rc==SQLITE_BUSY &&
2038 pPager->pBusyHandler &&
2039 pPager->pBusyHandler->xFunc &&
2040 pPager->pBusyHandler->xFunc(pPager->pBusyHandler->pArg, busy++)
2041 );
2042 if( rc==SQLITE_OK ){
2043 pPager->state = locktype;
2044 }
2045 }
2046 return rc;
2047}
2048
2049/*
drh2554f8b2003-01-22 01:26:44 +00002050** Given a list of pages (connected by the PgHdr.pDirty pointer) write
2051** every one of those pages out to the database file and mark them all
2052** as clean.
2053*/
2054static int pager_write_pagelist(PgHdr *pList){
2055 Pager *pPager;
2056 int rc;
2057
2058 if( pList==0 ) return SQLITE_OK;
2059 pPager = pList->pPager;
danielk19779eed5052004-06-04 10:38:30 +00002060
2061 /* At this point there may be either a RESERVED or EXCLUSIVE lock on the
2062 ** database file. If there is already an EXCLUSIVE lock, the following
2063 ** calls to sqlite3OsLock() are no-ops.
2064 **
drha6abd042004-06-09 17:37:22 +00002065 ** Moving the lock from RESERVED to EXCLUSIVE actually involves going
2066 ** through an intermediate state PENDING. A PENDING lock prevents new
2067 ** readers from attaching to the database but is unsufficient for us to
2068 ** write. The idea of a PENDING lock is to prevent new readers from
2069 ** coming in while we wait for existing readers to clear.
danielk19779eed5052004-06-04 10:38:30 +00002070 **
drha6abd042004-06-09 17:37:22 +00002071 ** While the pager is in the RESERVED state, the original database file
2072 ** is unchanged and we can rollback without having to playback the
2073 ** journal into the original database file. Once we transition to
2074 ** EXCLUSIVE, it means the database file has been changed and any rollback
2075 ** will require a journal playback.
danielk19779eed5052004-06-04 10:38:30 +00002076 */
drh684917c2004-10-05 02:41:42 +00002077 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
danielk19779eed5052004-06-04 10:38:30 +00002078 if( rc!=SQLITE_OK ){
2079 return rc;
2080 }
2081
drh2554f8b2003-01-22 01:26:44 +00002082 while( pList ){
2083 assert( pList->dirty );
drheb206252004-10-01 02:00:31 +00002084 sqlite3OsSeek(&pPager->fd, (pList->pgno-1)*(i64)pPager->pageSize);
danielk1977687566d2004-11-02 12:56:41 +00002085 /* If there are dirty pages in the page cache with page numbers greater
2086 ** than Pager.dbSize, this means sqlite3pager_truncate() was called to
2087 ** make the file smaller (presumably by auto-vacuum code). Do not write
2088 ** any such pages to the file.
2089 */
2090 if( pList->pgno<=pPager->dbSize ){
2091 CODEC(pPager, PGHDR_TO_DATA(pList), pList->pgno, 6);
danielk1977ef73ee92004-11-06 12:26:07 +00002092 TRACE3("STORE %d page %d\n", PAGERID(pPager), pList->pgno);
danielk1977687566d2004-11-02 12:56:41 +00002093 rc = sqlite3OsWrite(&pPager->fd, PGHDR_TO_DATA(pList), pPager->pageSize);
2094 CODEC(pPager, PGHDR_TO_DATA(pList), pList->pgno, 0);
danielk197742741be2005-01-08 12:42:39 +00002095 pPager->nWrite++;
danielk1977687566d2004-11-02 12:56:41 +00002096 }
2097#ifndef NDEBUG
2098 else{
danielk1977ef73ee92004-11-06 12:26:07 +00002099 TRACE3("NOSTORE %d page %d\n", PAGERID(pPager), pList->pgno);
danielk1977687566d2004-11-02 12:56:41 +00002100 }
2101#endif
drh2554f8b2003-01-22 01:26:44 +00002102 if( rc ) return rc;
2103 pList->dirty = 0;
2104 pList = pList->pDirty;
2105 }
2106 return SQLITE_OK;
2107}
2108
2109/*
2110** Collect every dirty page into a dirty list and
2111** return a pointer to the head of that list. All pages are
2112** collected even if they are still in use.
2113*/
2114static PgHdr *pager_get_all_dirty_pages(Pager *pPager){
2115 PgHdr *p, *pList;
2116 pList = 0;
2117 for(p=pPager->pAll; p; p=p->pNextAll){
2118 if( p->dirty ){
2119 p->pDirty = pList;
2120 pList = p;
2121 }
2122 }
2123 return pList;
2124}
2125
2126/*
drhd9b02572001-04-15 00:37:09 +00002127** Acquire a page.
2128**
drh58a11682001-11-10 13:51:08 +00002129** A read lock on the disk file is obtained when the first page is acquired.
drh5e00f6c2001-09-13 13:46:56 +00002130** This read lock is dropped when the last page is released.
drhd9b02572001-04-15 00:37:09 +00002131**
drh306dc212001-05-21 13:45:10 +00002132** A _get works for any page number greater than 0. If the database
2133** file is smaller than the requested page, then no actual disk
2134** read occurs and the memory image of the page is initialized to
2135** all zeros. The extra data appended to a page is always initialized
2136** to zeros the first time a page is loaded into memory.
2137**
drhd9b02572001-04-15 00:37:09 +00002138** The acquisition might fail for several reasons. In all cases,
2139** an appropriate error code is returned and *ppPage is set to NULL.
drh7e3b0a02001-04-28 16:52:40 +00002140**
drh3aac2dd2004-04-26 14:10:20 +00002141** See also sqlite3pager_lookup(). Both this routine and _lookup() attempt
drh7e3b0a02001-04-28 16:52:40 +00002142** to find a page in the in-memory cache first. If the page is not already
drh5e00f6c2001-09-13 13:46:56 +00002143** in memory, this routine goes to disk to read it in whereas _lookup()
drh7e3b0a02001-04-28 16:52:40 +00002144** just returns 0. This routine acquires a read-lock the first time it
2145** has to go to disk, and could also playback an old journal if necessary.
2146** Since _lookup() never goes to disk, it never has to deal with locks
2147** or journal files.
drhed7c8552001-04-11 14:29:21 +00002148*/
drh3aac2dd2004-04-26 14:10:20 +00002149int sqlite3pager_get(Pager *pPager, Pgno pgno, void **ppPage){
drhed7c8552001-04-11 14:29:21 +00002150 PgHdr *pPg;
drh7bec5052005-02-06 02:45:41 +00002151 int rc, n;
drhed7c8552001-04-11 14:29:21 +00002152
danielk197726836652005-01-17 01:33:13 +00002153 /* The maximum page number is 2^31. Return SQLITE_CORRUPT if a page
2154 ** number greater than this, or zero, is requested.
2155 */
2156 if( pgno>PAGER_MAX_PGNO || pgno==0 ){
2157 return SQLITE_CORRUPT;
2158 }
2159
drhd9b02572001-04-15 00:37:09 +00002160 /* Make sure we have not hit any critical errors.
2161 */
drh836faa42003-01-11 13:30:57 +00002162 assert( pPager!=0 );
drh2e6d11b2003-04-25 15:37:57 +00002163 *ppPage = 0;
drhd9b02572001-04-15 00:37:09 +00002164 if( pPager->errMask & ~(PAGER_ERR_FULL) ){
2165 return pager_errcode(pPager);
2166 }
2167
danielk197713adf8a2004-06-03 16:08:41 +00002168 /* If this is the first page accessed, then get a SHARED lock
drhed7c8552001-04-11 14:29:21 +00002169 ** on the database file.
2170 */
drhb7f91642004-10-31 02:22:47 +00002171 if( pPager->nRef==0 && !MEMDB ){
drh7bec5052005-02-06 02:45:41 +00002172 if( !pPager->noReadlock ){
2173 rc = pager_wait_on_lock(pPager, SHARED_LOCK);
2174 if( rc!=SQLITE_OK ){
2175 return rc;
2176 }
drhed7c8552001-04-11 14:29:21 +00002177 }
2178
danielk197713adf8a2004-06-03 16:08:41 +00002179 /* If a journal file exists, and there is no RESERVED lock on the
2180 ** database file, then it either needs to be played back or deleted.
drhed7c8552001-04-11 14:29:21 +00002181 */
danielk197713adf8a2004-06-03 16:08:41 +00002182 if( pPager->useJournal &&
2183 sqlite3OsFileExists(pPager->zJournal) &&
drha6abd042004-06-09 17:37:22 +00002184 !sqlite3OsCheckReservedLock(&pPager->fd)
danielk197713adf8a2004-06-03 16:08:41 +00002185 ){
drhe2227f02003-06-14 11:42:57 +00002186 int rc;
drhed7c8552001-04-11 14:29:21 +00002187
danielk197790ba3bd2004-06-25 08:32:25 +00002188 /* Get an EXCLUSIVE lock on the database file. At this point it is
2189 ** important that a RESERVED lock is not obtained on the way to the
2190 ** EXCLUSIVE lock. If it were, another process might open the
2191 ** database file, detect the RESERVED lock, and conclude that the
2192 ** database is safe to read while this process is still rolling it
2193 ** back.
2194 **
2195 ** Because the intermediate RESERVED lock is not requested, the
2196 ** second process will get to this point in the code and fail to
2197 ** obtain it's own EXCLUSIVE lock on the database file.
2198 */
danielk197713adf8a2004-06-03 16:08:41 +00002199 rc = sqlite3OsLock(&pPager->fd, EXCLUSIVE_LOCK);
drha7fcb052001-12-14 15:09:55 +00002200 if( rc!=SQLITE_OK ){
drha6abd042004-06-09 17:37:22 +00002201 sqlite3OsUnlock(&pPager->fd, NO_LOCK);
2202 pPager->state = PAGER_UNLOCK;
drh8766c342002-11-09 00:33:15 +00002203 return rc;
drha7fcb052001-12-14 15:09:55 +00002204 }
drha6abd042004-06-09 17:37:22 +00002205 pPager->state = PAGER_EXCLUSIVE;
drha7fcb052001-12-14 15:09:55 +00002206
drhe2227f02003-06-14 11:42:57 +00002207 /* Open the journal for reading only. Return SQLITE_BUSY if
2208 ** we are unable to open the journal file.
drhf57b3392001-10-08 13:22:32 +00002209 **
drhe2227f02003-06-14 11:42:57 +00002210 ** The journal file does not need to be locked itself. The
2211 ** journal file is never open unless the main database file holds
2212 ** a write lock, so there is never any chance of two or more
2213 ** processes opening the journal at the same time.
drhed7c8552001-04-11 14:29:21 +00002214 */
danielk19774adee202004-05-08 08:23:19 +00002215 rc = sqlite3OsOpenReadOnly(pPager->zJournal, &pPager->jfd);
drha7fcb052001-12-14 15:09:55 +00002216 if( rc!=SQLITE_OK ){
drha6abd042004-06-09 17:37:22 +00002217 sqlite3OsUnlock(&pPager->fd, NO_LOCK);
2218 pPager->state = PAGER_UNLOCK;
drhed7c8552001-04-11 14:29:21 +00002219 return SQLITE_BUSY;
2220 }
drha7fcb052001-12-14 15:09:55 +00002221 pPager->journalOpen = 1;
drhdb48ee02003-01-16 13:42:43 +00002222 pPager->journalStarted = 0;
danielk197776572402004-06-25 02:38:54 +00002223 pPager->journalOff = 0;
2224 pPager->setMaster = 0;
2225 pPager->journalHdr = 0;
drhed7c8552001-04-11 14:29:21 +00002226
2227 /* Playback and delete the journal. Drop the database write
2228 ** lock and reacquire the read lock.
2229 */
danielk197776572402004-06-25 02:38:54 +00002230 rc = pager_playback(pPager);
drhd9b02572001-04-15 00:37:09 +00002231 if( rc!=SQLITE_OK ){
2232 return rc;
2233 }
drhed7c8552001-04-11 14:29:21 +00002234 }
2235 pPg = 0;
2236 }else{
2237 /* Search for page in cache */
drhd9b02572001-04-15 00:37:09 +00002238 pPg = pager_lookup(pPager, pgno);
drhb7f91642004-10-31 02:22:47 +00002239 if( MEMDB && pPager->state==PAGER_UNLOCK ){
drha6abd042004-06-09 17:37:22 +00002240 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00002241 }
drhed7c8552001-04-11 14:29:21 +00002242 }
2243 if( pPg==0 ){
drhd9b02572001-04-15 00:37:09 +00002244 /* The requested page is not in the page cache. */
drhed7c8552001-04-11 14:29:21 +00002245 int h;
drh7e3b0a02001-04-28 16:52:40 +00002246 pPager->nMiss++;
drhb7f91642004-10-31 02:22:47 +00002247 if( pPager->nPage<pPager->mxPage || pPager->pFirst==0 || MEMDB ){
drhed7c8552001-04-11 14:29:21 +00002248 /* Create a new page */
drh887dc4c2004-10-22 16:22:57 +00002249 pPg = sqliteMallocRaw( sizeof(*pPg) + pPager->psAligned
drhac69b052004-05-12 13:30:07 +00002250 + sizeof(u32) + pPager->nExtra
drhb7f91642004-10-31 02:22:47 +00002251 + MEMDB*sizeof(PgHistory) );
drhd9b02572001-04-15 00:37:09 +00002252 if( pPg==0 ){
drhb7f91642004-10-31 02:22:47 +00002253 if( !MEMDB ){
danielk19778def5ea2004-06-16 10:39:52 +00002254 pager_unwritelock(pPager);
2255 }
drhd9b02572001-04-15 00:37:09 +00002256 pPager->errMask |= PAGER_ERR_MEM;
2257 return SQLITE_NOMEM;
2258 }
drh8c1238a2003-01-02 14:43:55 +00002259 memset(pPg, 0, sizeof(*pPg));
drhb7f91642004-10-31 02:22:47 +00002260 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00002261 memset(PGHDR_TO_HIST(pPg, pPager), 0, sizeof(PgHistory));
2262 }
drhed7c8552001-04-11 14:29:21 +00002263 pPg->pPager = pPager;
drhd9b02572001-04-15 00:37:09 +00002264 pPg->pNextAll = pPager->pAll;
drhd79caeb2001-04-15 02:27:24 +00002265 pPager->pAll = pPg;
drhd9b02572001-04-15 00:37:09 +00002266 pPager->nPage++;
drhed7c8552001-04-11 14:29:21 +00002267 }else{
drhdb48ee02003-01-16 13:42:43 +00002268 /* Find a page to recycle. Try to locate a page that does not
2269 ** require us to do an fsync() on the journal.
2270 */
drh341eae82003-01-21 02:39:36 +00002271 pPg = pPager->pFirstSynced;
drhb19a2bc2001-09-16 00:13:26 +00002272
drhdb48ee02003-01-16 13:42:43 +00002273 /* If we could not find a page that does not require an fsync()
2274 ** on the journal file then fsync the journal file. This is a
2275 ** very slow operation, so we work hard to avoid it. But sometimes
2276 ** it can't be helped.
drhb19a2bc2001-09-16 00:13:26 +00002277 */
drh603240c2002-03-05 01:11:12 +00002278 if( pPg==0 ){
danielk197776572402004-06-25 02:38:54 +00002279 int rc = syncJournal(pPager);
drh50e5dad2001-09-15 00:57:28 +00002280 if( rc!=0 ){
drh3aac2dd2004-04-26 14:10:20 +00002281 sqlite3pager_rollback(pPager);
drh50e5dad2001-09-15 00:57:28 +00002282 return SQLITE_IOERR;
2283 }
danielk197776572402004-06-25 02:38:54 +00002284 if( pPager->fullSync ){
2285 /* If in full-sync mode, write a new journal header into the
2286 ** journal file. This is done to avoid ever modifying a journal
2287 ** header that is involved in the rollback of pages that have
2288 ** already been written to the database (in case the header is
2289 ** trashed when the nRec field is updated).
2290 */
2291 pPager->nRec = 0;
danielk1977f187bd92004-06-25 06:23:22 +00002292 assert( pPager->journalOff > 0 );
danielk197776572402004-06-25 02:38:54 +00002293 rc = writeJournalHdr(pPager);
2294 if( rc!=0 ){
2295 sqlite3pager_rollback(pPager);
2296 return SQLITE_IOERR;
2297 }
2298 }
drh50e5dad2001-09-15 00:57:28 +00002299 pPg = pPager->pFirst;
2300 }
drhd9b02572001-04-15 00:37:09 +00002301 assert( pPg->nRef==0 );
drhdb48ee02003-01-16 13:42:43 +00002302
2303 /* Write the page to the database file if it is dirty.
2304 */
2305 if( pPg->dirty ){
2306 assert( pPg->needSync==0 );
drh2554f8b2003-01-22 01:26:44 +00002307 pPg->pDirty = 0;
2308 rc = pager_write_pagelist( pPg );
drhdb48ee02003-01-16 13:42:43 +00002309 if( rc!=SQLITE_OK ){
drh3aac2dd2004-04-26 14:10:20 +00002310 sqlite3pager_rollback(pPager);
drhdb48ee02003-01-16 13:42:43 +00002311 return SQLITE_IOERR;
2312 }
drhdb48ee02003-01-16 13:42:43 +00002313 }
drh50e5dad2001-09-15 00:57:28 +00002314 assert( pPg->dirty==0 );
drhd9b02572001-04-15 00:37:09 +00002315
drhdb48ee02003-01-16 13:42:43 +00002316 /* If the page we are recycling is marked as alwaysRollback, then
drh193a6b42002-07-07 16:52:46 +00002317 ** set the global alwaysRollback flag, thus disabling the
2318 ** sqlite_dont_rollback() optimization for the rest of this transaction.
2319 ** It is necessary to do this because the page marked alwaysRollback
2320 ** might be reloaded at a later time but at that point we won't remember
2321 ** that is was marked alwaysRollback. This means that all pages must
2322 ** be marked as alwaysRollback from here on out.
2323 */
2324 if( pPg->alwaysRollback ){
2325 pPager->alwaysRollback = 1;
2326 }
2327
drhd9b02572001-04-15 00:37:09 +00002328 /* Unlink the old page from the free list and the hash table
2329 */
drhac69b052004-05-12 13:30:07 +00002330 unlinkPage(pPg);
drhd9b02572001-04-15 00:37:09 +00002331 pPager->nOvfl++;
drhed7c8552001-04-11 14:29:21 +00002332 }
2333 pPg->pgno = pgno;
drh1ab43002002-01-14 09:28:19 +00002334 if( pPager->aInJournal && (int)pgno<=pPager->origDbSize ){
danielk19774adee202004-05-08 08:23:19 +00002335 sqlite3CheckMemory(pPager->aInJournal, pgno/8);
drhdb48ee02003-01-16 13:42:43 +00002336 assert( pPager->journalOpen );
drh6019e162001-07-02 17:51:45 +00002337 pPg->inJournal = (pPager->aInJournal[pgno/8] & (1<<(pgno&7)))!=0;
drhdb48ee02003-01-16 13:42:43 +00002338 pPg->needSync = 0;
drh6019e162001-07-02 17:51:45 +00002339 }else{
2340 pPg->inJournal = 0;
drhdb48ee02003-01-16 13:42:43 +00002341 pPg->needSync = 0;
drh6019e162001-07-02 17:51:45 +00002342 }
drhac69b052004-05-12 13:30:07 +00002343 if( pPager->aInStmt && (int)pgno<=pPager->stmtSize
2344 && (pPager->aInStmt[pgno/8] & (1<<(pgno&7)))!=0 ){
drh3aac2dd2004-04-26 14:10:20 +00002345 page_add_to_stmt_list(pPg);
drhfa86c412002-02-02 15:01:15 +00002346 }else{
drh3aac2dd2004-04-26 14:10:20 +00002347 page_remove_from_stmt_list(pPg);
drhfa86c412002-02-02 15:01:15 +00002348 }
drhed7c8552001-04-11 14:29:21 +00002349 pPg->dirty = 0;
2350 pPg->nRef = 1;
drhdd793422001-06-28 01:54:48 +00002351 REFINFO(pPg);
drhd9b02572001-04-15 00:37:09 +00002352 pPager->nRef++;
2353 h = pager_hash(pgno);
drhed7c8552001-04-11 14:29:21 +00002354 pPg->pNextHash = pPager->aHash[h];
2355 pPager->aHash[h] = pPg;
2356 if( pPg->pNextHash ){
2357 assert( pPg->pNextHash->pPrevHash==0 );
2358 pPg->pNextHash->pPrevHash = pPg;
2359 }
drh2e6d11b2003-04-25 15:37:57 +00002360 if( pPager->nExtra>0 ){
drh90f5ecb2004-07-22 01:19:35 +00002361 memset(PGHDR_TO_EXTRA(pPg, pPager), 0, pPager->nExtra);
drh2e6d11b2003-04-25 15:37:57 +00002362 }
drh7bec5052005-02-06 02:45:41 +00002363 n = sqlite3pager_pagecount(pPager);
drh2e6d11b2003-04-25 15:37:57 +00002364 if( pPager->errMask!=0 ){
drh3aac2dd2004-04-26 14:10:20 +00002365 sqlite3pager_unref(PGHDR_TO_DATA(pPg));
drh2e6d11b2003-04-25 15:37:57 +00002366 rc = pager_errcode(pPager);
2367 return rc;
2368 }
drh7bec5052005-02-06 02:45:41 +00002369 if( n<(int)pgno ){
drh90f5ecb2004-07-22 01:19:35 +00002370 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
drh306dc212001-05-21 13:45:10 +00002371 }else{
drh81a20f22001-10-12 17:30:04 +00002372 int rc;
drhb7f91642004-10-31 02:22:47 +00002373 assert( MEMDB==0 );
drheb206252004-10-01 02:00:31 +00002374 sqlite3OsSeek(&pPager->fd, (pgno-1)*(i64)pPager->pageSize);
drh90f5ecb2004-07-22 01:19:35 +00002375 rc = sqlite3OsRead(&pPager->fd, PGHDR_TO_DATA(pPg), pPager->pageSize);
danielk1977ef73ee92004-11-06 12:26:07 +00002376 TRACE3("FETCH %d page %d\n", PAGERID(pPager), pPg->pgno);
drh9eb9e262004-02-11 02:18:05 +00002377 CODEC(pPager, PGHDR_TO_DATA(pPg), pPg->pgno, 3);
drh81a20f22001-10-12 17:30:04 +00002378 if( rc!=SQLITE_OK ){
drheb206252004-10-01 02:00:31 +00002379 i64 fileSize;
danielk19774adee202004-05-08 08:23:19 +00002380 if( sqlite3OsFileSize(&pPager->fd,&fileSize)!=SQLITE_OK
drh90f5ecb2004-07-22 01:19:35 +00002381 || fileSize>=pgno*pPager->pageSize ){
drh3aac2dd2004-04-26 14:10:20 +00002382 sqlite3pager_unref(PGHDR_TO_DATA(pPg));
drh4e371ee2002-09-05 16:08:27 +00002383 return rc;
2384 }else{
drh90f5ecb2004-07-22 01:19:35 +00002385 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
drh4e371ee2002-09-05 16:08:27 +00002386 }
danielk197742741be2005-01-08 12:42:39 +00002387 }else{
2388 pPager->nRead++;
drh81a20f22001-10-12 17:30:04 +00002389 }
drh306dc212001-05-21 13:45:10 +00002390 }
drhed7c8552001-04-11 14:29:21 +00002391 }else{
drhd9b02572001-04-15 00:37:09 +00002392 /* The requested page is in the page cache. */
drh7e3b0a02001-04-28 16:52:40 +00002393 pPager->nHit++;
drhdf0b3b02001-06-23 11:36:20 +00002394 page_ref(pPg);
drhed7c8552001-04-11 14:29:21 +00002395 }
2396 *ppPage = PGHDR_TO_DATA(pPg);
2397 return SQLITE_OK;
2398}
2399
2400/*
drh7e3b0a02001-04-28 16:52:40 +00002401** Acquire a page if it is already in the in-memory cache. Do
2402** not read the page from disk. Return a pointer to the page,
2403** or 0 if the page is not in cache.
2404**
drh3aac2dd2004-04-26 14:10:20 +00002405** See also sqlite3pager_get(). The difference between this routine
2406** and sqlite3pager_get() is that _get() will go to the disk and read
drh7e3b0a02001-04-28 16:52:40 +00002407** in the page if the page is not already in cache. This routine
drh5e00f6c2001-09-13 13:46:56 +00002408** returns NULL if the page is not in cache or if a disk I/O error
2409** has ever happened.
drh7e3b0a02001-04-28 16:52:40 +00002410*/
drh3aac2dd2004-04-26 14:10:20 +00002411void *sqlite3pager_lookup(Pager *pPager, Pgno pgno){
drh7e3b0a02001-04-28 16:52:40 +00002412 PgHdr *pPg;
2413
drh836faa42003-01-11 13:30:57 +00002414 assert( pPager!=0 );
2415 assert( pgno!=0 );
drh7e3b0a02001-04-28 16:52:40 +00002416 if( pPager->errMask & ~(PAGER_ERR_FULL) ){
2417 return 0;
2418 }
drh7e3b0a02001-04-28 16:52:40 +00002419 pPg = pager_lookup(pPager, pgno);
2420 if( pPg==0 ) return 0;
drhdf0b3b02001-06-23 11:36:20 +00002421 page_ref(pPg);
drh7e3b0a02001-04-28 16:52:40 +00002422 return PGHDR_TO_DATA(pPg);
2423}
2424
2425/*
drhed7c8552001-04-11 14:29:21 +00002426** Release a page.
2427**
2428** If the number of references to the page drop to zero, then the
2429** page is added to the LRU list. When all references to all pages
drhd9b02572001-04-15 00:37:09 +00002430** are released, a rollback occurs and the lock on the database is
drhed7c8552001-04-11 14:29:21 +00002431** removed.
2432*/
drh3aac2dd2004-04-26 14:10:20 +00002433int sqlite3pager_unref(void *pData){
drhed7c8552001-04-11 14:29:21 +00002434 PgHdr *pPg;
drhd9b02572001-04-15 00:37:09 +00002435
2436 /* Decrement the reference count for this page
2437 */
drhed7c8552001-04-11 14:29:21 +00002438 pPg = DATA_TO_PGHDR(pData);
2439 assert( pPg->nRef>0 );
drhed7c8552001-04-11 14:29:21 +00002440 pPg->nRef--;
drhdd793422001-06-28 01:54:48 +00002441 REFINFO(pPg);
drhd9b02572001-04-15 00:37:09 +00002442
drh72f82862001-05-24 21:06:34 +00002443 /* When the number of references to a page reach 0, call the
2444 ** destructor and add the page to the freelist.
drhd9b02572001-04-15 00:37:09 +00002445 */
drhed7c8552001-04-11 14:29:21 +00002446 if( pPg->nRef==0 ){
drh1eaa2692001-09-18 02:02:23 +00002447 Pager *pPager;
2448 pPager = pPg->pPager;
drhd9b02572001-04-15 00:37:09 +00002449 pPg->pNextFree = 0;
2450 pPg->pPrevFree = pPager->pLast;
drhed7c8552001-04-11 14:29:21 +00002451 pPager->pLast = pPg;
drhd9b02572001-04-15 00:37:09 +00002452 if( pPg->pPrevFree ){
2453 pPg->pPrevFree->pNextFree = pPg;
drhed7c8552001-04-11 14:29:21 +00002454 }else{
2455 pPager->pFirst = pPg;
2456 }
drh341eae82003-01-21 02:39:36 +00002457 if( pPg->needSync==0 && pPager->pFirstSynced==0 ){
2458 pPager->pFirstSynced = pPg;
2459 }
drh72f82862001-05-24 21:06:34 +00002460 if( pPager->xDestructor ){
drhb6f41482004-05-14 01:58:11 +00002461 pPager->xDestructor(pData, pPager->pageSize);
drh72f82862001-05-24 21:06:34 +00002462 }
drhd9b02572001-04-15 00:37:09 +00002463
2464 /* When all pages reach the freelist, drop the read lock from
2465 ** the database file.
2466 */
2467 pPager->nRef--;
2468 assert( pPager->nRef>=0 );
drhb7f91642004-10-31 02:22:47 +00002469 if( pPager->nRef==0 && !MEMDB ){
drhd9b02572001-04-15 00:37:09 +00002470 pager_reset(pPager);
2471 }
drhed7c8552001-04-11 14:29:21 +00002472 }
drhd9b02572001-04-15 00:37:09 +00002473 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +00002474}
2475
2476/*
drha6abd042004-06-09 17:37:22 +00002477** Create a journal file for pPager. There should already be a RESERVED
2478** or EXCLUSIVE lock on the database file when this routine is called.
drhda47d772002-12-02 04:25:19 +00002479**
2480** Return SQLITE_OK if everything. Return an error code and release the
2481** write lock if anything goes wrong.
2482*/
2483static int pager_open_journal(Pager *pPager){
2484 int rc;
drhb7f91642004-10-31 02:22:47 +00002485 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +00002486 assert( pPager->state>=PAGER_RESERVED );
drhda47d772002-12-02 04:25:19 +00002487 assert( pPager->journalOpen==0 );
2488 assert( pPager->useJournal );
drh3aac2dd2004-04-26 14:10:20 +00002489 sqlite3pager_pagecount(pPager);
drhda47d772002-12-02 04:25:19 +00002490 pPager->aInJournal = sqliteMalloc( pPager->dbSize/8 + 1 );
2491 if( pPager->aInJournal==0 ){
drh9c105bb2004-10-02 20:38:28 +00002492 rc = SQLITE_NOMEM;
2493 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00002494 }
danielk19774adee202004-05-08 08:23:19 +00002495 rc = sqlite3OsOpenExclusive(pPager->zJournal, &pPager->jfd,pPager->tempFile);
danielk197776572402004-06-25 02:38:54 +00002496 pPager->journalOff = 0;
2497 pPager->setMaster = 0;
2498 pPager->journalHdr = 0;
drhda47d772002-12-02 04:25:19 +00002499 if( rc!=SQLITE_OK ){
drh9c105bb2004-10-02 20:38:28 +00002500 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00002501 }
danielk19774adee202004-05-08 08:23:19 +00002502 sqlite3OsOpenDirectory(pPager->zDirectory, &pPager->jfd);
drhda47d772002-12-02 04:25:19 +00002503 pPager->journalOpen = 1;
drhdb48ee02003-01-16 13:42:43 +00002504 pPager->journalStarted = 0;
drhda47d772002-12-02 04:25:19 +00002505 pPager->needSync = 0;
2506 pPager->alwaysRollback = 0;
drh968af522003-02-11 14:55:40 +00002507 pPager->nRec = 0;
drh2e6d11b2003-04-25 15:37:57 +00002508 if( pPager->errMask!=0 ){
2509 rc = pager_errcode(pPager);
2510 return rc;
2511 }
drhda47d772002-12-02 04:25:19 +00002512 pPager->origDbSize = pPager->dbSize;
drhae2b40c2004-06-09 19:03:54 +00002513
danielk197776572402004-06-25 02:38:54 +00002514 rc = writeJournalHdr(pPager);
2515
drhac69b052004-05-12 13:30:07 +00002516 if( pPager->stmtAutoopen && rc==SQLITE_OK ){
drh3aac2dd2004-04-26 14:10:20 +00002517 rc = sqlite3pager_stmt_begin(pPager);
drhda47d772002-12-02 04:25:19 +00002518 }
2519 if( rc!=SQLITE_OK ){
2520 rc = pager_unwritelock(pPager);
2521 if( rc==SQLITE_OK ){
2522 rc = SQLITE_FULL;
2523 }
2524 }
drh9c105bb2004-10-02 20:38:28 +00002525 return rc;
2526
2527failed_to_open_journal:
2528 sqliteFree(pPager->aInJournal);
2529 pPager->aInJournal = 0;
2530 sqlite3OsUnlock(&pPager->fd, NO_LOCK);
2531 pPager->state = PAGER_UNLOCK;
2532 return rc;
drhda47d772002-12-02 04:25:19 +00002533}
2534
2535/*
drh4b845d72002-03-05 12:41:19 +00002536** Acquire a write-lock on the database. The lock is removed when
2537** the any of the following happen:
2538**
drh3aac2dd2004-04-26 14:10:20 +00002539** * sqlite3pager_commit() is called.
2540** * sqlite3pager_rollback() is called.
2541** * sqlite3pager_close() is called.
2542** * sqlite3pager_unref() is called to on every outstanding page.
drh4b845d72002-03-05 12:41:19 +00002543**
danielk197713adf8a2004-06-03 16:08:41 +00002544** The first parameter to this routine is a pointer to any open page of the
2545** database file. Nothing changes about the page - it is used merely to
2546** acquire a pointer to the Pager structure and as proof that there is
2547** already a read-lock on the database.
drh4b845d72002-03-05 12:41:19 +00002548**
danielk197713adf8a2004-06-03 16:08:41 +00002549** The second parameter indicates how much space in bytes to reserve for a
2550** master journal file-name at the start of the journal when it is created.
2551**
2552** A journal file is opened if this is not a temporary file. For temporary
2553** files, the opening of the journal file is deferred until there is an
2554** actual need to write to the journal.
drhda47d772002-12-02 04:25:19 +00002555**
drha6abd042004-06-09 17:37:22 +00002556** If the database is already reserved for writing, this routine is a no-op.
drh684917c2004-10-05 02:41:42 +00002557**
2558** If exFlag is true, go ahead and get an EXCLUSIVE lock on the file
2559** immediately instead of waiting until we try to flush the cache. The
2560** exFlag is ignored if a transaction is already active.
drh4b845d72002-03-05 12:41:19 +00002561*/
drh684917c2004-10-05 02:41:42 +00002562int sqlite3pager_begin(void *pData, int exFlag){
drh4b845d72002-03-05 12:41:19 +00002563 PgHdr *pPg = DATA_TO_PGHDR(pData);
2564 Pager *pPager = pPg->pPager;
2565 int rc = SQLITE_OK;
2566 assert( pPg->nRef>0 );
drha6abd042004-06-09 17:37:22 +00002567 assert( pPager->state!=PAGER_UNLOCK );
2568 if( pPager->state==PAGER_SHARED ){
drh4b845d72002-03-05 12:41:19 +00002569 assert( pPager->aInJournal==0 );
drhb7f91642004-10-31 02:22:47 +00002570 if( MEMDB ){
drha6abd042004-06-09 17:37:22 +00002571 pPager->state = PAGER_EXCLUSIVE;
drhac69b052004-05-12 13:30:07 +00002572 pPager->origDbSize = pPager->dbSize;
2573 }else{
drh684917c2004-10-05 02:41:42 +00002574 if( SQLITE_BUSY_RESERVED_LOCK || exFlag ){
2575 rc = pager_wait_on_lock(pPager, RESERVED_LOCK);
2576 }else{
danielk19779eed5052004-06-04 10:38:30 +00002577 rc = sqlite3OsLock(&pPager->fd, RESERVED_LOCK);
drh684917c2004-10-05 02:41:42 +00002578 }
2579 if( rc==SQLITE_OK ){
2580 pPager->state = PAGER_RESERVED;
2581 if( exFlag ){
2582 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
2583 }
2584 }
danielk19779eed5052004-06-04 10:38:30 +00002585 if( rc!=SQLITE_OK ){
2586 return rc;
drhac69b052004-05-12 13:30:07 +00002587 }
drha6abd042004-06-09 17:37:22 +00002588 pPager->dirtyCache = 0;
danielk1977ef73ee92004-11-06 12:26:07 +00002589 TRACE2("TRANSACTION %d\n", PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00002590 if( pPager->useJournal && !pPager->tempFile ){
2591 rc = pager_open_journal(pPager);
2592 }
drh4b845d72002-03-05 12:41:19 +00002593 }
2594 }
2595 return rc;
2596}
2597
2598/*
drhed7c8552001-04-11 14:29:21 +00002599** Mark a data page as writeable. The page is written into the journal
2600** if it is not there already. This routine must be called before making
2601** changes to a page.
2602**
2603** The first time this routine is called, the pager creates a new
drha6abd042004-06-09 17:37:22 +00002604** journal and acquires a RESERVED lock on the database. If the RESERVED
drhed7c8552001-04-11 14:29:21 +00002605** lock could not be acquired, this routine returns SQLITE_BUSY. The
drh306dc212001-05-21 13:45:10 +00002606** calling routine must check for that return value and be careful not to
drhed7c8552001-04-11 14:29:21 +00002607** change any page data until this routine returns SQLITE_OK.
drhd9b02572001-04-15 00:37:09 +00002608**
2609** If the journal file could not be written because the disk is full,
2610** then this routine returns SQLITE_FULL and does an immediate rollback.
2611** All subsequent write attempts also return SQLITE_FULL until there
drh3aac2dd2004-04-26 14:10:20 +00002612** is a call to sqlite3pager_commit() or sqlite3pager_rollback() to
drhd9b02572001-04-15 00:37:09 +00002613** reset.
drhed7c8552001-04-11 14:29:21 +00002614*/
drh3aac2dd2004-04-26 14:10:20 +00002615int sqlite3pager_write(void *pData){
drh69688d52001-04-14 16:38:23 +00002616 PgHdr *pPg = DATA_TO_PGHDR(pData);
2617 Pager *pPager = pPg->pPager;
drhd79caeb2001-04-15 02:27:24 +00002618 int rc = SQLITE_OK;
drh69688d52001-04-14 16:38:23 +00002619
drh6446c4d2001-12-15 14:22:18 +00002620 /* Check for errors
2621 */
drhd9b02572001-04-15 00:37:09 +00002622 if( pPager->errMask ){
2623 return pager_errcode(pPager);
2624 }
drh5e00f6c2001-09-13 13:46:56 +00002625 if( pPager->readOnly ){
2626 return SQLITE_PERM;
2627 }
drh6446c4d2001-12-15 14:22:18 +00002628
danielk197776572402004-06-25 02:38:54 +00002629 assert( !pPager->setMaster );
2630
drh6446c4d2001-12-15 14:22:18 +00002631 /* Mark the page as dirty. If the page has already been written
2632 ** to the journal then we can return right away.
2633 */
drhd9b02572001-04-15 00:37:09 +00002634 pPg->dirty = 1;
drhac69b052004-05-12 13:30:07 +00002635 if( pPg->inJournal && (pPg->inStmt || pPager->stmtInUse==0) ){
drha6abd042004-06-09 17:37:22 +00002636 pPager->dirtyCache = 1;
danielk1977a0bf2652004-11-04 14:30:04 +00002637 }else{
drh6446c4d2001-12-15 14:22:18 +00002638
danielk1977a0bf2652004-11-04 14:30:04 +00002639 /* If we get this far, it means that the page needs to be
2640 ** written to the transaction journal or the ckeckpoint journal
2641 ** or both.
2642 **
2643 ** First check to see that the transaction journal exists and
2644 ** create it if it does not.
2645 */
2646 assert( pPager->state!=PAGER_UNLOCK );
2647 rc = sqlite3pager_begin(pData, 0);
2648 if( rc!=SQLITE_OK ){
2649 return rc;
2650 }
2651 assert( pPager->state>=PAGER_RESERVED );
2652 if( !pPager->journalOpen && pPager->useJournal ){
2653 rc = pager_open_journal(pPager);
2654 if( rc!=SQLITE_OK ) return rc;
2655 }
2656 assert( pPager->journalOpen || !pPager->useJournal );
2657 pPager->dirtyCache = 1;
2658
2659 /* The transaction journal now exists and we have a RESERVED or an
2660 ** EXCLUSIVE lock on the main database file. Write the current page to
2661 ** the transaction journal if it is not there already.
2662 */
2663 if( !pPg->inJournal && (pPager->useJournal || MEMDB) ){
2664 if( (int)pPg->pgno <= pPager->origDbSize ){
2665 int szPg;
2666 u32 saved;
2667 if( MEMDB ){
2668 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
danielk1977ef73ee92004-11-06 12:26:07 +00002669 TRACE3("JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00002670 assert( pHist->pOrig==0 );
2671 pHist->pOrig = sqliteMallocRaw( pPager->pageSize );
2672 if( pHist->pOrig ){
2673 memcpy(pHist->pOrig, PGHDR_TO_DATA(pPg), pPager->pageSize);
2674 }
2675 }else{
2676 u32 cksum;
2677 CODEC(pPager, pData, pPg->pgno, 7);
2678 cksum = pager_cksum(pPager, pPg->pgno, pData);
2679 saved = *(u32*)PGHDR_TO_EXTRA(pPg, pPager);
2680 store32bits(cksum, pPg, pPager->pageSize);
2681 szPg = pPager->pageSize+8;
2682 store32bits(pPg->pgno, pPg, -4);
2683 rc = sqlite3OsWrite(&pPager->jfd, &((char*)pData)[-4], szPg);
2684 pPager->journalOff += szPg;
2685 TRACE4("JOURNAL %d page %d needSync=%d\n",
danielk1977ef73ee92004-11-06 12:26:07 +00002686 PAGERID(pPager), pPg->pgno, pPg->needSync);
danielk1977a0bf2652004-11-04 14:30:04 +00002687 CODEC(pPager, pData, pPg->pgno, 0);
2688 *(u32*)PGHDR_TO_EXTRA(pPg, pPager) = saved;
2689 if( rc!=SQLITE_OK ){
2690 sqlite3pager_rollback(pPager);
2691 pPager->errMask |= PAGER_ERR_FULL;
2692 return rc;
2693 }
2694 pPager->nRec++;
2695 assert( pPager->aInJournal!=0 );
2696 pPager->aInJournal[pPg->pgno/8] |= 1<<(pPg->pgno&7);
2697 pPg->needSync = !pPager->noSync;
2698 if( pPager->stmtInUse ){
2699 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
2700 page_add_to_stmt_list(pPg);
2701 }
drhac69b052004-05-12 13:30:07 +00002702 }
danielk197713adf8a2004-06-03 16:08:41 +00002703 }else{
danielk1977a0bf2652004-11-04 14:30:04 +00002704 pPg->needSync = !pPager->journalStarted && !pPager->noSync;
2705 TRACE4("APPEND %d page %d needSync=%d\n",
danielk1977ef73ee92004-11-06 12:26:07 +00002706 PAGERID(pPager), pPg->pgno, pPg->needSync);
danielk1977a0bf2652004-11-04 14:30:04 +00002707 }
2708 if( pPg->needSync ){
2709 pPager->needSync = 1;
2710 }
2711 pPg->inJournal = 1;
2712 }
2713
2714 /* If the statement journal is open and the page is not in it,
2715 ** then write the current page to the statement journal. Note that
2716 ** the statement journal format differs from the standard journal format
2717 ** in that it omits the checksums and the header.
2718 */
2719 if( pPager->stmtInUse && !pPg->inStmt && (int)pPg->pgno<=pPager->stmtSize ){
2720 assert( pPg->inJournal || (int)pPg->pgno>pPager->origDbSize );
2721 if( MEMDB ){
2722 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
2723 assert( pHist->pStmt==0 );
2724 pHist->pStmt = sqliteMallocRaw( pPager->pageSize );
2725 if( pHist->pStmt ){
2726 memcpy(pHist->pStmt, PGHDR_TO_DATA(pPg), pPager->pageSize);
2727 }
danielk1977ef73ee92004-11-06 12:26:07 +00002728 TRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00002729 }else{
2730 store32bits(pPg->pgno, pPg, -4);
2731 CODEC(pPager, pData, pPg->pgno, 7);
2732 rc = sqlite3OsWrite(&pPager->stfd,((char*)pData)-4, pPager->pageSize+4);
danielk1977ef73ee92004-11-06 12:26:07 +00002733 TRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
drhac69b052004-05-12 13:30:07 +00002734 CODEC(pPager, pData, pPg->pgno, 0);
drhac69b052004-05-12 13:30:07 +00002735 if( rc!=SQLITE_OK ){
2736 sqlite3pager_rollback(pPager);
2737 pPager->errMask |= PAGER_ERR_FULL;
2738 return rc;
2739 }
danielk1977a0bf2652004-11-04 14:30:04 +00002740 pPager->stmtNRec++;
2741 assert( pPager->aInStmt!=0 );
2742 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drhdb48ee02003-01-16 13:42:43 +00002743 }
danielk1977a0bf2652004-11-04 14:30:04 +00002744 page_add_to_stmt_list(pPg);
drhd9b02572001-04-15 00:37:09 +00002745 }
drhfa86c412002-02-02 15:01:15 +00002746 }
2747
2748 /* Update the database size and return.
2749 */
drh1ab43002002-01-14 09:28:19 +00002750 if( pPager->dbSize<(int)pPg->pgno ){
drh306dc212001-05-21 13:45:10 +00002751 pPager->dbSize = pPg->pgno;
drhb7f91642004-10-31 02:22:47 +00002752 if( !MEMDB && pPager->dbSize==PENDING_BYTE/pPager->pageSize ){
drh1f595712004-06-15 01:40:29 +00002753 pPager->dbSize++;
2754 }
drh306dc212001-05-21 13:45:10 +00002755 }
drh69688d52001-04-14 16:38:23 +00002756 return rc;
drhed7c8552001-04-11 14:29:21 +00002757}
2758
2759/*
drhaacc5432002-01-06 17:07:40 +00002760** Return TRUE if the page given in the argument was previously passed
drh3aac2dd2004-04-26 14:10:20 +00002761** to sqlite3pager_write(). In other words, return TRUE if it is ok
drh6019e162001-07-02 17:51:45 +00002762** to change the content of the page.
2763*/
drh3aac2dd2004-04-26 14:10:20 +00002764int sqlite3pager_iswriteable(void *pData){
drh6019e162001-07-02 17:51:45 +00002765 PgHdr *pPg = DATA_TO_PGHDR(pData);
2766 return pPg->dirty;
2767}
2768
danielk1977b84f96f2005-01-20 11:32:23 +00002769#ifndef SQLITE_OMIT_VACUUM
drh6019e162001-07-02 17:51:45 +00002770/*
drh001bbcb2003-03-19 03:14:00 +00002771** Replace the content of a single page with the information in the third
2772** argument.
2773*/
drh3aac2dd2004-04-26 14:10:20 +00002774int sqlite3pager_overwrite(Pager *pPager, Pgno pgno, void *pData){
drh001bbcb2003-03-19 03:14:00 +00002775 void *pPage;
2776 int rc;
2777
drh3aac2dd2004-04-26 14:10:20 +00002778 rc = sqlite3pager_get(pPager, pgno, &pPage);
drh001bbcb2003-03-19 03:14:00 +00002779 if( rc==SQLITE_OK ){
drh3aac2dd2004-04-26 14:10:20 +00002780 rc = sqlite3pager_write(pPage);
drh001bbcb2003-03-19 03:14:00 +00002781 if( rc==SQLITE_OK ){
drh90f5ecb2004-07-22 01:19:35 +00002782 memcpy(pPage, pData, pPager->pageSize);
drh001bbcb2003-03-19 03:14:00 +00002783 }
drh3aac2dd2004-04-26 14:10:20 +00002784 sqlite3pager_unref(pPage);
drh001bbcb2003-03-19 03:14:00 +00002785 }
2786 return rc;
2787}
danielk1977b84f96f2005-01-20 11:32:23 +00002788#endif
drh001bbcb2003-03-19 03:14:00 +00002789
2790/*
drh30e58752002-03-02 20:41:57 +00002791** A call to this routine tells the pager that it is not necessary to
2792** write the information on page "pgno" back to the disk, even though
2793** that page might be marked as dirty.
2794**
2795** The overlying software layer calls this routine when all of the data
2796** on the given page is unused. The pager marks the page as clean so
2797** that it does not get written to disk.
2798**
2799** Tests show that this optimization, together with the
drh3aac2dd2004-04-26 14:10:20 +00002800** sqlite3pager_dont_rollback() below, more than double the speed
drh30e58752002-03-02 20:41:57 +00002801** of large INSERT operations and quadruple the speed of large DELETEs.
drh8e298f92002-07-06 16:28:47 +00002802**
2803** When this routine is called, set the alwaysRollback flag to true.
drh3aac2dd2004-04-26 14:10:20 +00002804** Subsequent calls to sqlite3pager_dont_rollback() for the same page
drh8e298f92002-07-06 16:28:47 +00002805** will thereafter be ignored. This is necessary to avoid a problem
2806** where a page with data is added to the freelist during one part of
2807** a transaction then removed from the freelist during a later part
2808** of the same transaction and reused for some other purpose. When it
2809** is first added to the freelist, this routine is called. When reused,
2810** the dont_rollback() routine is called. But because the page contains
2811** critical data, we still need to be sure it gets rolled back in spite
2812** of the dont_rollback() call.
drh30e58752002-03-02 20:41:57 +00002813*/
drh3aac2dd2004-04-26 14:10:20 +00002814void sqlite3pager_dont_write(Pager *pPager, Pgno pgno){
drh30e58752002-03-02 20:41:57 +00002815 PgHdr *pPg;
drh8e298f92002-07-06 16:28:47 +00002816
drhb7f91642004-10-31 02:22:47 +00002817 if( MEMDB ) return;
danielk1977eac7a362004-06-16 07:45:24 +00002818
drh30e58752002-03-02 20:41:57 +00002819 pPg = pager_lookup(pPager, pgno);
drh8e298f92002-07-06 16:28:47 +00002820 pPg->alwaysRollback = 1;
drh30e58752002-03-02 20:41:57 +00002821 if( pPg && pPg->dirty ){
drh8124a302002-06-25 14:43:57 +00002822 if( pPager->dbSize==(int)pPg->pgno && pPager->origDbSize<pPager->dbSize ){
2823 /* If this pages is the last page in the file and the file has grown
2824 ** during the current transaction, then do NOT mark the page as clean.
2825 ** When the database file grows, we must make sure that the last page
2826 ** gets written at least once so that the disk file will be the correct
2827 ** size. If you do not write this page and the size of the file
2828 ** on the disk ends up being too small, that can lead to database
2829 ** corruption during the next transaction.
2830 */
2831 }else{
danielk1977ef73ee92004-11-06 12:26:07 +00002832 TRACE3("DONT_WRITE page %d of %d\n", pgno, PAGERID(pPager));
drh8124a302002-06-25 14:43:57 +00002833 pPg->dirty = 0;
2834 }
drh30e58752002-03-02 20:41:57 +00002835 }
2836}
2837
2838/*
2839** A call to this routine tells the pager that if a rollback occurs,
2840** it is not necessary to restore the data on the given page. This
2841** means that the pager does not have to record the given page in the
2842** rollback journal.
2843*/
drh3aac2dd2004-04-26 14:10:20 +00002844void sqlite3pager_dont_rollback(void *pData){
drh30e58752002-03-02 20:41:57 +00002845 PgHdr *pPg = DATA_TO_PGHDR(pData);
2846 Pager *pPager = pPg->pPager;
2847
drha6abd042004-06-09 17:37:22 +00002848 if( pPager->state!=PAGER_EXCLUSIVE || pPager->journalOpen==0 ) return;
drhb7f91642004-10-31 02:22:47 +00002849 if( pPg->alwaysRollback || pPager->alwaysRollback || MEMDB ) return;
drh30e58752002-03-02 20:41:57 +00002850 if( !pPg->inJournal && (int)pPg->pgno <= pPager->origDbSize ){
2851 assert( pPager->aInJournal!=0 );
2852 pPager->aInJournal[pPg->pgno/8] |= 1<<(pPg->pgno&7);
2853 pPg->inJournal = 1;
drhac69b052004-05-12 13:30:07 +00002854 if( pPager->stmtInUse ){
2855 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drh3aac2dd2004-04-26 14:10:20 +00002856 page_add_to_stmt_list(pPg);
drh30e58752002-03-02 20:41:57 +00002857 }
danielk1977ef73ee92004-11-06 12:26:07 +00002858 TRACE3("DONT_ROLLBACK page %d of %d\n", pPg->pgno, PAGERID(pPager));
drh30e58752002-03-02 20:41:57 +00002859 }
drhac69b052004-05-12 13:30:07 +00002860 if( pPager->stmtInUse && !pPg->inStmt && (int)pPg->pgno<=pPager->stmtSize ){
drh30e58752002-03-02 20:41:57 +00002861 assert( pPg->inJournal || (int)pPg->pgno>pPager->origDbSize );
drhac69b052004-05-12 13:30:07 +00002862 assert( pPager->aInStmt!=0 );
2863 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drh3aac2dd2004-04-26 14:10:20 +00002864 page_add_to_stmt_list(pPg);
drh30e58752002-03-02 20:41:57 +00002865 }
2866}
2867
drhac69b052004-05-12 13:30:07 +00002868
danielk197793758c82005-01-21 08:13:14 +00002869#ifndef SQLITE_OMIT_MEMORYDB
drhac69b052004-05-12 13:30:07 +00002870/*
2871** Clear a PgHistory block
2872*/
2873static void clearHistory(PgHistory *pHist){
2874 sqliteFree(pHist->pOrig);
2875 sqliteFree(pHist->pStmt);
2876 pHist->pOrig = 0;
2877 pHist->pStmt = 0;
2878}
danielk197793758c82005-01-21 08:13:14 +00002879#else
2880#define clearHistory(x)
2881#endif
drhac69b052004-05-12 13:30:07 +00002882
drh30e58752002-03-02 20:41:57 +00002883/*
drhed7c8552001-04-11 14:29:21 +00002884** Commit all changes to the database and release the write lock.
drhd9b02572001-04-15 00:37:09 +00002885**
2886** If the commit fails for any reason, a rollback attempt is made
2887** and an error code is returned. If the commit worked, SQLITE_OK
2888** is returned.
drhed7c8552001-04-11 14:29:21 +00002889*/
drh3aac2dd2004-04-26 14:10:20 +00002890int sqlite3pager_commit(Pager *pPager){
drha1b351a2001-09-14 16:42:12 +00002891 int rc;
drhed7c8552001-04-11 14:29:21 +00002892 PgHdr *pPg;
drhd9b02572001-04-15 00:37:09 +00002893
2894 if( pPager->errMask==PAGER_ERR_FULL ){
drh3aac2dd2004-04-26 14:10:20 +00002895 rc = sqlite3pager_rollback(pPager);
drh4e371ee2002-09-05 16:08:27 +00002896 if( rc==SQLITE_OK ){
2897 rc = SQLITE_FULL;
2898 }
drhd9b02572001-04-15 00:37:09 +00002899 return rc;
2900 }
2901 if( pPager->errMask!=0 ){
2902 rc = pager_errcode(pPager);
2903 return rc;
2904 }
drha6abd042004-06-09 17:37:22 +00002905 if( pPager->state<PAGER_RESERVED ){
drhd9b02572001-04-15 00:37:09 +00002906 return SQLITE_ERROR;
2907 }
danielk1977ef73ee92004-11-06 12:26:07 +00002908 TRACE2("COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00002909 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00002910 pPg = pager_get_all_dirty_pages(pPager);
2911 while( pPg ){
2912 clearHistory(PGHDR_TO_HIST(pPg, pPager));
2913 pPg->dirty = 0;
2914 pPg->inJournal = 0;
2915 pPg->inStmt = 0;
2916 pPg->pPrevStmt = pPg->pNextStmt = 0;
2917 pPg = pPg->pDirty;
2918 }
danielk1977eac7a362004-06-16 07:45:24 +00002919#ifndef NDEBUG
2920 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2921 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
2922 assert( !pPg->alwaysRollback );
2923 assert( !pHist->pOrig );
2924 assert( !pHist->pStmt );
2925 }
2926#endif
drhac69b052004-05-12 13:30:07 +00002927 pPager->pStmt = 0;
drha6abd042004-06-09 17:37:22 +00002928 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00002929 return SQLITE_OK;
2930 }
drha6abd042004-06-09 17:37:22 +00002931 if( pPager->dirtyCache==0 ){
danielk19774adee202004-05-08 08:23:19 +00002932 /* Exit early (without doing the time-consuming sqlite3OsSync() calls)
drha1680452002-04-18 01:56:57 +00002933 ** if there have been no changes to the database file. */
drh341eae82003-01-21 02:39:36 +00002934 assert( pPager->needSync==0 );
drha1680452002-04-18 01:56:57 +00002935 rc = pager_unwritelock(pPager);
2936 pPager->dbSize = -1;
2937 return rc;
2938 }
drhda47d772002-12-02 04:25:19 +00002939 assert( pPager->journalOpen );
danielk1977d761c0c2004-11-05 16:37:02 +00002940 rc = sqlite3pager_sync(pPager, 0, 0);
drha6abd042004-06-09 17:37:22 +00002941 if( rc!=SQLITE_OK ){
2942 goto commit_abort;
2943 }
drhd9b02572001-04-15 00:37:09 +00002944 rc = pager_unwritelock(pPager);
2945 pPager->dbSize = -1;
2946 return rc;
2947
2948 /* Jump here if anything goes wrong during the commit process.
2949 */
2950commit_abort:
drh92f02c32004-09-02 14:57:08 +00002951 sqlite3pager_rollback(pPager);
drhed7c8552001-04-11 14:29:21 +00002952 return rc;
2953}
2954
2955/*
drha6abd042004-06-09 17:37:22 +00002956** Rollback all changes. The database falls back to PAGER_SHARED mode.
drhed7c8552001-04-11 14:29:21 +00002957** All in-memory cache pages revert to their original data contents.
2958** The journal is deleted.
drhd9b02572001-04-15 00:37:09 +00002959**
2960** This routine cannot fail unless some other process is not following
2961** the correct locking protocol (SQLITE_PROTOCOL) or unless some other
2962** process is writing trash into the journal file (SQLITE_CORRUPT) or
2963** unless a prior malloc() failed (SQLITE_NOMEM). Appropriate error
2964** codes are returned for all these occasions. Otherwise,
2965** SQLITE_OK is returned.
drhed7c8552001-04-11 14:29:21 +00002966*/
drh3aac2dd2004-04-26 14:10:20 +00002967int sqlite3pager_rollback(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +00002968 int rc;
danielk1977ef73ee92004-11-06 12:26:07 +00002969 TRACE2("ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00002970 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00002971 PgHdr *p;
2972 for(p=pPager->pAll; p; p=p->pNextAll){
2973 PgHistory *pHist;
danielk1977eac7a362004-06-16 07:45:24 +00002974 assert( !p->alwaysRollback );
2975 if( !p->dirty ){
2976 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pOrig );
2977 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pStmt );
2978 continue;
2979 }
2980
drhac69b052004-05-12 13:30:07 +00002981 pHist = PGHDR_TO_HIST(p, pPager);
2982 if( pHist->pOrig ){
2983 memcpy(PGHDR_TO_DATA(p), pHist->pOrig, pPager->pageSize);
danielk1977ef73ee92004-11-06 12:26:07 +00002984 TRACE3("ROLLBACK-PAGE %d of %d\n", p->pgno, PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00002985 }else{
danielk1977ef73ee92004-11-06 12:26:07 +00002986 TRACE3("PAGE %d is clean on %d\n", p->pgno, PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00002987 }
2988 clearHistory(pHist);
2989 p->dirty = 0;
2990 p->inJournal = 0;
2991 p->inStmt = 0;
2992 p->pPrevStmt = p->pNextStmt = 0;
danielk1977369f27e2004-06-15 11:40:04 +00002993
2994 if( pPager->xReiniter ){
2995 pPager->xReiniter(PGHDR_TO_DATA(p), pPager->pageSize);
2996 }
2997
drhac69b052004-05-12 13:30:07 +00002998 }
2999 pPager->pStmt = 0;
3000 pPager->dbSize = pPager->origDbSize;
3001 memoryTruncate(pPager);
3002 pPager->stmtInUse = 0;
drha6abd042004-06-09 17:37:22 +00003003 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00003004 return SQLITE_OK;
3005 }
3006
drha6abd042004-06-09 17:37:22 +00003007 if( !pPager->dirtyCache || !pPager->journalOpen ){
drhda47d772002-12-02 04:25:19 +00003008 rc = pager_unwritelock(pPager);
3009 pPager->dbSize = -1;
3010 return rc;
3011 }
drhdb48ee02003-01-16 13:42:43 +00003012
drhd9b02572001-04-15 00:37:09 +00003013 if( pPager->errMask!=0 && pPager->errMask!=PAGER_ERR_FULL ){
drha6abd042004-06-09 17:37:22 +00003014 if( pPager->state>=PAGER_EXCLUSIVE ){
danielk197776572402004-06-25 02:38:54 +00003015 pager_playback(pPager);
drh4b845d72002-03-05 12:41:19 +00003016 }
drhd9b02572001-04-15 00:37:09 +00003017 return pager_errcode(pPager);
drhed7c8552001-04-11 14:29:21 +00003018 }
drha6abd042004-06-09 17:37:22 +00003019 if( pPager->state==PAGER_RESERVED ){
drhcb4c40b2004-08-18 19:09:43 +00003020 int rc2, rc3;
drha6abd042004-06-09 17:37:22 +00003021 rc = pager_reload_cache(pPager);
drhcb4c40b2004-08-18 19:09:43 +00003022 rc2 = pager_truncate(pPager, pPager->origDbSize);
3023 rc3 = pager_unwritelock(pPager);
drha6abd042004-06-09 17:37:22 +00003024 if( rc==SQLITE_OK ){
3025 rc = rc2;
drhcb4c40b2004-08-18 19:09:43 +00003026 if( rc3 ) rc = rc3;
drha6abd042004-06-09 17:37:22 +00003027 }
3028 }else{
danielk197776572402004-06-25 02:38:54 +00003029 rc = pager_playback(pPager);
drhd9b02572001-04-15 00:37:09 +00003030 }
drhd9b02572001-04-15 00:37:09 +00003031 if( rc!=SQLITE_OK ){
drhee696e22004-08-30 16:52:17 +00003032 rc = SQLITE_CORRUPT; /* bkpt-CORRUPT */
drhd9b02572001-04-15 00:37:09 +00003033 pPager->errMask |= PAGER_ERR_CORRUPT;
3034 }
3035 pPager->dbSize = -1;
drhed7c8552001-04-11 14:29:21 +00003036 return rc;
drh98808ba2001-10-18 12:34:46 +00003037}
drhd9b02572001-04-15 00:37:09 +00003038
3039/*
drh5e00f6c2001-09-13 13:46:56 +00003040** Return TRUE if the database file is opened read-only. Return FALSE
3041** if the database is (in theory) writable.
3042*/
drh3aac2dd2004-04-26 14:10:20 +00003043int sqlite3pager_isreadonly(Pager *pPager){
drhbe0072d2001-09-13 14:46:09 +00003044 return pPager->readOnly;
drh5e00f6c2001-09-13 13:46:56 +00003045}
3046
3047/*
drhd9b02572001-04-15 00:37:09 +00003048** This routine is used for testing and analysis only.
3049*/
drh3aac2dd2004-04-26 14:10:20 +00003050int *sqlite3pager_stats(Pager *pPager){
danielk197742741be2005-01-08 12:42:39 +00003051 static int a[11];
drhd9b02572001-04-15 00:37:09 +00003052 a[0] = pPager->nRef;
3053 a[1] = pPager->nPage;
3054 a[2] = pPager->mxPage;
3055 a[3] = pPager->dbSize;
3056 a[4] = pPager->state;
3057 a[5] = pPager->errMask;
3058 a[6] = pPager->nHit;
3059 a[7] = pPager->nMiss;
3060 a[8] = pPager->nOvfl;
danielk197742741be2005-01-08 12:42:39 +00003061 a[9] = pPager->nRead;
3062 a[10] = pPager->nWrite;
drhd9b02572001-04-15 00:37:09 +00003063 return a;
3064}
drhdd793422001-06-28 01:54:48 +00003065
drhfa86c412002-02-02 15:01:15 +00003066/*
drhac69b052004-05-12 13:30:07 +00003067** Set the statement rollback point.
drhfa86c412002-02-02 15:01:15 +00003068**
3069** This routine should be called with the transaction journal already
drhac69b052004-05-12 13:30:07 +00003070** open. A new statement journal is created that can be used to rollback
drhaaab5722002-02-19 13:39:21 +00003071** changes of a single SQL command within a larger transaction.
drhfa86c412002-02-02 15:01:15 +00003072*/
drh3aac2dd2004-04-26 14:10:20 +00003073int sqlite3pager_stmt_begin(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00003074 int rc;
3075 char zTemp[SQLITE_TEMPNAME_SIZE];
drhac69b052004-05-12 13:30:07 +00003076 assert( !pPager->stmtInUse );
drhdc3ff9c2004-08-18 02:10:15 +00003077 assert( pPager->dbSize>=0 );
danielk1977ef73ee92004-11-06 12:26:07 +00003078 TRACE2("STMT-BEGIN %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003079 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00003080 pPager->stmtInUse = 1;
3081 pPager->stmtSize = pPager->dbSize;
3082 return SQLITE_OK;
3083 }
drhda47d772002-12-02 04:25:19 +00003084 if( !pPager->journalOpen ){
drhac69b052004-05-12 13:30:07 +00003085 pPager->stmtAutoopen = 1;
drhda47d772002-12-02 04:25:19 +00003086 return SQLITE_OK;
3087 }
drhfa86c412002-02-02 15:01:15 +00003088 assert( pPager->journalOpen );
drhac69b052004-05-12 13:30:07 +00003089 pPager->aInStmt = sqliteMalloc( pPager->dbSize/8 + 1 );
3090 if( pPager->aInStmt==0 ){
danielk19779eed5052004-06-04 10:38:30 +00003091 sqlite3OsLock(&pPager->fd, SHARED_LOCK);
drhfa86c412002-02-02 15:01:15 +00003092 return SQLITE_NOMEM;
3093 }
drh968af522003-02-11 14:55:40 +00003094#ifndef NDEBUG
drhac69b052004-05-12 13:30:07 +00003095 rc = sqlite3OsFileSize(&pPager->jfd, &pPager->stmtJSize);
3096 if( rc ) goto stmt_begin_failed;
danielk197776572402004-06-25 02:38:54 +00003097 assert( pPager->stmtJSize == pPager->journalOff );
drh968af522003-02-11 14:55:40 +00003098#endif
danielk197776572402004-06-25 02:38:54 +00003099 pPager->stmtJSize = pPager->journalOff;
drhac69b052004-05-12 13:30:07 +00003100 pPager->stmtSize = pPager->dbSize;
danielk197776572402004-06-25 02:38:54 +00003101 pPager->stmtHdrOff = 0;
danielk197775edc162004-06-26 01:48:18 +00003102 pPager->stmtCksum = pPager->cksumInit;
drhac69b052004-05-12 13:30:07 +00003103 if( !pPager->stmtOpen ){
3104 rc = sqlite3pager_opentemp(zTemp, &pPager->stfd);
3105 if( rc ) goto stmt_begin_failed;
3106 pPager->stmtOpen = 1;
3107 pPager->stmtNRec = 0;
drh0f892532002-05-30 12:27:03 +00003108 }
drhac69b052004-05-12 13:30:07 +00003109 pPager->stmtInUse = 1;
drhfa86c412002-02-02 15:01:15 +00003110 return SQLITE_OK;
3111
drhac69b052004-05-12 13:30:07 +00003112stmt_begin_failed:
3113 if( pPager->aInStmt ){
3114 sqliteFree(pPager->aInStmt);
3115 pPager->aInStmt = 0;
drhfa86c412002-02-02 15:01:15 +00003116 }
3117 return rc;
3118}
3119
3120/*
drhac69b052004-05-12 13:30:07 +00003121** Commit a statement.
drhfa86c412002-02-02 15:01:15 +00003122*/
drh3aac2dd2004-04-26 14:10:20 +00003123int sqlite3pager_stmt_commit(Pager *pPager){
drhac69b052004-05-12 13:30:07 +00003124 if( pPager->stmtInUse ){
drh03eb96a2002-11-10 23:32:56 +00003125 PgHdr *pPg, *pNext;
danielk1977ef73ee92004-11-06 12:26:07 +00003126 TRACE2("STMT-COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003127 if( !MEMDB ){
drhac69b052004-05-12 13:30:07 +00003128 sqlite3OsSeek(&pPager->stfd, 0);
3129 /* sqlite3OsTruncate(&pPager->stfd, 0); */
3130 sqliteFree( pPager->aInStmt );
3131 pPager->aInStmt = 0;
drh663fc632002-02-02 18:49:19 +00003132 }
drhac69b052004-05-12 13:30:07 +00003133 for(pPg=pPager->pStmt; pPg; pPg=pNext){
3134 pNext = pPg->pNextStmt;
3135 assert( pPg->inStmt );
3136 pPg->inStmt = 0;
3137 pPg->pPrevStmt = pPg->pNextStmt = 0;
drhb7f91642004-10-31 02:22:47 +00003138 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00003139 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
3140 sqliteFree(pHist->pStmt);
3141 pHist->pStmt = 0;
3142 }
3143 }
3144 pPager->stmtNRec = 0;
3145 pPager->stmtInUse = 0;
3146 pPager->pStmt = 0;
drh663fc632002-02-02 18:49:19 +00003147 }
drhac69b052004-05-12 13:30:07 +00003148 pPager->stmtAutoopen = 0;
drhfa86c412002-02-02 15:01:15 +00003149 return SQLITE_OK;
3150}
3151
3152/*
drhac69b052004-05-12 13:30:07 +00003153** Rollback a statement.
drhfa86c412002-02-02 15:01:15 +00003154*/
drh3aac2dd2004-04-26 14:10:20 +00003155int sqlite3pager_stmt_rollback(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00003156 int rc;
drhac69b052004-05-12 13:30:07 +00003157 if( pPager->stmtInUse ){
danielk1977ef73ee92004-11-06 12:26:07 +00003158 TRACE2("STMT-ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003159 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00003160 PgHdr *pPg;
3161 for(pPg=pPager->pStmt; pPg; pPg=pPg->pNextStmt){
3162 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
3163 if( pHist->pStmt ){
3164 memcpy(PGHDR_TO_DATA(pPg), pHist->pStmt, pPager->pageSize);
3165 sqliteFree(pHist->pStmt);
3166 pHist->pStmt = 0;
3167 }
3168 }
3169 pPager->dbSize = pPager->stmtSize;
3170 memoryTruncate(pPager);
3171 rc = SQLITE_OK;
3172 }else{
3173 rc = pager_stmt_playback(pPager);
3174 }
drh3aac2dd2004-04-26 14:10:20 +00003175 sqlite3pager_stmt_commit(pPager);
drh663fc632002-02-02 18:49:19 +00003176 }else{
3177 rc = SQLITE_OK;
3178 }
drhac69b052004-05-12 13:30:07 +00003179 pPager->stmtAutoopen = 0;
drhfa86c412002-02-02 15:01:15 +00003180 return rc;
3181}
3182
drh73509ee2003-04-06 20:44:45 +00003183/*
3184** Return the full pathname of the database file.
3185*/
drh3aac2dd2004-04-26 14:10:20 +00003186const char *sqlite3pager_filename(Pager *pPager){
drh73509ee2003-04-06 20:44:45 +00003187 return pPager->zFilename;
3188}
3189
drhb20ea9d2004-02-09 01:20:36 +00003190/*
danielk19775865e3d2004-06-14 06:03:57 +00003191** Return the directory of the database file.
3192*/
3193const char *sqlite3pager_dirname(Pager *pPager){
3194 return pPager->zDirectory;
3195}
3196
3197/*
3198** Return the full pathname of the journal file.
3199*/
3200const char *sqlite3pager_journalname(Pager *pPager){
3201 return pPager->zJournal;
3202}
3203
3204/*
drhb20ea9d2004-02-09 01:20:36 +00003205** Set the codec for this pager
3206*/
drh3aac2dd2004-04-26 14:10:20 +00003207void sqlite3pager_set_codec(
drhb20ea9d2004-02-09 01:20:36 +00003208 Pager *pPager,
drh9eb9e262004-02-11 02:18:05 +00003209 void (*xCodec)(void*,void*,Pgno,int),
drhb20ea9d2004-02-09 01:20:36 +00003210 void *pCodecArg
3211){
3212 pPager->xCodec = xCodec;
3213 pPager->pCodecArg = pCodecArg;
3214}
3215
danielk197713adf8a2004-06-03 16:08:41 +00003216/*
danielk1977aa5ccdf2004-06-14 05:10:42 +00003217** This routine is called to increment the database file change-counter,
3218** stored at byte 24 of the pager file.
3219*/
3220static int pager_incr_changecounter(Pager *pPager){
3221 void *pPage;
3222 PgHdr *pPgHdr;
3223 u32 change_counter;
3224 int rc;
3225
3226 /* Open page 1 of the file for writing. */
3227 rc = sqlite3pager_get(pPager, 1, &pPage);
3228 if( rc!=SQLITE_OK ) return rc;
3229 rc = sqlite3pager_write(pPage);
3230 if( rc!=SQLITE_OK ) return rc;
3231
3232 /* Read the current value at byte 24. */
3233 pPgHdr = DATA_TO_PGHDR(pPage);
3234 change_counter = retrieve32bits(pPgHdr, 24);
3235
3236 /* Increment the value just read and write it back to byte 24. */
3237 change_counter++;
3238 store32bits(change_counter, pPgHdr, 24);
3239
3240 /* Release the page reference. */
3241 sqlite3pager_unref(pPage);
3242 return SQLITE_OK;
3243}
3244
3245/*
danielk197713adf8a2004-06-03 16:08:41 +00003246** Sync the database file for the pager pPager. zMaster points to the name
3247** of a master journal file that should be written into the individual
3248** journal file. zMaster may be NULL, which is interpreted as no master
3249** journal (a single database transaction).
3250**
3251** This routine ensures that the journal is synced, all dirty pages written
3252** to the database file and the database file synced. The only thing that
3253** remains to commit the transaction is to delete the journal file (or
3254** master journal file if specified).
3255**
3256** Note that if zMaster==NULL, this does not overwrite a previous value
3257** passed to an sqlite3pager_sync() call.
danielk1977d761c0c2004-11-05 16:37:02 +00003258**
3259** If parameter nTrunc is non-zero, then the pager file is truncated to
3260** nTrunc pages (this is used by auto-vacuum databases).
danielk197713adf8a2004-06-03 16:08:41 +00003261*/
danielk1977d761c0c2004-11-05 16:37:02 +00003262int sqlite3pager_sync(Pager *pPager, const char *zMaster, Pgno nTrunc){
danielk197713adf8a2004-06-03 16:08:41 +00003263 int rc = SQLITE_OK;
3264
danielk1977ef73ee92004-11-06 12:26:07 +00003265 TRACE4("DATABASE SYNC: File=%s zMaster=%s nTrunc=%d\n",
3266 pPager->zFilename, zMaster, nTrunc);
3267
danielk1977aa5ccdf2004-06-14 05:10:42 +00003268 /* If this is an in-memory db, or no pages have been written to, or this
3269 ** function has already been called, it is a no-op.
danielk197713adf8a2004-06-03 16:08:41 +00003270 */
drhb7f91642004-10-31 02:22:47 +00003271 if( pPager->state!=PAGER_SYNCED && !MEMDB && pPager->dirtyCache ){
danielk197713adf8a2004-06-03 16:08:41 +00003272 PgHdr *pPg;
3273 assert( pPager->journalOpen );
3274
danielk197776572402004-06-25 02:38:54 +00003275 /* If a master journal file name has already been written to the
3276 ** journal file, then no sync is required. This happens when it is
3277 ** written, then the process fails to upgrade from a RESERVED to an
3278 ** EXCLUSIVE lock. The next time the process tries to commit the
3279 ** transaction the m-j name will have already been written.
3280 */
3281 if( !pPager->setMaster ){
3282 rc = pager_incr_changecounter(pPager);
3283 if( rc!=SQLITE_OK ) goto sync_exit;
danielk1977ef73ee92004-11-06 12:26:07 +00003284#ifndef SQLITE_OMIT_AUTOVACUUM
3285 if( nTrunc!=0 ){
3286 /* If this transaction has made the database smaller, then all pages
3287 ** being discarded by the truncation must be written to the journal
3288 ** file.
3289 */
3290 Pgno i;
3291 void *pPage;
3292 for( i=nTrunc+1; i<=pPager->origDbSize; i++ ){
3293 if( !(pPager->aInJournal[i/8] & (1<<(i&7))) ){
3294 rc = sqlite3pager_get(pPager, i, &pPage);
3295 if( rc!=SQLITE_OK ) goto sync_exit;
3296 rc = sqlite3pager_write(pPage);
3297 sqlite3pager_unref(pPage);
3298 if( rc!=SQLITE_OK ) goto sync_exit;
3299 }
3300 }
3301 }
3302#endif
danielk197776572402004-06-25 02:38:54 +00003303 rc = writeMasterJournal(pPager, zMaster);
3304 if( rc!=SQLITE_OK ) goto sync_exit;
3305 rc = syncJournal(pPager);
3306 if( rc!=SQLITE_OK ) goto sync_exit;
3307 }
danielk197713adf8a2004-06-03 16:08:41 +00003308
danielk1977d761c0c2004-11-05 16:37:02 +00003309#ifndef SQLITE_OMIT_AUTOVACUUM
3310 if( nTrunc!=0 ){
3311 rc = sqlite3pager_truncate(pPager, nTrunc);
3312 if( rc!=SQLITE_OK ) goto sync_exit;
3313 }
3314#endif
3315
danielk197713adf8a2004-06-03 16:08:41 +00003316 /* Write all dirty pages to the database file */
3317 pPg = pager_get_all_dirty_pages(pPager);
3318 rc = pager_write_pagelist(pPg);
3319 if( rc!=SQLITE_OK ) goto sync_exit;
3320
danielk1977aa5ccdf2004-06-14 05:10:42 +00003321 /* Sync the database file. */
3322 if( !pPager->noSync ){
danielk197713adf8a2004-06-03 16:08:41 +00003323 rc = sqlite3OsSync(&pPager->fd);
3324 }
danielk1977aa5ccdf2004-06-14 05:10:42 +00003325
3326 pPager->state = PAGER_SYNCED;
danielk197713adf8a2004-06-03 16:08:41 +00003327 }
3328
3329sync_exit:
3330 return rc;
3331}
3332
danielk1977687566d2004-11-02 12:56:41 +00003333#ifndef SQLITE_OMIT_AUTOVACUUM
3334/*
3335** Move the page identified by pData to location pgno in the file.
3336**
3337** There must be no references to the current page pgno. If current page
3338** pgno is not already in the rollback journal, it is not written there by
3339** by this routine. The same applies to the page pData refers to on entry to
3340** this routine.
3341**
3342** References to the page refered to by pData remain valid. Updating any
3343** meta-data associated with page pData (i.e. data stored in the nExtra bytes
3344** allocated along with the page) is the responsibility of the caller.
3345**
3346** A transaction must be active when this routine is called, however it is
3347** illegal to call this routine if a statment transaction is active.
3348*/
3349int sqlite3pager_movepage(Pager *pPager, void *pData, Pgno pgno){
3350 PgHdr *pPg = DATA_TO_PGHDR(pData);
3351 PgHdr *pPgOld;
danielk1977f5fdda82004-11-03 08:44:05 +00003352 int h;
danielk197794daf7f2004-11-08 09:26:09 +00003353 Pgno needSyncPgno = 0;
danielk1977687566d2004-11-02 12:56:41 +00003354
3355 assert( !pPager->stmtInUse );
danielk1977687566d2004-11-02 12:56:41 +00003356 assert( pPg->nRef>0 );
3357
danielk1977599fcba2004-11-08 07:13:13 +00003358 TRACE5("MOVE %d page %d (needSync=%d) moves to %d\n",
3359 PAGERID(pPager), pPg->pgno, pPg->needSync, pgno);
danielk1977ef73ee92004-11-06 12:26:07 +00003360
danielk197794daf7f2004-11-08 09:26:09 +00003361 if( pPg->needSync ){
3362 needSyncPgno = pPg->pgno;
3363 assert( pPg->inJournal );
3364 assert( pPg->dirty );
danielk1977ae825582004-11-23 09:06:55 +00003365 assert( pPager->needSync );
danielk197794daf7f2004-11-08 09:26:09 +00003366 }
3367
danielk1977687566d2004-11-02 12:56:41 +00003368 /* Unlink pPg from it's hash-chain */
danielk1977f5fdda82004-11-03 08:44:05 +00003369 unlinkHashChain(pPager, pPg);
danielk1977687566d2004-11-02 12:56:41 +00003370
danielk1977ef73ee92004-11-06 12:26:07 +00003371 /* If the cache contains a page with page-number pgno, remove it
danielk1977599fcba2004-11-08 07:13:13 +00003372 ** from it's hash chain. Also, if the PgHdr.needSync was set for
3373 ** page pgno before the 'move' operation, it needs to be retained
3374 ** for the page moved there.
danielk1977f5fdda82004-11-03 08:44:05 +00003375 */
danielk1977687566d2004-11-02 12:56:41 +00003376 pPgOld = pager_lookup(pPager, pgno);
3377 if( pPgOld ){
danielk1977f5fdda82004-11-03 08:44:05 +00003378 assert( pPgOld->nRef==0 );
3379 unlinkHashChain(pPager, pPgOld);
3380 pPgOld->dirty = 0;
danielk1977ef73ee92004-11-06 12:26:07 +00003381 if( pPgOld->needSync ){
danielk197745901d62004-11-10 15:27:38 +00003382 assert( pPgOld->inJournal );
3383 pPg->inJournal = 1;
danielk1977ef73ee92004-11-06 12:26:07 +00003384 pPg->needSync = 1;
danielk1977ae825582004-11-23 09:06:55 +00003385 assert( pPager->needSync );
danielk1977ef73ee92004-11-06 12:26:07 +00003386 }
danielk1977687566d2004-11-02 12:56:41 +00003387 }
3388
danielk1977f5fdda82004-11-03 08:44:05 +00003389 /* Change the page number for pPg and insert it into the new hash-chain. */
3390 pPg->pgno = pgno;
3391 h = pager_hash(pgno);
3392 if( pPager->aHash[h] ){
3393 assert( pPager->aHash[h]->pPrevHash==0 );
3394 pPager->aHash[h]->pPrevHash = pPg;
3395 }
3396 pPg->pNextHash = pPager->aHash[h];
3397 pPager->aHash[h] = pPg;
3398 pPg->pPrevHash = 0;
3399
danielk1977687566d2004-11-02 12:56:41 +00003400 pPg->dirty = 1;
3401 pPager->dirtyCache = 1;
3402
danielk197794daf7f2004-11-08 09:26:09 +00003403 if( needSyncPgno ){
3404 /* If needSyncPgno is non-zero, then the journal file needs to be
3405 ** sync()ed before any data is written to database file page needSyncPgno.
3406 ** Currently, no such page exists in the page-cache and the
3407 ** Pager.aInJournal bit has been set. This needs to be remedied by loading
3408 ** the page into the pager-cache and setting the PgHdr.needSync flag.
danielk1977ae825582004-11-23 09:06:55 +00003409 **
3410 ** The sqlite3pager_get() call may cause the journal to sync. So make
3411 ** sure the Pager.needSync flag is set too.
danielk197794daf7f2004-11-08 09:26:09 +00003412 */
3413 int rc;
3414 void *pNeedSync;
danielk1977ae825582004-11-23 09:06:55 +00003415 assert( pPager->needSync );
danielk197794daf7f2004-11-08 09:26:09 +00003416 rc = sqlite3pager_get(pPager, needSyncPgno, &pNeedSync);
3417 if( rc!=SQLITE_OK ) return rc;
danielk1977ae825582004-11-23 09:06:55 +00003418 pPager->needSync = 1;
danielk197794daf7f2004-11-08 09:26:09 +00003419 DATA_TO_PGHDR(pNeedSync)->needSync = 1;
3420 DATA_TO_PGHDR(pNeedSync)->inJournal = 1;
3421 DATA_TO_PGHDR(pNeedSync)->dirty = 1;
3422 sqlite3pager_unref(pNeedSync);
3423 }
3424
danielk1977687566d2004-11-02 12:56:41 +00003425 return SQLITE_OK;
3426}
3427#endif
3428
dougcurrie81c95ef2004-06-18 23:21:47 +00003429#if defined(SQLITE_DEBUG) || defined(SQLITE_TEST)
drh89ac8c12004-06-09 14:17:20 +00003430/*
3431** Return the current state of the file lock for the given pager.
3432** The return value is one of NO_LOCK, SHARED_LOCK, RESERVED_LOCK,
3433** PENDING_LOCK, or EXCLUSIVE_LOCK.
3434*/
3435int sqlite3pager_lockstate(Pager *pPager){
danielk1977e3026632004-06-22 11:29:02 +00003436#ifdef OS_TEST
danielk19778a6c5502004-06-22 12:18:32 +00003437 return pPager->fd->fd.locktype;
danielk1977e3026632004-06-22 11:29:02 +00003438#else
drh89ac8c12004-06-09 14:17:20 +00003439 return pPager->fd.locktype;
danielk1977e3026632004-06-22 11:29:02 +00003440#endif
drh89ac8c12004-06-09 14:17:20 +00003441}
3442#endif
3443
danielk197793758c82005-01-21 08:13:14 +00003444#ifdef SQLITE_DEBUG
drhdd793422001-06-28 01:54:48 +00003445/*
3446** Print a listing of all referenced pages and their ref count.
3447*/
drh3aac2dd2004-04-26 14:10:20 +00003448void sqlite3pager_refdump(Pager *pPager){
drhdd793422001-06-28 01:54:48 +00003449 PgHdr *pPg;
3450 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
3451 if( pPg->nRef<=0 ) continue;
drhfe63d1c2004-09-08 20:13:04 +00003452 sqlite3DebugPrintf("PAGE %3d addr=%p nRef=%d\n",
3453 pPg->pgno, PGHDR_TO_DATA(pPg), pPg->nRef);
drhdd793422001-06-28 01:54:48 +00003454 }
3455}
3456#endif