blob: 725c032581ae419b68f306823e15e50319a75b27 [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**
danielk1977f35843b2007-04-07 15:03:17 +000021** @(#) $Id: pager.c,v 1.325 2007/04/07 15:03:17 danielk1977 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
drhd3627af2006-12-18 18:34:51 +000034#define sqlite3DebugPrintf printf
drh4f0c5872007-03-26 22:05:01 +000035#define PAGERTRACE1(X) sqlite3DebugPrintf(X)
36#define PAGERTRACE2(X,Y) sqlite3DebugPrintf(X,Y)
37#define PAGERTRACE3(X,Y,Z) sqlite3DebugPrintf(X,Y,Z)
38#define PAGERTRACE4(X,Y,Z,W) sqlite3DebugPrintf(X,Y,Z,W)
39#define PAGERTRACE5(X,Y,Z,W,V) sqlite3DebugPrintf(X,Y,Z,W,V)
drhdb48ee02003-01-16 13:42:43 +000040#else
drh4f0c5872007-03-26 22:05:01 +000041#define PAGERTRACE1(X)
42#define PAGERTRACE2(X,Y)
43#define PAGERTRACE3(X,Y,Z)
44#define PAGERTRACE4(X,Y,Z,W)
45#define PAGERTRACE5(X,Y,Z,W,V)
drhdb48ee02003-01-16 13:42:43 +000046#endif
47
danielk1977599fcba2004-11-08 07:13:13 +000048/*
drh4f0c5872007-03-26 22:05:01 +000049** The following two macros are used within the PAGERTRACEX() macros above
drhd86959f2005-11-26 03:51:18 +000050** to print out file-descriptors.
danielk1977599fcba2004-11-08 07:13:13 +000051**
52** PAGERID() takes a pointer to a Pager struct as it's argument. The
53** associated file-descriptor is returned. FILEHANDLEID() takes an OsFile
54** struct as it's argument.
55*/
drhc001c582006-03-06 18:23:16 +000056#define PAGERID(p) ((int)(p->fd))
57#define FILEHANDLEID(fd) ((int)fd)
drhdb48ee02003-01-16 13:42:43 +000058
59/*
drhed7c8552001-04-11 14:29:21 +000060** The page cache as a whole is always in one of the following
61** states:
62**
drha6abd042004-06-09 17:37:22 +000063** PAGER_UNLOCK The page cache is not currently reading or
drhed7c8552001-04-11 14:29:21 +000064** writing the database file. There is no
65** data held in memory. This is the initial
66** state.
67**
drha6abd042004-06-09 17:37:22 +000068** PAGER_SHARED The page cache is reading the database.
drhed7c8552001-04-11 14:29:21 +000069** Writing is not permitted. There can be
70** multiple readers accessing the same database
drh69688d52001-04-14 16:38:23 +000071** file at the same time.
drhed7c8552001-04-11 14:29:21 +000072**
drh726de592004-06-10 23:35:50 +000073** PAGER_RESERVED This process has reserved the database for writing
74** but has not yet made any changes. Only one process
75** at a time can reserve the database. The original
76** database file has not been modified so other
77** processes may still be reading the on-disk
drha6abd042004-06-09 17:37:22 +000078** database file.
79**
80** PAGER_EXCLUSIVE The page cache is writing the database.
drhed7c8552001-04-11 14:29:21 +000081** Access is exclusive. No other processes or
82** threads can be reading or writing while one
83** process is writing.
84**
danielk1977aa5ccdf2004-06-14 05:10:42 +000085** PAGER_SYNCED The pager moves to this state from PAGER_EXCLUSIVE
86** after all dirty pages have been written to the
87** database file and the file has been synced to
drh369339d2007-03-30 16:01:55 +000088** disk. All that remains to do is to remove or
89** truncate the journal file and the transaction
90** will be committed.
danielk1977aa5ccdf2004-06-14 05:10:42 +000091**
drha6abd042004-06-09 17:37:22 +000092** The page cache comes up in PAGER_UNLOCK. The first time a
danielk19773b8a05f2007-03-19 17:44:26 +000093** sqlite3PagerGet() occurs, the state transitions to PAGER_SHARED.
drhed7c8552001-04-11 14:29:21 +000094** After all pages have been released using sqlite_page_unref(),
drha6abd042004-06-09 17:37:22 +000095** the state transitions back to PAGER_UNLOCK. The first time
danielk19773b8a05f2007-03-19 17:44:26 +000096** that sqlite3PagerWrite() is called, the state transitions to
drh369339d2007-03-30 16:01:55 +000097** PAGER_RESERVED. (Note that sqlite3PagerWrite() can only be
drh306dc212001-05-21 13:45:10 +000098** called on an outstanding page which means that the pager must
drha6abd042004-06-09 17:37:22 +000099** be in PAGER_SHARED before it transitions to PAGER_RESERVED.)
drh369339d2007-03-30 16:01:55 +0000100** PAGER_RESERVED means that there is an open rollback journal.
101** The transition to PAGER_EXCLUSIVE occurs before any changes
102** are made to the database file, though writes to the rollback
103** journal occurs with just PAGER_RESERVED. After an sqlite3PagerRollback()
104** or sqlite3PagerCommitPhaseTwo(), the state can go back to PAGER_SHARED,
105** or it can stay at PAGER_EXCLUSIVE if we are in exclusive access mode.
drhed7c8552001-04-11 14:29:21 +0000106*/
drha6abd042004-06-09 17:37:22 +0000107#define PAGER_UNLOCK 0
drh684917c2004-10-05 02:41:42 +0000108#define PAGER_SHARED 1 /* same as SHARED_LOCK */
109#define PAGER_RESERVED 2 /* same as RESERVED_LOCK */
110#define PAGER_EXCLUSIVE 4 /* same as EXCLUSIVE_LOCK */
111#define PAGER_SYNCED 5
drhed7c8552001-04-11 14:29:21 +0000112
drh684917c2004-10-05 02:41:42 +0000113/*
114** If the SQLITE_BUSY_RESERVED_LOCK macro is set to true at compile-time,
115** then failed attempts to get a reserved lock will invoke the busy callback.
116** This is off by default. To see why, consider the following scenario:
117**
118** Suppose thread A already has a shared lock and wants a reserved lock.
119** Thread B already has a reserved lock and wants an exclusive lock. If
120** both threads are using their busy callbacks, it might be a long time
121** be for one of the threads give up and allows the other to proceed.
122** But if the thread trying to get the reserved lock gives up quickly
123** (if it never invokes its busy callback) then the contention will be
124** resolved quickly.
125*/
126#ifndef SQLITE_BUSY_RESERVED_LOCK
127# define SQLITE_BUSY_RESERVED_LOCK 0
128#endif
drhd9b02572001-04-15 00:37:09 +0000129
drhed7c8552001-04-11 14:29:21 +0000130/*
drh887dc4c2004-10-22 16:22:57 +0000131** This macro rounds values up so that if the value is an address it
132** is guaranteed to be an address that is aligned to an 8-byte boundary.
133*/
134#define FORCE_ALIGNMENT(X) (((X)+7)&~7)
135
136/*
drhed7c8552001-04-11 14:29:21 +0000137** Each in-memory image of a page begins with the following header.
drhbd03cae2001-06-02 02:40:57 +0000138** This header is only visible to this pager module. The client
139** code that calls pager sees only the data that follows the header.
drhf6038712004-02-08 18:07:34 +0000140**
danielk19773b8a05f2007-03-19 17:44:26 +0000141** Client code should call sqlite3PagerWrite() on a page prior to making
142** any modifications to that page. The first time sqlite3PagerWrite()
drhf6038712004-02-08 18:07:34 +0000143** is called, the original page contents are written into the rollback
144** journal and PgHdr.inJournal and PgHdr.needSync are set. Later, once
145** the journal page has made it onto the disk surface, PgHdr.needSync
146** is cleared. The modified page cannot be written back into the original
147** database file until the journal pages has been synced to disk and the
148** PgHdr.needSync has been cleared.
149**
danielk19773b8a05f2007-03-19 17:44:26 +0000150** The PgHdr.dirty flag is set when sqlite3PagerWrite() is called and
drhf6038712004-02-08 18:07:34 +0000151** is cleared again when the page content is written back to the original
152** database file.
drhed7c8552001-04-11 14:29:21 +0000153*/
drhd9b02572001-04-15 00:37:09 +0000154typedef struct PgHdr PgHdr;
drhed7c8552001-04-11 14:29:21 +0000155struct PgHdr {
156 Pager *pPager; /* The pager to which this page belongs */
157 Pgno pgno; /* The page number for this page */
drh69688d52001-04-14 16:38:23 +0000158 PgHdr *pNextHash, *pPrevHash; /* Hash collision chain for PgHdr.pgno */
drhd9b02572001-04-15 00:37:09 +0000159 PgHdr *pNextFree, *pPrevFree; /* Freelist of pages where nRef==0 */
drhac69b052004-05-12 13:30:07 +0000160 PgHdr *pNextAll; /* A list of all pages */
drh193a6b42002-07-07 16:52:46 +0000161 u8 inJournal; /* TRUE if has been written to journal */
drh193a6b42002-07-07 16:52:46 +0000162 u8 dirty; /* TRUE if we need to write back changes */
drhdb48ee02003-01-16 13:42:43 +0000163 u8 needSync; /* Sync journal before writing this page */
drh80e35f42007-03-30 14:06:34 +0000164 u8 alwaysRollback; /* Disable DontRollback() for this page */
drhac69b052004-05-12 13:30:07 +0000165 short int nRef; /* Number of users of this page */
drhdc3e10b2006-06-15 14:31:06 +0000166 PgHdr *pDirty, *pPrevDirty; /* Dirty pages */
drh605ad8f2006-05-03 23:34:05 +0000167 u32 notUsed; /* Buffer space */
danielk19773c407372005-02-15 02:54:14 +0000168#ifdef SQLITE_CHECK_PAGES
169 u32 pageHash;
170#endif
drh1c7880e2005-05-20 20:01:55 +0000171 /* pPager->pageSize bytes of page data follow this header */
drh973b6e32003-02-12 14:09:42 +0000172 /* Pager.nExtra bytes of local data follow the page data */
drhed7c8552001-04-11 14:29:21 +0000173};
174
drhac69b052004-05-12 13:30:07 +0000175/*
176** For an in-memory only database, some extra information is recorded about
177** each page so that changes can be rolled back. (Journal files are not
178** used for in-memory databases.) The following information is added to
179** the end of every EXTRA block for in-memory databases.
180**
181** This information could have been added directly to the PgHdr structure.
182** But then it would take up an extra 8 bytes of storage on every PgHdr
183** even for disk-based databases. Splitting it out saves 8 bytes. This
184** is only a savings of 0.8% but those percentages add up.
185*/
186typedef struct PgHistory PgHistory;
187struct PgHistory {
188 u8 *pOrig; /* Original page text. Restore to this on a full rollback */
189 u8 *pStmt; /* Text as it was at the beginning of the current statement */
danielk1977f35843b2007-04-07 15:03:17 +0000190 PgHdr *pNextStmt, *pPrevStmt; /* List of pages in the statement journal */
191 u8 inStmt; /* TRUE if in the statement subjournal */
drhac69b052004-05-12 13:30:07 +0000192};
drh9eb9e262004-02-11 02:18:05 +0000193
194/*
195** A macro used for invoking the codec if there is one
196*/
197#ifdef SQLITE_HAS_CODEC
drhc001c582006-03-06 18:23:16 +0000198# define CODEC1(P,D,N,X) if( P->xCodec!=0 ){ P->xCodec(P->pCodecArg,D,N,X); }
199# define CODEC2(P,D,N,X) ((char*)(P->xCodec!=0?P->xCodec(P->pCodecArg,D,N,X):D))
drh9eb9e262004-02-11 02:18:05 +0000200#else
drhc001c582006-03-06 18:23:16 +0000201# define CODEC1(P,D,N,X) /* NO-OP */
202# define CODEC2(P,D,N,X) ((char*)D)
drh9eb9e262004-02-11 02:18:05 +0000203#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** A open page cache is an instance of the following structure.
danielk1977efaaf572006-01-16 11:29:19 +0000217**
drh4f0ee682007-03-30 20:43:40 +0000218** Pager.errCode may be set to SQLITE_IOERR, SQLITE_CORRUPT, or
danielk1977efaaf572006-01-16 11:29:19 +0000219** or SQLITE_FULL. Once one of the first three errors occurs, it persists
220** and is returned as the result of every major pager API call. The
221** SQLITE_FULL return code is slightly different. It persists only until the
222** next successful rollback is performed on the pager cache. Also,
danielk19773b8a05f2007-03-19 17:44:26 +0000223** SQLITE_FULL does not affect the sqlite3PagerGet() and sqlite3PagerLookup()
danielk1977efaaf572006-01-16 11:29:19 +0000224** APIs, they may still be used successfully.
drhed7c8552001-04-11 14:29:21 +0000225*/
226struct Pager {
drh603240c2002-03-05 01:11:12 +0000227 u8 journalOpen; /* True if journal file descriptors is valid */
drh34e79ce2004-02-08 06:05:46 +0000228 u8 journalStarted; /* True if header of journal is synced */
229 u8 useJournal; /* Use a rollback journal on this file */
drh7bec5052005-02-06 02:45:41 +0000230 u8 noReadlock; /* Do not bother to obtain readlocks */
drhac69b052004-05-12 13:30:07 +0000231 u8 stmtOpen; /* True if the statement subjournal is open */
232 u8 stmtInUse; /* True we are in a statement subtransaction */
233 u8 stmtAutoopen; /* Open stmt journal when main journal is opened*/
drh603240c2002-03-05 01:11:12 +0000234 u8 noSync; /* Do not sync the journal if true */
drh968af522003-02-11 14:55:40 +0000235 u8 fullSync; /* Do extra syncs of the journal for robustness */
drhac530b12006-02-11 01:25:50 +0000236 u8 full_fsync; /* Use F_FULLFSYNC when available */
drha6abd042004-06-09 17:37:22 +0000237 u8 state; /* PAGER_UNLOCK, _SHARED, _RESERVED, etc. */
drh603240c2002-03-05 01:11:12 +0000238 u8 tempFile; /* zFilename is a temporary file */
239 u8 readOnly; /* True for a read-only database */
240 u8 needSync; /* True if an fsync() is needed on the journal */
drha6abd042004-06-09 17:37:22 +0000241 u8 dirtyCache; /* True if cached pages have changed */
drh80e35f42007-03-30 14:06:34 +0000242 u8 alwaysRollback; /* Disable DontRollback() for all pages */
drhac69b052004-05-12 13:30:07 +0000243 u8 memDb; /* True to inhibit all file I/O */
drh6d156e42005-05-20 20:11:20 +0000244 u8 setMaster; /* True if a m-j name has been written to jrnl */
drh80e35f42007-03-30 14:06:34 +0000245 u8 doNotSync; /* Boolean. While true, do not spill the cache */
246 u8 exclusiveMode; /* Boolean. True if locking_mode==EXCLUSIVE */
247 u8 changeCountDone; /* Set after incrementing the change-counter */
drhe49f9822006-09-15 12:29:16 +0000248 int errCode; /* One of several kinds of errors */
drhfcd35c72005-05-21 02:48:08 +0000249 int dbSize; /* Number of pages in the file */
250 int origDbSize; /* dbSize before the current change */
251 int stmtSize; /* Size of database (in pages) at stmt_begin() */
252 int nRec; /* Number of pages written to the journal */
253 u32 cksumInit; /* Quasi-random value added to every checksum */
254 int stmtNRec; /* Number of records in stmt subjournal */
255 int nExtra; /* Add this many bytes to each in-memory page */
256 int pageSize; /* Number of bytes in a page */
257 int nPage; /* Total number of in-memory pages */
258 int nMaxPage; /* High water mark of nPage */
259 int nRef; /* Number of in-memory pages with PgHdr.nRef>0 */
260 int mxPage; /* Maximum number of pages to hold in cache */
drh603240c2002-03-05 01:11:12 +0000261 u8 *aInJournal; /* One bit for each page in the database file */
drhac69b052004-05-12 13:30:07 +0000262 u8 *aInStmt; /* One bit for each page in the database */
drhfcd35c72005-05-21 02:48:08 +0000263 char *zFilename; /* Name of the database file */
264 char *zJournal; /* Name of the journal file */
265 char *zDirectory; /* Directory hold database and journal files */
drh9cbe6352005-11-29 03:13:21 +0000266 OsFile *fd, *jfd; /* File descriptors for database and journal */
267 OsFile *stfd; /* File descriptor for the statement subjournal*/
drh726de592004-06-10 23:35:50 +0000268 BusyHandler *pBusyHandler; /* Pointer to sqlite.busyHandler */
drhed7c8552001-04-11 14:29:21 +0000269 PgHdr *pFirst, *pLast; /* List of free pages */
drh341eae82003-01-21 02:39:36 +0000270 PgHdr *pFirstSynced; /* First free page with PgHdr.needSync==0 */
drhd9b02572001-04-15 00:37:09 +0000271 PgHdr *pAll; /* List of all pages */
drhac69b052004-05-12 13:30:07 +0000272 PgHdr *pStmt; /* List of pages in the statement subjournal */
drh605ad8f2006-05-03 23:34:05 +0000273 PgHdr *pDirty; /* List of all dirty pages */
drheb206252004-10-01 02:00:31 +0000274 i64 journalOff; /* Current byte offset in the journal file */
275 i64 journalHdr; /* Byte offset to previous journal header */
276 i64 stmtHdrOff; /* First journal header written this statement */
277 i64 stmtCksum; /* cksumInit when statement was started */
drh6d156e42005-05-20 20:11:20 +0000278 i64 stmtJSize; /* Size of journal at stmt_begin() */
danielk197776572402004-06-25 02:38:54 +0000279 int sectorSize; /* Assumed sector size during rollback */
drhfcd35c72005-05-21 02:48:08 +0000280#ifdef SQLITE_TEST
drh7c4ac0c2007-04-05 11:25:58 +0000281 int nHit, nMiss; /* Cache hits and missing */
282 int nRead, nWrite; /* Database pages read/written */
drhfcd35c72005-05-21 02:48:08 +0000283#endif
danielk19773b8a05f2007-03-19 17:44:26 +0000284 void (*xDestructor)(DbPage*,int); /* Call this routine when freeing pages */
285 void (*xReiniter)(DbPage*,int); /* Call this routine when reloading pages */
drh7c4ac0c2007-04-05 11:25:58 +0000286#ifdef SQLITE_HAS_CODEC
drhc001c582006-03-06 18:23:16 +0000287 void *(*xCodec)(void*,void*,Pgno,int); /* Routine for en/decoding data */
drh6d156e42005-05-20 20:11:20 +0000288 void *pCodecArg; /* First argument to xCodec() */
drh7c4ac0c2007-04-05 11:25:58 +0000289#endif
drh8ca0c722006-05-07 17:49:38 +0000290 int nHash; /* Size of the pager hash table */
291 PgHdr **aHash; /* Hash table to map page number to PgHdr */
drh6f7adc82006-01-11 21:41:20 +0000292#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
danielk197713f72992005-12-18 08:51:22 +0000293 Pager *pNext; /* Linked list of pagers in this thread */
294#endif
danielk19778186df82007-03-06 13:45:59 +0000295 char *pTmpSpace; /* Pager.pageSize bytes of space for tmp use */
danielk1977e277be02007-03-23 18:12:06 +0000296 u32 iChangeCount; /* Db change-counter for which cache is valid */
drhd9b02572001-04-15 00:37:09 +0000297};
298
299/*
drhfcd35c72005-05-21 02:48:08 +0000300** If SQLITE_TEST is defined then increment the variable given in
301** the argument
302*/
303#ifdef SQLITE_TEST
304# define TEST_INCR(x) x++
305#else
306# define TEST_INCR(x)
307#endif
308
309/*
drh5e00f6c2001-09-13 13:46:56 +0000310** Journal files begin with the following magic string. The data
311** was obtained from /dev/random. It is used only as a sanity check.
drh94f33312002-08-12 12:29:56 +0000312**
drhae2b40c2004-06-09 19:03:54 +0000313** Since version 2.8.0, the journal format contains additional sanity
314** checking information. If the power fails while the journal is begin
315** written, semi-random garbage data might appear in the journal
316** file after power is restored. If an attempt is then made
drh968af522003-02-11 14:55:40 +0000317** to roll the journal back, the database could be corrupted. The additional
318** sanity checking data is an attempt to discover the garbage in the
319** journal and ignore it.
320**
drhae2b40c2004-06-09 19:03:54 +0000321** The sanity checking information for the new journal format consists
drh968af522003-02-11 14:55:40 +0000322** of a 32-bit checksum on each page of data. The checksum covers both
drh90f5ecb2004-07-22 01:19:35 +0000323** the page number and the pPager->pageSize bytes of data for the page.
drh968af522003-02-11 14:55:40 +0000324** This cksum is initialized to a 32-bit random value that appears in the
325** journal file right after the header. The random initializer is important,
326** because garbage data that appears at the end of a journal is likely
327** data that was once in other files that have now been deleted. If the
328** garbage data came from an obsolete journal file, the checksums might
329** be correct. But by initializing the checksum to random value which
330** is different for every journal, we minimize that risk.
drhd9b02572001-04-15 00:37:09 +0000331*/
drhae2b40c2004-06-09 19:03:54 +0000332static const unsigned char aJournalMagic[] = {
333 0xd9, 0xd5, 0x05, 0xf9, 0x20, 0xa1, 0x63, 0xd7,
drhed7c8552001-04-11 14:29:21 +0000334};
335
336/*
drh726de592004-06-10 23:35:50 +0000337** The size of the header and of each page in the journal is determined
338** by the following macros.
drh968af522003-02-11 14:55:40 +0000339*/
drhae2b40c2004-06-09 19:03:54 +0000340#define JOURNAL_PG_SZ(pPager) ((pPager->pageSize) + 8)
drh968af522003-02-11 14:55:40 +0000341
danielk197776572402004-06-25 02:38:54 +0000342/*
343** The journal header size for this pager. In the future, this could be
344** set to some value read from the disk controller. The important
345** characteristic is that it is the same size as a disk sector.
346*/
347#define JOURNAL_HDR_SZ(pPager) (pPager->sectorSize)
348
drhb7f91642004-10-31 02:22:47 +0000349/*
350** The macro MEMDB is true if we are dealing with an in-memory database.
351** We do this as a macro so that if the SQLITE_OMIT_MEMORYDB macro is set,
352** the value of MEMDB will be a constant and the compiler will optimize
353** out code that would never execute.
354*/
355#ifdef SQLITE_OMIT_MEMORYDB
356# define MEMDB 0
357#else
358# define MEMDB pPager->memDb
359#endif
360
361/*
danielk197776572402004-06-25 02:38:54 +0000362** Page number PAGER_MJ_PGNO is never used in an SQLite database (it is
363** reserved for working around a windows/posix incompatibility). It is
364** used in the journal to signify that the remainder of the journal file
365** is devoted to storing a master journal name - there are no more pages to
366** roll back. See comments for function writeMasterJournal() for details.
367*/
danielk1977599fcba2004-11-08 07:13:13 +0000368/* #define PAGER_MJ_PGNO(x) (PENDING_BYTE/((x)->pageSize)) */
369#define PAGER_MJ_PGNO(x) ((PENDING_BYTE/((x)->pageSize))+1)
danielk197713adf8a2004-06-03 16:08:41 +0000370
drh968af522003-02-11 14:55:40 +0000371/*
danielk197726836652005-01-17 01:33:13 +0000372** The maximum legal page number is (2^31 - 1).
373*/
374#define PAGER_MAX_PGNO 2147483647
375
376/*
drh726de592004-06-10 23:35:50 +0000377** Enable reference count tracking (for debugging) here:
drhdd793422001-06-28 01:54:48 +0000378*/
drh7c4ac0c2007-04-05 11:25:58 +0000379#ifdef SQLITE_DEBUG
drh3aac2dd2004-04-26 14:10:20 +0000380 int pager3_refinfo_enable = 0;
drhdd793422001-06-28 01:54:48 +0000381 static void pager_refinfo(PgHdr *p){
382 static int cnt = 0;
drh3aac2dd2004-04-26 14:10:20 +0000383 if( !pager3_refinfo_enable ) return;
drhfe63d1c2004-09-08 20:13:04 +0000384 sqlite3DebugPrintf(
drh24c9a2e2007-01-05 02:00:47 +0000385 "REFCNT: %4d addr=%p nRef=%-3d total=%d\n",
386 p->pgno, PGHDR_TO_DATA(p), p->nRef, p->pPager->nRef
drhdd793422001-06-28 01:54:48 +0000387 );
388 cnt++; /* Something to set a breakpoint on */
389 }
390# define REFINFO(X) pager_refinfo(X)
391#else
392# define REFINFO(X)
393#endif
394
danielk1977f35843b2007-04-07 15:03:17 +0000395/*
396** Return true if page *pPg has already been written to the statement
397** journal (or statement snapshot has been created, if *pPg is part
398** of an in-memory database).
399*/
400static int pageInStatement(PgHdr *pPg){
401 Pager *pPager = pPg->pPager;
402 if( MEMDB ){
403 return PGHDR_TO_HIST(pPg, pPager)->inStmt;
404 }else{
405 Pgno pgno = pPg->pgno;
406 u8 *a = pPager->aInStmt;
407 return (a && (int)pgno<=pPager->stmtSize && (a[pgno/8] & (1<<(pgno&7))));
408 }
409}
drh8ca0c722006-05-07 17:49:38 +0000410
411/*
412** Change the size of the pager hash table to N. N must be a power
413** of two.
414*/
415static void pager_resize_hash_table(Pager *pPager, int N){
416 PgHdr **aHash, *pPg;
417 assert( N>0 && (N&(N-1))==0 );
418 aHash = sqliteMalloc( sizeof(aHash[0])*N );
419 if( aHash==0 ){
420 /* Failure to rehash is not an error. It is only a performance hit. */
421 return;
422 }
423 sqliteFree(pPager->aHash);
424 pPager->nHash = N;
425 pPager->aHash = aHash;
426 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
drh3765df42006-06-28 18:18:09 +0000427 int h;
428 if( pPg->pgno==0 ){
429 assert( pPg->pNextHash==0 && pPg->pPrevHash==0 );
430 continue;
431 }
432 h = pPg->pgno & (N-1);
drh8ca0c722006-05-07 17:49:38 +0000433 pPg->pNextHash = aHash[h];
434 if( aHash[h] ){
435 aHash[h]->pPrevHash = pPg;
436 }
437 aHash[h] = pPg;
438 pPg->pPrevHash = 0;
439 }
440}
441
drhdd793422001-06-28 01:54:48 +0000442/*
drh34e79ce2004-02-08 06:05:46 +0000443** Read a 32-bit integer from the given file descriptor. Store the integer
444** that is read in *pRes. Return SQLITE_OK if everything worked, or an
445** error code is something goes wrong.
drh726de592004-06-10 23:35:50 +0000446**
447** All values are stored on disk as big-endian.
drh94f33312002-08-12 12:29:56 +0000448*/
drhae2b40c2004-06-09 19:03:54 +0000449static int read32bits(OsFile *fd, u32 *pRes){
drh3b59a5c2006-01-15 20:28:28 +0000450 unsigned char ac[4];
451 int rc = sqlite3OsRead(fd, ac, sizeof(ac));
drhae2b40c2004-06-09 19:03:54 +0000452 if( rc==SQLITE_OK ){
drh3b59a5c2006-01-15 20:28:28 +0000453 *pRes = (ac[0]<<24) | (ac[1]<<16) | (ac[2]<<8) | ac[3];
drh94f33312002-08-12 12:29:56 +0000454 }
drh94f33312002-08-12 12:29:56 +0000455 return rc;
456}
457
458/*
drh97b57482006-01-10 20:32:32 +0000459** Write a 32-bit integer into a string buffer in big-endian byte order.
460*/
461static void put32bits(char *ac, u32 val){
462 ac[0] = (val>>24) & 0xff;
463 ac[1] = (val>>16) & 0xff;
464 ac[2] = (val>>8) & 0xff;
465 ac[3] = val & 0xff;
466}
467
468/*
drh34e79ce2004-02-08 06:05:46 +0000469** Write a 32-bit integer into the given file descriptor. Return SQLITE_OK
470** on success or an error code is something goes wrong.
drh94f33312002-08-12 12:29:56 +0000471*/
472static int write32bits(OsFile *fd, u32 val){
danielk1977bab45c62006-01-16 15:14:27 +0000473 char ac[4];
drh97b57482006-01-10 20:32:32 +0000474 put32bits(ac, val);
drh054889e2005-11-30 03:20:31 +0000475 return sqlite3OsWrite(fd, ac, 4);
drh94f33312002-08-12 12:29:56 +0000476}
477
drh2554f8b2003-01-22 01:26:44 +0000478/*
danielk1977aa5ccdf2004-06-14 05:10:42 +0000479** Read a 32-bit integer at offset 'offset' from the page identified by
480** page header 'p'.
481*/
482static u32 retrieve32bits(PgHdr *p, int offset){
483 unsigned char *ac;
484 ac = &((unsigned char*)PGHDR_TO_DATA(p))[offset];
485 return (ac[0]<<24) | (ac[1]<<16) | (ac[2]<<8) | ac[3];
486}
487
drh94f33312002-08-12 12:29:56 +0000488
489/*
danielk1977aef0bf62005-12-30 16:28:01 +0000490** This function should be called when an error occurs within the pager
danielk1977a96a7102006-01-16 12:46:41 +0000491** code. The first argument is a pointer to the pager structure, the
492** second the error-code about to be returned by a pager API function.
493** The value returned is a copy of the second argument to this function.
494**
drh4f0ee682007-03-30 20:43:40 +0000495** If the second argument is SQLITE_IOERR, SQLITE_CORRUPT, or SQLITE_FULL
danielk1977a96a7102006-01-16 12:46:41 +0000496** the error becomes persistent. All subsequent API calls on this Pager
497** will immediately return the same error code.
danielk1977aef0bf62005-12-30 16:28:01 +0000498*/
499static int pager_error(Pager *pPager, int rc){
drh4ac285a2006-09-15 07:28:50 +0000500 int rc2 = rc & 0xff;
danielk1977efaaf572006-01-16 11:29:19 +0000501 assert( pPager->errCode==SQLITE_FULL || pPager->errCode==SQLITE_OK );
danielk1977979f38e2007-03-27 16:19:51 +0000502 if(
drh4ac285a2006-09-15 07:28:50 +0000503 rc2==SQLITE_FULL ||
504 rc2==SQLITE_IOERR ||
drh4f0ee682007-03-30 20:43:40 +0000505 rc2==SQLITE_CORRUPT
danielk1977efaaf572006-01-16 11:29:19 +0000506 ){
507 pPager->errCode = rc;
danielk1977aef0bf62005-12-30 16:28:01 +0000508 }
509 return rc;
510}
511
danielk19773c407372005-02-15 02:54:14 +0000512#ifdef SQLITE_CHECK_PAGES
513/*
514** Return a 32-bit hash of the page data for pPage.
515*/
516static u32 pager_pagehash(PgHdr *pPage){
517 u32 hash = 0;
518 int i;
519 unsigned char *pData = (unsigned char *)PGHDR_TO_DATA(pPage);
520 for(i=0; i<pPage->pPager->pageSize; i++){
521 hash = (hash+i)^pData[i];
522 }
523 return hash;
524}
525
526/*
527** The CHECK_PAGE macro takes a PgHdr* as an argument. If SQLITE_CHECK_PAGES
528** is defined, and NDEBUG is not defined, an assert() statement checks
529** that the page is either dirty or still matches the calculated page-hash.
530*/
531#define CHECK_PAGE(x) checkPage(x)
532static void checkPage(PgHdr *pPg){
533 Pager *pPager = pPg->pPager;
danielk1977efaaf572006-01-16 11:29:19 +0000534 assert( !pPg->pageHash || pPager->errCode || MEMDB || pPg->dirty ||
danielk19773c407372005-02-15 02:54:14 +0000535 pPg->pageHash==pager_pagehash(pPg) );
536}
537
538#else
539#define CHECK_PAGE(x)
540#endif
541
drhed7c8552001-04-11 14:29:21 +0000542/*
danielk197776572402004-06-25 02:38:54 +0000543** When this is called the journal file for pager pPager must be open.
544** The master journal file name is read from the end of the file and
545** written into memory obtained from sqliteMalloc(). *pzMaster is
546** set to point at the memory and SQLITE_OK returned. The caller must
547** sqliteFree() *pzMaster.
548**
549** If no master journal file name is present *pzMaster is set to 0 and
550** SQLITE_OK returned.
551*/
552static int readMasterJournal(OsFile *pJrnl, char **pzMaster){
553 int rc;
554 u32 len;
drheb206252004-10-01 02:00:31 +0000555 i64 szJ;
danielk1977c3e8f5e2004-06-28 01:16:46 +0000556 u32 cksum;
danielk1977cafadba2004-06-25 11:11:54 +0000557 int i;
danielk197776572402004-06-25 02:38:54 +0000558 unsigned char aMagic[8]; /* A buffer to hold the magic header */
559
560 *pzMaster = 0;
561
drh054889e2005-11-30 03:20:31 +0000562 rc = sqlite3OsFileSize(pJrnl, &szJ);
danielk1977cafadba2004-06-25 11:11:54 +0000563 if( rc!=SQLITE_OK || szJ<16 ) return rc;
danielk197776572402004-06-25 02:38:54 +0000564
drh054889e2005-11-30 03:20:31 +0000565 rc = sqlite3OsSeek(pJrnl, szJ-16);
danielk197776572402004-06-25 02:38:54 +0000566 if( rc!=SQLITE_OK ) return rc;
567
568 rc = read32bits(pJrnl, &len);
569 if( rc!=SQLITE_OK ) return rc;
570
danielk1977cafadba2004-06-25 11:11:54 +0000571 rc = read32bits(pJrnl, &cksum);
572 if( rc!=SQLITE_OK ) return rc;
573
drh054889e2005-11-30 03:20:31 +0000574 rc = sqlite3OsRead(pJrnl, aMagic, 8);
danielk197776572402004-06-25 02:38:54 +0000575 if( rc!=SQLITE_OK || memcmp(aMagic, aJournalMagic, 8) ) return rc;
576
drh054889e2005-11-30 03:20:31 +0000577 rc = sqlite3OsSeek(pJrnl, szJ-16-len);
danielk197776572402004-06-25 02:38:54 +0000578 if( rc!=SQLITE_OK ) return rc;
579
danielk19778191bff2004-06-28 04:52:30 +0000580 *pzMaster = (char *)sqliteMalloc(len+1);
danielk197776572402004-06-25 02:38:54 +0000581 if( !*pzMaster ){
582 return SQLITE_NOMEM;
583 }
drh054889e2005-11-30 03:20:31 +0000584 rc = sqlite3OsRead(pJrnl, *pzMaster, len);
danielk197776572402004-06-25 02:38:54 +0000585 if( rc!=SQLITE_OK ){
586 sqliteFree(*pzMaster);
587 *pzMaster = 0;
588 return rc;
589 }
danielk1977cafadba2004-06-25 11:11:54 +0000590
591 /* See if the checksum matches the master journal name */
592 for(i=0; i<len; i++){
danielk19778191bff2004-06-28 04:52:30 +0000593 cksum -= (*pzMaster)[i];
danielk1977cafadba2004-06-25 11:11:54 +0000594 }
danielk19778191bff2004-06-28 04:52:30 +0000595 if( cksum ){
596 /* If the checksum doesn't add up, then one or more of the disk sectors
597 ** containing the master journal filename is corrupted. This means
598 ** definitely roll back, so just return SQLITE_OK and report a (nul)
599 ** master-journal filename.
600 */
danielk1977cafadba2004-06-25 11:11:54 +0000601 sqliteFree(*pzMaster);
602 *pzMaster = 0;
danielk1977aca790a2005-01-13 11:07:52 +0000603 }else{
604 (*pzMaster)[len] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000605 }
danielk197776572402004-06-25 02:38:54 +0000606
607 return SQLITE_OK;
608}
609
610/*
611** Seek the journal file descriptor to the next sector boundary where a
612** journal header may be read or written. Pager.journalOff is updated with
613** the new seek offset.
614**
615** i.e for a sector size of 512:
616**
617** Input Offset Output Offset
618** ---------------------------------------
619** 0 0
620** 512 512
621** 100 512
622** 2000 2048
623**
624*/
625static int seekJournalHdr(Pager *pPager){
drheb206252004-10-01 02:00:31 +0000626 i64 offset = 0;
627 i64 c = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000628 if( c ){
629 offset = ((c-1)/JOURNAL_HDR_SZ(pPager) + 1) * JOURNAL_HDR_SZ(pPager);
630 }
631 assert( offset%JOURNAL_HDR_SZ(pPager)==0 );
632 assert( offset>=c );
633 assert( (offset-c)<JOURNAL_HDR_SZ(pPager) );
634 pPager->journalOff = offset;
drh054889e2005-11-30 03:20:31 +0000635 return sqlite3OsSeek(pPager->jfd, pPager->journalOff);
danielk197776572402004-06-25 02:38:54 +0000636}
637
638/*
639** The journal file must be open when this routine is called. A journal
640** header (JOURNAL_HDR_SZ bytes) is written into the journal file at the
641** current location.
642**
643** The format for the journal header is as follows:
644** - 8 bytes: Magic identifying journal format.
645** - 4 bytes: Number of records in journal, or -1 no-sync mode is on.
646** - 4 bytes: Random number used for page hash.
647** - 4 bytes: Initial database page count.
648** - 4 bytes: Sector size used by the process that wrote this journal.
649**
danielk1977f42f25c2004-06-25 07:21:28 +0000650** Followed by (JOURNAL_HDR_SZ - 24) bytes of unused space.
danielk197776572402004-06-25 02:38:54 +0000651*/
652static int writeJournalHdr(Pager *pPager){
drh97b57482006-01-10 20:32:32 +0000653 char zHeader[sizeof(aJournalMagic)+16];
danielk19774099f6e2007-03-19 11:25:20 +0000654 int rc;
danielk197776572402004-06-25 02:38:54 +0000655
danielk19774099f6e2007-03-19 11:25:20 +0000656 if( pPager->stmtHdrOff==0 ){
657 pPager->stmtHdrOff = pPager->journalOff;
658 }
659
660 rc = seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +0000661 if( rc ) return rc;
662
663 pPager->journalHdr = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000664 pPager->journalOff += JOURNAL_HDR_SZ(pPager);
665
666 /* FIX ME:
667 **
668 ** Possibly for a pager not in no-sync mode, the journal magic should not
669 ** be written until nRec is filled in as part of next syncJournal().
670 **
671 ** Actually maybe the whole journal header should be delayed until that
672 ** point. Think about this.
673 */
drh97b57482006-01-10 20:32:32 +0000674 memcpy(zHeader, aJournalMagic, sizeof(aJournalMagic));
675 /* The nRec Field. 0xFFFFFFFF for no-sync journals. */
676 put32bits(&zHeader[sizeof(aJournalMagic)], pPager->noSync ? 0xffffffff : 0);
677 /* The random check-hash initialiser */
678 sqlite3Randomness(sizeof(pPager->cksumInit), &pPager->cksumInit);
679 put32bits(&zHeader[sizeof(aJournalMagic)+4], pPager->cksumInit);
680 /* The initial database size */
681 put32bits(&zHeader[sizeof(aJournalMagic)+8], pPager->dbSize);
682 /* The assumed sector size for this process */
683 put32bits(&zHeader[sizeof(aJournalMagic)+12], pPager->sectorSize);
drhb0603412007-02-28 04:47:26 +0000684 IOTRACE(("JHDR %p %lld %d\n", pPager, pPager->journalHdr, sizeof(zHeader)))
drh97b57482006-01-10 20:32:32 +0000685 rc = sqlite3OsWrite(pPager->jfd, zHeader, sizeof(zHeader));
danielk197776572402004-06-25 02:38:54 +0000686
687 /* The journal header has been written successfully. Seek the journal
688 ** file descriptor to the end of the journal header sector.
689 */
690 if( rc==SQLITE_OK ){
drhb0603412007-02-28 04:47:26 +0000691 IOTRACE(("JTAIL %p %lld\n", pPager, pPager->journalOff-1))
drh054889e2005-11-30 03:20:31 +0000692 rc = sqlite3OsSeek(pPager->jfd, pPager->journalOff-1);
drhb4746b92005-09-09 01:32:06 +0000693 if( rc==SQLITE_OK ){
drh054889e2005-11-30 03:20:31 +0000694 rc = sqlite3OsWrite(pPager->jfd, "\000", 1);
drhb4746b92005-09-09 01:32:06 +0000695 }
danielk197776572402004-06-25 02:38:54 +0000696 }
697 return rc;
698}
699
700/*
701** The journal file must be open when this is called. A journal header file
702** (JOURNAL_HDR_SZ bytes) is read from the current location in the journal
703** file. See comments above function writeJournalHdr() for a description of
704** the journal header format.
705**
706** If the header is read successfully, *nRec is set to the number of
707** page records following this header and *dbSize is set to the size of the
708** database before the transaction began, in pages. Also, pPager->cksumInit
709** is set to the value read from the journal header. SQLITE_OK is returned
710** in this case.
711**
712** If the journal header file appears to be corrupted, SQLITE_DONE is
713** returned and *nRec and *dbSize are not set. If JOURNAL_HDR_SZ bytes
714** cannot be read from the journal file an error code is returned.
715*/
716static int readJournalHdr(
717 Pager *pPager,
drheb206252004-10-01 02:00:31 +0000718 i64 journalSize,
danielk197776572402004-06-25 02:38:54 +0000719 u32 *pNRec,
720 u32 *pDbSize
721){
722 int rc;
723 unsigned char aMagic[8]; /* A buffer to hold the magic header */
724
725 rc = seekJournalHdr(pPager);
726 if( rc ) return rc;
727
728 if( pPager->journalOff+JOURNAL_HDR_SZ(pPager) > journalSize ){
729 return SQLITE_DONE;
730 }
731
drh054889e2005-11-30 03:20:31 +0000732 rc = sqlite3OsRead(pPager->jfd, aMagic, sizeof(aMagic));
danielk197776572402004-06-25 02:38:54 +0000733 if( rc ) return rc;
734
735 if( memcmp(aMagic, aJournalMagic, sizeof(aMagic))!=0 ){
736 return SQLITE_DONE;
737 }
738
drh9cbe6352005-11-29 03:13:21 +0000739 rc = read32bits(pPager->jfd, pNRec);
danielk197776572402004-06-25 02:38:54 +0000740 if( rc ) return rc;
741
drh9cbe6352005-11-29 03:13:21 +0000742 rc = read32bits(pPager->jfd, &pPager->cksumInit);
danielk197776572402004-06-25 02:38:54 +0000743 if( rc ) return rc;
744
drh9cbe6352005-11-29 03:13:21 +0000745 rc = read32bits(pPager->jfd, pDbSize);
danielk197776572402004-06-25 02:38:54 +0000746 if( rc ) return rc;
747
748 /* Update the assumed sector-size to match the value used by
749 ** the process that created this journal. If this journal was
750 ** created by a process other than this one, then this routine
751 ** is being called from within pager_playback(). The local value
752 ** of Pager.sectorSize is restored at the end of that routine.
753 */
drh9cbe6352005-11-29 03:13:21 +0000754 rc = read32bits(pPager->jfd, (u32 *)&pPager->sectorSize);
danielk197776572402004-06-25 02:38:54 +0000755 if( rc ) return rc;
756
757 pPager->journalOff += JOURNAL_HDR_SZ(pPager);
drh054889e2005-11-30 03:20:31 +0000758 rc = sqlite3OsSeek(pPager->jfd, pPager->journalOff);
danielk197776572402004-06-25 02:38:54 +0000759 return rc;
760}
761
762
763/*
764** Write the supplied master journal name into the journal file for pager
danielk1977cafadba2004-06-25 11:11:54 +0000765** pPager at the current location. The master journal name must be the last
766** thing written to a journal file. If the pager is in full-sync mode, the
767** journal file descriptor is advanced to the next sector boundary before
768** anything is written. The format is:
769**
770** + 4 bytes: PAGER_MJ_PGNO.
771** + N bytes: length of master journal name.
772** + 4 bytes: N
773** + 4 bytes: Master journal name checksum.
774** + 8 bytes: aJournalMagic[].
775**
776** The master journal page checksum is the sum of the bytes in the master
777** journal name.
danielk1977aef0bf62005-12-30 16:28:01 +0000778**
779** If zMaster is a NULL pointer (occurs for a single database transaction),
780** this call is a no-op.
danielk197776572402004-06-25 02:38:54 +0000781*/
782static int writeMasterJournal(Pager *pPager, const char *zMaster){
783 int rc;
784 int len;
danielk1977cafadba2004-06-25 11:11:54 +0000785 int i;
drh97b57482006-01-10 20:32:32 +0000786 u32 cksum = 0;
787 char zBuf[sizeof(aJournalMagic)+2*4];
danielk197776572402004-06-25 02:38:54 +0000788
789 if( !zMaster || pPager->setMaster) return SQLITE_OK;
790 pPager->setMaster = 1;
791
792 len = strlen(zMaster);
danielk1977cafadba2004-06-25 11:11:54 +0000793 for(i=0; i<len; i++){
794 cksum += zMaster[i];
795 }
danielk197776572402004-06-25 02:38:54 +0000796
797 /* If in full-sync mode, advance to the next disk sector before writing
798 ** the master journal name. This is in case the previous page written to
799 ** the journal has already been synced.
800 */
801 if( pPager->fullSync ){
802 rc = seekJournalHdr(pPager);
803 if( rc!=SQLITE_OK ) return rc;
804 }
danielk1977cafadba2004-06-25 11:11:54 +0000805 pPager->journalOff += (len+20);
danielk197776572402004-06-25 02:38:54 +0000806
drh9cbe6352005-11-29 03:13:21 +0000807 rc = write32bits(pPager->jfd, PAGER_MJ_PGNO(pPager));
danielk197776572402004-06-25 02:38:54 +0000808 if( rc!=SQLITE_OK ) return rc;
809
drh054889e2005-11-30 03:20:31 +0000810 rc = sqlite3OsWrite(pPager->jfd, zMaster, len);
danielk197776572402004-06-25 02:38:54 +0000811 if( rc!=SQLITE_OK ) return rc;
812
drh97b57482006-01-10 20:32:32 +0000813 put32bits(zBuf, len);
814 put32bits(&zBuf[4], cksum);
815 memcpy(&zBuf[8], aJournalMagic, sizeof(aJournalMagic));
816 rc = sqlite3OsWrite(pPager->jfd, zBuf, 8+sizeof(aJournalMagic));
drh2c8997b2005-08-27 16:36:48 +0000817 pPager->needSync = !pPager->noSync;
danielk197776572402004-06-25 02:38:54 +0000818 return rc;
819}
820
821/*
drh03eb96a2002-11-10 23:32:56 +0000822** Add or remove a page from the list of all pages that are in the
drhac69b052004-05-12 13:30:07 +0000823** statement journal.
drh03eb96a2002-11-10 23:32:56 +0000824**
825** The Pager keeps a separate list of pages that are currently in
danielk19773b8a05f2007-03-19 17:44:26 +0000826** the statement journal. This helps the sqlite3PagerStmtCommit()
drh03eb96a2002-11-10 23:32:56 +0000827** routine run MUCH faster for the common case where there are many
drhac69b052004-05-12 13:30:07 +0000828** pages in memory but only a few are in the statement journal.
drh03eb96a2002-11-10 23:32:56 +0000829*/
drh3aac2dd2004-04-26 14:10:20 +0000830static void page_add_to_stmt_list(PgHdr *pPg){
drh03eb96a2002-11-10 23:32:56 +0000831 Pager *pPager = pPg->pPager;
danielk1977f35843b2007-04-07 15:03:17 +0000832 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
833 assert( MEMDB );
834 if( !pHist->inStmt ){
835 assert( pHist->pPrevStmt==0 && pHist->pNextStmt==0 );
836 if( pPager->pStmt ){
837 PGHDR_TO_HIST(pPager->pStmt, pPager)->pPrevStmt = pPg;
838 }
839 pHist->pNextStmt = pPager->pStmt;
840 pPager->pStmt = pPg;
841 pHist->inStmt = 1;
drh03eb96a2002-11-10 23:32:56 +0000842 }
drh03eb96a2002-11-10 23:32:56 +0000843}
844
845/*
drhed7c8552001-04-11 14:29:21 +0000846** Find a page in the hash table given its page number. Return
847** a pointer to the page or NULL if not found.
848*/
drhd9b02572001-04-15 00:37:09 +0000849static PgHdr *pager_lookup(Pager *pPager, Pgno pgno){
drh8ca0c722006-05-07 17:49:38 +0000850 PgHdr *p;
851 if( pPager->aHash==0 ) return 0;
852 p = pPager->aHash[pgno & (pPager->nHash-1)];
drhed7c8552001-04-11 14:29:21 +0000853 while( p && p->pgno!=pgno ){
854 p = p->pNextHash;
855 }
856 return p;
857}
858
859/*
drh1aa2d8b2007-01-03 15:34:29 +0000860** Unlock the database file.
drh1aa2d8b2007-01-03 15:34:29 +0000861*/
862static void pager_unlock(Pager *pPager){
danielk197741483462007-03-24 16:45:04 +0000863 if( !pPager->exclusiveMode ){
864 if( !MEMDB ){
865 sqlite3OsUnlock(pPager->fd, NO_LOCK);
866 pPager->dbSize = -1;
867 IOTRACE(("UNLOCK %p\n", pPager))
868 }
869 pPager->state = PAGER_UNLOCK;
870 pPager->changeCountDone = 0;
drh1aa2d8b2007-01-03 15:34:29 +0000871 }
danielk1977e277be02007-03-23 18:12:06 +0000872}
873
874/*
875** Execute a rollback if a transaction is active and unlock the
876** database file. This is a no-op if the pager has already entered
877** the error-state.
878*/
danielk1977334cdb62007-03-26 08:05:12 +0000879static void pagerUnlockAndRollback(Pager *p){
880 if( p->errCode ) return;
danielk1977c5859712007-03-26 12:26:27 +0000881 assert( p->state>=PAGER_RESERVED || p->journalOpen==0 );
danielk1977334cdb62007-03-26 08:05:12 +0000882 if( p->state>=PAGER_RESERVED ){
883 sqlite3PagerRollback(p);
danielk1977e277be02007-03-23 18:12:06 +0000884 }
danielk1977334cdb62007-03-26 08:05:12 +0000885 pager_unlock(p);
886 assert( p->errCode || !p->journalOpen || (p->exclusiveMode&&!p->journalOff) );
887 assert( p->errCode || !p->stmtOpen || p->exclusiveMode );
drh1aa2d8b2007-01-03 15:34:29 +0000888}
889
890
891/*
danielk1977e180dd92007-04-05 17:15:52 +0000892** Clear the in-memory cache. This routine
drhed7c8552001-04-11 14:29:21 +0000893** sets the state of the pager back to what it was when it was first
894** opened. Any outstanding pages are invalidated and subsequent attempts
895** to access those pages will likely result in a coredump.
896*/
drhd9b02572001-04-15 00:37:09 +0000897static void pager_reset(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +0000898 PgHdr *pPg, *pNext;
danielk1977efaaf572006-01-16 11:29:19 +0000899 if( pPager->errCode ) return;
drhd9b02572001-04-15 00:37:09 +0000900 for(pPg=pPager->pAll; pPg; pPg=pNext){
901 pNext = pPg->pNextAll;
902 sqliteFree(pPg);
drhed7c8552001-04-11 14:29:21 +0000903 }
danielk1977b94bf852007-03-19 13:53:37 +0000904 pPager->pStmt = 0;
drhed7c8552001-04-11 14:29:21 +0000905 pPager->pFirst = 0;
drh341eae82003-01-21 02:39:36 +0000906 pPager->pFirstSynced = 0;
drhd9b02572001-04-15 00:37:09 +0000907 pPager->pLast = 0;
908 pPager->pAll = 0;
drh8ca0c722006-05-07 17:49:38 +0000909 pPager->nHash = 0;
910 sqliteFree(pPager->aHash);
drhed7c8552001-04-11 14:29:21 +0000911 pPager->nPage = 0;
drh8ca0c722006-05-07 17:49:38 +0000912 pPager->aHash = 0;
drhed7c8552001-04-11 14:29:21 +0000913 pPager->nRef = 0;
danielk1977e277be02007-03-23 18:12:06 +0000914}
915
916/*
drh80e35f42007-03-30 14:06:34 +0000917** This routine ends a transaction. A transaction is ended by either
918** a COMMIT or a ROLLBACK.
919**
drhed7c8552001-04-11 14:29:21 +0000920** When this routine is called, the pager has the journal file open and
drh80e35f42007-03-30 14:06:34 +0000921** a RESERVED or EXCLUSIVE lock on the database. This routine will release
922** the database lock and acquires a SHARED lock in its place if that is
923** the appropriate thing to do. Release locks usually is appropriate,
924** unless we are in exclusive access mode or unless this is a
925** COMMIT AND BEGIN or ROLLBACK AND BEGIN operation.
926**
927** The journal file is either deleted or truncated.
drh50457892003-09-06 01:10:47 +0000928**
929** TODO: Consider keeping the journal file open for temporary databases.
930** This might give a performance improvement on windows where opening
931** a file is an expensive operation.
drhed7c8552001-04-11 14:29:21 +0000932*/
drh80e35f42007-03-30 14:06:34 +0000933static int pager_end_transaction(Pager *pPager){
drhd9b02572001-04-15 00:37:09 +0000934 PgHdr *pPg;
danielk197741483462007-03-24 16:45:04 +0000935 int rc = SQLITE_OK;
danielk1977979f38e2007-03-27 16:19:51 +0000936 int rc2 = SQLITE_OK;
drhb7f91642004-10-31 02:22:47 +0000937 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +0000938 if( pPager->state<PAGER_RESERVED ){
939 return SQLITE_OK;
940 }
danielk19773b8a05f2007-03-19 17:44:26 +0000941 sqlite3PagerStmtCommit(pPager);
danielk1977334cdb62007-03-26 08:05:12 +0000942 if( pPager->stmtOpen && !pPager->exclusiveMode ){
danielk1977979f38e2007-03-27 16:19:51 +0000943 sqlite3OsClose(&pPager->stfd);
944 pPager->stmtOpen = 0;
drh0f892532002-05-30 12:27:03 +0000945 }
drhda47d772002-12-02 04:25:19 +0000946 if( pPager->journalOpen ){
drh01fa4c32007-04-02 11:22:22 +0000947 if( pPager->exclusiveMode
948 && (rc = sqlite3OsTruncate(pPager->jfd, 0))==SQLITE_OK ){;
danielk197741483462007-03-24 16:45:04 +0000949 sqlite3OsSeek(pPager->jfd, 0);
950 pPager->journalOff = 0;
danielk1977334cdb62007-03-26 08:05:12 +0000951 pPager->journalStarted = 0;
danielk197741483462007-03-24 16:45:04 +0000952 }else{
953 sqlite3OsClose(&pPager->jfd);
954 pPager->journalOpen = 0;
drh01fa4c32007-04-02 11:22:22 +0000955 if( rc==SQLITE_OK ){
danielk19777152de82007-03-29 17:28:14 +0000956 rc = sqlite3OsDelete(pPager->zJournal);
957 }
danielk197741483462007-03-24 16:45:04 +0000958 }
drhda47d772002-12-02 04:25:19 +0000959 sqliteFree( pPager->aInJournal );
960 pPager->aInJournal = 0;
961 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
962 pPg->inJournal = 0;
963 pPg->dirty = 0;
drhdb48ee02003-01-16 13:42:43 +0000964 pPg->needSync = 0;
danielk197741483462007-03-24 16:45:04 +0000965 pPg->alwaysRollback = 0;
danielk19773c407372005-02-15 02:54:14 +0000966#ifdef SQLITE_CHECK_PAGES
967 pPg->pageHash = pager_pagehash(pPg);
968#endif
drhda47d772002-12-02 04:25:19 +0000969 }
drh605ad8f2006-05-03 23:34:05 +0000970 pPager->pDirty = 0;
danielk1977ef317ab2004-06-23 10:43:10 +0000971 pPager->dirtyCache = 0;
danielk1977ef317ab2004-06-23 10:43:10 +0000972 pPager->nRec = 0;
drhda47d772002-12-02 04:25:19 +0000973 }else{
drh88b01a12005-03-28 18:04:27 +0000974 assert( pPager->aInJournal==0 );
drha6abd042004-06-09 17:37:22 +0000975 assert( pPager->dirtyCache==0 || pPager->useJournal==0 );
drhd9b02572001-04-15 00:37:09 +0000976 }
danielk1977979f38e2007-03-27 16:19:51 +0000977
danielk197741483462007-03-24 16:45:04 +0000978 if( !pPager->exclusiveMode ){
danielk1977979f38e2007-03-27 16:19:51 +0000979 rc2 = sqlite3OsUnlock(pPager->fd, SHARED_LOCK);
danielk197741483462007-03-24 16:45:04 +0000980 pPager->state = PAGER_SHARED;
danielk1977334cdb62007-03-26 08:05:12 +0000981 }else if( pPager->state==PAGER_SYNCED ){
982 pPager->state = PAGER_EXCLUSIVE;
danielk197741483462007-03-24 16:45:04 +0000983 }
danielk1977334cdb62007-03-26 08:05:12 +0000984 pPager->origDbSize = 0;
danielk197776572402004-06-25 02:38:54 +0000985 pPager->setMaster = 0;
danielk1977c4da5b92006-01-21 12:08:54 +0000986 pPager->needSync = 0;
987 pPager->pFirstSynced = pPager->pFirst;
drh588f5bc2007-01-02 18:41:54 +0000988 pPager->dbSize = -1;
danielk1977979f38e2007-03-27 16:19:51 +0000989
990 return (rc==SQLITE_OK?rc2:rc);
drhed7c8552001-04-11 14:29:21 +0000991}
992
drhed7c8552001-04-11 14:29:21 +0000993/*
drh968af522003-02-11 14:55:40 +0000994** Compute and return a checksum for the page of data.
drh34e79ce2004-02-08 06:05:46 +0000995**
996** This is not a real checksum. It is really just the sum of the
drh726de592004-06-10 23:35:50 +0000997** random initial value and the page number. We experimented with
998** a checksum of the entire data, but that was found to be too slow.
999**
1000** Note that the page number is stored at the beginning of data and
1001** the checksum is stored at the end. This is important. If journal
1002** corruption occurs due to a power failure, the most likely scenario
1003** is that one end or the other of the record will be changed. It is
1004** much less likely that the two ends of the journal record will be
1005** correct and the middle be corrupt. Thus, this "checksum" scheme,
1006** though fast and simple, catches the mostly likely kind of corruption.
1007**
1008** FIX ME: Consider adding every 200th (or so) byte of the data to the
1009** checksum. That way if a single page spans 3 or more disk sectors and
1010** only the middle sector is corrupt, we will still have a reasonable
1011** chance of failing the checksum and thus detecting the problem.
drh968af522003-02-11 14:55:40 +00001012*/
drh74161702006-02-24 02:53:49 +00001013static u32 pager_cksum(Pager *pPager, const u8 *aData){
danielk1977ef317ab2004-06-23 10:43:10 +00001014 u32 cksum = pPager->cksumInit;
1015 int i = pPager->pageSize-200;
1016 while( i>0 ){
1017 cksum += aData[i];
1018 i -= 200;
1019 }
drh968af522003-02-11 14:55:40 +00001020 return cksum;
1021}
1022
drh605ad8f2006-05-03 23:34:05 +00001023/* Forward declaration */
1024static void makeClean(PgHdr*);
1025
drh968af522003-02-11 14:55:40 +00001026/*
drhfa86c412002-02-02 15:01:15 +00001027** Read a single page from the journal file opened on file descriptor
1028** jfd. Playback this one page.
drh968af522003-02-11 14:55:40 +00001029**
drh726de592004-06-10 23:35:50 +00001030** If useCksum==0 it means this journal does not use checksums. Checksums
1031** are not used in statement journals because statement journals do not
1032** need to survive power failures.
drhfa86c412002-02-02 15:01:15 +00001033*/
drhae2b40c2004-06-09 19:03:54 +00001034static int pager_playback_one_page(Pager *pPager, OsFile *jfd, int useCksum){
drhfa86c412002-02-02 15:01:15 +00001035 int rc;
drhae2b40c2004-06-09 19:03:54 +00001036 PgHdr *pPg; /* An existing page in the cache */
1037 Pgno pgno; /* The page number of a page in journal */
1038 u32 cksum; /* Checksum used for sanity checking */
danielk19778186df82007-03-06 13:45:59 +00001039 u8 *aData = (u8 *)pPager->pTmpSpace; /* Temp storage for a page */
drhfa86c412002-02-02 15:01:15 +00001040
drh96362842005-03-20 22:47:56 +00001041 /* useCksum should be true for the main journal and false for
1042 ** statement journals. Verify that this is always the case
1043 */
drh9cbe6352005-11-29 03:13:21 +00001044 assert( jfd == (useCksum ? pPager->jfd : pPager->stfd) );
danielk19778186df82007-03-06 13:45:59 +00001045 assert( aData );
drh96362842005-03-20 22:47:56 +00001046
drhae2b40c2004-06-09 19:03:54 +00001047 rc = read32bits(jfd, &pgno);
drh99ee3602003-02-16 19:13:36 +00001048 if( rc!=SQLITE_OK ) return rc;
danielk19778186df82007-03-06 13:45:59 +00001049 rc = sqlite3OsRead(jfd, aData, pPager->pageSize);
drh99ee3602003-02-16 19:13:36 +00001050 if( rc!=SQLITE_OK ) return rc;
danielk197776572402004-06-25 02:38:54 +00001051 pPager->journalOff += pPager->pageSize + 4;
drhfa86c412002-02-02 15:01:15 +00001052
drh968af522003-02-11 14:55:40 +00001053 /* Sanity checking on the page. This is more important that I originally
1054 ** thought. If a power failure occurs while the journal is being written,
1055 ** it could cause invalid data to be written into the journal. We need to
1056 ** detect this invalid data (with high probability) and ignore it.
1057 */
danielk197775edc162004-06-26 01:48:18 +00001058 if( pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh968af522003-02-11 14:55:40 +00001059 return SQLITE_DONE;
1060 }
drhae2b40c2004-06-09 19:03:54 +00001061 if( pgno>(unsigned)pPager->dbSize ){
drh968af522003-02-11 14:55:40 +00001062 return SQLITE_OK;
1063 }
drhae2b40c2004-06-09 19:03:54 +00001064 if( useCksum ){
1065 rc = read32bits(jfd, &cksum);
drh99ee3602003-02-16 19:13:36 +00001066 if( rc ) return rc;
danielk197776572402004-06-25 02:38:54 +00001067 pPager->journalOff += 4;
drh74161702006-02-24 02:53:49 +00001068 if( pager_cksum(pPager, aData)!=cksum ){
drh968af522003-02-11 14:55:40 +00001069 return SQLITE_DONE;
1070 }
1071 }
drhfa86c412002-02-02 15:01:15 +00001072
danielk1977aa5ccdf2004-06-14 05:10:42 +00001073 assert( pPager->state==PAGER_RESERVED || pPager->state>=PAGER_EXCLUSIVE );
danielk1977a3f3a5f2004-06-10 04:32:16 +00001074
1075 /* If the pager is in RESERVED state, then there must be a copy of this
1076 ** page in the pager cache. In this case just update the pager cache,
danielk19770de0bb32004-06-10 05:59:24 +00001077 ** not the database file. The page is left marked dirty in this case.
1078 **
danielk1977a3f3a5f2004-06-10 04:32:16 +00001079 ** If in EXCLUSIVE state, then we update the pager cache if it exists
1080 ** and the main file. The page is then marked not dirty.
drh96362842005-03-20 22:47:56 +00001081 **
1082 ** Ticket #1171: The statement journal might contain page content that is
1083 ** different from the page content at the start of the transaction.
1084 ** This occurs when a page is changed prior to the start of a statement
1085 ** then changed again within the statement. When rolling back such a
1086 ** statement we must not write to the original database unless we know
1087 ** for certain that original page contents are in the main rollback
1088 ** journal. Otherwise, if a full ROLLBACK occurs after the statement
1089 ** rollback the full ROLLBACK will not restore the page to its original
1090 ** content. Two conditions must be met before writing to the database
1091 ** files. (1) the database must be locked. (2) we know that the original
1092 ** page content is in the main journal either because the page is not in
1093 ** cache or else it is marked as needSync==0.
drhfa86c412002-02-02 15:01:15 +00001094 */
drhae2b40c2004-06-09 19:03:54 +00001095 pPg = pager_lookup(pPager, pgno);
drh96362842005-03-20 22:47:56 +00001096 assert( pPager->state>=PAGER_EXCLUSIVE || pPg!=0 );
drh4f0c5872007-03-26 22:05:01 +00001097 PAGERTRACE3("PLAYBACK %d page %d\n", PAGERID(pPager), pgno);
drh96362842005-03-20 22:47:56 +00001098 if( pPager->state>=PAGER_EXCLUSIVE && (pPg==0 || pPg->needSync==0) ){
drh054889e2005-11-30 03:20:31 +00001099 rc = sqlite3OsSeek(pPager->fd, (pgno-1)*(i64)pPager->pageSize);
drhb4746b92005-09-09 01:32:06 +00001100 if( rc==SQLITE_OK ){
drh054889e2005-11-30 03:20:31 +00001101 rc = sqlite3OsWrite(pPager->fd, aData, pPager->pageSize);
drhb4746b92005-09-09 01:32:06 +00001102 }
drh605ad8f2006-05-03 23:34:05 +00001103 if( pPg ){
1104 makeClean(pPg);
1105 }
danielk1977a3f3a5f2004-06-10 04:32:16 +00001106 }
drhfa86c412002-02-02 15:01:15 +00001107 if( pPg ){
danielk197728129562005-01-11 10:25:06 +00001108 /* No page should ever be explicitly rolled back that is in use, except
1109 ** for page 1 which is held in use in order to keep the lock on the
1110 ** database active. However such a page may be rolled back as a result
1111 ** of an internal error resulting in an automatic call to
danielk19773b8a05f2007-03-19 17:44:26 +00001112 ** sqlite3PagerRollback().
drhacf4ac92003-12-17 23:57:34 +00001113 */
drhb6f41482004-05-14 01:58:11 +00001114 void *pData;
danielk197728129562005-01-11 10:25:06 +00001115 /* assert( pPg->nRef==0 || pPg->pgno==1 ); */
drhb6f41482004-05-14 01:58:11 +00001116 pData = PGHDR_TO_DATA(pPg);
drhae2b40c2004-06-09 19:03:54 +00001117 memcpy(pData, aData, pPager->pageSize);
drh726de592004-06-10 23:35:50 +00001118 if( pPager->xDestructor ){ /*** FIX ME: Should this be xReinit? ***/
danielk19773b8a05f2007-03-19 17:44:26 +00001119 pPager->xDestructor(pPg, pPager->pageSize);
drhde647132004-05-07 17:57:49 +00001120 }
danielk19773c407372005-02-15 02:54:14 +00001121#ifdef SQLITE_CHECK_PAGES
drh96362842005-03-20 22:47:56 +00001122 pPg->pageHash = pager_pagehash(pPg);
danielk19773c407372005-02-15 02:54:14 +00001123#endif
drhc001c582006-03-06 18:23:16 +00001124 CODEC1(pPager, pData, pPg->pgno, 3);
danielk197741483462007-03-24 16:45:04 +00001125
1126 /* If this was page 1, then restore the value of Pager.iChangeCount */
1127 if( pgno==1 ){
1128 pPager->iChangeCount = retrieve32bits(pPg, 24);
1129 }
drhfa86c412002-02-02 15:01:15 +00001130 }
1131 return rc;
1132}
1133
1134/*
danielk197713adf8a2004-06-03 16:08:41 +00001135** Parameter zMaster is the name of a master journal file. A single journal
1136** file that referred to the master journal file has just been rolled back.
1137** This routine checks if it is possible to delete the master journal file,
1138** and does so if it is.
drh726de592004-06-10 23:35:50 +00001139**
1140** The master journal file contains the names of all child journals.
1141** To tell if a master journal can be deleted, check to each of the
1142** children. If all children are either missing or do not refer to
1143** a different master journal, then this master journal can be deleted.
danielk197713adf8a2004-06-03 16:08:41 +00001144*/
1145static int pager_delmaster(const char *zMaster){
1146 int rc;
1147 int master_open = 0;
drh9cbe6352005-11-29 03:13:21 +00001148 OsFile *master = 0;
danielk197713adf8a2004-06-03 16:08:41 +00001149 char *zMasterJournal = 0; /* Contents of master journal file */
drheb206252004-10-01 02:00:31 +00001150 i64 nMasterJournal; /* Size of master journal file */
danielk197713adf8a2004-06-03 16:08:41 +00001151
1152 /* Open the master journal file exclusively in case some other process
1153 ** is running this routine also. Not that it makes too much difference.
1154 */
drh66560ad2006-01-06 14:32:19 +00001155 rc = sqlite3OsOpenReadOnly(zMaster, &master);
danielk19775bb16fe2007-04-05 11:54:42 +00001156 assert( rc!=SQLITE_OK || master );
danielk197713adf8a2004-06-03 16:08:41 +00001157 if( rc!=SQLITE_OK ) goto delmaster_out;
1158 master_open = 1;
drh054889e2005-11-30 03:20:31 +00001159 rc = sqlite3OsFileSize(master, &nMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001160 if( rc!=SQLITE_OK ) goto delmaster_out;
1161
1162 if( nMasterJournal>0 ){
danielk19775865e3d2004-06-14 06:03:57 +00001163 char *zJournal;
danielk197776572402004-06-25 02:38:54 +00001164 char *zMasterPtr = 0;
danielk19775865e3d2004-06-14 06:03:57 +00001165
1166 /* Load the entire master journal file into space obtained from
1167 ** sqliteMalloc() and pointed to by zMasterJournal.
danielk19775865e3d2004-06-14 06:03:57 +00001168 */
danielk197776572402004-06-25 02:38:54 +00001169 zMasterJournal = (char *)sqliteMalloc(nMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001170 if( !zMasterJournal ){
1171 rc = SQLITE_NOMEM;
1172 goto delmaster_out;
1173 }
drh054889e2005-11-30 03:20:31 +00001174 rc = sqlite3OsRead(master, zMasterJournal, nMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001175 if( rc!=SQLITE_OK ) goto delmaster_out;
1176
danielk19775865e3d2004-06-14 06:03:57 +00001177 zJournal = zMasterJournal;
1178 while( (zJournal-zMasterJournal)<nMasterJournal ){
drh66560ad2006-01-06 14:32:19 +00001179 if( sqlite3OsFileExists(zJournal) ){
danielk197713adf8a2004-06-03 16:08:41 +00001180 /* One of the journals pointed to by the master journal exists.
1181 ** Open it and check if it points at the master journal. If
1182 ** so, return without deleting the master journal file.
1183 */
drh9cbe6352005-11-29 03:13:21 +00001184 OsFile *journal = 0;
drh3b7b78b2004-11-24 01:16:43 +00001185 int c;
danielk197713adf8a2004-06-03 16:08:41 +00001186
drh66560ad2006-01-06 14:32:19 +00001187 rc = sqlite3OsOpenReadOnly(zJournal, &journal);
danielk19775bb16fe2007-04-05 11:54:42 +00001188 assert( rc!=SQLITE_OK || journal );
danielk197713adf8a2004-06-03 16:08:41 +00001189 if( rc!=SQLITE_OK ){
danielk197713adf8a2004-06-03 16:08:41 +00001190 goto delmaster_out;
1191 }
danielk197713adf8a2004-06-03 16:08:41 +00001192
drh9cbe6352005-11-29 03:13:21 +00001193 rc = readMasterJournal(journal, &zMasterPtr);
drh054889e2005-11-30 03:20:31 +00001194 sqlite3OsClose(&journal);
danielk19779eed5052004-06-04 10:38:30 +00001195 if( rc!=SQLITE_OK ){
danielk19779eed5052004-06-04 10:38:30 +00001196 goto delmaster_out;
1197 }
danielk197776572402004-06-25 02:38:54 +00001198
drh3b7b78b2004-11-24 01:16:43 +00001199 c = zMasterPtr!=0 && strcmp(zMasterPtr, zMaster)==0;
1200 sqliteFree(zMasterPtr);
1201 if( c ){
danielk197776572402004-06-25 02:38:54 +00001202 /* We have a match. Do not delete the master journal file. */
1203 goto delmaster_out;
danielk197713adf8a2004-06-03 16:08:41 +00001204 }
1205 }
danielk19775865e3d2004-06-14 06:03:57 +00001206 zJournal += (strlen(zJournal)+1);
danielk197713adf8a2004-06-03 16:08:41 +00001207 }
1208 }
1209
danielk1977979f38e2007-03-27 16:19:51 +00001210 rc = sqlite3OsDelete(zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001211
1212delmaster_out:
1213 if( zMasterJournal ){
1214 sqliteFree(zMasterJournal);
1215 }
1216 if( master_open ){
drh054889e2005-11-30 03:20:31 +00001217 sqlite3OsClose(&master);
danielk197713adf8a2004-06-03 16:08:41 +00001218 }
1219 return rc;
1220}
1221
danielk197741483462007-03-24 16:45:04 +00001222#if 0
danielk197713adf8a2004-06-03 16:08:41 +00001223/*
drha6abd042004-06-09 17:37:22 +00001224** Make every page in the cache agree with what is on disk. In other words,
1225** reread the disk to reset the state of the cache.
1226**
1227** This routine is called after a rollback in which some of the dirty cache
1228** pages had never been written out to disk. We need to roll back the
1229** cache content and the easiest way to do that is to reread the old content
1230** back from the disk.
1231*/
1232static int pager_reload_cache(Pager *pPager){
1233 PgHdr *pPg;
1234 int rc = SQLITE_OK;
1235 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
danielk19778186df82007-03-06 13:45:59 +00001236 char *zBuf = pPager->pTmpSpace; /* Temp storage for one page */
drha6abd042004-06-09 17:37:22 +00001237 if( !pPg->dirty ) continue;
1238 if( (int)pPg->pgno <= pPager->origDbSize ){
drh054889e2005-11-30 03:20:31 +00001239 rc = sqlite3OsSeek(pPager->fd, pPager->pageSize*(i64)(pPg->pgno-1));
drhb4746b92005-09-09 01:32:06 +00001240 if( rc==SQLITE_OK ){
drh054889e2005-11-30 03:20:31 +00001241 rc = sqlite3OsRead(pPager->fd, zBuf, pPager->pageSize);
drhb4746b92005-09-09 01:32:06 +00001242 }
drh4f0c5872007-03-26 22:05:01 +00001243 PAGERTRACE3("REFETCH %d page %d\n", PAGERID(pPager), pPg->pgno);
drha6abd042004-06-09 17:37:22 +00001244 if( rc ) break;
drhc001c582006-03-06 18:23:16 +00001245 CODEC1(pPager, zBuf, pPg->pgno, 2);
drha6abd042004-06-09 17:37:22 +00001246 }else{
drh90f5ecb2004-07-22 01:19:35 +00001247 memset(zBuf, 0, pPager->pageSize);
drha6abd042004-06-09 17:37:22 +00001248 }
drh90f5ecb2004-07-22 01:19:35 +00001249 if( pPg->nRef==0 || memcmp(zBuf, PGHDR_TO_DATA(pPg), pPager->pageSize) ){
1250 memcpy(PGHDR_TO_DATA(pPg), zBuf, pPager->pageSize);
drha6abd042004-06-09 17:37:22 +00001251 if( pPager->xReiniter ){
danielk19773b8a05f2007-03-19 17:44:26 +00001252 pPager->xReiniter(pPg, pPager->pageSize);
drha6abd042004-06-09 17:37:22 +00001253 }else{
drh90f5ecb2004-07-22 01:19:35 +00001254 memset(PGHDR_TO_EXTRA(pPg, pPager), 0, pPager->nExtra);
drha6abd042004-06-09 17:37:22 +00001255 }
1256 }
1257 pPg->needSync = 0;
1258 pPg->dirty = 0;
danielk19773c407372005-02-15 02:54:14 +00001259#ifdef SQLITE_CHECK_PAGES
1260 pPg->pageHash = pager_pagehash(pPg);
1261#endif
drha6abd042004-06-09 17:37:22 +00001262 }
drh605ad8f2006-05-03 23:34:05 +00001263 pPager->pDirty = 0;
drha6abd042004-06-09 17:37:22 +00001264 return rc;
1265}
danielk197741483462007-03-24 16:45:04 +00001266#endif
drha6abd042004-06-09 17:37:22 +00001267
danielk1977e180dd92007-04-05 17:15:52 +00001268static void pager_truncate_cache(Pager *pPager);
1269
drha6abd042004-06-09 17:37:22 +00001270/*
drhcb4c40b2004-08-18 19:09:43 +00001271** Truncate the main file of the given pager to the number of pages
danielk1977e180dd92007-04-05 17:15:52 +00001272** indicated. Also truncate the cached representation of the file.
drhcb4c40b2004-08-18 19:09:43 +00001273*/
1274static int pager_truncate(Pager *pPager, int nPage){
danielk1977e180dd92007-04-05 17:15:52 +00001275 int rc = SQLITE_OK;
1276 if( pPager->state>=PAGER_EXCLUSIVE ){
1277 rc = sqlite3OsTruncate(pPager->fd, pPager->pageSize*(i64)nPage);
1278 }
1279 if( rc==SQLITE_OK ){
1280 pPager->dbSize = nPage;
1281 pager_truncate_cache(pPager);
1282 }
1283 return rc;
drhcb4c40b2004-08-18 19:09:43 +00001284}
1285
1286/*
drhed7c8552001-04-11 14:29:21 +00001287** Playback the journal and thus restore the database file to
1288** the state it was in before we started making changes.
1289**
drh34e79ce2004-02-08 06:05:46 +00001290** The journal file format is as follows:
1291**
drhae2b40c2004-06-09 19:03:54 +00001292** (1) 8 byte prefix. A copy of aJournalMagic[].
1293** (2) 4 byte big-endian integer which is the number of valid page records
drh34e79ce2004-02-08 06:05:46 +00001294** in the journal. If this value is 0xffffffff, then compute the
drhae2b40c2004-06-09 19:03:54 +00001295** number of page records from the journal size.
1296** (3) 4 byte big-endian integer which is the initial value for the
1297** sanity checksum.
1298** (4) 4 byte integer which is the number of pages to truncate the
drh34e79ce2004-02-08 06:05:46 +00001299** database to during a rollback.
drhae2b40c2004-06-09 19:03:54 +00001300** (5) 4 byte integer which is the number of bytes in the master journal
1301** name. The value may be zero (indicate that there is no master
1302** journal.)
1303** (6) N bytes of the master journal name. The name will be nul-terminated
1304** and might be shorter than the value read from (5). If the first byte
1305** of the name is \000 then there is no master journal. The master
1306** journal name is stored in UTF-8.
1307** (7) Zero or more pages instances, each as follows:
drh34e79ce2004-02-08 06:05:46 +00001308** + 4 byte page number.
drhae2b40c2004-06-09 19:03:54 +00001309** + pPager->pageSize bytes of data.
1310** + 4 byte checksum
drh34e79ce2004-02-08 06:05:46 +00001311**
drhae2b40c2004-06-09 19:03:54 +00001312** When we speak of the journal header, we mean the first 6 items above.
1313** Each entry in the journal is an instance of the 7th item.
drh34e79ce2004-02-08 06:05:46 +00001314**
1315** Call the value from the second bullet "nRec". nRec is the number of
1316** valid page entries in the journal. In most cases, you can compute the
1317** value of nRec from the size of the journal file. But if a power
1318** failure occurred while the journal was being written, it could be the
1319** case that the size of the journal file had already been increased but
1320** the extra entries had not yet made it safely to disk. In such a case,
1321** the value of nRec computed from the file size would be too large. For
1322** that reason, we always use the nRec value in the header.
1323**
1324** If the nRec value is 0xffffffff it means that nRec should be computed
1325** from the file size. This value is used when the user selects the
1326** no-sync option for the journal. A power failure could lead to corruption
1327** in this case. But for things like temporary table (which will be
1328** deleted when the power is restored) we don't care.
1329**
drhd9b02572001-04-15 00:37:09 +00001330** If the file opened as the journal file is not a well-formed
danielk1977ece80f12004-06-23 01:05:26 +00001331** journal file then all pages up to the first corrupted page are rolled
1332** back (or no pages if the journal header is corrupted). The journal file
1333** is then deleted and SQLITE_OK returned, just as if no corruption had
1334** been encountered.
1335**
1336** If an I/O or malloc() error occurs, the journal-file is not deleted
1337** and an error code is returned.
drhed7c8552001-04-11 14:29:21 +00001338*/
danielk1977e277be02007-03-23 18:12:06 +00001339static int pager_playback(Pager *pPager, int isHot){
drheb206252004-10-01 02:00:31 +00001340 i64 szJ; /* Size of the journal file in bytes */
danielk1977c3e8f5e2004-06-28 01:16:46 +00001341 u32 nRec; /* Number of Records in the journal */
drhd9b02572001-04-15 00:37:09 +00001342 int i; /* Loop counter */
1343 Pgno mxPg = 0; /* Size of the original file in pages */
drhae2b40c2004-06-09 19:03:54 +00001344 int rc; /* Result code of a subroutine */
danielk197713adf8a2004-06-03 16:08:41 +00001345 char *zMaster = 0; /* Name of master journal file if any */
drhed7c8552001-04-11 14:29:21 +00001346
drhc3a64ba2001-11-22 00:01:27 +00001347 /* Figure out how many records are in the journal. Abort early if
1348 ** the journal is empty.
drhed7c8552001-04-11 14:29:21 +00001349 */
drh8cfbf082001-09-19 13:22:39 +00001350 assert( pPager->journalOpen );
drh054889e2005-11-30 03:20:31 +00001351 rc = sqlite3OsFileSize(pPager->jfd, &szJ);
danielk1977334cdb62007-03-26 08:05:12 +00001352 if( rc!=SQLITE_OK || szJ==0 ){
drhc3a64ba2001-11-22 00:01:27 +00001353 goto end_playback;
1354 }
drh240c5792004-02-08 00:40:52 +00001355
danielk197776572402004-06-25 02:38:54 +00001356 /* Read the master journal name from the journal, if it is present.
1357 ** If a master journal file name is specified, but the file is not
1358 ** present on disk, then the journal is not hot and does not need to be
1359 ** played back.
drh240c5792004-02-08 00:40:52 +00001360 */
drh9cbe6352005-11-29 03:13:21 +00001361 rc = readMasterJournal(pPager->jfd, &zMaster);
danielk197776572402004-06-25 02:38:54 +00001362 assert( rc!=SQLITE_DONE );
drh66560ad2006-01-06 14:32:19 +00001363 if( rc!=SQLITE_OK || (zMaster && !sqlite3OsFileExists(zMaster)) ){
danielk197776572402004-06-25 02:38:54 +00001364 sqliteFree(zMaster);
1365 zMaster = 0;
1366 if( rc==SQLITE_DONE ) rc = SQLITE_OK;
drhc3a64ba2001-11-22 00:01:27 +00001367 goto end_playback;
1368 }
drh054889e2005-11-30 03:20:31 +00001369 sqlite3OsSeek(pPager->jfd, 0);
danielk197776572402004-06-25 02:38:54 +00001370 pPager->journalOff = 0;
drhc3a64ba2001-11-22 00:01:27 +00001371
danielk197776572402004-06-25 02:38:54 +00001372 /* This loop terminates either when the readJournalHdr() call returns
1373 ** SQLITE_DONE or an IO error occurs. */
1374 while( 1 ){
drhae2b40c2004-06-09 19:03:54 +00001375
danielk197776572402004-06-25 02:38:54 +00001376 /* Read the next journal header from the journal file. If there are
1377 ** not enough bytes left in the journal file for a complete header, or
1378 ** it is corrupted, then a process must of failed while writing it.
1379 ** This indicates nothing more needs to be rolled back.
1380 */
1381 rc = readJournalHdr(pPager, szJ, &nRec, &mxPg);
1382 if( rc!=SQLITE_OK ){
drh968af522003-02-11 14:55:40 +00001383 if( rc==SQLITE_DONE ){
drh968af522003-02-11 14:55:40 +00001384 rc = SQLITE_OK;
1385 }
danielk197776572402004-06-25 02:38:54 +00001386 goto end_playback;
1387 }
1388
1389 /* If nRec is 0xffffffff, then this journal was created by a process
1390 ** working in no-sync mode. This means that the rest of the journal
1391 ** file consists of pages, there are no more journal headers. Compute
1392 ** the value of nRec based on this assumption.
1393 */
1394 if( nRec==0xffffffff ){
1395 assert( pPager->journalOff==JOURNAL_HDR_SZ(pPager) );
1396 nRec = (szJ - JOURNAL_HDR_SZ(pPager))/JOURNAL_PG_SZ(pPager);
1397 }
1398
danielk1977e277be02007-03-23 18:12:06 +00001399 /* If nRec is 0 and this rollback is of a transaction created by this
1400 ** process. In this case the rest of the journal file consists of
1401 ** journalled copies of pages that need to be read back into the cache.
1402 */
1403 if( nRec==0 && !isHot ){
1404 nRec = (szJ - pPager->journalOff) / JOURNAL_PG_SZ(pPager);
1405 }
1406
danielk197776572402004-06-25 02:38:54 +00001407 /* If this is the first header read from the journal, truncate the
1408 ** database file back to it's original size.
1409 */
danielk1977e180dd92007-04-05 17:15:52 +00001410 if( pPager->journalOff==JOURNAL_HDR_SZ(pPager) ){
drhcb4c40b2004-08-18 19:09:43 +00001411 rc = pager_truncate(pPager, mxPg);
danielk197776572402004-06-25 02:38:54 +00001412 if( rc!=SQLITE_OK ){
1413 goto end_playback;
1414 }
danielk197776572402004-06-25 02:38:54 +00001415 }
1416
danielk197776572402004-06-25 02:38:54 +00001417 /* Copy original pages out of the journal and back into the database file.
1418 */
1419 for(i=0; i<nRec; i++){
drh9cbe6352005-11-29 03:13:21 +00001420 rc = pager_playback_one_page(pPager, pPager->jfd, 1);
danielk197776572402004-06-25 02:38:54 +00001421 if( rc!=SQLITE_OK ){
1422 if( rc==SQLITE_DONE ){
1423 rc = SQLITE_OK;
1424 pPager->journalOff = szJ;
1425 break;
1426 }else{
1427 goto end_playback;
1428 }
1429 }
drh968af522003-02-11 14:55:40 +00001430 }
drhed7c8552001-04-11 14:29:21 +00001431 }
drh580eeaf2006-02-24 03:09:37 +00001432 /*NOTREACHED*/
1433 assert( 0 );
drh4a0681e2003-02-13 01:58:20 +00001434
1435end_playback:
danielk19778191bff2004-06-28 04:52:30 +00001436 if( rc==SQLITE_OK ){
drh80e35f42007-03-30 14:06:34 +00001437 rc = pager_end_transaction(pPager);
danielk19778191bff2004-06-28 04:52:30 +00001438 }
danielk197713adf8a2004-06-03 16:08:41 +00001439 if( zMaster ){
danielk1977979f38e2007-03-27 16:19:51 +00001440 /* If there was a master journal and this routine will return success,
danielk197732554c12005-01-22 03:39:39 +00001441 ** see if it is possible to delete the master journal.
danielk197713adf8a2004-06-03 16:08:41 +00001442 */
1443 if( rc==SQLITE_OK ){
danielk197732554c12005-01-22 03:39:39 +00001444 rc = pager_delmaster(zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001445 }
1446 sqliteFree(zMaster);
1447 }
danielk197776572402004-06-25 02:38:54 +00001448
1449 /* The Pager.sectorSize variable may have been updated while rolling
drh3ceeb752007-03-29 18:19:52 +00001450 ** back a journal created by a process with a different sector size
danielk197776572402004-06-25 02:38:54 +00001451 ** value. Reset it to the correct value for this process.
1452 */
danielk1977b4721172007-03-19 05:54:48 +00001453 pPager->sectorSize = sqlite3OsSectorSize(pPager->fd);
drhd9b02572001-04-15 00:37:09 +00001454 return rc;
drhed7c8552001-04-11 14:29:21 +00001455}
1456
1457/*
drhac69b052004-05-12 13:30:07 +00001458** Playback the statement journal.
drhfa86c412002-02-02 15:01:15 +00001459**
1460** This is similar to playing back the transaction journal but with
1461** a few extra twists.
1462**
drh663fc632002-02-02 18:49:19 +00001463** (1) The number of pages in the database file at the start of
drhac69b052004-05-12 13:30:07 +00001464** the statement is stored in pPager->stmtSize, not in the
drh663fc632002-02-02 18:49:19 +00001465** journal file itself.
drhfa86c412002-02-02 15:01:15 +00001466**
drhac69b052004-05-12 13:30:07 +00001467** (2) In addition to playing back the statement journal, also
drhfa86c412002-02-02 15:01:15 +00001468** playback all pages of the transaction journal beginning
drhac69b052004-05-12 13:30:07 +00001469** at offset pPager->stmtJSize.
drhfa86c412002-02-02 15:01:15 +00001470*/
drh3aac2dd2004-04-26 14:10:20 +00001471static int pager_stmt_playback(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001472 i64 szJ; /* Size of the full journal */
1473 i64 hdrOff;
drh968af522003-02-11 14:55:40 +00001474 int nRec; /* Number of Records */
drhfa86c412002-02-02 15:01:15 +00001475 int i; /* Loop counter */
1476 int rc;
1477
danielk197776572402004-06-25 02:38:54 +00001478 szJ = pPager->journalOff;
1479#ifndef NDEBUG
1480 {
drheb206252004-10-01 02:00:31 +00001481 i64 os_szJ;
drh054889e2005-11-30 03:20:31 +00001482 rc = sqlite3OsFileSize(pPager->jfd, &os_szJ);
danielk197776572402004-06-25 02:38:54 +00001483 if( rc!=SQLITE_OK ) return rc;
1484 assert( szJ==os_szJ );
1485 }
1486#endif
1487
danielk19774099f6e2007-03-19 11:25:20 +00001488 /* Set hdrOff to be the offset just after the end of the last journal
1489 ** page written before the first journal-header for this statement
1490 ** transaction was written, or the end of the file if no journal
danielk197776572402004-06-25 02:38:54 +00001491 ** header was written.
1492 */
1493 hdrOff = pPager->stmtHdrOff;
1494 assert( pPager->fullSync || !hdrOff );
1495 if( !hdrOff ){
1496 hdrOff = szJ;
1497 }
1498
drhfa86c412002-02-02 15:01:15 +00001499 /* Truncate the database back to its original size.
1500 */
danielk1977e180dd92007-04-05 17:15:52 +00001501 rc = pager_truncate(pPager, pPager->stmtSize);
drh1aa2d8b2007-01-03 15:34:29 +00001502 assert( pPager->state>=PAGER_SHARED );
drhfa86c412002-02-02 15:01:15 +00001503
drhac69b052004-05-12 13:30:07 +00001504 /* Figure out how many records are in the statement journal.
drhfa86c412002-02-02 15:01:15 +00001505 */
drhac69b052004-05-12 13:30:07 +00001506 assert( pPager->stmtInUse && pPager->journalOpen );
drh054889e2005-11-30 03:20:31 +00001507 sqlite3OsSeek(pPager->stfd, 0);
drhac69b052004-05-12 13:30:07 +00001508 nRec = pPager->stmtNRec;
drhfa86c412002-02-02 15:01:15 +00001509
drhac69b052004-05-12 13:30:07 +00001510 /* Copy original pages out of the statement journal and back into the
drhae2b40c2004-06-09 19:03:54 +00001511 ** database file. Note that the statement journal omits checksums from
1512 ** each record since power-failure recovery is not important to statement
1513 ** journals.
drhfa86c412002-02-02 15:01:15 +00001514 */
1515 for(i=nRec-1; i>=0; i--){
drh9cbe6352005-11-29 03:13:21 +00001516 rc = pager_playback_one_page(pPager, pPager->stfd, 0);
drh968af522003-02-11 14:55:40 +00001517 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001518 if( rc!=SQLITE_OK ) goto end_stmt_playback;
drhfa86c412002-02-02 15:01:15 +00001519 }
1520
danielk197776572402004-06-25 02:38:54 +00001521 /* Now roll some pages back from the transaction journal. Pager.stmtJSize
1522 ** was the size of the journal file when this statement was started, so
1523 ** everything after that needs to be rolled back, either into the
1524 ** database, the memory cache, or both.
1525 **
1526 ** If it is not zero, then Pager.stmtHdrOff is the offset to the start
1527 ** of the first journal header written during this statement transaction.
drhfa86c412002-02-02 15:01:15 +00001528 */
drh054889e2005-11-30 03:20:31 +00001529 rc = sqlite3OsSeek(pPager->jfd, pPager->stmtJSize);
drhfa86c412002-02-02 15:01:15 +00001530 if( rc!=SQLITE_OK ){
drh3aac2dd2004-04-26 14:10:20 +00001531 goto end_stmt_playback;
drhfa86c412002-02-02 15:01:15 +00001532 }
danielk197776572402004-06-25 02:38:54 +00001533 pPager->journalOff = pPager->stmtJSize;
danielk197775edc162004-06-26 01:48:18 +00001534 pPager->cksumInit = pPager->stmtCksum;
danielk19774099f6e2007-03-19 11:25:20 +00001535 while( pPager->journalOff < hdrOff ){
drh9cbe6352005-11-29 03:13:21 +00001536 rc = pager_playback_one_page(pPager, pPager->jfd, 1);
danielk197776572402004-06-25 02:38:54 +00001537 assert( rc!=SQLITE_DONE );
1538 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1539 }
1540
1541 while( pPager->journalOff < szJ ){
danielk1977f0113002006-01-24 12:09:17 +00001542 u32 nJRec; /* Number of Journal Records */
danielk197776572402004-06-25 02:38:54 +00001543 u32 dummy;
danielk1977f0113002006-01-24 12:09:17 +00001544 rc = readJournalHdr(pPager, szJ, &nJRec, &dummy);
drh968af522003-02-11 14:55:40 +00001545 if( rc!=SQLITE_OK ){
1546 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001547 goto end_stmt_playback;
drh968af522003-02-11 14:55:40 +00001548 }
danielk1977f0113002006-01-24 12:09:17 +00001549 if( nJRec==0 ){
1550 nJRec = (szJ - pPager->journalOff) / (pPager->pageSize+8);
danielk197775edc162004-06-26 01:48:18 +00001551 }
danielk1977f0113002006-01-24 12:09:17 +00001552 for(i=nJRec-1; i>=0 && pPager->journalOff < szJ; i--){
drh9cbe6352005-11-29 03:13:21 +00001553 rc = pager_playback_one_page(pPager, pPager->jfd, 1);
danielk197776572402004-06-25 02:38:54 +00001554 assert( rc!=SQLITE_DONE );
1555 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1556 }
drhfa86c412002-02-02 15:01:15 +00001557 }
danielk197776572402004-06-25 02:38:54 +00001558
1559 pPager->journalOff = szJ;
drhfa86c412002-02-02 15:01:15 +00001560
drh3aac2dd2004-04-26 14:10:20 +00001561end_stmt_playback:
danielk19778a7aea32006-01-23 15:25:48 +00001562 if( rc==SQLITE_OK) {
danielk197775edc162004-06-26 01:48:18 +00001563 pPager->journalOff = szJ;
1564 /* pager_reload_cache(pPager); */
drhfa86c412002-02-02 15:01:15 +00001565 }
1566 return rc;
1567}
1568
1569/*
drhf57b14a2001-09-14 18:54:08 +00001570** Change the maximum number of in-memory pages that are allowed.
1571*/
danielk19773b8a05f2007-03-19 17:44:26 +00001572void sqlite3PagerSetCachesize(Pager *pPager, int mxPage){
drhf57b14a2001-09-14 18:54:08 +00001573 if( mxPage>10 ){
1574 pPager->mxPage = mxPage;
danielk1977ef317ab2004-06-23 10:43:10 +00001575 }else{
1576 pPager->mxPage = 10;
drhf57b14a2001-09-14 18:54:08 +00001577 }
1578}
1579
1580/*
drh973b6e32003-02-12 14:09:42 +00001581** Adjust the robustness of the database to damage due to OS crashes
1582** or power failures by changing the number of syncs()s when writing
1583** the rollback journal. There are three levels:
1584**
drh054889e2005-11-30 03:20:31 +00001585** OFF sqlite3OsSync() is never called. This is the default
drh973b6e32003-02-12 14:09:42 +00001586** for temporary and transient files.
1587**
1588** NORMAL The journal is synced once before writes begin on the
1589** database. This is normally adequate protection, but
1590** it is theoretically possible, though very unlikely,
1591** that an inopertune power failure could leave the journal
1592** in a state which would cause damage to the database
1593** when it is rolled back.
1594**
1595** FULL The journal is synced twice before writes begin on the
drh34e79ce2004-02-08 06:05:46 +00001596** database (with some additional information - the nRec field
1597** of the journal header - being written in between the two
1598** syncs). If we assume that writing a
drh973b6e32003-02-12 14:09:42 +00001599** single disk sector is atomic, then this mode provides
1600** assurance that the journal will not be corrupted to the
1601** point of causing damage to the database during rollback.
1602**
1603** Numeric values associated with these states are OFF==1, NORMAL=2,
1604** and FULL=3.
1605*/
danielk197793758c82005-01-21 08:13:14 +00001606#ifndef SQLITE_OMIT_PAGER_PRAGMAS
danielk19773b8a05f2007-03-19 17:44:26 +00001607void sqlite3PagerSetSafetyLevel(Pager *pPager, int level, int full_fsync){
drh973b6e32003-02-12 14:09:42 +00001608 pPager->noSync = level==1 || pPager->tempFile;
1609 pPager->fullSync = level==3 && !pPager->tempFile;
drhac530b12006-02-11 01:25:50 +00001610 pPager->full_fsync = full_fsync;
danielk19771d850a72004-05-31 08:26:49 +00001611 if( pPager->noSync ) pPager->needSync = 0;
drh973b6e32003-02-12 14:09:42 +00001612}
danielk197793758c82005-01-21 08:13:14 +00001613#endif
drh973b6e32003-02-12 14:09:42 +00001614
1615/*
drhaf6df112005-06-07 02:12:30 +00001616** The following global variable is incremented whenever the library
1617** attempts to open a temporary file. This information is used for
1618** testing and analysis only.
1619*/
drh0f7eb612006-08-08 13:51:43 +00001620#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00001621int sqlite3_opentemp_count = 0;
drh0f7eb612006-08-08 13:51:43 +00001622#endif
drhaf6df112005-06-07 02:12:30 +00001623
1624/*
drh3f56e6e2007-03-15 01:16:47 +00001625** Open a temporary file.
1626**
1627** Write the file descriptor into *fd. Return SQLITE_OK on success or some
drhfa86c412002-02-02 15:01:15 +00001628** other error code if we fail.
1629**
1630** The OS will automatically delete the temporary file when it is
1631** closed.
1632*/
danielk19773b8a05f2007-03-19 17:44:26 +00001633static int sqlite3PagerOpentemp(OsFile **pFd){
drhfa86c412002-02-02 15:01:15 +00001634 int cnt = 8;
1635 int rc;
drh3f56e6e2007-03-15 01:16:47 +00001636 char zFile[SQLITE_TEMPNAME_SIZE];
1637
drh0f7eb612006-08-08 13:51:43 +00001638#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00001639 sqlite3_opentemp_count++; /* Used for testing and analysis only */
drh0f7eb612006-08-08 13:51:43 +00001640#endif
drhfa86c412002-02-02 15:01:15 +00001641 do{
1642 cnt--;
drh66560ad2006-01-06 14:32:19 +00001643 sqlite3OsTempFileName(zFile);
1644 rc = sqlite3OsOpenExclusive(zFile, pFd, 1);
danielk19775bb16fe2007-04-05 11:54:42 +00001645 assert( rc!=SQLITE_OK || *pFd );
danielk197713073932004-06-30 11:54:06 +00001646 }while( cnt>0 && rc!=SQLITE_OK && rc!=SQLITE_NOMEM );
drhfa86c412002-02-02 15:01:15 +00001647 return rc;
1648}
1649
1650/*
drhed7c8552001-04-11 14:29:21 +00001651** Create a new page cache and put a pointer to the page cache in *ppPager.
drh5e00f6c2001-09-13 13:46:56 +00001652** The file to be cached need not exist. The file is not locked until
danielk19773b8a05f2007-03-19 17:44:26 +00001653** the first call to sqlite3PagerGet() and is only held open until the
1654** last page is released using sqlite3PagerUnref().
drh382c0242001-10-06 16:33:02 +00001655**
drh6446c4d2001-12-15 14:22:18 +00001656** If zFilename is NULL then a randomly-named temporary file is created
1657** and used as the file to be cached. The file will be deleted
1658** automatically when it is closed.
drh90f5ecb2004-07-22 01:19:35 +00001659**
1660** If zFilename is ":memory:" then all information is held in cache.
1661** It is never written to disk. This can be used to implement an
1662** in-memory database.
drhed7c8552001-04-11 14:29:21 +00001663*/
danielk19773b8a05f2007-03-19 17:44:26 +00001664int sqlite3PagerOpen(
drh7e3b0a02001-04-28 16:52:40 +00001665 Pager **ppPager, /* Return the Pager structure here */
1666 const char *zFilename, /* Name of the database file to open */
drhda47d772002-12-02 04:25:19 +00001667 int nExtra, /* Extra bytes append to each in-memory page */
drh7bec5052005-02-06 02:45:41 +00001668 int flags /* flags controlling this file */
drh7e3b0a02001-04-28 16:52:40 +00001669){
danielk1977aef0bf62005-12-30 16:28:01 +00001670 Pager *pPager = 0;
danielk19778def5ea2004-06-16 10:39:52 +00001671 char *zFullPathname = 0;
drh02afc862006-01-20 18:10:57 +00001672 int nameLen; /* Compiler is wrong. This is always initialized before use */
danielk1977393f0682007-03-31 10:00:48 +00001673 OsFile *fd = 0;
danielk1977cfe9a692004-06-16 12:00:29 +00001674 int rc = SQLITE_OK;
1675 int i;
danielk19778def5ea2004-06-16 10:39:52 +00001676 int tempFile = 0;
drhac69b052004-05-12 13:30:07 +00001677 int memDb = 0;
drh5e00f6c2001-09-13 13:46:56 +00001678 int readOnly = 0;
drh7bec5052005-02-06 02:45:41 +00001679 int useJournal = (flags & PAGER_OMIT_JOURNAL)==0;
1680 int noReadlock = (flags & PAGER_NO_READLOCK)!=0;
drh8cfbf082001-09-19 13:22:39 +00001681 char zTemp[SQLITE_TEMPNAME_SIZE];
drh6f7adc82006-01-11 21:41:20 +00001682#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
danielk197754f01982006-01-18 15:25:17 +00001683 /* A malloc() cannot fail in sqlite3ThreadData() as one or more calls to
1684 ** malloc() must have already been made by this thread before it gets
1685 ** to this point. This means the ThreadData must have been allocated already
1686 ** so that ThreadData.nAlloc can be set. It would be nice to assert
1687 ** that ThreadData.nAlloc is non-zero, but alas this breaks test cases
1688 ** written to invoke the pager directly.
1689 */
danielk19778212def2006-01-16 15:32:23 +00001690 ThreadData *pTsd = sqlite3ThreadData();
danielk197754f01982006-01-18 15:25:17 +00001691 assert( pTsd );
danielk197752622822006-01-09 09:59:49 +00001692#endif
drhed7c8552001-04-11 14:29:21 +00001693
danielk1977393f0682007-03-31 10:00:48 +00001694 /* We used to test if malloc() had already failed before proceeding.
1695 ** But the way this function is used in SQLite means that can never
1696 ** happen. Furthermore, if the malloc-failed flag is already set,
1697 ** either the call to sqliteStrDup() or sqliteMalloc() below will
1698 ** fail shortly and SQLITE_NOMEM returned anyway.
danielk1977aef0bf62005-12-30 16:28:01 +00001699 */
drhd9b02572001-04-15 00:37:09 +00001700 *ppPager = 0;
danielk1977aef0bf62005-12-30 16:28:01 +00001701
1702 /* Open the pager file and set zFullPathname to point at malloc()ed
1703 ** memory containing the complete filename (i.e. including the directory).
1704 */
drh901afd42003-08-26 11:25:58 +00001705 if( zFilename && zFilename[0] ){
drhb7f91642004-10-31 02:22:47 +00001706#ifndef SQLITE_OMIT_MEMORYDB
drhac69b052004-05-12 13:30:07 +00001707 if( strcmp(zFilename,":memory:")==0 ){
1708 memDb = 1;
drhda71ce12004-06-21 18:14:45 +00001709 zFullPathname = sqliteStrDup("");
drhb7f91642004-10-31 02:22:47 +00001710 }else
1711#endif
1712 {
drh66560ad2006-01-06 14:32:19 +00001713 zFullPathname = sqlite3OsFullPathname(zFilename);
danielk19778def5ea2004-06-16 10:39:52 +00001714 if( zFullPathname ){
drh66560ad2006-01-06 14:32:19 +00001715 rc = sqlite3OsOpenReadWrite(zFullPathname, &fd, &readOnly);
danielk19775bb16fe2007-04-05 11:54:42 +00001716 assert( rc!=SQLITE_OK || fd );
danielk19778def5ea2004-06-16 10:39:52 +00001717 }
drhac69b052004-05-12 13:30:07 +00001718 }
drh5e00f6c2001-09-13 13:46:56 +00001719 }else{
danielk19773b8a05f2007-03-19 17:44:26 +00001720 rc = sqlite3PagerOpentemp(&fd);
drh3f56e6e2007-03-15 01:16:47 +00001721 sqlite3OsTempFileName(zTemp);
drh5e00f6c2001-09-13 13:46:56 +00001722 zFilename = zTemp;
drh66560ad2006-01-06 14:32:19 +00001723 zFullPathname = sqlite3OsFullPathname(zFilename);
danielk19778def5ea2004-06-16 10:39:52 +00001724 if( rc==SQLITE_OK ){
1725 tempFile = 1;
1726 }
drh5e00f6c2001-09-13 13:46:56 +00001727 }
danielk1977aef0bf62005-12-30 16:28:01 +00001728
1729 /* Allocate the Pager structure. As part of the same allocation, allocate
1730 ** space for the full paths of the file, directory and journal
1731 ** (Pager.zFilename, Pager.zDirectory and Pager.zJournal).
1732 */
1733 if( zFullPathname ){
1734 nameLen = strlen(zFullPathname);
1735 pPager = sqliteMalloc( sizeof(*pPager) + nameLen*3 + 30 );
danielk19778186df82007-03-06 13:45:59 +00001736 if( pPager && rc==SQLITE_OK ){
1737 pPager->pTmpSpace = (char *)sqliteMallocRaw(SQLITE_DEFAULT_PAGE_SIZE);
1738 }
drh3e7a6092002-12-07 21:45:14 +00001739 }
danielk1977aef0bf62005-12-30 16:28:01 +00001740
danielk19778186df82007-03-06 13:45:59 +00001741
danielk1977aef0bf62005-12-30 16:28:01 +00001742 /* If an error occured in either of the blocks above, free the memory
1743 ** pointed to by zFullPathname, free the Pager structure and close the
1744 ** file. Since the pager is not allocated there is no need to set
1745 ** any Pager.errMask variables.
1746 */
danielk19778186df82007-03-06 13:45:59 +00001747 if( !pPager || !zFullPathname || !pPager->pTmpSpace || rc!=SQLITE_OK ){
drh054889e2005-11-30 03:20:31 +00001748 sqlite3OsClose(&fd);
drhda71ce12004-06-21 18:14:45 +00001749 sqliteFree(zFullPathname);
danielk1977aef0bf62005-12-30 16:28:01 +00001750 sqliteFree(pPager);
1751 return ((rc==SQLITE_OK)?SQLITE_NOMEM:rc);
drhed7c8552001-04-11 14:29:21 +00001752 }
danielk1977aef0bf62005-12-30 16:28:01 +00001753
drh4f0c5872007-03-26 22:05:01 +00001754 PAGERTRACE3("OPEN %d %s\n", FILEHANDLEID(fd), zFullPathname);
drhb0603412007-02-28 04:47:26 +00001755 IOTRACE(("OPEN %p %s\n", pPager, zFullPathname))
drhed7c8552001-04-11 14:29:21 +00001756 pPager->zFilename = (char*)&pPager[1];
drha76c82e2003-07-27 18:59:42 +00001757 pPager->zDirectory = &pPager->zFilename[nameLen+1];
1758 pPager->zJournal = &pPager->zDirectory[nameLen+1];
drh3e7a6092002-12-07 21:45:14 +00001759 strcpy(pPager->zFilename, zFullPathname);
drha76c82e2003-07-27 18:59:42 +00001760 strcpy(pPager->zDirectory, zFullPathname);
danielk1977aef0bf62005-12-30 16:28:01 +00001761
drha76c82e2003-07-27 18:59:42 +00001762 for(i=nameLen; i>0 && pPager->zDirectory[i-1]!='/'; i--){}
1763 if( i>0 ) pPager->zDirectory[i-1] = 0;
drh3e7a6092002-12-07 21:45:14 +00001764 strcpy(pPager->zJournal, zFullPathname);
1765 sqliteFree(zFullPathname);
drhed7c8552001-04-11 14:29:21 +00001766 strcpy(&pPager->zJournal[nameLen], "-journal");
drh9cbe6352005-11-29 03:13:21 +00001767 pPager->fd = fd;
drh3b59a5c2006-01-15 20:28:28 +00001768 /* pPager->journalOpen = 0; */
drhac69b052004-05-12 13:30:07 +00001769 pPager->useJournal = useJournal && !memDb;
drh7bec5052005-02-06 02:45:41 +00001770 pPager->noReadlock = noReadlock && readOnly;
drh3b59a5c2006-01-15 20:28:28 +00001771 /* pPager->stmtOpen = 0; */
1772 /* pPager->stmtInUse = 0; */
1773 /* pPager->nRef = 0; */
drhac69b052004-05-12 13:30:07 +00001774 pPager->dbSize = memDb-1;
drh90f5ecb2004-07-22 01:19:35 +00001775 pPager->pageSize = SQLITE_DEFAULT_PAGE_SIZE;
drh3b59a5c2006-01-15 20:28:28 +00001776 /* pPager->stmtSize = 0; */
1777 /* pPager->stmtJSize = 0; */
1778 /* pPager->nPage = 0; */
1779 /* pPager->nMaxPage = 0; */
drh90f5ecb2004-07-22 01:19:35 +00001780 pPager->mxPage = 100;
drh3b59a5c2006-01-15 20:28:28 +00001781 assert( PAGER_UNLOCK==0 );
1782 /* pPager->state = PAGER_UNLOCK; */
1783 /* pPager->errMask = 0; */
drh5e00f6c2001-09-13 13:46:56 +00001784 pPager->tempFile = tempFile;
drh369339d2007-03-30 16:01:55 +00001785 assert( tempFile==PAGER_LOCKINGMODE_NORMAL
1786 || tempFile==PAGER_LOCKINGMODE_EXCLUSIVE );
1787 assert( PAGER_LOCKINGMODE_EXCLUSIVE==1 );
1788 pPager->exclusiveMode = tempFile;
drhac69b052004-05-12 13:30:07 +00001789 pPager->memDb = memDb;
drh5e00f6c2001-09-13 13:46:56 +00001790 pPager->readOnly = readOnly;
drh3b59a5c2006-01-15 20:28:28 +00001791 /* pPager->needSync = 0; */
drhda47d772002-12-02 04:25:19 +00001792 pPager->noSync = pPager->tempFile || !useJournal;
danielk197775edc162004-06-26 01:48:18 +00001793 pPager->fullSync = (pPager->noSync?0:1);
drh3b59a5c2006-01-15 20:28:28 +00001794 /* pPager->pFirst = 0; */
1795 /* pPager->pFirstSynced = 0; */
1796 /* pPager->pLast = 0; */
drh887dc4c2004-10-22 16:22:57 +00001797 pPager->nExtra = FORCE_ALIGNMENT(nExtra);
danielk1977b4721172007-03-19 05:54:48 +00001798 assert(fd||memDb);
1799 if( !memDb ){
1800 pPager->sectorSize = sqlite3OsSectorSize(fd);
1801 }
drh3b59a5c2006-01-15 20:28:28 +00001802 /* pPager->pBusyHandler = 0; */
1803 /* memset(pPager->aHash, 0, sizeof(pPager->aHash)); */
drhed7c8552001-04-11 14:29:21 +00001804 *ppPager = pPager;
drh6f7adc82006-01-11 21:41:20 +00001805#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
danielk19778212def2006-01-16 15:32:23 +00001806 pPager->pNext = pTsd->pPager;
1807 pTsd->pPager = pPager;
danielk197752622822006-01-09 09:59:49 +00001808#endif
drhed7c8552001-04-11 14:29:21 +00001809 return SQLITE_OK;
1810}
1811
1812/*
drh90f5ecb2004-07-22 01:19:35 +00001813** Set the busy handler function.
1814*/
danielk19773b8a05f2007-03-19 17:44:26 +00001815void sqlite3PagerSetBusyhandler(Pager *pPager, BusyHandler *pBusyHandler){
drh90f5ecb2004-07-22 01:19:35 +00001816 pPager->pBusyHandler = pBusyHandler;
1817}
1818
1819/*
drh72f82862001-05-24 21:06:34 +00001820** Set the destructor for this pager. If not NULL, the destructor is called
drh5e00f6c2001-09-13 13:46:56 +00001821** when the reference count on each page reaches zero. The destructor can
1822** be used to clean up information in the extra segment appended to each page.
drh72f82862001-05-24 21:06:34 +00001823**
danielk19773b8a05f2007-03-19 17:44:26 +00001824** The destructor is not called as a result sqlite3PagerClose().
1825** Destructors are only called by sqlite3PagerUnref().
drh72f82862001-05-24 21:06:34 +00001826*/
danielk19773b8a05f2007-03-19 17:44:26 +00001827void sqlite3PagerSetDestructor(Pager *pPager, void (*xDesc)(DbPage*,int)){
drh72f82862001-05-24 21:06:34 +00001828 pPager->xDestructor = xDesc;
1829}
1830
1831/*
drha6abd042004-06-09 17:37:22 +00001832** Set the reinitializer for this pager. If not NULL, the reinitializer
1833** is called when the content of a page in cache is restored to its original
1834** value as a result of a rollback. The callback gives higher-level code
1835** an opportunity to restore the EXTRA section to agree with the restored
1836** page data.
1837*/
danielk19773b8a05f2007-03-19 17:44:26 +00001838void sqlite3PagerSetReiniter(Pager *pPager, void (*xReinit)(DbPage*,int)){
drha6abd042004-06-09 17:37:22 +00001839 pPager->xReiniter = xReinit;
1840}
1841
1842/*
drh1c7880e2005-05-20 20:01:55 +00001843** Set the page size. Return the new size. If the suggest new page
1844** size is inappropriate, then an alternative page size is selected
1845** and returned.
drh90f5ecb2004-07-22 01:19:35 +00001846*/
danielk19773b8a05f2007-03-19 17:44:26 +00001847int sqlite3PagerSetPagesize(Pager *pPager, int pageSize){
drh90f5ecb2004-07-22 01:19:35 +00001848 assert( pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE );
danielk1977c7c7e622007-03-26 15:46:00 +00001849 if( !pPager->memDb && pPager->nRef==0 ){
1850 pager_reset(pPager);
drh1c7880e2005-05-20 20:01:55 +00001851 pPager->pageSize = pageSize;
drhcf643722007-03-27 13:36:37 +00001852 pPager->pTmpSpace = sqlite3ReallocOrFree(pPager->pTmpSpace, pageSize);
drh1c7880e2005-05-20 20:01:55 +00001853 }
1854 return pPager->pageSize;
drh90f5ecb2004-07-22 01:19:35 +00001855}
1856
1857/*
drhc9ac5ca2005-11-04 22:03:30 +00001858** The following set of routines are used to disable the simulated
1859** I/O error mechanism. These routines are used to avoid simulated
1860** errors in places where we do not care about errors.
1861**
1862** Unless -DSQLITE_TEST=1 is used, these routines are all no-ops
1863** and generate no code.
1864*/
1865#ifdef SQLITE_TEST
1866extern int sqlite3_io_error_pending;
1867extern int sqlite3_io_error_hit;
1868static int saved_cnt;
drhc9ac5ca2005-11-04 22:03:30 +00001869void disable_simulated_io_errors(void){
1870 saved_cnt = sqlite3_io_error_pending;
1871 sqlite3_io_error_pending = -1;
1872}
1873void enable_simulated_io_errors(void){
1874 sqlite3_io_error_pending = saved_cnt;
1875}
1876#else
drh152410f2005-11-05 15:11:22 +00001877# define disable_simulated_io_errors()
1878# define enable_simulated_io_errors()
drhc9ac5ca2005-11-04 22:03:30 +00001879#endif
1880
1881/*
drh90f5ecb2004-07-22 01:19:35 +00001882** Read the first N bytes from the beginning of the file into memory
danielk1977aef0bf62005-12-30 16:28:01 +00001883** that pDest points to.
1884**
1885** No error checking is done. The rational for this is that this function
1886** may be called even if the file does not exist or contain a header. In
1887** these cases sqlite3OsRead() will return an error, to which the correct
1888** response is to zero the memory at pDest and continue. A real IO error
1889** will presumably recur and be picked up later (Todo: Think about this).
drh90f5ecb2004-07-22 01:19:35 +00001890*/
danielk19773b8a05f2007-03-19 17:44:26 +00001891int sqlite3PagerReadFileheader(Pager *pPager, int N, unsigned char *pDest){
drh551b7732006-11-06 21:20:25 +00001892 int rc = SQLITE_OK;
drh90f5ecb2004-07-22 01:19:35 +00001893 memset(pDest, 0, N);
drhb7f91642004-10-31 02:22:47 +00001894 if( MEMDB==0 ){
danielk1977f2fa8312006-01-24 13:09:33 +00001895 disable_simulated_io_errors();
drh054889e2005-11-30 03:20:31 +00001896 sqlite3OsSeek(pPager->fd, 0);
danielk1977f2fa8312006-01-24 13:09:33 +00001897 enable_simulated_io_errors();
drhb0603412007-02-28 04:47:26 +00001898 IOTRACE(("DBHDR %p 0 %d\n", pPager, N))
drh551b7732006-11-06 21:20:25 +00001899 rc = sqlite3OsRead(pPager->fd, pDest, N);
1900 if( rc==SQLITE_IOERR_SHORT_READ ){
1901 rc = SQLITE_OK;
1902 }
drh90f5ecb2004-07-22 01:19:35 +00001903 }
drh551b7732006-11-06 21:20:25 +00001904 return rc;
drh90f5ecb2004-07-22 01:19:35 +00001905}
1906
1907/*
drh5e00f6c2001-09-13 13:46:56 +00001908** Return the total number of pages in the disk file associated with
danielk197715f411d2005-09-16 10:18:45 +00001909** pPager.
1910**
1911** If the PENDING_BYTE lies on the page directly after the end of the
1912** file, then consider this page part of the file too. For example, if
1913** PENDING_BYTE is byte 4096 (the first byte of page 5) and the size of the
1914** file is 4096 bytes, 5 is returned instead of 4.
drhed7c8552001-04-11 14:29:21 +00001915*/
danielk19773b8a05f2007-03-19 17:44:26 +00001916int sqlite3PagerPagecount(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001917 i64 n;
drhe49f9822006-09-15 12:29:16 +00001918 int rc;
drhd9b02572001-04-15 00:37:09 +00001919 assert( pPager!=0 );
drha7aea3d2007-03-15 12:51:16 +00001920 if( pPager->errCode ){
1921 return 0;
1922 }
drhed7c8552001-04-11 14:29:21 +00001923 if( pPager->dbSize>=0 ){
danielk197715f411d2005-09-16 10:18:45 +00001924 n = pPager->dbSize;
1925 } else {
drhe49f9822006-09-15 12:29:16 +00001926 if( (rc = sqlite3OsFileSize(pPager->fd, &n))!=SQLITE_OK ){
1927 pager_error(pPager, rc);
danielk197715f411d2005-09-16 10:18:45 +00001928 return 0;
1929 }
1930 if( n>0 && n<pPager->pageSize ){
1931 n = 1;
1932 }else{
1933 n /= pPager->pageSize;
1934 }
1935 if( pPager->state!=PAGER_UNLOCK ){
1936 pPager->dbSize = n;
1937 }
drhed7c8552001-04-11 14:29:21 +00001938 }
danielk197715f411d2005-09-16 10:18:45 +00001939 if( n==(PENDING_BYTE/pPager->pageSize) ){
drh1f595712004-06-15 01:40:29 +00001940 n++;
1941 }
drhed7c8552001-04-11 14:29:21 +00001942 return n;
1943}
1944
drhf07e7d52006-04-07 13:54:46 +00001945
1946#ifndef SQLITE_OMIT_MEMORYDB
1947/*
1948** Clear a PgHistory block
1949*/
1950static void clearHistory(PgHistory *pHist){
1951 sqliteFree(pHist->pOrig);
1952 sqliteFree(pHist->pStmt);
1953 pHist->pOrig = 0;
1954 pHist->pStmt = 0;
1955}
1956#else
1957#define clearHistory(x)
1958#endif
1959
drhed7c8552001-04-11 14:29:21 +00001960/*
drhf7c57532003-04-25 13:22:51 +00001961** Forward declaration
1962*/
danielk197776572402004-06-25 02:38:54 +00001963static int syncJournal(Pager*);
drhac69b052004-05-12 13:30:07 +00001964
1965/*
danielk1977f5fdda82004-11-03 08:44:05 +00001966** Unlink pPg from it's hash chain. Also set the page number to 0 to indicate
1967** that the page is not part of any hash chain. This is required because the
danielk19773b8a05f2007-03-19 17:44:26 +00001968** sqlite3PagerMovepage() routine can leave a page in the
danielk1977f5fdda82004-11-03 08:44:05 +00001969** pNextFree/pPrevFree list that is not a part of any hash-chain.
1970*/
1971static void unlinkHashChain(Pager *pPager, PgHdr *pPg){
1972 if( pPg->pgno==0 ){
drh3765df42006-06-28 18:18:09 +00001973 assert( pPg->pNextHash==0 && pPg->pPrevHash==0 );
danielk1977f5fdda82004-11-03 08:44:05 +00001974 return;
1975 }
1976 if( pPg->pNextHash ){
1977 pPg->pNextHash->pPrevHash = pPg->pPrevHash;
1978 }
1979 if( pPg->pPrevHash ){
drh8ca0c722006-05-07 17:49:38 +00001980 assert( pPager->aHash[pPg->pgno & (pPager->nHash-1)]!=pPg );
danielk1977f5fdda82004-11-03 08:44:05 +00001981 pPg->pPrevHash->pNextHash = pPg->pNextHash;
1982 }else{
drh8ca0c722006-05-07 17:49:38 +00001983 int h = pPg->pgno & (pPager->nHash-1);
danielk1977f5fdda82004-11-03 08:44:05 +00001984 pPager->aHash[h] = pPg->pNextHash;
1985 }
drh5229ae42006-03-23 23:29:04 +00001986 if( MEMDB ){
drh5229ae42006-03-23 23:29:04 +00001987 clearHistory(PGHDR_TO_HIST(pPg, pPager));
1988 }
danielk1977f5fdda82004-11-03 08:44:05 +00001989 pPg->pgno = 0;
1990 pPg->pNextHash = pPg->pPrevHash = 0;
1991}
1992
1993/*
drhac69b052004-05-12 13:30:07 +00001994** Unlink a page from the free list (the list of all pages where nRef==0)
1995** and from its hash collision chain.
1996*/
1997static void unlinkPage(PgHdr *pPg){
1998 Pager *pPager = pPg->pPager;
1999
2000 /* Keep the pFirstSynced pointer pointing at the first synchronized page */
2001 if( pPg==pPager->pFirstSynced ){
2002 PgHdr *p = pPg->pNextFree;
2003 while( p && p->needSync ){ p = p->pNextFree; }
2004 pPager->pFirstSynced = p;
2005 }
2006
2007 /* Unlink from the freelist */
2008 if( pPg->pPrevFree ){
2009 pPg->pPrevFree->pNextFree = pPg->pNextFree;
2010 }else{
2011 assert( pPager->pFirst==pPg );
2012 pPager->pFirst = pPg->pNextFree;
2013 }
2014 if( pPg->pNextFree ){
2015 pPg->pNextFree->pPrevFree = pPg->pPrevFree;
2016 }else{
2017 assert( pPager->pLast==pPg );
2018 pPager->pLast = pPg->pPrevFree;
2019 }
2020 pPg->pNextFree = pPg->pPrevFree = 0;
2021
2022 /* Unlink from the pgno hash table */
danielk1977f5fdda82004-11-03 08:44:05 +00002023 unlinkHashChain(pPager, pPg);
drhac69b052004-05-12 13:30:07 +00002024}
2025
2026/*
danielk1977e180dd92007-04-05 17:15:52 +00002027** This routine is used to truncate the cache when a database
2028** is truncated. Drop from the cache all pages whose pgno is
2029** larger than pPager->dbSize and is unreferenced.
2030**
drhac69b052004-05-12 13:30:07 +00002031** Referenced pages larger than pPager->dbSize are zeroed.
danielk1977e180dd92007-04-05 17:15:52 +00002032**
2033** Actually, at the point this routine is called, it would be
2034** an error to have a referenced page. But rather than delete
2035** that page and guarantee a subsequent segfault, it seems better
2036** to zero it and hope that we error out sanely.
drhac69b052004-05-12 13:30:07 +00002037*/
danielk1977e180dd92007-04-05 17:15:52 +00002038static void pager_truncate_cache(Pager *pPager){
drhac69b052004-05-12 13:30:07 +00002039 PgHdr *pPg;
2040 PgHdr **ppPg;
2041 int dbSize = pPager->dbSize;
2042
2043 ppPg = &pPager->pAll;
2044 while( (pPg = *ppPg)!=0 ){
2045 if( pPg->pgno<=dbSize ){
2046 ppPg = &pPg->pNextAll;
2047 }else if( pPg->nRef>0 ){
2048 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
2049 ppPg = &pPg->pNextAll;
2050 }else{
2051 *ppPg = pPg->pNextAll;
2052 unlinkPage(pPg);
drh605ad8f2006-05-03 23:34:05 +00002053 makeClean(pPg);
drhac69b052004-05-12 13:30:07 +00002054 sqliteFree(pPg);
2055 pPager->nPage--;
2056 }
2057 }
2058}
2059
drhf7c57532003-04-25 13:22:51 +00002060/*
danielk197717221812005-02-15 03:38:05 +00002061** Try to obtain a lock on a file. Invoke the busy callback if the lock
drha4afb652005-07-09 02:16:02 +00002062** is currently not available. Repeat until the busy callback returns
danielk197717221812005-02-15 03:38:05 +00002063** false or until the lock succeeds.
2064**
2065** Return SQLITE_OK on success and an error code if we cannot obtain
2066** the lock.
2067*/
2068static int pager_wait_on_lock(Pager *pPager, int locktype){
2069 int rc;
drh1aa2d8b2007-01-03 15:34:29 +00002070
2071 /* The OS lock values must be the same as the Pager lock values */
danielk197717221812005-02-15 03:38:05 +00002072 assert( PAGER_SHARED==SHARED_LOCK );
2073 assert( PAGER_RESERVED==RESERVED_LOCK );
2074 assert( PAGER_EXCLUSIVE==EXCLUSIVE_LOCK );
drh1aa2d8b2007-01-03 15:34:29 +00002075
2076 /* If the file is currently unlocked then the size must be unknown */
2077 assert( pPager->state>=PAGER_SHARED || pPager->dbSize<0 || MEMDB );
2078
danielk197717221812005-02-15 03:38:05 +00002079 if( pPager->state>=locktype ){
2080 rc = SQLITE_OK;
2081 }else{
danielk197717221812005-02-15 03:38:05 +00002082 do {
drh054889e2005-11-30 03:20:31 +00002083 rc = sqlite3OsLock(pPager->fd, locktype);
drha4afb652005-07-09 02:16:02 +00002084 }while( rc==SQLITE_BUSY && sqlite3InvokeBusyHandler(pPager->pBusyHandler) );
danielk197717221812005-02-15 03:38:05 +00002085 if( rc==SQLITE_OK ){
2086 pPager->state = locktype;
drhb0603412007-02-28 04:47:26 +00002087 IOTRACE(("LOCK %p %d\n", pPager, locktype))
danielk197717221812005-02-15 03:38:05 +00002088 }
2089 }
2090 return rc;
2091}
2092
2093/*
drhf7c57532003-04-25 13:22:51 +00002094** Truncate the file to the number of pages specified.
2095*/
danielk19773b8a05f2007-03-19 17:44:26 +00002096int sqlite3PagerTruncate(Pager *pPager, Pgno nPage){
drhf7c57532003-04-25 13:22:51 +00002097 int rc;
drh1aa2d8b2007-01-03 15:34:29 +00002098 assert( pPager->state>=PAGER_SHARED || MEMDB );
danielk19773b8a05f2007-03-19 17:44:26 +00002099 sqlite3PagerPagecount(pPager);
danielk1977efaaf572006-01-16 11:29:19 +00002100 if( pPager->errCode ){
2101 rc = pPager->errCode;
drh2e6d11b2003-04-25 15:37:57 +00002102 return rc;
2103 }
drh7d02cb72003-06-04 16:24:39 +00002104 if( nPage>=(unsigned)pPager->dbSize ){
drhf7c57532003-04-25 13:22:51 +00002105 return SQLITE_OK;
2106 }
drhb7f91642004-10-31 02:22:47 +00002107 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00002108 pPager->dbSize = nPage;
danielk1977e180dd92007-04-05 17:15:52 +00002109 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00002110 return SQLITE_OK;
2111 }
danielk197776572402004-06-25 02:38:54 +00002112 rc = syncJournal(pPager);
danielk1977369f27e2004-06-15 11:40:04 +00002113 if( rc!=SQLITE_OK ){
2114 return rc;
2115 }
danielk197717221812005-02-15 03:38:05 +00002116
2117 /* Get an exclusive lock on the database before truncating. */
2118 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
2119 if( rc!=SQLITE_OK ){
2120 return rc;
2121 }
2122
drhcb4c40b2004-08-18 19:09:43 +00002123 rc = pager_truncate(pPager, nPage);
drhf7c57532003-04-25 13:22:51 +00002124 return rc;
2125}
2126
2127/*
drhed7c8552001-04-11 14:29:21 +00002128** Shutdown the page cache. Free all memory and close all files.
2129**
2130** If a transaction was in progress when this routine is called, that
2131** transaction is rolled back. All outstanding pages are invalidated
2132** and their memory is freed. Any attempt to use a page associated
2133** with this page cache after this function returns will likely
2134** result in a coredump.
danielk1977aef0bf62005-12-30 16:28:01 +00002135**
2136** This function always succeeds. If a transaction is active an attempt
2137** is made to roll it back. If an error occurs during the rollback
2138** a hot journal may be left in the filesystem but no error is returned
2139** to the caller.
drhed7c8552001-04-11 14:29:21 +00002140*/
danielk19773b8a05f2007-03-19 17:44:26 +00002141int sqlite3PagerClose(Pager *pPager){
drh6f7adc82006-01-11 21:41:20 +00002142#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
danielk197754f01982006-01-18 15:25:17 +00002143 /* A malloc() cannot fail in sqlite3ThreadData() as one or more calls to
2144 ** malloc() must have already been made by this thread before it gets
2145 ** to this point. This means the ThreadData must have been allocated already
2146 ** so that ThreadData.nAlloc can be set.
2147 */
danielk19778212def2006-01-16 15:32:23 +00002148 ThreadData *pTsd = sqlite3ThreadData();
danielk197776e8d1a2006-01-18 18:22:43 +00002149 assert( pPager );
danielk197754f01982006-01-18 15:25:17 +00002150 assert( pTsd && pTsd->nAlloc );
danielk197713f72992005-12-18 08:51:22 +00002151#endif
2152
drhbafda092007-01-03 23:36:22 +00002153 disable_simulated_io_errors();
drhc2ee76c2007-01-04 14:58:14 +00002154 pPager->errCode = 0;
danielk197741483462007-03-24 16:45:04 +00002155 pPager->exclusiveMode = 0;
drhbafda092007-01-03 23:36:22 +00002156 pager_reset(pPager);
danielk1977e277be02007-03-23 18:12:06 +00002157 pagerUnlockAndRollback(pPager);
drhbafda092007-01-03 23:36:22 +00002158 enable_simulated_io_errors();
drh4f0c5872007-03-26 22:05:01 +00002159 PAGERTRACE2("CLOSE %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002160 IOTRACE(("CLOSE %p\n", pPager))
danielk1977efaaf572006-01-16 11:29:19 +00002161 assert( pPager->errCode || (pPager->journalOpen==0 && pPager->stmtOpen==0) );
danielk1977e94ddc92005-03-21 03:53:38 +00002162 if( pPager->journalOpen ){
drh054889e2005-11-30 03:20:31 +00002163 sqlite3OsClose(&pPager->jfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002164 }
drh88b01a12005-03-28 18:04:27 +00002165 sqliteFree(pPager->aInJournal);
danielk1977e94ddc92005-03-21 03:53:38 +00002166 if( pPager->stmtOpen ){
drh054889e2005-11-30 03:20:31 +00002167 sqlite3OsClose(&pPager->stfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002168 }
drh054889e2005-11-30 03:20:31 +00002169 sqlite3OsClose(&pPager->fd);
drh0f892532002-05-30 12:27:03 +00002170 /* Temp files are automatically deleted by the OS
2171 ** if( pPager->tempFile ){
drh66560ad2006-01-06 14:32:19 +00002172 ** sqlite3OsDelete(pPager->zFilename);
drh0f892532002-05-30 12:27:03 +00002173 ** }
2174 */
danielk1977aca790a2005-01-13 11:07:52 +00002175
drh6f7adc82006-01-11 21:41:20 +00002176#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
danielk1977aef0bf62005-12-30 16:28:01 +00002177 /* Remove the pager from the linked list of pagers starting at
danielk197752622822006-01-09 09:59:49 +00002178 ** ThreadData.pPager if memory-management is enabled.
danielk1977aef0bf62005-12-30 16:28:01 +00002179 */
danielk19778212def2006-01-16 15:32:23 +00002180 if( pPager==pTsd->pPager ){
2181 pTsd->pPager = pPager->pNext;
2182 }else{
2183 Pager *pTmp;
drh74161702006-02-24 02:53:49 +00002184 for(pTmp = pTsd->pPager; pTmp->pNext!=pPager; pTmp=pTmp->pNext){}
danielk19778212def2006-01-16 15:32:23 +00002185 pTmp->pNext = pPager->pNext;
danielk197713f72992005-12-18 08:51:22 +00002186 }
2187#endif
drh8ca0c722006-05-07 17:49:38 +00002188 sqliteFree(pPager->aHash);
danielk19778186df82007-03-06 13:45:59 +00002189 sqliteFree(pPager->pTmpSpace);
drhed7c8552001-04-11 14:29:21 +00002190 sqliteFree(pPager);
2191 return SQLITE_OK;
2192}
2193
2194/*
drh5e00f6c2001-09-13 13:46:56 +00002195** Return the page number for the given page data.
drhed7c8552001-04-11 14:29:21 +00002196*/
danielk19773b8a05f2007-03-19 17:44:26 +00002197Pgno sqlite3PagerPagenumber(DbPage *p){
drhed7c8552001-04-11 14:29:21 +00002198 return p->pgno;
2199}
2200
2201/*
drhc8629a12004-05-08 20:07:40 +00002202** The page_ref() function increments the reference count for a page.
2203** If the page is currently on the freelist (the reference count is zero) then
drh7e3b0a02001-04-28 16:52:40 +00002204** remove it from the freelist.
drhc8629a12004-05-08 20:07:40 +00002205**
2206** For non-test systems, page_ref() is a macro that calls _page_ref()
2207** online of the reference count is zero. For test systems, page_ref()
2208** is a real function so that we can set breakpoints and trace it.
drh7e3b0a02001-04-28 16:52:40 +00002209*/
drh836faa42003-01-11 13:30:57 +00002210static void _page_ref(PgHdr *pPg){
drh7e3b0a02001-04-28 16:52:40 +00002211 if( pPg->nRef==0 ){
2212 /* The page is currently on the freelist. Remove it. */
drh341eae82003-01-21 02:39:36 +00002213 if( pPg==pPg->pPager->pFirstSynced ){
2214 PgHdr *p = pPg->pNextFree;
2215 while( p && p->needSync ){ p = p->pNextFree; }
2216 pPg->pPager->pFirstSynced = p;
2217 }
drh7e3b0a02001-04-28 16:52:40 +00002218 if( pPg->pPrevFree ){
2219 pPg->pPrevFree->pNextFree = pPg->pNextFree;
2220 }else{
2221 pPg->pPager->pFirst = pPg->pNextFree;
2222 }
2223 if( pPg->pNextFree ){
2224 pPg->pNextFree->pPrevFree = pPg->pPrevFree;
2225 }else{
2226 pPg->pPager->pLast = pPg->pPrevFree;
2227 }
2228 pPg->pPager->nRef++;
2229 }
2230 pPg->nRef++;
drhdd793422001-06-28 01:54:48 +00002231 REFINFO(pPg);
drhdf0b3b02001-06-23 11:36:20 +00002232}
danielk1977aca790a2005-01-13 11:07:52 +00002233#ifdef SQLITE_DEBUG
drhc8629a12004-05-08 20:07:40 +00002234 static void page_ref(PgHdr *pPg){
2235 if( pPg->nRef==0 ){
2236 _page_ref(pPg);
2237 }else{
2238 pPg->nRef++;
2239 REFINFO(pPg);
2240 }
2241 }
2242#else
2243# define page_ref(P) ((P)->nRef==0?_page_ref(P):(void)(P)->nRef++)
2244#endif
drhdf0b3b02001-06-23 11:36:20 +00002245
2246/*
2247** Increment the reference count for a page. The input pointer is
2248** a reference to the page data.
2249*/
danielk19773b8a05f2007-03-19 17:44:26 +00002250int sqlite3PagerRef(DbPage *pPg){
drhdf0b3b02001-06-23 11:36:20 +00002251 page_ref(pPg);
drh8c42ca92001-06-22 19:15:00 +00002252 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +00002253}
2254
2255/*
drh34e79ce2004-02-08 06:05:46 +00002256** Sync the journal. In other words, make sure all the pages that have
2257** been written to the journal have actually reached the surface of the
2258** disk. It is not safe to modify the original database file until after
2259** the journal has been synced. If the original database is modified before
2260** the journal is synced and a power failure occurs, the unsynced journal
2261** data would be lost and we would be unable to completely rollback the
2262** database changes. Database corruption would occur.
2263**
2264** This routine also updates the nRec field in the header of the journal.
2265** (See comments on the pager_playback() routine for additional information.)
2266** If the sync mode is FULL, two syncs will occur. First the whole journal
2267** is synced, then the nRec field is updated, then a second sync occurs.
drhb19a2bc2001-09-16 00:13:26 +00002268**
drh34e79ce2004-02-08 06:05:46 +00002269** For temporary databases, we do not care if we are able to rollback
2270** after a power failure, so sync occurs.
drhfa86c412002-02-02 15:01:15 +00002271**
drh34e79ce2004-02-08 06:05:46 +00002272** This routine clears the needSync field of every page current held in
2273** memory.
drh50e5dad2001-09-15 00:57:28 +00002274*/
danielk197776572402004-06-25 02:38:54 +00002275static int syncJournal(Pager *pPager){
drh50e5dad2001-09-15 00:57:28 +00002276 PgHdr *pPg;
2277 int rc = SQLITE_OK;
drh03eb96a2002-11-10 23:32:56 +00002278
2279 /* Sync the journal before modifying the main database
2280 ** (assuming there is a journal and it needs to be synced.)
2281 */
danielk197776572402004-06-25 02:38:54 +00002282 if( pPager->needSync ){
drhfa86c412002-02-02 15:01:15 +00002283 if( !pPager->tempFile ){
drhdb48ee02003-01-16 13:42:43 +00002284 assert( pPager->journalOpen );
drh946966f2004-02-25 02:20:41 +00002285 /* assert( !pPager->noSync ); // noSync might be set if synchronous
2286 ** was turned off after the transaction was started. Ticket #615 */
drh968af522003-02-11 14:55:40 +00002287#ifndef NDEBUG
2288 {
drh34e79ce2004-02-08 06:05:46 +00002289 /* Make sure the pPager->nRec counter we are keeping agrees
2290 ** with the nRec computed from the size of the journal file.
2291 */
drheb206252004-10-01 02:00:31 +00002292 i64 jSz;
drh054889e2005-11-30 03:20:31 +00002293 rc = sqlite3OsFileSize(pPager->jfd, &jSz);
drh968af522003-02-11 14:55:40 +00002294 if( rc!=0 ) return rc;
danielk197776572402004-06-25 02:38:54 +00002295 assert( pPager->journalOff==jSz );
drh968af522003-02-11 14:55:40 +00002296 }
2297#endif
drhae2b40c2004-06-09 19:03:54 +00002298 {
danielk197776572402004-06-25 02:38:54 +00002299 /* Write the nRec value into the journal file header. If in
2300 ** full-synchronous mode, sync the journal first. This ensures that
2301 ** all data has really hit the disk before nRec is updated to mark
2302 ** it as a candidate for rollback.
2303 */
drhd8d66e82003-02-12 02:10:15 +00002304 if( pPager->fullSync ){
drh4f0c5872007-03-26 22:05:01 +00002305 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002306 IOTRACE(("JSYNC %p\n", pPager))
drh054889e2005-11-30 03:20:31 +00002307 rc = sqlite3OsSync(pPager->jfd, 0);
drhd8d66e82003-02-12 02:10:15 +00002308 if( rc!=0 ) return rc;
2309 }
drh054889e2005-11-30 03:20:31 +00002310 rc = sqlite3OsSeek(pPager->jfd,
drhb4746b92005-09-09 01:32:06 +00002311 pPager->journalHdr + sizeof(aJournalMagic));
2312 if( rc ) return rc;
drhb0603412007-02-28 04:47:26 +00002313 IOTRACE(("JHDR %p %lld %d\n", pPager,
2314 pPager->journalHdr + sizeof(aJournalMagic), 4))
drh9cbe6352005-11-29 03:13:21 +00002315 rc = write32bits(pPager->jfd, pPager->nRec);
drh99ee3602003-02-16 19:13:36 +00002316 if( rc ) return rc;
danielk197713adf8a2004-06-03 16:08:41 +00002317
drh054889e2005-11-30 03:20:31 +00002318 rc = sqlite3OsSeek(pPager->jfd, pPager->journalOff);
drhb4746b92005-09-09 01:32:06 +00002319 if( rc ) return rc;
drh968af522003-02-11 14:55:40 +00002320 }
drh4f0c5872007-03-26 22:05:01 +00002321 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002322 IOTRACE(("JSYNC %d\n", pPager))
drhac530b12006-02-11 01:25:50 +00002323 rc = sqlite3OsSync(pPager->jfd, pPager->full_fsync);
drhfa86c412002-02-02 15:01:15 +00002324 if( rc!=0 ) return rc;
drhdb48ee02003-01-16 13:42:43 +00002325 pPager->journalStarted = 1;
drhfa86c412002-02-02 15:01:15 +00002326 }
drh50e5dad2001-09-15 00:57:28 +00002327 pPager->needSync = 0;
drh341eae82003-01-21 02:39:36 +00002328
2329 /* Erase the needSync flag from every page.
2330 */
2331 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2332 pPg->needSync = 0;
2333 }
2334 pPager->pFirstSynced = pPager->pFirst;
drh50e5dad2001-09-15 00:57:28 +00002335 }
drh03eb96a2002-11-10 23:32:56 +00002336
drh341eae82003-01-21 02:39:36 +00002337#ifndef NDEBUG
2338 /* If the Pager.needSync flag is clear then the PgHdr.needSync
2339 ** flag must also be clear for all pages. Verify that this
2340 ** invariant is true.
drh03eb96a2002-11-10 23:32:56 +00002341 */
drh341eae82003-01-21 02:39:36 +00002342 else{
2343 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2344 assert( pPg->needSync==0 );
2345 }
2346 assert( pPager->pFirstSynced==pPager->pFirst );
drh03eb96a2002-11-10 23:32:56 +00002347 }
drh341eae82003-01-21 02:39:36 +00002348#endif
drhdb48ee02003-01-16 13:42:43 +00002349
drh81a20f22001-10-12 17:30:04 +00002350 return rc;
drh50e5dad2001-09-15 00:57:28 +00002351}
2352
2353/*
drhdc3e10b2006-06-15 14:31:06 +00002354** Merge two lists of pages connected by pDirty and in pgno order.
2355** Do not both fixing the pPrevDirty pointers.
2356*/
2357static PgHdr *merge_pagelist(PgHdr *pA, PgHdr *pB){
2358 PgHdr result, *pTail;
2359 pTail = &result;
2360 while( pA && pB ){
2361 if( pA->pgno<pB->pgno ){
2362 pTail->pDirty = pA;
2363 pTail = pA;
2364 pA = pA->pDirty;
2365 }else{
2366 pTail->pDirty = pB;
2367 pTail = pB;
2368 pB = pB->pDirty;
2369 }
2370 }
2371 if( pA ){
2372 pTail->pDirty = pA;
2373 }else if( pB ){
2374 pTail->pDirty = pB;
2375 }else{
2376 pTail->pDirty = 0;
2377 }
2378 return result.pDirty;
2379}
2380
2381/*
2382** Sort the list of pages in accending order by pgno. Pages are
2383** connected by pDirty pointers. The pPrevDirty pointers are
2384** corrupted by this sort.
2385*/
danielk197724168722007-04-02 05:07:47 +00002386#define N_SORT_BUCKET_ALLOC 25
2387#define N_SORT_BUCKET 25
2388#ifdef SQLITE_TEST
2389 int sqlite3_pager_n_sort_bucket = 0;
2390 #undef N_SORT_BUCKET
2391 #define N_SORT_BUCKET \
2392 (sqlite3_pager_n_sort_bucket?sqlite3_pager_n_sort_bucket:N_SORT_BUCKET_ALLOC)
2393#endif
drhdc3e10b2006-06-15 14:31:06 +00002394static PgHdr *sort_pagelist(PgHdr *pIn){
danielk197724168722007-04-02 05:07:47 +00002395 PgHdr *a[N_SORT_BUCKET_ALLOC], *p;
drhdc3e10b2006-06-15 14:31:06 +00002396 int i;
2397 memset(a, 0, sizeof(a));
2398 while( pIn ){
2399 p = pIn;
2400 pIn = p->pDirty;
2401 p->pDirty = 0;
2402 for(i=0; i<N_SORT_BUCKET-1; i++){
2403 if( a[i]==0 ){
2404 a[i] = p;
2405 break;
2406 }else{
2407 p = merge_pagelist(a[i], p);
2408 a[i] = 0;
2409 }
2410 }
2411 if( i==N_SORT_BUCKET-1 ){
danielk197724168722007-04-02 05:07:47 +00002412 /* Coverage: To get here, there need to be 2^(N_SORT_BUCKET)
2413 ** elements in the input list. This is possible, but impractical.
2414 ** Testing this line is the point of global variable
2415 ** sqlite3_pager_n_sort_bucket.
2416 */
drhdc3e10b2006-06-15 14:31:06 +00002417 a[i] = merge_pagelist(a[i], p);
2418 }
2419 }
2420 p = a[0];
2421 for(i=1; i<N_SORT_BUCKET; i++){
2422 p = merge_pagelist(p, a[i]);
2423 }
2424 return p;
2425}
2426
2427/*
drh2554f8b2003-01-22 01:26:44 +00002428** Given a list of pages (connected by the PgHdr.pDirty pointer) write
2429** every one of those pages out to the database file and mark them all
2430** as clean.
2431*/
2432static int pager_write_pagelist(PgHdr *pList){
2433 Pager *pPager;
2434 int rc;
2435
2436 if( pList==0 ) return SQLITE_OK;
2437 pPager = pList->pPager;
danielk19779eed5052004-06-04 10:38:30 +00002438
2439 /* At this point there may be either a RESERVED or EXCLUSIVE lock on the
2440 ** database file. If there is already an EXCLUSIVE lock, the following
drh054889e2005-11-30 03:20:31 +00002441 ** calls to sqlite3OsLock() are no-ops.
danielk19779eed5052004-06-04 10:38:30 +00002442 **
drha6abd042004-06-09 17:37:22 +00002443 ** Moving the lock from RESERVED to EXCLUSIVE actually involves going
2444 ** through an intermediate state PENDING. A PENDING lock prevents new
2445 ** readers from attaching to the database but is unsufficient for us to
2446 ** write. The idea of a PENDING lock is to prevent new readers from
2447 ** coming in while we wait for existing readers to clear.
danielk19779eed5052004-06-04 10:38:30 +00002448 **
drha6abd042004-06-09 17:37:22 +00002449 ** While the pager is in the RESERVED state, the original database file
2450 ** is unchanged and we can rollback without having to playback the
2451 ** journal into the original database file. Once we transition to
2452 ** EXCLUSIVE, it means the database file has been changed and any rollback
2453 ** will require a journal playback.
danielk19779eed5052004-06-04 10:38:30 +00002454 */
drh684917c2004-10-05 02:41:42 +00002455 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
danielk19779eed5052004-06-04 10:38:30 +00002456 if( rc!=SQLITE_OK ){
2457 return rc;
2458 }
2459
drhdc3e10b2006-06-15 14:31:06 +00002460 pList = sort_pagelist(pList);
drh2554f8b2003-01-22 01:26:44 +00002461 while( pList ){
2462 assert( pList->dirty );
drh054889e2005-11-30 03:20:31 +00002463 rc = sqlite3OsSeek(pPager->fd, (pList->pgno-1)*(i64)pPager->pageSize);
drhb4746b92005-09-09 01:32:06 +00002464 if( rc ) return rc;
danielk1977687566d2004-11-02 12:56:41 +00002465 /* If there are dirty pages in the page cache with page numbers greater
danielk19773b8a05f2007-03-19 17:44:26 +00002466 ** than Pager.dbSize, this means sqlite3PagerTruncate() was called to
danielk1977687566d2004-11-02 12:56:41 +00002467 ** make the file smaller (presumably by auto-vacuum code). Do not write
2468 ** any such pages to the file.
2469 */
2470 if( pList->pgno<=pPager->dbSize ){
drhc001c582006-03-06 18:23:16 +00002471 char *pData = CODEC2(pPager, PGHDR_TO_DATA(pList), pList->pgno, 6);
drh4f0c5872007-03-26 22:05:01 +00002472 PAGERTRACE3("STORE %d page %d\n", PAGERID(pPager), pList->pgno);
drhb0603412007-02-28 04:47:26 +00002473 IOTRACE(("PGOUT %p %d\n", pPager, pList->pgno))
drhc001c582006-03-06 18:23:16 +00002474 rc = sqlite3OsWrite(pPager->fd, pData, pPager->pageSize);
drhfcd35c72005-05-21 02:48:08 +00002475 TEST_INCR(pPager->nWrite);
danielk1977687566d2004-11-02 12:56:41 +00002476 }
2477#ifndef NDEBUG
2478 else{
drh4f0c5872007-03-26 22:05:01 +00002479 PAGERTRACE3("NOSTORE %d page %d\n", PAGERID(pPager), pList->pgno);
danielk1977687566d2004-11-02 12:56:41 +00002480 }
2481#endif
drh2554f8b2003-01-22 01:26:44 +00002482 if( rc ) return rc;
2483 pList->dirty = 0;
danielk19773c407372005-02-15 02:54:14 +00002484#ifdef SQLITE_CHECK_PAGES
2485 pList->pageHash = pager_pagehash(pList);
2486#endif
drh2554f8b2003-01-22 01:26:44 +00002487 pList = pList->pDirty;
2488 }
2489 return SQLITE_OK;
2490}
2491
2492/*
2493** Collect every dirty page into a dirty list and
2494** return a pointer to the head of that list. All pages are
2495** collected even if they are still in use.
2496*/
2497static PgHdr *pager_get_all_dirty_pages(Pager *pPager){
drh605ad8f2006-05-03 23:34:05 +00002498 return pPager->pDirty;
drh2554f8b2003-01-22 01:26:44 +00002499}
2500
2501/*
drh165ffe92005-03-15 17:09:30 +00002502** Return TRUE if there is a hot journal on the given pager.
2503** A hot journal is one that needs to be played back.
2504**
2505** If the current size of the database file is 0 but a journal file
2506** exists, that is probably an old journal left over from a prior
2507** database with the same name. Just delete the journal.
2508*/
2509static int hasHotJournal(Pager *pPager){
2510 if( !pPager->useJournal ) return 0;
drhbb5f18d2007-04-06 18:23:17 +00002511 if( !sqlite3OsFileExists(pPager->zJournal) ){
2512 return 0;
2513 }
2514 if( sqlite3OsCheckReservedLock(pPager->fd) ){
2515 return 0;
2516 }
danielk19773b8a05f2007-03-19 17:44:26 +00002517 if( sqlite3PagerPagecount(pPager)==0 ){
drh66560ad2006-01-06 14:32:19 +00002518 sqlite3OsDelete(pPager->zJournal);
drh165ffe92005-03-15 17:09:30 +00002519 return 0;
2520 }else{
2521 return 1;
2522 }
2523}
2524
danielk19775591df52005-12-20 09:19:37 +00002525/*
danielk1977aef0bf62005-12-30 16:28:01 +00002526** Try to find a page in the cache that can be recycled.
2527**
2528** This routine may return SQLITE_IOERR, SQLITE_FULL or SQLITE_OK. It
danielk1977efaaf572006-01-16 11:29:19 +00002529** does not set the pPager->errCode variable.
danielk19775591df52005-12-20 09:19:37 +00002530*/
danielk197713f72992005-12-18 08:51:22 +00002531static int pager_recycle(Pager *pPager, int syncOk, PgHdr **ppPg){
2532 PgHdr *pPg;
2533 *ppPg = 0;
2534
danielk1977c551edc2007-04-05 13:12:13 +00002535 assert(!MEMDB);
2536
danielk197713f72992005-12-18 08:51:22 +00002537 /* Find a page to recycle. Try to locate a page that does not
2538 ** require us to do an fsync() on the journal.
2539 */
2540 pPg = pPager->pFirstSynced;
2541
2542 /* If we could not find a page that does not require an fsync()
2543 ** on the journal file then fsync the journal file. This is a
2544 ** very slow operation, so we work hard to avoid it. But sometimes
2545 ** it can't be helped.
2546 */
danielk19775591df52005-12-20 09:19:37 +00002547 if( pPg==0 && pPager->pFirst && syncOk && !MEMDB){
danielk197713f72992005-12-18 08:51:22 +00002548 int rc = syncJournal(pPager);
2549 if( rc!=0 ){
danielk1977aef0bf62005-12-30 16:28:01 +00002550 return rc;
danielk197713f72992005-12-18 08:51:22 +00002551 }
2552 if( pPager->fullSync ){
2553 /* If in full-sync mode, write a new journal header into the
2554 ** journal file. This is done to avoid ever modifying a journal
2555 ** header that is involved in the rollback of pages that have
2556 ** already been written to the database (in case the header is
2557 ** trashed when the nRec field is updated).
2558 */
2559 pPager->nRec = 0;
2560 assert( pPager->journalOff > 0 );
danielk19774099f6e2007-03-19 11:25:20 +00002561 assert( pPager->doNotSync==0 );
danielk197713f72992005-12-18 08:51:22 +00002562 rc = writeJournalHdr(pPager);
2563 if( rc!=0 ){
danielk1977aef0bf62005-12-30 16:28:01 +00002564 return rc;
danielk197713f72992005-12-18 08:51:22 +00002565 }
2566 }
2567 pPg = pPager->pFirst;
2568 }
2569 if( pPg==0 ){
2570 return SQLITE_OK;
2571 }
2572
2573 assert( pPg->nRef==0 );
2574
2575 /* Write the page to the database file if it is dirty.
2576 */
2577 if( pPg->dirty ){
2578 int rc;
2579 assert( pPg->needSync==0 );
drh605ad8f2006-05-03 23:34:05 +00002580 makeClean(pPg);
2581 pPg->dirty = 1;
danielk197713f72992005-12-18 08:51:22 +00002582 pPg->pDirty = 0;
2583 rc = pager_write_pagelist( pPg );
2584 if( rc!=SQLITE_OK ){
danielk1977aef0bf62005-12-30 16:28:01 +00002585 return rc;
danielk197713f72992005-12-18 08:51:22 +00002586 }
2587 }
2588 assert( pPg->dirty==0 );
2589
2590 /* If the page we are recycling is marked as alwaysRollback, then
2591 ** set the global alwaysRollback flag, thus disabling the
drh80e35f42007-03-30 14:06:34 +00002592 ** sqlite3PagerDontRollback() optimization for the rest of this transaction.
danielk197713f72992005-12-18 08:51:22 +00002593 ** It is necessary to do this because the page marked alwaysRollback
2594 ** might be reloaded at a later time but at that point we won't remember
2595 ** that is was marked alwaysRollback. This means that all pages must
2596 ** be marked as alwaysRollback from here on out.
2597 */
2598 if( pPg->alwaysRollback ){
drh602c2372007-03-01 00:29:13 +00002599 IOTRACE(("ALWAYS_ROLLBACK %p\n", pPager))
danielk197713f72992005-12-18 08:51:22 +00002600 pPager->alwaysRollback = 1;
2601 }
2602
2603 /* Unlink the old page from the free list and the hash table
2604 */
2605 unlinkPage(pPg);
drh7c4ac0c2007-04-05 11:25:58 +00002606 assert( pPg->pgno==0 );
danielk197713f72992005-12-18 08:51:22 +00002607
2608 *ppPg = pPg;
2609 return SQLITE_OK;
2610}
2611
2612/*
2613** This function is called to free superfluous dynamically allocated memory
2614** held by the pager system. Memory in use by any SQLite pager allocated
2615** by the current thread may be sqliteFree()ed.
2616**
2617** nReq is the number of bytes of memory required. Once this much has
danielk19770190d1d2005-12-19 14:18:11 +00002618** been released, the function returns. A negative value for nReq means
2619** free as much memory as possible. The return value is the total number
danielk197713f72992005-12-18 08:51:22 +00002620** of bytes of memory released.
2621*/
drh6f7adc82006-01-11 21:41:20 +00002622#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
danielk19773b8a05f2007-03-19 17:44:26 +00002623int sqlite3PagerReleaseMemory(int nReq){
drh6f7adc82006-01-11 21:41:20 +00002624 const ThreadData *pTsdro = sqlite3ThreadDataReadOnly();
danielk197713f72992005-12-18 08:51:22 +00002625 int nReleased = 0;
2626 int i;
2627
drh29c636b2006-01-09 23:40:25 +00002628 /* If the the global mutex is held, this subroutine becomes a
2629 ** o-op; zero bytes of memory are freed. This is because
2630 ** some of the code invoked by this function may also
2631 ** try to obtain the mutex, resulting in a deadlock.
danielk1977441b09a2006-01-05 13:48:29 +00002632 */
drh757b04e2006-01-18 17:25:45 +00002633 if( sqlite3OsInMutex(0) ){
danielk1977441b09a2006-01-05 13:48:29 +00002634 return 0;
2635 }
2636
danielk197713f72992005-12-18 08:51:22 +00002637 /* Outermost loop runs for at most two iterations. First iteration we
2638 ** try to find memory that can be released without calling fsync(). Second
2639 ** iteration (which only runs if the first failed to free nReq bytes of
2640 ** memory) is permitted to call fsync(). This is of course much more
2641 ** expensive.
2642 */
drh29c636b2006-01-09 23:40:25 +00002643 for(i=0; i<=1; i++){
danielk197713f72992005-12-18 08:51:22 +00002644
2645 /* Loop through all the SQLite pagers opened by the current thread. */
danielk197738ec0cb2007-04-05 14:29:42 +00002646 Pager *pPager = pTsdro->pPager;
2647 for( ; pPager && (nReq<0 || nReleased<nReq); pPager=pPager->pNext){
danielk197713f72992005-12-18 08:51:22 +00002648 PgHdr *pPg;
2649 int rc;
2650
danielk197738ec0cb2007-04-05 14:29:42 +00002651 if( MEMDB ){
danielk1977c551edc2007-04-05 13:12:13 +00002652 continue;
2653 }
danielk1977c551edc2007-04-05 13:12:13 +00002654
danielk197713f72992005-12-18 08:51:22 +00002655 /* For each pager, try to free as many pages as possible (without
2656 ** calling fsync() if this is the first iteration of the outermost
2657 ** loop).
2658 */
danielk197738ec0cb2007-04-05 14:29:42 +00002659 while( SQLITE_OK==(rc = pager_recycle(pPager, i, &pPg)) && pPg) {
danielk1977aef0bf62005-12-30 16:28:01 +00002660 /* We've found a page to free. At this point the page has been
danielk197713f72992005-12-18 08:51:22 +00002661 ** removed from the page hash-table, free-list and synced-list
danielk1977aef0bf62005-12-30 16:28:01 +00002662 ** (pFirstSynced). It is still in the all pages (pAll) list.
danielk197713f72992005-12-18 08:51:22 +00002663 ** Remove it from this list before freeing.
2664 **
2665 ** Todo: Check the Pager.pStmt list to make sure this is Ok. It
2666 ** probably is though.
2667 */
2668 PgHdr *pTmp;
danielk19770190d1d2005-12-19 14:18:11 +00002669 assert( pPg );
danielk197738ec0cb2007-04-05 14:29:42 +00002670 if( pPg==pPager->pAll ){
2671 pPager->pAll = pPg->pNextAll;
danielk197713f72992005-12-18 08:51:22 +00002672 }else{
danielk197738ec0cb2007-04-05 14:29:42 +00002673 for( pTmp=pPager->pAll; pTmp->pNextAll!=pPg; pTmp=pTmp->pNextAll ){}
danielk197713f72992005-12-18 08:51:22 +00002674 pTmp->pNextAll = pPg->pNextAll;
2675 }
2676 nReleased += sqliteAllocSize(pPg);
2677 sqliteFree(pPg);
2678 }
2679
2680 if( rc!=SQLITE_OK ){
danielk1977aef0bf62005-12-30 16:28:01 +00002681 /* An error occured whilst writing to the database file or
2682 ** journal in pager_recycle(). The error is not returned to the
danielk1977efaaf572006-01-16 11:29:19 +00002683 ** caller of this function. Instead, set the Pager.errCode variable.
danielk1977aef0bf62005-12-30 16:28:01 +00002684 ** The error will be returned to the user (or users, in the case
2685 ** of a shared pager cache) of the pager for which the error occured.
danielk197713f72992005-12-18 08:51:22 +00002686 */
drh4ac285a2006-09-15 07:28:50 +00002687 assert( (rc&0xff)==SQLITE_IOERR || rc==SQLITE_FULL );
danielk197738ec0cb2007-04-05 14:29:42 +00002688 assert( pPager->state>=PAGER_RESERVED );
2689 pager_error(pPager, rc);
danielk197713f72992005-12-18 08:51:22 +00002690 }
2691 }
2692 }
danielk1977aef0bf62005-12-30 16:28:01 +00002693
danielk197713f72992005-12-18 08:51:22 +00002694 return nReleased;
2695}
drh6f7adc82006-01-11 21:41:20 +00002696#endif /* SQLITE_ENABLE_MEMORY_MANAGEMENT */
danielk197713f72992005-12-18 08:51:22 +00002697
drh165ffe92005-03-15 17:09:30 +00002698/*
danielk1977e180dd92007-04-05 17:15:52 +00002699** Read the content of page pPg out of the database file.
2700*/
2701static int readDbPage(Pager *pPager, PgHdr *pPg, Pgno pgno){
2702 int rc;
2703 assert( MEMDB==0 );
2704 rc = sqlite3OsSeek(pPager->fd, (pgno-1)*(i64)pPager->pageSize);
2705 if( rc==SQLITE_OK ){
2706 rc = sqlite3OsRead(pPager->fd, PGHDR_TO_DATA(pPg),
2707 pPager->pageSize);
2708 }
2709 IOTRACE(("PGIN %p %d\n", pPager, pgno))
2710 PAGERTRACE3("FETCH %d page %d\n", PAGERID(pPager), pPg->pgno);
2711 CODEC1(pPager, PGHDR_TO_DATA(pPg), pPg->pgno, 3);
2712 return rc;
2713}
2714
2715
2716/*
danielk1977e277be02007-03-23 18:12:06 +00002717** This function is called to obtain the shared lock required before
2718** data may be read from the pager cache. If the shared lock has already
2719** been obtained, this function is a no-op.
danielk1977393f0682007-03-31 10:00:48 +00002720**
2721** Immediately after obtaining the shared lock (if required), this function
2722** checks for a hot-journal file. If one is found, an emergency rollback
2723** is performed immediately.
danielk1977e277be02007-03-23 18:12:06 +00002724*/
2725static int pagerSharedLock(Pager *pPager){
2726 int rc = SQLITE_OK;
2727
2728 if( pPager->state==PAGER_UNLOCK ){
2729 if( !MEMDB ){
2730 assert( pPager->nRef==0 );
2731 if( !pPager->noReadlock ){
2732 rc = pager_wait_on_lock(pPager, SHARED_LOCK);
2733 if( rc!=SQLITE_OK ){
2734 return pager_error(pPager, rc);
2735 }
2736 assert( pPager->state>=SHARED_LOCK );
2737 }
2738
2739 /* If a journal file exists, and there is no RESERVED lock on the
2740 ** database file, then it either needs to be played back or deleted.
2741 */
2742 if( hasHotJournal(pPager) ){
2743 /* Get an EXCLUSIVE lock on the database file. At this point it is
2744 ** important that a RESERVED lock is not obtained on the way to the
2745 ** EXCLUSIVE lock. If it were, another process might open the
2746 ** database file, detect the RESERVED lock, and conclude that the
2747 ** database is safe to read while this process is still rolling it
2748 ** back.
2749 **
2750 ** Because the intermediate RESERVED lock is not requested, the
2751 ** second process will get to this point in the code and fail to
2752 ** obtain it's own EXCLUSIVE lock on the database file.
2753 */
2754 rc = sqlite3OsLock(pPager->fd, EXCLUSIVE_LOCK);
2755 if( rc!=SQLITE_OK ){
2756 pager_unlock(pPager);
2757 return pager_error(pPager, rc);
2758 }
2759 pPager->state = PAGER_EXCLUSIVE;
2760
2761 /* Open the journal for reading only. Return SQLITE_BUSY if
2762 ** we are unable to open the journal file.
2763 **
2764 ** The journal file does not need to be locked itself. The
2765 ** journal file is never open unless the main database file holds
2766 ** a write lock, so there is never any chance of two or more
2767 ** processes opening the journal at the same time.
danielk1977979f38e2007-03-27 16:19:51 +00002768 **
2769 ** Open the journal for read/write access. This is because in
2770 ** exclusive-access mode the file descriptor will be kept open and
2771 ** possibly used for a transaction later on. On some systems, the
2772 ** OsTruncate() call used in exclusive-access mode also requires
2773 ** a read/write file handle.
danielk1977e277be02007-03-23 18:12:06 +00002774 */
danielk1977979f38e2007-03-27 16:19:51 +00002775 rc = SQLITE_BUSY;
2776 if( sqlite3OsFileExists(pPager->zJournal) ){
2777 int ro;
danielk19777152de82007-03-29 17:28:14 +00002778 assert( !pPager->tempFile );
danielk1977979f38e2007-03-27 16:19:51 +00002779 rc = sqlite3OsOpenReadWrite(pPager->zJournal, &pPager->jfd, &ro);
danielk19775bb16fe2007-04-05 11:54:42 +00002780 assert( rc!=SQLITE_OK || pPager->jfd );
danielk1977979f38e2007-03-27 16:19:51 +00002781 if( ro ){
2782 rc = SQLITE_BUSY;
danielk197708d31a22007-04-02 11:08:58 +00002783 sqlite3OsClose(&pPager->jfd);
danielk1977979f38e2007-03-27 16:19:51 +00002784 }
2785 }
danielk1977e277be02007-03-23 18:12:06 +00002786 if( rc!=SQLITE_OK ){
2787 pager_unlock(pPager);
2788 return SQLITE_BUSY;
2789 }
2790 pPager->journalOpen = 1;
2791 pPager->journalStarted = 0;
2792 pPager->journalOff = 0;
2793 pPager->setMaster = 0;
2794 pPager->journalHdr = 0;
2795
2796 /* Playback and delete the journal. Drop the database write
2797 ** lock and reacquire the read lock.
2798 */
2799 rc = pager_playback(pPager, 1);
2800 if( rc!=SQLITE_OK ){
2801 return pager_error(pPager, rc);
2802 }
danielk1977c5859712007-03-26 12:26:27 +00002803 assert(pPager->state==PAGER_SHARED ||
2804 (pPager->exclusiveMode && pPager->state>PAGER_SHARED)
2805 );
danielk1977e277be02007-03-23 18:12:06 +00002806 }
2807
2808 if( pPager->pAll ){
danielk197724168722007-04-02 05:07:47 +00002809 /* The shared-lock has just been acquired on the database file
2810 ** and there are already pages in the cache (from a previous
2811 ** read or write transaction). If the value of the change-counter
2812 ** stored in Pager.iChangeCount matches that found on page 1 of
2813 ** the database file, then no database changes have occured since
2814 ** the cache was last valid and it is safe to retain the cached
2815 ** pages. Otherwise, if Pager.iChangeCount does not match the
2816 ** change-counter on page 1 of the file, the current cache contents
2817 ** must be discarded.
2818 */
danielk1977e180dd92007-04-05 17:15:52 +00002819 u8 zC[4];
2820 u32 iChangeCounter = 0;
2821 sqlite3PagerPagecount(pPager);
danielk197724168722007-04-02 05:07:47 +00002822
danielk1977e180dd92007-04-05 17:15:52 +00002823 if( pPager->errCode ){
2824 return pPager->errCode;
danielk1977e277be02007-03-23 18:12:06 +00002825 }
2826
danielk1977e180dd92007-04-05 17:15:52 +00002827 if( pPager->dbSize>0 ){
2828 /* Read the 4-byte change counter directly from the file. */
2829 rc = sqlite3OsSeek(pPager->fd, 24);
2830 if( rc!=SQLITE_OK ){
2831 return rc;
danielk1977e277be02007-03-23 18:12:06 +00002832 }
danielk1977e180dd92007-04-05 17:15:52 +00002833 rc = sqlite3OsRead(pPager->fd, zC, 4);
2834 if( rc!=SQLITE_OK ){
2835 return rc;
2836 }
2837 iChangeCounter = (zC[0]<<24) + (zC[1]<<16) + (zC[2]<<8) + zC[3];
2838 }
2839
2840 if( iChangeCounter!=pPager->iChangeCount ){
2841 pager_reset(pPager);
danielk1977e277be02007-03-23 18:12:06 +00002842 }
2843 }
2844 }
danielk1977c5859712007-03-26 12:26:27 +00002845 assert( pPager->exclusiveMode || pPager->state<=PAGER_SHARED );
2846 if( pPager->state==PAGER_UNLOCK ){
2847 pPager->state = PAGER_SHARED;
2848 }
danielk1977e277be02007-03-23 18:12:06 +00002849 }
2850
2851 return rc;
2852}
2853
2854/*
danielk1977e180dd92007-04-05 17:15:52 +00002855** Allocate a PgHdr object. Either create a new one or reuse
2856** an existing one that is not otherwise in use.
2857**
2858** A new PgHdr structure is created if any of the following are
2859** true:
2860**
2861** (1) We have not exceeded our maximum allocated cache size
2862** as set by the "PRAGMA cache_size" command.
2863**
2864** (2) There are no unused PgHdr objects available at this time.
2865**
2866** (3) This is an in-memory database.
2867**
2868** (4) There are no PgHdr objects that do not require a journal
2869** file sync and a sync of the journal file is currently
2870** prohibited.
2871**
2872** Otherwise, reuse an existing PgHdr. In other words, reuse an
2873** existing PgHdr if all of the following are true:
2874**
2875** (1) We have reached or exceeded the maximum cache size
2876** allowed by "PRAGMA cache_size".
2877**
2878** (2) There is a PgHdr available with PgHdr->nRef==0
2879**
2880** (3) We are not in an in-memory database
2881**
2882** (4) Either there is an available PgHdr that does not need
2883** to be synced to disk or else disk syncing is currently
2884** allowed.
danielk197724168722007-04-02 05:07:47 +00002885*/
2886static int pagerAllocatePage(Pager *pPager, PgHdr **ppPg){
2887 int rc = SQLITE_OK;
2888 PgHdr *pPg;
2889
danielk1977e180dd92007-04-05 17:15:52 +00002890 /* Create a new PgHdr if any of the four conditions defined
2891 ** above is met: */
2892 if( pPager->nPage<pPager->mxPage
2893 || pPager->pFirst==0
2894 || MEMDB
2895 || (pPager->pFirstSynced==0 && pPager->doNotSync)
2896 ){
danielk197724168722007-04-02 05:07:47 +00002897 if( pPager->nPage>=pPager->nHash ){
2898 pager_resize_hash_table(pPager,
2899 pPager->nHash<256 ? 256 : pPager->nHash*2);
2900 if( pPager->nHash==0 ){
2901 rc = SQLITE_NOMEM;
2902 goto pager_allocate_out;
2903 }
2904 }
2905 pPg = sqliteMallocRaw( sizeof(*pPg) + pPager->pageSize
2906 + sizeof(u32) + pPager->nExtra
2907 + MEMDB*sizeof(PgHistory) );
2908 if( pPg==0 ){
2909 rc = SQLITE_NOMEM;
2910 goto pager_allocate_out;
2911 }
2912 memset(pPg, 0, sizeof(*pPg));
2913 if( MEMDB ){
2914 memset(PGHDR_TO_HIST(pPg, pPager), 0, sizeof(PgHistory));
2915 }
2916 pPg->pPager = pPager;
2917 pPg->pNextAll = pPager->pAll;
2918 pPager->pAll = pPg;
2919 pPager->nPage++;
2920 if( pPager->nPage>pPager->nMaxPage ){
2921 assert( pPager->nMaxPage==(pPager->nPage-1) );
2922 pPager->nMaxPage++;
2923 }
2924 }else{
2925 /* Recycle an existing page with a zero ref-count. */
2926 rc = pager_recycle(pPager, 1, &pPg);
2927 if( rc!=SQLITE_OK ){
2928 goto pager_allocate_out;
2929 }
2930 assert( pPager->state>=SHARED_LOCK );
2931 assert(pPg);
2932 }
2933 *ppPg = pPg;
2934
2935pager_allocate_out:
2936 return rc;
2937}
2938
2939/*
drhd9b02572001-04-15 00:37:09 +00002940** Acquire a page.
2941**
drh58a11682001-11-10 13:51:08 +00002942** A read lock on the disk file is obtained when the first page is acquired.
drh5e00f6c2001-09-13 13:46:56 +00002943** This read lock is dropped when the last page is released.
drhd9b02572001-04-15 00:37:09 +00002944**
drh306dc212001-05-21 13:45:10 +00002945** A _get works for any page number greater than 0. If the database
2946** file is smaller than the requested page, then no actual disk
2947** read occurs and the memory image of the page is initialized to
2948** all zeros. The extra data appended to a page is always initialized
2949** to zeros the first time a page is loaded into memory.
2950**
drhd9b02572001-04-15 00:37:09 +00002951** The acquisition might fail for several reasons. In all cases,
2952** an appropriate error code is returned and *ppPage is set to NULL.
drh7e3b0a02001-04-28 16:52:40 +00002953**
danielk19773b8a05f2007-03-19 17:44:26 +00002954** See also sqlite3PagerLookup(). Both this routine and _lookup() attempt
drh7e3b0a02001-04-28 16:52:40 +00002955** to find a page in the in-memory cache first. If the page is not already
drh5e00f6c2001-09-13 13:46:56 +00002956** in memory, this routine goes to disk to read it in whereas _lookup()
drh7e3b0a02001-04-28 16:52:40 +00002957** just returns 0. This routine acquires a read-lock the first time it
2958** has to go to disk, and could also playback an old journal if necessary.
2959** Since _lookup() never goes to disk, it never has to deal with locks
2960** or journal files.
drh0787db62007-03-04 13:15:27 +00002961**
2962** If clrFlag is false, the page contents are actually read from disk.
2963** If clfFlag is true, it means the page is about to be erased and
2964** rewritten without first being read so there is no point it doing
2965** the disk I/O.
drhed7c8552001-04-11 14:29:21 +00002966*/
danielk19773b8a05f2007-03-19 17:44:26 +00002967int sqlite3PagerAcquire(Pager *pPager, Pgno pgno, DbPage **ppPage, int clrFlag){
drhed7c8552001-04-11 14:29:21 +00002968 PgHdr *pPg;
drh165ffe92005-03-15 17:09:30 +00002969 int rc;
drhed7c8552001-04-11 14:29:21 +00002970
danielk1977e277be02007-03-23 18:12:06 +00002971 assert( pPager->state==PAGER_UNLOCK || pPager->nRef>0 || pgno==1 );
2972
danielk197726836652005-01-17 01:33:13 +00002973 /* The maximum page number is 2^31. Return SQLITE_CORRUPT if a page
2974 ** number greater than this, or zero, is requested.
2975 */
drh267cb322005-09-16 17:16:52 +00002976 if( pgno>PAGER_MAX_PGNO || pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh49285702005-09-17 15:20:26 +00002977 return SQLITE_CORRUPT_BKPT;
danielk197726836652005-01-17 01:33:13 +00002978 }
2979
drhd9b02572001-04-15 00:37:09 +00002980 /* Make sure we have not hit any critical errors.
2981 */
drh836faa42003-01-11 13:30:57 +00002982 assert( pPager!=0 );
drh2e6d11b2003-04-25 15:37:57 +00002983 *ppPage = 0;
danielk1977efaaf572006-01-16 11:29:19 +00002984 if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
2985 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00002986 }
2987
danielk197713adf8a2004-06-03 16:08:41 +00002988 /* If this is the first page accessed, then get a SHARED lock
danielk1977334cdb62007-03-26 08:05:12 +00002989 ** on the database file. pagerSharedLock() is a no-op if
2990 ** a database lock is already held.
drhed7c8552001-04-11 14:29:21 +00002991 */
danielk1977e277be02007-03-23 18:12:06 +00002992 rc = pagerSharedLock(pPager);
2993 if( rc!=SQLITE_OK ){
2994 return rc;
drhed7c8552001-04-11 14:29:21 +00002995 }
danielk1977e277be02007-03-23 18:12:06 +00002996 assert( pPager->state!=PAGER_UNLOCK );
2997
2998 pPg = pager_lookup(pPager, pgno);
drhed7c8552001-04-11 14:29:21 +00002999 if( pPg==0 ){
drhd9b02572001-04-15 00:37:09 +00003000 /* The requested page is not in the page cache. */
danielk1977979f38e2007-03-27 16:19:51 +00003001 int nMax;
drhed7c8552001-04-11 14:29:21 +00003002 int h;
drhfcd35c72005-05-21 02:48:08 +00003003 TEST_INCR(pPager->nMiss);
danielk197724168722007-04-02 05:07:47 +00003004 rc = pagerAllocatePage(pPager, &pPg);
3005 if( rc!=SQLITE_OK ){
3006 return rc;
drhed7c8552001-04-11 14:29:21 +00003007 }
danielk197724168722007-04-02 05:07:47 +00003008
drhed7c8552001-04-11 14:29:21 +00003009 pPg->pgno = pgno;
danielk1977f35843b2007-04-07 15:03:17 +00003010 assert( !MEMDB || pgno>pPager->stmtSize );
drh1ab43002002-01-14 09:28:19 +00003011 if( pPager->aInJournal && (int)pgno<=pPager->origDbSize ){
danielk19774adee202004-05-08 08:23:19 +00003012 sqlite3CheckMemory(pPager->aInJournal, pgno/8);
drhdb48ee02003-01-16 13:42:43 +00003013 assert( pPager->journalOpen );
drh6019e162001-07-02 17:51:45 +00003014 pPg->inJournal = (pPager->aInJournal[pgno/8] & (1<<(pgno&7)))!=0;
drhdb48ee02003-01-16 13:42:43 +00003015 pPg->needSync = 0;
drh6019e162001-07-02 17:51:45 +00003016 }else{
3017 pPg->inJournal = 0;
drhdb48ee02003-01-16 13:42:43 +00003018 pPg->needSync = 0;
drh6019e162001-07-02 17:51:45 +00003019 }
danielk1977f35843b2007-04-07 15:03:17 +00003020
drh605ad8f2006-05-03 23:34:05 +00003021 makeClean(pPg);
drhed7c8552001-04-11 14:29:21 +00003022 pPg->nRef = 1;
drhdd793422001-06-28 01:54:48 +00003023 REFINFO(pPg);
danielk197775bab7d2006-01-23 13:09:45 +00003024
drhd9b02572001-04-15 00:37:09 +00003025 pPager->nRef++;
drh2e6d11b2003-04-25 15:37:57 +00003026 if( pPager->nExtra>0 ){
drh90f5ecb2004-07-22 01:19:35 +00003027 memset(PGHDR_TO_EXTRA(pPg, pPager), 0, pPager->nExtra);
drh2e6d11b2003-04-25 15:37:57 +00003028 }
danielk1977979f38e2007-03-27 16:19:51 +00003029 nMax = sqlite3PagerPagecount(pPager);
danielk1977efaaf572006-01-16 11:29:19 +00003030 if( pPager->errCode ){
danielk19773b8a05f2007-03-19 17:44:26 +00003031 sqlite3PagerUnref(pPg);
danielk1977efaaf572006-01-16 11:29:19 +00003032 rc = pPager->errCode;
drh2e6d11b2003-04-25 15:37:57 +00003033 return rc;
3034 }
danielk197775bab7d2006-01-23 13:09:45 +00003035
3036 /* Populate the page with data, either by reading from the database
3037 ** file, or by setting the entire page to zero.
3038 */
danielk1977979f38e2007-03-27 16:19:51 +00003039 if( nMax<(int)pgno || MEMDB || (clrFlag && !pPager->alwaysRollback) ){
drh90f5ecb2004-07-22 01:19:35 +00003040 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
drh306dc212001-05-21 13:45:10 +00003041 }else{
danielk1977e180dd92007-04-05 17:15:52 +00003042 rc = readDbPage(pPager, pPg, pgno);
drh551b7732006-11-06 21:20:25 +00003043 if( rc!=SQLITE_OK && rc!=SQLITE_IOERR_SHORT_READ ){
3044 pPg->pgno = 0;
danielk19773b8a05f2007-03-19 17:44:26 +00003045 sqlite3PagerUnref(pPg);
drh551b7732006-11-06 21:20:25 +00003046 return rc;
danielk197742741be2005-01-08 12:42:39 +00003047 }else{
drhfcd35c72005-05-21 02:48:08 +00003048 TEST_INCR(pPager->nRead);
drh81a20f22001-10-12 17:30:04 +00003049 }
drh306dc212001-05-21 13:45:10 +00003050 }
danielk197775bab7d2006-01-23 13:09:45 +00003051
3052 /* Link the page into the page hash table */
drh8ca0c722006-05-07 17:49:38 +00003053 h = pgno & (pPager->nHash-1);
drh3765df42006-06-28 18:18:09 +00003054 assert( pgno!=0 );
danielk197775bab7d2006-01-23 13:09:45 +00003055 pPg->pNextHash = pPager->aHash[h];
3056 pPager->aHash[h] = pPg;
3057 if( pPg->pNextHash ){
3058 assert( pPg->pNextHash->pPrevHash==0 );
3059 pPg->pNextHash->pPrevHash = pPg;
3060 }
3061
danielk19773c407372005-02-15 02:54:14 +00003062#ifdef SQLITE_CHECK_PAGES
3063 pPg->pageHash = pager_pagehash(pPg);
3064#endif
drhed7c8552001-04-11 14:29:21 +00003065 }else{
drhd9b02572001-04-15 00:37:09 +00003066 /* The requested page is in the page cache. */
danielk1977e277be02007-03-23 18:12:06 +00003067 assert(pPager->nRef>0 || pgno==1);
drhfcd35c72005-05-21 02:48:08 +00003068 TEST_INCR(pPager->nHit);
drhdf0b3b02001-06-23 11:36:20 +00003069 page_ref(pPg);
drhed7c8552001-04-11 14:29:21 +00003070 }
danielk19773b8a05f2007-03-19 17:44:26 +00003071 *ppPage = pPg;
drhed7c8552001-04-11 14:29:21 +00003072 return SQLITE_OK;
3073}
3074
3075/*
drh7e3b0a02001-04-28 16:52:40 +00003076** Acquire a page if it is already in the in-memory cache. Do
3077** not read the page from disk. Return a pointer to the page,
3078** or 0 if the page is not in cache.
3079**
danielk19773b8a05f2007-03-19 17:44:26 +00003080** See also sqlite3PagerGet(). The difference between this routine
3081** and sqlite3PagerGet() is that _get() will go to the disk and read
drh7e3b0a02001-04-28 16:52:40 +00003082** in the page if the page is not already in cache. This routine
drh5e00f6c2001-09-13 13:46:56 +00003083** returns NULL if the page is not in cache or if a disk I/O error
3084** has ever happened.
drh7e3b0a02001-04-28 16:52:40 +00003085*/
danielk19773b8a05f2007-03-19 17:44:26 +00003086DbPage *sqlite3PagerLookup(Pager *pPager, Pgno pgno){
drh7e3b0a02001-04-28 16:52:40 +00003087 PgHdr *pPg;
3088
drh836faa42003-01-11 13:30:57 +00003089 assert( pPager!=0 );
3090 assert( pgno!=0 );
danielk1977e277be02007-03-23 18:12:06 +00003091
3092 if( pPager->state==PAGER_UNLOCK ){
danielk1977334cdb62007-03-26 08:05:12 +00003093 assert( !pPager->pAll || pPager->exclusiveMode );
danielk1977e277be02007-03-23 18:12:06 +00003094 return 0;
3095 }
danielk1977334cdb62007-03-26 08:05:12 +00003096 if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
drh7e3b0a02001-04-28 16:52:40 +00003097 return 0;
3098 }
drh7e3b0a02001-04-28 16:52:40 +00003099 pPg = pager_lookup(pPager, pgno);
3100 if( pPg==0 ) return 0;
drhdf0b3b02001-06-23 11:36:20 +00003101 page_ref(pPg);
danielk19773b8a05f2007-03-19 17:44:26 +00003102 return pPg;
drh7e3b0a02001-04-28 16:52:40 +00003103}
3104
3105/*
drhed7c8552001-04-11 14:29:21 +00003106** Release a page.
3107**
3108** If the number of references to the page drop to zero, then the
3109** page is added to the LRU list. When all references to all pages
drhd9b02572001-04-15 00:37:09 +00003110** are released, a rollback occurs and the lock on the database is
drhed7c8552001-04-11 14:29:21 +00003111** removed.
3112*/
danielk19773b8a05f2007-03-19 17:44:26 +00003113int sqlite3PagerUnref(DbPage *pPg){
drhd9b02572001-04-15 00:37:09 +00003114
3115 /* Decrement the reference count for this page
3116 */
drhed7c8552001-04-11 14:29:21 +00003117 assert( pPg->nRef>0 );
drhed7c8552001-04-11 14:29:21 +00003118 pPg->nRef--;
drhdd793422001-06-28 01:54:48 +00003119 REFINFO(pPg);
drhd9b02572001-04-15 00:37:09 +00003120
danielk19773c407372005-02-15 02:54:14 +00003121 CHECK_PAGE(pPg);
3122
drh72f82862001-05-24 21:06:34 +00003123 /* When the number of references to a page reach 0, call the
3124 ** destructor and add the page to the freelist.
drhd9b02572001-04-15 00:37:09 +00003125 */
drhed7c8552001-04-11 14:29:21 +00003126 if( pPg->nRef==0 ){
drh1eaa2692001-09-18 02:02:23 +00003127 Pager *pPager;
3128 pPager = pPg->pPager;
drhd9b02572001-04-15 00:37:09 +00003129 pPg->pNextFree = 0;
3130 pPg->pPrevFree = pPager->pLast;
drhed7c8552001-04-11 14:29:21 +00003131 pPager->pLast = pPg;
drhd9b02572001-04-15 00:37:09 +00003132 if( pPg->pPrevFree ){
3133 pPg->pPrevFree->pNextFree = pPg;
drhed7c8552001-04-11 14:29:21 +00003134 }else{
3135 pPager->pFirst = pPg;
3136 }
drh341eae82003-01-21 02:39:36 +00003137 if( pPg->needSync==0 && pPager->pFirstSynced==0 ){
3138 pPager->pFirstSynced = pPg;
3139 }
drh72f82862001-05-24 21:06:34 +00003140 if( pPager->xDestructor ){
danielk19773b8a05f2007-03-19 17:44:26 +00003141 pPager->xDestructor(pPg, pPager->pageSize);
drh72f82862001-05-24 21:06:34 +00003142 }
drhd9b02572001-04-15 00:37:09 +00003143
3144 /* When all pages reach the freelist, drop the read lock from
3145 ** the database file.
3146 */
3147 pPager->nRef--;
3148 assert( pPager->nRef>=0 );
danielk19773dedc192007-03-27 17:37:31 +00003149 if( pPager->nRef==0 && (!pPager->exclusiveMode || pPager->journalOff>0) ){
danielk1977e277be02007-03-23 18:12:06 +00003150 pagerUnlockAndRollback(pPager);
drhd9b02572001-04-15 00:37:09 +00003151 }
drhed7c8552001-04-11 14:29:21 +00003152 }
drhd9b02572001-04-15 00:37:09 +00003153 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +00003154}
3155
3156/*
drha6abd042004-06-09 17:37:22 +00003157** Create a journal file for pPager. There should already be a RESERVED
3158** or EXCLUSIVE lock on the database file when this routine is called.
drhda47d772002-12-02 04:25:19 +00003159**
3160** Return SQLITE_OK if everything. Return an error code and release the
3161** write lock if anything goes wrong.
3162*/
3163static int pager_open_journal(Pager *pPager){
3164 int rc;
drhb7f91642004-10-31 02:22:47 +00003165 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +00003166 assert( pPager->state>=PAGER_RESERVED );
drhda47d772002-12-02 04:25:19 +00003167 assert( pPager->journalOpen==0 );
3168 assert( pPager->useJournal );
drh88b01a12005-03-28 18:04:27 +00003169 assert( pPager->aInJournal==0 );
danielk19773b8a05f2007-03-19 17:44:26 +00003170 sqlite3PagerPagecount(pPager);
drhda47d772002-12-02 04:25:19 +00003171 pPager->aInJournal = sqliteMalloc( pPager->dbSize/8 + 1 );
3172 if( pPager->aInJournal==0 ){
drh9c105bb2004-10-02 20:38:28 +00003173 rc = SQLITE_NOMEM;
3174 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00003175 }
drh66560ad2006-01-06 14:32:19 +00003176 rc = sqlite3OsOpenExclusive(pPager->zJournal, &pPager->jfd,
drh9c06c952005-11-26 00:25:00 +00003177 pPager->tempFile);
danielk19775bb16fe2007-04-05 11:54:42 +00003178 assert( rc!=SQLITE_OK || pPager->jfd );
danielk197776572402004-06-25 02:38:54 +00003179 pPager->journalOff = 0;
3180 pPager->setMaster = 0;
3181 pPager->journalHdr = 0;
drhda47d772002-12-02 04:25:19 +00003182 if( rc!=SQLITE_OK ){
drh600e46a2007-03-28 01:59:33 +00003183 if( rc==SQLITE_NOMEM ){
3184 sqlite3OsDelete(pPager->zJournal);
3185 }
drh9c105bb2004-10-02 20:38:28 +00003186 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00003187 }
drhac530b12006-02-11 01:25:50 +00003188 sqlite3OsSetFullSync(pPager->jfd, pPager->full_fsync);
3189 sqlite3OsSetFullSync(pPager->fd, pPager->full_fsync);
drh054889e2005-11-30 03:20:31 +00003190 sqlite3OsOpenDirectory(pPager->jfd, pPager->zDirectory);
drhda47d772002-12-02 04:25:19 +00003191 pPager->journalOpen = 1;
drhdb48ee02003-01-16 13:42:43 +00003192 pPager->journalStarted = 0;
drhda47d772002-12-02 04:25:19 +00003193 pPager->needSync = 0;
3194 pPager->alwaysRollback = 0;
drh968af522003-02-11 14:55:40 +00003195 pPager->nRec = 0;
danielk1977efaaf572006-01-16 11:29:19 +00003196 if( pPager->errCode ){
3197 rc = pPager->errCode;
drhdd5b2fa2005-03-28 03:39:55 +00003198 goto failed_to_open_journal;
drh2e6d11b2003-04-25 15:37:57 +00003199 }
drhda47d772002-12-02 04:25:19 +00003200 pPager->origDbSize = pPager->dbSize;
drhae2b40c2004-06-09 19:03:54 +00003201
danielk197776572402004-06-25 02:38:54 +00003202 rc = writeJournalHdr(pPager);
3203
drhac69b052004-05-12 13:30:07 +00003204 if( pPager->stmtAutoopen && rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00003205 rc = sqlite3PagerStmtBegin(pPager);
drhda47d772002-12-02 04:25:19 +00003206 }
danielk1977261919c2005-12-06 12:52:59 +00003207 if( rc!=SQLITE_OK && rc!=SQLITE_NOMEM ){
drh80e35f42007-03-30 14:06:34 +00003208 rc = pager_end_transaction(pPager);
drhda47d772002-12-02 04:25:19 +00003209 if( rc==SQLITE_OK ){
3210 rc = SQLITE_FULL;
3211 }
3212 }
drh9c105bb2004-10-02 20:38:28 +00003213 return rc;
3214
3215failed_to_open_journal:
3216 sqliteFree(pPager->aInJournal);
3217 pPager->aInJournal = 0;
drh9c105bb2004-10-02 20:38:28 +00003218 return rc;
drhda47d772002-12-02 04:25:19 +00003219}
3220
3221/*
drh4b845d72002-03-05 12:41:19 +00003222** Acquire a write-lock on the database. The lock is removed when
3223** the any of the following happen:
3224**
drh80e35f42007-03-30 14:06:34 +00003225** * sqlite3PagerCommitPhaseTwo() is called.
danielk19773b8a05f2007-03-19 17:44:26 +00003226** * sqlite3PagerRollback() is called.
3227** * sqlite3PagerClose() is called.
3228** * sqlite3PagerUnref() is called to on every outstanding page.
drh4b845d72002-03-05 12:41:19 +00003229**
danielk197713adf8a2004-06-03 16:08:41 +00003230** The first parameter to this routine is a pointer to any open page of the
3231** database file. Nothing changes about the page - it is used merely to
3232** acquire a pointer to the Pager structure and as proof that there is
3233** already a read-lock on the database.
drh4b845d72002-03-05 12:41:19 +00003234**
danielk197713adf8a2004-06-03 16:08:41 +00003235** The second parameter indicates how much space in bytes to reserve for a
3236** master journal file-name at the start of the journal when it is created.
3237**
3238** A journal file is opened if this is not a temporary file. For temporary
3239** files, the opening of the journal file is deferred until there is an
3240** actual need to write to the journal.
drhda47d772002-12-02 04:25:19 +00003241**
drha6abd042004-06-09 17:37:22 +00003242** If the database is already reserved for writing, this routine is a no-op.
drh684917c2004-10-05 02:41:42 +00003243**
3244** If exFlag is true, go ahead and get an EXCLUSIVE lock on the file
3245** immediately instead of waiting until we try to flush the cache. The
3246** exFlag is ignored if a transaction is already active.
drh4b845d72002-03-05 12:41:19 +00003247*/
danielk19773b8a05f2007-03-19 17:44:26 +00003248int sqlite3PagerBegin(DbPage *pPg, int exFlag){
drh4b845d72002-03-05 12:41:19 +00003249 Pager *pPager = pPg->pPager;
3250 int rc = SQLITE_OK;
3251 assert( pPg->nRef>0 );
drha6abd042004-06-09 17:37:22 +00003252 assert( pPager->state!=PAGER_UNLOCK );
3253 if( pPager->state==PAGER_SHARED ){
drh4b845d72002-03-05 12:41:19 +00003254 assert( pPager->aInJournal==0 );
drhb7f91642004-10-31 02:22:47 +00003255 if( MEMDB ){
drha6abd042004-06-09 17:37:22 +00003256 pPager->state = PAGER_EXCLUSIVE;
drhac69b052004-05-12 13:30:07 +00003257 pPager->origDbSize = pPager->dbSize;
3258 }else{
drh054889e2005-11-30 03:20:31 +00003259 rc = sqlite3OsLock(pPager->fd, RESERVED_LOCK);
drh684917c2004-10-05 02:41:42 +00003260 if( rc==SQLITE_OK ){
3261 pPager->state = PAGER_RESERVED;
3262 if( exFlag ){
3263 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
3264 }
3265 }
danielk19779eed5052004-06-04 10:38:30 +00003266 if( rc!=SQLITE_OK ){
3267 return rc;
drhac69b052004-05-12 13:30:07 +00003268 }
drha6abd042004-06-09 17:37:22 +00003269 pPager->dirtyCache = 0;
drh4f0c5872007-03-26 22:05:01 +00003270 PAGERTRACE2("TRANSACTION %d\n", PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00003271 if( pPager->useJournal && !pPager->tempFile ){
3272 rc = pager_open_journal(pPager);
3273 }
drh4b845d72002-03-05 12:41:19 +00003274 }
danielk1977334cdb62007-03-26 08:05:12 +00003275 }else if( pPager->journalOpen && pPager->journalOff==0 ){
3276 /* This happens when the pager was in exclusive-access mode last
3277 ** time a (read or write) transaction was successfully concluded
3278 ** by this connection. Instead of deleting the journal file it was
3279 ** kept open and truncated to 0 bytes.
3280 */
3281 assert( pPager->nRec==0 );
3282 assert( pPager->origDbSize==0 );
drh369339d2007-03-30 16:01:55 +00003283 assert( pPager->aInJournal==0 );
danielk1977334cdb62007-03-26 08:05:12 +00003284 sqlite3PagerPagecount(pPager);
danielk1977334cdb62007-03-26 08:05:12 +00003285 pPager->aInJournal = sqliteMalloc( pPager->dbSize/8 + 1 );
3286 if( !pPager->aInJournal ){
3287 rc = SQLITE_NOMEM;
3288 }else{
drh369339d2007-03-30 16:01:55 +00003289 pPager->origDbSize = pPager->dbSize;
danielk1977334cdb62007-03-26 08:05:12 +00003290 rc = writeJournalHdr(pPager);
3291 }
drh4b845d72002-03-05 12:41:19 +00003292 }
danielk1977334cdb62007-03-26 08:05:12 +00003293 assert( !pPager->journalOpen || pPager->journalOff>0 || rc!=SQLITE_OK );
drh4b845d72002-03-05 12:41:19 +00003294 return rc;
3295}
3296
3297/*
drh605ad8f2006-05-03 23:34:05 +00003298** Make a page dirty. Set its dirty flag and add it to the dirty
3299** page list.
3300*/
3301static void makeDirty(PgHdr *pPg){
3302 if( pPg->dirty==0 ){
3303 Pager *pPager = pPg->pPager;
3304 pPg->dirty = 1;
3305 pPg->pDirty = pPager->pDirty;
3306 if( pPager->pDirty ){
3307 pPager->pDirty->pPrevDirty = pPg;
3308 }
3309 pPg->pPrevDirty = 0;
3310 pPager->pDirty = pPg;
3311 }
3312}
3313
3314/*
3315** Make a page clean. Clear its dirty bit and remove it from the
3316** dirty page list.
3317*/
3318static void makeClean(PgHdr *pPg){
3319 if( pPg->dirty ){
3320 pPg->dirty = 0;
3321 if( pPg->pDirty ){
3322 pPg->pDirty->pPrevDirty = pPg->pPrevDirty;
3323 }
3324 if( pPg->pPrevDirty ){
3325 pPg->pPrevDirty->pDirty = pPg->pDirty;
3326 }else{
3327 pPg->pPager->pDirty = pPg->pDirty;
3328 }
3329 }
3330}
3331
3332
3333/*
drhed7c8552001-04-11 14:29:21 +00003334** Mark a data page as writeable. The page is written into the journal
3335** if it is not there already. This routine must be called before making
3336** changes to a page.
3337**
3338** The first time this routine is called, the pager creates a new
drha6abd042004-06-09 17:37:22 +00003339** journal and acquires a RESERVED lock on the database. If the RESERVED
drhed7c8552001-04-11 14:29:21 +00003340** lock could not be acquired, this routine returns SQLITE_BUSY. The
drh306dc212001-05-21 13:45:10 +00003341** calling routine must check for that return value and be careful not to
drhed7c8552001-04-11 14:29:21 +00003342** change any page data until this routine returns SQLITE_OK.
drhd9b02572001-04-15 00:37:09 +00003343**
3344** If the journal file could not be written because the disk is full,
3345** then this routine returns SQLITE_FULL and does an immediate rollback.
3346** All subsequent write attempts also return SQLITE_FULL until there
danielk19773b8a05f2007-03-19 17:44:26 +00003347** is a call to sqlite3PagerCommit() or sqlite3PagerRollback() to
drhd9b02572001-04-15 00:37:09 +00003348** reset.
drhed7c8552001-04-11 14:29:21 +00003349*/
danielk19773b8a05f2007-03-19 17:44:26 +00003350static int pager_write(PgHdr *pPg){
3351 void *pData = PGHDR_TO_DATA(pPg);
drh69688d52001-04-14 16:38:23 +00003352 Pager *pPager = pPg->pPager;
drhd79caeb2001-04-15 02:27:24 +00003353 int rc = SQLITE_OK;
drh69688d52001-04-14 16:38:23 +00003354
drh6446c4d2001-12-15 14:22:18 +00003355 /* Check for errors
3356 */
danielk1977efaaf572006-01-16 11:29:19 +00003357 if( pPager->errCode ){
3358 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00003359 }
drh5e00f6c2001-09-13 13:46:56 +00003360 if( pPager->readOnly ){
3361 return SQLITE_PERM;
3362 }
drh6446c4d2001-12-15 14:22:18 +00003363
danielk197776572402004-06-25 02:38:54 +00003364 assert( !pPager->setMaster );
3365
danielk19773c407372005-02-15 02:54:14 +00003366 CHECK_PAGE(pPg);
3367
drh6446c4d2001-12-15 14:22:18 +00003368 /* Mark the page as dirty. If the page has already been written
3369 ** to the journal then we can return right away.
3370 */
drh605ad8f2006-05-03 23:34:05 +00003371 makeDirty(pPg);
danielk1977f35843b2007-04-07 15:03:17 +00003372 if( pPg->inJournal && (pageInStatement(pPg) || pPager->stmtInUse==0) ){
drha6abd042004-06-09 17:37:22 +00003373 pPager->dirtyCache = 1;
danielk1977a0bf2652004-11-04 14:30:04 +00003374 }else{
drh6446c4d2001-12-15 14:22:18 +00003375
danielk1977a0bf2652004-11-04 14:30:04 +00003376 /* If we get this far, it means that the page needs to be
3377 ** written to the transaction journal or the ckeckpoint journal
3378 ** or both.
3379 **
3380 ** First check to see that the transaction journal exists and
3381 ** create it if it does not.
3382 */
3383 assert( pPager->state!=PAGER_UNLOCK );
danielk19773b8a05f2007-03-19 17:44:26 +00003384 rc = sqlite3PagerBegin(pPg, 0);
danielk1977a0bf2652004-11-04 14:30:04 +00003385 if( rc!=SQLITE_OK ){
3386 return rc;
3387 }
3388 assert( pPager->state>=PAGER_RESERVED );
3389 if( !pPager->journalOpen && pPager->useJournal ){
3390 rc = pager_open_journal(pPager);
3391 if( rc!=SQLITE_OK ) return rc;
3392 }
3393 assert( pPager->journalOpen || !pPager->useJournal );
3394 pPager->dirtyCache = 1;
3395
3396 /* The transaction journal now exists and we have a RESERVED or an
3397 ** EXCLUSIVE lock on the main database file. Write the current page to
3398 ** the transaction journal if it is not there already.
3399 */
3400 if( !pPg->inJournal && (pPager->useJournal || MEMDB) ){
3401 if( (int)pPg->pgno <= pPager->origDbSize ){
3402 int szPg;
danielk1977a0bf2652004-11-04 14:30:04 +00003403 if( MEMDB ){
3404 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
drh4f0c5872007-03-26 22:05:01 +00003405 PAGERTRACE3("JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00003406 assert( pHist->pOrig==0 );
3407 pHist->pOrig = sqliteMallocRaw( pPager->pageSize );
3408 if( pHist->pOrig ){
3409 memcpy(pHist->pOrig, PGHDR_TO_DATA(pPg), pPager->pageSize);
3410 }
3411 }else{
drhc001c582006-03-06 18:23:16 +00003412 u32 cksum, saved;
3413 char *pData2, *pEnd;
drh267cb322005-09-16 17:16:52 +00003414 /* We should never write to the journal file the page that
3415 ** contains the database locks. The following assert verifies
3416 ** that we do not. */
3417 assert( pPg->pgno!=PAGER_MJ_PGNO(pPager) );
drhc001c582006-03-06 18:23:16 +00003418 pData2 = CODEC2(pPager, pData, pPg->pgno, 7);
drh37527852006-03-16 16:19:56 +00003419 cksum = pager_cksum(pPager, (u8*)pData2);
drhc001c582006-03-06 18:23:16 +00003420 pEnd = pData2 + pPager->pageSize;
3421 pData2 -= 4;
3422 saved = *(u32*)pEnd;
3423 put32bits(pEnd, cksum);
danielk1977a0bf2652004-11-04 14:30:04 +00003424 szPg = pPager->pageSize+8;
drhc001c582006-03-06 18:23:16 +00003425 put32bits(pData2, pPg->pgno);
3426 rc = sqlite3OsWrite(pPager->jfd, pData2, szPg);
drhb0603412007-02-28 04:47:26 +00003427 IOTRACE(("JOUT %p %d %lld %d\n", pPager, pPg->pgno,
3428 pPager->journalOff, szPg))
danielk1977a0bf2652004-11-04 14:30:04 +00003429 pPager->journalOff += szPg;
drh4f0c5872007-03-26 22:05:01 +00003430 PAGERTRACE4("JOURNAL %d page %d needSync=%d\n",
danielk1977ef73ee92004-11-06 12:26:07 +00003431 PAGERID(pPager), pPg->pgno, pPg->needSync);
drhc001c582006-03-06 18:23:16 +00003432 *(u32*)pEnd = saved;
danielk197707cb5602006-01-20 10:55:05 +00003433
3434 /* An error has occured writing to the journal file. The
3435 ** transaction will be rolled back by the layer above.
3436 */
danielk1977a0bf2652004-11-04 14:30:04 +00003437 if( rc!=SQLITE_OK ){
danielk1977a0bf2652004-11-04 14:30:04 +00003438 return rc;
3439 }
danielk197707cb5602006-01-20 10:55:05 +00003440
danielk1977a0bf2652004-11-04 14:30:04 +00003441 pPager->nRec++;
3442 assert( pPager->aInJournal!=0 );
3443 pPager->aInJournal[pPg->pgno/8] |= 1<<(pPg->pgno&7);
3444 pPg->needSync = !pPager->noSync;
3445 if( pPager->stmtInUse ){
3446 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
danielk1977a0bf2652004-11-04 14:30:04 +00003447 }
drhac69b052004-05-12 13:30:07 +00003448 }
danielk197713adf8a2004-06-03 16:08:41 +00003449 }else{
danielk1977a0bf2652004-11-04 14:30:04 +00003450 pPg->needSync = !pPager->journalStarted && !pPager->noSync;
drh4f0c5872007-03-26 22:05:01 +00003451 PAGERTRACE4("APPEND %d page %d needSync=%d\n",
danielk1977ef73ee92004-11-06 12:26:07 +00003452 PAGERID(pPager), pPg->pgno, pPg->needSync);
danielk1977a0bf2652004-11-04 14:30:04 +00003453 }
3454 if( pPg->needSync ){
3455 pPager->needSync = 1;
3456 }
3457 pPg->inJournal = 1;
3458 }
3459
3460 /* If the statement journal is open and the page is not in it,
3461 ** then write the current page to the statement journal. Note that
3462 ** the statement journal format differs from the standard journal format
3463 ** in that it omits the checksums and the header.
3464 */
danielk1977f35843b2007-04-07 15:03:17 +00003465 if( pPager->stmtInUse
3466 && !pageInStatement(pPg)
3467 && (int)pPg->pgno<=pPager->stmtSize
3468 ){
danielk1977a0bf2652004-11-04 14:30:04 +00003469 assert( pPg->inJournal || (int)pPg->pgno>pPager->origDbSize );
3470 if( MEMDB ){
3471 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
3472 assert( pHist->pStmt==0 );
3473 pHist->pStmt = sqliteMallocRaw( pPager->pageSize );
3474 if( pHist->pStmt ){
3475 memcpy(pHist->pStmt, PGHDR_TO_DATA(pPg), pPager->pageSize);
3476 }
drh4f0c5872007-03-26 22:05:01 +00003477 PAGERTRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk1977f35843b2007-04-07 15:03:17 +00003478 page_add_to_stmt_list(pPg);
danielk1977a0bf2652004-11-04 14:30:04 +00003479 }else{
drhc001c582006-03-06 18:23:16 +00003480 char *pData2 = CODEC2(pPager, pData, pPg->pgno, 7)-4;
3481 put32bits(pData2, pPg->pgno);
3482 rc = sqlite3OsWrite(pPager->stfd, pData2, pPager->pageSize+4);
drh4f0c5872007-03-26 22:05:01 +00003483 PAGERTRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
drhac69b052004-05-12 13:30:07 +00003484 if( rc!=SQLITE_OK ){
drhac69b052004-05-12 13:30:07 +00003485 return rc;
3486 }
danielk1977a0bf2652004-11-04 14:30:04 +00003487 pPager->stmtNRec++;
3488 assert( pPager->aInStmt!=0 );
3489 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drhdb48ee02003-01-16 13:42:43 +00003490 }
drhd9b02572001-04-15 00:37:09 +00003491 }
drhfa86c412002-02-02 15:01:15 +00003492 }
3493
3494 /* Update the database size and return.
3495 */
drh1aa2d8b2007-01-03 15:34:29 +00003496 assert( pPager->state>=PAGER_SHARED );
drh1ab43002002-01-14 09:28:19 +00003497 if( pPager->dbSize<(int)pPg->pgno ){
drh306dc212001-05-21 13:45:10 +00003498 pPager->dbSize = pPg->pgno;
drhb7f91642004-10-31 02:22:47 +00003499 if( !MEMDB && pPager->dbSize==PENDING_BYTE/pPager->pageSize ){
drh1f595712004-06-15 01:40:29 +00003500 pPager->dbSize++;
3501 }
drh306dc212001-05-21 13:45:10 +00003502 }
drh69688d52001-04-14 16:38:23 +00003503 return rc;
drhed7c8552001-04-11 14:29:21 +00003504}
3505
3506/*
danielk19774099f6e2007-03-19 11:25:20 +00003507** This function is used to mark a data-page as writable. It uses
3508** pager_write() to open a journal file (if it is not already open)
3509** and write the page *pData to the journal.
3510**
3511** The difference between this function and pager_write() is that this
3512** function also deals with the special case where 2 or more pages
3513** fit on a single disk sector. In this case all co-resident pages
3514** must have been written to the journal file before returning.
3515*/
danielk19773b8a05f2007-03-19 17:44:26 +00003516int sqlite3PagerWrite(DbPage *pDbPage){
danielk19774099f6e2007-03-19 11:25:20 +00003517 int rc = SQLITE_OK;
3518
danielk19773b8a05f2007-03-19 17:44:26 +00003519 PgHdr *pPg = pDbPage;
danielk19774099f6e2007-03-19 11:25:20 +00003520 Pager *pPager = pPg->pPager;
3521 Pgno nPagePerSector = (pPager->sectorSize/pPager->pageSize);
3522
3523 if( !MEMDB && nPagePerSector>1 ){
3524 Pgno nPageCount; /* Total number of pages in database file */
3525 Pgno pg1; /* First page of the sector pPg is located on. */
3526 int nPage; /* Number of pages starting at pg1 to journal */
3527 int ii;
3528
3529 /* Set the doNotSync flag to 1. This is because we cannot allow a journal
3530 ** header to be written between the pages journaled by this function.
3531 */
3532 assert( pPager->doNotSync==0 );
3533 pPager->doNotSync = 1;
3534
3535 /* This trick assumes that both the page-size and sector-size are
3536 ** an integer power of 2. It sets variable pg1 to the identifier
3537 ** of the first page of the sector pPg is located on.
3538 */
3539 pg1 = ((pPg->pgno-1) & ~(nPagePerSector-1)) + 1;
3540
danielk19773b8a05f2007-03-19 17:44:26 +00003541 nPageCount = sqlite3PagerPagecount(pPager);
danielk19774099f6e2007-03-19 11:25:20 +00003542 if( pPg->pgno>nPageCount ){
3543 nPage = (pPg->pgno - pg1)+1;
3544 }else if( (pg1+nPagePerSector-1)>nPageCount ){
3545 nPage = nPageCount+1-pg1;
3546 }else{
3547 nPage = nPagePerSector;
3548 }
3549 assert(nPage>0);
3550 assert(pg1<=pPg->pgno);
3551 assert((pg1+nPage)>pPg->pgno);
3552
3553 for(ii=0; ii<nPage && rc==SQLITE_OK; ii++){
3554 Pgno pg = pg1+ii;
3555 if( !pPager->aInJournal || pg==pPg->pgno ||
3556 pg>pPager->origDbSize || !(pPager->aInJournal[pg/8]&(1<<(pg&7)))
3557 ) {
3558 if( pg!=PAGER_MJ_PGNO(pPager) ){
danielk19773b8a05f2007-03-19 17:44:26 +00003559 PgHdr *pPage;
3560 rc = sqlite3PagerGet(pPager, pg, &pPage);
danielk19774099f6e2007-03-19 11:25:20 +00003561 if( rc==SQLITE_OK ){
3562 rc = pager_write(pPage);
danielk19773b8a05f2007-03-19 17:44:26 +00003563 sqlite3PagerUnref(pPage);
danielk19774099f6e2007-03-19 11:25:20 +00003564 }
3565 }
3566 }
3567 }
3568
3569 assert( pPager->doNotSync==1 );
3570 pPager->doNotSync = 0;
3571 }else{
danielk19773b8a05f2007-03-19 17:44:26 +00003572 rc = pager_write(pDbPage);
danielk19774099f6e2007-03-19 11:25:20 +00003573 }
3574 return rc;
3575}
3576
3577/*
drhaacc5432002-01-06 17:07:40 +00003578** Return TRUE if the page given in the argument was previously passed
danielk19773b8a05f2007-03-19 17:44:26 +00003579** to sqlite3PagerWrite(). In other words, return TRUE if it is ok
drh6019e162001-07-02 17:51:45 +00003580** to change the content of the page.
3581*/
danielk19777d3a6662006-01-23 16:21:05 +00003582#ifndef NDEBUG
danielk19773b8a05f2007-03-19 17:44:26 +00003583int sqlite3PagerIswriteable(DbPage *pPg){
drh6019e162001-07-02 17:51:45 +00003584 return pPg->dirty;
3585}
danielk19777d3a6662006-01-23 16:21:05 +00003586#endif
drh6019e162001-07-02 17:51:45 +00003587
danielk1977b84f96f2005-01-20 11:32:23 +00003588#ifndef SQLITE_OMIT_VACUUM
drh6019e162001-07-02 17:51:45 +00003589/*
drh001bbcb2003-03-19 03:14:00 +00003590** Replace the content of a single page with the information in the third
3591** argument.
3592*/
danielk19773b8a05f2007-03-19 17:44:26 +00003593int sqlite3PagerOverwrite(Pager *pPager, Pgno pgno, void *pData){
3594 PgHdr *pPg;
drh001bbcb2003-03-19 03:14:00 +00003595 int rc;
3596
danielk19773b8a05f2007-03-19 17:44:26 +00003597 rc = sqlite3PagerGet(pPager, pgno, &pPg);
drh001bbcb2003-03-19 03:14:00 +00003598 if( rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00003599 rc = sqlite3PagerWrite(pPg);
drh001bbcb2003-03-19 03:14:00 +00003600 if( rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00003601 memcpy(sqlite3PagerGetData(pPg), pData, pPager->pageSize);
drh001bbcb2003-03-19 03:14:00 +00003602 }
danielk19773b8a05f2007-03-19 17:44:26 +00003603 sqlite3PagerUnref(pPg);
drh001bbcb2003-03-19 03:14:00 +00003604 }
3605 return rc;
3606}
danielk1977b84f96f2005-01-20 11:32:23 +00003607#endif
drh001bbcb2003-03-19 03:14:00 +00003608
3609/*
drh30e58752002-03-02 20:41:57 +00003610** A call to this routine tells the pager that it is not necessary to
3611** write the information on page "pgno" back to the disk, even though
3612** that page might be marked as dirty.
3613**
3614** The overlying software layer calls this routine when all of the data
3615** on the given page is unused. The pager marks the page as clean so
3616** that it does not get written to disk.
3617**
3618** Tests show that this optimization, together with the
danielk19773b8a05f2007-03-19 17:44:26 +00003619** sqlite3PagerDontRollback() below, more than double the speed
drh30e58752002-03-02 20:41:57 +00003620** of large INSERT operations and quadruple the speed of large DELETEs.
drh8e298f92002-07-06 16:28:47 +00003621**
3622** When this routine is called, set the alwaysRollback flag to true.
danielk19773b8a05f2007-03-19 17:44:26 +00003623** Subsequent calls to sqlite3PagerDontRollback() for the same page
drh8e298f92002-07-06 16:28:47 +00003624** will thereafter be ignored. This is necessary to avoid a problem
3625** where a page with data is added to the freelist during one part of
3626** a transaction then removed from the freelist during a later part
3627** of the same transaction and reused for some other purpose. When it
3628** is first added to the freelist, this routine is called. When reused,
drh80e35f42007-03-30 14:06:34 +00003629** the sqlite3PagerDontRollback() routine is called. But because the
3630** page contains critical data, we still need to be sure it gets
3631** rolled back in spite of the sqlite3PagerDontRollback() call.
drh30e58752002-03-02 20:41:57 +00003632*/
danielk19773b8a05f2007-03-19 17:44:26 +00003633void sqlite3PagerDontWrite(Pager *pPager, Pgno pgno){
drh30e58752002-03-02 20:41:57 +00003634 PgHdr *pPg;
drh8e298f92002-07-06 16:28:47 +00003635
drhb7f91642004-10-31 02:22:47 +00003636 if( MEMDB ) return;
danielk1977eac7a362004-06-16 07:45:24 +00003637
drh30e58752002-03-02 20:41:57 +00003638 pPg = pager_lookup(pPager, pgno);
drh43617e92006-03-06 20:55:46 +00003639 assert( pPg!=0 ); /* We never call _dont_write unless the page is in mem */
drh8e298f92002-07-06 16:28:47 +00003640 pPg->alwaysRollback = 1;
drh43617e92006-03-06 20:55:46 +00003641 if( pPg->dirty && !pPager->stmtInUse ){
drh1aa2d8b2007-01-03 15:34:29 +00003642 assert( pPager->state>=PAGER_SHARED );
drh8124a302002-06-25 14:43:57 +00003643 if( pPager->dbSize==(int)pPg->pgno && pPager->origDbSize<pPager->dbSize ){
3644 /* If this pages is the last page in the file and the file has grown
3645 ** during the current transaction, then do NOT mark the page as clean.
3646 ** When the database file grows, we must make sure that the last page
3647 ** gets written at least once so that the disk file will be the correct
3648 ** size. If you do not write this page and the size of the file
3649 ** on the disk ends up being too small, that can lead to database
3650 ** corruption during the next transaction.
3651 */
3652 }else{
drh4f0c5872007-03-26 22:05:01 +00003653 PAGERTRACE3("DONT_WRITE page %d of %d\n", pgno, PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00003654 IOTRACE(("CLEAN %p %d\n", pPager, pgno))
drh605ad8f2006-05-03 23:34:05 +00003655 makeClean(pPg);
danielk19773c407372005-02-15 02:54:14 +00003656#ifdef SQLITE_CHECK_PAGES
3657 pPg->pageHash = pager_pagehash(pPg);
3658#endif
drh8124a302002-06-25 14:43:57 +00003659 }
drh30e58752002-03-02 20:41:57 +00003660 }
3661}
3662
3663/*
3664** A call to this routine tells the pager that if a rollback occurs,
3665** it is not necessary to restore the data on the given page. This
3666** means that the pager does not have to record the given page in the
3667** rollback journal.
3668*/
danielk19773b8a05f2007-03-19 17:44:26 +00003669void sqlite3PagerDontRollback(DbPage *pPg){
drh30e58752002-03-02 20:41:57 +00003670 Pager *pPager = pPg->pPager;
3671
drhd3627af2006-12-18 18:34:51 +00003672 assert( pPager->state>=PAGER_RESERVED );
3673 if( pPager->journalOpen==0 ) return;
drhb7f91642004-10-31 02:22:47 +00003674 if( pPg->alwaysRollback || pPager->alwaysRollback || MEMDB ) return;
drh30e58752002-03-02 20:41:57 +00003675 if( !pPg->inJournal && (int)pPg->pgno <= pPager->origDbSize ){
3676 assert( pPager->aInJournal!=0 );
3677 pPager->aInJournal[pPg->pgno/8] |= 1<<(pPg->pgno&7);
3678 pPg->inJournal = 1;
drhac69b052004-05-12 13:30:07 +00003679 if( pPager->stmtInUse ){
3680 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drh30e58752002-03-02 20:41:57 +00003681 }
drh4f0c5872007-03-26 22:05:01 +00003682 PAGERTRACE3("DONT_ROLLBACK page %d of %d\n", pPg->pgno, PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00003683 IOTRACE(("GARBAGE %p %d\n", pPager, pPg->pgno))
drh30e58752002-03-02 20:41:57 +00003684 }
danielk1977f35843b2007-04-07 15:03:17 +00003685 if( pPager->stmtInUse
3686 && !pageInStatement(pPg)
3687 && (int)pPg->pgno<=pPager->stmtSize
3688 ){
drh30e58752002-03-02 20:41:57 +00003689 assert( pPg->inJournal || (int)pPg->pgno>pPager->origDbSize );
drhac69b052004-05-12 13:30:07 +00003690 assert( pPager->aInStmt!=0 );
3691 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drh30e58752002-03-02 20:41:57 +00003692 }
3693}
3694
drhac69b052004-05-12 13:30:07 +00003695
drh30e58752002-03-02 20:41:57 +00003696/*
drh80e35f42007-03-30 14:06:34 +00003697** This routine is called to increment the database file change-counter,
3698** stored at byte 24 of the pager file.
3699*/
3700static int pager_incr_changecounter(Pager *pPager){
3701 PgHdr *pPgHdr;
3702 u32 change_counter;
3703 int rc;
3704
3705 if( !pPager->changeCountDone ){
3706 /* Open page 1 of the file for writing. */
3707 rc = sqlite3PagerGet(pPager, 1, &pPgHdr);
3708 if( rc!=SQLITE_OK ) return rc;
3709 rc = sqlite3PagerWrite(pPgHdr);
3710 if( rc!=SQLITE_OK ) return rc;
3711
3712 /* Read the current value at byte 24. */
3713 change_counter = retrieve32bits(pPgHdr, 24);
3714
3715 /* Increment the value just read and write it back to byte 24. */
3716 change_counter++;
3717 put32bits(((char*)PGHDR_TO_DATA(pPgHdr))+24, change_counter);
3718 pPager->iChangeCount = change_counter;
3719
3720 /* Release the page reference. */
3721 sqlite3PagerUnref(pPgHdr);
3722 pPager->changeCountDone = 1;
3723 }
3724 return SQLITE_OK;
3725}
3726
3727/*
3728** Sync the database file for the pager pPager. zMaster points to the name
3729** of a master journal file that should be written into the individual
3730** journal file. zMaster may be NULL, which is interpreted as no master
3731** journal (a single database transaction).
3732**
3733** This routine ensures that the journal is synced, all dirty pages written
3734** to the database file and the database file synced. The only thing that
3735** remains to commit the transaction is to delete the journal file (or
3736** master journal file if specified).
3737**
3738** Note that if zMaster==NULL, this does not overwrite a previous value
3739** passed to an sqlite3PagerCommitPhaseOne() call.
3740**
3741** If parameter nTrunc is non-zero, then the pager file is truncated to
3742** nTrunc pages (this is used by auto-vacuum databases).
3743*/
3744int sqlite3PagerCommitPhaseOne(Pager *pPager, const char *zMaster, Pgno nTrunc){
3745 int rc = SQLITE_OK;
3746
3747 PAGERTRACE4("DATABASE SYNC: File=%s zMaster=%s nTrunc=%d\n",
3748 pPager->zFilename, zMaster, nTrunc);
3749
3750 /* If this is an in-memory db, or no pages have been written to, or this
3751 ** function has already been called, it is a no-op.
3752 */
3753 if( pPager->state!=PAGER_SYNCED && !MEMDB && pPager->dirtyCache ){
3754 PgHdr *pPg;
3755 assert( pPager->journalOpen );
3756
3757 /* If a master journal file name has already been written to the
3758 ** journal file, then no sync is required. This happens when it is
3759 ** written, then the process fails to upgrade from a RESERVED to an
3760 ** EXCLUSIVE lock. The next time the process tries to commit the
3761 ** transaction the m-j name will have already been written.
3762 */
3763 if( !pPager->setMaster ){
3764 rc = pager_incr_changecounter(pPager);
3765 if( rc!=SQLITE_OK ) goto sync_exit;
3766#ifndef SQLITE_OMIT_AUTOVACUUM
3767 if( nTrunc!=0 ){
3768 /* If this transaction has made the database smaller, then all pages
3769 ** being discarded by the truncation must be written to the journal
3770 ** file.
3771 */
3772 Pgno i;
3773 int iSkip = PAGER_MJ_PGNO(pPager);
3774 for( i=nTrunc+1; i<=pPager->origDbSize; i++ ){
3775 if( !(pPager->aInJournal[i/8] & (1<<(i&7))) && i!=iSkip ){
3776 rc = sqlite3PagerGet(pPager, i, &pPg);
3777 if( rc!=SQLITE_OK ) goto sync_exit;
3778 rc = sqlite3PagerWrite(pPg);
3779 sqlite3PagerUnref(pPg);
3780 if( rc!=SQLITE_OK ) goto sync_exit;
3781 }
3782 }
3783 }
3784#endif
3785 rc = writeMasterJournal(pPager, zMaster);
3786 if( rc!=SQLITE_OK ) goto sync_exit;
3787 rc = syncJournal(pPager);
3788 if( rc!=SQLITE_OK ) goto sync_exit;
3789 }
3790
3791#ifndef SQLITE_OMIT_AUTOVACUUM
3792 if( nTrunc!=0 ){
3793 rc = sqlite3PagerTruncate(pPager, nTrunc);
3794 if( rc!=SQLITE_OK ) goto sync_exit;
3795 }
3796#endif
3797
3798 /* Write all dirty pages to the database file */
3799 pPg = pager_get_all_dirty_pages(pPager);
3800 rc = pager_write_pagelist(pPg);
3801 if( rc!=SQLITE_OK ) goto sync_exit;
drh3cdd7d32007-03-30 14:46:01 +00003802 pPager->pDirty = 0;
drh80e35f42007-03-30 14:06:34 +00003803
3804 /* Sync the database file. */
3805 if( !pPager->noSync ){
3806 rc = sqlite3OsSync(pPager->fd, 0);
3807 }
3808 IOTRACE(("DBSYNC %p\n", pPager))
3809
3810 pPager->state = PAGER_SYNCED;
3811 }else if( MEMDB && nTrunc!=0 ){
3812 rc = sqlite3PagerTruncate(pPager, nTrunc);
3813 }
3814
3815sync_exit:
3816 return rc;
3817}
3818
3819
3820/*
drhed7c8552001-04-11 14:29:21 +00003821** Commit all changes to the database and release the write lock.
drhd9b02572001-04-15 00:37:09 +00003822**
3823** If the commit fails for any reason, a rollback attempt is made
3824** and an error code is returned. If the commit worked, SQLITE_OK
3825** is returned.
drhed7c8552001-04-11 14:29:21 +00003826*/
drh80e35f42007-03-30 14:06:34 +00003827int sqlite3PagerCommitPhaseTwo(Pager *pPager){
drha1b351a2001-09-14 16:42:12 +00003828 int rc;
drhed7c8552001-04-11 14:29:21 +00003829 PgHdr *pPg;
drhd9b02572001-04-15 00:37:09 +00003830
danielk1977efaaf572006-01-16 11:29:19 +00003831 if( pPager->errCode ){
danielk19777f7bc662006-01-23 13:47:47 +00003832 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00003833 }
drha6abd042004-06-09 17:37:22 +00003834 if( pPager->state<PAGER_RESERVED ){
drhd9b02572001-04-15 00:37:09 +00003835 return SQLITE_ERROR;
3836 }
drh4f0c5872007-03-26 22:05:01 +00003837 PAGERTRACE2("COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003838 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00003839 pPg = pager_get_all_dirty_pages(pPager);
3840 while( pPg ){
danielk1977f35843b2007-04-07 15:03:17 +00003841 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
3842 clearHistory(pHist);
drhac69b052004-05-12 13:30:07 +00003843 pPg->dirty = 0;
3844 pPg->inJournal = 0;
danielk1977f35843b2007-04-07 15:03:17 +00003845 pHist->inStmt = 0;
drh5229ae42006-03-23 23:29:04 +00003846 pPg->needSync = 0;
danielk1977f35843b2007-04-07 15:03:17 +00003847 pHist->pPrevStmt = pHist->pNextStmt = 0;
drhac69b052004-05-12 13:30:07 +00003848 pPg = pPg->pDirty;
3849 }
drh605ad8f2006-05-03 23:34:05 +00003850 pPager->pDirty = 0;
danielk1977eac7a362004-06-16 07:45:24 +00003851#ifndef NDEBUG
3852 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
3853 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
3854 assert( !pPg->alwaysRollback );
3855 assert( !pHist->pOrig );
3856 assert( !pHist->pStmt );
3857 }
3858#endif
drhac69b052004-05-12 13:30:07 +00003859 pPager->pStmt = 0;
drha6abd042004-06-09 17:37:22 +00003860 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00003861 return SQLITE_OK;
3862 }
drh3cdd7d32007-03-30 14:46:01 +00003863 assert( pPager->journalOpen || !pPager->dirtyCache );
3864 assert( pPager->state==PAGER_SYNCED || !pPager->dirtyCache );
3865 rc = pager_end_transaction(pPager);
danielk1977979f38e2007-03-27 16:19:51 +00003866 return pager_error(pPager, rc);
drhed7c8552001-04-11 14:29:21 +00003867}
3868
3869/*
drha6abd042004-06-09 17:37:22 +00003870** Rollback all changes. The database falls back to PAGER_SHARED mode.
drhed7c8552001-04-11 14:29:21 +00003871** All in-memory cache pages revert to their original data contents.
3872** The journal is deleted.
drhd9b02572001-04-15 00:37:09 +00003873**
3874** This routine cannot fail unless some other process is not following
drh4f0ee682007-03-30 20:43:40 +00003875** the correct locking protocol or unless some other
drhd9b02572001-04-15 00:37:09 +00003876** process is writing trash into the journal file (SQLITE_CORRUPT) or
3877** unless a prior malloc() failed (SQLITE_NOMEM). Appropriate error
3878** codes are returned for all these occasions. Otherwise,
3879** SQLITE_OK is returned.
drhed7c8552001-04-11 14:29:21 +00003880*/
danielk19773b8a05f2007-03-19 17:44:26 +00003881int sqlite3PagerRollback(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +00003882 int rc;
drh4f0c5872007-03-26 22:05:01 +00003883 PAGERTRACE2("ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003884 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00003885 PgHdr *p;
3886 for(p=pPager->pAll; p; p=p->pNextAll){
3887 PgHistory *pHist;
danielk1977eac7a362004-06-16 07:45:24 +00003888 assert( !p->alwaysRollback );
3889 if( !p->dirty ){
3890 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pOrig );
3891 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pStmt );
3892 continue;
3893 }
3894
drhac69b052004-05-12 13:30:07 +00003895 pHist = PGHDR_TO_HIST(p, pPager);
3896 if( pHist->pOrig ){
3897 memcpy(PGHDR_TO_DATA(p), pHist->pOrig, pPager->pageSize);
drh4f0c5872007-03-26 22:05:01 +00003898 PAGERTRACE3("ROLLBACK-PAGE %d of %d\n", p->pgno, PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00003899 }else{
drh4f0c5872007-03-26 22:05:01 +00003900 PAGERTRACE3("PAGE %d is clean on %d\n", p->pgno, PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00003901 }
3902 clearHistory(pHist);
3903 p->dirty = 0;
3904 p->inJournal = 0;
danielk1977f35843b2007-04-07 15:03:17 +00003905 pHist->inStmt = 0;
3906 pHist->pPrevStmt = pHist->pNextStmt = 0;
danielk1977369f27e2004-06-15 11:40:04 +00003907 if( pPager->xReiniter ){
danielk19773b8a05f2007-03-19 17:44:26 +00003908 pPager->xReiniter(p, pPager->pageSize);
danielk1977369f27e2004-06-15 11:40:04 +00003909 }
drhac69b052004-05-12 13:30:07 +00003910 }
drh605ad8f2006-05-03 23:34:05 +00003911 pPager->pDirty = 0;
drhac69b052004-05-12 13:30:07 +00003912 pPager->pStmt = 0;
3913 pPager->dbSize = pPager->origDbSize;
danielk1977e180dd92007-04-05 17:15:52 +00003914 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00003915 pPager->stmtInUse = 0;
drha6abd042004-06-09 17:37:22 +00003916 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00003917 return SQLITE_OK;
3918 }
3919
drha6abd042004-06-09 17:37:22 +00003920 if( !pPager->dirtyCache || !pPager->journalOpen ){
drh80e35f42007-03-30 14:06:34 +00003921 rc = pager_end_transaction(pPager);
drhda47d772002-12-02 04:25:19 +00003922 return rc;
3923 }
drhdb48ee02003-01-16 13:42:43 +00003924
danielk1977efaaf572006-01-16 11:29:19 +00003925 if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
drha6abd042004-06-09 17:37:22 +00003926 if( pPager->state>=PAGER_EXCLUSIVE ){
danielk1977e277be02007-03-23 18:12:06 +00003927 pager_playback(pPager, 0);
drh4b845d72002-03-05 12:41:19 +00003928 }
danielk1977efaaf572006-01-16 11:29:19 +00003929 return pPager->errCode;
drhed7c8552001-04-11 14:29:21 +00003930 }
drha6abd042004-06-09 17:37:22 +00003931 if( pPager->state==PAGER_RESERVED ){
danielk197717221812005-02-15 03:38:05 +00003932 int rc2;
danielk1977e277be02007-03-23 18:12:06 +00003933 rc = pager_playback(pPager, 0);
drh80e35f42007-03-30 14:06:34 +00003934 rc2 = pager_end_transaction(pPager);
drha6abd042004-06-09 17:37:22 +00003935 if( rc==SQLITE_OK ){
3936 rc = rc2;
3937 }
3938 }else{
danielk1977e277be02007-03-23 18:12:06 +00003939 rc = pager_playback(pPager, 0);
drhd9b02572001-04-15 00:37:09 +00003940 }
danielk1977e180dd92007-04-05 17:15:52 +00003941 /* pager_reset(pPager); */
drhd9b02572001-04-15 00:37:09 +00003942 pPager->dbSize = -1;
danielk197707cb5602006-01-20 10:55:05 +00003943
3944 /* If an error occurs during a ROLLBACK, we can no longer trust the pager
3945 ** cache. So call pager_error() on the way out to make any error
3946 ** persistent.
3947 */
3948 return pager_error(pPager, rc);
drh98808ba2001-10-18 12:34:46 +00003949}
drhd9b02572001-04-15 00:37:09 +00003950
3951/*
drh5e00f6c2001-09-13 13:46:56 +00003952** Return TRUE if the database file is opened read-only. Return FALSE
3953** if the database is (in theory) writable.
3954*/
danielk19773b8a05f2007-03-19 17:44:26 +00003955int sqlite3PagerIsreadonly(Pager *pPager){
drhbe0072d2001-09-13 14:46:09 +00003956 return pPager->readOnly;
drh5e00f6c2001-09-13 13:46:56 +00003957}
3958
3959/*
drh0f7eb612006-08-08 13:51:43 +00003960** Return the number of references to the pager.
3961*/
danielk19773b8a05f2007-03-19 17:44:26 +00003962int sqlite3PagerRefcount(Pager *pPager){
drh0f7eb612006-08-08 13:51:43 +00003963 return pPager->nRef;
3964}
3965
3966#ifdef SQLITE_TEST
3967/*
drhd9b02572001-04-15 00:37:09 +00003968** This routine is used for testing and analysis only.
3969*/
danielk19773b8a05f2007-03-19 17:44:26 +00003970int *sqlite3PagerStats(Pager *pPager){
danielk197742741be2005-01-08 12:42:39 +00003971 static int a[11];
drhd9b02572001-04-15 00:37:09 +00003972 a[0] = pPager->nRef;
3973 a[1] = pPager->nPage;
3974 a[2] = pPager->mxPage;
3975 a[3] = pPager->dbSize;
3976 a[4] = pPager->state;
danielk1977efaaf572006-01-16 11:29:19 +00003977 a[5] = pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00003978 a[6] = pPager->nHit;
3979 a[7] = pPager->nMiss;
drh7c4ac0c2007-04-05 11:25:58 +00003980 a[8] = 0; /* Used to be pPager->nOvfl */
danielk197742741be2005-01-08 12:42:39 +00003981 a[9] = pPager->nRead;
3982 a[10] = pPager->nWrite;
drhd9b02572001-04-15 00:37:09 +00003983 return a;
3984}
drh0f7eb612006-08-08 13:51:43 +00003985#endif
drhdd793422001-06-28 01:54:48 +00003986
drhfa86c412002-02-02 15:01:15 +00003987/*
drhac69b052004-05-12 13:30:07 +00003988** Set the statement rollback point.
drhfa86c412002-02-02 15:01:15 +00003989**
3990** This routine should be called with the transaction journal already
drhac69b052004-05-12 13:30:07 +00003991** open. A new statement journal is created that can be used to rollback
drhaaab5722002-02-19 13:39:21 +00003992** changes of a single SQL command within a larger transaction.
drhfa86c412002-02-02 15:01:15 +00003993*/
danielk19773b8a05f2007-03-19 17:44:26 +00003994int sqlite3PagerStmtBegin(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00003995 int rc;
drhac69b052004-05-12 13:30:07 +00003996 assert( !pPager->stmtInUse );
drh1aa2d8b2007-01-03 15:34:29 +00003997 assert( pPager->state>=PAGER_SHARED );
drhdc3ff9c2004-08-18 02:10:15 +00003998 assert( pPager->dbSize>=0 );
drh4f0c5872007-03-26 22:05:01 +00003999 PAGERTRACE2("STMT-BEGIN %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004000 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004001 pPager->stmtInUse = 1;
4002 pPager->stmtSize = pPager->dbSize;
4003 return SQLITE_OK;
4004 }
drhda47d772002-12-02 04:25:19 +00004005 if( !pPager->journalOpen ){
drhac69b052004-05-12 13:30:07 +00004006 pPager->stmtAutoopen = 1;
drhda47d772002-12-02 04:25:19 +00004007 return SQLITE_OK;
4008 }
drhfa86c412002-02-02 15:01:15 +00004009 assert( pPager->journalOpen );
drhac69b052004-05-12 13:30:07 +00004010 pPager->aInStmt = sqliteMalloc( pPager->dbSize/8 + 1 );
4011 if( pPager->aInStmt==0 ){
danielk1977261919c2005-12-06 12:52:59 +00004012 /* sqlite3OsLock(pPager->fd, SHARED_LOCK); */
drhfa86c412002-02-02 15:01:15 +00004013 return SQLITE_NOMEM;
4014 }
drh968af522003-02-11 14:55:40 +00004015#ifndef NDEBUG
drh054889e2005-11-30 03:20:31 +00004016 rc = sqlite3OsFileSize(pPager->jfd, &pPager->stmtJSize);
drhac69b052004-05-12 13:30:07 +00004017 if( rc ) goto stmt_begin_failed;
danielk197776572402004-06-25 02:38:54 +00004018 assert( pPager->stmtJSize == pPager->journalOff );
drh968af522003-02-11 14:55:40 +00004019#endif
danielk197776572402004-06-25 02:38:54 +00004020 pPager->stmtJSize = pPager->journalOff;
drhac69b052004-05-12 13:30:07 +00004021 pPager->stmtSize = pPager->dbSize;
danielk197776572402004-06-25 02:38:54 +00004022 pPager->stmtHdrOff = 0;
danielk197775edc162004-06-26 01:48:18 +00004023 pPager->stmtCksum = pPager->cksumInit;
drhac69b052004-05-12 13:30:07 +00004024 if( !pPager->stmtOpen ){
danielk19773b8a05f2007-03-19 17:44:26 +00004025 rc = sqlite3PagerOpentemp(&pPager->stfd);
drhac69b052004-05-12 13:30:07 +00004026 if( rc ) goto stmt_begin_failed;
4027 pPager->stmtOpen = 1;
4028 pPager->stmtNRec = 0;
drh0f892532002-05-30 12:27:03 +00004029 }
drhac69b052004-05-12 13:30:07 +00004030 pPager->stmtInUse = 1;
drhfa86c412002-02-02 15:01:15 +00004031 return SQLITE_OK;
4032
drhac69b052004-05-12 13:30:07 +00004033stmt_begin_failed:
4034 if( pPager->aInStmt ){
4035 sqliteFree(pPager->aInStmt);
4036 pPager->aInStmt = 0;
drhfa86c412002-02-02 15:01:15 +00004037 }
4038 return rc;
4039}
4040
4041/*
drhac69b052004-05-12 13:30:07 +00004042** Commit a statement.
drhfa86c412002-02-02 15:01:15 +00004043*/
danielk19773b8a05f2007-03-19 17:44:26 +00004044int sqlite3PagerStmtCommit(Pager *pPager){
drhac69b052004-05-12 13:30:07 +00004045 if( pPager->stmtInUse ){
drh03eb96a2002-11-10 23:32:56 +00004046 PgHdr *pPg, *pNext;
drh4f0c5872007-03-26 22:05:01 +00004047 PAGERTRACE2("STMT-COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004048 if( !MEMDB ){
drh054889e2005-11-30 03:20:31 +00004049 sqlite3OsSeek(pPager->stfd, 0);
4050 /* sqlite3OsTruncate(pPager->stfd, 0); */
drhac69b052004-05-12 13:30:07 +00004051 sqliteFree( pPager->aInStmt );
4052 pPager->aInStmt = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004053 }else{
4054 for(pPg=pPager->pStmt; pPg; pPg=pNext){
drhac69b052004-05-12 13:30:07 +00004055 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
danielk1977f35843b2007-04-07 15:03:17 +00004056 pNext = pHist->pNextStmt;
4057 assert( pHist->inStmt );
4058 pHist->inStmt = 0;
4059 pHist->pPrevStmt = pHist->pNextStmt = 0;
drhac69b052004-05-12 13:30:07 +00004060 sqliteFree(pHist->pStmt);
4061 pHist->pStmt = 0;
4062 }
4063 }
4064 pPager->stmtNRec = 0;
4065 pPager->stmtInUse = 0;
4066 pPager->pStmt = 0;
drh663fc632002-02-02 18:49:19 +00004067 }
drhac69b052004-05-12 13:30:07 +00004068 pPager->stmtAutoopen = 0;
drhfa86c412002-02-02 15:01:15 +00004069 return SQLITE_OK;
4070}
4071
4072/*
drhac69b052004-05-12 13:30:07 +00004073** Rollback a statement.
drhfa86c412002-02-02 15:01:15 +00004074*/
danielk19773b8a05f2007-03-19 17:44:26 +00004075int sqlite3PagerStmtRollback(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00004076 int rc;
drhac69b052004-05-12 13:30:07 +00004077 if( pPager->stmtInUse ){
drh4f0c5872007-03-26 22:05:01 +00004078 PAGERTRACE2("STMT-ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004079 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004080 PgHdr *pPg;
danielk1977f35843b2007-04-07 15:03:17 +00004081 PgHistory *pHist;
4082 for(pPg=pPager->pStmt; pPg; pPg=pHist->pNextStmt){
4083 pHist = PGHDR_TO_HIST(pPg, pPager);
drhac69b052004-05-12 13:30:07 +00004084 if( pHist->pStmt ){
4085 memcpy(PGHDR_TO_DATA(pPg), pHist->pStmt, pPager->pageSize);
4086 sqliteFree(pHist->pStmt);
4087 pHist->pStmt = 0;
4088 }
4089 }
4090 pPager->dbSize = pPager->stmtSize;
danielk1977e180dd92007-04-05 17:15:52 +00004091 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00004092 rc = SQLITE_OK;
4093 }else{
4094 rc = pager_stmt_playback(pPager);
4095 }
danielk19773b8a05f2007-03-19 17:44:26 +00004096 sqlite3PagerStmtCommit(pPager);
drh663fc632002-02-02 18:49:19 +00004097 }else{
4098 rc = SQLITE_OK;
4099 }
drhac69b052004-05-12 13:30:07 +00004100 pPager->stmtAutoopen = 0;
drhfa86c412002-02-02 15:01:15 +00004101 return rc;
4102}
4103
drh73509ee2003-04-06 20:44:45 +00004104/*
4105** Return the full pathname of the database file.
4106*/
danielk19773b8a05f2007-03-19 17:44:26 +00004107const char *sqlite3PagerFilename(Pager *pPager){
drh73509ee2003-04-06 20:44:45 +00004108 return pPager->zFilename;
4109}
4110
drhb20ea9d2004-02-09 01:20:36 +00004111/*
danielk19775865e3d2004-06-14 06:03:57 +00004112** Return the directory of the database file.
4113*/
danielk19773b8a05f2007-03-19 17:44:26 +00004114const char *sqlite3PagerDirname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00004115 return pPager->zDirectory;
4116}
4117
4118/*
4119** Return the full pathname of the journal file.
4120*/
danielk19773b8a05f2007-03-19 17:44:26 +00004121const char *sqlite3PagerJournalname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00004122 return pPager->zJournal;
4123}
4124
4125/*
drh2c8997b2005-08-27 16:36:48 +00004126** Return true if fsync() calls are disabled for this pager. Return FALSE
4127** if fsync()s are executed normally.
4128*/
danielk19773b8a05f2007-03-19 17:44:26 +00004129int sqlite3PagerNosync(Pager *pPager){
drh2c8997b2005-08-27 16:36:48 +00004130 return pPager->noSync;
4131}
4132
drh7c4ac0c2007-04-05 11:25:58 +00004133#ifdef SQLITE_HAS_CODEC
drh2c8997b2005-08-27 16:36:48 +00004134/*
drhb20ea9d2004-02-09 01:20:36 +00004135** Set the codec for this pager
4136*/
danielk19773b8a05f2007-03-19 17:44:26 +00004137void sqlite3PagerSetCodec(
drhb20ea9d2004-02-09 01:20:36 +00004138 Pager *pPager,
drhc001c582006-03-06 18:23:16 +00004139 void *(*xCodec)(void*,void*,Pgno,int),
drhb20ea9d2004-02-09 01:20:36 +00004140 void *pCodecArg
4141){
4142 pPager->xCodec = xCodec;
4143 pPager->pCodecArg = pCodecArg;
4144}
drh7c4ac0c2007-04-05 11:25:58 +00004145#endif
drhb20ea9d2004-02-09 01:20:36 +00004146
danielk1977687566d2004-11-02 12:56:41 +00004147#ifndef SQLITE_OMIT_AUTOVACUUM
4148/*
4149** Move the page identified by pData to location pgno in the file.
4150**
4151** There must be no references to the current page pgno. If current page
4152** pgno is not already in the rollback journal, it is not written there by
4153** by this routine. The same applies to the page pData refers to on entry to
4154** this routine.
4155**
4156** References to the page refered to by pData remain valid. Updating any
4157** meta-data associated with page pData (i.e. data stored in the nExtra bytes
4158** allocated along with the page) is the responsibility of the caller.
4159**
danielk19775fd057a2005-03-09 13:09:43 +00004160** A transaction must be active when this routine is called. It used to be
4161** required that a statement transaction was not active, but this restriction
4162** has been removed (CREATE INDEX needs to move a page when a statement
4163** transaction is active).
danielk1977687566d2004-11-02 12:56:41 +00004164*/
danielk19773b8a05f2007-03-19 17:44:26 +00004165int sqlite3PagerMovepage(Pager *pPager, DbPage *pPg, Pgno pgno){
danielk1977687566d2004-11-02 12:56:41 +00004166 PgHdr *pPgOld;
danielk1977f5fdda82004-11-03 08:44:05 +00004167 int h;
danielk197794daf7f2004-11-08 09:26:09 +00004168 Pgno needSyncPgno = 0;
danielk1977687566d2004-11-02 12:56:41 +00004169
danielk1977687566d2004-11-02 12:56:41 +00004170 assert( pPg->nRef>0 );
4171
drh4f0c5872007-03-26 22:05:01 +00004172 PAGERTRACE5("MOVE %d page %d (needSync=%d) moves to %d\n",
danielk1977599fcba2004-11-08 07:13:13 +00004173 PAGERID(pPager), pPg->pgno, pPg->needSync, pgno);
drhb0603412007-02-28 04:47:26 +00004174 IOTRACE(("MOVE %p %d %d\n", pPager, pPg->pgno, pgno))
danielk1977ef73ee92004-11-06 12:26:07 +00004175
danielk197794daf7f2004-11-08 09:26:09 +00004176 if( pPg->needSync ){
4177 needSyncPgno = pPg->pgno;
4178 assert( pPg->inJournal );
4179 assert( pPg->dirty );
danielk1977ae825582004-11-23 09:06:55 +00004180 assert( pPager->needSync );
danielk197794daf7f2004-11-08 09:26:09 +00004181 }
4182
danielk1977687566d2004-11-02 12:56:41 +00004183 /* Unlink pPg from it's hash-chain */
danielk1977f5fdda82004-11-03 08:44:05 +00004184 unlinkHashChain(pPager, pPg);
danielk1977687566d2004-11-02 12:56:41 +00004185
danielk1977ef73ee92004-11-06 12:26:07 +00004186 /* If the cache contains a page with page-number pgno, remove it
danielk1977599fcba2004-11-08 07:13:13 +00004187 ** from it's hash chain. Also, if the PgHdr.needSync was set for
4188 ** page pgno before the 'move' operation, it needs to be retained
4189 ** for the page moved there.
danielk1977f5fdda82004-11-03 08:44:05 +00004190 */
danielk1977687566d2004-11-02 12:56:41 +00004191 pPgOld = pager_lookup(pPager, pgno);
4192 if( pPgOld ){
danielk1977f5fdda82004-11-03 08:44:05 +00004193 assert( pPgOld->nRef==0 );
4194 unlinkHashChain(pPager, pPgOld);
drh605ad8f2006-05-03 23:34:05 +00004195 makeClean(pPgOld);
danielk1977ef73ee92004-11-06 12:26:07 +00004196 if( pPgOld->needSync ){
danielk197745901d62004-11-10 15:27:38 +00004197 assert( pPgOld->inJournal );
4198 pPg->inJournal = 1;
danielk1977ef73ee92004-11-06 12:26:07 +00004199 pPg->needSync = 1;
danielk1977ae825582004-11-23 09:06:55 +00004200 assert( pPager->needSync );
danielk1977ef73ee92004-11-06 12:26:07 +00004201 }
danielk1977687566d2004-11-02 12:56:41 +00004202 }
4203
danielk1977f5fdda82004-11-03 08:44:05 +00004204 /* Change the page number for pPg and insert it into the new hash-chain. */
drh3765df42006-06-28 18:18:09 +00004205 assert( pgno!=0 );
danielk1977f5fdda82004-11-03 08:44:05 +00004206 pPg->pgno = pgno;
drh8ca0c722006-05-07 17:49:38 +00004207 h = pgno & (pPager->nHash-1);
danielk1977f5fdda82004-11-03 08:44:05 +00004208 if( pPager->aHash[h] ){
4209 assert( pPager->aHash[h]->pPrevHash==0 );
4210 pPager->aHash[h]->pPrevHash = pPg;
4211 }
4212 pPg->pNextHash = pPager->aHash[h];
4213 pPager->aHash[h] = pPg;
4214 pPg->pPrevHash = 0;
4215
drh605ad8f2006-05-03 23:34:05 +00004216 makeDirty(pPg);
danielk1977687566d2004-11-02 12:56:41 +00004217 pPager->dirtyCache = 1;
4218
danielk197794daf7f2004-11-08 09:26:09 +00004219 if( needSyncPgno ){
4220 /* If needSyncPgno is non-zero, then the journal file needs to be
4221 ** sync()ed before any data is written to database file page needSyncPgno.
4222 ** Currently, no such page exists in the page-cache and the
4223 ** Pager.aInJournal bit has been set. This needs to be remedied by loading
4224 ** the page into the pager-cache and setting the PgHdr.needSync flag.
danielk1977ae825582004-11-23 09:06:55 +00004225 **
danielk19773b8a05f2007-03-19 17:44:26 +00004226 ** The sqlite3PagerGet() call may cause the journal to sync. So make
danielk1977ae825582004-11-23 09:06:55 +00004227 ** sure the Pager.needSync flag is set too.
danielk197794daf7f2004-11-08 09:26:09 +00004228 */
4229 int rc;
danielk19773b8a05f2007-03-19 17:44:26 +00004230 PgHdr *pPgHdr;
danielk1977ae825582004-11-23 09:06:55 +00004231 assert( pPager->needSync );
danielk19773b8a05f2007-03-19 17:44:26 +00004232 rc = sqlite3PagerGet(pPager, needSyncPgno, &pPgHdr);
danielk197794daf7f2004-11-08 09:26:09 +00004233 if( rc!=SQLITE_OK ) return rc;
danielk1977ae825582004-11-23 09:06:55 +00004234 pPager->needSync = 1;
danielk19773b8a05f2007-03-19 17:44:26 +00004235 pPgHdr->needSync = 1;
4236 pPgHdr->inJournal = 1;
4237 makeDirty(pPgHdr);
4238 sqlite3PagerUnref(pPgHdr);
danielk197794daf7f2004-11-08 09:26:09 +00004239 }
4240
danielk1977687566d2004-11-02 12:56:41 +00004241 return SQLITE_OK;
4242}
4243#endif
4244
danielk19773b8a05f2007-03-19 17:44:26 +00004245/*
4246** Return a pointer to the data for the specified page.
4247*/
4248void *sqlite3PagerGetData(DbPage *pPg){
4249 return PGHDR_TO_DATA(pPg);
4250}
4251
4252/*
4253** Return a pointer to the Pager.nExtra bytes of "extra" space
4254** allocated along with the specified page.
4255*/
4256void *sqlite3PagerGetExtra(DbPage *pPg){
4257 Pager *pPager = pPg->pPager;
4258 return (pPager?PGHDR_TO_EXTRA(pPg, pPager):0);
4259}
4260
danielk197741483462007-03-24 16:45:04 +00004261/*
4262** Get/set the locking-mode for this pager. Parameter eMode must be one
4263** of PAGER_LOCKINGMODE_QUERY, PAGER_LOCKINGMODE_NORMAL or
4264** PAGER_LOCKINGMODE_EXCLUSIVE. If the parameter is not _QUERY, then
4265** the locking-mode is set to the value specified.
4266**
4267** The returned value is either PAGER_LOCKINGMODE_NORMAL or
4268** PAGER_LOCKINGMODE_EXCLUSIVE, indicating the current (possibly updated)
4269** locking-mode.
4270*/
4271int sqlite3PagerLockingMode(Pager *pPager, int eMode){
drh369339d2007-03-30 16:01:55 +00004272 assert( eMode==PAGER_LOCKINGMODE_QUERY
4273 || eMode==PAGER_LOCKINGMODE_NORMAL
4274 || eMode==PAGER_LOCKINGMODE_EXCLUSIVE );
4275 assert( PAGER_LOCKINGMODE_QUERY<0 );
4276 assert( PAGER_LOCKINGMODE_NORMAL>=0 && PAGER_LOCKINGMODE_EXCLUSIVE>=0 );
4277 if( eMode>=0 && !pPager->tempFile ){
danielk197741483462007-03-24 16:45:04 +00004278 pPager->exclusiveMode = eMode;
4279 }
4280 return (int)pPager->exclusiveMode;
4281}
4282
dougcurrie81c95ef2004-06-18 23:21:47 +00004283#if defined(SQLITE_DEBUG) || defined(SQLITE_TEST)
drh89ac8c12004-06-09 14:17:20 +00004284/*
4285** Return the current state of the file lock for the given pager.
4286** The return value is one of NO_LOCK, SHARED_LOCK, RESERVED_LOCK,
4287** PENDING_LOCK, or EXCLUSIVE_LOCK.
4288*/
danielk19773b8a05f2007-03-19 17:44:26 +00004289int sqlite3PagerLockstate(Pager *pPager){
drh054889e2005-11-30 03:20:31 +00004290 return sqlite3OsLockState(pPager->fd);
drh89ac8c12004-06-09 14:17:20 +00004291}
4292#endif
4293
danielk197793758c82005-01-21 08:13:14 +00004294#ifdef SQLITE_DEBUG
drhdd793422001-06-28 01:54:48 +00004295/*
4296** Print a listing of all referenced pages and their ref count.
4297*/
danielk19773b8a05f2007-03-19 17:44:26 +00004298void sqlite3PagerRefdump(Pager *pPager){
drhdd793422001-06-28 01:54:48 +00004299 PgHdr *pPg;
4300 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
4301 if( pPg->nRef<=0 ) continue;
drhfe63d1c2004-09-08 20:13:04 +00004302 sqlite3DebugPrintf("PAGE %3d addr=%p nRef=%d\n",
4303 pPg->pgno, PGHDR_TO_DATA(pPg), pPg->nRef);
drhdd793422001-06-28 01:54:48 +00004304 }
4305}
4306#endif
drh2e66f0b2005-04-28 17:18:48 +00004307
4308#endif /* SQLITE_OMIT_DISKIO */