blob: 478a7014d7d7de7f3e7079f1e838ea2bfa384128 [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**
drh538f5702007-04-13 02:14:30 +000021** @(#) $Id: pager.c,v 1.327 2007/04/13 02:14:30 drh Exp $
drhed7c8552001-04-11 14:29:21 +000022*/
drh2e66f0b2005-04-28 17:18:48 +000023#ifndef SQLITE_OMIT_DISKIO
drhd9b02572001-04-15 00:37:09 +000024#include "sqliteInt.h"
drheb206252004-10-01 02:00:31 +000025#include "os.h"
drhed7c8552001-04-11 14:29:21 +000026#include "pager.h"
drhed7c8552001-04-11 14:29:21 +000027#include <assert.h>
drhd9b02572001-04-15 00:37:09 +000028#include <string.h>
drhed7c8552001-04-11 14:29:21 +000029
30/*
drhdb48ee02003-01-16 13:42:43 +000031** Macros for troubleshooting. Normally turned off
32*/
danielk1977466be562004-06-10 02:16:01 +000033#if 0
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 */
drh538f5702007-04-13 02:14:30 +0000165 u8 needRead; /* Read content if PagerWrite() is called */
drhac69b052004-05-12 13:30:07 +0000166 short int nRef; /* Number of users of this page */
drhdc3e10b2006-06-15 14:31:06 +0000167 PgHdr *pDirty, *pPrevDirty; /* Dirty pages */
drh605ad8f2006-05-03 23:34:05 +0000168 u32 notUsed; /* Buffer space */
danielk19773c407372005-02-15 02:54:14 +0000169#ifdef SQLITE_CHECK_PAGES
170 u32 pageHash;
171#endif
drh1c7880e2005-05-20 20:01:55 +0000172 /* pPager->pageSize bytes of page data follow this header */
drh973b6e32003-02-12 14:09:42 +0000173 /* Pager.nExtra bytes of local data follow the page data */
drhed7c8552001-04-11 14:29:21 +0000174};
175
drhac69b052004-05-12 13:30:07 +0000176/*
177** For an in-memory only database, some extra information is recorded about
178** each page so that changes can be rolled back. (Journal files are not
179** used for in-memory databases.) The following information is added to
180** the end of every EXTRA block for in-memory databases.
181**
182** This information could have been added directly to the PgHdr structure.
183** But then it would take up an extra 8 bytes of storage on every PgHdr
184** even for disk-based databases. Splitting it out saves 8 bytes. This
185** is only a savings of 0.8% but those percentages add up.
186*/
187typedef struct PgHistory PgHistory;
188struct PgHistory {
189 u8 *pOrig; /* Original page text. Restore to this on a full rollback */
190 u8 *pStmt; /* Text as it was at the beginning of the current statement */
danielk1977f35843b2007-04-07 15:03:17 +0000191 PgHdr *pNextStmt, *pPrevStmt; /* List of pages in the statement journal */
192 u8 inStmt; /* TRUE if in the statement subjournal */
drhac69b052004-05-12 13:30:07 +0000193};
drh9eb9e262004-02-11 02:18:05 +0000194
195/*
196** A macro used for invoking the codec if there is one
197*/
198#ifdef SQLITE_HAS_CODEC
drhc001c582006-03-06 18:23:16 +0000199# define CODEC1(P,D,N,X) if( P->xCodec!=0 ){ P->xCodec(P->pCodecArg,D,N,X); }
200# define CODEC2(P,D,N,X) ((char*)(P->xCodec!=0?P->xCodec(P->pCodecArg,D,N,X):D))
drh9eb9e262004-02-11 02:18:05 +0000201#else
drhc001c582006-03-06 18:23:16 +0000202# define CODEC1(P,D,N,X) /* NO-OP */
203# define CODEC2(P,D,N,X) ((char*)D)
drh9eb9e262004-02-11 02:18:05 +0000204#endif
205
drhed7c8552001-04-11 14:29:21 +0000206/*
drh69688d52001-04-14 16:38:23 +0000207** Convert a pointer to a PgHdr into a pointer to its data
208** and back again.
drhed7c8552001-04-11 14:29:21 +0000209*/
210#define PGHDR_TO_DATA(P) ((void*)(&(P)[1]))
211#define DATA_TO_PGHDR(D) (&((PgHdr*)(D))[-1])
drh1c7880e2005-05-20 20:01:55 +0000212#define PGHDR_TO_EXTRA(G,P) ((void*)&((char*)(&(G)[1]))[(P)->pageSize])
drhac69b052004-05-12 13:30:07 +0000213#define PGHDR_TO_HIST(P,PGR) \
drh1c7880e2005-05-20 20:01:55 +0000214 ((PgHistory*)&((char*)(&(P)[1]))[(PGR)->pageSize+(PGR)->nExtra])
drhed7c8552001-04-11 14:29:21 +0000215
216/*
drhed7c8552001-04-11 14:29:21 +0000217** A open page cache is an instance of the following structure.
danielk1977efaaf572006-01-16 11:29:19 +0000218**
drh4f0ee682007-03-30 20:43:40 +0000219** Pager.errCode may be set to SQLITE_IOERR, SQLITE_CORRUPT, or
danielk1977efaaf572006-01-16 11:29:19 +0000220** or SQLITE_FULL. Once one of the first three errors occurs, it persists
221** and is returned as the result of every major pager API call. The
222** SQLITE_FULL return code is slightly different. It persists only until the
223** next successful rollback is performed on the pager cache. Also,
danielk19773b8a05f2007-03-19 17:44:26 +0000224** SQLITE_FULL does not affect the sqlite3PagerGet() and sqlite3PagerLookup()
danielk1977efaaf572006-01-16 11:29:19 +0000225** APIs, they may still be used successfully.
drhed7c8552001-04-11 14:29:21 +0000226*/
227struct Pager {
drh603240c2002-03-05 01:11:12 +0000228 u8 journalOpen; /* True if journal file descriptors is valid */
drh34e79ce2004-02-08 06:05:46 +0000229 u8 journalStarted; /* True if header of journal is synced */
230 u8 useJournal; /* Use a rollback journal on this file */
drh7bec5052005-02-06 02:45:41 +0000231 u8 noReadlock; /* Do not bother to obtain readlocks */
drhac69b052004-05-12 13:30:07 +0000232 u8 stmtOpen; /* True if the statement subjournal is open */
233 u8 stmtInUse; /* True we are in a statement subtransaction */
234 u8 stmtAutoopen; /* Open stmt journal when main journal is opened*/
drh603240c2002-03-05 01:11:12 +0000235 u8 noSync; /* Do not sync the journal if true */
drh968af522003-02-11 14:55:40 +0000236 u8 fullSync; /* Do extra syncs of the journal for robustness */
drhac530b12006-02-11 01:25:50 +0000237 u8 full_fsync; /* Use F_FULLFSYNC when available */
drha6abd042004-06-09 17:37:22 +0000238 u8 state; /* PAGER_UNLOCK, _SHARED, _RESERVED, etc. */
drh603240c2002-03-05 01:11:12 +0000239 u8 tempFile; /* zFilename is a temporary file */
240 u8 readOnly; /* True for a read-only database */
241 u8 needSync; /* True if an fsync() is needed on the journal */
drha6abd042004-06-09 17:37:22 +0000242 u8 dirtyCache; /* True if cached pages have changed */
drh80e35f42007-03-30 14:06:34 +0000243 u8 alwaysRollback; /* Disable DontRollback() for all pages */
drhac69b052004-05-12 13:30:07 +0000244 u8 memDb; /* True to inhibit all file I/O */
drh6d156e42005-05-20 20:11:20 +0000245 u8 setMaster; /* True if a m-j name has been written to jrnl */
drh80e35f42007-03-30 14:06:34 +0000246 u8 doNotSync; /* Boolean. While true, do not spill the cache */
247 u8 exclusiveMode; /* Boolean. True if locking_mode==EXCLUSIVE */
248 u8 changeCountDone; /* Set after incrementing the change-counter */
drhe49f9822006-09-15 12:29:16 +0000249 int errCode; /* One of several kinds of errors */
drhfcd35c72005-05-21 02:48:08 +0000250 int dbSize; /* Number of pages in the file */
251 int origDbSize; /* dbSize before the current change */
252 int stmtSize; /* Size of database (in pages) at stmt_begin() */
253 int nRec; /* Number of pages written to the journal */
254 u32 cksumInit; /* Quasi-random value added to every checksum */
255 int stmtNRec; /* Number of records in stmt subjournal */
256 int nExtra; /* Add this many bytes to each in-memory page */
257 int pageSize; /* Number of bytes in a page */
258 int nPage; /* Total number of in-memory pages */
259 int nMaxPage; /* High water mark of nPage */
260 int nRef; /* Number of in-memory pages with PgHdr.nRef>0 */
261 int mxPage; /* Maximum number of pages to hold in cache */
drh603240c2002-03-05 01:11:12 +0000262 u8 *aInJournal; /* One bit for each page in the database file */
drhac69b052004-05-12 13:30:07 +0000263 u8 *aInStmt; /* One bit for each page in the database */
drhfcd35c72005-05-21 02:48:08 +0000264 char *zFilename; /* Name of the database file */
265 char *zJournal; /* Name of the journal file */
266 char *zDirectory; /* Directory hold database and journal files */
drh9cbe6352005-11-29 03:13:21 +0000267 OsFile *fd, *jfd; /* File descriptors for database and journal */
268 OsFile *stfd; /* File descriptor for the statement subjournal*/
drh726de592004-06-10 23:35:50 +0000269 BusyHandler *pBusyHandler; /* Pointer to sqlite.busyHandler */
drhed7c8552001-04-11 14:29:21 +0000270 PgHdr *pFirst, *pLast; /* List of free pages */
drh341eae82003-01-21 02:39:36 +0000271 PgHdr *pFirstSynced; /* First free page with PgHdr.needSync==0 */
drhd9b02572001-04-15 00:37:09 +0000272 PgHdr *pAll; /* List of all pages */
drhac69b052004-05-12 13:30:07 +0000273 PgHdr *pStmt; /* List of pages in the statement subjournal */
drh605ad8f2006-05-03 23:34:05 +0000274 PgHdr *pDirty; /* List of all dirty pages */
drheb206252004-10-01 02:00:31 +0000275 i64 journalOff; /* Current byte offset in the journal file */
276 i64 journalHdr; /* Byte offset to previous journal header */
277 i64 stmtHdrOff; /* First journal header written this statement */
278 i64 stmtCksum; /* cksumInit when statement was started */
drh6d156e42005-05-20 20:11:20 +0000279 i64 stmtJSize; /* Size of journal at stmt_begin() */
danielk197776572402004-06-25 02:38:54 +0000280 int sectorSize; /* Assumed sector size during rollback */
drhfcd35c72005-05-21 02:48:08 +0000281#ifdef SQLITE_TEST
drh7c4ac0c2007-04-05 11:25:58 +0000282 int nHit, nMiss; /* Cache hits and missing */
283 int nRead, nWrite; /* Database pages read/written */
drhfcd35c72005-05-21 02:48:08 +0000284#endif
danielk19773b8a05f2007-03-19 17:44:26 +0000285 void (*xDestructor)(DbPage*,int); /* Call this routine when freeing pages */
286 void (*xReiniter)(DbPage*,int); /* Call this routine when reloading pages */
drh7c4ac0c2007-04-05 11:25:58 +0000287#ifdef SQLITE_HAS_CODEC
drhc001c582006-03-06 18:23:16 +0000288 void *(*xCodec)(void*,void*,Pgno,int); /* Routine for en/decoding data */
drh6d156e42005-05-20 20:11:20 +0000289 void *pCodecArg; /* First argument to xCodec() */
drh7c4ac0c2007-04-05 11:25:58 +0000290#endif
drh8ca0c722006-05-07 17:49:38 +0000291 int nHash; /* Size of the pager hash table */
292 PgHdr **aHash; /* Hash table to map page number to PgHdr */
drh6f7adc82006-01-11 21:41:20 +0000293#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
danielk197713f72992005-12-18 08:51:22 +0000294 Pager *pNext; /* Linked list of pagers in this thread */
295#endif
danielk19778186df82007-03-06 13:45:59 +0000296 char *pTmpSpace; /* Pager.pageSize bytes of space for tmp use */
danielk1977e277be02007-03-23 18:12:06 +0000297 u32 iChangeCount; /* Db change-counter for which cache is valid */
drhd9b02572001-04-15 00:37:09 +0000298};
299
300/*
drh538f5702007-04-13 02:14:30 +0000301** The following global variables hold counters used for
302** testing purposes only. These variables do not exist in
303** a non-testing build. These variables are not thread-safe.
drhfcd35c72005-05-21 02:48:08 +0000304*/
305#ifdef SQLITE_TEST
drh538f5702007-04-13 02:14:30 +0000306int sqlite3_pager_readdb_count = 0; /* Number of full pages read from DB */
307int sqlite3_pager_writedb_count = 0; /* Number of full pages written to DB */
308int sqlite3_pager_writej_count = 0; /* Number of pages written to journal */
309int sqlite3_pager_pgfree_count = 0; /* Number of cache pages freed */
310# define PAGER_INCR(v) v++
drhfcd35c72005-05-21 02:48:08 +0000311#else
drh538f5702007-04-13 02:14:30 +0000312# define PAGER_INCR(v)
drhfcd35c72005-05-21 02:48:08 +0000313#endif
314
drh538f5702007-04-13 02:14:30 +0000315
316
drhfcd35c72005-05-21 02:48:08 +0000317/*
drh5e00f6c2001-09-13 13:46:56 +0000318** Journal files begin with the following magic string. The data
319** was obtained from /dev/random. It is used only as a sanity check.
drh94f33312002-08-12 12:29:56 +0000320**
drhae2b40c2004-06-09 19:03:54 +0000321** Since version 2.8.0, the journal format contains additional sanity
322** checking information. If the power fails while the journal is begin
323** written, semi-random garbage data might appear in the journal
324** file after power is restored. If an attempt is then made
drh968af522003-02-11 14:55:40 +0000325** to roll the journal back, the database could be corrupted. The additional
326** sanity checking data is an attempt to discover the garbage in the
327** journal and ignore it.
328**
drhae2b40c2004-06-09 19:03:54 +0000329** The sanity checking information for the new journal format consists
drh968af522003-02-11 14:55:40 +0000330** of a 32-bit checksum on each page of data. The checksum covers both
drh90f5ecb2004-07-22 01:19:35 +0000331** the page number and the pPager->pageSize bytes of data for the page.
drh968af522003-02-11 14:55:40 +0000332** This cksum is initialized to a 32-bit random value that appears in the
333** journal file right after the header. The random initializer is important,
334** because garbage data that appears at the end of a journal is likely
335** data that was once in other files that have now been deleted. If the
336** garbage data came from an obsolete journal file, the checksums might
337** be correct. But by initializing the checksum to random value which
338** is different for every journal, we minimize that risk.
drhd9b02572001-04-15 00:37:09 +0000339*/
drhae2b40c2004-06-09 19:03:54 +0000340static const unsigned char aJournalMagic[] = {
341 0xd9, 0xd5, 0x05, 0xf9, 0x20, 0xa1, 0x63, 0xd7,
drhed7c8552001-04-11 14:29:21 +0000342};
343
344/*
drh726de592004-06-10 23:35:50 +0000345** The size of the header and of each page in the journal is determined
346** by the following macros.
drh968af522003-02-11 14:55:40 +0000347*/
drhae2b40c2004-06-09 19:03:54 +0000348#define JOURNAL_PG_SZ(pPager) ((pPager->pageSize) + 8)
drh968af522003-02-11 14:55:40 +0000349
danielk197776572402004-06-25 02:38:54 +0000350/*
351** The journal header size for this pager. In the future, this could be
352** set to some value read from the disk controller. The important
353** characteristic is that it is the same size as a disk sector.
354*/
355#define JOURNAL_HDR_SZ(pPager) (pPager->sectorSize)
356
drhb7f91642004-10-31 02:22:47 +0000357/*
358** The macro MEMDB is true if we are dealing with an in-memory database.
359** We do this as a macro so that if the SQLITE_OMIT_MEMORYDB macro is set,
360** the value of MEMDB will be a constant and the compiler will optimize
361** out code that would never execute.
362*/
363#ifdef SQLITE_OMIT_MEMORYDB
364# define MEMDB 0
365#else
366# define MEMDB pPager->memDb
367#endif
368
369/*
danielk197776572402004-06-25 02:38:54 +0000370** Page number PAGER_MJ_PGNO is never used in an SQLite database (it is
371** reserved for working around a windows/posix incompatibility). It is
372** used in the journal to signify that the remainder of the journal file
373** is devoted to storing a master journal name - there are no more pages to
374** roll back. See comments for function writeMasterJournal() for details.
375*/
danielk1977599fcba2004-11-08 07:13:13 +0000376/* #define PAGER_MJ_PGNO(x) (PENDING_BYTE/((x)->pageSize)) */
377#define PAGER_MJ_PGNO(x) ((PENDING_BYTE/((x)->pageSize))+1)
danielk197713adf8a2004-06-03 16:08:41 +0000378
drh968af522003-02-11 14:55:40 +0000379/*
danielk197726836652005-01-17 01:33:13 +0000380** The maximum legal page number is (2^31 - 1).
381*/
382#define PAGER_MAX_PGNO 2147483647
383
384/*
drh726de592004-06-10 23:35:50 +0000385** Enable reference count tracking (for debugging) here:
drhdd793422001-06-28 01:54:48 +0000386*/
drh7c4ac0c2007-04-05 11:25:58 +0000387#ifdef SQLITE_DEBUG
drh3aac2dd2004-04-26 14:10:20 +0000388 int pager3_refinfo_enable = 0;
drhdd793422001-06-28 01:54:48 +0000389 static void pager_refinfo(PgHdr *p){
390 static int cnt = 0;
drh3aac2dd2004-04-26 14:10:20 +0000391 if( !pager3_refinfo_enable ) return;
drhfe63d1c2004-09-08 20:13:04 +0000392 sqlite3DebugPrintf(
drh24c9a2e2007-01-05 02:00:47 +0000393 "REFCNT: %4d addr=%p nRef=%-3d total=%d\n",
394 p->pgno, PGHDR_TO_DATA(p), p->nRef, p->pPager->nRef
drhdd793422001-06-28 01:54:48 +0000395 );
396 cnt++; /* Something to set a breakpoint on */
397 }
398# define REFINFO(X) pager_refinfo(X)
399#else
400# define REFINFO(X)
401#endif
402
danielk1977f35843b2007-04-07 15:03:17 +0000403/*
404** Return true if page *pPg has already been written to the statement
405** journal (or statement snapshot has been created, if *pPg is part
406** of an in-memory database).
407*/
408static int pageInStatement(PgHdr *pPg){
409 Pager *pPager = pPg->pPager;
410 if( MEMDB ){
411 return PGHDR_TO_HIST(pPg, pPager)->inStmt;
412 }else{
413 Pgno pgno = pPg->pgno;
414 u8 *a = pPager->aInStmt;
415 return (a && (int)pgno<=pPager->stmtSize && (a[pgno/8] & (1<<(pgno&7))));
416 }
417}
drh8ca0c722006-05-07 17:49:38 +0000418
419/*
420** Change the size of the pager hash table to N. N must be a power
421** of two.
422*/
423static void pager_resize_hash_table(Pager *pPager, int N){
424 PgHdr **aHash, *pPg;
425 assert( N>0 && (N&(N-1))==0 );
426 aHash = sqliteMalloc( sizeof(aHash[0])*N );
427 if( aHash==0 ){
428 /* Failure to rehash is not an error. It is only a performance hit. */
429 return;
430 }
431 sqliteFree(pPager->aHash);
432 pPager->nHash = N;
433 pPager->aHash = aHash;
434 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
drh3765df42006-06-28 18:18:09 +0000435 int h;
436 if( pPg->pgno==0 ){
437 assert( pPg->pNextHash==0 && pPg->pPrevHash==0 );
438 continue;
439 }
440 h = pPg->pgno & (N-1);
drh8ca0c722006-05-07 17:49:38 +0000441 pPg->pNextHash = aHash[h];
442 if( aHash[h] ){
443 aHash[h]->pPrevHash = pPg;
444 }
445 aHash[h] = pPg;
446 pPg->pPrevHash = 0;
447 }
448}
449
drhdd793422001-06-28 01:54:48 +0000450/*
drh34e79ce2004-02-08 06:05:46 +0000451** Read a 32-bit integer from the given file descriptor. Store the integer
452** that is read in *pRes. Return SQLITE_OK if everything worked, or an
453** error code is something goes wrong.
drh726de592004-06-10 23:35:50 +0000454**
455** All values are stored on disk as big-endian.
drh94f33312002-08-12 12:29:56 +0000456*/
drhae2b40c2004-06-09 19:03:54 +0000457static int read32bits(OsFile *fd, u32 *pRes){
drh3b59a5c2006-01-15 20:28:28 +0000458 unsigned char ac[4];
459 int rc = sqlite3OsRead(fd, ac, sizeof(ac));
drhae2b40c2004-06-09 19:03:54 +0000460 if( rc==SQLITE_OK ){
drh3b59a5c2006-01-15 20:28:28 +0000461 *pRes = (ac[0]<<24) | (ac[1]<<16) | (ac[2]<<8) | ac[3];
drh94f33312002-08-12 12:29:56 +0000462 }
drh94f33312002-08-12 12:29:56 +0000463 return rc;
464}
465
466/*
drh97b57482006-01-10 20:32:32 +0000467** Write a 32-bit integer into a string buffer in big-endian byte order.
468*/
469static void put32bits(char *ac, u32 val){
470 ac[0] = (val>>24) & 0xff;
471 ac[1] = (val>>16) & 0xff;
472 ac[2] = (val>>8) & 0xff;
473 ac[3] = val & 0xff;
474}
475
476/*
drh34e79ce2004-02-08 06:05:46 +0000477** Write a 32-bit integer into the given file descriptor. Return SQLITE_OK
478** on success or an error code is something goes wrong.
drh94f33312002-08-12 12:29:56 +0000479*/
480static int write32bits(OsFile *fd, u32 val){
danielk1977bab45c62006-01-16 15:14:27 +0000481 char ac[4];
drh97b57482006-01-10 20:32:32 +0000482 put32bits(ac, val);
drh054889e2005-11-30 03:20:31 +0000483 return sqlite3OsWrite(fd, ac, 4);
drh94f33312002-08-12 12:29:56 +0000484}
485
drh2554f8b2003-01-22 01:26:44 +0000486/*
danielk1977aa5ccdf2004-06-14 05:10:42 +0000487** Read a 32-bit integer at offset 'offset' from the page identified by
488** page header 'p'.
489*/
490static u32 retrieve32bits(PgHdr *p, int offset){
491 unsigned char *ac;
492 ac = &((unsigned char*)PGHDR_TO_DATA(p))[offset];
493 return (ac[0]<<24) | (ac[1]<<16) | (ac[2]<<8) | ac[3];
494}
495
drh94f33312002-08-12 12:29:56 +0000496
497/*
danielk1977aef0bf62005-12-30 16:28:01 +0000498** This function should be called when an error occurs within the pager
danielk1977a96a7102006-01-16 12:46:41 +0000499** code. The first argument is a pointer to the pager structure, the
500** second the error-code about to be returned by a pager API function.
501** The value returned is a copy of the second argument to this function.
502**
drh4f0ee682007-03-30 20:43:40 +0000503** If the second argument is SQLITE_IOERR, SQLITE_CORRUPT, or SQLITE_FULL
danielk1977a96a7102006-01-16 12:46:41 +0000504** the error becomes persistent. All subsequent API calls on this Pager
505** will immediately return the same error code.
danielk1977aef0bf62005-12-30 16:28:01 +0000506*/
507static int pager_error(Pager *pPager, int rc){
drh4ac285a2006-09-15 07:28:50 +0000508 int rc2 = rc & 0xff;
danielk1977efaaf572006-01-16 11:29:19 +0000509 assert( pPager->errCode==SQLITE_FULL || pPager->errCode==SQLITE_OK );
danielk1977979f38e2007-03-27 16:19:51 +0000510 if(
drh4ac285a2006-09-15 07:28:50 +0000511 rc2==SQLITE_FULL ||
512 rc2==SQLITE_IOERR ||
drh4f0ee682007-03-30 20:43:40 +0000513 rc2==SQLITE_CORRUPT
danielk1977efaaf572006-01-16 11:29:19 +0000514 ){
515 pPager->errCode = rc;
danielk1977aef0bf62005-12-30 16:28:01 +0000516 }
517 return rc;
518}
519
danielk19773c407372005-02-15 02:54:14 +0000520#ifdef SQLITE_CHECK_PAGES
521/*
522** Return a 32-bit hash of the page data for pPage.
523*/
524static u32 pager_pagehash(PgHdr *pPage){
525 u32 hash = 0;
526 int i;
527 unsigned char *pData = (unsigned char *)PGHDR_TO_DATA(pPage);
528 for(i=0; i<pPage->pPager->pageSize; i++){
529 hash = (hash+i)^pData[i];
530 }
531 return hash;
532}
533
534/*
535** The CHECK_PAGE macro takes a PgHdr* as an argument. If SQLITE_CHECK_PAGES
536** is defined, and NDEBUG is not defined, an assert() statement checks
537** that the page is either dirty or still matches the calculated page-hash.
538*/
539#define CHECK_PAGE(x) checkPage(x)
540static void checkPage(PgHdr *pPg){
541 Pager *pPager = pPg->pPager;
danielk1977efaaf572006-01-16 11:29:19 +0000542 assert( !pPg->pageHash || pPager->errCode || MEMDB || pPg->dirty ||
danielk19773c407372005-02-15 02:54:14 +0000543 pPg->pageHash==pager_pagehash(pPg) );
544}
545
546#else
547#define CHECK_PAGE(x)
548#endif
549
drhed7c8552001-04-11 14:29:21 +0000550/*
danielk197776572402004-06-25 02:38:54 +0000551** When this is called the journal file for pager pPager must be open.
552** The master journal file name is read from the end of the file and
553** written into memory obtained from sqliteMalloc(). *pzMaster is
554** set to point at the memory and SQLITE_OK returned. The caller must
555** sqliteFree() *pzMaster.
556**
557** If no master journal file name is present *pzMaster is set to 0 and
558** SQLITE_OK returned.
559*/
560static int readMasterJournal(OsFile *pJrnl, char **pzMaster){
561 int rc;
562 u32 len;
drheb206252004-10-01 02:00:31 +0000563 i64 szJ;
danielk1977c3e8f5e2004-06-28 01:16:46 +0000564 u32 cksum;
danielk1977cafadba2004-06-25 11:11:54 +0000565 int i;
danielk197776572402004-06-25 02:38:54 +0000566 unsigned char aMagic[8]; /* A buffer to hold the magic header */
567
568 *pzMaster = 0;
569
drh054889e2005-11-30 03:20:31 +0000570 rc = sqlite3OsFileSize(pJrnl, &szJ);
danielk1977cafadba2004-06-25 11:11:54 +0000571 if( rc!=SQLITE_OK || szJ<16 ) return rc;
danielk197776572402004-06-25 02:38:54 +0000572
drh054889e2005-11-30 03:20:31 +0000573 rc = sqlite3OsSeek(pJrnl, szJ-16);
danielk197776572402004-06-25 02:38:54 +0000574 if( rc!=SQLITE_OK ) return rc;
575
576 rc = read32bits(pJrnl, &len);
577 if( rc!=SQLITE_OK ) return rc;
578
danielk1977cafadba2004-06-25 11:11:54 +0000579 rc = read32bits(pJrnl, &cksum);
580 if( rc!=SQLITE_OK ) return rc;
581
drh054889e2005-11-30 03:20:31 +0000582 rc = sqlite3OsRead(pJrnl, aMagic, 8);
danielk197776572402004-06-25 02:38:54 +0000583 if( rc!=SQLITE_OK || memcmp(aMagic, aJournalMagic, 8) ) return rc;
584
drh054889e2005-11-30 03:20:31 +0000585 rc = sqlite3OsSeek(pJrnl, szJ-16-len);
danielk197776572402004-06-25 02:38:54 +0000586 if( rc!=SQLITE_OK ) return rc;
587
danielk19778191bff2004-06-28 04:52:30 +0000588 *pzMaster = (char *)sqliteMalloc(len+1);
danielk197776572402004-06-25 02:38:54 +0000589 if( !*pzMaster ){
590 return SQLITE_NOMEM;
591 }
drh054889e2005-11-30 03:20:31 +0000592 rc = sqlite3OsRead(pJrnl, *pzMaster, len);
danielk197776572402004-06-25 02:38:54 +0000593 if( rc!=SQLITE_OK ){
594 sqliteFree(*pzMaster);
595 *pzMaster = 0;
596 return rc;
597 }
danielk1977cafadba2004-06-25 11:11:54 +0000598
599 /* See if the checksum matches the master journal name */
600 for(i=0; i<len; i++){
danielk19778191bff2004-06-28 04:52:30 +0000601 cksum -= (*pzMaster)[i];
danielk1977cafadba2004-06-25 11:11:54 +0000602 }
danielk19778191bff2004-06-28 04:52:30 +0000603 if( cksum ){
604 /* If the checksum doesn't add up, then one or more of the disk sectors
605 ** containing the master journal filename is corrupted. This means
606 ** definitely roll back, so just return SQLITE_OK and report a (nul)
607 ** master-journal filename.
608 */
danielk1977cafadba2004-06-25 11:11:54 +0000609 sqliteFree(*pzMaster);
610 *pzMaster = 0;
danielk1977aca790a2005-01-13 11:07:52 +0000611 }else{
612 (*pzMaster)[len] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000613 }
danielk197776572402004-06-25 02:38:54 +0000614
615 return SQLITE_OK;
616}
617
618/*
619** Seek the journal file descriptor to the next sector boundary where a
620** journal header may be read or written. Pager.journalOff is updated with
621** the new seek offset.
622**
623** i.e for a sector size of 512:
624**
625** Input Offset Output Offset
626** ---------------------------------------
627** 0 0
628** 512 512
629** 100 512
630** 2000 2048
631**
632*/
633static int seekJournalHdr(Pager *pPager){
drheb206252004-10-01 02:00:31 +0000634 i64 offset = 0;
635 i64 c = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000636 if( c ){
637 offset = ((c-1)/JOURNAL_HDR_SZ(pPager) + 1) * JOURNAL_HDR_SZ(pPager);
638 }
639 assert( offset%JOURNAL_HDR_SZ(pPager)==0 );
640 assert( offset>=c );
641 assert( (offset-c)<JOURNAL_HDR_SZ(pPager) );
642 pPager->journalOff = offset;
drh054889e2005-11-30 03:20:31 +0000643 return sqlite3OsSeek(pPager->jfd, pPager->journalOff);
danielk197776572402004-06-25 02:38:54 +0000644}
645
646/*
647** The journal file must be open when this routine is called. A journal
648** header (JOURNAL_HDR_SZ bytes) is written into the journal file at the
649** current location.
650**
651** The format for the journal header is as follows:
652** - 8 bytes: Magic identifying journal format.
653** - 4 bytes: Number of records in journal, or -1 no-sync mode is on.
654** - 4 bytes: Random number used for page hash.
655** - 4 bytes: Initial database page count.
656** - 4 bytes: Sector size used by the process that wrote this journal.
657**
danielk1977f42f25c2004-06-25 07:21:28 +0000658** Followed by (JOURNAL_HDR_SZ - 24) bytes of unused space.
danielk197776572402004-06-25 02:38:54 +0000659*/
660static int writeJournalHdr(Pager *pPager){
drh97b57482006-01-10 20:32:32 +0000661 char zHeader[sizeof(aJournalMagic)+16];
danielk19774099f6e2007-03-19 11:25:20 +0000662 int rc;
danielk197776572402004-06-25 02:38:54 +0000663
danielk19774099f6e2007-03-19 11:25:20 +0000664 if( pPager->stmtHdrOff==0 ){
665 pPager->stmtHdrOff = pPager->journalOff;
666 }
667
668 rc = seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +0000669 if( rc ) return rc;
670
671 pPager->journalHdr = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000672 pPager->journalOff += JOURNAL_HDR_SZ(pPager);
673
674 /* FIX ME:
675 **
676 ** Possibly for a pager not in no-sync mode, the journal magic should not
677 ** be written until nRec is filled in as part of next syncJournal().
678 **
679 ** Actually maybe the whole journal header should be delayed until that
680 ** point. Think about this.
681 */
drh97b57482006-01-10 20:32:32 +0000682 memcpy(zHeader, aJournalMagic, sizeof(aJournalMagic));
683 /* The nRec Field. 0xFFFFFFFF for no-sync journals. */
684 put32bits(&zHeader[sizeof(aJournalMagic)], pPager->noSync ? 0xffffffff : 0);
685 /* The random check-hash initialiser */
686 sqlite3Randomness(sizeof(pPager->cksumInit), &pPager->cksumInit);
687 put32bits(&zHeader[sizeof(aJournalMagic)+4], pPager->cksumInit);
688 /* The initial database size */
689 put32bits(&zHeader[sizeof(aJournalMagic)+8], pPager->dbSize);
690 /* The assumed sector size for this process */
691 put32bits(&zHeader[sizeof(aJournalMagic)+12], pPager->sectorSize);
drhb0603412007-02-28 04:47:26 +0000692 IOTRACE(("JHDR %p %lld %d\n", pPager, pPager->journalHdr, sizeof(zHeader)))
drh97b57482006-01-10 20:32:32 +0000693 rc = sqlite3OsWrite(pPager->jfd, zHeader, sizeof(zHeader));
danielk197776572402004-06-25 02:38:54 +0000694
695 /* The journal header has been written successfully. Seek the journal
696 ** file descriptor to the end of the journal header sector.
697 */
698 if( rc==SQLITE_OK ){
drhb0603412007-02-28 04:47:26 +0000699 IOTRACE(("JTAIL %p %lld\n", pPager, pPager->journalOff-1))
drh054889e2005-11-30 03:20:31 +0000700 rc = sqlite3OsSeek(pPager->jfd, pPager->journalOff-1);
drhb4746b92005-09-09 01:32:06 +0000701 if( rc==SQLITE_OK ){
drh054889e2005-11-30 03:20:31 +0000702 rc = sqlite3OsWrite(pPager->jfd, "\000", 1);
drhb4746b92005-09-09 01:32:06 +0000703 }
danielk197776572402004-06-25 02:38:54 +0000704 }
705 return rc;
706}
707
708/*
709** The journal file must be open when this is called. A journal header file
710** (JOURNAL_HDR_SZ bytes) is read from the current location in the journal
711** file. See comments above function writeJournalHdr() for a description of
712** the journal header format.
713**
714** If the header is read successfully, *nRec is set to the number of
715** page records following this header and *dbSize is set to the size of the
716** database before the transaction began, in pages. Also, pPager->cksumInit
717** is set to the value read from the journal header. SQLITE_OK is returned
718** in this case.
719**
720** If the journal header file appears to be corrupted, SQLITE_DONE is
721** returned and *nRec and *dbSize are not set. If JOURNAL_HDR_SZ bytes
722** cannot be read from the journal file an error code is returned.
723*/
724static int readJournalHdr(
725 Pager *pPager,
drheb206252004-10-01 02:00:31 +0000726 i64 journalSize,
danielk197776572402004-06-25 02:38:54 +0000727 u32 *pNRec,
728 u32 *pDbSize
729){
730 int rc;
731 unsigned char aMagic[8]; /* A buffer to hold the magic header */
732
733 rc = seekJournalHdr(pPager);
734 if( rc ) return rc;
735
736 if( pPager->journalOff+JOURNAL_HDR_SZ(pPager) > journalSize ){
737 return SQLITE_DONE;
738 }
739
drh054889e2005-11-30 03:20:31 +0000740 rc = sqlite3OsRead(pPager->jfd, aMagic, sizeof(aMagic));
danielk197776572402004-06-25 02:38:54 +0000741 if( rc ) return rc;
742
743 if( memcmp(aMagic, aJournalMagic, sizeof(aMagic))!=0 ){
744 return SQLITE_DONE;
745 }
746
drh9cbe6352005-11-29 03:13:21 +0000747 rc = read32bits(pPager->jfd, pNRec);
danielk197776572402004-06-25 02:38:54 +0000748 if( rc ) return rc;
749
drh9cbe6352005-11-29 03:13:21 +0000750 rc = read32bits(pPager->jfd, &pPager->cksumInit);
danielk197776572402004-06-25 02:38:54 +0000751 if( rc ) return rc;
752
drh9cbe6352005-11-29 03:13:21 +0000753 rc = read32bits(pPager->jfd, pDbSize);
danielk197776572402004-06-25 02:38:54 +0000754 if( rc ) return rc;
755
756 /* Update the assumed sector-size to match the value used by
757 ** the process that created this journal. If this journal was
758 ** created by a process other than this one, then this routine
759 ** is being called from within pager_playback(). The local value
760 ** of Pager.sectorSize is restored at the end of that routine.
761 */
drh9cbe6352005-11-29 03:13:21 +0000762 rc = read32bits(pPager->jfd, (u32 *)&pPager->sectorSize);
danielk197776572402004-06-25 02:38:54 +0000763 if( rc ) return rc;
764
765 pPager->journalOff += JOURNAL_HDR_SZ(pPager);
drh054889e2005-11-30 03:20:31 +0000766 rc = sqlite3OsSeek(pPager->jfd, pPager->journalOff);
danielk197776572402004-06-25 02:38:54 +0000767 return rc;
768}
769
770
771/*
772** Write the supplied master journal name into the journal file for pager
danielk1977cafadba2004-06-25 11:11:54 +0000773** pPager at the current location. The master journal name must be the last
774** thing written to a journal file. If the pager is in full-sync mode, the
775** journal file descriptor is advanced to the next sector boundary before
776** anything is written. The format is:
777**
778** + 4 bytes: PAGER_MJ_PGNO.
779** + N bytes: length of master journal name.
780** + 4 bytes: N
781** + 4 bytes: Master journal name checksum.
782** + 8 bytes: aJournalMagic[].
783**
784** The master journal page checksum is the sum of the bytes in the master
785** journal name.
danielk1977aef0bf62005-12-30 16:28:01 +0000786**
787** If zMaster is a NULL pointer (occurs for a single database transaction),
788** this call is a no-op.
danielk197776572402004-06-25 02:38:54 +0000789*/
790static int writeMasterJournal(Pager *pPager, const char *zMaster){
791 int rc;
792 int len;
danielk1977cafadba2004-06-25 11:11:54 +0000793 int i;
drh97b57482006-01-10 20:32:32 +0000794 u32 cksum = 0;
795 char zBuf[sizeof(aJournalMagic)+2*4];
danielk197776572402004-06-25 02:38:54 +0000796
797 if( !zMaster || pPager->setMaster) return SQLITE_OK;
798 pPager->setMaster = 1;
799
800 len = strlen(zMaster);
danielk1977cafadba2004-06-25 11:11:54 +0000801 for(i=0; i<len; i++){
802 cksum += zMaster[i];
803 }
danielk197776572402004-06-25 02:38:54 +0000804
805 /* If in full-sync mode, advance to the next disk sector before writing
806 ** the master journal name. This is in case the previous page written to
807 ** the journal has already been synced.
808 */
809 if( pPager->fullSync ){
810 rc = seekJournalHdr(pPager);
811 if( rc!=SQLITE_OK ) return rc;
812 }
danielk1977cafadba2004-06-25 11:11:54 +0000813 pPager->journalOff += (len+20);
danielk197776572402004-06-25 02:38:54 +0000814
drh9cbe6352005-11-29 03:13:21 +0000815 rc = write32bits(pPager->jfd, PAGER_MJ_PGNO(pPager));
danielk197776572402004-06-25 02:38:54 +0000816 if( rc!=SQLITE_OK ) return rc;
817
drh054889e2005-11-30 03:20:31 +0000818 rc = sqlite3OsWrite(pPager->jfd, zMaster, len);
danielk197776572402004-06-25 02:38:54 +0000819 if( rc!=SQLITE_OK ) return rc;
820
drh97b57482006-01-10 20:32:32 +0000821 put32bits(zBuf, len);
822 put32bits(&zBuf[4], cksum);
823 memcpy(&zBuf[8], aJournalMagic, sizeof(aJournalMagic));
824 rc = sqlite3OsWrite(pPager->jfd, zBuf, 8+sizeof(aJournalMagic));
drh2c8997b2005-08-27 16:36:48 +0000825 pPager->needSync = !pPager->noSync;
danielk197776572402004-06-25 02:38:54 +0000826 return rc;
827}
828
829/*
drh03eb96a2002-11-10 23:32:56 +0000830** Add or remove a page from the list of all pages that are in the
drhac69b052004-05-12 13:30:07 +0000831** statement journal.
drh03eb96a2002-11-10 23:32:56 +0000832**
833** The Pager keeps a separate list of pages that are currently in
danielk19773b8a05f2007-03-19 17:44:26 +0000834** the statement journal. This helps the sqlite3PagerStmtCommit()
drh03eb96a2002-11-10 23:32:56 +0000835** routine run MUCH faster for the common case where there are many
drhac69b052004-05-12 13:30:07 +0000836** pages in memory but only a few are in the statement journal.
drh03eb96a2002-11-10 23:32:56 +0000837*/
drh3aac2dd2004-04-26 14:10:20 +0000838static void page_add_to_stmt_list(PgHdr *pPg){
drh03eb96a2002-11-10 23:32:56 +0000839 Pager *pPager = pPg->pPager;
danielk1977f35843b2007-04-07 15:03:17 +0000840 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
841 assert( MEMDB );
842 if( !pHist->inStmt ){
843 assert( pHist->pPrevStmt==0 && pHist->pNextStmt==0 );
844 if( pPager->pStmt ){
845 PGHDR_TO_HIST(pPager->pStmt, pPager)->pPrevStmt = pPg;
846 }
847 pHist->pNextStmt = pPager->pStmt;
848 pPager->pStmt = pPg;
849 pHist->inStmt = 1;
drh03eb96a2002-11-10 23:32:56 +0000850 }
drh03eb96a2002-11-10 23:32:56 +0000851}
852
853/*
drhed7c8552001-04-11 14:29:21 +0000854** Find a page in the hash table given its page number. Return
855** a pointer to the page or NULL if not found.
856*/
drhd9b02572001-04-15 00:37:09 +0000857static PgHdr *pager_lookup(Pager *pPager, Pgno pgno){
drh8ca0c722006-05-07 17:49:38 +0000858 PgHdr *p;
859 if( pPager->aHash==0 ) return 0;
860 p = pPager->aHash[pgno & (pPager->nHash-1)];
drhed7c8552001-04-11 14:29:21 +0000861 while( p && p->pgno!=pgno ){
862 p = p->pNextHash;
863 }
864 return p;
865}
866
867/*
drh1aa2d8b2007-01-03 15:34:29 +0000868** Unlock the database file.
drh1aa2d8b2007-01-03 15:34:29 +0000869*/
870static void pager_unlock(Pager *pPager){
danielk197741483462007-03-24 16:45:04 +0000871 if( !pPager->exclusiveMode ){
872 if( !MEMDB ){
873 sqlite3OsUnlock(pPager->fd, NO_LOCK);
874 pPager->dbSize = -1;
875 IOTRACE(("UNLOCK %p\n", pPager))
876 }
877 pPager->state = PAGER_UNLOCK;
878 pPager->changeCountDone = 0;
drh1aa2d8b2007-01-03 15:34:29 +0000879 }
danielk1977e277be02007-03-23 18:12:06 +0000880}
881
882/*
883** Execute a rollback if a transaction is active and unlock the
884** database file. This is a no-op if the pager has already entered
885** the error-state.
886*/
danielk1977334cdb62007-03-26 08:05:12 +0000887static void pagerUnlockAndRollback(Pager *p){
888 if( p->errCode ) return;
danielk1977c5859712007-03-26 12:26:27 +0000889 assert( p->state>=PAGER_RESERVED || p->journalOpen==0 );
danielk1977334cdb62007-03-26 08:05:12 +0000890 if( p->state>=PAGER_RESERVED ){
891 sqlite3PagerRollback(p);
danielk1977e277be02007-03-23 18:12:06 +0000892 }
danielk1977334cdb62007-03-26 08:05:12 +0000893 pager_unlock(p);
894 assert( p->errCode || !p->journalOpen || (p->exclusiveMode&&!p->journalOff) );
895 assert( p->errCode || !p->stmtOpen || p->exclusiveMode );
drh1aa2d8b2007-01-03 15:34:29 +0000896}
897
898
899/*
danielk1977e180dd92007-04-05 17:15:52 +0000900** Clear the in-memory cache. This routine
drhed7c8552001-04-11 14:29:21 +0000901** sets the state of the pager back to what it was when it was first
902** opened. Any outstanding pages are invalidated and subsequent attempts
903** to access those pages will likely result in a coredump.
904*/
drhd9b02572001-04-15 00:37:09 +0000905static void pager_reset(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +0000906 PgHdr *pPg, *pNext;
danielk1977efaaf572006-01-16 11:29:19 +0000907 if( pPager->errCode ) return;
drhd9b02572001-04-15 00:37:09 +0000908 for(pPg=pPager->pAll; pPg; pPg=pNext){
drh538f5702007-04-13 02:14:30 +0000909 IOTRACE(("PGFREE %p %d\n", pPager, pPg->pgno));
910 PAGER_INCR(sqlite3_pager_pgfree_count);
drhd9b02572001-04-15 00:37:09 +0000911 pNext = pPg->pNextAll;
912 sqliteFree(pPg);
drhed7c8552001-04-11 14:29:21 +0000913 }
danielk1977b94bf852007-03-19 13:53:37 +0000914 pPager->pStmt = 0;
drhed7c8552001-04-11 14:29:21 +0000915 pPager->pFirst = 0;
drh341eae82003-01-21 02:39:36 +0000916 pPager->pFirstSynced = 0;
drhd9b02572001-04-15 00:37:09 +0000917 pPager->pLast = 0;
918 pPager->pAll = 0;
drh8ca0c722006-05-07 17:49:38 +0000919 pPager->nHash = 0;
920 sqliteFree(pPager->aHash);
drhed7c8552001-04-11 14:29:21 +0000921 pPager->nPage = 0;
drh8ca0c722006-05-07 17:49:38 +0000922 pPager->aHash = 0;
drhed7c8552001-04-11 14:29:21 +0000923 pPager->nRef = 0;
danielk1977e277be02007-03-23 18:12:06 +0000924}
925
926/*
drh80e35f42007-03-30 14:06:34 +0000927** This routine ends a transaction. A transaction is ended by either
928** a COMMIT or a ROLLBACK.
929**
drhed7c8552001-04-11 14:29:21 +0000930** When this routine is called, the pager has the journal file open and
drh80e35f42007-03-30 14:06:34 +0000931** a RESERVED or EXCLUSIVE lock on the database. This routine will release
932** the database lock and acquires a SHARED lock in its place if that is
933** the appropriate thing to do. Release locks usually is appropriate,
934** unless we are in exclusive access mode or unless this is a
935** COMMIT AND BEGIN or ROLLBACK AND BEGIN operation.
936**
937** The journal file is either deleted or truncated.
drh50457892003-09-06 01:10:47 +0000938**
939** TODO: Consider keeping the journal file open for temporary databases.
940** This might give a performance improvement on windows where opening
941** a file is an expensive operation.
drhed7c8552001-04-11 14:29:21 +0000942*/
drh80e35f42007-03-30 14:06:34 +0000943static int pager_end_transaction(Pager *pPager){
drhd9b02572001-04-15 00:37:09 +0000944 PgHdr *pPg;
danielk197741483462007-03-24 16:45:04 +0000945 int rc = SQLITE_OK;
danielk1977979f38e2007-03-27 16:19:51 +0000946 int rc2 = SQLITE_OK;
drhb7f91642004-10-31 02:22:47 +0000947 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +0000948 if( pPager->state<PAGER_RESERVED ){
949 return SQLITE_OK;
950 }
danielk19773b8a05f2007-03-19 17:44:26 +0000951 sqlite3PagerStmtCommit(pPager);
danielk1977334cdb62007-03-26 08:05:12 +0000952 if( pPager->stmtOpen && !pPager->exclusiveMode ){
danielk1977979f38e2007-03-27 16:19:51 +0000953 sqlite3OsClose(&pPager->stfd);
954 pPager->stmtOpen = 0;
drh0f892532002-05-30 12:27:03 +0000955 }
drhda47d772002-12-02 04:25:19 +0000956 if( pPager->journalOpen ){
drh01fa4c32007-04-02 11:22:22 +0000957 if( pPager->exclusiveMode
958 && (rc = sqlite3OsTruncate(pPager->jfd, 0))==SQLITE_OK ){;
danielk197741483462007-03-24 16:45:04 +0000959 sqlite3OsSeek(pPager->jfd, 0);
960 pPager->journalOff = 0;
danielk1977334cdb62007-03-26 08:05:12 +0000961 pPager->journalStarted = 0;
danielk197741483462007-03-24 16:45:04 +0000962 }else{
963 sqlite3OsClose(&pPager->jfd);
964 pPager->journalOpen = 0;
drh01fa4c32007-04-02 11:22:22 +0000965 if( rc==SQLITE_OK ){
danielk19777152de82007-03-29 17:28:14 +0000966 rc = sqlite3OsDelete(pPager->zJournal);
967 }
danielk197741483462007-03-24 16:45:04 +0000968 }
drhda47d772002-12-02 04:25:19 +0000969 sqliteFree( pPager->aInJournal );
970 pPager->aInJournal = 0;
971 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
972 pPg->inJournal = 0;
973 pPg->dirty = 0;
drhdb48ee02003-01-16 13:42:43 +0000974 pPg->needSync = 0;
danielk197741483462007-03-24 16:45:04 +0000975 pPg->alwaysRollback = 0;
danielk19773c407372005-02-15 02:54:14 +0000976#ifdef SQLITE_CHECK_PAGES
977 pPg->pageHash = pager_pagehash(pPg);
978#endif
drhda47d772002-12-02 04:25:19 +0000979 }
drh605ad8f2006-05-03 23:34:05 +0000980 pPager->pDirty = 0;
danielk1977ef317ab2004-06-23 10:43:10 +0000981 pPager->dirtyCache = 0;
danielk1977ef317ab2004-06-23 10:43:10 +0000982 pPager->nRec = 0;
drhda47d772002-12-02 04:25:19 +0000983 }else{
drh88b01a12005-03-28 18:04:27 +0000984 assert( pPager->aInJournal==0 );
drha6abd042004-06-09 17:37:22 +0000985 assert( pPager->dirtyCache==0 || pPager->useJournal==0 );
drhd9b02572001-04-15 00:37:09 +0000986 }
danielk1977979f38e2007-03-27 16:19:51 +0000987
danielk197741483462007-03-24 16:45:04 +0000988 if( !pPager->exclusiveMode ){
danielk1977979f38e2007-03-27 16:19:51 +0000989 rc2 = sqlite3OsUnlock(pPager->fd, SHARED_LOCK);
danielk197741483462007-03-24 16:45:04 +0000990 pPager->state = PAGER_SHARED;
danielk1977334cdb62007-03-26 08:05:12 +0000991 }else if( pPager->state==PAGER_SYNCED ){
992 pPager->state = PAGER_EXCLUSIVE;
danielk197741483462007-03-24 16:45:04 +0000993 }
danielk1977334cdb62007-03-26 08:05:12 +0000994 pPager->origDbSize = 0;
danielk197776572402004-06-25 02:38:54 +0000995 pPager->setMaster = 0;
danielk1977c4da5b92006-01-21 12:08:54 +0000996 pPager->needSync = 0;
997 pPager->pFirstSynced = pPager->pFirst;
drh588f5bc2007-01-02 18:41:54 +0000998 pPager->dbSize = -1;
danielk1977979f38e2007-03-27 16:19:51 +0000999
1000 return (rc==SQLITE_OK?rc2:rc);
drhed7c8552001-04-11 14:29:21 +00001001}
1002
drhed7c8552001-04-11 14:29:21 +00001003/*
drh968af522003-02-11 14:55:40 +00001004** Compute and return a checksum for the page of data.
drh34e79ce2004-02-08 06:05:46 +00001005**
1006** This is not a real checksum. It is really just the sum of the
drh726de592004-06-10 23:35:50 +00001007** random initial value and the page number. We experimented with
1008** a checksum of the entire data, but that was found to be too slow.
1009**
1010** Note that the page number is stored at the beginning of data and
1011** the checksum is stored at the end. This is important. If journal
1012** corruption occurs due to a power failure, the most likely scenario
1013** is that one end or the other of the record will be changed. It is
1014** much less likely that the two ends of the journal record will be
1015** correct and the middle be corrupt. Thus, this "checksum" scheme,
1016** though fast and simple, catches the mostly likely kind of corruption.
1017**
1018** FIX ME: Consider adding every 200th (or so) byte of the data to the
1019** checksum. That way if a single page spans 3 or more disk sectors and
1020** only the middle sector is corrupt, we will still have a reasonable
1021** chance of failing the checksum and thus detecting the problem.
drh968af522003-02-11 14:55:40 +00001022*/
drh74161702006-02-24 02:53:49 +00001023static u32 pager_cksum(Pager *pPager, const u8 *aData){
danielk1977ef317ab2004-06-23 10:43:10 +00001024 u32 cksum = pPager->cksumInit;
1025 int i = pPager->pageSize-200;
1026 while( i>0 ){
1027 cksum += aData[i];
1028 i -= 200;
1029 }
drh968af522003-02-11 14:55:40 +00001030 return cksum;
1031}
1032
drh605ad8f2006-05-03 23:34:05 +00001033/* Forward declaration */
1034static void makeClean(PgHdr*);
1035
drh968af522003-02-11 14:55:40 +00001036/*
drhfa86c412002-02-02 15:01:15 +00001037** Read a single page from the journal file opened on file descriptor
1038** jfd. Playback this one page.
drh968af522003-02-11 14:55:40 +00001039**
drh726de592004-06-10 23:35:50 +00001040** If useCksum==0 it means this journal does not use checksums. Checksums
1041** are not used in statement journals because statement journals do not
1042** need to survive power failures.
drhfa86c412002-02-02 15:01:15 +00001043*/
drhae2b40c2004-06-09 19:03:54 +00001044static int pager_playback_one_page(Pager *pPager, OsFile *jfd, int useCksum){
drhfa86c412002-02-02 15:01:15 +00001045 int rc;
drhae2b40c2004-06-09 19:03:54 +00001046 PgHdr *pPg; /* An existing page in the cache */
1047 Pgno pgno; /* The page number of a page in journal */
1048 u32 cksum; /* Checksum used for sanity checking */
danielk19778186df82007-03-06 13:45:59 +00001049 u8 *aData = (u8 *)pPager->pTmpSpace; /* Temp storage for a page */
drhfa86c412002-02-02 15:01:15 +00001050
drh96362842005-03-20 22:47:56 +00001051 /* useCksum should be true for the main journal and false for
1052 ** statement journals. Verify that this is always the case
1053 */
drh9cbe6352005-11-29 03:13:21 +00001054 assert( jfd == (useCksum ? pPager->jfd : pPager->stfd) );
danielk19778186df82007-03-06 13:45:59 +00001055 assert( aData );
drh96362842005-03-20 22:47:56 +00001056
drhae2b40c2004-06-09 19:03:54 +00001057 rc = read32bits(jfd, &pgno);
drh99ee3602003-02-16 19:13:36 +00001058 if( rc!=SQLITE_OK ) return rc;
danielk19778186df82007-03-06 13:45:59 +00001059 rc = sqlite3OsRead(jfd, aData, pPager->pageSize);
drh99ee3602003-02-16 19:13:36 +00001060 if( rc!=SQLITE_OK ) return rc;
danielk197776572402004-06-25 02:38:54 +00001061 pPager->journalOff += pPager->pageSize + 4;
drhfa86c412002-02-02 15:01:15 +00001062
drh968af522003-02-11 14:55:40 +00001063 /* Sanity checking on the page. This is more important that I originally
1064 ** thought. If a power failure occurs while the journal is being written,
1065 ** it could cause invalid data to be written into the journal. We need to
1066 ** detect this invalid data (with high probability) and ignore it.
1067 */
danielk197775edc162004-06-26 01:48:18 +00001068 if( pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh968af522003-02-11 14:55:40 +00001069 return SQLITE_DONE;
1070 }
drhae2b40c2004-06-09 19:03:54 +00001071 if( pgno>(unsigned)pPager->dbSize ){
drh968af522003-02-11 14:55:40 +00001072 return SQLITE_OK;
1073 }
drhae2b40c2004-06-09 19:03:54 +00001074 if( useCksum ){
1075 rc = read32bits(jfd, &cksum);
drh99ee3602003-02-16 19:13:36 +00001076 if( rc ) return rc;
danielk197776572402004-06-25 02:38:54 +00001077 pPager->journalOff += 4;
drh74161702006-02-24 02:53:49 +00001078 if( pager_cksum(pPager, aData)!=cksum ){
drh968af522003-02-11 14:55:40 +00001079 return SQLITE_DONE;
1080 }
1081 }
drhfa86c412002-02-02 15:01:15 +00001082
danielk1977aa5ccdf2004-06-14 05:10:42 +00001083 assert( pPager->state==PAGER_RESERVED || pPager->state>=PAGER_EXCLUSIVE );
danielk1977a3f3a5f2004-06-10 04:32:16 +00001084
1085 /* If the pager is in RESERVED state, then there must be a copy of this
1086 ** page in the pager cache. In this case just update the pager cache,
danielk19770de0bb32004-06-10 05:59:24 +00001087 ** not the database file. The page is left marked dirty in this case.
1088 **
danielk1977a3f3a5f2004-06-10 04:32:16 +00001089 ** If in EXCLUSIVE state, then we update the pager cache if it exists
1090 ** and the main file. The page is then marked not dirty.
drh96362842005-03-20 22:47:56 +00001091 **
1092 ** Ticket #1171: The statement journal might contain page content that is
1093 ** different from the page content at the start of the transaction.
1094 ** This occurs when a page is changed prior to the start of a statement
1095 ** then changed again within the statement. When rolling back such a
1096 ** statement we must not write to the original database unless we know
1097 ** for certain that original page contents are in the main rollback
1098 ** journal. Otherwise, if a full ROLLBACK occurs after the statement
1099 ** rollback the full ROLLBACK will not restore the page to its original
1100 ** content. Two conditions must be met before writing to the database
1101 ** files. (1) the database must be locked. (2) we know that the original
1102 ** page content is in the main journal either because the page is not in
1103 ** cache or else it is marked as needSync==0.
drhfa86c412002-02-02 15:01:15 +00001104 */
drhae2b40c2004-06-09 19:03:54 +00001105 pPg = pager_lookup(pPager, pgno);
drh96362842005-03-20 22:47:56 +00001106 assert( pPager->state>=PAGER_EXCLUSIVE || pPg!=0 );
drh4f0c5872007-03-26 22:05:01 +00001107 PAGERTRACE3("PLAYBACK %d page %d\n", PAGERID(pPager), pgno);
drh96362842005-03-20 22:47:56 +00001108 if( pPager->state>=PAGER_EXCLUSIVE && (pPg==0 || pPg->needSync==0) ){
drh054889e2005-11-30 03:20:31 +00001109 rc = sqlite3OsSeek(pPager->fd, (pgno-1)*(i64)pPager->pageSize);
drhb4746b92005-09-09 01:32:06 +00001110 if( rc==SQLITE_OK ){
drh054889e2005-11-30 03:20:31 +00001111 rc = sqlite3OsWrite(pPager->fd, aData, pPager->pageSize);
drhb4746b92005-09-09 01:32:06 +00001112 }
drh605ad8f2006-05-03 23:34:05 +00001113 if( pPg ){
1114 makeClean(pPg);
1115 }
danielk1977a3f3a5f2004-06-10 04:32:16 +00001116 }
drhfa86c412002-02-02 15:01:15 +00001117 if( pPg ){
danielk197728129562005-01-11 10:25:06 +00001118 /* No page should ever be explicitly rolled back that is in use, except
1119 ** for page 1 which is held in use in order to keep the lock on the
1120 ** database active. However such a page may be rolled back as a result
1121 ** of an internal error resulting in an automatic call to
danielk19773b8a05f2007-03-19 17:44:26 +00001122 ** sqlite3PagerRollback().
drhacf4ac92003-12-17 23:57:34 +00001123 */
drhb6f41482004-05-14 01:58:11 +00001124 void *pData;
danielk197728129562005-01-11 10:25:06 +00001125 /* assert( pPg->nRef==0 || pPg->pgno==1 ); */
drhb6f41482004-05-14 01:58:11 +00001126 pData = PGHDR_TO_DATA(pPg);
drhae2b40c2004-06-09 19:03:54 +00001127 memcpy(pData, aData, pPager->pageSize);
danielk19779038bb62007-04-09 11:20:54 +00001128 if( pPager->xReiniter ){
1129 pPager->xReiniter(pPg, pPager->pageSize);
drhde647132004-05-07 17:57:49 +00001130 }
danielk19773c407372005-02-15 02:54:14 +00001131#ifdef SQLITE_CHECK_PAGES
drh96362842005-03-20 22:47:56 +00001132 pPg->pageHash = pager_pagehash(pPg);
danielk19773c407372005-02-15 02:54:14 +00001133#endif
drhc001c582006-03-06 18:23:16 +00001134 CODEC1(pPager, pData, pPg->pgno, 3);
danielk197741483462007-03-24 16:45:04 +00001135
1136 /* If this was page 1, then restore the value of Pager.iChangeCount */
1137 if( pgno==1 ){
1138 pPager->iChangeCount = retrieve32bits(pPg, 24);
1139 }
drhfa86c412002-02-02 15:01:15 +00001140 }
1141 return rc;
1142}
1143
1144/*
danielk197713adf8a2004-06-03 16:08:41 +00001145** Parameter zMaster is the name of a master journal file. A single journal
1146** file that referred to the master journal file has just been rolled back.
1147** This routine checks if it is possible to delete the master journal file,
1148** and does so if it is.
drh726de592004-06-10 23:35:50 +00001149**
1150** The master journal file contains the names of all child journals.
1151** To tell if a master journal can be deleted, check to each of the
1152** children. If all children are either missing or do not refer to
1153** a different master journal, then this master journal can be deleted.
danielk197713adf8a2004-06-03 16:08:41 +00001154*/
1155static int pager_delmaster(const char *zMaster){
1156 int rc;
1157 int master_open = 0;
drh9cbe6352005-11-29 03:13:21 +00001158 OsFile *master = 0;
danielk197713adf8a2004-06-03 16:08:41 +00001159 char *zMasterJournal = 0; /* Contents of master journal file */
drheb206252004-10-01 02:00:31 +00001160 i64 nMasterJournal; /* Size of master journal file */
danielk197713adf8a2004-06-03 16:08:41 +00001161
1162 /* Open the master journal file exclusively in case some other process
1163 ** is running this routine also. Not that it makes too much difference.
1164 */
drh66560ad2006-01-06 14:32:19 +00001165 rc = sqlite3OsOpenReadOnly(zMaster, &master);
danielk19775bb16fe2007-04-05 11:54:42 +00001166 assert( rc!=SQLITE_OK || master );
danielk197713adf8a2004-06-03 16:08:41 +00001167 if( rc!=SQLITE_OK ) goto delmaster_out;
1168 master_open = 1;
drh054889e2005-11-30 03:20:31 +00001169 rc = sqlite3OsFileSize(master, &nMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001170 if( rc!=SQLITE_OK ) goto delmaster_out;
1171
1172 if( nMasterJournal>0 ){
danielk19775865e3d2004-06-14 06:03:57 +00001173 char *zJournal;
danielk197776572402004-06-25 02:38:54 +00001174 char *zMasterPtr = 0;
danielk19775865e3d2004-06-14 06:03:57 +00001175
1176 /* Load the entire master journal file into space obtained from
1177 ** sqliteMalloc() and pointed to by zMasterJournal.
danielk19775865e3d2004-06-14 06:03:57 +00001178 */
danielk197776572402004-06-25 02:38:54 +00001179 zMasterJournal = (char *)sqliteMalloc(nMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001180 if( !zMasterJournal ){
1181 rc = SQLITE_NOMEM;
1182 goto delmaster_out;
1183 }
drh054889e2005-11-30 03:20:31 +00001184 rc = sqlite3OsRead(master, zMasterJournal, nMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001185 if( rc!=SQLITE_OK ) goto delmaster_out;
1186
danielk19775865e3d2004-06-14 06:03:57 +00001187 zJournal = zMasterJournal;
1188 while( (zJournal-zMasterJournal)<nMasterJournal ){
drh66560ad2006-01-06 14:32:19 +00001189 if( sqlite3OsFileExists(zJournal) ){
danielk197713adf8a2004-06-03 16:08:41 +00001190 /* One of the journals pointed to by the master journal exists.
1191 ** Open it and check if it points at the master journal. If
1192 ** so, return without deleting the master journal file.
1193 */
drh9cbe6352005-11-29 03:13:21 +00001194 OsFile *journal = 0;
drh3b7b78b2004-11-24 01:16:43 +00001195 int c;
danielk197713adf8a2004-06-03 16:08:41 +00001196
drh66560ad2006-01-06 14:32:19 +00001197 rc = sqlite3OsOpenReadOnly(zJournal, &journal);
danielk19775bb16fe2007-04-05 11:54:42 +00001198 assert( rc!=SQLITE_OK || journal );
danielk197713adf8a2004-06-03 16:08:41 +00001199 if( rc!=SQLITE_OK ){
danielk197713adf8a2004-06-03 16:08:41 +00001200 goto delmaster_out;
1201 }
danielk197713adf8a2004-06-03 16:08:41 +00001202
drh9cbe6352005-11-29 03:13:21 +00001203 rc = readMasterJournal(journal, &zMasterPtr);
drh054889e2005-11-30 03:20:31 +00001204 sqlite3OsClose(&journal);
danielk19779eed5052004-06-04 10:38:30 +00001205 if( rc!=SQLITE_OK ){
danielk19779eed5052004-06-04 10:38:30 +00001206 goto delmaster_out;
1207 }
danielk197776572402004-06-25 02:38:54 +00001208
drh3b7b78b2004-11-24 01:16:43 +00001209 c = zMasterPtr!=0 && strcmp(zMasterPtr, zMaster)==0;
1210 sqliteFree(zMasterPtr);
1211 if( c ){
danielk197776572402004-06-25 02:38:54 +00001212 /* We have a match. Do not delete the master journal file. */
1213 goto delmaster_out;
danielk197713adf8a2004-06-03 16:08:41 +00001214 }
1215 }
danielk19775865e3d2004-06-14 06:03:57 +00001216 zJournal += (strlen(zJournal)+1);
danielk197713adf8a2004-06-03 16:08:41 +00001217 }
1218 }
1219
danielk1977979f38e2007-03-27 16:19:51 +00001220 rc = sqlite3OsDelete(zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001221
1222delmaster_out:
1223 if( zMasterJournal ){
1224 sqliteFree(zMasterJournal);
1225 }
1226 if( master_open ){
drh054889e2005-11-30 03:20:31 +00001227 sqlite3OsClose(&master);
danielk197713adf8a2004-06-03 16:08:41 +00001228 }
1229 return rc;
1230}
1231
drha6abd042004-06-09 17:37:22 +00001232
danielk1977e180dd92007-04-05 17:15:52 +00001233static void pager_truncate_cache(Pager *pPager);
1234
drha6abd042004-06-09 17:37:22 +00001235/*
drhcb4c40b2004-08-18 19:09:43 +00001236** Truncate the main file of the given pager to the number of pages
danielk1977e180dd92007-04-05 17:15:52 +00001237** indicated. Also truncate the cached representation of the file.
drhcb4c40b2004-08-18 19:09:43 +00001238*/
1239static int pager_truncate(Pager *pPager, int nPage){
danielk1977e180dd92007-04-05 17:15:52 +00001240 int rc = SQLITE_OK;
1241 if( pPager->state>=PAGER_EXCLUSIVE ){
1242 rc = sqlite3OsTruncate(pPager->fd, pPager->pageSize*(i64)nPage);
1243 }
1244 if( rc==SQLITE_OK ){
1245 pPager->dbSize = nPage;
1246 pager_truncate_cache(pPager);
1247 }
1248 return rc;
drhcb4c40b2004-08-18 19:09:43 +00001249}
1250
1251/*
drhed7c8552001-04-11 14:29:21 +00001252** Playback the journal and thus restore the database file to
1253** the state it was in before we started making changes.
1254**
drh34e79ce2004-02-08 06:05:46 +00001255** The journal file format is as follows:
1256**
drhae2b40c2004-06-09 19:03:54 +00001257** (1) 8 byte prefix. A copy of aJournalMagic[].
1258** (2) 4 byte big-endian integer which is the number of valid page records
drh34e79ce2004-02-08 06:05:46 +00001259** in the journal. If this value is 0xffffffff, then compute the
drhae2b40c2004-06-09 19:03:54 +00001260** number of page records from the journal size.
1261** (3) 4 byte big-endian integer which is the initial value for the
1262** sanity checksum.
1263** (4) 4 byte integer which is the number of pages to truncate the
drh34e79ce2004-02-08 06:05:46 +00001264** database to during a rollback.
drhae2b40c2004-06-09 19:03:54 +00001265** (5) 4 byte integer which is the number of bytes in the master journal
1266** name. The value may be zero (indicate that there is no master
1267** journal.)
1268** (6) N bytes of the master journal name. The name will be nul-terminated
1269** and might be shorter than the value read from (5). If the first byte
1270** of the name is \000 then there is no master journal. The master
1271** journal name is stored in UTF-8.
1272** (7) Zero or more pages instances, each as follows:
drh34e79ce2004-02-08 06:05:46 +00001273** + 4 byte page number.
drhae2b40c2004-06-09 19:03:54 +00001274** + pPager->pageSize bytes of data.
1275** + 4 byte checksum
drh34e79ce2004-02-08 06:05:46 +00001276**
drhae2b40c2004-06-09 19:03:54 +00001277** When we speak of the journal header, we mean the first 6 items above.
1278** Each entry in the journal is an instance of the 7th item.
drh34e79ce2004-02-08 06:05:46 +00001279**
1280** Call the value from the second bullet "nRec". nRec is the number of
1281** valid page entries in the journal. In most cases, you can compute the
1282** value of nRec from the size of the journal file. But if a power
1283** failure occurred while the journal was being written, it could be the
1284** case that the size of the journal file had already been increased but
1285** the extra entries had not yet made it safely to disk. In such a case,
1286** the value of nRec computed from the file size would be too large. For
1287** that reason, we always use the nRec value in the header.
1288**
1289** If the nRec value is 0xffffffff it means that nRec should be computed
1290** from the file size. This value is used when the user selects the
1291** no-sync option for the journal. A power failure could lead to corruption
1292** in this case. But for things like temporary table (which will be
1293** deleted when the power is restored) we don't care.
1294**
drhd9b02572001-04-15 00:37:09 +00001295** If the file opened as the journal file is not a well-formed
danielk1977ece80f12004-06-23 01:05:26 +00001296** journal file then all pages up to the first corrupted page are rolled
1297** back (or no pages if the journal header is corrupted). The journal file
1298** is then deleted and SQLITE_OK returned, just as if no corruption had
1299** been encountered.
1300**
1301** If an I/O or malloc() error occurs, the journal-file is not deleted
1302** and an error code is returned.
drhed7c8552001-04-11 14:29:21 +00001303*/
danielk1977e277be02007-03-23 18:12:06 +00001304static int pager_playback(Pager *pPager, int isHot){
drheb206252004-10-01 02:00:31 +00001305 i64 szJ; /* Size of the journal file in bytes */
danielk1977c3e8f5e2004-06-28 01:16:46 +00001306 u32 nRec; /* Number of Records in the journal */
drhd9b02572001-04-15 00:37:09 +00001307 int i; /* Loop counter */
1308 Pgno mxPg = 0; /* Size of the original file in pages */
drhae2b40c2004-06-09 19:03:54 +00001309 int rc; /* Result code of a subroutine */
danielk197713adf8a2004-06-03 16:08:41 +00001310 char *zMaster = 0; /* Name of master journal file if any */
drhed7c8552001-04-11 14:29:21 +00001311
drhc3a64ba2001-11-22 00:01:27 +00001312 /* Figure out how many records are in the journal. Abort early if
1313 ** the journal is empty.
drhed7c8552001-04-11 14:29:21 +00001314 */
drh8cfbf082001-09-19 13:22:39 +00001315 assert( pPager->journalOpen );
drh054889e2005-11-30 03:20:31 +00001316 rc = sqlite3OsFileSize(pPager->jfd, &szJ);
danielk1977334cdb62007-03-26 08:05:12 +00001317 if( rc!=SQLITE_OK || szJ==0 ){
drhc3a64ba2001-11-22 00:01:27 +00001318 goto end_playback;
1319 }
drh240c5792004-02-08 00:40:52 +00001320
danielk197776572402004-06-25 02:38:54 +00001321 /* Read the master journal name from the journal, if it is present.
1322 ** If a master journal file name is specified, but the file is not
1323 ** present on disk, then the journal is not hot and does not need to be
1324 ** played back.
drh240c5792004-02-08 00:40:52 +00001325 */
drh9cbe6352005-11-29 03:13:21 +00001326 rc = readMasterJournal(pPager->jfd, &zMaster);
danielk197776572402004-06-25 02:38:54 +00001327 assert( rc!=SQLITE_DONE );
drh66560ad2006-01-06 14:32:19 +00001328 if( rc!=SQLITE_OK || (zMaster && !sqlite3OsFileExists(zMaster)) ){
danielk197776572402004-06-25 02:38:54 +00001329 sqliteFree(zMaster);
1330 zMaster = 0;
1331 if( rc==SQLITE_DONE ) rc = SQLITE_OK;
drhc3a64ba2001-11-22 00:01:27 +00001332 goto end_playback;
1333 }
drh054889e2005-11-30 03:20:31 +00001334 sqlite3OsSeek(pPager->jfd, 0);
danielk197776572402004-06-25 02:38:54 +00001335 pPager->journalOff = 0;
drhc3a64ba2001-11-22 00:01:27 +00001336
danielk197776572402004-06-25 02:38:54 +00001337 /* This loop terminates either when the readJournalHdr() call returns
1338 ** SQLITE_DONE or an IO error occurs. */
1339 while( 1 ){
drhae2b40c2004-06-09 19:03:54 +00001340
danielk197776572402004-06-25 02:38:54 +00001341 /* Read the next journal header from the journal file. If there are
1342 ** not enough bytes left in the journal file for a complete header, or
1343 ** it is corrupted, then a process must of failed while writing it.
1344 ** This indicates nothing more needs to be rolled back.
1345 */
1346 rc = readJournalHdr(pPager, szJ, &nRec, &mxPg);
1347 if( rc!=SQLITE_OK ){
drh968af522003-02-11 14:55:40 +00001348 if( rc==SQLITE_DONE ){
drh968af522003-02-11 14:55:40 +00001349 rc = SQLITE_OK;
1350 }
danielk197776572402004-06-25 02:38:54 +00001351 goto end_playback;
1352 }
1353
1354 /* If nRec is 0xffffffff, then this journal was created by a process
1355 ** working in no-sync mode. This means that the rest of the journal
1356 ** file consists of pages, there are no more journal headers. Compute
1357 ** the value of nRec based on this assumption.
1358 */
1359 if( nRec==0xffffffff ){
1360 assert( pPager->journalOff==JOURNAL_HDR_SZ(pPager) );
1361 nRec = (szJ - JOURNAL_HDR_SZ(pPager))/JOURNAL_PG_SZ(pPager);
1362 }
1363
danielk1977e277be02007-03-23 18:12:06 +00001364 /* If nRec is 0 and this rollback is of a transaction created by this
1365 ** process. In this case the rest of the journal file consists of
1366 ** journalled copies of pages that need to be read back into the cache.
1367 */
1368 if( nRec==0 && !isHot ){
1369 nRec = (szJ - pPager->journalOff) / JOURNAL_PG_SZ(pPager);
1370 }
1371
danielk197776572402004-06-25 02:38:54 +00001372 /* If this is the first header read from the journal, truncate the
1373 ** database file back to it's original size.
1374 */
danielk1977e180dd92007-04-05 17:15:52 +00001375 if( pPager->journalOff==JOURNAL_HDR_SZ(pPager) ){
drhcb4c40b2004-08-18 19:09:43 +00001376 rc = pager_truncate(pPager, mxPg);
danielk197776572402004-06-25 02:38:54 +00001377 if( rc!=SQLITE_OK ){
1378 goto end_playback;
1379 }
danielk197776572402004-06-25 02:38:54 +00001380 }
1381
danielk197776572402004-06-25 02:38:54 +00001382 /* Copy original pages out of the journal and back into the database file.
1383 */
1384 for(i=0; i<nRec; i++){
drh9cbe6352005-11-29 03:13:21 +00001385 rc = pager_playback_one_page(pPager, pPager->jfd, 1);
danielk197776572402004-06-25 02:38:54 +00001386 if( rc!=SQLITE_OK ){
1387 if( rc==SQLITE_DONE ){
1388 rc = SQLITE_OK;
1389 pPager->journalOff = szJ;
1390 break;
1391 }else{
1392 goto end_playback;
1393 }
1394 }
drh968af522003-02-11 14:55:40 +00001395 }
drhed7c8552001-04-11 14:29:21 +00001396 }
drh580eeaf2006-02-24 03:09:37 +00001397 /*NOTREACHED*/
1398 assert( 0 );
drh4a0681e2003-02-13 01:58:20 +00001399
1400end_playback:
danielk19778191bff2004-06-28 04:52:30 +00001401 if( rc==SQLITE_OK ){
drh80e35f42007-03-30 14:06:34 +00001402 rc = pager_end_transaction(pPager);
danielk19778191bff2004-06-28 04:52:30 +00001403 }
danielk197713adf8a2004-06-03 16:08:41 +00001404 if( zMaster ){
danielk1977979f38e2007-03-27 16:19:51 +00001405 /* If there was a master journal and this routine will return success,
danielk197732554c12005-01-22 03:39:39 +00001406 ** see if it is possible to delete the master journal.
danielk197713adf8a2004-06-03 16:08:41 +00001407 */
1408 if( rc==SQLITE_OK ){
danielk197732554c12005-01-22 03:39:39 +00001409 rc = pager_delmaster(zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001410 }
1411 sqliteFree(zMaster);
1412 }
danielk197776572402004-06-25 02:38:54 +00001413
1414 /* The Pager.sectorSize variable may have been updated while rolling
drh3ceeb752007-03-29 18:19:52 +00001415 ** back a journal created by a process with a different sector size
danielk197776572402004-06-25 02:38:54 +00001416 ** value. Reset it to the correct value for this process.
1417 */
danielk1977b4721172007-03-19 05:54:48 +00001418 pPager->sectorSize = sqlite3OsSectorSize(pPager->fd);
drhd9b02572001-04-15 00:37:09 +00001419 return rc;
drhed7c8552001-04-11 14:29:21 +00001420}
1421
1422/*
drhac69b052004-05-12 13:30:07 +00001423** Playback the statement journal.
drhfa86c412002-02-02 15:01:15 +00001424**
1425** This is similar to playing back the transaction journal but with
1426** a few extra twists.
1427**
drh663fc632002-02-02 18:49:19 +00001428** (1) The number of pages in the database file at the start of
drhac69b052004-05-12 13:30:07 +00001429** the statement is stored in pPager->stmtSize, not in the
drh663fc632002-02-02 18:49:19 +00001430** journal file itself.
drhfa86c412002-02-02 15:01:15 +00001431**
drhac69b052004-05-12 13:30:07 +00001432** (2) In addition to playing back the statement journal, also
drhfa86c412002-02-02 15:01:15 +00001433** playback all pages of the transaction journal beginning
drhac69b052004-05-12 13:30:07 +00001434** at offset pPager->stmtJSize.
drhfa86c412002-02-02 15:01:15 +00001435*/
drh3aac2dd2004-04-26 14:10:20 +00001436static int pager_stmt_playback(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001437 i64 szJ; /* Size of the full journal */
1438 i64 hdrOff;
drh968af522003-02-11 14:55:40 +00001439 int nRec; /* Number of Records */
drhfa86c412002-02-02 15:01:15 +00001440 int i; /* Loop counter */
1441 int rc;
1442
danielk197776572402004-06-25 02:38:54 +00001443 szJ = pPager->journalOff;
1444#ifndef NDEBUG
1445 {
drheb206252004-10-01 02:00:31 +00001446 i64 os_szJ;
drh054889e2005-11-30 03:20:31 +00001447 rc = sqlite3OsFileSize(pPager->jfd, &os_szJ);
danielk197776572402004-06-25 02:38:54 +00001448 if( rc!=SQLITE_OK ) return rc;
1449 assert( szJ==os_szJ );
1450 }
1451#endif
1452
danielk19774099f6e2007-03-19 11:25:20 +00001453 /* Set hdrOff to be the offset just after the end of the last journal
1454 ** page written before the first journal-header for this statement
1455 ** transaction was written, or the end of the file if no journal
danielk197776572402004-06-25 02:38:54 +00001456 ** header was written.
1457 */
1458 hdrOff = pPager->stmtHdrOff;
1459 assert( pPager->fullSync || !hdrOff );
1460 if( !hdrOff ){
1461 hdrOff = szJ;
1462 }
1463
drhfa86c412002-02-02 15:01:15 +00001464 /* Truncate the database back to its original size.
1465 */
danielk1977e180dd92007-04-05 17:15:52 +00001466 rc = pager_truncate(pPager, pPager->stmtSize);
drh1aa2d8b2007-01-03 15:34:29 +00001467 assert( pPager->state>=PAGER_SHARED );
drhfa86c412002-02-02 15:01:15 +00001468
drhac69b052004-05-12 13:30:07 +00001469 /* Figure out how many records are in the statement journal.
drhfa86c412002-02-02 15:01:15 +00001470 */
drhac69b052004-05-12 13:30:07 +00001471 assert( pPager->stmtInUse && pPager->journalOpen );
drh054889e2005-11-30 03:20:31 +00001472 sqlite3OsSeek(pPager->stfd, 0);
drhac69b052004-05-12 13:30:07 +00001473 nRec = pPager->stmtNRec;
drhfa86c412002-02-02 15:01:15 +00001474
drhac69b052004-05-12 13:30:07 +00001475 /* Copy original pages out of the statement journal and back into the
drhae2b40c2004-06-09 19:03:54 +00001476 ** database file. Note that the statement journal omits checksums from
1477 ** each record since power-failure recovery is not important to statement
1478 ** journals.
drhfa86c412002-02-02 15:01:15 +00001479 */
1480 for(i=nRec-1; i>=0; i--){
drh9cbe6352005-11-29 03:13:21 +00001481 rc = pager_playback_one_page(pPager, pPager->stfd, 0);
drh968af522003-02-11 14:55:40 +00001482 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001483 if( rc!=SQLITE_OK ) goto end_stmt_playback;
drhfa86c412002-02-02 15:01:15 +00001484 }
1485
danielk197776572402004-06-25 02:38:54 +00001486 /* Now roll some pages back from the transaction journal. Pager.stmtJSize
1487 ** was the size of the journal file when this statement was started, so
1488 ** everything after that needs to be rolled back, either into the
1489 ** database, the memory cache, or both.
1490 **
1491 ** If it is not zero, then Pager.stmtHdrOff is the offset to the start
1492 ** of the first journal header written during this statement transaction.
drhfa86c412002-02-02 15:01:15 +00001493 */
drh054889e2005-11-30 03:20:31 +00001494 rc = sqlite3OsSeek(pPager->jfd, pPager->stmtJSize);
drhfa86c412002-02-02 15:01:15 +00001495 if( rc!=SQLITE_OK ){
drh3aac2dd2004-04-26 14:10:20 +00001496 goto end_stmt_playback;
drhfa86c412002-02-02 15:01:15 +00001497 }
danielk197776572402004-06-25 02:38:54 +00001498 pPager->journalOff = pPager->stmtJSize;
danielk197775edc162004-06-26 01:48:18 +00001499 pPager->cksumInit = pPager->stmtCksum;
danielk19774099f6e2007-03-19 11:25:20 +00001500 while( pPager->journalOff < hdrOff ){
drh9cbe6352005-11-29 03:13:21 +00001501 rc = pager_playback_one_page(pPager, pPager->jfd, 1);
danielk197776572402004-06-25 02:38:54 +00001502 assert( rc!=SQLITE_DONE );
1503 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1504 }
1505
1506 while( pPager->journalOff < szJ ){
danielk1977f0113002006-01-24 12:09:17 +00001507 u32 nJRec; /* Number of Journal Records */
danielk197776572402004-06-25 02:38:54 +00001508 u32 dummy;
danielk1977f0113002006-01-24 12:09:17 +00001509 rc = readJournalHdr(pPager, szJ, &nJRec, &dummy);
drh968af522003-02-11 14:55:40 +00001510 if( rc!=SQLITE_OK ){
1511 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001512 goto end_stmt_playback;
drh968af522003-02-11 14:55:40 +00001513 }
danielk1977f0113002006-01-24 12:09:17 +00001514 if( nJRec==0 ){
1515 nJRec = (szJ - pPager->journalOff) / (pPager->pageSize+8);
danielk197775edc162004-06-26 01:48:18 +00001516 }
danielk1977f0113002006-01-24 12:09:17 +00001517 for(i=nJRec-1; i>=0 && pPager->journalOff < szJ; i--){
drh9cbe6352005-11-29 03:13:21 +00001518 rc = pager_playback_one_page(pPager, pPager->jfd, 1);
danielk197776572402004-06-25 02:38:54 +00001519 assert( rc!=SQLITE_DONE );
1520 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1521 }
drhfa86c412002-02-02 15:01:15 +00001522 }
danielk197776572402004-06-25 02:38:54 +00001523
1524 pPager->journalOff = szJ;
drhfa86c412002-02-02 15:01:15 +00001525
drh3aac2dd2004-04-26 14:10:20 +00001526end_stmt_playback:
danielk19778a7aea32006-01-23 15:25:48 +00001527 if( rc==SQLITE_OK) {
danielk197775edc162004-06-26 01:48:18 +00001528 pPager->journalOff = szJ;
1529 /* pager_reload_cache(pPager); */
drhfa86c412002-02-02 15:01:15 +00001530 }
1531 return rc;
1532}
1533
1534/*
drhf57b14a2001-09-14 18:54:08 +00001535** Change the maximum number of in-memory pages that are allowed.
1536*/
danielk19773b8a05f2007-03-19 17:44:26 +00001537void sqlite3PagerSetCachesize(Pager *pPager, int mxPage){
drhf57b14a2001-09-14 18:54:08 +00001538 if( mxPage>10 ){
1539 pPager->mxPage = mxPage;
danielk1977ef317ab2004-06-23 10:43:10 +00001540 }else{
1541 pPager->mxPage = 10;
drhf57b14a2001-09-14 18:54:08 +00001542 }
1543}
1544
1545/*
drh973b6e32003-02-12 14:09:42 +00001546** Adjust the robustness of the database to damage due to OS crashes
1547** or power failures by changing the number of syncs()s when writing
1548** the rollback journal. There are three levels:
1549**
drh054889e2005-11-30 03:20:31 +00001550** OFF sqlite3OsSync() is never called. This is the default
drh973b6e32003-02-12 14:09:42 +00001551** for temporary and transient files.
1552**
1553** NORMAL The journal is synced once before writes begin on the
1554** database. This is normally adequate protection, but
1555** it is theoretically possible, though very unlikely,
1556** that an inopertune power failure could leave the journal
1557** in a state which would cause damage to the database
1558** when it is rolled back.
1559**
1560** FULL The journal is synced twice before writes begin on the
drh34e79ce2004-02-08 06:05:46 +00001561** database (with some additional information - the nRec field
1562** of the journal header - being written in between the two
1563** syncs). If we assume that writing a
drh973b6e32003-02-12 14:09:42 +00001564** single disk sector is atomic, then this mode provides
1565** assurance that the journal will not be corrupted to the
1566** point of causing damage to the database during rollback.
1567**
1568** Numeric values associated with these states are OFF==1, NORMAL=2,
1569** and FULL=3.
1570*/
danielk197793758c82005-01-21 08:13:14 +00001571#ifndef SQLITE_OMIT_PAGER_PRAGMAS
danielk19773b8a05f2007-03-19 17:44:26 +00001572void sqlite3PagerSetSafetyLevel(Pager *pPager, int level, int full_fsync){
drh973b6e32003-02-12 14:09:42 +00001573 pPager->noSync = level==1 || pPager->tempFile;
1574 pPager->fullSync = level==3 && !pPager->tempFile;
drhac530b12006-02-11 01:25:50 +00001575 pPager->full_fsync = full_fsync;
danielk19771d850a72004-05-31 08:26:49 +00001576 if( pPager->noSync ) pPager->needSync = 0;
drh973b6e32003-02-12 14:09:42 +00001577}
danielk197793758c82005-01-21 08:13:14 +00001578#endif
drh973b6e32003-02-12 14:09:42 +00001579
1580/*
drhaf6df112005-06-07 02:12:30 +00001581** The following global variable is incremented whenever the library
1582** attempts to open a temporary file. This information is used for
1583** testing and analysis only.
1584*/
drh0f7eb612006-08-08 13:51:43 +00001585#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00001586int sqlite3_opentemp_count = 0;
drh0f7eb612006-08-08 13:51:43 +00001587#endif
drhaf6df112005-06-07 02:12:30 +00001588
1589/*
drh3f56e6e2007-03-15 01:16:47 +00001590** Open a temporary file.
1591**
1592** Write the file descriptor into *fd. Return SQLITE_OK on success or some
drhfa86c412002-02-02 15:01:15 +00001593** other error code if we fail.
1594**
1595** The OS will automatically delete the temporary file when it is
1596** closed.
1597*/
danielk19773b8a05f2007-03-19 17:44:26 +00001598static int sqlite3PagerOpentemp(OsFile **pFd){
drhfa86c412002-02-02 15:01:15 +00001599 int cnt = 8;
1600 int rc;
drh3f56e6e2007-03-15 01:16:47 +00001601 char zFile[SQLITE_TEMPNAME_SIZE];
1602
drh0f7eb612006-08-08 13:51:43 +00001603#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00001604 sqlite3_opentemp_count++; /* Used for testing and analysis only */
drh0f7eb612006-08-08 13:51:43 +00001605#endif
drhfa86c412002-02-02 15:01:15 +00001606 do{
1607 cnt--;
drh66560ad2006-01-06 14:32:19 +00001608 sqlite3OsTempFileName(zFile);
1609 rc = sqlite3OsOpenExclusive(zFile, pFd, 1);
danielk19775bb16fe2007-04-05 11:54:42 +00001610 assert( rc!=SQLITE_OK || *pFd );
danielk197713073932004-06-30 11:54:06 +00001611 }while( cnt>0 && rc!=SQLITE_OK && rc!=SQLITE_NOMEM );
drhfa86c412002-02-02 15:01:15 +00001612 return rc;
1613}
1614
1615/*
drhed7c8552001-04-11 14:29:21 +00001616** Create a new page cache and put a pointer to the page cache in *ppPager.
drh5e00f6c2001-09-13 13:46:56 +00001617** The file to be cached need not exist. The file is not locked until
danielk19773b8a05f2007-03-19 17:44:26 +00001618** the first call to sqlite3PagerGet() and is only held open until the
1619** last page is released using sqlite3PagerUnref().
drh382c0242001-10-06 16:33:02 +00001620**
drh6446c4d2001-12-15 14:22:18 +00001621** If zFilename is NULL then a randomly-named temporary file is created
1622** and used as the file to be cached. The file will be deleted
1623** automatically when it is closed.
drh90f5ecb2004-07-22 01:19:35 +00001624**
1625** If zFilename is ":memory:" then all information is held in cache.
1626** It is never written to disk. This can be used to implement an
1627** in-memory database.
drhed7c8552001-04-11 14:29:21 +00001628*/
danielk19773b8a05f2007-03-19 17:44:26 +00001629int sqlite3PagerOpen(
drh7e3b0a02001-04-28 16:52:40 +00001630 Pager **ppPager, /* Return the Pager structure here */
1631 const char *zFilename, /* Name of the database file to open */
drhda47d772002-12-02 04:25:19 +00001632 int nExtra, /* Extra bytes append to each in-memory page */
drh7bec5052005-02-06 02:45:41 +00001633 int flags /* flags controlling this file */
drh7e3b0a02001-04-28 16:52:40 +00001634){
danielk1977aef0bf62005-12-30 16:28:01 +00001635 Pager *pPager = 0;
danielk19778def5ea2004-06-16 10:39:52 +00001636 char *zFullPathname = 0;
drh02afc862006-01-20 18:10:57 +00001637 int nameLen; /* Compiler is wrong. This is always initialized before use */
danielk1977393f0682007-03-31 10:00:48 +00001638 OsFile *fd = 0;
danielk1977cfe9a692004-06-16 12:00:29 +00001639 int rc = SQLITE_OK;
1640 int i;
danielk19778def5ea2004-06-16 10:39:52 +00001641 int tempFile = 0;
drhac69b052004-05-12 13:30:07 +00001642 int memDb = 0;
drh5e00f6c2001-09-13 13:46:56 +00001643 int readOnly = 0;
drh7bec5052005-02-06 02:45:41 +00001644 int useJournal = (flags & PAGER_OMIT_JOURNAL)==0;
1645 int noReadlock = (flags & PAGER_NO_READLOCK)!=0;
drh8cfbf082001-09-19 13:22:39 +00001646 char zTemp[SQLITE_TEMPNAME_SIZE];
drh6f7adc82006-01-11 21:41:20 +00001647#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
danielk197754f01982006-01-18 15:25:17 +00001648 /* A malloc() cannot fail in sqlite3ThreadData() as one or more calls to
1649 ** malloc() must have already been made by this thread before it gets
1650 ** to this point. This means the ThreadData must have been allocated already
1651 ** so that ThreadData.nAlloc can be set. It would be nice to assert
1652 ** that ThreadData.nAlloc is non-zero, but alas this breaks test cases
1653 ** written to invoke the pager directly.
1654 */
danielk19778212def2006-01-16 15:32:23 +00001655 ThreadData *pTsd = sqlite3ThreadData();
danielk197754f01982006-01-18 15:25:17 +00001656 assert( pTsd );
danielk197752622822006-01-09 09:59:49 +00001657#endif
drhed7c8552001-04-11 14:29:21 +00001658
danielk1977393f0682007-03-31 10:00:48 +00001659 /* We used to test if malloc() had already failed before proceeding.
1660 ** But the way this function is used in SQLite means that can never
1661 ** happen. Furthermore, if the malloc-failed flag is already set,
1662 ** either the call to sqliteStrDup() or sqliteMalloc() below will
1663 ** fail shortly and SQLITE_NOMEM returned anyway.
danielk1977aef0bf62005-12-30 16:28:01 +00001664 */
drhd9b02572001-04-15 00:37:09 +00001665 *ppPager = 0;
danielk1977aef0bf62005-12-30 16:28:01 +00001666
1667 /* Open the pager file and set zFullPathname to point at malloc()ed
1668 ** memory containing the complete filename (i.e. including the directory).
1669 */
drh901afd42003-08-26 11:25:58 +00001670 if( zFilename && zFilename[0] ){
drhb7f91642004-10-31 02:22:47 +00001671#ifndef SQLITE_OMIT_MEMORYDB
drhac69b052004-05-12 13:30:07 +00001672 if( strcmp(zFilename,":memory:")==0 ){
1673 memDb = 1;
drhda71ce12004-06-21 18:14:45 +00001674 zFullPathname = sqliteStrDup("");
drhb7f91642004-10-31 02:22:47 +00001675 }else
1676#endif
1677 {
drh66560ad2006-01-06 14:32:19 +00001678 zFullPathname = sqlite3OsFullPathname(zFilename);
danielk19778def5ea2004-06-16 10:39:52 +00001679 if( zFullPathname ){
drh66560ad2006-01-06 14:32:19 +00001680 rc = sqlite3OsOpenReadWrite(zFullPathname, &fd, &readOnly);
danielk19775bb16fe2007-04-05 11:54:42 +00001681 assert( rc!=SQLITE_OK || fd );
danielk19778def5ea2004-06-16 10:39:52 +00001682 }
drhac69b052004-05-12 13:30:07 +00001683 }
drh5e00f6c2001-09-13 13:46:56 +00001684 }else{
danielk19773b8a05f2007-03-19 17:44:26 +00001685 rc = sqlite3PagerOpentemp(&fd);
drh3f56e6e2007-03-15 01:16:47 +00001686 sqlite3OsTempFileName(zTemp);
drh5e00f6c2001-09-13 13:46:56 +00001687 zFilename = zTemp;
drh66560ad2006-01-06 14:32:19 +00001688 zFullPathname = sqlite3OsFullPathname(zFilename);
danielk19778def5ea2004-06-16 10:39:52 +00001689 if( rc==SQLITE_OK ){
1690 tempFile = 1;
1691 }
drh5e00f6c2001-09-13 13:46:56 +00001692 }
danielk1977aef0bf62005-12-30 16:28:01 +00001693
1694 /* Allocate the Pager structure. As part of the same allocation, allocate
1695 ** space for the full paths of the file, directory and journal
1696 ** (Pager.zFilename, Pager.zDirectory and Pager.zJournal).
1697 */
1698 if( zFullPathname ){
1699 nameLen = strlen(zFullPathname);
1700 pPager = sqliteMalloc( sizeof(*pPager) + nameLen*3 + 30 );
danielk19778186df82007-03-06 13:45:59 +00001701 if( pPager && rc==SQLITE_OK ){
1702 pPager->pTmpSpace = (char *)sqliteMallocRaw(SQLITE_DEFAULT_PAGE_SIZE);
1703 }
drh3e7a6092002-12-07 21:45:14 +00001704 }
danielk1977aef0bf62005-12-30 16:28:01 +00001705
danielk19778186df82007-03-06 13:45:59 +00001706
danielk1977aef0bf62005-12-30 16:28:01 +00001707 /* If an error occured in either of the blocks above, free the memory
1708 ** pointed to by zFullPathname, free the Pager structure and close the
1709 ** file. Since the pager is not allocated there is no need to set
1710 ** any Pager.errMask variables.
1711 */
danielk19778186df82007-03-06 13:45:59 +00001712 if( !pPager || !zFullPathname || !pPager->pTmpSpace || rc!=SQLITE_OK ){
drh054889e2005-11-30 03:20:31 +00001713 sqlite3OsClose(&fd);
drhda71ce12004-06-21 18:14:45 +00001714 sqliteFree(zFullPathname);
danielk1977aef0bf62005-12-30 16:28:01 +00001715 sqliteFree(pPager);
1716 return ((rc==SQLITE_OK)?SQLITE_NOMEM:rc);
drhed7c8552001-04-11 14:29:21 +00001717 }
danielk1977aef0bf62005-12-30 16:28:01 +00001718
drh4f0c5872007-03-26 22:05:01 +00001719 PAGERTRACE3("OPEN %d %s\n", FILEHANDLEID(fd), zFullPathname);
drhb0603412007-02-28 04:47:26 +00001720 IOTRACE(("OPEN %p %s\n", pPager, zFullPathname))
drhed7c8552001-04-11 14:29:21 +00001721 pPager->zFilename = (char*)&pPager[1];
drha76c82e2003-07-27 18:59:42 +00001722 pPager->zDirectory = &pPager->zFilename[nameLen+1];
1723 pPager->zJournal = &pPager->zDirectory[nameLen+1];
drh3e7a6092002-12-07 21:45:14 +00001724 strcpy(pPager->zFilename, zFullPathname);
drha76c82e2003-07-27 18:59:42 +00001725 strcpy(pPager->zDirectory, zFullPathname);
danielk1977aef0bf62005-12-30 16:28:01 +00001726
drha76c82e2003-07-27 18:59:42 +00001727 for(i=nameLen; i>0 && pPager->zDirectory[i-1]!='/'; i--){}
1728 if( i>0 ) pPager->zDirectory[i-1] = 0;
drh3e7a6092002-12-07 21:45:14 +00001729 strcpy(pPager->zJournal, zFullPathname);
1730 sqliteFree(zFullPathname);
drhed7c8552001-04-11 14:29:21 +00001731 strcpy(&pPager->zJournal[nameLen], "-journal");
drh9cbe6352005-11-29 03:13:21 +00001732 pPager->fd = fd;
drh3b59a5c2006-01-15 20:28:28 +00001733 /* pPager->journalOpen = 0; */
drhac69b052004-05-12 13:30:07 +00001734 pPager->useJournal = useJournal && !memDb;
drh7bec5052005-02-06 02:45:41 +00001735 pPager->noReadlock = noReadlock && readOnly;
drh3b59a5c2006-01-15 20:28:28 +00001736 /* pPager->stmtOpen = 0; */
1737 /* pPager->stmtInUse = 0; */
1738 /* pPager->nRef = 0; */
drhac69b052004-05-12 13:30:07 +00001739 pPager->dbSize = memDb-1;
drh90f5ecb2004-07-22 01:19:35 +00001740 pPager->pageSize = SQLITE_DEFAULT_PAGE_SIZE;
drh3b59a5c2006-01-15 20:28:28 +00001741 /* pPager->stmtSize = 0; */
1742 /* pPager->stmtJSize = 0; */
1743 /* pPager->nPage = 0; */
1744 /* pPager->nMaxPage = 0; */
drh90f5ecb2004-07-22 01:19:35 +00001745 pPager->mxPage = 100;
drh3b59a5c2006-01-15 20:28:28 +00001746 assert( PAGER_UNLOCK==0 );
1747 /* pPager->state = PAGER_UNLOCK; */
1748 /* pPager->errMask = 0; */
drh5e00f6c2001-09-13 13:46:56 +00001749 pPager->tempFile = tempFile;
drh369339d2007-03-30 16:01:55 +00001750 assert( tempFile==PAGER_LOCKINGMODE_NORMAL
1751 || tempFile==PAGER_LOCKINGMODE_EXCLUSIVE );
1752 assert( PAGER_LOCKINGMODE_EXCLUSIVE==1 );
1753 pPager->exclusiveMode = tempFile;
drhac69b052004-05-12 13:30:07 +00001754 pPager->memDb = memDb;
drh5e00f6c2001-09-13 13:46:56 +00001755 pPager->readOnly = readOnly;
drh3b59a5c2006-01-15 20:28:28 +00001756 /* pPager->needSync = 0; */
drhda47d772002-12-02 04:25:19 +00001757 pPager->noSync = pPager->tempFile || !useJournal;
danielk197775edc162004-06-26 01:48:18 +00001758 pPager->fullSync = (pPager->noSync?0:1);
drh3b59a5c2006-01-15 20:28:28 +00001759 /* pPager->pFirst = 0; */
1760 /* pPager->pFirstSynced = 0; */
1761 /* pPager->pLast = 0; */
drh887dc4c2004-10-22 16:22:57 +00001762 pPager->nExtra = FORCE_ALIGNMENT(nExtra);
danielk1977b4721172007-03-19 05:54:48 +00001763 assert(fd||memDb);
1764 if( !memDb ){
1765 pPager->sectorSize = sqlite3OsSectorSize(fd);
1766 }
drh3b59a5c2006-01-15 20:28:28 +00001767 /* pPager->pBusyHandler = 0; */
1768 /* memset(pPager->aHash, 0, sizeof(pPager->aHash)); */
drhed7c8552001-04-11 14:29:21 +00001769 *ppPager = pPager;
drh6f7adc82006-01-11 21:41:20 +00001770#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
danielk19778212def2006-01-16 15:32:23 +00001771 pPager->pNext = pTsd->pPager;
1772 pTsd->pPager = pPager;
danielk197752622822006-01-09 09:59:49 +00001773#endif
drhed7c8552001-04-11 14:29:21 +00001774 return SQLITE_OK;
1775}
1776
1777/*
drh90f5ecb2004-07-22 01:19:35 +00001778** Set the busy handler function.
1779*/
danielk19773b8a05f2007-03-19 17:44:26 +00001780void sqlite3PagerSetBusyhandler(Pager *pPager, BusyHandler *pBusyHandler){
drh90f5ecb2004-07-22 01:19:35 +00001781 pPager->pBusyHandler = pBusyHandler;
1782}
1783
1784/*
drh72f82862001-05-24 21:06:34 +00001785** Set the destructor for this pager. If not NULL, the destructor is called
drh5e00f6c2001-09-13 13:46:56 +00001786** when the reference count on each page reaches zero. The destructor can
1787** be used to clean up information in the extra segment appended to each page.
drh72f82862001-05-24 21:06:34 +00001788**
danielk19773b8a05f2007-03-19 17:44:26 +00001789** The destructor is not called as a result sqlite3PagerClose().
1790** Destructors are only called by sqlite3PagerUnref().
drh72f82862001-05-24 21:06:34 +00001791*/
danielk19773b8a05f2007-03-19 17:44:26 +00001792void sqlite3PagerSetDestructor(Pager *pPager, void (*xDesc)(DbPage*,int)){
drh72f82862001-05-24 21:06:34 +00001793 pPager->xDestructor = xDesc;
1794}
1795
1796/*
drha6abd042004-06-09 17:37:22 +00001797** Set the reinitializer for this pager. If not NULL, the reinitializer
1798** is called when the content of a page in cache is restored to its original
1799** value as a result of a rollback. The callback gives higher-level code
1800** an opportunity to restore the EXTRA section to agree with the restored
1801** page data.
1802*/
danielk19773b8a05f2007-03-19 17:44:26 +00001803void sqlite3PagerSetReiniter(Pager *pPager, void (*xReinit)(DbPage*,int)){
drha6abd042004-06-09 17:37:22 +00001804 pPager->xReiniter = xReinit;
1805}
1806
1807/*
drh1c7880e2005-05-20 20:01:55 +00001808** Set the page size. Return the new size. If the suggest new page
1809** size is inappropriate, then an alternative page size is selected
1810** and returned.
drh90f5ecb2004-07-22 01:19:35 +00001811*/
danielk19773b8a05f2007-03-19 17:44:26 +00001812int sqlite3PagerSetPagesize(Pager *pPager, int pageSize){
drh90f5ecb2004-07-22 01:19:35 +00001813 assert( pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE );
danielk1977c7c7e622007-03-26 15:46:00 +00001814 if( !pPager->memDb && pPager->nRef==0 ){
1815 pager_reset(pPager);
drh1c7880e2005-05-20 20:01:55 +00001816 pPager->pageSize = pageSize;
drhcf643722007-03-27 13:36:37 +00001817 pPager->pTmpSpace = sqlite3ReallocOrFree(pPager->pTmpSpace, pageSize);
drh1c7880e2005-05-20 20:01:55 +00001818 }
1819 return pPager->pageSize;
drh90f5ecb2004-07-22 01:19:35 +00001820}
1821
1822/*
drhc9ac5ca2005-11-04 22:03:30 +00001823** The following set of routines are used to disable the simulated
1824** I/O error mechanism. These routines are used to avoid simulated
1825** errors in places where we do not care about errors.
1826**
1827** Unless -DSQLITE_TEST=1 is used, these routines are all no-ops
1828** and generate no code.
1829*/
1830#ifdef SQLITE_TEST
1831extern int sqlite3_io_error_pending;
1832extern int sqlite3_io_error_hit;
1833static int saved_cnt;
drhc9ac5ca2005-11-04 22:03:30 +00001834void disable_simulated_io_errors(void){
1835 saved_cnt = sqlite3_io_error_pending;
1836 sqlite3_io_error_pending = -1;
1837}
1838void enable_simulated_io_errors(void){
1839 sqlite3_io_error_pending = saved_cnt;
1840}
1841#else
drh152410f2005-11-05 15:11:22 +00001842# define disable_simulated_io_errors()
1843# define enable_simulated_io_errors()
drhc9ac5ca2005-11-04 22:03:30 +00001844#endif
1845
1846/*
drh90f5ecb2004-07-22 01:19:35 +00001847** Read the first N bytes from the beginning of the file into memory
danielk1977aef0bf62005-12-30 16:28:01 +00001848** that pDest points to.
1849**
1850** No error checking is done. The rational for this is that this function
1851** may be called even if the file does not exist or contain a header. In
1852** these cases sqlite3OsRead() will return an error, to which the correct
1853** response is to zero the memory at pDest and continue. A real IO error
1854** will presumably recur and be picked up later (Todo: Think about this).
drh90f5ecb2004-07-22 01:19:35 +00001855*/
danielk19773b8a05f2007-03-19 17:44:26 +00001856int sqlite3PagerReadFileheader(Pager *pPager, int N, unsigned char *pDest){
drh551b7732006-11-06 21:20:25 +00001857 int rc = SQLITE_OK;
drh90f5ecb2004-07-22 01:19:35 +00001858 memset(pDest, 0, N);
drhb7f91642004-10-31 02:22:47 +00001859 if( MEMDB==0 ){
danielk1977f2fa8312006-01-24 13:09:33 +00001860 disable_simulated_io_errors();
drh054889e2005-11-30 03:20:31 +00001861 sqlite3OsSeek(pPager->fd, 0);
danielk1977f2fa8312006-01-24 13:09:33 +00001862 enable_simulated_io_errors();
drhb0603412007-02-28 04:47:26 +00001863 IOTRACE(("DBHDR %p 0 %d\n", pPager, N))
drh551b7732006-11-06 21:20:25 +00001864 rc = sqlite3OsRead(pPager->fd, pDest, N);
1865 if( rc==SQLITE_IOERR_SHORT_READ ){
1866 rc = SQLITE_OK;
1867 }
drh90f5ecb2004-07-22 01:19:35 +00001868 }
drh551b7732006-11-06 21:20:25 +00001869 return rc;
drh90f5ecb2004-07-22 01:19:35 +00001870}
1871
1872/*
drh5e00f6c2001-09-13 13:46:56 +00001873** Return the total number of pages in the disk file associated with
danielk197715f411d2005-09-16 10:18:45 +00001874** pPager.
1875**
1876** If the PENDING_BYTE lies on the page directly after the end of the
1877** file, then consider this page part of the file too. For example, if
1878** PENDING_BYTE is byte 4096 (the first byte of page 5) and the size of the
1879** file is 4096 bytes, 5 is returned instead of 4.
drhed7c8552001-04-11 14:29:21 +00001880*/
danielk19773b8a05f2007-03-19 17:44:26 +00001881int sqlite3PagerPagecount(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001882 i64 n;
drhe49f9822006-09-15 12:29:16 +00001883 int rc;
drhd9b02572001-04-15 00:37:09 +00001884 assert( pPager!=0 );
drha7aea3d2007-03-15 12:51:16 +00001885 if( pPager->errCode ){
1886 return 0;
1887 }
drhed7c8552001-04-11 14:29:21 +00001888 if( pPager->dbSize>=0 ){
danielk197715f411d2005-09-16 10:18:45 +00001889 n = pPager->dbSize;
1890 } else {
drhe49f9822006-09-15 12:29:16 +00001891 if( (rc = sqlite3OsFileSize(pPager->fd, &n))!=SQLITE_OK ){
1892 pager_error(pPager, rc);
danielk197715f411d2005-09-16 10:18:45 +00001893 return 0;
1894 }
1895 if( n>0 && n<pPager->pageSize ){
1896 n = 1;
1897 }else{
1898 n /= pPager->pageSize;
1899 }
1900 if( pPager->state!=PAGER_UNLOCK ){
1901 pPager->dbSize = n;
1902 }
drhed7c8552001-04-11 14:29:21 +00001903 }
danielk197715f411d2005-09-16 10:18:45 +00001904 if( n==(PENDING_BYTE/pPager->pageSize) ){
drh1f595712004-06-15 01:40:29 +00001905 n++;
1906 }
drhed7c8552001-04-11 14:29:21 +00001907 return n;
1908}
1909
drhf07e7d52006-04-07 13:54:46 +00001910
1911#ifndef SQLITE_OMIT_MEMORYDB
1912/*
1913** Clear a PgHistory block
1914*/
1915static void clearHistory(PgHistory *pHist){
1916 sqliteFree(pHist->pOrig);
1917 sqliteFree(pHist->pStmt);
1918 pHist->pOrig = 0;
1919 pHist->pStmt = 0;
1920}
1921#else
1922#define clearHistory(x)
1923#endif
1924
drhed7c8552001-04-11 14:29:21 +00001925/*
drhf7c57532003-04-25 13:22:51 +00001926** Forward declaration
1927*/
danielk197776572402004-06-25 02:38:54 +00001928static int syncJournal(Pager*);
drhac69b052004-05-12 13:30:07 +00001929
1930/*
danielk1977f5fdda82004-11-03 08:44:05 +00001931** Unlink pPg from it's hash chain. Also set the page number to 0 to indicate
1932** that the page is not part of any hash chain. This is required because the
danielk19773b8a05f2007-03-19 17:44:26 +00001933** sqlite3PagerMovepage() routine can leave a page in the
danielk1977f5fdda82004-11-03 08:44:05 +00001934** pNextFree/pPrevFree list that is not a part of any hash-chain.
1935*/
1936static void unlinkHashChain(Pager *pPager, PgHdr *pPg){
1937 if( pPg->pgno==0 ){
drh3765df42006-06-28 18:18:09 +00001938 assert( pPg->pNextHash==0 && pPg->pPrevHash==0 );
danielk1977f5fdda82004-11-03 08:44:05 +00001939 return;
1940 }
1941 if( pPg->pNextHash ){
1942 pPg->pNextHash->pPrevHash = pPg->pPrevHash;
1943 }
1944 if( pPg->pPrevHash ){
drh8ca0c722006-05-07 17:49:38 +00001945 assert( pPager->aHash[pPg->pgno & (pPager->nHash-1)]!=pPg );
danielk1977f5fdda82004-11-03 08:44:05 +00001946 pPg->pPrevHash->pNextHash = pPg->pNextHash;
1947 }else{
drh8ca0c722006-05-07 17:49:38 +00001948 int h = pPg->pgno & (pPager->nHash-1);
danielk1977f5fdda82004-11-03 08:44:05 +00001949 pPager->aHash[h] = pPg->pNextHash;
1950 }
drh5229ae42006-03-23 23:29:04 +00001951 if( MEMDB ){
drh5229ae42006-03-23 23:29:04 +00001952 clearHistory(PGHDR_TO_HIST(pPg, pPager));
1953 }
danielk1977f5fdda82004-11-03 08:44:05 +00001954 pPg->pgno = 0;
1955 pPg->pNextHash = pPg->pPrevHash = 0;
1956}
1957
1958/*
drhac69b052004-05-12 13:30:07 +00001959** Unlink a page from the free list (the list of all pages where nRef==0)
1960** and from its hash collision chain.
1961*/
1962static void unlinkPage(PgHdr *pPg){
1963 Pager *pPager = pPg->pPager;
1964
1965 /* Keep the pFirstSynced pointer pointing at the first synchronized page */
1966 if( pPg==pPager->pFirstSynced ){
1967 PgHdr *p = pPg->pNextFree;
1968 while( p && p->needSync ){ p = p->pNextFree; }
1969 pPager->pFirstSynced = p;
1970 }
1971
1972 /* Unlink from the freelist */
1973 if( pPg->pPrevFree ){
1974 pPg->pPrevFree->pNextFree = pPg->pNextFree;
1975 }else{
1976 assert( pPager->pFirst==pPg );
1977 pPager->pFirst = pPg->pNextFree;
1978 }
1979 if( pPg->pNextFree ){
1980 pPg->pNextFree->pPrevFree = pPg->pPrevFree;
1981 }else{
1982 assert( pPager->pLast==pPg );
1983 pPager->pLast = pPg->pPrevFree;
1984 }
1985 pPg->pNextFree = pPg->pPrevFree = 0;
1986
1987 /* Unlink from the pgno hash table */
danielk1977f5fdda82004-11-03 08:44:05 +00001988 unlinkHashChain(pPager, pPg);
drhac69b052004-05-12 13:30:07 +00001989}
1990
1991/*
danielk1977e180dd92007-04-05 17:15:52 +00001992** This routine is used to truncate the cache when a database
1993** is truncated. Drop from the cache all pages whose pgno is
1994** larger than pPager->dbSize and is unreferenced.
1995**
drhac69b052004-05-12 13:30:07 +00001996** Referenced pages larger than pPager->dbSize are zeroed.
danielk1977e180dd92007-04-05 17:15:52 +00001997**
1998** Actually, at the point this routine is called, it would be
1999** an error to have a referenced page. But rather than delete
2000** that page and guarantee a subsequent segfault, it seems better
2001** to zero it and hope that we error out sanely.
drhac69b052004-05-12 13:30:07 +00002002*/
danielk1977e180dd92007-04-05 17:15:52 +00002003static void pager_truncate_cache(Pager *pPager){
drhac69b052004-05-12 13:30:07 +00002004 PgHdr *pPg;
2005 PgHdr **ppPg;
2006 int dbSize = pPager->dbSize;
2007
2008 ppPg = &pPager->pAll;
2009 while( (pPg = *ppPg)!=0 ){
2010 if( pPg->pgno<=dbSize ){
2011 ppPg = &pPg->pNextAll;
2012 }else if( pPg->nRef>0 ){
2013 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
2014 ppPg = &pPg->pNextAll;
2015 }else{
2016 *ppPg = pPg->pNextAll;
drh538f5702007-04-13 02:14:30 +00002017 IOTRACE(("PGFREE %p %d\n", pPager, pPg->pgno));
2018 PAGER_INCR(sqlite3_pager_pgfree_count);
drhac69b052004-05-12 13:30:07 +00002019 unlinkPage(pPg);
drh605ad8f2006-05-03 23:34:05 +00002020 makeClean(pPg);
drhac69b052004-05-12 13:30:07 +00002021 sqliteFree(pPg);
2022 pPager->nPage--;
2023 }
2024 }
2025}
2026
drhf7c57532003-04-25 13:22:51 +00002027/*
danielk197717221812005-02-15 03:38:05 +00002028** Try to obtain a lock on a file. Invoke the busy callback if the lock
drha4afb652005-07-09 02:16:02 +00002029** is currently not available. Repeat until the busy callback returns
danielk197717221812005-02-15 03:38:05 +00002030** false or until the lock succeeds.
2031**
2032** Return SQLITE_OK on success and an error code if we cannot obtain
2033** the lock.
2034*/
2035static int pager_wait_on_lock(Pager *pPager, int locktype){
2036 int rc;
drh1aa2d8b2007-01-03 15:34:29 +00002037
2038 /* The OS lock values must be the same as the Pager lock values */
danielk197717221812005-02-15 03:38:05 +00002039 assert( PAGER_SHARED==SHARED_LOCK );
2040 assert( PAGER_RESERVED==RESERVED_LOCK );
2041 assert( PAGER_EXCLUSIVE==EXCLUSIVE_LOCK );
drh1aa2d8b2007-01-03 15:34:29 +00002042
2043 /* If the file is currently unlocked then the size must be unknown */
2044 assert( pPager->state>=PAGER_SHARED || pPager->dbSize<0 || MEMDB );
2045
danielk197717221812005-02-15 03:38:05 +00002046 if( pPager->state>=locktype ){
2047 rc = SQLITE_OK;
2048 }else{
danielk197717221812005-02-15 03:38:05 +00002049 do {
drh054889e2005-11-30 03:20:31 +00002050 rc = sqlite3OsLock(pPager->fd, locktype);
drha4afb652005-07-09 02:16:02 +00002051 }while( rc==SQLITE_BUSY && sqlite3InvokeBusyHandler(pPager->pBusyHandler) );
danielk197717221812005-02-15 03:38:05 +00002052 if( rc==SQLITE_OK ){
2053 pPager->state = locktype;
drhb0603412007-02-28 04:47:26 +00002054 IOTRACE(("LOCK %p %d\n", pPager, locktype))
danielk197717221812005-02-15 03:38:05 +00002055 }
2056 }
2057 return rc;
2058}
2059
2060/*
drhf7c57532003-04-25 13:22:51 +00002061** Truncate the file to the number of pages specified.
2062*/
danielk19773b8a05f2007-03-19 17:44:26 +00002063int sqlite3PagerTruncate(Pager *pPager, Pgno nPage){
drhf7c57532003-04-25 13:22:51 +00002064 int rc;
drh1aa2d8b2007-01-03 15:34:29 +00002065 assert( pPager->state>=PAGER_SHARED || MEMDB );
danielk19773b8a05f2007-03-19 17:44:26 +00002066 sqlite3PagerPagecount(pPager);
danielk1977efaaf572006-01-16 11:29:19 +00002067 if( pPager->errCode ){
2068 rc = pPager->errCode;
drh2e6d11b2003-04-25 15:37:57 +00002069 return rc;
2070 }
drh7d02cb72003-06-04 16:24:39 +00002071 if( nPage>=(unsigned)pPager->dbSize ){
drhf7c57532003-04-25 13:22:51 +00002072 return SQLITE_OK;
2073 }
drhb7f91642004-10-31 02:22:47 +00002074 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00002075 pPager->dbSize = nPage;
danielk1977e180dd92007-04-05 17:15:52 +00002076 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00002077 return SQLITE_OK;
2078 }
danielk197776572402004-06-25 02:38:54 +00002079 rc = syncJournal(pPager);
danielk1977369f27e2004-06-15 11:40:04 +00002080 if( rc!=SQLITE_OK ){
2081 return rc;
2082 }
danielk197717221812005-02-15 03:38:05 +00002083
2084 /* Get an exclusive lock on the database before truncating. */
2085 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
2086 if( rc!=SQLITE_OK ){
2087 return rc;
2088 }
2089
drhcb4c40b2004-08-18 19:09:43 +00002090 rc = pager_truncate(pPager, nPage);
drhf7c57532003-04-25 13:22:51 +00002091 return rc;
2092}
2093
2094/*
drhed7c8552001-04-11 14:29:21 +00002095** Shutdown the page cache. Free all memory and close all files.
2096**
2097** If a transaction was in progress when this routine is called, that
2098** transaction is rolled back. All outstanding pages are invalidated
2099** and their memory is freed. Any attempt to use a page associated
2100** with this page cache after this function returns will likely
2101** result in a coredump.
danielk1977aef0bf62005-12-30 16:28:01 +00002102**
2103** This function always succeeds. If a transaction is active an attempt
2104** is made to roll it back. If an error occurs during the rollback
2105** a hot journal may be left in the filesystem but no error is returned
2106** to the caller.
drhed7c8552001-04-11 14:29:21 +00002107*/
danielk19773b8a05f2007-03-19 17:44:26 +00002108int sqlite3PagerClose(Pager *pPager){
drh6f7adc82006-01-11 21:41:20 +00002109#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
danielk197754f01982006-01-18 15:25:17 +00002110 /* A malloc() cannot fail in sqlite3ThreadData() as one or more calls to
2111 ** malloc() must have already been made by this thread before it gets
2112 ** to this point. This means the ThreadData must have been allocated already
2113 ** so that ThreadData.nAlloc can be set.
2114 */
danielk19778212def2006-01-16 15:32:23 +00002115 ThreadData *pTsd = sqlite3ThreadData();
danielk197776e8d1a2006-01-18 18:22:43 +00002116 assert( pPager );
danielk197754f01982006-01-18 15:25:17 +00002117 assert( pTsd && pTsd->nAlloc );
danielk197713f72992005-12-18 08:51:22 +00002118#endif
2119
drhbafda092007-01-03 23:36:22 +00002120 disable_simulated_io_errors();
drhc2ee76c2007-01-04 14:58:14 +00002121 pPager->errCode = 0;
danielk197741483462007-03-24 16:45:04 +00002122 pPager->exclusiveMode = 0;
drhbafda092007-01-03 23:36:22 +00002123 pager_reset(pPager);
danielk1977e277be02007-03-23 18:12:06 +00002124 pagerUnlockAndRollback(pPager);
drhbafda092007-01-03 23:36:22 +00002125 enable_simulated_io_errors();
drh4f0c5872007-03-26 22:05:01 +00002126 PAGERTRACE2("CLOSE %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002127 IOTRACE(("CLOSE %p\n", pPager))
danielk1977efaaf572006-01-16 11:29:19 +00002128 assert( pPager->errCode || (pPager->journalOpen==0 && pPager->stmtOpen==0) );
danielk1977e94ddc92005-03-21 03:53:38 +00002129 if( pPager->journalOpen ){
drh054889e2005-11-30 03:20:31 +00002130 sqlite3OsClose(&pPager->jfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002131 }
drh88b01a12005-03-28 18:04:27 +00002132 sqliteFree(pPager->aInJournal);
danielk1977e94ddc92005-03-21 03:53:38 +00002133 if( pPager->stmtOpen ){
drh054889e2005-11-30 03:20:31 +00002134 sqlite3OsClose(&pPager->stfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002135 }
drh054889e2005-11-30 03:20:31 +00002136 sqlite3OsClose(&pPager->fd);
drh0f892532002-05-30 12:27:03 +00002137 /* Temp files are automatically deleted by the OS
2138 ** if( pPager->tempFile ){
drh66560ad2006-01-06 14:32:19 +00002139 ** sqlite3OsDelete(pPager->zFilename);
drh0f892532002-05-30 12:27:03 +00002140 ** }
2141 */
danielk1977aca790a2005-01-13 11:07:52 +00002142
drh6f7adc82006-01-11 21:41:20 +00002143#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
danielk1977aef0bf62005-12-30 16:28:01 +00002144 /* Remove the pager from the linked list of pagers starting at
danielk197752622822006-01-09 09:59:49 +00002145 ** ThreadData.pPager if memory-management is enabled.
danielk1977aef0bf62005-12-30 16:28:01 +00002146 */
danielk19778212def2006-01-16 15:32:23 +00002147 if( pPager==pTsd->pPager ){
2148 pTsd->pPager = pPager->pNext;
2149 }else{
2150 Pager *pTmp;
drh74161702006-02-24 02:53:49 +00002151 for(pTmp = pTsd->pPager; pTmp->pNext!=pPager; pTmp=pTmp->pNext){}
danielk19778212def2006-01-16 15:32:23 +00002152 pTmp->pNext = pPager->pNext;
danielk197713f72992005-12-18 08:51:22 +00002153 }
2154#endif
drh8ca0c722006-05-07 17:49:38 +00002155 sqliteFree(pPager->aHash);
danielk19778186df82007-03-06 13:45:59 +00002156 sqliteFree(pPager->pTmpSpace);
drhed7c8552001-04-11 14:29:21 +00002157 sqliteFree(pPager);
2158 return SQLITE_OK;
2159}
2160
2161/*
drh5e00f6c2001-09-13 13:46:56 +00002162** Return the page number for the given page data.
drhed7c8552001-04-11 14:29:21 +00002163*/
danielk19773b8a05f2007-03-19 17:44:26 +00002164Pgno sqlite3PagerPagenumber(DbPage *p){
drhed7c8552001-04-11 14:29:21 +00002165 return p->pgno;
2166}
2167
2168/*
drhc8629a12004-05-08 20:07:40 +00002169** The page_ref() function increments the reference count for a page.
2170** If the page is currently on the freelist (the reference count is zero) then
drh7e3b0a02001-04-28 16:52:40 +00002171** remove it from the freelist.
drhc8629a12004-05-08 20:07:40 +00002172**
2173** For non-test systems, page_ref() is a macro that calls _page_ref()
2174** online of the reference count is zero. For test systems, page_ref()
2175** is a real function so that we can set breakpoints and trace it.
drh7e3b0a02001-04-28 16:52:40 +00002176*/
drh836faa42003-01-11 13:30:57 +00002177static void _page_ref(PgHdr *pPg){
drh7e3b0a02001-04-28 16:52:40 +00002178 if( pPg->nRef==0 ){
2179 /* The page is currently on the freelist. Remove it. */
drh341eae82003-01-21 02:39:36 +00002180 if( pPg==pPg->pPager->pFirstSynced ){
2181 PgHdr *p = pPg->pNextFree;
2182 while( p && p->needSync ){ p = p->pNextFree; }
2183 pPg->pPager->pFirstSynced = p;
2184 }
drh7e3b0a02001-04-28 16:52:40 +00002185 if( pPg->pPrevFree ){
2186 pPg->pPrevFree->pNextFree = pPg->pNextFree;
2187 }else{
2188 pPg->pPager->pFirst = pPg->pNextFree;
2189 }
2190 if( pPg->pNextFree ){
2191 pPg->pNextFree->pPrevFree = pPg->pPrevFree;
2192 }else{
2193 pPg->pPager->pLast = pPg->pPrevFree;
2194 }
2195 pPg->pPager->nRef++;
2196 }
2197 pPg->nRef++;
drhdd793422001-06-28 01:54:48 +00002198 REFINFO(pPg);
drhdf0b3b02001-06-23 11:36:20 +00002199}
danielk1977aca790a2005-01-13 11:07:52 +00002200#ifdef SQLITE_DEBUG
drhc8629a12004-05-08 20:07:40 +00002201 static void page_ref(PgHdr *pPg){
2202 if( pPg->nRef==0 ){
2203 _page_ref(pPg);
2204 }else{
2205 pPg->nRef++;
2206 REFINFO(pPg);
2207 }
2208 }
2209#else
2210# define page_ref(P) ((P)->nRef==0?_page_ref(P):(void)(P)->nRef++)
2211#endif
drhdf0b3b02001-06-23 11:36:20 +00002212
2213/*
2214** Increment the reference count for a page. The input pointer is
2215** a reference to the page data.
2216*/
danielk19773b8a05f2007-03-19 17:44:26 +00002217int sqlite3PagerRef(DbPage *pPg){
drhdf0b3b02001-06-23 11:36:20 +00002218 page_ref(pPg);
drh8c42ca92001-06-22 19:15:00 +00002219 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +00002220}
2221
2222/*
drh34e79ce2004-02-08 06:05:46 +00002223** Sync the journal. In other words, make sure all the pages that have
2224** been written to the journal have actually reached the surface of the
2225** disk. It is not safe to modify the original database file until after
2226** the journal has been synced. If the original database is modified before
2227** the journal is synced and a power failure occurs, the unsynced journal
2228** data would be lost and we would be unable to completely rollback the
2229** database changes. Database corruption would occur.
2230**
2231** This routine also updates the nRec field in the header of the journal.
2232** (See comments on the pager_playback() routine for additional information.)
2233** If the sync mode is FULL, two syncs will occur. First the whole journal
2234** is synced, then the nRec field is updated, then a second sync occurs.
drhb19a2bc2001-09-16 00:13:26 +00002235**
drh34e79ce2004-02-08 06:05:46 +00002236** For temporary databases, we do not care if we are able to rollback
2237** after a power failure, so sync occurs.
drhfa86c412002-02-02 15:01:15 +00002238**
drh34e79ce2004-02-08 06:05:46 +00002239** This routine clears the needSync field of every page current held in
2240** memory.
drh50e5dad2001-09-15 00:57:28 +00002241*/
danielk197776572402004-06-25 02:38:54 +00002242static int syncJournal(Pager *pPager){
drh50e5dad2001-09-15 00:57:28 +00002243 PgHdr *pPg;
2244 int rc = SQLITE_OK;
drh03eb96a2002-11-10 23:32:56 +00002245
2246 /* Sync the journal before modifying the main database
2247 ** (assuming there is a journal and it needs to be synced.)
2248 */
danielk197776572402004-06-25 02:38:54 +00002249 if( pPager->needSync ){
drhfa86c412002-02-02 15:01:15 +00002250 if( !pPager->tempFile ){
drhdb48ee02003-01-16 13:42:43 +00002251 assert( pPager->journalOpen );
drh946966f2004-02-25 02:20:41 +00002252 /* assert( !pPager->noSync ); // noSync might be set if synchronous
2253 ** was turned off after the transaction was started. Ticket #615 */
drh968af522003-02-11 14:55:40 +00002254#ifndef NDEBUG
2255 {
drh34e79ce2004-02-08 06:05:46 +00002256 /* Make sure the pPager->nRec counter we are keeping agrees
2257 ** with the nRec computed from the size of the journal file.
2258 */
drheb206252004-10-01 02:00:31 +00002259 i64 jSz;
drh054889e2005-11-30 03:20:31 +00002260 rc = sqlite3OsFileSize(pPager->jfd, &jSz);
drh968af522003-02-11 14:55:40 +00002261 if( rc!=0 ) return rc;
danielk197776572402004-06-25 02:38:54 +00002262 assert( pPager->journalOff==jSz );
drh968af522003-02-11 14:55:40 +00002263 }
2264#endif
drhae2b40c2004-06-09 19:03:54 +00002265 {
danielk197776572402004-06-25 02:38:54 +00002266 /* Write the nRec value into the journal file header. If in
2267 ** full-synchronous mode, sync the journal first. This ensures that
2268 ** all data has really hit the disk before nRec is updated to mark
2269 ** it as a candidate for rollback.
2270 */
drhd8d66e82003-02-12 02:10:15 +00002271 if( pPager->fullSync ){
drh4f0c5872007-03-26 22:05:01 +00002272 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002273 IOTRACE(("JSYNC %p\n", pPager))
drh054889e2005-11-30 03:20:31 +00002274 rc = sqlite3OsSync(pPager->jfd, 0);
drhd8d66e82003-02-12 02:10:15 +00002275 if( rc!=0 ) return rc;
2276 }
drh054889e2005-11-30 03:20:31 +00002277 rc = sqlite3OsSeek(pPager->jfd,
drhb4746b92005-09-09 01:32:06 +00002278 pPager->journalHdr + sizeof(aJournalMagic));
2279 if( rc ) return rc;
drhb0603412007-02-28 04:47:26 +00002280 IOTRACE(("JHDR %p %lld %d\n", pPager,
2281 pPager->journalHdr + sizeof(aJournalMagic), 4))
drh9cbe6352005-11-29 03:13:21 +00002282 rc = write32bits(pPager->jfd, pPager->nRec);
drh99ee3602003-02-16 19:13:36 +00002283 if( rc ) return rc;
danielk197713adf8a2004-06-03 16:08:41 +00002284
drh054889e2005-11-30 03:20:31 +00002285 rc = sqlite3OsSeek(pPager->jfd, pPager->journalOff);
drhb4746b92005-09-09 01:32:06 +00002286 if( rc ) return rc;
drh968af522003-02-11 14:55:40 +00002287 }
drh4f0c5872007-03-26 22:05:01 +00002288 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002289 IOTRACE(("JSYNC %d\n", pPager))
drhac530b12006-02-11 01:25:50 +00002290 rc = sqlite3OsSync(pPager->jfd, pPager->full_fsync);
drhfa86c412002-02-02 15:01:15 +00002291 if( rc!=0 ) return rc;
drhdb48ee02003-01-16 13:42:43 +00002292 pPager->journalStarted = 1;
drhfa86c412002-02-02 15:01:15 +00002293 }
drh50e5dad2001-09-15 00:57:28 +00002294 pPager->needSync = 0;
drh341eae82003-01-21 02:39:36 +00002295
2296 /* Erase the needSync flag from every page.
2297 */
2298 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2299 pPg->needSync = 0;
2300 }
2301 pPager->pFirstSynced = pPager->pFirst;
drh50e5dad2001-09-15 00:57:28 +00002302 }
drh03eb96a2002-11-10 23:32:56 +00002303
drh341eae82003-01-21 02:39:36 +00002304#ifndef NDEBUG
2305 /* If the Pager.needSync flag is clear then the PgHdr.needSync
2306 ** flag must also be clear for all pages. Verify that this
2307 ** invariant is true.
drh03eb96a2002-11-10 23:32:56 +00002308 */
drh341eae82003-01-21 02:39:36 +00002309 else{
2310 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2311 assert( pPg->needSync==0 );
2312 }
2313 assert( pPager->pFirstSynced==pPager->pFirst );
drh03eb96a2002-11-10 23:32:56 +00002314 }
drh341eae82003-01-21 02:39:36 +00002315#endif
drhdb48ee02003-01-16 13:42:43 +00002316
drh81a20f22001-10-12 17:30:04 +00002317 return rc;
drh50e5dad2001-09-15 00:57:28 +00002318}
2319
2320/*
drhdc3e10b2006-06-15 14:31:06 +00002321** Merge two lists of pages connected by pDirty and in pgno order.
2322** Do not both fixing the pPrevDirty pointers.
2323*/
2324static PgHdr *merge_pagelist(PgHdr *pA, PgHdr *pB){
2325 PgHdr result, *pTail;
2326 pTail = &result;
2327 while( pA && pB ){
2328 if( pA->pgno<pB->pgno ){
2329 pTail->pDirty = pA;
2330 pTail = pA;
2331 pA = pA->pDirty;
2332 }else{
2333 pTail->pDirty = pB;
2334 pTail = pB;
2335 pB = pB->pDirty;
2336 }
2337 }
2338 if( pA ){
2339 pTail->pDirty = pA;
2340 }else if( pB ){
2341 pTail->pDirty = pB;
2342 }else{
2343 pTail->pDirty = 0;
2344 }
2345 return result.pDirty;
2346}
2347
2348/*
2349** Sort the list of pages in accending order by pgno. Pages are
2350** connected by pDirty pointers. The pPrevDirty pointers are
2351** corrupted by this sort.
2352*/
danielk197724168722007-04-02 05:07:47 +00002353#define N_SORT_BUCKET_ALLOC 25
2354#define N_SORT_BUCKET 25
2355#ifdef SQLITE_TEST
2356 int sqlite3_pager_n_sort_bucket = 0;
2357 #undef N_SORT_BUCKET
2358 #define N_SORT_BUCKET \
2359 (sqlite3_pager_n_sort_bucket?sqlite3_pager_n_sort_bucket:N_SORT_BUCKET_ALLOC)
2360#endif
drhdc3e10b2006-06-15 14:31:06 +00002361static PgHdr *sort_pagelist(PgHdr *pIn){
danielk197724168722007-04-02 05:07:47 +00002362 PgHdr *a[N_SORT_BUCKET_ALLOC], *p;
drhdc3e10b2006-06-15 14:31:06 +00002363 int i;
2364 memset(a, 0, sizeof(a));
2365 while( pIn ){
2366 p = pIn;
2367 pIn = p->pDirty;
2368 p->pDirty = 0;
2369 for(i=0; i<N_SORT_BUCKET-1; i++){
2370 if( a[i]==0 ){
2371 a[i] = p;
2372 break;
2373 }else{
2374 p = merge_pagelist(a[i], p);
2375 a[i] = 0;
2376 }
2377 }
2378 if( i==N_SORT_BUCKET-1 ){
danielk197724168722007-04-02 05:07:47 +00002379 /* Coverage: To get here, there need to be 2^(N_SORT_BUCKET)
2380 ** elements in the input list. This is possible, but impractical.
2381 ** Testing this line is the point of global variable
2382 ** sqlite3_pager_n_sort_bucket.
2383 */
drhdc3e10b2006-06-15 14:31:06 +00002384 a[i] = merge_pagelist(a[i], p);
2385 }
2386 }
2387 p = a[0];
2388 for(i=1; i<N_SORT_BUCKET; i++){
2389 p = merge_pagelist(p, a[i]);
2390 }
2391 return p;
2392}
2393
2394/*
drh2554f8b2003-01-22 01:26:44 +00002395** Given a list of pages (connected by the PgHdr.pDirty pointer) write
2396** every one of those pages out to the database file and mark them all
2397** as clean.
2398*/
2399static int pager_write_pagelist(PgHdr *pList){
2400 Pager *pPager;
2401 int rc;
2402
2403 if( pList==0 ) return SQLITE_OK;
2404 pPager = pList->pPager;
danielk19779eed5052004-06-04 10:38:30 +00002405
2406 /* At this point there may be either a RESERVED or EXCLUSIVE lock on the
2407 ** database file. If there is already an EXCLUSIVE lock, the following
drh054889e2005-11-30 03:20:31 +00002408 ** calls to sqlite3OsLock() are no-ops.
danielk19779eed5052004-06-04 10:38:30 +00002409 **
drha6abd042004-06-09 17:37:22 +00002410 ** Moving the lock from RESERVED to EXCLUSIVE actually involves going
2411 ** through an intermediate state PENDING. A PENDING lock prevents new
2412 ** readers from attaching to the database but is unsufficient for us to
2413 ** write. The idea of a PENDING lock is to prevent new readers from
2414 ** coming in while we wait for existing readers to clear.
danielk19779eed5052004-06-04 10:38:30 +00002415 **
drha6abd042004-06-09 17:37:22 +00002416 ** While the pager is in the RESERVED state, the original database file
2417 ** is unchanged and we can rollback without having to playback the
2418 ** journal into the original database file. Once we transition to
2419 ** EXCLUSIVE, it means the database file has been changed and any rollback
2420 ** will require a journal playback.
danielk19779eed5052004-06-04 10:38:30 +00002421 */
drh684917c2004-10-05 02:41:42 +00002422 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
danielk19779eed5052004-06-04 10:38:30 +00002423 if( rc!=SQLITE_OK ){
2424 return rc;
2425 }
2426
drhdc3e10b2006-06-15 14:31:06 +00002427 pList = sort_pagelist(pList);
drh2554f8b2003-01-22 01:26:44 +00002428 while( pList ){
2429 assert( pList->dirty );
drh054889e2005-11-30 03:20:31 +00002430 rc = sqlite3OsSeek(pPager->fd, (pList->pgno-1)*(i64)pPager->pageSize);
drhb4746b92005-09-09 01:32:06 +00002431 if( rc ) return rc;
danielk1977687566d2004-11-02 12:56:41 +00002432 /* If there are dirty pages in the page cache with page numbers greater
danielk19773b8a05f2007-03-19 17:44:26 +00002433 ** than Pager.dbSize, this means sqlite3PagerTruncate() was called to
danielk1977687566d2004-11-02 12:56:41 +00002434 ** make the file smaller (presumably by auto-vacuum code). Do not write
2435 ** any such pages to the file.
2436 */
2437 if( pList->pgno<=pPager->dbSize ){
drhc001c582006-03-06 18:23:16 +00002438 char *pData = CODEC2(pPager, PGHDR_TO_DATA(pList), pList->pgno, 6);
drh4f0c5872007-03-26 22:05:01 +00002439 PAGERTRACE3("STORE %d page %d\n", PAGERID(pPager), pList->pgno);
drh538f5702007-04-13 02:14:30 +00002440 IOTRACE(("PGOUT %p %d\n", pPager, pList->pgno));
drhc001c582006-03-06 18:23:16 +00002441 rc = sqlite3OsWrite(pPager->fd, pData, pPager->pageSize);
drh538f5702007-04-13 02:14:30 +00002442 PAGER_INCR(sqlite3_pager_writedb_count);
2443 PAGER_INCR(pPager->nWrite);
danielk1977687566d2004-11-02 12:56:41 +00002444 }
2445#ifndef NDEBUG
2446 else{
drh4f0c5872007-03-26 22:05:01 +00002447 PAGERTRACE3("NOSTORE %d page %d\n", PAGERID(pPager), pList->pgno);
danielk1977687566d2004-11-02 12:56:41 +00002448 }
2449#endif
drh2554f8b2003-01-22 01:26:44 +00002450 if( rc ) return rc;
2451 pList->dirty = 0;
danielk19773c407372005-02-15 02:54:14 +00002452#ifdef SQLITE_CHECK_PAGES
2453 pList->pageHash = pager_pagehash(pList);
2454#endif
drh2554f8b2003-01-22 01:26:44 +00002455 pList = pList->pDirty;
2456 }
2457 return SQLITE_OK;
2458}
2459
2460/*
2461** Collect every dirty page into a dirty list and
2462** return a pointer to the head of that list. All pages are
2463** collected even if they are still in use.
2464*/
2465static PgHdr *pager_get_all_dirty_pages(Pager *pPager){
drh605ad8f2006-05-03 23:34:05 +00002466 return pPager->pDirty;
drh2554f8b2003-01-22 01:26:44 +00002467}
2468
2469/*
drh165ffe92005-03-15 17:09:30 +00002470** Return TRUE if there is a hot journal on the given pager.
2471** A hot journal is one that needs to be played back.
2472**
2473** If the current size of the database file is 0 but a journal file
2474** exists, that is probably an old journal left over from a prior
2475** database with the same name. Just delete the journal.
2476*/
2477static int hasHotJournal(Pager *pPager){
2478 if( !pPager->useJournal ) return 0;
drhbb5f18d2007-04-06 18:23:17 +00002479 if( !sqlite3OsFileExists(pPager->zJournal) ){
2480 return 0;
2481 }
2482 if( sqlite3OsCheckReservedLock(pPager->fd) ){
2483 return 0;
2484 }
danielk19773b8a05f2007-03-19 17:44:26 +00002485 if( sqlite3PagerPagecount(pPager)==0 ){
drh66560ad2006-01-06 14:32:19 +00002486 sqlite3OsDelete(pPager->zJournal);
drh165ffe92005-03-15 17:09:30 +00002487 return 0;
2488 }else{
2489 return 1;
2490 }
2491}
2492
danielk19775591df52005-12-20 09:19:37 +00002493/*
danielk1977aef0bf62005-12-30 16:28:01 +00002494** Try to find a page in the cache that can be recycled.
2495**
2496** This routine may return SQLITE_IOERR, SQLITE_FULL or SQLITE_OK. It
danielk1977efaaf572006-01-16 11:29:19 +00002497** does not set the pPager->errCode variable.
danielk19775591df52005-12-20 09:19:37 +00002498*/
danielk197713f72992005-12-18 08:51:22 +00002499static int pager_recycle(Pager *pPager, int syncOk, PgHdr **ppPg){
2500 PgHdr *pPg;
2501 *ppPg = 0;
2502
danielk1977c551edc2007-04-05 13:12:13 +00002503 assert(!MEMDB);
2504
danielk197713f72992005-12-18 08:51:22 +00002505 /* Find a page to recycle. Try to locate a page that does not
2506 ** require us to do an fsync() on the journal.
2507 */
2508 pPg = pPager->pFirstSynced;
2509
2510 /* If we could not find a page that does not require an fsync()
2511 ** on the journal file then fsync the journal file. This is a
2512 ** very slow operation, so we work hard to avoid it. But sometimes
2513 ** it can't be helped.
2514 */
danielk19775591df52005-12-20 09:19:37 +00002515 if( pPg==0 && pPager->pFirst && syncOk && !MEMDB){
danielk197713f72992005-12-18 08:51:22 +00002516 int rc = syncJournal(pPager);
2517 if( rc!=0 ){
danielk1977aef0bf62005-12-30 16:28:01 +00002518 return rc;
danielk197713f72992005-12-18 08:51:22 +00002519 }
2520 if( pPager->fullSync ){
2521 /* If in full-sync mode, write a new journal header into the
2522 ** journal file. This is done to avoid ever modifying a journal
2523 ** header that is involved in the rollback of pages that have
2524 ** already been written to the database (in case the header is
2525 ** trashed when the nRec field is updated).
2526 */
2527 pPager->nRec = 0;
2528 assert( pPager->journalOff > 0 );
danielk19774099f6e2007-03-19 11:25:20 +00002529 assert( pPager->doNotSync==0 );
danielk197713f72992005-12-18 08:51:22 +00002530 rc = writeJournalHdr(pPager);
2531 if( rc!=0 ){
danielk1977aef0bf62005-12-30 16:28:01 +00002532 return rc;
danielk197713f72992005-12-18 08:51:22 +00002533 }
2534 }
2535 pPg = pPager->pFirst;
2536 }
2537 if( pPg==0 ){
2538 return SQLITE_OK;
2539 }
2540
2541 assert( pPg->nRef==0 );
2542
2543 /* Write the page to the database file if it is dirty.
2544 */
2545 if( pPg->dirty ){
2546 int rc;
2547 assert( pPg->needSync==0 );
drh605ad8f2006-05-03 23:34:05 +00002548 makeClean(pPg);
2549 pPg->dirty = 1;
danielk197713f72992005-12-18 08:51:22 +00002550 pPg->pDirty = 0;
2551 rc = pager_write_pagelist( pPg );
2552 if( rc!=SQLITE_OK ){
danielk1977aef0bf62005-12-30 16:28:01 +00002553 return rc;
danielk197713f72992005-12-18 08:51:22 +00002554 }
2555 }
2556 assert( pPg->dirty==0 );
2557
2558 /* If the page we are recycling is marked as alwaysRollback, then
2559 ** set the global alwaysRollback flag, thus disabling the
drh80e35f42007-03-30 14:06:34 +00002560 ** sqlite3PagerDontRollback() optimization for the rest of this transaction.
danielk197713f72992005-12-18 08:51:22 +00002561 ** It is necessary to do this because the page marked alwaysRollback
2562 ** might be reloaded at a later time but at that point we won't remember
2563 ** that is was marked alwaysRollback. This means that all pages must
2564 ** be marked as alwaysRollback from here on out.
2565 */
2566 if( pPg->alwaysRollback ){
drh602c2372007-03-01 00:29:13 +00002567 IOTRACE(("ALWAYS_ROLLBACK %p\n", pPager))
danielk197713f72992005-12-18 08:51:22 +00002568 pPager->alwaysRollback = 1;
2569 }
2570
2571 /* Unlink the old page from the free list and the hash table
2572 */
2573 unlinkPage(pPg);
drh7c4ac0c2007-04-05 11:25:58 +00002574 assert( pPg->pgno==0 );
danielk197713f72992005-12-18 08:51:22 +00002575
2576 *ppPg = pPg;
2577 return SQLITE_OK;
2578}
2579
2580/*
2581** This function is called to free superfluous dynamically allocated memory
2582** held by the pager system. Memory in use by any SQLite pager allocated
2583** by the current thread may be sqliteFree()ed.
2584**
2585** nReq is the number of bytes of memory required. Once this much has
danielk19770190d1d2005-12-19 14:18:11 +00002586** been released, the function returns. A negative value for nReq means
2587** free as much memory as possible. The return value is the total number
danielk197713f72992005-12-18 08:51:22 +00002588** of bytes of memory released.
2589*/
drh6f7adc82006-01-11 21:41:20 +00002590#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
danielk19773b8a05f2007-03-19 17:44:26 +00002591int sqlite3PagerReleaseMemory(int nReq){
drh6f7adc82006-01-11 21:41:20 +00002592 const ThreadData *pTsdro = sqlite3ThreadDataReadOnly();
danielk197713f72992005-12-18 08:51:22 +00002593 int nReleased = 0;
2594 int i;
2595
drh29c636b2006-01-09 23:40:25 +00002596 /* If the the global mutex is held, this subroutine becomes a
2597 ** o-op; zero bytes of memory are freed. This is because
2598 ** some of the code invoked by this function may also
2599 ** try to obtain the mutex, resulting in a deadlock.
danielk1977441b09a2006-01-05 13:48:29 +00002600 */
drh757b04e2006-01-18 17:25:45 +00002601 if( sqlite3OsInMutex(0) ){
danielk1977441b09a2006-01-05 13:48:29 +00002602 return 0;
2603 }
2604
danielk197713f72992005-12-18 08:51:22 +00002605 /* Outermost loop runs for at most two iterations. First iteration we
2606 ** try to find memory that can be released without calling fsync(). Second
2607 ** iteration (which only runs if the first failed to free nReq bytes of
2608 ** memory) is permitted to call fsync(). This is of course much more
2609 ** expensive.
2610 */
drh29c636b2006-01-09 23:40:25 +00002611 for(i=0; i<=1; i++){
danielk197713f72992005-12-18 08:51:22 +00002612
2613 /* Loop through all the SQLite pagers opened by the current thread. */
danielk197738ec0cb2007-04-05 14:29:42 +00002614 Pager *pPager = pTsdro->pPager;
2615 for( ; pPager && (nReq<0 || nReleased<nReq); pPager=pPager->pNext){
danielk197713f72992005-12-18 08:51:22 +00002616 PgHdr *pPg;
2617 int rc;
2618
danielk197738ec0cb2007-04-05 14:29:42 +00002619 if( MEMDB ){
danielk1977c551edc2007-04-05 13:12:13 +00002620 continue;
2621 }
danielk1977c551edc2007-04-05 13:12:13 +00002622
danielk197713f72992005-12-18 08:51:22 +00002623 /* For each pager, try to free as many pages as possible (without
2624 ** calling fsync() if this is the first iteration of the outermost
2625 ** loop).
2626 */
danielk197738ec0cb2007-04-05 14:29:42 +00002627 while( SQLITE_OK==(rc = pager_recycle(pPager, i, &pPg)) && pPg) {
danielk1977aef0bf62005-12-30 16:28:01 +00002628 /* We've found a page to free. At this point the page has been
danielk197713f72992005-12-18 08:51:22 +00002629 ** removed from the page hash-table, free-list and synced-list
danielk1977aef0bf62005-12-30 16:28:01 +00002630 ** (pFirstSynced). It is still in the all pages (pAll) list.
danielk197713f72992005-12-18 08:51:22 +00002631 ** Remove it from this list before freeing.
2632 **
2633 ** Todo: Check the Pager.pStmt list to make sure this is Ok. It
2634 ** probably is though.
2635 */
2636 PgHdr *pTmp;
danielk19770190d1d2005-12-19 14:18:11 +00002637 assert( pPg );
danielk197738ec0cb2007-04-05 14:29:42 +00002638 if( pPg==pPager->pAll ){
2639 pPager->pAll = pPg->pNextAll;
danielk197713f72992005-12-18 08:51:22 +00002640 }else{
danielk197738ec0cb2007-04-05 14:29:42 +00002641 for( pTmp=pPager->pAll; pTmp->pNextAll!=pPg; pTmp=pTmp->pNextAll ){}
danielk197713f72992005-12-18 08:51:22 +00002642 pTmp->pNextAll = pPg->pNextAll;
2643 }
2644 nReleased += sqliteAllocSize(pPg);
drh538f5702007-04-13 02:14:30 +00002645 IOTRACE(("PGFREE %p %d\n", pPager, pPg->pgno));
2646 PAGER_INCR(sqlite3_pager_pgfree_count);
danielk197713f72992005-12-18 08:51:22 +00002647 sqliteFree(pPg);
2648 }
2649
2650 if( rc!=SQLITE_OK ){
danielk1977aef0bf62005-12-30 16:28:01 +00002651 /* An error occured whilst writing to the database file or
2652 ** journal in pager_recycle(). The error is not returned to the
danielk1977efaaf572006-01-16 11:29:19 +00002653 ** caller of this function. Instead, set the Pager.errCode variable.
danielk1977aef0bf62005-12-30 16:28:01 +00002654 ** The error will be returned to the user (or users, in the case
2655 ** of a shared pager cache) of the pager for which the error occured.
danielk197713f72992005-12-18 08:51:22 +00002656 */
drh4ac285a2006-09-15 07:28:50 +00002657 assert( (rc&0xff)==SQLITE_IOERR || rc==SQLITE_FULL );
danielk197738ec0cb2007-04-05 14:29:42 +00002658 assert( pPager->state>=PAGER_RESERVED );
2659 pager_error(pPager, rc);
danielk197713f72992005-12-18 08:51:22 +00002660 }
2661 }
2662 }
danielk1977aef0bf62005-12-30 16:28:01 +00002663
danielk197713f72992005-12-18 08:51:22 +00002664 return nReleased;
2665}
drh6f7adc82006-01-11 21:41:20 +00002666#endif /* SQLITE_ENABLE_MEMORY_MANAGEMENT */
danielk197713f72992005-12-18 08:51:22 +00002667
drh165ffe92005-03-15 17:09:30 +00002668/*
danielk1977e180dd92007-04-05 17:15:52 +00002669** Read the content of page pPg out of the database file.
2670*/
2671static int readDbPage(Pager *pPager, PgHdr *pPg, Pgno pgno){
2672 int rc;
2673 assert( MEMDB==0 );
2674 rc = sqlite3OsSeek(pPager->fd, (pgno-1)*(i64)pPager->pageSize);
2675 if( rc==SQLITE_OK ){
2676 rc = sqlite3OsRead(pPager->fd, PGHDR_TO_DATA(pPg),
2677 pPager->pageSize);
2678 }
drh538f5702007-04-13 02:14:30 +00002679 PAGER_INCR(sqlite3_pager_readdb_count);
2680 PAGER_INCR(pPager->nRead);
2681 IOTRACE(("PGIN %p %d\n", pPager, pgno));
danielk1977e180dd92007-04-05 17:15:52 +00002682 PAGERTRACE3("FETCH %d page %d\n", PAGERID(pPager), pPg->pgno);
2683 CODEC1(pPager, PGHDR_TO_DATA(pPg), pPg->pgno, 3);
2684 return rc;
2685}
2686
2687
2688/*
danielk1977e277be02007-03-23 18:12:06 +00002689** This function is called to obtain the shared lock required before
2690** data may be read from the pager cache. If the shared lock has already
2691** been obtained, this function is a no-op.
danielk1977393f0682007-03-31 10:00:48 +00002692**
2693** Immediately after obtaining the shared lock (if required), this function
2694** checks for a hot-journal file. If one is found, an emergency rollback
2695** is performed immediately.
danielk1977e277be02007-03-23 18:12:06 +00002696*/
2697static int pagerSharedLock(Pager *pPager){
2698 int rc = SQLITE_OK;
2699
2700 if( pPager->state==PAGER_UNLOCK ){
2701 if( !MEMDB ){
2702 assert( pPager->nRef==0 );
2703 if( !pPager->noReadlock ){
2704 rc = pager_wait_on_lock(pPager, SHARED_LOCK);
2705 if( rc!=SQLITE_OK ){
2706 return pager_error(pPager, rc);
2707 }
2708 assert( pPager->state>=SHARED_LOCK );
2709 }
2710
2711 /* If a journal file exists, and there is no RESERVED lock on the
2712 ** database file, then it either needs to be played back or deleted.
2713 */
2714 if( hasHotJournal(pPager) ){
2715 /* Get an EXCLUSIVE lock on the database file. At this point it is
2716 ** important that a RESERVED lock is not obtained on the way to the
2717 ** EXCLUSIVE lock. If it were, another process might open the
2718 ** database file, detect the RESERVED lock, and conclude that the
2719 ** database is safe to read while this process is still rolling it
2720 ** back.
2721 **
2722 ** Because the intermediate RESERVED lock is not requested, the
2723 ** second process will get to this point in the code and fail to
2724 ** obtain it's own EXCLUSIVE lock on the database file.
2725 */
2726 rc = sqlite3OsLock(pPager->fd, EXCLUSIVE_LOCK);
2727 if( rc!=SQLITE_OK ){
2728 pager_unlock(pPager);
2729 return pager_error(pPager, rc);
2730 }
2731 pPager->state = PAGER_EXCLUSIVE;
2732
2733 /* Open the journal for reading only. Return SQLITE_BUSY if
2734 ** we are unable to open the journal file.
2735 **
2736 ** The journal file does not need to be locked itself. The
2737 ** journal file is never open unless the main database file holds
2738 ** a write lock, so there is never any chance of two or more
2739 ** processes opening the journal at the same time.
danielk1977979f38e2007-03-27 16:19:51 +00002740 **
2741 ** Open the journal for read/write access. This is because in
2742 ** exclusive-access mode the file descriptor will be kept open and
2743 ** possibly used for a transaction later on. On some systems, the
2744 ** OsTruncate() call used in exclusive-access mode also requires
2745 ** a read/write file handle.
danielk1977e277be02007-03-23 18:12:06 +00002746 */
danielk1977979f38e2007-03-27 16:19:51 +00002747 rc = SQLITE_BUSY;
2748 if( sqlite3OsFileExists(pPager->zJournal) ){
2749 int ro;
danielk19777152de82007-03-29 17:28:14 +00002750 assert( !pPager->tempFile );
danielk1977979f38e2007-03-27 16:19:51 +00002751 rc = sqlite3OsOpenReadWrite(pPager->zJournal, &pPager->jfd, &ro);
danielk19775bb16fe2007-04-05 11:54:42 +00002752 assert( rc!=SQLITE_OK || pPager->jfd );
danielk1977979f38e2007-03-27 16:19:51 +00002753 if( ro ){
2754 rc = SQLITE_BUSY;
danielk197708d31a22007-04-02 11:08:58 +00002755 sqlite3OsClose(&pPager->jfd);
danielk1977979f38e2007-03-27 16:19:51 +00002756 }
2757 }
danielk1977e277be02007-03-23 18:12:06 +00002758 if( rc!=SQLITE_OK ){
2759 pager_unlock(pPager);
2760 return SQLITE_BUSY;
2761 }
2762 pPager->journalOpen = 1;
2763 pPager->journalStarted = 0;
2764 pPager->journalOff = 0;
2765 pPager->setMaster = 0;
2766 pPager->journalHdr = 0;
2767
2768 /* Playback and delete the journal. Drop the database write
2769 ** lock and reacquire the read lock.
2770 */
2771 rc = pager_playback(pPager, 1);
2772 if( rc!=SQLITE_OK ){
2773 return pager_error(pPager, rc);
2774 }
danielk1977c5859712007-03-26 12:26:27 +00002775 assert(pPager->state==PAGER_SHARED ||
2776 (pPager->exclusiveMode && pPager->state>PAGER_SHARED)
2777 );
danielk1977e277be02007-03-23 18:12:06 +00002778 }
2779
2780 if( pPager->pAll ){
danielk197724168722007-04-02 05:07:47 +00002781 /* The shared-lock has just been acquired on the database file
2782 ** and there are already pages in the cache (from a previous
2783 ** read or write transaction). If the value of the change-counter
2784 ** stored in Pager.iChangeCount matches that found on page 1 of
2785 ** the database file, then no database changes have occured since
2786 ** the cache was last valid and it is safe to retain the cached
2787 ** pages. Otherwise, if Pager.iChangeCount does not match the
2788 ** change-counter on page 1 of the file, the current cache contents
2789 ** must be discarded.
2790 */
danielk1977e180dd92007-04-05 17:15:52 +00002791 u8 zC[4];
2792 u32 iChangeCounter = 0;
2793 sqlite3PagerPagecount(pPager);
danielk197724168722007-04-02 05:07:47 +00002794
danielk1977e180dd92007-04-05 17:15:52 +00002795 if( pPager->errCode ){
2796 return pPager->errCode;
danielk1977e277be02007-03-23 18:12:06 +00002797 }
2798
danielk1977e180dd92007-04-05 17:15:52 +00002799 if( pPager->dbSize>0 ){
2800 /* Read the 4-byte change counter directly from the file. */
2801 rc = sqlite3OsSeek(pPager->fd, 24);
2802 if( rc!=SQLITE_OK ){
2803 return rc;
danielk1977e277be02007-03-23 18:12:06 +00002804 }
danielk1977e180dd92007-04-05 17:15:52 +00002805 rc = sqlite3OsRead(pPager->fd, zC, 4);
2806 if( rc!=SQLITE_OK ){
2807 return rc;
2808 }
2809 iChangeCounter = (zC[0]<<24) + (zC[1]<<16) + (zC[2]<<8) + zC[3];
2810 }
2811
2812 if( iChangeCounter!=pPager->iChangeCount ){
2813 pager_reset(pPager);
drh538f5702007-04-13 02:14:30 +00002814 pPager->iChangeCount = iChangeCounter;
danielk1977e277be02007-03-23 18:12:06 +00002815 }
2816 }
2817 }
danielk1977c5859712007-03-26 12:26:27 +00002818 assert( pPager->exclusiveMode || pPager->state<=PAGER_SHARED );
2819 if( pPager->state==PAGER_UNLOCK ){
2820 pPager->state = PAGER_SHARED;
2821 }
danielk1977e277be02007-03-23 18:12:06 +00002822 }
2823
2824 return rc;
2825}
2826
2827/*
danielk1977e180dd92007-04-05 17:15:52 +00002828** Allocate a PgHdr object. Either create a new one or reuse
2829** an existing one that is not otherwise in use.
2830**
2831** A new PgHdr structure is created if any of the following are
2832** true:
2833**
2834** (1) We have not exceeded our maximum allocated cache size
2835** as set by the "PRAGMA cache_size" command.
2836**
2837** (2) There are no unused PgHdr objects available at this time.
2838**
2839** (3) This is an in-memory database.
2840**
2841** (4) There are no PgHdr objects that do not require a journal
2842** file sync and a sync of the journal file is currently
2843** prohibited.
2844**
2845** Otherwise, reuse an existing PgHdr. In other words, reuse an
2846** existing PgHdr if all of the following are true:
2847**
2848** (1) We have reached or exceeded the maximum cache size
2849** allowed by "PRAGMA cache_size".
2850**
2851** (2) There is a PgHdr available with PgHdr->nRef==0
2852**
2853** (3) We are not in an in-memory database
2854**
2855** (4) Either there is an available PgHdr that does not need
2856** to be synced to disk or else disk syncing is currently
2857** allowed.
danielk197724168722007-04-02 05:07:47 +00002858*/
2859static int pagerAllocatePage(Pager *pPager, PgHdr **ppPg){
2860 int rc = SQLITE_OK;
2861 PgHdr *pPg;
2862
danielk1977e180dd92007-04-05 17:15:52 +00002863 /* Create a new PgHdr if any of the four conditions defined
2864 ** above is met: */
2865 if( pPager->nPage<pPager->mxPage
2866 || pPager->pFirst==0
2867 || MEMDB
2868 || (pPager->pFirstSynced==0 && pPager->doNotSync)
2869 ){
danielk197724168722007-04-02 05:07:47 +00002870 if( pPager->nPage>=pPager->nHash ){
2871 pager_resize_hash_table(pPager,
2872 pPager->nHash<256 ? 256 : pPager->nHash*2);
2873 if( pPager->nHash==0 ){
2874 rc = SQLITE_NOMEM;
2875 goto pager_allocate_out;
2876 }
2877 }
2878 pPg = sqliteMallocRaw( sizeof(*pPg) + pPager->pageSize
2879 + sizeof(u32) + pPager->nExtra
2880 + MEMDB*sizeof(PgHistory) );
2881 if( pPg==0 ){
2882 rc = SQLITE_NOMEM;
2883 goto pager_allocate_out;
2884 }
2885 memset(pPg, 0, sizeof(*pPg));
2886 if( MEMDB ){
2887 memset(PGHDR_TO_HIST(pPg, pPager), 0, sizeof(PgHistory));
2888 }
2889 pPg->pPager = pPager;
2890 pPg->pNextAll = pPager->pAll;
2891 pPager->pAll = pPg;
2892 pPager->nPage++;
2893 if( pPager->nPage>pPager->nMaxPage ){
2894 assert( pPager->nMaxPage==(pPager->nPage-1) );
2895 pPager->nMaxPage++;
2896 }
2897 }else{
2898 /* Recycle an existing page with a zero ref-count. */
2899 rc = pager_recycle(pPager, 1, &pPg);
2900 if( rc!=SQLITE_OK ){
2901 goto pager_allocate_out;
2902 }
2903 assert( pPager->state>=SHARED_LOCK );
2904 assert(pPg);
2905 }
2906 *ppPg = pPg;
2907
2908pager_allocate_out:
2909 return rc;
2910}
2911
2912/*
drhd9b02572001-04-15 00:37:09 +00002913** Acquire a page.
2914**
drh58a11682001-11-10 13:51:08 +00002915** A read lock on the disk file is obtained when the first page is acquired.
drh5e00f6c2001-09-13 13:46:56 +00002916** This read lock is dropped when the last page is released.
drhd9b02572001-04-15 00:37:09 +00002917**
drh306dc212001-05-21 13:45:10 +00002918** A _get works for any page number greater than 0. If the database
2919** file is smaller than the requested page, then no actual disk
2920** read occurs and the memory image of the page is initialized to
2921** all zeros. The extra data appended to a page is always initialized
2922** to zeros the first time a page is loaded into memory.
2923**
drhd9b02572001-04-15 00:37:09 +00002924** The acquisition might fail for several reasons. In all cases,
2925** an appropriate error code is returned and *ppPage is set to NULL.
drh7e3b0a02001-04-28 16:52:40 +00002926**
danielk19773b8a05f2007-03-19 17:44:26 +00002927** See also sqlite3PagerLookup(). Both this routine and _lookup() attempt
drh7e3b0a02001-04-28 16:52:40 +00002928** to find a page in the in-memory cache first. If the page is not already
drh5e00f6c2001-09-13 13:46:56 +00002929** in memory, this routine goes to disk to read it in whereas _lookup()
drh7e3b0a02001-04-28 16:52:40 +00002930** just returns 0. This routine acquires a read-lock the first time it
2931** has to go to disk, and could also playback an old journal if necessary.
2932** Since _lookup() never goes to disk, it never has to deal with locks
2933** or journal files.
drh0787db62007-03-04 13:15:27 +00002934**
drh538f5702007-04-13 02:14:30 +00002935** If noContent is false, the page contents are actually read from disk.
2936** If noContent is true, it means that we do not care about the contents
2937** of the page at this time, so do not do a disk read. Just fill in the
2938** page content with zeros. But mark the fact that we have not read the
2939** content by setting the PgHdr.needRead flag. Later on, if
2940** sqlite3PagerWrite() is called on this page, that means that the
2941** content is needed and the disk read should occur at that point.
drhed7c8552001-04-11 14:29:21 +00002942*/
drh538f5702007-04-13 02:14:30 +00002943int sqlite3PagerAcquire(
2944 Pager *pPager, /* The pager open on the database file */
2945 Pgno pgno, /* Page number to fetch */
2946 DbPage **ppPage, /* Write a pointer to the page here */
2947 int noContent /* Do not bother reading content from disk if true */
2948){
drhed7c8552001-04-11 14:29:21 +00002949 PgHdr *pPg;
drh165ffe92005-03-15 17:09:30 +00002950 int rc;
drhed7c8552001-04-11 14:29:21 +00002951
danielk1977e277be02007-03-23 18:12:06 +00002952 assert( pPager->state==PAGER_UNLOCK || pPager->nRef>0 || pgno==1 );
2953
danielk197726836652005-01-17 01:33:13 +00002954 /* The maximum page number is 2^31. Return SQLITE_CORRUPT if a page
2955 ** number greater than this, or zero, is requested.
2956 */
drh267cb322005-09-16 17:16:52 +00002957 if( pgno>PAGER_MAX_PGNO || pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh49285702005-09-17 15:20:26 +00002958 return SQLITE_CORRUPT_BKPT;
danielk197726836652005-01-17 01:33:13 +00002959 }
2960
drhd9b02572001-04-15 00:37:09 +00002961 /* Make sure we have not hit any critical errors.
2962 */
drh836faa42003-01-11 13:30:57 +00002963 assert( pPager!=0 );
drh2e6d11b2003-04-25 15:37:57 +00002964 *ppPage = 0;
danielk1977efaaf572006-01-16 11:29:19 +00002965 if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
2966 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00002967 }
2968
danielk197713adf8a2004-06-03 16:08:41 +00002969 /* If this is the first page accessed, then get a SHARED lock
danielk1977334cdb62007-03-26 08:05:12 +00002970 ** on the database file. pagerSharedLock() is a no-op if
2971 ** a database lock is already held.
drhed7c8552001-04-11 14:29:21 +00002972 */
danielk1977e277be02007-03-23 18:12:06 +00002973 rc = pagerSharedLock(pPager);
2974 if( rc!=SQLITE_OK ){
2975 return rc;
drhed7c8552001-04-11 14:29:21 +00002976 }
danielk1977e277be02007-03-23 18:12:06 +00002977 assert( pPager->state!=PAGER_UNLOCK );
2978
2979 pPg = pager_lookup(pPager, pgno);
drhed7c8552001-04-11 14:29:21 +00002980 if( pPg==0 ){
drhd9b02572001-04-15 00:37:09 +00002981 /* The requested page is not in the page cache. */
danielk1977979f38e2007-03-27 16:19:51 +00002982 int nMax;
drhed7c8552001-04-11 14:29:21 +00002983 int h;
drh538f5702007-04-13 02:14:30 +00002984 PAGER_INCR(pPager->nMiss);
danielk197724168722007-04-02 05:07:47 +00002985 rc = pagerAllocatePage(pPager, &pPg);
2986 if( rc!=SQLITE_OK ){
2987 return rc;
drhed7c8552001-04-11 14:29:21 +00002988 }
danielk197724168722007-04-02 05:07:47 +00002989
drhed7c8552001-04-11 14:29:21 +00002990 pPg->pgno = pgno;
danielk1977f35843b2007-04-07 15:03:17 +00002991 assert( !MEMDB || pgno>pPager->stmtSize );
drh1ab43002002-01-14 09:28:19 +00002992 if( pPager->aInJournal && (int)pgno<=pPager->origDbSize ){
danielk19774adee202004-05-08 08:23:19 +00002993 sqlite3CheckMemory(pPager->aInJournal, pgno/8);
drhdb48ee02003-01-16 13:42:43 +00002994 assert( pPager->journalOpen );
drh6019e162001-07-02 17:51:45 +00002995 pPg->inJournal = (pPager->aInJournal[pgno/8] & (1<<(pgno&7)))!=0;
drhdb48ee02003-01-16 13:42:43 +00002996 pPg->needSync = 0;
drh6019e162001-07-02 17:51:45 +00002997 }else{
2998 pPg->inJournal = 0;
drhdb48ee02003-01-16 13:42:43 +00002999 pPg->needSync = 0;
drh6019e162001-07-02 17:51:45 +00003000 }
danielk1977f35843b2007-04-07 15:03:17 +00003001
drh605ad8f2006-05-03 23:34:05 +00003002 makeClean(pPg);
drhed7c8552001-04-11 14:29:21 +00003003 pPg->nRef = 1;
drhdd793422001-06-28 01:54:48 +00003004 REFINFO(pPg);
danielk197775bab7d2006-01-23 13:09:45 +00003005
drhd9b02572001-04-15 00:37:09 +00003006 pPager->nRef++;
drh2e6d11b2003-04-25 15:37:57 +00003007 if( pPager->nExtra>0 ){
drh90f5ecb2004-07-22 01:19:35 +00003008 memset(PGHDR_TO_EXTRA(pPg, pPager), 0, pPager->nExtra);
drh2e6d11b2003-04-25 15:37:57 +00003009 }
danielk1977979f38e2007-03-27 16:19:51 +00003010 nMax = sqlite3PagerPagecount(pPager);
danielk1977efaaf572006-01-16 11:29:19 +00003011 if( pPager->errCode ){
danielk19773b8a05f2007-03-19 17:44:26 +00003012 sqlite3PagerUnref(pPg);
danielk1977efaaf572006-01-16 11:29:19 +00003013 rc = pPager->errCode;
drh2e6d11b2003-04-25 15:37:57 +00003014 return rc;
3015 }
danielk197775bab7d2006-01-23 13:09:45 +00003016
3017 /* Populate the page with data, either by reading from the database
3018 ** file, or by setting the entire page to zero.
3019 */
drh538f5702007-04-13 02:14:30 +00003020 if( nMax<(int)pgno || MEMDB || noContent ){
drh90f5ecb2004-07-22 01:19:35 +00003021 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
drh538f5702007-04-13 02:14:30 +00003022 pPg->needRead = noContent;
3023 IOTRACE(("ZERO %p %d\n", pPager, pgno));
drh306dc212001-05-21 13:45:10 +00003024 }else{
danielk1977e180dd92007-04-05 17:15:52 +00003025 rc = readDbPage(pPager, pPg, pgno);
drh551b7732006-11-06 21:20:25 +00003026 if( rc!=SQLITE_OK && rc!=SQLITE_IOERR_SHORT_READ ){
3027 pPg->pgno = 0;
danielk19773b8a05f2007-03-19 17:44:26 +00003028 sqlite3PagerUnref(pPg);
drh551b7732006-11-06 21:20:25 +00003029 return rc;
drh81a20f22001-10-12 17:30:04 +00003030 }
drh306dc212001-05-21 13:45:10 +00003031 }
drh538f5702007-04-13 02:14:30 +00003032 /* If this was page 1, then restore the value of Pager.iChangeCount */
3033 if( pgno==1 ){
3034 pPager->iChangeCount = retrieve32bits(pPg, 24);
3035 }
danielk197775bab7d2006-01-23 13:09:45 +00003036
3037 /* Link the page into the page hash table */
drh8ca0c722006-05-07 17:49:38 +00003038 h = pgno & (pPager->nHash-1);
drh3765df42006-06-28 18:18:09 +00003039 assert( pgno!=0 );
danielk197775bab7d2006-01-23 13:09:45 +00003040 pPg->pNextHash = pPager->aHash[h];
3041 pPager->aHash[h] = pPg;
3042 if( pPg->pNextHash ){
3043 assert( pPg->pNextHash->pPrevHash==0 );
3044 pPg->pNextHash->pPrevHash = pPg;
3045 }
3046
danielk19773c407372005-02-15 02:54:14 +00003047#ifdef SQLITE_CHECK_PAGES
3048 pPg->pageHash = pager_pagehash(pPg);
3049#endif
drhed7c8552001-04-11 14:29:21 +00003050 }else{
drhd9b02572001-04-15 00:37:09 +00003051 /* The requested page is in the page cache. */
danielk1977e277be02007-03-23 18:12:06 +00003052 assert(pPager->nRef>0 || pgno==1);
drh538f5702007-04-13 02:14:30 +00003053 PAGER_INCR(pPager->nHit);
drhdf0b3b02001-06-23 11:36:20 +00003054 page_ref(pPg);
drhed7c8552001-04-11 14:29:21 +00003055 }
danielk19773b8a05f2007-03-19 17:44:26 +00003056 *ppPage = pPg;
drhed7c8552001-04-11 14:29:21 +00003057 return SQLITE_OK;
3058}
3059
3060/*
drh7e3b0a02001-04-28 16:52:40 +00003061** Acquire a page if it is already in the in-memory cache. Do
3062** not read the page from disk. Return a pointer to the page,
3063** or 0 if the page is not in cache.
3064**
danielk19773b8a05f2007-03-19 17:44:26 +00003065** See also sqlite3PagerGet(). The difference between this routine
3066** and sqlite3PagerGet() is that _get() will go to the disk and read
drh7e3b0a02001-04-28 16:52:40 +00003067** in the page if the page is not already in cache. This routine
drh5e00f6c2001-09-13 13:46:56 +00003068** returns NULL if the page is not in cache or if a disk I/O error
3069** has ever happened.
drh7e3b0a02001-04-28 16:52:40 +00003070*/
danielk19773b8a05f2007-03-19 17:44:26 +00003071DbPage *sqlite3PagerLookup(Pager *pPager, Pgno pgno){
drh7e3b0a02001-04-28 16:52:40 +00003072 PgHdr *pPg;
3073
drh836faa42003-01-11 13:30:57 +00003074 assert( pPager!=0 );
3075 assert( pgno!=0 );
danielk1977e277be02007-03-23 18:12:06 +00003076
3077 if( pPager->state==PAGER_UNLOCK ){
danielk1977334cdb62007-03-26 08:05:12 +00003078 assert( !pPager->pAll || pPager->exclusiveMode );
danielk1977e277be02007-03-23 18:12:06 +00003079 return 0;
3080 }
danielk1977334cdb62007-03-26 08:05:12 +00003081 if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
drh7e3b0a02001-04-28 16:52:40 +00003082 return 0;
3083 }
drh7e3b0a02001-04-28 16:52:40 +00003084 pPg = pager_lookup(pPager, pgno);
3085 if( pPg==0 ) return 0;
drhdf0b3b02001-06-23 11:36:20 +00003086 page_ref(pPg);
danielk19773b8a05f2007-03-19 17:44:26 +00003087 return pPg;
drh7e3b0a02001-04-28 16:52:40 +00003088}
3089
3090/*
drhed7c8552001-04-11 14:29:21 +00003091** Release a page.
3092**
3093** If the number of references to the page drop to zero, then the
3094** page is added to the LRU list. When all references to all pages
drhd9b02572001-04-15 00:37:09 +00003095** are released, a rollback occurs and the lock on the database is
drhed7c8552001-04-11 14:29:21 +00003096** removed.
3097*/
danielk19773b8a05f2007-03-19 17:44:26 +00003098int sqlite3PagerUnref(DbPage *pPg){
drhd9b02572001-04-15 00:37:09 +00003099
3100 /* Decrement the reference count for this page
3101 */
drhed7c8552001-04-11 14:29:21 +00003102 assert( pPg->nRef>0 );
drhed7c8552001-04-11 14:29:21 +00003103 pPg->nRef--;
drhdd793422001-06-28 01:54:48 +00003104 REFINFO(pPg);
drhd9b02572001-04-15 00:37:09 +00003105
danielk19773c407372005-02-15 02:54:14 +00003106 CHECK_PAGE(pPg);
3107
drh72f82862001-05-24 21:06:34 +00003108 /* When the number of references to a page reach 0, call the
3109 ** destructor and add the page to the freelist.
drhd9b02572001-04-15 00:37:09 +00003110 */
drhed7c8552001-04-11 14:29:21 +00003111 if( pPg->nRef==0 ){
drh1eaa2692001-09-18 02:02:23 +00003112 Pager *pPager;
3113 pPager = pPg->pPager;
drhd9b02572001-04-15 00:37:09 +00003114 pPg->pNextFree = 0;
3115 pPg->pPrevFree = pPager->pLast;
drhed7c8552001-04-11 14:29:21 +00003116 pPager->pLast = pPg;
drhd9b02572001-04-15 00:37:09 +00003117 if( pPg->pPrevFree ){
3118 pPg->pPrevFree->pNextFree = pPg;
drhed7c8552001-04-11 14:29:21 +00003119 }else{
3120 pPager->pFirst = pPg;
3121 }
drh341eae82003-01-21 02:39:36 +00003122 if( pPg->needSync==0 && pPager->pFirstSynced==0 ){
3123 pPager->pFirstSynced = pPg;
3124 }
drh72f82862001-05-24 21:06:34 +00003125 if( pPager->xDestructor ){
danielk19773b8a05f2007-03-19 17:44:26 +00003126 pPager->xDestructor(pPg, pPager->pageSize);
drh72f82862001-05-24 21:06:34 +00003127 }
drhd9b02572001-04-15 00:37:09 +00003128
3129 /* When all pages reach the freelist, drop the read lock from
3130 ** the database file.
3131 */
3132 pPager->nRef--;
3133 assert( pPager->nRef>=0 );
danielk19773dedc192007-03-27 17:37:31 +00003134 if( pPager->nRef==0 && (!pPager->exclusiveMode || pPager->journalOff>0) ){
danielk1977e277be02007-03-23 18:12:06 +00003135 pagerUnlockAndRollback(pPager);
drhd9b02572001-04-15 00:37:09 +00003136 }
drhed7c8552001-04-11 14:29:21 +00003137 }
drhd9b02572001-04-15 00:37:09 +00003138 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +00003139}
3140
3141/*
drha6abd042004-06-09 17:37:22 +00003142** Create a journal file for pPager. There should already be a RESERVED
3143** or EXCLUSIVE lock on the database file when this routine is called.
drhda47d772002-12-02 04:25:19 +00003144**
3145** Return SQLITE_OK if everything. Return an error code and release the
3146** write lock if anything goes wrong.
3147*/
3148static int pager_open_journal(Pager *pPager){
3149 int rc;
drhb7f91642004-10-31 02:22:47 +00003150 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +00003151 assert( pPager->state>=PAGER_RESERVED );
drhda47d772002-12-02 04:25:19 +00003152 assert( pPager->journalOpen==0 );
3153 assert( pPager->useJournal );
drh88b01a12005-03-28 18:04:27 +00003154 assert( pPager->aInJournal==0 );
danielk19773b8a05f2007-03-19 17:44:26 +00003155 sqlite3PagerPagecount(pPager);
drhda47d772002-12-02 04:25:19 +00003156 pPager->aInJournal = sqliteMalloc( pPager->dbSize/8 + 1 );
3157 if( pPager->aInJournal==0 ){
drh9c105bb2004-10-02 20:38:28 +00003158 rc = SQLITE_NOMEM;
3159 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00003160 }
drh66560ad2006-01-06 14:32:19 +00003161 rc = sqlite3OsOpenExclusive(pPager->zJournal, &pPager->jfd,
drh9c06c952005-11-26 00:25:00 +00003162 pPager->tempFile);
danielk19775bb16fe2007-04-05 11:54:42 +00003163 assert( rc!=SQLITE_OK || pPager->jfd );
danielk197776572402004-06-25 02:38:54 +00003164 pPager->journalOff = 0;
3165 pPager->setMaster = 0;
3166 pPager->journalHdr = 0;
drhda47d772002-12-02 04:25:19 +00003167 if( rc!=SQLITE_OK ){
drh600e46a2007-03-28 01:59:33 +00003168 if( rc==SQLITE_NOMEM ){
3169 sqlite3OsDelete(pPager->zJournal);
3170 }
drh9c105bb2004-10-02 20:38:28 +00003171 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00003172 }
drhac530b12006-02-11 01:25:50 +00003173 sqlite3OsSetFullSync(pPager->jfd, pPager->full_fsync);
3174 sqlite3OsSetFullSync(pPager->fd, pPager->full_fsync);
drh054889e2005-11-30 03:20:31 +00003175 sqlite3OsOpenDirectory(pPager->jfd, pPager->zDirectory);
drhda47d772002-12-02 04:25:19 +00003176 pPager->journalOpen = 1;
drhdb48ee02003-01-16 13:42:43 +00003177 pPager->journalStarted = 0;
drhda47d772002-12-02 04:25:19 +00003178 pPager->needSync = 0;
3179 pPager->alwaysRollback = 0;
drh968af522003-02-11 14:55:40 +00003180 pPager->nRec = 0;
danielk1977efaaf572006-01-16 11:29:19 +00003181 if( pPager->errCode ){
3182 rc = pPager->errCode;
drhdd5b2fa2005-03-28 03:39:55 +00003183 goto failed_to_open_journal;
drh2e6d11b2003-04-25 15:37:57 +00003184 }
drhda47d772002-12-02 04:25:19 +00003185 pPager->origDbSize = pPager->dbSize;
drhae2b40c2004-06-09 19:03:54 +00003186
danielk197776572402004-06-25 02:38:54 +00003187 rc = writeJournalHdr(pPager);
3188
drhac69b052004-05-12 13:30:07 +00003189 if( pPager->stmtAutoopen && rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00003190 rc = sqlite3PagerStmtBegin(pPager);
drhda47d772002-12-02 04:25:19 +00003191 }
danielk1977261919c2005-12-06 12:52:59 +00003192 if( rc!=SQLITE_OK && rc!=SQLITE_NOMEM ){
drh80e35f42007-03-30 14:06:34 +00003193 rc = pager_end_transaction(pPager);
drhda47d772002-12-02 04:25:19 +00003194 if( rc==SQLITE_OK ){
3195 rc = SQLITE_FULL;
3196 }
3197 }
drh9c105bb2004-10-02 20:38:28 +00003198 return rc;
3199
3200failed_to_open_journal:
3201 sqliteFree(pPager->aInJournal);
3202 pPager->aInJournal = 0;
drh9c105bb2004-10-02 20:38:28 +00003203 return rc;
drhda47d772002-12-02 04:25:19 +00003204}
3205
3206/*
drh4b845d72002-03-05 12:41:19 +00003207** Acquire a write-lock on the database. The lock is removed when
3208** the any of the following happen:
3209**
drh80e35f42007-03-30 14:06:34 +00003210** * sqlite3PagerCommitPhaseTwo() is called.
danielk19773b8a05f2007-03-19 17:44:26 +00003211** * sqlite3PagerRollback() is called.
3212** * sqlite3PagerClose() is called.
3213** * sqlite3PagerUnref() is called to on every outstanding page.
drh4b845d72002-03-05 12:41:19 +00003214**
danielk197713adf8a2004-06-03 16:08:41 +00003215** The first parameter to this routine is a pointer to any open page of the
3216** database file. Nothing changes about the page - it is used merely to
3217** acquire a pointer to the Pager structure and as proof that there is
3218** already a read-lock on the database.
drh4b845d72002-03-05 12:41:19 +00003219**
danielk197713adf8a2004-06-03 16:08:41 +00003220** The second parameter indicates how much space in bytes to reserve for a
3221** master journal file-name at the start of the journal when it is created.
3222**
3223** A journal file is opened if this is not a temporary file. For temporary
3224** files, the opening of the journal file is deferred until there is an
3225** actual need to write to the journal.
drhda47d772002-12-02 04:25:19 +00003226**
drha6abd042004-06-09 17:37:22 +00003227** If the database is already reserved for writing, this routine is a no-op.
drh684917c2004-10-05 02:41:42 +00003228**
3229** If exFlag is true, go ahead and get an EXCLUSIVE lock on the file
3230** immediately instead of waiting until we try to flush the cache. The
3231** exFlag is ignored if a transaction is already active.
drh4b845d72002-03-05 12:41:19 +00003232*/
danielk19773b8a05f2007-03-19 17:44:26 +00003233int sqlite3PagerBegin(DbPage *pPg, int exFlag){
drh4b845d72002-03-05 12:41:19 +00003234 Pager *pPager = pPg->pPager;
3235 int rc = SQLITE_OK;
3236 assert( pPg->nRef>0 );
drha6abd042004-06-09 17:37:22 +00003237 assert( pPager->state!=PAGER_UNLOCK );
3238 if( pPager->state==PAGER_SHARED ){
drh4b845d72002-03-05 12:41:19 +00003239 assert( pPager->aInJournal==0 );
drhb7f91642004-10-31 02:22:47 +00003240 if( MEMDB ){
drha6abd042004-06-09 17:37:22 +00003241 pPager->state = PAGER_EXCLUSIVE;
drhac69b052004-05-12 13:30:07 +00003242 pPager->origDbSize = pPager->dbSize;
3243 }else{
drh054889e2005-11-30 03:20:31 +00003244 rc = sqlite3OsLock(pPager->fd, RESERVED_LOCK);
drh684917c2004-10-05 02:41:42 +00003245 if( rc==SQLITE_OK ){
3246 pPager->state = PAGER_RESERVED;
3247 if( exFlag ){
3248 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
3249 }
3250 }
danielk19779eed5052004-06-04 10:38:30 +00003251 if( rc!=SQLITE_OK ){
3252 return rc;
drhac69b052004-05-12 13:30:07 +00003253 }
drha6abd042004-06-09 17:37:22 +00003254 pPager->dirtyCache = 0;
drh4f0c5872007-03-26 22:05:01 +00003255 PAGERTRACE2("TRANSACTION %d\n", PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00003256 if( pPager->useJournal && !pPager->tempFile ){
3257 rc = pager_open_journal(pPager);
3258 }
drh4b845d72002-03-05 12:41:19 +00003259 }
danielk1977334cdb62007-03-26 08:05:12 +00003260 }else if( pPager->journalOpen && pPager->journalOff==0 ){
3261 /* This happens when the pager was in exclusive-access mode last
3262 ** time a (read or write) transaction was successfully concluded
3263 ** by this connection. Instead of deleting the journal file it was
3264 ** kept open and truncated to 0 bytes.
3265 */
3266 assert( pPager->nRec==0 );
3267 assert( pPager->origDbSize==0 );
drh369339d2007-03-30 16:01:55 +00003268 assert( pPager->aInJournal==0 );
danielk1977334cdb62007-03-26 08:05:12 +00003269 sqlite3PagerPagecount(pPager);
danielk1977334cdb62007-03-26 08:05:12 +00003270 pPager->aInJournal = sqliteMalloc( pPager->dbSize/8 + 1 );
3271 if( !pPager->aInJournal ){
3272 rc = SQLITE_NOMEM;
3273 }else{
drh369339d2007-03-30 16:01:55 +00003274 pPager->origDbSize = pPager->dbSize;
danielk1977334cdb62007-03-26 08:05:12 +00003275 rc = writeJournalHdr(pPager);
3276 }
drh4b845d72002-03-05 12:41:19 +00003277 }
danielk1977334cdb62007-03-26 08:05:12 +00003278 assert( !pPager->journalOpen || pPager->journalOff>0 || rc!=SQLITE_OK );
drh4b845d72002-03-05 12:41:19 +00003279 return rc;
3280}
3281
3282/*
drh605ad8f2006-05-03 23:34:05 +00003283** Make a page dirty. Set its dirty flag and add it to the dirty
3284** page list.
3285*/
3286static void makeDirty(PgHdr *pPg){
3287 if( pPg->dirty==0 ){
3288 Pager *pPager = pPg->pPager;
3289 pPg->dirty = 1;
3290 pPg->pDirty = pPager->pDirty;
3291 if( pPager->pDirty ){
3292 pPager->pDirty->pPrevDirty = pPg;
3293 }
3294 pPg->pPrevDirty = 0;
3295 pPager->pDirty = pPg;
3296 }
3297}
3298
3299/*
3300** Make a page clean. Clear its dirty bit and remove it from the
3301** dirty page list.
3302*/
3303static void makeClean(PgHdr *pPg){
3304 if( pPg->dirty ){
3305 pPg->dirty = 0;
3306 if( pPg->pDirty ){
3307 pPg->pDirty->pPrevDirty = pPg->pPrevDirty;
3308 }
3309 if( pPg->pPrevDirty ){
3310 pPg->pPrevDirty->pDirty = pPg->pDirty;
3311 }else{
3312 pPg->pPager->pDirty = pPg->pDirty;
3313 }
3314 }
3315}
3316
3317
3318/*
drhed7c8552001-04-11 14:29:21 +00003319** Mark a data page as writeable. The page is written into the journal
3320** if it is not there already. This routine must be called before making
3321** changes to a page.
3322**
3323** The first time this routine is called, the pager creates a new
drha6abd042004-06-09 17:37:22 +00003324** journal and acquires a RESERVED lock on the database. If the RESERVED
drhed7c8552001-04-11 14:29:21 +00003325** lock could not be acquired, this routine returns SQLITE_BUSY. The
drh306dc212001-05-21 13:45:10 +00003326** calling routine must check for that return value and be careful not to
drhed7c8552001-04-11 14:29:21 +00003327** change any page data until this routine returns SQLITE_OK.
drhd9b02572001-04-15 00:37:09 +00003328**
3329** If the journal file could not be written because the disk is full,
3330** then this routine returns SQLITE_FULL and does an immediate rollback.
3331** All subsequent write attempts also return SQLITE_FULL until there
danielk19773b8a05f2007-03-19 17:44:26 +00003332** is a call to sqlite3PagerCommit() or sqlite3PagerRollback() to
drhd9b02572001-04-15 00:37:09 +00003333** reset.
drhed7c8552001-04-11 14:29:21 +00003334*/
danielk19773b8a05f2007-03-19 17:44:26 +00003335static int pager_write(PgHdr *pPg){
3336 void *pData = PGHDR_TO_DATA(pPg);
drh69688d52001-04-14 16:38:23 +00003337 Pager *pPager = pPg->pPager;
drhd79caeb2001-04-15 02:27:24 +00003338 int rc = SQLITE_OK;
drh69688d52001-04-14 16:38:23 +00003339
drh6446c4d2001-12-15 14:22:18 +00003340 /* Check for errors
3341 */
danielk1977efaaf572006-01-16 11:29:19 +00003342 if( pPager->errCode ){
3343 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00003344 }
drh5e00f6c2001-09-13 13:46:56 +00003345 if( pPager->readOnly ){
3346 return SQLITE_PERM;
3347 }
drh6446c4d2001-12-15 14:22:18 +00003348
danielk197776572402004-06-25 02:38:54 +00003349 assert( !pPager->setMaster );
3350
danielk19773c407372005-02-15 02:54:14 +00003351 CHECK_PAGE(pPg);
3352
drh538f5702007-04-13 02:14:30 +00003353 /* If this page was previously acquired with noContent==1, that means
3354 ** we didn't really read in the content of the page. This can happen
3355 ** (for example) when the page is being moved to the freelist. But
3356 ** now we are (perhaps) moving the page off of the freelist for
3357 ** reuse and we need to know its original content so that content
3358 ** can be stored in the rollback journal. So do the read at this
3359 ** time.
3360 */
3361 if( pPg->needRead ){
3362 rc = readDbPage(pPager, pPg, pPg->pgno);
3363 if( rc==SQLITE_OK ){
3364 pPg->needRead = 0;
3365 }else{
3366 return rc;
3367 }
3368 }
3369
drh6446c4d2001-12-15 14:22:18 +00003370 /* Mark the page as dirty. If the page has already been written
3371 ** to the journal then we can return right away.
3372 */
drh605ad8f2006-05-03 23:34:05 +00003373 makeDirty(pPg);
danielk1977f35843b2007-04-07 15:03:17 +00003374 if( pPg->inJournal && (pageInStatement(pPg) || pPager->stmtInUse==0) ){
drha6abd042004-06-09 17:37:22 +00003375 pPager->dirtyCache = 1;
danielk1977a0bf2652004-11-04 14:30:04 +00003376 }else{
drh6446c4d2001-12-15 14:22:18 +00003377
danielk1977a0bf2652004-11-04 14:30:04 +00003378 /* If we get this far, it means that the page needs to be
3379 ** written to the transaction journal or the ckeckpoint journal
3380 ** or both.
3381 **
3382 ** First check to see that the transaction journal exists and
3383 ** create it if it does not.
3384 */
3385 assert( pPager->state!=PAGER_UNLOCK );
danielk19773b8a05f2007-03-19 17:44:26 +00003386 rc = sqlite3PagerBegin(pPg, 0);
danielk1977a0bf2652004-11-04 14:30:04 +00003387 if( rc!=SQLITE_OK ){
3388 return rc;
3389 }
3390 assert( pPager->state>=PAGER_RESERVED );
3391 if( !pPager->journalOpen && pPager->useJournal ){
3392 rc = pager_open_journal(pPager);
3393 if( rc!=SQLITE_OK ) return rc;
3394 }
3395 assert( pPager->journalOpen || !pPager->useJournal );
3396 pPager->dirtyCache = 1;
3397
3398 /* The transaction journal now exists and we have a RESERVED or an
3399 ** EXCLUSIVE lock on the main database file. Write the current page to
3400 ** the transaction journal if it is not there already.
3401 */
3402 if( !pPg->inJournal && (pPager->useJournal || MEMDB) ){
3403 if( (int)pPg->pgno <= pPager->origDbSize ){
3404 int szPg;
danielk1977a0bf2652004-11-04 14:30:04 +00003405 if( MEMDB ){
3406 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
drh4f0c5872007-03-26 22:05:01 +00003407 PAGERTRACE3("JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00003408 assert( pHist->pOrig==0 );
3409 pHist->pOrig = sqliteMallocRaw( pPager->pageSize );
3410 if( pHist->pOrig ){
3411 memcpy(pHist->pOrig, PGHDR_TO_DATA(pPg), pPager->pageSize);
3412 }
3413 }else{
drhc001c582006-03-06 18:23:16 +00003414 u32 cksum, saved;
3415 char *pData2, *pEnd;
drh267cb322005-09-16 17:16:52 +00003416 /* We should never write to the journal file the page that
3417 ** contains the database locks. The following assert verifies
3418 ** that we do not. */
3419 assert( pPg->pgno!=PAGER_MJ_PGNO(pPager) );
drhc001c582006-03-06 18:23:16 +00003420 pData2 = CODEC2(pPager, pData, pPg->pgno, 7);
drh37527852006-03-16 16:19:56 +00003421 cksum = pager_cksum(pPager, (u8*)pData2);
drhc001c582006-03-06 18:23:16 +00003422 pEnd = pData2 + pPager->pageSize;
3423 pData2 -= 4;
3424 saved = *(u32*)pEnd;
3425 put32bits(pEnd, cksum);
danielk1977a0bf2652004-11-04 14:30:04 +00003426 szPg = pPager->pageSize+8;
drhc001c582006-03-06 18:23:16 +00003427 put32bits(pData2, pPg->pgno);
3428 rc = sqlite3OsWrite(pPager->jfd, pData2, szPg);
drhb0603412007-02-28 04:47:26 +00003429 IOTRACE(("JOUT %p %d %lld %d\n", pPager, pPg->pgno,
drh538f5702007-04-13 02:14:30 +00003430 pPager->journalOff, szPg));
3431 PAGER_INCR(sqlite3_pager_writej_count);
danielk1977a0bf2652004-11-04 14:30:04 +00003432 pPager->journalOff += szPg;
drh4f0c5872007-03-26 22:05:01 +00003433 PAGERTRACE4("JOURNAL %d page %d needSync=%d\n",
danielk1977ef73ee92004-11-06 12:26:07 +00003434 PAGERID(pPager), pPg->pgno, pPg->needSync);
drhc001c582006-03-06 18:23:16 +00003435 *(u32*)pEnd = saved;
danielk197707cb5602006-01-20 10:55:05 +00003436
3437 /* An error has occured writing to the journal file. The
3438 ** transaction will be rolled back by the layer above.
3439 */
danielk1977a0bf2652004-11-04 14:30:04 +00003440 if( rc!=SQLITE_OK ){
danielk1977a0bf2652004-11-04 14:30:04 +00003441 return rc;
3442 }
danielk197707cb5602006-01-20 10:55:05 +00003443
danielk1977a0bf2652004-11-04 14:30:04 +00003444 pPager->nRec++;
3445 assert( pPager->aInJournal!=0 );
3446 pPager->aInJournal[pPg->pgno/8] |= 1<<(pPg->pgno&7);
3447 pPg->needSync = !pPager->noSync;
3448 if( pPager->stmtInUse ){
3449 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
danielk1977a0bf2652004-11-04 14:30:04 +00003450 }
drhac69b052004-05-12 13:30:07 +00003451 }
danielk197713adf8a2004-06-03 16:08:41 +00003452 }else{
danielk1977a0bf2652004-11-04 14:30:04 +00003453 pPg->needSync = !pPager->journalStarted && !pPager->noSync;
drh4f0c5872007-03-26 22:05:01 +00003454 PAGERTRACE4("APPEND %d page %d needSync=%d\n",
danielk1977ef73ee92004-11-06 12:26:07 +00003455 PAGERID(pPager), pPg->pgno, pPg->needSync);
danielk1977a0bf2652004-11-04 14:30:04 +00003456 }
3457 if( pPg->needSync ){
3458 pPager->needSync = 1;
3459 }
3460 pPg->inJournal = 1;
3461 }
3462
3463 /* If the statement journal is open and the page is not in it,
3464 ** then write the current page to the statement journal. Note that
3465 ** the statement journal format differs from the standard journal format
3466 ** in that it omits the checksums and the header.
3467 */
danielk1977f35843b2007-04-07 15:03:17 +00003468 if( pPager->stmtInUse
3469 && !pageInStatement(pPg)
3470 && (int)pPg->pgno<=pPager->stmtSize
3471 ){
danielk1977a0bf2652004-11-04 14:30:04 +00003472 assert( pPg->inJournal || (int)pPg->pgno>pPager->origDbSize );
3473 if( MEMDB ){
3474 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
3475 assert( pHist->pStmt==0 );
3476 pHist->pStmt = sqliteMallocRaw( pPager->pageSize );
3477 if( pHist->pStmt ){
3478 memcpy(pHist->pStmt, PGHDR_TO_DATA(pPg), pPager->pageSize);
3479 }
drh4f0c5872007-03-26 22:05:01 +00003480 PAGERTRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk1977f35843b2007-04-07 15:03:17 +00003481 page_add_to_stmt_list(pPg);
danielk1977a0bf2652004-11-04 14:30:04 +00003482 }else{
drhc001c582006-03-06 18:23:16 +00003483 char *pData2 = CODEC2(pPager, pData, pPg->pgno, 7)-4;
3484 put32bits(pData2, pPg->pgno);
3485 rc = sqlite3OsWrite(pPager->stfd, pData2, pPager->pageSize+4);
drh4f0c5872007-03-26 22:05:01 +00003486 PAGERTRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
drhac69b052004-05-12 13:30:07 +00003487 if( rc!=SQLITE_OK ){
drhac69b052004-05-12 13:30:07 +00003488 return rc;
3489 }
danielk1977a0bf2652004-11-04 14:30:04 +00003490 pPager->stmtNRec++;
3491 assert( pPager->aInStmt!=0 );
3492 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drhdb48ee02003-01-16 13:42:43 +00003493 }
drhd9b02572001-04-15 00:37:09 +00003494 }
drhfa86c412002-02-02 15:01:15 +00003495 }
3496
3497 /* Update the database size and return.
3498 */
drh1aa2d8b2007-01-03 15:34:29 +00003499 assert( pPager->state>=PAGER_SHARED );
drh1ab43002002-01-14 09:28:19 +00003500 if( pPager->dbSize<(int)pPg->pgno ){
drh306dc212001-05-21 13:45:10 +00003501 pPager->dbSize = pPg->pgno;
drhb7f91642004-10-31 02:22:47 +00003502 if( !MEMDB && pPager->dbSize==PENDING_BYTE/pPager->pageSize ){
drh1f595712004-06-15 01:40:29 +00003503 pPager->dbSize++;
3504 }
drh306dc212001-05-21 13:45:10 +00003505 }
drh69688d52001-04-14 16:38:23 +00003506 return rc;
drhed7c8552001-04-11 14:29:21 +00003507}
3508
3509/*
danielk19774099f6e2007-03-19 11:25:20 +00003510** This function is used to mark a data-page as writable. It uses
3511** pager_write() to open a journal file (if it is not already open)
3512** and write the page *pData to the journal.
3513**
3514** The difference between this function and pager_write() is that this
3515** function also deals with the special case where 2 or more pages
3516** fit on a single disk sector. In this case all co-resident pages
3517** must have been written to the journal file before returning.
3518*/
danielk19773b8a05f2007-03-19 17:44:26 +00003519int sqlite3PagerWrite(DbPage *pDbPage){
danielk19774099f6e2007-03-19 11:25:20 +00003520 int rc = SQLITE_OK;
3521
danielk19773b8a05f2007-03-19 17:44:26 +00003522 PgHdr *pPg = pDbPage;
danielk19774099f6e2007-03-19 11:25:20 +00003523 Pager *pPager = pPg->pPager;
3524 Pgno nPagePerSector = (pPager->sectorSize/pPager->pageSize);
3525
3526 if( !MEMDB && nPagePerSector>1 ){
3527 Pgno nPageCount; /* Total number of pages in database file */
3528 Pgno pg1; /* First page of the sector pPg is located on. */
3529 int nPage; /* Number of pages starting at pg1 to journal */
3530 int ii;
3531
3532 /* Set the doNotSync flag to 1. This is because we cannot allow a journal
3533 ** header to be written between the pages journaled by this function.
3534 */
3535 assert( pPager->doNotSync==0 );
3536 pPager->doNotSync = 1;
3537
3538 /* This trick assumes that both the page-size and sector-size are
3539 ** an integer power of 2. It sets variable pg1 to the identifier
3540 ** of the first page of the sector pPg is located on.
3541 */
3542 pg1 = ((pPg->pgno-1) & ~(nPagePerSector-1)) + 1;
3543
danielk19773b8a05f2007-03-19 17:44:26 +00003544 nPageCount = sqlite3PagerPagecount(pPager);
danielk19774099f6e2007-03-19 11:25:20 +00003545 if( pPg->pgno>nPageCount ){
3546 nPage = (pPg->pgno - pg1)+1;
3547 }else if( (pg1+nPagePerSector-1)>nPageCount ){
3548 nPage = nPageCount+1-pg1;
3549 }else{
3550 nPage = nPagePerSector;
3551 }
3552 assert(nPage>0);
3553 assert(pg1<=pPg->pgno);
3554 assert((pg1+nPage)>pPg->pgno);
3555
3556 for(ii=0; ii<nPage && rc==SQLITE_OK; ii++){
3557 Pgno pg = pg1+ii;
3558 if( !pPager->aInJournal || pg==pPg->pgno ||
3559 pg>pPager->origDbSize || !(pPager->aInJournal[pg/8]&(1<<(pg&7)))
3560 ) {
3561 if( pg!=PAGER_MJ_PGNO(pPager) ){
danielk19773b8a05f2007-03-19 17:44:26 +00003562 PgHdr *pPage;
3563 rc = sqlite3PagerGet(pPager, pg, &pPage);
danielk19774099f6e2007-03-19 11:25:20 +00003564 if( rc==SQLITE_OK ){
3565 rc = pager_write(pPage);
danielk19773b8a05f2007-03-19 17:44:26 +00003566 sqlite3PagerUnref(pPage);
danielk19774099f6e2007-03-19 11:25:20 +00003567 }
3568 }
3569 }
3570 }
3571
3572 assert( pPager->doNotSync==1 );
3573 pPager->doNotSync = 0;
3574 }else{
danielk19773b8a05f2007-03-19 17:44:26 +00003575 rc = pager_write(pDbPage);
danielk19774099f6e2007-03-19 11:25:20 +00003576 }
3577 return rc;
3578}
3579
3580/*
drhaacc5432002-01-06 17:07:40 +00003581** Return TRUE if the page given in the argument was previously passed
danielk19773b8a05f2007-03-19 17:44:26 +00003582** to sqlite3PagerWrite(). In other words, return TRUE if it is ok
drh6019e162001-07-02 17:51:45 +00003583** to change the content of the page.
3584*/
danielk19777d3a6662006-01-23 16:21:05 +00003585#ifndef NDEBUG
danielk19773b8a05f2007-03-19 17:44:26 +00003586int sqlite3PagerIswriteable(DbPage *pPg){
drh6019e162001-07-02 17:51:45 +00003587 return pPg->dirty;
3588}
danielk19777d3a6662006-01-23 16:21:05 +00003589#endif
drh6019e162001-07-02 17:51:45 +00003590
danielk1977b84f96f2005-01-20 11:32:23 +00003591#ifndef SQLITE_OMIT_VACUUM
drh6019e162001-07-02 17:51:45 +00003592/*
drh001bbcb2003-03-19 03:14:00 +00003593** Replace the content of a single page with the information in the third
3594** argument.
3595*/
danielk19773b8a05f2007-03-19 17:44:26 +00003596int sqlite3PagerOverwrite(Pager *pPager, Pgno pgno, void *pData){
3597 PgHdr *pPg;
drh001bbcb2003-03-19 03:14:00 +00003598 int rc;
3599
danielk19773b8a05f2007-03-19 17:44:26 +00003600 rc = sqlite3PagerGet(pPager, pgno, &pPg);
drh001bbcb2003-03-19 03:14:00 +00003601 if( rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00003602 rc = sqlite3PagerWrite(pPg);
drh001bbcb2003-03-19 03:14:00 +00003603 if( rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00003604 memcpy(sqlite3PagerGetData(pPg), pData, pPager->pageSize);
drh001bbcb2003-03-19 03:14:00 +00003605 }
danielk19773b8a05f2007-03-19 17:44:26 +00003606 sqlite3PagerUnref(pPg);
drh001bbcb2003-03-19 03:14:00 +00003607 }
3608 return rc;
3609}
danielk1977b84f96f2005-01-20 11:32:23 +00003610#endif
drh001bbcb2003-03-19 03:14:00 +00003611
3612/*
drh30e58752002-03-02 20:41:57 +00003613** A call to this routine tells the pager that it is not necessary to
drh538f5702007-04-13 02:14:30 +00003614** write the information on page pPg back to the disk, even though
drh30e58752002-03-02 20:41:57 +00003615** that page might be marked as dirty.
3616**
3617** The overlying software layer calls this routine when all of the data
3618** on the given page is unused. The pager marks the page as clean so
3619** that it does not get written to disk.
3620**
3621** Tests show that this optimization, together with the
danielk19773b8a05f2007-03-19 17:44:26 +00003622** sqlite3PagerDontRollback() below, more than double the speed
drh30e58752002-03-02 20:41:57 +00003623** of large INSERT operations and quadruple the speed of large DELETEs.
drh8e298f92002-07-06 16:28:47 +00003624**
3625** When this routine is called, set the alwaysRollback flag to true.
danielk19773b8a05f2007-03-19 17:44:26 +00003626** Subsequent calls to sqlite3PagerDontRollback() for the same page
drh8e298f92002-07-06 16:28:47 +00003627** will thereafter be ignored. This is necessary to avoid a problem
3628** where a page with data is added to the freelist during one part of
3629** a transaction then removed from the freelist during a later part
3630** of the same transaction and reused for some other purpose. When it
3631** is first added to the freelist, this routine is called. When reused,
drh80e35f42007-03-30 14:06:34 +00003632** the sqlite3PagerDontRollback() routine is called. But because the
3633** page contains critical data, we still need to be sure it gets
3634** rolled back in spite of the sqlite3PagerDontRollback() call.
drh30e58752002-03-02 20:41:57 +00003635*/
drh538f5702007-04-13 02:14:30 +00003636void sqlite3PagerDontWrite(DbPage *pDbPage){
3637 PgHdr *pPg = pDbPage;
3638 Pager *pPager = pPg->pPager;
drh8e298f92002-07-06 16:28:47 +00003639
drhb7f91642004-10-31 02:22:47 +00003640 if( MEMDB ) return;
drh8e298f92002-07-06 16:28:47 +00003641 pPg->alwaysRollback = 1;
drh43617e92006-03-06 20:55:46 +00003642 if( pPg->dirty && !pPager->stmtInUse ){
drh1aa2d8b2007-01-03 15:34:29 +00003643 assert( pPager->state>=PAGER_SHARED );
drh8124a302002-06-25 14:43:57 +00003644 if( pPager->dbSize==(int)pPg->pgno && pPager->origDbSize<pPager->dbSize ){
3645 /* If this pages is the last page in the file and the file has grown
3646 ** during the current transaction, then do NOT mark the page as clean.
3647 ** When the database file grows, we must make sure that the last page
3648 ** gets written at least once so that the disk file will be the correct
3649 ** size. If you do not write this page and the size of the file
3650 ** on the disk ends up being too small, that can lead to database
3651 ** corruption during the next transaction.
3652 */
3653 }else{
drh538f5702007-04-13 02:14:30 +00003654 PAGERTRACE3("DONT_WRITE page %d of %d\n", pPg->pgno, PAGERID(pPager));
3655 IOTRACE(("CLEAN %p %d\n", pPager, pPg->pgno))
drh605ad8f2006-05-03 23:34:05 +00003656 makeClean(pPg);
danielk19773c407372005-02-15 02:54:14 +00003657#ifdef SQLITE_CHECK_PAGES
3658 pPg->pageHash = pager_pagehash(pPg);
3659#endif
drh8124a302002-06-25 14:43:57 +00003660 }
drh30e58752002-03-02 20:41:57 +00003661 }
3662}
3663
3664/*
3665** A call to this routine tells the pager that if a rollback occurs,
3666** it is not necessary to restore the data on the given page. This
3667** means that the pager does not have to record the given page in the
3668** rollback journal.
drh538f5702007-04-13 02:14:30 +00003669**
3670** If we have not yet actually read the content of this page (if
3671** the PgHdr.needRead flag is set) then this routine acts as a promise
3672** that we will never need to read the page content in the future.
3673** so the needRead flag can be cleared at this point.
drh30e58752002-03-02 20:41:57 +00003674*/
danielk19773b8a05f2007-03-19 17:44:26 +00003675void sqlite3PagerDontRollback(DbPage *pPg){
drh30e58752002-03-02 20:41:57 +00003676 Pager *pPager = pPg->pPager;
3677
drhd3627af2006-12-18 18:34:51 +00003678 assert( pPager->state>=PAGER_RESERVED );
3679 if( pPager->journalOpen==0 ) return;
drhb7f91642004-10-31 02:22:47 +00003680 if( pPg->alwaysRollback || pPager->alwaysRollback || MEMDB ) return;
drh30e58752002-03-02 20:41:57 +00003681 if( !pPg->inJournal && (int)pPg->pgno <= pPager->origDbSize ){
3682 assert( pPager->aInJournal!=0 );
3683 pPager->aInJournal[pPg->pgno/8] |= 1<<(pPg->pgno&7);
3684 pPg->inJournal = 1;
drh538f5702007-04-13 02:14:30 +00003685 pPg->needRead = 0;
drhac69b052004-05-12 13:30:07 +00003686 if( pPager->stmtInUse ){
3687 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drh30e58752002-03-02 20:41:57 +00003688 }
drh4f0c5872007-03-26 22:05:01 +00003689 PAGERTRACE3("DONT_ROLLBACK page %d of %d\n", pPg->pgno, PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00003690 IOTRACE(("GARBAGE %p %d\n", pPager, pPg->pgno))
drh30e58752002-03-02 20:41:57 +00003691 }
danielk1977f35843b2007-04-07 15:03:17 +00003692 if( pPager->stmtInUse
3693 && !pageInStatement(pPg)
3694 && (int)pPg->pgno<=pPager->stmtSize
3695 ){
drh30e58752002-03-02 20:41:57 +00003696 assert( pPg->inJournal || (int)pPg->pgno>pPager->origDbSize );
drhac69b052004-05-12 13:30:07 +00003697 assert( pPager->aInStmt!=0 );
3698 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drh30e58752002-03-02 20:41:57 +00003699 }
3700}
3701
drhac69b052004-05-12 13:30:07 +00003702
drh30e58752002-03-02 20:41:57 +00003703/*
drh80e35f42007-03-30 14:06:34 +00003704** This routine is called to increment the database file change-counter,
3705** stored at byte 24 of the pager file.
3706*/
3707static int pager_incr_changecounter(Pager *pPager){
3708 PgHdr *pPgHdr;
3709 u32 change_counter;
3710 int rc;
3711
3712 if( !pPager->changeCountDone ){
3713 /* Open page 1 of the file for writing. */
3714 rc = sqlite3PagerGet(pPager, 1, &pPgHdr);
3715 if( rc!=SQLITE_OK ) return rc;
3716 rc = sqlite3PagerWrite(pPgHdr);
3717 if( rc!=SQLITE_OK ) return rc;
3718
3719 /* Read the current value at byte 24. */
3720 change_counter = retrieve32bits(pPgHdr, 24);
3721
3722 /* Increment the value just read and write it back to byte 24. */
3723 change_counter++;
3724 put32bits(((char*)PGHDR_TO_DATA(pPgHdr))+24, change_counter);
3725 pPager->iChangeCount = change_counter;
3726
3727 /* Release the page reference. */
3728 sqlite3PagerUnref(pPgHdr);
3729 pPager->changeCountDone = 1;
3730 }
3731 return SQLITE_OK;
3732}
3733
3734/*
3735** Sync the database file for the pager pPager. zMaster points to the name
3736** of a master journal file that should be written into the individual
3737** journal file. zMaster may be NULL, which is interpreted as no master
3738** journal (a single database transaction).
3739**
3740** This routine ensures that the journal is synced, all dirty pages written
3741** to the database file and the database file synced. The only thing that
3742** remains to commit the transaction is to delete the journal file (or
3743** master journal file if specified).
3744**
3745** Note that if zMaster==NULL, this does not overwrite a previous value
3746** passed to an sqlite3PagerCommitPhaseOne() call.
3747**
3748** If parameter nTrunc is non-zero, then the pager file is truncated to
3749** nTrunc pages (this is used by auto-vacuum databases).
3750*/
3751int sqlite3PagerCommitPhaseOne(Pager *pPager, const char *zMaster, Pgno nTrunc){
3752 int rc = SQLITE_OK;
3753
3754 PAGERTRACE4("DATABASE SYNC: File=%s zMaster=%s nTrunc=%d\n",
3755 pPager->zFilename, zMaster, nTrunc);
3756
3757 /* If this is an in-memory db, or no pages have been written to, or this
3758 ** function has already been called, it is a no-op.
3759 */
3760 if( pPager->state!=PAGER_SYNCED && !MEMDB && pPager->dirtyCache ){
3761 PgHdr *pPg;
3762 assert( pPager->journalOpen );
3763
3764 /* If a master journal file name has already been written to the
3765 ** journal file, then no sync is required. This happens when it is
3766 ** written, then the process fails to upgrade from a RESERVED to an
3767 ** EXCLUSIVE lock. The next time the process tries to commit the
3768 ** transaction the m-j name will have already been written.
3769 */
3770 if( !pPager->setMaster ){
3771 rc = pager_incr_changecounter(pPager);
3772 if( rc!=SQLITE_OK ) goto sync_exit;
3773#ifndef SQLITE_OMIT_AUTOVACUUM
3774 if( nTrunc!=0 ){
3775 /* If this transaction has made the database smaller, then all pages
3776 ** being discarded by the truncation must be written to the journal
3777 ** file.
3778 */
3779 Pgno i;
3780 int iSkip = PAGER_MJ_PGNO(pPager);
3781 for( i=nTrunc+1; i<=pPager->origDbSize; i++ ){
3782 if( !(pPager->aInJournal[i/8] & (1<<(i&7))) && i!=iSkip ){
3783 rc = sqlite3PagerGet(pPager, i, &pPg);
3784 if( rc!=SQLITE_OK ) goto sync_exit;
3785 rc = sqlite3PagerWrite(pPg);
3786 sqlite3PagerUnref(pPg);
3787 if( rc!=SQLITE_OK ) goto sync_exit;
3788 }
3789 }
3790 }
3791#endif
3792 rc = writeMasterJournal(pPager, zMaster);
3793 if( rc!=SQLITE_OK ) goto sync_exit;
3794 rc = syncJournal(pPager);
3795 if( rc!=SQLITE_OK ) goto sync_exit;
3796 }
3797
3798#ifndef SQLITE_OMIT_AUTOVACUUM
3799 if( nTrunc!=0 ){
3800 rc = sqlite3PagerTruncate(pPager, nTrunc);
3801 if( rc!=SQLITE_OK ) goto sync_exit;
3802 }
3803#endif
3804
3805 /* Write all dirty pages to the database file */
3806 pPg = pager_get_all_dirty_pages(pPager);
3807 rc = pager_write_pagelist(pPg);
3808 if( rc!=SQLITE_OK ) goto sync_exit;
drh3cdd7d32007-03-30 14:46:01 +00003809 pPager->pDirty = 0;
drh80e35f42007-03-30 14:06:34 +00003810
3811 /* Sync the database file. */
3812 if( !pPager->noSync ){
3813 rc = sqlite3OsSync(pPager->fd, 0);
3814 }
3815 IOTRACE(("DBSYNC %p\n", pPager))
3816
3817 pPager->state = PAGER_SYNCED;
3818 }else if( MEMDB && nTrunc!=0 ){
3819 rc = sqlite3PagerTruncate(pPager, nTrunc);
3820 }
3821
3822sync_exit:
3823 return rc;
3824}
3825
3826
3827/*
drhed7c8552001-04-11 14:29:21 +00003828** Commit all changes to the database and release the write lock.
drhd9b02572001-04-15 00:37:09 +00003829**
3830** If the commit fails for any reason, a rollback attempt is made
3831** and an error code is returned. If the commit worked, SQLITE_OK
3832** is returned.
drhed7c8552001-04-11 14:29:21 +00003833*/
drh80e35f42007-03-30 14:06:34 +00003834int sqlite3PagerCommitPhaseTwo(Pager *pPager){
drha1b351a2001-09-14 16:42:12 +00003835 int rc;
drhed7c8552001-04-11 14:29:21 +00003836 PgHdr *pPg;
drhd9b02572001-04-15 00:37:09 +00003837
danielk1977efaaf572006-01-16 11:29:19 +00003838 if( pPager->errCode ){
danielk19777f7bc662006-01-23 13:47:47 +00003839 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00003840 }
drha6abd042004-06-09 17:37:22 +00003841 if( pPager->state<PAGER_RESERVED ){
drhd9b02572001-04-15 00:37:09 +00003842 return SQLITE_ERROR;
3843 }
drh4f0c5872007-03-26 22:05:01 +00003844 PAGERTRACE2("COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003845 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00003846 pPg = pager_get_all_dirty_pages(pPager);
3847 while( pPg ){
danielk1977f35843b2007-04-07 15:03:17 +00003848 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
3849 clearHistory(pHist);
drhac69b052004-05-12 13:30:07 +00003850 pPg->dirty = 0;
3851 pPg->inJournal = 0;
danielk1977f35843b2007-04-07 15:03:17 +00003852 pHist->inStmt = 0;
drh5229ae42006-03-23 23:29:04 +00003853 pPg->needSync = 0;
danielk1977f35843b2007-04-07 15:03:17 +00003854 pHist->pPrevStmt = pHist->pNextStmt = 0;
drhac69b052004-05-12 13:30:07 +00003855 pPg = pPg->pDirty;
3856 }
drh605ad8f2006-05-03 23:34:05 +00003857 pPager->pDirty = 0;
danielk1977eac7a362004-06-16 07:45:24 +00003858#ifndef NDEBUG
3859 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
3860 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
3861 assert( !pPg->alwaysRollback );
3862 assert( !pHist->pOrig );
3863 assert( !pHist->pStmt );
3864 }
3865#endif
drhac69b052004-05-12 13:30:07 +00003866 pPager->pStmt = 0;
drha6abd042004-06-09 17:37:22 +00003867 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00003868 return SQLITE_OK;
3869 }
drh3cdd7d32007-03-30 14:46:01 +00003870 assert( pPager->journalOpen || !pPager->dirtyCache );
3871 assert( pPager->state==PAGER_SYNCED || !pPager->dirtyCache );
3872 rc = pager_end_transaction(pPager);
danielk1977979f38e2007-03-27 16:19:51 +00003873 return pager_error(pPager, rc);
drhed7c8552001-04-11 14:29:21 +00003874}
3875
3876/*
drha6abd042004-06-09 17:37:22 +00003877** Rollback all changes. The database falls back to PAGER_SHARED mode.
drhed7c8552001-04-11 14:29:21 +00003878** All in-memory cache pages revert to their original data contents.
3879** The journal is deleted.
drhd9b02572001-04-15 00:37:09 +00003880**
3881** This routine cannot fail unless some other process is not following
drh4f0ee682007-03-30 20:43:40 +00003882** the correct locking protocol or unless some other
drhd9b02572001-04-15 00:37:09 +00003883** process is writing trash into the journal file (SQLITE_CORRUPT) or
3884** unless a prior malloc() failed (SQLITE_NOMEM). Appropriate error
3885** codes are returned for all these occasions. Otherwise,
3886** SQLITE_OK is returned.
drhed7c8552001-04-11 14:29:21 +00003887*/
danielk19773b8a05f2007-03-19 17:44:26 +00003888int sqlite3PagerRollback(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +00003889 int rc;
drh4f0c5872007-03-26 22:05:01 +00003890 PAGERTRACE2("ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00003891 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00003892 PgHdr *p;
3893 for(p=pPager->pAll; p; p=p->pNextAll){
3894 PgHistory *pHist;
danielk1977eac7a362004-06-16 07:45:24 +00003895 assert( !p->alwaysRollback );
3896 if( !p->dirty ){
3897 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pOrig );
3898 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pStmt );
3899 continue;
3900 }
3901
drhac69b052004-05-12 13:30:07 +00003902 pHist = PGHDR_TO_HIST(p, pPager);
3903 if( pHist->pOrig ){
3904 memcpy(PGHDR_TO_DATA(p), pHist->pOrig, pPager->pageSize);
drh4f0c5872007-03-26 22:05:01 +00003905 PAGERTRACE3("ROLLBACK-PAGE %d of %d\n", p->pgno, PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00003906 }else{
drh4f0c5872007-03-26 22:05:01 +00003907 PAGERTRACE3("PAGE %d is clean on %d\n", p->pgno, PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00003908 }
3909 clearHistory(pHist);
3910 p->dirty = 0;
3911 p->inJournal = 0;
danielk1977f35843b2007-04-07 15:03:17 +00003912 pHist->inStmt = 0;
3913 pHist->pPrevStmt = pHist->pNextStmt = 0;
danielk1977369f27e2004-06-15 11:40:04 +00003914 if( pPager->xReiniter ){
danielk19773b8a05f2007-03-19 17:44:26 +00003915 pPager->xReiniter(p, pPager->pageSize);
danielk1977369f27e2004-06-15 11:40:04 +00003916 }
drhac69b052004-05-12 13:30:07 +00003917 }
drh605ad8f2006-05-03 23:34:05 +00003918 pPager->pDirty = 0;
drhac69b052004-05-12 13:30:07 +00003919 pPager->pStmt = 0;
3920 pPager->dbSize = pPager->origDbSize;
danielk1977e180dd92007-04-05 17:15:52 +00003921 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00003922 pPager->stmtInUse = 0;
drha6abd042004-06-09 17:37:22 +00003923 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00003924 return SQLITE_OK;
3925 }
3926
drha6abd042004-06-09 17:37:22 +00003927 if( !pPager->dirtyCache || !pPager->journalOpen ){
drh80e35f42007-03-30 14:06:34 +00003928 rc = pager_end_transaction(pPager);
drhda47d772002-12-02 04:25:19 +00003929 return rc;
3930 }
drhdb48ee02003-01-16 13:42:43 +00003931
danielk1977efaaf572006-01-16 11:29:19 +00003932 if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
drha6abd042004-06-09 17:37:22 +00003933 if( pPager->state>=PAGER_EXCLUSIVE ){
danielk1977e277be02007-03-23 18:12:06 +00003934 pager_playback(pPager, 0);
drh4b845d72002-03-05 12:41:19 +00003935 }
danielk1977efaaf572006-01-16 11:29:19 +00003936 return pPager->errCode;
drhed7c8552001-04-11 14:29:21 +00003937 }
drha6abd042004-06-09 17:37:22 +00003938 if( pPager->state==PAGER_RESERVED ){
danielk197717221812005-02-15 03:38:05 +00003939 int rc2;
danielk1977e277be02007-03-23 18:12:06 +00003940 rc = pager_playback(pPager, 0);
drh80e35f42007-03-30 14:06:34 +00003941 rc2 = pager_end_transaction(pPager);
drha6abd042004-06-09 17:37:22 +00003942 if( rc==SQLITE_OK ){
3943 rc = rc2;
3944 }
3945 }else{
danielk1977e277be02007-03-23 18:12:06 +00003946 rc = pager_playback(pPager, 0);
drhd9b02572001-04-15 00:37:09 +00003947 }
danielk1977e180dd92007-04-05 17:15:52 +00003948 /* pager_reset(pPager); */
drhd9b02572001-04-15 00:37:09 +00003949 pPager->dbSize = -1;
danielk197707cb5602006-01-20 10:55:05 +00003950
3951 /* If an error occurs during a ROLLBACK, we can no longer trust the pager
3952 ** cache. So call pager_error() on the way out to make any error
3953 ** persistent.
3954 */
3955 return pager_error(pPager, rc);
drh98808ba2001-10-18 12:34:46 +00003956}
drhd9b02572001-04-15 00:37:09 +00003957
3958/*
drh5e00f6c2001-09-13 13:46:56 +00003959** Return TRUE if the database file is opened read-only. Return FALSE
3960** if the database is (in theory) writable.
3961*/
danielk19773b8a05f2007-03-19 17:44:26 +00003962int sqlite3PagerIsreadonly(Pager *pPager){
drhbe0072d2001-09-13 14:46:09 +00003963 return pPager->readOnly;
drh5e00f6c2001-09-13 13:46:56 +00003964}
3965
3966/*
drh0f7eb612006-08-08 13:51:43 +00003967** Return the number of references to the pager.
3968*/
danielk19773b8a05f2007-03-19 17:44:26 +00003969int sqlite3PagerRefcount(Pager *pPager){
drh0f7eb612006-08-08 13:51:43 +00003970 return pPager->nRef;
3971}
3972
3973#ifdef SQLITE_TEST
3974/*
drhd9b02572001-04-15 00:37:09 +00003975** This routine is used for testing and analysis only.
3976*/
danielk19773b8a05f2007-03-19 17:44:26 +00003977int *sqlite3PagerStats(Pager *pPager){
danielk197742741be2005-01-08 12:42:39 +00003978 static int a[11];
drhd9b02572001-04-15 00:37:09 +00003979 a[0] = pPager->nRef;
3980 a[1] = pPager->nPage;
3981 a[2] = pPager->mxPage;
3982 a[3] = pPager->dbSize;
3983 a[4] = pPager->state;
danielk1977efaaf572006-01-16 11:29:19 +00003984 a[5] = pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00003985 a[6] = pPager->nHit;
3986 a[7] = pPager->nMiss;
drh7c4ac0c2007-04-05 11:25:58 +00003987 a[8] = 0; /* Used to be pPager->nOvfl */
danielk197742741be2005-01-08 12:42:39 +00003988 a[9] = pPager->nRead;
3989 a[10] = pPager->nWrite;
drhd9b02572001-04-15 00:37:09 +00003990 return a;
3991}
drh0f7eb612006-08-08 13:51:43 +00003992#endif
drhdd793422001-06-28 01:54:48 +00003993
drhfa86c412002-02-02 15:01:15 +00003994/*
drhac69b052004-05-12 13:30:07 +00003995** Set the statement rollback point.
drhfa86c412002-02-02 15:01:15 +00003996**
3997** This routine should be called with the transaction journal already
drhac69b052004-05-12 13:30:07 +00003998** open. A new statement journal is created that can be used to rollback
drhaaab5722002-02-19 13:39:21 +00003999** changes of a single SQL command within a larger transaction.
drhfa86c412002-02-02 15:01:15 +00004000*/
danielk19773b8a05f2007-03-19 17:44:26 +00004001int sqlite3PagerStmtBegin(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00004002 int rc;
drhac69b052004-05-12 13:30:07 +00004003 assert( !pPager->stmtInUse );
drh1aa2d8b2007-01-03 15:34:29 +00004004 assert( pPager->state>=PAGER_SHARED );
drhdc3ff9c2004-08-18 02:10:15 +00004005 assert( pPager->dbSize>=0 );
drh4f0c5872007-03-26 22:05:01 +00004006 PAGERTRACE2("STMT-BEGIN %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004007 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004008 pPager->stmtInUse = 1;
4009 pPager->stmtSize = pPager->dbSize;
4010 return SQLITE_OK;
4011 }
drhda47d772002-12-02 04:25:19 +00004012 if( !pPager->journalOpen ){
drhac69b052004-05-12 13:30:07 +00004013 pPager->stmtAutoopen = 1;
drhda47d772002-12-02 04:25:19 +00004014 return SQLITE_OK;
4015 }
drhfa86c412002-02-02 15:01:15 +00004016 assert( pPager->journalOpen );
drhac69b052004-05-12 13:30:07 +00004017 pPager->aInStmt = sqliteMalloc( pPager->dbSize/8 + 1 );
4018 if( pPager->aInStmt==0 ){
danielk1977261919c2005-12-06 12:52:59 +00004019 /* sqlite3OsLock(pPager->fd, SHARED_LOCK); */
drhfa86c412002-02-02 15:01:15 +00004020 return SQLITE_NOMEM;
4021 }
drh968af522003-02-11 14:55:40 +00004022#ifndef NDEBUG
drh054889e2005-11-30 03:20:31 +00004023 rc = sqlite3OsFileSize(pPager->jfd, &pPager->stmtJSize);
drhac69b052004-05-12 13:30:07 +00004024 if( rc ) goto stmt_begin_failed;
danielk197776572402004-06-25 02:38:54 +00004025 assert( pPager->stmtJSize == pPager->journalOff );
drh968af522003-02-11 14:55:40 +00004026#endif
danielk197776572402004-06-25 02:38:54 +00004027 pPager->stmtJSize = pPager->journalOff;
drhac69b052004-05-12 13:30:07 +00004028 pPager->stmtSize = pPager->dbSize;
danielk197776572402004-06-25 02:38:54 +00004029 pPager->stmtHdrOff = 0;
danielk197775edc162004-06-26 01:48:18 +00004030 pPager->stmtCksum = pPager->cksumInit;
drhac69b052004-05-12 13:30:07 +00004031 if( !pPager->stmtOpen ){
danielk19773b8a05f2007-03-19 17:44:26 +00004032 rc = sqlite3PagerOpentemp(&pPager->stfd);
drhac69b052004-05-12 13:30:07 +00004033 if( rc ) goto stmt_begin_failed;
4034 pPager->stmtOpen = 1;
4035 pPager->stmtNRec = 0;
drh0f892532002-05-30 12:27:03 +00004036 }
drhac69b052004-05-12 13:30:07 +00004037 pPager->stmtInUse = 1;
drhfa86c412002-02-02 15:01:15 +00004038 return SQLITE_OK;
4039
drhac69b052004-05-12 13:30:07 +00004040stmt_begin_failed:
4041 if( pPager->aInStmt ){
4042 sqliteFree(pPager->aInStmt);
4043 pPager->aInStmt = 0;
drhfa86c412002-02-02 15:01:15 +00004044 }
4045 return rc;
4046}
4047
4048/*
drhac69b052004-05-12 13:30:07 +00004049** Commit a statement.
drhfa86c412002-02-02 15:01:15 +00004050*/
danielk19773b8a05f2007-03-19 17:44:26 +00004051int sqlite3PagerStmtCommit(Pager *pPager){
drhac69b052004-05-12 13:30:07 +00004052 if( pPager->stmtInUse ){
drh03eb96a2002-11-10 23:32:56 +00004053 PgHdr *pPg, *pNext;
drh4f0c5872007-03-26 22:05:01 +00004054 PAGERTRACE2("STMT-COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004055 if( !MEMDB ){
drh054889e2005-11-30 03:20:31 +00004056 sqlite3OsSeek(pPager->stfd, 0);
4057 /* sqlite3OsTruncate(pPager->stfd, 0); */
drhac69b052004-05-12 13:30:07 +00004058 sqliteFree( pPager->aInStmt );
4059 pPager->aInStmt = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004060 }else{
4061 for(pPg=pPager->pStmt; pPg; pPg=pNext){
drhac69b052004-05-12 13:30:07 +00004062 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
danielk1977f35843b2007-04-07 15:03:17 +00004063 pNext = pHist->pNextStmt;
4064 assert( pHist->inStmt );
4065 pHist->inStmt = 0;
4066 pHist->pPrevStmt = pHist->pNextStmt = 0;
drhac69b052004-05-12 13:30:07 +00004067 sqliteFree(pHist->pStmt);
4068 pHist->pStmt = 0;
4069 }
4070 }
4071 pPager->stmtNRec = 0;
4072 pPager->stmtInUse = 0;
4073 pPager->pStmt = 0;
drh663fc632002-02-02 18:49:19 +00004074 }
drhac69b052004-05-12 13:30:07 +00004075 pPager->stmtAutoopen = 0;
drhfa86c412002-02-02 15:01:15 +00004076 return SQLITE_OK;
4077}
4078
4079/*
drhac69b052004-05-12 13:30:07 +00004080** Rollback a statement.
drhfa86c412002-02-02 15:01:15 +00004081*/
danielk19773b8a05f2007-03-19 17:44:26 +00004082int sqlite3PagerStmtRollback(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00004083 int rc;
drhac69b052004-05-12 13:30:07 +00004084 if( pPager->stmtInUse ){
drh4f0c5872007-03-26 22:05:01 +00004085 PAGERTRACE2("STMT-ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004086 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004087 PgHdr *pPg;
danielk1977f35843b2007-04-07 15:03:17 +00004088 PgHistory *pHist;
4089 for(pPg=pPager->pStmt; pPg; pPg=pHist->pNextStmt){
4090 pHist = PGHDR_TO_HIST(pPg, pPager);
drhac69b052004-05-12 13:30:07 +00004091 if( pHist->pStmt ){
4092 memcpy(PGHDR_TO_DATA(pPg), pHist->pStmt, pPager->pageSize);
4093 sqliteFree(pHist->pStmt);
4094 pHist->pStmt = 0;
4095 }
4096 }
4097 pPager->dbSize = pPager->stmtSize;
danielk1977e180dd92007-04-05 17:15:52 +00004098 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00004099 rc = SQLITE_OK;
4100 }else{
4101 rc = pager_stmt_playback(pPager);
4102 }
danielk19773b8a05f2007-03-19 17:44:26 +00004103 sqlite3PagerStmtCommit(pPager);
drh663fc632002-02-02 18:49:19 +00004104 }else{
4105 rc = SQLITE_OK;
4106 }
drhac69b052004-05-12 13:30:07 +00004107 pPager->stmtAutoopen = 0;
drhfa86c412002-02-02 15:01:15 +00004108 return rc;
4109}
4110
drh73509ee2003-04-06 20:44:45 +00004111/*
4112** Return the full pathname of the database file.
4113*/
danielk19773b8a05f2007-03-19 17:44:26 +00004114const char *sqlite3PagerFilename(Pager *pPager){
drh73509ee2003-04-06 20:44:45 +00004115 return pPager->zFilename;
4116}
4117
drhb20ea9d2004-02-09 01:20:36 +00004118/*
danielk19775865e3d2004-06-14 06:03:57 +00004119** Return the directory of the database file.
4120*/
danielk19773b8a05f2007-03-19 17:44:26 +00004121const char *sqlite3PagerDirname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00004122 return pPager->zDirectory;
4123}
4124
4125/*
4126** Return the full pathname of the journal file.
4127*/
danielk19773b8a05f2007-03-19 17:44:26 +00004128const char *sqlite3PagerJournalname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00004129 return pPager->zJournal;
4130}
4131
4132/*
drh2c8997b2005-08-27 16:36:48 +00004133** Return true if fsync() calls are disabled for this pager. Return FALSE
4134** if fsync()s are executed normally.
4135*/
danielk19773b8a05f2007-03-19 17:44:26 +00004136int sqlite3PagerNosync(Pager *pPager){
drh2c8997b2005-08-27 16:36:48 +00004137 return pPager->noSync;
4138}
4139
drh7c4ac0c2007-04-05 11:25:58 +00004140#ifdef SQLITE_HAS_CODEC
drh2c8997b2005-08-27 16:36:48 +00004141/*
drhb20ea9d2004-02-09 01:20:36 +00004142** Set the codec for this pager
4143*/
danielk19773b8a05f2007-03-19 17:44:26 +00004144void sqlite3PagerSetCodec(
drhb20ea9d2004-02-09 01:20:36 +00004145 Pager *pPager,
drhc001c582006-03-06 18:23:16 +00004146 void *(*xCodec)(void*,void*,Pgno,int),
drhb20ea9d2004-02-09 01:20:36 +00004147 void *pCodecArg
4148){
4149 pPager->xCodec = xCodec;
4150 pPager->pCodecArg = pCodecArg;
4151}
drh7c4ac0c2007-04-05 11:25:58 +00004152#endif
drhb20ea9d2004-02-09 01:20:36 +00004153
danielk1977687566d2004-11-02 12:56:41 +00004154#ifndef SQLITE_OMIT_AUTOVACUUM
4155/*
4156** Move the page identified by pData to location pgno in the file.
4157**
4158** There must be no references to the current page pgno. If current page
4159** pgno is not already in the rollback journal, it is not written there by
4160** by this routine. The same applies to the page pData refers to on entry to
4161** this routine.
4162**
4163** References to the page refered to by pData remain valid. Updating any
4164** meta-data associated with page pData (i.e. data stored in the nExtra bytes
4165** allocated along with the page) is the responsibility of the caller.
4166**
danielk19775fd057a2005-03-09 13:09:43 +00004167** A transaction must be active when this routine is called. It used to be
4168** required that a statement transaction was not active, but this restriction
4169** has been removed (CREATE INDEX needs to move a page when a statement
4170** transaction is active).
danielk1977687566d2004-11-02 12:56:41 +00004171*/
danielk19773b8a05f2007-03-19 17:44:26 +00004172int sqlite3PagerMovepage(Pager *pPager, DbPage *pPg, Pgno pgno){
danielk1977687566d2004-11-02 12:56:41 +00004173 PgHdr *pPgOld;
danielk1977f5fdda82004-11-03 08:44:05 +00004174 int h;
danielk197794daf7f2004-11-08 09:26:09 +00004175 Pgno needSyncPgno = 0;
danielk1977687566d2004-11-02 12:56:41 +00004176
danielk1977687566d2004-11-02 12:56:41 +00004177 assert( pPg->nRef>0 );
4178
drh4f0c5872007-03-26 22:05:01 +00004179 PAGERTRACE5("MOVE %d page %d (needSync=%d) moves to %d\n",
danielk1977599fcba2004-11-08 07:13:13 +00004180 PAGERID(pPager), pPg->pgno, pPg->needSync, pgno);
drhb0603412007-02-28 04:47:26 +00004181 IOTRACE(("MOVE %p %d %d\n", pPager, pPg->pgno, pgno))
danielk1977ef73ee92004-11-06 12:26:07 +00004182
danielk197794daf7f2004-11-08 09:26:09 +00004183 if( pPg->needSync ){
4184 needSyncPgno = pPg->pgno;
4185 assert( pPg->inJournal );
4186 assert( pPg->dirty );
danielk1977ae825582004-11-23 09:06:55 +00004187 assert( pPager->needSync );
danielk197794daf7f2004-11-08 09:26:09 +00004188 }
4189
danielk1977687566d2004-11-02 12:56:41 +00004190 /* Unlink pPg from it's hash-chain */
danielk1977f5fdda82004-11-03 08:44:05 +00004191 unlinkHashChain(pPager, pPg);
danielk1977687566d2004-11-02 12:56:41 +00004192
danielk1977ef73ee92004-11-06 12:26:07 +00004193 /* If the cache contains a page with page-number pgno, remove it
danielk1977599fcba2004-11-08 07:13:13 +00004194 ** from it's hash chain. Also, if the PgHdr.needSync was set for
4195 ** page pgno before the 'move' operation, it needs to be retained
4196 ** for the page moved there.
danielk1977f5fdda82004-11-03 08:44:05 +00004197 */
danielk1977687566d2004-11-02 12:56:41 +00004198 pPgOld = pager_lookup(pPager, pgno);
4199 if( pPgOld ){
danielk1977f5fdda82004-11-03 08:44:05 +00004200 assert( pPgOld->nRef==0 );
4201 unlinkHashChain(pPager, pPgOld);
drh605ad8f2006-05-03 23:34:05 +00004202 makeClean(pPgOld);
danielk1977ef73ee92004-11-06 12:26:07 +00004203 if( pPgOld->needSync ){
danielk197745901d62004-11-10 15:27:38 +00004204 assert( pPgOld->inJournal );
4205 pPg->inJournal = 1;
danielk1977ef73ee92004-11-06 12:26:07 +00004206 pPg->needSync = 1;
danielk1977ae825582004-11-23 09:06:55 +00004207 assert( pPager->needSync );
danielk1977ef73ee92004-11-06 12:26:07 +00004208 }
danielk1977687566d2004-11-02 12:56:41 +00004209 }
4210
danielk1977f5fdda82004-11-03 08:44:05 +00004211 /* Change the page number for pPg and insert it into the new hash-chain. */
drh3765df42006-06-28 18:18:09 +00004212 assert( pgno!=0 );
danielk1977f5fdda82004-11-03 08:44:05 +00004213 pPg->pgno = pgno;
drh8ca0c722006-05-07 17:49:38 +00004214 h = pgno & (pPager->nHash-1);
danielk1977f5fdda82004-11-03 08:44:05 +00004215 if( pPager->aHash[h] ){
4216 assert( pPager->aHash[h]->pPrevHash==0 );
4217 pPager->aHash[h]->pPrevHash = pPg;
4218 }
4219 pPg->pNextHash = pPager->aHash[h];
4220 pPager->aHash[h] = pPg;
4221 pPg->pPrevHash = 0;
4222
drh605ad8f2006-05-03 23:34:05 +00004223 makeDirty(pPg);
danielk1977687566d2004-11-02 12:56:41 +00004224 pPager->dirtyCache = 1;
4225
danielk197794daf7f2004-11-08 09:26:09 +00004226 if( needSyncPgno ){
4227 /* If needSyncPgno is non-zero, then the journal file needs to be
4228 ** sync()ed before any data is written to database file page needSyncPgno.
4229 ** Currently, no such page exists in the page-cache and the
4230 ** Pager.aInJournal bit has been set. This needs to be remedied by loading
4231 ** the page into the pager-cache and setting the PgHdr.needSync flag.
danielk1977ae825582004-11-23 09:06:55 +00004232 **
danielk19773b8a05f2007-03-19 17:44:26 +00004233 ** The sqlite3PagerGet() call may cause the journal to sync. So make
danielk1977ae825582004-11-23 09:06:55 +00004234 ** sure the Pager.needSync flag is set too.
danielk197794daf7f2004-11-08 09:26:09 +00004235 */
4236 int rc;
danielk19773b8a05f2007-03-19 17:44:26 +00004237 PgHdr *pPgHdr;
danielk1977ae825582004-11-23 09:06:55 +00004238 assert( pPager->needSync );
danielk19773b8a05f2007-03-19 17:44:26 +00004239 rc = sqlite3PagerGet(pPager, needSyncPgno, &pPgHdr);
danielk197794daf7f2004-11-08 09:26:09 +00004240 if( rc!=SQLITE_OK ) return rc;
danielk1977ae825582004-11-23 09:06:55 +00004241 pPager->needSync = 1;
danielk19773b8a05f2007-03-19 17:44:26 +00004242 pPgHdr->needSync = 1;
4243 pPgHdr->inJournal = 1;
4244 makeDirty(pPgHdr);
4245 sqlite3PagerUnref(pPgHdr);
danielk197794daf7f2004-11-08 09:26:09 +00004246 }
4247
danielk1977687566d2004-11-02 12:56:41 +00004248 return SQLITE_OK;
4249}
4250#endif
4251
danielk19773b8a05f2007-03-19 17:44:26 +00004252/*
4253** Return a pointer to the data for the specified page.
4254*/
4255void *sqlite3PagerGetData(DbPage *pPg){
4256 return PGHDR_TO_DATA(pPg);
4257}
4258
4259/*
4260** Return a pointer to the Pager.nExtra bytes of "extra" space
4261** allocated along with the specified page.
4262*/
4263void *sqlite3PagerGetExtra(DbPage *pPg){
4264 Pager *pPager = pPg->pPager;
4265 return (pPager?PGHDR_TO_EXTRA(pPg, pPager):0);
4266}
4267
danielk197741483462007-03-24 16:45:04 +00004268/*
4269** Get/set the locking-mode for this pager. Parameter eMode must be one
4270** of PAGER_LOCKINGMODE_QUERY, PAGER_LOCKINGMODE_NORMAL or
4271** PAGER_LOCKINGMODE_EXCLUSIVE. If the parameter is not _QUERY, then
4272** the locking-mode is set to the value specified.
4273**
4274** The returned value is either PAGER_LOCKINGMODE_NORMAL or
4275** PAGER_LOCKINGMODE_EXCLUSIVE, indicating the current (possibly updated)
4276** locking-mode.
4277*/
4278int sqlite3PagerLockingMode(Pager *pPager, int eMode){
drh369339d2007-03-30 16:01:55 +00004279 assert( eMode==PAGER_LOCKINGMODE_QUERY
4280 || eMode==PAGER_LOCKINGMODE_NORMAL
4281 || eMode==PAGER_LOCKINGMODE_EXCLUSIVE );
4282 assert( PAGER_LOCKINGMODE_QUERY<0 );
4283 assert( PAGER_LOCKINGMODE_NORMAL>=0 && PAGER_LOCKINGMODE_EXCLUSIVE>=0 );
4284 if( eMode>=0 && !pPager->tempFile ){
danielk197741483462007-03-24 16:45:04 +00004285 pPager->exclusiveMode = eMode;
4286 }
4287 return (int)pPager->exclusiveMode;
4288}
4289
dougcurrie81c95ef2004-06-18 23:21:47 +00004290#if defined(SQLITE_DEBUG) || defined(SQLITE_TEST)
drh89ac8c12004-06-09 14:17:20 +00004291/*
4292** Return the current state of the file lock for the given pager.
4293** The return value is one of NO_LOCK, SHARED_LOCK, RESERVED_LOCK,
4294** PENDING_LOCK, or EXCLUSIVE_LOCK.
4295*/
danielk19773b8a05f2007-03-19 17:44:26 +00004296int sqlite3PagerLockstate(Pager *pPager){
drh054889e2005-11-30 03:20:31 +00004297 return sqlite3OsLockState(pPager->fd);
drh89ac8c12004-06-09 14:17:20 +00004298}
4299#endif
4300
danielk197793758c82005-01-21 08:13:14 +00004301#ifdef SQLITE_DEBUG
drhdd793422001-06-28 01:54:48 +00004302/*
4303** Print a listing of all referenced pages and their ref count.
4304*/
danielk19773b8a05f2007-03-19 17:44:26 +00004305void sqlite3PagerRefdump(Pager *pPager){
drhdd793422001-06-28 01:54:48 +00004306 PgHdr *pPg;
4307 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
4308 if( pPg->nRef<=0 ) continue;
drhfe63d1c2004-09-08 20:13:04 +00004309 sqlite3DebugPrintf("PAGE %3d addr=%p nRef=%d\n",
4310 pPg->pgno, PGHDR_TO_DATA(pPg), pPg->nRef);
drhdd793422001-06-28 01:54:48 +00004311 }
4312}
4313#endif
drh2e66f0b2005-04-28 17:18:48 +00004314
4315#endif /* SQLITE_OMIT_DISKIO */