blob: 9540fab39719a7273cbb53e097c8b0a6517ed633 [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**
danielk19778def5ea2004-06-16 10:39:52 +000021** @(#) $Id: pager.c,v 1.130 2004/06/16 10:39:39 danielk1977 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;
danielk1977eac7a362004-06-16 07:45:24 +0000462 assert( !pPager->memDb );
drha6abd042004-06-09 17:37:22 +0000463 if( pPager->state<PAGER_RESERVED ){
464 return SQLITE_OK;
465 }
drh3aac2dd2004-04-26 14:10:20 +0000466 sqlite3pager_stmt_commit(pPager);
drhac69b052004-05-12 13:30:07 +0000467 if( pPager->stmtOpen ){
468 sqlite3OsClose(&pPager->stfd);
469 pPager->stmtOpen = 0;
drh0f892532002-05-30 12:27:03 +0000470 }
drhda47d772002-12-02 04:25:19 +0000471 if( pPager->journalOpen ){
danielk19774adee202004-05-08 08:23:19 +0000472 sqlite3OsClose(&pPager->jfd);
drhda47d772002-12-02 04:25:19 +0000473 pPager->journalOpen = 0;
danielk19774adee202004-05-08 08:23:19 +0000474 sqlite3OsDelete(pPager->zJournal);
drhda47d772002-12-02 04:25:19 +0000475 sqliteFree( pPager->aInJournal );
476 pPager->aInJournal = 0;
477 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
478 pPg->inJournal = 0;
479 pPg->dirty = 0;
drhdb48ee02003-01-16 13:42:43 +0000480 pPg->needSync = 0;
drhda47d772002-12-02 04:25:19 +0000481 }
482 }else{
drha6abd042004-06-09 17:37:22 +0000483 assert( pPager->dirtyCache==0 || pPager->useJournal==0 );
drhd9b02572001-04-15 00:37:09 +0000484 }
drha6abd042004-06-09 17:37:22 +0000485 sqlite3OsUnlock(&pPager->fd, SHARED_LOCK);
486 pPager->state = PAGER_SHARED;
487 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +0000488}
489
drhed7c8552001-04-11 14:29:21 +0000490/*
drh968af522003-02-11 14:55:40 +0000491** Compute and return a checksum for the page of data.
drh34e79ce2004-02-08 06:05:46 +0000492**
493** This is not a real checksum. It is really just the sum of the
drh726de592004-06-10 23:35:50 +0000494** random initial value and the page number. We experimented with
495** a checksum of the entire data, but that was found to be too slow.
496**
497** Note that the page number is stored at the beginning of data and
498** the checksum is stored at the end. This is important. If journal
499** corruption occurs due to a power failure, the most likely scenario
500** is that one end or the other of the record will be changed. It is
501** much less likely that the two ends of the journal record will be
502** correct and the middle be corrupt. Thus, this "checksum" scheme,
503** though fast and simple, catches the mostly likely kind of corruption.
504**
505** FIX ME: Consider adding every 200th (or so) byte of the data to the
506** checksum. That way if a single page spans 3 or more disk sectors and
507** only the middle sector is corrupt, we will still have a reasonable
508** chance of failing the checksum and thus detecting the problem.
drh968af522003-02-11 14:55:40 +0000509*/
510static u32 pager_cksum(Pager *pPager, Pgno pgno, const char *aData){
511 u32 cksum = pPager->cksumInit + pgno;
drh968af522003-02-11 14:55:40 +0000512 return cksum;
513}
514
515/*
drhfa86c412002-02-02 15:01:15 +0000516** Read a single page from the journal file opened on file descriptor
517** jfd. Playback this one page.
drh968af522003-02-11 14:55:40 +0000518**
drh726de592004-06-10 23:35:50 +0000519** If useCksum==0 it means this journal does not use checksums. Checksums
520** are not used in statement journals because statement journals do not
521** need to survive power failures.
drhfa86c412002-02-02 15:01:15 +0000522*/
drhae2b40c2004-06-09 19:03:54 +0000523static int pager_playback_one_page(Pager *pPager, OsFile *jfd, int useCksum){
drhfa86c412002-02-02 15:01:15 +0000524 int rc;
drhae2b40c2004-06-09 19:03:54 +0000525 PgHdr *pPg; /* An existing page in the cache */
526 Pgno pgno; /* The page number of a page in journal */
527 u32 cksum; /* Checksum used for sanity checking */
528 u8 aData[SQLITE_PAGE_SIZE]; /* Store data here */
drhfa86c412002-02-02 15:01:15 +0000529
drhae2b40c2004-06-09 19:03:54 +0000530 rc = read32bits(jfd, &pgno);
drh99ee3602003-02-16 19:13:36 +0000531 if( rc!=SQLITE_OK ) return rc;
drhae2b40c2004-06-09 19:03:54 +0000532 rc = sqlite3OsRead(jfd, &aData, pPager->pageSize);
drh99ee3602003-02-16 19:13:36 +0000533 if( rc!=SQLITE_OK ) return rc;
drhfa86c412002-02-02 15:01:15 +0000534
drh968af522003-02-11 14:55:40 +0000535 /* Sanity checking on the page. This is more important that I originally
536 ** thought. If a power failure occurs while the journal is being written,
537 ** it could cause invalid data to be written into the journal. We need to
538 ** detect this invalid data (with high probability) and ignore it.
539 */
drhae2b40c2004-06-09 19:03:54 +0000540 if( pgno==0 ){
drh968af522003-02-11 14:55:40 +0000541 return SQLITE_DONE;
542 }
drhae2b40c2004-06-09 19:03:54 +0000543 if( pgno>(unsigned)pPager->dbSize ){
drh968af522003-02-11 14:55:40 +0000544 return SQLITE_OK;
545 }
drhae2b40c2004-06-09 19:03:54 +0000546 if( useCksum ){
547 rc = read32bits(jfd, &cksum);
drh99ee3602003-02-16 19:13:36 +0000548 if( rc ) return rc;
drhae2b40c2004-06-09 19:03:54 +0000549 if( pager_cksum(pPager, pgno, aData)!=cksum ){
drh968af522003-02-11 14:55:40 +0000550 return SQLITE_DONE;
551 }
552 }
drhfa86c412002-02-02 15:01:15 +0000553
danielk1977aa5ccdf2004-06-14 05:10:42 +0000554 assert( pPager->state==PAGER_RESERVED || pPager->state>=PAGER_EXCLUSIVE );
danielk1977a3f3a5f2004-06-10 04:32:16 +0000555
556 /* If the pager is in RESERVED state, then there must be a copy of this
557 ** page in the pager cache. In this case just update the pager cache,
danielk19770de0bb32004-06-10 05:59:24 +0000558 ** not the database file. The page is left marked dirty in this case.
559 **
560 ** FIX ME: Ideally the page would only be left marked dirty when the
561 ** pager is in RESERVED state if it was dirty when this statement
562 ** transaction was started.
danielk1977a3f3a5f2004-06-10 04:32:16 +0000563 **
564 ** If in EXCLUSIVE state, then we update the pager cache if it exists
565 ** and the main file. The page is then marked not dirty.
drhfa86c412002-02-02 15:01:15 +0000566 */
drhae2b40c2004-06-09 19:03:54 +0000567 pPg = pager_lookup(pPager, pgno);
danielk1977aa5ccdf2004-06-14 05:10:42 +0000568 assert( pPager->state>=PAGER_EXCLUSIVE || pPg );
drhae2b40c2004-06-09 19:03:54 +0000569 TRACE2("PLAYBACK page %d\n", pgno);
danielk1977aa5ccdf2004-06-14 05:10:42 +0000570 if( pPager->state>=PAGER_EXCLUSIVE ){
danielk1977a3f3a5f2004-06-10 04:32:16 +0000571 sqlite3OsSeek(&pPager->fd, (pgno-1)*(off_t)SQLITE_PAGE_SIZE);
572 rc = sqlite3OsWrite(&pPager->fd, aData, SQLITE_PAGE_SIZE);
573 }
drhfa86c412002-02-02 15:01:15 +0000574 if( pPg ){
drhacf4ac92003-12-17 23:57:34 +0000575 /* No page should ever be rolled back that is in use, except for page
576 ** 1 which is held in use in order to keep the lock on the database
577 ** active.
578 */
drhb6f41482004-05-14 01:58:11 +0000579 void *pData;
drhacf4ac92003-12-17 23:57:34 +0000580 assert( pPg->nRef==0 || pPg->pgno==1 );
drhb6f41482004-05-14 01:58:11 +0000581 pData = PGHDR_TO_DATA(pPg);
drhae2b40c2004-06-09 19:03:54 +0000582 memcpy(pData, aData, pPager->pageSize);
drh726de592004-06-10 23:35:50 +0000583 if( pPager->xDestructor ){ /*** FIX ME: Should this be xReinit? ***/
drhb6f41482004-05-14 01:58:11 +0000584 pPager->xDestructor(pData, pPager->pageSize);
drhde647132004-05-07 17:57:49 +0000585 }
danielk1977aa5ccdf2004-06-14 05:10:42 +0000586 if( pPager->state>=PAGER_EXCLUSIVE ){
danielk19770de0bb32004-06-10 05:59:24 +0000587 pPg->dirty = 0;
588 pPg->needSync = 0;
589 }
drhb6f41482004-05-14 01:58:11 +0000590 CODEC(pPager, pData, pPg->pgno, 3);
drhfa86c412002-02-02 15:01:15 +0000591 }
592 return rc;
593}
594
595/*
danielk197713adf8a2004-06-03 16:08:41 +0000596** Parameter zMaster is the name of a master journal file. A single journal
597** file that referred to the master journal file has just been rolled back.
598** This routine checks if it is possible to delete the master journal file,
599** and does so if it is.
drh726de592004-06-10 23:35:50 +0000600**
601** The master journal file contains the names of all child journals.
602** To tell if a master journal can be deleted, check to each of the
603** children. If all children are either missing or do not refer to
604** a different master journal, then this master journal can be deleted.
danielk197713adf8a2004-06-03 16:08:41 +0000605*/
606static int pager_delmaster(const char *zMaster){
607 int rc;
608 int master_open = 0;
609 OsFile master;
610 char *zMasterJournal = 0; /* Contents of master journal file */
611 off_t nMasterJournal; /* Size of master journal file */
612
613 /* Open the master journal file exclusively in case some other process
614 ** is running this routine also. Not that it makes too much difference.
615 */
616 rc = sqlite3OsOpenExclusive(zMaster, &master, 0);
617 if( rc!=SQLITE_OK ) goto delmaster_out;
618 master_open = 1;
danielk197713adf8a2004-06-03 16:08:41 +0000619 rc = sqlite3OsFileSize(&master, &nMasterJournal);
620 if( rc!=SQLITE_OK ) goto delmaster_out;
621
622 if( nMasterJournal>0 ){
danielk19775865e3d2004-06-14 06:03:57 +0000623 char *zJournal;
624 char *zMasterPtr;
625 int nMasterPtr; /* Number of bytes allocated at zMasterPtr */
626
627 /* Load the entire master journal file into space obtained from
628 ** sqliteMalloc() and pointed to by zMasterJournal.
629 **
630 ** Also allocate an extra (strlen(zMaster)+1) bytes. This space is used
631 ** to load a master-journal filename from some other journal file to
632 ** check if it points at this master journal file.
633 */
634 nMasterPtr = strlen(zMaster) + 1;
635 zMasterJournal = (char *)sqliteMalloc(nMasterJournal) + nMasterPtr;
danielk197713adf8a2004-06-03 16:08:41 +0000636 if( !zMasterJournal ){
637 rc = SQLITE_NOMEM;
638 goto delmaster_out;
639 }
danielk19775865e3d2004-06-14 06:03:57 +0000640 zMasterPtr = &zMasterJournal[nMasterJournal];
danielk197713adf8a2004-06-03 16:08:41 +0000641 rc = sqlite3OsRead(&master, zMasterJournal, nMasterJournal);
642 if( rc!=SQLITE_OK ) goto delmaster_out;
643
danielk19775865e3d2004-06-14 06:03:57 +0000644 zJournal = zMasterJournal;
645 while( (zJournal-zMasterJournal)<nMasterJournal ){
danielk197713adf8a2004-06-03 16:08:41 +0000646 if( sqlite3OsFileExists(zJournal) ){
647 /* One of the journals pointed to by the master journal exists.
648 ** Open it and check if it points at the master journal. If
649 ** so, return without deleting the master journal file.
650 */
651 OsFile journal;
652 int nMaster;
danielk19779eed5052004-06-04 10:38:30 +0000653 off_t jsz;
danielk197713adf8a2004-06-03 16:08:41 +0000654
655 rc = sqlite3OsOpenReadOnly(zJournal, &journal);
656 if( rc!=SQLITE_OK ){
657 sqlite3OsClose(&journal);
danielk197713adf8a2004-06-03 16:08:41 +0000658 goto delmaster_out;
659 }
danielk197713adf8a2004-06-03 16:08:41 +0000660
drhae2b40c2004-06-09 19:03:54 +0000661 /* Check if the file is big enough to be a journal file
danielk19779eed5052004-06-04 10:38:30 +0000662 ** with the required master journal name. If not, ignore it.
663 */
664 rc = sqlite3OsFileSize(&journal, &jsz);
665 if( rc!=SQLITE_OK ){
666 sqlite3OsClose(&journal);
667 goto delmaster_out;
668 }
drhae2b40c2004-06-09 19:03:54 +0000669 if( jsz<(25+strlen(zMaster)) ){
danielk19779eed5052004-06-04 10:38:30 +0000670 sqlite3OsClose(&journal);
671 continue;
672 }
673
danielk197713adf8a2004-06-03 16:08:41 +0000674 /* Seek to the point in the journal where the master journal name
675 ** is stored. Read the master journal name into memory obtained
676 ** from malloc.
677 */
drhae2b40c2004-06-09 19:03:54 +0000678 rc = sqlite3OsSeek(&journal, 20);
danielk197713adf8a2004-06-03 16:08:41 +0000679 if( rc!=SQLITE_OK ) goto delmaster_out;
drhae2b40c2004-06-09 19:03:54 +0000680 rc = read32bits(&journal, (u32*)&nMaster);
danielk197713adf8a2004-06-03 16:08:41 +0000681 if( rc!=SQLITE_OK ) goto delmaster_out;
danielk19775865e3d2004-06-14 06:03:57 +0000682 if( nMaster>=nMasterPtr ){
683 rc = sqlite3OsRead(&journal, zMasterPtr, nMasterPtr);
danielk197713adf8a2004-06-03 16:08:41 +0000684 if( rc!=SQLITE_OK ){
danielk197713adf8a2004-06-03 16:08:41 +0000685 goto delmaster_out;
686 }
danielk19775865e3d2004-06-14 06:03:57 +0000687 if( zMasterPtr[nMasterPtr-1]=='\0' && !strcmp(zMasterPtr, zMaster) ){
danielk197713adf8a2004-06-03 16:08:41 +0000688 /* We have a match. Do not delete the master journal file. */
danielk197713adf8a2004-06-03 16:08:41 +0000689 goto delmaster_out;
690 }
691 }
692 }
danielk19775865e3d2004-06-14 06:03:57 +0000693 zJournal += (strlen(zJournal)+1);
danielk197713adf8a2004-06-03 16:08:41 +0000694 }
695 }
696
697 sqlite3OsDelete(zMaster);
698
699delmaster_out:
700 if( zMasterJournal ){
701 sqliteFree(zMasterJournal);
702 }
703 if( master_open ){
704 sqlite3OsClose(&master);
705 }
706 return rc;
707}
708
709/*
drha6abd042004-06-09 17:37:22 +0000710** Make every page in the cache agree with what is on disk. In other words,
711** reread the disk to reset the state of the cache.
712**
713** This routine is called after a rollback in which some of the dirty cache
714** pages had never been written out to disk. We need to roll back the
715** cache content and the easiest way to do that is to reread the old content
716** back from the disk.
717*/
718static int pager_reload_cache(Pager *pPager){
719 PgHdr *pPg;
720 int rc = SQLITE_OK;
721 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
722 char zBuf[SQLITE_PAGE_SIZE];
723 if( !pPg->dirty ) continue;
724 if( (int)pPg->pgno <= pPager->origDbSize ){
725 sqlite3OsSeek(&pPager->fd, SQLITE_PAGE_SIZE*(off_t)(pPg->pgno-1));
726 rc = sqlite3OsRead(&pPager->fd, zBuf, SQLITE_PAGE_SIZE);
727 TRACE2("REFETCH page %d\n", pPg->pgno);
728 CODEC(pPager, zBuf, pPg->pgno, 2);
729 if( rc ) break;
730 }else{
731 memset(zBuf, 0, SQLITE_PAGE_SIZE);
732 }
733 if( pPg->nRef==0 || memcmp(zBuf, PGHDR_TO_DATA(pPg), SQLITE_PAGE_SIZE) ){
734 memcpy(PGHDR_TO_DATA(pPg), zBuf, SQLITE_PAGE_SIZE);
735 if( pPager->xReiniter ){
736 pPager->xReiniter(PGHDR_TO_DATA(pPg), pPager->pageSize);
737 }else{
738 memset(PGHDR_TO_EXTRA(pPg), 0, pPager->nExtra);
739 }
740 }
741 pPg->needSync = 0;
742 pPg->dirty = 0;
743 }
744 return rc;
745}
746
747
748/*
drhed7c8552001-04-11 14:29:21 +0000749** Playback the journal and thus restore the database file to
750** the state it was in before we started making changes.
751**
drh34e79ce2004-02-08 06:05:46 +0000752** The journal file format is as follows:
753**
drhae2b40c2004-06-09 19:03:54 +0000754** (1) 8 byte prefix. A copy of aJournalMagic[].
755** (2) 4 byte big-endian integer which is the number of valid page records
drh34e79ce2004-02-08 06:05:46 +0000756** in the journal. If this value is 0xffffffff, then compute the
drhae2b40c2004-06-09 19:03:54 +0000757** number of page records from the journal size.
758** (3) 4 byte big-endian integer which is the initial value for the
759** sanity checksum.
760** (4) 4 byte integer which is the number of pages to truncate the
drh34e79ce2004-02-08 06:05:46 +0000761** database to during a rollback.
drhae2b40c2004-06-09 19:03:54 +0000762** (5) 4 byte integer which is the number of bytes in the master journal
763** name. The value may be zero (indicate that there is no master
764** journal.)
765** (6) N bytes of the master journal name. The name will be nul-terminated
766** and might be shorter than the value read from (5). If the first byte
767** of the name is \000 then there is no master journal. The master
768** journal name is stored in UTF-8.
769** (7) Zero or more pages instances, each as follows:
drh34e79ce2004-02-08 06:05:46 +0000770** + 4 byte page number.
drhae2b40c2004-06-09 19:03:54 +0000771** + pPager->pageSize bytes of data.
772** + 4 byte checksum
drh34e79ce2004-02-08 06:05:46 +0000773**
drhae2b40c2004-06-09 19:03:54 +0000774** When we speak of the journal header, we mean the first 6 items above.
775** Each entry in the journal is an instance of the 7th item.
drh34e79ce2004-02-08 06:05:46 +0000776**
777** Call the value from the second bullet "nRec". nRec is the number of
778** valid page entries in the journal. In most cases, you can compute the
779** value of nRec from the size of the journal file. But if a power
780** failure occurred while the journal was being written, it could be the
781** case that the size of the journal file had already been increased but
782** the extra entries had not yet made it safely to disk. In such a case,
783** the value of nRec computed from the file size would be too large. For
784** that reason, we always use the nRec value in the header.
785**
786** If the nRec value is 0xffffffff it means that nRec should be computed
787** from the file size. This value is used when the user selects the
788** no-sync option for the journal. A power failure could lead to corruption
789** in this case. But for things like temporary table (which will be
790** deleted when the power is restored) we don't care.
791**
drhd9b02572001-04-15 00:37:09 +0000792** If the file opened as the journal file is not a well-formed
drh34e79ce2004-02-08 06:05:46 +0000793** journal file then the database will likely already be
794** corrupted, so the PAGER_ERR_CORRUPT bit is set in pPager->errMask
795** and SQLITE_CORRUPT is returned. If it all works, then this routine
796** returns SQLITE_OK.
drhed7c8552001-04-11 14:29:21 +0000797*/
drh99ee3602003-02-16 19:13:36 +0000798static int pager_playback(Pager *pPager, int useJournalSize){
drh968af522003-02-11 14:55:40 +0000799 off_t szJ; /* Size of the journal file in bytes */
800 int nRec; /* Number of Records in the journal */
drhd9b02572001-04-15 00:37:09 +0000801 int i; /* Loop counter */
802 Pgno mxPg = 0; /* Size of the original file in pages */
drhae2b40c2004-06-09 19:03:54 +0000803 unsigned char aMagic[8]; /* A buffer to hold the magic header */
804 int rc; /* Result code of a subroutine */
805 int nMaster; /* Number of bytes in the name of master journal */
danielk197713adf8a2004-06-03 16:08:41 +0000806 char *zMaster = 0; /* Name of master journal file if any */
drhed7c8552001-04-11 14:29:21 +0000807
drhc3a64ba2001-11-22 00:01:27 +0000808 /* Figure out how many records are in the journal. Abort early if
809 ** the journal is empty.
drhed7c8552001-04-11 14:29:21 +0000810 */
drh8cfbf082001-09-19 13:22:39 +0000811 assert( pPager->journalOpen );
danielk19774adee202004-05-08 08:23:19 +0000812 sqlite3OsSeek(&pPager->jfd, 0);
813 rc = sqlite3OsFileSize(&pPager->jfd, &szJ);
drhc3a64ba2001-11-22 00:01:27 +0000814 if( rc!=SQLITE_OK ){
815 goto end_playback;
816 }
drh240c5792004-02-08 00:40:52 +0000817
818 /* If the journal file is too small to contain a complete header,
drh34e79ce2004-02-08 06:05:46 +0000819 ** it must mean that the process that created the journal was just
820 ** beginning to write the journal file when it died. In that case,
821 ** the database file should have still been completely unchanged.
822 ** Nothing needs to be rolled back. We can safely ignore this journal.
drh240c5792004-02-08 00:40:52 +0000823 */
drhae2b40c2004-06-09 19:03:54 +0000824 if( szJ < 24 ){
drhc3a64ba2001-11-22 00:01:27 +0000825 goto end_playback;
826 }
827
drhae2b40c2004-06-09 19:03:54 +0000828 /* (1) Read the beginning of the journal and verify the magic string
829 ** at the beginning of the journal. */
danielk19774adee202004-05-08 08:23:19 +0000830 rc = sqlite3OsRead(&pPager->jfd, aMagic, sizeof(aMagic));
drhae2b40c2004-06-09 19:03:54 +0000831 if( rc!=SQLITE_OK || memcmp(aMagic, aJournalMagic, sizeof(aMagic))!=0 ){
832 rc = SQLITE_PROTOCOL;
833 goto end_playback;
834 }
835
836 /* (2) Read the number of pages stored in the journal. */
837 rc = read32bits(&pPager->jfd, (u32*)&nRec);
838 if( rc ) goto end_playback;
839 if( nRec==0xffffffff || useJournalSize ){
840 nRec = (szJ - JOURNAL_HDR_SZ(pPager))/JOURNAL_PG_SZ(pPager);
841 }
842
843 /* (3) Read the initial value for the sanity checksum */
844 rc = read32bits(&pPager->jfd, &pPager->cksumInit);
845 if( rc ) goto end_playback;
846
847 /* (4) Read the number of pages in the database file prior to the
848 ** start of the transaction */
849 rc = read32bits(&pPager->jfd, &mxPg);
drh94f33312002-08-12 12:29:56 +0000850 if( rc!=SQLITE_OK ){
drh81a20f22001-10-12 17:30:04 +0000851 goto end_playback;
drhd9b02572001-04-15 00:37:09 +0000852 }
drhae2b40c2004-06-09 19:03:54 +0000853
854 /* (5) and (6): Check if a master journal file is specified. If one is
855 ** specified, only proceed with the playback if it still exists. */
856 rc = read32bits(&pPager->jfd, &nMaster);
857 if( rc ) goto end_playback;
858 if( nMaster>0 ){
859 zMaster = sqliteMalloc(nMaster);
860 if( !zMaster ){
861 rc = SQLITE_NOMEM;
drh240c5792004-02-08 00:40:52 +0000862 goto end_playback;
863 }
drh427eab52004-06-10 00:51:43 +0000864 rc = sqlite3OsRead(&pPager->jfd, zMaster, nMaster);
drhae2b40c2004-06-09 19:03:54 +0000865 if( rc!=SQLITE_OK || (zMaster[0] && !sqlite3OsFileExists(zMaster)) ){
866 goto end_playback;
danielk197713adf8a2004-06-03 16:08:41 +0000867 }
drhae2b40c2004-06-09 19:03:54 +0000868 }
danielk197713adf8a2004-06-03 16:08:41 +0000869
drhae2b40c2004-06-09 19:03:54 +0000870 /* Truncate the database file back to it's original size */
drhd8d66e82003-02-12 02:10:15 +0000871 assert( pPager->origDbSize==0 || pPager->origDbSize==mxPg );
danielk19774adee202004-05-08 08:23:19 +0000872 rc = sqlite3OsTruncate(&pPager->fd, SQLITE_PAGE_SIZE*(off_t)mxPg);
drh81a20f22001-10-12 17:30:04 +0000873 if( rc!=SQLITE_OK ){
874 goto end_playback;
875 }
drhd9b02572001-04-15 00:37:09 +0000876 pPager->dbSize = mxPg;
877
drhfa86c412002-02-02 15:01:15 +0000878 /* Copy original pages out of the journal and back into the database file.
drhed7c8552001-04-11 14:29:21 +0000879 */
drh968af522003-02-11 14:55:40 +0000880 for(i=0; i<nRec; i++){
drhae2b40c2004-06-09 19:03:54 +0000881 rc = pager_playback_one_page(pPager, &pPager->jfd, 1);
drh968af522003-02-11 14:55:40 +0000882 if( rc!=SQLITE_OK ){
883 if( rc==SQLITE_DONE ){
drh968af522003-02-11 14:55:40 +0000884 rc = SQLITE_OK;
885 }
886 break;
887 }
drhed7c8552001-04-11 14:29:21 +0000888 }
drh81a20f22001-10-12 17:30:04 +0000889
drh4a0681e2003-02-13 01:58:20 +0000890 /* Pages that have been written to the journal but never synced
891 ** where not restored by the loop above. We have to restore those
drh240c5792004-02-08 00:40:52 +0000892 ** pages by reading them back from the original database.
drhdb48ee02003-01-16 13:42:43 +0000893 */
894 if( rc==SQLITE_OK ){
drha6abd042004-06-09 17:37:22 +0000895 pager_reload_cache(pPager);
drhdb48ee02003-01-16 13:42:43 +0000896 }
drh4a0681e2003-02-13 01:58:20 +0000897
898end_playback:
danielk197713adf8a2004-06-03 16:08:41 +0000899 if( zMaster ){
900 /* If there was a master journal and this routine will return true,
901 ** see if it is possible to delete the master journal. If errors
902 ** occur during this process, ignore them.
903 */
904 if( rc==SQLITE_OK ){
905 pager_delmaster(zMaster);
906 }
907 sqliteFree(zMaster);
908 }
drhd9b02572001-04-15 00:37:09 +0000909 if( rc!=SQLITE_OK ){
danielk197713adf8a2004-06-03 16:08:41 +0000910 /* FIX ME: We shouldn't delete the journal if an error occured during
911 ** rollback. It may have been a transient error and the rollback may
912 ** succeed next time it is attempted.
913 */
drhd9b02572001-04-15 00:37:09 +0000914 pager_unwritelock(pPager);
915 pPager->errMask |= PAGER_ERR_CORRUPT;
916 rc = SQLITE_CORRUPT;
917 }else{
918 rc = pager_unwritelock(pPager);
drhed7c8552001-04-11 14:29:21 +0000919 }
drhd9b02572001-04-15 00:37:09 +0000920 return rc;
drhed7c8552001-04-11 14:29:21 +0000921}
922
923/*
drhac69b052004-05-12 13:30:07 +0000924** Playback the statement journal.
drhfa86c412002-02-02 15:01:15 +0000925**
926** This is similar to playing back the transaction journal but with
927** a few extra twists.
928**
drh663fc632002-02-02 18:49:19 +0000929** (1) The number of pages in the database file at the start of
drhac69b052004-05-12 13:30:07 +0000930** the statement is stored in pPager->stmtSize, not in the
drh663fc632002-02-02 18:49:19 +0000931** journal file itself.
drhfa86c412002-02-02 15:01:15 +0000932**
drhac69b052004-05-12 13:30:07 +0000933** (2) In addition to playing back the statement journal, also
drhfa86c412002-02-02 15:01:15 +0000934** playback all pages of the transaction journal beginning
drhac69b052004-05-12 13:30:07 +0000935** at offset pPager->stmtJSize.
drhfa86c412002-02-02 15:01:15 +0000936*/
drh3aac2dd2004-04-26 14:10:20 +0000937static int pager_stmt_playback(Pager *pPager){
drh968af522003-02-11 14:55:40 +0000938 off_t szJ; /* Size of the full journal */
939 int nRec; /* Number of Records */
drhfa86c412002-02-02 15:01:15 +0000940 int i; /* Loop counter */
941 int rc;
942
943 /* Truncate the database back to its original size.
944 */
drhac69b052004-05-12 13:30:07 +0000945 rc = sqlite3OsTruncate(&pPager->fd, SQLITE_PAGE_SIZE*(off_t)pPager->stmtSize);
946 pPager->dbSize = pPager->stmtSize;
drhfa86c412002-02-02 15:01:15 +0000947
drhac69b052004-05-12 13:30:07 +0000948 /* Figure out how many records are in the statement journal.
drhfa86c412002-02-02 15:01:15 +0000949 */
drhac69b052004-05-12 13:30:07 +0000950 assert( pPager->stmtInUse && pPager->journalOpen );
951 sqlite3OsSeek(&pPager->stfd, 0);
952 nRec = pPager->stmtNRec;
drhfa86c412002-02-02 15:01:15 +0000953
drhac69b052004-05-12 13:30:07 +0000954 /* Copy original pages out of the statement journal and back into the
drhae2b40c2004-06-09 19:03:54 +0000955 ** database file. Note that the statement journal omits checksums from
956 ** each record since power-failure recovery is not important to statement
957 ** journals.
drhfa86c412002-02-02 15:01:15 +0000958 */
959 for(i=nRec-1; i>=0; i--){
drhae2b40c2004-06-09 19:03:54 +0000960 rc = pager_playback_one_page(pPager, &pPager->stfd, 0);
drh968af522003-02-11 14:55:40 +0000961 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +0000962 if( rc!=SQLITE_OK ) goto end_stmt_playback;
drhfa86c412002-02-02 15:01:15 +0000963 }
964
965 /* Figure out how many pages need to be copied out of the transaction
966 ** journal.
967 */
drhac69b052004-05-12 13:30:07 +0000968 rc = sqlite3OsSeek(&pPager->jfd, pPager->stmtJSize);
drhfa86c412002-02-02 15:01:15 +0000969 if( rc!=SQLITE_OK ){
drh3aac2dd2004-04-26 14:10:20 +0000970 goto end_stmt_playback;
drhfa86c412002-02-02 15:01:15 +0000971 }
danielk19774adee202004-05-08 08:23:19 +0000972 rc = sqlite3OsFileSize(&pPager->jfd, &szJ);
drhfa86c412002-02-02 15:01:15 +0000973 if( rc!=SQLITE_OK ){
drh3aac2dd2004-04-26 14:10:20 +0000974 goto end_stmt_playback;
drhfa86c412002-02-02 15:01:15 +0000975 }
drhae2b40c2004-06-09 19:03:54 +0000976 nRec = (szJ - pPager->stmtJSize)/JOURNAL_PG_SZ(pPager);
drhfa86c412002-02-02 15:01:15 +0000977 for(i=nRec-1; i>=0; i--){
drhae2b40c2004-06-09 19:03:54 +0000978 rc = pager_playback_one_page(pPager, &pPager->jfd, 1);
drh968af522003-02-11 14:55:40 +0000979 if( rc!=SQLITE_OK ){
980 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +0000981 goto end_stmt_playback;
drh968af522003-02-11 14:55:40 +0000982 }
drhfa86c412002-02-02 15:01:15 +0000983 }
984
drh3aac2dd2004-04-26 14:10:20 +0000985end_stmt_playback:
drhfa86c412002-02-02 15:01:15 +0000986 if( rc!=SQLITE_OK ){
drhfa86c412002-02-02 15:01:15 +0000987 pPager->errMask |= PAGER_ERR_CORRUPT;
988 rc = SQLITE_CORRUPT;
drhfa86c412002-02-02 15:01:15 +0000989 }
990 return rc;
991}
992
993/*
drhf57b14a2001-09-14 18:54:08 +0000994** Change the maximum number of in-memory pages that are allowed.
drhcd61c282002-03-06 22:01:34 +0000995**
996** The maximum number is the absolute value of the mxPage parameter.
997** If mxPage is negative, the noSync flag is also set. noSync bypasses
danielk19774adee202004-05-08 08:23:19 +0000998** calls to sqlite3OsSync(). The pager runs much faster with noSync on,
drhcd61c282002-03-06 22:01:34 +0000999** but if the operating system crashes or there is an abrupt power
1000** failure, the database file might be left in an inconsistent and
1001** unrepairable state.
drhf57b14a2001-09-14 18:54:08 +00001002*/
drh3aac2dd2004-04-26 14:10:20 +00001003void sqlite3pager_set_cachesize(Pager *pPager, int mxPage){
drh603240c2002-03-05 01:11:12 +00001004 if( mxPage>=0 ){
drha1680452002-04-18 01:56:57 +00001005 pPager->noSync = pPager->tempFile;
danielk19771d850a72004-05-31 08:26:49 +00001006 if( pPager->noSync ) pPager->needSync = 0;
drh603240c2002-03-05 01:11:12 +00001007 }else{
1008 pPager->noSync = 1;
1009 mxPage = -mxPage;
1010 }
drhf57b14a2001-09-14 18:54:08 +00001011 if( mxPage>10 ){
1012 pPager->mxPage = mxPage;
1013 }
1014}
1015
1016/*
drh973b6e32003-02-12 14:09:42 +00001017** Adjust the robustness of the database to damage due to OS crashes
1018** or power failures by changing the number of syncs()s when writing
1019** the rollback journal. There are three levels:
1020**
danielk19774adee202004-05-08 08:23:19 +00001021** OFF sqlite3OsSync() is never called. This is the default
drh973b6e32003-02-12 14:09:42 +00001022** for temporary and transient files.
1023**
1024** NORMAL The journal is synced once before writes begin on the
1025** database. This is normally adequate protection, but
1026** it is theoretically possible, though very unlikely,
1027** that an inopertune power failure could leave the journal
1028** in a state which would cause damage to the database
1029** when it is rolled back.
1030**
1031** FULL The journal is synced twice before writes begin on the
drh34e79ce2004-02-08 06:05:46 +00001032** database (with some additional information - the nRec field
1033** of the journal header - being written in between the two
1034** syncs). If we assume that writing a
drh973b6e32003-02-12 14:09:42 +00001035** single disk sector is atomic, then this mode provides
1036** assurance that the journal will not be corrupted to the
1037** point of causing damage to the database during rollback.
1038**
1039** Numeric values associated with these states are OFF==1, NORMAL=2,
1040** and FULL=3.
1041*/
drh3aac2dd2004-04-26 14:10:20 +00001042void sqlite3pager_set_safety_level(Pager *pPager, int level){
drh973b6e32003-02-12 14:09:42 +00001043 pPager->noSync = level==1 || pPager->tempFile;
1044 pPager->fullSync = level==3 && !pPager->tempFile;
danielk19771d850a72004-05-31 08:26:49 +00001045 if( pPager->noSync ) pPager->needSync = 0;
drh973b6e32003-02-12 14:09:42 +00001046}
1047
1048/*
drhfa86c412002-02-02 15:01:15 +00001049** Open a temporary file. Write the name of the file into zName
1050** (zName must be at least SQLITE_TEMPNAME_SIZE bytes long.) Write
1051** the file descriptor into *fd. Return SQLITE_OK on success or some
1052** other error code if we fail.
1053**
1054** The OS will automatically delete the temporary file when it is
1055** closed.
1056*/
drh3aac2dd2004-04-26 14:10:20 +00001057static int sqlite3pager_opentemp(char *zFile, OsFile *fd){
drhfa86c412002-02-02 15:01:15 +00001058 int cnt = 8;
1059 int rc;
1060 do{
1061 cnt--;
danielk19774adee202004-05-08 08:23:19 +00001062 sqlite3OsTempFileName(zFile);
1063 rc = sqlite3OsOpenExclusive(zFile, fd, 1);
drhfa86c412002-02-02 15:01:15 +00001064 }while( cnt>0 && rc!=SQLITE_OK );
1065 return rc;
1066}
1067
1068/*
drhed7c8552001-04-11 14:29:21 +00001069** Create a new page cache and put a pointer to the page cache in *ppPager.
drh5e00f6c2001-09-13 13:46:56 +00001070** The file to be cached need not exist. The file is not locked until
drh3aac2dd2004-04-26 14:10:20 +00001071** the first call to sqlite3pager_get() and is only held open until the
1072** last page is released using sqlite3pager_unref().
drh382c0242001-10-06 16:33:02 +00001073**
drh6446c4d2001-12-15 14:22:18 +00001074** If zFilename is NULL then a randomly-named temporary file is created
1075** and used as the file to be cached. The file will be deleted
1076** automatically when it is closed.
drhed7c8552001-04-11 14:29:21 +00001077*/
drh3aac2dd2004-04-26 14:10:20 +00001078int sqlite3pager_open(
drh7e3b0a02001-04-28 16:52:40 +00001079 Pager **ppPager, /* Return the Pager structure here */
1080 const char *zFilename, /* Name of the database file to open */
1081 int mxPage, /* Max number of in-memory cache pages */
drhda47d772002-12-02 04:25:19 +00001082 int nExtra, /* Extra bytes append to each in-memory page */
danielk197724162fe2004-06-04 06:22:00 +00001083 int useJournal, /* TRUE to use a rollback journal on this file */
1084 void *pBusyHandler /* Busy callback */
drh7e3b0a02001-04-28 16:52:40 +00001085){
drhed7c8552001-04-11 14:29:21 +00001086 Pager *pPager;
danielk19778def5ea2004-06-16 10:39:52 +00001087 char *zFullPathname = 0;
drhed7c8552001-04-11 14:29:21 +00001088 int nameLen;
drh8cfbf082001-09-19 13:22:39 +00001089 OsFile fd;
drha76c82e2003-07-27 18:59:42 +00001090 int rc, i;
danielk19778def5ea2004-06-16 10:39:52 +00001091 int tempFile = 0;
drhac69b052004-05-12 13:30:07 +00001092 int memDb = 0;
drh5e00f6c2001-09-13 13:46:56 +00001093 int readOnly = 0;
drh8cfbf082001-09-19 13:22:39 +00001094 char zTemp[SQLITE_TEMPNAME_SIZE];
drhed7c8552001-04-11 14:29:21 +00001095
drhd9b02572001-04-15 00:37:09 +00001096 *ppPager = 0;
danielk19776f8a5032004-05-10 10:34:51 +00001097 if( sqlite3_malloc_failed ){
drhd9b02572001-04-15 00:37:09 +00001098 return SQLITE_NOMEM;
1099 }
drh901afd42003-08-26 11:25:58 +00001100 if( zFilename && zFilename[0] ){
drhac69b052004-05-12 13:30:07 +00001101 if( strcmp(zFilename,":memory:")==0 ){
1102 memDb = 1;
1103 zFullPathname = sqliteMalloc(4);
drhae2b40c2004-06-09 19:03:54 +00001104 if( zFullPathname ) strcpy(zFullPathname, "");
drhac69b052004-05-12 13:30:07 +00001105 rc = SQLITE_OK;
1106 }else{
1107 zFullPathname = sqlite3OsFullPathname(zFilename);
danielk19778def5ea2004-06-16 10:39:52 +00001108 if( zFullPathname ){
1109 rc = sqlite3OsOpenReadWrite(zFullPathname, &fd, &readOnly);
1110 }
drhac69b052004-05-12 13:30:07 +00001111 }
drh5e00f6c2001-09-13 13:46:56 +00001112 }else{
drh3aac2dd2004-04-26 14:10:20 +00001113 rc = sqlite3pager_opentemp(zTemp, &fd);
drh5e00f6c2001-09-13 13:46:56 +00001114 zFilename = zTemp;
danielk19774adee202004-05-08 08:23:19 +00001115 zFullPathname = sqlite3OsFullPathname(zFilename);
danielk19778def5ea2004-06-16 10:39:52 +00001116 if( rc==SQLITE_OK ){
1117 tempFile = 1;
1118 }
drh5e00f6c2001-09-13 13:46:56 +00001119 }
danielk19778def5ea2004-06-16 10:39:52 +00001120 if( !zFullPathname ){
drh3e7a6092002-12-07 21:45:14 +00001121 return SQLITE_NOMEM;
1122 }
drh8cfbf082001-09-19 13:22:39 +00001123 if( rc!=SQLITE_OK ){
danielk19778def5ea2004-06-16 10:39:52 +00001124 if( tempFile ) sqlite3OsClose(&fd);
1125 if( zFullPathname ) sqliteFree(zFullPathname);
1126 return rc;
drhed7c8552001-04-11 14:29:21 +00001127 }
drh3e7a6092002-12-07 21:45:14 +00001128 nameLen = strlen(zFullPathname);
drha76c82e2003-07-27 18:59:42 +00001129 pPager = sqliteMalloc( sizeof(*pPager) + nameLen*3 + 30 );
drhd9b02572001-04-15 00:37:09 +00001130 if( pPager==0 ){
danielk19778def5ea2004-06-16 10:39:52 +00001131 if( tempFile ) sqlite3OsClose(&fd);
1132 if( zFullPathname ) sqliteFree(zFullPathname);
drhd9b02572001-04-15 00:37:09 +00001133 return SQLITE_NOMEM;
1134 }
drhdb48ee02003-01-16 13:42:43 +00001135 SET_PAGER(pPager);
drhed7c8552001-04-11 14:29:21 +00001136 pPager->zFilename = (char*)&pPager[1];
drha76c82e2003-07-27 18:59:42 +00001137 pPager->zDirectory = &pPager->zFilename[nameLen+1];
1138 pPager->zJournal = &pPager->zDirectory[nameLen+1];
drh3e7a6092002-12-07 21:45:14 +00001139 strcpy(pPager->zFilename, zFullPathname);
drha76c82e2003-07-27 18:59:42 +00001140 strcpy(pPager->zDirectory, zFullPathname);
1141 for(i=nameLen; i>0 && pPager->zDirectory[i-1]!='/'; i--){}
1142 if( i>0 ) pPager->zDirectory[i-1] = 0;
drh3e7a6092002-12-07 21:45:14 +00001143 strcpy(pPager->zJournal, zFullPathname);
1144 sqliteFree(zFullPathname);
drhed7c8552001-04-11 14:29:21 +00001145 strcpy(&pPager->zJournal[nameLen], "-journal");
1146 pPager->fd = fd;
drh8cfbf082001-09-19 13:22:39 +00001147 pPager->journalOpen = 0;
drhac69b052004-05-12 13:30:07 +00001148 pPager->useJournal = useJournal && !memDb;
1149 pPager->stmtOpen = 0;
1150 pPager->stmtInUse = 0;
drhed7c8552001-04-11 14:29:21 +00001151 pPager->nRef = 0;
drhac69b052004-05-12 13:30:07 +00001152 pPager->dbSize = memDb-1;
1153 pPager->pageSize = SQLITE_PAGE_SIZE;
1154 pPager->stmtSize = 0;
1155 pPager->stmtJSize = 0;
drhed7c8552001-04-11 14:29:21 +00001156 pPager->nPage = 0;
drhd79caeb2001-04-15 02:27:24 +00001157 pPager->mxPage = mxPage>5 ? mxPage : 10;
drha6abd042004-06-09 17:37:22 +00001158 pPager->state = PAGER_UNLOCK;
drhd9b02572001-04-15 00:37:09 +00001159 pPager->errMask = 0;
drh5e00f6c2001-09-13 13:46:56 +00001160 pPager->tempFile = tempFile;
drhac69b052004-05-12 13:30:07 +00001161 pPager->memDb = memDb;
drh5e00f6c2001-09-13 13:46:56 +00001162 pPager->readOnly = readOnly;
drhf57b14a2001-09-14 18:54:08 +00001163 pPager->needSync = 0;
drhda47d772002-12-02 04:25:19 +00001164 pPager->noSync = pPager->tempFile || !useJournal;
drhed7c8552001-04-11 14:29:21 +00001165 pPager->pFirst = 0;
drh341eae82003-01-21 02:39:36 +00001166 pPager->pFirstSynced = 0;
drhed7c8552001-04-11 14:29:21 +00001167 pPager->pLast = 0;
drh7c717f72001-06-24 20:39:41 +00001168 pPager->nExtra = nExtra;
danielk197724162fe2004-06-04 06:22:00 +00001169 pPager->pBusyHandler = (BusyHandler *)pBusyHandler;
drhed7c8552001-04-11 14:29:21 +00001170 memset(pPager->aHash, 0, sizeof(pPager->aHash));
1171 *ppPager = pPager;
1172 return SQLITE_OK;
1173}
1174
1175/*
drh72f82862001-05-24 21:06:34 +00001176** Set the destructor for this pager. If not NULL, the destructor is called
drh5e00f6c2001-09-13 13:46:56 +00001177** when the reference count on each page reaches zero. The destructor can
1178** be used to clean up information in the extra segment appended to each page.
drh72f82862001-05-24 21:06:34 +00001179**
drh3aac2dd2004-04-26 14:10:20 +00001180** The destructor is not called as a result sqlite3pager_close().
1181** Destructors are only called by sqlite3pager_unref().
drh72f82862001-05-24 21:06:34 +00001182*/
drhb6f41482004-05-14 01:58:11 +00001183void sqlite3pager_set_destructor(Pager *pPager, void (*xDesc)(void*,int)){
drh72f82862001-05-24 21:06:34 +00001184 pPager->xDestructor = xDesc;
1185}
1186
1187/*
drha6abd042004-06-09 17:37:22 +00001188** Set the reinitializer for this pager. If not NULL, the reinitializer
1189** is called when the content of a page in cache is restored to its original
1190** value as a result of a rollback. The callback gives higher-level code
1191** an opportunity to restore the EXTRA section to agree with the restored
1192** page data.
1193*/
1194void sqlite3pager_set_reiniter(Pager *pPager, void (*xReinit)(void*,int)){
1195 pPager->xReiniter = xReinit;
1196}
1197
1198/*
drh5e00f6c2001-09-13 13:46:56 +00001199** Return the total number of pages in the disk file associated with
1200** pPager.
drhed7c8552001-04-11 14:29:21 +00001201*/
drh3aac2dd2004-04-26 14:10:20 +00001202int sqlite3pager_pagecount(Pager *pPager){
drh28be87c2002-11-05 23:03:02 +00001203 off_t n;
drhd9b02572001-04-15 00:37:09 +00001204 assert( pPager!=0 );
drhed7c8552001-04-11 14:29:21 +00001205 if( pPager->dbSize>=0 ){
1206 return pPager->dbSize;
1207 }
danielk19774adee202004-05-08 08:23:19 +00001208 if( sqlite3OsFileSize(&pPager->fd, &n)!=SQLITE_OK ){
drh81a20f22001-10-12 17:30:04 +00001209 pPager->errMask |= PAGER_ERR_DISK;
drh8cfbf082001-09-19 13:22:39 +00001210 return 0;
drhed7c8552001-04-11 14:29:21 +00001211 }
drhd0ba1932004-02-10 01:54:28 +00001212 n /= SQLITE_PAGE_SIZE;
drh1f595712004-06-15 01:40:29 +00001213 if( !pPager->memDb && n==PENDING_BYTE/SQLITE_PAGE_SIZE ){
1214 n++;
1215 }
drha6abd042004-06-09 17:37:22 +00001216 if( pPager->state!=PAGER_UNLOCK ){
drhed7c8552001-04-11 14:29:21 +00001217 pPager->dbSize = n;
1218 }
1219 return n;
1220}
1221
1222/*
drhf7c57532003-04-25 13:22:51 +00001223** Forward declaration
1224*/
danielk197713adf8a2004-06-03 16:08:41 +00001225static int syncJournal(Pager*, const char*);
drhf7c57532003-04-25 13:22:51 +00001226
drhac69b052004-05-12 13:30:07 +00001227
1228/*
1229** Unlink a page from the free list (the list of all pages where nRef==0)
1230** and from its hash collision chain.
1231*/
1232static void unlinkPage(PgHdr *pPg){
1233 Pager *pPager = pPg->pPager;
1234
1235 /* Keep the pFirstSynced pointer pointing at the first synchronized page */
1236 if( pPg==pPager->pFirstSynced ){
1237 PgHdr *p = pPg->pNextFree;
1238 while( p && p->needSync ){ p = p->pNextFree; }
1239 pPager->pFirstSynced = p;
1240 }
1241
1242 /* Unlink from the freelist */
1243 if( pPg->pPrevFree ){
1244 pPg->pPrevFree->pNextFree = pPg->pNextFree;
1245 }else{
1246 assert( pPager->pFirst==pPg );
1247 pPager->pFirst = pPg->pNextFree;
1248 }
1249 if( pPg->pNextFree ){
1250 pPg->pNextFree->pPrevFree = pPg->pPrevFree;
1251 }else{
1252 assert( pPager->pLast==pPg );
1253 pPager->pLast = pPg->pPrevFree;
1254 }
1255 pPg->pNextFree = pPg->pPrevFree = 0;
1256
1257 /* Unlink from the pgno hash table */
1258 if( pPg->pNextHash ){
1259 pPg->pNextHash->pPrevHash = pPg->pPrevHash;
1260 }
1261 if( pPg->pPrevHash ){
1262 pPg->pPrevHash->pNextHash = pPg->pNextHash;
1263 }else{
1264 int h = pager_hash(pPg->pgno);
1265 assert( pPager->aHash[h]==pPg );
1266 pPager->aHash[h] = pPg->pNextHash;
1267 }
1268 pPg->pNextHash = pPg->pPrevHash = 0;
1269}
1270
1271/*
1272** This routine is used to truncate an in-memory database. Delete
danielk1977369f27e2004-06-15 11:40:04 +00001273** all pages whose pgno is larger than pPager->dbSize and is unreferenced.
drhac69b052004-05-12 13:30:07 +00001274** Referenced pages larger than pPager->dbSize are zeroed.
1275*/
1276static void memoryTruncate(Pager *pPager){
1277 PgHdr *pPg;
1278 PgHdr **ppPg;
1279 int dbSize = pPager->dbSize;
1280
1281 ppPg = &pPager->pAll;
1282 while( (pPg = *ppPg)!=0 ){
1283 if( pPg->pgno<=dbSize ){
1284 ppPg = &pPg->pNextAll;
1285 }else if( pPg->nRef>0 ){
1286 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
1287 ppPg = &pPg->pNextAll;
1288 }else{
1289 *ppPg = pPg->pNextAll;
1290 unlinkPage(pPg);
1291 sqliteFree(pPg);
1292 pPager->nPage--;
1293 }
1294 }
1295}
1296
drhf7c57532003-04-25 13:22:51 +00001297/*
1298** Truncate the file to the number of pages specified.
1299*/
drh3aac2dd2004-04-26 14:10:20 +00001300int sqlite3pager_truncate(Pager *pPager, Pgno nPage){
drhf7c57532003-04-25 13:22:51 +00001301 int rc;
drh2e6d11b2003-04-25 15:37:57 +00001302 if( pPager->dbSize<0 ){
drh3aac2dd2004-04-26 14:10:20 +00001303 sqlite3pager_pagecount(pPager);
drh2e6d11b2003-04-25 15:37:57 +00001304 }
1305 if( pPager->errMask!=0 ){
1306 rc = pager_errcode(pPager);
1307 return rc;
1308 }
drh7d02cb72003-06-04 16:24:39 +00001309 if( nPage>=(unsigned)pPager->dbSize ){
drhf7c57532003-04-25 13:22:51 +00001310 return SQLITE_OK;
1311 }
drhac69b052004-05-12 13:30:07 +00001312 if( pPager->memDb ){
1313 pPager->dbSize = nPage;
1314 memoryTruncate(pPager);
1315 return SQLITE_OK;
1316 }
danielk1977369f27e2004-06-15 11:40:04 +00001317 rc = syncJournal(pPager, 0);
1318 if( rc!=SQLITE_OK ){
1319 return rc;
1320 }
danielk19774adee202004-05-08 08:23:19 +00001321 rc = sqlite3OsTruncate(&pPager->fd, SQLITE_PAGE_SIZE*(off_t)nPage);
drhf7c57532003-04-25 13:22:51 +00001322 if( rc==SQLITE_OK ){
1323 pPager->dbSize = nPage;
1324 }
1325 return rc;
1326}
1327
1328/*
drhed7c8552001-04-11 14:29:21 +00001329** Shutdown the page cache. Free all memory and close all files.
1330**
1331** If a transaction was in progress when this routine is called, that
1332** transaction is rolled back. All outstanding pages are invalidated
1333** and their memory is freed. Any attempt to use a page associated
1334** with this page cache after this function returns will likely
1335** result in a coredump.
1336*/
drh3aac2dd2004-04-26 14:10:20 +00001337int sqlite3pager_close(Pager *pPager){
drhd9b02572001-04-15 00:37:09 +00001338 PgHdr *pPg, *pNext;
drhed7c8552001-04-11 14:29:21 +00001339 switch( pPager->state ){
drha6abd042004-06-09 17:37:22 +00001340 case PAGER_RESERVED:
danielk1977aa5ccdf2004-06-14 05:10:42 +00001341 case PAGER_SYNCED:
drha6abd042004-06-09 17:37:22 +00001342 case PAGER_EXCLUSIVE: {
drh3aac2dd2004-04-26 14:10:20 +00001343 sqlite3pager_rollback(pPager);
drhac69b052004-05-12 13:30:07 +00001344 if( !pPager->memDb ){
drha6abd042004-06-09 17:37:22 +00001345 sqlite3OsUnlock(&pPager->fd, NO_LOCK);
drhac69b052004-05-12 13:30:07 +00001346 }
drh8cfbf082001-09-19 13:22:39 +00001347 assert( pPager->journalOpen==0 );
drhed7c8552001-04-11 14:29:21 +00001348 break;
1349 }
drha6abd042004-06-09 17:37:22 +00001350 case PAGER_SHARED: {
drhac69b052004-05-12 13:30:07 +00001351 if( !pPager->memDb ){
drha6abd042004-06-09 17:37:22 +00001352 sqlite3OsUnlock(&pPager->fd, NO_LOCK);
drhac69b052004-05-12 13:30:07 +00001353 }
drhed7c8552001-04-11 14:29:21 +00001354 break;
1355 }
1356 default: {
1357 /* Do nothing */
1358 break;
1359 }
1360 }
drhd9b02572001-04-15 00:37:09 +00001361 for(pPg=pPager->pAll; pPg; pPg=pNext){
danielk1977eac7a362004-06-16 07:45:24 +00001362#ifndef NDEBUG
1363 if( pPager->memDb ){
1364 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
1365 assert( !pPg->alwaysRollback );
1366 assert( !pHist->pOrig );
1367 assert( !pHist->pStmt );
1368 }
1369#endif
drhd9b02572001-04-15 00:37:09 +00001370 pNext = pPg->pNextAll;
1371 sqliteFree(pPg);
drhed7c8552001-04-11 14:29:21 +00001372 }
drhac69b052004-05-12 13:30:07 +00001373 if( !pPager->memDb ){
1374 sqlite3OsClose(&pPager->fd);
1375 }
drh8cfbf082001-09-19 13:22:39 +00001376 assert( pPager->journalOpen==0 );
drh0f892532002-05-30 12:27:03 +00001377 /* Temp files are automatically deleted by the OS
1378 ** if( pPager->tempFile ){
danielk19774adee202004-05-08 08:23:19 +00001379 ** sqlite3OsDelete(pPager->zFilename);
drh0f892532002-05-30 12:27:03 +00001380 ** }
1381 */
drhdb48ee02003-01-16 13:42:43 +00001382 CLR_PAGER(pPager);
drh73509ee2003-04-06 20:44:45 +00001383 if( pPager->zFilename!=(char*)&pPager[1] ){
drha76c82e2003-07-27 18:59:42 +00001384 assert( 0 ); /* Cannot happen */
drh73509ee2003-04-06 20:44:45 +00001385 sqliteFree(pPager->zFilename);
1386 sqliteFree(pPager->zJournal);
drha76c82e2003-07-27 18:59:42 +00001387 sqliteFree(pPager->zDirectory);
drh73509ee2003-04-06 20:44:45 +00001388 }
drhed7c8552001-04-11 14:29:21 +00001389 sqliteFree(pPager);
1390 return SQLITE_OK;
1391}
1392
1393/*
drh5e00f6c2001-09-13 13:46:56 +00001394** Return the page number for the given page data.
drhed7c8552001-04-11 14:29:21 +00001395*/
drh3aac2dd2004-04-26 14:10:20 +00001396Pgno sqlite3pager_pagenumber(void *pData){
drhed7c8552001-04-11 14:29:21 +00001397 PgHdr *p = DATA_TO_PGHDR(pData);
1398 return p->pgno;
1399}
1400
1401/*
drhc8629a12004-05-08 20:07:40 +00001402** The page_ref() function increments the reference count for a page.
1403** If the page is currently on the freelist (the reference count is zero) then
drh7e3b0a02001-04-28 16:52:40 +00001404** remove it from the freelist.
drhc8629a12004-05-08 20:07:40 +00001405**
1406** For non-test systems, page_ref() is a macro that calls _page_ref()
1407** online of the reference count is zero. For test systems, page_ref()
1408** is a real function so that we can set breakpoints and trace it.
drh7e3b0a02001-04-28 16:52:40 +00001409*/
drh836faa42003-01-11 13:30:57 +00001410static void _page_ref(PgHdr *pPg){
drh7e3b0a02001-04-28 16:52:40 +00001411 if( pPg->nRef==0 ){
1412 /* The page is currently on the freelist. Remove it. */
drh341eae82003-01-21 02:39:36 +00001413 if( pPg==pPg->pPager->pFirstSynced ){
1414 PgHdr *p = pPg->pNextFree;
1415 while( p && p->needSync ){ p = p->pNextFree; }
1416 pPg->pPager->pFirstSynced = p;
1417 }
drh7e3b0a02001-04-28 16:52:40 +00001418 if( pPg->pPrevFree ){
1419 pPg->pPrevFree->pNextFree = pPg->pNextFree;
1420 }else{
1421 pPg->pPager->pFirst = pPg->pNextFree;
1422 }
1423 if( pPg->pNextFree ){
1424 pPg->pNextFree->pPrevFree = pPg->pPrevFree;
1425 }else{
1426 pPg->pPager->pLast = pPg->pPrevFree;
1427 }
1428 pPg->pPager->nRef++;
1429 }
1430 pPg->nRef++;
drhdd793422001-06-28 01:54:48 +00001431 REFINFO(pPg);
drhdf0b3b02001-06-23 11:36:20 +00001432}
drhc8629a12004-05-08 20:07:40 +00001433#ifdef SQLITE_TEST
1434 static void page_ref(PgHdr *pPg){
1435 if( pPg->nRef==0 ){
1436 _page_ref(pPg);
1437 }else{
1438 pPg->nRef++;
1439 REFINFO(pPg);
1440 }
1441 }
1442#else
1443# define page_ref(P) ((P)->nRef==0?_page_ref(P):(void)(P)->nRef++)
1444#endif
drhdf0b3b02001-06-23 11:36:20 +00001445
1446/*
1447** Increment the reference count for a page. The input pointer is
1448** a reference to the page data.
1449*/
drh3aac2dd2004-04-26 14:10:20 +00001450int sqlite3pager_ref(void *pData){
drhdf0b3b02001-06-23 11:36:20 +00001451 PgHdr *pPg = DATA_TO_PGHDR(pData);
1452 page_ref(pPg);
drh8c42ca92001-06-22 19:15:00 +00001453 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +00001454}
1455
1456/*
drh34e79ce2004-02-08 06:05:46 +00001457** Sync the journal. In other words, make sure all the pages that have
1458** been written to the journal have actually reached the surface of the
1459** disk. It is not safe to modify the original database file until after
1460** the journal has been synced. If the original database is modified before
1461** the journal is synced and a power failure occurs, the unsynced journal
1462** data would be lost and we would be unable to completely rollback the
1463** database changes. Database corruption would occur.
1464**
1465** This routine also updates the nRec field in the header of the journal.
1466** (See comments on the pager_playback() routine for additional information.)
1467** If the sync mode is FULL, two syncs will occur. First the whole journal
1468** is synced, then the nRec field is updated, then a second sync occurs.
drhb19a2bc2001-09-16 00:13:26 +00001469**
drh34e79ce2004-02-08 06:05:46 +00001470** For temporary databases, we do not care if we are able to rollback
1471** after a power failure, so sync occurs.
drhfa86c412002-02-02 15:01:15 +00001472**
drh34e79ce2004-02-08 06:05:46 +00001473** This routine clears the needSync field of every page current held in
1474** memory.
drh50e5dad2001-09-15 00:57:28 +00001475*/
danielk197713adf8a2004-06-03 16:08:41 +00001476static int syncJournal(Pager *pPager, const char *zMaster){
drh50e5dad2001-09-15 00:57:28 +00001477 PgHdr *pPg;
1478 int rc = SQLITE_OK;
drh03eb96a2002-11-10 23:32:56 +00001479
1480 /* Sync the journal before modifying the main database
1481 ** (assuming there is a journal and it needs to be synced.)
1482 */
danielk197713adf8a2004-06-03 16:08:41 +00001483 if( pPager->needSync || zMaster ){
drhfa86c412002-02-02 15:01:15 +00001484 if( !pPager->tempFile ){
drhdb48ee02003-01-16 13:42:43 +00001485 assert( pPager->journalOpen );
drh946966f2004-02-25 02:20:41 +00001486 /* assert( !pPager->noSync ); // noSync might be set if synchronous
1487 ** was turned off after the transaction was started. Ticket #615 */
drh968af522003-02-11 14:55:40 +00001488#ifndef NDEBUG
1489 {
drh34e79ce2004-02-08 06:05:46 +00001490 /* Make sure the pPager->nRec counter we are keeping agrees
1491 ** with the nRec computed from the size of the journal file.
1492 */
drh4a0681e2003-02-13 01:58:20 +00001493 off_t hdrSz, pgSz, jSz;
drhae2b40c2004-06-09 19:03:54 +00001494 hdrSz = JOURNAL_HDR_SZ(pPager);
1495 pgSz = JOURNAL_PG_SZ(pPager);
danielk19774adee202004-05-08 08:23:19 +00001496 rc = sqlite3OsFileSize(&pPager->jfd, &jSz);
drh968af522003-02-11 14:55:40 +00001497 if( rc!=0 ) return rc;
drh4a0681e2003-02-13 01:58:20 +00001498 assert( pPager->nRec*pgSz+hdrSz==jSz );
drh968af522003-02-11 14:55:40 +00001499 }
1500#endif
drhae2b40c2004-06-09 19:03:54 +00001501 {
drh34e79ce2004-02-08 06:05:46 +00001502 /* Write the nRec value into the journal file header */
drhd8d66e82003-02-12 02:10:15 +00001503 off_t szJ;
1504 if( pPager->fullSync ){
drha6abd042004-06-09 17:37:22 +00001505 TRACE2("SYNC journal of %d\n", pPager->fd.h);
danielk19774adee202004-05-08 08:23:19 +00001506 rc = sqlite3OsSync(&pPager->jfd);
drhd8d66e82003-02-12 02:10:15 +00001507 if( rc!=0 ) return rc;
1508 }
drhae2b40c2004-06-09 19:03:54 +00001509 sqlite3OsSeek(&pPager->jfd, sizeof(aJournalMagic));
drh99ee3602003-02-16 19:13:36 +00001510 rc = write32bits(&pPager->jfd, pPager->nRec);
1511 if( rc ) return rc;
danielk197713adf8a2004-06-03 16:08:41 +00001512
1513 /* Write the name of the master journal file if one is specified */
1514 if( zMaster ){
1515 assert( strlen(zMaster)<pPager->nMaster );
drhae2b40c2004-06-09 19:03:54 +00001516 rc = sqlite3OsSeek(&pPager->jfd, 20);
danielk197713adf8a2004-06-03 16:08:41 +00001517 if( rc ) return rc;
1518 rc = sqlite3OsWrite(&pPager->jfd, zMaster, strlen(zMaster)+1);
1519 if( rc ) return rc;
1520 }
1521
drhae2b40c2004-06-09 19:03:54 +00001522 szJ = JOURNAL_HDR_SZ(pPager) + pPager->nRec*JOURNAL_PG_SZ(pPager);
danielk19774adee202004-05-08 08:23:19 +00001523 sqlite3OsSeek(&pPager->jfd, szJ);
drh968af522003-02-11 14:55:40 +00001524 }
drha6abd042004-06-09 17:37:22 +00001525 TRACE2("SYNC journal of %d\n", pPager->fd.h);
danielk19774adee202004-05-08 08:23:19 +00001526 rc = sqlite3OsSync(&pPager->jfd);
drhfa86c412002-02-02 15:01:15 +00001527 if( rc!=0 ) return rc;
drhdb48ee02003-01-16 13:42:43 +00001528 pPager->journalStarted = 1;
drhfa86c412002-02-02 15:01:15 +00001529 }
drh50e5dad2001-09-15 00:57:28 +00001530 pPager->needSync = 0;
drh341eae82003-01-21 02:39:36 +00001531
1532 /* Erase the needSync flag from every page.
1533 */
1534 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
1535 pPg->needSync = 0;
1536 }
1537 pPager->pFirstSynced = pPager->pFirst;
drh50e5dad2001-09-15 00:57:28 +00001538 }
drh03eb96a2002-11-10 23:32:56 +00001539
drh341eae82003-01-21 02:39:36 +00001540#ifndef NDEBUG
1541 /* If the Pager.needSync flag is clear then the PgHdr.needSync
1542 ** flag must also be clear for all pages. Verify that this
1543 ** invariant is true.
drh03eb96a2002-11-10 23:32:56 +00001544 */
drh341eae82003-01-21 02:39:36 +00001545 else{
1546 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
1547 assert( pPg->needSync==0 );
1548 }
1549 assert( pPager->pFirstSynced==pPager->pFirst );
drh03eb96a2002-11-10 23:32:56 +00001550 }
drh341eae82003-01-21 02:39:36 +00001551#endif
drhdb48ee02003-01-16 13:42:43 +00001552
drh81a20f22001-10-12 17:30:04 +00001553 return rc;
drh50e5dad2001-09-15 00:57:28 +00001554}
1555
1556/*
drh2554f8b2003-01-22 01:26:44 +00001557** Given a list of pages (connected by the PgHdr.pDirty pointer) write
1558** every one of those pages out to the database file and mark them all
1559** as clean.
1560*/
1561static int pager_write_pagelist(PgHdr *pList){
1562 Pager *pPager;
1563 int rc;
danielk19779eed5052004-06-04 10:38:30 +00001564 int busy = 1;
drh2554f8b2003-01-22 01:26:44 +00001565
1566 if( pList==0 ) return SQLITE_OK;
1567 pPager = pList->pPager;
danielk19779eed5052004-06-04 10:38:30 +00001568
1569 /* At this point there may be either a RESERVED or EXCLUSIVE lock on the
1570 ** database file. If there is already an EXCLUSIVE lock, the following
1571 ** calls to sqlite3OsLock() are no-ops.
1572 **
drha6abd042004-06-09 17:37:22 +00001573 ** Moving the lock from RESERVED to EXCLUSIVE actually involves going
1574 ** through an intermediate state PENDING. A PENDING lock prevents new
1575 ** readers from attaching to the database but is unsufficient for us to
1576 ** write. The idea of a PENDING lock is to prevent new readers from
1577 ** coming in while we wait for existing readers to clear.
danielk19779eed5052004-06-04 10:38:30 +00001578 **
drha6abd042004-06-09 17:37:22 +00001579 ** While the pager is in the RESERVED state, the original database file
1580 ** is unchanged and we can rollback without having to playback the
1581 ** journal into the original database file. Once we transition to
1582 ** EXCLUSIVE, it means the database file has been changed and any rollback
1583 ** will require a journal playback.
danielk19779eed5052004-06-04 10:38:30 +00001584 */
danielk19779eed5052004-06-04 10:38:30 +00001585 do {
1586 rc = sqlite3OsLock(&pPager->fd, EXCLUSIVE_LOCK);
1587 }while( rc==SQLITE_BUSY &&
1588 pPager->pBusyHandler &&
1589 pPager->pBusyHandler->xFunc &&
danielk19772a764eb2004-06-12 01:43:26 +00001590 pPager->pBusyHandler->xFunc(pPager->pBusyHandler->pArg, busy++)
danielk19779eed5052004-06-04 10:38:30 +00001591 );
1592 if( rc!=SQLITE_OK ){
1593 return rc;
1594 }
drha6abd042004-06-09 17:37:22 +00001595 pPager->state = PAGER_EXCLUSIVE;
danielk19779eed5052004-06-04 10:38:30 +00001596
drh2554f8b2003-01-22 01:26:44 +00001597 while( pList ){
1598 assert( pList->dirty );
danielk19774adee202004-05-08 08:23:19 +00001599 sqlite3OsSeek(&pPager->fd, (pList->pgno-1)*(off_t)SQLITE_PAGE_SIZE);
drh9eb9e262004-02-11 02:18:05 +00001600 CODEC(pPager, PGHDR_TO_DATA(pList), pList->pgno, 6);
drha6abd042004-06-09 17:37:22 +00001601 TRACE2("STORE page %d\n", pList->pgno);
danielk19774adee202004-05-08 08:23:19 +00001602 rc = sqlite3OsWrite(&pPager->fd, PGHDR_TO_DATA(pList), SQLITE_PAGE_SIZE);
drh9eb9e262004-02-11 02:18:05 +00001603 CODEC(pPager, PGHDR_TO_DATA(pList), pList->pgno, 0);
drh2554f8b2003-01-22 01:26:44 +00001604 if( rc ) return rc;
1605 pList->dirty = 0;
1606 pList = pList->pDirty;
1607 }
1608 return SQLITE_OK;
1609}
1610
1611/*
1612** Collect every dirty page into a dirty list and
1613** return a pointer to the head of that list. All pages are
1614** collected even if they are still in use.
1615*/
1616static PgHdr *pager_get_all_dirty_pages(Pager *pPager){
1617 PgHdr *p, *pList;
1618 pList = 0;
1619 for(p=pPager->pAll; p; p=p->pNextAll){
1620 if( p->dirty ){
1621 p->pDirty = pList;
1622 pList = p;
1623 }
1624 }
1625 return pList;
1626}
1627
1628/*
drhd9b02572001-04-15 00:37:09 +00001629** Acquire a page.
1630**
drh58a11682001-11-10 13:51:08 +00001631** A read lock on the disk file is obtained when the first page is acquired.
drh5e00f6c2001-09-13 13:46:56 +00001632** This read lock is dropped when the last page is released.
drhd9b02572001-04-15 00:37:09 +00001633**
drh306dc212001-05-21 13:45:10 +00001634** A _get works for any page number greater than 0. If the database
1635** file is smaller than the requested page, then no actual disk
1636** read occurs and the memory image of the page is initialized to
1637** all zeros. The extra data appended to a page is always initialized
1638** to zeros the first time a page is loaded into memory.
1639**
drhd9b02572001-04-15 00:37:09 +00001640** The acquisition might fail for several reasons. In all cases,
1641** an appropriate error code is returned and *ppPage is set to NULL.
drh7e3b0a02001-04-28 16:52:40 +00001642**
drh3aac2dd2004-04-26 14:10:20 +00001643** See also sqlite3pager_lookup(). Both this routine and _lookup() attempt
drh7e3b0a02001-04-28 16:52:40 +00001644** to find a page in the in-memory cache first. If the page is not already
drh5e00f6c2001-09-13 13:46:56 +00001645** in memory, this routine goes to disk to read it in whereas _lookup()
drh7e3b0a02001-04-28 16:52:40 +00001646** just returns 0. This routine acquires a read-lock the first time it
1647** has to go to disk, and could also playback an old journal if necessary.
1648** Since _lookup() never goes to disk, it never has to deal with locks
1649** or journal files.
drhed7c8552001-04-11 14:29:21 +00001650*/
drh3aac2dd2004-04-26 14:10:20 +00001651int sqlite3pager_get(Pager *pPager, Pgno pgno, void **ppPage){
drhed7c8552001-04-11 14:29:21 +00001652 PgHdr *pPg;
drh8766c342002-11-09 00:33:15 +00001653 int rc;
drhed7c8552001-04-11 14:29:21 +00001654
drhd9b02572001-04-15 00:37:09 +00001655 /* Make sure we have not hit any critical errors.
1656 */
drh836faa42003-01-11 13:30:57 +00001657 assert( pPager!=0 );
1658 assert( pgno!=0 );
drh2e6d11b2003-04-25 15:37:57 +00001659 *ppPage = 0;
drhd9b02572001-04-15 00:37:09 +00001660 if( pPager->errMask & ~(PAGER_ERR_FULL) ){
1661 return pager_errcode(pPager);
1662 }
1663
danielk197713adf8a2004-06-03 16:08:41 +00001664 /* If this is the first page accessed, then get a SHARED lock
drhed7c8552001-04-11 14:29:21 +00001665 ** on the database file.
1666 */
drhac69b052004-05-12 13:30:07 +00001667 if( pPager->nRef==0 && !pPager->memDb ){
danielk197724162fe2004-06-04 06:22:00 +00001668 int busy = 1;
danielk19779eed5052004-06-04 10:38:30 +00001669 do {
1670 rc = sqlite3OsLock(&pPager->fd, SHARED_LOCK);
1671 }while( rc==SQLITE_BUSY &&
1672 pPager->pBusyHandler &&
1673 pPager->pBusyHandler->xFunc &&
danielk19772a764eb2004-06-12 01:43:26 +00001674 pPager->pBusyHandler->xFunc(pPager->pBusyHandler->pArg, busy++)
danielk19779eed5052004-06-04 10:38:30 +00001675 );
1676 if( rc!=SQLITE_OK ){
1677 return rc;
drhed7c8552001-04-11 14:29:21 +00001678 }
drha6abd042004-06-09 17:37:22 +00001679 pPager->state = PAGER_SHARED;
drhed7c8552001-04-11 14:29:21 +00001680
danielk197713adf8a2004-06-03 16:08:41 +00001681 /* If a journal file exists, and there is no RESERVED lock on the
1682 ** database file, then it either needs to be played back or deleted.
drhed7c8552001-04-11 14:29:21 +00001683 */
danielk197713adf8a2004-06-03 16:08:41 +00001684 if( pPager->useJournal &&
1685 sqlite3OsFileExists(pPager->zJournal) &&
drha6abd042004-06-09 17:37:22 +00001686 !sqlite3OsCheckReservedLock(&pPager->fd)
danielk197713adf8a2004-06-03 16:08:41 +00001687 ){
drhe2227f02003-06-14 11:42:57 +00001688 int rc;
drhed7c8552001-04-11 14:29:21 +00001689
danielk197713adf8a2004-06-03 16:08:41 +00001690 /* Get an EXCLUSIVE lock on the database file. */
1691 rc = sqlite3OsLock(&pPager->fd, EXCLUSIVE_LOCK);
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;
drh8766c342002-11-09 00:33:15 +00001695 return rc;
drha7fcb052001-12-14 15:09:55 +00001696 }
drha6abd042004-06-09 17:37:22 +00001697 pPager->state = PAGER_EXCLUSIVE;
drha7fcb052001-12-14 15:09:55 +00001698
drhe2227f02003-06-14 11:42:57 +00001699 /* Open the journal for reading only. Return SQLITE_BUSY if
1700 ** we are unable to open the journal file.
drhf57b3392001-10-08 13:22:32 +00001701 **
drhe2227f02003-06-14 11:42:57 +00001702 ** The journal file does not need to be locked itself. The
1703 ** journal file is never open unless the main database file holds
1704 ** a write lock, so there is never any chance of two or more
1705 ** processes opening the journal at the same time.
drhed7c8552001-04-11 14:29:21 +00001706 */
danielk19774adee202004-05-08 08:23:19 +00001707 rc = sqlite3OsOpenReadOnly(pPager->zJournal, &pPager->jfd);
drha7fcb052001-12-14 15:09:55 +00001708 if( rc!=SQLITE_OK ){
drha6abd042004-06-09 17:37:22 +00001709 sqlite3OsUnlock(&pPager->fd, NO_LOCK);
1710 pPager->state = PAGER_UNLOCK;
drhed7c8552001-04-11 14:29:21 +00001711 return SQLITE_BUSY;
1712 }
drha7fcb052001-12-14 15:09:55 +00001713 pPager->journalOpen = 1;
drhdb48ee02003-01-16 13:42:43 +00001714 pPager->journalStarted = 0;
drhed7c8552001-04-11 14:29:21 +00001715
1716 /* Playback and delete the journal. Drop the database write
1717 ** lock and reacquire the read lock.
1718 */
drh99ee3602003-02-16 19:13:36 +00001719 rc = pager_playback(pPager, 0);
drhd9b02572001-04-15 00:37:09 +00001720 if( rc!=SQLITE_OK ){
1721 return rc;
1722 }
drhed7c8552001-04-11 14:29:21 +00001723 }
1724 pPg = 0;
1725 }else{
1726 /* Search for page in cache */
drhd9b02572001-04-15 00:37:09 +00001727 pPg = pager_lookup(pPager, pgno);
drha6abd042004-06-09 17:37:22 +00001728 if( pPager->memDb && pPager->state==PAGER_UNLOCK ){
1729 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00001730 }
drhed7c8552001-04-11 14:29:21 +00001731 }
1732 if( pPg==0 ){
drhd9b02572001-04-15 00:37:09 +00001733 /* The requested page is not in the page cache. */
drhed7c8552001-04-11 14:29:21 +00001734 int h;
drh7e3b0a02001-04-28 16:52:40 +00001735 pPager->nMiss++;
drhac69b052004-05-12 13:30:07 +00001736 if( pPager->nPage<pPager->mxPage || pPager->pFirst==0 || pPager->memDb ){
drhed7c8552001-04-11 14:29:21 +00001737 /* Create a new page */
drhd0ba1932004-02-10 01:54:28 +00001738 pPg = sqliteMallocRaw( sizeof(*pPg) + SQLITE_PAGE_SIZE
drhac69b052004-05-12 13:30:07 +00001739 + sizeof(u32) + pPager->nExtra
1740 + pPager->memDb*sizeof(PgHistory) );
drhd9b02572001-04-15 00:37:09 +00001741 if( pPg==0 ){
danielk19778def5ea2004-06-16 10:39:52 +00001742 if( !pPager->memDb ){
1743 pager_unwritelock(pPager);
1744 }
drhd9b02572001-04-15 00:37:09 +00001745 pPager->errMask |= PAGER_ERR_MEM;
1746 return SQLITE_NOMEM;
1747 }
drh8c1238a2003-01-02 14:43:55 +00001748 memset(pPg, 0, sizeof(*pPg));
drhac69b052004-05-12 13:30:07 +00001749 if( pPager->memDb ){
1750 memset(PGHDR_TO_HIST(pPg, pPager), 0, sizeof(PgHistory));
1751 }
drhed7c8552001-04-11 14:29:21 +00001752 pPg->pPager = pPager;
drhd9b02572001-04-15 00:37:09 +00001753 pPg->pNextAll = pPager->pAll;
drhd79caeb2001-04-15 02:27:24 +00001754 pPager->pAll = pPg;
drhd9b02572001-04-15 00:37:09 +00001755 pPager->nPage++;
drhed7c8552001-04-11 14:29:21 +00001756 }else{
drhdb48ee02003-01-16 13:42:43 +00001757 /* Find a page to recycle. Try to locate a page that does not
1758 ** require us to do an fsync() on the journal.
1759 */
drh341eae82003-01-21 02:39:36 +00001760 pPg = pPager->pFirstSynced;
drhb19a2bc2001-09-16 00:13:26 +00001761
drhdb48ee02003-01-16 13:42:43 +00001762 /* If we could not find a page that does not require an fsync()
1763 ** on the journal file then fsync the journal file. This is a
1764 ** very slow operation, so we work hard to avoid it. But sometimes
1765 ** it can't be helped.
drhb19a2bc2001-09-16 00:13:26 +00001766 */
drh603240c2002-03-05 01:11:12 +00001767 if( pPg==0 ){
danielk197713adf8a2004-06-03 16:08:41 +00001768 int rc = syncJournal(pPager, 0);
drh50e5dad2001-09-15 00:57:28 +00001769 if( rc!=0 ){
drh3aac2dd2004-04-26 14:10:20 +00001770 sqlite3pager_rollback(pPager);
drh50e5dad2001-09-15 00:57:28 +00001771 return SQLITE_IOERR;
1772 }
1773 pPg = pPager->pFirst;
1774 }
drhd9b02572001-04-15 00:37:09 +00001775 assert( pPg->nRef==0 );
drhdb48ee02003-01-16 13:42:43 +00001776
1777 /* Write the page to the database file if it is dirty.
1778 */
1779 if( pPg->dirty ){
1780 assert( pPg->needSync==0 );
drh2554f8b2003-01-22 01:26:44 +00001781 pPg->pDirty = 0;
1782 rc = pager_write_pagelist( pPg );
drhdb48ee02003-01-16 13:42:43 +00001783 if( rc!=SQLITE_OK ){
drh3aac2dd2004-04-26 14:10:20 +00001784 sqlite3pager_rollback(pPager);
drhdb48ee02003-01-16 13:42:43 +00001785 return SQLITE_IOERR;
1786 }
drhdb48ee02003-01-16 13:42:43 +00001787 }
drh50e5dad2001-09-15 00:57:28 +00001788 assert( pPg->dirty==0 );
drhd9b02572001-04-15 00:37:09 +00001789
drhdb48ee02003-01-16 13:42:43 +00001790 /* If the page we are recycling is marked as alwaysRollback, then
drh193a6b42002-07-07 16:52:46 +00001791 ** set the global alwaysRollback flag, thus disabling the
1792 ** sqlite_dont_rollback() optimization for the rest of this transaction.
1793 ** It is necessary to do this because the page marked alwaysRollback
1794 ** might be reloaded at a later time but at that point we won't remember
1795 ** that is was marked alwaysRollback. This means that all pages must
1796 ** be marked as alwaysRollback from here on out.
1797 */
1798 if( pPg->alwaysRollback ){
1799 pPager->alwaysRollback = 1;
1800 }
1801
drhd9b02572001-04-15 00:37:09 +00001802 /* Unlink the old page from the free list and the hash table
1803 */
drhac69b052004-05-12 13:30:07 +00001804 unlinkPage(pPg);
drhd9b02572001-04-15 00:37:09 +00001805 pPager->nOvfl++;
drhed7c8552001-04-11 14:29:21 +00001806 }
1807 pPg->pgno = pgno;
drh1ab43002002-01-14 09:28:19 +00001808 if( pPager->aInJournal && (int)pgno<=pPager->origDbSize ){
danielk19774adee202004-05-08 08:23:19 +00001809 sqlite3CheckMemory(pPager->aInJournal, pgno/8);
drhdb48ee02003-01-16 13:42:43 +00001810 assert( pPager->journalOpen );
drh6019e162001-07-02 17:51:45 +00001811 pPg->inJournal = (pPager->aInJournal[pgno/8] & (1<<(pgno&7)))!=0;
drhdb48ee02003-01-16 13:42:43 +00001812 pPg->needSync = 0;
drh6019e162001-07-02 17:51:45 +00001813 }else{
1814 pPg->inJournal = 0;
drhdb48ee02003-01-16 13:42:43 +00001815 pPg->needSync = 0;
drh6019e162001-07-02 17:51:45 +00001816 }
drhac69b052004-05-12 13:30:07 +00001817 if( pPager->aInStmt && (int)pgno<=pPager->stmtSize
1818 && (pPager->aInStmt[pgno/8] & (1<<(pgno&7)))!=0 ){
drh3aac2dd2004-04-26 14:10:20 +00001819 page_add_to_stmt_list(pPg);
drhfa86c412002-02-02 15:01:15 +00001820 }else{
drh3aac2dd2004-04-26 14:10:20 +00001821 page_remove_from_stmt_list(pPg);
drhfa86c412002-02-02 15:01:15 +00001822 }
drhed7c8552001-04-11 14:29:21 +00001823 pPg->dirty = 0;
1824 pPg->nRef = 1;
drhdd793422001-06-28 01:54:48 +00001825 REFINFO(pPg);
drhd9b02572001-04-15 00:37:09 +00001826 pPager->nRef++;
1827 h = pager_hash(pgno);
drhed7c8552001-04-11 14:29:21 +00001828 pPg->pNextHash = pPager->aHash[h];
1829 pPager->aHash[h] = pPg;
1830 if( pPg->pNextHash ){
1831 assert( pPg->pNextHash->pPrevHash==0 );
1832 pPg->pNextHash->pPrevHash = pPg;
1833 }
drh2e6d11b2003-04-25 15:37:57 +00001834 if( pPager->nExtra>0 ){
1835 memset(PGHDR_TO_EXTRA(pPg), 0, pPager->nExtra);
1836 }
drh3aac2dd2004-04-26 14:10:20 +00001837 if( pPager->dbSize<0 ) sqlite3pager_pagecount(pPager);
drh2e6d11b2003-04-25 15:37:57 +00001838 if( pPager->errMask!=0 ){
drh3aac2dd2004-04-26 14:10:20 +00001839 sqlite3pager_unref(PGHDR_TO_DATA(pPg));
drh2e6d11b2003-04-25 15:37:57 +00001840 rc = pager_errcode(pPager);
1841 return rc;
1842 }
drh1ab43002002-01-14 09:28:19 +00001843 if( pPager->dbSize<(int)pgno ){
drhd0ba1932004-02-10 01:54:28 +00001844 memset(PGHDR_TO_DATA(pPg), 0, SQLITE_PAGE_SIZE);
drh306dc212001-05-21 13:45:10 +00001845 }else{
drh81a20f22001-10-12 17:30:04 +00001846 int rc;
drhac69b052004-05-12 13:30:07 +00001847 assert( pPager->memDb==0 );
danielk19774adee202004-05-08 08:23:19 +00001848 sqlite3OsSeek(&pPager->fd, (pgno-1)*(off_t)SQLITE_PAGE_SIZE);
1849 rc = sqlite3OsRead(&pPager->fd, PGHDR_TO_DATA(pPg), SQLITE_PAGE_SIZE);
drha6abd042004-06-09 17:37:22 +00001850 TRACE2("FETCH page %d\n", pPg->pgno);
drh9eb9e262004-02-11 02:18:05 +00001851 CODEC(pPager, PGHDR_TO_DATA(pPg), pPg->pgno, 3);
drh81a20f22001-10-12 17:30:04 +00001852 if( rc!=SQLITE_OK ){
drh28be87c2002-11-05 23:03:02 +00001853 off_t fileSize;
danielk19774adee202004-05-08 08:23:19 +00001854 if( sqlite3OsFileSize(&pPager->fd,&fileSize)!=SQLITE_OK
drhd0ba1932004-02-10 01:54:28 +00001855 || fileSize>=pgno*SQLITE_PAGE_SIZE ){
drh3aac2dd2004-04-26 14:10:20 +00001856 sqlite3pager_unref(PGHDR_TO_DATA(pPg));
drh4e371ee2002-09-05 16:08:27 +00001857 return rc;
1858 }else{
drhd0ba1932004-02-10 01:54:28 +00001859 memset(PGHDR_TO_DATA(pPg), 0, SQLITE_PAGE_SIZE);
drh4e371ee2002-09-05 16:08:27 +00001860 }
drh81a20f22001-10-12 17:30:04 +00001861 }
drh306dc212001-05-21 13:45:10 +00001862 }
drhed7c8552001-04-11 14:29:21 +00001863 }else{
drhd9b02572001-04-15 00:37:09 +00001864 /* The requested page is in the page cache. */
drh7e3b0a02001-04-28 16:52:40 +00001865 pPager->nHit++;
drhdf0b3b02001-06-23 11:36:20 +00001866 page_ref(pPg);
drhed7c8552001-04-11 14:29:21 +00001867 }
1868 *ppPage = PGHDR_TO_DATA(pPg);
1869 return SQLITE_OK;
1870}
1871
1872/*
drh7e3b0a02001-04-28 16:52:40 +00001873** Acquire a page if it is already in the in-memory cache. Do
1874** not read the page from disk. Return a pointer to the page,
1875** or 0 if the page is not in cache.
1876**
drh3aac2dd2004-04-26 14:10:20 +00001877** See also sqlite3pager_get(). The difference between this routine
1878** and sqlite3pager_get() is that _get() will go to the disk and read
drh7e3b0a02001-04-28 16:52:40 +00001879** in the page if the page is not already in cache. This routine
drh5e00f6c2001-09-13 13:46:56 +00001880** returns NULL if the page is not in cache or if a disk I/O error
1881** has ever happened.
drh7e3b0a02001-04-28 16:52:40 +00001882*/
drh3aac2dd2004-04-26 14:10:20 +00001883void *sqlite3pager_lookup(Pager *pPager, Pgno pgno){
drh7e3b0a02001-04-28 16:52:40 +00001884 PgHdr *pPg;
1885
drh836faa42003-01-11 13:30:57 +00001886 assert( pPager!=0 );
1887 assert( pgno!=0 );
drh7e3b0a02001-04-28 16:52:40 +00001888 if( pPager->errMask & ~(PAGER_ERR_FULL) ){
1889 return 0;
1890 }
drh7e3b0a02001-04-28 16:52:40 +00001891 pPg = pager_lookup(pPager, pgno);
1892 if( pPg==0 ) return 0;
drhdf0b3b02001-06-23 11:36:20 +00001893 page_ref(pPg);
drh7e3b0a02001-04-28 16:52:40 +00001894 return PGHDR_TO_DATA(pPg);
1895}
1896
1897/*
drhed7c8552001-04-11 14:29:21 +00001898** Release a page.
1899**
1900** If the number of references to the page drop to zero, then the
1901** page is added to the LRU list. When all references to all pages
drhd9b02572001-04-15 00:37:09 +00001902** are released, a rollback occurs and the lock on the database is
drhed7c8552001-04-11 14:29:21 +00001903** removed.
1904*/
drh3aac2dd2004-04-26 14:10:20 +00001905int sqlite3pager_unref(void *pData){
drhed7c8552001-04-11 14:29:21 +00001906 PgHdr *pPg;
drhd9b02572001-04-15 00:37:09 +00001907
1908 /* Decrement the reference count for this page
1909 */
drhed7c8552001-04-11 14:29:21 +00001910 pPg = DATA_TO_PGHDR(pData);
1911 assert( pPg->nRef>0 );
drhed7c8552001-04-11 14:29:21 +00001912 pPg->nRef--;
drhdd793422001-06-28 01:54:48 +00001913 REFINFO(pPg);
drhd9b02572001-04-15 00:37:09 +00001914
drh72f82862001-05-24 21:06:34 +00001915 /* When the number of references to a page reach 0, call the
1916 ** destructor and add the page to the freelist.
drhd9b02572001-04-15 00:37:09 +00001917 */
drhed7c8552001-04-11 14:29:21 +00001918 if( pPg->nRef==0 ){
drh1eaa2692001-09-18 02:02:23 +00001919 Pager *pPager;
1920 pPager = pPg->pPager;
drhd9b02572001-04-15 00:37:09 +00001921 pPg->pNextFree = 0;
1922 pPg->pPrevFree = pPager->pLast;
drhed7c8552001-04-11 14:29:21 +00001923 pPager->pLast = pPg;
drhd9b02572001-04-15 00:37:09 +00001924 if( pPg->pPrevFree ){
1925 pPg->pPrevFree->pNextFree = pPg;
drhed7c8552001-04-11 14:29:21 +00001926 }else{
1927 pPager->pFirst = pPg;
1928 }
drh341eae82003-01-21 02:39:36 +00001929 if( pPg->needSync==0 && pPager->pFirstSynced==0 ){
1930 pPager->pFirstSynced = pPg;
1931 }
drh72f82862001-05-24 21:06:34 +00001932 if( pPager->xDestructor ){
drhb6f41482004-05-14 01:58:11 +00001933 pPager->xDestructor(pData, pPager->pageSize);
drh72f82862001-05-24 21:06:34 +00001934 }
drhd9b02572001-04-15 00:37:09 +00001935
1936 /* When all pages reach the freelist, drop the read lock from
1937 ** the database file.
1938 */
1939 pPager->nRef--;
1940 assert( pPager->nRef>=0 );
drhac69b052004-05-12 13:30:07 +00001941 if( pPager->nRef==0 && !pPager->memDb ){
drhd9b02572001-04-15 00:37:09 +00001942 pager_reset(pPager);
1943 }
drhed7c8552001-04-11 14:29:21 +00001944 }
drhd9b02572001-04-15 00:37:09 +00001945 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +00001946}
1947
1948/*
drha6abd042004-06-09 17:37:22 +00001949** Create a journal file for pPager. There should already be a RESERVED
1950** or EXCLUSIVE lock on the database file when this routine is called.
drhda47d772002-12-02 04:25:19 +00001951**
1952** Return SQLITE_OK if everything. Return an error code and release the
1953** write lock if anything goes wrong.
1954*/
1955static int pager_open_journal(Pager *pPager){
1956 int rc;
danielk1977eac7a362004-06-16 07:45:24 +00001957 assert( !pPager->memDb );
drha6abd042004-06-09 17:37:22 +00001958 assert( pPager->state>=PAGER_RESERVED );
drhda47d772002-12-02 04:25:19 +00001959 assert( pPager->journalOpen==0 );
1960 assert( pPager->useJournal );
drh3aac2dd2004-04-26 14:10:20 +00001961 sqlite3pager_pagecount(pPager);
drhda47d772002-12-02 04:25:19 +00001962 pPager->aInJournal = sqliteMalloc( pPager->dbSize/8 + 1 );
1963 if( pPager->aInJournal==0 ){
drha6abd042004-06-09 17:37:22 +00001964 sqlite3OsUnlock(&pPager->fd, SHARED_LOCK);
1965 pPager->state = PAGER_SHARED;
drhda47d772002-12-02 04:25:19 +00001966 return SQLITE_NOMEM;
1967 }
danielk19774adee202004-05-08 08:23:19 +00001968 rc = sqlite3OsOpenExclusive(pPager->zJournal, &pPager->jfd,pPager->tempFile);
drhda47d772002-12-02 04:25:19 +00001969 if( rc!=SQLITE_OK ){
1970 sqliteFree(pPager->aInJournal);
1971 pPager->aInJournal = 0;
drha6abd042004-06-09 17:37:22 +00001972 sqlite3OsUnlock(&pPager->fd, SHARED_LOCK);
1973 pPager->state = PAGER_SHARED;
drhda47d772002-12-02 04:25:19 +00001974 return SQLITE_CANTOPEN;
1975 }
danielk19774adee202004-05-08 08:23:19 +00001976 sqlite3OsOpenDirectory(pPager->zDirectory, &pPager->jfd);
drhda47d772002-12-02 04:25:19 +00001977 pPager->journalOpen = 1;
drhdb48ee02003-01-16 13:42:43 +00001978 pPager->journalStarted = 0;
drhda47d772002-12-02 04:25:19 +00001979 pPager->needSync = 0;
1980 pPager->alwaysRollback = 0;
drh968af522003-02-11 14:55:40 +00001981 pPager->nRec = 0;
drh2e6d11b2003-04-25 15:37:57 +00001982 if( pPager->errMask!=0 ){
1983 rc = pager_errcode(pPager);
1984 return rc;
1985 }
drhda47d772002-12-02 04:25:19 +00001986 pPager->origDbSize = pPager->dbSize;
drhae2b40c2004-06-09 19:03:54 +00001987
1988 /* Create the header for the journal:
1989 ** - 8 bytes: Magic identifying journal format.
1990 ** - 4 bytes: Number of records in journal, or -1 no-sync mode is on.
1991 ** - 4 bytes: Magic used for page checksums.
1992 ** - 4 bytes: Initial database page count.
1993 ** - 4 bytes: Number of bytes reserved for master journal ptr (nMaster)
1994 ** - nMaster bytes: Space for a master journal pointer.
1995 */
1996 rc = sqlite3OsWrite(&pPager->jfd, aJournalMagic, sizeof(aJournalMagic));
1997 if( rc==SQLITE_OK ){
1998 rc = write32bits(&pPager->jfd, pPager->noSync ? 0xffffffff : 0);
1999 }
2000 if( rc==SQLITE_OK ){
2001 sqlite3Randomness(sizeof(pPager->cksumInit), &pPager->cksumInit);
2002 rc = write32bits(&pPager->jfd, pPager->cksumInit);
drhda47d772002-12-02 04:25:19 +00002003 }
2004 if( rc==SQLITE_OK ){
2005 rc = write32bits(&pPager->jfd, pPager->dbSize);
2006 }
drhae2b40c2004-06-09 19:03:54 +00002007 if( rc==SQLITE_OK ){
2008 rc = write32bits(&pPager->jfd, pPager->nMaster);
2009 }
2010 if( rc==SQLITE_OK ){
drhc9e06862004-06-09 20:03:08 +00002011 sqlite3OsSeek(&pPager->jfd, 24 + pPager->nMaster - 1);
2012 rc = sqlite3OsWrite(&pPager->jfd, "\000", 1);
drhae2b40c2004-06-09 19:03:54 +00002013 }
drhac69b052004-05-12 13:30:07 +00002014 if( pPager->stmtAutoopen && rc==SQLITE_OK ){
drh3aac2dd2004-04-26 14:10:20 +00002015 rc = sqlite3pager_stmt_begin(pPager);
drhda47d772002-12-02 04:25:19 +00002016 }
2017 if( rc!=SQLITE_OK ){
2018 rc = pager_unwritelock(pPager);
2019 if( rc==SQLITE_OK ){
2020 rc = SQLITE_FULL;
2021 }
2022 }
2023 return rc;
2024}
2025
2026/*
drh4b845d72002-03-05 12:41:19 +00002027** Acquire a write-lock on the database. The lock is removed when
2028** the any of the following happen:
2029**
drh3aac2dd2004-04-26 14:10:20 +00002030** * sqlite3pager_commit() is called.
2031** * sqlite3pager_rollback() is called.
2032** * sqlite3pager_close() is called.
2033** * sqlite3pager_unref() is called to on every outstanding page.
drh4b845d72002-03-05 12:41:19 +00002034**
danielk197713adf8a2004-06-03 16:08:41 +00002035** The first parameter to this routine is a pointer to any open page of the
2036** database file. Nothing changes about the page - it is used merely to
2037** acquire a pointer to the Pager structure and as proof that there is
2038** already a read-lock on the database.
drh4b845d72002-03-05 12:41:19 +00002039**
danielk197713adf8a2004-06-03 16:08:41 +00002040** The second parameter indicates how much space in bytes to reserve for a
2041** master journal file-name at the start of the journal when it is created.
2042**
2043** A journal file is opened if this is not a temporary file. For temporary
2044** files, the opening of the journal file is deferred until there is an
2045** actual need to write to the journal.
drhda47d772002-12-02 04:25:19 +00002046**
drha6abd042004-06-09 17:37:22 +00002047** If the database is already reserved for writing, this routine is a no-op.
drh4b845d72002-03-05 12:41:19 +00002048*/
danielk197713adf8a2004-06-03 16:08:41 +00002049int sqlite3pager_begin(void *pData, int nMaster){
drh4b845d72002-03-05 12:41:19 +00002050 PgHdr *pPg = DATA_TO_PGHDR(pData);
2051 Pager *pPager = pPg->pPager;
2052 int rc = SQLITE_OK;
2053 assert( pPg->nRef>0 );
danielk197713adf8a2004-06-03 16:08:41 +00002054 assert( nMaster>=0 );
drha6abd042004-06-09 17:37:22 +00002055 assert( pPager->state!=PAGER_UNLOCK );
2056 if( pPager->state==PAGER_SHARED ){
drh4b845d72002-03-05 12:41:19 +00002057 assert( pPager->aInJournal==0 );
drhac69b052004-05-12 13:30:07 +00002058 if( pPager->memDb ){
drha6abd042004-06-09 17:37:22 +00002059 pPager->state = PAGER_EXCLUSIVE;
drhac69b052004-05-12 13:30:07 +00002060 pPager->origDbSize = pPager->dbSize;
2061 }else{
danielk197724162fe2004-06-04 06:22:00 +00002062 int busy = 1;
danielk19779eed5052004-06-04 10:38:30 +00002063 do {
danielk19779eed5052004-06-04 10:38:30 +00002064 rc = sqlite3OsLock(&pPager->fd, RESERVED_LOCK);
2065 }while( rc==SQLITE_BUSY &&
2066 pPager->pBusyHandler &&
2067 pPager->pBusyHandler->xFunc &&
danielk19772a764eb2004-06-12 01:43:26 +00002068 pPager->pBusyHandler->xFunc(pPager->pBusyHandler->pArg, busy++)
danielk19779eed5052004-06-04 10:38:30 +00002069 );
2070 if( rc!=SQLITE_OK ){
2071 return rc;
drhac69b052004-05-12 13:30:07 +00002072 }
danielk197713adf8a2004-06-03 16:08:41 +00002073 pPager->nMaster = nMaster;
drha6abd042004-06-09 17:37:22 +00002074 pPager->state = PAGER_RESERVED;
2075 pPager->dirtyCache = 0;
2076 TRACE3("TRANSACTION %d nMaster=%d\n", pPager->fd.h, nMaster);
drhac69b052004-05-12 13:30:07 +00002077 if( pPager->useJournal && !pPager->tempFile ){
2078 rc = pager_open_journal(pPager);
2079 }
drh4b845d72002-03-05 12:41:19 +00002080 }
2081 }
2082 return rc;
2083}
2084
2085/*
drhed7c8552001-04-11 14:29:21 +00002086** Mark a data page as writeable. The page is written into the journal
2087** if it is not there already. This routine must be called before making
2088** changes to a page.
2089**
2090** The first time this routine is called, the pager creates a new
drha6abd042004-06-09 17:37:22 +00002091** journal and acquires a RESERVED lock on the database. If the RESERVED
drhed7c8552001-04-11 14:29:21 +00002092** lock could not be acquired, this routine returns SQLITE_BUSY. The
drh306dc212001-05-21 13:45:10 +00002093** calling routine must check for that return value and be careful not to
drhed7c8552001-04-11 14:29:21 +00002094** change any page data until this routine returns SQLITE_OK.
drhd9b02572001-04-15 00:37:09 +00002095**
2096** If the journal file could not be written because the disk is full,
2097** then this routine returns SQLITE_FULL and does an immediate rollback.
2098** All subsequent write attempts also return SQLITE_FULL until there
drh3aac2dd2004-04-26 14:10:20 +00002099** is a call to sqlite3pager_commit() or sqlite3pager_rollback() to
drhd9b02572001-04-15 00:37:09 +00002100** reset.
drhed7c8552001-04-11 14:29:21 +00002101*/
drh3aac2dd2004-04-26 14:10:20 +00002102int sqlite3pager_write(void *pData){
drh69688d52001-04-14 16:38:23 +00002103 PgHdr *pPg = DATA_TO_PGHDR(pData);
2104 Pager *pPager = pPg->pPager;
drhd79caeb2001-04-15 02:27:24 +00002105 int rc = SQLITE_OK;
drh69688d52001-04-14 16:38:23 +00002106
drh6446c4d2001-12-15 14:22:18 +00002107 /* Check for errors
2108 */
drhd9b02572001-04-15 00:37:09 +00002109 if( pPager->errMask ){
2110 return pager_errcode(pPager);
2111 }
drh5e00f6c2001-09-13 13:46:56 +00002112 if( pPager->readOnly ){
2113 return SQLITE_PERM;
2114 }
drh6446c4d2001-12-15 14:22:18 +00002115
2116 /* Mark the page as dirty. If the page has already been written
2117 ** to the journal then we can return right away.
2118 */
drhd9b02572001-04-15 00:37:09 +00002119 pPg->dirty = 1;
drhac69b052004-05-12 13:30:07 +00002120 if( pPg->inJournal && (pPg->inStmt || pPager->stmtInUse==0) ){
drha6abd042004-06-09 17:37:22 +00002121 pPager->dirtyCache = 1;
drhfa86c412002-02-02 15:01:15 +00002122 return SQLITE_OK;
2123 }
drh6446c4d2001-12-15 14:22:18 +00002124
2125 /* If we get this far, it means that the page needs to be
drhfa86c412002-02-02 15:01:15 +00002126 ** written to the transaction journal or the ckeckpoint journal
2127 ** or both.
2128 **
2129 ** First check to see that the transaction journal exists and
2130 ** create it if it does not.
drh6446c4d2001-12-15 14:22:18 +00002131 */
drha6abd042004-06-09 17:37:22 +00002132 assert( pPager->state!=PAGER_UNLOCK );
danielk197713adf8a2004-06-03 16:08:41 +00002133 rc = sqlite3pager_begin(pData, 0);
drhda47d772002-12-02 04:25:19 +00002134 if( rc!=SQLITE_OK ){
2135 return rc;
2136 }
drha6abd042004-06-09 17:37:22 +00002137 assert( pPager->state>=PAGER_RESERVED );
drhda47d772002-12-02 04:25:19 +00002138 if( !pPager->journalOpen && pPager->useJournal ){
2139 rc = pager_open_journal(pPager);
2140 if( rc!=SQLITE_OK ) return rc;
2141 }
2142 assert( pPager->journalOpen || !pPager->useJournal );
drha6abd042004-06-09 17:37:22 +00002143 pPager->dirtyCache = 1;
drh6446c4d2001-12-15 14:22:18 +00002144
drha6abd042004-06-09 17:37:22 +00002145 /* The transaction journal now exists and we have a RESERVED or an
2146 ** EXCLUSIVE lock on the main database file. Write the current page to
2147 ** the transaction journal if it is not there already.
drh6446c4d2001-12-15 14:22:18 +00002148 */
drhac69b052004-05-12 13:30:07 +00002149 if( !pPg->inJournal && (pPager->useJournal || pPager->memDb) ){
drhdb48ee02003-01-16 13:42:43 +00002150 if( (int)pPg->pgno <= pPager->origDbSize ){
drh968af522003-02-11 14:55:40 +00002151 int szPg;
2152 u32 saved;
drhac69b052004-05-12 13:30:07 +00002153 if( pPager->memDb ){
2154 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
drha6abd042004-06-09 17:37:22 +00002155 TRACE2("JOURNAL page %d\n", pPg->pgno);
drhac69b052004-05-12 13:30:07 +00002156 assert( pHist->pOrig==0 );
2157 pHist->pOrig = sqliteMallocRaw( pPager->pageSize );
2158 if( pHist->pOrig ){
2159 memcpy(pHist->pOrig, PGHDR_TO_DATA(pPg), pPager->pageSize);
2160 }
2161 pPg->inJournal = 1;
danielk197713adf8a2004-06-03 16:08:41 +00002162 }else{
drhae2b40c2004-06-09 19:03:54 +00002163 u32 cksum = pager_cksum(pPager, pPg->pgno, pData);
2164 saved = *(u32*)PGHDR_TO_EXTRA(pPg);
2165 store32bits(cksum, pPg, SQLITE_PAGE_SIZE);
2166 szPg = SQLITE_PAGE_SIZE+8;
drhac69b052004-05-12 13:30:07 +00002167 store32bits(pPg->pgno, pPg, -4);
2168 CODEC(pPager, pData, pPg->pgno, 7);
2169 rc = sqlite3OsWrite(&pPager->jfd, &((char*)pData)[-4], szPg);
drha6abd042004-06-09 17:37:22 +00002170 TRACE3("JOURNAL page %d needSync=%d\n", pPg->pgno, pPg->needSync);
drhac69b052004-05-12 13:30:07 +00002171 CODEC(pPager, pData, pPg->pgno, 0);
drhae2b40c2004-06-09 19:03:54 +00002172 *(u32*)PGHDR_TO_EXTRA(pPg) = saved;
drhac69b052004-05-12 13:30:07 +00002173 if( rc!=SQLITE_OK ){
2174 sqlite3pager_rollback(pPager);
2175 pPager->errMask |= PAGER_ERR_FULL;
2176 return rc;
2177 }
2178 pPager->nRec++;
2179 assert( pPager->aInJournal!=0 );
2180 pPager->aInJournal[pPg->pgno/8] |= 1<<(pPg->pgno&7);
2181 pPg->needSync = !pPager->noSync;
2182 pPg->inJournal = 1;
2183 if( pPager->stmtInUse ){
2184 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
2185 page_add_to_stmt_list(pPg);
2186 }
drhdb48ee02003-01-16 13:42:43 +00002187 }
drhdb48ee02003-01-16 13:42:43 +00002188 }else{
2189 pPg->needSync = !pPager->journalStarted && !pPager->noSync;
drha6abd042004-06-09 17:37:22 +00002190 TRACE3("APPEND page %d needSync=%d\n", pPg->pgno, pPg->needSync);
drhd9b02572001-04-15 00:37:09 +00002191 }
drhdb48ee02003-01-16 13:42:43 +00002192 if( pPg->needSync ){
2193 pPager->needSync = 1;
drhfa86c412002-02-02 15:01:15 +00002194 }
drh69688d52001-04-14 16:38:23 +00002195 }
drh6446c4d2001-12-15 14:22:18 +00002196
drhac69b052004-05-12 13:30:07 +00002197 /* If the statement journal is open and the page is not in it,
2198 ** then write the current page to the statement journal. Note that
drhae2b40c2004-06-09 19:03:54 +00002199 ** the statement journal format differs from the standard journal format
2200 ** in that it omits the checksums and the header.
drh6446c4d2001-12-15 14:22:18 +00002201 */
drhac69b052004-05-12 13:30:07 +00002202 if( pPager->stmtInUse && !pPg->inStmt && (int)pPg->pgno<=pPager->stmtSize ){
drh1e336b42002-02-14 12:50:33 +00002203 assert( pPg->inJournal || (int)pPg->pgno>pPager->origDbSize );
drhac69b052004-05-12 13:30:07 +00002204 if( pPager->memDb ){
2205 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
2206 assert( pHist->pStmt==0 );
2207 pHist->pStmt = sqliteMallocRaw( pPager->pageSize );
2208 if( pHist->pStmt ){
2209 memcpy(pHist->pStmt, PGHDR_TO_DATA(pPg), pPager->pageSize);
2210 }
drha6abd042004-06-09 17:37:22 +00002211 TRACE2("STMT-JOURNAL page %d\n", pPg->pgno);
drhac69b052004-05-12 13:30:07 +00002212 }else{
2213 store32bits(pPg->pgno, pPg, -4);
2214 CODEC(pPager, pData, pPg->pgno, 7);
2215 rc = sqlite3OsWrite(&pPager->stfd, ((char*)pData)-4, SQLITE_PAGE_SIZE+4);
drha6abd042004-06-09 17:37:22 +00002216 TRACE2("STMT-JOURNAL page %d\n", pPg->pgno);
drhac69b052004-05-12 13:30:07 +00002217 CODEC(pPager, pData, pPg->pgno, 0);
2218 if( rc!=SQLITE_OK ){
2219 sqlite3pager_rollback(pPager);
2220 pPager->errMask |= PAGER_ERR_FULL;
2221 return rc;
2222 }
2223 pPager->stmtNRec++;
2224 assert( pPager->aInStmt!=0 );
2225 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drhfa86c412002-02-02 15:01:15 +00002226 }
drh3aac2dd2004-04-26 14:10:20 +00002227 page_add_to_stmt_list(pPg);
drhfa86c412002-02-02 15:01:15 +00002228 }
2229
2230 /* Update the database size and return.
2231 */
drh1ab43002002-01-14 09:28:19 +00002232 if( pPager->dbSize<(int)pPg->pgno ){
drh306dc212001-05-21 13:45:10 +00002233 pPager->dbSize = pPg->pgno;
drh1f595712004-06-15 01:40:29 +00002234 if( !pPager->memDb && pPager->dbSize==PENDING_BYTE/pPager->pageSize ){
2235 pPager->dbSize++;
2236 }
drh306dc212001-05-21 13:45:10 +00002237 }
drh69688d52001-04-14 16:38:23 +00002238 return rc;
drhed7c8552001-04-11 14:29:21 +00002239}
2240
2241/*
drhaacc5432002-01-06 17:07:40 +00002242** Return TRUE if the page given in the argument was previously passed
drh3aac2dd2004-04-26 14:10:20 +00002243** to sqlite3pager_write(). In other words, return TRUE if it is ok
drh6019e162001-07-02 17:51:45 +00002244** to change the content of the page.
2245*/
drh3aac2dd2004-04-26 14:10:20 +00002246int sqlite3pager_iswriteable(void *pData){
drh6019e162001-07-02 17:51:45 +00002247 PgHdr *pPg = DATA_TO_PGHDR(pData);
2248 return pPg->dirty;
2249}
2250
2251/*
drh001bbcb2003-03-19 03:14:00 +00002252** Replace the content of a single page with the information in the third
2253** argument.
2254*/
drh3aac2dd2004-04-26 14:10:20 +00002255int sqlite3pager_overwrite(Pager *pPager, Pgno pgno, void *pData){
drh001bbcb2003-03-19 03:14:00 +00002256 void *pPage;
2257 int rc;
2258
drh3aac2dd2004-04-26 14:10:20 +00002259 rc = sqlite3pager_get(pPager, pgno, &pPage);
drh001bbcb2003-03-19 03:14:00 +00002260 if( rc==SQLITE_OK ){
drh3aac2dd2004-04-26 14:10:20 +00002261 rc = sqlite3pager_write(pPage);
drh001bbcb2003-03-19 03:14:00 +00002262 if( rc==SQLITE_OK ){
drhd0ba1932004-02-10 01:54:28 +00002263 memcpy(pPage, pData, SQLITE_PAGE_SIZE);
drh001bbcb2003-03-19 03:14:00 +00002264 }
drh3aac2dd2004-04-26 14:10:20 +00002265 sqlite3pager_unref(pPage);
drh001bbcb2003-03-19 03:14:00 +00002266 }
2267 return rc;
2268}
2269
2270/*
drh30e58752002-03-02 20:41:57 +00002271** A call to this routine tells the pager that it is not necessary to
2272** write the information on page "pgno" back to the disk, even though
2273** that page might be marked as dirty.
2274**
2275** The overlying software layer calls this routine when all of the data
2276** on the given page is unused. The pager marks the page as clean so
2277** that it does not get written to disk.
2278**
2279** Tests show that this optimization, together with the
drh3aac2dd2004-04-26 14:10:20 +00002280** sqlite3pager_dont_rollback() below, more than double the speed
drh30e58752002-03-02 20:41:57 +00002281** of large INSERT operations and quadruple the speed of large DELETEs.
drh8e298f92002-07-06 16:28:47 +00002282**
2283** When this routine is called, set the alwaysRollback flag to true.
drh3aac2dd2004-04-26 14:10:20 +00002284** Subsequent calls to sqlite3pager_dont_rollback() for the same page
drh8e298f92002-07-06 16:28:47 +00002285** will thereafter be ignored. This is necessary to avoid a problem
2286** where a page with data is added to the freelist during one part of
2287** a transaction then removed from the freelist during a later part
2288** of the same transaction and reused for some other purpose. When it
2289** is first added to the freelist, this routine is called. When reused,
2290** the dont_rollback() routine is called. But because the page contains
2291** critical data, we still need to be sure it gets rolled back in spite
2292** of the dont_rollback() call.
drh30e58752002-03-02 20:41:57 +00002293*/
drh3aac2dd2004-04-26 14:10:20 +00002294void sqlite3pager_dont_write(Pager *pPager, Pgno pgno){
drh30e58752002-03-02 20:41:57 +00002295 PgHdr *pPg;
drh8e298f92002-07-06 16:28:47 +00002296
danielk1977eac7a362004-06-16 07:45:24 +00002297 if( pPager->memDb ) return;
2298
drh30e58752002-03-02 20:41:57 +00002299 pPg = pager_lookup(pPager, pgno);
drh8e298f92002-07-06 16:28:47 +00002300 pPg->alwaysRollback = 1;
drh30e58752002-03-02 20:41:57 +00002301 if( pPg && pPg->dirty ){
drh8124a302002-06-25 14:43:57 +00002302 if( pPager->dbSize==(int)pPg->pgno && pPager->origDbSize<pPager->dbSize ){
2303 /* If this pages is the last page in the file and the file has grown
2304 ** during the current transaction, then do NOT mark the page as clean.
2305 ** When the database file grows, we must make sure that the last page
2306 ** gets written at least once so that the disk file will be the correct
2307 ** size. If you do not write this page and the size of the file
2308 ** on the disk ends up being too small, that can lead to database
2309 ** corruption during the next transaction.
2310 */
2311 }else{
drha6abd042004-06-09 17:37:22 +00002312 TRACE3("DONT_WRITE page %d of %d\n", pgno, pPager->fd.h);
drh8124a302002-06-25 14:43:57 +00002313 pPg->dirty = 0;
2314 }
drh30e58752002-03-02 20:41:57 +00002315 }
2316}
2317
2318/*
2319** A call to this routine tells the pager that if a rollback occurs,
2320** it is not necessary to restore the data on the given page. This
2321** means that the pager does not have to record the given page in the
2322** rollback journal.
2323*/
drh3aac2dd2004-04-26 14:10:20 +00002324void sqlite3pager_dont_rollback(void *pData){
drh30e58752002-03-02 20:41:57 +00002325 PgHdr *pPg = DATA_TO_PGHDR(pData);
2326 Pager *pPager = pPg->pPager;
2327
drha6abd042004-06-09 17:37:22 +00002328 if( pPager->state!=PAGER_EXCLUSIVE || pPager->journalOpen==0 ) return;
drhac69b052004-05-12 13:30:07 +00002329 if( pPg->alwaysRollback || pPager->alwaysRollback || pPager->memDb ) return;
drh30e58752002-03-02 20:41:57 +00002330 if( !pPg->inJournal && (int)pPg->pgno <= pPager->origDbSize ){
2331 assert( pPager->aInJournal!=0 );
2332 pPager->aInJournal[pPg->pgno/8] |= 1<<(pPg->pgno&7);
2333 pPg->inJournal = 1;
drhac69b052004-05-12 13:30:07 +00002334 if( pPager->stmtInUse ){
2335 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drh3aac2dd2004-04-26 14:10:20 +00002336 page_add_to_stmt_list(pPg);
drh30e58752002-03-02 20:41:57 +00002337 }
drha6abd042004-06-09 17:37:22 +00002338 TRACE3("DONT_ROLLBACK page %d of %d\n", pPg->pgno, pPager->fd.h);
drh30e58752002-03-02 20:41:57 +00002339 }
drhac69b052004-05-12 13:30:07 +00002340 if( pPager->stmtInUse && !pPg->inStmt && (int)pPg->pgno<=pPager->stmtSize ){
drh30e58752002-03-02 20:41:57 +00002341 assert( pPg->inJournal || (int)pPg->pgno>pPager->origDbSize );
drhac69b052004-05-12 13:30:07 +00002342 assert( pPager->aInStmt!=0 );
2343 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drh3aac2dd2004-04-26 14:10:20 +00002344 page_add_to_stmt_list(pPg);
drh30e58752002-03-02 20:41:57 +00002345 }
2346}
2347
drhac69b052004-05-12 13:30:07 +00002348
2349/*
2350** Clear a PgHistory block
2351*/
2352static void clearHistory(PgHistory *pHist){
2353 sqliteFree(pHist->pOrig);
2354 sqliteFree(pHist->pStmt);
2355 pHist->pOrig = 0;
2356 pHist->pStmt = 0;
2357}
2358
drh30e58752002-03-02 20:41:57 +00002359/*
drhed7c8552001-04-11 14:29:21 +00002360** Commit all changes to the database and release the write lock.
drhd9b02572001-04-15 00:37:09 +00002361**
2362** If the commit fails for any reason, a rollback attempt is made
2363** and an error code is returned. If the commit worked, SQLITE_OK
2364** is returned.
drhed7c8552001-04-11 14:29:21 +00002365*/
drh3aac2dd2004-04-26 14:10:20 +00002366int sqlite3pager_commit(Pager *pPager){
drha1b351a2001-09-14 16:42:12 +00002367 int rc;
drhed7c8552001-04-11 14:29:21 +00002368 PgHdr *pPg;
drhd9b02572001-04-15 00:37:09 +00002369
2370 if( pPager->errMask==PAGER_ERR_FULL ){
drh3aac2dd2004-04-26 14:10:20 +00002371 rc = sqlite3pager_rollback(pPager);
drh4e371ee2002-09-05 16:08:27 +00002372 if( rc==SQLITE_OK ){
2373 rc = SQLITE_FULL;
2374 }
drhd9b02572001-04-15 00:37:09 +00002375 return rc;
2376 }
2377 if( pPager->errMask!=0 ){
2378 rc = pager_errcode(pPager);
2379 return rc;
2380 }
drha6abd042004-06-09 17:37:22 +00002381 if( pPager->state<PAGER_RESERVED ){
drhd9b02572001-04-15 00:37:09 +00002382 return SQLITE_ERROR;
2383 }
drha6abd042004-06-09 17:37:22 +00002384 TRACE2("COMMIT %d\n", pPager->fd.h);
drhac69b052004-05-12 13:30:07 +00002385 if( pPager->memDb ){
2386 pPg = pager_get_all_dirty_pages(pPager);
2387 while( pPg ){
2388 clearHistory(PGHDR_TO_HIST(pPg, pPager));
2389 pPg->dirty = 0;
2390 pPg->inJournal = 0;
2391 pPg->inStmt = 0;
2392 pPg->pPrevStmt = pPg->pNextStmt = 0;
2393 pPg = pPg->pDirty;
2394 }
danielk1977eac7a362004-06-16 07:45:24 +00002395#ifndef NDEBUG
2396 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2397 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
2398 assert( !pPg->alwaysRollback );
2399 assert( !pHist->pOrig );
2400 assert( !pHist->pStmt );
2401 }
2402#endif
drhac69b052004-05-12 13:30:07 +00002403 pPager->pStmt = 0;
drha6abd042004-06-09 17:37:22 +00002404 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00002405 return SQLITE_OK;
2406 }
drha6abd042004-06-09 17:37:22 +00002407 if( pPager->dirtyCache==0 ){
danielk19774adee202004-05-08 08:23:19 +00002408 /* Exit early (without doing the time-consuming sqlite3OsSync() calls)
drha1680452002-04-18 01:56:57 +00002409 ** if there have been no changes to the database file. */
drh341eae82003-01-21 02:39:36 +00002410 assert( pPager->needSync==0 );
drha1680452002-04-18 01:56:57 +00002411 rc = pager_unwritelock(pPager);
2412 pPager->dbSize = -1;
2413 return rc;
2414 }
drhda47d772002-12-02 04:25:19 +00002415 assert( pPager->journalOpen );
drha6abd042004-06-09 17:37:22 +00002416#if 0
danielk197713adf8a2004-06-03 16:08:41 +00002417 rc = syncJournal(pPager, 0);
drh240c5792004-02-08 00:40:52 +00002418 if( rc!=SQLITE_OK ){
drhd9b02572001-04-15 00:37:09 +00002419 goto commit_abort;
drhed7c8552001-04-11 14:29:21 +00002420 }
drh2554f8b2003-01-22 01:26:44 +00002421 pPg = pager_get_all_dirty_pages(pPager);
2422 if( pPg ){
2423 rc = pager_write_pagelist(pPg);
danielk19774adee202004-05-08 08:23:19 +00002424 if( rc || (!pPager->noSync && sqlite3OsSync(&pPager->fd)!=SQLITE_OK) ){
drh2554f8b2003-01-22 01:26:44 +00002425 goto commit_abort;
2426 }
drh603240c2002-03-05 01:11:12 +00002427 }
danielk197713adf8a2004-06-03 16:08:41 +00002428#endif
2429 rc = sqlite3pager_sync(pPager, 0);
drha6abd042004-06-09 17:37:22 +00002430 if( rc!=SQLITE_OK ){
2431 goto commit_abort;
2432 }
drhd9b02572001-04-15 00:37:09 +00002433 rc = pager_unwritelock(pPager);
2434 pPager->dbSize = -1;
2435 return rc;
2436
2437 /* Jump here if anything goes wrong during the commit process.
2438 */
2439commit_abort:
drh3aac2dd2004-04-26 14:10:20 +00002440 rc = sqlite3pager_rollback(pPager);
drhd9b02572001-04-15 00:37:09 +00002441 if( rc==SQLITE_OK ){
2442 rc = SQLITE_FULL;
drhed7c8552001-04-11 14:29:21 +00002443 }
drhed7c8552001-04-11 14:29:21 +00002444 return rc;
2445}
2446
2447/*
drha6abd042004-06-09 17:37:22 +00002448** Rollback all changes. The database falls back to PAGER_SHARED mode.
drhed7c8552001-04-11 14:29:21 +00002449** All in-memory cache pages revert to their original data contents.
2450** The journal is deleted.
drhd9b02572001-04-15 00:37:09 +00002451**
2452** This routine cannot fail unless some other process is not following
2453** the correct locking protocol (SQLITE_PROTOCOL) or unless some other
2454** process is writing trash into the journal file (SQLITE_CORRUPT) or
2455** unless a prior malloc() failed (SQLITE_NOMEM). Appropriate error
2456** codes are returned for all these occasions. Otherwise,
2457** SQLITE_OK is returned.
drhed7c8552001-04-11 14:29:21 +00002458*/
drh3aac2dd2004-04-26 14:10:20 +00002459int sqlite3pager_rollback(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +00002460 int rc;
drha6abd042004-06-09 17:37:22 +00002461 TRACE2("ROLLBACK %d\n", pPager->fd.h);
drhac69b052004-05-12 13:30:07 +00002462 if( pPager->memDb ){
2463 PgHdr *p;
2464 for(p=pPager->pAll; p; p=p->pNextAll){
2465 PgHistory *pHist;
danielk1977eac7a362004-06-16 07:45:24 +00002466 assert( !p->alwaysRollback );
2467 if( !p->dirty ){
2468 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pOrig );
2469 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pStmt );
2470 continue;
2471 }
2472
drhac69b052004-05-12 13:30:07 +00002473 pHist = PGHDR_TO_HIST(p, pPager);
2474 if( pHist->pOrig ){
2475 memcpy(PGHDR_TO_DATA(p), pHist->pOrig, pPager->pageSize);
2476 TRACE2("ROLLBACK-PAGE %d\n", p->pgno);
2477 }else{
2478 TRACE2("PAGE %d is clean\n", p->pgno);
2479 }
2480 clearHistory(pHist);
2481 p->dirty = 0;
2482 p->inJournal = 0;
2483 p->inStmt = 0;
2484 p->pPrevStmt = p->pNextStmt = 0;
danielk1977369f27e2004-06-15 11:40:04 +00002485
2486 if( pPager->xReiniter ){
2487 pPager->xReiniter(PGHDR_TO_DATA(p), pPager->pageSize);
2488 }
2489
drhac69b052004-05-12 13:30:07 +00002490 }
2491 pPager->pStmt = 0;
2492 pPager->dbSize = pPager->origDbSize;
2493 memoryTruncate(pPager);
2494 pPager->stmtInUse = 0;
drha6abd042004-06-09 17:37:22 +00002495 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00002496 return SQLITE_OK;
2497 }
2498
drha6abd042004-06-09 17:37:22 +00002499 if( !pPager->dirtyCache || !pPager->journalOpen ){
drhda47d772002-12-02 04:25:19 +00002500 rc = pager_unwritelock(pPager);
2501 pPager->dbSize = -1;
2502 return rc;
2503 }
drhdb48ee02003-01-16 13:42:43 +00002504
drhd9b02572001-04-15 00:37:09 +00002505 if( pPager->errMask!=0 && pPager->errMask!=PAGER_ERR_FULL ){
drha6abd042004-06-09 17:37:22 +00002506 if( pPager->state>=PAGER_EXCLUSIVE ){
drh99ee3602003-02-16 19:13:36 +00002507 pager_playback(pPager, 1);
drh4b845d72002-03-05 12:41:19 +00002508 }
drhd9b02572001-04-15 00:37:09 +00002509 return pager_errcode(pPager);
drhed7c8552001-04-11 14:29:21 +00002510 }
drha6abd042004-06-09 17:37:22 +00002511 if( pPager->state==PAGER_RESERVED ){
2512 int rc2;
2513 rc = pager_reload_cache(pPager);
2514 rc2 = pager_unwritelock(pPager);
2515 if( rc==SQLITE_OK ){
2516 rc = rc2;
2517 }
2518 }else{
2519 rc = pager_playback(pPager, 1);
drhd9b02572001-04-15 00:37:09 +00002520 }
drhd9b02572001-04-15 00:37:09 +00002521 if( rc!=SQLITE_OK ){
2522 rc = SQLITE_CORRUPT;
2523 pPager->errMask |= PAGER_ERR_CORRUPT;
2524 }
2525 pPager->dbSize = -1;
drhed7c8552001-04-11 14:29:21 +00002526 return rc;
drh98808ba2001-10-18 12:34:46 +00002527}
drhd9b02572001-04-15 00:37:09 +00002528
2529/*
drh5e00f6c2001-09-13 13:46:56 +00002530** Return TRUE if the database file is opened read-only. Return FALSE
2531** if the database is (in theory) writable.
2532*/
drh3aac2dd2004-04-26 14:10:20 +00002533int sqlite3pager_isreadonly(Pager *pPager){
drhbe0072d2001-09-13 14:46:09 +00002534 return pPager->readOnly;
drh5e00f6c2001-09-13 13:46:56 +00002535}
2536
2537/*
drhd9b02572001-04-15 00:37:09 +00002538** This routine is used for testing and analysis only.
2539*/
drh3aac2dd2004-04-26 14:10:20 +00002540int *sqlite3pager_stats(Pager *pPager){
drhd9b02572001-04-15 00:37:09 +00002541 static int a[9];
2542 a[0] = pPager->nRef;
2543 a[1] = pPager->nPage;
2544 a[2] = pPager->mxPage;
2545 a[3] = pPager->dbSize;
2546 a[4] = pPager->state;
2547 a[5] = pPager->errMask;
2548 a[6] = pPager->nHit;
2549 a[7] = pPager->nMiss;
2550 a[8] = pPager->nOvfl;
2551 return a;
2552}
drhdd793422001-06-28 01:54:48 +00002553
drhfa86c412002-02-02 15:01:15 +00002554/*
drhac69b052004-05-12 13:30:07 +00002555** Set the statement rollback point.
drhfa86c412002-02-02 15:01:15 +00002556**
2557** This routine should be called with the transaction journal already
drhac69b052004-05-12 13:30:07 +00002558** open. A new statement journal is created that can be used to rollback
drhaaab5722002-02-19 13:39:21 +00002559** changes of a single SQL command within a larger transaction.
drhfa86c412002-02-02 15:01:15 +00002560*/
drh3aac2dd2004-04-26 14:10:20 +00002561int sqlite3pager_stmt_begin(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00002562 int rc;
2563 char zTemp[SQLITE_TEMPNAME_SIZE];
drhac69b052004-05-12 13:30:07 +00002564 assert( !pPager->stmtInUse );
drha6abd042004-06-09 17:37:22 +00002565 TRACE2("STMT-BEGIN %d\n", pPager->fd.h);
drhac69b052004-05-12 13:30:07 +00002566 if( pPager->memDb ){
2567 pPager->stmtInUse = 1;
2568 pPager->stmtSize = pPager->dbSize;
2569 return SQLITE_OK;
2570 }
drhda47d772002-12-02 04:25:19 +00002571 if( !pPager->journalOpen ){
drhac69b052004-05-12 13:30:07 +00002572 pPager->stmtAutoopen = 1;
drhda47d772002-12-02 04:25:19 +00002573 return SQLITE_OK;
2574 }
drhfa86c412002-02-02 15:01:15 +00002575 assert( pPager->journalOpen );
drhac69b052004-05-12 13:30:07 +00002576 pPager->aInStmt = sqliteMalloc( pPager->dbSize/8 + 1 );
2577 if( pPager->aInStmt==0 ){
danielk19779eed5052004-06-04 10:38:30 +00002578 sqlite3OsLock(&pPager->fd, SHARED_LOCK);
drhfa86c412002-02-02 15:01:15 +00002579 return SQLITE_NOMEM;
2580 }
drh968af522003-02-11 14:55:40 +00002581#ifndef NDEBUG
drhac69b052004-05-12 13:30:07 +00002582 rc = sqlite3OsFileSize(&pPager->jfd, &pPager->stmtJSize);
2583 if( rc ) goto stmt_begin_failed;
2584 assert( pPager->stmtJSize ==
drhae2b40c2004-06-09 19:03:54 +00002585 pPager->nRec*JOURNAL_PG_SZ(pPager) + JOURNAL_HDR_SZ(pPager) );
drh968af522003-02-11 14:55:40 +00002586#endif
drhae2b40c2004-06-09 19:03:54 +00002587 pPager->stmtJSize =
2588 pPager->nRec*JOURNAL_PG_SZ(pPager) + JOURNAL_HDR_SZ(pPager);
drhac69b052004-05-12 13:30:07 +00002589 pPager->stmtSize = pPager->dbSize;
2590 if( !pPager->stmtOpen ){
2591 rc = sqlite3pager_opentemp(zTemp, &pPager->stfd);
2592 if( rc ) goto stmt_begin_failed;
2593 pPager->stmtOpen = 1;
2594 pPager->stmtNRec = 0;
drh0f892532002-05-30 12:27:03 +00002595 }
drhac69b052004-05-12 13:30:07 +00002596 pPager->stmtInUse = 1;
drhfa86c412002-02-02 15:01:15 +00002597 return SQLITE_OK;
2598
drhac69b052004-05-12 13:30:07 +00002599stmt_begin_failed:
2600 if( pPager->aInStmt ){
2601 sqliteFree(pPager->aInStmt);
2602 pPager->aInStmt = 0;
drhfa86c412002-02-02 15:01:15 +00002603 }
2604 return rc;
2605}
2606
2607/*
drhac69b052004-05-12 13:30:07 +00002608** Commit a statement.
drhfa86c412002-02-02 15:01:15 +00002609*/
drh3aac2dd2004-04-26 14:10:20 +00002610int sqlite3pager_stmt_commit(Pager *pPager){
drhac69b052004-05-12 13:30:07 +00002611 if( pPager->stmtInUse ){
drh03eb96a2002-11-10 23:32:56 +00002612 PgHdr *pPg, *pNext;
drha6abd042004-06-09 17:37:22 +00002613 TRACE2("STMT-COMMIT %d\n", pPager->fd.h);
drhac69b052004-05-12 13:30:07 +00002614 if( !pPager->memDb ){
2615 sqlite3OsSeek(&pPager->stfd, 0);
2616 /* sqlite3OsTruncate(&pPager->stfd, 0); */
2617 sqliteFree( pPager->aInStmt );
2618 pPager->aInStmt = 0;
drh663fc632002-02-02 18:49:19 +00002619 }
drhac69b052004-05-12 13:30:07 +00002620 for(pPg=pPager->pStmt; pPg; pPg=pNext){
2621 pNext = pPg->pNextStmt;
2622 assert( pPg->inStmt );
2623 pPg->inStmt = 0;
2624 pPg->pPrevStmt = pPg->pNextStmt = 0;
2625 if( pPager->memDb ){
2626 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
2627 sqliteFree(pHist->pStmt);
2628 pHist->pStmt = 0;
2629 }
2630 }
2631 pPager->stmtNRec = 0;
2632 pPager->stmtInUse = 0;
2633 pPager->pStmt = 0;
drh663fc632002-02-02 18:49:19 +00002634 }
drhac69b052004-05-12 13:30:07 +00002635 pPager->stmtAutoopen = 0;
drhfa86c412002-02-02 15:01:15 +00002636 return SQLITE_OK;
2637}
2638
2639/*
drhac69b052004-05-12 13:30:07 +00002640** Rollback a statement.
drhfa86c412002-02-02 15:01:15 +00002641*/
drh3aac2dd2004-04-26 14:10:20 +00002642int sqlite3pager_stmt_rollback(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00002643 int rc;
drhac69b052004-05-12 13:30:07 +00002644 if( pPager->stmtInUse ){
drha6abd042004-06-09 17:37:22 +00002645 TRACE2("STMT-ROLLBACK %d\n", pPager->fd.h);
drhac69b052004-05-12 13:30:07 +00002646 if( pPager->memDb ){
2647 PgHdr *pPg;
2648 for(pPg=pPager->pStmt; pPg; pPg=pPg->pNextStmt){
2649 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
2650 if( pHist->pStmt ){
2651 memcpy(PGHDR_TO_DATA(pPg), pHist->pStmt, pPager->pageSize);
2652 sqliteFree(pHist->pStmt);
2653 pHist->pStmt = 0;
2654 }
2655 }
2656 pPager->dbSize = pPager->stmtSize;
2657 memoryTruncate(pPager);
2658 rc = SQLITE_OK;
2659 }else{
2660 rc = pager_stmt_playback(pPager);
2661 }
drh3aac2dd2004-04-26 14:10:20 +00002662 sqlite3pager_stmt_commit(pPager);
drh663fc632002-02-02 18:49:19 +00002663 }else{
2664 rc = SQLITE_OK;
2665 }
drhac69b052004-05-12 13:30:07 +00002666 pPager->stmtAutoopen = 0;
drhfa86c412002-02-02 15:01:15 +00002667 return rc;
2668}
2669
drh73509ee2003-04-06 20:44:45 +00002670/*
2671** Return the full pathname of the database file.
2672*/
drh3aac2dd2004-04-26 14:10:20 +00002673const char *sqlite3pager_filename(Pager *pPager){
drh73509ee2003-04-06 20:44:45 +00002674 return pPager->zFilename;
2675}
2676
drhb20ea9d2004-02-09 01:20:36 +00002677/*
danielk19775865e3d2004-06-14 06:03:57 +00002678** Return the directory of the database file.
2679*/
2680const char *sqlite3pager_dirname(Pager *pPager){
2681 return pPager->zDirectory;
2682}
2683
2684/*
2685** Return the full pathname of the journal file.
2686*/
2687const char *sqlite3pager_journalname(Pager *pPager){
2688 return pPager->zJournal;
2689}
2690
2691/*
drhb20ea9d2004-02-09 01:20:36 +00002692** Set the codec for this pager
2693*/
drh3aac2dd2004-04-26 14:10:20 +00002694void sqlite3pager_set_codec(
drhb20ea9d2004-02-09 01:20:36 +00002695 Pager *pPager,
drh9eb9e262004-02-11 02:18:05 +00002696 void (*xCodec)(void*,void*,Pgno,int),
drhb20ea9d2004-02-09 01:20:36 +00002697 void *pCodecArg
2698){
2699 pPager->xCodec = xCodec;
2700 pPager->pCodecArg = pCodecArg;
2701}
2702
danielk197713adf8a2004-06-03 16:08:41 +00002703/*
danielk1977aa5ccdf2004-06-14 05:10:42 +00002704** This routine is called to increment the database file change-counter,
2705** stored at byte 24 of the pager file.
2706*/
2707static int pager_incr_changecounter(Pager *pPager){
2708 void *pPage;
2709 PgHdr *pPgHdr;
2710 u32 change_counter;
2711 int rc;
2712
2713 /* Open page 1 of the file for writing. */
2714 rc = sqlite3pager_get(pPager, 1, &pPage);
2715 if( rc!=SQLITE_OK ) return rc;
2716 rc = sqlite3pager_write(pPage);
2717 if( rc!=SQLITE_OK ) return rc;
2718
2719 /* Read the current value at byte 24. */
2720 pPgHdr = DATA_TO_PGHDR(pPage);
2721 change_counter = retrieve32bits(pPgHdr, 24);
2722
2723 /* Increment the value just read and write it back to byte 24. */
2724 change_counter++;
2725 store32bits(change_counter, pPgHdr, 24);
2726
2727 /* Release the page reference. */
2728 sqlite3pager_unref(pPage);
2729 return SQLITE_OK;
2730}
2731
2732/*
danielk197713adf8a2004-06-03 16:08:41 +00002733** Sync the database file for the pager pPager. zMaster points to the name
2734** of a master journal file that should be written into the individual
2735** journal file. zMaster may be NULL, which is interpreted as no master
2736** journal (a single database transaction).
2737**
2738** This routine ensures that the journal is synced, all dirty pages written
2739** to the database file and the database file synced. The only thing that
2740** remains to commit the transaction is to delete the journal file (or
2741** master journal file if specified).
2742**
2743** Note that if zMaster==NULL, this does not overwrite a previous value
2744** passed to an sqlite3pager_sync() call.
2745*/
2746int sqlite3pager_sync(Pager *pPager, const char *zMaster){
2747 int rc = SQLITE_OK;
2748
danielk1977aa5ccdf2004-06-14 05:10:42 +00002749 /* If this is an in-memory db, or no pages have been written to, or this
2750 ** function has already been called, it is a no-op.
danielk197713adf8a2004-06-03 16:08:41 +00002751 */
danielk1977aa5ccdf2004-06-14 05:10:42 +00002752 if( pPager->state!=PAGER_SYNCED && !pPager->memDb && pPager->dirtyCache ){
danielk197713adf8a2004-06-03 16:08:41 +00002753 PgHdr *pPg;
2754 assert( pPager->journalOpen );
2755
danielk1977aa5ccdf2004-06-14 05:10:42 +00002756 rc = pager_incr_changecounter(pPager);
2757 if( rc!=SQLITE_OK ) goto sync_exit;
2758
danielk197713adf8a2004-06-03 16:08:41 +00002759 /* Sync the journal file */
2760 rc = syncJournal(pPager, zMaster);
2761 if( rc!=SQLITE_OK ) goto sync_exit;
2762
2763 /* Write all dirty pages to the database file */
2764 pPg = pager_get_all_dirty_pages(pPager);
2765 rc = pager_write_pagelist(pPg);
2766 if( rc!=SQLITE_OK ) goto sync_exit;
2767
danielk1977aa5ccdf2004-06-14 05:10:42 +00002768 /* Sync the database file. */
2769 if( !pPager->noSync ){
danielk197713adf8a2004-06-03 16:08:41 +00002770 rc = sqlite3OsSync(&pPager->fd);
2771 }
danielk1977aa5ccdf2004-06-14 05:10:42 +00002772
2773 pPager->state = PAGER_SYNCED;
danielk197713adf8a2004-06-03 16:08:41 +00002774 }
2775
2776sync_exit:
2777 return rc;
2778}
2779
drh89ac8c12004-06-09 14:17:20 +00002780#ifdef SQLITE_DEBUG
2781/*
2782** Return the current state of the file lock for the given pager.
2783** The return value is one of NO_LOCK, SHARED_LOCK, RESERVED_LOCK,
2784** PENDING_LOCK, or EXCLUSIVE_LOCK.
2785*/
2786int sqlite3pager_lockstate(Pager *pPager){
2787 return pPager->fd.locktype;
2788}
2789#endif
2790
drh74587e52002-08-13 00:01:16 +00002791#ifdef SQLITE_TEST
drhdd793422001-06-28 01:54:48 +00002792/*
2793** Print a listing of all referenced pages and their ref count.
2794*/
drh3aac2dd2004-04-26 14:10:20 +00002795void sqlite3pager_refdump(Pager *pPager){
drhdd793422001-06-28 01:54:48 +00002796 PgHdr *pPg;
2797 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2798 if( pPg->nRef<=0 ) continue;
2799 printf("PAGE %3d addr=0x%08x nRef=%d\n",
2800 pPg->pgno, (int)PGHDR_TO_DATA(pPg), pPg->nRef);
2801 }
2802}
2803#endif