blob: 8a8eca6226422249096bf2561843448fcf9d301c [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**
drh1c7880e2005-05-20 20:01:55 +000021** @(#) $Id: pager.c,v 1.203 2005/05/20 20:01:56 drh Exp $
drhed7c8552001-04-11 14:29:21 +000022*/
drh2e66f0b2005-04-28 17:18:48 +000023#ifndef SQLITE_OMIT_DISKIO
drhd9b02572001-04-15 00:37:09 +000024#include "sqliteInt.h"
drheb206252004-10-01 02:00:31 +000025#include "os.h"
drhed7c8552001-04-11 14:29:21 +000026#include "pager.h"
drhed7c8552001-04-11 14:29:21 +000027#include <assert.h>
drhd9b02572001-04-15 00:37:09 +000028#include <string.h>
drhed7c8552001-04-11 14:29:21 +000029
30/*
drhdb48ee02003-01-16 13:42:43 +000031** Macros for troubleshooting. Normally turned off
32*/
danielk1977466be562004-06-10 02:16:01 +000033#if 0
drh34f47322004-08-18 15:58:22 +000034#define TRACE1(X) sqlite3DebugPrintf(X)
35#define TRACE2(X,Y) sqlite3DebugPrintf(X,Y)
36#define TRACE3(X,Y,Z) sqlite3DebugPrintf(X,Y,Z)
37#define TRACE4(X,Y,Z,W) sqlite3DebugPrintf(X,Y,Z,W)
danielk197794daf7f2004-11-08 09:26:09 +000038#define TRACE5(X,Y,Z,W,V) sqlite3DebugPrintf(X,Y,Z,W,V)
drhdb48ee02003-01-16 13:42:43 +000039#else
drhdb48ee02003-01-16 13:42:43 +000040#define TRACE1(X)
41#define TRACE2(X,Y)
42#define TRACE3(X,Y,Z)
drh34f47322004-08-18 15:58:22 +000043#define TRACE4(X,Y,Z,W)
danielk1977599fcba2004-11-08 07:13:13 +000044#define TRACE5(X,Y,Z,W,V)
drhdb48ee02003-01-16 13:42:43 +000045#endif
46
danielk1977599fcba2004-11-08 07:13:13 +000047/*
48** The following two macros are used within the TRACEX() macros above
49** to print out file-descriptors. They are required so that tracing
50** can be turned on when using both the regular os_unix.c and os_test.c
51** backends.
52**
53** PAGERID() takes a pointer to a Pager struct as it's argument. The
54** associated file-descriptor is returned. FILEHANDLEID() takes an OsFile
55** struct as it's argument.
56*/
danielk1977ef73ee92004-11-06 12:26:07 +000057#ifdef OS_TEST
58#define PAGERID(p) (p->fd->fd.h)
59#define FILEHANDLEID(fd) (fd->fd.h)
60#else
61#define PAGERID(p) (p->fd.h)
62#define FILEHANDLEID(fd) (fd.h)
63#endif
drhdb48ee02003-01-16 13:42:43 +000064
65/*
drhed7c8552001-04-11 14:29:21 +000066** The page cache as a whole is always in one of the following
67** states:
68**
drha6abd042004-06-09 17:37:22 +000069** PAGER_UNLOCK The page cache is not currently reading or
drhed7c8552001-04-11 14:29:21 +000070** writing the database file. There is no
71** data held in memory. This is the initial
72** state.
73**
drha6abd042004-06-09 17:37:22 +000074** PAGER_SHARED The page cache is reading the database.
drhed7c8552001-04-11 14:29:21 +000075** Writing is not permitted. There can be
76** multiple readers accessing the same database
drh69688d52001-04-14 16:38:23 +000077** file at the same time.
drhed7c8552001-04-11 14:29:21 +000078**
drh726de592004-06-10 23:35:50 +000079** PAGER_RESERVED This process has reserved the database for writing
80** but has not yet made any changes. Only one process
81** at a time can reserve the database. The original
82** database file has not been modified so other
83** processes may still be reading the on-disk
drha6abd042004-06-09 17:37:22 +000084** database file.
85**
86** PAGER_EXCLUSIVE The page cache is writing the database.
drhed7c8552001-04-11 14:29:21 +000087** Access is exclusive. No other processes or
88** threads can be reading or writing while one
89** process is writing.
90**
danielk1977aa5ccdf2004-06-14 05:10:42 +000091** PAGER_SYNCED The pager moves to this state from PAGER_EXCLUSIVE
92** after all dirty pages have been written to the
93** database file and the file has been synced to
94** disk. All that remains to do is to remove the
95** journal file and the transaction will be
96** committed.
97**
drha6abd042004-06-09 17:37:22 +000098** The page cache comes up in PAGER_UNLOCK. The first time a
drh726de592004-06-10 23:35:50 +000099** sqlite3pager_get() occurs, the state transitions to PAGER_SHARED.
drhed7c8552001-04-11 14:29:21 +0000100** After all pages have been released using sqlite_page_unref(),
drha6abd042004-06-09 17:37:22 +0000101** the state transitions back to PAGER_UNLOCK. The first time
drh726de592004-06-10 23:35:50 +0000102** that sqlite3pager_write() is called, the state transitions to
drha6abd042004-06-09 17:37:22 +0000103** PAGER_RESERVED. (Note that sqlite_page_write() can only be
drh306dc212001-05-21 13:45:10 +0000104** called on an outstanding page which means that the pager must
drha6abd042004-06-09 17:37:22 +0000105** be in PAGER_SHARED before it transitions to PAGER_RESERVED.)
drh726de592004-06-10 23:35:50 +0000106** The transition to PAGER_EXCLUSIVE occurs when before any changes
107** are made to the database file. After an sqlite3pager_rollback()
108** or sqlite_pager_commit(), the state goes back to PAGER_SHARED.
drhed7c8552001-04-11 14:29:21 +0000109*/
drha6abd042004-06-09 17:37:22 +0000110#define PAGER_UNLOCK 0
drh684917c2004-10-05 02:41:42 +0000111#define PAGER_SHARED 1 /* same as SHARED_LOCK */
112#define PAGER_RESERVED 2 /* same as RESERVED_LOCK */
113#define PAGER_EXCLUSIVE 4 /* same as EXCLUSIVE_LOCK */
114#define PAGER_SYNCED 5
drhed7c8552001-04-11 14:29:21 +0000115
drh684917c2004-10-05 02:41:42 +0000116/*
117** If the SQLITE_BUSY_RESERVED_LOCK macro is set to true at compile-time,
118** then failed attempts to get a reserved lock will invoke the busy callback.
119** This is off by default. To see why, consider the following scenario:
120**
121** Suppose thread A already has a shared lock and wants a reserved lock.
122** Thread B already has a reserved lock and wants an exclusive lock. If
123** both threads are using their busy callbacks, it might be a long time
124** be for one of the threads give up and allows the other to proceed.
125** But if the thread trying to get the reserved lock gives up quickly
126** (if it never invokes its busy callback) then the contention will be
127** resolved quickly.
128*/
129#ifndef SQLITE_BUSY_RESERVED_LOCK
130# define SQLITE_BUSY_RESERVED_LOCK 0
131#endif
drhd9b02572001-04-15 00:37:09 +0000132
drhed7c8552001-04-11 14:29:21 +0000133/*
drh887dc4c2004-10-22 16:22:57 +0000134** This macro rounds values up so that if the value is an address it
135** is guaranteed to be an address that is aligned to an 8-byte boundary.
136*/
137#define FORCE_ALIGNMENT(X) (((X)+7)&~7)
138
139/*
drhed7c8552001-04-11 14:29:21 +0000140** Each in-memory image of a page begins with the following header.
drhbd03cae2001-06-02 02:40:57 +0000141** This header is only visible to this pager module. The client
142** code that calls pager sees only the data that follows the header.
drhf6038712004-02-08 18:07:34 +0000143**
drh3aac2dd2004-04-26 14:10:20 +0000144** Client code should call sqlite3pager_write() on a page prior to making
145** any modifications to that page. The first time sqlite3pager_write()
drhf6038712004-02-08 18:07:34 +0000146** is called, the original page contents are written into the rollback
147** journal and PgHdr.inJournal and PgHdr.needSync are set. Later, once
148** the journal page has made it onto the disk surface, PgHdr.needSync
149** is cleared. The modified page cannot be written back into the original
150** database file until the journal pages has been synced to disk and the
151** PgHdr.needSync has been cleared.
152**
drh3aac2dd2004-04-26 14:10:20 +0000153** The PgHdr.dirty flag is set when sqlite3pager_write() is called and
drhf6038712004-02-08 18:07:34 +0000154** is cleared again when the page content is written back to the original
155** database file.
drhed7c8552001-04-11 14:29:21 +0000156*/
drhd9b02572001-04-15 00:37:09 +0000157typedef struct PgHdr PgHdr;
drhed7c8552001-04-11 14:29:21 +0000158struct PgHdr {
159 Pager *pPager; /* The pager to which this page belongs */
160 Pgno pgno; /* The page number for this page */
drh69688d52001-04-14 16:38:23 +0000161 PgHdr *pNextHash, *pPrevHash; /* Hash collision chain for PgHdr.pgno */
drhd9b02572001-04-15 00:37:09 +0000162 PgHdr *pNextFree, *pPrevFree; /* Freelist of pages where nRef==0 */
drhac69b052004-05-12 13:30:07 +0000163 PgHdr *pNextAll; /* A list of all pages */
164 PgHdr *pNextStmt, *pPrevStmt; /* List of pages in the statement journal */
drh193a6b42002-07-07 16:52:46 +0000165 u8 inJournal; /* TRUE if has been written to journal */
drhac69b052004-05-12 13:30:07 +0000166 u8 inStmt; /* TRUE if in the statement subjournal */
drh193a6b42002-07-07 16:52:46 +0000167 u8 dirty; /* TRUE if we need to write back changes */
drhdb48ee02003-01-16 13:42:43 +0000168 u8 needSync; /* Sync journal before writing this page */
drh193a6b42002-07-07 16:52:46 +0000169 u8 alwaysRollback; /* Disable dont_rollback() for this page */
drhac69b052004-05-12 13:30:07 +0000170 short int nRef; /* Number of users of this page */
drh2554f8b2003-01-22 01:26:44 +0000171 PgHdr *pDirty; /* Dirty pages sorted by PgHdr.pgno */
danielk19773c407372005-02-15 02:54:14 +0000172#ifdef SQLITE_CHECK_PAGES
173 u32 pageHash;
174#endif
drh1c7880e2005-05-20 20:01:55 +0000175 /* pPager->pageSize bytes of page data follow this header */
drh973b6e32003-02-12 14:09:42 +0000176 /* Pager.nExtra bytes of local data follow the page data */
drhed7c8552001-04-11 14:29:21 +0000177};
178
drhac69b052004-05-12 13:30:07 +0000179/*
180** For an in-memory only database, some extra information is recorded about
181** each page so that changes can be rolled back. (Journal files are not
182** used for in-memory databases.) The following information is added to
183** the end of every EXTRA block for in-memory databases.
184**
185** This information could have been added directly to the PgHdr structure.
186** But then it would take up an extra 8 bytes of storage on every PgHdr
187** even for disk-based databases. Splitting it out saves 8 bytes. This
188** is only a savings of 0.8% but those percentages add up.
189*/
190typedef struct PgHistory PgHistory;
191struct PgHistory {
192 u8 *pOrig; /* Original page text. Restore to this on a full rollback */
193 u8 *pStmt; /* Text as it was at the beginning of the current statement */
194};
drh9eb9e262004-02-11 02:18:05 +0000195
196/*
197** A macro used for invoking the codec if there is one
198*/
199#ifdef SQLITE_HAS_CODEC
200# define CODEC(P,D,N,X) if( P->xCodec ){ P->xCodec(P->pCodecArg,D,N,X); }
201#else
202# define CODEC(P,D,N,X)
203#endif
204
drhed7c8552001-04-11 14:29:21 +0000205/*
drh69688d52001-04-14 16:38:23 +0000206** Convert a pointer to a PgHdr into a pointer to its data
207** and back again.
drhed7c8552001-04-11 14:29:21 +0000208*/
209#define PGHDR_TO_DATA(P) ((void*)(&(P)[1]))
210#define DATA_TO_PGHDR(D) (&((PgHdr*)(D))[-1])
drh1c7880e2005-05-20 20:01:55 +0000211#define PGHDR_TO_EXTRA(G,P) ((void*)&((char*)(&(G)[1]))[(P)->pageSize])
drhac69b052004-05-12 13:30:07 +0000212#define PGHDR_TO_HIST(P,PGR) \
drh1c7880e2005-05-20 20:01:55 +0000213 ((PgHistory*)&((char*)(&(P)[1]))[(PGR)->pageSize+(PGR)->nExtra])
drhed7c8552001-04-11 14:29:21 +0000214
215/*
drhed7c8552001-04-11 14:29:21 +0000216** How big to make the hash table used for locating in-memory pages
danielk1977634f2982005-03-28 08:44:07 +0000217** by page number. This macro looks a little silly, but is evaluated
218** at compile-time, not run-time (at least for gcc this is true).
drhed7c8552001-04-11 14:29:21 +0000219*/
danielk1977634f2982005-03-28 08:44:07 +0000220#define N_PG_HASH (\
221 (MAX_PAGES>1024)?2048: \
222 (MAX_PAGES>512)?1024: \
223 (MAX_PAGES>256)?512: \
224 (MAX_PAGES>128)?256: \
225 (MAX_PAGES>64)?128:64 \
226)
drh836faa42003-01-11 13:30:57 +0000227
228/*
229** Hash a page number
230*/
231#define pager_hash(PN) ((PN)&(N_PG_HASH-1))
drhed7c8552001-04-11 14:29:21 +0000232
233/*
234** A open page cache is an instance of the following structure.
235*/
236struct Pager {
237 char *zFilename; /* Name of the database file */
238 char *zJournal; /* Name of the journal file */
drha76c82e2003-07-27 18:59:42 +0000239 char *zDirectory; /* Directory hold database and journal files */
drh8cfbf082001-09-19 13:22:39 +0000240 OsFile fd, jfd; /* File descriptors for database and journal */
drhac69b052004-05-12 13:30:07 +0000241 OsFile stfd; /* File descriptor for the statement subjournal*/
drhed7c8552001-04-11 14:29:21 +0000242 int dbSize; /* Number of pages in the file */
drh69688d52001-04-14 16:38:23 +0000243 int origDbSize; /* dbSize before the current change */
drhac69b052004-05-12 13:30:07 +0000244 int stmtSize; /* Size of database (in pages) at stmt_begin() */
drheb206252004-10-01 02:00:31 +0000245 i64 stmtJSize; /* Size of journal at stmt_begin() */
drh968af522003-02-11 14:55:40 +0000246 int nRec; /* Number of pages written to the journal */
247 u32 cksumInit; /* Quasi-random value added to every checksum */
drhac69b052004-05-12 13:30:07 +0000248 int stmtNRec; /* Number of records in stmt subjournal */
drh7e3b0a02001-04-28 16:52:40 +0000249 int nExtra; /* Add this many bytes to each in-memory page */
drhb6f41482004-05-14 01:58:11 +0000250 void (*xDestructor)(void*,int); /* Call this routine when freeing pages */
drha6abd042004-06-09 17:37:22 +0000251 void (*xReiniter)(void*,int); /* Call this routine when reloading pages */
drhb6f41482004-05-14 01:58:11 +0000252 int pageSize; /* Number of bytes in a page */
drhed7c8552001-04-11 14:29:21 +0000253 int nPage; /* Total number of in-memory pages */
danielk1977e94ddc92005-03-21 03:53:38 +0000254 int nMaxPage; /* High water mark of nPage */
drhd9b02572001-04-15 00:37:09 +0000255 int nRef; /* Number of in-memory pages with PgHdr.nRef>0 */
drhed7c8552001-04-11 14:29:21 +0000256 int mxPage; /* Maximum number of pages to hold in cache */
drhd9b02572001-04-15 00:37:09 +0000257 int nHit, nMiss, nOvfl; /* Cache hits, missing, and LRU overflows */
danielk197742741be2005-01-08 12:42:39 +0000258 int nRead,nWrite; /* Database pages read/written */
drh9eb9e262004-02-11 02:18:05 +0000259 void (*xCodec)(void*,void*,Pgno,int); /* Routine for en/decoding data */
drhb20ea9d2004-02-09 01:20:36 +0000260 void *pCodecArg; /* First argument to xCodec() */
drh603240c2002-03-05 01:11:12 +0000261 u8 journalOpen; /* True if journal file descriptors is valid */
drh34e79ce2004-02-08 06:05:46 +0000262 u8 journalStarted; /* True if header of journal is synced */
263 u8 useJournal; /* Use a rollback journal on this file */
drh7bec5052005-02-06 02:45:41 +0000264 u8 noReadlock; /* Do not bother to obtain readlocks */
drhac69b052004-05-12 13:30:07 +0000265 u8 stmtOpen; /* True if the statement subjournal is open */
266 u8 stmtInUse; /* True we are in a statement subtransaction */
267 u8 stmtAutoopen; /* Open stmt journal when main journal is opened*/
drh603240c2002-03-05 01:11:12 +0000268 u8 noSync; /* Do not sync the journal if true */
drh968af522003-02-11 14:55:40 +0000269 u8 fullSync; /* Do extra syncs of the journal for robustness */
drha6abd042004-06-09 17:37:22 +0000270 u8 state; /* PAGER_UNLOCK, _SHARED, _RESERVED, etc. */
drh603240c2002-03-05 01:11:12 +0000271 u8 errMask; /* One of several kinds of errors */
272 u8 tempFile; /* zFilename is a temporary file */
273 u8 readOnly; /* True for a read-only database */
274 u8 needSync; /* True if an fsync() is needed on the journal */
drha6abd042004-06-09 17:37:22 +0000275 u8 dirtyCache; /* True if cached pages have changed */
drh193a6b42002-07-07 16:52:46 +0000276 u8 alwaysRollback; /* Disable dont_rollback() for all pages */
drhac69b052004-05-12 13:30:07 +0000277 u8 memDb; /* True to inhibit all file I/O */
drh603240c2002-03-05 01:11:12 +0000278 u8 *aInJournal; /* One bit for each page in the database file */
drhac69b052004-05-12 13:30:07 +0000279 u8 *aInStmt; /* One bit for each page in the database */
drhfdb38062004-08-21 19:20:42 +0000280 u8 setMaster; /* True if a m-j name has been written to jrnl */
drh726de592004-06-10 23:35:50 +0000281 BusyHandler *pBusyHandler; /* Pointer to sqlite.busyHandler */
drhed7c8552001-04-11 14:29:21 +0000282 PgHdr *pFirst, *pLast; /* List of free pages */
drh341eae82003-01-21 02:39:36 +0000283 PgHdr *pFirstSynced; /* First free page with PgHdr.needSync==0 */
drhd9b02572001-04-15 00:37:09 +0000284 PgHdr *pAll; /* List of all pages */
drhac69b052004-05-12 13:30:07 +0000285 PgHdr *pStmt; /* List of pages in the statement subjournal */
drheb206252004-10-01 02:00:31 +0000286 i64 journalOff; /* Current byte offset in the journal file */
287 i64 journalHdr; /* Byte offset to previous journal header */
288 i64 stmtHdrOff; /* First journal header written this statement */
289 i64 stmtCksum; /* cksumInit when statement was started */
danielk197776572402004-06-25 02:38:54 +0000290 int sectorSize; /* Assumed sector size during rollback */
drh76ff3a02004-09-24 22:32:30 +0000291 PgHdr *aHash[N_PG_HASH]; /* Hash table to map page number to PgHdr */
drhd9b02572001-04-15 00:37:09 +0000292};
293
294/*
295** These are bits that can be set in Pager.errMask.
296*/
297#define PAGER_ERR_FULL 0x01 /* a write() failed */
298#define PAGER_ERR_MEM 0x02 /* malloc() failed */
299#define PAGER_ERR_LOCK 0x04 /* error in the locking protocol */
300#define PAGER_ERR_CORRUPT 0x08 /* database or journal corruption */
drh81a20f22001-10-12 17:30:04 +0000301#define PAGER_ERR_DISK 0x10 /* general disk I/O error - bad hard drive? */
drhd9b02572001-04-15 00:37:09 +0000302
303/*
drh5e00f6c2001-09-13 13:46:56 +0000304** Journal files begin with the following magic string. The data
305** was obtained from /dev/random. It is used only as a sanity check.
drh94f33312002-08-12 12:29:56 +0000306**
drhae2b40c2004-06-09 19:03:54 +0000307** Since version 2.8.0, the journal format contains additional sanity
308** checking information. If the power fails while the journal is begin
309** written, semi-random garbage data might appear in the journal
310** file after power is restored. If an attempt is then made
drh968af522003-02-11 14:55:40 +0000311** to roll the journal back, the database could be corrupted. The additional
312** sanity checking data is an attempt to discover the garbage in the
313** journal and ignore it.
314**
drhae2b40c2004-06-09 19:03:54 +0000315** The sanity checking information for the new journal format consists
drh968af522003-02-11 14:55:40 +0000316** of a 32-bit checksum on each page of data. The checksum covers both
drh90f5ecb2004-07-22 01:19:35 +0000317** the page number and the pPager->pageSize bytes of data for the page.
drh968af522003-02-11 14:55:40 +0000318** This cksum is initialized to a 32-bit random value that appears in the
319** journal file right after the header. The random initializer is important,
320** because garbage data that appears at the end of a journal is likely
321** data that was once in other files that have now been deleted. If the
322** garbage data came from an obsolete journal file, the checksums might
323** be correct. But by initializing the checksum to random value which
324** is different for every journal, we minimize that risk.
drhd9b02572001-04-15 00:37:09 +0000325*/
drhae2b40c2004-06-09 19:03:54 +0000326static const unsigned char aJournalMagic[] = {
327 0xd9, 0xd5, 0x05, 0xf9, 0x20, 0xa1, 0x63, 0xd7,
drhed7c8552001-04-11 14:29:21 +0000328};
329
330/*
drh726de592004-06-10 23:35:50 +0000331** The size of the header and of each page in the journal is determined
332** by the following macros.
drh968af522003-02-11 14:55:40 +0000333*/
drhae2b40c2004-06-09 19:03:54 +0000334#define JOURNAL_PG_SZ(pPager) ((pPager->pageSize) + 8)
drh968af522003-02-11 14:55:40 +0000335
danielk197776572402004-06-25 02:38:54 +0000336/*
337** The journal header size for this pager. In the future, this could be
338** set to some value read from the disk controller. The important
339** characteristic is that it is the same size as a disk sector.
340*/
341#define JOURNAL_HDR_SZ(pPager) (pPager->sectorSize)
342
drhb7f91642004-10-31 02:22:47 +0000343/*
344** The macro MEMDB is true if we are dealing with an in-memory database.
345** We do this as a macro so that if the SQLITE_OMIT_MEMORYDB macro is set,
346** the value of MEMDB will be a constant and the compiler will optimize
347** out code that would never execute.
348*/
349#ifdef SQLITE_OMIT_MEMORYDB
350# define MEMDB 0
351#else
352# define MEMDB pPager->memDb
353#endif
354
355/*
356** The default size of a disk sector
357*/
danielk197776572402004-06-25 02:38:54 +0000358#define PAGER_SECTOR_SIZE 512
359
360/*
361** Page number PAGER_MJ_PGNO is never used in an SQLite database (it is
362** reserved for working around a windows/posix incompatibility). It is
363** used in the journal to signify that the remainder of the journal file
364** is devoted to storing a master journal name - there are no more pages to
365** roll back. See comments for function writeMasterJournal() for details.
366*/
danielk1977599fcba2004-11-08 07:13:13 +0000367/* #define PAGER_MJ_PGNO(x) (PENDING_BYTE/((x)->pageSize)) */
368#define PAGER_MJ_PGNO(x) ((PENDING_BYTE/((x)->pageSize))+1)
danielk197713adf8a2004-06-03 16:08:41 +0000369
drh968af522003-02-11 14:55:40 +0000370/*
danielk197726836652005-01-17 01:33:13 +0000371** The maximum legal page number is (2^31 - 1).
372*/
373#define PAGER_MAX_PGNO 2147483647
374
375/*
drh726de592004-06-10 23:35:50 +0000376** Enable reference count tracking (for debugging) here:
drhdd793422001-06-28 01:54:48 +0000377*/
danielk1977aca790a2005-01-13 11:07:52 +0000378#ifdef SQLITE_DEBUG
drh3aac2dd2004-04-26 14:10:20 +0000379 int pager3_refinfo_enable = 0;
drhdd793422001-06-28 01:54:48 +0000380 static void pager_refinfo(PgHdr *p){
381 static int cnt = 0;
drh3aac2dd2004-04-26 14:10:20 +0000382 if( !pager3_refinfo_enable ) return;
drhfe63d1c2004-09-08 20:13:04 +0000383 sqlite3DebugPrintf(
384 "REFCNT: %4d addr=%p nRef=%d\n",
385 p->pgno, PGHDR_TO_DATA(p), p->nRef
drhdd793422001-06-28 01:54:48 +0000386 );
387 cnt++; /* Something to set a breakpoint on */
388 }
389# define REFINFO(X) pager_refinfo(X)
390#else
391# define REFINFO(X)
392#endif
393
394/*
drh34e79ce2004-02-08 06:05:46 +0000395** Read a 32-bit integer from the given file descriptor. Store the integer
396** that is read in *pRes. Return SQLITE_OK if everything worked, or an
397** error code is something goes wrong.
drh726de592004-06-10 23:35:50 +0000398**
399** All values are stored on disk as big-endian.
drh94f33312002-08-12 12:29:56 +0000400*/
drhae2b40c2004-06-09 19:03:54 +0000401static int read32bits(OsFile *fd, u32 *pRes){
drh94f33312002-08-12 12:29:56 +0000402 u32 res;
403 int rc;
danielk19774adee202004-05-08 08:23:19 +0000404 rc = sqlite3OsRead(fd, &res, sizeof(res));
drhae2b40c2004-06-09 19:03:54 +0000405 if( rc==SQLITE_OK ){
drh94f33312002-08-12 12:29:56 +0000406 unsigned char ac[4];
407 memcpy(ac, &res, 4);
408 res = (ac[0]<<24) | (ac[1]<<16) | (ac[2]<<8) | ac[3];
409 }
410 *pRes = res;
411 return rc;
412}
413
414/*
drh34e79ce2004-02-08 06:05:46 +0000415** Write a 32-bit integer into the given file descriptor. Return SQLITE_OK
416** on success or an error code is something goes wrong.
drh94f33312002-08-12 12:29:56 +0000417*/
418static int write32bits(OsFile *fd, u32 val){
419 unsigned char ac[4];
drh94f33312002-08-12 12:29:56 +0000420 ac[0] = (val>>24) & 0xff;
421 ac[1] = (val>>16) & 0xff;
422 ac[2] = (val>>8) & 0xff;
423 ac[3] = val & 0xff;
danielk19774adee202004-05-08 08:23:19 +0000424 return sqlite3OsWrite(fd, ac, 4);
drh94f33312002-08-12 12:29:56 +0000425}
426
drh2554f8b2003-01-22 01:26:44 +0000427/*
danielk1977aa5ccdf2004-06-14 05:10:42 +0000428** Write the 32-bit integer 'val' into the page identified by page header
429** 'p' at offset 'offset'.
drh2554f8b2003-01-22 01:26:44 +0000430*/
drh968af522003-02-11 14:55:40 +0000431static void store32bits(u32 val, PgHdr *p, int offset){
drh2554f8b2003-01-22 01:26:44 +0000432 unsigned char *ac;
drhec1bd0b2003-08-26 11:41:27 +0000433 ac = &((unsigned char*)PGHDR_TO_DATA(p))[offset];
drhae2b40c2004-06-09 19:03:54 +0000434 ac[0] = (val>>24) & 0xff;
435 ac[1] = (val>>16) & 0xff;
436 ac[2] = (val>>8) & 0xff;
437 ac[3] = val & 0xff;
drh2554f8b2003-01-22 01:26:44 +0000438}
439
danielk1977aa5ccdf2004-06-14 05:10:42 +0000440/*
441** Read a 32-bit integer at offset 'offset' from the page identified by
442** page header 'p'.
443*/
444static u32 retrieve32bits(PgHdr *p, int offset){
445 unsigned char *ac;
446 ac = &((unsigned char*)PGHDR_TO_DATA(p))[offset];
447 return (ac[0]<<24) | (ac[1]<<16) | (ac[2]<<8) | ac[3];
448}
449
drh94f33312002-08-12 12:29:56 +0000450
451/*
drhd9b02572001-04-15 00:37:09 +0000452** Convert the bits in the pPager->errMask into an approprate
453** return code.
454*/
455static int pager_errcode(Pager *pPager){
456 int rc = SQLITE_OK;
457 if( pPager->errMask & PAGER_ERR_LOCK ) rc = SQLITE_PROTOCOL;
drh81a20f22001-10-12 17:30:04 +0000458 if( pPager->errMask & PAGER_ERR_DISK ) rc = SQLITE_IOERR;
drhd9b02572001-04-15 00:37:09 +0000459 if( pPager->errMask & PAGER_ERR_FULL ) rc = SQLITE_FULL;
460 if( pPager->errMask & PAGER_ERR_MEM ) rc = SQLITE_NOMEM;
461 if( pPager->errMask & PAGER_ERR_CORRUPT ) rc = SQLITE_CORRUPT;
462 return rc;
drhed7c8552001-04-11 14:29:21 +0000463}
464
danielk19773c407372005-02-15 02:54:14 +0000465#ifdef SQLITE_CHECK_PAGES
466/*
467** Return a 32-bit hash of the page data for pPage.
468*/
469static u32 pager_pagehash(PgHdr *pPage){
470 u32 hash = 0;
471 int i;
472 unsigned char *pData = (unsigned char *)PGHDR_TO_DATA(pPage);
473 for(i=0; i<pPage->pPager->pageSize; i++){
474 hash = (hash+i)^pData[i];
475 }
476 return hash;
477}
478
479/*
480** The CHECK_PAGE macro takes a PgHdr* as an argument. If SQLITE_CHECK_PAGES
481** is defined, and NDEBUG is not defined, an assert() statement checks
482** that the page is either dirty or still matches the calculated page-hash.
483*/
484#define CHECK_PAGE(x) checkPage(x)
485static void checkPage(PgHdr *pPg){
486 Pager *pPager = pPg->pPager;
487 assert( !pPg->pageHash || pPager->errMask || MEMDB || pPg->dirty ||
488 pPg->pageHash==pager_pagehash(pPg) );
489}
490
491#else
492#define CHECK_PAGE(x)
493#endif
494
drhed7c8552001-04-11 14:29:21 +0000495/*
danielk197776572402004-06-25 02:38:54 +0000496** When this is called the journal file for pager pPager must be open.
497** The master journal file name is read from the end of the file and
498** written into memory obtained from sqliteMalloc(). *pzMaster is
499** set to point at the memory and SQLITE_OK returned. The caller must
500** sqliteFree() *pzMaster.
501**
502** If no master journal file name is present *pzMaster is set to 0 and
503** SQLITE_OK returned.
504*/
505static int readMasterJournal(OsFile *pJrnl, char **pzMaster){
506 int rc;
507 u32 len;
drheb206252004-10-01 02:00:31 +0000508 i64 szJ;
danielk1977c3e8f5e2004-06-28 01:16:46 +0000509 u32 cksum;
danielk1977cafadba2004-06-25 11:11:54 +0000510 int i;
danielk197776572402004-06-25 02:38:54 +0000511 unsigned char aMagic[8]; /* A buffer to hold the magic header */
512
513 *pzMaster = 0;
514
515 rc = sqlite3OsFileSize(pJrnl, &szJ);
danielk1977cafadba2004-06-25 11:11:54 +0000516 if( rc!=SQLITE_OK || szJ<16 ) return rc;
danielk197776572402004-06-25 02:38:54 +0000517
danielk1977cafadba2004-06-25 11:11:54 +0000518 rc = sqlite3OsSeek(pJrnl, szJ-16);
danielk197776572402004-06-25 02:38:54 +0000519 if( rc!=SQLITE_OK ) return rc;
520
521 rc = read32bits(pJrnl, &len);
522 if( rc!=SQLITE_OK ) return rc;
523
danielk1977cafadba2004-06-25 11:11:54 +0000524 rc = read32bits(pJrnl, &cksum);
525 if( rc!=SQLITE_OK ) return rc;
526
danielk197776572402004-06-25 02:38:54 +0000527 rc = sqlite3OsRead(pJrnl, aMagic, 8);
528 if( rc!=SQLITE_OK || memcmp(aMagic, aJournalMagic, 8) ) return rc;
529
danielk19778191bff2004-06-28 04:52:30 +0000530 rc = sqlite3OsSeek(pJrnl, szJ-16-len);
danielk197776572402004-06-25 02:38:54 +0000531 if( rc!=SQLITE_OK ) return rc;
532
danielk19778191bff2004-06-28 04:52:30 +0000533 *pzMaster = (char *)sqliteMalloc(len+1);
danielk197776572402004-06-25 02:38:54 +0000534 if( !*pzMaster ){
535 return SQLITE_NOMEM;
536 }
537 rc = sqlite3OsRead(pJrnl, *pzMaster, len);
538 if( rc!=SQLITE_OK ){
539 sqliteFree(*pzMaster);
540 *pzMaster = 0;
541 return rc;
542 }
danielk1977cafadba2004-06-25 11:11:54 +0000543
544 /* See if the checksum matches the master journal name */
545 for(i=0; i<len; i++){
danielk19778191bff2004-06-28 04:52:30 +0000546 cksum -= (*pzMaster)[i];
danielk1977cafadba2004-06-25 11:11:54 +0000547 }
danielk19778191bff2004-06-28 04:52:30 +0000548 if( cksum ){
549 /* If the checksum doesn't add up, then one or more of the disk sectors
550 ** containing the master journal filename is corrupted. This means
551 ** definitely roll back, so just return SQLITE_OK and report a (nul)
552 ** master-journal filename.
553 */
danielk1977cafadba2004-06-25 11:11:54 +0000554 sqliteFree(*pzMaster);
555 *pzMaster = 0;
danielk1977aca790a2005-01-13 11:07:52 +0000556 }else{
557 (*pzMaster)[len] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000558 }
danielk197776572402004-06-25 02:38:54 +0000559
560 return SQLITE_OK;
561}
562
563/*
564** Seek the journal file descriptor to the next sector boundary where a
565** journal header may be read or written. Pager.journalOff is updated with
566** the new seek offset.
567**
568** i.e for a sector size of 512:
569**
570** Input Offset Output Offset
571** ---------------------------------------
572** 0 0
573** 512 512
574** 100 512
575** 2000 2048
576**
577*/
578static int seekJournalHdr(Pager *pPager){
drheb206252004-10-01 02:00:31 +0000579 i64 offset = 0;
580 i64 c = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000581 if( c ){
582 offset = ((c-1)/JOURNAL_HDR_SZ(pPager) + 1) * JOURNAL_HDR_SZ(pPager);
583 }
584 assert( offset%JOURNAL_HDR_SZ(pPager)==0 );
585 assert( offset>=c );
586 assert( (offset-c)<JOURNAL_HDR_SZ(pPager) );
587 pPager->journalOff = offset;
588 return sqlite3OsSeek(&pPager->jfd, pPager->journalOff);
589}
590
591/*
592** The journal file must be open when this routine is called. A journal
593** header (JOURNAL_HDR_SZ bytes) is written into the journal file at the
594** current location.
595**
596** The format for the journal header is as follows:
597** - 8 bytes: Magic identifying journal format.
598** - 4 bytes: Number of records in journal, or -1 no-sync mode is on.
599** - 4 bytes: Random number used for page hash.
600** - 4 bytes: Initial database page count.
601** - 4 bytes: Sector size used by the process that wrote this journal.
602**
danielk1977f42f25c2004-06-25 07:21:28 +0000603** Followed by (JOURNAL_HDR_SZ - 24) bytes of unused space.
danielk197776572402004-06-25 02:38:54 +0000604*/
605static int writeJournalHdr(Pager *pPager){
606
607 int rc = seekJournalHdr(pPager);
608 if( rc ) return rc;
609
610 pPager->journalHdr = pPager->journalOff;
611 if( pPager->stmtHdrOff==0 ){
612 pPager->stmtHdrOff = pPager->journalHdr;
613 }
614 pPager->journalOff += JOURNAL_HDR_SZ(pPager);
615
616 /* FIX ME:
617 **
618 ** Possibly for a pager not in no-sync mode, the journal magic should not
619 ** be written until nRec is filled in as part of next syncJournal().
620 **
621 ** Actually maybe the whole journal header should be delayed until that
622 ** point. Think about this.
623 */
624 rc = sqlite3OsWrite(&pPager->jfd, aJournalMagic, sizeof(aJournalMagic));
625
626 if( rc==SQLITE_OK ){
627 /* The nRec Field. 0xFFFFFFFF for no-sync journals. */
628 rc = write32bits(&pPager->jfd, pPager->noSync ? 0xffffffff : 0);
629 }
630 if( rc==SQLITE_OK ){
631 /* The random check-hash initialiser */
632 sqlite3Randomness(sizeof(pPager->cksumInit), &pPager->cksumInit);
633 rc = write32bits(&pPager->jfd, pPager->cksumInit);
634 }
635 if( rc==SQLITE_OK ){
636 /* The initial database size */
637 rc = write32bits(&pPager->jfd, pPager->dbSize);
638 }
639 if( rc==SQLITE_OK ){
640 /* The assumed sector size for this process */
641 rc = write32bits(&pPager->jfd, pPager->sectorSize);
642 }
643
644 /* The journal header has been written successfully. Seek the journal
645 ** file descriptor to the end of the journal header sector.
646 */
647 if( rc==SQLITE_OK ){
648 sqlite3OsSeek(&pPager->jfd, pPager->journalOff-1);
649 rc = sqlite3OsWrite(&pPager->jfd, "\000", 1);
650 }
651 return rc;
652}
653
654/*
655** The journal file must be open when this is called. A journal header file
656** (JOURNAL_HDR_SZ bytes) is read from the current location in the journal
657** file. See comments above function writeJournalHdr() for a description of
658** the journal header format.
659**
660** If the header is read successfully, *nRec is set to the number of
661** page records following this header and *dbSize is set to the size of the
662** database before the transaction began, in pages. Also, pPager->cksumInit
663** is set to the value read from the journal header. SQLITE_OK is returned
664** in this case.
665**
666** If the journal header file appears to be corrupted, SQLITE_DONE is
667** returned and *nRec and *dbSize are not set. If JOURNAL_HDR_SZ bytes
668** cannot be read from the journal file an error code is returned.
669*/
670static int readJournalHdr(
671 Pager *pPager,
drheb206252004-10-01 02:00:31 +0000672 i64 journalSize,
danielk197776572402004-06-25 02:38:54 +0000673 u32 *pNRec,
674 u32 *pDbSize
675){
676 int rc;
677 unsigned char aMagic[8]; /* A buffer to hold the magic header */
678
679 rc = seekJournalHdr(pPager);
680 if( rc ) return rc;
681
682 if( pPager->journalOff+JOURNAL_HDR_SZ(pPager) > journalSize ){
683 return SQLITE_DONE;
684 }
685
686 rc = sqlite3OsRead(&pPager->jfd, aMagic, sizeof(aMagic));
687 if( rc ) return rc;
688
689 if( memcmp(aMagic, aJournalMagic, sizeof(aMagic))!=0 ){
690 return SQLITE_DONE;
691 }
692
693 rc = read32bits(&pPager->jfd, pNRec);
694 if( rc ) return rc;
695
696 rc = read32bits(&pPager->jfd, &pPager->cksumInit);
697 if( rc ) return rc;
698
699 rc = read32bits(&pPager->jfd, pDbSize);
700 if( rc ) return rc;
701
702 /* Update the assumed sector-size to match the value used by
703 ** the process that created this journal. If this journal was
704 ** created by a process other than this one, then this routine
705 ** is being called from within pager_playback(). The local value
706 ** of Pager.sectorSize is restored at the end of that routine.
707 */
danielk1977c3e8f5e2004-06-28 01:16:46 +0000708 rc = read32bits(&pPager->jfd, (u32 *)&pPager->sectorSize);
danielk197776572402004-06-25 02:38:54 +0000709 if( rc ) return rc;
710
711 pPager->journalOff += JOURNAL_HDR_SZ(pPager);
712 rc = sqlite3OsSeek(&pPager->jfd, pPager->journalOff);
713 return rc;
714}
715
716
717/*
718** Write the supplied master journal name into the journal file for pager
danielk1977cafadba2004-06-25 11:11:54 +0000719** pPager at the current location. The master journal name must be the last
720** thing written to a journal file. If the pager is in full-sync mode, the
721** journal file descriptor is advanced to the next sector boundary before
722** anything is written. The format is:
723**
724** + 4 bytes: PAGER_MJ_PGNO.
725** + N bytes: length of master journal name.
726** + 4 bytes: N
727** + 4 bytes: Master journal name checksum.
728** + 8 bytes: aJournalMagic[].
729**
730** The master journal page checksum is the sum of the bytes in the master
731** journal name.
danielk197776572402004-06-25 02:38:54 +0000732*/
733static int writeMasterJournal(Pager *pPager, const char *zMaster){
734 int rc;
735 int len;
danielk1977cafadba2004-06-25 11:11:54 +0000736 int i;
danielk1977c3e8f5e2004-06-28 01:16:46 +0000737 u32 cksum = 0;
danielk197776572402004-06-25 02:38:54 +0000738
739 if( !zMaster || pPager->setMaster) return SQLITE_OK;
740 pPager->setMaster = 1;
741
742 len = strlen(zMaster);
danielk1977cafadba2004-06-25 11:11:54 +0000743 for(i=0; i<len; i++){
744 cksum += zMaster[i];
745 }
danielk197776572402004-06-25 02:38:54 +0000746
747 /* If in full-sync mode, advance to the next disk sector before writing
748 ** the master journal name. This is in case the previous page written to
749 ** the journal has already been synced.
750 */
751 if( pPager->fullSync ){
752 rc = seekJournalHdr(pPager);
753 if( rc!=SQLITE_OK ) return rc;
754 }
danielk1977cafadba2004-06-25 11:11:54 +0000755 pPager->journalOff += (len+20);
danielk197776572402004-06-25 02:38:54 +0000756
757 rc = write32bits(&pPager->jfd, PAGER_MJ_PGNO(pPager));
758 if( rc!=SQLITE_OK ) return rc;
759
760 rc = sqlite3OsWrite(&pPager->jfd, zMaster, len);
761 if( rc!=SQLITE_OK ) return rc;
762
763 rc = write32bits(&pPager->jfd, len);
764 if( rc!=SQLITE_OK ) return rc;
765
danielk1977cafadba2004-06-25 11:11:54 +0000766 rc = write32bits(&pPager->jfd, cksum);
767 if( rc!=SQLITE_OK ) return rc;
768
danielk197776572402004-06-25 02:38:54 +0000769 rc = sqlite3OsWrite(&pPager->jfd, aJournalMagic, sizeof(aJournalMagic));
drhfdb38062004-08-21 19:20:42 +0000770 pPager->needSync = 1;
danielk197776572402004-06-25 02:38:54 +0000771 return rc;
772}
773
774/*
drh03eb96a2002-11-10 23:32:56 +0000775** Add or remove a page from the list of all pages that are in the
drhac69b052004-05-12 13:30:07 +0000776** statement journal.
drh03eb96a2002-11-10 23:32:56 +0000777**
778** The Pager keeps a separate list of pages that are currently in
drhac69b052004-05-12 13:30:07 +0000779** the statement journal. This helps the sqlite3pager_stmt_commit()
drh03eb96a2002-11-10 23:32:56 +0000780** routine run MUCH faster for the common case where there are many
drhac69b052004-05-12 13:30:07 +0000781** pages in memory but only a few are in the statement journal.
drh03eb96a2002-11-10 23:32:56 +0000782*/
drh3aac2dd2004-04-26 14:10:20 +0000783static void page_add_to_stmt_list(PgHdr *pPg){
drh03eb96a2002-11-10 23:32:56 +0000784 Pager *pPager = pPg->pPager;
drhac69b052004-05-12 13:30:07 +0000785 if( pPg->inStmt ) return;
786 assert( pPg->pPrevStmt==0 && pPg->pNextStmt==0 );
787 pPg->pPrevStmt = 0;
788 if( pPager->pStmt ){
789 pPager->pStmt->pPrevStmt = pPg;
drh03eb96a2002-11-10 23:32:56 +0000790 }
drhac69b052004-05-12 13:30:07 +0000791 pPg->pNextStmt = pPager->pStmt;
792 pPager->pStmt = pPg;
793 pPg->inStmt = 1;
drh03eb96a2002-11-10 23:32:56 +0000794}
drh3aac2dd2004-04-26 14:10:20 +0000795static void page_remove_from_stmt_list(PgHdr *pPg){
drhac69b052004-05-12 13:30:07 +0000796 if( !pPg->inStmt ) return;
797 if( pPg->pPrevStmt ){
798 assert( pPg->pPrevStmt->pNextStmt==pPg );
799 pPg->pPrevStmt->pNextStmt = pPg->pNextStmt;
drh03eb96a2002-11-10 23:32:56 +0000800 }else{
drhac69b052004-05-12 13:30:07 +0000801 assert( pPg->pPager->pStmt==pPg );
802 pPg->pPager->pStmt = pPg->pNextStmt;
drh03eb96a2002-11-10 23:32:56 +0000803 }
drhac69b052004-05-12 13:30:07 +0000804 if( pPg->pNextStmt ){
805 assert( pPg->pNextStmt->pPrevStmt==pPg );
806 pPg->pNextStmt->pPrevStmt = pPg->pPrevStmt;
drh03eb96a2002-11-10 23:32:56 +0000807 }
drhac69b052004-05-12 13:30:07 +0000808 pPg->pNextStmt = 0;
809 pPg->pPrevStmt = 0;
810 pPg->inStmt = 0;
drh03eb96a2002-11-10 23:32:56 +0000811}
812
813/*
drhed7c8552001-04-11 14:29:21 +0000814** Find a page in the hash table given its page number. Return
815** a pointer to the page or NULL if not found.
816*/
drhd9b02572001-04-15 00:37:09 +0000817static PgHdr *pager_lookup(Pager *pPager, Pgno pgno){
drh836faa42003-01-11 13:30:57 +0000818 PgHdr *p = pPager->aHash[pager_hash(pgno)];
drhed7c8552001-04-11 14:29:21 +0000819 while( p && p->pgno!=pgno ){
820 p = p->pNextHash;
821 }
822 return p;
823}
824
825/*
826** Unlock the database and clear the in-memory cache. This routine
827** sets the state of the pager back to what it was when it was first
828** opened. Any outstanding pages are invalidated and subsequent attempts
829** to access those pages will likely result in a coredump.
830*/
drhd9b02572001-04-15 00:37:09 +0000831static void pager_reset(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +0000832 PgHdr *pPg, *pNext;
danielk1977e94ddc92005-03-21 03:53:38 +0000833 if( pPager->errMask ) return;
drhd9b02572001-04-15 00:37:09 +0000834 for(pPg=pPager->pAll; pPg; pPg=pNext){
835 pNext = pPg->pNextAll;
836 sqliteFree(pPg);
drhed7c8552001-04-11 14:29:21 +0000837 }
838 pPager->pFirst = 0;
drh341eae82003-01-21 02:39:36 +0000839 pPager->pFirstSynced = 0;
drhd9b02572001-04-15 00:37:09 +0000840 pPager->pLast = 0;
841 pPager->pAll = 0;
drhed7c8552001-04-11 14:29:21 +0000842 memset(pPager->aHash, 0, sizeof(pPager->aHash));
843 pPager->nPage = 0;
drha6abd042004-06-09 17:37:22 +0000844 if( pPager->state>=PAGER_RESERVED ){
drh3aac2dd2004-04-26 14:10:20 +0000845 sqlite3pager_rollback(pPager);
drhed7c8552001-04-11 14:29:21 +0000846 }
drha6abd042004-06-09 17:37:22 +0000847 sqlite3OsUnlock(&pPager->fd, NO_LOCK);
848 pPager->state = PAGER_UNLOCK;
drhd9b02572001-04-15 00:37:09 +0000849 pPager->dbSize = -1;
drhed7c8552001-04-11 14:29:21 +0000850 pPager->nRef = 0;
drh8cfbf082001-09-19 13:22:39 +0000851 assert( pPager->journalOpen==0 );
drhed7c8552001-04-11 14:29:21 +0000852}
853
danielk19776b456a22005-03-21 04:04:02 +0000854/*
855** This function is used to reset the pager after a malloc() failure. This
856** doesn't work with in-memory databases. If a malloc() fails when an
857** in-memory database is in use it is not possible to recover.
858**
859** If a transaction or statement transaction is active, it is rolled back.
860**
861** It is an error to call this function if any pages are in use.
862*/
863#ifndef SQLITE_OMIT_GLOBALRECOVER
864int sqlite3pager_reset(Pager *pPager){
865 if( pPager ){
866 if( pPager->nRef || MEMDB ){
867 return SQLITE_ERROR;
868 }
869 pPager->errMask &= ~(PAGER_ERR_MEM);
870 pager_reset(pPager);
871 }
872 return SQLITE_OK;
873}
874#endif
875
danielk1977e94ddc92005-03-21 03:53:38 +0000876
drhed7c8552001-04-11 14:29:21 +0000877/*
878** When this routine is called, the pager has the journal file open and
drha6abd042004-06-09 17:37:22 +0000879** a RESERVED or EXCLUSIVE lock on the database. This routine releases
880** the database lock and acquires a SHARED lock in its place. The journal
881** file is deleted and closed.
drh50457892003-09-06 01:10:47 +0000882**
883** TODO: Consider keeping the journal file open for temporary databases.
884** This might give a performance improvement on windows where opening
885** a file is an expensive operation.
drhed7c8552001-04-11 14:29:21 +0000886*/
drhd9b02572001-04-15 00:37:09 +0000887static int pager_unwritelock(Pager *pPager){
drhd9b02572001-04-15 00:37:09 +0000888 PgHdr *pPg;
drh9c105bb2004-10-02 20:38:28 +0000889 int rc;
drhb7f91642004-10-31 02:22:47 +0000890 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +0000891 if( pPager->state<PAGER_RESERVED ){
892 return SQLITE_OK;
893 }
drh3aac2dd2004-04-26 14:10:20 +0000894 sqlite3pager_stmt_commit(pPager);
drhac69b052004-05-12 13:30:07 +0000895 if( pPager->stmtOpen ){
896 sqlite3OsClose(&pPager->stfd);
897 pPager->stmtOpen = 0;
drh0f892532002-05-30 12:27:03 +0000898 }
drhda47d772002-12-02 04:25:19 +0000899 if( pPager->journalOpen ){
danielk19774adee202004-05-08 08:23:19 +0000900 sqlite3OsClose(&pPager->jfd);
drhda47d772002-12-02 04:25:19 +0000901 pPager->journalOpen = 0;
danielk19774adee202004-05-08 08:23:19 +0000902 sqlite3OsDelete(pPager->zJournal);
drhda47d772002-12-02 04:25:19 +0000903 sqliteFree( pPager->aInJournal );
904 pPager->aInJournal = 0;
905 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
906 pPg->inJournal = 0;
907 pPg->dirty = 0;
drhdb48ee02003-01-16 13:42:43 +0000908 pPg->needSync = 0;
danielk19773c407372005-02-15 02:54:14 +0000909#ifdef SQLITE_CHECK_PAGES
910 pPg->pageHash = pager_pagehash(pPg);
911#endif
drhda47d772002-12-02 04:25:19 +0000912 }
danielk1977ef317ab2004-06-23 10:43:10 +0000913 pPager->dirtyCache = 0;
danielk1977ef317ab2004-06-23 10:43:10 +0000914 pPager->nRec = 0;
drhda47d772002-12-02 04:25:19 +0000915 }else{
drh88b01a12005-03-28 18:04:27 +0000916 assert( pPager->aInJournal==0 );
drha6abd042004-06-09 17:37:22 +0000917 assert( pPager->dirtyCache==0 || pPager->useJournal==0 );
drhd9b02572001-04-15 00:37:09 +0000918 }
drh9c105bb2004-10-02 20:38:28 +0000919 rc = sqlite3OsUnlock(&pPager->fd, SHARED_LOCK);
drha6abd042004-06-09 17:37:22 +0000920 pPager->state = PAGER_SHARED;
danielk1977ef317ab2004-06-23 10:43:10 +0000921 pPager->origDbSize = 0;
danielk197776572402004-06-25 02:38:54 +0000922 pPager->setMaster = 0;
drh9c105bb2004-10-02 20:38:28 +0000923 return rc;
drhed7c8552001-04-11 14:29:21 +0000924}
925
drhed7c8552001-04-11 14:29:21 +0000926/*
drh968af522003-02-11 14:55:40 +0000927** Compute and return a checksum for the page of data.
drh34e79ce2004-02-08 06:05:46 +0000928**
929** This is not a real checksum. It is really just the sum of the
drh726de592004-06-10 23:35:50 +0000930** random initial value and the page number. We experimented with
931** a checksum of the entire data, but that was found to be too slow.
932**
933** Note that the page number is stored at the beginning of data and
934** the checksum is stored at the end. This is important. If journal
935** corruption occurs due to a power failure, the most likely scenario
936** is that one end or the other of the record will be changed. It is
937** much less likely that the two ends of the journal record will be
938** correct and the middle be corrupt. Thus, this "checksum" scheme,
939** though fast and simple, catches the mostly likely kind of corruption.
940**
941** FIX ME: Consider adding every 200th (or so) byte of the data to the
942** checksum. That way if a single page spans 3 or more disk sectors and
943** only the middle sector is corrupt, we will still have a reasonable
944** chance of failing the checksum and thus detecting the problem.
drh968af522003-02-11 14:55:40 +0000945*/
946static u32 pager_cksum(Pager *pPager, Pgno pgno, const char *aData){
danielk1977ef317ab2004-06-23 10:43:10 +0000947 u32 cksum = pPager->cksumInit;
948 int i = pPager->pageSize-200;
949 while( i>0 ){
950 cksum += aData[i];
951 i -= 200;
952 }
drh968af522003-02-11 14:55:40 +0000953 return cksum;
954}
955
956/*
drhfa86c412002-02-02 15:01:15 +0000957** Read a single page from the journal file opened on file descriptor
958** jfd. Playback this one page.
drh968af522003-02-11 14:55:40 +0000959**
drh726de592004-06-10 23:35:50 +0000960** If useCksum==0 it means this journal does not use checksums. Checksums
961** are not used in statement journals because statement journals do not
962** need to survive power failures.
drhfa86c412002-02-02 15:01:15 +0000963*/
drhae2b40c2004-06-09 19:03:54 +0000964static int pager_playback_one_page(Pager *pPager, OsFile *jfd, int useCksum){
drhfa86c412002-02-02 15:01:15 +0000965 int rc;
drhae2b40c2004-06-09 19:03:54 +0000966 PgHdr *pPg; /* An existing page in the cache */
967 Pgno pgno; /* The page number of a page in journal */
968 u32 cksum; /* Checksum used for sanity checking */
drh90f5ecb2004-07-22 01:19:35 +0000969 u8 aData[SQLITE_MAX_PAGE_SIZE]; /* Temp storage for a page */
drhfa86c412002-02-02 15:01:15 +0000970
drh96362842005-03-20 22:47:56 +0000971 /* useCksum should be true for the main journal and false for
972 ** statement journals. Verify that this is always the case
973 */
974 assert( jfd == (useCksum ? &pPager->jfd : &pPager->stfd) );
975
976
drhae2b40c2004-06-09 19:03:54 +0000977 rc = read32bits(jfd, &pgno);
drh99ee3602003-02-16 19:13:36 +0000978 if( rc!=SQLITE_OK ) return rc;
drhae2b40c2004-06-09 19:03:54 +0000979 rc = sqlite3OsRead(jfd, &aData, pPager->pageSize);
drh99ee3602003-02-16 19:13:36 +0000980 if( rc!=SQLITE_OK ) return rc;
danielk197776572402004-06-25 02:38:54 +0000981 pPager->journalOff += pPager->pageSize + 4;
drhfa86c412002-02-02 15:01:15 +0000982
drh968af522003-02-11 14:55:40 +0000983 /* Sanity checking on the page. This is more important that I originally
984 ** thought. If a power failure occurs while the journal is being written,
985 ** it could cause invalid data to be written into the journal. We need to
986 ** detect this invalid data (with high probability) and ignore it.
987 */
danielk197775edc162004-06-26 01:48:18 +0000988 if( pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh968af522003-02-11 14:55:40 +0000989 return SQLITE_DONE;
990 }
drhae2b40c2004-06-09 19:03:54 +0000991 if( pgno>(unsigned)pPager->dbSize ){
drh968af522003-02-11 14:55:40 +0000992 return SQLITE_OK;
993 }
drhae2b40c2004-06-09 19:03:54 +0000994 if( useCksum ){
995 rc = read32bits(jfd, &cksum);
drh99ee3602003-02-16 19:13:36 +0000996 if( rc ) return rc;
danielk197776572402004-06-25 02:38:54 +0000997 pPager->journalOff += 4;
drhae2b40c2004-06-09 19:03:54 +0000998 if( pager_cksum(pPager, pgno, aData)!=cksum ){
drh968af522003-02-11 14:55:40 +0000999 return SQLITE_DONE;
1000 }
1001 }
drhfa86c412002-02-02 15:01:15 +00001002
danielk1977aa5ccdf2004-06-14 05:10:42 +00001003 assert( pPager->state==PAGER_RESERVED || pPager->state>=PAGER_EXCLUSIVE );
danielk1977a3f3a5f2004-06-10 04:32:16 +00001004
1005 /* If the pager is in RESERVED state, then there must be a copy of this
1006 ** page in the pager cache. In this case just update the pager cache,
danielk19770de0bb32004-06-10 05:59:24 +00001007 ** not the database file. The page is left marked dirty in this case.
1008 **
danielk1977a3f3a5f2004-06-10 04:32:16 +00001009 ** If in EXCLUSIVE state, then we update the pager cache if it exists
1010 ** and the main file. The page is then marked not dirty.
drh96362842005-03-20 22:47:56 +00001011 **
1012 ** Ticket #1171: The statement journal might contain page content that is
1013 ** different from the page content at the start of the transaction.
1014 ** This occurs when a page is changed prior to the start of a statement
1015 ** then changed again within the statement. When rolling back such a
1016 ** statement we must not write to the original database unless we know
1017 ** for certain that original page contents are in the main rollback
1018 ** journal. Otherwise, if a full ROLLBACK occurs after the statement
1019 ** rollback the full ROLLBACK will not restore the page to its original
1020 ** content. Two conditions must be met before writing to the database
1021 ** files. (1) the database must be locked. (2) we know that the original
1022 ** page content is in the main journal either because the page is not in
1023 ** cache or else it is marked as needSync==0.
drhfa86c412002-02-02 15:01:15 +00001024 */
drhae2b40c2004-06-09 19:03:54 +00001025 pPg = pager_lookup(pPager, pgno);
drh96362842005-03-20 22:47:56 +00001026 assert( pPager->state>=PAGER_EXCLUSIVE || pPg!=0 );
danielk1977ef73ee92004-11-06 12:26:07 +00001027 TRACE3("PLAYBACK %d page %d\n", PAGERID(pPager), pgno);
drh96362842005-03-20 22:47:56 +00001028 if( pPager->state>=PAGER_EXCLUSIVE && (pPg==0 || pPg->needSync==0) ){
drheb206252004-10-01 02:00:31 +00001029 sqlite3OsSeek(&pPager->fd, (pgno-1)*(i64)pPager->pageSize);
drh90f5ecb2004-07-22 01:19:35 +00001030 rc = sqlite3OsWrite(&pPager->fd, aData, pPager->pageSize);
drh96362842005-03-20 22:47:56 +00001031 if( pPg ) pPg->dirty = 0;
danielk1977a3f3a5f2004-06-10 04:32:16 +00001032 }
drhfa86c412002-02-02 15:01:15 +00001033 if( pPg ){
danielk197728129562005-01-11 10:25:06 +00001034 /* No page should ever be explicitly rolled back that is in use, except
1035 ** for page 1 which is held in use in order to keep the lock on the
1036 ** database active. However such a page may be rolled back as a result
1037 ** of an internal error resulting in an automatic call to
1038 ** sqlite3pager_rollback().
drhacf4ac92003-12-17 23:57:34 +00001039 */
drhb6f41482004-05-14 01:58:11 +00001040 void *pData;
danielk197728129562005-01-11 10:25:06 +00001041 /* assert( pPg->nRef==0 || pPg->pgno==1 ); */
drhb6f41482004-05-14 01:58:11 +00001042 pData = PGHDR_TO_DATA(pPg);
drhae2b40c2004-06-09 19:03:54 +00001043 memcpy(pData, aData, pPager->pageSize);
drh726de592004-06-10 23:35:50 +00001044 if( pPager->xDestructor ){ /*** FIX ME: Should this be xReinit? ***/
drhb6f41482004-05-14 01:58:11 +00001045 pPager->xDestructor(pData, pPager->pageSize);
drhde647132004-05-07 17:57:49 +00001046 }
danielk19773c407372005-02-15 02:54:14 +00001047#ifdef SQLITE_CHECK_PAGES
drh96362842005-03-20 22:47:56 +00001048 pPg->pageHash = pager_pagehash(pPg);
danielk19773c407372005-02-15 02:54:14 +00001049#endif
drhb6f41482004-05-14 01:58:11 +00001050 CODEC(pPager, pData, pPg->pgno, 3);
drhfa86c412002-02-02 15:01:15 +00001051 }
1052 return rc;
1053}
1054
1055/*
danielk197713adf8a2004-06-03 16:08:41 +00001056** Parameter zMaster is the name of a master journal file. A single journal
1057** file that referred to the master journal file has just been rolled back.
1058** This routine checks if it is possible to delete the master journal file,
1059** and does so if it is.
drh726de592004-06-10 23:35:50 +00001060**
1061** The master journal file contains the names of all child journals.
1062** To tell if a master journal can be deleted, check to each of the
1063** children. If all children are either missing or do not refer to
1064** a different master journal, then this master journal can be deleted.
danielk197713adf8a2004-06-03 16:08:41 +00001065*/
1066static int pager_delmaster(const char *zMaster){
1067 int rc;
1068 int master_open = 0;
1069 OsFile master;
1070 char *zMasterJournal = 0; /* Contents of master journal file */
drheb206252004-10-01 02:00:31 +00001071 i64 nMasterJournal; /* Size of master journal file */
danielk197713adf8a2004-06-03 16:08:41 +00001072
1073 /* Open the master journal file exclusively in case some other process
1074 ** is running this routine also. Not that it makes too much difference.
1075 */
drhda71ce12004-06-21 18:14:45 +00001076 memset(&master, 0, sizeof(master));
danielk19778191bff2004-06-28 04:52:30 +00001077 rc = sqlite3OsOpenReadOnly(zMaster, &master);
danielk197713adf8a2004-06-03 16:08:41 +00001078 if( rc!=SQLITE_OK ) goto delmaster_out;
1079 master_open = 1;
danielk197713adf8a2004-06-03 16:08:41 +00001080 rc = sqlite3OsFileSize(&master, &nMasterJournal);
1081 if( rc!=SQLITE_OK ) goto delmaster_out;
1082
1083 if( nMasterJournal>0 ){
danielk19775865e3d2004-06-14 06:03:57 +00001084 char *zJournal;
danielk197776572402004-06-25 02:38:54 +00001085 char *zMasterPtr = 0;
danielk19775865e3d2004-06-14 06:03:57 +00001086
1087 /* Load the entire master journal file into space obtained from
1088 ** sqliteMalloc() and pointed to by zMasterJournal.
danielk19775865e3d2004-06-14 06:03:57 +00001089 */
danielk197776572402004-06-25 02:38:54 +00001090 zMasterJournal = (char *)sqliteMalloc(nMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001091 if( !zMasterJournal ){
1092 rc = SQLITE_NOMEM;
1093 goto delmaster_out;
1094 }
1095 rc = sqlite3OsRead(&master, zMasterJournal, nMasterJournal);
1096 if( rc!=SQLITE_OK ) goto delmaster_out;
1097
danielk19775865e3d2004-06-14 06:03:57 +00001098 zJournal = zMasterJournal;
1099 while( (zJournal-zMasterJournal)<nMasterJournal ){
danielk197713adf8a2004-06-03 16:08:41 +00001100 if( sqlite3OsFileExists(zJournal) ){
1101 /* One of the journals pointed to by the master journal exists.
1102 ** Open it and check if it points at the master journal. If
1103 ** so, return without deleting the master journal file.
1104 */
1105 OsFile journal;
drh3b7b78b2004-11-24 01:16:43 +00001106 int c;
danielk197713adf8a2004-06-03 16:08:41 +00001107
drhda71ce12004-06-21 18:14:45 +00001108 memset(&journal, 0, sizeof(journal));
danielk197713adf8a2004-06-03 16:08:41 +00001109 rc = sqlite3OsOpenReadOnly(zJournal, &journal);
1110 if( rc!=SQLITE_OK ){
danielk197713adf8a2004-06-03 16:08:41 +00001111 goto delmaster_out;
1112 }
danielk197713adf8a2004-06-03 16:08:41 +00001113
danielk197776572402004-06-25 02:38:54 +00001114 rc = readMasterJournal(&journal, &zMasterPtr);
1115 sqlite3OsClose(&journal);
danielk19779eed5052004-06-04 10:38:30 +00001116 if( rc!=SQLITE_OK ){
danielk19779eed5052004-06-04 10:38:30 +00001117 goto delmaster_out;
1118 }
danielk197776572402004-06-25 02:38:54 +00001119
drh3b7b78b2004-11-24 01:16:43 +00001120 c = zMasterPtr!=0 && strcmp(zMasterPtr, zMaster)==0;
1121 sqliteFree(zMasterPtr);
1122 if( c ){
danielk197776572402004-06-25 02:38:54 +00001123 /* We have a match. Do not delete the master journal file. */
1124 goto delmaster_out;
danielk197713adf8a2004-06-03 16:08:41 +00001125 }
1126 }
danielk19775865e3d2004-06-14 06:03:57 +00001127 zJournal += (strlen(zJournal)+1);
danielk197713adf8a2004-06-03 16:08:41 +00001128 }
1129 }
1130
1131 sqlite3OsDelete(zMaster);
1132
1133delmaster_out:
1134 if( zMasterJournal ){
1135 sqliteFree(zMasterJournal);
1136 }
1137 if( master_open ){
1138 sqlite3OsClose(&master);
1139 }
1140 return rc;
1141}
1142
1143/*
drha6abd042004-06-09 17:37:22 +00001144** Make every page in the cache agree with what is on disk. In other words,
1145** reread the disk to reset the state of the cache.
1146**
1147** This routine is called after a rollback in which some of the dirty cache
1148** pages had never been written out to disk. We need to roll back the
1149** cache content and the easiest way to do that is to reread the old content
1150** back from the disk.
1151*/
1152static int pager_reload_cache(Pager *pPager){
1153 PgHdr *pPg;
1154 int rc = SQLITE_OK;
1155 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
drh90f5ecb2004-07-22 01:19:35 +00001156 char zBuf[SQLITE_MAX_PAGE_SIZE];
drha6abd042004-06-09 17:37:22 +00001157 if( !pPg->dirty ) continue;
1158 if( (int)pPg->pgno <= pPager->origDbSize ){
drheb206252004-10-01 02:00:31 +00001159 sqlite3OsSeek(&pPager->fd, pPager->pageSize*(i64)(pPg->pgno-1));
drh90f5ecb2004-07-22 01:19:35 +00001160 rc = sqlite3OsRead(&pPager->fd, zBuf, pPager->pageSize);
danielk1977ef73ee92004-11-06 12:26:07 +00001161 TRACE3("REFETCH %d page %d\n", PAGERID(pPager), pPg->pgno);
drha6abd042004-06-09 17:37:22 +00001162 if( rc ) break;
drh25d65432004-07-22 15:02:25 +00001163 CODEC(pPager, zBuf, pPg->pgno, 2);
drha6abd042004-06-09 17:37:22 +00001164 }else{
drh90f5ecb2004-07-22 01:19:35 +00001165 memset(zBuf, 0, pPager->pageSize);
drha6abd042004-06-09 17:37:22 +00001166 }
drh90f5ecb2004-07-22 01:19:35 +00001167 if( pPg->nRef==0 || memcmp(zBuf, PGHDR_TO_DATA(pPg), pPager->pageSize) ){
1168 memcpy(PGHDR_TO_DATA(pPg), zBuf, pPager->pageSize);
drha6abd042004-06-09 17:37:22 +00001169 if( pPager->xReiniter ){
1170 pPager->xReiniter(PGHDR_TO_DATA(pPg), pPager->pageSize);
1171 }else{
drh90f5ecb2004-07-22 01:19:35 +00001172 memset(PGHDR_TO_EXTRA(pPg, pPager), 0, pPager->nExtra);
drha6abd042004-06-09 17:37:22 +00001173 }
1174 }
1175 pPg->needSync = 0;
1176 pPg->dirty = 0;
danielk19773c407372005-02-15 02:54:14 +00001177#ifdef SQLITE_CHECK_PAGES
1178 pPg->pageHash = pager_pagehash(pPg);
1179#endif
drha6abd042004-06-09 17:37:22 +00001180 }
1181 return rc;
1182}
1183
drha6abd042004-06-09 17:37:22 +00001184/*
drhcb4c40b2004-08-18 19:09:43 +00001185** Truncate the main file of the given pager to the number of pages
1186** indicated.
1187*/
1188static int pager_truncate(Pager *pPager, int nPage){
danielk197717221812005-02-15 03:38:05 +00001189 assert( pPager->state>=PAGER_EXCLUSIVE );
drheb206252004-10-01 02:00:31 +00001190 return sqlite3OsTruncate(&pPager->fd, pPager->pageSize*(i64)nPage);
drhcb4c40b2004-08-18 19:09:43 +00001191}
1192
1193/*
drhed7c8552001-04-11 14:29:21 +00001194** Playback the journal and thus restore the database file to
1195** the state it was in before we started making changes.
1196**
drh34e79ce2004-02-08 06:05:46 +00001197** The journal file format is as follows:
1198**
drhae2b40c2004-06-09 19:03:54 +00001199** (1) 8 byte prefix. A copy of aJournalMagic[].
1200** (2) 4 byte big-endian integer which is the number of valid page records
drh34e79ce2004-02-08 06:05:46 +00001201** in the journal. If this value is 0xffffffff, then compute the
drhae2b40c2004-06-09 19:03:54 +00001202** number of page records from the journal size.
1203** (3) 4 byte big-endian integer which is the initial value for the
1204** sanity checksum.
1205** (4) 4 byte integer which is the number of pages to truncate the
drh34e79ce2004-02-08 06:05:46 +00001206** database to during a rollback.
drhae2b40c2004-06-09 19:03:54 +00001207** (5) 4 byte integer which is the number of bytes in the master journal
1208** name. The value may be zero (indicate that there is no master
1209** journal.)
1210** (6) N bytes of the master journal name. The name will be nul-terminated
1211** and might be shorter than the value read from (5). If the first byte
1212** of the name is \000 then there is no master journal. The master
1213** journal name is stored in UTF-8.
1214** (7) Zero or more pages instances, each as follows:
drh34e79ce2004-02-08 06:05:46 +00001215** + 4 byte page number.
drhae2b40c2004-06-09 19:03:54 +00001216** + pPager->pageSize bytes of data.
1217** + 4 byte checksum
drh34e79ce2004-02-08 06:05:46 +00001218**
drhae2b40c2004-06-09 19:03:54 +00001219** When we speak of the journal header, we mean the first 6 items above.
1220** Each entry in the journal is an instance of the 7th item.
drh34e79ce2004-02-08 06:05:46 +00001221**
1222** Call the value from the second bullet "nRec". nRec is the number of
1223** valid page entries in the journal. In most cases, you can compute the
1224** value of nRec from the size of the journal file. But if a power
1225** failure occurred while the journal was being written, it could be the
1226** case that the size of the journal file had already been increased but
1227** the extra entries had not yet made it safely to disk. In such a case,
1228** the value of nRec computed from the file size would be too large. For
1229** that reason, we always use the nRec value in the header.
1230**
1231** If the nRec value is 0xffffffff it means that nRec should be computed
1232** from the file size. This value is used when the user selects the
1233** no-sync option for the journal. A power failure could lead to corruption
1234** in this case. But for things like temporary table (which will be
1235** deleted when the power is restored) we don't care.
1236**
drhd9b02572001-04-15 00:37:09 +00001237** If the file opened as the journal file is not a well-formed
danielk1977ece80f12004-06-23 01:05:26 +00001238** journal file then all pages up to the first corrupted page are rolled
1239** back (or no pages if the journal header is corrupted). The journal file
1240** is then deleted and SQLITE_OK returned, just as if no corruption had
1241** been encountered.
1242**
1243** If an I/O or malloc() error occurs, the journal-file is not deleted
1244** and an error code is returned.
drhed7c8552001-04-11 14:29:21 +00001245*/
danielk197776572402004-06-25 02:38:54 +00001246static int pager_playback(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001247 i64 szJ; /* Size of the journal file in bytes */
danielk1977c3e8f5e2004-06-28 01:16:46 +00001248 u32 nRec; /* Number of Records in the journal */
drhd9b02572001-04-15 00:37:09 +00001249 int i; /* Loop counter */
1250 Pgno mxPg = 0; /* Size of the original file in pages */
drhae2b40c2004-06-09 19:03:54 +00001251 int rc; /* Result code of a subroutine */
danielk197713adf8a2004-06-03 16:08:41 +00001252 char *zMaster = 0; /* Name of master journal file if any */
drhed7c8552001-04-11 14:29:21 +00001253
drhc3a64ba2001-11-22 00:01:27 +00001254 /* Figure out how many records are in the journal. Abort early if
1255 ** the journal is empty.
drhed7c8552001-04-11 14:29:21 +00001256 */
drh8cfbf082001-09-19 13:22:39 +00001257 assert( pPager->journalOpen );
danielk19774adee202004-05-08 08:23:19 +00001258 rc = sqlite3OsFileSize(&pPager->jfd, &szJ);
drhc3a64ba2001-11-22 00:01:27 +00001259 if( rc!=SQLITE_OK ){
1260 goto end_playback;
1261 }
drh240c5792004-02-08 00:40:52 +00001262
danielk197776572402004-06-25 02:38:54 +00001263 /* Read the master journal name from the journal, if it is present.
1264 ** If a master journal file name is specified, but the file is not
1265 ** present on disk, then the journal is not hot and does not need to be
1266 ** played back.
drh240c5792004-02-08 00:40:52 +00001267 */
danielk197776572402004-06-25 02:38:54 +00001268 rc = readMasterJournal(&pPager->jfd, &zMaster);
1269 assert( rc!=SQLITE_DONE );
1270 if( rc!=SQLITE_OK || (zMaster && !sqlite3OsFileExists(zMaster)) ){
1271 sqliteFree(zMaster);
1272 zMaster = 0;
1273 if( rc==SQLITE_DONE ) rc = SQLITE_OK;
drhc3a64ba2001-11-22 00:01:27 +00001274 goto end_playback;
1275 }
danielk197776572402004-06-25 02:38:54 +00001276 sqlite3OsSeek(&pPager->jfd, 0);
1277 pPager->journalOff = 0;
drhc3a64ba2001-11-22 00:01:27 +00001278
danielk197776572402004-06-25 02:38:54 +00001279 /* This loop terminates either when the readJournalHdr() call returns
1280 ** SQLITE_DONE or an IO error occurs. */
1281 while( 1 ){
drhae2b40c2004-06-09 19:03:54 +00001282
danielk197776572402004-06-25 02:38:54 +00001283 /* Read the next journal header from the journal file. If there are
1284 ** not enough bytes left in the journal file for a complete header, or
1285 ** it is corrupted, then a process must of failed while writing it.
1286 ** This indicates nothing more needs to be rolled back.
1287 */
1288 rc = readJournalHdr(pPager, szJ, &nRec, &mxPg);
1289 if( rc!=SQLITE_OK ){
drh968af522003-02-11 14:55:40 +00001290 if( rc==SQLITE_DONE ){
drh968af522003-02-11 14:55:40 +00001291 rc = SQLITE_OK;
1292 }
danielk197776572402004-06-25 02:38:54 +00001293 goto end_playback;
1294 }
1295
1296 /* If nRec is 0xffffffff, then this journal was created by a process
1297 ** working in no-sync mode. This means that the rest of the journal
1298 ** file consists of pages, there are no more journal headers. Compute
1299 ** the value of nRec based on this assumption.
1300 */
1301 if( nRec==0xffffffff ){
1302 assert( pPager->journalOff==JOURNAL_HDR_SZ(pPager) );
1303 nRec = (szJ - JOURNAL_HDR_SZ(pPager))/JOURNAL_PG_SZ(pPager);
1304 }
1305
1306 /* If this is the first header read from the journal, truncate the
1307 ** database file back to it's original size.
1308 */
danielk197717221812005-02-15 03:38:05 +00001309 if( pPager->state>=PAGER_EXCLUSIVE &&
1310 pPager->journalOff==JOURNAL_HDR_SZ(pPager) ){
danielk197776572402004-06-25 02:38:54 +00001311 assert( pPager->origDbSize==0 || pPager->origDbSize==mxPg );
drhcb4c40b2004-08-18 19:09:43 +00001312 rc = pager_truncate(pPager, mxPg);
danielk197776572402004-06-25 02:38:54 +00001313 if( rc!=SQLITE_OK ){
1314 goto end_playback;
1315 }
1316 pPager->dbSize = mxPg;
1317 }
1318
1319 /* rc = sqlite3OsSeek(&pPager->jfd, JOURNAL_HDR_SZ(pPager)); */
1320 if( rc!=SQLITE_OK ) goto end_playback;
1321
1322 /* Copy original pages out of the journal and back into the database file.
1323 */
1324 for(i=0; i<nRec; i++){
1325 rc = pager_playback_one_page(pPager, &pPager->jfd, 1);
1326 if( rc!=SQLITE_OK ){
1327 if( rc==SQLITE_DONE ){
1328 rc = SQLITE_OK;
1329 pPager->journalOff = szJ;
1330 break;
1331 }else{
1332 goto end_playback;
1333 }
1334 }
drh968af522003-02-11 14:55:40 +00001335 }
drhed7c8552001-04-11 14:29:21 +00001336 }
drh81a20f22001-10-12 17:30:04 +00001337
drh4a0681e2003-02-13 01:58:20 +00001338 /* Pages that have been written to the journal but never synced
1339 ** where not restored by the loop above. We have to restore those
drh240c5792004-02-08 00:40:52 +00001340 ** pages by reading them back from the original database.
drhdb48ee02003-01-16 13:42:43 +00001341 */
danielk197776572402004-06-25 02:38:54 +00001342 assert( rc==SQLITE_OK );
1343 pager_reload_cache(pPager);
drh4a0681e2003-02-13 01:58:20 +00001344
1345end_playback:
danielk19778191bff2004-06-28 04:52:30 +00001346 if( rc==SQLITE_OK ){
1347 rc = pager_unwritelock(pPager);
1348 }
danielk197713adf8a2004-06-03 16:08:41 +00001349 if( zMaster ){
1350 /* If there was a master journal and this routine will return true,
danielk197732554c12005-01-22 03:39:39 +00001351 ** see if it is possible to delete the master journal.
danielk197713adf8a2004-06-03 16:08:41 +00001352 */
1353 if( rc==SQLITE_OK ){
danielk197732554c12005-01-22 03:39:39 +00001354 rc = pager_delmaster(zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001355 }
1356 sqliteFree(zMaster);
1357 }
danielk197776572402004-06-25 02:38:54 +00001358
1359 /* The Pager.sectorSize variable may have been updated while rolling
1360 ** back a journal created by a process with a different PAGER_SECTOR_SIZE
1361 ** value. Reset it to the correct value for this process.
1362 */
1363 pPager->sectorSize = PAGER_SECTOR_SIZE;
drhd9b02572001-04-15 00:37:09 +00001364 return rc;
drhed7c8552001-04-11 14:29:21 +00001365}
1366
1367/*
drhac69b052004-05-12 13:30:07 +00001368** Playback the statement journal.
drhfa86c412002-02-02 15:01:15 +00001369**
1370** This is similar to playing back the transaction journal but with
1371** a few extra twists.
1372**
drh663fc632002-02-02 18:49:19 +00001373** (1) The number of pages in the database file at the start of
drhac69b052004-05-12 13:30:07 +00001374** the statement is stored in pPager->stmtSize, not in the
drh663fc632002-02-02 18:49:19 +00001375** journal file itself.
drhfa86c412002-02-02 15:01:15 +00001376**
drhac69b052004-05-12 13:30:07 +00001377** (2) In addition to playing back the statement journal, also
drhfa86c412002-02-02 15:01:15 +00001378** playback all pages of the transaction journal beginning
drhac69b052004-05-12 13:30:07 +00001379** at offset pPager->stmtJSize.
drhfa86c412002-02-02 15:01:15 +00001380*/
drh3aac2dd2004-04-26 14:10:20 +00001381static int pager_stmt_playback(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001382 i64 szJ; /* Size of the full journal */
1383 i64 hdrOff;
drh968af522003-02-11 14:55:40 +00001384 int nRec; /* Number of Records */
drhfa86c412002-02-02 15:01:15 +00001385 int i; /* Loop counter */
1386 int rc;
1387
danielk197776572402004-06-25 02:38:54 +00001388 szJ = pPager->journalOff;
1389#ifndef NDEBUG
1390 {
drheb206252004-10-01 02:00:31 +00001391 i64 os_szJ;
danielk197776572402004-06-25 02:38:54 +00001392 rc = sqlite3OsFileSize(&pPager->jfd, &os_szJ);
1393 if( rc!=SQLITE_OK ) return rc;
1394 assert( szJ==os_szJ );
1395 }
1396#endif
1397
1398 /* Set hdrOff to be the offset to the first journal header written
1399 ** this statement transaction, or the end of the file if no journal
1400 ** header was written.
1401 */
1402 hdrOff = pPager->stmtHdrOff;
1403 assert( pPager->fullSync || !hdrOff );
1404 if( !hdrOff ){
1405 hdrOff = szJ;
1406 }
1407
drhfa86c412002-02-02 15:01:15 +00001408 /* Truncate the database back to its original size.
1409 */
danielk197717221812005-02-15 03:38:05 +00001410 if( pPager->state>=PAGER_EXCLUSIVE ){
1411 rc = pager_truncate(pPager, pPager->stmtSize);
1412 }
drhac69b052004-05-12 13:30:07 +00001413 pPager->dbSize = pPager->stmtSize;
drhfa86c412002-02-02 15:01:15 +00001414
drhac69b052004-05-12 13:30:07 +00001415 /* Figure out how many records are in the statement journal.
drhfa86c412002-02-02 15:01:15 +00001416 */
drhac69b052004-05-12 13:30:07 +00001417 assert( pPager->stmtInUse && pPager->journalOpen );
1418 sqlite3OsSeek(&pPager->stfd, 0);
1419 nRec = pPager->stmtNRec;
drhfa86c412002-02-02 15:01:15 +00001420
drhac69b052004-05-12 13:30:07 +00001421 /* Copy original pages out of the statement journal and back into the
drhae2b40c2004-06-09 19:03:54 +00001422 ** database file. Note that the statement journal omits checksums from
1423 ** each record since power-failure recovery is not important to statement
1424 ** journals.
drhfa86c412002-02-02 15:01:15 +00001425 */
1426 for(i=nRec-1; i>=0; i--){
drhae2b40c2004-06-09 19:03:54 +00001427 rc = pager_playback_one_page(pPager, &pPager->stfd, 0);
drh968af522003-02-11 14:55:40 +00001428 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001429 if( rc!=SQLITE_OK ) goto end_stmt_playback;
drhfa86c412002-02-02 15:01:15 +00001430 }
1431
danielk197776572402004-06-25 02:38:54 +00001432 /* Now roll some pages back from the transaction journal. Pager.stmtJSize
1433 ** was the size of the journal file when this statement was started, so
1434 ** everything after that needs to be rolled back, either into the
1435 ** database, the memory cache, or both.
1436 **
1437 ** If it is not zero, then Pager.stmtHdrOff is the offset to the start
1438 ** of the first journal header written during this statement transaction.
drhfa86c412002-02-02 15:01:15 +00001439 */
drhac69b052004-05-12 13:30:07 +00001440 rc = sqlite3OsSeek(&pPager->jfd, pPager->stmtJSize);
drhfa86c412002-02-02 15:01:15 +00001441 if( rc!=SQLITE_OK ){
drh3aac2dd2004-04-26 14:10:20 +00001442 goto end_stmt_playback;
drhfa86c412002-02-02 15:01:15 +00001443 }
danielk197776572402004-06-25 02:38:54 +00001444 pPager->journalOff = pPager->stmtJSize;
danielk197775edc162004-06-26 01:48:18 +00001445 pPager->cksumInit = pPager->stmtCksum;
1446 assert( JOURNAL_HDR_SZ(pPager)<(pPager->pageSize+8) );
1447 while( pPager->journalOff <= (hdrOff-(pPager->pageSize+8)) ){
drhae2b40c2004-06-09 19:03:54 +00001448 rc = pager_playback_one_page(pPager, &pPager->jfd, 1);
danielk197776572402004-06-25 02:38:54 +00001449 assert( rc!=SQLITE_DONE );
1450 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1451 }
1452
1453 while( pPager->journalOff < szJ ){
1454 u32 nRec;
1455 u32 dummy;
1456 rc = readJournalHdr(pPager, szJ, &nRec, &dummy);
drh968af522003-02-11 14:55:40 +00001457 if( rc!=SQLITE_OK ){
1458 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001459 goto end_stmt_playback;
drh968af522003-02-11 14:55:40 +00001460 }
danielk197775edc162004-06-26 01:48:18 +00001461 if( nRec==0 ){
1462 nRec = (szJ - pPager->journalOff) / (pPager->pageSize+8);
1463 }
danielk197776572402004-06-25 02:38:54 +00001464 for(i=nRec-1; i>=0 && pPager->journalOff < szJ; i--){
1465 rc = pager_playback_one_page(pPager, &pPager->jfd, 1);
1466 assert( rc!=SQLITE_DONE );
1467 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1468 }
drhfa86c412002-02-02 15:01:15 +00001469 }
danielk197776572402004-06-25 02:38:54 +00001470
1471 pPager->journalOff = szJ;
drhfa86c412002-02-02 15:01:15 +00001472
drh3aac2dd2004-04-26 14:10:20 +00001473end_stmt_playback:
drhfa86c412002-02-02 15:01:15 +00001474 if( rc!=SQLITE_OK ){
drhfa86c412002-02-02 15:01:15 +00001475 pPager->errMask |= PAGER_ERR_CORRUPT;
drhee696e22004-08-30 16:52:17 +00001476 rc = SQLITE_CORRUPT; /* bkpt-CORRUPT */
danielk197775edc162004-06-26 01:48:18 +00001477 }else{
1478 pPager->journalOff = szJ;
1479 /* pager_reload_cache(pPager); */
drhfa86c412002-02-02 15:01:15 +00001480 }
1481 return rc;
1482}
1483
1484/*
drhf57b14a2001-09-14 18:54:08 +00001485** Change the maximum number of in-memory pages that are allowed.
drhcd61c282002-03-06 22:01:34 +00001486**
1487** The maximum number is the absolute value of the mxPage parameter.
1488** If mxPage is negative, the noSync flag is also set. noSync bypasses
danielk19774adee202004-05-08 08:23:19 +00001489** calls to sqlite3OsSync(). The pager runs much faster with noSync on,
drhcd61c282002-03-06 22:01:34 +00001490** but if the operating system crashes or there is an abrupt power
1491** failure, the database file might be left in an inconsistent and
1492** unrepairable state.
drhf57b14a2001-09-14 18:54:08 +00001493*/
drh3aac2dd2004-04-26 14:10:20 +00001494void sqlite3pager_set_cachesize(Pager *pPager, int mxPage){
drh603240c2002-03-05 01:11:12 +00001495 if( mxPage>=0 ){
drha1680452002-04-18 01:56:57 +00001496 pPager->noSync = pPager->tempFile;
danielk19771d850a72004-05-31 08:26:49 +00001497 if( pPager->noSync ) pPager->needSync = 0;
drh603240c2002-03-05 01:11:12 +00001498 }else{
1499 pPager->noSync = 1;
1500 mxPage = -mxPage;
1501 }
drhf57b14a2001-09-14 18:54:08 +00001502 if( mxPage>10 ){
1503 pPager->mxPage = mxPage;
danielk1977ef317ab2004-06-23 10:43:10 +00001504 }else{
1505 pPager->mxPage = 10;
drhf57b14a2001-09-14 18:54:08 +00001506 }
1507}
1508
1509/*
drh973b6e32003-02-12 14:09:42 +00001510** Adjust the robustness of the database to damage due to OS crashes
1511** or power failures by changing the number of syncs()s when writing
1512** the rollback journal. There are three levels:
1513**
danielk19774adee202004-05-08 08:23:19 +00001514** OFF sqlite3OsSync() is never called. This is the default
drh973b6e32003-02-12 14:09:42 +00001515** for temporary and transient files.
1516**
1517** NORMAL The journal is synced once before writes begin on the
1518** database. This is normally adequate protection, but
1519** it is theoretically possible, though very unlikely,
1520** that an inopertune power failure could leave the journal
1521** in a state which would cause damage to the database
1522** when it is rolled back.
1523**
1524** FULL The journal is synced twice before writes begin on the
drh34e79ce2004-02-08 06:05:46 +00001525** database (with some additional information - the nRec field
1526** of the journal header - being written in between the two
1527** syncs). If we assume that writing a
drh973b6e32003-02-12 14:09:42 +00001528** single disk sector is atomic, then this mode provides
1529** assurance that the journal will not be corrupted to the
1530** point of causing damage to the database during rollback.
1531**
1532** Numeric values associated with these states are OFF==1, NORMAL=2,
1533** and FULL=3.
1534*/
danielk197793758c82005-01-21 08:13:14 +00001535#ifndef SQLITE_OMIT_PAGER_PRAGMAS
drh3aac2dd2004-04-26 14:10:20 +00001536void sqlite3pager_set_safety_level(Pager *pPager, int level){
drh973b6e32003-02-12 14:09:42 +00001537 pPager->noSync = level==1 || pPager->tempFile;
1538 pPager->fullSync = level==3 && !pPager->tempFile;
danielk19771d850a72004-05-31 08:26:49 +00001539 if( pPager->noSync ) pPager->needSync = 0;
drh973b6e32003-02-12 14:09:42 +00001540}
danielk197793758c82005-01-21 08:13:14 +00001541#endif
drh973b6e32003-02-12 14:09:42 +00001542
1543/*
drhfa86c412002-02-02 15:01:15 +00001544** Open a temporary file. Write the name of the file into zName
1545** (zName must be at least SQLITE_TEMPNAME_SIZE bytes long.) Write
1546** the file descriptor into *fd. Return SQLITE_OK on success or some
1547** other error code if we fail.
1548**
1549** The OS will automatically delete the temporary file when it is
1550** closed.
1551*/
drh3aac2dd2004-04-26 14:10:20 +00001552static int sqlite3pager_opentemp(char *zFile, OsFile *fd){
drhfa86c412002-02-02 15:01:15 +00001553 int cnt = 8;
1554 int rc;
1555 do{
1556 cnt--;
danielk19774adee202004-05-08 08:23:19 +00001557 sqlite3OsTempFileName(zFile);
1558 rc = sqlite3OsOpenExclusive(zFile, fd, 1);
danielk197713073932004-06-30 11:54:06 +00001559 }while( cnt>0 && rc!=SQLITE_OK && rc!=SQLITE_NOMEM );
drhfa86c412002-02-02 15:01:15 +00001560 return rc;
1561}
1562
1563/*
drhed7c8552001-04-11 14:29:21 +00001564** Create a new page cache and put a pointer to the page cache in *ppPager.
drh5e00f6c2001-09-13 13:46:56 +00001565** The file to be cached need not exist. The file is not locked until
drh3aac2dd2004-04-26 14:10:20 +00001566** the first call to sqlite3pager_get() and is only held open until the
1567** last page is released using sqlite3pager_unref().
drh382c0242001-10-06 16:33:02 +00001568**
drh6446c4d2001-12-15 14:22:18 +00001569** If zFilename is NULL then a randomly-named temporary file is created
1570** and used as the file to be cached. The file will be deleted
1571** automatically when it is closed.
drh90f5ecb2004-07-22 01:19:35 +00001572**
1573** If zFilename is ":memory:" then all information is held in cache.
1574** It is never written to disk. This can be used to implement an
1575** in-memory database.
drhed7c8552001-04-11 14:29:21 +00001576*/
drh3aac2dd2004-04-26 14:10:20 +00001577int sqlite3pager_open(
drh7e3b0a02001-04-28 16:52:40 +00001578 Pager **ppPager, /* Return the Pager structure here */
1579 const char *zFilename, /* Name of the database file to open */
drhda47d772002-12-02 04:25:19 +00001580 int nExtra, /* Extra bytes append to each in-memory page */
drh7bec5052005-02-06 02:45:41 +00001581 int flags /* flags controlling this file */
drh7e3b0a02001-04-28 16:52:40 +00001582){
drhed7c8552001-04-11 14:29:21 +00001583 Pager *pPager;
danielk19778def5ea2004-06-16 10:39:52 +00001584 char *zFullPathname = 0;
drhed7c8552001-04-11 14:29:21 +00001585 int nameLen;
drh8cfbf082001-09-19 13:22:39 +00001586 OsFile fd;
danielk1977cfe9a692004-06-16 12:00:29 +00001587 int rc = SQLITE_OK;
1588 int i;
danielk19778def5ea2004-06-16 10:39:52 +00001589 int tempFile = 0;
drhac69b052004-05-12 13:30:07 +00001590 int memDb = 0;
drh5e00f6c2001-09-13 13:46:56 +00001591 int readOnly = 0;
drh7bec5052005-02-06 02:45:41 +00001592 int useJournal = (flags & PAGER_OMIT_JOURNAL)==0;
1593 int noReadlock = (flags & PAGER_NO_READLOCK)!=0;
drh8cfbf082001-09-19 13:22:39 +00001594 char zTemp[SQLITE_TEMPNAME_SIZE];
drhed7c8552001-04-11 14:29:21 +00001595
drhd9b02572001-04-15 00:37:09 +00001596 *ppPager = 0;
drhda71ce12004-06-21 18:14:45 +00001597 memset(&fd, 0, sizeof(fd));
danielk19776f8a5032004-05-10 10:34:51 +00001598 if( sqlite3_malloc_failed ){
drhd9b02572001-04-15 00:37:09 +00001599 return SQLITE_NOMEM;
1600 }
drh901afd42003-08-26 11:25:58 +00001601 if( zFilename && zFilename[0] ){
drhb7f91642004-10-31 02:22:47 +00001602#ifndef SQLITE_OMIT_MEMORYDB
drhac69b052004-05-12 13:30:07 +00001603 if( strcmp(zFilename,":memory:")==0 ){
1604 memDb = 1;
drhda71ce12004-06-21 18:14:45 +00001605 zFullPathname = sqliteStrDup("");
drhac69b052004-05-12 13:30:07 +00001606 rc = SQLITE_OK;
drhb7f91642004-10-31 02:22:47 +00001607 }else
1608#endif
1609 {
drhac69b052004-05-12 13:30:07 +00001610 zFullPathname = sqlite3OsFullPathname(zFilename);
danielk19778def5ea2004-06-16 10:39:52 +00001611 if( zFullPathname ){
1612 rc = sqlite3OsOpenReadWrite(zFullPathname, &fd, &readOnly);
1613 }
drhac69b052004-05-12 13:30:07 +00001614 }
drh5e00f6c2001-09-13 13:46:56 +00001615 }else{
drh3aac2dd2004-04-26 14:10:20 +00001616 rc = sqlite3pager_opentemp(zTemp, &fd);
drh5e00f6c2001-09-13 13:46:56 +00001617 zFilename = zTemp;
danielk19774adee202004-05-08 08:23:19 +00001618 zFullPathname = sqlite3OsFullPathname(zFilename);
danielk19778def5ea2004-06-16 10:39:52 +00001619 if( rc==SQLITE_OK ){
1620 tempFile = 1;
1621 }
drh5e00f6c2001-09-13 13:46:56 +00001622 }
danielk19778def5ea2004-06-16 10:39:52 +00001623 if( !zFullPathname ){
danielk1977b5548a82004-06-26 13:51:33 +00001624 sqlite3OsClose(&fd);
drh3e7a6092002-12-07 21:45:14 +00001625 return SQLITE_NOMEM;
1626 }
drh8cfbf082001-09-19 13:22:39 +00001627 if( rc!=SQLITE_OK ){
drhda71ce12004-06-21 18:14:45 +00001628 sqlite3OsClose(&fd);
1629 sqliteFree(zFullPathname);
danielk19778def5ea2004-06-16 10:39:52 +00001630 return rc;
drhed7c8552001-04-11 14:29:21 +00001631 }
drh3e7a6092002-12-07 21:45:14 +00001632 nameLen = strlen(zFullPathname);
drha76c82e2003-07-27 18:59:42 +00001633 pPager = sqliteMalloc( sizeof(*pPager) + nameLen*3 + 30 );
drhd9b02572001-04-15 00:37:09 +00001634 if( pPager==0 ){
drhda71ce12004-06-21 18:14:45 +00001635 sqlite3OsClose(&fd);
1636 sqliteFree(zFullPathname);
drhd9b02572001-04-15 00:37:09 +00001637 return SQLITE_NOMEM;
1638 }
danielk1977ef73ee92004-11-06 12:26:07 +00001639 TRACE3("OPEN %d %s\n", FILEHANDLEID(fd), zFullPathname);
drhed7c8552001-04-11 14:29:21 +00001640 pPager->zFilename = (char*)&pPager[1];
drha76c82e2003-07-27 18:59:42 +00001641 pPager->zDirectory = &pPager->zFilename[nameLen+1];
1642 pPager->zJournal = &pPager->zDirectory[nameLen+1];
drh3e7a6092002-12-07 21:45:14 +00001643 strcpy(pPager->zFilename, zFullPathname);
drha76c82e2003-07-27 18:59:42 +00001644 strcpy(pPager->zDirectory, zFullPathname);
1645 for(i=nameLen; i>0 && pPager->zDirectory[i-1]!='/'; i--){}
1646 if( i>0 ) pPager->zDirectory[i-1] = 0;
drh3e7a6092002-12-07 21:45:14 +00001647 strcpy(pPager->zJournal, zFullPathname);
1648 sqliteFree(zFullPathname);
drhed7c8552001-04-11 14:29:21 +00001649 strcpy(&pPager->zJournal[nameLen], "-journal");
1650 pPager->fd = fd;
drh6d08b4d2004-07-20 12:45:22 +00001651#if OS_UNIX
drhd5b447d2004-07-19 22:08:09 +00001652 pPager->fd.pPager = pPager;
drh6d08b4d2004-07-20 12:45:22 +00001653#endif
drh8cfbf082001-09-19 13:22:39 +00001654 pPager->journalOpen = 0;
drhac69b052004-05-12 13:30:07 +00001655 pPager->useJournal = useJournal && !memDb;
drh7bec5052005-02-06 02:45:41 +00001656 pPager->noReadlock = noReadlock && readOnly;
drhac69b052004-05-12 13:30:07 +00001657 pPager->stmtOpen = 0;
1658 pPager->stmtInUse = 0;
drhed7c8552001-04-11 14:29:21 +00001659 pPager->nRef = 0;
drhac69b052004-05-12 13:30:07 +00001660 pPager->dbSize = memDb-1;
drh90f5ecb2004-07-22 01:19:35 +00001661 pPager->pageSize = SQLITE_DEFAULT_PAGE_SIZE;
drhac69b052004-05-12 13:30:07 +00001662 pPager->stmtSize = 0;
1663 pPager->stmtJSize = 0;
drhed7c8552001-04-11 14:29:21 +00001664 pPager->nPage = 0;
danielk1977e94ddc92005-03-21 03:53:38 +00001665 pPager->nMaxPage = 0;
drh90f5ecb2004-07-22 01:19:35 +00001666 pPager->mxPage = 100;
drha6abd042004-06-09 17:37:22 +00001667 pPager->state = PAGER_UNLOCK;
drhd9b02572001-04-15 00:37:09 +00001668 pPager->errMask = 0;
drh5e00f6c2001-09-13 13:46:56 +00001669 pPager->tempFile = tempFile;
drhac69b052004-05-12 13:30:07 +00001670 pPager->memDb = memDb;
drh5e00f6c2001-09-13 13:46:56 +00001671 pPager->readOnly = readOnly;
drhf57b14a2001-09-14 18:54:08 +00001672 pPager->needSync = 0;
drhda47d772002-12-02 04:25:19 +00001673 pPager->noSync = pPager->tempFile || !useJournal;
danielk197775edc162004-06-26 01:48:18 +00001674 pPager->fullSync = (pPager->noSync?0:1);
drhed7c8552001-04-11 14:29:21 +00001675 pPager->pFirst = 0;
drh341eae82003-01-21 02:39:36 +00001676 pPager->pFirstSynced = 0;
drhed7c8552001-04-11 14:29:21 +00001677 pPager->pLast = 0;
drh887dc4c2004-10-22 16:22:57 +00001678 pPager->nExtra = FORCE_ALIGNMENT(nExtra);
danielk197776572402004-06-25 02:38:54 +00001679 pPager->sectorSize = PAGER_SECTOR_SIZE;
drh90f5ecb2004-07-22 01:19:35 +00001680 pPager->pBusyHandler = 0;
drhed7c8552001-04-11 14:29:21 +00001681 memset(pPager->aHash, 0, sizeof(pPager->aHash));
1682 *ppPager = pPager;
1683 return SQLITE_OK;
1684}
1685
1686/*
drh90f5ecb2004-07-22 01:19:35 +00001687** Set the busy handler function.
1688*/
1689void sqlite3pager_set_busyhandler(Pager *pPager, BusyHandler *pBusyHandler){
1690 pPager->pBusyHandler = pBusyHandler;
1691}
1692
1693/*
drh72f82862001-05-24 21:06:34 +00001694** Set the destructor for this pager. If not NULL, the destructor is called
drh5e00f6c2001-09-13 13:46:56 +00001695** when the reference count on each page reaches zero. The destructor can
1696** be used to clean up information in the extra segment appended to each page.
drh72f82862001-05-24 21:06:34 +00001697**
drh3aac2dd2004-04-26 14:10:20 +00001698** The destructor is not called as a result sqlite3pager_close().
1699** Destructors are only called by sqlite3pager_unref().
drh72f82862001-05-24 21:06:34 +00001700*/
drhb6f41482004-05-14 01:58:11 +00001701void sqlite3pager_set_destructor(Pager *pPager, void (*xDesc)(void*,int)){
drh72f82862001-05-24 21:06:34 +00001702 pPager->xDestructor = xDesc;
1703}
1704
1705/*
drha6abd042004-06-09 17:37:22 +00001706** Set the reinitializer for this pager. If not NULL, the reinitializer
1707** is called when the content of a page in cache is restored to its original
1708** value as a result of a rollback. The callback gives higher-level code
1709** an opportunity to restore the EXTRA section to agree with the restored
1710** page data.
1711*/
1712void sqlite3pager_set_reiniter(Pager *pPager, void (*xReinit)(void*,int)){
1713 pPager->xReiniter = xReinit;
1714}
1715
1716/*
drh1c7880e2005-05-20 20:01:55 +00001717** Set the page size. Return the new size. If the suggest new page
1718** size is inappropriate, then an alternative page size is selected
1719** and returned.
drh90f5ecb2004-07-22 01:19:35 +00001720*/
drh1c7880e2005-05-20 20:01:55 +00001721int sqlite3pager_set_pagesize(Pager *pPager, int pageSize){
drh90f5ecb2004-07-22 01:19:35 +00001722 assert( pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE );
drh1c7880e2005-05-20 20:01:55 +00001723 if( !pPager->memDb ){
1724 pPager->pageSize = pageSize;
1725 }
1726 return pPager->pageSize;
drh90f5ecb2004-07-22 01:19:35 +00001727}
1728
1729/*
1730** Read the first N bytes from the beginning of the file into memory
1731** that pDest points to. No error checking is done.
1732*/
1733void sqlite3pager_read_fileheader(Pager *pPager, int N, unsigned char *pDest){
1734 memset(pDest, 0, N);
drhb7f91642004-10-31 02:22:47 +00001735 if( MEMDB==0 ){
drh90f5ecb2004-07-22 01:19:35 +00001736 sqlite3OsSeek(&pPager->fd, 0);
1737 sqlite3OsRead(&pPager->fd, pDest, N);
1738 }
1739}
1740
1741/*
drh5e00f6c2001-09-13 13:46:56 +00001742** Return the total number of pages in the disk file associated with
1743** pPager.
drhed7c8552001-04-11 14:29:21 +00001744*/
drh3aac2dd2004-04-26 14:10:20 +00001745int sqlite3pager_pagecount(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001746 i64 n;
drhd9b02572001-04-15 00:37:09 +00001747 assert( pPager!=0 );
drhed7c8552001-04-11 14:29:21 +00001748 if( pPager->dbSize>=0 ){
1749 return pPager->dbSize;
1750 }
danielk19774adee202004-05-08 08:23:19 +00001751 if( sqlite3OsFileSize(&pPager->fd, &n)!=SQLITE_OK ){
drh81a20f22001-10-12 17:30:04 +00001752 pPager->errMask |= PAGER_ERR_DISK;
drh8cfbf082001-09-19 13:22:39 +00001753 return 0;
drhed7c8552001-04-11 14:29:21 +00001754 }
drh90f5ecb2004-07-22 01:19:35 +00001755 n /= pPager->pageSize;
drhb7f91642004-10-31 02:22:47 +00001756 if( !MEMDB && n==PENDING_BYTE/pPager->pageSize ){
drh1f595712004-06-15 01:40:29 +00001757 n++;
1758 }
drha6abd042004-06-09 17:37:22 +00001759 if( pPager->state!=PAGER_UNLOCK ){
drhed7c8552001-04-11 14:29:21 +00001760 pPager->dbSize = n;
1761 }
1762 return n;
1763}
1764
1765/*
drhf7c57532003-04-25 13:22:51 +00001766** Forward declaration
1767*/
danielk197776572402004-06-25 02:38:54 +00001768static int syncJournal(Pager*);
drhf7c57532003-04-25 13:22:51 +00001769
drhac69b052004-05-12 13:30:07 +00001770
1771/*
danielk1977f5fdda82004-11-03 08:44:05 +00001772** Unlink pPg from it's hash chain. Also set the page number to 0 to indicate
1773** that the page is not part of any hash chain. This is required because the
1774** sqlite3pager_movepage() routine can leave a page in the
1775** pNextFree/pPrevFree list that is not a part of any hash-chain.
1776*/
1777static void unlinkHashChain(Pager *pPager, PgHdr *pPg){
1778 if( pPg->pgno==0 ){
1779 /* If the page number is zero, then this page is not in any hash chain. */
1780 return;
1781 }
1782 if( pPg->pNextHash ){
1783 pPg->pNextHash->pPrevHash = pPg->pPrevHash;
1784 }
1785 if( pPg->pPrevHash ){
1786 assert( pPager->aHash[pager_hash(pPg->pgno)]!=pPg );
1787 pPg->pPrevHash->pNextHash = pPg->pNextHash;
1788 }else{
1789 int h = pager_hash(pPg->pgno);
1790 assert( pPager->aHash[h]==pPg );
1791 pPager->aHash[h] = pPg->pNextHash;
1792 }
1793
1794 pPg->pgno = 0;
1795 pPg->pNextHash = pPg->pPrevHash = 0;
1796}
1797
1798/*
drhac69b052004-05-12 13:30:07 +00001799** Unlink a page from the free list (the list of all pages where nRef==0)
1800** and from its hash collision chain.
1801*/
1802static void unlinkPage(PgHdr *pPg){
1803 Pager *pPager = pPg->pPager;
1804
1805 /* Keep the pFirstSynced pointer pointing at the first synchronized page */
1806 if( pPg==pPager->pFirstSynced ){
1807 PgHdr *p = pPg->pNextFree;
1808 while( p && p->needSync ){ p = p->pNextFree; }
1809 pPager->pFirstSynced = p;
1810 }
1811
1812 /* Unlink from the freelist */
1813 if( pPg->pPrevFree ){
1814 pPg->pPrevFree->pNextFree = pPg->pNextFree;
1815 }else{
1816 assert( pPager->pFirst==pPg );
1817 pPager->pFirst = pPg->pNextFree;
1818 }
1819 if( pPg->pNextFree ){
1820 pPg->pNextFree->pPrevFree = pPg->pPrevFree;
1821 }else{
1822 assert( pPager->pLast==pPg );
1823 pPager->pLast = pPg->pPrevFree;
1824 }
1825 pPg->pNextFree = pPg->pPrevFree = 0;
1826
1827 /* Unlink from the pgno hash table */
danielk1977f5fdda82004-11-03 08:44:05 +00001828 unlinkHashChain(pPager, pPg);
drhac69b052004-05-12 13:30:07 +00001829}
1830
danielk1977b84f96f2005-01-20 11:32:23 +00001831#ifndef SQLITE_OMIT_MEMORYDB
drhac69b052004-05-12 13:30:07 +00001832/*
1833** This routine is used to truncate an in-memory database. Delete
danielk1977369f27e2004-06-15 11:40:04 +00001834** all pages whose pgno is larger than pPager->dbSize and is unreferenced.
drhac69b052004-05-12 13:30:07 +00001835** Referenced pages larger than pPager->dbSize are zeroed.
1836*/
1837static void memoryTruncate(Pager *pPager){
1838 PgHdr *pPg;
1839 PgHdr **ppPg;
1840 int dbSize = pPager->dbSize;
1841
1842 ppPg = &pPager->pAll;
1843 while( (pPg = *ppPg)!=0 ){
1844 if( pPg->pgno<=dbSize ){
1845 ppPg = &pPg->pNextAll;
1846 }else if( pPg->nRef>0 ){
1847 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
1848 ppPg = &pPg->pNextAll;
1849 }else{
1850 *ppPg = pPg->pNextAll;
1851 unlinkPage(pPg);
1852 sqliteFree(pPg);
1853 pPager->nPage--;
1854 }
1855 }
1856}
danielk1977b84f96f2005-01-20 11:32:23 +00001857#else
1858#define memoryTruncate(p)
1859#endif
drhac69b052004-05-12 13:30:07 +00001860
drhf7c57532003-04-25 13:22:51 +00001861/*
danielk197717221812005-02-15 03:38:05 +00001862** Try to obtain a lock on a file. Invoke the busy callback if the lock
1863** is currently not available. Repeate until the busy callback returns
1864** false or until the lock succeeds.
1865**
1866** Return SQLITE_OK on success and an error code if we cannot obtain
1867** the lock.
1868*/
1869static int pager_wait_on_lock(Pager *pPager, int locktype){
1870 int rc;
1871 assert( PAGER_SHARED==SHARED_LOCK );
1872 assert( PAGER_RESERVED==RESERVED_LOCK );
1873 assert( PAGER_EXCLUSIVE==EXCLUSIVE_LOCK );
1874 if( pPager->state>=locktype ){
1875 rc = SQLITE_OK;
1876 }else{
1877 int busy = 1;
drhb8ef32c2005-03-14 02:01:49 +00001878 BusyHandler *pH;
danielk197717221812005-02-15 03:38:05 +00001879 do {
1880 rc = sqlite3OsLock(&pPager->fd, locktype);
1881 }while( rc==SQLITE_BUSY &&
drhb8ef32c2005-03-14 02:01:49 +00001882 (pH = pPager->pBusyHandler)!=0 &&
1883 pH->xFunc && pH->xFunc(pH->pArg, busy++)
danielk197717221812005-02-15 03:38:05 +00001884 );
1885 if( rc==SQLITE_OK ){
1886 pPager->state = locktype;
1887 }
1888 }
1889 return rc;
1890}
1891
1892/*
drhf7c57532003-04-25 13:22:51 +00001893** Truncate the file to the number of pages specified.
1894*/
drh3aac2dd2004-04-26 14:10:20 +00001895int sqlite3pager_truncate(Pager *pPager, Pgno nPage){
drhf7c57532003-04-25 13:22:51 +00001896 int rc;
drhdc3ff9c2004-08-18 02:10:15 +00001897 sqlite3pager_pagecount(pPager);
drh2e6d11b2003-04-25 15:37:57 +00001898 if( pPager->errMask!=0 ){
1899 rc = pager_errcode(pPager);
1900 return rc;
1901 }
drh7d02cb72003-06-04 16:24:39 +00001902 if( nPage>=(unsigned)pPager->dbSize ){
drhf7c57532003-04-25 13:22:51 +00001903 return SQLITE_OK;
1904 }
drhb7f91642004-10-31 02:22:47 +00001905 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00001906 pPager->dbSize = nPage;
1907 memoryTruncate(pPager);
1908 return SQLITE_OK;
1909 }
danielk197776572402004-06-25 02:38:54 +00001910 rc = syncJournal(pPager);
danielk1977369f27e2004-06-15 11:40:04 +00001911 if( rc!=SQLITE_OK ){
1912 return rc;
1913 }
danielk197717221812005-02-15 03:38:05 +00001914
1915 /* Get an exclusive lock on the database before truncating. */
1916 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
1917 if( rc!=SQLITE_OK ){
1918 return rc;
1919 }
1920
drhcb4c40b2004-08-18 19:09:43 +00001921 rc = pager_truncate(pPager, nPage);
drhf7c57532003-04-25 13:22:51 +00001922 if( rc==SQLITE_OK ){
1923 pPager->dbSize = nPage;
1924 }
1925 return rc;
1926}
1927
1928/*
drhed7c8552001-04-11 14:29:21 +00001929** Shutdown the page cache. Free all memory and close all files.
1930**
1931** If a transaction was in progress when this routine is called, that
1932** transaction is rolled back. All outstanding pages are invalidated
1933** and their memory is freed. Any attempt to use a page associated
1934** with this page cache after this function returns will likely
1935** result in a coredump.
1936*/
drh3aac2dd2004-04-26 14:10:20 +00001937int sqlite3pager_close(Pager *pPager){
drhd9b02572001-04-15 00:37:09 +00001938 PgHdr *pPg, *pNext;
drhed7c8552001-04-11 14:29:21 +00001939 switch( pPager->state ){
drha6abd042004-06-09 17:37:22 +00001940 case PAGER_RESERVED:
danielk1977aa5ccdf2004-06-14 05:10:42 +00001941 case PAGER_SYNCED:
drha6abd042004-06-09 17:37:22 +00001942 case PAGER_EXCLUSIVE: {
danielk1977b3bce662005-01-29 08:32:43 +00001943 /* We ignore any IO errors that occur during the rollback
1944 ** operation. So disable IO error simulation so that testing
1945 ** works more easily.
1946 */
1947#if defined(SQLITE_TEST) && (defined(OS_UNIX) || defined(OS_WIN))
1948 extern int sqlite3_io_error_pending;
1949 int ioerr_cnt = sqlite3_io_error_pending;
1950 sqlite3_io_error_pending = -1;
1951#endif
drh3aac2dd2004-04-26 14:10:20 +00001952 sqlite3pager_rollback(pPager);
danielk1977b3bce662005-01-29 08:32:43 +00001953#if defined(SQLITE_TEST) && (defined(OS_UNIX) || defined(OS_WIN))
1954 sqlite3_io_error_pending = ioerr_cnt;
1955#endif
drhb7f91642004-10-31 02:22:47 +00001956 if( !MEMDB ){
drha6abd042004-06-09 17:37:22 +00001957 sqlite3OsUnlock(&pPager->fd, NO_LOCK);
drhac69b052004-05-12 13:30:07 +00001958 }
danielk1977e94ddc92005-03-21 03:53:38 +00001959 assert( pPager->errMask || pPager->journalOpen==0 );
drhed7c8552001-04-11 14:29:21 +00001960 break;
1961 }
drha6abd042004-06-09 17:37:22 +00001962 case PAGER_SHARED: {
drhb7f91642004-10-31 02:22:47 +00001963 if( !MEMDB ){
drha6abd042004-06-09 17:37:22 +00001964 sqlite3OsUnlock(&pPager->fd, NO_LOCK);
drhac69b052004-05-12 13:30:07 +00001965 }
drhed7c8552001-04-11 14:29:21 +00001966 break;
1967 }
1968 default: {
1969 /* Do nothing */
1970 break;
1971 }
1972 }
drhd9b02572001-04-15 00:37:09 +00001973 for(pPg=pPager->pAll; pPg; pPg=pNext){
danielk1977eac7a362004-06-16 07:45:24 +00001974#ifndef NDEBUG
drhb7f91642004-10-31 02:22:47 +00001975 if( MEMDB ){
danielk1977eac7a362004-06-16 07:45:24 +00001976 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
1977 assert( !pPg->alwaysRollback );
1978 assert( !pHist->pOrig );
1979 assert( !pHist->pStmt );
1980 }
1981#endif
drhd9b02572001-04-15 00:37:09 +00001982 pNext = pPg->pNextAll;
1983 sqliteFree(pPg);
drhed7c8552001-04-11 14:29:21 +00001984 }
danielk1977ef73ee92004-11-06 12:26:07 +00001985 TRACE2("CLOSE %d\n", PAGERID(pPager));
danielk1977e94ddc92005-03-21 03:53:38 +00001986 assert( pPager->errMask || (pPager->journalOpen==0 && pPager->stmtOpen==0) );
1987 if( pPager->journalOpen ){
1988 sqlite3OsClose(&pPager->jfd);
1989 }
drh88b01a12005-03-28 18:04:27 +00001990 sqliteFree(pPager->aInJournal);
danielk1977e94ddc92005-03-21 03:53:38 +00001991 if( pPager->stmtOpen ){
1992 sqlite3OsClose(&pPager->stfd);
1993 }
drhda71ce12004-06-21 18:14:45 +00001994 sqlite3OsClose(&pPager->fd);
drh0f892532002-05-30 12:27:03 +00001995 /* Temp files are automatically deleted by the OS
1996 ** if( pPager->tempFile ){
danielk19774adee202004-05-08 08:23:19 +00001997 ** sqlite3OsDelete(pPager->zFilename);
drh0f892532002-05-30 12:27:03 +00001998 ** }
1999 */
danielk1977aca790a2005-01-13 11:07:52 +00002000
drhed7c8552001-04-11 14:29:21 +00002001 sqliteFree(pPager);
2002 return SQLITE_OK;
2003}
2004
2005/*
drh5e00f6c2001-09-13 13:46:56 +00002006** Return the page number for the given page data.
drhed7c8552001-04-11 14:29:21 +00002007*/
drh3aac2dd2004-04-26 14:10:20 +00002008Pgno sqlite3pager_pagenumber(void *pData){
drhed7c8552001-04-11 14:29:21 +00002009 PgHdr *p = DATA_TO_PGHDR(pData);
2010 return p->pgno;
2011}
2012
2013/*
drhc8629a12004-05-08 20:07:40 +00002014** The page_ref() function increments the reference count for a page.
2015** If the page is currently on the freelist (the reference count is zero) then
drh7e3b0a02001-04-28 16:52:40 +00002016** remove it from the freelist.
drhc8629a12004-05-08 20:07:40 +00002017**
2018** For non-test systems, page_ref() is a macro that calls _page_ref()
2019** online of the reference count is zero. For test systems, page_ref()
2020** is a real function so that we can set breakpoints and trace it.
drh7e3b0a02001-04-28 16:52:40 +00002021*/
drh836faa42003-01-11 13:30:57 +00002022static void _page_ref(PgHdr *pPg){
drh7e3b0a02001-04-28 16:52:40 +00002023 if( pPg->nRef==0 ){
2024 /* The page is currently on the freelist. Remove it. */
drh341eae82003-01-21 02:39:36 +00002025 if( pPg==pPg->pPager->pFirstSynced ){
2026 PgHdr *p = pPg->pNextFree;
2027 while( p && p->needSync ){ p = p->pNextFree; }
2028 pPg->pPager->pFirstSynced = p;
2029 }
drh7e3b0a02001-04-28 16:52:40 +00002030 if( pPg->pPrevFree ){
2031 pPg->pPrevFree->pNextFree = pPg->pNextFree;
2032 }else{
2033 pPg->pPager->pFirst = pPg->pNextFree;
2034 }
2035 if( pPg->pNextFree ){
2036 pPg->pNextFree->pPrevFree = pPg->pPrevFree;
2037 }else{
2038 pPg->pPager->pLast = pPg->pPrevFree;
2039 }
2040 pPg->pPager->nRef++;
2041 }
2042 pPg->nRef++;
drhdd793422001-06-28 01:54:48 +00002043 REFINFO(pPg);
drhdf0b3b02001-06-23 11:36:20 +00002044}
danielk1977aca790a2005-01-13 11:07:52 +00002045#ifdef SQLITE_DEBUG
drhc8629a12004-05-08 20:07:40 +00002046 static void page_ref(PgHdr *pPg){
2047 if( pPg->nRef==0 ){
2048 _page_ref(pPg);
2049 }else{
2050 pPg->nRef++;
2051 REFINFO(pPg);
2052 }
2053 }
2054#else
2055# define page_ref(P) ((P)->nRef==0?_page_ref(P):(void)(P)->nRef++)
2056#endif
drhdf0b3b02001-06-23 11:36:20 +00002057
2058/*
2059** Increment the reference count for a page. The input pointer is
2060** a reference to the page data.
2061*/
drh3aac2dd2004-04-26 14:10:20 +00002062int sqlite3pager_ref(void *pData){
drhdf0b3b02001-06-23 11:36:20 +00002063 PgHdr *pPg = DATA_TO_PGHDR(pData);
2064 page_ref(pPg);
drh8c42ca92001-06-22 19:15:00 +00002065 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +00002066}
2067
2068/*
drh34e79ce2004-02-08 06:05:46 +00002069** Sync the journal. In other words, make sure all the pages that have
2070** been written to the journal have actually reached the surface of the
2071** disk. It is not safe to modify the original database file until after
2072** the journal has been synced. If the original database is modified before
2073** the journal is synced and a power failure occurs, the unsynced journal
2074** data would be lost and we would be unable to completely rollback the
2075** database changes. Database corruption would occur.
2076**
2077** This routine also updates the nRec field in the header of the journal.
2078** (See comments on the pager_playback() routine for additional information.)
2079** If the sync mode is FULL, two syncs will occur. First the whole journal
2080** is synced, then the nRec field is updated, then a second sync occurs.
drhb19a2bc2001-09-16 00:13:26 +00002081**
drh34e79ce2004-02-08 06:05:46 +00002082** For temporary databases, we do not care if we are able to rollback
2083** after a power failure, so sync occurs.
drhfa86c412002-02-02 15:01:15 +00002084**
drh34e79ce2004-02-08 06:05:46 +00002085** This routine clears the needSync field of every page current held in
2086** memory.
drh50e5dad2001-09-15 00:57:28 +00002087*/
danielk197776572402004-06-25 02:38:54 +00002088static int syncJournal(Pager *pPager){
drh50e5dad2001-09-15 00:57:28 +00002089 PgHdr *pPg;
2090 int rc = SQLITE_OK;
drh03eb96a2002-11-10 23:32:56 +00002091
2092 /* Sync the journal before modifying the main database
2093 ** (assuming there is a journal and it needs to be synced.)
2094 */
danielk197776572402004-06-25 02:38:54 +00002095 if( pPager->needSync ){
drhfa86c412002-02-02 15:01:15 +00002096 if( !pPager->tempFile ){
drhdb48ee02003-01-16 13:42:43 +00002097 assert( pPager->journalOpen );
drh946966f2004-02-25 02:20:41 +00002098 /* assert( !pPager->noSync ); // noSync might be set if synchronous
2099 ** was turned off after the transaction was started. Ticket #615 */
drh968af522003-02-11 14:55:40 +00002100#ifndef NDEBUG
2101 {
drh34e79ce2004-02-08 06:05:46 +00002102 /* Make sure the pPager->nRec counter we are keeping agrees
2103 ** with the nRec computed from the size of the journal file.
2104 */
drheb206252004-10-01 02:00:31 +00002105 i64 jSz;
danielk19774adee202004-05-08 08:23:19 +00002106 rc = sqlite3OsFileSize(&pPager->jfd, &jSz);
drh968af522003-02-11 14:55:40 +00002107 if( rc!=0 ) return rc;
danielk197776572402004-06-25 02:38:54 +00002108 assert( pPager->journalOff==jSz );
drh968af522003-02-11 14:55:40 +00002109 }
2110#endif
drhae2b40c2004-06-09 19:03:54 +00002111 {
danielk197776572402004-06-25 02:38:54 +00002112 /* Write the nRec value into the journal file header. If in
2113 ** full-synchronous mode, sync the journal first. This ensures that
2114 ** all data has really hit the disk before nRec is updated to mark
2115 ** it as a candidate for rollback.
2116 */
drhd8d66e82003-02-12 02:10:15 +00002117 if( pPager->fullSync ){
danielk1977ef73ee92004-11-06 12:26:07 +00002118 TRACE2("SYNC journal of %d\n", PAGERID(pPager));
danielk19774adee202004-05-08 08:23:19 +00002119 rc = sqlite3OsSync(&pPager->jfd);
drhd8d66e82003-02-12 02:10:15 +00002120 if( rc!=0 ) return rc;
2121 }
danielk197776572402004-06-25 02:38:54 +00002122 sqlite3OsSeek(&pPager->jfd, pPager->journalHdr + sizeof(aJournalMagic));
drh99ee3602003-02-16 19:13:36 +00002123 rc = write32bits(&pPager->jfd, pPager->nRec);
2124 if( rc ) return rc;
danielk197713adf8a2004-06-03 16:08:41 +00002125
danielk197776572402004-06-25 02:38:54 +00002126 sqlite3OsSeek(&pPager->jfd, pPager->journalOff);
drh968af522003-02-11 14:55:40 +00002127 }
danielk1977ef73ee92004-11-06 12:26:07 +00002128 TRACE2("SYNC journal of %d\n", PAGERID(pPager));
danielk19774adee202004-05-08 08:23:19 +00002129 rc = sqlite3OsSync(&pPager->jfd);
drhfa86c412002-02-02 15:01:15 +00002130 if( rc!=0 ) return rc;
drhdb48ee02003-01-16 13:42:43 +00002131 pPager->journalStarted = 1;
drhfa86c412002-02-02 15:01:15 +00002132 }
drh50e5dad2001-09-15 00:57:28 +00002133 pPager->needSync = 0;
drh341eae82003-01-21 02:39:36 +00002134
2135 /* Erase the needSync flag from every page.
2136 */
2137 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2138 pPg->needSync = 0;
2139 }
2140 pPager->pFirstSynced = pPager->pFirst;
drh50e5dad2001-09-15 00:57:28 +00002141 }
drh03eb96a2002-11-10 23:32:56 +00002142
drh341eae82003-01-21 02:39:36 +00002143#ifndef NDEBUG
2144 /* If the Pager.needSync flag is clear then the PgHdr.needSync
2145 ** flag must also be clear for all pages. Verify that this
2146 ** invariant is true.
drh03eb96a2002-11-10 23:32:56 +00002147 */
drh341eae82003-01-21 02:39:36 +00002148 else{
2149 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2150 assert( pPg->needSync==0 );
2151 }
2152 assert( pPager->pFirstSynced==pPager->pFirst );
drh03eb96a2002-11-10 23:32:56 +00002153 }
drh341eae82003-01-21 02:39:36 +00002154#endif
drhdb48ee02003-01-16 13:42:43 +00002155
drh81a20f22001-10-12 17:30:04 +00002156 return rc;
drh50e5dad2001-09-15 00:57:28 +00002157}
2158
2159/*
drh2554f8b2003-01-22 01:26:44 +00002160** Given a list of pages (connected by the PgHdr.pDirty pointer) write
2161** every one of those pages out to the database file and mark them all
2162** as clean.
2163*/
2164static int pager_write_pagelist(PgHdr *pList){
2165 Pager *pPager;
2166 int rc;
2167
2168 if( pList==0 ) return SQLITE_OK;
2169 pPager = pList->pPager;
danielk19779eed5052004-06-04 10:38:30 +00002170
2171 /* At this point there may be either a RESERVED or EXCLUSIVE lock on the
2172 ** database file. If there is already an EXCLUSIVE lock, the following
2173 ** calls to sqlite3OsLock() are no-ops.
2174 **
drha6abd042004-06-09 17:37:22 +00002175 ** Moving the lock from RESERVED to EXCLUSIVE actually involves going
2176 ** through an intermediate state PENDING. A PENDING lock prevents new
2177 ** readers from attaching to the database but is unsufficient for us to
2178 ** write. The idea of a PENDING lock is to prevent new readers from
2179 ** coming in while we wait for existing readers to clear.
danielk19779eed5052004-06-04 10:38:30 +00002180 **
drha6abd042004-06-09 17:37:22 +00002181 ** While the pager is in the RESERVED state, the original database file
2182 ** is unchanged and we can rollback without having to playback the
2183 ** journal into the original database file. Once we transition to
2184 ** EXCLUSIVE, it means the database file has been changed and any rollback
2185 ** will require a journal playback.
danielk19779eed5052004-06-04 10:38:30 +00002186 */
drh684917c2004-10-05 02:41:42 +00002187 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
danielk19779eed5052004-06-04 10:38:30 +00002188 if( rc!=SQLITE_OK ){
2189 return rc;
2190 }
2191
drh2554f8b2003-01-22 01:26:44 +00002192 while( pList ){
2193 assert( pList->dirty );
drheb206252004-10-01 02:00:31 +00002194 sqlite3OsSeek(&pPager->fd, (pList->pgno-1)*(i64)pPager->pageSize);
danielk1977687566d2004-11-02 12:56:41 +00002195 /* If there are dirty pages in the page cache with page numbers greater
2196 ** than Pager.dbSize, this means sqlite3pager_truncate() was called to
2197 ** make the file smaller (presumably by auto-vacuum code). Do not write
2198 ** any such pages to the file.
2199 */
2200 if( pList->pgno<=pPager->dbSize ){
2201 CODEC(pPager, PGHDR_TO_DATA(pList), pList->pgno, 6);
danielk1977ef73ee92004-11-06 12:26:07 +00002202 TRACE3("STORE %d page %d\n", PAGERID(pPager), pList->pgno);
danielk1977687566d2004-11-02 12:56:41 +00002203 rc = sqlite3OsWrite(&pPager->fd, PGHDR_TO_DATA(pList), pPager->pageSize);
2204 CODEC(pPager, PGHDR_TO_DATA(pList), pList->pgno, 0);
danielk197742741be2005-01-08 12:42:39 +00002205 pPager->nWrite++;
danielk1977687566d2004-11-02 12:56:41 +00002206 }
2207#ifndef NDEBUG
2208 else{
danielk1977ef73ee92004-11-06 12:26:07 +00002209 TRACE3("NOSTORE %d page %d\n", PAGERID(pPager), pList->pgno);
danielk1977687566d2004-11-02 12:56:41 +00002210 }
2211#endif
drh2554f8b2003-01-22 01:26:44 +00002212 if( rc ) return rc;
2213 pList->dirty = 0;
danielk19773c407372005-02-15 02:54:14 +00002214#ifdef SQLITE_CHECK_PAGES
2215 pList->pageHash = pager_pagehash(pList);
2216#endif
drh2554f8b2003-01-22 01:26:44 +00002217 pList = pList->pDirty;
2218 }
2219 return SQLITE_OK;
2220}
2221
2222/*
2223** Collect every dirty page into a dirty list and
2224** return a pointer to the head of that list. All pages are
2225** collected even if they are still in use.
2226*/
2227static PgHdr *pager_get_all_dirty_pages(Pager *pPager){
2228 PgHdr *p, *pList;
2229 pList = 0;
2230 for(p=pPager->pAll; p; p=p->pNextAll){
2231 if( p->dirty ){
2232 p->pDirty = pList;
2233 pList = p;
2234 }
2235 }
2236 return pList;
2237}
2238
2239/*
drh165ffe92005-03-15 17:09:30 +00002240** Return TRUE if there is a hot journal on the given pager.
2241** A hot journal is one that needs to be played back.
2242**
2243** If the current size of the database file is 0 but a journal file
2244** exists, that is probably an old journal left over from a prior
2245** database with the same name. Just delete the journal.
2246*/
2247static int hasHotJournal(Pager *pPager){
2248 if( !pPager->useJournal ) return 0;
2249 if( !sqlite3OsFileExists(pPager->zJournal) ) return 0;
2250 if( sqlite3OsCheckReservedLock(&pPager->fd) ) return 0;
2251 if( sqlite3pager_pagecount(pPager)==0 ){
2252 sqlite3OsDelete(pPager->zJournal);
2253 return 0;
2254 }else{
2255 return 1;
2256 }
2257}
2258
2259/*
drhd9b02572001-04-15 00:37:09 +00002260** Acquire a page.
2261**
drh58a11682001-11-10 13:51:08 +00002262** A read lock on the disk file is obtained when the first page is acquired.
drh5e00f6c2001-09-13 13:46:56 +00002263** This read lock is dropped when the last page is released.
drhd9b02572001-04-15 00:37:09 +00002264**
drh306dc212001-05-21 13:45:10 +00002265** A _get works for any page number greater than 0. If the database
2266** file is smaller than the requested page, then no actual disk
2267** read occurs and the memory image of the page is initialized to
2268** all zeros. The extra data appended to a page is always initialized
2269** to zeros the first time a page is loaded into memory.
2270**
drhd9b02572001-04-15 00:37:09 +00002271** The acquisition might fail for several reasons. In all cases,
2272** an appropriate error code is returned and *ppPage is set to NULL.
drh7e3b0a02001-04-28 16:52:40 +00002273**
drh3aac2dd2004-04-26 14:10:20 +00002274** See also sqlite3pager_lookup(). Both this routine and _lookup() attempt
drh7e3b0a02001-04-28 16:52:40 +00002275** to find a page in the in-memory cache first. If the page is not already
drh5e00f6c2001-09-13 13:46:56 +00002276** in memory, this routine goes to disk to read it in whereas _lookup()
drh7e3b0a02001-04-28 16:52:40 +00002277** just returns 0. This routine acquires a read-lock the first time it
2278** has to go to disk, and could also playback an old journal if necessary.
2279** Since _lookup() never goes to disk, it never has to deal with locks
2280** or journal files.
drhed7c8552001-04-11 14:29:21 +00002281*/
drh3aac2dd2004-04-26 14:10:20 +00002282int sqlite3pager_get(Pager *pPager, Pgno pgno, void **ppPage){
drhed7c8552001-04-11 14:29:21 +00002283 PgHdr *pPg;
drh165ffe92005-03-15 17:09:30 +00002284 int rc;
drhed7c8552001-04-11 14:29:21 +00002285
danielk197726836652005-01-17 01:33:13 +00002286 /* The maximum page number is 2^31. Return SQLITE_CORRUPT if a page
2287 ** number greater than this, or zero, is requested.
2288 */
2289 if( pgno>PAGER_MAX_PGNO || pgno==0 ){
2290 return SQLITE_CORRUPT;
2291 }
2292
drhd9b02572001-04-15 00:37:09 +00002293 /* Make sure we have not hit any critical errors.
2294 */
drh836faa42003-01-11 13:30:57 +00002295 assert( pPager!=0 );
drh2e6d11b2003-04-25 15:37:57 +00002296 *ppPage = 0;
drhd9b02572001-04-15 00:37:09 +00002297 if( pPager->errMask & ~(PAGER_ERR_FULL) ){
2298 return pager_errcode(pPager);
2299 }
2300
danielk197713adf8a2004-06-03 16:08:41 +00002301 /* If this is the first page accessed, then get a SHARED lock
drhed7c8552001-04-11 14:29:21 +00002302 ** on the database file.
2303 */
drhb7f91642004-10-31 02:22:47 +00002304 if( pPager->nRef==0 && !MEMDB ){
drh7bec5052005-02-06 02:45:41 +00002305 if( !pPager->noReadlock ){
2306 rc = pager_wait_on_lock(pPager, SHARED_LOCK);
2307 if( rc!=SQLITE_OK ){
2308 return rc;
2309 }
drhed7c8552001-04-11 14:29:21 +00002310 }
2311
danielk197713adf8a2004-06-03 16:08:41 +00002312 /* If a journal file exists, and there is no RESERVED lock on the
2313 ** database file, then it either needs to be played back or deleted.
drhed7c8552001-04-11 14:29:21 +00002314 */
drh165ffe92005-03-15 17:09:30 +00002315 if( hasHotJournal(pPager) ){
drhe2227f02003-06-14 11:42:57 +00002316 int rc;
drhed7c8552001-04-11 14:29:21 +00002317
danielk197790ba3bd2004-06-25 08:32:25 +00002318 /* Get an EXCLUSIVE lock on the database file. At this point it is
2319 ** important that a RESERVED lock is not obtained on the way to the
2320 ** EXCLUSIVE lock. If it were, another process might open the
2321 ** database file, detect the RESERVED lock, and conclude that the
2322 ** database is safe to read while this process is still rolling it
2323 ** back.
2324 **
2325 ** Because the intermediate RESERVED lock is not requested, the
2326 ** second process will get to this point in the code and fail to
2327 ** obtain it's own EXCLUSIVE lock on the database file.
2328 */
danielk197713adf8a2004-06-03 16:08:41 +00002329 rc = sqlite3OsLock(&pPager->fd, EXCLUSIVE_LOCK);
drha7fcb052001-12-14 15:09:55 +00002330 if( rc!=SQLITE_OK ){
drha6abd042004-06-09 17:37:22 +00002331 sqlite3OsUnlock(&pPager->fd, NO_LOCK);
2332 pPager->state = PAGER_UNLOCK;
drh8766c342002-11-09 00:33:15 +00002333 return rc;
drha7fcb052001-12-14 15:09:55 +00002334 }
drha6abd042004-06-09 17:37:22 +00002335 pPager->state = PAGER_EXCLUSIVE;
drha7fcb052001-12-14 15:09:55 +00002336
drhe2227f02003-06-14 11:42:57 +00002337 /* Open the journal for reading only. Return SQLITE_BUSY if
2338 ** we are unable to open the journal file.
drhf57b3392001-10-08 13:22:32 +00002339 **
drhe2227f02003-06-14 11:42:57 +00002340 ** The journal file does not need to be locked itself. The
2341 ** journal file is never open unless the main database file holds
2342 ** a write lock, so there is never any chance of two or more
2343 ** processes opening the journal at the same time.
drhed7c8552001-04-11 14:29:21 +00002344 */
danielk19774adee202004-05-08 08:23:19 +00002345 rc = sqlite3OsOpenReadOnly(pPager->zJournal, &pPager->jfd);
drha7fcb052001-12-14 15:09:55 +00002346 if( rc!=SQLITE_OK ){
drha6abd042004-06-09 17:37:22 +00002347 sqlite3OsUnlock(&pPager->fd, NO_LOCK);
2348 pPager->state = PAGER_UNLOCK;
drhed7c8552001-04-11 14:29:21 +00002349 return SQLITE_BUSY;
2350 }
drha7fcb052001-12-14 15:09:55 +00002351 pPager->journalOpen = 1;
drhdb48ee02003-01-16 13:42:43 +00002352 pPager->journalStarted = 0;
danielk197776572402004-06-25 02:38:54 +00002353 pPager->journalOff = 0;
2354 pPager->setMaster = 0;
2355 pPager->journalHdr = 0;
drhed7c8552001-04-11 14:29:21 +00002356
2357 /* Playback and delete the journal. Drop the database write
2358 ** lock and reacquire the read lock.
2359 */
danielk197776572402004-06-25 02:38:54 +00002360 rc = pager_playback(pPager);
drhd9b02572001-04-15 00:37:09 +00002361 if( rc!=SQLITE_OK ){
2362 return rc;
2363 }
drhed7c8552001-04-11 14:29:21 +00002364 }
2365 pPg = 0;
2366 }else{
2367 /* Search for page in cache */
drhd9b02572001-04-15 00:37:09 +00002368 pPg = pager_lookup(pPager, pgno);
drhb7f91642004-10-31 02:22:47 +00002369 if( MEMDB && pPager->state==PAGER_UNLOCK ){
drha6abd042004-06-09 17:37:22 +00002370 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00002371 }
drhed7c8552001-04-11 14:29:21 +00002372 }
2373 if( pPg==0 ){
drhd9b02572001-04-15 00:37:09 +00002374 /* The requested page is not in the page cache. */
drhed7c8552001-04-11 14:29:21 +00002375 int h;
drh7e3b0a02001-04-28 16:52:40 +00002376 pPager->nMiss++;
drhb7f91642004-10-31 02:22:47 +00002377 if( pPager->nPage<pPager->mxPage || pPager->pFirst==0 || MEMDB ){
drhed7c8552001-04-11 14:29:21 +00002378 /* Create a new page */
drh1c7880e2005-05-20 20:01:55 +00002379 pPg = sqliteMallocRaw( sizeof(*pPg) + pPager->pageSize
drhac69b052004-05-12 13:30:07 +00002380 + sizeof(u32) + pPager->nExtra
drhb7f91642004-10-31 02:22:47 +00002381 + MEMDB*sizeof(PgHistory) );
drhd9b02572001-04-15 00:37:09 +00002382 if( pPg==0 ){
drhd9b02572001-04-15 00:37:09 +00002383 pPager->errMask |= PAGER_ERR_MEM;
2384 return SQLITE_NOMEM;
2385 }
drh8c1238a2003-01-02 14:43:55 +00002386 memset(pPg, 0, sizeof(*pPg));
drhb7f91642004-10-31 02:22:47 +00002387 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00002388 memset(PGHDR_TO_HIST(pPg, pPager), 0, sizeof(PgHistory));
2389 }
drhed7c8552001-04-11 14:29:21 +00002390 pPg->pPager = pPager;
drhd9b02572001-04-15 00:37:09 +00002391 pPg->pNextAll = pPager->pAll;
drhd79caeb2001-04-15 02:27:24 +00002392 pPager->pAll = pPg;
drhd9b02572001-04-15 00:37:09 +00002393 pPager->nPage++;
danielk1977e94ddc92005-03-21 03:53:38 +00002394 if( pPager->nPage>pPager->nMaxPage ){
2395 assert( pPager->nMaxPage==(pPager->nPage-1) );
2396 pPager->nMaxPage++;
2397 }
drhed7c8552001-04-11 14:29:21 +00002398 }else{
drhdb48ee02003-01-16 13:42:43 +00002399 /* Find a page to recycle. Try to locate a page that does not
2400 ** require us to do an fsync() on the journal.
2401 */
drh341eae82003-01-21 02:39:36 +00002402 pPg = pPager->pFirstSynced;
drhb19a2bc2001-09-16 00:13:26 +00002403
drhdb48ee02003-01-16 13:42:43 +00002404 /* If we could not find a page that does not require an fsync()
2405 ** on the journal file then fsync the journal file. This is a
2406 ** very slow operation, so we work hard to avoid it. But sometimes
2407 ** it can't be helped.
drhb19a2bc2001-09-16 00:13:26 +00002408 */
drh603240c2002-03-05 01:11:12 +00002409 if( pPg==0 ){
danielk197776572402004-06-25 02:38:54 +00002410 int rc = syncJournal(pPager);
drh50e5dad2001-09-15 00:57:28 +00002411 if( rc!=0 ){
drh3aac2dd2004-04-26 14:10:20 +00002412 sqlite3pager_rollback(pPager);
drh50e5dad2001-09-15 00:57:28 +00002413 return SQLITE_IOERR;
2414 }
danielk197776572402004-06-25 02:38:54 +00002415 if( pPager->fullSync ){
2416 /* If in full-sync mode, write a new journal header into the
2417 ** journal file. This is done to avoid ever modifying a journal
2418 ** header that is involved in the rollback of pages that have
2419 ** already been written to the database (in case the header is
2420 ** trashed when the nRec field is updated).
2421 */
2422 pPager->nRec = 0;
danielk1977f187bd92004-06-25 06:23:22 +00002423 assert( pPager->journalOff > 0 );
danielk197776572402004-06-25 02:38:54 +00002424 rc = writeJournalHdr(pPager);
2425 if( rc!=0 ){
2426 sqlite3pager_rollback(pPager);
2427 return SQLITE_IOERR;
2428 }
2429 }
drh50e5dad2001-09-15 00:57:28 +00002430 pPg = pPager->pFirst;
2431 }
drhd9b02572001-04-15 00:37:09 +00002432 assert( pPg->nRef==0 );
drhdb48ee02003-01-16 13:42:43 +00002433
2434 /* Write the page to the database file if it is dirty.
2435 */
2436 if( pPg->dirty ){
2437 assert( pPg->needSync==0 );
drh2554f8b2003-01-22 01:26:44 +00002438 pPg->pDirty = 0;
2439 rc = pager_write_pagelist( pPg );
drhdb48ee02003-01-16 13:42:43 +00002440 if( rc!=SQLITE_OK ){
drh3aac2dd2004-04-26 14:10:20 +00002441 sqlite3pager_rollback(pPager);
drhdb48ee02003-01-16 13:42:43 +00002442 return SQLITE_IOERR;
2443 }
drhdb48ee02003-01-16 13:42:43 +00002444 }
drh50e5dad2001-09-15 00:57:28 +00002445 assert( pPg->dirty==0 );
drhd9b02572001-04-15 00:37:09 +00002446
drhdb48ee02003-01-16 13:42:43 +00002447 /* If the page we are recycling is marked as alwaysRollback, then
drh193a6b42002-07-07 16:52:46 +00002448 ** set the global alwaysRollback flag, thus disabling the
2449 ** sqlite_dont_rollback() optimization for the rest of this transaction.
2450 ** It is necessary to do this because the page marked alwaysRollback
2451 ** might be reloaded at a later time but at that point we won't remember
2452 ** that is was marked alwaysRollback. This means that all pages must
2453 ** be marked as alwaysRollback from here on out.
2454 */
2455 if( pPg->alwaysRollback ){
2456 pPager->alwaysRollback = 1;
2457 }
2458
drhd9b02572001-04-15 00:37:09 +00002459 /* Unlink the old page from the free list and the hash table
2460 */
drhac69b052004-05-12 13:30:07 +00002461 unlinkPage(pPg);
drhd9b02572001-04-15 00:37:09 +00002462 pPager->nOvfl++;
drhed7c8552001-04-11 14:29:21 +00002463 }
2464 pPg->pgno = pgno;
drh1ab43002002-01-14 09:28:19 +00002465 if( pPager->aInJournal && (int)pgno<=pPager->origDbSize ){
danielk19774adee202004-05-08 08:23:19 +00002466 sqlite3CheckMemory(pPager->aInJournal, pgno/8);
drhdb48ee02003-01-16 13:42:43 +00002467 assert( pPager->journalOpen );
drh6019e162001-07-02 17:51:45 +00002468 pPg->inJournal = (pPager->aInJournal[pgno/8] & (1<<(pgno&7)))!=0;
drhdb48ee02003-01-16 13:42:43 +00002469 pPg->needSync = 0;
drh6019e162001-07-02 17:51:45 +00002470 }else{
2471 pPg->inJournal = 0;
drhdb48ee02003-01-16 13:42:43 +00002472 pPg->needSync = 0;
drh6019e162001-07-02 17:51:45 +00002473 }
drhac69b052004-05-12 13:30:07 +00002474 if( pPager->aInStmt && (int)pgno<=pPager->stmtSize
2475 && (pPager->aInStmt[pgno/8] & (1<<(pgno&7)))!=0 ){
drh3aac2dd2004-04-26 14:10:20 +00002476 page_add_to_stmt_list(pPg);
drhfa86c412002-02-02 15:01:15 +00002477 }else{
drh3aac2dd2004-04-26 14:10:20 +00002478 page_remove_from_stmt_list(pPg);
drhfa86c412002-02-02 15:01:15 +00002479 }
drhed7c8552001-04-11 14:29:21 +00002480 pPg->dirty = 0;
2481 pPg->nRef = 1;
drhdd793422001-06-28 01:54:48 +00002482 REFINFO(pPg);
drhd9b02572001-04-15 00:37:09 +00002483 pPager->nRef++;
2484 h = pager_hash(pgno);
drhed7c8552001-04-11 14:29:21 +00002485 pPg->pNextHash = pPager->aHash[h];
2486 pPager->aHash[h] = pPg;
2487 if( pPg->pNextHash ){
2488 assert( pPg->pNextHash->pPrevHash==0 );
2489 pPg->pNextHash->pPrevHash = pPg;
2490 }
drh2e6d11b2003-04-25 15:37:57 +00002491 if( pPager->nExtra>0 ){
drh90f5ecb2004-07-22 01:19:35 +00002492 memset(PGHDR_TO_EXTRA(pPg, pPager), 0, pPager->nExtra);
drh2e6d11b2003-04-25 15:37:57 +00002493 }
drh2e6d11b2003-04-25 15:37:57 +00002494 if( pPager->errMask!=0 ){
drh3aac2dd2004-04-26 14:10:20 +00002495 sqlite3pager_unref(PGHDR_TO_DATA(pPg));
drh2e6d11b2003-04-25 15:37:57 +00002496 rc = pager_errcode(pPager);
2497 return rc;
2498 }
drh165ffe92005-03-15 17:09:30 +00002499 if( sqlite3pager_pagecount(pPager)<(int)pgno ){
drh90f5ecb2004-07-22 01:19:35 +00002500 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
drh306dc212001-05-21 13:45:10 +00002501 }else{
drh81a20f22001-10-12 17:30:04 +00002502 int rc;
drhb7f91642004-10-31 02:22:47 +00002503 assert( MEMDB==0 );
drheb206252004-10-01 02:00:31 +00002504 sqlite3OsSeek(&pPager->fd, (pgno-1)*(i64)pPager->pageSize);
drh90f5ecb2004-07-22 01:19:35 +00002505 rc = sqlite3OsRead(&pPager->fd, PGHDR_TO_DATA(pPg), pPager->pageSize);
danielk1977ef73ee92004-11-06 12:26:07 +00002506 TRACE3("FETCH %d page %d\n", PAGERID(pPager), pPg->pgno);
drh9eb9e262004-02-11 02:18:05 +00002507 CODEC(pPager, PGHDR_TO_DATA(pPg), pPg->pgno, 3);
drh81a20f22001-10-12 17:30:04 +00002508 if( rc!=SQLITE_OK ){
drheb206252004-10-01 02:00:31 +00002509 i64 fileSize;
danielk19774adee202004-05-08 08:23:19 +00002510 if( sqlite3OsFileSize(&pPager->fd,&fileSize)!=SQLITE_OK
drh90f5ecb2004-07-22 01:19:35 +00002511 || fileSize>=pgno*pPager->pageSize ){
drh3aac2dd2004-04-26 14:10:20 +00002512 sqlite3pager_unref(PGHDR_TO_DATA(pPg));
drh4e371ee2002-09-05 16:08:27 +00002513 return rc;
2514 }else{
drh90f5ecb2004-07-22 01:19:35 +00002515 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
drh4e371ee2002-09-05 16:08:27 +00002516 }
danielk197742741be2005-01-08 12:42:39 +00002517 }else{
2518 pPager->nRead++;
drh81a20f22001-10-12 17:30:04 +00002519 }
drh306dc212001-05-21 13:45:10 +00002520 }
danielk19773c407372005-02-15 02:54:14 +00002521#ifdef SQLITE_CHECK_PAGES
2522 pPg->pageHash = pager_pagehash(pPg);
2523#endif
drhed7c8552001-04-11 14:29:21 +00002524 }else{
drhd9b02572001-04-15 00:37:09 +00002525 /* The requested page is in the page cache. */
drh7e3b0a02001-04-28 16:52:40 +00002526 pPager->nHit++;
drhdf0b3b02001-06-23 11:36:20 +00002527 page_ref(pPg);
drhed7c8552001-04-11 14:29:21 +00002528 }
2529 *ppPage = PGHDR_TO_DATA(pPg);
2530 return SQLITE_OK;
2531}
2532
2533/*
drh7e3b0a02001-04-28 16:52:40 +00002534** Acquire a page if it is already in the in-memory cache. Do
2535** not read the page from disk. Return a pointer to the page,
2536** or 0 if the page is not in cache.
2537**
drh3aac2dd2004-04-26 14:10:20 +00002538** See also sqlite3pager_get(). The difference between this routine
2539** and sqlite3pager_get() is that _get() will go to the disk and read
drh7e3b0a02001-04-28 16:52:40 +00002540** in the page if the page is not already in cache. This routine
drh5e00f6c2001-09-13 13:46:56 +00002541** returns NULL if the page is not in cache or if a disk I/O error
2542** has ever happened.
drh7e3b0a02001-04-28 16:52:40 +00002543*/
drh3aac2dd2004-04-26 14:10:20 +00002544void *sqlite3pager_lookup(Pager *pPager, Pgno pgno){
drh7e3b0a02001-04-28 16:52:40 +00002545 PgHdr *pPg;
2546
drh836faa42003-01-11 13:30:57 +00002547 assert( pPager!=0 );
2548 assert( pgno!=0 );
drh7e3b0a02001-04-28 16:52:40 +00002549 if( pPager->errMask & ~(PAGER_ERR_FULL) ){
2550 return 0;
2551 }
drh7e3b0a02001-04-28 16:52:40 +00002552 pPg = pager_lookup(pPager, pgno);
2553 if( pPg==0 ) return 0;
drhdf0b3b02001-06-23 11:36:20 +00002554 page_ref(pPg);
drh7e3b0a02001-04-28 16:52:40 +00002555 return PGHDR_TO_DATA(pPg);
2556}
2557
2558/*
drhed7c8552001-04-11 14:29:21 +00002559** Release a page.
2560**
2561** If the number of references to the page drop to zero, then the
2562** page is added to the LRU list. When all references to all pages
drhd9b02572001-04-15 00:37:09 +00002563** are released, a rollback occurs and the lock on the database is
drhed7c8552001-04-11 14:29:21 +00002564** removed.
2565*/
drh3aac2dd2004-04-26 14:10:20 +00002566int sqlite3pager_unref(void *pData){
drhed7c8552001-04-11 14:29:21 +00002567 PgHdr *pPg;
drhd9b02572001-04-15 00:37:09 +00002568
2569 /* Decrement the reference count for this page
2570 */
drhed7c8552001-04-11 14:29:21 +00002571 pPg = DATA_TO_PGHDR(pData);
2572 assert( pPg->nRef>0 );
drhed7c8552001-04-11 14:29:21 +00002573 pPg->nRef--;
drhdd793422001-06-28 01:54:48 +00002574 REFINFO(pPg);
drhd9b02572001-04-15 00:37:09 +00002575
danielk19773c407372005-02-15 02:54:14 +00002576 CHECK_PAGE(pPg);
2577
drh72f82862001-05-24 21:06:34 +00002578 /* When the number of references to a page reach 0, call the
2579 ** destructor and add the page to the freelist.
drhd9b02572001-04-15 00:37:09 +00002580 */
drhed7c8552001-04-11 14:29:21 +00002581 if( pPg->nRef==0 ){
drh1eaa2692001-09-18 02:02:23 +00002582 Pager *pPager;
2583 pPager = pPg->pPager;
drhd9b02572001-04-15 00:37:09 +00002584 pPg->pNextFree = 0;
2585 pPg->pPrevFree = pPager->pLast;
drhed7c8552001-04-11 14:29:21 +00002586 pPager->pLast = pPg;
drhd9b02572001-04-15 00:37:09 +00002587 if( pPg->pPrevFree ){
2588 pPg->pPrevFree->pNextFree = pPg;
drhed7c8552001-04-11 14:29:21 +00002589 }else{
2590 pPager->pFirst = pPg;
2591 }
drh341eae82003-01-21 02:39:36 +00002592 if( pPg->needSync==0 && pPager->pFirstSynced==0 ){
2593 pPager->pFirstSynced = pPg;
2594 }
drh72f82862001-05-24 21:06:34 +00002595 if( pPager->xDestructor ){
drhb6f41482004-05-14 01:58:11 +00002596 pPager->xDestructor(pData, pPager->pageSize);
drh72f82862001-05-24 21:06:34 +00002597 }
drhd9b02572001-04-15 00:37:09 +00002598
2599 /* When all pages reach the freelist, drop the read lock from
2600 ** the database file.
2601 */
2602 pPager->nRef--;
2603 assert( pPager->nRef>=0 );
drhb7f91642004-10-31 02:22:47 +00002604 if( pPager->nRef==0 && !MEMDB ){
drhd9b02572001-04-15 00:37:09 +00002605 pager_reset(pPager);
2606 }
drhed7c8552001-04-11 14:29:21 +00002607 }
drhd9b02572001-04-15 00:37:09 +00002608 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +00002609}
2610
2611/*
drha6abd042004-06-09 17:37:22 +00002612** Create a journal file for pPager. There should already be a RESERVED
2613** or EXCLUSIVE lock on the database file when this routine is called.
drhda47d772002-12-02 04:25:19 +00002614**
2615** Return SQLITE_OK if everything. Return an error code and release the
2616** write lock if anything goes wrong.
2617*/
2618static int pager_open_journal(Pager *pPager){
2619 int rc;
drhb7f91642004-10-31 02:22:47 +00002620 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +00002621 assert( pPager->state>=PAGER_RESERVED );
drhda47d772002-12-02 04:25:19 +00002622 assert( pPager->journalOpen==0 );
2623 assert( pPager->useJournal );
drh88b01a12005-03-28 18:04:27 +00002624 assert( pPager->aInJournal==0 );
drh3aac2dd2004-04-26 14:10:20 +00002625 sqlite3pager_pagecount(pPager);
drhda47d772002-12-02 04:25:19 +00002626 pPager->aInJournal = sqliteMalloc( pPager->dbSize/8 + 1 );
2627 if( pPager->aInJournal==0 ){
drh9c105bb2004-10-02 20:38:28 +00002628 rc = SQLITE_NOMEM;
2629 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00002630 }
danielk19774adee202004-05-08 08:23:19 +00002631 rc = sqlite3OsOpenExclusive(pPager->zJournal, &pPager->jfd,pPager->tempFile);
danielk197776572402004-06-25 02:38:54 +00002632 pPager->journalOff = 0;
2633 pPager->setMaster = 0;
2634 pPager->journalHdr = 0;
drhda47d772002-12-02 04:25:19 +00002635 if( rc!=SQLITE_OK ){
drh9c105bb2004-10-02 20:38:28 +00002636 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00002637 }
drhb851b2c2005-03-10 14:11:12 +00002638 SET_FULLSYNC(pPager->jfd, pPager->fullSync);
2639 SET_FULLSYNC(pPager->fd, pPager->fullSync);
danielk19774adee202004-05-08 08:23:19 +00002640 sqlite3OsOpenDirectory(pPager->zDirectory, &pPager->jfd);
drhda47d772002-12-02 04:25:19 +00002641 pPager->journalOpen = 1;
drhdb48ee02003-01-16 13:42:43 +00002642 pPager->journalStarted = 0;
drhda47d772002-12-02 04:25:19 +00002643 pPager->needSync = 0;
2644 pPager->alwaysRollback = 0;
drh968af522003-02-11 14:55:40 +00002645 pPager->nRec = 0;
drh2e6d11b2003-04-25 15:37:57 +00002646 if( pPager->errMask!=0 ){
2647 rc = pager_errcode(pPager);
drhdd5b2fa2005-03-28 03:39:55 +00002648 goto failed_to_open_journal;
drh2e6d11b2003-04-25 15:37:57 +00002649 }
drhda47d772002-12-02 04:25:19 +00002650 pPager->origDbSize = pPager->dbSize;
drhae2b40c2004-06-09 19:03:54 +00002651
danielk197776572402004-06-25 02:38:54 +00002652 rc = writeJournalHdr(pPager);
2653
drhac69b052004-05-12 13:30:07 +00002654 if( pPager->stmtAutoopen && rc==SQLITE_OK ){
drh3aac2dd2004-04-26 14:10:20 +00002655 rc = sqlite3pager_stmt_begin(pPager);
drhda47d772002-12-02 04:25:19 +00002656 }
2657 if( rc!=SQLITE_OK ){
2658 rc = pager_unwritelock(pPager);
2659 if( rc==SQLITE_OK ){
2660 rc = SQLITE_FULL;
2661 }
2662 }
drh9c105bb2004-10-02 20:38:28 +00002663 return rc;
2664
2665failed_to_open_journal:
2666 sqliteFree(pPager->aInJournal);
2667 pPager->aInJournal = 0;
2668 sqlite3OsUnlock(&pPager->fd, NO_LOCK);
2669 pPager->state = PAGER_UNLOCK;
2670 return rc;
drhda47d772002-12-02 04:25:19 +00002671}
2672
2673/*
drh4b845d72002-03-05 12:41:19 +00002674** Acquire a write-lock on the database. The lock is removed when
2675** the any of the following happen:
2676**
drh3aac2dd2004-04-26 14:10:20 +00002677** * sqlite3pager_commit() is called.
2678** * sqlite3pager_rollback() is called.
2679** * sqlite3pager_close() is called.
2680** * sqlite3pager_unref() is called to on every outstanding page.
drh4b845d72002-03-05 12:41:19 +00002681**
danielk197713adf8a2004-06-03 16:08:41 +00002682** The first parameter to this routine is a pointer to any open page of the
2683** database file. Nothing changes about the page - it is used merely to
2684** acquire a pointer to the Pager structure and as proof that there is
2685** already a read-lock on the database.
drh4b845d72002-03-05 12:41:19 +00002686**
danielk197713adf8a2004-06-03 16:08:41 +00002687** The second parameter indicates how much space in bytes to reserve for a
2688** master journal file-name at the start of the journal when it is created.
2689**
2690** A journal file is opened if this is not a temporary file. For temporary
2691** files, the opening of the journal file is deferred until there is an
2692** actual need to write to the journal.
drhda47d772002-12-02 04:25:19 +00002693**
drha6abd042004-06-09 17:37:22 +00002694** If the database is already reserved for writing, this routine is a no-op.
drh684917c2004-10-05 02:41:42 +00002695**
2696** If exFlag is true, go ahead and get an EXCLUSIVE lock on the file
2697** immediately instead of waiting until we try to flush the cache. The
2698** exFlag is ignored if a transaction is already active.
drh4b845d72002-03-05 12:41:19 +00002699*/
drh684917c2004-10-05 02:41:42 +00002700int sqlite3pager_begin(void *pData, int exFlag){
drh4b845d72002-03-05 12:41:19 +00002701 PgHdr *pPg = DATA_TO_PGHDR(pData);
2702 Pager *pPager = pPg->pPager;
2703 int rc = SQLITE_OK;
2704 assert( pPg->nRef>0 );
drha6abd042004-06-09 17:37:22 +00002705 assert( pPager->state!=PAGER_UNLOCK );
2706 if( pPager->state==PAGER_SHARED ){
drh4b845d72002-03-05 12:41:19 +00002707 assert( pPager->aInJournal==0 );
drhb7f91642004-10-31 02:22:47 +00002708 if( MEMDB ){
drha6abd042004-06-09 17:37:22 +00002709 pPager->state = PAGER_EXCLUSIVE;
drhac69b052004-05-12 13:30:07 +00002710 pPager->origDbSize = pPager->dbSize;
2711 }else{
drhb8ef32c2005-03-14 02:01:49 +00002712 rc = sqlite3OsLock(&pPager->fd, RESERVED_LOCK);
drh684917c2004-10-05 02:41:42 +00002713 if( rc==SQLITE_OK ){
2714 pPager->state = PAGER_RESERVED;
2715 if( exFlag ){
2716 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
2717 }
2718 }
danielk19779eed5052004-06-04 10:38:30 +00002719 if( rc!=SQLITE_OK ){
2720 return rc;
drhac69b052004-05-12 13:30:07 +00002721 }
drha6abd042004-06-09 17:37:22 +00002722 pPager->dirtyCache = 0;
danielk1977ef73ee92004-11-06 12:26:07 +00002723 TRACE2("TRANSACTION %d\n", PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00002724 if( pPager->useJournal && !pPager->tempFile ){
2725 rc = pager_open_journal(pPager);
2726 }
drh4b845d72002-03-05 12:41:19 +00002727 }
2728 }
2729 return rc;
2730}
2731
2732/*
drhed7c8552001-04-11 14:29:21 +00002733** Mark a data page as writeable. The page is written into the journal
2734** if it is not there already. This routine must be called before making
2735** changes to a page.
2736**
2737** The first time this routine is called, the pager creates a new
drha6abd042004-06-09 17:37:22 +00002738** journal and acquires a RESERVED lock on the database. If the RESERVED
drhed7c8552001-04-11 14:29:21 +00002739** lock could not be acquired, this routine returns SQLITE_BUSY. The
drh306dc212001-05-21 13:45:10 +00002740** calling routine must check for that return value and be careful not to
drhed7c8552001-04-11 14:29:21 +00002741** change any page data until this routine returns SQLITE_OK.
drhd9b02572001-04-15 00:37:09 +00002742**
2743** If the journal file could not be written because the disk is full,
2744** then this routine returns SQLITE_FULL and does an immediate rollback.
2745** All subsequent write attempts also return SQLITE_FULL until there
drh3aac2dd2004-04-26 14:10:20 +00002746** is a call to sqlite3pager_commit() or sqlite3pager_rollback() to
drhd9b02572001-04-15 00:37:09 +00002747** reset.
drhed7c8552001-04-11 14:29:21 +00002748*/
drh3aac2dd2004-04-26 14:10:20 +00002749int sqlite3pager_write(void *pData){
drh69688d52001-04-14 16:38:23 +00002750 PgHdr *pPg = DATA_TO_PGHDR(pData);
2751 Pager *pPager = pPg->pPager;
drhd79caeb2001-04-15 02:27:24 +00002752 int rc = SQLITE_OK;
drh69688d52001-04-14 16:38:23 +00002753
drh6446c4d2001-12-15 14:22:18 +00002754 /* Check for errors
2755 */
drhd9b02572001-04-15 00:37:09 +00002756 if( pPager->errMask ){
2757 return pager_errcode(pPager);
2758 }
drh5e00f6c2001-09-13 13:46:56 +00002759 if( pPager->readOnly ){
2760 return SQLITE_PERM;
2761 }
drh6446c4d2001-12-15 14:22:18 +00002762
danielk197776572402004-06-25 02:38:54 +00002763 assert( !pPager->setMaster );
2764
danielk19773c407372005-02-15 02:54:14 +00002765 CHECK_PAGE(pPg);
2766
drh6446c4d2001-12-15 14:22:18 +00002767 /* Mark the page as dirty. If the page has already been written
2768 ** to the journal then we can return right away.
2769 */
drhd9b02572001-04-15 00:37:09 +00002770 pPg->dirty = 1;
drhac69b052004-05-12 13:30:07 +00002771 if( pPg->inJournal && (pPg->inStmt || pPager->stmtInUse==0) ){
drha6abd042004-06-09 17:37:22 +00002772 pPager->dirtyCache = 1;
danielk1977a0bf2652004-11-04 14:30:04 +00002773 }else{
drh6446c4d2001-12-15 14:22:18 +00002774
danielk1977a0bf2652004-11-04 14:30:04 +00002775 /* If we get this far, it means that the page needs to be
2776 ** written to the transaction journal or the ckeckpoint journal
2777 ** or both.
2778 **
2779 ** First check to see that the transaction journal exists and
2780 ** create it if it does not.
2781 */
2782 assert( pPager->state!=PAGER_UNLOCK );
2783 rc = sqlite3pager_begin(pData, 0);
2784 if( rc!=SQLITE_OK ){
2785 return rc;
2786 }
2787 assert( pPager->state>=PAGER_RESERVED );
2788 if( !pPager->journalOpen && pPager->useJournal ){
2789 rc = pager_open_journal(pPager);
2790 if( rc!=SQLITE_OK ) return rc;
2791 }
2792 assert( pPager->journalOpen || !pPager->useJournal );
2793 pPager->dirtyCache = 1;
2794
2795 /* The transaction journal now exists and we have a RESERVED or an
2796 ** EXCLUSIVE lock on the main database file. Write the current page to
2797 ** the transaction journal if it is not there already.
2798 */
2799 if( !pPg->inJournal && (pPager->useJournal || MEMDB) ){
2800 if( (int)pPg->pgno <= pPager->origDbSize ){
2801 int szPg;
2802 u32 saved;
2803 if( MEMDB ){
2804 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
danielk1977ef73ee92004-11-06 12:26:07 +00002805 TRACE3("JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00002806 assert( pHist->pOrig==0 );
2807 pHist->pOrig = sqliteMallocRaw( pPager->pageSize );
2808 if( pHist->pOrig ){
2809 memcpy(pHist->pOrig, PGHDR_TO_DATA(pPg), pPager->pageSize);
2810 }
2811 }else{
2812 u32 cksum;
2813 CODEC(pPager, pData, pPg->pgno, 7);
2814 cksum = pager_cksum(pPager, pPg->pgno, pData);
2815 saved = *(u32*)PGHDR_TO_EXTRA(pPg, pPager);
2816 store32bits(cksum, pPg, pPager->pageSize);
2817 szPg = pPager->pageSize+8;
2818 store32bits(pPg->pgno, pPg, -4);
2819 rc = sqlite3OsWrite(&pPager->jfd, &((char*)pData)[-4], szPg);
2820 pPager->journalOff += szPg;
2821 TRACE4("JOURNAL %d page %d needSync=%d\n",
danielk1977ef73ee92004-11-06 12:26:07 +00002822 PAGERID(pPager), pPg->pgno, pPg->needSync);
danielk1977a0bf2652004-11-04 14:30:04 +00002823 CODEC(pPager, pData, pPg->pgno, 0);
2824 *(u32*)PGHDR_TO_EXTRA(pPg, pPager) = saved;
2825 if( rc!=SQLITE_OK ){
2826 sqlite3pager_rollback(pPager);
2827 pPager->errMask |= PAGER_ERR_FULL;
2828 return rc;
2829 }
2830 pPager->nRec++;
2831 assert( pPager->aInJournal!=0 );
2832 pPager->aInJournal[pPg->pgno/8] |= 1<<(pPg->pgno&7);
2833 pPg->needSync = !pPager->noSync;
2834 if( pPager->stmtInUse ){
2835 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
2836 page_add_to_stmt_list(pPg);
2837 }
drhac69b052004-05-12 13:30:07 +00002838 }
danielk197713adf8a2004-06-03 16:08:41 +00002839 }else{
danielk1977a0bf2652004-11-04 14:30:04 +00002840 pPg->needSync = !pPager->journalStarted && !pPager->noSync;
2841 TRACE4("APPEND %d page %d needSync=%d\n",
danielk1977ef73ee92004-11-06 12:26:07 +00002842 PAGERID(pPager), pPg->pgno, pPg->needSync);
danielk1977a0bf2652004-11-04 14:30:04 +00002843 }
2844 if( pPg->needSync ){
2845 pPager->needSync = 1;
2846 }
2847 pPg->inJournal = 1;
2848 }
2849
2850 /* If the statement journal is open and the page is not in it,
2851 ** then write the current page to the statement journal. Note that
2852 ** the statement journal format differs from the standard journal format
2853 ** in that it omits the checksums and the header.
2854 */
2855 if( pPager->stmtInUse && !pPg->inStmt && (int)pPg->pgno<=pPager->stmtSize ){
2856 assert( pPg->inJournal || (int)pPg->pgno>pPager->origDbSize );
2857 if( MEMDB ){
2858 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
2859 assert( pHist->pStmt==0 );
2860 pHist->pStmt = sqliteMallocRaw( pPager->pageSize );
2861 if( pHist->pStmt ){
2862 memcpy(pHist->pStmt, PGHDR_TO_DATA(pPg), pPager->pageSize);
2863 }
danielk1977ef73ee92004-11-06 12:26:07 +00002864 TRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00002865 }else{
2866 store32bits(pPg->pgno, pPg, -4);
2867 CODEC(pPager, pData, pPg->pgno, 7);
2868 rc = sqlite3OsWrite(&pPager->stfd,((char*)pData)-4, pPager->pageSize+4);
danielk1977ef73ee92004-11-06 12:26:07 +00002869 TRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
drhac69b052004-05-12 13:30:07 +00002870 CODEC(pPager, pData, pPg->pgno, 0);
drhac69b052004-05-12 13:30:07 +00002871 if( rc!=SQLITE_OK ){
2872 sqlite3pager_rollback(pPager);
2873 pPager->errMask |= PAGER_ERR_FULL;
2874 return rc;
2875 }
danielk1977a0bf2652004-11-04 14:30:04 +00002876 pPager->stmtNRec++;
2877 assert( pPager->aInStmt!=0 );
2878 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drhdb48ee02003-01-16 13:42:43 +00002879 }
danielk1977a0bf2652004-11-04 14:30:04 +00002880 page_add_to_stmt_list(pPg);
drhd9b02572001-04-15 00:37:09 +00002881 }
drhfa86c412002-02-02 15:01:15 +00002882 }
2883
2884 /* Update the database size and return.
2885 */
drh1ab43002002-01-14 09:28:19 +00002886 if( pPager->dbSize<(int)pPg->pgno ){
drh306dc212001-05-21 13:45:10 +00002887 pPager->dbSize = pPg->pgno;
drhb7f91642004-10-31 02:22:47 +00002888 if( !MEMDB && pPager->dbSize==PENDING_BYTE/pPager->pageSize ){
drh1f595712004-06-15 01:40:29 +00002889 pPager->dbSize++;
2890 }
drh306dc212001-05-21 13:45:10 +00002891 }
drh69688d52001-04-14 16:38:23 +00002892 return rc;
drhed7c8552001-04-11 14:29:21 +00002893}
2894
2895/*
drhaacc5432002-01-06 17:07:40 +00002896** Return TRUE if the page given in the argument was previously passed
drh3aac2dd2004-04-26 14:10:20 +00002897** to sqlite3pager_write(). In other words, return TRUE if it is ok
drh6019e162001-07-02 17:51:45 +00002898** to change the content of the page.
2899*/
drh3aac2dd2004-04-26 14:10:20 +00002900int sqlite3pager_iswriteable(void *pData){
drh6019e162001-07-02 17:51:45 +00002901 PgHdr *pPg = DATA_TO_PGHDR(pData);
2902 return pPg->dirty;
2903}
2904
danielk1977b84f96f2005-01-20 11:32:23 +00002905#ifndef SQLITE_OMIT_VACUUM
drh6019e162001-07-02 17:51:45 +00002906/*
drh001bbcb2003-03-19 03:14:00 +00002907** Replace the content of a single page with the information in the third
2908** argument.
2909*/
drh3aac2dd2004-04-26 14:10:20 +00002910int sqlite3pager_overwrite(Pager *pPager, Pgno pgno, void *pData){
drh001bbcb2003-03-19 03:14:00 +00002911 void *pPage;
2912 int rc;
2913
drh3aac2dd2004-04-26 14:10:20 +00002914 rc = sqlite3pager_get(pPager, pgno, &pPage);
drh001bbcb2003-03-19 03:14:00 +00002915 if( rc==SQLITE_OK ){
drh3aac2dd2004-04-26 14:10:20 +00002916 rc = sqlite3pager_write(pPage);
drh001bbcb2003-03-19 03:14:00 +00002917 if( rc==SQLITE_OK ){
drh90f5ecb2004-07-22 01:19:35 +00002918 memcpy(pPage, pData, pPager->pageSize);
drh001bbcb2003-03-19 03:14:00 +00002919 }
drh3aac2dd2004-04-26 14:10:20 +00002920 sqlite3pager_unref(pPage);
drh001bbcb2003-03-19 03:14:00 +00002921 }
2922 return rc;
2923}
danielk1977b84f96f2005-01-20 11:32:23 +00002924#endif
drh001bbcb2003-03-19 03:14:00 +00002925
2926/*
drh30e58752002-03-02 20:41:57 +00002927** A call to this routine tells the pager that it is not necessary to
2928** write the information on page "pgno" back to the disk, even though
2929** that page might be marked as dirty.
2930**
2931** The overlying software layer calls this routine when all of the data
2932** on the given page is unused. The pager marks the page as clean so
2933** that it does not get written to disk.
2934**
2935** Tests show that this optimization, together with the
drh3aac2dd2004-04-26 14:10:20 +00002936** sqlite3pager_dont_rollback() below, more than double the speed
drh30e58752002-03-02 20:41:57 +00002937** of large INSERT operations and quadruple the speed of large DELETEs.
drh8e298f92002-07-06 16:28:47 +00002938**
2939** When this routine is called, set the alwaysRollback flag to true.
drh3aac2dd2004-04-26 14:10:20 +00002940** Subsequent calls to sqlite3pager_dont_rollback() for the same page
drh8e298f92002-07-06 16:28:47 +00002941** will thereafter be ignored. This is necessary to avoid a problem
2942** where a page with data is added to the freelist during one part of
2943** a transaction then removed from the freelist during a later part
2944** of the same transaction and reused for some other purpose. When it
2945** is first added to the freelist, this routine is called. When reused,
2946** the dont_rollback() routine is called. But because the page contains
2947** critical data, we still need to be sure it gets rolled back in spite
2948** of the dont_rollback() call.
drh30e58752002-03-02 20:41:57 +00002949*/
drh3aac2dd2004-04-26 14:10:20 +00002950void sqlite3pager_dont_write(Pager *pPager, Pgno pgno){
drh30e58752002-03-02 20:41:57 +00002951 PgHdr *pPg;
drh8e298f92002-07-06 16:28:47 +00002952
drhb7f91642004-10-31 02:22:47 +00002953 if( MEMDB ) return;
danielk1977eac7a362004-06-16 07:45:24 +00002954
drh30e58752002-03-02 20:41:57 +00002955 pPg = pager_lookup(pPager, pgno);
drh8e298f92002-07-06 16:28:47 +00002956 pPg->alwaysRollback = 1;
drh30e58752002-03-02 20:41:57 +00002957 if( pPg && pPg->dirty ){
drh8124a302002-06-25 14:43:57 +00002958 if( pPager->dbSize==(int)pPg->pgno && pPager->origDbSize<pPager->dbSize ){
2959 /* If this pages is the last page in the file and the file has grown
2960 ** during the current transaction, then do NOT mark the page as clean.
2961 ** When the database file grows, we must make sure that the last page
2962 ** gets written at least once so that the disk file will be the correct
2963 ** size. If you do not write this page and the size of the file
2964 ** on the disk ends up being too small, that can lead to database
2965 ** corruption during the next transaction.
2966 */
2967 }else{
danielk1977ef73ee92004-11-06 12:26:07 +00002968 TRACE3("DONT_WRITE page %d of %d\n", pgno, PAGERID(pPager));
drh8124a302002-06-25 14:43:57 +00002969 pPg->dirty = 0;
danielk19773c407372005-02-15 02:54:14 +00002970#ifdef SQLITE_CHECK_PAGES
2971 pPg->pageHash = pager_pagehash(pPg);
2972#endif
drh8124a302002-06-25 14:43:57 +00002973 }
drh30e58752002-03-02 20:41:57 +00002974 }
2975}
2976
2977/*
2978** A call to this routine tells the pager that if a rollback occurs,
2979** it is not necessary to restore the data on the given page. This
2980** means that the pager does not have to record the given page in the
2981** rollback journal.
2982*/
drh3aac2dd2004-04-26 14:10:20 +00002983void sqlite3pager_dont_rollback(void *pData){
drh30e58752002-03-02 20:41:57 +00002984 PgHdr *pPg = DATA_TO_PGHDR(pData);
2985 Pager *pPager = pPg->pPager;
2986
drha6abd042004-06-09 17:37:22 +00002987 if( pPager->state!=PAGER_EXCLUSIVE || pPager->journalOpen==0 ) return;
drhb7f91642004-10-31 02:22:47 +00002988 if( pPg->alwaysRollback || pPager->alwaysRollback || MEMDB ) return;
drh30e58752002-03-02 20:41:57 +00002989 if( !pPg->inJournal && (int)pPg->pgno <= pPager->origDbSize ){
2990 assert( pPager->aInJournal!=0 );
2991 pPager->aInJournal[pPg->pgno/8] |= 1<<(pPg->pgno&7);
2992 pPg->inJournal = 1;
drhac69b052004-05-12 13:30:07 +00002993 if( pPager->stmtInUse ){
2994 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drh3aac2dd2004-04-26 14:10:20 +00002995 page_add_to_stmt_list(pPg);
drh30e58752002-03-02 20:41:57 +00002996 }
danielk1977ef73ee92004-11-06 12:26:07 +00002997 TRACE3("DONT_ROLLBACK page %d of %d\n", pPg->pgno, PAGERID(pPager));
drh30e58752002-03-02 20:41:57 +00002998 }
drhac69b052004-05-12 13:30:07 +00002999 if( pPager->stmtInUse && !pPg->inStmt && (int)pPg->pgno<=pPager->stmtSize ){
drh30e58752002-03-02 20:41:57 +00003000 assert( pPg->inJournal || (int)pPg->pgno>pPager->origDbSize );
drhac69b052004-05-12 13:30:07 +00003001 assert( pPager->aInStmt!=0 );
3002 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drh3aac2dd2004-04-26 14:10:20 +00003003 page_add_to_stmt_list(pPg);
drh30e58752002-03-02 20:41:57 +00003004 }
3005}
3006
drhac69b052004-05-12 13:30:07 +00003007
danielk197793758c82005-01-21 08:13:14 +00003008#ifndef SQLITE_OMIT_MEMORYDB
drhac69b052004-05-12 13:30:07 +00003009/*
3010** Clear a PgHistory block
3011*/
3012static void clearHistory(PgHistory *pHist){
3013 sqliteFree(pHist->pOrig);
3014 sqliteFree(pHist->pStmt);
3015 pHist->pOrig = 0;
3016 pHist->pStmt = 0;
3017}
danielk197793758c82005-01-21 08:13:14 +00003018#else
3019#define clearHistory(x)
3020#endif
drhac69b052004-05-12 13:30:07 +00003021
drh30e58752002-03-02 20:41:57 +00003022/*
drhed7c8552001-04-11 14:29:21 +00003023** Commit all changes to the database and release the write lock.
drhd9b02572001-04-15 00:37:09 +00003024**
3025** If the commit fails for any reason, a rollback attempt is made
3026** and an error code is returned. If the commit worked, SQLITE_OK
3027** is returned.
drhed7c8552001-04-11 14:29:21 +00003028*/
drh3aac2dd2004-04-26 14:10:20 +00003029int sqlite3pager_commit(Pager *pPager){
drha1b351a2001-09-14 16:42:12 +00003030 int rc;
drhed7c8552001-04-11 14:29:21 +00003031 PgHdr *pPg;
drhd9b02572001-04-15 00:37:09 +00003032
3033 if( pPager->errMask==PAGER_ERR_FULL ){
drh3aac2dd2004-04-26 14:10:20 +00003034 rc = sqlite3pager_rollback(pPager);
drh4e371ee2002-09-05 16:08:27 +00003035 if( rc==SQLITE_OK ){
3036 rc = SQLITE_FULL;
3037 }
drhd9b02572001-04-15 00:37:09 +00003038 return rc;
3039 }
3040 if( pPager->errMask!=0 ){
3041 rc = pager_errcode(pPager);
3042 return rc;
3043 }
drha6abd042004-06-09 17:37:22 +00003044 if( pPager->state<PAGER_RESERVED ){
drhd9b02572001-04-15 00:37:09 +00003045 return SQLITE_ERROR;
3046 }
danielk1977ef73ee92004-11-06 12:26:07 +00003047 TRACE2("COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003048 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00003049 pPg = pager_get_all_dirty_pages(pPager);
3050 while( pPg ){
3051 clearHistory(PGHDR_TO_HIST(pPg, pPager));
3052 pPg->dirty = 0;
3053 pPg->inJournal = 0;
3054 pPg->inStmt = 0;
3055 pPg->pPrevStmt = pPg->pNextStmt = 0;
3056 pPg = pPg->pDirty;
3057 }
danielk1977eac7a362004-06-16 07:45:24 +00003058#ifndef NDEBUG
3059 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
3060 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
3061 assert( !pPg->alwaysRollback );
3062 assert( !pHist->pOrig );
3063 assert( !pHist->pStmt );
3064 }
3065#endif
drhac69b052004-05-12 13:30:07 +00003066 pPager->pStmt = 0;
drha6abd042004-06-09 17:37:22 +00003067 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00003068 return SQLITE_OK;
3069 }
drha6abd042004-06-09 17:37:22 +00003070 if( pPager->dirtyCache==0 ){
danielk19774adee202004-05-08 08:23:19 +00003071 /* Exit early (without doing the time-consuming sqlite3OsSync() calls)
drha1680452002-04-18 01:56:57 +00003072 ** if there have been no changes to the database file. */
drh341eae82003-01-21 02:39:36 +00003073 assert( pPager->needSync==0 );
drha1680452002-04-18 01:56:57 +00003074 rc = pager_unwritelock(pPager);
3075 pPager->dbSize = -1;
3076 return rc;
3077 }
drhda47d772002-12-02 04:25:19 +00003078 assert( pPager->journalOpen );
danielk1977d761c0c2004-11-05 16:37:02 +00003079 rc = sqlite3pager_sync(pPager, 0, 0);
drha6abd042004-06-09 17:37:22 +00003080 if( rc!=SQLITE_OK ){
3081 goto commit_abort;
3082 }
drhd9b02572001-04-15 00:37:09 +00003083 rc = pager_unwritelock(pPager);
3084 pPager->dbSize = -1;
3085 return rc;
3086
3087 /* Jump here if anything goes wrong during the commit process.
3088 */
3089commit_abort:
drh92f02c32004-09-02 14:57:08 +00003090 sqlite3pager_rollback(pPager);
drhed7c8552001-04-11 14:29:21 +00003091 return rc;
3092}
3093
3094/*
drha6abd042004-06-09 17:37:22 +00003095** Rollback all changes. The database falls back to PAGER_SHARED mode.
drhed7c8552001-04-11 14:29:21 +00003096** All in-memory cache pages revert to their original data contents.
3097** The journal is deleted.
drhd9b02572001-04-15 00:37:09 +00003098**
3099** This routine cannot fail unless some other process is not following
3100** the correct locking protocol (SQLITE_PROTOCOL) or unless some other
3101** process is writing trash into the journal file (SQLITE_CORRUPT) or
3102** unless a prior malloc() failed (SQLITE_NOMEM). Appropriate error
3103** codes are returned for all these occasions. Otherwise,
3104** SQLITE_OK is returned.
drhed7c8552001-04-11 14:29:21 +00003105*/
drh3aac2dd2004-04-26 14:10:20 +00003106int sqlite3pager_rollback(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +00003107 int rc;
danielk1977ef73ee92004-11-06 12:26:07 +00003108 TRACE2("ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003109 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00003110 PgHdr *p;
3111 for(p=pPager->pAll; p; p=p->pNextAll){
3112 PgHistory *pHist;
danielk1977eac7a362004-06-16 07:45:24 +00003113 assert( !p->alwaysRollback );
3114 if( !p->dirty ){
3115 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pOrig );
3116 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pStmt );
3117 continue;
3118 }
3119
drhac69b052004-05-12 13:30:07 +00003120 pHist = PGHDR_TO_HIST(p, pPager);
3121 if( pHist->pOrig ){
3122 memcpy(PGHDR_TO_DATA(p), pHist->pOrig, pPager->pageSize);
danielk1977ef73ee92004-11-06 12:26:07 +00003123 TRACE3("ROLLBACK-PAGE %d of %d\n", p->pgno, PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00003124 }else{
danielk1977ef73ee92004-11-06 12:26:07 +00003125 TRACE3("PAGE %d is clean on %d\n", p->pgno, PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00003126 }
3127 clearHistory(pHist);
3128 p->dirty = 0;
3129 p->inJournal = 0;
3130 p->inStmt = 0;
3131 p->pPrevStmt = p->pNextStmt = 0;
danielk1977369f27e2004-06-15 11:40:04 +00003132
3133 if( pPager->xReiniter ){
3134 pPager->xReiniter(PGHDR_TO_DATA(p), pPager->pageSize);
3135 }
3136
drhac69b052004-05-12 13:30:07 +00003137 }
3138 pPager->pStmt = 0;
3139 pPager->dbSize = pPager->origDbSize;
3140 memoryTruncate(pPager);
3141 pPager->stmtInUse = 0;
drha6abd042004-06-09 17:37:22 +00003142 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00003143 return SQLITE_OK;
3144 }
3145
drha6abd042004-06-09 17:37:22 +00003146 if( !pPager->dirtyCache || !pPager->journalOpen ){
drhda47d772002-12-02 04:25:19 +00003147 rc = pager_unwritelock(pPager);
3148 pPager->dbSize = -1;
3149 return rc;
3150 }
drhdb48ee02003-01-16 13:42:43 +00003151
drhd9b02572001-04-15 00:37:09 +00003152 if( pPager->errMask!=0 && pPager->errMask!=PAGER_ERR_FULL ){
drha6abd042004-06-09 17:37:22 +00003153 if( pPager->state>=PAGER_EXCLUSIVE ){
danielk197776572402004-06-25 02:38:54 +00003154 pager_playback(pPager);
drh4b845d72002-03-05 12:41:19 +00003155 }
drhd9b02572001-04-15 00:37:09 +00003156 return pager_errcode(pPager);
drhed7c8552001-04-11 14:29:21 +00003157 }
drha6abd042004-06-09 17:37:22 +00003158 if( pPager->state==PAGER_RESERVED ){
danielk197717221812005-02-15 03:38:05 +00003159 int rc2;
drha6abd042004-06-09 17:37:22 +00003160 rc = pager_reload_cache(pPager);
danielk197717221812005-02-15 03:38:05 +00003161 rc2 = pager_unwritelock(pPager);
drha6abd042004-06-09 17:37:22 +00003162 if( rc==SQLITE_OK ){
3163 rc = rc2;
3164 }
3165 }else{
danielk197776572402004-06-25 02:38:54 +00003166 rc = pager_playback(pPager);
drhd9b02572001-04-15 00:37:09 +00003167 }
drhd9b02572001-04-15 00:37:09 +00003168 if( rc!=SQLITE_OK ){
drhee696e22004-08-30 16:52:17 +00003169 rc = SQLITE_CORRUPT; /* bkpt-CORRUPT */
drhd9b02572001-04-15 00:37:09 +00003170 pPager->errMask |= PAGER_ERR_CORRUPT;
3171 }
3172 pPager->dbSize = -1;
drhed7c8552001-04-11 14:29:21 +00003173 return rc;
drh98808ba2001-10-18 12:34:46 +00003174}
drhd9b02572001-04-15 00:37:09 +00003175
3176/*
drh5e00f6c2001-09-13 13:46:56 +00003177** Return TRUE if the database file is opened read-only. Return FALSE
3178** if the database is (in theory) writable.
3179*/
drh3aac2dd2004-04-26 14:10:20 +00003180int sqlite3pager_isreadonly(Pager *pPager){
drhbe0072d2001-09-13 14:46:09 +00003181 return pPager->readOnly;
drh5e00f6c2001-09-13 13:46:56 +00003182}
3183
3184/*
drhd9b02572001-04-15 00:37:09 +00003185** This routine is used for testing and analysis only.
3186*/
drh3aac2dd2004-04-26 14:10:20 +00003187int *sqlite3pager_stats(Pager *pPager){
danielk197742741be2005-01-08 12:42:39 +00003188 static int a[11];
drhd9b02572001-04-15 00:37:09 +00003189 a[0] = pPager->nRef;
3190 a[1] = pPager->nPage;
3191 a[2] = pPager->mxPage;
3192 a[3] = pPager->dbSize;
3193 a[4] = pPager->state;
3194 a[5] = pPager->errMask;
3195 a[6] = pPager->nHit;
3196 a[7] = pPager->nMiss;
3197 a[8] = pPager->nOvfl;
danielk197742741be2005-01-08 12:42:39 +00003198 a[9] = pPager->nRead;
3199 a[10] = pPager->nWrite;
drhd9b02572001-04-15 00:37:09 +00003200 return a;
3201}
drhdd793422001-06-28 01:54:48 +00003202
drhfa86c412002-02-02 15:01:15 +00003203/*
drhac69b052004-05-12 13:30:07 +00003204** Set the statement rollback point.
drhfa86c412002-02-02 15:01:15 +00003205**
3206** This routine should be called with the transaction journal already
drhac69b052004-05-12 13:30:07 +00003207** open. A new statement journal is created that can be used to rollback
drhaaab5722002-02-19 13:39:21 +00003208** changes of a single SQL command within a larger transaction.
drhfa86c412002-02-02 15:01:15 +00003209*/
drh3aac2dd2004-04-26 14:10:20 +00003210int sqlite3pager_stmt_begin(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00003211 int rc;
3212 char zTemp[SQLITE_TEMPNAME_SIZE];
drhac69b052004-05-12 13:30:07 +00003213 assert( !pPager->stmtInUse );
drhdc3ff9c2004-08-18 02:10:15 +00003214 assert( pPager->dbSize>=0 );
danielk1977ef73ee92004-11-06 12:26:07 +00003215 TRACE2("STMT-BEGIN %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003216 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00003217 pPager->stmtInUse = 1;
3218 pPager->stmtSize = pPager->dbSize;
3219 return SQLITE_OK;
3220 }
drhda47d772002-12-02 04:25:19 +00003221 if( !pPager->journalOpen ){
drhac69b052004-05-12 13:30:07 +00003222 pPager->stmtAutoopen = 1;
drhda47d772002-12-02 04:25:19 +00003223 return SQLITE_OK;
3224 }
drhfa86c412002-02-02 15:01:15 +00003225 assert( pPager->journalOpen );
drhac69b052004-05-12 13:30:07 +00003226 pPager->aInStmt = sqliteMalloc( pPager->dbSize/8 + 1 );
3227 if( pPager->aInStmt==0 ){
danielk19779eed5052004-06-04 10:38:30 +00003228 sqlite3OsLock(&pPager->fd, SHARED_LOCK);
drhfa86c412002-02-02 15:01:15 +00003229 return SQLITE_NOMEM;
3230 }
drh968af522003-02-11 14:55:40 +00003231#ifndef NDEBUG
drhac69b052004-05-12 13:30:07 +00003232 rc = sqlite3OsFileSize(&pPager->jfd, &pPager->stmtJSize);
3233 if( rc ) goto stmt_begin_failed;
danielk197776572402004-06-25 02:38:54 +00003234 assert( pPager->stmtJSize == pPager->journalOff );
drh968af522003-02-11 14:55:40 +00003235#endif
danielk197776572402004-06-25 02:38:54 +00003236 pPager->stmtJSize = pPager->journalOff;
drhac69b052004-05-12 13:30:07 +00003237 pPager->stmtSize = pPager->dbSize;
danielk197776572402004-06-25 02:38:54 +00003238 pPager->stmtHdrOff = 0;
danielk197775edc162004-06-26 01:48:18 +00003239 pPager->stmtCksum = pPager->cksumInit;
drhac69b052004-05-12 13:30:07 +00003240 if( !pPager->stmtOpen ){
3241 rc = sqlite3pager_opentemp(zTemp, &pPager->stfd);
3242 if( rc ) goto stmt_begin_failed;
3243 pPager->stmtOpen = 1;
3244 pPager->stmtNRec = 0;
drh0f892532002-05-30 12:27:03 +00003245 }
drhac69b052004-05-12 13:30:07 +00003246 pPager->stmtInUse = 1;
drhfa86c412002-02-02 15:01:15 +00003247 return SQLITE_OK;
3248
drhac69b052004-05-12 13:30:07 +00003249stmt_begin_failed:
3250 if( pPager->aInStmt ){
3251 sqliteFree(pPager->aInStmt);
3252 pPager->aInStmt = 0;
drhfa86c412002-02-02 15:01:15 +00003253 }
3254 return rc;
3255}
3256
3257/*
drhac69b052004-05-12 13:30:07 +00003258** Commit a statement.
drhfa86c412002-02-02 15:01:15 +00003259*/
drh3aac2dd2004-04-26 14:10:20 +00003260int sqlite3pager_stmt_commit(Pager *pPager){
drhac69b052004-05-12 13:30:07 +00003261 if( pPager->stmtInUse ){
drh03eb96a2002-11-10 23:32:56 +00003262 PgHdr *pPg, *pNext;
danielk1977ef73ee92004-11-06 12:26:07 +00003263 TRACE2("STMT-COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003264 if( !MEMDB ){
drhac69b052004-05-12 13:30:07 +00003265 sqlite3OsSeek(&pPager->stfd, 0);
3266 /* sqlite3OsTruncate(&pPager->stfd, 0); */
3267 sqliteFree( pPager->aInStmt );
3268 pPager->aInStmt = 0;
drh663fc632002-02-02 18:49:19 +00003269 }
drhac69b052004-05-12 13:30:07 +00003270 for(pPg=pPager->pStmt; pPg; pPg=pNext){
3271 pNext = pPg->pNextStmt;
3272 assert( pPg->inStmt );
3273 pPg->inStmt = 0;
3274 pPg->pPrevStmt = pPg->pNextStmt = 0;
drhb7f91642004-10-31 02:22:47 +00003275 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00003276 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
3277 sqliteFree(pHist->pStmt);
3278 pHist->pStmt = 0;
3279 }
3280 }
3281 pPager->stmtNRec = 0;
3282 pPager->stmtInUse = 0;
3283 pPager->pStmt = 0;
drh663fc632002-02-02 18:49:19 +00003284 }
drhac69b052004-05-12 13:30:07 +00003285 pPager->stmtAutoopen = 0;
drhfa86c412002-02-02 15:01:15 +00003286 return SQLITE_OK;
3287}
3288
3289/*
drhac69b052004-05-12 13:30:07 +00003290** Rollback a statement.
drhfa86c412002-02-02 15:01:15 +00003291*/
drh3aac2dd2004-04-26 14:10:20 +00003292int sqlite3pager_stmt_rollback(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00003293 int rc;
drhac69b052004-05-12 13:30:07 +00003294 if( pPager->stmtInUse ){
danielk1977ef73ee92004-11-06 12:26:07 +00003295 TRACE2("STMT-ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003296 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00003297 PgHdr *pPg;
3298 for(pPg=pPager->pStmt; pPg; pPg=pPg->pNextStmt){
3299 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
3300 if( pHist->pStmt ){
3301 memcpy(PGHDR_TO_DATA(pPg), pHist->pStmt, pPager->pageSize);
3302 sqliteFree(pHist->pStmt);
3303 pHist->pStmt = 0;
3304 }
3305 }
3306 pPager->dbSize = pPager->stmtSize;
3307 memoryTruncate(pPager);
3308 rc = SQLITE_OK;
3309 }else{
3310 rc = pager_stmt_playback(pPager);
3311 }
drh3aac2dd2004-04-26 14:10:20 +00003312 sqlite3pager_stmt_commit(pPager);
drh663fc632002-02-02 18:49:19 +00003313 }else{
3314 rc = SQLITE_OK;
3315 }
drhac69b052004-05-12 13:30:07 +00003316 pPager->stmtAutoopen = 0;
drhfa86c412002-02-02 15:01:15 +00003317 return rc;
3318}
3319
drh73509ee2003-04-06 20:44:45 +00003320/*
3321** Return the full pathname of the database file.
3322*/
drh3aac2dd2004-04-26 14:10:20 +00003323const char *sqlite3pager_filename(Pager *pPager){
drh73509ee2003-04-06 20:44:45 +00003324 return pPager->zFilename;
3325}
3326
drhb20ea9d2004-02-09 01:20:36 +00003327/*
danielk19775865e3d2004-06-14 06:03:57 +00003328** Return the directory of the database file.
3329*/
3330const char *sqlite3pager_dirname(Pager *pPager){
3331 return pPager->zDirectory;
3332}
3333
3334/*
3335** Return the full pathname of the journal file.
3336*/
3337const char *sqlite3pager_journalname(Pager *pPager){
3338 return pPager->zJournal;
3339}
3340
3341/*
drhb20ea9d2004-02-09 01:20:36 +00003342** Set the codec for this pager
3343*/
drh3aac2dd2004-04-26 14:10:20 +00003344void sqlite3pager_set_codec(
drhb20ea9d2004-02-09 01:20:36 +00003345 Pager *pPager,
drh9eb9e262004-02-11 02:18:05 +00003346 void (*xCodec)(void*,void*,Pgno,int),
drhb20ea9d2004-02-09 01:20:36 +00003347 void *pCodecArg
3348){
3349 pPager->xCodec = xCodec;
3350 pPager->pCodecArg = pCodecArg;
3351}
3352
danielk197713adf8a2004-06-03 16:08:41 +00003353/*
danielk1977aa5ccdf2004-06-14 05:10:42 +00003354** This routine is called to increment the database file change-counter,
3355** stored at byte 24 of the pager file.
3356*/
3357static int pager_incr_changecounter(Pager *pPager){
3358 void *pPage;
3359 PgHdr *pPgHdr;
3360 u32 change_counter;
3361 int rc;
3362
3363 /* Open page 1 of the file for writing. */
3364 rc = sqlite3pager_get(pPager, 1, &pPage);
3365 if( rc!=SQLITE_OK ) return rc;
3366 rc = sqlite3pager_write(pPage);
3367 if( rc!=SQLITE_OK ) return rc;
3368
3369 /* Read the current value at byte 24. */
3370 pPgHdr = DATA_TO_PGHDR(pPage);
3371 change_counter = retrieve32bits(pPgHdr, 24);
3372
3373 /* Increment the value just read and write it back to byte 24. */
3374 change_counter++;
3375 store32bits(change_counter, pPgHdr, 24);
3376
3377 /* Release the page reference. */
3378 sqlite3pager_unref(pPage);
3379 return SQLITE_OK;
3380}
3381
3382/*
danielk197713adf8a2004-06-03 16:08:41 +00003383** Sync the database file for the pager pPager. zMaster points to the name
3384** of a master journal file that should be written into the individual
3385** journal file. zMaster may be NULL, which is interpreted as no master
3386** journal (a single database transaction).
3387**
3388** This routine ensures that the journal is synced, all dirty pages written
3389** to the database file and the database file synced. The only thing that
3390** remains to commit the transaction is to delete the journal file (or
3391** master journal file if specified).
3392**
3393** Note that if zMaster==NULL, this does not overwrite a previous value
3394** passed to an sqlite3pager_sync() call.
danielk1977d761c0c2004-11-05 16:37:02 +00003395**
3396** If parameter nTrunc is non-zero, then the pager file is truncated to
3397** nTrunc pages (this is used by auto-vacuum databases).
danielk197713adf8a2004-06-03 16:08:41 +00003398*/
danielk1977d761c0c2004-11-05 16:37:02 +00003399int sqlite3pager_sync(Pager *pPager, const char *zMaster, Pgno nTrunc){
danielk197713adf8a2004-06-03 16:08:41 +00003400 int rc = SQLITE_OK;
3401
danielk1977ef73ee92004-11-06 12:26:07 +00003402 TRACE4("DATABASE SYNC: File=%s zMaster=%s nTrunc=%d\n",
3403 pPager->zFilename, zMaster, nTrunc);
3404
danielk1977aa5ccdf2004-06-14 05:10:42 +00003405 /* If this is an in-memory db, or no pages have been written to, or this
3406 ** function has already been called, it is a no-op.
danielk197713adf8a2004-06-03 16:08:41 +00003407 */
drhb7f91642004-10-31 02:22:47 +00003408 if( pPager->state!=PAGER_SYNCED && !MEMDB && pPager->dirtyCache ){
danielk197713adf8a2004-06-03 16:08:41 +00003409 PgHdr *pPg;
3410 assert( pPager->journalOpen );
3411
danielk197776572402004-06-25 02:38:54 +00003412 /* If a master journal file name has already been written to the
3413 ** journal file, then no sync is required. This happens when it is
3414 ** written, then the process fails to upgrade from a RESERVED to an
3415 ** EXCLUSIVE lock. The next time the process tries to commit the
3416 ** transaction the m-j name will have already been written.
3417 */
3418 if( !pPager->setMaster ){
3419 rc = pager_incr_changecounter(pPager);
3420 if( rc!=SQLITE_OK ) goto sync_exit;
danielk1977ef73ee92004-11-06 12:26:07 +00003421#ifndef SQLITE_OMIT_AUTOVACUUM
3422 if( nTrunc!=0 ){
3423 /* If this transaction has made the database smaller, then all pages
3424 ** being discarded by the truncation must be written to the journal
3425 ** file.
3426 */
3427 Pgno i;
3428 void *pPage;
3429 for( i=nTrunc+1; i<=pPager->origDbSize; i++ ){
3430 if( !(pPager->aInJournal[i/8] & (1<<(i&7))) ){
3431 rc = sqlite3pager_get(pPager, i, &pPage);
3432 if( rc!=SQLITE_OK ) goto sync_exit;
3433 rc = sqlite3pager_write(pPage);
3434 sqlite3pager_unref(pPage);
3435 if( rc!=SQLITE_OK ) goto sync_exit;
3436 }
3437 }
3438 }
3439#endif
danielk197776572402004-06-25 02:38:54 +00003440 rc = writeMasterJournal(pPager, zMaster);
3441 if( rc!=SQLITE_OK ) goto sync_exit;
3442 rc = syncJournal(pPager);
3443 if( rc!=SQLITE_OK ) goto sync_exit;
3444 }
danielk197713adf8a2004-06-03 16:08:41 +00003445
danielk1977d761c0c2004-11-05 16:37:02 +00003446#ifndef SQLITE_OMIT_AUTOVACUUM
3447 if( nTrunc!=0 ){
3448 rc = sqlite3pager_truncate(pPager, nTrunc);
3449 if( rc!=SQLITE_OK ) goto sync_exit;
3450 }
3451#endif
3452
danielk197713adf8a2004-06-03 16:08:41 +00003453 /* Write all dirty pages to the database file */
3454 pPg = pager_get_all_dirty_pages(pPager);
3455 rc = pager_write_pagelist(pPg);
3456 if( rc!=SQLITE_OK ) goto sync_exit;
3457
danielk1977aa5ccdf2004-06-14 05:10:42 +00003458 /* Sync the database file. */
3459 if( !pPager->noSync ){
danielk197713adf8a2004-06-03 16:08:41 +00003460 rc = sqlite3OsSync(&pPager->fd);
3461 }
danielk1977aa5ccdf2004-06-14 05:10:42 +00003462
3463 pPager->state = PAGER_SYNCED;
danielk197713adf8a2004-06-03 16:08:41 +00003464 }
3465
3466sync_exit:
3467 return rc;
3468}
3469
danielk1977687566d2004-11-02 12:56:41 +00003470#ifndef SQLITE_OMIT_AUTOVACUUM
3471/*
3472** Move the page identified by pData to location pgno in the file.
3473**
3474** There must be no references to the current page pgno. If current page
3475** pgno is not already in the rollback journal, it is not written there by
3476** by this routine. The same applies to the page pData refers to on entry to
3477** this routine.
3478**
3479** References to the page refered to by pData remain valid. Updating any
3480** meta-data associated with page pData (i.e. data stored in the nExtra bytes
3481** allocated along with the page) is the responsibility of the caller.
3482**
danielk19775fd057a2005-03-09 13:09:43 +00003483** A transaction must be active when this routine is called. It used to be
3484** required that a statement transaction was not active, but this restriction
3485** has been removed (CREATE INDEX needs to move a page when a statement
3486** transaction is active).
danielk1977687566d2004-11-02 12:56:41 +00003487*/
3488int sqlite3pager_movepage(Pager *pPager, void *pData, Pgno pgno){
3489 PgHdr *pPg = DATA_TO_PGHDR(pData);
3490 PgHdr *pPgOld;
danielk1977f5fdda82004-11-03 08:44:05 +00003491 int h;
danielk197794daf7f2004-11-08 09:26:09 +00003492 Pgno needSyncPgno = 0;
danielk1977687566d2004-11-02 12:56:41 +00003493
danielk1977687566d2004-11-02 12:56:41 +00003494 assert( pPg->nRef>0 );
3495
danielk1977599fcba2004-11-08 07:13:13 +00003496 TRACE5("MOVE %d page %d (needSync=%d) moves to %d\n",
3497 PAGERID(pPager), pPg->pgno, pPg->needSync, pgno);
danielk1977ef73ee92004-11-06 12:26:07 +00003498
danielk197794daf7f2004-11-08 09:26:09 +00003499 if( pPg->needSync ){
3500 needSyncPgno = pPg->pgno;
3501 assert( pPg->inJournal );
3502 assert( pPg->dirty );
danielk1977ae825582004-11-23 09:06:55 +00003503 assert( pPager->needSync );
danielk197794daf7f2004-11-08 09:26:09 +00003504 }
3505
danielk1977687566d2004-11-02 12:56:41 +00003506 /* Unlink pPg from it's hash-chain */
danielk1977f5fdda82004-11-03 08:44:05 +00003507 unlinkHashChain(pPager, pPg);
danielk1977687566d2004-11-02 12:56:41 +00003508
danielk1977ef73ee92004-11-06 12:26:07 +00003509 /* If the cache contains a page with page-number pgno, remove it
danielk1977599fcba2004-11-08 07:13:13 +00003510 ** from it's hash chain. Also, if the PgHdr.needSync was set for
3511 ** page pgno before the 'move' operation, it needs to be retained
3512 ** for the page moved there.
danielk1977f5fdda82004-11-03 08:44:05 +00003513 */
danielk1977687566d2004-11-02 12:56:41 +00003514 pPgOld = pager_lookup(pPager, pgno);
3515 if( pPgOld ){
danielk1977f5fdda82004-11-03 08:44:05 +00003516 assert( pPgOld->nRef==0 );
3517 unlinkHashChain(pPager, pPgOld);
3518 pPgOld->dirty = 0;
danielk1977ef73ee92004-11-06 12:26:07 +00003519 if( pPgOld->needSync ){
danielk197745901d62004-11-10 15:27:38 +00003520 assert( pPgOld->inJournal );
3521 pPg->inJournal = 1;
danielk1977ef73ee92004-11-06 12:26:07 +00003522 pPg->needSync = 1;
danielk1977ae825582004-11-23 09:06:55 +00003523 assert( pPager->needSync );
danielk1977ef73ee92004-11-06 12:26:07 +00003524 }
danielk1977687566d2004-11-02 12:56:41 +00003525 }
3526
danielk1977f5fdda82004-11-03 08:44:05 +00003527 /* Change the page number for pPg and insert it into the new hash-chain. */
3528 pPg->pgno = pgno;
3529 h = pager_hash(pgno);
3530 if( pPager->aHash[h] ){
3531 assert( pPager->aHash[h]->pPrevHash==0 );
3532 pPager->aHash[h]->pPrevHash = pPg;
3533 }
3534 pPg->pNextHash = pPager->aHash[h];
3535 pPager->aHash[h] = pPg;
3536 pPg->pPrevHash = 0;
3537
danielk1977687566d2004-11-02 12:56:41 +00003538 pPg->dirty = 1;
3539 pPager->dirtyCache = 1;
3540
danielk197794daf7f2004-11-08 09:26:09 +00003541 if( needSyncPgno ){
3542 /* If needSyncPgno is non-zero, then the journal file needs to be
3543 ** sync()ed before any data is written to database file page needSyncPgno.
3544 ** Currently, no such page exists in the page-cache and the
3545 ** Pager.aInJournal bit has been set. This needs to be remedied by loading
3546 ** the page into the pager-cache and setting the PgHdr.needSync flag.
danielk1977ae825582004-11-23 09:06:55 +00003547 **
3548 ** The sqlite3pager_get() call may cause the journal to sync. So make
3549 ** sure the Pager.needSync flag is set too.
danielk197794daf7f2004-11-08 09:26:09 +00003550 */
3551 int rc;
3552 void *pNeedSync;
danielk1977ae825582004-11-23 09:06:55 +00003553 assert( pPager->needSync );
danielk197794daf7f2004-11-08 09:26:09 +00003554 rc = sqlite3pager_get(pPager, needSyncPgno, &pNeedSync);
3555 if( rc!=SQLITE_OK ) return rc;
danielk1977ae825582004-11-23 09:06:55 +00003556 pPager->needSync = 1;
danielk197794daf7f2004-11-08 09:26:09 +00003557 DATA_TO_PGHDR(pNeedSync)->needSync = 1;
3558 DATA_TO_PGHDR(pNeedSync)->inJournal = 1;
3559 DATA_TO_PGHDR(pNeedSync)->dirty = 1;
3560 sqlite3pager_unref(pNeedSync);
3561 }
3562
danielk1977687566d2004-11-02 12:56:41 +00003563 return SQLITE_OK;
3564}
3565#endif
3566
dougcurrie81c95ef2004-06-18 23:21:47 +00003567#if defined(SQLITE_DEBUG) || defined(SQLITE_TEST)
drh89ac8c12004-06-09 14:17:20 +00003568/*
3569** Return the current state of the file lock for the given pager.
3570** The return value is one of NO_LOCK, SHARED_LOCK, RESERVED_LOCK,
3571** PENDING_LOCK, or EXCLUSIVE_LOCK.
3572*/
3573int sqlite3pager_lockstate(Pager *pPager){
danielk1977e3026632004-06-22 11:29:02 +00003574#ifdef OS_TEST
danielk19778a6c5502004-06-22 12:18:32 +00003575 return pPager->fd->fd.locktype;
danielk1977e3026632004-06-22 11:29:02 +00003576#else
drh89ac8c12004-06-09 14:17:20 +00003577 return pPager->fd.locktype;
danielk1977e3026632004-06-22 11:29:02 +00003578#endif
drh89ac8c12004-06-09 14:17:20 +00003579}
3580#endif
3581
danielk197793758c82005-01-21 08:13:14 +00003582#ifdef SQLITE_DEBUG
drhdd793422001-06-28 01:54:48 +00003583/*
3584** Print a listing of all referenced pages and their ref count.
3585*/
drh3aac2dd2004-04-26 14:10:20 +00003586void sqlite3pager_refdump(Pager *pPager){
drhdd793422001-06-28 01:54:48 +00003587 PgHdr *pPg;
3588 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
3589 if( pPg->nRef<=0 ) continue;
drhfe63d1c2004-09-08 20:13:04 +00003590 sqlite3DebugPrintf("PAGE %3d addr=%p nRef=%d\n",
3591 pPg->pgno, PGHDR_TO_DATA(pPg), pPg->nRef);
drhdd793422001-06-28 01:54:48 +00003592 }
3593}
3594#endif
drh2e66f0b2005-04-28 17:18:48 +00003595
3596#endif /* SQLITE_OMIT_DISKIO */