blob: 2ec7561c38d36573d2e55803f33de0ec362d96b2 [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**
danielk197732554c12005-01-22 03:39:39 +000021** @(#) $Id: pager.c,v 1.186 2005/01/22 03:39:39 danielk1977 Exp $
drhed7c8552001-04-11 14:29:21 +000022*/
drhd9b02572001-04-15 00:37:09 +000023#include "sqliteInt.h"
drheb206252004-10-01 02:00:31 +000024#include "os.h"
drhed7c8552001-04-11 14:29:21 +000025#include "pager.h"
drhed7c8552001-04-11 14:29:21 +000026#include <assert.h>
drhd9b02572001-04-15 00:37:09 +000027#include <string.h>
drhed7c8552001-04-11 14:29:21 +000028
29/*
drhdb48ee02003-01-16 13:42:43 +000030** Macros for troubleshooting. Normally turned off
31*/
danielk1977466be562004-06-10 02:16:01 +000032#if 0
drh34f47322004-08-18 15:58:22 +000033#define TRACE1(X) sqlite3DebugPrintf(X)
34#define TRACE2(X,Y) sqlite3DebugPrintf(X,Y)
35#define TRACE3(X,Y,Z) sqlite3DebugPrintf(X,Y,Z)
36#define TRACE4(X,Y,Z,W) sqlite3DebugPrintf(X,Y,Z,W)
danielk197794daf7f2004-11-08 09:26:09 +000037#define TRACE5(X,Y,Z,W,V) sqlite3DebugPrintf(X,Y,Z,W,V)
drhdb48ee02003-01-16 13:42:43 +000038#else
drhdb48ee02003-01-16 13:42:43 +000039#define TRACE1(X)
40#define TRACE2(X,Y)
41#define TRACE3(X,Y,Z)
drh34f47322004-08-18 15:58:22 +000042#define TRACE4(X,Y,Z,W)
danielk1977599fcba2004-11-08 07:13:13 +000043#define TRACE5(X,Y,Z,W,V)
drhdb48ee02003-01-16 13:42:43 +000044#endif
45
danielk1977599fcba2004-11-08 07:13:13 +000046/*
47** The following two macros are used within the TRACEX() macros above
48** to print out file-descriptors. They are required so that tracing
49** can be turned on when using both the regular os_unix.c and os_test.c
50** backends.
51**
52** PAGERID() takes a pointer to a Pager struct as it's argument. The
53** associated file-descriptor is returned. FILEHANDLEID() takes an OsFile
54** struct as it's argument.
55*/
danielk1977ef73ee92004-11-06 12:26:07 +000056#ifdef OS_TEST
57#define PAGERID(p) (p->fd->fd.h)
58#define FILEHANDLEID(fd) (fd->fd.h)
59#else
60#define PAGERID(p) (p->fd.h)
61#define FILEHANDLEID(fd) (fd.h)
62#endif
drhdb48ee02003-01-16 13:42:43 +000063
64/*
drhed7c8552001-04-11 14:29:21 +000065** The page cache as a whole is always in one of the following
66** states:
67**
drha6abd042004-06-09 17:37:22 +000068** PAGER_UNLOCK The page cache is not currently reading or
drhed7c8552001-04-11 14:29:21 +000069** writing the database file. There is no
70** data held in memory. This is the initial
71** state.
72**
drha6abd042004-06-09 17:37:22 +000073** PAGER_SHARED The page cache is reading the database.
drhed7c8552001-04-11 14:29:21 +000074** Writing is not permitted. There can be
75** multiple readers accessing the same database
drh69688d52001-04-14 16:38:23 +000076** file at the same time.
drhed7c8552001-04-11 14:29:21 +000077**
drh726de592004-06-10 23:35:50 +000078** PAGER_RESERVED This process has reserved the database for writing
79** but has not yet made any changes. Only one process
80** at a time can reserve the database. The original
81** database file has not been modified so other
82** processes may still be reading the on-disk
drha6abd042004-06-09 17:37:22 +000083** database file.
84**
85** PAGER_EXCLUSIVE The page cache is writing the database.
drhed7c8552001-04-11 14:29:21 +000086** Access is exclusive. No other processes or
87** threads can be reading or writing while one
88** process is writing.
89**
danielk1977aa5ccdf2004-06-14 05:10:42 +000090** PAGER_SYNCED The pager moves to this state from PAGER_EXCLUSIVE
91** after all dirty pages have been written to the
92** database file and the file has been synced to
93** disk. All that remains to do is to remove the
94** journal file and the transaction will be
95** committed.
96**
drha6abd042004-06-09 17:37:22 +000097** The page cache comes up in PAGER_UNLOCK. The first time a
drh726de592004-06-10 23:35:50 +000098** sqlite3pager_get() occurs, the state transitions to PAGER_SHARED.
drhed7c8552001-04-11 14:29:21 +000099** After all pages have been released using sqlite_page_unref(),
drha6abd042004-06-09 17:37:22 +0000100** the state transitions back to PAGER_UNLOCK. The first time
drh726de592004-06-10 23:35:50 +0000101** that sqlite3pager_write() is called, the state transitions to
drha6abd042004-06-09 17:37:22 +0000102** PAGER_RESERVED. (Note that sqlite_page_write() can only be
drh306dc212001-05-21 13:45:10 +0000103** called on an outstanding page which means that the pager must
drha6abd042004-06-09 17:37:22 +0000104** be in PAGER_SHARED before it transitions to PAGER_RESERVED.)
drh726de592004-06-10 23:35:50 +0000105** The transition to PAGER_EXCLUSIVE occurs when before any changes
106** are made to the database file. After an sqlite3pager_rollback()
107** or sqlite_pager_commit(), the state goes back to PAGER_SHARED.
drhed7c8552001-04-11 14:29:21 +0000108*/
drha6abd042004-06-09 17:37:22 +0000109#define PAGER_UNLOCK 0
drh684917c2004-10-05 02:41:42 +0000110#define PAGER_SHARED 1 /* same as SHARED_LOCK */
111#define PAGER_RESERVED 2 /* same as RESERVED_LOCK */
112#define PAGER_EXCLUSIVE 4 /* same as EXCLUSIVE_LOCK */
113#define PAGER_SYNCED 5
drhed7c8552001-04-11 14:29:21 +0000114
drh684917c2004-10-05 02:41:42 +0000115/*
116** If the SQLITE_BUSY_RESERVED_LOCK macro is set to true at compile-time,
117** then failed attempts to get a reserved lock will invoke the busy callback.
118** This is off by default. To see why, consider the following scenario:
119**
120** Suppose thread A already has a shared lock and wants a reserved lock.
121** Thread B already has a reserved lock and wants an exclusive lock. If
122** both threads are using their busy callbacks, it might be a long time
123** be for one of the threads give up and allows the other to proceed.
124** But if the thread trying to get the reserved lock gives up quickly
125** (if it never invokes its busy callback) then the contention will be
126** resolved quickly.
127*/
128#ifndef SQLITE_BUSY_RESERVED_LOCK
129# define SQLITE_BUSY_RESERVED_LOCK 0
130#endif
drhd9b02572001-04-15 00:37:09 +0000131
drhed7c8552001-04-11 14:29:21 +0000132/*
drh887dc4c2004-10-22 16:22:57 +0000133** This macro rounds values up so that if the value is an address it
134** is guaranteed to be an address that is aligned to an 8-byte boundary.
135*/
136#define FORCE_ALIGNMENT(X) (((X)+7)&~7)
137
138/*
drhed7c8552001-04-11 14:29:21 +0000139** Each in-memory image of a page begins with the following header.
drhbd03cae2001-06-02 02:40:57 +0000140** This header is only visible to this pager module. The client
141** code that calls pager sees only the data that follows the header.
drhf6038712004-02-08 18:07:34 +0000142**
drh3aac2dd2004-04-26 14:10:20 +0000143** Client code should call sqlite3pager_write() on a page prior to making
144** any modifications to that page. The first time sqlite3pager_write()
drhf6038712004-02-08 18:07:34 +0000145** is called, the original page contents are written into the rollback
146** journal and PgHdr.inJournal and PgHdr.needSync are set. Later, once
147** the journal page has made it onto the disk surface, PgHdr.needSync
148** is cleared. The modified page cannot be written back into the original
149** database file until the journal pages has been synced to disk and the
150** PgHdr.needSync has been cleared.
151**
drh3aac2dd2004-04-26 14:10:20 +0000152** The PgHdr.dirty flag is set when sqlite3pager_write() is called and
drhf6038712004-02-08 18:07:34 +0000153** is cleared again when the page content is written back to the original
154** database file.
drhed7c8552001-04-11 14:29:21 +0000155*/
drhd9b02572001-04-15 00:37:09 +0000156typedef struct PgHdr PgHdr;
drhed7c8552001-04-11 14:29:21 +0000157struct PgHdr {
158 Pager *pPager; /* The pager to which this page belongs */
159 Pgno pgno; /* The page number for this page */
drh69688d52001-04-14 16:38:23 +0000160 PgHdr *pNextHash, *pPrevHash; /* Hash collision chain for PgHdr.pgno */
drhd9b02572001-04-15 00:37:09 +0000161 PgHdr *pNextFree, *pPrevFree; /* Freelist of pages where nRef==0 */
drhac69b052004-05-12 13:30:07 +0000162 PgHdr *pNextAll; /* A list of all pages */
163 PgHdr *pNextStmt, *pPrevStmt; /* List of pages in the statement journal */
drh193a6b42002-07-07 16:52:46 +0000164 u8 inJournal; /* TRUE if has been written to journal */
drhac69b052004-05-12 13:30:07 +0000165 u8 inStmt; /* TRUE if in the statement subjournal */
drh193a6b42002-07-07 16:52:46 +0000166 u8 dirty; /* TRUE if we need to write back changes */
drhdb48ee02003-01-16 13:42:43 +0000167 u8 needSync; /* Sync journal before writing this page */
drh193a6b42002-07-07 16:52:46 +0000168 u8 alwaysRollback; /* Disable dont_rollback() for this page */
drhac69b052004-05-12 13:30:07 +0000169 short int nRef; /* Number of users of this page */
drh2554f8b2003-01-22 01:26:44 +0000170 PgHdr *pDirty; /* Dirty pages sorted by PgHdr.pgno */
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 */
drhac69b052004-05-12 13:30:07 +0000253 u8 stmtOpen; /* True if the statement subjournal is open */
254 u8 stmtInUse; /* True we are in a statement subtransaction */
255 u8 stmtAutoopen; /* Open stmt journal when main journal is opened*/
drh603240c2002-03-05 01:11:12 +0000256 u8 noSync; /* Do not sync the journal if true */
drh968af522003-02-11 14:55:40 +0000257 u8 fullSync; /* Do extra syncs of the journal for robustness */
drha6abd042004-06-09 17:37:22 +0000258 u8 state; /* PAGER_UNLOCK, _SHARED, _RESERVED, etc. */
drh603240c2002-03-05 01:11:12 +0000259 u8 errMask; /* One of several kinds of errors */
260 u8 tempFile; /* zFilename is a temporary file */
261 u8 readOnly; /* True for a read-only database */
262 u8 needSync; /* True if an fsync() is needed on the journal */
drha6abd042004-06-09 17:37:22 +0000263 u8 dirtyCache; /* True if cached pages have changed */
drh193a6b42002-07-07 16:52:46 +0000264 u8 alwaysRollback; /* Disable dont_rollback() for all pages */
drhac69b052004-05-12 13:30:07 +0000265 u8 memDb; /* True to inhibit all file I/O */
drh603240c2002-03-05 01:11:12 +0000266 u8 *aInJournal; /* One bit for each page in the database file */
drhac69b052004-05-12 13:30:07 +0000267 u8 *aInStmt; /* One bit for each page in the database */
drhfdb38062004-08-21 19:20:42 +0000268 u8 setMaster; /* True if a m-j name has been written to jrnl */
drh726de592004-06-10 23:35:50 +0000269 BusyHandler *pBusyHandler; /* Pointer to sqlite.busyHandler */
drhed7c8552001-04-11 14:29:21 +0000270 PgHdr *pFirst, *pLast; /* List of free pages */
drh341eae82003-01-21 02:39:36 +0000271 PgHdr *pFirstSynced; /* First free page with PgHdr.needSync==0 */
drhd9b02572001-04-15 00:37:09 +0000272 PgHdr *pAll; /* List of all pages */
drhac69b052004-05-12 13:30:07 +0000273 PgHdr *pStmt; /* List of pages in the statement subjournal */
drheb206252004-10-01 02:00:31 +0000274 i64 journalOff; /* Current byte offset in the journal file */
275 i64 journalHdr; /* Byte offset to previous journal header */
276 i64 stmtHdrOff; /* First journal header written this statement */
277 i64 stmtCksum; /* cksumInit when statement was started */
danielk197776572402004-06-25 02:38:54 +0000278 int sectorSize; /* Assumed sector size during rollback */
drh76ff3a02004-09-24 22:32:30 +0000279 PgHdr *aHash[N_PG_HASH]; /* Hash table to map page number to PgHdr */
drhd9b02572001-04-15 00:37:09 +0000280};
281
282/*
283** These are bits that can be set in Pager.errMask.
284*/
285#define PAGER_ERR_FULL 0x01 /* a write() failed */
286#define PAGER_ERR_MEM 0x02 /* malloc() failed */
287#define PAGER_ERR_LOCK 0x04 /* error in the locking protocol */
288#define PAGER_ERR_CORRUPT 0x08 /* database or journal corruption */
drh81a20f22001-10-12 17:30:04 +0000289#define PAGER_ERR_DISK 0x10 /* general disk I/O error - bad hard drive? */
drhd9b02572001-04-15 00:37:09 +0000290
291/*
drh5e00f6c2001-09-13 13:46:56 +0000292** Journal files begin with the following magic string. The data
293** was obtained from /dev/random. It is used only as a sanity check.
drh94f33312002-08-12 12:29:56 +0000294**
drhae2b40c2004-06-09 19:03:54 +0000295** Since version 2.8.0, the journal format contains additional sanity
296** checking information. If the power fails while the journal is begin
297** written, semi-random garbage data might appear in the journal
298** file after power is restored. If an attempt is then made
drh968af522003-02-11 14:55:40 +0000299** to roll the journal back, the database could be corrupted. The additional
300** sanity checking data is an attempt to discover the garbage in the
301** journal and ignore it.
302**
drhae2b40c2004-06-09 19:03:54 +0000303** The sanity checking information for the new journal format consists
drh968af522003-02-11 14:55:40 +0000304** of a 32-bit checksum on each page of data. The checksum covers both
drh90f5ecb2004-07-22 01:19:35 +0000305** the page number and the pPager->pageSize bytes of data for the page.
drh968af522003-02-11 14:55:40 +0000306** This cksum is initialized to a 32-bit random value that appears in the
307** journal file right after the header. The random initializer is important,
308** because garbage data that appears at the end of a journal is likely
309** data that was once in other files that have now been deleted. If the
310** garbage data came from an obsolete journal file, the checksums might
311** be correct. But by initializing the checksum to random value which
312** is different for every journal, we minimize that risk.
drhd9b02572001-04-15 00:37:09 +0000313*/
drhae2b40c2004-06-09 19:03:54 +0000314static const unsigned char aJournalMagic[] = {
315 0xd9, 0xd5, 0x05, 0xf9, 0x20, 0xa1, 0x63, 0xd7,
drhed7c8552001-04-11 14:29:21 +0000316};
317
318/*
drh726de592004-06-10 23:35:50 +0000319** The size of the header and of each page in the journal is determined
320** by the following macros.
drh968af522003-02-11 14:55:40 +0000321*/
drhae2b40c2004-06-09 19:03:54 +0000322#define JOURNAL_PG_SZ(pPager) ((pPager->pageSize) + 8)
drh968af522003-02-11 14:55:40 +0000323
danielk197776572402004-06-25 02:38:54 +0000324/*
325** The journal header size for this pager. In the future, this could be
326** set to some value read from the disk controller. The important
327** characteristic is that it is the same size as a disk sector.
328*/
329#define JOURNAL_HDR_SZ(pPager) (pPager->sectorSize)
330
drhb7f91642004-10-31 02:22:47 +0000331/*
332** The macro MEMDB is true if we are dealing with an in-memory database.
333** We do this as a macro so that if the SQLITE_OMIT_MEMORYDB macro is set,
334** the value of MEMDB will be a constant and the compiler will optimize
335** out code that would never execute.
336*/
337#ifdef SQLITE_OMIT_MEMORYDB
338# define MEMDB 0
339#else
340# define MEMDB pPager->memDb
341#endif
342
343/*
344** The default size of a disk sector
345*/
danielk197776572402004-06-25 02:38:54 +0000346#define PAGER_SECTOR_SIZE 512
347
348/*
349** Page number PAGER_MJ_PGNO is never used in an SQLite database (it is
350** reserved for working around a windows/posix incompatibility). It is
351** used in the journal to signify that the remainder of the journal file
352** is devoted to storing a master journal name - there are no more pages to
353** roll back. See comments for function writeMasterJournal() for details.
354*/
danielk1977599fcba2004-11-08 07:13:13 +0000355/* #define PAGER_MJ_PGNO(x) (PENDING_BYTE/((x)->pageSize)) */
356#define PAGER_MJ_PGNO(x) ((PENDING_BYTE/((x)->pageSize))+1)
danielk197713adf8a2004-06-03 16:08:41 +0000357
drh968af522003-02-11 14:55:40 +0000358/*
danielk197726836652005-01-17 01:33:13 +0000359** The maximum legal page number is (2^31 - 1).
360*/
361#define PAGER_MAX_PGNO 2147483647
362
363/*
drh726de592004-06-10 23:35:50 +0000364** Enable reference count tracking (for debugging) here:
drhdd793422001-06-28 01:54:48 +0000365*/
danielk1977aca790a2005-01-13 11:07:52 +0000366#ifdef SQLITE_DEBUG
drh3aac2dd2004-04-26 14:10:20 +0000367 int pager3_refinfo_enable = 0;
drhdd793422001-06-28 01:54:48 +0000368 static void pager_refinfo(PgHdr *p){
369 static int cnt = 0;
drh3aac2dd2004-04-26 14:10:20 +0000370 if( !pager3_refinfo_enable ) return;
drhfe63d1c2004-09-08 20:13:04 +0000371 sqlite3DebugPrintf(
372 "REFCNT: %4d addr=%p nRef=%d\n",
373 p->pgno, PGHDR_TO_DATA(p), p->nRef
drhdd793422001-06-28 01:54:48 +0000374 );
375 cnt++; /* Something to set a breakpoint on */
376 }
377# define REFINFO(X) pager_refinfo(X)
378#else
379# define REFINFO(X)
380#endif
381
382/*
drh34e79ce2004-02-08 06:05:46 +0000383** Read a 32-bit integer from the given file descriptor. Store the integer
384** that is read in *pRes. Return SQLITE_OK if everything worked, or an
385** error code is something goes wrong.
drh726de592004-06-10 23:35:50 +0000386**
387** All values are stored on disk as big-endian.
drh94f33312002-08-12 12:29:56 +0000388*/
drhae2b40c2004-06-09 19:03:54 +0000389static int read32bits(OsFile *fd, u32 *pRes){
drh94f33312002-08-12 12:29:56 +0000390 u32 res;
391 int rc;
danielk19774adee202004-05-08 08:23:19 +0000392 rc = sqlite3OsRead(fd, &res, sizeof(res));
drhae2b40c2004-06-09 19:03:54 +0000393 if( rc==SQLITE_OK ){
drh94f33312002-08-12 12:29:56 +0000394 unsigned char ac[4];
395 memcpy(ac, &res, 4);
396 res = (ac[0]<<24) | (ac[1]<<16) | (ac[2]<<8) | ac[3];
397 }
398 *pRes = res;
399 return rc;
400}
401
402/*
drh34e79ce2004-02-08 06:05:46 +0000403** Write a 32-bit integer into the given file descriptor. Return SQLITE_OK
404** on success or an error code is something goes wrong.
drh94f33312002-08-12 12:29:56 +0000405*/
406static int write32bits(OsFile *fd, u32 val){
407 unsigned char ac[4];
drh94f33312002-08-12 12:29:56 +0000408 ac[0] = (val>>24) & 0xff;
409 ac[1] = (val>>16) & 0xff;
410 ac[2] = (val>>8) & 0xff;
411 ac[3] = val & 0xff;
danielk19774adee202004-05-08 08:23:19 +0000412 return sqlite3OsWrite(fd, ac, 4);
drh94f33312002-08-12 12:29:56 +0000413}
414
drh2554f8b2003-01-22 01:26:44 +0000415/*
danielk1977aa5ccdf2004-06-14 05:10:42 +0000416** Write the 32-bit integer 'val' into the page identified by page header
417** 'p' at offset 'offset'.
drh2554f8b2003-01-22 01:26:44 +0000418*/
drh968af522003-02-11 14:55:40 +0000419static void store32bits(u32 val, PgHdr *p, int offset){
drh2554f8b2003-01-22 01:26:44 +0000420 unsigned char *ac;
drhec1bd0b2003-08-26 11:41:27 +0000421 ac = &((unsigned char*)PGHDR_TO_DATA(p))[offset];
drhae2b40c2004-06-09 19:03:54 +0000422 ac[0] = (val>>24) & 0xff;
423 ac[1] = (val>>16) & 0xff;
424 ac[2] = (val>>8) & 0xff;
425 ac[3] = val & 0xff;
drh2554f8b2003-01-22 01:26:44 +0000426}
427
danielk1977aa5ccdf2004-06-14 05:10:42 +0000428/*
429** Read a 32-bit integer at offset 'offset' from the page identified by
430** page header 'p'.
431*/
432static u32 retrieve32bits(PgHdr *p, int offset){
433 unsigned char *ac;
434 ac = &((unsigned char*)PGHDR_TO_DATA(p))[offset];
435 return (ac[0]<<24) | (ac[1]<<16) | (ac[2]<<8) | ac[3];
436}
437
drh94f33312002-08-12 12:29:56 +0000438
439/*
drhd9b02572001-04-15 00:37:09 +0000440** Convert the bits in the pPager->errMask into an approprate
441** return code.
442*/
443static int pager_errcode(Pager *pPager){
444 int rc = SQLITE_OK;
445 if( pPager->errMask & PAGER_ERR_LOCK ) rc = SQLITE_PROTOCOL;
drh81a20f22001-10-12 17:30:04 +0000446 if( pPager->errMask & PAGER_ERR_DISK ) rc = SQLITE_IOERR;
drhd9b02572001-04-15 00:37:09 +0000447 if( pPager->errMask & PAGER_ERR_FULL ) rc = SQLITE_FULL;
448 if( pPager->errMask & PAGER_ERR_MEM ) rc = SQLITE_NOMEM;
449 if( pPager->errMask & PAGER_ERR_CORRUPT ) rc = SQLITE_CORRUPT;
450 return rc;
drhed7c8552001-04-11 14:29:21 +0000451}
452
453/*
danielk197776572402004-06-25 02:38:54 +0000454** When this is called the journal file for pager pPager must be open.
455** The master journal file name is read from the end of the file and
456** written into memory obtained from sqliteMalloc(). *pzMaster is
457** set to point at the memory and SQLITE_OK returned. The caller must
458** sqliteFree() *pzMaster.
459**
460** If no master journal file name is present *pzMaster is set to 0 and
461** SQLITE_OK returned.
462*/
463static int readMasterJournal(OsFile *pJrnl, char **pzMaster){
464 int rc;
465 u32 len;
drheb206252004-10-01 02:00:31 +0000466 i64 szJ;
danielk1977c3e8f5e2004-06-28 01:16:46 +0000467 u32 cksum;
danielk1977cafadba2004-06-25 11:11:54 +0000468 int i;
danielk197776572402004-06-25 02:38:54 +0000469 unsigned char aMagic[8]; /* A buffer to hold the magic header */
470
471 *pzMaster = 0;
472
473 rc = sqlite3OsFileSize(pJrnl, &szJ);
danielk1977cafadba2004-06-25 11:11:54 +0000474 if( rc!=SQLITE_OK || szJ<16 ) return rc;
danielk197776572402004-06-25 02:38:54 +0000475
danielk1977cafadba2004-06-25 11:11:54 +0000476 rc = sqlite3OsSeek(pJrnl, szJ-16);
danielk197776572402004-06-25 02:38:54 +0000477 if( rc!=SQLITE_OK ) return rc;
478
479 rc = read32bits(pJrnl, &len);
480 if( rc!=SQLITE_OK ) return rc;
481
danielk1977cafadba2004-06-25 11:11:54 +0000482 rc = read32bits(pJrnl, &cksum);
483 if( rc!=SQLITE_OK ) return rc;
484
danielk197776572402004-06-25 02:38:54 +0000485 rc = sqlite3OsRead(pJrnl, aMagic, 8);
486 if( rc!=SQLITE_OK || memcmp(aMagic, aJournalMagic, 8) ) return rc;
487
danielk19778191bff2004-06-28 04:52:30 +0000488 rc = sqlite3OsSeek(pJrnl, szJ-16-len);
danielk197776572402004-06-25 02:38:54 +0000489 if( rc!=SQLITE_OK ) return rc;
490
danielk19778191bff2004-06-28 04:52:30 +0000491 *pzMaster = (char *)sqliteMalloc(len+1);
danielk197776572402004-06-25 02:38:54 +0000492 if( !*pzMaster ){
493 return SQLITE_NOMEM;
494 }
495 rc = sqlite3OsRead(pJrnl, *pzMaster, len);
496 if( rc!=SQLITE_OK ){
497 sqliteFree(*pzMaster);
498 *pzMaster = 0;
499 return rc;
500 }
danielk1977cafadba2004-06-25 11:11:54 +0000501
502 /* See if the checksum matches the master journal name */
503 for(i=0; i<len; i++){
danielk19778191bff2004-06-28 04:52:30 +0000504 cksum -= (*pzMaster)[i];
danielk1977cafadba2004-06-25 11:11:54 +0000505 }
danielk19778191bff2004-06-28 04:52:30 +0000506 if( cksum ){
507 /* If the checksum doesn't add up, then one or more of the disk sectors
508 ** containing the master journal filename is corrupted. This means
509 ** definitely roll back, so just return SQLITE_OK and report a (nul)
510 ** master-journal filename.
511 */
danielk1977cafadba2004-06-25 11:11:54 +0000512 sqliteFree(*pzMaster);
513 *pzMaster = 0;
danielk1977aca790a2005-01-13 11:07:52 +0000514 }else{
515 (*pzMaster)[len] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000516 }
danielk197776572402004-06-25 02:38:54 +0000517
518 return SQLITE_OK;
519}
520
521/*
522** Seek the journal file descriptor to the next sector boundary where a
523** journal header may be read or written. Pager.journalOff is updated with
524** the new seek offset.
525**
526** i.e for a sector size of 512:
527**
528** Input Offset Output Offset
529** ---------------------------------------
530** 0 0
531** 512 512
532** 100 512
533** 2000 2048
534**
535*/
536static int seekJournalHdr(Pager *pPager){
drheb206252004-10-01 02:00:31 +0000537 i64 offset = 0;
538 i64 c = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000539 if( c ){
540 offset = ((c-1)/JOURNAL_HDR_SZ(pPager) + 1) * JOURNAL_HDR_SZ(pPager);
541 }
542 assert( offset%JOURNAL_HDR_SZ(pPager)==0 );
543 assert( offset>=c );
544 assert( (offset-c)<JOURNAL_HDR_SZ(pPager) );
545 pPager->journalOff = offset;
546 return sqlite3OsSeek(&pPager->jfd, pPager->journalOff);
547}
548
549/*
550** The journal file must be open when this routine is called. A journal
551** header (JOURNAL_HDR_SZ bytes) is written into the journal file at the
552** current location.
553**
554** The format for the journal header is as follows:
555** - 8 bytes: Magic identifying journal format.
556** - 4 bytes: Number of records in journal, or -1 no-sync mode is on.
557** - 4 bytes: Random number used for page hash.
558** - 4 bytes: Initial database page count.
559** - 4 bytes: Sector size used by the process that wrote this journal.
560**
danielk1977f42f25c2004-06-25 07:21:28 +0000561** Followed by (JOURNAL_HDR_SZ - 24) bytes of unused space.
danielk197776572402004-06-25 02:38:54 +0000562*/
563static int writeJournalHdr(Pager *pPager){
564
565 int rc = seekJournalHdr(pPager);
566 if( rc ) return rc;
567
568 pPager->journalHdr = pPager->journalOff;
569 if( pPager->stmtHdrOff==0 ){
570 pPager->stmtHdrOff = pPager->journalHdr;
571 }
572 pPager->journalOff += JOURNAL_HDR_SZ(pPager);
573
574 /* FIX ME:
575 **
576 ** Possibly for a pager not in no-sync mode, the journal magic should not
577 ** be written until nRec is filled in as part of next syncJournal().
578 **
579 ** Actually maybe the whole journal header should be delayed until that
580 ** point. Think about this.
581 */
582 rc = sqlite3OsWrite(&pPager->jfd, aJournalMagic, sizeof(aJournalMagic));
583
584 if( rc==SQLITE_OK ){
585 /* The nRec Field. 0xFFFFFFFF for no-sync journals. */
586 rc = write32bits(&pPager->jfd, pPager->noSync ? 0xffffffff : 0);
587 }
588 if( rc==SQLITE_OK ){
589 /* The random check-hash initialiser */
590 sqlite3Randomness(sizeof(pPager->cksumInit), &pPager->cksumInit);
591 rc = write32bits(&pPager->jfd, pPager->cksumInit);
592 }
593 if( rc==SQLITE_OK ){
594 /* The initial database size */
595 rc = write32bits(&pPager->jfd, pPager->dbSize);
596 }
597 if( rc==SQLITE_OK ){
598 /* The assumed sector size for this process */
599 rc = write32bits(&pPager->jfd, pPager->sectorSize);
600 }
601
602 /* The journal header has been written successfully. Seek the journal
603 ** file descriptor to the end of the journal header sector.
604 */
605 if( rc==SQLITE_OK ){
606 sqlite3OsSeek(&pPager->jfd, pPager->journalOff-1);
607 rc = sqlite3OsWrite(&pPager->jfd, "\000", 1);
608 }
609 return rc;
610}
611
612/*
613** The journal file must be open when this is called. A journal header file
614** (JOURNAL_HDR_SZ bytes) is read from the current location in the journal
615** file. See comments above function writeJournalHdr() for a description of
616** the journal header format.
617**
618** If the header is read successfully, *nRec is set to the number of
619** page records following this header and *dbSize is set to the size of the
620** database before the transaction began, in pages. Also, pPager->cksumInit
621** is set to the value read from the journal header. SQLITE_OK is returned
622** in this case.
623**
624** If the journal header file appears to be corrupted, SQLITE_DONE is
625** returned and *nRec and *dbSize are not set. If JOURNAL_HDR_SZ bytes
626** cannot be read from the journal file an error code is returned.
627*/
628static int readJournalHdr(
629 Pager *pPager,
drheb206252004-10-01 02:00:31 +0000630 i64 journalSize,
danielk197776572402004-06-25 02:38:54 +0000631 u32 *pNRec,
632 u32 *pDbSize
633){
634 int rc;
635 unsigned char aMagic[8]; /* A buffer to hold the magic header */
636
637 rc = seekJournalHdr(pPager);
638 if( rc ) return rc;
639
640 if( pPager->journalOff+JOURNAL_HDR_SZ(pPager) > journalSize ){
641 return SQLITE_DONE;
642 }
643
644 rc = sqlite3OsRead(&pPager->jfd, aMagic, sizeof(aMagic));
645 if( rc ) return rc;
646
647 if( memcmp(aMagic, aJournalMagic, sizeof(aMagic))!=0 ){
648 return SQLITE_DONE;
649 }
650
651 rc = read32bits(&pPager->jfd, pNRec);
652 if( rc ) return rc;
653
654 rc = read32bits(&pPager->jfd, &pPager->cksumInit);
655 if( rc ) return rc;
656
657 rc = read32bits(&pPager->jfd, pDbSize);
658 if( rc ) return rc;
659
660 /* Update the assumed sector-size to match the value used by
661 ** the process that created this journal. If this journal was
662 ** created by a process other than this one, then this routine
663 ** is being called from within pager_playback(). The local value
664 ** of Pager.sectorSize is restored at the end of that routine.
665 */
danielk1977c3e8f5e2004-06-28 01:16:46 +0000666 rc = read32bits(&pPager->jfd, (u32 *)&pPager->sectorSize);
danielk197776572402004-06-25 02:38:54 +0000667 if( rc ) return rc;
668
669 pPager->journalOff += JOURNAL_HDR_SZ(pPager);
670 rc = sqlite3OsSeek(&pPager->jfd, pPager->journalOff);
671 return rc;
672}
673
674
675/*
676** Write the supplied master journal name into the journal file for pager
danielk1977cafadba2004-06-25 11:11:54 +0000677** pPager at the current location. The master journal name must be the last
678** thing written to a journal file. If the pager is in full-sync mode, the
679** journal file descriptor is advanced to the next sector boundary before
680** anything is written. The format is:
681**
682** + 4 bytes: PAGER_MJ_PGNO.
683** + N bytes: length of master journal name.
684** + 4 bytes: N
685** + 4 bytes: Master journal name checksum.
686** + 8 bytes: aJournalMagic[].
687**
688** The master journal page checksum is the sum of the bytes in the master
689** journal name.
danielk197776572402004-06-25 02:38:54 +0000690*/
691static int writeMasterJournal(Pager *pPager, const char *zMaster){
692 int rc;
693 int len;
danielk1977cafadba2004-06-25 11:11:54 +0000694 int i;
danielk1977c3e8f5e2004-06-28 01:16:46 +0000695 u32 cksum = 0;
danielk197776572402004-06-25 02:38:54 +0000696
697 if( !zMaster || pPager->setMaster) return SQLITE_OK;
698 pPager->setMaster = 1;
699
700 len = strlen(zMaster);
danielk1977cafadba2004-06-25 11:11:54 +0000701 for(i=0; i<len; i++){
702 cksum += zMaster[i];
703 }
danielk197776572402004-06-25 02:38:54 +0000704
705 /* If in full-sync mode, advance to the next disk sector before writing
706 ** the master journal name. This is in case the previous page written to
707 ** the journal has already been synced.
708 */
709 if( pPager->fullSync ){
710 rc = seekJournalHdr(pPager);
711 if( rc!=SQLITE_OK ) return rc;
712 }
danielk1977cafadba2004-06-25 11:11:54 +0000713 pPager->journalOff += (len+20);
danielk197776572402004-06-25 02:38:54 +0000714
715 rc = write32bits(&pPager->jfd, PAGER_MJ_PGNO(pPager));
716 if( rc!=SQLITE_OK ) return rc;
717
718 rc = sqlite3OsWrite(&pPager->jfd, zMaster, len);
719 if( rc!=SQLITE_OK ) return rc;
720
721 rc = write32bits(&pPager->jfd, len);
722 if( rc!=SQLITE_OK ) return rc;
723
danielk1977cafadba2004-06-25 11:11:54 +0000724 rc = write32bits(&pPager->jfd, cksum);
725 if( rc!=SQLITE_OK ) return rc;
726
danielk197776572402004-06-25 02:38:54 +0000727 rc = sqlite3OsWrite(&pPager->jfd, aJournalMagic, sizeof(aJournalMagic));
drhfdb38062004-08-21 19:20:42 +0000728 pPager->needSync = 1;
danielk197776572402004-06-25 02:38:54 +0000729 return rc;
730}
731
732/*
drh03eb96a2002-11-10 23:32:56 +0000733** Add or remove a page from the list of all pages that are in the
drhac69b052004-05-12 13:30:07 +0000734** statement journal.
drh03eb96a2002-11-10 23:32:56 +0000735**
736** The Pager keeps a separate list of pages that are currently in
drhac69b052004-05-12 13:30:07 +0000737** the statement journal. This helps the sqlite3pager_stmt_commit()
drh03eb96a2002-11-10 23:32:56 +0000738** routine run MUCH faster for the common case where there are many
drhac69b052004-05-12 13:30:07 +0000739** pages in memory but only a few are in the statement journal.
drh03eb96a2002-11-10 23:32:56 +0000740*/
drh3aac2dd2004-04-26 14:10:20 +0000741static void page_add_to_stmt_list(PgHdr *pPg){
drh03eb96a2002-11-10 23:32:56 +0000742 Pager *pPager = pPg->pPager;
drhac69b052004-05-12 13:30:07 +0000743 if( pPg->inStmt ) return;
744 assert( pPg->pPrevStmt==0 && pPg->pNextStmt==0 );
745 pPg->pPrevStmt = 0;
746 if( pPager->pStmt ){
747 pPager->pStmt->pPrevStmt = pPg;
drh03eb96a2002-11-10 23:32:56 +0000748 }
drhac69b052004-05-12 13:30:07 +0000749 pPg->pNextStmt = pPager->pStmt;
750 pPager->pStmt = pPg;
751 pPg->inStmt = 1;
drh03eb96a2002-11-10 23:32:56 +0000752}
drh3aac2dd2004-04-26 14:10:20 +0000753static void page_remove_from_stmt_list(PgHdr *pPg){
drhac69b052004-05-12 13:30:07 +0000754 if( !pPg->inStmt ) return;
755 if( pPg->pPrevStmt ){
756 assert( pPg->pPrevStmt->pNextStmt==pPg );
757 pPg->pPrevStmt->pNextStmt = pPg->pNextStmt;
drh03eb96a2002-11-10 23:32:56 +0000758 }else{
drhac69b052004-05-12 13:30:07 +0000759 assert( pPg->pPager->pStmt==pPg );
760 pPg->pPager->pStmt = pPg->pNextStmt;
drh03eb96a2002-11-10 23:32:56 +0000761 }
drhac69b052004-05-12 13:30:07 +0000762 if( pPg->pNextStmt ){
763 assert( pPg->pNextStmt->pPrevStmt==pPg );
764 pPg->pNextStmt->pPrevStmt = pPg->pPrevStmt;
drh03eb96a2002-11-10 23:32:56 +0000765 }
drhac69b052004-05-12 13:30:07 +0000766 pPg->pNextStmt = 0;
767 pPg->pPrevStmt = 0;
768 pPg->inStmt = 0;
drh03eb96a2002-11-10 23:32:56 +0000769}
770
771/*
drhed7c8552001-04-11 14:29:21 +0000772** Find a page in the hash table given its page number. Return
773** a pointer to the page or NULL if not found.
774*/
drhd9b02572001-04-15 00:37:09 +0000775static PgHdr *pager_lookup(Pager *pPager, Pgno pgno){
drh836faa42003-01-11 13:30:57 +0000776 PgHdr *p = pPager->aHash[pager_hash(pgno)];
drhed7c8552001-04-11 14:29:21 +0000777 while( p && p->pgno!=pgno ){
778 p = p->pNextHash;
779 }
780 return p;
781}
782
783/*
784** Unlock the database and clear the in-memory cache. This routine
785** sets the state of the pager back to what it was when it was first
786** opened. Any outstanding pages are invalidated and subsequent attempts
787** to access those pages will likely result in a coredump.
788*/
drhd9b02572001-04-15 00:37:09 +0000789static void pager_reset(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +0000790 PgHdr *pPg, *pNext;
drhd9b02572001-04-15 00:37:09 +0000791 for(pPg=pPager->pAll; pPg; pPg=pNext){
792 pNext = pPg->pNextAll;
793 sqliteFree(pPg);
drhed7c8552001-04-11 14:29:21 +0000794 }
795 pPager->pFirst = 0;
drh341eae82003-01-21 02:39:36 +0000796 pPager->pFirstSynced = 0;
drhd9b02572001-04-15 00:37:09 +0000797 pPager->pLast = 0;
798 pPager->pAll = 0;
drhed7c8552001-04-11 14:29:21 +0000799 memset(pPager->aHash, 0, sizeof(pPager->aHash));
800 pPager->nPage = 0;
drha6abd042004-06-09 17:37:22 +0000801 if( pPager->state>=PAGER_RESERVED ){
drh3aac2dd2004-04-26 14:10:20 +0000802 sqlite3pager_rollback(pPager);
drhed7c8552001-04-11 14:29:21 +0000803 }
drha6abd042004-06-09 17:37:22 +0000804 sqlite3OsUnlock(&pPager->fd, NO_LOCK);
805 pPager->state = PAGER_UNLOCK;
drhd9b02572001-04-15 00:37:09 +0000806 pPager->dbSize = -1;
drhed7c8552001-04-11 14:29:21 +0000807 pPager->nRef = 0;
drh8cfbf082001-09-19 13:22:39 +0000808 assert( pPager->journalOpen==0 );
drhed7c8552001-04-11 14:29:21 +0000809}
810
811/*
812** When this routine is called, the pager has the journal file open and
drha6abd042004-06-09 17:37:22 +0000813** a RESERVED or EXCLUSIVE lock on the database. This routine releases
814** the database lock and acquires a SHARED lock in its place. The journal
815** file is deleted and closed.
drh50457892003-09-06 01:10:47 +0000816**
817** TODO: Consider keeping the journal file open for temporary databases.
818** This might give a performance improvement on windows where opening
819** a file is an expensive operation.
drhed7c8552001-04-11 14:29:21 +0000820*/
drhd9b02572001-04-15 00:37:09 +0000821static int pager_unwritelock(Pager *pPager){
drhd9b02572001-04-15 00:37:09 +0000822 PgHdr *pPg;
drh9c105bb2004-10-02 20:38:28 +0000823 int rc;
drhb7f91642004-10-31 02:22:47 +0000824 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +0000825 if( pPager->state<PAGER_RESERVED ){
826 return SQLITE_OK;
827 }
drh3aac2dd2004-04-26 14:10:20 +0000828 sqlite3pager_stmt_commit(pPager);
drhac69b052004-05-12 13:30:07 +0000829 if( pPager->stmtOpen ){
830 sqlite3OsClose(&pPager->stfd);
831 pPager->stmtOpen = 0;
drh0f892532002-05-30 12:27:03 +0000832 }
drhda47d772002-12-02 04:25:19 +0000833 if( pPager->journalOpen ){
danielk19774adee202004-05-08 08:23:19 +0000834 sqlite3OsClose(&pPager->jfd);
drhda47d772002-12-02 04:25:19 +0000835 pPager->journalOpen = 0;
danielk19774adee202004-05-08 08:23:19 +0000836 sqlite3OsDelete(pPager->zJournal);
drhda47d772002-12-02 04:25:19 +0000837 sqliteFree( pPager->aInJournal );
838 pPager->aInJournal = 0;
839 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
840 pPg->inJournal = 0;
841 pPg->dirty = 0;
drhdb48ee02003-01-16 13:42:43 +0000842 pPg->needSync = 0;
drhda47d772002-12-02 04:25:19 +0000843 }
danielk1977ef317ab2004-06-23 10:43:10 +0000844 pPager->dirtyCache = 0;
danielk1977ef317ab2004-06-23 10:43:10 +0000845 pPager->nRec = 0;
drhda47d772002-12-02 04:25:19 +0000846 }else{
drha6abd042004-06-09 17:37:22 +0000847 assert( pPager->dirtyCache==0 || pPager->useJournal==0 );
drhd9b02572001-04-15 00:37:09 +0000848 }
drh9c105bb2004-10-02 20:38:28 +0000849 rc = sqlite3OsUnlock(&pPager->fd, SHARED_LOCK);
drha6abd042004-06-09 17:37:22 +0000850 pPager->state = PAGER_SHARED;
danielk1977ef317ab2004-06-23 10:43:10 +0000851 pPager->origDbSize = 0;
danielk197776572402004-06-25 02:38:54 +0000852 pPager->setMaster = 0;
drh9c105bb2004-10-02 20:38:28 +0000853 return rc;
drhed7c8552001-04-11 14:29:21 +0000854}
855
drhed7c8552001-04-11 14:29:21 +0000856/*
drh968af522003-02-11 14:55:40 +0000857** Compute and return a checksum for the page of data.
drh34e79ce2004-02-08 06:05:46 +0000858**
859** This is not a real checksum. It is really just the sum of the
drh726de592004-06-10 23:35:50 +0000860** random initial value and the page number. We experimented with
861** a checksum of the entire data, but that was found to be too slow.
862**
863** Note that the page number is stored at the beginning of data and
864** the checksum is stored at the end. This is important. If journal
865** corruption occurs due to a power failure, the most likely scenario
866** is that one end or the other of the record will be changed. It is
867** much less likely that the two ends of the journal record will be
868** correct and the middle be corrupt. Thus, this "checksum" scheme,
869** though fast and simple, catches the mostly likely kind of corruption.
870**
871** FIX ME: Consider adding every 200th (or so) byte of the data to the
872** checksum. That way if a single page spans 3 or more disk sectors and
873** only the middle sector is corrupt, we will still have a reasonable
874** chance of failing the checksum and thus detecting the problem.
drh968af522003-02-11 14:55:40 +0000875*/
876static u32 pager_cksum(Pager *pPager, Pgno pgno, const char *aData){
danielk1977ef317ab2004-06-23 10:43:10 +0000877 u32 cksum = pPager->cksumInit;
878 int i = pPager->pageSize-200;
879 while( i>0 ){
880 cksum += aData[i];
881 i -= 200;
882 }
drh968af522003-02-11 14:55:40 +0000883 return cksum;
884}
885
886/*
drhfa86c412002-02-02 15:01:15 +0000887** Read a single page from the journal file opened on file descriptor
888** jfd. Playback this one page.
drh968af522003-02-11 14:55:40 +0000889**
drh726de592004-06-10 23:35:50 +0000890** If useCksum==0 it means this journal does not use checksums. Checksums
891** are not used in statement journals because statement journals do not
892** need to survive power failures.
drhfa86c412002-02-02 15:01:15 +0000893*/
drhae2b40c2004-06-09 19:03:54 +0000894static int pager_playback_one_page(Pager *pPager, OsFile *jfd, int useCksum){
drhfa86c412002-02-02 15:01:15 +0000895 int rc;
drhae2b40c2004-06-09 19:03:54 +0000896 PgHdr *pPg; /* An existing page in the cache */
897 Pgno pgno; /* The page number of a page in journal */
898 u32 cksum; /* Checksum used for sanity checking */
drh90f5ecb2004-07-22 01:19:35 +0000899 u8 aData[SQLITE_MAX_PAGE_SIZE]; /* Temp storage for a page */
drhfa86c412002-02-02 15:01:15 +0000900
drhae2b40c2004-06-09 19:03:54 +0000901 rc = read32bits(jfd, &pgno);
drh99ee3602003-02-16 19:13:36 +0000902 if( rc!=SQLITE_OK ) return rc;
drhae2b40c2004-06-09 19:03:54 +0000903 rc = sqlite3OsRead(jfd, &aData, pPager->pageSize);
drh99ee3602003-02-16 19:13:36 +0000904 if( rc!=SQLITE_OK ) return rc;
danielk197776572402004-06-25 02:38:54 +0000905 pPager->journalOff += pPager->pageSize + 4;
drhfa86c412002-02-02 15:01:15 +0000906
drh968af522003-02-11 14:55:40 +0000907 /* Sanity checking on the page. This is more important that I originally
908 ** thought. If a power failure occurs while the journal is being written,
909 ** it could cause invalid data to be written into the journal. We need to
910 ** detect this invalid data (with high probability) and ignore it.
911 */
danielk197775edc162004-06-26 01:48:18 +0000912 if( pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh968af522003-02-11 14:55:40 +0000913 return SQLITE_DONE;
914 }
drhae2b40c2004-06-09 19:03:54 +0000915 if( pgno>(unsigned)pPager->dbSize ){
drh968af522003-02-11 14:55:40 +0000916 return SQLITE_OK;
917 }
drhae2b40c2004-06-09 19:03:54 +0000918 if( useCksum ){
919 rc = read32bits(jfd, &cksum);
drh99ee3602003-02-16 19:13:36 +0000920 if( rc ) return rc;
danielk197776572402004-06-25 02:38:54 +0000921 pPager->journalOff += 4;
drhae2b40c2004-06-09 19:03:54 +0000922 if( pager_cksum(pPager, pgno, aData)!=cksum ){
drh968af522003-02-11 14:55:40 +0000923 return SQLITE_DONE;
924 }
925 }
drhfa86c412002-02-02 15:01:15 +0000926
danielk1977aa5ccdf2004-06-14 05:10:42 +0000927 assert( pPager->state==PAGER_RESERVED || pPager->state>=PAGER_EXCLUSIVE );
danielk1977a3f3a5f2004-06-10 04:32:16 +0000928
929 /* If the pager is in RESERVED state, then there must be a copy of this
930 ** page in the pager cache. In this case just update the pager cache,
danielk19770de0bb32004-06-10 05:59:24 +0000931 ** not the database file. The page is left marked dirty in this case.
932 **
danielk1977a3f3a5f2004-06-10 04:32:16 +0000933 ** If in EXCLUSIVE state, then we update the pager cache if it exists
934 ** and the main file. The page is then marked not dirty.
drhfa86c412002-02-02 15:01:15 +0000935 */
drhae2b40c2004-06-09 19:03:54 +0000936 pPg = pager_lookup(pPager, pgno);
danielk1977aa5ccdf2004-06-14 05:10:42 +0000937 assert( pPager->state>=PAGER_EXCLUSIVE || pPg );
danielk1977ef73ee92004-11-06 12:26:07 +0000938 TRACE3("PLAYBACK %d page %d\n", PAGERID(pPager), pgno);
danielk1977aa5ccdf2004-06-14 05:10:42 +0000939 if( pPager->state>=PAGER_EXCLUSIVE ){
drheb206252004-10-01 02:00:31 +0000940 sqlite3OsSeek(&pPager->fd, (pgno-1)*(i64)pPager->pageSize);
drh90f5ecb2004-07-22 01:19:35 +0000941 rc = sqlite3OsWrite(&pPager->fd, aData, pPager->pageSize);
danielk1977a3f3a5f2004-06-10 04:32:16 +0000942 }
drhfa86c412002-02-02 15:01:15 +0000943 if( pPg ){
danielk197728129562005-01-11 10:25:06 +0000944 /* No page should ever be explicitly rolled back that is in use, except
945 ** for page 1 which is held in use in order to keep the lock on the
946 ** database active. However such a page may be rolled back as a result
947 ** of an internal error resulting in an automatic call to
948 ** sqlite3pager_rollback().
drhacf4ac92003-12-17 23:57:34 +0000949 */
drhb6f41482004-05-14 01:58:11 +0000950 void *pData;
danielk197728129562005-01-11 10:25:06 +0000951 /* assert( pPg->nRef==0 || pPg->pgno==1 ); */
drhb6f41482004-05-14 01:58:11 +0000952 pData = PGHDR_TO_DATA(pPg);
drhae2b40c2004-06-09 19:03:54 +0000953 memcpy(pData, aData, pPager->pageSize);
drh726de592004-06-10 23:35:50 +0000954 if( pPager->xDestructor ){ /*** FIX ME: Should this be xReinit? ***/
drhb6f41482004-05-14 01:58:11 +0000955 pPager->xDestructor(pData, pPager->pageSize);
drhde647132004-05-07 17:57:49 +0000956 }
danielk1977aa5ccdf2004-06-14 05:10:42 +0000957 if( pPager->state>=PAGER_EXCLUSIVE ){
danielk19770de0bb32004-06-10 05:59:24 +0000958 pPg->dirty = 0;
959 pPg->needSync = 0;
960 }
drhb6f41482004-05-14 01:58:11 +0000961 CODEC(pPager, pData, pPg->pgno, 3);
drhfa86c412002-02-02 15:01:15 +0000962 }
963 return rc;
964}
965
966/*
danielk197713adf8a2004-06-03 16:08:41 +0000967** Parameter zMaster is the name of a master journal file. A single journal
968** file that referred to the master journal file has just been rolled back.
969** This routine checks if it is possible to delete the master journal file,
970** and does so if it is.
drh726de592004-06-10 23:35:50 +0000971**
972** The master journal file contains the names of all child journals.
973** To tell if a master journal can be deleted, check to each of the
974** children. If all children are either missing or do not refer to
975** a different master journal, then this master journal can be deleted.
danielk197713adf8a2004-06-03 16:08:41 +0000976*/
977static int pager_delmaster(const char *zMaster){
978 int rc;
979 int master_open = 0;
980 OsFile master;
981 char *zMasterJournal = 0; /* Contents of master journal file */
drheb206252004-10-01 02:00:31 +0000982 i64 nMasterJournal; /* Size of master journal file */
danielk197713adf8a2004-06-03 16:08:41 +0000983
984 /* Open the master journal file exclusively in case some other process
985 ** is running this routine also. Not that it makes too much difference.
986 */
drhda71ce12004-06-21 18:14:45 +0000987 memset(&master, 0, sizeof(master));
danielk19778191bff2004-06-28 04:52:30 +0000988 rc = sqlite3OsOpenReadOnly(zMaster, &master);
danielk197713adf8a2004-06-03 16:08:41 +0000989 if( rc!=SQLITE_OK ) goto delmaster_out;
990 master_open = 1;
danielk197713adf8a2004-06-03 16:08:41 +0000991 rc = sqlite3OsFileSize(&master, &nMasterJournal);
992 if( rc!=SQLITE_OK ) goto delmaster_out;
993
994 if( nMasterJournal>0 ){
danielk19775865e3d2004-06-14 06:03:57 +0000995 char *zJournal;
danielk197776572402004-06-25 02:38:54 +0000996 char *zMasterPtr = 0;
danielk19775865e3d2004-06-14 06:03:57 +0000997
998 /* Load the entire master journal file into space obtained from
999 ** sqliteMalloc() and pointed to by zMasterJournal.
danielk19775865e3d2004-06-14 06:03:57 +00001000 */
danielk197776572402004-06-25 02:38:54 +00001001 zMasterJournal = (char *)sqliteMalloc(nMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001002 if( !zMasterJournal ){
1003 rc = SQLITE_NOMEM;
1004 goto delmaster_out;
1005 }
1006 rc = sqlite3OsRead(&master, zMasterJournal, nMasterJournal);
1007 if( rc!=SQLITE_OK ) goto delmaster_out;
1008
danielk19775865e3d2004-06-14 06:03:57 +00001009 zJournal = zMasterJournal;
1010 while( (zJournal-zMasterJournal)<nMasterJournal ){
danielk197713adf8a2004-06-03 16:08:41 +00001011 if( sqlite3OsFileExists(zJournal) ){
1012 /* One of the journals pointed to by the master journal exists.
1013 ** Open it and check if it points at the master journal. If
1014 ** so, return without deleting the master journal file.
1015 */
1016 OsFile journal;
drh3b7b78b2004-11-24 01:16:43 +00001017 int c;
danielk197713adf8a2004-06-03 16:08:41 +00001018
drhda71ce12004-06-21 18:14:45 +00001019 memset(&journal, 0, sizeof(journal));
danielk197713adf8a2004-06-03 16:08:41 +00001020 rc = sqlite3OsOpenReadOnly(zJournal, &journal);
1021 if( rc!=SQLITE_OK ){
danielk197713adf8a2004-06-03 16:08:41 +00001022 goto delmaster_out;
1023 }
danielk197713adf8a2004-06-03 16:08:41 +00001024
danielk197776572402004-06-25 02:38:54 +00001025 rc = readMasterJournal(&journal, &zMasterPtr);
1026 sqlite3OsClose(&journal);
danielk19779eed5052004-06-04 10:38:30 +00001027 if( rc!=SQLITE_OK ){
danielk19779eed5052004-06-04 10:38:30 +00001028 goto delmaster_out;
1029 }
danielk197776572402004-06-25 02:38:54 +00001030
drh3b7b78b2004-11-24 01:16:43 +00001031 c = zMasterPtr!=0 && strcmp(zMasterPtr, zMaster)==0;
1032 sqliteFree(zMasterPtr);
1033 if( c ){
danielk197776572402004-06-25 02:38:54 +00001034 /* We have a match. Do not delete the master journal file. */
1035 goto delmaster_out;
danielk197713adf8a2004-06-03 16:08:41 +00001036 }
1037 }
danielk19775865e3d2004-06-14 06:03:57 +00001038 zJournal += (strlen(zJournal)+1);
danielk197713adf8a2004-06-03 16:08:41 +00001039 }
1040 }
1041
1042 sqlite3OsDelete(zMaster);
1043
1044delmaster_out:
1045 if( zMasterJournal ){
1046 sqliteFree(zMasterJournal);
1047 }
1048 if( master_open ){
1049 sqlite3OsClose(&master);
1050 }
1051 return rc;
1052}
1053
1054/*
drha6abd042004-06-09 17:37:22 +00001055** Make every page in the cache agree with what is on disk. In other words,
1056** reread the disk to reset the state of the cache.
1057**
1058** This routine is called after a rollback in which some of the dirty cache
1059** pages had never been written out to disk. We need to roll back the
1060** cache content and the easiest way to do that is to reread the old content
1061** back from the disk.
1062*/
1063static int pager_reload_cache(Pager *pPager){
1064 PgHdr *pPg;
1065 int rc = SQLITE_OK;
1066 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
drh90f5ecb2004-07-22 01:19:35 +00001067 char zBuf[SQLITE_MAX_PAGE_SIZE];
drha6abd042004-06-09 17:37:22 +00001068 if( !pPg->dirty ) continue;
1069 if( (int)pPg->pgno <= pPager->origDbSize ){
drheb206252004-10-01 02:00:31 +00001070 sqlite3OsSeek(&pPager->fd, pPager->pageSize*(i64)(pPg->pgno-1));
drh90f5ecb2004-07-22 01:19:35 +00001071 rc = sqlite3OsRead(&pPager->fd, zBuf, pPager->pageSize);
danielk1977ef73ee92004-11-06 12:26:07 +00001072 TRACE3("REFETCH %d page %d\n", PAGERID(pPager), pPg->pgno);
drha6abd042004-06-09 17:37:22 +00001073 if( rc ) break;
drh25d65432004-07-22 15:02:25 +00001074 CODEC(pPager, zBuf, pPg->pgno, 2);
drha6abd042004-06-09 17:37:22 +00001075 }else{
drh90f5ecb2004-07-22 01:19:35 +00001076 memset(zBuf, 0, pPager->pageSize);
drha6abd042004-06-09 17:37:22 +00001077 }
drh90f5ecb2004-07-22 01:19:35 +00001078 if( pPg->nRef==0 || memcmp(zBuf, PGHDR_TO_DATA(pPg), pPager->pageSize) ){
1079 memcpy(PGHDR_TO_DATA(pPg), zBuf, pPager->pageSize);
drha6abd042004-06-09 17:37:22 +00001080 if( pPager->xReiniter ){
1081 pPager->xReiniter(PGHDR_TO_DATA(pPg), pPager->pageSize);
1082 }else{
drh90f5ecb2004-07-22 01:19:35 +00001083 memset(PGHDR_TO_EXTRA(pPg, pPager), 0, pPager->nExtra);
drha6abd042004-06-09 17:37:22 +00001084 }
1085 }
1086 pPg->needSync = 0;
1087 pPg->dirty = 0;
1088 }
1089 return rc;
1090}
1091
drha6abd042004-06-09 17:37:22 +00001092/*
drhcb4c40b2004-08-18 19:09:43 +00001093** Truncate the main file of the given pager to the number of pages
1094** indicated.
1095*/
1096static int pager_truncate(Pager *pPager, int nPage){
drheb206252004-10-01 02:00:31 +00001097 return sqlite3OsTruncate(&pPager->fd, pPager->pageSize*(i64)nPage);
drhcb4c40b2004-08-18 19:09:43 +00001098}
1099
1100/*
drhed7c8552001-04-11 14:29:21 +00001101** Playback the journal and thus restore the database file to
1102** the state it was in before we started making changes.
1103**
drh34e79ce2004-02-08 06:05:46 +00001104** The journal file format is as follows:
1105**
drhae2b40c2004-06-09 19:03:54 +00001106** (1) 8 byte prefix. A copy of aJournalMagic[].
1107** (2) 4 byte big-endian integer which is the number of valid page records
drh34e79ce2004-02-08 06:05:46 +00001108** in the journal. If this value is 0xffffffff, then compute the
drhae2b40c2004-06-09 19:03:54 +00001109** number of page records from the journal size.
1110** (3) 4 byte big-endian integer which is the initial value for the
1111** sanity checksum.
1112** (4) 4 byte integer which is the number of pages to truncate the
drh34e79ce2004-02-08 06:05:46 +00001113** database to during a rollback.
drhae2b40c2004-06-09 19:03:54 +00001114** (5) 4 byte integer which is the number of bytes in the master journal
1115** name. The value may be zero (indicate that there is no master
1116** journal.)
1117** (6) N bytes of the master journal name. The name will be nul-terminated
1118** and might be shorter than the value read from (5). If the first byte
1119** of the name is \000 then there is no master journal. The master
1120** journal name is stored in UTF-8.
1121** (7) Zero or more pages instances, each as follows:
drh34e79ce2004-02-08 06:05:46 +00001122** + 4 byte page number.
drhae2b40c2004-06-09 19:03:54 +00001123** + pPager->pageSize bytes of data.
1124** + 4 byte checksum
drh34e79ce2004-02-08 06:05:46 +00001125**
drhae2b40c2004-06-09 19:03:54 +00001126** When we speak of the journal header, we mean the first 6 items above.
1127** Each entry in the journal is an instance of the 7th item.
drh34e79ce2004-02-08 06:05:46 +00001128**
1129** Call the value from the second bullet "nRec". nRec is the number of
1130** valid page entries in the journal. In most cases, you can compute the
1131** value of nRec from the size of the journal file. But if a power
1132** failure occurred while the journal was being written, it could be the
1133** case that the size of the journal file had already been increased but
1134** the extra entries had not yet made it safely to disk. In such a case,
1135** the value of nRec computed from the file size would be too large. For
1136** that reason, we always use the nRec value in the header.
1137**
1138** If the nRec value is 0xffffffff it means that nRec should be computed
1139** from the file size. This value is used when the user selects the
1140** no-sync option for the journal. A power failure could lead to corruption
1141** in this case. But for things like temporary table (which will be
1142** deleted when the power is restored) we don't care.
1143**
drhd9b02572001-04-15 00:37:09 +00001144** If the file opened as the journal file is not a well-formed
danielk1977ece80f12004-06-23 01:05:26 +00001145** journal file then all pages up to the first corrupted page are rolled
1146** back (or no pages if the journal header is corrupted). The journal file
1147** is then deleted and SQLITE_OK returned, just as if no corruption had
1148** been encountered.
1149**
1150** If an I/O or malloc() error occurs, the journal-file is not deleted
1151** and an error code is returned.
drhed7c8552001-04-11 14:29:21 +00001152*/
danielk197776572402004-06-25 02:38:54 +00001153static int pager_playback(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001154 i64 szJ; /* Size of the journal file in bytes */
danielk1977c3e8f5e2004-06-28 01:16:46 +00001155 u32 nRec; /* Number of Records in the journal */
drhd9b02572001-04-15 00:37:09 +00001156 int i; /* Loop counter */
1157 Pgno mxPg = 0; /* Size of the original file in pages */
drhae2b40c2004-06-09 19:03:54 +00001158 int rc; /* Result code of a subroutine */
danielk197713adf8a2004-06-03 16:08:41 +00001159 char *zMaster = 0; /* Name of master journal file if any */
drhed7c8552001-04-11 14:29:21 +00001160
drhc3a64ba2001-11-22 00:01:27 +00001161 /* Figure out how many records are in the journal. Abort early if
1162 ** the journal is empty.
drhed7c8552001-04-11 14:29:21 +00001163 */
drh8cfbf082001-09-19 13:22:39 +00001164 assert( pPager->journalOpen );
danielk19774adee202004-05-08 08:23:19 +00001165 rc = sqlite3OsFileSize(&pPager->jfd, &szJ);
drhc3a64ba2001-11-22 00:01:27 +00001166 if( rc!=SQLITE_OK ){
1167 goto end_playback;
1168 }
drh240c5792004-02-08 00:40:52 +00001169
danielk197776572402004-06-25 02:38:54 +00001170 /* Read the master journal name from the journal, if it is present.
1171 ** If a master journal file name is specified, but the file is not
1172 ** present on disk, then the journal is not hot and does not need to be
1173 ** played back.
drh240c5792004-02-08 00:40:52 +00001174 */
danielk197776572402004-06-25 02:38:54 +00001175 rc = readMasterJournal(&pPager->jfd, &zMaster);
1176 assert( rc!=SQLITE_DONE );
1177 if( rc!=SQLITE_OK || (zMaster && !sqlite3OsFileExists(zMaster)) ){
1178 sqliteFree(zMaster);
1179 zMaster = 0;
1180 if( rc==SQLITE_DONE ) rc = SQLITE_OK;
drhc3a64ba2001-11-22 00:01:27 +00001181 goto end_playback;
1182 }
danielk197776572402004-06-25 02:38:54 +00001183 sqlite3OsSeek(&pPager->jfd, 0);
1184 pPager->journalOff = 0;
drhc3a64ba2001-11-22 00:01:27 +00001185
danielk197776572402004-06-25 02:38:54 +00001186 /* This loop terminates either when the readJournalHdr() call returns
1187 ** SQLITE_DONE or an IO error occurs. */
1188 while( 1 ){
drhae2b40c2004-06-09 19:03:54 +00001189
danielk197776572402004-06-25 02:38:54 +00001190 /* Read the next journal header from the journal file. If there are
1191 ** not enough bytes left in the journal file for a complete header, or
1192 ** it is corrupted, then a process must of failed while writing it.
1193 ** This indicates nothing more needs to be rolled back.
1194 */
1195 rc = readJournalHdr(pPager, szJ, &nRec, &mxPg);
1196 if( rc!=SQLITE_OK ){
drh968af522003-02-11 14:55:40 +00001197 if( rc==SQLITE_DONE ){
drh968af522003-02-11 14:55:40 +00001198 rc = SQLITE_OK;
1199 }
danielk197776572402004-06-25 02:38:54 +00001200 goto end_playback;
1201 }
1202
1203 /* If nRec is 0xffffffff, then this journal was created by a process
1204 ** working in no-sync mode. This means that the rest of the journal
1205 ** file consists of pages, there are no more journal headers. Compute
1206 ** the value of nRec based on this assumption.
1207 */
1208 if( nRec==0xffffffff ){
1209 assert( pPager->journalOff==JOURNAL_HDR_SZ(pPager) );
1210 nRec = (szJ - JOURNAL_HDR_SZ(pPager))/JOURNAL_PG_SZ(pPager);
1211 }
1212
1213 /* If this is the first header read from the journal, truncate the
1214 ** database file back to it's original size.
1215 */
1216 if( pPager->journalOff==JOURNAL_HDR_SZ(pPager) ){
1217 assert( pPager->origDbSize==0 || pPager->origDbSize==mxPg );
drhcb4c40b2004-08-18 19:09:43 +00001218 rc = pager_truncate(pPager, mxPg);
danielk197776572402004-06-25 02:38:54 +00001219 if( rc!=SQLITE_OK ){
1220 goto end_playback;
1221 }
1222 pPager->dbSize = mxPg;
1223 }
1224
1225 /* rc = sqlite3OsSeek(&pPager->jfd, JOURNAL_HDR_SZ(pPager)); */
1226 if( rc!=SQLITE_OK ) goto end_playback;
1227
1228 /* Copy original pages out of the journal and back into the database file.
1229 */
1230 for(i=0; i<nRec; i++){
1231 rc = pager_playback_one_page(pPager, &pPager->jfd, 1);
1232 if( rc!=SQLITE_OK ){
1233 if( rc==SQLITE_DONE ){
1234 rc = SQLITE_OK;
1235 pPager->journalOff = szJ;
1236 break;
1237 }else{
1238 goto end_playback;
1239 }
1240 }
drh968af522003-02-11 14:55:40 +00001241 }
drhed7c8552001-04-11 14:29:21 +00001242 }
drh81a20f22001-10-12 17:30:04 +00001243
drh4a0681e2003-02-13 01:58:20 +00001244 /* Pages that have been written to the journal but never synced
1245 ** where not restored by the loop above. We have to restore those
drh240c5792004-02-08 00:40:52 +00001246 ** pages by reading them back from the original database.
drhdb48ee02003-01-16 13:42:43 +00001247 */
danielk197776572402004-06-25 02:38:54 +00001248 assert( rc==SQLITE_OK );
1249 pager_reload_cache(pPager);
drh4a0681e2003-02-13 01:58:20 +00001250
1251end_playback:
danielk19778191bff2004-06-28 04:52:30 +00001252 if( rc==SQLITE_OK ){
1253 rc = pager_unwritelock(pPager);
1254 }
danielk197713adf8a2004-06-03 16:08:41 +00001255 if( zMaster ){
1256 /* If there was a master journal and this routine will return true,
danielk197732554c12005-01-22 03:39:39 +00001257 ** see if it is possible to delete the master journal.
danielk197713adf8a2004-06-03 16:08:41 +00001258 */
1259 if( rc==SQLITE_OK ){
danielk197732554c12005-01-22 03:39:39 +00001260 rc = pager_delmaster(zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001261 }
1262 sqliteFree(zMaster);
1263 }
danielk197776572402004-06-25 02:38:54 +00001264
1265 /* The Pager.sectorSize variable may have been updated while rolling
1266 ** back a journal created by a process with a different PAGER_SECTOR_SIZE
1267 ** value. Reset it to the correct value for this process.
1268 */
1269 pPager->sectorSize = PAGER_SECTOR_SIZE;
drhd9b02572001-04-15 00:37:09 +00001270 return rc;
drhed7c8552001-04-11 14:29:21 +00001271}
1272
1273/*
drhac69b052004-05-12 13:30:07 +00001274** Playback the statement journal.
drhfa86c412002-02-02 15:01:15 +00001275**
1276** This is similar to playing back the transaction journal but with
1277** a few extra twists.
1278**
drh663fc632002-02-02 18:49:19 +00001279** (1) The number of pages in the database file at the start of
drhac69b052004-05-12 13:30:07 +00001280** the statement is stored in pPager->stmtSize, not in the
drh663fc632002-02-02 18:49:19 +00001281** journal file itself.
drhfa86c412002-02-02 15:01:15 +00001282**
drhac69b052004-05-12 13:30:07 +00001283** (2) In addition to playing back the statement journal, also
drhfa86c412002-02-02 15:01:15 +00001284** playback all pages of the transaction journal beginning
drhac69b052004-05-12 13:30:07 +00001285** at offset pPager->stmtJSize.
drhfa86c412002-02-02 15:01:15 +00001286*/
drh3aac2dd2004-04-26 14:10:20 +00001287static int pager_stmt_playback(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001288 i64 szJ; /* Size of the full journal */
1289 i64 hdrOff;
drh968af522003-02-11 14:55:40 +00001290 int nRec; /* Number of Records */
drhfa86c412002-02-02 15:01:15 +00001291 int i; /* Loop counter */
1292 int rc;
1293
danielk197776572402004-06-25 02:38:54 +00001294 szJ = pPager->journalOff;
1295#ifndef NDEBUG
1296 {
drheb206252004-10-01 02:00:31 +00001297 i64 os_szJ;
danielk197776572402004-06-25 02:38:54 +00001298 rc = sqlite3OsFileSize(&pPager->jfd, &os_szJ);
1299 if( rc!=SQLITE_OK ) return rc;
1300 assert( szJ==os_szJ );
1301 }
1302#endif
1303
1304 /* Set hdrOff to be the offset to the first journal header written
1305 ** this statement transaction, or the end of the file if no journal
1306 ** header was written.
1307 */
1308 hdrOff = pPager->stmtHdrOff;
1309 assert( pPager->fullSync || !hdrOff );
1310 if( !hdrOff ){
1311 hdrOff = szJ;
1312 }
1313
1314
drhfa86c412002-02-02 15:01:15 +00001315 /* Truncate the database back to its original size.
1316 */
drhcb4c40b2004-08-18 19:09:43 +00001317 rc = pager_truncate(pPager, pPager->stmtSize);
drhac69b052004-05-12 13:30:07 +00001318 pPager->dbSize = pPager->stmtSize;
drhfa86c412002-02-02 15:01:15 +00001319
drhac69b052004-05-12 13:30:07 +00001320 /* Figure out how many records are in the statement journal.
drhfa86c412002-02-02 15:01:15 +00001321 */
drhac69b052004-05-12 13:30:07 +00001322 assert( pPager->stmtInUse && pPager->journalOpen );
1323 sqlite3OsSeek(&pPager->stfd, 0);
1324 nRec = pPager->stmtNRec;
drhfa86c412002-02-02 15:01:15 +00001325
drhac69b052004-05-12 13:30:07 +00001326 /* Copy original pages out of the statement journal and back into the
drhae2b40c2004-06-09 19:03:54 +00001327 ** database file. Note that the statement journal omits checksums from
1328 ** each record since power-failure recovery is not important to statement
1329 ** journals.
drhfa86c412002-02-02 15:01:15 +00001330 */
1331 for(i=nRec-1; i>=0; i--){
drhae2b40c2004-06-09 19:03:54 +00001332 rc = pager_playback_one_page(pPager, &pPager->stfd, 0);
drh968af522003-02-11 14:55:40 +00001333 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001334 if( rc!=SQLITE_OK ) goto end_stmt_playback;
drhfa86c412002-02-02 15:01:15 +00001335 }
1336
danielk197776572402004-06-25 02:38:54 +00001337 /* Now roll some pages back from the transaction journal. Pager.stmtJSize
1338 ** was the size of the journal file when this statement was started, so
1339 ** everything after that needs to be rolled back, either into the
1340 ** database, the memory cache, or both.
1341 **
1342 ** If it is not zero, then Pager.stmtHdrOff is the offset to the start
1343 ** of the first journal header written during this statement transaction.
drhfa86c412002-02-02 15:01:15 +00001344 */
drhac69b052004-05-12 13:30:07 +00001345 rc = sqlite3OsSeek(&pPager->jfd, pPager->stmtJSize);
drhfa86c412002-02-02 15:01:15 +00001346 if( rc!=SQLITE_OK ){
drh3aac2dd2004-04-26 14:10:20 +00001347 goto end_stmt_playback;
drhfa86c412002-02-02 15:01:15 +00001348 }
danielk197776572402004-06-25 02:38:54 +00001349 pPager->journalOff = pPager->stmtJSize;
danielk197775edc162004-06-26 01:48:18 +00001350 pPager->cksumInit = pPager->stmtCksum;
1351 assert( JOURNAL_HDR_SZ(pPager)<(pPager->pageSize+8) );
1352 while( pPager->journalOff <= (hdrOff-(pPager->pageSize+8)) ){
drhae2b40c2004-06-09 19:03:54 +00001353 rc = pager_playback_one_page(pPager, &pPager->jfd, 1);
danielk197776572402004-06-25 02:38:54 +00001354 assert( rc!=SQLITE_DONE );
1355 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1356 }
1357
1358 while( pPager->journalOff < szJ ){
1359 u32 nRec;
1360 u32 dummy;
1361 rc = readJournalHdr(pPager, szJ, &nRec, &dummy);
drh968af522003-02-11 14:55:40 +00001362 if( rc!=SQLITE_OK ){
1363 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001364 goto end_stmt_playback;
drh968af522003-02-11 14:55:40 +00001365 }
danielk197775edc162004-06-26 01:48:18 +00001366 if( nRec==0 ){
1367 nRec = (szJ - pPager->journalOff) / (pPager->pageSize+8);
1368 }
danielk197776572402004-06-25 02:38:54 +00001369 for(i=nRec-1; i>=0 && pPager->journalOff < szJ; i--){
1370 rc = pager_playback_one_page(pPager, &pPager->jfd, 1);
1371 assert( rc!=SQLITE_DONE );
1372 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1373 }
drhfa86c412002-02-02 15:01:15 +00001374 }
danielk197776572402004-06-25 02:38:54 +00001375
1376 pPager->journalOff = szJ;
drhfa86c412002-02-02 15:01:15 +00001377
drh3aac2dd2004-04-26 14:10:20 +00001378end_stmt_playback:
drhfa86c412002-02-02 15:01:15 +00001379 if( rc!=SQLITE_OK ){
drhfa86c412002-02-02 15:01:15 +00001380 pPager->errMask |= PAGER_ERR_CORRUPT;
drhee696e22004-08-30 16:52:17 +00001381 rc = SQLITE_CORRUPT; /* bkpt-CORRUPT */
danielk197775edc162004-06-26 01:48:18 +00001382 }else{
1383 pPager->journalOff = szJ;
1384 /* pager_reload_cache(pPager); */
drhfa86c412002-02-02 15:01:15 +00001385 }
1386 return rc;
1387}
1388
1389/*
drhf57b14a2001-09-14 18:54:08 +00001390** Change the maximum number of in-memory pages that are allowed.
drhcd61c282002-03-06 22:01:34 +00001391**
1392** The maximum number is the absolute value of the mxPage parameter.
1393** If mxPage is negative, the noSync flag is also set. noSync bypasses
danielk19774adee202004-05-08 08:23:19 +00001394** calls to sqlite3OsSync(). The pager runs much faster with noSync on,
drhcd61c282002-03-06 22:01:34 +00001395** but if the operating system crashes or there is an abrupt power
1396** failure, the database file might be left in an inconsistent and
1397** unrepairable state.
drhf57b14a2001-09-14 18:54:08 +00001398*/
drh3aac2dd2004-04-26 14:10:20 +00001399void sqlite3pager_set_cachesize(Pager *pPager, int mxPage){
drh603240c2002-03-05 01:11:12 +00001400 if( mxPage>=0 ){
drha1680452002-04-18 01:56:57 +00001401 pPager->noSync = pPager->tempFile;
danielk19771d850a72004-05-31 08:26:49 +00001402 if( pPager->noSync ) pPager->needSync = 0;
drh603240c2002-03-05 01:11:12 +00001403 }else{
1404 pPager->noSync = 1;
1405 mxPage = -mxPage;
1406 }
drhf57b14a2001-09-14 18:54:08 +00001407 if( mxPage>10 ){
1408 pPager->mxPage = mxPage;
danielk1977ef317ab2004-06-23 10:43:10 +00001409 }else{
1410 pPager->mxPage = 10;
drhf57b14a2001-09-14 18:54:08 +00001411 }
1412}
1413
1414/*
drh973b6e32003-02-12 14:09:42 +00001415** Adjust the robustness of the database to damage due to OS crashes
1416** or power failures by changing the number of syncs()s when writing
1417** the rollback journal. There are three levels:
1418**
danielk19774adee202004-05-08 08:23:19 +00001419** OFF sqlite3OsSync() is never called. This is the default
drh973b6e32003-02-12 14:09:42 +00001420** for temporary and transient files.
1421**
1422** NORMAL The journal is synced once before writes begin on the
1423** database. This is normally adequate protection, but
1424** it is theoretically possible, though very unlikely,
1425** that an inopertune power failure could leave the journal
1426** in a state which would cause damage to the database
1427** when it is rolled back.
1428**
1429** FULL The journal is synced twice before writes begin on the
drh34e79ce2004-02-08 06:05:46 +00001430** database (with some additional information - the nRec field
1431** of the journal header - being written in between the two
1432** syncs). If we assume that writing a
drh973b6e32003-02-12 14:09:42 +00001433** single disk sector is atomic, then this mode provides
1434** assurance that the journal will not be corrupted to the
1435** point of causing damage to the database during rollback.
1436**
1437** Numeric values associated with these states are OFF==1, NORMAL=2,
1438** and FULL=3.
1439*/
danielk197793758c82005-01-21 08:13:14 +00001440#ifndef SQLITE_OMIT_PAGER_PRAGMAS
drh3aac2dd2004-04-26 14:10:20 +00001441void sqlite3pager_set_safety_level(Pager *pPager, int level){
drh973b6e32003-02-12 14:09:42 +00001442 pPager->noSync = level==1 || pPager->tempFile;
1443 pPager->fullSync = level==3 && !pPager->tempFile;
danielk19771d850a72004-05-31 08:26:49 +00001444 if( pPager->noSync ) pPager->needSync = 0;
drh973b6e32003-02-12 14:09:42 +00001445}
danielk197793758c82005-01-21 08:13:14 +00001446#endif
drh973b6e32003-02-12 14:09:42 +00001447
1448/*
drhfa86c412002-02-02 15:01:15 +00001449** Open a temporary file. Write the name of the file into zName
1450** (zName must be at least SQLITE_TEMPNAME_SIZE bytes long.) Write
1451** the file descriptor into *fd. Return SQLITE_OK on success or some
1452** other error code if we fail.
1453**
1454** The OS will automatically delete the temporary file when it is
1455** closed.
1456*/
drh3aac2dd2004-04-26 14:10:20 +00001457static int sqlite3pager_opentemp(char *zFile, OsFile *fd){
drhfa86c412002-02-02 15:01:15 +00001458 int cnt = 8;
1459 int rc;
1460 do{
1461 cnt--;
danielk19774adee202004-05-08 08:23:19 +00001462 sqlite3OsTempFileName(zFile);
1463 rc = sqlite3OsOpenExclusive(zFile, fd, 1);
danielk197713073932004-06-30 11:54:06 +00001464 }while( cnt>0 && rc!=SQLITE_OK && rc!=SQLITE_NOMEM );
drhfa86c412002-02-02 15:01:15 +00001465 return rc;
1466}
1467
1468/*
drhed7c8552001-04-11 14:29:21 +00001469** Create a new page cache and put a pointer to the page cache in *ppPager.
drh5e00f6c2001-09-13 13:46:56 +00001470** The file to be cached need not exist. The file is not locked until
drh3aac2dd2004-04-26 14:10:20 +00001471** the first call to sqlite3pager_get() and is only held open until the
1472** last page is released using sqlite3pager_unref().
drh382c0242001-10-06 16:33:02 +00001473**
drh6446c4d2001-12-15 14:22:18 +00001474** If zFilename is NULL then a randomly-named temporary file is created
1475** and used as the file to be cached. The file will be deleted
1476** automatically when it is closed.
drh90f5ecb2004-07-22 01:19:35 +00001477**
1478** If zFilename is ":memory:" then all information is held in cache.
1479** It is never written to disk. This can be used to implement an
1480** in-memory database.
drhed7c8552001-04-11 14:29:21 +00001481*/
drh3aac2dd2004-04-26 14:10:20 +00001482int sqlite3pager_open(
drh7e3b0a02001-04-28 16:52:40 +00001483 Pager **ppPager, /* Return the Pager structure here */
1484 const char *zFilename, /* Name of the database file to open */
drhda47d772002-12-02 04:25:19 +00001485 int nExtra, /* Extra bytes append to each in-memory page */
drh90f5ecb2004-07-22 01:19:35 +00001486 int useJournal /* TRUE to use a rollback journal on this file */
drh7e3b0a02001-04-28 16:52:40 +00001487){
drhed7c8552001-04-11 14:29:21 +00001488 Pager *pPager;
danielk19778def5ea2004-06-16 10:39:52 +00001489 char *zFullPathname = 0;
drhed7c8552001-04-11 14:29:21 +00001490 int nameLen;
drh8cfbf082001-09-19 13:22:39 +00001491 OsFile fd;
danielk1977cfe9a692004-06-16 12:00:29 +00001492 int rc = SQLITE_OK;
1493 int i;
danielk19778def5ea2004-06-16 10:39:52 +00001494 int tempFile = 0;
drhac69b052004-05-12 13:30:07 +00001495 int memDb = 0;
drh5e00f6c2001-09-13 13:46:56 +00001496 int readOnly = 0;
drh8cfbf082001-09-19 13:22:39 +00001497 char zTemp[SQLITE_TEMPNAME_SIZE];
drhed7c8552001-04-11 14:29:21 +00001498
drhd9b02572001-04-15 00:37:09 +00001499 *ppPager = 0;
drhda71ce12004-06-21 18:14:45 +00001500 memset(&fd, 0, sizeof(fd));
danielk19776f8a5032004-05-10 10:34:51 +00001501 if( sqlite3_malloc_failed ){
drhd9b02572001-04-15 00:37:09 +00001502 return SQLITE_NOMEM;
1503 }
drh901afd42003-08-26 11:25:58 +00001504 if( zFilename && zFilename[0] ){
drhb7f91642004-10-31 02:22:47 +00001505#ifndef SQLITE_OMIT_MEMORYDB
drhac69b052004-05-12 13:30:07 +00001506 if( strcmp(zFilename,":memory:")==0 ){
1507 memDb = 1;
drhda71ce12004-06-21 18:14:45 +00001508 zFullPathname = sqliteStrDup("");
drhac69b052004-05-12 13:30:07 +00001509 rc = SQLITE_OK;
drhb7f91642004-10-31 02:22:47 +00001510 }else
1511#endif
1512 {
drhac69b052004-05-12 13:30:07 +00001513 zFullPathname = sqlite3OsFullPathname(zFilename);
danielk19778def5ea2004-06-16 10:39:52 +00001514 if( zFullPathname ){
1515 rc = sqlite3OsOpenReadWrite(zFullPathname, &fd, &readOnly);
1516 }
drhac69b052004-05-12 13:30:07 +00001517 }
drh5e00f6c2001-09-13 13:46:56 +00001518 }else{
drh3aac2dd2004-04-26 14:10:20 +00001519 rc = sqlite3pager_opentemp(zTemp, &fd);
drh5e00f6c2001-09-13 13:46:56 +00001520 zFilename = zTemp;
danielk19774adee202004-05-08 08:23:19 +00001521 zFullPathname = sqlite3OsFullPathname(zFilename);
danielk19778def5ea2004-06-16 10:39:52 +00001522 if( rc==SQLITE_OK ){
1523 tempFile = 1;
1524 }
drh5e00f6c2001-09-13 13:46:56 +00001525 }
danielk19778def5ea2004-06-16 10:39:52 +00001526 if( !zFullPathname ){
danielk1977b5548a82004-06-26 13:51:33 +00001527 sqlite3OsClose(&fd);
drh3e7a6092002-12-07 21:45:14 +00001528 return SQLITE_NOMEM;
1529 }
drh8cfbf082001-09-19 13:22:39 +00001530 if( rc!=SQLITE_OK ){
drhda71ce12004-06-21 18:14:45 +00001531 sqlite3OsClose(&fd);
1532 sqliteFree(zFullPathname);
danielk19778def5ea2004-06-16 10:39:52 +00001533 return rc;
drhed7c8552001-04-11 14:29:21 +00001534 }
drh3e7a6092002-12-07 21:45:14 +00001535 nameLen = strlen(zFullPathname);
drha76c82e2003-07-27 18:59:42 +00001536 pPager = sqliteMalloc( sizeof(*pPager) + nameLen*3 + 30 );
drhd9b02572001-04-15 00:37:09 +00001537 if( pPager==0 ){
drhda71ce12004-06-21 18:14:45 +00001538 sqlite3OsClose(&fd);
1539 sqliteFree(zFullPathname);
drhd9b02572001-04-15 00:37:09 +00001540 return SQLITE_NOMEM;
1541 }
danielk1977ef73ee92004-11-06 12:26:07 +00001542 TRACE3("OPEN %d %s\n", FILEHANDLEID(fd), zFullPathname);
drhed7c8552001-04-11 14:29:21 +00001543 pPager->zFilename = (char*)&pPager[1];
drha76c82e2003-07-27 18:59:42 +00001544 pPager->zDirectory = &pPager->zFilename[nameLen+1];
1545 pPager->zJournal = &pPager->zDirectory[nameLen+1];
drh3e7a6092002-12-07 21:45:14 +00001546 strcpy(pPager->zFilename, zFullPathname);
drha76c82e2003-07-27 18:59:42 +00001547 strcpy(pPager->zDirectory, zFullPathname);
1548 for(i=nameLen; i>0 && pPager->zDirectory[i-1]!='/'; i--){}
1549 if( i>0 ) pPager->zDirectory[i-1] = 0;
drh3e7a6092002-12-07 21:45:14 +00001550 strcpy(pPager->zJournal, zFullPathname);
1551 sqliteFree(zFullPathname);
drhed7c8552001-04-11 14:29:21 +00001552 strcpy(&pPager->zJournal[nameLen], "-journal");
1553 pPager->fd = fd;
drh6d08b4d2004-07-20 12:45:22 +00001554#if OS_UNIX
drhd5b447d2004-07-19 22:08:09 +00001555 pPager->fd.pPager = pPager;
drh6d08b4d2004-07-20 12:45:22 +00001556#endif
drh8cfbf082001-09-19 13:22:39 +00001557 pPager->journalOpen = 0;
drhac69b052004-05-12 13:30:07 +00001558 pPager->useJournal = useJournal && !memDb;
1559 pPager->stmtOpen = 0;
1560 pPager->stmtInUse = 0;
drhed7c8552001-04-11 14:29:21 +00001561 pPager->nRef = 0;
drhac69b052004-05-12 13:30:07 +00001562 pPager->dbSize = memDb-1;
drh90f5ecb2004-07-22 01:19:35 +00001563 pPager->pageSize = SQLITE_DEFAULT_PAGE_SIZE;
drh887dc4c2004-10-22 16:22:57 +00001564 pPager->psAligned = FORCE_ALIGNMENT(pPager->pageSize);
drhac69b052004-05-12 13:30:07 +00001565 pPager->stmtSize = 0;
1566 pPager->stmtJSize = 0;
drhed7c8552001-04-11 14:29:21 +00001567 pPager->nPage = 0;
drh90f5ecb2004-07-22 01:19:35 +00001568 pPager->mxPage = 100;
drha6abd042004-06-09 17:37:22 +00001569 pPager->state = PAGER_UNLOCK;
drhd9b02572001-04-15 00:37:09 +00001570 pPager->errMask = 0;
drh5e00f6c2001-09-13 13:46:56 +00001571 pPager->tempFile = tempFile;
drhac69b052004-05-12 13:30:07 +00001572 pPager->memDb = memDb;
drh5e00f6c2001-09-13 13:46:56 +00001573 pPager->readOnly = readOnly;
drhf57b14a2001-09-14 18:54:08 +00001574 pPager->needSync = 0;
drhda47d772002-12-02 04:25:19 +00001575 pPager->noSync = pPager->tempFile || !useJournal;
danielk197775edc162004-06-26 01:48:18 +00001576 pPager->fullSync = (pPager->noSync?0:1);
drhed7c8552001-04-11 14:29:21 +00001577 pPager->pFirst = 0;
drh341eae82003-01-21 02:39:36 +00001578 pPager->pFirstSynced = 0;
drhed7c8552001-04-11 14:29:21 +00001579 pPager->pLast = 0;
drh887dc4c2004-10-22 16:22:57 +00001580 pPager->nExtra = FORCE_ALIGNMENT(nExtra);
danielk197776572402004-06-25 02:38:54 +00001581 pPager->sectorSize = PAGER_SECTOR_SIZE;
drh90f5ecb2004-07-22 01:19:35 +00001582 pPager->pBusyHandler = 0;
drhed7c8552001-04-11 14:29:21 +00001583 memset(pPager->aHash, 0, sizeof(pPager->aHash));
1584 *ppPager = pPager;
1585 return SQLITE_OK;
1586}
1587
1588/*
drh90f5ecb2004-07-22 01:19:35 +00001589** Set the busy handler function.
1590*/
1591void sqlite3pager_set_busyhandler(Pager *pPager, BusyHandler *pBusyHandler){
1592 pPager->pBusyHandler = pBusyHandler;
1593}
1594
1595/*
drh72f82862001-05-24 21:06:34 +00001596** Set the destructor for this pager. If not NULL, the destructor is called
drh5e00f6c2001-09-13 13:46:56 +00001597** when the reference count on each page reaches zero. The destructor can
1598** be used to clean up information in the extra segment appended to each page.
drh72f82862001-05-24 21:06:34 +00001599**
drh3aac2dd2004-04-26 14:10:20 +00001600** The destructor is not called as a result sqlite3pager_close().
1601** Destructors are only called by sqlite3pager_unref().
drh72f82862001-05-24 21:06:34 +00001602*/
drhb6f41482004-05-14 01:58:11 +00001603void sqlite3pager_set_destructor(Pager *pPager, void (*xDesc)(void*,int)){
drh72f82862001-05-24 21:06:34 +00001604 pPager->xDestructor = xDesc;
1605}
1606
1607/*
drha6abd042004-06-09 17:37:22 +00001608** Set the reinitializer for this pager. If not NULL, the reinitializer
1609** is called when the content of a page in cache is restored to its original
1610** value as a result of a rollback. The callback gives higher-level code
1611** an opportunity to restore the EXTRA section to agree with the restored
1612** page data.
1613*/
1614void sqlite3pager_set_reiniter(Pager *pPager, void (*xReinit)(void*,int)){
1615 pPager->xReiniter = xReinit;
1616}
1617
1618/*
drh90f5ecb2004-07-22 01:19:35 +00001619** Set the page size.
1620**
1621** The page size must only be changed when the cache is empty.
1622*/
1623void sqlite3pager_set_pagesize(Pager *pPager, int pageSize){
1624 assert( pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE );
1625 pPager->pageSize = pageSize;
drh887dc4c2004-10-22 16:22:57 +00001626 pPager->psAligned = FORCE_ALIGNMENT(pageSize);
drh90f5ecb2004-07-22 01:19:35 +00001627}
1628
1629/*
1630** Read the first N bytes from the beginning of the file into memory
1631** that pDest points to. No error checking is done.
1632*/
1633void sqlite3pager_read_fileheader(Pager *pPager, int N, unsigned char *pDest){
1634 memset(pDest, 0, N);
drhb7f91642004-10-31 02:22:47 +00001635 if( MEMDB==0 ){
drh90f5ecb2004-07-22 01:19:35 +00001636 sqlite3OsSeek(&pPager->fd, 0);
1637 sqlite3OsRead(&pPager->fd, pDest, N);
1638 }
1639}
1640
1641/*
drh5e00f6c2001-09-13 13:46:56 +00001642** Return the total number of pages in the disk file associated with
1643** pPager.
drhed7c8552001-04-11 14:29:21 +00001644*/
drh3aac2dd2004-04-26 14:10:20 +00001645int sqlite3pager_pagecount(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001646 i64 n;
drhd9b02572001-04-15 00:37:09 +00001647 assert( pPager!=0 );
drhed7c8552001-04-11 14:29:21 +00001648 if( pPager->dbSize>=0 ){
1649 return pPager->dbSize;
1650 }
danielk19774adee202004-05-08 08:23:19 +00001651 if( sqlite3OsFileSize(&pPager->fd, &n)!=SQLITE_OK ){
drh81a20f22001-10-12 17:30:04 +00001652 pPager->errMask |= PAGER_ERR_DISK;
drh8cfbf082001-09-19 13:22:39 +00001653 return 0;
drhed7c8552001-04-11 14:29:21 +00001654 }
drh90f5ecb2004-07-22 01:19:35 +00001655 n /= pPager->pageSize;
drhb7f91642004-10-31 02:22:47 +00001656 if( !MEMDB && n==PENDING_BYTE/pPager->pageSize ){
drh1f595712004-06-15 01:40:29 +00001657 n++;
1658 }
drha6abd042004-06-09 17:37:22 +00001659 if( pPager->state!=PAGER_UNLOCK ){
drhed7c8552001-04-11 14:29:21 +00001660 pPager->dbSize = n;
1661 }
1662 return n;
1663}
1664
1665/*
drhf7c57532003-04-25 13:22:51 +00001666** Forward declaration
1667*/
danielk197776572402004-06-25 02:38:54 +00001668static int syncJournal(Pager*);
drhf7c57532003-04-25 13:22:51 +00001669
drhac69b052004-05-12 13:30:07 +00001670
1671/*
danielk1977f5fdda82004-11-03 08:44:05 +00001672** Unlink pPg from it's hash chain. Also set the page number to 0 to indicate
1673** that the page is not part of any hash chain. This is required because the
1674** sqlite3pager_movepage() routine can leave a page in the
1675** pNextFree/pPrevFree list that is not a part of any hash-chain.
1676*/
1677static void unlinkHashChain(Pager *pPager, PgHdr *pPg){
1678 if( pPg->pgno==0 ){
1679 /* If the page number is zero, then this page is not in any hash chain. */
1680 return;
1681 }
1682 if( pPg->pNextHash ){
1683 pPg->pNextHash->pPrevHash = pPg->pPrevHash;
1684 }
1685 if( pPg->pPrevHash ){
1686 assert( pPager->aHash[pager_hash(pPg->pgno)]!=pPg );
1687 pPg->pPrevHash->pNextHash = pPg->pNextHash;
1688 }else{
1689 int h = pager_hash(pPg->pgno);
1690 assert( pPager->aHash[h]==pPg );
1691 pPager->aHash[h] = pPg->pNextHash;
1692 }
1693
1694 pPg->pgno = 0;
1695 pPg->pNextHash = pPg->pPrevHash = 0;
1696}
1697
1698/*
drhac69b052004-05-12 13:30:07 +00001699** Unlink a page from the free list (the list of all pages where nRef==0)
1700** and from its hash collision chain.
1701*/
1702static void unlinkPage(PgHdr *pPg){
1703 Pager *pPager = pPg->pPager;
1704
1705 /* Keep the pFirstSynced pointer pointing at the first synchronized page */
1706 if( pPg==pPager->pFirstSynced ){
1707 PgHdr *p = pPg->pNextFree;
1708 while( p && p->needSync ){ p = p->pNextFree; }
1709 pPager->pFirstSynced = p;
1710 }
1711
1712 /* Unlink from the freelist */
1713 if( pPg->pPrevFree ){
1714 pPg->pPrevFree->pNextFree = pPg->pNextFree;
1715 }else{
1716 assert( pPager->pFirst==pPg );
1717 pPager->pFirst = pPg->pNextFree;
1718 }
1719 if( pPg->pNextFree ){
1720 pPg->pNextFree->pPrevFree = pPg->pPrevFree;
1721 }else{
1722 assert( pPager->pLast==pPg );
1723 pPager->pLast = pPg->pPrevFree;
1724 }
1725 pPg->pNextFree = pPg->pPrevFree = 0;
1726
1727 /* Unlink from the pgno hash table */
danielk1977f5fdda82004-11-03 08:44:05 +00001728 unlinkHashChain(pPager, pPg);
drhac69b052004-05-12 13:30:07 +00001729}
1730
danielk1977b84f96f2005-01-20 11:32:23 +00001731#ifndef SQLITE_OMIT_MEMORYDB
drhac69b052004-05-12 13:30:07 +00001732/*
1733** This routine is used to truncate an in-memory database. Delete
danielk1977369f27e2004-06-15 11:40:04 +00001734** all pages whose pgno is larger than pPager->dbSize and is unreferenced.
drhac69b052004-05-12 13:30:07 +00001735** Referenced pages larger than pPager->dbSize are zeroed.
1736*/
1737static void memoryTruncate(Pager *pPager){
1738 PgHdr *pPg;
1739 PgHdr **ppPg;
1740 int dbSize = pPager->dbSize;
1741
1742 ppPg = &pPager->pAll;
1743 while( (pPg = *ppPg)!=0 ){
1744 if( pPg->pgno<=dbSize ){
1745 ppPg = &pPg->pNextAll;
1746 }else if( pPg->nRef>0 ){
1747 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
1748 ppPg = &pPg->pNextAll;
1749 }else{
1750 *ppPg = pPg->pNextAll;
1751 unlinkPage(pPg);
1752 sqliteFree(pPg);
1753 pPager->nPage--;
1754 }
1755 }
1756}
danielk1977b84f96f2005-01-20 11:32:23 +00001757#else
1758#define memoryTruncate(p)
1759#endif
drhac69b052004-05-12 13:30:07 +00001760
drhf7c57532003-04-25 13:22:51 +00001761/*
1762** Truncate the file to the number of pages specified.
1763*/
drh3aac2dd2004-04-26 14:10:20 +00001764int sqlite3pager_truncate(Pager *pPager, Pgno nPage){
drhf7c57532003-04-25 13:22:51 +00001765 int rc;
drhdc3ff9c2004-08-18 02:10:15 +00001766 sqlite3pager_pagecount(pPager);
drh2e6d11b2003-04-25 15:37:57 +00001767 if( pPager->errMask!=0 ){
1768 rc = pager_errcode(pPager);
1769 return rc;
1770 }
drh7d02cb72003-06-04 16:24:39 +00001771 if( nPage>=(unsigned)pPager->dbSize ){
drhf7c57532003-04-25 13:22:51 +00001772 return SQLITE_OK;
1773 }
drhb7f91642004-10-31 02:22:47 +00001774 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00001775 pPager->dbSize = nPage;
1776 memoryTruncate(pPager);
1777 return SQLITE_OK;
1778 }
danielk197776572402004-06-25 02:38:54 +00001779 rc = syncJournal(pPager);
danielk1977369f27e2004-06-15 11:40:04 +00001780 if( rc!=SQLITE_OK ){
1781 return rc;
1782 }
drhcb4c40b2004-08-18 19:09:43 +00001783 rc = pager_truncate(pPager, nPage);
drhf7c57532003-04-25 13:22:51 +00001784 if( rc==SQLITE_OK ){
1785 pPager->dbSize = nPage;
1786 }
1787 return rc;
1788}
1789
1790/*
drhed7c8552001-04-11 14:29:21 +00001791** Shutdown the page cache. Free all memory and close all files.
1792**
1793** If a transaction was in progress when this routine is called, that
1794** transaction is rolled back. All outstanding pages are invalidated
1795** and their memory is freed. Any attempt to use a page associated
1796** with this page cache after this function returns will likely
1797** result in a coredump.
1798*/
drh3aac2dd2004-04-26 14:10:20 +00001799int sqlite3pager_close(Pager *pPager){
drhd9b02572001-04-15 00:37:09 +00001800 PgHdr *pPg, *pNext;
drhed7c8552001-04-11 14:29:21 +00001801 switch( pPager->state ){
drha6abd042004-06-09 17:37:22 +00001802 case PAGER_RESERVED:
danielk1977aa5ccdf2004-06-14 05:10:42 +00001803 case PAGER_SYNCED:
drha6abd042004-06-09 17:37:22 +00001804 case PAGER_EXCLUSIVE: {
drh3aac2dd2004-04-26 14:10:20 +00001805 sqlite3pager_rollback(pPager);
drhb7f91642004-10-31 02:22:47 +00001806 if( !MEMDB ){
drha6abd042004-06-09 17:37:22 +00001807 sqlite3OsUnlock(&pPager->fd, NO_LOCK);
drhac69b052004-05-12 13:30:07 +00001808 }
drh8cfbf082001-09-19 13:22:39 +00001809 assert( pPager->journalOpen==0 );
drhed7c8552001-04-11 14:29:21 +00001810 break;
1811 }
drha6abd042004-06-09 17:37:22 +00001812 case PAGER_SHARED: {
drhb7f91642004-10-31 02:22:47 +00001813 if( !MEMDB ){
drha6abd042004-06-09 17:37:22 +00001814 sqlite3OsUnlock(&pPager->fd, NO_LOCK);
drhac69b052004-05-12 13:30:07 +00001815 }
drhed7c8552001-04-11 14:29:21 +00001816 break;
1817 }
1818 default: {
1819 /* Do nothing */
1820 break;
1821 }
1822 }
drhd9b02572001-04-15 00:37:09 +00001823 for(pPg=pPager->pAll; pPg; pPg=pNext){
danielk1977eac7a362004-06-16 07:45:24 +00001824#ifndef NDEBUG
drhb7f91642004-10-31 02:22:47 +00001825 if( MEMDB ){
danielk1977eac7a362004-06-16 07:45:24 +00001826 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
1827 assert( !pPg->alwaysRollback );
1828 assert( !pHist->pOrig );
1829 assert( !pHist->pStmt );
1830 }
1831#endif
drhd9b02572001-04-15 00:37:09 +00001832 pNext = pPg->pNextAll;
1833 sqliteFree(pPg);
drhed7c8552001-04-11 14:29:21 +00001834 }
danielk1977ef73ee92004-11-06 12:26:07 +00001835 TRACE2("CLOSE %d\n", PAGERID(pPager));
drhda71ce12004-06-21 18:14:45 +00001836 sqlite3OsClose(&pPager->fd);
drh8cfbf082001-09-19 13:22:39 +00001837 assert( pPager->journalOpen==0 );
drh0f892532002-05-30 12:27:03 +00001838 /* Temp files are automatically deleted by the OS
1839 ** if( pPager->tempFile ){
danielk19774adee202004-05-08 08:23:19 +00001840 ** sqlite3OsDelete(pPager->zFilename);
drh0f892532002-05-30 12:27:03 +00001841 ** }
1842 */
danielk1977aca790a2005-01-13 11:07:52 +00001843
drhed7c8552001-04-11 14:29:21 +00001844 sqliteFree(pPager);
1845 return SQLITE_OK;
1846}
1847
1848/*
drh5e00f6c2001-09-13 13:46:56 +00001849** Return the page number for the given page data.
drhed7c8552001-04-11 14:29:21 +00001850*/
drh3aac2dd2004-04-26 14:10:20 +00001851Pgno sqlite3pager_pagenumber(void *pData){
drhed7c8552001-04-11 14:29:21 +00001852 PgHdr *p = DATA_TO_PGHDR(pData);
1853 return p->pgno;
1854}
1855
1856/*
drhc8629a12004-05-08 20:07:40 +00001857** The page_ref() function increments the reference count for a page.
1858** If the page is currently on the freelist (the reference count is zero) then
drh7e3b0a02001-04-28 16:52:40 +00001859** remove it from the freelist.
drhc8629a12004-05-08 20:07:40 +00001860**
1861** For non-test systems, page_ref() is a macro that calls _page_ref()
1862** online of the reference count is zero. For test systems, page_ref()
1863** is a real function so that we can set breakpoints and trace it.
drh7e3b0a02001-04-28 16:52:40 +00001864*/
drh836faa42003-01-11 13:30:57 +00001865static void _page_ref(PgHdr *pPg){
drh7e3b0a02001-04-28 16:52:40 +00001866 if( pPg->nRef==0 ){
1867 /* The page is currently on the freelist. Remove it. */
drh341eae82003-01-21 02:39:36 +00001868 if( pPg==pPg->pPager->pFirstSynced ){
1869 PgHdr *p = pPg->pNextFree;
1870 while( p && p->needSync ){ p = p->pNextFree; }
1871 pPg->pPager->pFirstSynced = p;
1872 }
drh7e3b0a02001-04-28 16:52:40 +00001873 if( pPg->pPrevFree ){
1874 pPg->pPrevFree->pNextFree = pPg->pNextFree;
1875 }else{
1876 pPg->pPager->pFirst = pPg->pNextFree;
1877 }
1878 if( pPg->pNextFree ){
1879 pPg->pNextFree->pPrevFree = pPg->pPrevFree;
1880 }else{
1881 pPg->pPager->pLast = pPg->pPrevFree;
1882 }
1883 pPg->pPager->nRef++;
1884 }
1885 pPg->nRef++;
drhdd793422001-06-28 01:54:48 +00001886 REFINFO(pPg);
drhdf0b3b02001-06-23 11:36:20 +00001887}
danielk1977aca790a2005-01-13 11:07:52 +00001888#ifdef SQLITE_DEBUG
drhc8629a12004-05-08 20:07:40 +00001889 static void page_ref(PgHdr *pPg){
1890 if( pPg->nRef==0 ){
1891 _page_ref(pPg);
1892 }else{
1893 pPg->nRef++;
1894 REFINFO(pPg);
1895 }
1896 }
1897#else
1898# define page_ref(P) ((P)->nRef==0?_page_ref(P):(void)(P)->nRef++)
1899#endif
drhdf0b3b02001-06-23 11:36:20 +00001900
1901/*
1902** Increment the reference count for a page. The input pointer is
1903** a reference to the page data.
1904*/
drh3aac2dd2004-04-26 14:10:20 +00001905int sqlite3pager_ref(void *pData){
drhdf0b3b02001-06-23 11:36:20 +00001906 PgHdr *pPg = DATA_TO_PGHDR(pData);
1907 page_ref(pPg);
drh8c42ca92001-06-22 19:15:00 +00001908 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +00001909}
1910
1911/*
drh34e79ce2004-02-08 06:05:46 +00001912** Sync the journal. In other words, make sure all the pages that have
1913** been written to the journal have actually reached the surface of the
1914** disk. It is not safe to modify the original database file until after
1915** the journal has been synced. If the original database is modified before
1916** the journal is synced and a power failure occurs, the unsynced journal
1917** data would be lost and we would be unable to completely rollback the
1918** database changes. Database corruption would occur.
1919**
1920** This routine also updates the nRec field in the header of the journal.
1921** (See comments on the pager_playback() routine for additional information.)
1922** If the sync mode is FULL, two syncs will occur. First the whole journal
1923** is synced, then the nRec field is updated, then a second sync occurs.
drhb19a2bc2001-09-16 00:13:26 +00001924**
drh34e79ce2004-02-08 06:05:46 +00001925** For temporary databases, we do not care if we are able to rollback
1926** after a power failure, so sync occurs.
drhfa86c412002-02-02 15:01:15 +00001927**
drh34e79ce2004-02-08 06:05:46 +00001928** This routine clears the needSync field of every page current held in
1929** memory.
drh50e5dad2001-09-15 00:57:28 +00001930*/
danielk197776572402004-06-25 02:38:54 +00001931static int syncJournal(Pager *pPager){
drh50e5dad2001-09-15 00:57:28 +00001932 PgHdr *pPg;
1933 int rc = SQLITE_OK;
drh03eb96a2002-11-10 23:32:56 +00001934
1935 /* Sync the journal before modifying the main database
1936 ** (assuming there is a journal and it needs to be synced.)
1937 */
danielk197776572402004-06-25 02:38:54 +00001938 if( pPager->needSync ){
drhfa86c412002-02-02 15:01:15 +00001939 if( !pPager->tempFile ){
drhdb48ee02003-01-16 13:42:43 +00001940 assert( pPager->journalOpen );
drh946966f2004-02-25 02:20:41 +00001941 /* assert( !pPager->noSync ); // noSync might be set if synchronous
1942 ** was turned off after the transaction was started. Ticket #615 */
drh968af522003-02-11 14:55:40 +00001943#ifndef NDEBUG
1944 {
drh34e79ce2004-02-08 06:05:46 +00001945 /* Make sure the pPager->nRec counter we are keeping agrees
1946 ** with the nRec computed from the size of the journal file.
1947 */
drheb206252004-10-01 02:00:31 +00001948 i64 jSz;
danielk19774adee202004-05-08 08:23:19 +00001949 rc = sqlite3OsFileSize(&pPager->jfd, &jSz);
drh968af522003-02-11 14:55:40 +00001950 if( rc!=0 ) return rc;
danielk197776572402004-06-25 02:38:54 +00001951 assert( pPager->journalOff==jSz );
drh968af522003-02-11 14:55:40 +00001952 }
1953#endif
drhae2b40c2004-06-09 19:03:54 +00001954 {
danielk197776572402004-06-25 02:38:54 +00001955 /* Write the nRec value into the journal file header. If in
1956 ** full-synchronous mode, sync the journal first. This ensures that
1957 ** all data has really hit the disk before nRec is updated to mark
1958 ** it as a candidate for rollback.
1959 */
drhd8d66e82003-02-12 02:10:15 +00001960 if( pPager->fullSync ){
danielk1977ef73ee92004-11-06 12:26:07 +00001961 TRACE2("SYNC journal of %d\n", PAGERID(pPager));
danielk19774adee202004-05-08 08:23:19 +00001962 rc = sqlite3OsSync(&pPager->jfd);
drhd8d66e82003-02-12 02:10:15 +00001963 if( rc!=0 ) return rc;
1964 }
danielk197776572402004-06-25 02:38:54 +00001965 sqlite3OsSeek(&pPager->jfd, pPager->journalHdr + sizeof(aJournalMagic));
drh99ee3602003-02-16 19:13:36 +00001966 rc = write32bits(&pPager->jfd, pPager->nRec);
1967 if( rc ) return rc;
danielk197713adf8a2004-06-03 16:08:41 +00001968
danielk197776572402004-06-25 02:38:54 +00001969 sqlite3OsSeek(&pPager->jfd, pPager->journalOff);
drh968af522003-02-11 14:55:40 +00001970 }
danielk1977ef73ee92004-11-06 12:26:07 +00001971 TRACE2("SYNC journal of %d\n", PAGERID(pPager));
danielk19774adee202004-05-08 08:23:19 +00001972 rc = sqlite3OsSync(&pPager->jfd);
drhfa86c412002-02-02 15:01:15 +00001973 if( rc!=0 ) return rc;
drhdb48ee02003-01-16 13:42:43 +00001974 pPager->journalStarted = 1;
drhfa86c412002-02-02 15:01:15 +00001975 }
drh50e5dad2001-09-15 00:57:28 +00001976 pPager->needSync = 0;
drh341eae82003-01-21 02:39:36 +00001977
1978 /* Erase the needSync flag from every page.
1979 */
1980 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
1981 pPg->needSync = 0;
1982 }
1983 pPager->pFirstSynced = pPager->pFirst;
drh50e5dad2001-09-15 00:57:28 +00001984 }
drh03eb96a2002-11-10 23:32:56 +00001985
drh341eae82003-01-21 02:39:36 +00001986#ifndef NDEBUG
1987 /* If the Pager.needSync flag is clear then the PgHdr.needSync
1988 ** flag must also be clear for all pages. Verify that this
1989 ** invariant is true.
drh03eb96a2002-11-10 23:32:56 +00001990 */
drh341eae82003-01-21 02:39:36 +00001991 else{
1992 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
1993 assert( pPg->needSync==0 );
1994 }
1995 assert( pPager->pFirstSynced==pPager->pFirst );
drh03eb96a2002-11-10 23:32:56 +00001996 }
drh341eae82003-01-21 02:39:36 +00001997#endif
drhdb48ee02003-01-16 13:42:43 +00001998
drh81a20f22001-10-12 17:30:04 +00001999 return rc;
drh50e5dad2001-09-15 00:57:28 +00002000}
2001
2002/*
drh684917c2004-10-05 02:41:42 +00002003** Try to obtain a lock on a file. Invoke the busy callback if the lock
2004** is currently not available. Repeate until the busy callback returns
2005** false or until the lock succeeds.
2006**
2007** Return SQLITE_OK on success and an error code if we cannot obtain
2008** the lock.
2009*/
2010static int pager_wait_on_lock(Pager *pPager, int locktype){
2011 int rc;
2012 assert( PAGER_SHARED==SHARED_LOCK );
2013 assert( PAGER_RESERVED==RESERVED_LOCK );
2014 assert( PAGER_EXCLUSIVE==EXCLUSIVE_LOCK );
2015 if( pPager->state>=locktype ){
2016 rc = SQLITE_OK;
2017 }else{
2018 int busy = 1;
2019 do {
2020 rc = sqlite3OsLock(&pPager->fd, locktype);
2021 }while( rc==SQLITE_BUSY &&
2022 pPager->pBusyHandler &&
2023 pPager->pBusyHandler->xFunc &&
2024 pPager->pBusyHandler->xFunc(pPager->pBusyHandler->pArg, busy++)
2025 );
2026 if( rc==SQLITE_OK ){
2027 pPager->state = locktype;
2028 }
2029 }
2030 return rc;
2031}
2032
2033/*
drh2554f8b2003-01-22 01:26:44 +00002034** Given a list of pages (connected by the PgHdr.pDirty pointer) write
2035** every one of those pages out to the database file and mark them all
2036** as clean.
2037*/
2038static int pager_write_pagelist(PgHdr *pList){
2039 Pager *pPager;
2040 int rc;
2041
2042 if( pList==0 ) return SQLITE_OK;
2043 pPager = pList->pPager;
danielk19779eed5052004-06-04 10:38:30 +00002044
2045 /* At this point there may be either a RESERVED or EXCLUSIVE lock on the
2046 ** database file. If there is already an EXCLUSIVE lock, the following
2047 ** calls to sqlite3OsLock() are no-ops.
2048 **
drha6abd042004-06-09 17:37:22 +00002049 ** Moving the lock from RESERVED to EXCLUSIVE actually involves going
2050 ** through an intermediate state PENDING. A PENDING lock prevents new
2051 ** readers from attaching to the database but is unsufficient for us to
2052 ** write. The idea of a PENDING lock is to prevent new readers from
2053 ** coming in while we wait for existing readers to clear.
danielk19779eed5052004-06-04 10:38:30 +00002054 **
drha6abd042004-06-09 17:37:22 +00002055 ** While the pager is in the RESERVED state, the original database file
2056 ** is unchanged and we can rollback without having to playback the
2057 ** journal into the original database file. Once we transition to
2058 ** EXCLUSIVE, it means the database file has been changed and any rollback
2059 ** will require a journal playback.
danielk19779eed5052004-06-04 10:38:30 +00002060 */
drh684917c2004-10-05 02:41:42 +00002061 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
danielk19779eed5052004-06-04 10:38:30 +00002062 if( rc!=SQLITE_OK ){
2063 return rc;
2064 }
2065
drh2554f8b2003-01-22 01:26:44 +00002066 while( pList ){
2067 assert( pList->dirty );
drheb206252004-10-01 02:00:31 +00002068 sqlite3OsSeek(&pPager->fd, (pList->pgno-1)*(i64)pPager->pageSize);
danielk1977687566d2004-11-02 12:56:41 +00002069 /* If there are dirty pages in the page cache with page numbers greater
2070 ** than Pager.dbSize, this means sqlite3pager_truncate() was called to
2071 ** make the file smaller (presumably by auto-vacuum code). Do not write
2072 ** any such pages to the file.
2073 */
2074 if( pList->pgno<=pPager->dbSize ){
2075 CODEC(pPager, PGHDR_TO_DATA(pList), pList->pgno, 6);
danielk1977ef73ee92004-11-06 12:26:07 +00002076 TRACE3("STORE %d page %d\n", PAGERID(pPager), pList->pgno);
danielk1977687566d2004-11-02 12:56:41 +00002077 rc = sqlite3OsWrite(&pPager->fd, PGHDR_TO_DATA(pList), pPager->pageSize);
2078 CODEC(pPager, PGHDR_TO_DATA(pList), pList->pgno, 0);
danielk197742741be2005-01-08 12:42:39 +00002079 pPager->nWrite++;
danielk1977687566d2004-11-02 12:56:41 +00002080 }
2081#ifndef NDEBUG
2082 else{
danielk1977ef73ee92004-11-06 12:26:07 +00002083 TRACE3("NOSTORE %d page %d\n", PAGERID(pPager), pList->pgno);
danielk1977687566d2004-11-02 12:56:41 +00002084 }
2085#endif
drh2554f8b2003-01-22 01:26:44 +00002086 if( rc ) return rc;
2087 pList->dirty = 0;
2088 pList = pList->pDirty;
2089 }
2090 return SQLITE_OK;
2091}
2092
2093/*
2094** Collect every dirty page into a dirty list and
2095** return a pointer to the head of that list. All pages are
2096** collected even if they are still in use.
2097*/
2098static PgHdr *pager_get_all_dirty_pages(Pager *pPager){
2099 PgHdr *p, *pList;
2100 pList = 0;
2101 for(p=pPager->pAll; p; p=p->pNextAll){
2102 if( p->dirty ){
2103 p->pDirty = pList;
2104 pList = p;
2105 }
2106 }
2107 return pList;
2108}
2109
2110/*
drhd9b02572001-04-15 00:37:09 +00002111** Acquire a page.
2112**
drh58a11682001-11-10 13:51:08 +00002113** A read lock on the disk file is obtained when the first page is acquired.
drh5e00f6c2001-09-13 13:46:56 +00002114** This read lock is dropped when the last page is released.
drhd9b02572001-04-15 00:37:09 +00002115**
drh306dc212001-05-21 13:45:10 +00002116** A _get works for any page number greater than 0. If the database
2117** file is smaller than the requested page, then no actual disk
2118** read occurs and the memory image of the page is initialized to
2119** all zeros. The extra data appended to a page is always initialized
2120** to zeros the first time a page is loaded into memory.
2121**
drhd9b02572001-04-15 00:37:09 +00002122** The acquisition might fail for several reasons. In all cases,
2123** an appropriate error code is returned and *ppPage is set to NULL.
drh7e3b0a02001-04-28 16:52:40 +00002124**
drh3aac2dd2004-04-26 14:10:20 +00002125** See also sqlite3pager_lookup(). Both this routine and _lookup() attempt
drh7e3b0a02001-04-28 16:52:40 +00002126** to find a page in the in-memory cache first. If the page is not already
drh5e00f6c2001-09-13 13:46:56 +00002127** in memory, this routine goes to disk to read it in whereas _lookup()
drh7e3b0a02001-04-28 16:52:40 +00002128** just returns 0. This routine acquires a read-lock the first time it
2129** has to go to disk, and could also playback an old journal if necessary.
2130** Since _lookup() never goes to disk, it never has to deal with locks
2131** or journal files.
drhed7c8552001-04-11 14:29:21 +00002132*/
drh3aac2dd2004-04-26 14:10:20 +00002133int sqlite3pager_get(Pager *pPager, Pgno pgno, void **ppPage){
drhed7c8552001-04-11 14:29:21 +00002134 PgHdr *pPg;
drh8766c342002-11-09 00:33:15 +00002135 int rc;
drhed7c8552001-04-11 14:29:21 +00002136
danielk197726836652005-01-17 01:33:13 +00002137 /* The maximum page number is 2^31. Return SQLITE_CORRUPT if a page
2138 ** number greater than this, or zero, is requested.
2139 */
2140 if( pgno>PAGER_MAX_PGNO || pgno==0 ){
2141 return SQLITE_CORRUPT;
2142 }
2143
drhd9b02572001-04-15 00:37:09 +00002144 /* Make sure we have not hit any critical errors.
2145 */
drh836faa42003-01-11 13:30:57 +00002146 assert( pPager!=0 );
drh2e6d11b2003-04-25 15:37:57 +00002147 *ppPage = 0;
drhd9b02572001-04-15 00:37:09 +00002148 if( pPager->errMask & ~(PAGER_ERR_FULL) ){
2149 return pager_errcode(pPager);
2150 }
2151
danielk197713adf8a2004-06-03 16:08:41 +00002152 /* If this is the first page accessed, then get a SHARED lock
drhed7c8552001-04-11 14:29:21 +00002153 ** on the database file.
2154 */
drhb7f91642004-10-31 02:22:47 +00002155 if( pPager->nRef==0 && !MEMDB ){
drh684917c2004-10-05 02:41:42 +00002156 rc = pager_wait_on_lock(pPager, SHARED_LOCK);
danielk19779eed5052004-06-04 10:38:30 +00002157 if( rc!=SQLITE_OK ){
2158 return rc;
drhed7c8552001-04-11 14:29:21 +00002159 }
2160
danielk197713adf8a2004-06-03 16:08:41 +00002161 /* If a journal file exists, and there is no RESERVED lock on the
2162 ** database file, then it either needs to be played back or deleted.
drhed7c8552001-04-11 14:29:21 +00002163 */
danielk197713adf8a2004-06-03 16:08:41 +00002164 if( pPager->useJournal &&
2165 sqlite3OsFileExists(pPager->zJournal) &&
drha6abd042004-06-09 17:37:22 +00002166 !sqlite3OsCheckReservedLock(&pPager->fd)
danielk197713adf8a2004-06-03 16:08:41 +00002167 ){
drhe2227f02003-06-14 11:42:57 +00002168 int rc;
drhed7c8552001-04-11 14:29:21 +00002169
danielk197790ba3bd2004-06-25 08:32:25 +00002170 /* Get an EXCLUSIVE lock on the database file. At this point it is
2171 ** important that a RESERVED lock is not obtained on the way to the
2172 ** EXCLUSIVE lock. If it were, another process might open the
2173 ** database file, detect the RESERVED lock, and conclude that the
2174 ** database is safe to read while this process is still rolling it
2175 ** back.
2176 **
2177 ** Because the intermediate RESERVED lock is not requested, the
2178 ** second process will get to this point in the code and fail to
2179 ** obtain it's own EXCLUSIVE lock on the database file.
2180 */
danielk197713adf8a2004-06-03 16:08:41 +00002181 rc = sqlite3OsLock(&pPager->fd, EXCLUSIVE_LOCK);
drha7fcb052001-12-14 15:09:55 +00002182 if( rc!=SQLITE_OK ){
drha6abd042004-06-09 17:37:22 +00002183 sqlite3OsUnlock(&pPager->fd, NO_LOCK);
2184 pPager->state = PAGER_UNLOCK;
drh8766c342002-11-09 00:33:15 +00002185 return rc;
drha7fcb052001-12-14 15:09:55 +00002186 }
drha6abd042004-06-09 17:37:22 +00002187 pPager->state = PAGER_EXCLUSIVE;
drha7fcb052001-12-14 15:09:55 +00002188
drhe2227f02003-06-14 11:42:57 +00002189 /* Open the journal for reading only. Return SQLITE_BUSY if
2190 ** we are unable to open the journal file.
drhf57b3392001-10-08 13:22:32 +00002191 **
drhe2227f02003-06-14 11:42:57 +00002192 ** The journal file does not need to be locked itself. The
2193 ** journal file is never open unless the main database file holds
2194 ** a write lock, so there is never any chance of two or more
2195 ** processes opening the journal at the same time.
drhed7c8552001-04-11 14:29:21 +00002196 */
danielk19774adee202004-05-08 08:23:19 +00002197 rc = sqlite3OsOpenReadOnly(pPager->zJournal, &pPager->jfd);
drha7fcb052001-12-14 15:09:55 +00002198 if( rc!=SQLITE_OK ){
drha6abd042004-06-09 17:37:22 +00002199 sqlite3OsUnlock(&pPager->fd, NO_LOCK);
2200 pPager->state = PAGER_UNLOCK;
drhed7c8552001-04-11 14:29:21 +00002201 return SQLITE_BUSY;
2202 }
drha7fcb052001-12-14 15:09:55 +00002203 pPager->journalOpen = 1;
drhdb48ee02003-01-16 13:42:43 +00002204 pPager->journalStarted = 0;
danielk197776572402004-06-25 02:38:54 +00002205 pPager->journalOff = 0;
2206 pPager->setMaster = 0;
2207 pPager->journalHdr = 0;
drhed7c8552001-04-11 14:29:21 +00002208
2209 /* Playback and delete the journal. Drop the database write
2210 ** lock and reacquire the read lock.
2211 */
danielk197776572402004-06-25 02:38:54 +00002212 rc = pager_playback(pPager);
drhd9b02572001-04-15 00:37:09 +00002213 if( rc!=SQLITE_OK ){
2214 return rc;
2215 }
drhed7c8552001-04-11 14:29:21 +00002216 }
2217 pPg = 0;
2218 }else{
2219 /* Search for page in cache */
drhd9b02572001-04-15 00:37:09 +00002220 pPg = pager_lookup(pPager, pgno);
drhb7f91642004-10-31 02:22:47 +00002221 if( MEMDB && pPager->state==PAGER_UNLOCK ){
drha6abd042004-06-09 17:37:22 +00002222 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00002223 }
drhed7c8552001-04-11 14:29:21 +00002224 }
2225 if( pPg==0 ){
drhd9b02572001-04-15 00:37:09 +00002226 /* The requested page is not in the page cache. */
drhed7c8552001-04-11 14:29:21 +00002227 int h;
drh7e3b0a02001-04-28 16:52:40 +00002228 pPager->nMiss++;
drhb7f91642004-10-31 02:22:47 +00002229 if( pPager->nPage<pPager->mxPage || pPager->pFirst==0 || MEMDB ){
drhed7c8552001-04-11 14:29:21 +00002230 /* Create a new page */
drh887dc4c2004-10-22 16:22:57 +00002231 pPg = sqliteMallocRaw( sizeof(*pPg) + pPager->psAligned
drhac69b052004-05-12 13:30:07 +00002232 + sizeof(u32) + pPager->nExtra
drhb7f91642004-10-31 02:22:47 +00002233 + MEMDB*sizeof(PgHistory) );
drhd9b02572001-04-15 00:37:09 +00002234 if( pPg==0 ){
drhb7f91642004-10-31 02:22:47 +00002235 if( !MEMDB ){
danielk19778def5ea2004-06-16 10:39:52 +00002236 pager_unwritelock(pPager);
2237 }
drhd9b02572001-04-15 00:37:09 +00002238 pPager->errMask |= PAGER_ERR_MEM;
2239 return SQLITE_NOMEM;
2240 }
drh8c1238a2003-01-02 14:43:55 +00002241 memset(pPg, 0, sizeof(*pPg));
drhb7f91642004-10-31 02:22:47 +00002242 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00002243 memset(PGHDR_TO_HIST(pPg, pPager), 0, sizeof(PgHistory));
2244 }
drhed7c8552001-04-11 14:29:21 +00002245 pPg->pPager = pPager;
drhd9b02572001-04-15 00:37:09 +00002246 pPg->pNextAll = pPager->pAll;
drhd79caeb2001-04-15 02:27:24 +00002247 pPager->pAll = pPg;
drhd9b02572001-04-15 00:37:09 +00002248 pPager->nPage++;
drhed7c8552001-04-11 14:29:21 +00002249 }else{
drhdb48ee02003-01-16 13:42:43 +00002250 /* Find a page to recycle. Try to locate a page that does not
2251 ** require us to do an fsync() on the journal.
2252 */
drh341eae82003-01-21 02:39:36 +00002253 pPg = pPager->pFirstSynced;
drhb19a2bc2001-09-16 00:13:26 +00002254
drhdb48ee02003-01-16 13:42:43 +00002255 /* If we could not find a page that does not require an fsync()
2256 ** on the journal file then fsync the journal file. This is a
2257 ** very slow operation, so we work hard to avoid it. But sometimes
2258 ** it can't be helped.
drhb19a2bc2001-09-16 00:13:26 +00002259 */
drh603240c2002-03-05 01:11:12 +00002260 if( pPg==0 ){
danielk197776572402004-06-25 02:38:54 +00002261 int rc = syncJournal(pPager);
drh50e5dad2001-09-15 00:57:28 +00002262 if( rc!=0 ){
drh3aac2dd2004-04-26 14:10:20 +00002263 sqlite3pager_rollback(pPager);
drh50e5dad2001-09-15 00:57:28 +00002264 return SQLITE_IOERR;
2265 }
danielk197776572402004-06-25 02:38:54 +00002266 if( pPager->fullSync ){
2267 /* If in full-sync mode, write a new journal header into the
2268 ** journal file. This is done to avoid ever modifying a journal
2269 ** header that is involved in the rollback of pages that have
2270 ** already been written to the database (in case the header is
2271 ** trashed when the nRec field is updated).
2272 */
2273 pPager->nRec = 0;
danielk1977f187bd92004-06-25 06:23:22 +00002274 assert( pPager->journalOff > 0 );
danielk197776572402004-06-25 02:38:54 +00002275 rc = writeJournalHdr(pPager);
2276 if( rc!=0 ){
2277 sqlite3pager_rollback(pPager);
2278 return SQLITE_IOERR;
2279 }
2280 }
drh50e5dad2001-09-15 00:57:28 +00002281 pPg = pPager->pFirst;
2282 }
drhd9b02572001-04-15 00:37:09 +00002283 assert( pPg->nRef==0 );
drhdb48ee02003-01-16 13:42:43 +00002284
2285 /* Write the page to the database file if it is dirty.
2286 */
2287 if( pPg->dirty ){
2288 assert( pPg->needSync==0 );
drh2554f8b2003-01-22 01:26:44 +00002289 pPg->pDirty = 0;
2290 rc = pager_write_pagelist( pPg );
drhdb48ee02003-01-16 13:42:43 +00002291 if( rc!=SQLITE_OK ){
drh3aac2dd2004-04-26 14:10:20 +00002292 sqlite3pager_rollback(pPager);
drhdb48ee02003-01-16 13:42:43 +00002293 return SQLITE_IOERR;
2294 }
drhdb48ee02003-01-16 13:42:43 +00002295 }
drh50e5dad2001-09-15 00:57:28 +00002296 assert( pPg->dirty==0 );
drhd9b02572001-04-15 00:37:09 +00002297
drhdb48ee02003-01-16 13:42:43 +00002298 /* If the page we are recycling is marked as alwaysRollback, then
drh193a6b42002-07-07 16:52:46 +00002299 ** set the global alwaysRollback flag, thus disabling the
2300 ** sqlite_dont_rollback() optimization for the rest of this transaction.
2301 ** It is necessary to do this because the page marked alwaysRollback
2302 ** might be reloaded at a later time but at that point we won't remember
2303 ** that is was marked alwaysRollback. This means that all pages must
2304 ** be marked as alwaysRollback from here on out.
2305 */
2306 if( pPg->alwaysRollback ){
2307 pPager->alwaysRollback = 1;
2308 }
2309
drhd9b02572001-04-15 00:37:09 +00002310 /* Unlink the old page from the free list and the hash table
2311 */
drhac69b052004-05-12 13:30:07 +00002312 unlinkPage(pPg);
drhd9b02572001-04-15 00:37:09 +00002313 pPager->nOvfl++;
drhed7c8552001-04-11 14:29:21 +00002314 }
2315 pPg->pgno = pgno;
drh1ab43002002-01-14 09:28:19 +00002316 if( pPager->aInJournal && (int)pgno<=pPager->origDbSize ){
danielk19774adee202004-05-08 08:23:19 +00002317 sqlite3CheckMemory(pPager->aInJournal, pgno/8);
drhdb48ee02003-01-16 13:42:43 +00002318 assert( pPager->journalOpen );
drh6019e162001-07-02 17:51:45 +00002319 pPg->inJournal = (pPager->aInJournal[pgno/8] & (1<<(pgno&7)))!=0;
drhdb48ee02003-01-16 13:42:43 +00002320 pPg->needSync = 0;
drh6019e162001-07-02 17:51:45 +00002321 }else{
2322 pPg->inJournal = 0;
drhdb48ee02003-01-16 13:42:43 +00002323 pPg->needSync = 0;
drh6019e162001-07-02 17:51:45 +00002324 }
drhac69b052004-05-12 13:30:07 +00002325 if( pPager->aInStmt && (int)pgno<=pPager->stmtSize
2326 && (pPager->aInStmt[pgno/8] & (1<<(pgno&7)))!=0 ){
drh3aac2dd2004-04-26 14:10:20 +00002327 page_add_to_stmt_list(pPg);
drhfa86c412002-02-02 15:01:15 +00002328 }else{
drh3aac2dd2004-04-26 14:10:20 +00002329 page_remove_from_stmt_list(pPg);
drhfa86c412002-02-02 15:01:15 +00002330 }
drhed7c8552001-04-11 14:29:21 +00002331 pPg->dirty = 0;
2332 pPg->nRef = 1;
drhdd793422001-06-28 01:54:48 +00002333 REFINFO(pPg);
drhd9b02572001-04-15 00:37:09 +00002334 pPager->nRef++;
2335 h = pager_hash(pgno);
drhed7c8552001-04-11 14:29:21 +00002336 pPg->pNextHash = pPager->aHash[h];
2337 pPager->aHash[h] = pPg;
2338 if( pPg->pNextHash ){
2339 assert( pPg->pNextHash->pPrevHash==0 );
2340 pPg->pNextHash->pPrevHash = pPg;
2341 }
drh2e6d11b2003-04-25 15:37:57 +00002342 if( pPager->nExtra>0 ){
drh90f5ecb2004-07-22 01:19:35 +00002343 memset(PGHDR_TO_EXTRA(pPg, pPager), 0, pPager->nExtra);
drh2e6d11b2003-04-25 15:37:57 +00002344 }
drhdc3ff9c2004-08-18 02:10:15 +00002345 sqlite3pager_pagecount(pPager);
drh2e6d11b2003-04-25 15:37:57 +00002346 if( pPager->errMask!=0 ){
drh3aac2dd2004-04-26 14:10:20 +00002347 sqlite3pager_unref(PGHDR_TO_DATA(pPg));
drh2e6d11b2003-04-25 15:37:57 +00002348 rc = pager_errcode(pPager);
2349 return rc;
2350 }
drh1ab43002002-01-14 09:28:19 +00002351 if( pPager->dbSize<(int)pgno ){
drh90f5ecb2004-07-22 01:19:35 +00002352 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
drh306dc212001-05-21 13:45:10 +00002353 }else{
drh81a20f22001-10-12 17:30:04 +00002354 int rc;
drhb7f91642004-10-31 02:22:47 +00002355 assert( MEMDB==0 );
drheb206252004-10-01 02:00:31 +00002356 sqlite3OsSeek(&pPager->fd, (pgno-1)*(i64)pPager->pageSize);
drh90f5ecb2004-07-22 01:19:35 +00002357 rc = sqlite3OsRead(&pPager->fd, PGHDR_TO_DATA(pPg), pPager->pageSize);
danielk1977ef73ee92004-11-06 12:26:07 +00002358 TRACE3("FETCH %d page %d\n", PAGERID(pPager), pPg->pgno);
drh9eb9e262004-02-11 02:18:05 +00002359 CODEC(pPager, PGHDR_TO_DATA(pPg), pPg->pgno, 3);
drh81a20f22001-10-12 17:30:04 +00002360 if( rc!=SQLITE_OK ){
drheb206252004-10-01 02:00:31 +00002361 i64 fileSize;
danielk19774adee202004-05-08 08:23:19 +00002362 if( sqlite3OsFileSize(&pPager->fd,&fileSize)!=SQLITE_OK
drh90f5ecb2004-07-22 01:19:35 +00002363 || fileSize>=pgno*pPager->pageSize ){
drh3aac2dd2004-04-26 14:10:20 +00002364 sqlite3pager_unref(PGHDR_TO_DATA(pPg));
drh4e371ee2002-09-05 16:08:27 +00002365 return rc;
2366 }else{
drh90f5ecb2004-07-22 01:19:35 +00002367 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
drh4e371ee2002-09-05 16:08:27 +00002368 }
danielk197742741be2005-01-08 12:42:39 +00002369 }else{
2370 pPager->nRead++;
drh81a20f22001-10-12 17:30:04 +00002371 }
drh306dc212001-05-21 13:45:10 +00002372 }
drhed7c8552001-04-11 14:29:21 +00002373 }else{
drhd9b02572001-04-15 00:37:09 +00002374 /* The requested page is in the page cache. */
drh7e3b0a02001-04-28 16:52:40 +00002375 pPager->nHit++;
drhdf0b3b02001-06-23 11:36:20 +00002376 page_ref(pPg);
drhed7c8552001-04-11 14:29:21 +00002377 }
2378 *ppPage = PGHDR_TO_DATA(pPg);
2379 return SQLITE_OK;
2380}
2381
2382/*
drh7e3b0a02001-04-28 16:52:40 +00002383** Acquire a page if it is already in the in-memory cache. Do
2384** not read the page from disk. Return a pointer to the page,
2385** or 0 if the page is not in cache.
2386**
drh3aac2dd2004-04-26 14:10:20 +00002387** See also sqlite3pager_get(). The difference between this routine
2388** and sqlite3pager_get() is that _get() will go to the disk and read
drh7e3b0a02001-04-28 16:52:40 +00002389** in the page if the page is not already in cache. This routine
drh5e00f6c2001-09-13 13:46:56 +00002390** returns NULL if the page is not in cache or if a disk I/O error
2391** has ever happened.
drh7e3b0a02001-04-28 16:52:40 +00002392*/
drh3aac2dd2004-04-26 14:10:20 +00002393void *sqlite3pager_lookup(Pager *pPager, Pgno pgno){
drh7e3b0a02001-04-28 16:52:40 +00002394 PgHdr *pPg;
2395
drh836faa42003-01-11 13:30:57 +00002396 assert( pPager!=0 );
2397 assert( pgno!=0 );
drh7e3b0a02001-04-28 16:52:40 +00002398 if( pPager->errMask & ~(PAGER_ERR_FULL) ){
2399 return 0;
2400 }
drh7e3b0a02001-04-28 16:52:40 +00002401 pPg = pager_lookup(pPager, pgno);
2402 if( pPg==0 ) return 0;
drhdf0b3b02001-06-23 11:36:20 +00002403 page_ref(pPg);
drh7e3b0a02001-04-28 16:52:40 +00002404 return PGHDR_TO_DATA(pPg);
2405}
2406
2407/*
drhed7c8552001-04-11 14:29:21 +00002408** Release a page.
2409**
2410** If the number of references to the page drop to zero, then the
2411** page is added to the LRU list. When all references to all pages
drhd9b02572001-04-15 00:37:09 +00002412** are released, a rollback occurs and the lock on the database is
drhed7c8552001-04-11 14:29:21 +00002413** removed.
2414*/
drh3aac2dd2004-04-26 14:10:20 +00002415int sqlite3pager_unref(void *pData){
drhed7c8552001-04-11 14:29:21 +00002416 PgHdr *pPg;
drhd9b02572001-04-15 00:37:09 +00002417
2418 /* Decrement the reference count for this page
2419 */
drhed7c8552001-04-11 14:29:21 +00002420 pPg = DATA_TO_PGHDR(pData);
2421 assert( pPg->nRef>0 );
drhed7c8552001-04-11 14:29:21 +00002422 pPg->nRef--;
drhdd793422001-06-28 01:54:48 +00002423 REFINFO(pPg);
drhd9b02572001-04-15 00:37:09 +00002424
drh72f82862001-05-24 21:06:34 +00002425 /* When the number of references to a page reach 0, call the
2426 ** destructor and add the page to the freelist.
drhd9b02572001-04-15 00:37:09 +00002427 */
drhed7c8552001-04-11 14:29:21 +00002428 if( pPg->nRef==0 ){
drh1eaa2692001-09-18 02:02:23 +00002429 Pager *pPager;
2430 pPager = pPg->pPager;
drhd9b02572001-04-15 00:37:09 +00002431 pPg->pNextFree = 0;
2432 pPg->pPrevFree = pPager->pLast;
drhed7c8552001-04-11 14:29:21 +00002433 pPager->pLast = pPg;
drhd9b02572001-04-15 00:37:09 +00002434 if( pPg->pPrevFree ){
2435 pPg->pPrevFree->pNextFree = pPg;
drhed7c8552001-04-11 14:29:21 +00002436 }else{
2437 pPager->pFirst = pPg;
2438 }
drh341eae82003-01-21 02:39:36 +00002439 if( pPg->needSync==0 && pPager->pFirstSynced==0 ){
2440 pPager->pFirstSynced = pPg;
2441 }
drh72f82862001-05-24 21:06:34 +00002442 if( pPager->xDestructor ){
drhb6f41482004-05-14 01:58:11 +00002443 pPager->xDestructor(pData, pPager->pageSize);
drh72f82862001-05-24 21:06:34 +00002444 }
drhd9b02572001-04-15 00:37:09 +00002445
2446 /* When all pages reach the freelist, drop the read lock from
2447 ** the database file.
2448 */
2449 pPager->nRef--;
2450 assert( pPager->nRef>=0 );
drhb7f91642004-10-31 02:22:47 +00002451 if( pPager->nRef==0 && !MEMDB ){
drhd9b02572001-04-15 00:37:09 +00002452 pager_reset(pPager);
2453 }
drhed7c8552001-04-11 14:29:21 +00002454 }
drhd9b02572001-04-15 00:37:09 +00002455 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +00002456}
2457
2458/*
drha6abd042004-06-09 17:37:22 +00002459** Create a journal file for pPager. There should already be a RESERVED
2460** or EXCLUSIVE lock on the database file when this routine is called.
drhda47d772002-12-02 04:25:19 +00002461**
2462** Return SQLITE_OK if everything. Return an error code and release the
2463** write lock if anything goes wrong.
2464*/
2465static int pager_open_journal(Pager *pPager){
2466 int rc;
drhb7f91642004-10-31 02:22:47 +00002467 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +00002468 assert( pPager->state>=PAGER_RESERVED );
drhda47d772002-12-02 04:25:19 +00002469 assert( pPager->journalOpen==0 );
2470 assert( pPager->useJournal );
drh3aac2dd2004-04-26 14:10:20 +00002471 sqlite3pager_pagecount(pPager);
drhda47d772002-12-02 04:25:19 +00002472 pPager->aInJournal = sqliteMalloc( pPager->dbSize/8 + 1 );
2473 if( pPager->aInJournal==0 ){
drh9c105bb2004-10-02 20:38:28 +00002474 rc = SQLITE_NOMEM;
2475 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00002476 }
danielk19774adee202004-05-08 08:23:19 +00002477 rc = sqlite3OsOpenExclusive(pPager->zJournal, &pPager->jfd,pPager->tempFile);
danielk197776572402004-06-25 02:38:54 +00002478 pPager->journalOff = 0;
2479 pPager->setMaster = 0;
2480 pPager->journalHdr = 0;
drhda47d772002-12-02 04:25:19 +00002481 if( rc!=SQLITE_OK ){
drh9c105bb2004-10-02 20:38:28 +00002482 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00002483 }
danielk19774adee202004-05-08 08:23:19 +00002484 sqlite3OsOpenDirectory(pPager->zDirectory, &pPager->jfd);
drhda47d772002-12-02 04:25:19 +00002485 pPager->journalOpen = 1;
drhdb48ee02003-01-16 13:42:43 +00002486 pPager->journalStarted = 0;
drhda47d772002-12-02 04:25:19 +00002487 pPager->needSync = 0;
2488 pPager->alwaysRollback = 0;
drh968af522003-02-11 14:55:40 +00002489 pPager->nRec = 0;
drh2e6d11b2003-04-25 15:37:57 +00002490 if( pPager->errMask!=0 ){
2491 rc = pager_errcode(pPager);
2492 return rc;
2493 }
drhda47d772002-12-02 04:25:19 +00002494 pPager->origDbSize = pPager->dbSize;
drhae2b40c2004-06-09 19:03:54 +00002495
danielk197776572402004-06-25 02:38:54 +00002496 rc = writeJournalHdr(pPager);
2497
drhac69b052004-05-12 13:30:07 +00002498 if( pPager->stmtAutoopen && rc==SQLITE_OK ){
drh3aac2dd2004-04-26 14:10:20 +00002499 rc = sqlite3pager_stmt_begin(pPager);
drhda47d772002-12-02 04:25:19 +00002500 }
2501 if( rc!=SQLITE_OK ){
2502 rc = pager_unwritelock(pPager);
2503 if( rc==SQLITE_OK ){
2504 rc = SQLITE_FULL;
2505 }
2506 }
drh9c105bb2004-10-02 20:38:28 +00002507 return rc;
2508
2509failed_to_open_journal:
2510 sqliteFree(pPager->aInJournal);
2511 pPager->aInJournal = 0;
2512 sqlite3OsUnlock(&pPager->fd, NO_LOCK);
2513 pPager->state = PAGER_UNLOCK;
2514 return rc;
drhda47d772002-12-02 04:25:19 +00002515}
2516
2517/*
drh4b845d72002-03-05 12:41:19 +00002518** Acquire a write-lock on the database. The lock is removed when
2519** the any of the following happen:
2520**
drh3aac2dd2004-04-26 14:10:20 +00002521** * sqlite3pager_commit() is called.
2522** * sqlite3pager_rollback() is called.
2523** * sqlite3pager_close() is called.
2524** * sqlite3pager_unref() is called to on every outstanding page.
drh4b845d72002-03-05 12:41:19 +00002525**
danielk197713adf8a2004-06-03 16:08:41 +00002526** The first parameter to this routine is a pointer to any open page of the
2527** database file. Nothing changes about the page - it is used merely to
2528** acquire a pointer to the Pager structure and as proof that there is
2529** already a read-lock on the database.
drh4b845d72002-03-05 12:41:19 +00002530**
danielk197713adf8a2004-06-03 16:08:41 +00002531** The second parameter indicates how much space in bytes to reserve for a
2532** master journal file-name at the start of the journal when it is created.
2533**
2534** A journal file is opened if this is not a temporary file. For temporary
2535** files, the opening of the journal file is deferred until there is an
2536** actual need to write to the journal.
drhda47d772002-12-02 04:25:19 +00002537**
drha6abd042004-06-09 17:37:22 +00002538** If the database is already reserved for writing, this routine is a no-op.
drh684917c2004-10-05 02:41:42 +00002539**
2540** If exFlag is true, go ahead and get an EXCLUSIVE lock on the file
2541** immediately instead of waiting until we try to flush the cache. The
2542** exFlag is ignored if a transaction is already active.
drh4b845d72002-03-05 12:41:19 +00002543*/
drh684917c2004-10-05 02:41:42 +00002544int sqlite3pager_begin(void *pData, int exFlag){
drh4b845d72002-03-05 12:41:19 +00002545 PgHdr *pPg = DATA_TO_PGHDR(pData);
2546 Pager *pPager = pPg->pPager;
2547 int rc = SQLITE_OK;
2548 assert( pPg->nRef>0 );
drha6abd042004-06-09 17:37:22 +00002549 assert( pPager->state!=PAGER_UNLOCK );
2550 if( pPager->state==PAGER_SHARED ){
drh4b845d72002-03-05 12:41:19 +00002551 assert( pPager->aInJournal==0 );
drhb7f91642004-10-31 02:22:47 +00002552 if( MEMDB ){
drha6abd042004-06-09 17:37:22 +00002553 pPager->state = PAGER_EXCLUSIVE;
drhac69b052004-05-12 13:30:07 +00002554 pPager->origDbSize = pPager->dbSize;
2555 }else{
drh684917c2004-10-05 02:41:42 +00002556 if( SQLITE_BUSY_RESERVED_LOCK || exFlag ){
2557 rc = pager_wait_on_lock(pPager, RESERVED_LOCK);
2558 }else{
danielk19779eed5052004-06-04 10:38:30 +00002559 rc = sqlite3OsLock(&pPager->fd, RESERVED_LOCK);
drh684917c2004-10-05 02:41:42 +00002560 }
2561 if( rc==SQLITE_OK ){
2562 pPager->state = PAGER_RESERVED;
2563 if( exFlag ){
2564 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
2565 }
2566 }
danielk19779eed5052004-06-04 10:38:30 +00002567 if( rc!=SQLITE_OK ){
2568 return rc;
drhac69b052004-05-12 13:30:07 +00002569 }
drha6abd042004-06-09 17:37:22 +00002570 pPager->dirtyCache = 0;
danielk1977ef73ee92004-11-06 12:26:07 +00002571 TRACE2("TRANSACTION %d\n", PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00002572 if( pPager->useJournal && !pPager->tempFile ){
2573 rc = pager_open_journal(pPager);
2574 }
drh4b845d72002-03-05 12:41:19 +00002575 }
2576 }
2577 return rc;
2578}
2579
2580/*
drhed7c8552001-04-11 14:29:21 +00002581** Mark a data page as writeable. The page is written into the journal
2582** if it is not there already. This routine must be called before making
2583** changes to a page.
2584**
2585** The first time this routine is called, the pager creates a new
drha6abd042004-06-09 17:37:22 +00002586** journal and acquires a RESERVED lock on the database. If the RESERVED
drhed7c8552001-04-11 14:29:21 +00002587** lock could not be acquired, this routine returns SQLITE_BUSY. The
drh306dc212001-05-21 13:45:10 +00002588** calling routine must check for that return value and be careful not to
drhed7c8552001-04-11 14:29:21 +00002589** change any page data until this routine returns SQLITE_OK.
drhd9b02572001-04-15 00:37:09 +00002590**
2591** If the journal file could not be written because the disk is full,
2592** then this routine returns SQLITE_FULL and does an immediate rollback.
2593** All subsequent write attempts also return SQLITE_FULL until there
drh3aac2dd2004-04-26 14:10:20 +00002594** is a call to sqlite3pager_commit() or sqlite3pager_rollback() to
drhd9b02572001-04-15 00:37:09 +00002595** reset.
drhed7c8552001-04-11 14:29:21 +00002596*/
drh3aac2dd2004-04-26 14:10:20 +00002597int sqlite3pager_write(void *pData){
drh69688d52001-04-14 16:38:23 +00002598 PgHdr *pPg = DATA_TO_PGHDR(pData);
2599 Pager *pPager = pPg->pPager;
drhd79caeb2001-04-15 02:27:24 +00002600 int rc = SQLITE_OK;
drh69688d52001-04-14 16:38:23 +00002601
drh6446c4d2001-12-15 14:22:18 +00002602 /* Check for errors
2603 */
drhd9b02572001-04-15 00:37:09 +00002604 if( pPager->errMask ){
2605 return pager_errcode(pPager);
2606 }
drh5e00f6c2001-09-13 13:46:56 +00002607 if( pPager->readOnly ){
2608 return SQLITE_PERM;
2609 }
drh6446c4d2001-12-15 14:22:18 +00002610
danielk197776572402004-06-25 02:38:54 +00002611 assert( !pPager->setMaster );
2612
drh6446c4d2001-12-15 14:22:18 +00002613 /* Mark the page as dirty. If the page has already been written
2614 ** to the journal then we can return right away.
2615 */
drhd9b02572001-04-15 00:37:09 +00002616 pPg->dirty = 1;
drhac69b052004-05-12 13:30:07 +00002617 if( pPg->inJournal && (pPg->inStmt || pPager->stmtInUse==0) ){
drha6abd042004-06-09 17:37:22 +00002618 pPager->dirtyCache = 1;
danielk1977a0bf2652004-11-04 14:30:04 +00002619 }else{
drh6446c4d2001-12-15 14:22:18 +00002620
danielk1977a0bf2652004-11-04 14:30:04 +00002621 /* If we get this far, it means that the page needs to be
2622 ** written to the transaction journal or the ckeckpoint journal
2623 ** or both.
2624 **
2625 ** First check to see that the transaction journal exists and
2626 ** create it if it does not.
2627 */
2628 assert( pPager->state!=PAGER_UNLOCK );
2629 rc = sqlite3pager_begin(pData, 0);
2630 if( rc!=SQLITE_OK ){
2631 return rc;
2632 }
2633 assert( pPager->state>=PAGER_RESERVED );
2634 if( !pPager->journalOpen && pPager->useJournal ){
2635 rc = pager_open_journal(pPager);
2636 if( rc!=SQLITE_OK ) return rc;
2637 }
2638 assert( pPager->journalOpen || !pPager->useJournal );
2639 pPager->dirtyCache = 1;
2640
2641 /* The transaction journal now exists and we have a RESERVED or an
2642 ** EXCLUSIVE lock on the main database file. Write the current page to
2643 ** the transaction journal if it is not there already.
2644 */
2645 if( !pPg->inJournal && (pPager->useJournal || MEMDB) ){
2646 if( (int)pPg->pgno <= pPager->origDbSize ){
2647 int szPg;
2648 u32 saved;
2649 if( MEMDB ){
2650 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
danielk1977ef73ee92004-11-06 12:26:07 +00002651 TRACE3("JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00002652 assert( pHist->pOrig==0 );
2653 pHist->pOrig = sqliteMallocRaw( pPager->pageSize );
2654 if( pHist->pOrig ){
2655 memcpy(pHist->pOrig, PGHDR_TO_DATA(pPg), pPager->pageSize);
2656 }
2657 }else{
2658 u32 cksum;
2659 CODEC(pPager, pData, pPg->pgno, 7);
2660 cksum = pager_cksum(pPager, pPg->pgno, pData);
2661 saved = *(u32*)PGHDR_TO_EXTRA(pPg, pPager);
2662 store32bits(cksum, pPg, pPager->pageSize);
2663 szPg = pPager->pageSize+8;
2664 store32bits(pPg->pgno, pPg, -4);
2665 rc = sqlite3OsWrite(&pPager->jfd, &((char*)pData)[-4], szPg);
2666 pPager->journalOff += szPg;
2667 TRACE4("JOURNAL %d page %d needSync=%d\n",
danielk1977ef73ee92004-11-06 12:26:07 +00002668 PAGERID(pPager), pPg->pgno, pPg->needSync);
danielk1977a0bf2652004-11-04 14:30:04 +00002669 CODEC(pPager, pData, pPg->pgno, 0);
2670 *(u32*)PGHDR_TO_EXTRA(pPg, pPager) = saved;
2671 if( rc!=SQLITE_OK ){
2672 sqlite3pager_rollback(pPager);
2673 pPager->errMask |= PAGER_ERR_FULL;
2674 return rc;
2675 }
2676 pPager->nRec++;
2677 assert( pPager->aInJournal!=0 );
2678 pPager->aInJournal[pPg->pgno/8] |= 1<<(pPg->pgno&7);
2679 pPg->needSync = !pPager->noSync;
2680 if( pPager->stmtInUse ){
2681 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
2682 page_add_to_stmt_list(pPg);
2683 }
drhac69b052004-05-12 13:30:07 +00002684 }
danielk197713adf8a2004-06-03 16:08:41 +00002685 }else{
danielk1977a0bf2652004-11-04 14:30:04 +00002686 pPg->needSync = !pPager->journalStarted && !pPager->noSync;
2687 TRACE4("APPEND %d page %d needSync=%d\n",
danielk1977ef73ee92004-11-06 12:26:07 +00002688 PAGERID(pPager), pPg->pgno, pPg->needSync);
danielk1977a0bf2652004-11-04 14:30:04 +00002689 }
2690 if( pPg->needSync ){
2691 pPager->needSync = 1;
2692 }
2693 pPg->inJournal = 1;
2694 }
2695
2696 /* If the statement journal is open and the page is not in it,
2697 ** then write the current page to the statement journal. Note that
2698 ** the statement journal format differs from the standard journal format
2699 ** in that it omits the checksums and the header.
2700 */
2701 if( pPager->stmtInUse && !pPg->inStmt && (int)pPg->pgno<=pPager->stmtSize ){
2702 assert( pPg->inJournal || (int)pPg->pgno>pPager->origDbSize );
2703 if( MEMDB ){
2704 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
2705 assert( pHist->pStmt==0 );
2706 pHist->pStmt = sqliteMallocRaw( pPager->pageSize );
2707 if( pHist->pStmt ){
2708 memcpy(pHist->pStmt, PGHDR_TO_DATA(pPg), pPager->pageSize);
2709 }
danielk1977ef73ee92004-11-06 12:26:07 +00002710 TRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00002711 }else{
2712 store32bits(pPg->pgno, pPg, -4);
2713 CODEC(pPager, pData, pPg->pgno, 7);
2714 rc = sqlite3OsWrite(&pPager->stfd,((char*)pData)-4, pPager->pageSize+4);
danielk1977ef73ee92004-11-06 12:26:07 +00002715 TRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
drhac69b052004-05-12 13:30:07 +00002716 CODEC(pPager, pData, pPg->pgno, 0);
drhac69b052004-05-12 13:30:07 +00002717 if( rc!=SQLITE_OK ){
2718 sqlite3pager_rollback(pPager);
2719 pPager->errMask |= PAGER_ERR_FULL;
2720 return rc;
2721 }
danielk1977a0bf2652004-11-04 14:30:04 +00002722 pPager->stmtNRec++;
2723 assert( pPager->aInStmt!=0 );
2724 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drhdb48ee02003-01-16 13:42:43 +00002725 }
danielk1977a0bf2652004-11-04 14:30:04 +00002726 page_add_to_stmt_list(pPg);
drhd9b02572001-04-15 00:37:09 +00002727 }
drhfa86c412002-02-02 15:01:15 +00002728 }
2729
2730 /* Update the database size and return.
2731 */
drh1ab43002002-01-14 09:28:19 +00002732 if( pPager->dbSize<(int)pPg->pgno ){
drh306dc212001-05-21 13:45:10 +00002733 pPager->dbSize = pPg->pgno;
drhb7f91642004-10-31 02:22:47 +00002734 if( !MEMDB && pPager->dbSize==PENDING_BYTE/pPager->pageSize ){
drh1f595712004-06-15 01:40:29 +00002735 pPager->dbSize++;
2736 }
drh306dc212001-05-21 13:45:10 +00002737 }
drh69688d52001-04-14 16:38:23 +00002738 return rc;
drhed7c8552001-04-11 14:29:21 +00002739}
2740
2741/*
drhaacc5432002-01-06 17:07:40 +00002742** Return TRUE if the page given in the argument was previously passed
drh3aac2dd2004-04-26 14:10:20 +00002743** to sqlite3pager_write(). In other words, return TRUE if it is ok
drh6019e162001-07-02 17:51:45 +00002744** to change the content of the page.
2745*/
drh3aac2dd2004-04-26 14:10:20 +00002746int sqlite3pager_iswriteable(void *pData){
drh6019e162001-07-02 17:51:45 +00002747 PgHdr *pPg = DATA_TO_PGHDR(pData);
2748 return pPg->dirty;
2749}
2750
danielk1977b84f96f2005-01-20 11:32:23 +00002751#ifndef SQLITE_OMIT_VACUUM
drh6019e162001-07-02 17:51:45 +00002752/*
drh001bbcb2003-03-19 03:14:00 +00002753** Replace the content of a single page with the information in the third
2754** argument.
2755*/
drh3aac2dd2004-04-26 14:10:20 +00002756int sqlite3pager_overwrite(Pager *pPager, Pgno pgno, void *pData){
drh001bbcb2003-03-19 03:14:00 +00002757 void *pPage;
2758 int rc;
2759
drh3aac2dd2004-04-26 14:10:20 +00002760 rc = sqlite3pager_get(pPager, pgno, &pPage);
drh001bbcb2003-03-19 03:14:00 +00002761 if( rc==SQLITE_OK ){
drh3aac2dd2004-04-26 14:10:20 +00002762 rc = sqlite3pager_write(pPage);
drh001bbcb2003-03-19 03:14:00 +00002763 if( rc==SQLITE_OK ){
drh90f5ecb2004-07-22 01:19:35 +00002764 memcpy(pPage, pData, pPager->pageSize);
drh001bbcb2003-03-19 03:14:00 +00002765 }
drh3aac2dd2004-04-26 14:10:20 +00002766 sqlite3pager_unref(pPage);
drh001bbcb2003-03-19 03:14:00 +00002767 }
2768 return rc;
2769}
danielk1977b84f96f2005-01-20 11:32:23 +00002770#endif
drh001bbcb2003-03-19 03:14:00 +00002771
2772/*
drh30e58752002-03-02 20:41:57 +00002773** A call to this routine tells the pager that it is not necessary to
2774** write the information on page "pgno" back to the disk, even though
2775** that page might be marked as dirty.
2776**
2777** The overlying software layer calls this routine when all of the data
2778** on the given page is unused. The pager marks the page as clean so
2779** that it does not get written to disk.
2780**
2781** Tests show that this optimization, together with the
drh3aac2dd2004-04-26 14:10:20 +00002782** sqlite3pager_dont_rollback() below, more than double the speed
drh30e58752002-03-02 20:41:57 +00002783** of large INSERT operations and quadruple the speed of large DELETEs.
drh8e298f92002-07-06 16:28:47 +00002784**
2785** When this routine is called, set the alwaysRollback flag to true.
drh3aac2dd2004-04-26 14:10:20 +00002786** Subsequent calls to sqlite3pager_dont_rollback() for the same page
drh8e298f92002-07-06 16:28:47 +00002787** will thereafter be ignored. This is necessary to avoid a problem
2788** where a page with data is added to the freelist during one part of
2789** a transaction then removed from the freelist during a later part
2790** of the same transaction and reused for some other purpose. When it
2791** is first added to the freelist, this routine is called. When reused,
2792** the dont_rollback() routine is called. But because the page contains
2793** critical data, we still need to be sure it gets rolled back in spite
2794** of the dont_rollback() call.
drh30e58752002-03-02 20:41:57 +00002795*/
drh3aac2dd2004-04-26 14:10:20 +00002796void sqlite3pager_dont_write(Pager *pPager, Pgno pgno){
drh30e58752002-03-02 20:41:57 +00002797 PgHdr *pPg;
drh8e298f92002-07-06 16:28:47 +00002798
drhb7f91642004-10-31 02:22:47 +00002799 if( MEMDB ) return;
danielk1977eac7a362004-06-16 07:45:24 +00002800
drh30e58752002-03-02 20:41:57 +00002801 pPg = pager_lookup(pPager, pgno);
drh8e298f92002-07-06 16:28:47 +00002802 pPg->alwaysRollback = 1;
drh30e58752002-03-02 20:41:57 +00002803 if( pPg && pPg->dirty ){
drh8124a302002-06-25 14:43:57 +00002804 if( pPager->dbSize==(int)pPg->pgno && pPager->origDbSize<pPager->dbSize ){
2805 /* If this pages is the last page in the file and the file has grown
2806 ** during the current transaction, then do NOT mark the page as clean.
2807 ** When the database file grows, we must make sure that the last page
2808 ** gets written at least once so that the disk file will be the correct
2809 ** size. If you do not write this page and the size of the file
2810 ** on the disk ends up being too small, that can lead to database
2811 ** corruption during the next transaction.
2812 */
2813 }else{
danielk1977ef73ee92004-11-06 12:26:07 +00002814 TRACE3("DONT_WRITE page %d of %d\n", pgno, PAGERID(pPager));
drh8124a302002-06-25 14:43:57 +00002815 pPg->dirty = 0;
2816 }
drh30e58752002-03-02 20:41:57 +00002817 }
2818}
2819
2820/*
2821** A call to this routine tells the pager that if a rollback occurs,
2822** it is not necessary to restore the data on the given page. This
2823** means that the pager does not have to record the given page in the
2824** rollback journal.
2825*/
drh3aac2dd2004-04-26 14:10:20 +00002826void sqlite3pager_dont_rollback(void *pData){
drh30e58752002-03-02 20:41:57 +00002827 PgHdr *pPg = DATA_TO_PGHDR(pData);
2828 Pager *pPager = pPg->pPager;
2829
drha6abd042004-06-09 17:37:22 +00002830 if( pPager->state!=PAGER_EXCLUSIVE || pPager->journalOpen==0 ) return;
drhb7f91642004-10-31 02:22:47 +00002831 if( pPg->alwaysRollback || pPager->alwaysRollback || MEMDB ) return;
drh30e58752002-03-02 20:41:57 +00002832 if( !pPg->inJournal && (int)pPg->pgno <= pPager->origDbSize ){
2833 assert( pPager->aInJournal!=0 );
2834 pPager->aInJournal[pPg->pgno/8] |= 1<<(pPg->pgno&7);
2835 pPg->inJournal = 1;
drhac69b052004-05-12 13:30:07 +00002836 if( pPager->stmtInUse ){
2837 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drh3aac2dd2004-04-26 14:10:20 +00002838 page_add_to_stmt_list(pPg);
drh30e58752002-03-02 20:41:57 +00002839 }
danielk1977ef73ee92004-11-06 12:26:07 +00002840 TRACE3("DONT_ROLLBACK page %d of %d\n", pPg->pgno, PAGERID(pPager));
drh30e58752002-03-02 20:41:57 +00002841 }
drhac69b052004-05-12 13:30:07 +00002842 if( pPager->stmtInUse && !pPg->inStmt && (int)pPg->pgno<=pPager->stmtSize ){
drh30e58752002-03-02 20:41:57 +00002843 assert( pPg->inJournal || (int)pPg->pgno>pPager->origDbSize );
drhac69b052004-05-12 13:30:07 +00002844 assert( pPager->aInStmt!=0 );
2845 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drh3aac2dd2004-04-26 14:10:20 +00002846 page_add_to_stmt_list(pPg);
drh30e58752002-03-02 20:41:57 +00002847 }
2848}
2849
drhac69b052004-05-12 13:30:07 +00002850
danielk197793758c82005-01-21 08:13:14 +00002851#ifndef SQLITE_OMIT_MEMORYDB
drhac69b052004-05-12 13:30:07 +00002852/*
2853** Clear a PgHistory block
2854*/
2855static void clearHistory(PgHistory *pHist){
2856 sqliteFree(pHist->pOrig);
2857 sqliteFree(pHist->pStmt);
2858 pHist->pOrig = 0;
2859 pHist->pStmt = 0;
2860}
danielk197793758c82005-01-21 08:13:14 +00002861#else
2862#define clearHistory(x)
2863#endif
drhac69b052004-05-12 13:30:07 +00002864
drh30e58752002-03-02 20:41:57 +00002865/*
drhed7c8552001-04-11 14:29:21 +00002866** Commit all changes to the database and release the write lock.
drhd9b02572001-04-15 00:37:09 +00002867**
2868** If the commit fails for any reason, a rollback attempt is made
2869** and an error code is returned. If the commit worked, SQLITE_OK
2870** is returned.
drhed7c8552001-04-11 14:29:21 +00002871*/
drh3aac2dd2004-04-26 14:10:20 +00002872int sqlite3pager_commit(Pager *pPager){
drha1b351a2001-09-14 16:42:12 +00002873 int rc;
drhed7c8552001-04-11 14:29:21 +00002874 PgHdr *pPg;
drhd9b02572001-04-15 00:37:09 +00002875
2876 if( pPager->errMask==PAGER_ERR_FULL ){
drh3aac2dd2004-04-26 14:10:20 +00002877 rc = sqlite3pager_rollback(pPager);
drh4e371ee2002-09-05 16:08:27 +00002878 if( rc==SQLITE_OK ){
2879 rc = SQLITE_FULL;
2880 }
drhd9b02572001-04-15 00:37:09 +00002881 return rc;
2882 }
2883 if( pPager->errMask!=0 ){
2884 rc = pager_errcode(pPager);
2885 return rc;
2886 }
drha6abd042004-06-09 17:37:22 +00002887 if( pPager->state<PAGER_RESERVED ){
drhd9b02572001-04-15 00:37:09 +00002888 return SQLITE_ERROR;
2889 }
danielk1977ef73ee92004-11-06 12:26:07 +00002890 TRACE2("COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00002891 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00002892 pPg = pager_get_all_dirty_pages(pPager);
2893 while( pPg ){
2894 clearHistory(PGHDR_TO_HIST(pPg, pPager));
2895 pPg->dirty = 0;
2896 pPg->inJournal = 0;
2897 pPg->inStmt = 0;
2898 pPg->pPrevStmt = pPg->pNextStmt = 0;
2899 pPg = pPg->pDirty;
2900 }
danielk1977eac7a362004-06-16 07:45:24 +00002901#ifndef NDEBUG
2902 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2903 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
2904 assert( !pPg->alwaysRollback );
2905 assert( !pHist->pOrig );
2906 assert( !pHist->pStmt );
2907 }
2908#endif
drhac69b052004-05-12 13:30:07 +00002909 pPager->pStmt = 0;
drha6abd042004-06-09 17:37:22 +00002910 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00002911 return SQLITE_OK;
2912 }
drha6abd042004-06-09 17:37:22 +00002913 if( pPager->dirtyCache==0 ){
danielk19774adee202004-05-08 08:23:19 +00002914 /* Exit early (without doing the time-consuming sqlite3OsSync() calls)
drha1680452002-04-18 01:56:57 +00002915 ** if there have been no changes to the database file. */
drh341eae82003-01-21 02:39:36 +00002916 assert( pPager->needSync==0 );
drha1680452002-04-18 01:56:57 +00002917 rc = pager_unwritelock(pPager);
2918 pPager->dbSize = -1;
2919 return rc;
2920 }
drhda47d772002-12-02 04:25:19 +00002921 assert( pPager->journalOpen );
danielk1977d761c0c2004-11-05 16:37:02 +00002922 rc = sqlite3pager_sync(pPager, 0, 0);
drha6abd042004-06-09 17:37:22 +00002923 if( rc!=SQLITE_OK ){
2924 goto commit_abort;
2925 }
drhd9b02572001-04-15 00:37:09 +00002926 rc = pager_unwritelock(pPager);
2927 pPager->dbSize = -1;
2928 return rc;
2929
2930 /* Jump here if anything goes wrong during the commit process.
2931 */
2932commit_abort:
drh92f02c32004-09-02 14:57:08 +00002933 sqlite3pager_rollback(pPager);
drhed7c8552001-04-11 14:29:21 +00002934 return rc;
2935}
2936
2937/*
drha6abd042004-06-09 17:37:22 +00002938** Rollback all changes. The database falls back to PAGER_SHARED mode.
drhed7c8552001-04-11 14:29:21 +00002939** All in-memory cache pages revert to their original data contents.
2940** The journal is deleted.
drhd9b02572001-04-15 00:37:09 +00002941**
2942** This routine cannot fail unless some other process is not following
2943** the correct locking protocol (SQLITE_PROTOCOL) or unless some other
2944** process is writing trash into the journal file (SQLITE_CORRUPT) or
2945** unless a prior malloc() failed (SQLITE_NOMEM). Appropriate error
2946** codes are returned for all these occasions. Otherwise,
2947** SQLITE_OK is returned.
drhed7c8552001-04-11 14:29:21 +00002948*/
drh3aac2dd2004-04-26 14:10:20 +00002949int sqlite3pager_rollback(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +00002950 int rc;
danielk1977ef73ee92004-11-06 12:26:07 +00002951 TRACE2("ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00002952 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00002953 PgHdr *p;
2954 for(p=pPager->pAll; p; p=p->pNextAll){
2955 PgHistory *pHist;
danielk1977eac7a362004-06-16 07:45:24 +00002956 assert( !p->alwaysRollback );
2957 if( !p->dirty ){
2958 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pOrig );
2959 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pStmt );
2960 continue;
2961 }
2962
drhac69b052004-05-12 13:30:07 +00002963 pHist = PGHDR_TO_HIST(p, pPager);
2964 if( pHist->pOrig ){
2965 memcpy(PGHDR_TO_DATA(p), pHist->pOrig, pPager->pageSize);
danielk1977ef73ee92004-11-06 12:26:07 +00002966 TRACE3("ROLLBACK-PAGE %d of %d\n", p->pgno, PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00002967 }else{
danielk1977ef73ee92004-11-06 12:26:07 +00002968 TRACE3("PAGE %d is clean on %d\n", p->pgno, PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00002969 }
2970 clearHistory(pHist);
2971 p->dirty = 0;
2972 p->inJournal = 0;
2973 p->inStmt = 0;
2974 p->pPrevStmt = p->pNextStmt = 0;
danielk1977369f27e2004-06-15 11:40:04 +00002975
2976 if( pPager->xReiniter ){
2977 pPager->xReiniter(PGHDR_TO_DATA(p), pPager->pageSize);
2978 }
2979
drhac69b052004-05-12 13:30:07 +00002980 }
2981 pPager->pStmt = 0;
2982 pPager->dbSize = pPager->origDbSize;
2983 memoryTruncate(pPager);
2984 pPager->stmtInUse = 0;
drha6abd042004-06-09 17:37:22 +00002985 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00002986 return SQLITE_OK;
2987 }
2988
drha6abd042004-06-09 17:37:22 +00002989 if( !pPager->dirtyCache || !pPager->journalOpen ){
drhda47d772002-12-02 04:25:19 +00002990 rc = pager_unwritelock(pPager);
2991 pPager->dbSize = -1;
2992 return rc;
2993 }
drhdb48ee02003-01-16 13:42:43 +00002994
drhd9b02572001-04-15 00:37:09 +00002995 if( pPager->errMask!=0 && pPager->errMask!=PAGER_ERR_FULL ){
drha6abd042004-06-09 17:37:22 +00002996 if( pPager->state>=PAGER_EXCLUSIVE ){
danielk197776572402004-06-25 02:38:54 +00002997 pager_playback(pPager);
drh4b845d72002-03-05 12:41:19 +00002998 }
drhd9b02572001-04-15 00:37:09 +00002999 return pager_errcode(pPager);
drhed7c8552001-04-11 14:29:21 +00003000 }
drha6abd042004-06-09 17:37:22 +00003001 if( pPager->state==PAGER_RESERVED ){
drhcb4c40b2004-08-18 19:09:43 +00003002 int rc2, rc3;
drha6abd042004-06-09 17:37:22 +00003003 rc = pager_reload_cache(pPager);
drhcb4c40b2004-08-18 19:09:43 +00003004 rc2 = pager_truncate(pPager, pPager->origDbSize);
3005 rc3 = pager_unwritelock(pPager);
drha6abd042004-06-09 17:37:22 +00003006 if( rc==SQLITE_OK ){
3007 rc = rc2;
drhcb4c40b2004-08-18 19:09:43 +00003008 if( rc3 ) rc = rc3;
drha6abd042004-06-09 17:37:22 +00003009 }
3010 }else{
danielk197776572402004-06-25 02:38:54 +00003011 rc = pager_playback(pPager);
drhd9b02572001-04-15 00:37:09 +00003012 }
drhd9b02572001-04-15 00:37:09 +00003013 if( rc!=SQLITE_OK ){
drhee696e22004-08-30 16:52:17 +00003014 rc = SQLITE_CORRUPT; /* bkpt-CORRUPT */
drhd9b02572001-04-15 00:37:09 +00003015 pPager->errMask |= PAGER_ERR_CORRUPT;
3016 }
3017 pPager->dbSize = -1;
drhed7c8552001-04-11 14:29:21 +00003018 return rc;
drh98808ba2001-10-18 12:34:46 +00003019}
drhd9b02572001-04-15 00:37:09 +00003020
3021/*
drh5e00f6c2001-09-13 13:46:56 +00003022** Return TRUE if the database file is opened read-only. Return FALSE
3023** if the database is (in theory) writable.
3024*/
drh3aac2dd2004-04-26 14:10:20 +00003025int sqlite3pager_isreadonly(Pager *pPager){
drhbe0072d2001-09-13 14:46:09 +00003026 return pPager->readOnly;
drh5e00f6c2001-09-13 13:46:56 +00003027}
3028
3029/*
drhd9b02572001-04-15 00:37:09 +00003030** This routine is used for testing and analysis only.
3031*/
drh3aac2dd2004-04-26 14:10:20 +00003032int *sqlite3pager_stats(Pager *pPager){
danielk197742741be2005-01-08 12:42:39 +00003033 static int a[11];
drhd9b02572001-04-15 00:37:09 +00003034 a[0] = pPager->nRef;
3035 a[1] = pPager->nPage;
3036 a[2] = pPager->mxPage;
3037 a[3] = pPager->dbSize;
3038 a[4] = pPager->state;
3039 a[5] = pPager->errMask;
3040 a[6] = pPager->nHit;
3041 a[7] = pPager->nMiss;
3042 a[8] = pPager->nOvfl;
danielk197742741be2005-01-08 12:42:39 +00003043 a[9] = pPager->nRead;
3044 a[10] = pPager->nWrite;
drhd9b02572001-04-15 00:37:09 +00003045 return a;
3046}
drhdd793422001-06-28 01:54:48 +00003047
drhfa86c412002-02-02 15:01:15 +00003048/*
drhac69b052004-05-12 13:30:07 +00003049** Set the statement rollback point.
drhfa86c412002-02-02 15:01:15 +00003050**
3051** This routine should be called with the transaction journal already
drhac69b052004-05-12 13:30:07 +00003052** open. A new statement journal is created that can be used to rollback
drhaaab5722002-02-19 13:39:21 +00003053** changes of a single SQL command within a larger transaction.
drhfa86c412002-02-02 15:01:15 +00003054*/
drh3aac2dd2004-04-26 14:10:20 +00003055int sqlite3pager_stmt_begin(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00003056 int rc;
3057 char zTemp[SQLITE_TEMPNAME_SIZE];
drhac69b052004-05-12 13:30:07 +00003058 assert( !pPager->stmtInUse );
drhdc3ff9c2004-08-18 02:10:15 +00003059 assert( pPager->dbSize>=0 );
danielk1977ef73ee92004-11-06 12:26:07 +00003060 TRACE2("STMT-BEGIN %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003061 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00003062 pPager->stmtInUse = 1;
3063 pPager->stmtSize = pPager->dbSize;
3064 return SQLITE_OK;
3065 }
drhda47d772002-12-02 04:25:19 +00003066 if( !pPager->journalOpen ){
drhac69b052004-05-12 13:30:07 +00003067 pPager->stmtAutoopen = 1;
drhda47d772002-12-02 04:25:19 +00003068 return SQLITE_OK;
3069 }
drhfa86c412002-02-02 15:01:15 +00003070 assert( pPager->journalOpen );
drhac69b052004-05-12 13:30:07 +00003071 pPager->aInStmt = sqliteMalloc( pPager->dbSize/8 + 1 );
3072 if( pPager->aInStmt==0 ){
danielk19779eed5052004-06-04 10:38:30 +00003073 sqlite3OsLock(&pPager->fd, SHARED_LOCK);
drhfa86c412002-02-02 15:01:15 +00003074 return SQLITE_NOMEM;
3075 }
drh968af522003-02-11 14:55:40 +00003076#ifndef NDEBUG
drhac69b052004-05-12 13:30:07 +00003077 rc = sqlite3OsFileSize(&pPager->jfd, &pPager->stmtJSize);
3078 if( rc ) goto stmt_begin_failed;
danielk197776572402004-06-25 02:38:54 +00003079 assert( pPager->stmtJSize == pPager->journalOff );
drh968af522003-02-11 14:55:40 +00003080#endif
danielk197776572402004-06-25 02:38:54 +00003081 pPager->stmtJSize = pPager->journalOff;
drhac69b052004-05-12 13:30:07 +00003082 pPager->stmtSize = pPager->dbSize;
danielk197776572402004-06-25 02:38:54 +00003083 pPager->stmtHdrOff = 0;
danielk197775edc162004-06-26 01:48:18 +00003084 pPager->stmtCksum = pPager->cksumInit;
drhac69b052004-05-12 13:30:07 +00003085 if( !pPager->stmtOpen ){
3086 rc = sqlite3pager_opentemp(zTemp, &pPager->stfd);
3087 if( rc ) goto stmt_begin_failed;
3088 pPager->stmtOpen = 1;
3089 pPager->stmtNRec = 0;
drh0f892532002-05-30 12:27:03 +00003090 }
drhac69b052004-05-12 13:30:07 +00003091 pPager->stmtInUse = 1;
drhfa86c412002-02-02 15:01:15 +00003092 return SQLITE_OK;
3093
drhac69b052004-05-12 13:30:07 +00003094stmt_begin_failed:
3095 if( pPager->aInStmt ){
3096 sqliteFree(pPager->aInStmt);
3097 pPager->aInStmt = 0;
drhfa86c412002-02-02 15:01:15 +00003098 }
3099 return rc;
3100}
3101
3102/*
drhac69b052004-05-12 13:30:07 +00003103** Commit a statement.
drhfa86c412002-02-02 15:01:15 +00003104*/
drh3aac2dd2004-04-26 14:10:20 +00003105int sqlite3pager_stmt_commit(Pager *pPager){
drhac69b052004-05-12 13:30:07 +00003106 if( pPager->stmtInUse ){
drh03eb96a2002-11-10 23:32:56 +00003107 PgHdr *pPg, *pNext;
danielk1977ef73ee92004-11-06 12:26:07 +00003108 TRACE2("STMT-COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003109 if( !MEMDB ){
drhac69b052004-05-12 13:30:07 +00003110 sqlite3OsSeek(&pPager->stfd, 0);
3111 /* sqlite3OsTruncate(&pPager->stfd, 0); */
3112 sqliteFree( pPager->aInStmt );
3113 pPager->aInStmt = 0;
drh663fc632002-02-02 18:49:19 +00003114 }
drhac69b052004-05-12 13:30:07 +00003115 for(pPg=pPager->pStmt; pPg; pPg=pNext){
3116 pNext = pPg->pNextStmt;
3117 assert( pPg->inStmt );
3118 pPg->inStmt = 0;
3119 pPg->pPrevStmt = pPg->pNextStmt = 0;
drhb7f91642004-10-31 02:22:47 +00003120 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00003121 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
3122 sqliteFree(pHist->pStmt);
3123 pHist->pStmt = 0;
3124 }
3125 }
3126 pPager->stmtNRec = 0;
3127 pPager->stmtInUse = 0;
3128 pPager->pStmt = 0;
drh663fc632002-02-02 18:49:19 +00003129 }
drhac69b052004-05-12 13:30:07 +00003130 pPager->stmtAutoopen = 0;
drhfa86c412002-02-02 15:01:15 +00003131 return SQLITE_OK;
3132}
3133
3134/*
drhac69b052004-05-12 13:30:07 +00003135** Rollback a statement.
drhfa86c412002-02-02 15:01:15 +00003136*/
drh3aac2dd2004-04-26 14:10:20 +00003137int sqlite3pager_stmt_rollback(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00003138 int rc;
drhac69b052004-05-12 13:30:07 +00003139 if( pPager->stmtInUse ){
danielk1977ef73ee92004-11-06 12:26:07 +00003140 TRACE2("STMT-ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003141 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00003142 PgHdr *pPg;
3143 for(pPg=pPager->pStmt; pPg; pPg=pPg->pNextStmt){
3144 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
3145 if( pHist->pStmt ){
3146 memcpy(PGHDR_TO_DATA(pPg), pHist->pStmt, pPager->pageSize);
3147 sqliteFree(pHist->pStmt);
3148 pHist->pStmt = 0;
3149 }
3150 }
3151 pPager->dbSize = pPager->stmtSize;
3152 memoryTruncate(pPager);
3153 rc = SQLITE_OK;
3154 }else{
3155 rc = pager_stmt_playback(pPager);
3156 }
drh3aac2dd2004-04-26 14:10:20 +00003157 sqlite3pager_stmt_commit(pPager);
drh663fc632002-02-02 18:49:19 +00003158 }else{
3159 rc = SQLITE_OK;
3160 }
drhac69b052004-05-12 13:30:07 +00003161 pPager->stmtAutoopen = 0;
drhfa86c412002-02-02 15:01:15 +00003162 return rc;
3163}
3164
drh73509ee2003-04-06 20:44:45 +00003165/*
3166** Return the full pathname of the database file.
3167*/
drh3aac2dd2004-04-26 14:10:20 +00003168const char *sqlite3pager_filename(Pager *pPager){
drh73509ee2003-04-06 20:44:45 +00003169 return pPager->zFilename;
3170}
3171
drhb20ea9d2004-02-09 01:20:36 +00003172/*
danielk19775865e3d2004-06-14 06:03:57 +00003173** Return the directory of the database file.
3174*/
3175const char *sqlite3pager_dirname(Pager *pPager){
3176 return pPager->zDirectory;
3177}
3178
3179/*
3180** Return the full pathname of the journal file.
3181*/
3182const char *sqlite3pager_journalname(Pager *pPager){
3183 return pPager->zJournal;
3184}
3185
3186/*
drhb20ea9d2004-02-09 01:20:36 +00003187** Set the codec for this pager
3188*/
drh3aac2dd2004-04-26 14:10:20 +00003189void sqlite3pager_set_codec(
drhb20ea9d2004-02-09 01:20:36 +00003190 Pager *pPager,
drh9eb9e262004-02-11 02:18:05 +00003191 void (*xCodec)(void*,void*,Pgno,int),
drhb20ea9d2004-02-09 01:20:36 +00003192 void *pCodecArg
3193){
3194 pPager->xCodec = xCodec;
3195 pPager->pCodecArg = pCodecArg;
3196}
3197
danielk197713adf8a2004-06-03 16:08:41 +00003198/*
danielk1977aa5ccdf2004-06-14 05:10:42 +00003199** This routine is called to increment the database file change-counter,
3200** stored at byte 24 of the pager file.
3201*/
3202static int pager_incr_changecounter(Pager *pPager){
3203 void *pPage;
3204 PgHdr *pPgHdr;
3205 u32 change_counter;
3206 int rc;
3207
3208 /* Open page 1 of the file for writing. */
3209 rc = sqlite3pager_get(pPager, 1, &pPage);
3210 if( rc!=SQLITE_OK ) return rc;
3211 rc = sqlite3pager_write(pPage);
3212 if( rc!=SQLITE_OK ) return rc;
3213
3214 /* Read the current value at byte 24. */
3215 pPgHdr = DATA_TO_PGHDR(pPage);
3216 change_counter = retrieve32bits(pPgHdr, 24);
3217
3218 /* Increment the value just read and write it back to byte 24. */
3219 change_counter++;
3220 store32bits(change_counter, pPgHdr, 24);
3221
3222 /* Release the page reference. */
3223 sqlite3pager_unref(pPage);
3224 return SQLITE_OK;
3225}
3226
3227/*
danielk197713adf8a2004-06-03 16:08:41 +00003228** Sync the database file for the pager pPager. zMaster points to the name
3229** of a master journal file that should be written into the individual
3230** journal file. zMaster may be NULL, which is interpreted as no master
3231** journal (a single database transaction).
3232**
3233** This routine ensures that the journal is synced, all dirty pages written
3234** to the database file and the database file synced. The only thing that
3235** remains to commit the transaction is to delete the journal file (or
3236** master journal file if specified).
3237**
3238** Note that if zMaster==NULL, this does not overwrite a previous value
3239** passed to an sqlite3pager_sync() call.
danielk1977d761c0c2004-11-05 16:37:02 +00003240**
3241** If parameter nTrunc is non-zero, then the pager file is truncated to
3242** nTrunc pages (this is used by auto-vacuum databases).
danielk197713adf8a2004-06-03 16:08:41 +00003243*/
danielk1977d761c0c2004-11-05 16:37:02 +00003244int sqlite3pager_sync(Pager *pPager, const char *zMaster, Pgno nTrunc){
danielk197713adf8a2004-06-03 16:08:41 +00003245 int rc = SQLITE_OK;
3246
danielk1977ef73ee92004-11-06 12:26:07 +00003247 TRACE4("DATABASE SYNC: File=%s zMaster=%s nTrunc=%d\n",
3248 pPager->zFilename, zMaster, nTrunc);
3249
danielk1977aa5ccdf2004-06-14 05:10:42 +00003250 /* If this is an in-memory db, or no pages have been written to, or this
3251 ** function has already been called, it is a no-op.
danielk197713adf8a2004-06-03 16:08:41 +00003252 */
drhb7f91642004-10-31 02:22:47 +00003253 if( pPager->state!=PAGER_SYNCED && !MEMDB && pPager->dirtyCache ){
danielk197713adf8a2004-06-03 16:08:41 +00003254 PgHdr *pPg;
3255 assert( pPager->journalOpen );
3256
danielk197776572402004-06-25 02:38:54 +00003257 /* If a master journal file name has already been written to the
3258 ** journal file, then no sync is required. This happens when it is
3259 ** written, then the process fails to upgrade from a RESERVED to an
3260 ** EXCLUSIVE lock. The next time the process tries to commit the
3261 ** transaction the m-j name will have already been written.
3262 */
3263 if( !pPager->setMaster ){
3264 rc = pager_incr_changecounter(pPager);
3265 if( rc!=SQLITE_OK ) goto sync_exit;
danielk1977ef73ee92004-11-06 12:26:07 +00003266#ifndef SQLITE_OMIT_AUTOVACUUM
3267 if( nTrunc!=0 ){
3268 /* If this transaction has made the database smaller, then all pages
3269 ** being discarded by the truncation must be written to the journal
3270 ** file.
3271 */
3272 Pgno i;
3273 void *pPage;
3274 for( i=nTrunc+1; i<=pPager->origDbSize; i++ ){
3275 if( !(pPager->aInJournal[i/8] & (1<<(i&7))) ){
3276 rc = sqlite3pager_get(pPager, i, &pPage);
3277 if( rc!=SQLITE_OK ) goto sync_exit;
3278 rc = sqlite3pager_write(pPage);
3279 sqlite3pager_unref(pPage);
3280 if( rc!=SQLITE_OK ) goto sync_exit;
3281 }
3282 }
3283 }
3284#endif
danielk197776572402004-06-25 02:38:54 +00003285 rc = writeMasterJournal(pPager, zMaster);
3286 if( rc!=SQLITE_OK ) goto sync_exit;
3287 rc = syncJournal(pPager);
3288 if( rc!=SQLITE_OK ) goto sync_exit;
3289 }
danielk197713adf8a2004-06-03 16:08:41 +00003290
danielk1977d761c0c2004-11-05 16:37:02 +00003291#ifndef SQLITE_OMIT_AUTOVACUUM
3292 if( nTrunc!=0 ){
3293 rc = sqlite3pager_truncate(pPager, nTrunc);
3294 if( rc!=SQLITE_OK ) goto sync_exit;
3295 }
3296#endif
3297
danielk197713adf8a2004-06-03 16:08:41 +00003298 /* Write all dirty pages to the database file */
3299 pPg = pager_get_all_dirty_pages(pPager);
3300 rc = pager_write_pagelist(pPg);
3301 if( rc!=SQLITE_OK ) goto sync_exit;
3302
danielk1977aa5ccdf2004-06-14 05:10:42 +00003303 /* Sync the database file. */
3304 if( !pPager->noSync ){
danielk197713adf8a2004-06-03 16:08:41 +00003305 rc = sqlite3OsSync(&pPager->fd);
3306 }
danielk1977aa5ccdf2004-06-14 05:10:42 +00003307
3308 pPager->state = PAGER_SYNCED;
danielk197713adf8a2004-06-03 16:08:41 +00003309 }
3310
3311sync_exit:
3312 return rc;
3313}
3314
danielk1977687566d2004-11-02 12:56:41 +00003315#ifndef SQLITE_OMIT_AUTOVACUUM
3316/*
3317** Move the page identified by pData to location pgno in the file.
3318**
3319** There must be no references to the current page pgno. If current page
3320** pgno is not already in the rollback journal, it is not written there by
3321** by this routine. The same applies to the page pData refers to on entry to
3322** this routine.
3323**
3324** References to the page refered to by pData remain valid. Updating any
3325** meta-data associated with page pData (i.e. data stored in the nExtra bytes
3326** allocated along with the page) is the responsibility of the caller.
3327**
3328** A transaction must be active when this routine is called, however it is
3329** illegal to call this routine if a statment transaction is active.
3330*/
3331int sqlite3pager_movepage(Pager *pPager, void *pData, Pgno pgno){
3332 PgHdr *pPg = DATA_TO_PGHDR(pData);
3333 PgHdr *pPgOld;
danielk1977f5fdda82004-11-03 08:44:05 +00003334 int h;
danielk197794daf7f2004-11-08 09:26:09 +00003335 Pgno needSyncPgno = 0;
danielk1977687566d2004-11-02 12:56:41 +00003336
3337 assert( !pPager->stmtInUse );
danielk1977687566d2004-11-02 12:56:41 +00003338 assert( pPg->nRef>0 );
3339
danielk1977599fcba2004-11-08 07:13:13 +00003340 TRACE5("MOVE %d page %d (needSync=%d) moves to %d\n",
3341 PAGERID(pPager), pPg->pgno, pPg->needSync, pgno);
danielk1977ef73ee92004-11-06 12:26:07 +00003342
danielk197794daf7f2004-11-08 09:26:09 +00003343 if( pPg->needSync ){
3344 needSyncPgno = pPg->pgno;
3345 assert( pPg->inJournal );
3346 assert( pPg->dirty );
danielk1977ae825582004-11-23 09:06:55 +00003347 assert( pPager->needSync );
danielk197794daf7f2004-11-08 09:26:09 +00003348 }
3349
danielk1977687566d2004-11-02 12:56:41 +00003350 /* Unlink pPg from it's hash-chain */
danielk1977f5fdda82004-11-03 08:44:05 +00003351 unlinkHashChain(pPager, pPg);
danielk1977687566d2004-11-02 12:56:41 +00003352
danielk1977ef73ee92004-11-06 12:26:07 +00003353 /* If the cache contains a page with page-number pgno, remove it
danielk1977599fcba2004-11-08 07:13:13 +00003354 ** from it's hash chain. Also, if the PgHdr.needSync was set for
3355 ** page pgno before the 'move' operation, it needs to be retained
3356 ** for the page moved there.
danielk1977f5fdda82004-11-03 08:44:05 +00003357 */
danielk1977687566d2004-11-02 12:56:41 +00003358 pPgOld = pager_lookup(pPager, pgno);
3359 if( pPgOld ){
danielk1977f5fdda82004-11-03 08:44:05 +00003360 assert( pPgOld->nRef==0 );
3361 unlinkHashChain(pPager, pPgOld);
3362 pPgOld->dirty = 0;
danielk1977ef73ee92004-11-06 12:26:07 +00003363 if( pPgOld->needSync ){
danielk197745901d62004-11-10 15:27:38 +00003364 assert( pPgOld->inJournal );
3365 pPg->inJournal = 1;
danielk1977ef73ee92004-11-06 12:26:07 +00003366 pPg->needSync = 1;
danielk1977ae825582004-11-23 09:06:55 +00003367 assert( pPager->needSync );
danielk1977ef73ee92004-11-06 12:26:07 +00003368 }
danielk1977687566d2004-11-02 12:56:41 +00003369 }
3370
danielk1977f5fdda82004-11-03 08:44:05 +00003371 /* Change the page number for pPg and insert it into the new hash-chain. */
3372 pPg->pgno = pgno;
3373 h = pager_hash(pgno);
3374 if( pPager->aHash[h] ){
3375 assert( pPager->aHash[h]->pPrevHash==0 );
3376 pPager->aHash[h]->pPrevHash = pPg;
3377 }
3378 pPg->pNextHash = pPager->aHash[h];
3379 pPager->aHash[h] = pPg;
3380 pPg->pPrevHash = 0;
3381
danielk1977687566d2004-11-02 12:56:41 +00003382 pPg->dirty = 1;
3383 pPager->dirtyCache = 1;
3384
danielk197794daf7f2004-11-08 09:26:09 +00003385 if( needSyncPgno ){
3386 /* If needSyncPgno is non-zero, then the journal file needs to be
3387 ** sync()ed before any data is written to database file page needSyncPgno.
3388 ** Currently, no such page exists in the page-cache and the
3389 ** Pager.aInJournal bit has been set. This needs to be remedied by loading
3390 ** the page into the pager-cache and setting the PgHdr.needSync flag.
danielk1977ae825582004-11-23 09:06:55 +00003391 **
3392 ** The sqlite3pager_get() call may cause the journal to sync. So make
3393 ** sure the Pager.needSync flag is set too.
danielk197794daf7f2004-11-08 09:26:09 +00003394 */
3395 int rc;
3396 void *pNeedSync;
danielk1977ae825582004-11-23 09:06:55 +00003397 assert( pPager->needSync );
danielk197794daf7f2004-11-08 09:26:09 +00003398 rc = sqlite3pager_get(pPager, needSyncPgno, &pNeedSync);
3399 if( rc!=SQLITE_OK ) return rc;
danielk1977ae825582004-11-23 09:06:55 +00003400 pPager->needSync = 1;
danielk197794daf7f2004-11-08 09:26:09 +00003401 DATA_TO_PGHDR(pNeedSync)->needSync = 1;
3402 DATA_TO_PGHDR(pNeedSync)->inJournal = 1;
3403 DATA_TO_PGHDR(pNeedSync)->dirty = 1;
3404 sqlite3pager_unref(pNeedSync);
3405 }
3406
danielk1977687566d2004-11-02 12:56:41 +00003407 return SQLITE_OK;
3408}
3409#endif
3410
dougcurrie81c95ef2004-06-18 23:21:47 +00003411#if defined(SQLITE_DEBUG) || defined(SQLITE_TEST)
drh89ac8c12004-06-09 14:17:20 +00003412/*
3413** Return the current state of the file lock for the given pager.
3414** The return value is one of NO_LOCK, SHARED_LOCK, RESERVED_LOCK,
3415** PENDING_LOCK, or EXCLUSIVE_LOCK.
3416*/
3417int sqlite3pager_lockstate(Pager *pPager){
danielk1977e3026632004-06-22 11:29:02 +00003418#ifdef OS_TEST
danielk19778a6c5502004-06-22 12:18:32 +00003419 return pPager->fd->fd.locktype;
danielk1977e3026632004-06-22 11:29:02 +00003420#else
drh89ac8c12004-06-09 14:17:20 +00003421 return pPager->fd.locktype;
danielk1977e3026632004-06-22 11:29:02 +00003422#endif
drh89ac8c12004-06-09 14:17:20 +00003423}
3424#endif
3425
danielk197793758c82005-01-21 08:13:14 +00003426#ifdef SQLITE_DEBUG
drhdd793422001-06-28 01:54:48 +00003427/*
3428** Print a listing of all referenced pages and their ref count.
3429*/
drh3aac2dd2004-04-26 14:10:20 +00003430void sqlite3pager_refdump(Pager *pPager){
drhdd793422001-06-28 01:54:48 +00003431 PgHdr *pPg;
3432 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
3433 if( pPg->nRef<=0 ) continue;
drhfe63d1c2004-09-08 20:13:04 +00003434 sqlite3DebugPrintf("PAGE %3d addr=%p nRef=%d\n",
3435 pPg->pgno, PGHDR_TO_DATA(pPg), pPg->nRef);
drhdd793422001-06-28 01:54:48 +00003436 }
3437}
3438#endif