blob: 334f578d0eb2e81a380d0b1be5be1e94027b1607 [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**
drh1f595712004-06-15 01:40:29 +000021** @(#) $Id: pager.c,v 1.127 2004/06/15 01:40:29 drh Exp $
drhed7c8552001-04-11 14:29:21 +000022*/
drh829e8022002-11-06 14:08:11 +000023#include "os.h" /* Must be first to enable large file support */
drhd9b02572001-04-15 00:37:09 +000024#include "sqliteInt.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
drhdb48ee02003-01-16 13:42:43 +000033static Pager *mainPager = 0;
34#define SET_PAGER(X) if( mainPager==0 ) mainPager = (X)
35#define CLR_PAGER(X) if( mainPager==(X) ) mainPager = 0
drh35d4c2f2004-06-10 01:30:59 +000036#define TRACE1(X) if( pPager==mainPager ) sqlite3DebugPrintf(X)
37#define TRACE2(X,Y) if( pPager==mainPager ) sqlite3DebugPrintf(X,Y)
38#define TRACE3(X,Y,Z) if( pPager==mainPager ) sqlite3DebugPrintf(X,Y,Z)
drhdb48ee02003-01-16 13:42:43 +000039#else
40#define SET_PAGER(X)
41#define CLR_PAGER(X)
42#define TRACE1(X)
43#define TRACE2(X,Y)
44#define TRACE3(X,Y,Z)
45#endif
46
47
48/*
drhed7c8552001-04-11 14:29:21 +000049** The page cache as a whole is always in one of the following
50** states:
51**
drha6abd042004-06-09 17:37:22 +000052** PAGER_UNLOCK The page cache is not currently reading or
drhed7c8552001-04-11 14:29:21 +000053** writing the database file. There is no
54** data held in memory. This is the initial
55** state.
56**
drha6abd042004-06-09 17:37:22 +000057** PAGER_SHARED The page cache is reading the database.
drhed7c8552001-04-11 14:29:21 +000058** Writing is not permitted. There can be
59** multiple readers accessing the same database
drh69688d52001-04-14 16:38:23 +000060** file at the same time.
drhed7c8552001-04-11 14:29:21 +000061**
drh726de592004-06-10 23:35:50 +000062** PAGER_RESERVED This process has reserved the database for writing
63** but has not yet made any changes. Only one process
64** at a time can reserve the database. The original
65** database file has not been modified so other
66** processes may still be reading the on-disk
drha6abd042004-06-09 17:37:22 +000067** database file.
68**
69** PAGER_EXCLUSIVE The page cache is writing the database.
drhed7c8552001-04-11 14:29:21 +000070** Access is exclusive. No other processes or
71** threads can be reading or writing while one
72** process is writing.
73**
danielk1977aa5ccdf2004-06-14 05:10:42 +000074** PAGER_SYNCED The pager moves to this state from PAGER_EXCLUSIVE
75** after all dirty pages have been written to the
76** database file and the file has been synced to
77** disk. All that remains to do is to remove the
78** journal file and the transaction will be
79** committed.
80**
drha6abd042004-06-09 17:37:22 +000081** The page cache comes up in PAGER_UNLOCK. The first time a
drh726de592004-06-10 23:35:50 +000082** sqlite3pager_get() occurs, the state transitions to PAGER_SHARED.
drhed7c8552001-04-11 14:29:21 +000083** After all pages have been released using sqlite_page_unref(),
drha6abd042004-06-09 17:37:22 +000084** the state transitions back to PAGER_UNLOCK. The first time
drh726de592004-06-10 23:35:50 +000085** that sqlite3pager_write() is called, the state transitions to
drha6abd042004-06-09 17:37:22 +000086** PAGER_RESERVED. (Note that sqlite_page_write() can only be
drh306dc212001-05-21 13:45:10 +000087** called on an outstanding page which means that the pager must
drha6abd042004-06-09 17:37:22 +000088** be in PAGER_SHARED before it transitions to PAGER_RESERVED.)
drh726de592004-06-10 23:35:50 +000089** The transition to PAGER_EXCLUSIVE occurs when before any changes
90** are made to the database file. After an sqlite3pager_rollback()
91** or sqlite_pager_commit(), the state goes back to PAGER_SHARED.
drhed7c8552001-04-11 14:29:21 +000092*/
drha6abd042004-06-09 17:37:22 +000093#define PAGER_UNLOCK 0
94#define PAGER_SHARED 1
95#define PAGER_RESERVED 2
96#define PAGER_EXCLUSIVE 3
danielk1977aa5ccdf2004-06-14 05:10:42 +000097#define PAGER_SYNCED 4
drhed7c8552001-04-11 14:29:21 +000098
drhd9b02572001-04-15 00:37:09 +000099
drhed7c8552001-04-11 14:29:21 +0000100/*
101** Each in-memory image of a page begins with the following header.
drhbd03cae2001-06-02 02:40:57 +0000102** This header is only visible to this pager module. The client
103** code that calls pager sees only the data that follows the header.
drhf6038712004-02-08 18:07:34 +0000104**
drh3aac2dd2004-04-26 14:10:20 +0000105** Client code should call sqlite3pager_write() on a page prior to making
106** any modifications to that page. The first time sqlite3pager_write()
drhf6038712004-02-08 18:07:34 +0000107** is called, the original page contents are written into the rollback
108** journal and PgHdr.inJournal and PgHdr.needSync are set. Later, once
109** the journal page has made it onto the disk surface, PgHdr.needSync
110** is cleared. The modified page cannot be written back into the original
111** database file until the journal pages has been synced to disk and the
112** PgHdr.needSync has been cleared.
113**
drh3aac2dd2004-04-26 14:10:20 +0000114** The PgHdr.dirty flag is set when sqlite3pager_write() is called and
drhf6038712004-02-08 18:07:34 +0000115** is cleared again when the page content is written back to the original
116** database file.
drhed7c8552001-04-11 14:29:21 +0000117*/
drhd9b02572001-04-15 00:37:09 +0000118typedef struct PgHdr PgHdr;
drhed7c8552001-04-11 14:29:21 +0000119struct PgHdr {
120 Pager *pPager; /* The pager to which this page belongs */
121 Pgno pgno; /* The page number for this page */
drh69688d52001-04-14 16:38:23 +0000122 PgHdr *pNextHash, *pPrevHash; /* Hash collision chain for PgHdr.pgno */
drhd9b02572001-04-15 00:37:09 +0000123 PgHdr *pNextFree, *pPrevFree; /* Freelist of pages where nRef==0 */
drhac69b052004-05-12 13:30:07 +0000124 PgHdr *pNextAll; /* A list of all pages */
125 PgHdr *pNextStmt, *pPrevStmt; /* List of pages in the statement journal */
drh193a6b42002-07-07 16:52:46 +0000126 u8 inJournal; /* TRUE if has been written to journal */
drhac69b052004-05-12 13:30:07 +0000127 u8 inStmt; /* TRUE if in the statement subjournal */
drh193a6b42002-07-07 16:52:46 +0000128 u8 dirty; /* TRUE if we need to write back changes */
drhdb48ee02003-01-16 13:42:43 +0000129 u8 needSync; /* Sync journal before writing this page */
drh193a6b42002-07-07 16:52:46 +0000130 u8 alwaysRollback; /* Disable dont_rollback() for this page */
drhac69b052004-05-12 13:30:07 +0000131 short int nRef; /* Number of users of this page */
drh2554f8b2003-01-22 01:26:44 +0000132 PgHdr *pDirty; /* Dirty pages sorted by PgHdr.pgno */
drhd0ba1932004-02-10 01:54:28 +0000133 /* SQLITE_PAGE_SIZE bytes of page data follow this header */
drh973b6e32003-02-12 14:09:42 +0000134 /* Pager.nExtra bytes of local data follow the page data */
drhed7c8552001-04-11 14:29:21 +0000135};
136
drhac69b052004-05-12 13:30:07 +0000137/*
138** For an in-memory only database, some extra information is recorded about
139** each page so that changes can be rolled back. (Journal files are not
140** used for in-memory databases.) The following information is added to
141** the end of every EXTRA block for in-memory databases.
142**
143** This information could have been added directly to the PgHdr structure.
144** But then it would take up an extra 8 bytes of storage on every PgHdr
145** even for disk-based databases. Splitting it out saves 8 bytes. This
146** is only a savings of 0.8% but those percentages add up.
147*/
148typedef struct PgHistory PgHistory;
149struct PgHistory {
150 u8 *pOrig; /* Original page text. Restore to this on a full rollback */
151 u8 *pStmt; /* Text as it was at the beginning of the current statement */
152};
drh9eb9e262004-02-11 02:18:05 +0000153
154/*
155** A macro used for invoking the codec if there is one
156*/
157#ifdef SQLITE_HAS_CODEC
158# define CODEC(P,D,N,X) if( P->xCodec ){ P->xCodec(P->pCodecArg,D,N,X); }
159#else
160# define CODEC(P,D,N,X)
161#endif
162
drhed7c8552001-04-11 14:29:21 +0000163/*
drh69688d52001-04-14 16:38:23 +0000164** Convert a pointer to a PgHdr into a pointer to its data
165** and back again.
drhed7c8552001-04-11 14:29:21 +0000166*/
167#define PGHDR_TO_DATA(P) ((void*)(&(P)[1]))
168#define DATA_TO_PGHDR(D) (&((PgHdr*)(D))[-1])
drhd0ba1932004-02-10 01:54:28 +0000169#define PGHDR_TO_EXTRA(P) ((void*)&((char*)(&(P)[1]))[SQLITE_PAGE_SIZE])
drhac69b052004-05-12 13:30:07 +0000170#define PGHDR_TO_HIST(P,PGR) \
171 ((PgHistory*)&((char*)(&(P)[1]))[(PGR)->pageSize+(PGR)->nExtra])
drhed7c8552001-04-11 14:29:21 +0000172
173/*
drhed7c8552001-04-11 14:29:21 +0000174** How big to make the hash table used for locating in-memory pages
drh836faa42003-01-11 13:30:57 +0000175** by page number.
drhed7c8552001-04-11 14:29:21 +0000176*/
drh836faa42003-01-11 13:30:57 +0000177#define N_PG_HASH 2048
178
179/*
180** Hash a page number
181*/
182#define pager_hash(PN) ((PN)&(N_PG_HASH-1))
drhed7c8552001-04-11 14:29:21 +0000183
184/*
185** A open page cache is an instance of the following structure.
186*/
187struct Pager {
188 char *zFilename; /* Name of the database file */
189 char *zJournal; /* Name of the journal file */
drha76c82e2003-07-27 18:59:42 +0000190 char *zDirectory; /* Directory hold database and journal files */
drh8cfbf082001-09-19 13:22:39 +0000191 OsFile fd, jfd; /* File descriptors for database and journal */
drhac69b052004-05-12 13:30:07 +0000192 OsFile stfd; /* File descriptor for the statement subjournal*/
drhed7c8552001-04-11 14:29:21 +0000193 int dbSize; /* Number of pages in the file */
drh69688d52001-04-14 16:38:23 +0000194 int origDbSize; /* dbSize before the current change */
drhac69b052004-05-12 13:30:07 +0000195 int stmtSize; /* Size of database (in pages) at stmt_begin() */
196 off_t stmtJSize; /* Size of journal at stmt_begin() */
drh968af522003-02-11 14:55:40 +0000197 int nRec; /* Number of pages written to the journal */
198 u32 cksumInit; /* Quasi-random value added to every checksum */
drhac69b052004-05-12 13:30:07 +0000199 int stmtNRec; /* Number of records in stmt subjournal */
drh7e3b0a02001-04-28 16:52:40 +0000200 int nExtra; /* Add this many bytes to each in-memory page */
drhb6f41482004-05-14 01:58:11 +0000201 void (*xDestructor)(void*,int); /* Call this routine when freeing pages */
drha6abd042004-06-09 17:37:22 +0000202 void (*xReiniter)(void*,int); /* Call this routine when reloading pages */
drhb6f41482004-05-14 01:58:11 +0000203 int pageSize; /* Number of bytes in a page */
drhed7c8552001-04-11 14:29:21 +0000204 int nPage; /* Total number of in-memory pages */
drhd9b02572001-04-15 00:37:09 +0000205 int nRef; /* Number of in-memory pages with PgHdr.nRef>0 */
drhed7c8552001-04-11 14:29:21 +0000206 int mxPage; /* Maximum number of pages to hold in cache */
drhd9b02572001-04-15 00:37:09 +0000207 int nHit, nMiss, nOvfl; /* Cache hits, missing, and LRU overflows */
drh9eb9e262004-02-11 02:18:05 +0000208 void (*xCodec)(void*,void*,Pgno,int); /* Routine for en/decoding data */
drhb20ea9d2004-02-09 01:20:36 +0000209 void *pCodecArg; /* First argument to xCodec() */
drh603240c2002-03-05 01:11:12 +0000210 u8 journalOpen; /* True if journal file descriptors is valid */
drh34e79ce2004-02-08 06:05:46 +0000211 u8 journalStarted; /* True if header of journal is synced */
212 u8 useJournal; /* Use a rollback journal on this file */
drhac69b052004-05-12 13:30:07 +0000213 u8 stmtOpen; /* True if the statement subjournal is open */
214 u8 stmtInUse; /* True we are in a statement subtransaction */
215 u8 stmtAutoopen; /* Open stmt journal when main journal is opened*/
drh603240c2002-03-05 01:11:12 +0000216 u8 noSync; /* Do not sync the journal if true */
drh968af522003-02-11 14:55:40 +0000217 u8 fullSync; /* Do extra syncs of the journal for robustness */
drha6abd042004-06-09 17:37:22 +0000218 u8 state; /* PAGER_UNLOCK, _SHARED, _RESERVED, etc. */
drh603240c2002-03-05 01:11:12 +0000219 u8 errMask; /* One of several kinds of errors */
220 u8 tempFile; /* zFilename is a temporary file */
221 u8 readOnly; /* True for a read-only database */
222 u8 needSync; /* True if an fsync() is needed on the journal */
drha6abd042004-06-09 17:37:22 +0000223 u8 dirtyCache; /* True if cached pages have changed */
drh193a6b42002-07-07 16:52:46 +0000224 u8 alwaysRollback; /* Disable dont_rollback() for all pages */
drhac69b052004-05-12 13:30:07 +0000225 u8 memDb; /* True to inhibit all file I/O */
drh603240c2002-03-05 01:11:12 +0000226 u8 *aInJournal; /* One bit for each page in the database file */
drhac69b052004-05-12 13:30:07 +0000227 u8 *aInStmt; /* One bit for each page in the database */
drh726de592004-06-10 23:35:50 +0000228 int nMaster; /* Number of bytes to reserve for master j.p */
229 BusyHandler *pBusyHandler; /* Pointer to sqlite.busyHandler */
drhed7c8552001-04-11 14:29:21 +0000230 PgHdr *pFirst, *pLast; /* List of free pages */
drh341eae82003-01-21 02:39:36 +0000231 PgHdr *pFirstSynced; /* First free page with PgHdr.needSync==0 */
drhd9b02572001-04-15 00:37:09 +0000232 PgHdr *pAll; /* List of all pages */
drhac69b052004-05-12 13:30:07 +0000233 PgHdr *pStmt; /* List of pages in the statement subjournal */
drh726de592004-06-10 23:35:50 +0000234 PgHdr *aHash[N_PG_HASH]; /* Hash table to map page number to PgHdr */
drhd9b02572001-04-15 00:37:09 +0000235};
236
237/*
238** These are bits that can be set in Pager.errMask.
239*/
240#define PAGER_ERR_FULL 0x01 /* a write() failed */
241#define PAGER_ERR_MEM 0x02 /* malloc() failed */
242#define PAGER_ERR_LOCK 0x04 /* error in the locking protocol */
243#define PAGER_ERR_CORRUPT 0x08 /* database or journal corruption */
drh81a20f22001-10-12 17:30:04 +0000244#define PAGER_ERR_DISK 0x10 /* general disk I/O error - bad hard drive? */
drhd9b02572001-04-15 00:37:09 +0000245
246/*
drh5e00f6c2001-09-13 13:46:56 +0000247** Journal files begin with the following magic string. The data
248** was obtained from /dev/random. It is used only as a sanity check.
drh94f33312002-08-12 12:29:56 +0000249**
drhae2b40c2004-06-09 19:03:54 +0000250** Since version 2.8.0, the journal format contains additional sanity
251** checking information. If the power fails while the journal is begin
252** written, semi-random garbage data might appear in the journal
253** file after power is restored. If an attempt is then made
drh968af522003-02-11 14:55:40 +0000254** to roll the journal back, the database could be corrupted. The additional
255** sanity checking data is an attempt to discover the garbage in the
256** journal and ignore it.
257**
drhae2b40c2004-06-09 19:03:54 +0000258** The sanity checking information for the new journal format consists
drh968af522003-02-11 14:55:40 +0000259** of a 32-bit checksum on each page of data. The checksum covers both
drhd0ba1932004-02-10 01:54:28 +0000260** the page number and the SQLITE_PAGE_SIZE bytes of data for the page.
drh968af522003-02-11 14:55:40 +0000261** This cksum is initialized to a 32-bit random value that appears in the
262** journal file right after the header. The random initializer is important,
263** because garbage data that appears at the end of a journal is likely
264** data that was once in other files that have now been deleted. If the
265** garbage data came from an obsolete journal file, the checksums might
266** be correct. But by initializing the checksum to random value which
267** is different for every journal, we minimize that risk.
drhd9b02572001-04-15 00:37:09 +0000268*/
drhae2b40c2004-06-09 19:03:54 +0000269static const unsigned char aJournalMagic[] = {
270 0xd9, 0xd5, 0x05, 0xf9, 0x20, 0xa1, 0x63, 0xd7,
drhed7c8552001-04-11 14:29:21 +0000271};
272
273/*
drh726de592004-06-10 23:35:50 +0000274** The size of the header and of each page in the journal is determined
275** by the following macros.
drh968af522003-02-11 14:55:40 +0000276*/
drhae2b40c2004-06-09 19:03:54 +0000277#define JOURNAL_HDR_SZ(pPager) (24 + (pPager)->nMaster)
278#define JOURNAL_PG_SZ(pPager) ((pPager->pageSize) + 8)
drh968af522003-02-11 14:55:40 +0000279
danielk197713adf8a2004-06-03 16:08:41 +0000280
drh968af522003-02-11 14:55:40 +0000281/*
drh726de592004-06-10 23:35:50 +0000282** Enable reference count tracking (for debugging) here:
drhdd793422001-06-28 01:54:48 +0000283*/
drh74587e52002-08-13 00:01:16 +0000284#ifdef SQLITE_TEST
drh3aac2dd2004-04-26 14:10:20 +0000285 int pager3_refinfo_enable = 0;
drhdd793422001-06-28 01:54:48 +0000286 static void pager_refinfo(PgHdr *p){
287 static int cnt = 0;
drh3aac2dd2004-04-26 14:10:20 +0000288 if( !pager3_refinfo_enable ) return;
drhdd793422001-06-28 01:54:48 +0000289 printf(
290 "REFCNT: %4d addr=0x%08x nRef=%d\n",
291 p->pgno, (int)PGHDR_TO_DATA(p), p->nRef
292 );
293 cnt++; /* Something to set a breakpoint on */
294 }
295# define REFINFO(X) pager_refinfo(X)
296#else
297# define REFINFO(X)
298#endif
299
300/*
drh34e79ce2004-02-08 06:05:46 +0000301** Read a 32-bit integer from the given file descriptor. Store the integer
302** that is read in *pRes. Return SQLITE_OK if everything worked, or an
303** error code is something goes wrong.
drh726de592004-06-10 23:35:50 +0000304**
305** All values are stored on disk as big-endian.
drh94f33312002-08-12 12:29:56 +0000306*/
drhae2b40c2004-06-09 19:03:54 +0000307static int read32bits(OsFile *fd, u32 *pRes){
drh94f33312002-08-12 12:29:56 +0000308 u32 res;
309 int rc;
danielk19774adee202004-05-08 08:23:19 +0000310 rc = sqlite3OsRead(fd, &res, sizeof(res));
drhae2b40c2004-06-09 19:03:54 +0000311 if( rc==SQLITE_OK ){
drh94f33312002-08-12 12:29:56 +0000312 unsigned char ac[4];
313 memcpy(ac, &res, 4);
314 res = (ac[0]<<24) | (ac[1]<<16) | (ac[2]<<8) | ac[3];
315 }
316 *pRes = res;
317 return rc;
318}
319
320/*
drh34e79ce2004-02-08 06:05:46 +0000321** Write a 32-bit integer into the given file descriptor. Return SQLITE_OK
322** on success or an error code is something goes wrong.
drh94f33312002-08-12 12:29:56 +0000323*/
324static int write32bits(OsFile *fd, u32 val){
325 unsigned char ac[4];
drh94f33312002-08-12 12:29:56 +0000326 ac[0] = (val>>24) & 0xff;
327 ac[1] = (val>>16) & 0xff;
328 ac[2] = (val>>8) & 0xff;
329 ac[3] = val & 0xff;
danielk19774adee202004-05-08 08:23:19 +0000330 return sqlite3OsWrite(fd, ac, 4);
drh94f33312002-08-12 12:29:56 +0000331}
332
drh2554f8b2003-01-22 01:26:44 +0000333/*
danielk1977aa5ccdf2004-06-14 05:10:42 +0000334** Write the 32-bit integer 'val' into the page identified by page header
335** 'p' at offset 'offset'.
drh2554f8b2003-01-22 01:26:44 +0000336*/
drh968af522003-02-11 14:55:40 +0000337static void store32bits(u32 val, PgHdr *p, int offset){
drh2554f8b2003-01-22 01:26:44 +0000338 unsigned char *ac;
drhec1bd0b2003-08-26 11:41:27 +0000339 ac = &((unsigned char*)PGHDR_TO_DATA(p))[offset];
drhae2b40c2004-06-09 19:03:54 +0000340 ac[0] = (val>>24) & 0xff;
341 ac[1] = (val>>16) & 0xff;
342 ac[2] = (val>>8) & 0xff;
343 ac[3] = val & 0xff;
drh2554f8b2003-01-22 01:26:44 +0000344}
345
danielk1977aa5ccdf2004-06-14 05:10:42 +0000346/*
347** Read a 32-bit integer at offset 'offset' from the page identified by
348** page header 'p'.
349*/
350static u32 retrieve32bits(PgHdr *p, int offset){
351 unsigned char *ac;
352 ac = &((unsigned char*)PGHDR_TO_DATA(p))[offset];
353 return (ac[0]<<24) | (ac[1]<<16) | (ac[2]<<8) | ac[3];
354}
355
drh94f33312002-08-12 12:29:56 +0000356
357/*
drhd9b02572001-04-15 00:37:09 +0000358** Convert the bits in the pPager->errMask into an approprate
359** return code.
360*/
361static int pager_errcode(Pager *pPager){
362 int rc = SQLITE_OK;
363 if( pPager->errMask & PAGER_ERR_LOCK ) rc = SQLITE_PROTOCOL;
drh81a20f22001-10-12 17:30:04 +0000364 if( pPager->errMask & PAGER_ERR_DISK ) rc = SQLITE_IOERR;
drhd9b02572001-04-15 00:37:09 +0000365 if( pPager->errMask & PAGER_ERR_FULL ) rc = SQLITE_FULL;
366 if( pPager->errMask & PAGER_ERR_MEM ) rc = SQLITE_NOMEM;
367 if( pPager->errMask & PAGER_ERR_CORRUPT ) rc = SQLITE_CORRUPT;
368 return rc;
drhed7c8552001-04-11 14:29:21 +0000369}
370
371/*
drh03eb96a2002-11-10 23:32:56 +0000372** Add or remove a page from the list of all pages that are in the
drhac69b052004-05-12 13:30:07 +0000373** statement journal.
drh03eb96a2002-11-10 23:32:56 +0000374**
375** The Pager keeps a separate list of pages that are currently in
drhac69b052004-05-12 13:30:07 +0000376** the statement journal. This helps the sqlite3pager_stmt_commit()
drh03eb96a2002-11-10 23:32:56 +0000377** routine run MUCH faster for the common case where there are many
drhac69b052004-05-12 13:30:07 +0000378** pages in memory but only a few are in the statement journal.
drh03eb96a2002-11-10 23:32:56 +0000379*/
drh3aac2dd2004-04-26 14:10:20 +0000380static void page_add_to_stmt_list(PgHdr *pPg){
drh03eb96a2002-11-10 23:32:56 +0000381 Pager *pPager = pPg->pPager;
drhac69b052004-05-12 13:30:07 +0000382 if( pPg->inStmt ) return;
383 assert( pPg->pPrevStmt==0 && pPg->pNextStmt==0 );
384 pPg->pPrevStmt = 0;
385 if( pPager->pStmt ){
386 pPager->pStmt->pPrevStmt = pPg;
drh03eb96a2002-11-10 23:32:56 +0000387 }
drhac69b052004-05-12 13:30:07 +0000388 pPg->pNextStmt = pPager->pStmt;
389 pPager->pStmt = pPg;
390 pPg->inStmt = 1;
drh03eb96a2002-11-10 23:32:56 +0000391}
drh3aac2dd2004-04-26 14:10:20 +0000392static void page_remove_from_stmt_list(PgHdr *pPg){
drhac69b052004-05-12 13:30:07 +0000393 if( !pPg->inStmt ) return;
394 if( pPg->pPrevStmt ){
395 assert( pPg->pPrevStmt->pNextStmt==pPg );
396 pPg->pPrevStmt->pNextStmt = pPg->pNextStmt;
drh03eb96a2002-11-10 23:32:56 +0000397 }else{
drhac69b052004-05-12 13:30:07 +0000398 assert( pPg->pPager->pStmt==pPg );
399 pPg->pPager->pStmt = pPg->pNextStmt;
drh03eb96a2002-11-10 23:32:56 +0000400 }
drhac69b052004-05-12 13:30:07 +0000401 if( pPg->pNextStmt ){
402 assert( pPg->pNextStmt->pPrevStmt==pPg );
403 pPg->pNextStmt->pPrevStmt = pPg->pPrevStmt;
drh03eb96a2002-11-10 23:32:56 +0000404 }
drhac69b052004-05-12 13:30:07 +0000405 pPg->pNextStmt = 0;
406 pPg->pPrevStmt = 0;
407 pPg->inStmt = 0;
drh03eb96a2002-11-10 23:32:56 +0000408}
409
410/*
drhed7c8552001-04-11 14:29:21 +0000411** Find a page in the hash table given its page number. Return
412** a pointer to the page or NULL if not found.
413*/
drhd9b02572001-04-15 00:37:09 +0000414static PgHdr *pager_lookup(Pager *pPager, Pgno pgno){
drh836faa42003-01-11 13:30:57 +0000415 PgHdr *p = pPager->aHash[pager_hash(pgno)];
drhed7c8552001-04-11 14:29:21 +0000416 while( p && p->pgno!=pgno ){
417 p = p->pNextHash;
418 }
419 return p;
420}
421
422/*
423** Unlock the database and clear the in-memory cache. This routine
424** sets the state of the pager back to what it was when it was first
425** opened. Any outstanding pages are invalidated and subsequent attempts
426** to access those pages will likely result in a coredump.
427*/
drhd9b02572001-04-15 00:37:09 +0000428static void pager_reset(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +0000429 PgHdr *pPg, *pNext;
drhd9b02572001-04-15 00:37:09 +0000430 for(pPg=pPager->pAll; pPg; pPg=pNext){
431 pNext = pPg->pNextAll;
432 sqliteFree(pPg);
drhed7c8552001-04-11 14:29:21 +0000433 }
434 pPager->pFirst = 0;
drh341eae82003-01-21 02:39:36 +0000435 pPager->pFirstSynced = 0;
drhd9b02572001-04-15 00:37:09 +0000436 pPager->pLast = 0;
437 pPager->pAll = 0;
drhed7c8552001-04-11 14:29:21 +0000438 memset(pPager->aHash, 0, sizeof(pPager->aHash));
439 pPager->nPage = 0;
drha6abd042004-06-09 17:37:22 +0000440 if( pPager->state>=PAGER_RESERVED ){
drh3aac2dd2004-04-26 14:10:20 +0000441 sqlite3pager_rollback(pPager);
drhed7c8552001-04-11 14:29:21 +0000442 }
drha6abd042004-06-09 17:37:22 +0000443 sqlite3OsUnlock(&pPager->fd, NO_LOCK);
444 pPager->state = PAGER_UNLOCK;
drhd9b02572001-04-15 00:37:09 +0000445 pPager->dbSize = -1;
drhed7c8552001-04-11 14:29:21 +0000446 pPager->nRef = 0;
drh8cfbf082001-09-19 13:22:39 +0000447 assert( pPager->journalOpen==0 );
drhed7c8552001-04-11 14:29:21 +0000448}
449
450/*
451** When this routine is called, the pager has the journal file open and
drha6abd042004-06-09 17:37:22 +0000452** a RESERVED or EXCLUSIVE lock on the database. This routine releases
453** the database lock and acquires a SHARED lock in its place. The journal
454** file is deleted and closed.
drh50457892003-09-06 01:10:47 +0000455**
456** TODO: Consider keeping the journal file open for temporary databases.
457** This might give a performance improvement on windows where opening
458** a file is an expensive operation.
drhed7c8552001-04-11 14:29:21 +0000459*/
drhd9b02572001-04-15 00:37:09 +0000460static int pager_unwritelock(Pager *pPager){
drhd9b02572001-04-15 00:37:09 +0000461 PgHdr *pPg;
drha6abd042004-06-09 17:37:22 +0000462 if( pPager->state<PAGER_RESERVED ){
463 return SQLITE_OK;
464 }
drh3aac2dd2004-04-26 14:10:20 +0000465 sqlite3pager_stmt_commit(pPager);
drhac69b052004-05-12 13:30:07 +0000466 if( pPager->stmtOpen ){
467 sqlite3OsClose(&pPager->stfd);
468 pPager->stmtOpen = 0;
drh0f892532002-05-30 12:27:03 +0000469 }
drhda47d772002-12-02 04:25:19 +0000470 if( pPager->journalOpen ){
danielk19774adee202004-05-08 08:23:19 +0000471 sqlite3OsClose(&pPager->jfd);
drhda47d772002-12-02 04:25:19 +0000472 pPager->journalOpen = 0;
danielk19774adee202004-05-08 08:23:19 +0000473 sqlite3OsDelete(pPager->zJournal);
drhda47d772002-12-02 04:25:19 +0000474 sqliteFree( pPager->aInJournal );
475 pPager->aInJournal = 0;
476 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
477 pPg->inJournal = 0;
478 pPg->dirty = 0;
drhdb48ee02003-01-16 13:42:43 +0000479 pPg->needSync = 0;
drhda47d772002-12-02 04:25:19 +0000480 }
481 }else{
drha6abd042004-06-09 17:37:22 +0000482 assert( pPager->dirtyCache==0 || pPager->useJournal==0 );
drhd9b02572001-04-15 00:37:09 +0000483 }
drha6abd042004-06-09 17:37:22 +0000484 sqlite3OsUnlock(&pPager->fd, SHARED_LOCK);
485 pPager->state = PAGER_SHARED;
486 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +0000487}
488
drhed7c8552001-04-11 14:29:21 +0000489/*
drh968af522003-02-11 14:55:40 +0000490** Compute and return a checksum for the page of data.
drh34e79ce2004-02-08 06:05:46 +0000491**
492** This is not a real checksum. It is really just the sum of the
drh726de592004-06-10 23:35:50 +0000493** random initial value and the page number. We experimented with
494** a checksum of the entire data, but that was found to be too slow.
495**
496** Note that the page number is stored at the beginning of data and
497** the checksum is stored at the end. This is important. If journal
498** corruption occurs due to a power failure, the most likely scenario
499** is that one end or the other of the record will be changed. It is
500** much less likely that the two ends of the journal record will be
501** correct and the middle be corrupt. Thus, this "checksum" scheme,
502** though fast and simple, catches the mostly likely kind of corruption.
503**
504** FIX ME: Consider adding every 200th (or so) byte of the data to the
505** checksum. That way if a single page spans 3 or more disk sectors and
506** only the middle sector is corrupt, we will still have a reasonable
507** chance of failing the checksum and thus detecting the problem.
drh968af522003-02-11 14:55:40 +0000508*/
509static u32 pager_cksum(Pager *pPager, Pgno pgno, const char *aData){
510 u32 cksum = pPager->cksumInit + pgno;
drh968af522003-02-11 14:55:40 +0000511 return cksum;
512}
513
514/*
drhfa86c412002-02-02 15:01:15 +0000515** Read a single page from the journal file opened on file descriptor
516** jfd. Playback this one page.
drh968af522003-02-11 14:55:40 +0000517**
drh726de592004-06-10 23:35:50 +0000518** If useCksum==0 it means this journal does not use checksums. Checksums
519** are not used in statement journals because statement journals do not
520** need to survive power failures.
drhfa86c412002-02-02 15:01:15 +0000521*/
drhae2b40c2004-06-09 19:03:54 +0000522static int pager_playback_one_page(Pager *pPager, OsFile *jfd, int useCksum){
drhfa86c412002-02-02 15:01:15 +0000523 int rc;
drhae2b40c2004-06-09 19:03:54 +0000524 PgHdr *pPg; /* An existing page in the cache */
525 Pgno pgno; /* The page number of a page in journal */
526 u32 cksum; /* Checksum used for sanity checking */
527 u8 aData[SQLITE_PAGE_SIZE]; /* Store data here */
drhfa86c412002-02-02 15:01:15 +0000528
drhae2b40c2004-06-09 19:03:54 +0000529 rc = read32bits(jfd, &pgno);
drh99ee3602003-02-16 19:13:36 +0000530 if( rc!=SQLITE_OK ) return rc;
drhae2b40c2004-06-09 19:03:54 +0000531 rc = sqlite3OsRead(jfd, &aData, pPager->pageSize);
drh99ee3602003-02-16 19:13:36 +0000532 if( rc!=SQLITE_OK ) return rc;
drhfa86c412002-02-02 15:01:15 +0000533
drh968af522003-02-11 14:55:40 +0000534 /* Sanity checking on the page. This is more important that I originally
535 ** thought. If a power failure occurs while the journal is being written,
536 ** it could cause invalid data to be written into the journal. We need to
537 ** detect this invalid data (with high probability) and ignore it.
538 */
drhae2b40c2004-06-09 19:03:54 +0000539 if( pgno==0 ){
drh968af522003-02-11 14:55:40 +0000540 return SQLITE_DONE;
541 }
drhae2b40c2004-06-09 19:03:54 +0000542 if( pgno>(unsigned)pPager->dbSize ){
drh968af522003-02-11 14:55:40 +0000543 return SQLITE_OK;
544 }
drhae2b40c2004-06-09 19:03:54 +0000545 if( useCksum ){
546 rc = read32bits(jfd, &cksum);
drh99ee3602003-02-16 19:13:36 +0000547 if( rc ) return rc;
drhae2b40c2004-06-09 19:03:54 +0000548 if( pager_cksum(pPager, pgno, aData)!=cksum ){
drh968af522003-02-11 14:55:40 +0000549 return SQLITE_DONE;
550 }
551 }
drhfa86c412002-02-02 15:01:15 +0000552
danielk1977aa5ccdf2004-06-14 05:10:42 +0000553 assert( pPager->state==PAGER_RESERVED || pPager->state>=PAGER_EXCLUSIVE );
danielk1977a3f3a5f2004-06-10 04:32:16 +0000554
555 /* If the pager is in RESERVED state, then there must be a copy of this
556 ** page in the pager cache. In this case just update the pager cache,
danielk19770de0bb32004-06-10 05:59:24 +0000557 ** not the database file. The page is left marked dirty in this case.
558 **
559 ** FIX ME: Ideally the page would only be left marked dirty when the
560 ** pager is in RESERVED state if it was dirty when this statement
561 ** transaction was started.
danielk1977a3f3a5f2004-06-10 04:32:16 +0000562 **
563 ** If in EXCLUSIVE state, then we update the pager cache if it exists
564 ** and the main file. The page is then marked not dirty.
drhfa86c412002-02-02 15:01:15 +0000565 */
drhae2b40c2004-06-09 19:03:54 +0000566 pPg = pager_lookup(pPager, pgno);
danielk1977aa5ccdf2004-06-14 05:10:42 +0000567 assert( pPager->state>=PAGER_EXCLUSIVE || pPg );
drhae2b40c2004-06-09 19:03:54 +0000568 TRACE2("PLAYBACK page %d\n", pgno);
danielk1977aa5ccdf2004-06-14 05:10:42 +0000569 if( pPager->state>=PAGER_EXCLUSIVE ){
danielk1977a3f3a5f2004-06-10 04:32:16 +0000570 sqlite3OsSeek(&pPager->fd, (pgno-1)*(off_t)SQLITE_PAGE_SIZE);
571 rc = sqlite3OsWrite(&pPager->fd, aData, SQLITE_PAGE_SIZE);
572 }
drhfa86c412002-02-02 15:01:15 +0000573 if( pPg ){
drhacf4ac92003-12-17 23:57:34 +0000574 /* No page should ever be rolled back that is in use, except for page
575 ** 1 which is held in use in order to keep the lock on the database
576 ** active.
577 */
drhb6f41482004-05-14 01:58:11 +0000578 void *pData;
drhacf4ac92003-12-17 23:57:34 +0000579 assert( pPg->nRef==0 || pPg->pgno==1 );
drhb6f41482004-05-14 01:58:11 +0000580 pData = PGHDR_TO_DATA(pPg);
drhae2b40c2004-06-09 19:03:54 +0000581 memcpy(pData, aData, pPager->pageSize);
drh726de592004-06-10 23:35:50 +0000582 if( pPager->xDestructor ){ /*** FIX ME: Should this be xReinit? ***/
drhb6f41482004-05-14 01:58:11 +0000583 pPager->xDestructor(pData, pPager->pageSize);
drhde647132004-05-07 17:57:49 +0000584 }
danielk1977aa5ccdf2004-06-14 05:10:42 +0000585 if( pPager->state>=PAGER_EXCLUSIVE ){
danielk19770de0bb32004-06-10 05:59:24 +0000586 pPg->dirty = 0;
587 pPg->needSync = 0;
588 }
drhb6f41482004-05-14 01:58:11 +0000589 CODEC(pPager, pData, pPg->pgno, 3);
drhfa86c412002-02-02 15:01:15 +0000590 }
591 return rc;
592}
593
594/*
danielk197713adf8a2004-06-03 16:08:41 +0000595** Parameter zMaster is the name of a master journal file. A single journal
596** file that referred to the master journal file has just been rolled back.
597** This routine checks if it is possible to delete the master journal file,
598** and does so if it is.
drh726de592004-06-10 23:35:50 +0000599**
600** The master journal file contains the names of all child journals.
601** To tell if a master journal can be deleted, check to each of the
602** children. If all children are either missing or do not refer to
603** a different master journal, then this master journal can be deleted.
danielk197713adf8a2004-06-03 16:08:41 +0000604*/
605static int pager_delmaster(const char *zMaster){
606 int rc;
607 int master_open = 0;
608 OsFile master;
609 char *zMasterJournal = 0; /* Contents of master journal file */
610 off_t nMasterJournal; /* Size of master journal file */
611
612 /* Open the master journal file exclusively in case some other process
613 ** is running this routine also. Not that it makes too much difference.
614 */
615 rc = sqlite3OsOpenExclusive(zMaster, &master, 0);
616 if( rc!=SQLITE_OK ) goto delmaster_out;
617 master_open = 1;
danielk197713adf8a2004-06-03 16:08:41 +0000618 rc = sqlite3OsFileSize(&master, &nMasterJournal);
619 if( rc!=SQLITE_OK ) goto delmaster_out;
620
621 if( nMasterJournal>0 ){
danielk19775865e3d2004-06-14 06:03:57 +0000622 char *zJournal;
623 char *zMasterPtr;
624 int nMasterPtr; /* Number of bytes allocated at zMasterPtr */
625
626 /* Load the entire master journal file into space obtained from
627 ** sqliteMalloc() and pointed to by zMasterJournal.
628 **
629 ** Also allocate an extra (strlen(zMaster)+1) bytes. This space is used
630 ** to load a master-journal filename from some other journal file to
631 ** check if it points at this master journal file.
632 */
633 nMasterPtr = strlen(zMaster) + 1;
634 zMasterJournal = (char *)sqliteMalloc(nMasterJournal) + nMasterPtr;
danielk197713adf8a2004-06-03 16:08:41 +0000635 if( !zMasterJournal ){
636 rc = SQLITE_NOMEM;
637 goto delmaster_out;
638 }
danielk19775865e3d2004-06-14 06:03:57 +0000639 zMasterPtr = &zMasterJournal[nMasterJournal];
danielk197713adf8a2004-06-03 16:08:41 +0000640 rc = sqlite3OsRead(&master, zMasterJournal, nMasterJournal);
641 if( rc!=SQLITE_OK ) goto delmaster_out;
642
danielk19775865e3d2004-06-14 06:03:57 +0000643 zJournal = zMasterJournal;
644 while( (zJournal-zMasterJournal)<nMasterJournal ){
danielk197713adf8a2004-06-03 16:08:41 +0000645 if( sqlite3OsFileExists(zJournal) ){
646 /* One of the journals pointed to by the master journal exists.
647 ** Open it and check if it points at the master journal. If
648 ** so, return without deleting the master journal file.
649 */
650 OsFile journal;
651 int nMaster;
danielk19779eed5052004-06-04 10:38:30 +0000652 off_t jsz;
danielk197713adf8a2004-06-03 16:08:41 +0000653
654 rc = sqlite3OsOpenReadOnly(zJournal, &journal);
655 if( rc!=SQLITE_OK ){
656 sqlite3OsClose(&journal);
danielk197713adf8a2004-06-03 16:08:41 +0000657 goto delmaster_out;
658 }
danielk197713adf8a2004-06-03 16:08:41 +0000659
drhae2b40c2004-06-09 19:03:54 +0000660 /* Check if the file is big enough to be a journal file
danielk19779eed5052004-06-04 10:38:30 +0000661 ** with the required master journal name. If not, ignore it.
662 */
663 rc = sqlite3OsFileSize(&journal, &jsz);
664 if( rc!=SQLITE_OK ){
665 sqlite3OsClose(&journal);
666 goto delmaster_out;
667 }
drhae2b40c2004-06-09 19:03:54 +0000668 if( jsz<(25+strlen(zMaster)) ){
danielk19779eed5052004-06-04 10:38:30 +0000669 sqlite3OsClose(&journal);
670 continue;
671 }
672
danielk197713adf8a2004-06-03 16:08:41 +0000673 /* Seek to the point in the journal where the master journal name
674 ** is stored. Read the master journal name into memory obtained
675 ** from malloc.
676 */
drhae2b40c2004-06-09 19:03:54 +0000677 rc = sqlite3OsSeek(&journal, 20);
danielk197713adf8a2004-06-03 16:08:41 +0000678 if( rc!=SQLITE_OK ) goto delmaster_out;
drhae2b40c2004-06-09 19:03:54 +0000679 rc = read32bits(&journal, (u32*)&nMaster);
danielk197713adf8a2004-06-03 16:08:41 +0000680 if( rc!=SQLITE_OK ) goto delmaster_out;
danielk19775865e3d2004-06-14 06:03:57 +0000681 if( nMaster>=nMasterPtr ){
682 rc = sqlite3OsRead(&journal, zMasterPtr, nMasterPtr);
danielk197713adf8a2004-06-03 16:08:41 +0000683 if( rc!=SQLITE_OK ){
danielk197713adf8a2004-06-03 16:08:41 +0000684 goto delmaster_out;
685 }
danielk19775865e3d2004-06-14 06:03:57 +0000686 if( zMasterPtr[nMasterPtr-1]=='\0' && !strcmp(zMasterPtr, zMaster) ){
danielk197713adf8a2004-06-03 16:08:41 +0000687 /* We have a match. Do not delete the master journal file. */
danielk197713adf8a2004-06-03 16:08:41 +0000688 goto delmaster_out;
689 }
690 }
691 }
danielk19775865e3d2004-06-14 06:03:57 +0000692 zJournal += (strlen(zJournal)+1);
danielk197713adf8a2004-06-03 16:08:41 +0000693 }
694 }
695
696 sqlite3OsDelete(zMaster);
697
698delmaster_out:
699 if( zMasterJournal ){
700 sqliteFree(zMasterJournal);
701 }
702 if( master_open ){
703 sqlite3OsClose(&master);
704 }
705 return rc;
706}
707
708/*
drha6abd042004-06-09 17:37:22 +0000709** Make every page in the cache agree with what is on disk. In other words,
710** reread the disk to reset the state of the cache.
711**
712** This routine is called after a rollback in which some of the dirty cache
713** pages had never been written out to disk. We need to roll back the
714** cache content and the easiest way to do that is to reread the old content
715** back from the disk.
716*/
717static int pager_reload_cache(Pager *pPager){
718 PgHdr *pPg;
719 int rc = SQLITE_OK;
720 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
721 char zBuf[SQLITE_PAGE_SIZE];
722 if( !pPg->dirty ) continue;
723 if( (int)pPg->pgno <= pPager->origDbSize ){
724 sqlite3OsSeek(&pPager->fd, SQLITE_PAGE_SIZE*(off_t)(pPg->pgno-1));
725 rc = sqlite3OsRead(&pPager->fd, zBuf, SQLITE_PAGE_SIZE);
726 TRACE2("REFETCH page %d\n", pPg->pgno);
727 CODEC(pPager, zBuf, pPg->pgno, 2);
728 if( rc ) break;
729 }else{
730 memset(zBuf, 0, SQLITE_PAGE_SIZE);
731 }
732 if( pPg->nRef==0 || memcmp(zBuf, PGHDR_TO_DATA(pPg), SQLITE_PAGE_SIZE) ){
733 memcpy(PGHDR_TO_DATA(pPg), zBuf, SQLITE_PAGE_SIZE);
734 if( pPager->xReiniter ){
735 pPager->xReiniter(PGHDR_TO_DATA(pPg), pPager->pageSize);
736 }else{
737 memset(PGHDR_TO_EXTRA(pPg), 0, pPager->nExtra);
738 }
739 }
740 pPg->needSync = 0;
741 pPg->dirty = 0;
742 }
743 return rc;
744}
745
746
747/*
drhed7c8552001-04-11 14:29:21 +0000748** Playback the journal and thus restore the database file to
749** the state it was in before we started making changes.
750**
drh34e79ce2004-02-08 06:05:46 +0000751** The journal file format is as follows:
752**
drhae2b40c2004-06-09 19:03:54 +0000753** (1) 8 byte prefix. A copy of aJournalMagic[].
754** (2) 4 byte big-endian integer which is the number of valid page records
drh34e79ce2004-02-08 06:05:46 +0000755** in the journal. If this value is 0xffffffff, then compute the
drhae2b40c2004-06-09 19:03:54 +0000756** number of page records from the journal size.
757** (3) 4 byte big-endian integer which is the initial value for the
758** sanity checksum.
759** (4) 4 byte integer which is the number of pages to truncate the
drh34e79ce2004-02-08 06:05:46 +0000760** database to during a rollback.
drhae2b40c2004-06-09 19:03:54 +0000761** (5) 4 byte integer which is the number of bytes in the master journal
762** name. The value may be zero (indicate that there is no master
763** journal.)
764** (6) N bytes of the master journal name. The name will be nul-terminated
765** and might be shorter than the value read from (5). If the first byte
766** of the name is \000 then there is no master journal. The master
767** journal name is stored in UTF-8.
768** (7) Zero or more pages instances, each as follows:
drh34e79ce2004-02-08 06:05:46 +0000769** + 4 byte page number.
drhae2b40c2004-06-09 19:03:54 +0000770** + pPager->pageSize bytes of data.
771** + 4 byte checksum
drh34e79ce2004-02-08 06:05:46 +0000772**
drhae2b40c2004-06-09 19:03:54 +0000773** When we speak of the journal header, we mean the first 6 items above.
774** Each entry in the journal is an instance of the 7th item.
drh34e79ce2004-02-08 06:05:46 +0000775**
776** Call the value from the second bullet "nRec". nRec is the number of
777** valid page entries in the journal. In most cases, you can compute the
778** value of nRec from the size of the journal file. But if a power
779** failure occurred while the journal was being written, it could be the
780** case that the size of the journal file had already been increased but
781** the extra entries had not yet made it safely to disk. In such a case,
782** the value of nRec computed from the file size would be too large. For
783** that reason, we always use the nRec value in the header.
784**
785** If the nRec value is 0xffffffff it means that nRec should be computed
786** from the file size. This value is used when the user selects the
787** no-sync option for the journal. A power failure could lead to corruption
788** in this case. But for things like temporary table (which will be
789** deleted when the power is restored) we don't care.
790**
drhd9b02572001-04-15 00:37:09 +0000791** If the file opened as the journal file is not a well-formed
drh34e79ce2004-02-08 06:05:46 +0000792** journal file then the database will likely already be
793** corrupted, so the PAGER_ERR_CORRUPT bit is set in pPager->errMask
794** and SQLITE_CORRUPT is returned. If it all works, then this routine
795** returns SQLITE_OK.
drhed7c8552001-04-11 14:29:21 +0000796*/
drh99ee3602003-02-16 19:13:36 +0000797static int pager_playback(Pager *pPager, int useJournalSize){
drh968af522003-02-11 14:55:40 +0000798 off_t szJ; /* Size of the journal file in bytes */
799 int nRec; /* Number of Records in the journal */
drhd9b02572001-04-15 00:37:09 +0000800 int i; /* Loop counter */
801 Pgno mxPg = 0; /* Size of the original file in pages */
drhae2b40c2004-06-09 19:03:54 +0000802 unsigned char aMagic[8]; /* A buffer to hold the magic header */
803 int rc; /* Result code of a subroutine */
804 int nMaster; /* Number of bytes in the name of master journal */
danielk197713adf8a2004-06-03 16:08:41 +0000805 char *zMaster = 0; /* Name of master journal file if any */
drhed7c8552001-04-11 14:29:21 +0000806
drhc3a64ba2001-11-22 00:01:27 +0000807 /* Figure out how many records are in the journal. Abort early if
808 ** the journal is empty.
drhed7c8552001-04-11 14:29:21 +0000809 */
drh8cfbf082001-09-19 13:22:39 +0000810 assert( pPager->journalOpen );
danielk19774adee202004-05-08 08:23:19 +0000811 sqlite3OsSeek(&pPager->jfd, 0);
812 rc = sqlite3OsFileSize(&pPager->jfd, &szJ);
drhc3a64ba2001-11-22 00:01:27 +0000813 if( rc!=SQLITE_OK ){
814 goto end_playback;
815 }
drh240c5792004-02-08 00:40:52 +0000816
817 /* If the journal file is too small to contain a complete header,
drh34e79ce2004-02-08 06:05:46 +0000818 ** it must mean that the process that created the journal was just
819 ** beginning to write the journal file when it died. In that case,
820 ** the database file should have still been completely unchanged.
821 ** Nothing needs to be rolled back. We can safely ignore this journal.
drh240c5792004-02-08 00:40:52 +0000822 */
drhae2b40c2004-06-09 19:03:54 +0000823 if( szJ < 24 ){
drhc3a64ba2001-11-22 00:01:27 +0000824 goto end_playback;
825 }
826
drhae2b40c2004-06-09 19:03:54 +0000827 /* (1) Read the beginning of the journal and verify the magic string
828 ** at the beginning of the journal. */
danielk19774adee202004-05-08 08:23:19 +0000829 rc = sqlite3OsRead(&pPager->jfd, aMagic, sizeof(aMagic));
drhae2b40c2004-06-09 19:03:54 +0000830 if( rc!=SQLITE_OK || memcmp(aMagic, aJournalMagic, sizeof(aMagic))!=0 ){
831 rc = SQLITE_PROTOCOL;
832 goto end_playback;
833 }
834
835 /* (2) Read the number of pages stored in the journal. */
836 rc = read32bits(&pPager->jfd, (u32*)&nRec);
837 if( rc ) goto end_playback;
838 if( nRec==0xffffffff || useJournalSize ){
839 nRec = (szJ - JOURNAL_HDR_SZ(pPager))/JOURNAL_PG_SZ(pPager);
840 }
841
842 /* (3) Read the initial value for the sanity checksum */
843 rc = read32bits(&pPager->jfd, &pPager->cksumInit);
844 if( rc ) goto end_playback;
845
846 /* (4) Read the number of pages in the database file prior to the
847 ** start of the transaction */
848 rc = read32bits(&pPager->jfd, &mxPg);
drh94f33312002-08-12 12:29:56 +0000849 if( rc!=SQLITE_OK ){
drh81a20f22001-10-12 17:30:04 +0000850 goto end_playback;
drhd9b02572001-04-15 00:37:09 +0000851 }
drhae2b40c2004-06-09 19:03:54 +0000852
853 /* (5) and (6): Check if a master journal file is specified. If one is
854 ** specified, only proceed with the playback if it still exists. */
855 rc = read32bits(&pPager->jfd, &nMaster);
856 if( rc ) goto end_playback;
857 if( nMaster>0 ){
858 zMaster = sqliteMalloc(nMaster);
859 if( !zMaster ){
860 rc = SQLITE_NOMEM;
drh240c5792004-02-08 00:40:52 +0000861 goto end_playback;
862 }
drh427eab52004-06-10 00:51:43 +0000863 rc = sqlite3OsRead(&pPager->jfd, zMaster, nMaster);
drhae2b40c2004-06-09 19:03:54 +0000864 if( rc!=SQLITE_OK || (zMaster[0] && !sqlite3OsFileExists(zMaster)) ){
865 goto end_playback;
danielk197713adf8a2004-06-03 16:08:41 +0000866 }
drhae2b40c2004-06-09 19:03:54 +0000867 }
danielk197713adf8a2004-06-03 16:08:41 +0000868
drhae2b40c2004-06-09 19:03:54 +0000869 /* Truncate the database file back to it's original size */
drhd8d66e82003-02-12 02:10:15 +0000870 assert( pPager->origDbSize==0 || pPager->origDbSize==mxPg );
danielk19774adee202004-05-08 08:23:19 +0000871 rc = sqlite3OsTruncate(&pPager->fd, SQLITE_PAGE_SIZE*(off_t)mxPg);
drh81a20f22001-10-12 17:30:04 +0000872 if( rc!=SQLITE_OK ){
873 goto end_playback;
874 }
drhd9b02572001-04-15 00:37:09 +0000875 pPager->dbSize = mxPg;
876
drhfa86c412002-02-02 15:01:15 +0000877 /* Copy original pages out of the journal and back into the database file.
drhed7c8552001-04-11 14:29:21 +0000878 */
drh968af522003-02-11 14:55:40 +0000879 for(i=0; i<nRec; i++){
drhae2b40c2004-06-09 19:03:54 +0000880 rc = pager_playback_one_page(pPager, &pPager->jfd, 1);
drh968af522003-02-11 14:55:40 +0000881 if( rc!=SQLITE_OK ){
882 if( rc==SQLITE_DONE ){
drh968af522003-02-11 14:55:40 +0000883 rc = SQLITE_OK;
884 }
885 break;
886 }
drhed7c8552001-04-11 14:29:21 +0000887 }
drh81a20f22001-10-12 17:30:04 +0000888
drh4a0681e2003-02-13 01:58:20 +0000889 /* Pages that have been written to the journal but never synced
890 ** where not restored by the loop above. We have to restore those
drh240c5792004-02-08 00:40:52 +0000891 ** pages by reading them back from the original database.
drhdb48ee02003-01-16 13:42:43 +0000892 */
893 if( rc==SQLITE_OK ){
drha6abd042004-06-09 17:37:22 +0000894 pager_reload_cache(pPager);
drhdb48ee02003-01-16 13:42:43 +0000895 }
drh4a0681e2003-02-13 01:58:20 +0000896
897end_playback:
danielk197713adf8a2004-06-03 16:08:41 +0000898 if( zMaster ){
899 /* If there was a master journal and this routine will return true,
900 ** see if it is possible to delete the master journal. If errors
901 ** occur during this process, ignore them.
902 */
903 if( rc==SQLITE_OK ){
904 pager_delmaster(zMaster);
905 }
906 sqliteFree(zMaster);
907 }
drhd9b02572001-04-15 00:37:09 +0000908 if( rc!=SQLITE_OK ){
danielk197713adf8a2004-06-03 16:08:41 +0000909 /* FIX ME: We shouldn't delete the journal if an error occured during
910 ** rollback. It may have been a transient error and the rollback may
911 ** succeed next time it is attempted.
912 */
drhd9b02572001-04-15 00:37:09 +0000913 pager_unwritelock(pPager);
914 pPager->errMask |= PAGER_ERR_CORRUPT;
915 rc = SQLITE_CORRUPT;
916 }else{
917 rc = pager_unwritelock(pPager);
drhed7c8552001-04-11 14:29:21 +0000918 }
drhd9b02572001-04-15 00:37:09 +0000919 return rc;
drhed7c8552001-04-11 14:29:21 +0000920}
921
922/*
drhac69b052004-05-12 13:30:07 +0000923** Playback the statement journal.
drhfa86c412002-02-02 15:01:15 +0000924**
925** This is similar to playing back the transaction journal but with
926** a few extra twists.
927**
drh663fc632002-02-02 18:49:19 +0000928** (1) The number of pages in the database file at the start of
drhac69b052004-05-12 13:30:07 +0000929** the statement is stored in pPager->stmtSize, not in the
drh663fc632002-02-02 18:49:19 +0000930** journal file itself.
drhfa86c412002-02-02 15:01:15 +0000931**
drhac69b052004-05-12 13:30:07 +0000932** (2) In addition to playing back the statement journal, also
drhfa86c412002-02-02 15:01:15 +0000933** playback all pages of the transaction journal beginning
drhac69b052004-05-12 13:30:07 +0000934** at offset pPager->stmtJSize.
drhfa86c412002-02-02 15:01:15 +0000935*/
drh3aac2dd2004-04-26 14:10:20 +0000936static int pager_stmt_playback(Pager *pPager){
drh968af522003-02-11 14:55:40 +0000937 off_t szJ; /* Size of the full journal */
938 int nRec; /* Number of Records */
drhfa86c412002-02-02 15:01:15 +0000939 int i; /* Loop counter */
940 int rc;
941
942 /* Truncate the database back to its original size.
943 */
drhac69b052004-05-12 13:30:07 +0000944 rc = sqlite3OsTruncate(&pPager->fd, SQLITE_PAGE_SIZE*(off_t)pPager->stmtSize);
945 pPager->dbSize = pPager->stmtSize;
drhfa86c412002-02-02 15:01:15 +0000946
drhac69b052004-05-12 13:30:07 +0000947 /* Figure out how many records are in the statement journal.
drhfa86c412002-02-02 15:01:15 +0000948 */
drhac69b052004-05-12 13:30:07 +0000949 assert( pPager->stmtInUse && pPager->journalOpen );
950 sqlite3OsSeek(&pPager->stfd, 0);
951 nRec = pPager->stmtNRec;
drhfa86c412002-02-02 15:01:15 +0000952
drhac69b052004-05-12 13:30:07 +0000953 /* Copy original pages out of the statement journal and back into the
drhae2b40c2004-06-09 19:03:54 +0000954 ** database file. Note that the statement journal omits checksums from
955 ** each record since power-failure recovery is not important to statement
956 ** journals.
drhfa86c412002-02-02 15:01:15 +0000957 */
958 for(i=nRec-1; i>=0; i--){
drhae2b40c2004-06-09 19:03:54 +0000959 rc = pager_playback_one_page(pPager, &pPager->stfd, 0);
drh968af522003-02-11 14:55:40 +0000960 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +0000961 if( rc!=SQLITE_OK ) goto end_stmt_playback;
drhfa86c412002-02-02 15:01:15 +0000962 }
963
964 /* Figure out how many pages need to be copied out of the transaction
965 ** journal.
966 */
drhac69b052004-05-12 13:30:07 +0000967 rc = sqlite3OsSeek(&pPager->jfd, pPager->stmtJSize);
drhfa86c412002-02-02 15:01:15 +0000968 if( rc!=SQLITE_OK ){
drh3aac2dd2004-04-26 14:10:20 +0000969 goto end_stmt_playback;
drhfa86c412002-02-02 15:01:15 +0000970 }
danielk19774adee202004-05-08 08:23:19 +0000971 rc = sqlite3OsFileSize(&pPager->jfd, &szJ);
drhfa86c412002-02-02 15:01:15 +0000972 if( rc!=SQLITE_OK ){
drh3aac2dd2004-04-26 14:10:20 +0000973 goto end_stmt_playback;
drhfa86c412002-02-02 15:01:15 +0000974 }
drhae2b40c2004-06-09 19:03:54 +0000975 nRec = (szJ - pPager->stmtJSize)/JOURNAL_PG_SZ(pPager);
drhfa86c412002-02-02 15:01:15 +0000976 for(i=nRec-1; i>=0; i--){
drhae2b40c2004-06-09 19:03:54 +0000977 rc = pager_playback_one_page(pPager, &pPager->jfd, 1);
drh968af522003-02-11 14:55:40 +0000978 if( rc!=SQLITE_OK ){
979 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +0000980 goto end_stmt_playback;
drh968af522003-02-11 14:55:40 +0000981 }
drhfa86c412002-02-02 15:01:15 +0000982 }
983
drh3aac2dd2004-04-26 14:10:20 +0000984end_stmt_playback:
drhfa86c412002-02-02 15:01:15 +0000985 if( rc!=SQLITE_OK ){
drhfa86c412002-02-02 15:01:15 +0000986 pPager->errMask |= PAGER_ERR_CORRUPT;
987 rc = SQLITE_CORRUPT;
drhfa86c412002-02-02 15:01:15 +0000988 }
989 return rc;
990}
991
992/*
drhf57b14a2001-09-14 18:54:08 +0000993** Change the maximum number of in-memory pages that are allowed.
drhcd61c282002-03-06 22:01:34 +0000994**
995** The maximum number is the absolute value of the mxPage parameter.
996** If mxPage is negative, the noSync flag is also set. noSync bypasses
danielk19774adee202004-05-08 08:23:19 +0000997** calls to sqlite3OsSync(). The pager runs much faster with noSync on,
drhcd61c282002-03-06 22:01:34 +0000998** but if the operating system crashes or there is an abrupt power
999** failure, the database file might be left in an inconsistent and
1000** unrepairable state.
drhf57b14a2001-09-14 18:54:08 +00001001*/
drh3aac2dd2004-04-26 14:10:20 +00001002void sqlite3pager_set_cachesize(Pager *pPager, int mxPage){
drh603240c2002-03-05 01:11:12 +00001003 if( mxPage>=0 ){
drha1680452002-04-18 01:56:57 +00001004 pPager->noSync = pPager->tempFile;
danielk19771d850a72004-05-31 08:26:49 +00001005 if( pPager->noSync ) pPager->needSync = 0;
drh603240c2002-03-05 01:11:12 +00001006 }else{
1007 pPager->noSync = 1;
1008 mxPage = -mxPage;
1009 }
drhf57b14a2001-09-14 18:54:08 +00001010 if( mxPage>10 ){
1011 pPager->mxPage = mxPage;
1012 }
1013}
1014
1015/*
drh973b6e32003-02-12 14:09:42 +00001016** Adjust the robustness of the database to damage due to OS crashes
1017** or power failures by changing the number of syncs()s when writing
1018** the rollback journal. There are three levels:
1019**
danielk19774adee202004-05-08 08:23:19 +00001020** OFF sqlite3OsSync() is never called. This is the default
drh973b6e32003-02-12 14:09:42 +00001021** for temporary and transient files.
1022**
1023** NORMAL The journal is synced once before writes begin on the
1024** database. This is normally adequate protection, but
1025** it is theoretically possible, though very unlikely,
1026** that an inopertune power failure could leave the journal
1027** in a state which would cause damage to the database
1028** when it is rolled back.
1029**
1030** FULL The journal is synced twice before writes begin on the
drh34e79ce2004-02-08 06:05:46 +00001031** database (with some additional information - the nRec field
1032** of the journal header - being written in between the two
1033** syncs). If we assume that writing a
drh973b6e32003-02-12 14:09:42 +00001034** single disk sector is atomic, then this mode provides
1035** assurance that the journal will not be corrupted to the
1036** point of causing damage to the database during rollback.
1037**
1038** Numeric values associated with these states are OFF==1, NORMAL=2,
1039** and FULL=3.
1040*/
drh3aac2dd2004-04-26 14:10:20 +00001041void sqlite3pager_set_safety_level(Pager *pPager, int level){
drh973b6e32003-02-12 14:09:42 +00001042 pPager->noSync = level==1 || pPager->tempFile;
1043 pPager->fullSync = level==3 && !pPager->tempFile;
danielk19771d850a72004-05-31 08:26:49 +00001044 if( pPager->noSync ) pPager->needSync = 0;
drh973b6e32003-02-12 14:09:42 +00001045}
1046
1047/*
drhfa86c412002-02-02 15:01:15 +00001048** Open a temporary file. Write the name of the file into zName
1049** (zName must be at least SQLITE_TEMPNAME_SIZE bytes long.) Write
1050** the file descriptor into *fd. Return SQLITE_OK on success or some
1051** other error code if we fail.
1052**
1053** The OS will automatically delete the temporary file when it is
1054** closed.
1055*/
drh3aac2dd2004-04-26 14:10:20 +00001056static int sqlite3pager_opentemp(char *zFile, OsFile *fd){
drhfa86c412002-02-02 15:01:15 +00001057 int cnt = 8;
1058 int rc;
1059 do{
1060 cnt--;
danielk19774adee202004-05-08 08:23:19 +00001061 sqlite3OsTempFileName(zFile);
1062 rc = sqlite3OsOpenExclusive(zFile, fd, 1);
drhfa86c412002-02-02 15:01:15 +00001063 }while( cnt>0 && rc!=SQLITE_OK );
1064 return rc;
1065}
1066
1067/*
drhed7c8552001-04-11 14:29:21 +00001068** Create a new page cache and put a pointer to the page cache in *ppPager.
drh5e00f6c2001-09-13 13:46:56 +00001069** The file to be cached need not exist. The file is not locked until
drh3aac2dd2004-04-26 14:10:20 +00001070** the first call to sqlite3pager_get() and is only held open until the
1071** last page is released using sqlite3pager_unref().
drh382c0242001-10-06 16:33:02 +00001072**
drh6446c4d2001-12-15 14:22:18 +00001073** If zFilename is NULL then a randomly-named temporary file is created
1074** and used as the file to be cached. The file will be deleted
1075** automatically when it is closed.
drhed7c8552001-04-11 14:29:21 +00001076*/
drh3aac2dd2004-04-26 14:10:20 +00001077int sqlite3pager_open(
drh7e3b0a02001-04-28 16:52:40 +00001078 Pager **ppPager, /* Return the Pager structure here */
1079 const char *zFilename, /* Name of the database file to open */
1080 int mxPage, /* Max number of in-memory cache pages */
drhda47d772002-12-02 04:25:19 +00001081 int nExtra, /* Extra bytes append to each in-memory page */
danielk197724162fe2004-06-04 06:22:00 +00001082 int useJournal, /* TRUE to use a rollback journal on this file */
1083 void *pBusyHandler /* Busy callback */
drh7e3b0a02001-04-28 16:52:40 +00001084){
drhed7c8552001-04-11 14:29:21 +00001085 Pager *pPager;
drh3e7a6092002-12-07 21:45:14 +00001086 char *zFullPathname;
drhed7c8552001-04-11 14:29:21 +00001087 int nameLen;
drh8cfbf082001-09-19 13:22:39 +00001088 OsFile fd;
drha76c82e2003-07-27 18:59:42 +00001089 int rc, i;
drh5e00f6c2001-09-13 13:46:56 +00001090 int tempFile;
drhac69b052004-05-12 13:30:07 +00001091 int memDb = 0;
drh5e00f6c2001-09-13 13:46:56 +00001092 int readOnly = 0;
drh8cfbf082001-09-19 13:22:39 +00001093 char zTemp[SQLITE_TEMPNAME_SIZE];
drhed7c8552001-04-11 14:29:21 +00001094
drhd9b02572001-04-15 00:37:09 +00001095 *ppPager = 0;
danielk19776f8a5032004-05-10 10:34:51 +00001096 if( sqlite3_malloc_failed ){
drhd9b02572001-04-15 00:37:09 +00001097 return SQLITE_NOMEM;
1098 }
drh901afd42003-08-26 11:25:58 +00001099 if( zFilename && zFilename[0] ){
drhac69b052004-05-12 13:30:07 +00001100 if( strcmp(zFilename,":memory:")==0 ){
1101 memDb = 1;
1102 zFullPathname = sqliteMalloc(4);
drhae2b40c2004-06-09 19:03:54 +00001103 if( zFullPathname ) strcpy(zFullPathname, "");
drhac69b052004-05-12 13:30:07 +00001104 rc = SQLITE_OK;
1105 }else{
1106 zFullPathname = sqlite3OsFullPathname(zFilename);
1107 rc = sqlite3OsOpenReadWrite(zFullPathname, &fd, &readOnly);
1108 tempFile = 0;
1109 }
drh5e00f6c2001-09-13 13:46:56 +00001110 }else{
drh3aac2dd2004-04-26 14:10:20 +00001111 rc = sqlite3pager_opentemp(zTemp, &fd);
drh5e00f6c2001-09-13 13:46:56 +00001112 zFilename = zTemp;
danielk19774adee202004-05-08 08:23:19 +00001113 zFullPathname = sqlite3OsFullPathname(zFilename);
drh5e00f6c2001-09-13 13:46:56 +00001114 tempFile = 1;
1115 }
danielk19776f8a5032004-05-10 10:34:51 +00001116 if( sqlite3_malloc_failed ){
drh3e7a6092002-12-07 21:45:14 +00001117 return SQLITE_NOMEM;
1118 }
drh8cfbf082001-09-19 13:22:39 +00001119 if( rc!=SQLITE_OK ){
drh3e7a6092002-12-07 21:45:14 +00001120 sqliteFree(zFullPathname);
drhed7c8552001-04-11 14:29:21 +00001121 return SQLITE_CANTOPEN;
1122 }
drh3e7a6092002-12-07 21:45:14 +00001123 nameLen = strlen(zFullPathname);
drha76c82e2003-07-27 18:59:42 +00001124 pPager = sqliteMalloc( sizeof(*pPager) + nameLen*3 + 30 );
drhd9b02572001-04-15 00:37:09 +00001125 if( pPager==0 ){
danielk19774adee202004-05-08 08:23:19 +00001126 sqlite3OsClose(&fd);
drh3e7a6092002-12-07 21:45:14 +00001127 sqliteFree(zFullPathname);
drhd9b02572001-04-15 00:37:09 +00001128 return SQLITE_NOMEM;
1129 }
drhdb48ee02003-01-16 13:42:43 +00001130 SET_PAGER(pPager);
drhed7c8552001-04-11 14:29:21 +00001131 pPager->zFilename = (char*)&pPager[1];
drha76c82e2003-07-27 18:59:42 +00001132 pPager->zDirectory = &pPager->zFilename[nameLen+1];
1133 pPager->zJournal = &pPager->zDirectory[nameLen+1];
drh3e7a6092002-12-07 21:45:14 +00001134 strcpy(pPager->zFilename, zFullPathname);
drha76c82e2003-07-27 18:59:42 +00001135 strcpy(pPager->zDirectory, zFullPathname);
1136 for(i=nameLen; i>0 && pPager->zDirectory[i-1]!='/'; i--){}
1137 if( i>0 ) pPager->zDirectory[i-1] = 0;
drh3e7a6092002-12-07 21:45:14 +00001138 strcpy(pPager->zJournal, zFullPathname);
1139 sqliteFree(zFullPathname);
drhed7c8552001-04-11 14:29:21 +00001140 strcpy(&pPager->zJournal[nameLen], "-journal");
1141 pPager->fd = fd;
drh8cfbf082001-09-19 13:22:39 +00001142 pPager->journalOpen = 0;
drhac69b052004-05-12 13:30:07 +00001143 pPager->useJournal = useJournal && !memDb;
1144 pPager->stmtOpen = 0;
1145 pPager->stmtInUse = 0;
drhed7c8552001-04-11 14:29:21 +00001146 pPager->nRef = 0;
drhac69b052004-05-12 13:30:07 +00001147 pPager->dbSize = memDb-1;
1148 pPager->pageSize = SQLITE_PAGE_SIZE;
1149 pPager->stmtSize = 0;
1150 pPager->stmtJSize = 0;
drhed7c8552001-04-11 14:29:21 +00001151 pPager->nPage = 0;
drhd79caeb2001-04-15 02:27:24 +00001152 pPager->mxPage = mxPage>5 ? mxPage : 10;
drha6abd042004-06-09 17:37:22 +00001153 pPager->state = PAGER_UNLOCK;
drhd9b02572001-04-15 00:37:09 +00001154 pPager->errMask = 0;
drh5e00f6c2001-09-13 13:46:56 +00001155 pPager->tempFile = tempFile;
drhac69b052004-05-12 13:30:07 +00001156 pPager->memDb = memDb;
drh5e00f6c2001-09-13 13:46:56 +00001157 pPager->readOnly = readOnly;
drhf57b14a2001-09-14 18:54:08 +00001158 pPager->needSync = 0;
drhda47d772002-12-02 04:25:19 +00001159 pPager->noSync = pPager->tempFile || !useJournal;
drhed7c8552001-04-11 14:29:21 +00001160 pPager->pFirst = 0;
drh341eae82003-01-21 02:39:36 +00001161 pPager->pFirstSynced = 0;
drhed7c8552001-04-11 14:29:21 +00001162 pPager->pLast = 0;
drh7c717f72001-06-24 20:39:41 +00001163 pPager->nExtra = nExtra;
danielk197724162fe2004-06-04 06:22:00 +00001164 pPager->pBusyHandler = (BusyHandler *)pBusyHandler;
drhed7c8552001-04-11 14:29:21 +00001165 memset(pPager->aHash, 0, sizeof(pPager->aHash));
1166 *ppPager = pPager;
1167 return SQLITE_OK;
1168}
1169
1170/*
drh72f82862001-05-24 21:06:34 +00001171** Set the destructor for this pager. If not NULL, the destructor is called
drh5e00f6c2001-09-13 13:46:56 +00001172** when the reference count on each page reaches zero. The destructor can
1173** be used to clean up information in the extra segment appended to each page.
drh72f82862001-05-24 21:06:34 +00001174**
drh3aac2dd2004-04-26 14:10:20 +00001175** The destructor is not called as a result sqlite3pager_close().
1176** Destructors are only called by sqlite3pager_unref().
drh72f82862001-05-24 21:06:34 +00001177*/
drhb6f41482004-05-14 01:58:11 +00001178void sqlite3pager_set_destructor(Pager *pPager, void (*xDesc)(void*,int)){
drh72f82862001-05-24 21:06:34 +00001179 pPager->xDestructor = xDesc;
1180}
1181
1182/*
drha6abd042004-06-09 17:37:22 +00001183** Set the reinitializer for this pager. If not NULL, the reinitializer
1184** is called when the content of a page in cache is restored to its original
1185** value as a result of a rollback. The callback gives higher-level code
1186** an opportunity to restore the EXTRA section to agree with the restored
1187** page data.
1188*/
1189void sqlite3pager_set_reiniter(Pager *pPager, void (*xReinit)(void*,int)){
1190 pPager->xReiniter = xReinit;
1191}
1192
1193/*
drh5e00f6c2001-09-13 13:46:56 +00001194** Return the total number of pages in the disk file associated with
1195** pPager.
drhed7c8552001-04-11 14:29:21 +00001196*/
drh3aac2dd2004-04-26 14:10:20 +00001197int sqlite3pager_pagecount(Pager *pPager){
drh28be87c2002-11-05 23:03:02 +00001198 off_t n;
drhd9b02572001-04-15 00:37:09 +00001199 assert( pPager!=0 );
drhed7c8552001-04-11 14:29:21 +00001200 if( pPager->dbSize>=0 ){
1201 return pPager->dbSize;
1202 }
danielk19774adee202004-05-08 08:23:19 +00001203 if( sqlite3OsFileSize(&pPager->fd, &n)!=SQLITE_OK ){
drh81a20f22001-10-12 17:30:04 +00001204 pPager->errMask |= PAGER_ERR_DISK;
drh8cfbf082001-09-19 13:22:39 +00001205 return 0;
drhed7c8552001-04-11 14:29:21 +00001206 }
drhd0ba1932004-02-10 01:54:28 +00001207 n /= SQLITE_PAGE_SIZE;
drh1f595712004-06-15 01:40:29 +00001208 if( !pPager->memDb && n==PENDING_BYTE/SQLITE_PAGE_SIZE ){
1209 n++;
1210 }
drha6abd042004-06-09 17:37:22 +00001211 if( pPager->state!=PAGER_UNLOCK ){
drhed7c8552001-04-11 14:29:21 +00001212 pPager->dbSize = n;
1213 }
1214 return n;
1215}
1216
1217/*
drhf7c57532003-04-25 13:22:51 +00001218** Forward declaration
1219*/
danielk197713adf8a2004-06-03 16:08:41 +00001220static int syncJournal(Pager*, const char*);
drhf7c57532003-04-25 13:22:51 +00001221
drhac69b052004-05-12 13:30:07 +00001222
1223/*
1224** Unlink a page from the free list (the list of all pages where nRef==0)
1225** and from its hash collision chain.
1226*/
1227static void unlinkPage(PgHdr *pPg){
1228 Pager *pPager = pPg->pPager;
1229
1230 /* Keep the pFirstSynced pointer pointing at the first synchronized page */
1231 if( pPg==pPager->pFirstSynced ){
1232 PgHdr *p = pPg->pNextFree;
1233 while( p && p->needSync ){ p = p->pNextFree; }
1234 pPager->pFirstSynced = p;
1235 }
1236
1237 /* Unlink from the freelist */
1238 if( pPg->pPrevFree ){
1239 pPg->pPrevFree->pNextFree = pPg->pNextFree;
1240 }else{
1241 assert( pPager->pFirst==pPg );
1242 pPager->pFirst = pPg->pNextFree;
1243 }
1244 if( pPg->pNextFree ){
1245 pPg->pNextFree->pPrevFree = pPg->pPrevFree;
1246 }else{
1247 assert( pPager->pLast==pPg );
1248 pPager->pLast = pPg->pPrevFree;
1249 }
1250 pPg->pNextFree = pPg->pPrevFree = 0;
1251
1252 /* Unlink from the pgno hash table */
1253 if( pPg->pNextHash ){
1254 pPg->pNextHash->pPrevHash = pPg->pPrevHash;
1255 }
1256 if( pPg->pPrevHash ){
1257 pPg->pPrevHash->pNextHash = pPg->pNextHash;
1258 }else{
1259 int h = pager_hash(pPg->pgno);
1260 assert( pPager->aHash[h]==pPg );
1261 pPager->aHash[h] = pPg->pNextHash;
1262 }
1263 pPg->pNextHash = pPg->pPrevHash = 0;
1264}
1265
1266/*
1267** This routine is used to truncate an in-memory database. Delete
1268** every pages whose pgno is larger than pPager->dbSize and is unreferenced.
1269** Referenced pages larger than pPager->dbSize are zeroed.
1270*/
1271static void memoryTruncate(Pager *pPager){
1272 PgHdr *pPg;
1273 PgHdr **ppPg;
1274 int dbSize = pPager->dbSize;
1275
1276 ppPg = &pPager->pAll;
1277 while( (pPg = *ppPg)!=0 ){
1278 if( pPg->pgno<=dbSize ){
1279 ppPg = &pPg->pNextAll;
1280 }else if( pPg->nRef>0 ){
1281 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
1282 ppPg = &pPg->pNextAll;
1283 }else{
1284 *ppPg = pPg->pNextAll;
1285 unlinkPage(pPg);
1286 sqliteFree(pPg);
1287 pPager->nPage--;
1288 }
1289 }
1290}
1291
drhf7c57532003-04-25 13:22:51 +00001292/*
1293** Truncate the file to the number of pages specified.
1294*/
drh3aac2dd2004-04-26 14:10:20 +00001295int sqlite3pager_truncate(Pager *pPager, Pgno nPage){
drhf7c57532003-04-25 13:22:51 +00001296 int rc;
drh2e6d11b2003-04-25 15:37:57 +00001297 if( pPager->dbSize<0 ){
drh3aac2dd2004-04-26 14:10:20 +00001298 sqlite3pager_pagecount(pPager);
drh2e6d11b2003-04-25 15:37:57 +00001299 }
1300 if( pPager->errMask!=0 ){
1301 rc = pager_errcode(pPager);
1302 return rc;
1303 }
drh7d02cb72003-06-04 16:24:39 +00001304 if( nPage>=(unsigned)pPager->dbSize ){
drhf7c57532003-04-25 13:22:51 +00001305 return SQLITE_OK;
1306 }
drhac69b052004-05-12 13:30:07 +00001307 if( pPager->memDb ){
1308 pPager->dbSize = nPage;
1309 memoryTruncate(pPager);
1310 return SQLITE_OK;
1311 }
danielk197713adf8a2004-06-03 16:08:41 +00001312 syncJournal(pPager, 0);
danielk19774adee202004-05-08 08:23:19 +00001313 rc = sqlite3OsTruncate(&pPager->fd, SQLITE_PAGE_SIZE*(off_t)nPage);
drhf7c57532003-04-25 13:22:51 +00001314 if( rc==SQLITE_OK ){
1315 pPager->dbSize = nPage;
1316 }
1317 return rc;
1318}
1319
1320/*
drhed7c8552001-04-11 14:29:21 +00001321** Shutdown the page cache. Free all memory and close all files.
1322**
1323** If a transaction was in progress when this routine is called, that
1324** transaction is rolled back. All outstanding pages are invalidated
1325** and their memory is freed. Any attempt to use a page associated
1326** with this page cache after this function returns will likely
1327** result in a coredump.
1328*/
drh3aac2dd2004-04-26 14:10:20 +00001329int sqlite3pager_close(Pager *pPager){
drhd9b02572001-04-15 00:37:09 +00001330 PgHdr *pPg, *pNext;
drhed7c8552001-04-11 14:29:21 +00001331 switch( pPager->state ){
drha6abd042004-06-09 17:37:22 +00001332 case PAGER_RESERVED:
danielk1977aa5ccdf2004-06-14 05:10:42 +00001333 case PAGER_SYNCED:
drha6abd042004-06-09 17:37:22 +00001334 case PAGER_EXCLUSIVE: {
drh3aac2dd2004-04-26 14:10:20 +00001335 sqlite3pager_rollback(pPager);
drhac69b052004-05-12 13:30:07 +00001336 if( !pPager->memDb ){
drha6abd042004-06-09 17:37:22 +00001337 sqlite3OsUnlock(&pPager->fd, NO_LOCK);
drhac69b052004-05-12 13:30:07 +00001338 }
drh8cfbf082001-09-19 13:22:39 +00001339 assert( pPager->journalOpen==0 );
drhed7c8552001-04-11 14:29:21 +00001340 break;
1341 }
drha6abd042004-06-09 17:37:22 +00001342 case PAGER_SHARED: {
drhac69b052004-05-12 13:30:07 +00001343 if( !pPager->memDb ){
drha6abd042004-06-09 17:37:22 +00001344 sqlite3OsUnlock(&pPager->fd, NO_LOCK);
drhac69b052004-05-12 13:30:07 +00001345 }
drhed7c8552001-04-11 14:29:21 +00001346 break;
1347 }
1348 default: {
1349 /* Do nothing */
1350 break;
1351 }
1352 }
drhd9b02572001-04-15 00:37:09 +00001353 for(pPg=pPager->pAll; pPg; pPg=pNext){
1354 pNext = pPg->pNextAll;
1355 sqliteFree(pPg);
drhed7c8552001-04-11 14:29:21 +00001356 }
drhac69b052004-05-12 13:30:07 +00001357 if( !pPager->memDb ){
1358 sqlite3OsClose(&pPager->fd);
1359 }
drh8cfbf082001-09-19 13:22:39 +00001360 assert( pPager->journalOpen==0 );
drh0f892532002-05-30 12:27:03 +00001361 /* Temp files are automatically deleted by the OS
1362 ** if( pPager->tempFile ){
danielk19774adee202004-05-08 08:23:19 +00001363 ** sqlite3OsDelete(pPager->zFilename);
drh0f892532002-05-30 12:27:03 +00001364 ** }
1365 */
drhdb48ee02003-01-16 13:42:43 +00001366 CLR_PAGER(pPager);
drh73509ee2003-04-06 20:44:45 +00001367 if( pPager->zFilename!=(char*)&pPager[1] ){
drha76c82e2003-07-27 18:59:42 +00001368 assert( 0 ); /* Cannot happen */
drh73509ee2003-04-06 20:44:45 +00001369 sqliteFree(pPager->zFilename);
1370 sqliteFree(pPager->zJournal);
drha76c82e2003-07-27 18:59:42 +00001371 sqliteFree(pPager->zDirectory);
drh73509ee2003-04-06 20:44:45 +00001372 }
drhed7c8552001-04-11 14:29:21 +00001373 sqliteFree(pPager);
1374 return SQLITE_OK;
1375}
1376
1377/*
drh5e00f6c2001-09-13 13:46:56 +00001378** Return the page number for the given page data.
drhed7c8552001-04-11 14:29:21 +00001379*/
drh3aac2dd2004-04-26 14:10:20 +00001380Pgno sqlite3pager_pagenumber(void *pData){
drhed7c8552001-04-11 14:29:21 +00001381 PgHdr *p = DATA_TO_PGHDR(pData);
1382 return p->pgno;
1383}
1384
1385/*
drhc8629a12004-05-08 20:07:40 +00001386** The page_ref() function increments the reference count for a page.
1387** If the page is currently on the freelist (the reference count is zero) then
drh7e3b0a02001-04-28 16:52:40 +00001388** remove it from the freelist.
drhc8629a12004-05-08 20:07:40 +00001389**
1390** For non-test systems, page_ref() is a macro that calls _page_ref()
1391** online of the reference count is zero. For test systems, page_ref()
1392** is a real function so that we can set breakpoints and trace it.
drh7e3b0a02001-04-28 16:52:40 +00001393*/
drh836faa42003-01-11 13:30:57 +00001394static void _page_ref(PgHdr *pPg){
drh7e3b0a02001-04-28 16:52:40 +00001395 if( pPg->nRef==0 ){
1396 /* The page is currently on the freelist. Remove it. */
drh341eae82003-01-21 02:39:36 +00001397 if( pPg==pPg->pPager->pFirstSynced ){
1398 PgHdr *p = pPg->pNextFree;
1399 while( p && p->needSync ){ p = p->pNextFree; }
1400 pPg->pPager->pFirstSynced = p;
1401 }
drh7e3b0a02001-04-28 16:52:40 +00001402 if( pPg->pPrevFree ){
1403 pPg->pPrevFree->pNextFree = pPg->pNextFree;
1404 }else{
1405 pPg->pPager->pFirst = pPg->pNextFree;
1406 }
1407 if( pPg->pNextFree ){
1408 pPg->pNextFree->pPrevFree = pPg->pPrevFree;
1409 }else{
1410 pPg->pPager->pLast = pPg->pPrevFree;
1411 }
1412 pPg->pPager->nRef++;
1413 }
1414 pPg->nRef++;
drhdd793422001-06-28 01:54:48 +00001415 REFINFO(pPg);
drhdf0b3b02001-06-23 11:36:20 +00001416}
drhc8629a12004-05-08 20:07:40 +00001417#ifdef SQLITE_TEST
1418 static void page_ref(PgHdr *pPg){
1419 if( pPg->nRef==0 ){
1420 _page_ref(pPg);
1421 }else{
1422 pPg->nRef++;
1423 REFINFO(pPg);
1424 }
1425 }
1426#else
1427# define page_ref(P) ((P)->nRef==0?_page_ref(P):(void)(P)->nRef++)
1428#endif
drhdf0b3b02001-06-23 11:36:20 +00001429
1430/*
1431** Increment the reference count for a page. The input pointer is
1432** a reference to the page data.
1433*/
drh3aac2dd2004-04-26 14:10:20 +00001434int sqlite3pager_ref(void *pData){
drhdf0b3b02001-06-23 11:36:20 +00001435 PgHdr *pPg = DATA_TO_PGHDR(pData);
1436 page_ref(pPg);
drh8c42ca92001-06-22 19:15:00 +00001437 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +00001438}
1439
1440/*
drh34e79ce2004-02-08 06:05:46 +00001441** Sync the journal. In other words, make sure all the pages that have
1442** been written to the journal have actually reached the surface of the
1443** disk. It is not safe to modify the original database file until after
1444** the journal has been synced. If the original database is modified before
1445** the journal is synced and a power failure occurs, the unsynced journal
1446** data would be lost and we would be unable to completely rollback the
1447** database changes. Database corruption would occur.
1448**
1449** This routine also updates the nRec field in the header of the journal.
1450** (See comments on the pager_playback() routine for additional information.)
1451** If the sync mode is FULL, two syncs will occur. First the whole journal
1452** is synced, then the nRec field is updated, then a second sync occurs.
drhb19a2bc2001-09-16 00:13:26 +00001453**
drh34e79ce2004-02-08 06:05:46 +00001454** For temporary databases, we do not care if we are able to rollback
1455** after a power failure, so sync occurs.
drhfa86c412002-02-02 15:01:15 +00001456**
drh34e79ce2004-02-08 06:05:46 +00001457** This routine clears the needSync field of every page current held in
1458** memory.
drh50e5dad2001-09-15 00:57:28 +00001459*/
danielk197713adf8a2004-06-03 16:08:41 +00001460static int syncJournal(Pager *pPager, const char *zMaster){
drh50e5dad2001-09-15 00:57:28 +00001461 PgHdr *pPg;
1462 int rc = SQLITE_OK;
drh03eb96a2002-11-10 23:32:56 +00001463
1464 /* Sync the journal before modifying the main database
1465 ** (assuming there is a journal and it needs to be synced.)
1466 */
danielk197713adf8a2004-06-03 16:08:41 +00001467 if( pPager->needSync || zMaster ){
drhfa86c412002-02-02 15:01:15 +00001468 if( !pPager->tempFile ){
drhdb48ee02003-01-16 13:42:43 +00001469 assert( pPager->journalOpen );
drh946966f2004-02-25 02:20:41 +00001470 /* assert( !pPager->noSync ); // noSync might be set if synchronous
1471 ** was turned off after the transaction was started. Ticket #615 */
drh968af522003-02-11 14:55:40 +00001472#ifndef NDEBUG
1473 {
drh34e79ce2004-02-08 06:05:46 +00001474 /* Make sure the pPager->nRec counter we are keeping agrees
1475 ** with the nRec computed from the size of the journal file.
1476 */
drh4a0681e2003-02-13 01:58:20 +00001477 off_t hdrSz, pgSz, jSz;
drhae2b40c2004-06-09 19:03:54 +00001478 hdrSz = JOURNAL_HDR_SZ(pPager);
1479 pgSz = JOURNAL_PG_SZ(pPager);
danielk19774adee202004-05-08 08:23:19 +00001480 rc = sqlite3OsFileSize(&pPager->jfd, &jSz);
drh968af522003-02-11 14:55:40 +00001481 if( rc!=0 ) return rc;
drh4a0681e2003-02-13 01:58:20 +00001482 assert( pPager->nRec*pgSz+hdrSz==jSz );
drh968af522003-02-11 14:55:40 +00001483 }
1484#endif
drhae2b40c2004-06-09 19:03:54 +00001485 {
drh34e79ce2004-02-08 06:05:46 +00001486 /* Write the nRec value into the journal file header */
drhd8d66e82003-02-12 02:10:15 +00001487 off_t szJ;
1488 if( pPager->fullSync ){
drha6abd042004-06-09 17:37:22 +00001489 TRACE2("SYNC journal of %d\n", pPager->fd.h);
danielk19774adee202004-05-08 08:23:19 +00001490 rc = sqlite3OsSync(&pPager->jfd);
drhd8d66e82003-02-12 02:10:15 +00001491 if( rc!=0 ) return rc;
1492 }
drhae2b40c2004-06-09 19:03:54 +00001493 sqlite3OsSeek(&pPager->jfd, sizeof(aJournalMagic));
drh99ee3602003-02-16 19:13:36 +00001494 rc = write32bits(&pPager->jfd, pPager->nRec);
1495 if( rc ) return rc;
danielk197713adf8a2004-06-03 16:08:41 +00001496
1497 /* Write the name of the master journal file if one is specified */
1498 if( zMaster ){
1499 assert( strlen(zMaster)<pPager->nMaster );
drhae2b40c2004-06-09 19:03:54 +00001500 rc = sqlite3OsSeek(&pPager->jfd, 20);
danielk197713adf8a2004-06-03 16:08:41 +00001501 if( rc ) return rc;
1502 rc = sqlite3OsWrite(&pPager->jfd, zMaster, strlen(zMaster)+1);
1503 if( rc ) return rc;
1504 }
1505
drhae2b40c2004-06-09 19:03:54 +00001506 szJ = JOURNAL_HDR_SZ(pPager) + pPager->nRec*JOURNAL_PG_SZ(pPager);
danielk19774adee202004-05-08 08:23:19 +00001507 sqlite3OsSeek(&pPager->jfd, szJ);
drh968af522003-02-11 14:55:40 +00001508 }
drha6abd042004-06-09 17:37:22 +00001509 TRACE2("SYNC journal of %d\n", pPager->fd.h);
danielk19774adee202004-05-08 08:23:19 +00001510 rc = sqlite3OsSync(&pPager->jfd);
drhfa86c412002-02-02 15:01:15 +00001511 if( rc!=0 ) return rc;
drhdb48ee02003-01-16 13:42:43 +00001512 pPager->journalStarted = 1;
drhfa86c412002-02-02 15:01:15 +00001513 }
drh50e5dad2001-09-15 00:57:28 +00001514 pPager->needSync = 0;
drh341eae82003-01-21 02:39:36 +00001515
1516 /* Erase the needSync flag from every page.
1517 */
1518 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
1519 pPg->needSync = 0;
1520 }
1521 pPager->pFirstSynced = pPager->pFirst;
drh50e5dad2001-09-15 00:57:28 +00001522 }
drh03eb96a2002-11-10 23:32:56 +00001523
drh341eae82003-01-21 02:39:36 +00001524#ifndef NDEBUG
1525 /* If the Pager.needSync flag is clear then the PgHdr.needSync
1526 ** flag must also be clear for all pages. Verify that this
1527 ** invariant is true.
drh03eb96a2002-11-10 23:32:56 +00001528 */
drh341eae82003-01-21 02:39:36 +00001529 else{
1530 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
1531 assert( pPg->needSync==0 );
1532 }
1533 assert( pPager->pFirstSynced==pPager->pFirst );
drh03eb96a2002-11-10 23:32:56 +00001534 }
drh341eae82003-01-21 02:39:36 +00001535#endif
drhdb48ee02003-01-16 13:42:43 +00001536
drh81a20f22001-10-12 17:30:04 +00001537 return rc;
drh50e5dad2001-09-15 00:57:28 +00001538}
1539
1540/*
drh2554f8b2003-01-22 01:26:44 +00001541** Given a list of pages (connected by the PgHdr.pDirty pointer) write
1542** every one of those pages out to the database file and mark them all
1543** as clean.
1544*/
1545static int pager_write_pagelist(PgHdr *pList){
1546 Pager *pPager;
1547 int rc;
danielk19779eed5052004-06-04 10:38:30 +00001548 int busy = 1;
drh2554f8b2003-01-22 01:26:44 +00001549
1550 if( pList==0 ) return SQLITE_OK;
1551 pPager = pList->pPager;
danielk19779eed5052004-06-04 10:38:30 +00001552
1553 /* At this point there may be either a RESERVED or EXCLUSIVE lock on the
1554 ** database file. If there is already an EXCLUSIVE lock, the following
1555 ** calls to sqlite3OsLock() are no-ops.
1556 **
drha6abd042004-06-09 17:37:22 +00001557 ** Moving the lock from RESERVED to EXCLUSIVE actually involves going
1558 ** through an intermediate state PENDING. A PENDING lock prevents new
1559 ** readers from attaching to the database but is unsufficient for us to
1560 ** write. The idea of a PENDING lock is to prevent new readers from
1561 ** coming in while we wait for existing readers to clear.
danielk19779eed5052004-06-04 10:38:30 +00001562 **
drha6abd042004-06-09 17:37:22 +00001563 ** While the pager is in the RESERVED state, the original database file
1564 ** is unchanged and we can rollback without having to playback the
1565 ** journal into the original database file. Once we transition to
1566 ** EXCLUSIVE, it means the database file has been changed and any rollback
1567 ** will require a journal playback.
danielk19779eed5052004-06-04 10:38:30 +00001568 */
danielk19779eed5052004-06-04 10:38:30 +00001569 do {
1570 rc = sqlite3OsLock(&pPager->fd, EXCLUSIVE_LOCK);
1571 }while( rc==SQLITE_BUSY &&
1572 pPager->pBusyHandler &&
1573 pPager->pBusyHandler->xFunc &&
danielk19772a764eb2004-06-12 01:43:26 +00001574 pPager->pBusyHandler->xFunc(pPager->pBusyHandler->pArg, busy++)
danielk19779eed5052004-06-04 10:38:30 +00001575 );
1576 if( rc!=SQLITE_OK ){
1577 return rc;
1578 }
drha6abd042004-06-09 17:37:22 +00001579 pPager->state = PAGER_EXCLUSIVE;
danielk19779eed5052004-06-04 10:38:30 +00001580
drh2554f8b2003-01-22 01:26:44 +00001581 while( pList ){
1582 assert( pList->dirty );
danielk19774adee202004-05-08 08:23:19 +00001583 sqlite3OsSeek(&pPager->fd, (pList->pgno-1)*(off_t)SQLITE_PAGE_SIZE);
drh9eb9e262004-02-11 02:18:05 +00001584 CODEC(pPager, PGHDR_TO_DATA(pList), pList->pgno, 6);
drha6abd042004-06-09 17:37:22 +00001585 TRACE2("STORE page %d\n", pList->pgno);
danielk19774adee202004-05-08 08:23:19 +00001586 rc = sqlite3OsWrite(&pPager->fd, PGHDR_TO_DATA(pList), SQLITE_PAGE_SIZE);
drh9eb9e262004-02-11 02:18:05 +00001587 CODEC(pPager, PGHDR_TO_DATA(pList), pList->pgno, 0);
drh2554f8b2003-01-22 01:26:44 +00001588 if( rc ) return rc;
1589 pList->dirty = 0;
1590 pList = pList->pDirty;
1591 }
1592 return SQLITE_OK;
1593}
1594
1595/*
1596** Collect every dirty page into a dirty list and
1597** return a pointer to the head of that list. All pages are
1598** collected even if they are still in use.
1599*/
1600static PgHdr *pager_get_all_dirty_pages(Pager *pPager){
1601 PgHdr *p, *pList;
1602 pList = 0;
1603 for(p=pPager->pAll; p; p=p->pNextAll){
1604 if( p->dirty ){
1605 p->pDirty = pList;
1606 pList = p;
1607 }
1608 }
1609 return pList;
1610}
1611
1612/*
drhd9b02572001-04-15 00:37:09 +00001613** Acquire a page.
1614**
drh58a11682001-11-10 13:51:08 +00001615** A read lock on the disk file is obtained when the first page is acquired.
drh5e00f6c2001-09-13 13:46:56 +00001616** This read lock is dropped when the last page is released.
drhd9b02572001-04-15 00:37:09 +00001617**
drh306dc212001-05-21 13:45:10 +00001618** A _get works for any page number greater than 0. If the database
1619** file is smaller than the requested page, then no actual disk
1620** read occurs and the memory image of the page is initialized to
1621** all zeros. The extra data appended to a page is always initialized
1622** to zeros the first time a page is loaded into memory.
1623**
drhd9b02572001-04-15 00:37:09 +00001624** The acquisition might fail for several reasons. In all cases,
1625** an appropriate error code is returned and *ppPage is set to NULL.
drh7e3b0a02001-04-28 16:52:40 +00001626**
drh3aac2dd2004-04-26 14:10:20 +00001627** See also sqlite3pager_lookup(). Both this routine and _lookup() attempt
drh7e3b0a02001-04-28 16:52:40 +00001628** to find a page in the in-memory cache first. If the page is not already
drh5e00f6c2001-09-13 13:46:56 +00001629** in memory, this routine goes to disk to read it in whereas _lookup()
drh7e3b0a02001-04-28 16:52:40 +00001630** just returns 0. This routine acquires a read-lock the first time it
1631** has to go to disk, and could also playback an old journal if necessary.
1632** Since _lookup() never goes to disk, it never has to deal with locks
1633** or journal files.
drhed7c8552001-04-11 14:29:21 +00001634*/
drh3aac2dd2004-04-26 14:10:20 +00001635int sqlite3pager_get(Pager *pPager, Pgno pgno, void **ppPage){
drhed7c8552001-04-11 14:29:21 +00001636 PgHdr *pPg;
drh8766c342002-11-09 00:33:15 +00001637 int rc;
drhed7c8552001-04-11 14:29:21 +00001638
drhd9b02572001-04-15 00:37:09 +00001639 /* Make sure we have not hit any critical errors.
1640 */
drh836faa42003-01-11 13:30:57 +00001641 assert( pPager!=0 );
1642 assert( pgno!=0 );
drh2e6d11b2003-04-25 15:37:57 +00001643 *ppPage = 0;
drhd9b02572001-04-15 00:37:09 +00001644 if( pPager->errMask & ~(PAGER_ERR_FULL) ){
1645 return pager_errcode(pPager);
1646 }
1647
danielk197713adf8a2004-06-03 16:08:41 +00001648 /* If this is the first page accessed, then get a SHARED lock
drhed7c8552001-04-11 14:29:21 +00001649 ** on the database file.
1650 */
drhac69b052004-05-12 13:30:07 +00001651 if( pPager->nRef==0 && !pPager->memDb ){
danielk197724162fe2004-06-04 06:22:00 +00001652 int busy = 1;
danielk19779eed5052004-06-04 10:38:30 +00001653 do {
1654 rc = sqlite3OsLock(&pPager->fd, SHARED_LOCK);
1655 }while( rc==SQLITE_BUSY &&
1656 pPager->pBusyHandler &&
1657 pPager->pBusyHandler->xFunc &&
danielk19772a764eb2004-06-12 01:43:26 +00001658 pPager->pBusyHandler->xFunc(pPager->pBusyHandler->pArg, busy++)
danielk19779eed5052004-06-04 10:38:30 +00001659 );
1660 if( rc!=SQLITE_OK ){
1661 return rc;
drhed7c8552001-04-11 14:29:21 +00001662 }
drha6abd042004-06-09 17:37:22 +00001663 pPager->state = PAGER_SHARED;
drhed7c8552001-04-11 14:29:21 +00001664
danielk197713adf8a2004-06-03 16:08:41 +00001665 /* If a journal file exists, and there is no RESERVED lock on the
1666 ** database file, then it either needs to be played back or deleted.
drhed7c8552001-04-11 14:29:21 +00001667 */
danielk197713adf8a2004-06-03 16:08:41 +00001668 if( pPager->useJournal &&
1669 sqlite3OsFileExists(pPager->zJournal) &&
drha6abd042004-06-09 17:37:22 +00001670 !sqlite3OsCheckReservedLock(&pPager->fd)
danielk197713adf8a2004-06-03 16:08:41 +00001671 ){
drhe2227f02003-06-14 11:42:57 +00001672 int rc;
drhed7c8552001-04-11 14:29:21 +00001673
danielk197713adf8a2004-06-03 16:08:41 +00001674 /* Get an EXCLUSIVE lock on the database file. */
1675 rc = sqlite3OsLock(&pPager->fd, EXCLUSIVE_LOCK);
drha7fcb052001-12-14 15:09:55 +00001676 if( rc!=SQLITE_OK ){
drha6abd042004-06-09 17:37:22 +00001677 sqlite3OsUnlock(&pPager->fd, NO_LOCK);
1678 pPager->state = PAGER_UNLOCK;
drh8766c342002-11-09 00:33:15 +00001679 return rc;
drha7fcb052001-12-14 15:09:55 +00001680 }
drha6abd042004-06-09 17:37:22 +00001681 pPager->state = PAGER_EXCLUSIVE;
drha7fcb052001-12-14 15:09:55 +00001682
drhe2227f02003-06-14 11:42:57 +00001683 /* Open the journal for reading only. Return SQLITE_BUSY if
1684 ** we are unable to open the journal file.
drhf57b3392001-10-08 13:22:32 +00001685 **
drhe2227f02003-06-14 11:42:57 +00001686 ** The journal file does not need to be locked itself. The
1687 ** journal file is never open unless the main database file holds
1688 ** a write lock, so there is never any chance of two or more
1689 ** processes opening the journal at the same time.
drhed7c8552001-04-11 14:29:21 +00001690 */
danielk19774adee202004-05-08 08:23:19 +00001691 rc = sqlite3OsOpenReadOnly(pPager->zJournal, &pPager->jfd);
drha7fcb052001-12-14 15:09:55 +00001692 if( rc!=SQLITE_OK ){
drha6abd042004-06-09 17:37:22 +00001693 sqlite3OsUnlock(&pPager->fd, NO_LOCK);
1694 pPager->state = PAGER_UNLOCK;
drhed7c8552001-04-11 14:29:21 +00001695 return SQLITE_BUSY;
1696 }
drha7fcb052001-12-14 15:09:55 +00001697 pPager->journalOpen = 1;
drhdb48ee02003-01-16 13:42:43 +00001698 pPager->journalStarted = 0;
drhed7c8552001-04-11 14:29:21 +00001699
1700 /* Playback and delete the journal. Drop the database write
1701 ** lock and reacquire the read lock.
1702 */
drh99ee3602003-02-16 19:13:36 +00001703 rc = pager_playback(pPager, 0);
drhd9b02572001-04-15 00:37:09 +00001704 if( rc!=SQLITE_OK ){
1705 return rc;
1706 }
drhed7c8552001-04-11 14:29:21 +00001707 }
1708 pPg = 0;
1709 }else{
1710 /* Search for page in cache */
drhd9b02572001-04-15 00:37:09 +00001711 pPg = pager_lookup(pPager, pgno);
drha6abd042004-06-09 17:37:22 +00001712 if( pPager->memDb && pPager->state==PAGER_UNLOCK ){
1713 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00001714 }
drhed7c8552001-04-11 14:29:21 +00001715 }
1716 if( pPg==0 ){
drhd9b02572001-04-15 00:37:09 +00001717 /* The requested page is not in the page cache. */
drhed7c8552001-04-11 14:29:21 +00001718 int h;
drh7e3b0a02001-04-28 16:52:40 +00001719 pPager->nMiss++;
drhac69b052004-05-12 13:30:07 +00001720 if( pPager->nPage<pPager->mxPage || pPager->pFirst==0 || pPager->memDb ){
drhed7c8552001-04-11 14:29:21 +00001721 /* Create a new page */
drhd0ba1932004-02-10 01:54:28 +00001722 pPg = sqliteMallocRaw( sizeof(*pPg) + SQLITE_PAGE_SIZE
drhac69b052004-05-12 13:30:07 +00001723 + sizeof(u32) + pPager->nExtra
1724 + pPager->memDb*sizeof(PgHistory) );
drhd9b02572001-04-15 00:37:09 +00001725 if( pPg==0 ){
drhd9b02572001-04-15 00:37:09 +00001726 pager_unwritelock(pPager);
1727 pPager->errMask |= PAGER_ERR_MEM;
1728 return SQLITE_NOMEM;
1729 }
drh8c1238a2003-01-02 14:43:55 +00001730 memset(pPg, 0, sizeof(*pPg));
drhac69b052004-05-12 13:30:07 +00001731 if( pPager->memDb ){
1732 memset(PGHDR_TO_HIST(pPg, pPager), 0, sizeof(PgHistory));
1733 }
drhed7c8552001-04-11 14:29:21 +00001734 pPg->pPager = pPager;
drhd9b02572001-04-15 00:37:09 +00001735 pPg->pNextAll = pPager->pAll;
drhd79caeb2001-04-15 02:27:24 +00001736 pPager->pAll = pPg;
drhd9b02572001-04-15 00:37:09 +00001737 pPager->nPage++;
drhed7c8552001-04-11 14:29:21 +00001738 }else{
drhdb48ee02003-01-16 13:42:43 +00001739 /* Find a page to recycle. Try to locate a page that does not
1740 ** require us to do an fsync() on the journal.
1741 */
drh341eae82003-01-21 02:39:36 +00001742 pPg = pPager->pFirstSynced;
drhb19a2bc2001-09-16 00:13:26 +00001743
drhdb48ee02003-01-16 13:42:43 +00001744 /* If we could not find a page that does not require an fsync()
1745 ** on the journal file then fsync the journal file. This is a
1746 ** very slow operation, so we work hard to avoid it. But sometimes
1747 ** it can't be helped.
drhb19a2bc2001-09-16 00:13:26 +00001748 */
drh603240c2002-03-05 01:11:12 +00001749 if( pPg==0 ){
danielk197713adf8a2004-06-03 16:08:41 +00001750 int rc = syncJournal(pPager, 0);
drh50e5dad2001-09-15 00:57:28 +00001751 if( rc!=0 ){
drh3aac2dd2004-04-26 14:10:20 +00001752 sqlite3pager_rollback(pPager);
drh50e5dad2001-09-15 00:57:28 +00001753 return SQLITE_IOERR;
1754 }
1755 pPg = pPager->pFirst;
1756 }
drhd9b02572001-04-15 00:37:09 +00001757 assert( pPg->nRef==0 );
drhdb48ee02003-01-16 13:42:43 +00001758
1759 /* Write the page to the database file if it is dirty.
1760 */
1761 if( pPg->dirty ){
1762 assert( pPg->needSync==0 );
drh2554f8b2003-01-22 01:26:44 +00001763 pPg->pDirty = 0;
1764 rc = pager_write_pagelist( pPg );
drhdb48ee02003-01-16 13:42:43 +00001765 if( rc!=SQLITE_OK ){
drh3aac2dd2004-04-26 14:10:20 +00001766 sqlite3pager_rollback(pPager);
drhdb48ee02003-01-16 13:42:43 +00001767 return SQLITE_IOERR;
1768 }
drhdb48ee02003-01-16 13:42:43 +00001769 }
drh50e5dad2001-09-15 00:57:28 +00001770 assert( pPg->dirty==0 );
drhd9b02572001-04-15 00:37:09 +00001771
drhdb48ee02003-01-16 13:42:43 +00001772 /* If the page we are recycling is marked as alwaysRollback, then
drh193a6b42002-07-07 16:52:46 +00001773 ** set the global alwaysRollback flag, thus disabling the
1774 ** sqlite_dont_rollback() optimization for the rest of this transaction.
1775 ** It is necessary to do this because the page marked alwaysRollback
1776 ** might be reloaded at a later time but at that point we won't remember
1777 ** that is was marked alwaysRollback. This means that all pages must
1778 ** be marked as alwaysRollback from here on out.
1779 */
1780 if( pPg->alwaysRollback ){
1781 pPager->alwaysRollback = 1;
1782 }
1783
drhd9b02572001-04-15 00:37:09 +00001784 /* Unlink the old page from the free list and the hash table
1785 */
drhac69b052004-05-12 13:30:07 +00001786 unlinkPage(pPg);
drhd9b02572001-04-15 00:37:09 +00001787 pPager->nOvfl++;
drhed7c8552001-04-11 14:29:21 +00001788 }
1789 pPg->pgno = pgno;
drh1ab43002002-01-14 09:28:19 +00001790 if( pPager->aInJournal && (int)pgno<=pPager->origDbSize ){
danielk19774adee202004-05-08 08:23:19 +00001791 sqlite3CheckMemory(pPager->aInJournal, pgno/8);
drhdb48ee02003-01-16 13:42:43 +00001792 assert( pPager->journalOpen );
drh6019e162001-07-02 17:51:45 +00001793 pPg->inJournal = (pPager->aInJournal[pgno/8] & (1<<(pgno&7)))!=0;
drhdb48ee02003-01-16 13:42:43 +00001794 pPg->needSync = 0;
drh6019e162001-07-02 17:51:45 +00001795 }else{
1796 pPg->inJournal = 0;
drhdb48ee02003-01-16 13:42:43 +00001797 pPg->needSync = 0;
drh6019e162001-07-02 17:51:45 +00001798 }
drhac69b052004-05-12 13:30:07 +00001799 if( pPager->aInStmt && (int)pgno<=pPager->stmtSize
1800 && (pPager->aInStmt[pgno/8] & (1<<(pgno&7)))!=0 ){
drh3aac2dd2004-04-26 14:10:20 +00001801 page_add_to_stmt_list(pPg);
drhfa86c412002-02-02 15:01:15 +00001802 }else{
drh3aac2dd2004-04-26 14:10:20 +00001803 page_remove_from_stmt_list(pPg);
drhfa86c412002-02-02 15:01:15 +00001804 }
drhed7c8552001-04-11 14:29:21 +00001805 pPg->dirty = 0;
1806 pPg->nRef = 1;
drhdd793422001-06-28 01:54:48 +00001807 REFINFO(pPg);
drhd9b02572001-04-15 00:37:09 +00001808 pPager->nRef++;
1809 h = pager_hash(pgno);
drhed7c8552001-04-11 14:29:21 +00001810 pPg->pNextHash = pPager->aHash[h];
1811 pPager->aHash[h] = pPg;
1812 if( pPg->pNextHash ){
1813 assert( pPg->pNextHash->pPrevHash==0 );
1814 pPg->pNextHash->pPrevHash = pPg;
1815 }
drh2e6d11b2003-04-25 15:37:57 +00001816 if( pPager->nExtra>0 ){
1817 memset(PGHDR_TO_EXTRA(pPg), 0, pPager->nExtra);
1818 }
drh3aac2dd2004-04-26 14:10:20 +00001819 if( pPager->dbSize<0 ) sqlite3pager_pagecount(pPager);
drh2e6d11b2003-04-25 15:37:57 +00001820 if( pPager->errMask!=0 ){
drh3aac2dd2004-04-26 14:10:20 +00001821 sqlite3pager_unref(PGHDR_TO_DATA(pPg));
drh2e6d11b2003-04-25 15:37:57 +00001822 rc = pager_errcode(pPager);
1823 return rc;
1824 }
drh1ab43002002-01-14 09:28:19 +00001825 if( pPager->dbSize<(int)pgno ){
drhd0ba1932004-02-10 01:54:28 +00001826 memset(PGHDR_TO_DATA(pPg), 0, SQLITE_PAGE_SIZE);
drh306dc212001-05-21 13:45:10 +00001827 }else{
drh81a20f22001-10-12 17:30:04 +00001828 int rc;
drhac69b052004-05-12 13:30:07 +00001829 assert( pPager->memDb==0 );
danielk19774adee202004-05-08 08:23:19 +00001830 sqlite3OsSeek(&pPager->fd, (pgno-1)*(off_t)SQLITE_PAGE_SIZE);
1831 rc = sqlite3OsRead(&pPager->fd, PGHDR_TO_DATA(pPg), SQLITE_PAGE_SIZE);
drha6abd042004-06-09 17:37:22 +00001832 TRACE2("FETCH page %d\n", pPg->pgno);
drh9eb9e262004-02-11 02:18:05 +00001833 CODEC(pPager, PGHDR_TO_DATA(pPg), pPg->pgno, 3);
drh81a20f22001-10-12 17:30:04 +00001834 if( rc!=SQLITE_OK ){
drh28be87c2002-11-05 23:03:02 +00001835 off_t fileSize;
danielk19774adee202004-05-08 08:23:19 +00001836 if( sqlite3OsFileSize(&pPager->fd,&fileSize)!=SQLITE_OK
drhd0ba1932004-02-10 01:54:28 +00001837 || fileSize>=pgno*SQLITE_PAGE_SIZE ){
drh3aac2dd2004-04-26 14:10:20 +00001838 sqlite3pager_unref(PGHDR_TO_DATA(pPg));
drh4e371ee2002-09-05 16:08:27 +00001839 return rc;
1840 }else{
drhd0ba1932004-02-10 01:54:28 +00001841 memset(PGHDR_TO_DATA(pPg), 0, SQLITE_PAGE_SIZE);
drh4e371ee2002-09-05 16:08:27 +00001842 }
drh81a20f22001-10-12 17:30:04 +00001843 }
drh306dc212001-05-21 13:45:10 +00001844 }
drhed7c8552001-04-11 14:29:21 +00001845 }else{
drhd9b02572001-04-15 00:37:09 +00001846 /* The requested page is in the page cache. */
drh7e3b0a02001-04-28 16:52:40 +00001847 pPager->nHit++;
drhdf0b3b02001-06-23 11:36:20 +00001848 page_ref(pPg);
drhed7c8552001-04-11 14:29:21 +00001849 }
1850 *ppPage = PGHDR_TO_DATA(pPg);
1851 return SQLITE_OK;
1852}
1853
1854/*
drh7e3b0a02001-04-28 16:52:40 +00001855** Acquire a page if it is already in the in-memory cache. Do
1856** not read the page from disk. Return a pointer to the page,
1857** or 0 if the page is not in cache.
1858**
drh3aac2dd2004-04-26 14:10:20 +00001859** See also sqlite3pager_get(). The difference between this routine
1860** and sqlite3pager_get() is that _get() will go to the disk and read
drh7e3b0a02001-04-28 16:52:40 +00001861** in the page if the page is not already in cache. This routine
drh5e00f6c2001-09-13 13:46:56 +00001862** returns NULL if the page is not in cache or if a disk I/O error
1863** has ever happened.
drh7e3b0a02001-04-28 16:52:40 +00001864*/
drh3aac2dd2004-04-26 14:10:20 +00001865void *sqlite3pager_lookup(Pager *pPager, Pgno pgno){
drh7e3b0a02001-04-28 16:52:40 +00001866 PgHdr *pPg;
1867
drh836faa42003-01-11 13:30:57 +00001868 assert( pPager!=0 );
1869 assert( pgno!=0 );
drh7e3b0a02001-04-28 16:52:40 +00001870 if( pPager->errMask & ~(PAGER_ERR_FULL) ){
1871 return 0;
1872 }
drh7e3b0a02001-04-28 16:52:40 +00001873 pPg = pager_lookup(pPager, pgno);
1874 if( pPg==0 ) return 0;
drhdf0b3b02001-06-23 11:36:20 +00001875 page_ref(pPg);
drh7e3b0a02001-04-28 16:52:40 +00001876 return PGHDR_TO_DATA(pPg);
1877}
1878
1879/*
drhed7c8552001-04-11 14:29:21 +00001880** Release a page.
1881**
1882** If the number of references to the page drop to zero, then the
1883** page is added to the LRU list. When all references to all pages
drhd9b02572001-04-15 00:37:09 +00001884** are released, a rollback occurs and the lock on the database is
drhed7c8552001-04-11 14:29:21 +00001885** removed.
1886*/
drh3aac2dd2004-04-26 14:10:20 +00001887int sqlite3pager_unref(void *pData){
drhed7c8552001-04-11 14:29:21 +00001888 PgHdr *pPg;
drhd9b02572001-04-15 00:37:09 +00001889
1890 /* Decrement the reference count for this page
1891 */
drhed7c8552001-04-11 14:29:21 +00001892 pPg = DATA_TO_PGHDR(pData);
1893 assert( pPg->nRef>0 );
drhed7c8552001-04-11 14:29:21 +00001894 pPg->nRef--;
drhdd793422001-06-28 01:54:48 +00001895 REFINFO(pPg);
drhd9b02572001-04-15 00:37:09 +00001896
drh72f82862001-05-24 21:06:34 +00001897 /* When the number of references to a page reach 0, call the
1898 ** destructor and add the page to the freelist.
drhd9b02572001-04-15 00:37:09 +00001899 */
drhed7c8552001-04-11 14:29:21 +00001900 if( pPg->nRef==0 ){
drh1eaa2692001-09-18 02:02:23 +00001901 Pager *pPager;
1902 pPager = pPg->pPager;
drhd9b02572001-04-15 00:37:09 +00001903 pPg->pNextFree = 0;
1904 pPg->pPrevFree = pPager->pLast;
drhed7c8552001-04-11 14:29:21 +00001905 pPager->pLast = pPg;
drhd9b02572001-04-15 00:37:09 +00001906 if( pPg->pPrevFree ){
1907 pPg->pPrevFree->pNextFree = pPg;
drhed7c8552001-04-11 14:29:21 +00001908 }else{
1909 pPager->pFirst = pPg;
1910 }
drh341eae82003-01-21 02:39:36 +00001911 if( pPg->needSync==0 && pPager->pFirstSynced==0 ){
1912 pPager->pFirstSynced = pPg;
1913 }
drh72f82862001-05-24 21:06:34 +00001914 if( pPager->xDestructor ){
drhb6f41482004-05-14 01:58:11 +00001915 pPager->xDestructor(pData, pPager->pageSize);
drh72f82862001-05-24 21:06:34 +00001916 }
drhd9b02572001-04-15 00:37:09 +00001917
1918 /* When all pages reach the freelist, drop the read lock from
1919 ** the database file.
1920 */
1921 pPager->nRef--;
1922 assert( pPager->nRef>=0 );
drhac69b052004-05-12 13:30:07 +00001923 if( pPager->nRef==0 && !pPager->memDb ){
drhd9b02572001-04-15 00:37:09 +00001924 pager_reset(pPager);
1925 }
drhed7c8552001-04-11 14:29:21 +00001926 }
drhd9b02572001-04-15 00:37:09 +00001927 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +00001928}
1929
1930/*
drha6abd042004-06-09 17:37:22 +00001931** Create a journal file for pPager. There should already be a RESERVED
1932** or EXCLUSIVE lock on the database file when this routine is called.
drhda47d772002-12-02 04:25:19 +00001933**
1934** Return SQLITE_OK if everything. Return an error code and release the
1935** write lock if anything goes wrong.
1936*/
1937static int pager_open_journal(Pager *pPager){
1938 int rc;
drha6abd042004-06-09 17:37:22 +00001939 assert( pPager->state>=PAGER_RESERVED );
drhda47d772002-12-02 04:25:19 +00001940 assert( pPager->journalOpen==0 );
1941 assert( pPager->useJournal );
drh3aac2dd2004-04-26 14:10:20 +00001942 sqlite3pager_pagecount(pPager);
drhda47d772002-12-02 04:25:19 +00001943 pPager->aInJournal = sqliteMalloc( pPager->dbSize/8 + 1 );
1944 if( pPager->aInJournal==0 ){
drha6abd042004-06-09 17:37:22 +00001945 sqlite3OsUnlock(&pPager->fd, SHARED_LOCK);
1946 pPager->state = PAGER_SHARED;
drhda47d772002-12-02 04:25:19 +00001947 return SQLITE_NOMEM;
1948 }
danielk19774adee202004-05-08 08:23:19 +00001949 rc = sqlite3OsOpenExclusive(pPager->zJournal, &pPager->jfd,pPager->tempFile);
drhda47d772002-12-02 04:25:19 +00001950 if( rc!=SQLITE_OK ){
1951 sqliteFree(pPager->aInJournal);
1952 pPager->aInJournal = 0;
drha6abd042004-06-09 17:37:22 +00001953 sqlite3OsUnlock(&pPager->fd, SHARED_LOCK);
1954 pPager->state = PAGER_SHARED;
drhda47d772002-12-02 04:25:19 +00001955 return SQLITE_CANTOPEN;
1956 }
danielk19774adee202004-05-08 08:23:19 +00001957 sqlite3OsOpenDirectory(pPager->zDirectory, &pPager->jfd);
drhda47d772002-12-02 04:25:19 +00001958 pPager->journalOpen = 1;
drhdb48ee02003-01-16 13:42:43 +00001959 pPager->journalStarted = 0;
drhda47d772002-12-02 04:25:19 +00001960 pPager->needSync = 0;
1961 pPager->alwaysRollback = 0;
drh968af522003-02-11 14:55:40 +00001962 pPager->nRec = 0;
drh2e6d11b2003-04-25 15:37:57 +00001963 if( pPager->errMask!=0 ){
1964 rc = pager_errcode(pPager);
1965 return rc;
1966 }
drhda47d772002-12-02 04:25:19 +00001967 pPager->origDbSize = pPager->dbSize;
drhae2b40c2004-06-09 19:03:54 +00001968
1969 /* Create the header for the journal:
1970 ** - 8 bytes: Magic identifying journal format.
1971 ** - 4 bytes: Number of records in journal, or -1 no-sync mode is on.
1972 ** - 4 bytes: Magic used for page checksums.
1973 ** - 4 bytes: Initial database page count.
1974 ** - 4 bytes: Number of bytes reserved for master journal ptr (nMaster)
1975 ** - nMaster bytes: Space for a master journal pointer.
1976 */
1977 rc = sqlite3OsWrite(&pPager->jfd, aJournalMagic, sizeof(aJournalMagic));
1978 if( rc==SQLITE_OK ){
1979 rc = write32bits(&pPager->jfd, pPager->noSync ? 0xffffffff : 0);
1980 }
1981 if( rc==SQLITE_OK ){
1982 sqlite3Randomness(sizeof(pPager->cksumInit), &pPager->cksumInit);
1983 rc = write32bits(&pPager->jfd, pPager->cksumInit);
drhda47d772002-12-02 04:25:19 +00001984 }
1985 if( rc==SQLITE_OK ){
1986 rc = write32bits(&pPager->jfd, pPager->dbSize);
1987 }
drhae2b40c2004-06-09 19:03:54 +00001988 if( rc==SQLITE_OK ){
1989 rc = write32bits(&pPager->jfd, pPager->nMaster);
1990 }
1991 if( rc==SQLITE_OK ){
drhc9e06862004-06-09 20:03:08 +00001992 sqlite3OsSeek(&pPager->jfd, 24 + pPager->nMaster - 1);
1993 rc = sqlite3OsWrite(&pPager->jfd, "\000", 1);
drhae2b40c2004-06-09 19:03:54 +00001994 }
drhac69b052004-05-12 13:30:07 +00001995 if( pPager->stmtAutoopen && rc==SQLITE_OK ){
drh3aac2dd2004-04-26 14:10:20 +00001996 rc = sqlite3pager_stmt_begin(pPager);
drhda47d772002-12-02 04:25:19 +00001997 }
1998 if( rc!=SQLITE_OK ){
1999 rc = pager_unwritelock(pPager);
2000 if( rc==SQLITE_OK ){
2001 rc = SQLITE_FULL;
2002 }
2003 }
2004 return rc;
2005}
2006
2007/*
drh4b845d72002-03-05 12:41:19 +00002008** Acquire a write-lock on the database. The lock is removed when
2009** the any of the following happen:
2010**
drh3aac2dd2004-04-26 14:10:20 +00002011** * sqlite3pager_commit() is called.
2012** * sqlite3pager_rollback() is called.
2013** * sqlite3pager_close() is called.
2014** * sqlite3pager_unref() is called to on every outstanding page.
drh4b845d72002-03-05 12:41:19 +00002015**
danielk197713adf8a2004-06-03 16:08:41 +00002016** The first parameter to this routine is a pointer to any open page of the
2017** database file. Nothing changes about the page - it is used merely to
2018** acquire a pointer to the Pager structure and as proof that there is
2019** already a read-lock on the database.
drh4b845d72002-03-05 12:41:19 +00002020**
danielk197713adf8a2004-06-03 16:08:41 +00002021** The second parameter indicates how much space in bytes to reserve for a
2022** master journal file-name at the start of the journal when it is created.
2023**
2024** A journal file is opened if this is not a temporary file. For temporary
2025** files, the opening of the journal file is deferred until there is an
2026** actual need to write to the journal.
drhda47d772002-12-02 04:25:19 +00002027**
drha6abd042004-06-09 17:37:22 +00002028** If the database is already reserved for writing, this routine is a no-op.
drh4b845d72002-03-05 12:41:19 +00002029*/
danielk197713adf8a2004-06-03 16:08:41 +00002030int sqlite3pager_begin(void *pData, int nMaster){
drh4b845d72002-03-05 12:41:19 +00002031 PgHdr *pPg = DATA_TO_PGHDR(pData);
2032 Pager *pPager = pPg->pPager;
2033 int rc = SQLITE_OK;
2034 assert( pPg->nRef>0 );
danielk197713adf8a2004-06-03 16:08:41 +00002035 assert( nMaster>=0 );
drha6abd042004-06-09 17:37:22 +00002036 assert( pPager->state!=PAGER_UNLOCK );
2037 if( pPager->state==PAGER_SHARED ){
drh4b845d72002-03-05 12:41:19 +00002038 assert( pPager->aInJournal==0 );
drhac69b052004-05-12 13:30:07 +00002039 if( pPager->memDb ){
drha6abd042004-06-09 17:37:22 +00002040 pPager->state = PAGER_EXCLUSIVE;
drhac69b052004-05-12 13:30:07 +00002041 pPager->origDbSize = pPager->dbSize;
2042 }else{
danielk197724162fe2004-06-04 06:22:00 +00002043 int busy = 1;
danielk19779eed5052004-06-04 10:38:30 +00002044 do {
danielk19779eed5052004-06-04 10:38:30 +00002045 rc = sqlite3OsLock(&pPager->fd, RESERVED_LOCK);
2046 }while( rc==SQLITE_BUSY &&
2047 pPager->pBusyHandler &&
2048 pPager->pBusyHandler->xFunc &&
danielk19772a764eb2004-06-12 01:43:26 +00002049 pPager->pBusyHandler->xFunc(pPager->pBusyHandler->pArg, busy++)
danielk19779eed5052004-06-04 10:38:30 +00002050 );
2051 if( rc!=SQLITE_OK ){
2052 return rc;
drhac69b052004-05-12 13:30:07 +00002053 }
danielk197713adf8a2004-06-03 16:08:41 +00002054 pPager->nMaster = nMaster;
drha6abd042004-06-09 17:37:22 +00002055 pPager->state = PAGER_RESERVED;
2056 pPager->dirtyCache = 0;
2057 TRACE3("TRANSACTION %d nMaster=%d\n", pPager->fd.h, nMaster);
drhac69b052004-05-12 13:30:07 +00002058 if( pPager->useJournal && !pPager->tempFile ){
2059 rc = pager_open_journal(pPager);
2060 }
drh4b845d72002-03-05 12:41:19 +00002061 }
2062 }
2063 return rc;
2064}
2065
2066/*
drhed7c8552001-04-11 14:29:21 +00002067** Mark a data page as writeable. The page is written into the journal
2068** if it is not there already. This routine must be called before making
2069** changes to a page.
2070**
2071** The first time this routine is called, the pager creates a new
drha6abd042004-06-09 17:37:22 +00002072** journal and acquires a RESERVED lock on the database. If the RESERVED
drhed7c8552001-04-11 14:29:21 +00002073** lock could not be acquired, this routine returns SQLITE_BUSY. The
drh306dc212001-05-21 13:45:10 +00002074** calling routine must check for that return value and be careful not to
drhed7c8552001-04-11 14:29:21 +00002075** change any page data until this routine returns SQLITE_OK.
drhd9b02572001-04-15 00:37:09 +00002076**
2077** If the journal file could not be written because the disk is full,
2078** then this routine returns SQLITE_FULL and does an immediate rollback.
2079** All subsequent write attempts also return SQLITE_FULL until there
drh3aac2dd2004-04-26 14:10:20 +00002080** is a call to sqlite3pager_commit() or sqlite3pager_rollback() to
drhd9b02572001-04-15 00:37:09 +00002081** reset.
drhed7c8552001-04-11 14:29:21 +00002082*/
drh3aac2dd2004-04-26 14:10:20 +00002083int sqlite3pager_write(void *pData){
drh69688d52001-04-14 16:38:23 +00002084 PgHdr *pPg = DATA_TO_PGHDR(pData);
2085 Pager *pPager = pPg->pPager;
drhd79caeb2001-04-15 02:27:24 +00002086 int rc = SQLITE_OK;
drh69688d52001-04-14 16:38:23 +00002087
drh6446c4d2001-12-15 14:22:18 +00002088 /* Check for errors
2089 */
drhd9b02572001-04-15 00:37:09 +00002090 if( pPager->errMask ){
2091 return pager_errcode(pPager);
2092 }
drh5e00f6c2001-09-13 13:46:56 +00002093 if( pPager->readOnly ){
2094 return SQLITE_PERM;
2095 }
drh6446c4d2001-12-15 14:22:18 +00002096
2097 /* Mark the page as dirty. If the page has already been written
2098 ** to the journal then we can return right away.
2099 */
drhd9b02572001-04-15 00:37:09 +00002100 pPg->dirty = 1;
drhac69b052004-05-12 13:30:07 +00002101 if( pPg->inJournal && (pPg->inStmt || pPager->stmtInUse==0) ){
drha6abd042004-06-09 17:37:22 +00002102 pPager->dirtyCache = 1;
drhfa86c412002-02-02 15:01:15 +00002103 return SQLITE_OK;
2104 }
drh6446c4d2001-12-15 14:22:18 +00002105
2106 /* If we get this far, it means that the page needs to be
drhfa86c412002-02-02 15:01:15 +00002107 ** written to the transaction journal or the ckeckpoint journal
2108 ** or both.
2109 **
2110 ** First check to see that the transaction journal exists and
2111 ** create it if it does not.
drh6446c4d2001-12-15 14:22:18 +00002112 */
drha6abd042004-06-09 17:37:22 +00002113 assert( pPager->state!=PAGER_UNLOCK );
danielk197713adf8a2004-06-03 16:08:41 +00002114 rc = sqlite3pager_begin(pData, 0);
drhda47d772002-12-02 04:25:19 +00002115 if( rc!=SQLITE_OK ){
2116 return rc;
2117 }
drha6abd042004-06-09 17:37:22 +00002118 assert( pPager->state>=PAGER_RESERVED );
drhda47d772002-12-02 04:25:19 +00002119 if( !pPager->journalOpen && pPager->useJournal ){
2120 rc = pager_open_journal(pPager);
2121 if( rc!=SQLITE_OK ) return rc;
2122 }
2123 assert( pPager->journalOpen || !pPager->useJournal );
drha6abd042004-06-09 17:37:22 +00002124 pPager->dirtyCache = 1;
drh6446c4d2001-12-15 14:22:18 +00002125
drha6abd042004-06-09 17:37:22 +00002126 /* The transaction journal now exists and we have a RESERVED or an
2127 ** EXCLUSIVE lock on the main database file. Write the current page to
2128 ** the transaction journal if it is not there already.
drh6446c4d2001-12-15 14:22:18 +00002129 */
drhac69b052004-05-12 13:30:07 +00002130 if( !pPg->inJournal && (pPager->useJournal || pPager->memDb) ){
drhdb48ee02003-01-16 13:42:43 +00002131 if( (int)pPg->pgno <= pPager->origDbSize ){
drh968af522003-02-11 14:55:40 +00002132 int szPg;
2133 u32 saved;
drhac69b052004-05-12 13:30:07 +00002134 if( pPager->memDb ){
2135 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
drha6abd042004-06-09 17:37:22 +00002136 TRACE2("JOURNAL page %d\n", pPg->pgno);
drhac69b052004-05-12 13:30:07 +00002137 assert( pHist->pOrig==0 );
2138 pHist->pOrig = sqliteMallocRaw( pPager->pageSize );
2139 if( pHist->pOrig ){
2140 memcpy(pHist->pOrig, PGHDR_TO_DATA(pPg), pPager->pageSize);
2141 }
2142 pPg->inJournal = 1;
danielk197713adf8a2004-06-03 16:08:41 +00002143 }else{
drhae2b40c2004-06-09 19:03:54 +00002144 u32 cksum = pager_cksum(pPager, pPg->pgno, pData);
2145 saved = *(u32*)PGHDR_TO_EXTRA(pPg);
2146 store32bits(cksum, pPg, SQLITE_PAGE_SIZE);
2147 szPg = SQLITE_PAGE_SIZE+8;
drhac69b052004-05-12 13:30:07 +00002148 store32bits(pPg->pgno, pPg, -4);
2149 CODEC(pPager, pData, pPg->pgno, 7);
2150 rc = sqlite3OsWrite(&pPager->jfd, &((char*)pData)[-4], szPg);
drha6abd042004-06-09 17:37:22 +00002151 TRACE3("JOURNAL page %d needSync=%d\n", pPg->pgno, pPg->needSync);
drhac69b052004-05-12 13:30:07 +00002152 CODEC(pPager, pData, pPg->pgno, 0);
drhae2b40c2004-06-09 19:03:54 +00002153 *(u32*)PGHDR_TO_EXTRA(pPg) = saved;
drhac69b052004-05-12 13:30:07 +00002154 if( rc!=SQLITE_OK ){
2155 sqlite3pager_rollback(pPager);
2156 pPager->errMask |= PAGER_ERR_FULL;
2157 return rc;
2158 }
2159 pPager->nRec++;
2160 assert( pPager->aInJournal!=0 );
2161 pPager->aInJournal[pPg->pgno/8] |= 1<<(pPg->pgno&7);
2162 pPg->needSync = !pPager->noSync;
2163 pPg->inJournal = 1;
2164 if( pPager->stmtInUse ){
2165 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
2166 page_add_to_stmt_list(pPg);
2167 }
drhdb48ee02003-01-16 13:42:43 +00002168 }
drhdb48ee02003-01-16 13:42:43 +00002169 }else{
2170 pPg->needSync = !pPager->journalStarted && !pPager->noSync;
drha6abd042004-06-09 17:37:22 +00002171 TRACE3("APPEND page %d needSync=%d\n", pPg->pgno, pPg->needSync);
drhd9b02572001-04-15 00:37:09 +00002172 }
drhdb48ee02003-01-16 13:42:43 +00002173 if( pPg->needSync ){
2174 pPager->needSync = 1;
drhfa86c412002-02-02 15:01:15 +00002175 }
drh69688d52001-04-14 16:38:23 +00002176 }
drh6446c4d2001-12-15 14:22:18 +00002177
drhac69b052004-05-12 13:30:07 +00002178 /* If the statement journal is open and the page is not in it,
2179 ** then write the current page to the statement journal. Note that
drhae2b40c2004-06-09 19:03:54 +00002180 ** the statement journal format differs from the standard journal format
2181 ** in that it omits the checksums and the header.
drh6446c4d2001-12-15 14:22:18 +00002182 */
drhac69b052004-05-12 13:30:07 +00002183 if( pPager->stmtInUse && !pPg->inStmt && (int)pPg->pgno<=pPager->stmtSize ){
drh1e336b42002-02-14 12:50:33 +00002184 assert( pPg->inJournal || (int)pPg->pgno>pPager->origDbSize );
drhac69b052004-05-12 13:30:07 +00002185 if( pPager->memDb ){
2186 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
2187 assert( pHist->pStmt==0 );
2188 pHist->pStmt = sqliteMallocRaw( pPager->pageSize );
2189 if( pHist->pStmt ){
2190 memcpy(pHist->pStmt, PGHDR_TO_DATA(pPg), pPager->pageSize);
2191 }
drha6abd042004-06-09 17:37:22 +00002192 TRACE2("STMT-JOURNAL page %d\n", pPg->pgno);
drhac69b052004-05-12 13:30:07 +00002193 }else{
2194 store32bits(pPg->pgno, pPg, -4);
2195 CODEC(pPager, pData, pPg->pgno, 7);
2196 rc = sqlite3OsWrite(&pPager->stfd, ((char*)pData)-4, SQLITE_PAGE_SIZE+4);
drha6abd042004-06-09 17:37:22 +00002197 TRACE2("STMT-JOURNAL page %d\n", pPg->pgno);
drhac69b052004-05-12 13:30:07 +00002198 CODEC(pPager, pData, pPg->pgno, 0);
2199 if( rc!=SQLITE_OK ){
2200 sqlite3pager_rollback(pPager);
2201 pPager->errMask |= PAGER_ERR_FULL;
2202 return rc;
2203 }
2204 pPager->stmtNRec++;
2205 assert( pPager->aInStmt!=0 );
2206 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drhfa86c412002-02-02 15:01:15 +00002207 }
drh3aac2dd2004-04-26 14:10:20 +00002208 page_add_to_stmt_list(pPg);
drhfa86c412002-02-02 15:01:15 +00002209 }
2210
2211 /* Update the database size and return.
2212 */
drh1ab43002002-01-14 09:28:19 +00002213 if( pPager->dbSize<(int)pPg->pgno ){
drh306dc212001-05-21 13:45:10 +00002214 pPager->dbSize = pPg->pgno;
drh1f595712004-06-15 01:40:29 +00002215 if( !pPager->memDb && pPager->dbSize==PENDING_BYTE/pPager->pageSize ){
2216 pPager->dbSize++;
2217 }
drh306dc212001-05-21 13:45:10 +00002218 }
drh69688d52001-04-14 16:38:23 +00002219 return rc;
drhed7c8552001-04-11 14:29:21 +00002220}
2221
2222/*
drhaacc5432002-01-06 17:07:40 +00002223** Return TRUE if the page given in the argument was previously passed
drh3aac2dd2004-04-26 14:10:20 +00002224** to sqlite3pager_write(). In other words, return TRUE if it is ok
drh6019e162001-07-02 17:51:45 +00002225** to change the content of the page.
2226*/
drh3aac2dd2004-04-26 14:10:20 +00002227int sqlite3pager_iswriteable(void *pData){
drh6019e162001-07-02 17:51:45 +00002228 PgHdr *pPg = DATA_TO_PGHDR(pData);
2229 return pPg->dirty;
2230}
2231
2232/*
drh001bbcb2003-03-19 03:14:00 +00002233** Replace the content of a single page with the information in the third
2234** argument.
2235*/
drh3aac2dd2004-04-26 14:10:20 +00002236int sqlite3pager_overwrite(Pager *pPager, Pgno pgno, void *pData){
drh001bbcb2003-03-19 03:14:00 +00002237 void *pPage;
2238 int rc;
2239
drh3aac2dd2004-04-26 14:10:20 +00002240 rc = sqlite3pager_get(pPager, pgno, &pPage);
drh001bbcb2003-03-19 03:14:00 +00002241 if( rc==SQLITE_OK ){
drh3aac2dd2004-04-26 14:10:20 +00002242 rc = sqlite3pager_write(pPage);
drh001bbcb2003-03-19 03:14:00 +00002243 if( rc==SQLITE_OK ){
drhd0ba1932004-02-10 01:54:28 +00002244 memcpy(pPage, pData, SQLITE_PAGE_SIZE);
drh001bbcb2003-03-19 03:14:00 +00002245 }
drh3aac2dd2004-04-26 14:10:20 +00002246 sqlite3pager_unref(pPage);
drh001bbcb2003-03-19 03:14:00 +00002247 }
2248 return rc;
2249}
2250
2251/*
drh30e58752002-03-02 20:41:57 +00002252** A call to this routine tells the pager that it is not necessary to
2253** write the information on page "pgno" back to the disk, even though
2254** that page might be marked as dirty.
2255**
2256** The overlying software layer calls this routine when all of the data
2257** on the given page is unused. The pager marks the page as clean so
2258** that it does not get written to disk.
2259**
2260** Tests show that this optimization, together with the
drh3aac2dd2004-04-26 14:10:20 +00002261** sqlite3pager_dont_rollback() below, more than double the speed
drh30e58752002-03-02 20:41:57 +00002262** of large INSERT operations and quadruple the speed of large DELETEs.
drh8e298f92002-07-06 16:28:47 +00002263**
2264** When this routine is called, set the alwaysRollback flag to true.
drh3aac2dd2004-04-26 14:10:20 +00002265** Subsequent calls to sqlite3pager_dont_rollback() for the same page
drh8e298f92002-07-06 16:28:47 +00002266** will thereafter be ignored. This is necessary to avoid a problem
2267** where a page with data is added to the freelist during one part of
2268** a transaction then removed from the freelist during a later part
2269** of the same transaction and reused for some other purpose. When it
2270** is first added to the freelist, this routine is called. When reused,
2271** the dont_rollback() routine is called. But because the page contains
2272** critical data, we still need to be sure it gets rolled back in spite
2273** of the dont_rollback() call.
drh30e58752002-03-02 20:41:57 +00002274*/
drh3aac2dd2004-04-26 14:10:20 +00002275void sqlite3pager_dont_write(Pager *pPager, Pgno pgno){
drh30e58752002-03-02 20:41:57 +00002276 PgHdr *pPg;
drh8e298f92002-07-06 16:28:47 +00002277
drh30e58752002-03-02 20:41:57 +00002278 pPg = pager_lookup(pPager, pgno);
drh8e298f92002-07-06 16:28:47 +00002279 pPg->alwaysRollback = 1;
drh30e58752002-03-02 20:41:57 +00002280 if( pPg && pPg->dirty ){
drh8124a302002-06-25 14:43:57 +00002281 if( pPager->dbSize==(int)pPg->pgno && pPager->origDbSize<pPager->dbSize ){
2282 /* If this pages is the last page in the file and the file has grown
2283 ** during the current transaction, then do NOT mark the page as clean.
2284 ** When the database file grows, we must make sure that the last page
2285 ** gets written at least once so that the disk file will be the correct
2286 ** size. If you do not write this page and the size of the file
2287 ** on the disk ends up being too small, that can lead to database
2288 ** corruption during the next transaction.
2289 */
2290 }else{
drha6abd042004-06-09 17:37:22 +00002291 TRACE3("DONT_WRITE page %d of %d\n", pgno, pPager->fd.h);
drh8124a302002-06-25 14:43:57 +00002292 pPg->dirty = 0;
2293 }
drh30e58752002-03-02 20:41:57 +00002294 }
2295}
2296
2297/*
2298** A call to this routine tells the pager that if a rollback occurs,
2299** it is not necessary to restore the data on the given page. This
2300** means that the pager does not have to record the given page in the
2301** rollback journal.
2302*/
drh3aac2dd2004-04-26 14:10:20 +00002303void sqlite3pager_dont_rollback(void *pData){
drh30e58752002-03-02 20:41:57 +00002304 PgHdr *pPg = DATA_TO_PGHDR(pData);
2305 Pager *pPager = pPg->pPager;
2306
drha6abd042004-06-09 17:37:22 +00002307 if( pPager->state!=PAGER_EXCLUSIVE || pPager->journalOpen==0 ) return;
drhac69b052004-05-12 13:30:07 +00002308 if( pPg->alwaysRollback || pPager->alwaysRollback || pPager->memDb ) return;
drh30e58752002-03-02 20:41:57 +00002309 if( !pPg->inJournal && (int)pPg->pgno <= pPager->origDbSize ){
2310 assert( pPager->aInJournal!=0 );
2311 pPager->aInJournal[pPg->pgno/8] |= 1<<(pPg->pgno&7);
2312 pPg->inJournal = 1;
drhac69b052004-05-12 13:30:07 +00002313 if( pPager->stmtInUse ){
2314 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drh3aac2dd2004-04-26 14:10:20 +00002315 page_add_to_stmt_list(pPg);
drh30e58752002-03-02 20:41:57 +00002316 }
drha6abd042004-06-09 17:37:22 +00002317 TRACE3("DONT_ROLLBACK page %d of %d\n", pPg->pgno, pPager->fd.h);
drh30e58752002-03-02 20:41:57 +00002318 }
drhac69b052004-05-12 13:30:07 +00002319 if( pPager->stmtInUse && !pPg->inStmt && (int)pPg->pgno<=pPager->stmtSize ){
drh30e58752002-03-02 20:41:57 +00002320 assert( pPg->inJournal || (int)pPg->pgno>pPager->origDbSize );
drhac69b052004-05-12 13:30:07 +00002321 assert( pPager->aInStmt!=0 );
2322 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drh3aac2dd2004-04-26 14:10:20 +00002323 page_add_to_stmt_list(pPg);
drh30e58752002-03-02 20:41:57 +00002324 }
2325}
2326
drhac69b052004-05-12 13:30:07 +00002327
2328/*
2329** Clear a PgHistory block
2330*/
2331static void clearHistory(PgHistory *pHist){
2332 sqliteFree(pHist->pOrig);
2333 sqliteFree(pHist->pStmt);
2334 pHist->pOrig = 0;
2335 pHist->pStmt = 0;
2336}
2337
drh30e58752002-03-02 20:41:57 +00002338/*
drhed7c8552001-04-11 14:29:21 +00002339** Commit all changes to the database and release the write lock.
drhd9b02572001-04-15 00:37:09 +00002340**
2341** If the commit fails for any reason, a rollback attempt is made
2342** and an error code is returned. If the commit worked, SQLITE_OK
2343** is returned.
drhed7c8552001-04-11 14:29:21 +00002344*/
drh3aac2dd2004-04-26 14:10:20 +00002345int sqlite3pager_commit(Pager *pPager){
drha1b351a2001-09-14 16:42:12 +00002346 int rc;
drhed7c8552001-04-11 14:29:21 +00002347 PgHdr *pPg;
drhd9b02572001-04-15 00:37:09 +00002348
2349 if( pPager->errMask==PAGER_ERR_FULL ){
drh3aac2dd2004-04-26 14:10:20 +00002350 rc = sqlite3pager_rollback(pPager);
drh4e371ee2002-09-05 16:08:27 +00002351 if( rc==SQLITE_OK ){
2352 rc = SQLITE_FULL;
2353 }
drhd9b02572001-04-15 00:37:09 +00002354 return rc;
2355 }
2356 if( pPager->errMask!=0 ){
2357 rc = pager_errcode(pPager);
2358 return rc;
2359 }
drha6abd042004-06-09 17:37:22 +00002360 if( pPager->state<PAGER_RESERVED ){
drhd9b02572001-04-15 00:37:09 +00002361 return SQLITE_ERROR;
2362 }
drha6abd042004-06-09 17:37:22 +00002363 TRACE2("COMMIT %d\n", pPager->fd.h);
drhac69b052004-05-12 13:30:07 +00002364 if( pPager->memDb ){
2365 pPg = pager_get_all_dirty_pages(pPager);
2366 while( pPg ){
2367 clearHistory(PGHDR_TO_HIST(pPg, pPager));
2368 pPg->dirty = 0;
2369 pPg->inJournal = 0;
2370 pPg->inStmt = 0;
2371 pPg->pPrevStmt = pPg->pNextStmt = 0;
2372 pPg = pPg->pDirty;
2373 }
2374 pPager->pStmt = 0;
drha6abd042004-06-09 17:37:22 +00002375 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00002376 return SQLITE_OK;
2377 }
drha6abd042004-06-09 17:37:22 +00002378 if( pPager->dirtyCache==0 ){
danielk19774adee202004-05-08 08:23:19 +00002379 /* Exit early (without doing the time-consuming sqlite3OsSync() calls)
drha1680452002-04-18 01:56:57 +00002380 ** if there have been no changes to the database file. */
drh341eae82003-01-21 02:39:36 +00002381 assert( pPager->needSync==0 );
drha1680452002-04-18 01:56:57 +00002382 rc = pager_unwritelock(pPager);
2383 pPager->dbSize = -1;
2384 return rc;
2385 }
drhda47d772002-12-02 04:25:19 +00002386 assert( pPager->journalOpen );
drha6abd042004-06-09 17:37:22 +00002387#if 0
danielk197713adf8a2004-06-03 16:08:41 +00002388 rc = syncJournal(pPager, 0);
drh240c5792004-02-08 00:40:52 +00002389 if( rc!=SQLITE_OK ){
drhd9b02572001-04-15 00:37:09 +00002390 goto commit_abort;
drhed7c8552001-04-11 14:29:21 +00002391 }
drh2554f8b2003-01-22 01:26:44 +00002392 pPg = pager_get_all_dirty_pages(pPager);
2393 if( pPg ){
2394 rc = pager_write_pagelist(pPg);
danielk19774adee202004-05-08 08:23:19 +00002395 if( rc || (!pPager->noSync && sqlite3OsSync(&pPager->fd)!=SQLITE_OK) ){
drh2554f8b2003-01-22 01:26:44 +00002396 goto commit_abort;
2397 }
drh603240c2002-03-05 01:11:12 +00002398 }
danielk197713adf8a2004-06-03 16:08:41 +00002399#endif
2400 rc = sqlite3pager_sync(pPager, 0);
drha6abd042004-06-09 17:37:22 +00002401 if( rc!=SQLITE_OK ){
2402 goto commit_abort;
2403 }
drhd9b02572001-04-15 00:37:09 +00002404 rc = pager_unwritelock(pPager);
2405 pPager->dbSize = -1;
2406 return rc;
2407
2408 /* Jump here if anything goes wrong during the commit process.
2409 */
2410commit_abort:
drh3aac2dd2004-04-26 14:10:20 +00002411 rc = sqlite3pager_rollback(pPager);
drhd9b02572001-04-15 00:37:09 +00002412 if( rc==SQLITE_OK ){
2413 rc = SQLITE_FULL;
drhed7c8552001-04-11 14:29:21 +00002414 }
drhed7c8552001-04-11 14:29:21 +00002415 return rc;
2416}
2417
2418/*
drha6abd042004-06-09 17:37:22 +00002419** Rollback all changes. The database falls back to PAGER_SHARED mode.
drhed7c8552001-04-11 14:29:21 +00002420** All in-memory cache pages revert to their original data contents.
2421** The journal is deleted.
drhd9b02572001-04-15 00:37:09 +00002422**
2423** This routine cannot fail unless some other process is not following
2424** the correct locking protocol (SQLITE_PROTOCOL) or unless some other
2425** process is writing trash into the journal file (SQLITE_CORRUPT) or
2426** unless a prior malloc() failed (SQLITE_NOMEM). Appropriate error
2427** codes are returned for all these occasions. Otherwise,
2428** SQLITE_OK is returned.
drhed7c8552001-04-11 14:29:21 +00002429*/
drh3aac2dd2004-04-26 14:10:20 +00002430int sqlite3pager_rollback(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +00002431 int rc;
drha6abd042004-06-09 17:37:22 +00002432 TRACE2("ROLLBACK %d\n", pPager->fd.h);
drhac69b052004-05-12 13:30:07 +00002433 if( pPager->memDb ){
2434 PgHdr *p;
2435 for(p=pPager->pAll; p; p=p->pNextAll){
2436 PgHistory *pHist;
2437 if( !p->dirty ) continue;
2438 pHist = PGHDR_TO_HIST(p, pPager);
2439 if( pHist->pOrig ){
2440 memcpy(PGHDR_TO_DATA(p), pHist->pOrig, pPager->pageSize);
2441 TRACE2("ROLLBACK-PAGE %d\n", p->pgno);
2442 }else{
2443 TRACE2("PAGE %d is clean\n", p->pgno);
2444 }
2445 clearHistory(pHist);
2446 p->dirty = 0;
2447 p->inJournal = 0;
2448 p->inStmt = 0;
2449 p->pPrevStmt = p->pNextStmt = 0;
2450 }
2451 pPager->pStmt = 0;
2452 pPager->dbSize = pPager->origDbSize;
2453 memoryTruncate(pPager);
2454 pPager->stmtInUse = 0;
drha6abd042004-06-09 17:37:22 +00002455 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00002456 return SQLITE_OK;
2457 }
2458
drha6abd042004-06-09 17:37:22 +00002459 if( !pPager->dirtyCache || !pPager->journalOpen ){
drhda47d772002-12-02 04:25:19 +00002460 rc = pager_unwritelock(pPager);
2461 pPager->dbSize = -1;
2462 return rc;
2463 }
drhdb48ee02003-01-16 13:42:43 +00002464
drhd9b02572001-04-15 00:37:09 +00002465 if( pPager->errMask!=0 && pPager->errMask!=PAGER_ERR_FULL ){
drha6abd042004-06-09 17:37:22 +00002466 if( pPager->state>=PAGER_EXCLUSIVE ){
drh99ee3602003-02-16 19:13:36 +00002467 pager_playback(pPager, 1);
drh4b845d72002-03-05 12:41:19 +00002468 }
drhd9b02572001-04-15 00:37:09 +00002469 return pager_errcode(pPager);
drhed7c8552001-04-11 14:29:21 +00002470 }
drha6abd042004-06-09 17:37:22 +00002471 if( pPager->state==PAGER_RESERVED ){
2472 int rc2;
2473 rc = pager_reload_cache(pPager);
2474 rc2 = pager_unwritelock(pPager);
2475 if( rc==SQLITE_OK ){
2476 rc = rc2;
2477 }
2478 }else{
2479 rc = pager_playback(pPager, 1);
drhd9b02572001-04-15 00:37:09 +00002480 }
drhd9b02572001-04-15 00:37:09 +00002481 if( rc!=SQLITE_OK ){
2482 rc = SQLITE_CORRUPT;
2483 pPager->errMask |= PAGER_ERR_CORRUPT;
2484 }
2485 pPager->dbSize = -1;
drhed7c8552001-04-11 14:29:21 +00002486 return rc;
drh98808ba2001-10-18 12:34:46 +00002487}
drhd9b02572001-04-15 00:37:09 +00002488
2489/*
drh5e00f6c2001-09-13 13:46:56 +00002490** Return TRUE if the database file is opened read-only. Return FALSE
2491** if the database is (in theory) writable.
2492*/
drh3aac2dd2004-04-26 14:10:20 +00002493int sqlite3pager_isreadonly(Pager *pPager){
drhbe0072d2001-09-13 14:46:09 +00002494 return pPager->readOnly;
drh5e00f6c2001-09-13 13:46:56 +00002495}
2496
2497/*
drhd9b02572001-04-15 00:37:09 +00002498** This routine is used for testing and analysis only.
2499*/
drh3aac2dd2004-04-26 14:10:20 +00002500int *sqlite3pager_stats(Pager *pPager){
drhd9b02572001-04-15 00:37:09 +00002501 static int a[9];
2502 a[0] = pPager->nRef;
2503 a[1] = pPager->nPage;
2504 a[2] = pPager->mxPage;
2505 a[3] = pPager->dbSize;
2506 a[4] = pPager->state;
2507 a[5] = pPager->errMask;
2508 a[6] = pPager->nHit;
2509 a[7] = pPager->nMiss;
2510 a[8] = pPager->nOvfl;
2511 return a;
2512}
drhdd793422001-06-28 01:54:48 +00002513
drhfa86c412002-02-02 15:01:15 +00002514/*
drhac69b052004-05-12 13:30:07 +00002515** Set the statement rollback point.
drhfa86c412002-02-02 15:01:15 +00002516**
2517** This routine should be called with the transaction journal already
drhac69b052004-05-12 13:30:07 +00002518** open. A new statement journal is created that can be used to rollback
drhaaab5722002-02-19 13:39:21 +00002519** changes of a single SQL command within a larger transaction.
drhfa86c412002-02-02 15:01:15 +00002520*/
drh3aac2dd2004-04-26 14:10:20 +00002521int sqlite3pager_stmt_begin(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00002522 int rc;
2523 char zTemp[SQLITE_TEMPNAME_SIZE];
drhac69b052004-05-12 13:30:07 +00002524 assert( !pPager->stmtInUse );
drha6abd042004-06-09 17:37:22 +00002525 TRACE2("STMT-BEGIN %d\n", pPager->fd.h);
drhac69b052004-05-12 13:30:07 +00002526 if( pPager->memDb ){
2527 pPager->stmtInUse = 1;
2528 pPager->stmtSize = pPager->dbSize;
2529 return SQLITE_OK;
2530 }
drhda47d772002-12-02 04:25:19 +00002531 if( !pPager->journalOpen ){
drhac69b052004-05-12 13:30:07 +00002532 pPager->stmtAutoopen = 1;
drhda47d772002-12-02 04:25:19 +00002533 return SQLITE_OK;
2534 }
drhfa86c412002-02-02 15:01:15 +00002535 assert( pPager->journalOpen );
drhac69b052004-05-12 13:30:07 +00002536 pPager->aInStmt = sqliteMalloc( pPager->dbSize/8 + 1 );
2537 if( pPager->aInStmt==0 ){
danielk19779eed5052004-06-04 10:38:30 +00002538 sqlite3OsLock(&pPager->fd, SHARED_LOCK);
drhfa86c412002-02-02 15:01:15 +00002539 return SQLITE_NOMEM;
2540 }
drh968af522003-02-11 14:55:40 +00002541#ifndef NDEBUG
drhac69b052004-05-12 13:30:07 +00002542 rc = sqlite3OsFileSize(&pPager->jfd, &pPager->stmtJSize);
2543 if( rc ) goto stmt_begin_failed;
2544 assert( pPager->stmtJSize ==
drhae2b40c2004-06-09 19:03:54 +00002545 pPager->nRec*JOURNAL_PG_SZ(pPager) + JOURNAL_HDR_SZ(pPager) );
drh968af522003-02-11 14:55:40 +00002546#endif
drhae2b40c2004-06-09 19:03:54 +00002547 pPager->stmtJSize =
2548 pPager->nRec*JOURNAL_PG_SZ(pPager) + JOURNAL_HDR_SZ(pPager);
drhac69b052004-05-12 13:30:07 +00002549 pPager->stmtSize = pPager->dbSize;
2550 if( !pPager->stmtOpen ){
2551 rc = sqlite3pager_opentemp(zTemp, &pPager->stfd);
2552 if( rc ) goto stmt_begin_failed;
2553 pPager->stmtOpen = 1;
2554 pPager->stmtNRec = 0;
drh0f892532002-05-30 12:27:03 +00002555 }
drhac69b052004-05-12 13:30:07 +00002556 pPager->stmtInUse = 1;
drhfa86c412002-02-02 15:01:15 +00002557 return SQLITE_OK;
2558
drhac69b052004-05-12 13:30:07 +00002559stmt_begin_failed:
2560 if( pPager->aInStmt ){
2561 sqliteFree(pPager->aInStmt);
2562 pPager->aInStmt = 0;
drhfa86c412002-02-02 15:01:15 +00002563 }
2564 return rc;
2565}
2566
2567/*
drhac69b052004-05-12 13:30:07 +00002568** Commit a statement.
drhfa86c412002-02-02 15:01:15 +00002569*/
drh3aac2dd2004-04-26 14:10:20 +00002570int sqlite3pager_stmt_commit(Pager *pPager){
drhac69b052004-05-12 13:30:07 +00002571 if( pPager->stmtInUse ){
drh03eb96a2002-11-10 23:32:56 +00002572 PgHdr *pPg, *pNext;
drha6abd042004-06-09 17:37:22 +00002573 TRACE2("STMT-COMMIT %d\n", pPager->fd.h);
drhac69b052004-05-12 13:30:07 +00002574 if( !pPager->memDb ){
2575 sqlite3OsSeek(&pPager->stfd, 0);
2576 /* sqlite3OsTruncate(&pPager->stfd, 0); */
2577 sqliteFree( pPager->aInStmt );
2578 pPager->aInStmt = 0;
drh663fc632002-02-02 18:49:19 +00002579 }
drhac69b052004-05-12 13:30:07 +00002580 for(pPg=pPager->pStmt; pPg; pPg=pNext){
2581 pNext = pPg->pNextStmt;
2582 assert( pPg->inStmt );
2583 pPg->inStmt = 0;
2584 pPg->pPrevStmt = pPg->pNextStmt = 0;
2585 if( pPager->memDb ){
2586 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
2587 sqliteFree(pHist->pStmt);
2588 pHist->pStmt = 0;
2589 }
2590 }
2591 pPager->stmtNRec = 0;
2592 pPager->stmtInUse = 0;
2593 pPager->pStmt = 0;
drh663fc632002-02-02 18:49:19 +00002594 }
drhac69b052004-05-12 13:30:07 +00002595 pPager->stmtAutoopen = 0;
drhfa86c412002-02-02 15:01:15 +00002596 return SQLITE_OK;
2597}
2598
2599/*
drhac69b052004-05-12 13:30:07 +00002600** Rollback a statement.
drhfa86c412002-02-02 15:01:15 +00002601*/
drh3aac2dd2004-04-26 14:10:20 +00002602int sqlite3pager_stmt_rollback(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00002603 int rc;
drhac69b052004-05-12 13:30:07 +00002604 if( pPager->stmtInUse ){
drha6abd042004-06-09 17:37:22 +00002605 TRACE2("STMT-ROLLBACK %d\n", pPager->fd.h);
drhac69b052004-05-12 13:30:07 +00002606 if( pPager->memDb ){
2607 PgHdr *pPg;
2608 for(pPg=pPager->pStmt; pPg; pPg=pPg->pNextStmt){
2609 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
2610 if( pHist->pStmt ){
2611 memcpy(PGHDR_TO_DATA(pPg), pHist->pStmt, pPager->pageSize);
2612 sqliteFree(pHist->pStmt);
2613 pHist->pStmt = 0;
2614 }
2615 }
2616 pPager->dbSize = pPager->stmtSize;
2617 memoryTruncate(pPager);
2618 rc = SQLITE_OK;
2619 }else{
2620 rc = pager_stmt_playback(pPager);
2621 }
drh3aac2dd2004-04-26 14:10:20 +00002622 sqlite3pager_stmt_commit(pPager);
drh663fc632002-02-02 18:49:19 +00002623 }else{
2624 rc = SQLITE_OK;
2625 }
drhac69b052004-05-12 13:30:07 +00002626 pPager->stmtAutoopen = 0;
drhfa86c412002-02-02 15:01:15 +00002627 return rc;
2628}
2629
drh73509ee2003-04-06 20:44:45 +00002630/*
2631** Return the full pathname of the database file.
2632*/
drh3aac2dd2004-04-26 14:10:20 +00002633const char *sqlite3pager_filename(Pager *pPager){
drh73509ee2003-04-06 20:44:45 +00002634 return pPager->zFilename;
2635}
2636
drhb20ea9d2004-02-09 01:20:36 +00002637/*
danielk19775865e3d2004-06-14 06:03:57 +00002638** Return the directory of the database file.
2639*/
2640const char *sqlite3pager_dirname(Pager *pPager){
2641 return pPager->zDirectory;
2642}
2643
2644/*
2645** Return the full pathname of the journal file.
2646*/
2647const char *sqlite3pager_journalname(Pager *pPager){
2648 return pPager->zJournal;
2649}
2650
2651/*
drhb20ea9d2004-02-09 01:20:36 +00002652** Set the codec for this pager
2653*/
drh3aac2dd2004-04-26 14:10:20 +00002654void sqlite3pager_set_codec(
drhb20ea9d2004-02-09 01:20:36 +00002655 Pager *pPager,
drh9eb9e262004-02-11 02:18:05 +00002656 void (*xCodec)(void*,void*,Pgno,int),
drhb20ea9d2004-02-09 01:20:36 +00002657 void *pCodecArg
2658){
2659 pPager->xCodec = xCodec;
2660 pPager->pCodecArg = pCodecArg;
2661}
2662
danielk197713adf8a2004-06-03 16:08:41 +00002663/*
danielk1977aa5ccdf2004-06-14 05:10:42 +00002664** This routine is called to increment the database file change-counter,
2665** stored at byte 24 of the pager file.
2666*/
2667static int pager_incr_changecounter(Pager *pPager){
2668 void *pPage;
2669 PgHdr *pPgHdr;
2670 u32 change_counter;
2671 int rc;
2672
2673 /* Open page 1 of the file for writing. */
2674 rc = sqlite3pager_get(pPager, 1, &pPage);
2675 if( rc!=SQLITE_OK ) return rc;
2676 rc = sqlite3pager_write(pPage);
2677 if( rc!=SQLITE_OK ) return rc;
2678
2679 /* Read the current value at byte 24. */
2680 pPgHdr = DATA_TO_PGHDR(pPage);
2681 change_counter = retrieve32bits(pPgHdr, 24);
2682
2683 /* Increment the value just read and write it back to byte 24. */
2684 change_counter++;
2685 store32bits(change_counter, pPgHdr, 24);
2686
2687 /* Release the page reference. */
2688 sqlite3pager_unref(pPage);
2689 return SQLITE_OK;
2690}
2691
2692/*
danielk197713adf8a2004-06-03 16:08:41 +00002693** Sync the database file for the pager pPager. zMaster points to the name
2694** of a master journal file that should be written into the individual
2695** journal file. zMaster may be NULL, which is interpreted as no master
2696** journal (a single database transaction).
2697**
2698** This routine ensures that the journal is synced, all dirty pages written
2699** to the database file and the database file synced. The only thing that
2700** remains to commit the transaction is to delete the journal file (or
2701** master journal file if specified).
2702**
2703** Note that if zMaster==NULL, this does not overwrite a previous value
2704** passed to an sqlite3pager_sync() call.
2705*/
2706int sqlite3pager_sync(Pager *pPager, const char *zMaster){
2707 int rc = SQLITE_OK;
2708
danielk1977aa5ccdf2004-06-14 05:10:42 +00002709 /* If this is an in-memory db, or no pages have been written to, or this
2710 ** function has already been called, it is a no-op.
danielk197713adf8a2004-06-03 16:08:41 +00002711 */
danielk1977aa5ccdf2004-06-14 05:10:42 +00002712 if( pPager->state!=PAGER_SYNCED && !pPager->memDb && pPager->dirtyCache ){
danielk197713adf8a2004-06-03 16:08:41 +00002713 PgHdr *pPg;
2714 assert( pPager->journalOpen );
2715
danielk1977aa5ccdf2004-06-14 05:10:42 +00002716 rc = pager_incr_changecounter(pPager);
2717 if( rc!=SQLITE_OK ) goto sync_exit;
2718
danielk197713adf8a2004-06-03 16:08:41 +00002719 /* Sync the journal file */
2720 rc = syncJournal(pPager, zMaster);
2721 if( rc!=SQLITE_OK ) goto sync_exit;
2722
2723 /* Write all dirty pages to the database file */
2724 pPg = pager_get_all_dirty_pages(pPager);
2725 rc = pager_write_pagelist(pPg);
2726 if( rc!=SQLITE_OK ) goto sync_exit;
2727
danielk1977aa5ccdf2004-06-14 05:10:42 +00002728 /* Sync the database file. */
2729 if( !pPager->noSync ){
danielk197713adf8a2004-06-03 16:08:41 +00002730 rc = sqlite3OsSync(&pPager->fd);
2731 }
danielk1977aa5ccdf2004-06-14 05:10:42 +00002732
2733 pPager->state = PAGER_SYNCED;
danielk197713adf8a2004-06-03 16:08:41 +00002734 }
2735
2736sync_exit:
2737 return rc;
2738}
2739
drh89ac8c12004-06-09 14:17:20 +00002740#ifdef SQLITE_DEBUG
2741/*
2742** Return the current state of the file lock for the given pager.
2743** The return value is one of NO_LOCK, SHARED_LOCK, RESERVED_LOCK,
2744** PENDING_LOCK, or EXCLUSIVE_LOCK.
2745*/
2746int sqlite3pager_lockstate(Pager *pPager){
2747 return pPager->fd.locktype;
2748}
2749#endif
2750
drh74587e52002-08-13 00:01:16 +00002751#ifdef SQLITE_TEST
drhdd793422001-06-28 01:54:48 +00002752/*
2753** Print a listing of all referenced pages and their ref count.
2754*/
drh3aac2dd2004-04-26 14:10:20 +00002755void sqlite3pager_refdump(Pager *pPager){
drhdd793422001-06-28 01:54:48 +00002756 PgHdr *pPg;
2757 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2758 if( pPg->nRef<=0 ) continue;
2759 printf("PAGE %3d addr=0x%08x nRef=%d\n",
2760 pPg->pgno, (int)PGHDR_TO_DATA(pPg), pPg->nRef);
2761 }
2762}
2763#endif