blob: f2f6796beb0ca369d0ead9940e9ae2a086e0ccd8 [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**
drhfdc40e92008-04-17 20:59:37 +000021** @(#) $Id: pager.c,v 1.429 2008/04/17 20:59:38 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"
drhed7c8552001-04-11 14:29:21 +000025#include <assert.h>
drhd9b02572001-04-15 00:37:09 +000026#include <string.h>
drhed7c8552001-04-11 14:29:21 +000027
28/*
drhdb48ee02003-01-16 13:42:43 +000029** Macros for troubleshooting. Normally turned off
30*/
danielk1977466be562004-06-10 02:16:01 +000031#if 0
drhd3627af2006-12-18 18:34:51 +000032#define sqlite3DebugPrintf printf
drh4f0c5872007-03-26 22:05:01 +000033#define PAGERTRACE1(X) sqlite3DebugPrintf(X)
34#define PAGERTRACE2(X,Y) sqlite3DebugPrintf(X,Y)
35#define PAGERTRACE3(X,Y,Z) sqlite3DebugPrintf(X,Y,Z)
36#define PAGERTRACE4(X,Y,Z,W) sqlite3DebugPrintf(X,Y,Z,W)
37#define PAGERTRACE5(X,Y,Z,W,V) sqlite3DebugPrintf(X,Y,Z,W,V)
drhdb48ee02003-01-16 13:42:43 +000038#else
drh4f0c5872007-03-26 22:05:01 +000039#define PAGERTRACE1(X)
40#define PAGERTRACE2(X,Y)
41#define PAGERTRACE3(X,Y,Z)
42#define PAGERTRACE4(X,Y,Z,W)
43#define PAGERTRACE5(X,Y,Z,W,V)
drhdb48ee02003-01-16 13:42:43 +000044#endif
45
danielk1977599fcba2004-11-08 07:13:13 +000046/*
drh4f0c5872007-03-26 22:05:01 +000047** The following two macros are used within the PAGERTRACEX() macros above
drhd86959f2005-11-26 03:51:18 +000048** to print out file-descriptors.
danielk1977599fcba2004-11-08 07:13:13 +000049**
drh85b623f2007-12-13 21:54:09 +000050** PAGERID() takes a pointer to a Pager struct as its argument. The
danielk197762079062007-08-15 17:08:46 +000051** associated file-descriptor is returned. FILEHANDLEID() takes an sqlite3_file
drh85b623f2007-12-13 21:54:09 +000052** struct as its argument.
danielk1977599fcba2004-11-08 07:13:13 +000053*/
drhc001c582006-03-06 18:23:16 +000054#define PAGERID(p) ((int)(p->fd))
55#define FILEHANDLEID(fd) ((int)fd)
drhdb48ee02003-01-16 13:42:43 +000056
57/*
drhed7c8552001-04-11 14:29:21 +000058** The page cache as a whole is always in one of the following
59** states:
60**
drha6abd042004-06-09 17:37:22 +000061** PAGER_UNLOCK The page cache is not currently reading or
drhed7c8552001-04-11 14:29:21 +000062** writing the database file. There is no
63** data held in memory. This is the initial
64** state.
65**
drha6abd042004-06-09 17:37:22 +000066** PAGER_SHARED The page cache is reading the database.
drhed7c8552001-04-11 14:29:21 +000067** Writing is not permitted. There can be
68** multiple readers accessing the same database
drh69688d52001-04-14 16:38:23 +000069** file at the same time.
drhed7c8552001-04-11 14:29:21 +000070**
drh726de592004-06-10 23:35:50 +000071** PAGER_RESERVED This process has reserved the database for writing
72** but has not yet made any changes. Only one process
73** at a time can reserve the database. The original
74** database file has not been modified so other
75** processes may still be reading the on-disk
drha6abd042004-06-09 17:37:22 +000076** database file.
77**
78** PAGER_EXCLUSIVE The page cache is writing the database.
drhed7c8552001-04-11 14:29:21 +000079** Access is exclusive. No other processes or
80** threads can be reading or writing while one
81** process is writing.
82**
danielk1977aa5ccdf2004-06-14 05:10:42 +000083** PAGER_SYNCED The pager moves to this state from PAGER_EXCLUSIVE
84** after all dirty pages have been written to the
85** database file and the file has been synced to
drh369339d2007-03-30 16:01:55 +000086** disk. All that remains to do is to remove or
87** truncate the journal file and the transaction
88** will be committed.
danielk1977aa5ccdf2004-06-14 05:10:42 +000089**
drha6abd042004-06-09 17:37:22 +000090** The page cache comes up in PAGER_UNLOCK. The first time a
danielk19773b8a05f2007-03-19 17:44:26 +000091** sqlite3PagerGet() occurs, the state transitions to PAGER_SHARED.
drhed7c8552001-04-11 14:29:21 +000092** After all pages have been released using sqlite_page_unref(),
drha6abd042004-06-09 17:37:22 +000093** the state transitions back to PAGER_UNLOCK. The first time
danielk19773b8a05f2007-03-19 17:44:26 +000094** that sqlite3PagerWrite() is called, the state transitions to
drh369339d2007-03-30 16:01:55 +000095** PAGER_RESERVED. (Note that sqlite3PagerWrite() can only be
drh306dc212001-05-21 13:45:10 +000096** called on an outstanding page which means that the pager must
drha6abd042004-06-09 17:37:22 +000097** be in PAGER_SHARED before it transitions to PAGER_RESERVED.)
drh369339d2007-03-30 16:01:55 +000098** PAGER_RESERVED means that there is an open rollback journal.
99** The transition to PAGER_EXCLUSIVE occurs before any changes
100** are made to the database file, though writes to the rollback
101** journal occurs with just PAGER_RESERVED. After an sqlite3PagerRollback()
102** or sqlite3PagerCommitPhaseTwo(), the state can go back to PAGER_SHARED,
103** or it can stay at PAGER_EXCLUSIVE if we are in exclusive access mode.
drhed7c8552001-04-11 14:29:21 +0000104*/
drha6abd042004-06-09 17:37:22 +0000105#define PAGER_UNLOCK 0
drh684917c2004-10-05 02:41:42 +0000106#define PAGER_SHARED 1 /* same as SHARED_LOCK */
107#define PAGER_RESERVED 2 /* same as RESERVED_LOCK */
108#define PAGER_EXCLUSIVE 4 /* same as EXCLUSIVE_LOCK */
109#define PAGER_SYNCED 5
drhed7c8552001-04-11 14:29:21 +0000110
drh684917c2004-10-05 02:41:42 +0000111/*
112** If the SQLITE_BUSY_RESERVED_LOCK macro is set to true at compile-time,
113** then failed attempts to get a reserved lock will invoke the busy callback.
114** This is off by default. To see why, consider the following scenario:
115**
116** Suppose thread A already has a shared lock and wants a reserved lock.
117** Thread B already has a reserved lock and wants an exclusive lock. If
118** both threads are using their busy callbacks, it might be a long time
119** be for one of the threads give up and allows the other to proceed.
120** But if the thread trying to get the reserved lock gives up quickly
121** (if it never invokes its busy callback) then the contention will be
122** resolved quickly.
123*/
124#ifndef SQLITE_BUSY_RESERVED_LOCK
125# define SQLITE_BUSY_RESERVED_LOCK 0
126#endif
drhd9b02572001-04-15 00:37:09 +0000127
drhed7c8552001-04-11 14:29:21 +0000128/*
drh887dc4c2004-10-22 16:22:57 +0000129** This macro rounds values up so that if the value is an address it
130** is guaranteed to be an address that is aligned to an 8-byte boundary.
131*/
132#define FORCE_ALIGNMENT(X) (((X)+7)&~7)
133
danielk19779f61c2f2007-08-27 17:27:49 +0000134typedef struct PgHdr PgHdr;
danielk197784f786f2007-08-28 08:00:17 +0000135
136/*
137** Each pager stores all currently unreferenced pages in a list sorted
138** in least-recently-used (LRU) order (i.e. the first item on the list has
139** not been referenced in a long time, the last item has been recently
140** used). An instance of this structure is included as part of each
141** pager structure for this purpose (variable Pager.lru).
142**
143** Additionally, if memory-management is enabled, all unreferenced pages
144** are stored in a global LRU list (global variable sqlite3LruPageList).
145**
146** In both cases, the PagerLruList.pFirstSynced variable points to
147** the first page in the corresponding list that does not require an
drh85b623f2007-12-13 21:54:09 +0000148** fsync() operation before its memory can be reclaimed. If no such
danielk197784f786f2007-08-28 08:00:17 +0000149** page exists, PagerLruList.pFirstSynced is set to NULL.
150*/
151typedef struct PagerLruList PagerLruList;
152struct PagerLruList {
153 PgHdr *pFirst; /* First page in LRU list */
154 PgHdr *pLast; /* Last page in LRU list (the most recently used) */
155 PgHdr *pFirstSynced; /* First page in list with PgHdr.needSync==0 */
156};
157
158/*
159** The following structure contains the next and previous pointers used
160** to link a PgHdr structure into a PagerLruList linked list.
161*/
danielk19779f61c2f2007-08-27 17:27:49 +0000162typedef struct PagerLruLink PagerLruLink;
163struct PagerLruLink {
164 PgHdr *pNext;
165 PgHdr *pPrev;
166};
167
drh887dc4c2004-10-22 16:22:57 +0000168/*
drhed7c8552001-04-11 14:29:21 +0000169** Each in-memory image of a page begins with the following header.
drhbd03cae2001-06-02 02:40:57 +0000170** This header is only visible to this pager module. The client
171** code that calls pager sees only the data that follows the header.
drhf6038712004-02-08 18:07:34 +0000172**
danielk19773b8a05f2007-03-19 17:44:26 +0000173** Client code should call sqlite3PagerWrite() on a page prior to making
174** any modifications to that page. The first time sqlite3PagerWrite()
drhf6038712004-02-08 18:07:34 +0000175** is called, the original page contents are written into the rollback
176** journal and PgHdr.inJournal and PgHdr.needSync are set. Later, once
177** the journal page has made it onto the disk surface, PgHdr.needSync
178** is cleared. The modified page cannot be written back into the original
179** database file until the journal pages has been synced to disk and the
180** PgHdr.needSync has been cleared.
181**
danielk19773b8a05f2007-03-19 17:44:26 +0000182** The PgHdr.dirty flag is set when sqlite3PagerWrite() is called and
drhf6038712004-02-08 18:07:34 +0000183** is cleared again when the page content is written back to the original
184** database file.
drh732c8172007-06-16 11:17:45 +0000185**
186** Details of important structure elements:
187**
188** needSync
189**
190** If this is true, this means that it is not safe to write the page
191** content to the database because the original content needed
192** for rollback has not by synced to the main rollback journal.
193** The original content may have been written to the rollback journal
194** but it has not yet been synced. So we cannot write to the database
195** file because power failure might cause the page in the journal file
196** to never reach the disk. It is as if the write to the journal file
197** does not occur until the journal file is synced.
198**
199** This flag is false if the page content exactly matches what
200** currently exists in the database file. The needSync flag is also
201** false if the original content has been written to the main rollback
202** journal and synced. If the page represents a new page that has
203** been added onto the end of the database during the current
204** transaction, the needSync flag is true until the original database
205** size in the journal header has been synced to disk.
206**
207** inJournal
208**
209** This is true if the original page has been written into the main
210** rollback journal. This is always false for new pages added to
211** the end of the database file during the current transaction.
212** And this flag says nothing about whether or not the journal
213** has been synced to disk. For pages that are in the original
214** database file, the following expression should always be true:
215**
drhf5e7bb52008-02-18 14:47:33 +0000216** inJournal = sqlite3BitvecTest(pPager->pInJournal, pgno)
drh732c8172007-06-16 11:17:45 +0000217**
drhf5e7bb52008-02-18 14:47:33 +0000218** The pPager->pInJournal object is only valid for the original
drh732c8172007-06-16 11:17:45 +0000219** pages of the database, not new pages that are added to the end
220** of the database, so obviously the above expression cannot be
221** valid for new pages. For new pages inJournal is always 0.
222**
223** dirty
224**
225** When true, this means that the content of the page has been
226** modified and needs to be written back to the database file.
227** If false, it means that either the content of the page is
228** unchanged or else the content is unimportant and we do not
229** care whether or not it is preserved.
230**
231** alwaysRollback
232**
233** This means that the sqlite3PagerDontRollback() API should be
234** ignored for this page. The DontRollback() API attempts to say
235** that the content of the page on disk is unimportant (it is an
236** unused page on the freelist) so that it is unnecessary to
237** rollback changes to this page because the content of the page
238** can change without changing the meaning of the database. This
239** flag overrides any DontRollback() attempt. This flag is set
240** when a page that originally contained valid data is added to
241** the freelist. Later in the same transaction, this page might
242** be pulled from the freelist and reused for something different
243** and at that point the DontRollback() API will be called because
244** pages taken from the freelist do not need to be protected by
245** the rollback journal. But this flag says that the page was
246** not originally part of the freelist so that it still needs to
247** be rolled back in spite of any subsequent DontRollback() calls.
248**
249** needRead
250**
251** This flag means (when true) that the content of the page has
252** not yet been loaded from disk. The in-memory content is just
253** garbage. (Actually, we zero the content, but you should not
254** make any assumptions about the content nevertheless.) If the
255** content is needed in the future, it should be read from the
256** original database file.
drhed7c8552001-04-11 14:29:21 +0000257*/
258struct PgHdr {
259 Pager *pPager; /* The pager to which this page belongs */
260 Pgno pgno; /* The page number for this page */
drh69688d52001-04-14 16:38:23 +0000261 PgHdr *pNextHash, *pPrevHash; /* Hash collision chain for PgHdr.pgno */
danielk19779f61c2f2007-08-27 17:27:49 +0000262 PagerLruLink free; /* Next and previous free pages */
drhac69b052004-05-12 13:30:07 +0000263 PgHdr *pNextAll; /* A list of all pages */
drh193a6b42002-07-07 16:52:46 +0000264 u8 inJournal; /* TRUE if has been written to journal */
drh193a6b42002-07-07 16:52:46 +0000265 u8 dirty; /* TRUE if we need to write back changes */
drhdb48ee02003-01-16 13:42:43 +0000266 u8 needSync; /* Sync journal before writing this page */
drh80e35f42007-03-30 14:06:34 +0000267 u8 alwaysRollback; /* Disable DontRollback() for this page */
drh538f5702007-04-13 02:14:30 +0000268 u8 needRead; /* Read content if PagerWrite() is called */
drhac69b052004-05-12 13:30:07 +0000269 short int nRef; /* Number of users of this page */
drhdc3e10b2006-06-15 14:31:06 +0000270 PgHdr *pDirty, *pPrevDirty; /* Dirty pages */
danielk19779f61c2f2007-08-27 17:27:49 +0000271#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
272 PagerLruLink gfree; /* Global list of nRef==0 pages */
273#endif
danielk19773c407372005-02-15 02:54:14 +0000274#ifdef SQLITE_CHECK_PAGES
275 u32 pageHash;
276#endif
drhbf4bca52007-09-06 22:19:14 +0000277 void *pData; /* Page data */
278 /* Pager.nExtra bytes of local data appended to this header */
drhed7c8552001-04-11 14:29:21 +0000279};
280
drhac69b052004-05-12 13:30:07 +0000281/*
282** For an in-memory only database, some extra information is recorded about
283** each page so that changes can be rolled back. (Journal files are not
284** used for in-memory databases.) The following information is added to
285** the end of every EXTRA block for in-memory databases.
286**
287** This information could have been added directly to the PgHdr structure.
288** But then it would take up an extra 8 bytes of storage on every PgHdr
289** even for disk-based databases. Splitting it out saves 8 bytes. This
290** is only a savings of 0.8% but those percentages add up.
291*/
292typedef struct PgHistory PgHistory;
293struct PgHistory {
294 u8 *pOrig; /* Original page text. Restore to this on a full rollback */
295 u8 *pStmt; /* Text as it was at the beginning of the current statement */
danielk1977f35843b2007-04-07 15:03:17 +0000296 PgHdr *pNextStmt, *pPrevStmt; /* List of pages in the statement journal */
297 u8 inStmt; /* TRUE if in the statement subjournal */
drhac69b052004-05-12 13:30:07 +0000298};
drh9eb9e262004-02-11 02:18:05 +0000299
300/*
301** A macro used for invoking the codec if there is one
302*/
303#ifdef SQLITE_HAS_CODEC
drhc001c582006-03-06 18:23:16 +0000304# define CODEC1(P,D,N,X) if( P->xCodec!=0 ){ P->xCodec(P->pCodecArg,D,N,X); }
305# define CODEC2(P,D,N,X) ((char*)(P->xCodec!=0?P->xCodec(P->pCodecArg,D,N,X):D))
drh9eb9e262004-02-11 02:18:05 +0000306#else
drhc001c582006-03-06 18:23:16 +0000307# define CODEC1(P,D,N,X) /* NO-OP */
308# define CODEC2(P,D,N,X) ((char*)D)
drh9eb9e262004-02-11 02:18:05 +0000309#endif
310
drhed7c8552001-04-11 14:29:21 +0000311/*
drh69688d52001-04-14 16:38:23 +0000312** Convert a pointer to a PgHdr into a pointer to its data
313** and back again.
drhed7c8552001-04-11 14:29:21 +0000314*/
drhbf4bca52007-09-06 22:19:14 +0000315#define PGHDR_TO_DATA(P) ((P)->pData)
316#define PGHDR_TO_EXTRA(G,P) ((void*)&((G)[1]))
drhac69b052004-05-12 13:30:07 +0000317#define PGHDR_TO_HIST(P,PGR) \
drhbf4bca52007-09-06 22:19:14 +0000318 ((PgHistory*)&((char*)(&(P)[1]))[(PGR)->nExtra])
drhed7c8552001-04-11 14:29:21 +0000319
320/*
drhed7c8552001-04-11 14:29:21 +0000321** A open page cache is an instance of the following structure.
danielk1977efaaf572006-01-16 11:29:19 +0000322**
drh4f0ee682007-03-30 20:43:40 +0000323** Pager.errCode may be set to SQLITE_IOERR, SQLITE_CORRUPT, or
danielk1977efaaf572006-01-16 11:29:19 +0000324** or SQLITE_FULL. Once one of the first three errors occurs, it persists
325** and is returned as the result of every major pager API call. The
326** SQLITE_FULL return code is slightly different. It persists only until the
327** next successful rollback is performed on the pager cache. Also,
danielk19773b8a05f2007-03-19 17:44:26 +0000328** SQLITE_FULL does not affect the sqlite3PagerGet() and sqlite3PagerLookup()
danielk1977efaaf572006-01-16 11:29:19 +0000329** APIs, they may still be used successfully.
drhed7c8552001-04-11 14:29:21 +0000330*/
331struct Pager {
danielk1977b4b47412007-08-17 15:53:36 +0000332 sqlite3_vfs *pVfs; /* OS functions to use for IO */
drh603240c2002-03-05 01:11:12 +0000333 u8 journalOpen; /* True if journal file descriptors is valid */
drh34e79ce2004-02-08 06:05:46 +0000334 u8 journalStarted; /* True if header of journal is synced */
335 u8 useJournal; /* Use a rollback journal on this file */
drh7bec5052005-02-06 02:45:41 +0000336 u8 noReadlock; /* Do not bother to obtain readlocks */
drhac69b052004-05-12 13:30:07 +0000337 u8 stmtOpen; /* True if the statement subjournal is open */
338 u8 stmtInUse; /* True we are in a statement subtransaction */
339 u8 stmtAutoopen; /* Open stmt journal when main journal is opened*/
drh603240c2002-03-05 01:11:12 +0000340 u8 noSync; /* Do not sync the journal if true */
drh968af522003-02-11 14:55:40 +0000341 u8 fullSync; /* Do extra syncs of the journal for robustness */
danielk1977f036aef2007-08-20 05:36:51 +0000342 u8 sync_flags; /* One of SYNC_NORMAL or SYNC_FULL */
drha6abd042004-06-09 17:37:22 +0000343 u8 state; /* PAGER_UNLOCK, _SHARED, _RESERVED, etc. */
drh603240c2002-03-05 01:11:12 +0000344 u8 tempFile; /* zFilename is a temporary file */
345 u8 readOnly; /* True for a read-only database */
346 u8 needSync; /* True if an fsync() is needed on the journal */
drha6abd042004-06-09 17:37:22 +0000347 u8 dirtyCache; /* True if cached pages have changed */
drh80e35f42007-03-30 14:06:34 +0000348 u8 alwaysRollback; /* Disable DontRollback() for all pages */
drhac69b052004-05-12 13:30:07 +0000349 u8 memDb; /* True to inhibit all file I/O */
drh6d156e42005-05-20 20:11:20 +0000350 u8 setMaster; /* True if a m-j name has been written to jrnl */
drh80e35f42007-03-30 14:06:34 +0000351 u8 doNotSync; /* Boolean. While true, do not spill the cache */
352 u8 exclusiveMode; /* Boolean. True if locking_mode==EXCLUSIVE */
drhfdc40e92008-04-17 20:59:37 +0000353 u8 journalMode; /* On of the PAGER_JOURNALMODE_* values */
drh80e35f42007-03-30 14:06:34 +0000354 u8 changeCountDone; /* Set after incrementing the change-counter */
drh33f4e022007-09-03 15:19:34 +0000355 u32 vfsFlags; /* Flags for sqlite3_vfs.xOpen() */
drhe49f9822006-09-15 12:29:16 +0000356 int errCode; /* One of several kinds of errors */
drhfcd35c72005-05-21 02:48:08 +0000357 int dbSize; /* Number of pages in the file */
358 int origDbSize; /* dbSize before the current change */
359 int stmtSize; /* Size of database (in pages) at stmt_begin() */
360 int nRec; /* Number of pages written to the journal */
361 u32 cksumInit; /* Quasi-random value added to every checksum */
362 int stmtNRec; /* Number of records in stmt subjournal */
363 int nExtra; /* Add this many bytes to each in-memory page */
364 int pageSize; /* Number of bytes in a page */
365 int nPage; /* Total number of in-memory pages */
drhfcd35c72005-05-21 02:48:08 +0000366 int nRef; /* Number of in-memory pages with PgHdr.nRef>0 */
367 int mxPage; /* Maximum number of pages to hold in cache */
drhf8e632b2007-05-08 14:51:36 +0000368 Pgno mxPgno; /* Maximum allowed size of the database */
drhf5e7bb52008-02-18 14:47:33 +0000369 Bitvec *pInJournal; /* One bit for each page in the database file */
370 Bitvec *pInStmt; /* One bit for each page in the database */
drhfcd35c72005-05-21 02:48:08 +0000371 char *zFilename; /* Name of the database file */
372 char *zJournal; /* Name of the journal file */
373 char *zDirectory; /* Directory hold database and journal files */
drh334b2992007-09-06 23:28:23 +0000374 char *zStmtJrnl; /* Name of the statement journal file */
danielk197762079062007-08-15 17:08:46 +0000375 sqlite3_file *fd, *jfd; /* File descriptors for database and journal */
376 sqlite3_file *stfd; /* File descriptor for the statement subjournal*/
drh726de592004-06-10 23:35:50 +0000377 BusyHandler *pBusyHandler; /* Pointer to sqlite.busyHandler */
danielk19779f61c2f2007-08-27 17:27:49 +0000378 PagerLruList lru; /* LRU list of free pages */
drhd9b02572001-04-15 00:37:09 +0000379 PgHdr *pAll; /* List of all pages */
drhac69b052004-05-12 13:30:07 +0000380 PgHdr *pStmt; /* List of pages in the statement subjournal */
drh605ad8f2006-05-03 23:34:05 +0000381 PgHdr *pDirty; /* List of all dirty pages */
drheb206252004-10-01 02:00:31 +0000382 i64 journalOff; /* Current byte offset in the journal file */
383 i64 journalHdr; /* Byte offset to previous journal header */
384 i64 stmtHdrOff; /* First journal header written this statement */
385 i64 stmtCksum; /* cksumInit when statement was started */
drh6d156e42005-05-20 20:11:20 +0000386 i64 stmtJSize; /* Size of journal at stmt_begin() */
danielk197776572402004-06-25 02:38:54 +0000387 int sectorSize; /* Assumed sector size during rollback */
drhfcd35c72005-05-21 02:48:08 +0000388#ifdef SQLITE_TEST
drh7c4ac0c2007-04-05 11:25:58 +0000389 int nHit, nMiss; /* Cache hits and missing */
390 int nRead, nWrite; /* Database pages read/written */
drhfcd35c72005-05-21 02:48:08 +0000391#endif
danielk19773b8a05f2007-03-19 17:44:26 +0000392 void (*xDestructor)(DbPage*,int); /* Call this routine when freeing pages */
393 void (*xReiniter)(DbPage*,int); /* Call this routine when reloading pages */
drh7c4ac0c2007-04-05 11:25:58 +0000394#ifdef SQLITE_HAS_CODEC
drhc001c582006-03-06 18:23:16 +0000395 void *(*xCodec)(void*,void*,Pgno,int); /* Routine for en/decoding data */
drh6d156e42005-05-20 20:11:20 +0000396 void *pCodecArg; /* First argument to xCodec() */
drh7c4ac0c2007-04-05 11:25:58 +0000397#endif
drh8ca0c722006-05-07 17:49:38 +0000398 int nHash; /* Size of the pager hash table */
399 PgHdr **aHash; /* Hash table to map page number to PgHdr */
drh6f7adc82006-01-11 21:41:20 +0000400#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
drh86f8c192007-08-22 00:39:19 +0000401 Pager *pNext; /* Doubly linked list of pagers on which */
402 Pager *pPrev; /* sqlite3_release_memory() will work */
403 int iInUseMM; /* Non-zero if unavailable to MM */
404 int iInUseDB; /* Non-zero if in sqlite3_release_memory() */
danielk197713f72992005-12-18 08:51:22 +0000405#endif
danielk19778186df82007-03-06 13:45:59 +0000406 char *pTmpSpace; /* Pager.pageSize bytes of space for tmp use */
drh86a88112007-04-16 15:02:19 +0000407 char dbFileVers[16]; /* Changes whenever database file changes */
drhd9b02572001-04-15 00:37:09 +0000408};
409
410/*
drh538f5702007-04-13 02:14:30 +0000411** The following global variables hold counters used for
412** testing purposes only. These variables do not exist in
413** a non-testing build. These variables are not thread-safe.
drhfcd35c72005-05-21 02:48:08 +0000414*/
415#ifdef SQLITE_TEST
drh538f5702007-04-13 02:14:30 +0000416int sqlite3_pager_readdb_count = 0; /* Number of full pages read from DB */
417int sqlite3_pager_writedb_count = 0; /* Number of full pages written to DB */
418int sqlite3_pager_writej_count = 0; /* Number of pages written to journal */
419int sqlite3_pager_pgfree_count = 0; /* Number of cache pages freed */
420# define PAGER_INCR(v) v++
drhfcd35c72005-05-21 02:48:08 +0000421#else
drh538f5702007-04-13 02:14:30 +0000422# define PAGER_INCR(v)
drhfcd35c72005-05-21 02:48:08 +0000423#endif
424
drh86f8c192007-08-22 00:39:19 +0000425/*
426** The following variable points to the head of a double-linked list
427** of all pagers that are eligible for page stealing by the
428** sqlite3_release_memory() interface. Access to this list is
429** protected by the SQLITE_MUTEX_STATIC_MEM2 mutex.
430*/
431#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
432static Pager *sqlite3PagerList = 0;
danielk19779f61c2f2007-08-27 17:27:49 +0000433static PagerLruList sqlite3LruPageList = {0, 0, 0};
drh86f8c192007-08-22 00:39:19 +0000434#endif
drh538f5702007-04-13 02:14:30 +0000435
436
drhfcd35c72005-05-21 02:48:08 +0000437/*
drh5e00f6c2001-09-13 13:46:56 +0000438** Journal files begin with the following magic string. The data
439** was obtained from /dev/random. It is used only as a sanity check.
drh94f33312002-08-12 12:29:56 +0000440**
drhae2b40c2004-06-09 19:03:54 +0000441** Since version 2.8.0, the journal format contains additional sanity
442** checking information. If the power fails while the journal is begin
443** written, semi-random garbage data might appear in the journal
444** file after power is restored. If an attempt is then made
drh968af522003-02-11 14:55:40 +0000445** to roll the journal back, the database could be corrupted. The additional
446** sanity checking data is an attempt to discover the garbage in the
447** journal and ignore it.
448**
drhae2b40c2004-06-09 19:03:54 +0000449** The sanity checking information for the new journal format consists
drh968af522003-02-11 14:55:40 +0000450** of a 32-bit checksum on each page of data. The checksum covers both
drh90f5ecb2004-07-22 01:19:35 +0000451** the page number and the pPager->pageSize bytes of data for the page.
drh968af522003-02-11 14:55:40 +0000452** This cksum is initialized to a 32-bit random value that appears in the
453** journal file right after the header. The random initializer is important,
454** because garbage data that appears at the end of a journal is likely
455** data that was once in other files that have now been deleted. If the
456** garbage data came from an obsolete journal file, the checksums might
457** be correct. But by initializing the checksum to random value which
458** is different for every journal, we minimize that risk.
drhd9b02572001-04-15 00:37:09 +0000459*/
drhae2b40c2004-06-09 19:03:54 +0000460static const unsigned char aJournalMagic[] = {
461 0xd9, 0xd5, 0x05, 0xf9, 0x20, 0xa1, 0x63, 0xd7,
drhed7c8552001-04-11 14:29:21 +0000462};
463
464/*
drh726de592004-06-10 23:35:50 +0000465** The size of the header and of each page in the journal is determined
466** by the following macros.
drh968af522003-02-11 14:55:40 +0000467*/
drhae2b40c2004-06-09 19:03:54 +0000468#define JOURNAL_PG_SZ(pPager) ((pPager->pageSize) + 8)
drh968af522003-02-11 14:55:40 +0000469
danielk197776572402004-06-25 02:38:54 +0000470/*
471** The journal header size for this pager. In the future, this could be
472** set to some value read from the disk controller. The important
473** characteristic is that it is the same size as a disk sector.
474*/
475#define JOURNAL_HDR_SZ(pPager) (pPager->sectorSize)
476
drhb7f91642004-10-31 02:22:47 +0000477/*
478** The macro MEMDB is true if we are dealing with an in-memory database.
479** We do this as a macro so that if the SQLITE_OMIT_MEMORYDB macro is set,
480** the value of MEMDB will be a constant and the compiler will optimize
481** out code that would never execute.
482*/
483#ifdef SQLITE_OMIT_MEMORYDB
484# define MEMDB 0
485#else
486# define MEMDB pPager->memDb
487#endif
488
489/*
danielk197776572402004-06-25 02:38:54 +0000490** Page number PAGER_MJ_PGNO is never used in an SQLite database (it is
491** reserved for working around a windows/posix incompatibility). It is
492** used in the journal to signify that the remainder of the journal file
493** is devoted to storing a master journal name - there are no more pages to
494** roll back. See comments for function writeMasterJournal() for details.
495*/
danielk1977599fcba2004-11-08 07:13:13 +0000496/* #define PAGER_MJ_PGNO(x) (PENDING_BYTE/((x)->pageSize)) */
497#define PAGER_MJ_PGNO(x) ((PENDING_BYTE/((x)->pageSize))+1)
danielk197713adf8a2004-06-03 16:08:41 +0000498
drh968af522003-02-11 14:55:40 +0000499/*
danielk197726836652005-01-17 01:33:13 +0000500** The maximum legal page number is (2^31 - 1).
501*/
502#define PAGER_MAX_PGNO 2147483647
503
504/*
drh86f8c192007-08-22 00:39:19 +0000505** The pagerEnter() and pagerLeave() routines acquire and release
506** a mutex on each pager. The mutex is recursive.
507**
508** This is a special-purpose mutex. It only provides mutual exclusion
509** between the Btree and the Memory Management sqlite3_release_memory()
510** function. It does not prevent, for example, two Btrees from accessing
511** the same pager at the same time. Other general-purpose mutexes in
512** the btree layer handle that chore.
513*/
514#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
515 static void pagerEnter(Pager *p){
516 p->iInUseDB++;
517 if( p->iInUseMM && p->iInUseDB==1 ){
518 sqlite3_mutex *mutex;
519 mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MEM2);
520 p->iInUseDB = 0;
521 sqlite3_mutex_enter(mutex);
522 p->iInUseDB = 1;
523 sqlite3_mutex_leave(mutex);
524 }
525 assert( p->iInUseMM==0 );
526 }
527 static void pagerLeave(Pager *p){
528 p->iInUseDB--;
529 assert( p->iInUseDB>=0 );
530 }
531#else
532# define pagerEnter(X)
533# define pagerLeave(X)
534#endif
535
536/*
danielk197784f786f2007-08-28 08:00:17 +0000537** Add page pPg to the end of the linked list managed by structure
538** pList (pPg becomes the last entry in the list - the most recently
539** used). Argument pLink should point to either pPg->free or pPg->gfree,
540** depending on whether pPg is being added to the pager-specific or
541** global LRU list.
542*/
danielk19779f61c2f2007-08-27 17:27:49 +0000543static void listAdd(PagerLruList *pList, PagerLruLink *pLink, PgHdr *pPg){
544 pLink->pNext = 0;
545 pLink->pPrev = pList->pLast;
546
danielk197784f786f2007-08-28 08:00:17 +0000547#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
548 assert(pLink==&pPg->free || pLink==&pPg->gfree);
549 assert(pLink==&pPg->gfree || pList!=&sqlite3LruPageList);
550#endif
551
danielk19779f61c2f2007-08-27 17:27:49 +0000552 if( pList->pLast ){
553 int iOff = (char *)pLink - (char *)pPg;
554 PagerLruLink *pLastLink = (PagerLruLink *)(&((u8 *)pList->pLast)[iOff]);
555 pLastLink->pNext = pPg;
556 }else{
557 assert(!pList->pFirst);
558 pList->pFirst = pPg;
559 }
560
561 pList->pLast = pPg;
562 if( !pList->pFirstSynced && pPg->needSync==0 ){
563 pList->pFirstSynced = pPg;
564 }
565}
566
danielk197784f786f2007-08-28 08:00:17 +0000567/*
568** Remove pPg from the list managed by the structure pointed to by pList.
569**
570** Argument pLink should point to either pPg->free or pPg->gfree, depending
571** on whether pPg is being added to the pager-specific or global LRU list.
572*/
danielk19779f61c2f2007-08-27 17:27:49 +0000573static void listRemove(PagerLruList *pList, PagerLruLink *pLink, PgHdr *pPg){
574 int iOff = (char *)pLink - (char *)pPg;
575
danielk197784f786f2007-08-28 08:00:17 +0000576#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
577 assert(pLink==&pPg->free || pLink==&pPg->gfree);
578 assert(pLink==&pPg->gfree || pList!=&sqlite3LruPageList);
579#endif
580
danielk19779f61c2f2007-08-27 17:27:49 +0000581 if( pPg==pList->pFirst ){
582 pList->pFirst = pLink->pNext;
583 }
584 if( pPg==pList->pLast ){
585 pList->pLast = pLink->pPrev;
586 }
587 if( pLink->pPrev ){
588 PagerLruLink *pPrevLink = (PagerLruLink *)(&((u8 *)pLink->pPrev)[iOff]);
589 pPrevLink->pNext = pLink->pNext;
590 }
591 if( pLink->pNext ){
592 PagerLruLink *pNextLink = (PagerLruLink *)(&((u8 *)pLink->pNext)[iOff]);
593 pNextLink->pPrev = pLink->pPrev;
594 }
595 if( pPg==pList->pFirstSynced ){
596 PgHdr *p = pLink->pNext;
597 while( p && p->needSync ){
598 PagerLruLink *pL = (PagerLruLink *)(&((u8 *)p)[iOff]);
599 p = pL->pNext;
600 }
601 pList->pFirstSynced = p;
602 }
603
604 pLink->pNext = pLink->pPrev = 0;
605}
606
607/*
danielk197784f786f2007-08-28 08:00:17 +0000608** Add page pPg to the list of free pages for the pager. If
609** memory-management is enabled, also add the page to the global
610** list of free pages.
danielk19779f61c2f2007-08-27 17:27:49 +0000611*/
612static void lruListAdd(PgHdr *pPg){
613 listAdd(&pPg->pPager->lru, &pPg->free, pPg);
614#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
615 if( !pPg->pPager->memDb ){
616 sqlite3_mutex_enter(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
617 listAdd(&sqlite3LruPageList, &pPg->gfree, pPg);
618 sqlite3_mutex_leave(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
619 }
620#endif
621}
622
623/*
danielk197784f786f2007-08-28 08:00:17 +0000624** Remove page pPg from the list of free pages for the associated pager.
625** If memory-management is enabled, also remove pPg from the global list
626** of free pages.
danielk19779f61c2f2007-08-27 17:27:49 +0000627*/
628static void lruListRemove(PgHdr *pPg){
629 listRemove(&pPg->pPager->lru, &pPg->free, pPg);
630#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
631 if( !pPg->pPager->memDb ){
632 sqlite3_mutex_enter(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
633 listRemove(&sqlite3LruPageList, &pPg->gfree, pPg);
634 sqlite3_mutex_leave(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
635 }
636#endif
637}
638
639/*
danielk197784f786f2007-08-28 08:00:17 +0000640** This function is called just after the needSync flag has been cleared
641** from all pages managed by pPager (usually because the journal file
642** has just been synced). It updates the pPager->lru.pFirstSynced variable
643** and, if memory-management is enabled, the sqlite3LruPageList.pFirstSynced
644** variable also.
danielk19779f61c2f2007-08-27 17:27:49 +0000645*/
646static void lruListSetFirstSynced(Pager *pPager){
647 pPager->lru.pFirstSynced = pPager->lru.pFirst;
648#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
649 if( !pPager->memDb ){
650 PgHdr *p;
651 sqlite3_mutex_enter(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
652 for(p=sqlite3LruPageList.pFirst; p && p->needSync; p=p->gfree.pNext);
653 assert(p==pPager->lru.pFirstSynced || p==sqlite3LruPageList.pFirstSynced);
654 sqlite3LruPageList.pFirstSynced = p;
655 sqlite3_mutex_leave(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
656 }
657#endif
658}
659
danielk1977f35843b2007-04-07 15:03:17 +0000660/*
661** Return true if page *pPg has already been written to the statement
662** journal (or statement snapshot has been created, if *pPg is part
663** of an in-memory database).
664*/
665static int pageInStatement(PgHdr *pPg){
666 Pager *pPager = pPg->pPager;
667 if( MEMDB ){
668 return PGHDR_TO_HIST(pPg, pPager)->inStmt;
669 }else{
drhf5e7bb52008-02-18 14:47:33 +0000670 return sqlite3BitvecTest(pPager->pInStmt, pPg->pgno);
danielk1977f35843b2007-04-07 15:03:17 +0000671 }
672}
drh8ca0c722006-05-07 17:49:38 +0000673
674/*
675** Change the size of the pager hash table to N. N must be a power
676** of two.
677*/
678static void pager_resize_hash_table(Pager *pPager, int N){
679 PgHdr **aHash, *pPg;
680 assert( N>0 && (N&(N-1))==0 );
drheee4c8c2008-02-18 22:24:57 +0000681#ifdef SQLITE_MALLOC_SOFT_LIMIT
682 if( N*sizeof(aHash[0])>SQLITE_MALLOC_SOFT_LIMIT ){
683 N = SQLITE_MALLOC_SOFT_LIMIT/sizeof(aHash[0]);
684 }
685 if( N==pPager->nHash ) return;
686#endif
drhed138fb2007-08-22 22:04:37 +0000687 pagerLeave(pPager);
drh643167f2008-01-22 21:30:53 +0000688 sqlite3FaultBenign(SQLITE_FAULTINJECTOR_MALLOC, pPager->aHash!=0);
drh17435752007-08-16 04:30:38 +0000689 aHash = sqlite3MallocZero( sizeof(aHash[0])*N );
drh643167f2008-01-22 21:30:53 +0000690 sqlite3FaultBenign(SQLITE_FAULTINJECTOR_MALLOC, 0);
drhed138fb2007-08-22 22:04:37 +0000691 pagerEnter(pPager);
drh8ca0c722006-05-07 17:49:38 +0000692 if( aHash==0 ){
693 /* Failure to rehash is not an error. It is only a performance hit. */
694 return;
695 }
drh17435752007-08-16 04:30:38 +0000696 sqlite3_free(pPager->aHash);
drh8ca0c722006-05-07 17:49:38 +0000697 pPager->nHash = N;
698 pPager->aHash = aHash;
699 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
drh3765df42006-06-28 18:18:09 +0000700 int h;
701 if( pPg->pgno==0 ){
702 assert( pPg->pNextHash==0 && pPg->pPrevHash==0 );
703 continue;
704 }
705 h = pPg->pgno & (N-1);
drh8ca0c722006-05-07 17:49:38 +0000706 pPg->pNextHash = aHash[h];
707 if( aHash[h] ){
708 aHash[h]->pPrevHash = pPg;
709 }
710 aHash[h] = pPg;
711 pPg->pPrevHash = 0;
712 }
713}
714
drhdd793422001-06-28 01:54:48 +0000715/*
drh34e79ce2004-02-08 06:05:46 +0000716** Read a 32-bit integer from the given file descriptor. Store the integer
717** that is read in *pRes. Return SQLITE_OK if everything worked, or an
718** error code is something goes wrong.
drh726de592004-06-10 23:35:50 +0000719**
720** All values are stored on disk as big-endian.
drh94f33312002-08-12 12:29:56 +0000721*/
danielk197762079062007-08-15 17:08:46 +0000722static int read32bits(sqlite3_file *fd, i64 offset, u32 *pRes){
drh3b59a5c2006-01-15 20:28:28 +0000723 unsigned char ac[4];
danielk197762079062007-08-15 17:08:46 +0000724 int rc = sqlite3OsRead(fd, ac, sizeof(ac), offset);
drhae2b40c2004-06-09 19:03:54 +0000725 if( rc==SQLITE_OK ){
drha3152892007-05-05 11:48:52 +0000726 *pRes = sqlite3Get4byte(ac);
drh94f33312002-08-12 12:29:56 +0000727 }
drh94f33312002-08-12 12:29:56 +0000728 return rc;
729}
730
731/*
drh97b57482006-01-10 20:32:32 +0000732** Write a 32-bit integer into a string buffer in big-endian byte order.
733*/
drha3152892007-05-05 11:48:52 +0000734#define put32bits(A,B) sqlite3Put4byte((u8*)A,B)
drh97b57482006-01-10 20:32:32 +0000735
736/*
drh34e79ce2004-02-08 06:05:46 +0000737** Write a 32-bit integer into the given file descriptor. Return SQLITE_OK
738** on success or an error code is something goes wrong.
drh94f33312002-08-12 12:29:56 +0000739*/
danielk197762079062007-08-15 17:08:46 +0000740static int write32bits(sqlite3_file *fd, i64 offset, u32 val){
danielk1977bab45c62006-01-16 15:14:27 +0000741 char ac[4];
drh97b57482006-01-10 20:32:32 +0000742 put32bits(ac, val);
danielk197762079062007-08-15 17:08:46 +0000743 return sqlite3OsWrite(fd, ac, 4, offset);
drh94f33312002-08-12 12:29:56 +0000744}
745
drh2554f8b2003-01-22 01:26:44 +0000746/*
danielk19777a2b1ee2007-08-21 14:27:01 +0000747** If file pFd is open, call sqlite3OsUnlock() on it.
748*/
749static int osUnlock(sqlite3_file *pFd, int eLock){
750 if( !pFd->pMethods ){
751 return SQLITE_OK;
752 }
753 return sqlite3OsUnlock(pFd, eLock);
754}
755
756/*
danielk1977c7b60172007-08-22 11:22:03 +0000757** This function determines whether or not the atomic-write optimization
758** can be used with this pager. The optimization can be used if:
759**
760** (a) the value returned by OsDeviceCharacteristics() indicates that
761** a database page may be written atomically, and
762** (b) the value returned by OsSectorSize() is less than or equal
763** to the page size.
764**
765** If the optimization cannot be used, 0 is returned. If it can be used,
766** then the value returned is the size of the journal file when it
767** contains rollback data for exactly one page.
768*/
769#ifdef SQLITE_ENABLE_ATOMIC_WRITE
770static int jrnlBufferSize(Pager *pPager){
771 int dc; /* Device characteristics */
772 int nSector; /* Sector size */
773 int nPage; /* Page size */
774 sqlite3_file *fd = pPager->fd;
775
776 if( fd->pMethods ){
777 dc = sqlite3OsDeviceCharacteristics(fd);
778 nSector = sqlite3OsSectorSize(fd);
779 nPage = pPager->pageSize;
780 }
781
782 assert(SQLITE_IOCAP_ATOMIC512==(512>>8));
783 assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8));
784
danielk1977f8940ae2007-08-23 11:07:10 +0000785 if( !fd->pMethods || (dc&(SQLITE_IOCAP_ATOMIC|(nPage>>8))&&nSector<=nPage) ){
danielk1977c7b60172007-08-22 11:22:03 +0000786 return JOURNAL_HDR_SZ(pPager) + JOURNAL_PG_SZ(pPager);
787 }
788 return 0;
789}
790#endif
791
792/*
danielk1977aef0bf62005-12-30 16:28:01 +0000793** This function should be called when an error occurs within the pager
danielk1977a96a7102006-01-16 12:46:41 +0000794** code. The first argument is a pointer to the pager structure, the
795** second the error-code about to be returned by a pager API function.
796** The value returned is a copy of the second argument to this function.
797**
drh4f0ee682007-03-30 20:43:40 +0000798** If the second argument is SQLITE_IOERR, SQLITE_CORRUPT, or SQLITE_FULL
danielk1977ae72d982007-10-03 08:46:44 +0000799** the error becomes persistent. Until the persisten error is cleared,
800** subsequent API calls on this Pager will immediately return the same
801** error code.
802**
803** A persistent error indicates that the contents of the pager-cache
804** cannot be trusted. This state can be cleared by completely discarding
805** the contents of the pager-cache. If a transaction was active when
806** the persistent error occured, then the rollback journal may need
807** to be replayed.
danielk1977aef0bf62005-12-30 16:28:01 +0000808*/
danielk1977ae72d982007-10-03 08:46:44 +0000809static void pager_unlock(Pager *pPager);
danielk1977aef0bf62005-12-30 16:28:01 +0000810static int pager_error(Pager *pPager, int rc){
drh4ac285a2006-09-15 07:28:50 +0000811 int rc2 = rc & 0xff;
drh34f56212007-08-10 23:56:35 +0000812 assert(
813 pPager->errCode==SQLITE_FULL ||
814 pPager->errCode==SQLITE_OK ||
815 (pPager->errCode & 0xff)==SQLITE_IOERR
816 );
danielk1977979f38e2007-03-27 16:19:51 +0000817 if(
drh4ac285a2006-09-15 07:28:50 +0000818 rc2==SQLITE_FULL ||
819 rc2==SQLITE_IOERR ||
drh4f0ee682007-03-30 20:43:40 +0000820 rc2==SQLITE_CORRUPT
danielk1977efaaf572006-01-16 11:29:19 +0000821 ){
822 pPager->errCode = rc;
danielk1977ae72d982007-10-03 08:46:44 +0000823 if( pPager->state==PAGER_UNLOCK && pPager->nRef==0 ){
824 /* If the pager is already unlocked, call pager_unlock() now to
825 ** clear the error state and ensure that the pager-cache is
826 ** completely empty.
827 */
828 pager_unlock(pPager);
829 }
danielk1977aef0bf62005-12-30 16:28:01 +0000830 }
831 return rc;
832}
833
drh477731b2007-06-16 03:06:27 +0000834/*
835** If SQLITE_CHECK_PAGES is defined then we do some sanity checking
836** on the cache using a hash function. This is used for testing
837** and debugging only.
838*/
danielk19773c407372005-02-15 02:54:14 +0000839#ifdef SQLITE_CHECK_PAGES
840/*
841** Return a 32-bit hash of the page data for pPage.
842*/
drh477731b2007-06-16 03:06:27 +0000843static u32 pager_datahash(int nByte, unsigned char *pData){
danielk19773c407372005-02-15 02:54:14 +0000844 u32 hash = 0;
845 int i;
drh477731b2007-06-16 03:06:27 +0000846 for(i=0; i<nByte; i++){
847 hash = (hash*1039) + pData[i];
danielk19773c407372005-02-15 02:54:14 +0000848 }
849 return hash;
850}
drh477731b2007-06-16 03:06:27 +0000851static u32 pager_pagehash(PgHdr *pPage){
852 return pager_datahash(pPage->pPager->pageSize,
853 (unsigned char *)PGHDR_TO_DATA(pPage));
854}
danielk19773c407372005-02-15 02:54:14 +0000855
856/*
857** The CHECK_PAGE macro takes a PgHdr* as an argument. If SQLITE_CHECK_PAGES
858** is defined, and NDEBUG is not defined, an assert() statement checks
859** that the page is either dirty or still matches the calculated page-hash.
860*/
861#define CHECK_PAGE(x) checkPage(x)
862static void checkPage(PgHdr *pPg){
863 Pager *pPager = pPg->pPager;
danielk1977efaaf572006-01-16 11:29:19 +0000864 assert( !pPg->pageHash || pPager->errCode || MEMDB || pPg->dirty ||
danielk19773c407372005-02-15 02:54:14 +0000865 pPg->pageHash==pager_pagehash(pPg) );
866}
867
868#else
drh8ffa8172007-06-18 17:25:17 +0000869#define pager_datahash(X,Y) 0
drh477731b2007-06-16 03:06:27 +0000870#define pager_pagehash(X) 0
danielk19773c407372005-02-15 02:54:14 +0000871#define CHECK_PAGE(x)
872#endif
873
drhed7c8552001-04-11 14:29:21 +0000874/*
danielk197776572402004-06-25 02:38:54 +0000875** When this is called the journal file for pager pPager must be open.
876** The master journal file name is read from the end of the file and
danielk197765839c62007-08-30 08:08:17 +0000877** written into memory supplied by the caller.
danielk197776572402004-06-25 02:38:54 +0000878**
danielk197765839c62007-08-30 08:08:17 +0000879** zMaster must point to a buffer of at least nMaster bytes allocated by
880** the caller. This should be sqlite3_vfs.mxPathname+1 (to ensure there is
881** enough space to write the master journal name). If the master journal
882** name in the journal is longer than nMaster bytes (including a
883** nul-terminator), then this is handled as if no master journal name
884** were present in the journal.
885**
886** If no master journal file name is present zMaster[0] is set to 0 and
danielk197776572402004-06-25 02:38:54 +0000887** SQLITE_OK returned.
888*/
danielk197765839c62007-08-30 08:08:17 +0000889static int readMasterJournal(sqlite3_file *pJrnl, char *zMaster, int nMaster){
danielk197776572402004-06-25 02:38:54 +0000890 int rc;
891 u32 len;
drheb206252004-10-01 02:00:31 +0000892 i64 szJ;
danielk1977c3e8f5e2004-06-28 01:16:46 +0000893 u32 cksum;
danielk1977cafadba2004-06-25 11:11:54 +0000894 int i;
danielk197776572402004-06-25 02:38:54 +0000895 unsigned char aMagic[8]; /* A buffer to hold the magic header */
896
danielk197765839c62007-08-30 08:08:17 +0000897 zMaster[0] = '\0';
danielk197776572402004-06-25 02:38:54 +0000898
drh054889e2005-11-30 03:20:31 +0000899 rc = sqlite3OsFileSize(pJrnl, &szJ);
danielk1977cafadba2004-06-25 11:11:54 +0000900 if( rc!=SQLITE_OK || szJ<16 ) return rc;
danielk197776572402004-06-25 02:38:54 +0000901
danielk197762079062007-08-15 17:08:46 +0000902 rc = read32bits(pJrnl, szJ-16, &len);
danielk197776572402004-06-25 02:38:54 +0000903 if( rc!=SQLITE_OK ) return rc;
904
danielk197765839c62007-08-30 08:08:17 +0000905 if( len>=nMaster ){
906 return SQLITE_OK;
907 }
908
danielk197762079062007-08-15 17:08:46 +0000909 rc = read32bits(pJrnl, szJ-12, &cksum);
danielk1977cafadba2004-06-25 11:11:54 +0000910 if( rc!=SQLITE_OK ) return rc;
911
danielk197762079062007-08-15 17:08:46 +0000912 rc = sqlite3OsRead(pJrnl, aMagic, 8, szJ-8);
danielk197776572402004-06-25 02:38:54 +0000913 if( rc!=SQLITE_OK || memcmp(aMagic, aJournalMagic, 8) ) return rc;
914
danielk197765839c62007-08-30 08:08:17 +0000915 rc = sqlite3OsRead(pJrnl, zMaster, len, szJ-16-len);
danielk197776572402004-06-25 02:38:54 +0000916 if( rc!=SQLITE_OK ){
danielk197776572402004-06-25 02:38:54 +0000917 return rc;
918 }
danielk197765839c62007-08-30 08:08:17 +0000919 zMaster[len] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000920
921 /* See if the checksum matches the master journal name */
922 for(i=0; i<len; i++){
danielk197765839c62007-08-30 08:08:17 +0000923 cksum -= zMaster[i];
924 }
danielk19778191bff2004-06-28 04:52:30 +0000925 if( cksum ){
926 /* If the checksum doesn't add up, then one or more of the disk sectors
927 ** containing the master journal filename is corrupted. This means
928 ** definitely roll back, so just return SQLITE_OK and report a (nul)
929 ** master-journal filename.
930 */
danielk197765839c62007-08-30 08:08:17 +0000931 zMaster[0] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000932 }
danielk197776572402004-06-25 02:38:54 +0000933
934 return SQLITE_OK;
935}
936
937/*
938** Seek the journal file descriptor to the next sector boundary where a
939** journal header may be read or written. Pager.journalOff is updated with
940** the new seek offset.
941**
942** i.e for a sector size of 512:
943**
944** Input Offset Output Offset
945** ---------------------------------------
946** 0 0
947** 512 512
948** 100 512
949** 2000 2048
950**
951*/
danielk197762079062007-08-15 17:08:46 +0000952static void seekJournalHdr(Pager *pPager){
drheb206252004-10-01 02:00:31 +0000953 i64 offset = 0;
954 i64 c = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000955 if( c ){
956 offset = ((c-1)/JOURNAL_HDR_SZ(pPager) + 1) * JOURNAL_HDR_SZ(pPager);
957 }
958 assert( offset%JOURNAL_HDR_SZ(pPager)==0 );
959 assert( offset>=c );
960 assert( (offset-c)<JOURNAL_HDR_SZ(pPager) );
961 pPager->journalOff = offset;
danielk197776572402004-06-25 02:38:54 +0000962}
963
964/*
drhf3a87622008-04-17 14:16:42 +0000965** Write zeros over the header of the journal file. This has the
966** effect of invalidating the journal file and committing the
967** transaction.
968*/
969static int zeroJournalHdr(Pager *pPager){
970 int rc;
971 static const char zeroHdr[28];
972
973 IOTRACE(("JZEROHDR %p\n", pPager))
974 rc = sqlite3OsWrite(pPager->jfd, zeroHdr, sizeof(zeroHdr), 0);
975 return rc;
976}
977
978/*
danielk197776572402004-06-25 02:38:54 +0000979** The journal file must be open when this routine is called. A journal
980** header (JOURNAL_HDR_SZ bytes) is written into the journal file at the
981** current location.
982**
983** The format for the journal header is as follows:
984** - 8 bytes: Magic identifying journal format.
985** - 4 bytes: Number of records in journal, or -1 no-sync mode is on.
986** - 4 bytes: Random number used for page hash.
987** - 4 bytes: Initial database page count.
988** - 4 bytes: Sector size used by the process that wrote this journal.
danielk197767c007b2008-03-20 04:45:49 +0000989** - 4 bytes: Database page size.
danielk197776572402004-06-25 02:38:54 +0000990**
danielk197767c007b2008-03-20 04:45:49 +0000991** Followed by (JOURNAL_HDR_SZ - 28) bytes of unused space.
danielk197776572402004-06-25 02:38:54 +0000992*/
993static int writeJournalHdr(Pager *pPager){
danielk197767c007b2008-03-20 04:45:49 +0000994 char zHeader[sizeof(aJournalMagic)+20];
danielk19774099f6e2007-03-19 11:25:20 +0000995 int rc;
danielk197776572402004-06-25 02:38:54 +0000996
danielk19774099f6e2007-03-19 11:25:20 +0000997 if( pPager->stmtHdrOff==0 ){
998 pPager->stmtHdrOff = pPager->journalOff;
999 }
1000
danielk197762079062007-08-15 17:08:46 +00001001 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +00001002 pPager->journalHdr = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +00001003
drh97b57482006-01-10 20:32:32 +00001004 memcpy(zHeader, aJournalMagic, sizeof(aJournalMagic));
danielk19774cd2cd52007-08-23 14:48:23 +00001005
1006 /*
1007 ** Write the nRec Field - the number of page records that follow this
1008 ** journal header. Normally, zero is written to this value at this time.
1009 ** After the records are added to the journal (and the journal synced,
1010 ** if in full-sync mode), the zero is overwritten with the true number
1011 ** of records (see syncJournal()).
1012 **
1013 ** A faster alternative is to write 0xFFFFFFFF to the nRec field. When
1014 ** reading the journal this value tells SQLite to assume that the
1015 ** rest of the journal file contains valid page records. This assumption
1016 ** is dangerous, as if a failure occured whilst writing to the journal
1017 ** file it may contain some garbage data. There are two scenarios
1018 ** where this risk can be ignored:
1019 **
1020 ** * When the pager is in no-sync mode. Corruption can follow a
1021 ** power failure in this case anyway.
1022 **
1023 ** * When the SQLITE_IOCAP_SAFE_APPEND flag is set. This guarantees
1024 ** that garbage data is never appended to the journal file.
1025 */
1026 assert(pPager->fd->pMethods||pPager->noSync);
1027 if( (pPager->noSync)
1028 || (sqlite3OsDeviceCharacteristics(pPager->fd)&SQLITE_IOCAP_SAFE_APPEND)
1029 ){
1030 put32bits(&zHeader[sizeof(aJournalMagic)], 0xffffffff);
1031 }else{
1032 put32bits(&zHeader[sizeof(aJournalMagic)], 0);
1033 }
1034
drh97b57482006-01-10 20:32:32 +00001035 /* The random check-hash initialiser */
drh2fa18682008-03-19 14:15:34 +00001036 sqlite3_randomness(sizeof(pPager->cksumInit), &pPager->cksumInit);
drh97b57482006-01-10 20:32:32 +00001037 put32bits(&zHeader[sizeof(aJournalMagic)+4], pPager->cksumInit);
1038 /* The initial database size */
1039 put32bits(&zHeader[sizeof(aJournalMagic)+8], pPager->dbSize);
1040 /* The assumed sector size for this process */
1041 put32bits(&zHeader[sizeof(aJournalMagic)+12], pPager->sectorSize);
danielk197767c007b2008-03-20 04:45:49 +00001042 if( pPager->journalHdr==0 ){
1043 /* The page size */
1044 put32bits(&zHeader[sizeof(aJournalMagic)+16], pPager->pageSize);
1045 }
drhb0603412007-02-28 04:47:26 +00001046 IOTRACE(("JHDR %p %lld %d\n", pPager, pPager->journalHdr, sizeof(zHeader)))
danielk197762079062007-08-15 17:08:46 +00001047 rc = sqlite3OsWrite(pPager->jfd, zHeader, sizeof(zHeader),pPager->journalOff);
1048 pPager->journalOff += JOURNAL_HDR_SZ(pPager);
danielk197776572402004-06-25 02:38:54 +00001049
1050 /* The journal header has been written successfully. Seek the journal
1051 ** file descriptor to the end of the journal header sector.
1052 */
1053 if( rc==SQLITE_OK ){
drhb0603412007-02-28 04:47:26 +00001054 IOTRACE(("JTAIL %p %lld\n", pPager, pPager->journalOff-1))
danielk197762079062007-08-15 17:08:46 +00001055 rc = sqlite3OsWrite(pPager->jfd, "\000", 1, pPager->journalOff-1);
danielk197776572402004-06-25 02:38:54 +00001056 }
1057 return rc;
1058}
1059
1060/*
1061** The journal file must be open when this is called. A journal header file
1062** (JOURNAL_HDR_SZ bytes) is read from the current location in the journal
1063** file. See comments above function writeJournalHdr() for a description of
1064** the journal header format.
1065**
1066** If the header is read successfully, *nRec is set to the number of
1067** page records following this header and *dbSize is set to the size of the
1068** database before the transaction began, in pages. Also, pPager->cksumInit
1069** is set to the value read from the journal header. SQLITE_OK is returned
1070** in this case.
1071**
1072** If the journal header file appears to be corrupted, SQLITE_DONE is
1073** returned and *nRec and *dbSize are not set. If JOURNAL_HDR_SZ bytes
1074** cannot be read from the journal file an error code is returned.
1075*/
1076static int readJournalHdr(
1077 Pager *pPager,
drheb206252004-10-01 02:00:31 +00001078 i64 journalSize,
danielk197776572402004-06-25 02:38:54 +00001079 u32 *pNRec,
1080 u32 *pDbSize
1081){
1082 int rc;
1083 unsigned char aMagic[8]; /* A buffer to hold the magic header */
danielk197762079062007-08-15 17:08:46 +00001084 i64 jrnlOff;
danielk197767c007b2008-03-20 04:45:49 +00001085 int iPageSize;
danielk197776572402004-06-25 02:38:54 +00001086
danielk197762079062007-08-15 17:08:46 +00001087 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +00001088 if( pPager->journalOff+JOURNAL_HDR_SZ(pPager) > journalSize ){
1089 return SQLITE_DONE;
1090 }
danielk197762079062007-08-15 17:08:46 +00001091 jrnlOff = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +00001092
danielk197762079062007-08-15 17:08:46 +00001093 rc = sqlite3OsRead(pPager->jfd, aMagic, sizeof(aMagic), jrnlOff);
danielk197776572402004-06-25 02:38:54 +00001094 if( rc ) return rc;
danielk197762079062007-08-15 17:08:46 +00001095 jrnlOff += sizeof(aMagic);
danielk197776572402004-06-25 02:38:54 +00001096
1097 if( memcmp(aMagic, aJournalMagic, sizeof(aMagic))!=0 ){
1098 return SQLITE_DONE;
1099 }
1100
danielk197762079062007-08-15 17:08:46 +00001101 rc = read32bits(pPager->jfd, jrnlOff, pNRec);
danielk197776572402004-06-25 02:38:54 +00001102 if( rc ) return rc;
1103
danielk197762079062007-08-15 17:08:46 +00001104 rc = read32bits(pPager->jfd, jrnlOff+4, &pPager->cksumInit);
danielk197776572402004-06-25 02:38:54 +00001105 if( rc ) return rc;
1106
danielk197762079062007-08-15 17:08:46 +00001107 rc = read32bits(pPager->jfd, jrnlOff+8, pDbSize);
danielk197776572402004-06-25 02:38:54 +00001108 if( rc ) return rc;
1109
danielk197767c007b2008-03-20 04:45:49 +00001110 rc = read32bits(pPager->jfd, jrnlOff+16, (u32 *)&iPageSize);
1111 if( rc==SQLITE_OK
1112 && iPageSize>=512
1113 && iPageSize<=SQLITE_MAX_PAGE_SIZE
1114 && ((iPageSize-1)&iPageSize)==0
1115 ){
1116 u16 pagesize = iPageSize;
1117 rc = sqlite3PagerSetPagesize(pPager, &pagesize);
1118 }
1119 if( rc ) return rc;
1120
danielk197776572402004-06-25 02:38:54 +00001121 /* Update the assumed sector-size to match the value used by
1122 ** the process that created this journal. If this journal was
1123 ** created by a process other than this one, then this routine
1124 ** is being called from within pager_playback(). The local value
1125 ** of Pager.sectorSize is restored at the end of that routine.
1126 */
danielk197762079062007-08-15 17:08:46 +00001127 rc = read32bits(pPager->jfd, jrnlOff+12, (u32 *)&pPager->sectorSize);
danielk197776572402004-06-25 02:38:54 +00001128 if( rc ) return rc;
1129
1130 pPager->journalOff += JOURNAL_HDR_SZ(pPager);
danielk197762079062007-08-15 17:08:46 +00001131 return SQLITE_OK;
danielk197776572402004-06-25 02:38:54 +00001132}
1133
1134
1135/*
1136** Write the supplied master journal name into the journal file for pager
danielk1977cafadba2004-06-25 11:11:54 +00001137** pPager at the current location. The master journal name must be the last
1138** thing written to a journal file. If the pager is in full-sync mode, the
1139** journal file descriptor is advanced to the next sector boundary before
1140** anything is written. The format is:
1141**
1142** + 4 bytes: PAGER_MJ_PGNO.
1143** + N bytes: length of master journal name.
1144** + 4 bytes: N
1145** + 4 bytes: Master journal name checksum.
1146** + 8 bytes: aJournalMagic[].
1147**
1148** The master journal page checksum is the sum of the bytes in the master
1149** journal name.
danielk1977aef0bf62005-12-30 16:28:01 +00001150**
1151** If zMaster is a NULL pointer (occurs for a single database transaction),
1152** this call is a no-op.
danielk197776572402004-06-25 02:38:54 +00001153*/
1154static int writeMasterJournal(Pager *pPager, const char *zMaster){
1155 int rc;
1156 int len;
danielk1977cafadba2004-06-25 11:11:54 +00001157 int i;
danielk197762079062007-08-15 17:08:46 +00001158 i64 jrnlOff;
drh97b57482006-01-10 20:32:32 +00001159 u32 cksum = 0;
1160 char zBuf[sizeof(aJournalMagic)+2*4];
danielk197776572402004-06-25 02:38:54 +00001161
1162 if( !zMaster || pPager->setMaster) return SQLITE_OK;
1163 pPager->setMaster = 1;
1164
1165 len = strlen(zMaster);
danielk1977cafadba2004-06-25 11:11:54 +00001166 for(i=0; i<len; i++){
1167 cksum += zMaster[i];
1168 }
danielk197776572402004-06-25 02:38:54 +00001169
1170 /* If in full-sync mode, advance to the next disk sector before writing
1171 ** the master journal name. This is in case the previous page written to
1172 ** the journal has already been synced.
1173 */
1174 if( pPager->fullSync ){
danielk197762079062007-08-15 17:08:46 +00001175 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +00001176 }
danielk197762079062007-08-15 17:08:46 +00001177 jrnlOff = pPager->journalOff;
danielk1977cafadba2004-06-25 11:11:54 +00001178 pPager->journalOff += (len+20);
danielk197776572402004-06-25 02:38:54 +00001179
danielk197762079062007-08-15 17:08:46 +00001180 rc = write32bits(pPager->jfd, jrnlOff, PAGER_MJ_PGNO(pPager));
danielk197776572402004-06-25 02:38:54 +00001181 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +00001182 jrnlOff += 4;
danielk197776572402004-06-25 02:38:54 +00001183
danielk197762079062007-08-15 17:08:46 +00001184 rc = sqlite3OsWrite(pPager->jfd, zMaster, len, jrnlOff);
danielk197776572402004-06-25 02:38:54 +00001185 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +00001186 jrnlOff += len;
danielk197776572402004-06-25 02:38:54 +00001187
drh97b57482006-01-10 20:32:32 +00001188 put32bits(zBuf, len);
1189 put32bits(&zBuf[4], cksum);
1190 memcpy(&zBuf[8], aJournalMagic, sizeof(aJournalMagic));
danielk197762079062007-08-15 17:08:46 +00001191 rc = sqlite3OsWrite(pPager->jfd, zBuf, 8+sizeof(aJournalMagic), jrnlOff);
drh2c8997b2005-08-27 16:36:48 +00001192 pPager->needSync = !pPager->noSync;
danielk197776572402004-06-25 02:38:54 +00001193 return rc;
1194}
1195
1196/*
drh03eb96a2002-11-10 23:32:56 +00001197** Add or remove a page from the list of all pages that are in the
drhac69b052004-05-12 13:30:07 +00001198** statement journal.
drh03eb96a2002-11-10 23:32:56 +00001199**
1200** The Pager keeps a separate list of pages that are currently in
danielk19773b8a05f2007-03-19 17:44:26 +00001201** the statement journal. This helps the sqlite3PagerStmtCommit()
drh03eb96a2002-11-10 23:32:56 +00001202** routine run MUCH faster for the common case where there are many
drhac69b052004-05-12 13:30:07 +00001203** pages in memory but only a few are in the statement journal.
drh03eb96a2002-11-10 23:32:56 +00001204*/
drh3aac2dd2004-04-26 14:10:20 +00001205static void page_add_to_stmt_list(PgHdr *pPg){
drh03eb96a2002-11-10 23:32:56 +00001206 Pager *pPager = pPg->pPager;
danielk1977f35843b2007-04-07 15:03:17 +00001207 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
1208 assert( MEMDB );
1209 if( !pHist->inStmt ){
1210 assert( pHist->pPrevStmt==0 && pHist->pNextStmt==0 );
1211 if( pPager->pStmt ){
1212 PGHDR_TO_HIST(pPager->pStmt, pPager)->pPrevStmt = pPg;
1213 }
1214 pHist->pNextStmt = pPager->pStmt;
1215 pPager->pStmt = pPg;
1216 pHist->inStmt = 1;
drh03eb96a2002-11-10 23:32:56 +00001217 }
drh03eb96a2002-11-10 23:32:56 +00001218}
1219
1220/*
drhed7c8552001-04-11 14:29:21 +00001221** Find a page in the hash table given its page number. Return
1222** a pointer to the page or NULL if not found.
1223*/
drhd9b02572001-04-15 00:37:09 +00001224static PgHdr *pager_lookup(Pager *pPager, Pgno pgno){
drh8ca0c722006-05-07 17:49:38 +00001225 PgHdr *p;
1226 if( pPager->aHash==0 ) return 0;
1227 p = pPager->aHash[pgno & (pPager->nHash-1)];
drhed7c8552001-04-11 14:29:21 +00001228 while( p && p->pgno!=pgno ){
1229 p = p->pNextHash;
1230 }
1231 return p;
1232}
1233
1234/*
danielk1977e180dd92007-04-05 17:15:52 +00001235** Clear the in-memory cache. This routine
drhed7c8552001-04-11 14:29:21 +00001236** sets the state of the pager back to what it was when it was first
1237** opened. Any outstanding pages are invalidated and subsequent attempts
1238** to access those pages will likely result in a coredump.
1239*/
drhd9b02572001-04-15 00:37:09 +00001240static void pager_reset(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +00001241 PgHdr *pPg, *pNext;
danielk1977efaaf572006-01-16 11:29:19 +00001242 if( pPager->errCode ) return;
drhd9b02572001-04-15 00:37:09 +00001243 for(pPg=pPager->pAll; pPg; pPg=pNext){
drh538f5702007-04-13 02:14:30 +00001244 IOTRACE(("PGFREE %p %d\n", pPager, pPg->pgno));
1245 PAGER_INCR(sqlite3_pager_pgfree_count);
drhd9b02572001-04-15 00:37:09 +00001246 pNext = pPg->pNextAll;
danielk19779f61c2f2007-08-27 17:27:49 +00001247 lruListRemove(pPg);
drh0d180202008-02-14 23:26:56 +00001248 sqlite3_free(pPg->pData);
drh17435752007-08-16 04:30:38 +00001249 sqlite3_free(pPg);
drhed7c8552001-04-11 14:29:21 +00001250 }
danielk19779f61c2f2007-08-27 17:27:49 +00001251 assert(pPager->lru.pFirst==0);
1252 assert(pPager->lru.pFirstSynced==0);
1253 assert(pPager->lru.pLast==0);
danielk1977b94bf852007-03-19 13:53:37 +00001254 pPager->pStmt = 0;
drhd9b02572001-04-15 00:37:09 +00001255 pPager->pAll = 0;
danielk1977ae72d982007-10-03 08:46:44 +00001256 pPager->pDirty = 0;
drh8ca0c722006-05-07 17:49:38 +00001257 pPager->nHash = 0;
drh17435752007-08-16 04:30:38 +00001258 sqlite3_free(pPager->aHash);
drhed7c8552001-04-11 14:29:21 +00001259 pPager->nPage = 0;
drh8ca0c722006-05-07 17:49:38 +00001260 pPager->aHash = 0;
drhed7c8552001-04-11 14:29:21 +00001261 pPager->nRef = 0;
danielk1977e277be02007-03-23 18:12:06 +00001262}
1263
1264/*
danielk1977ae72d982007-10-03 08:46:44 +00001265** Unlock the database file.
1266**
1267** If the pager is currently in error state, discard the contents of
1268** the cache and reset the Pager structure internal state. If there is
1269** an open journal-file, then the next time a shared-lock is obtained
1270** on the pager file (by this or any other process), it will be
1271** treated as a hot-journal and rolled back.
1272*/
1273static void pager_unlock(Pager *pPager){
1274 if( !pPager->exclusiveMode ){
1275 if( !MEMDB ){
drh1aa5af12008-03-07 19:51:14 +00001276 int rc = osUnlock(pPager->fd, NO_LOCK);
drh308aa322008-03-07 20:14:38 +00001277 if( rc ) pPager->errCode = rc;
danielk1977ae72d982007-10-03 08:46:44 +00001278 pPager->dbSize = -1;
1279 IOTRACE(("UNLOCK %p\n", pPager))
1280
1281 /* If Pager.errCode is set, the contents of the pager cache cannot be
1282 ** trusted. Now that the pager file is unlocked, the contents of the
1283 ** cache can be discarded and the error code safely cleared.
1284 */
1285 if( pPager->errCode ){
drh1aa5af12008-03-07 19:51:14 +00001286 if( rc==SQLITE_OK ) pPager->errCode = SQLITE_OK;
danielk1977ae72d982007-10-03 08:46:44 +00001287 pager_reset(pPager);
1288 if( pPager->stmtOpen ){
1289 sqlite3OsClose(pPager->stfd);
drhf5e7bb52008-02-18 14:47:33 +00001290 sqlite3BitvecDestroy(pPager->pInStmt);
1291 pPager->pInStmt = 0;
danielk1977ae72d982007-10-03 08:46:44 +00001292 }
1293 if( pPager->journalOpen ){
1294 sqlite3OsClose(pPager->jfd);
1295 pPager->journalOpen = 0;
drhf5e7bb52008-02-18 14:47:33 +00001296 sqlite3BitvecDestroy(pPager->pInJournal);
1297 pPager->pInJournal = 0;
danielk1977ae72d982007-10-03 08:46:44 +00001298 }
1299 pPager->stmtOpen = 0;
1300 pPager->stmtInUse = 0;
1301 pPager->journalOff = 0;
1302 pPager->journalStarted = 0;
1303 pPager->stmtAutoopen = 0;
1304 pPager->origDbSize = 0;
1305 }
1306 }
1307
1308 if( !MEMDB || pPager->errCode==SQLITE_OK ){
1309 pPager->state = PAGER_UNLOCK;
1310 pPager->changeCountDone = 0;
1311 }
1312 }
1313}
1314
1315/*
1316** Execute a rollback if a transaction is active and unlock the
1317** database file. If the pager has already entered the error state,
1318** do not attempt the rollback.
1319*/
1320static void pagerUnlockAndRollback(Pager *p){
drhfdc40e92008-04-17 20:59:37 +00001321 /* assert( p->state>=PAGER_RESERVED || p->journalOpen==0 ); */
danielk1977ae72d982007-10-03 08:46:44 +00001322 if( p->errCode==SQLITE_OK && p->state>=PAGER_RESERVED ){
1323 sqlite3PagerRollback(p);
1324 }
1325 pager_unlock(p);
drhfdc40e92008-04-17 20:59:37 +00001326#if 0
danielk1977ae72d982007-10-03 08:46:44 +00001327 assert( p->errCode || !p->journalOpen || (p->exclusiveMode&&!p->journalOff) );
1328 assert( p->errCode || !p->stmtOpen || p->exclusiveMode );
drhfdc40e92008-04-17 20:59:37 +00001329#endif
danielk1977ae72d982007-10-03 08:46:44 +00001330}
1331
1332/*
drh80e35f42007-03-30 14:06:34 +00001333** This routine ends a transaction. A transaction is ended by either
1334** a COMMIT or a ROLLBACK.
1335**
drhed7c8552001-04-11 14:29:21 +00001336** When this routine is called, the pager has the journal file open and
drh80e35f42007-03-30 14:06:34 +00001337** a RESERVED or EXCLUSIVE lock on the database. This routine will release
1338** the database lock and acquires a SHARED lock in its place if that is
1339** the appropriate thing to do. Release locks usually is appropriate,
1340** unless we are in exclusive access mode or unless this is a
1341** COMMIT AND BEGIN or ROLLBACK AND BEGIN operation.
1342**
1343** The journal file is either deleted or truncated.
drh50457892003-09-06 01:10:47 +00001344**
1345** TODO: Consider keeping the journal file open for temporary databases.
1346** This might give a performance improvement on windows where opening
1347** a file is an expensive operation.
drhed7c8552001-04-11 14:29:21 +00001348*/
drh80e35f42007-03-30 14:06:34 +00001349static int pager_end_transaction(Pager *pPager){
drhd9b02572001-04-15 00:37:09 +00001350 PgHdr *pPg;
danielk197741483462007-03-24 16:45:04 +00001351 int rc = SQLITE_OK;
danielk1977979f38e2007-03-27 16:19:51 +00001352 int rc2 = SQLITE_OK;
drhb7f91642004-10-31 02:22:47 +00001353 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +00001354 if( pPager->state<PAGER_RESERVED ){
1355 return SQLITE_OK;
1356 }
danielk19773b8a05f2007-03-19 17:44:26 +00001357 sqlite3PagerStmtCommit(pPager);
danielk1977334cdb62007-03-26 08:05:12 +00001358 if( pPager->stmtOpen && !pPager->exclusiveMode ){
danielk1977b4b47412007-08-17 15:53:36 +00001359 sqlite3OsClose(pPager->stfd);
danielk1977979f38e2007-03-27 16:19:51 +00001360 pPager->stmtOpen = 0;
drh0f892532002-05-30 12:27:03 +00001361 }
drhda47d772002-12-02 04:25:19 +00001362 if( pPager->journalOpen ){
drhfdc40e92008-04-17 20:59:37 +00001363 if( (pPager->exclusiveMode ||
1364 pPager->journalMode==PAGER_JOURNALMODE_PERSIST)
1365 && (rc = zeroJournalHdr(pPager))==SQLITE_OK ){
danielk197741483462007-03-24 16:45:04 +00001366 pPager->journalOff = 0;
danielk1977334cdb62007-03-26 08:05:12 +00001367 pPager->journalStarted = 0;
danielk197741483462007-03-24 16:45:04 +00001368 }else{
danielk1977b4b47412007-08-17 15:53:36 +00001369 sqlite3OsClose(pPager->jfd);
danielk197741483462007-03-24 16:45:04 +00001370 pPager->journalOpen = 0;
drh01fa4c32007-04-02 11:22:22 +00001371 if( rc==SQLITE_OK ){
danielk1977fee2d252007-08-18 10:59:19 +00001372 rc = sqlite3OsDelete(pPager->pVfs, pPager->zJournal, 0);
danielk19777152de82007-03-29 17:28:14 +00001373 }
danielk197741483462007-03-24 16:45:04 +00001374 }
drhf5e7bb52008-02-18 14:47:33 +00001375 sqlite3BitvecDestroy(pPager->pInJournal);
1376 pPager->pInJournal = 0;
drhda47d772002-12-02 04:25:19 +00001377 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
1378 pPg->inJournal = 0;
1379 pPg->dirty = 0;
drhdb48ee02003-01-16 13:42:43 +00001380 pPg->needSync = 0;
danielk197741483462007-03-24 16:45:04 +00001381 pPg->alwaysRollback = 0;
danielk19773c407372005-02-15 02:54:14 +00001382#ifdef SQLITE_CHECK_PAGES
1383 pPg->pageHash = pager_pagehash(pPg);
1384#endif
drhda47d772002-12-02 04:25:19 +00001385 }
drh605ad8f2006-05-03 23:34:05 +00001386 pPager->pDirty = 0;
danielk1977ef317ab2004-06-23 10:43:10 +00001387 pPager->dirtyCache = 0;
danielk1977ef317ab2004-06-23 10:43:10 +00001388 pPager->nRec = 0;
drhda47d772002-12-02 04:25:19 +00001389 }else{
drhf5e7bb52008-02-18 14:47:33 +00001390 assert( pPager->pInJournal==0 );
drha6abd042004-06-09 17:37:22 +00001391 assert( pPager->dirtyCache==0 || pPager->useJournal==0 );
drhd9b02572001-04-15 00:37:09 +00001392 }
danielk1977979f38e2007-03-27 16:19:51 +00001393
danielk197741483462007-03-24 16:45:04 +00001394 if( !pPager->exclusiveMode ){
danielk19777a2b1ee2007-08-21 14:27:01 +00001395 rc2 = osUnlock(pPager->fd, SHARED_LOCK);
danielk197741483462007-03-24 16:45:04 +00001396 pPager->state = PAGER_SHARED;
danielk1977334cdb62007-03-26 08:05:12 +00001397 }else if( pPager->state==PAGER_SYNCED ){
1398 pPager->state = PAGER_EXCLUSIVE;
danielk197741483462007-03-24 16:45:04 +00001399 }
danielk1977334cdb62007-03-26 08:05:12 +00001400 pPager->origDbSize = 0;
danielk197776572402004-06-25 02:38:54 +00001401 pPager->setMaster = 0;
danielk1977c4da5b92006-01-21 12:08:54 +00001402 pPager->needSync = 0;
danielk19779f61c2f2007-08-27 17:27:49 +00001403 lruListSetFirstSynced(pPager);
drh588f5bc2007-01-02 18:41:54 +00001404 pPager->dbSize = -1;
danielk1977979f38e2007-03-27 16:19:51 +00001405
1406 return (rc==SQLITE_OK?rc2:rc);
drhed7c8552001-04-11 14:29:21 +00001407}
1408
drhed7c8552001-04-11 14:29:21 +00001409/*
drh968af522003-02-11 14:55:40 +00001410** Compute and return a checksum for the page of data.
drh34e79ce2004-02-08 06:05:46 +00001411**
1412** This is not a real checksum. It is really just the sum of the
drh726de592004-06-10 23:35:50 +00001413** random initial value and the page number. We experimented with
1414** a checksum of the entire data, but that was found to be too slow.
1415**
1416** Note that the page number is stored at the beginning of data and
1417** the checksum is stored at the end. This is important. If journal
1418** corruption occurs due to a power failure, the most likely scenario
1419** is that one end or the other of the record will be changed. It is
1420** much less likely that the two ends of the journal record will be
1421** correct and the middle be corrupt. Thus, this "checksum" scheme,
1422** though fast and simple, catches the mostly likely kind of corruption.
1423**
1424** FIX ME: Consider adding every 200th (or so) byte of the data to the
1425** checksum. That way if a single page spans 3 or more disk sectors and
1426** only the middle sector is corrupt, we will still have a reasonable
1427** chance of failing the checksum and thus detecting the problem.
drh968af522003-02-11 14:55:40 +00001428*/
drh74161702006-02-24 02:53:49 +00001429static u32 pager_cksum(Pager *pPager, const u8 *aData){
danielk1977ef317ab2004-06-23 10:43:10 +00001430 u32 cksum = pPager->cksumInit;
1431 int i = pPager->pageSize-200;
1432 while( i>0 ){
1433 cksum += aData[i];
1434 i -= 200;
1435 }
drh968af522003-02-11 14:55:40 +00001436 return cksum;
1437}
1438
drh605ad8f2006-05-03 23:34:05 +00001439/* Forward declaration */
1440static void makeClean(PgHdr*);
1441
drh968af522003-02-11 14:55:40 +00001442/*
drhfa86c412002-02-02 15:01:15 +00001443** Read a single page from the journal file opened on file descriptor
1444** jfd. Playback this one page.
drh968af522003-02-11 14:55:40 +00001445**
drh726de592004-06-10 23:35:50 +00001446** If useCksum==0 it means this journal does not use checksums. Checksums
1447** are not used in statement journals because statement journals do not
1448** need to survive power failures.
drhfa86c412002-02-02 15:01:15 +00001449*/
danielk197762079062007-08-15 17:08:46 +00001450static int pager_playback_one_page(
1451 Pager *pPager,
1452 sqlite3_file *jfd,
1453 i64 offset,
1454 int useCksum
1455){
drhfa86c412002-02-02 15:01:15 +00001456 int rc;
drhae2b40c2004-06-09 19:03:54 +00001457 PgHdr *pPg; /* An existing page in the cache */
1458 Pgno pgno; /* The page number of a page in journal */
1459 u32 cksum; /* Checksum used for sanity checking */
danielk19778186df82007-03-06 13:45:59 +00001460 u8 *aData = (u8 *)pPager->pTmpSpace; /* Temp storage for a page */
drhfa86c412002-02-02 15:01:15 +00001461
drh96362842005-03-20 22:47:56 +00001462 /* useCksum should be true for the main journal and false for
1463 ** statement journals. Verify that this is always the case
1464 */
drh9cbe6352005-11-29 03:13:21 +00001465 assert( jfd == (useCksum ? pPager->jfd : pPager->stfd) );
danielk19778186df82007-03-06 13:45:59 +00001466 assert( aData );
drh96362842005-03-20 22:47:56 +00001467
danielk197762079062007-08-15 17:08:46 +00001468 rc = read32bits(jfd, offset, &pgno);
drh99ee3602003-02-16 19:13:36 +00001469 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +00001470 rc = sqlite3OsRead(jfd, aData, pPager->pageSize, offset+4);
drh99ee3602003-02-16 19:13:36 +00001471 if( rc!=SQLITE_OK ) return rc;
danielk197776572402004-06-25 02:38:54 +00001472 pPager->journalOff += pPager->pageSize + 4;
drhfa86c412002-02-02 15:01:15 +00001473
drh968af522003-02-11 14:55:40 +00001474 /* Sanity checking on the page. This is more important that I originally
1475 ** thought. If a power failure occurs while the journal is being written,
1476 ** it could cause invalid data to be written into the journal. We need to
1477 ** detect this invalid data (with high probability) and ignore it.
1478 */
danielk197775edc162004-06-26 01:48:18 +00001479 if( pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh968af522003-02-11 14:55:40 +00001480 return SQLITE_DONE;
1481 }
drhae2b40c2004-06-09 19:03:54 +00001482 if( pgno>(unsigned)pPager->dbSize ){
drh968af522003-02-11 14:55:40 +00001483 return SQLITE_OK;
1484 }
drhae2b40c2004-06-09 19:03:54 +00001485 if( useCksum ){
danielk197762079062007-08-15 17:08:46 +00001486 rc = read32bits(jfd, offset+pPager->pageSize+4, &cksum);
drh99ee3602003-02-16 19:13:36 +00001487 if( rc ) return rc;
danielk197776572402004-06-25 02:38:54 +00001488 pPager->journalOff += 4;
drh74161702006-02-24 02:53:49 +00001489 if( pager_cksum(pPager, aData)!=cksum ){
drh968af522003-02-11 14:55:40 +00001490 return SQLITE_DONE;
1491 }
1492 }
drhfa86c412002-02-02 15:01:15 +00001493
danielk1977aa5ccdf2004-06-14 05:10:42 +00001494 assert( pPager->state==PAGER_RESERVED || pPager->state>=PAGER_EXCLUSIVE );
danielk1977a3f3a5f2004-06-10 04:32:16 +00001495
1496 /* If the pager is in RESERVED state, then there must be a copy of this
1497 ** page in the pager cache. In this case just update the pager cache,
danielk19770de0bb32004-06-10 05:59:24 +00001498 ** not the database file. The page is left marked dirty in this case.
1499 **
danielk19772df71c72007-05-24 07:22:42 +00001500 ** An exception to the above rule: If the database is in no-sync mode
1501 ** and a page is moved during an incremental vacuum then the page may
danielk1977369f3a02007-05-24 09:41:20 +00001502 ** not be in the pager cache. Later: if a malloc() or IO error occurs
1503 ** during a Movepage() call, then the page may not be in the cache
1504 ** either. So the condition described in the above paragraph is not
1505 ** assert()able.
danielk19772df71c72007-05-24 07:22:42 +00001506 **
danielk1977a3f3a5f2004-06-10 04:32:16 +00001507 ** If in EXCLUSIVE state, then we update the pager cache if it exists
1508 ** and the main file. The page is then marked not dirty.
drh96362842005-03-20 22:47:56 +00001509 **
1510 ** Ticket #1171: The statement journal might contain page content that is
1511 ** different from the page content at the start of the transaction.
1512 ** This occurs when a page is changed prior to the start of a statement
1513 ** then changed again within the statement. When rolling back such a
1514 ** statement we must not write to the original database unless we know
drh5e385312007-06-16 04:42:12 +00001515 ** for certain that original page contents are synced into the main rollback
1516 ** journal. Otherwise, a power loss might leave modified data in the
1517 ** database file without an entry in the rollback journal that can
1518 ** restore the database to its original form. Two conditions must be
1519 ** met before writing to the database files. (1) the database must be
1520 ** locked. (2) we know that the original page content is fully synced
1521 ** in the main journal either because the page is not in cache or else
1522 ** the page is marked as needSync==0.
drh4c02a232008-04-14 23:13:45 +00001523 **
1524 ** 2008-04-14: When attempting to vacuum a corrupt database file, it
1525 ** is possible to fail a statement on a database that does not yet exist.
1526 ** Do not attempt to write if database file has never been opened.
drhfa86c412002-02-02 15:01:15 +00001527 */
drhae2b40c2004-06-09 19:03:54 +00001528 pPg = pager_lookup(pPager, pgno);
drh477731b2007-06-16 03:06:27 +00001529 PAGERTRACE4("PLAYBACK %d page %d hash(%08x)\n",
1530 PAGERID(pPager), pgno, pager_datahash(pPager->pageSize, aData));
drh4c02a232008-04-14 23:13:45 +00001531 if( pPager->state>=PAGER_EXCLUSIVE && (pPg==0 || pPg->needSync==0)
1532 && pPager->fd->pMethods ){
danielk197762079062007-08-15 17:08:46 +00001533 i64 offset = (pgno-1)*(i64)pPager->pageSize;
1534 rc = sqlite3OsWrite(pPager->fd, aData, pPager->pageSize, offset);
drh605ad8f2006-05-03 23:34:05 +00001535 if( pPg ){
1536 makeClean(pPg);
1537 }
danielk1977a3f3a5f2004-06-10 04:32:16 +00001538 }
drhfa86c412002-02-02 15:01:15 +00001539 if( pPg ){
danielk197728129562005-01-11 10:25:06 +00001540 /* No page should ever be explicitly rolled back that is in use, except
1541 ** for page 1 which is held in use in order to keep the lock on the
1542 ** database active. However such a page may be rolled back as a result
1543 ** of an internal error resulting in an automatic call to
danielk19773b8a05f2007-03-19 17:44:26 +00001544 ** sqlite3PagerRollback().
drhacf4ac92003-12-17 23:57:34 +00001545 */
drhb6f41482004-05-14 01:58:11 +00001546 void *pData;
danielk197728129562005-01-11 10:25:06 +00001547 /* assert( pPg->nRef==0 || pPg->pgno==1 ); */
drhb6f41482004-05-14 01:58:11 +00001548 pData = PGHDR_TO_DATA(pPg);
drhae2b40c2004-06-09 19:03:54 +00001549 memcpy(pData, aData, pPager->pageSize);
danielk19779038bb62007-04-09 11:20:54 +00001550 if( pPager->xReiniter ){
1551 pPager->xReiniter(pPg, pPager->pageSize);
drhde647132004-05-07 17:57:49 +00001552 }
danielk19773c407372005-02-15 02:54:14 +00001553#ifdef SQLITE_CHECK_PAGES
drh96362842005-03-20 22:47:56 +00001554 pPg->pageHash = pager_pagehash(pPg);
danielk19773c407372005-02-15 02:54:14 +00001555#endif
drh86a88112007-04-16 15:02:19 +00001556 /* If this was page 1, then restore the value of Pager.dbFileVers.
1557 ** Do this before any decoding. */
danielk197741483462007-03-24 16:45:04 +00001558 if( pgno==1 ){
drh86a88112007-04-16 15:02:19 +00001559 memcpy(&pPager->dbFileVers, &((u8*)pData)[24],sizeof(pPager->dbFileVers));
danielk197741483462007-03-24 16:45:04 +00001560 }
drh86a88112007-04-16 15:02:19 +00001561
1562 /* Decode the page just read from disk */
1563 CODEC1(pPager, pData, pPg->pgno, 3);
drhfa86c412002-02-02 15:01:15 +00001564 }
1565 return rc;
1566}
1567
1568/*
danielk197713adf8a2004-06-03 16:08:41 +00001569** Parameter zMaster is the name of a master journal file. A single journal
1570** file that referred to the master journal file has just been rolled back.
1571** This routine checks if it is possible to delete the master journal file,
1572** and does so if it is.
drh726de592004-06-10 23:35:50 +00001573**
danielk197765839c62007-08-30 08:08:17 +00001574** Argument zMaster may point to Pager.pTmpSpace. So that buffer is not
1575** available for use within this function.
1576**
1577**
drh726de592004-06-10 23:35:50 +00001578** The master journal file contains the names of all child journals.
1579** To tell if a master journal can be deleted, check to each of the
1580** children. If all children are either missing or do not refer to
1581** a different master journal, then this master journal can be deleted.
danielk197713adf8a2004-06-03 16:08:41 +00001582*/
danielk1977b4b47412007-08-17 15:53:36 +00001583static int pager_delmaster(Pager *pPager, const char *zMaster){
1584 sqlite3_vfs *pVfs = pPager->pVfs;
danielk197713adf8a2004-06-03 16:08:41 +00001585 int rc;
1586 int master_open = 0;
danielk1977b4b47412007-08-17 15:53:36 +00001587 sqlite3_file *pMaster;
1588 sqlite3_file *pJournal;
danielk197713adf8a2004-06-03 16:08:41 +00001589 char *zMasterJournal = 0; /* Contents of master journal file */
drheb206252004-10-01 02:00:31 +00001590 i64 nMasterJournal; /* Size of master journal file */
danielk197713adf8a2004-06-03 16:08:41 +00001591
1592 /* Open the master journal file exclusively in case some other process
1593 ** is running this routine also. Not that it makes too much difference.
1594 */
danielk1977b4b47412007-08-17 15:53:36 +00001595 pMaster = (sqlite3_file *)sqlite3_malloc(pVfs->szOsFile * 2);
danielk1977fee2d252007-08-18 10:59:19 +00001596 pJournal = (sqlite3_file *)(((u8 *)pMaster) + pVfs->szOsFile);
danielk1977b4b47412007-08-17 15:53:36 +00001597 if( !pMaster ){
1598 rc = SQLITE_NOMEM;
1599 }else{
danielk1977fee2d252007-08-18 10:59:19 +00001600 int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MASTER_JOURNAL);
1601 rc = sqlite3OsOpen(pVfs, zMaster, pMaster, flags, 0);
danielk1977b4b47412007-08-17 15:53:36 +00001602 }
danielk197713adf8a2004-06-03 16:08:41 +00001603 if( rc!=SQLITE_OK ) goto delmaster_out;
1604 master_open = 1;
danielk1977b4b47412007-08-17 15:53:36 +00001605
1606 rc = sqlite3OsFileSize(pMaster, &nMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001607 if( rc!=SQLITE_OK ) goto delmaster_out;
1608
1609 if( nMasterJournal>0 ){
danielk19775865e3d2004-06-14 06:03:57 +00001610 char *zJournal;
danielk197776572402004-06-25 02:38:54 +00001611 char *zMasterPtr = 0;
danielk197765839c62007-08-30 08:08:17 +00001612 int nMasterPtr = pPager->pVfs->mxPathname+1;
danielk19775865e3d2004-06-14 06:03:57 +00001613
1614 /* Load the entire master journal file into space obtained from
drh17435752007-08-16 04:30:38 +00001615 ** sqlite3_malloc() and pointed to by zMasterJournal.
danielk19775865e3d2004-06-14 06:03:57 +00001616 */
danielk197765839c62007-08-30 08:08:17 +00001617 zMasterJournal = (char *)sqlite3_malloc(nMasterJournal + nMasterPtr);
danielk197713adf8a2004-06-03 16:08:41 +00001618 if( !zMasterJournal ){
1619 rc = SQLITE_NOMEM;
1620 goto delmaster_out;
1621 }
danielk197765839c62007-08-30 08:08:17 +00001622 zMasterPtr = &zMasterJournal[nMasterJournal];
danielk1977b4b47412007-08-17 15:53:36 +00001623 rc = sqlite3OsRead(pMaster, zMasterJournal, nMasterJournal, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001624 if( rc!=SQLITE_OK ) goto delmaster_out;
1625
danielk19775865e3d2004-06-14 06:03:57 +00001626 zJournal = zMasterJournal;
1627 while( (zJournal-zMasterJournal)<nMasterJournal ){
drh19db9352008-03-27 22:42:51 +00001628 rc = sqlite3OsAccess(pVfs, zJournal, SQLITE_ACCESS_EXISTS);
1629 if( rc!=0 && rc!=1 ){
1630 rc = SQLITE_IOERR_NOMEM;
1631 goto delmaster_out;
1632 }
1633 if( rc==1 ){
danielk197713adf8a2004-06-03 16:08:41 +00001634 /* One of the journals pointed to by the master journal exists.
1635 ** Open it and check if it points at the master journal. If
1636 ** so, return without deleting the master journal file.
1637 */
drh3b7b78b2004-11-24 01:16:43 +00001638 int c;
danielk1977fee2d252007-08-18 10:59:19 +00001639 int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MAIN_JOURNAL);
1640 rc = sqlite3OsOpen(pVfs, zJournal, pJournal, flags, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001641 if( rc!=SQLITE_OK ){
danielk197713adf8a2004-06-03 16:08:41 +00001642 goto delmaster_out;
1643 }
danielk197713adf8a2004-06-03 16:08:41 +00001644
danielk197765839c62007-08-30 08:08:17 +00001645 rc = readMasterJournal(pJournal, zMasterPtr, nMasterPtr);
danielk1977b4b47412007-08-17 15:53:36 +00001646 sqlite3OsClose(pJournal);
danielk19779eed5052004-06-04 10:38:30 +00001647 if( rc!=SQLITE_OK ){
danielk19779eed5052004-06-04 10:38:30 +00001648 goto delmaster_out;
1649 }
danielk197776572402004-06-25 02:38:54 +00001650
danielk197765839c62007-08-30 08:08:17 +00001651 c = zMasterPtr[0]!=0 && strcmp(zMasterPtr, zMaster)==0;
drh3b7b78b2004-11-24 01:16:43 +00001652 if( c ){
danielk197776572402004-06-25 02:38:54 +00001653 /* We have a match. Do not delete the master journal file. */
1654 goto delmaster_out;
danielk197713adf8a2004-06-03 16:08:41 +00001655 }
1656 }
danielk19775865e3d2004-06-14 06:03:57 +00001657 zJournal += (strlen(zJournal)+1);
danielk197713adf8a2004-06-03 16:08:41 +00001658 }
1659 }
1660
danielk1977fee2d252007-08-18 10:59:19 +00001661 rc = sqlite3OsDelete(pVfs, zMaster, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001662
1663delmaster_out:
1664 if( zMasterJournal ){
drh17435752007-08-16 04:30:38 +00001665 sqlite3_free(zMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001666 }
1667 if( master_open ){
danielk1977b4b47412007-08-17 15:53:36 +00001668 sqlite3OsClose(pMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001669 }
danielk1977b4b47412007-08-17 15:53:36 +00001670 sqlite3_free(pMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001671 return rc;
1672}
1673
drha6abd042004-06-09 17:37:22 +00001674
danielk1977e180dd92007-04-05 17:15:52 +00001675static void pager_truncate_cache(Pager *pPager);
1676
drha6abd042004-06-09 17:37:22 +00001677/*
drhcb4c40b2004-08-18 19:09:43 +00001678** Truncate the main file of the given pager to the number of pages
danielk1977e180dd92007-04-05 17:15:52 +00001679** indicated. Also truncate the cached representation of the file.
drh7fe3f7e2007-11-29 18:44:27 +00001680**
1681** Might might be the case that the file on disk is smaller than nPage.
1682** This can happen, for example, if we are in the middle of a transaction
1683** which has extended the file size and the new pages are still all held
1684** in cache, then an INSERT or UPDATE does a statement rollback. Some
1685** operating system implementations can get confused if you try to
1686** truncate a file to some size that is larger than it currently is,
1687** so detect this case and do not do the truncation.
drhcb4c40b2004-08-18 19:09:43 +00001688*/
1689static int pager_truncate(Pager *pPager, int nPage){
danielk1977e180dd92007-04-05 17:15:52 +00001690 int rc = SQLITE_OK;
danielk19777a2b1ee2007-08-21 14:27:01 +00001691 if( pPager->state>=PAGER_EXCLUSIVE && pPager->fd->pMethods ){
drh7fe3f7e2007-11-29 18:44:27 +00001692 i64 currentSize, newSize;
1693 rc = sqlite3OsFileSize(pPager->fd, &currentSize);
1694 newSize = pPager->pageSize*(i64)nPage;
1695 if( rc==SQLITE_OK && currentSize>newSize ){
1696 rc = sqlite3OsTruncate(pPager->fd, newSize);
1697 }
danielk1977e180dd92007-04-05 17:15:52 +00001698 }
1699 if( rc==SQLITE_OK ){
1700 pPager->dbSize = nPage;
1701 pager_truncate_cache(pPager);
1702 }
1703 return rc;
drhcb4c40b2004-08-18 19:09:43 +00001704}
1705
1706/*
drhc80f0582007-05-01 16:59:48 +00001707** Set the sectorSize for the given pager.
1708**
drh334c80d2008-03-28 17:41:13 +00001709** The sector size is at least as big as the sector size reported
1710** by sqlite3OsSectorSize(). The minimum sector size is 512.
drhc80f0582007-05-01 16:59:48 +00001711*/
1712static void setSectorSize(Pager *pPager){
danielk19777a2b1ee2007-08-21 14:27:01 +00001713 assert(pPager->fd->pMethods||pPager->tempFile);
1714 if( !pPager->tempFile ){
1715 /* Sector size doesn't matter for temporary files. Also, the file
1716 ** may not have been opened yet, in whcih case the OsSectorSize()
1717 ** call will segfault.
1718 */
1719 pPager->sectorSize = sqlite3OsSectorSize(pPager->fd);
1720 }
drh334c80d2008-03-28 17:41:13 +00001721 if( pPager->sectorSize<512 ){
1722 pPager->sectorSize = 512;
drhc80f0582007-05-01 16:59:48 +00001723 }
1724}
1725
1726/*
drhed7c8552001-04-11 14:29:21 +00001727** Playback the journal and thus restore the database file to
1728** the state it was in before we started making changes.
1729**
drh34e79ce2004-02-08 06:05:46 +00001730** The journal file format is as follows:
1731**
drhae2b40c2004-06-09 19:03:54 +00001732** (1) 8 byte prefix. A copy of aJournalMagic[].
1733** (2) 4 byte big-endian integer which is the number of valid page records
drh34e79ce2004-02-08 06:05:46 +00001734** in the journal. If this value is 0xffffffff, then compute the
drhae2b40c2004-06-09 19:03:54 +00001735** number of page records from the journal size.
1736** (3) 4 byte big-endian integer which is the initial value for the
1737** sanity checksum.
1738** (4) 4 byte integer which is the number of pages to truncate the
drh34e79ce2004-02-08 06:05:46 +00001739** database to during a rollback.
drh334c80d2008-03-28 17:41:13 +00001740** (5) 4 byte big-endian integer which is the sector size. The header
1741** is this many bytes in size.
1742** (6) 4 byte big-endian integer which is the page case.
1743** (7) 4 byte integer which is the number of bytes in the master journal
drhae2b40c2004-06-09 19:03:54 +00001744** name. The value may be zero (indicate that there is no master
1745** journal.)
drh334c80d2008-03-28 17:41:13 +00001746** (8) N bytes of the master journal name. The name will be nul-terminated
drhae2b40c2004-06-09 19:03:54 +00001747** and might be shorter than the value read from (5). If the first byte
1748** of the name is \000 then there is no master journal. The master
1749** journal name is stored in UTF-8.
drh334c80d2008-03-28 17:41:13 +00001750** (9) Zero or more pages instances, each as follows:
drh34e79ce2004-02-08 06:05:46 +00001751** + 4 byte page number.
drhae2b40c2004-06-09 19:03:54 +00001752** + pPager->pageSize bytes of data.
1753** + 4 byte checksum
drh34e79ce2004-02-08 06:05:46 +00001754**
drh334c80d2008-03-28 17:41:13 +00001755** When we speak of the journal header, we mean the first 8 items above.
1756** Each entry in the journal is an instance of the 9th item.
drh34e79ce2004-02-08 06:05:46 +00001757**
1758** Call the value from the second bullet "nRec". nRec is the number of
1759** valid page entries in the journal. In most cases, you can compute the
1760** value of nRec from the size of the journal file. But if a power
1761** failure occurred while the journal was being written, it could be the
1762** case that the size of the journal file had already been increased but
1763** the extra entries had not yet made it safely to disk. In such a case,
1764** the value of nRec computed from the file size would be too large. For
1765** that reason, we always use the nRec value in the header.
1766**
1767** If the nRec value is 0xffffffff it means that nRec should be computed
1768** from the file size. This value is used when the user selects the
1769** no-sync option for the journal. A power failure could lead to corruption
1770** in this case. But for things like temporary table (which will be
1771** deleted when the power is restored) we don't care.
1772**
drhd9b02572001-04-15 00:37:09 +00001773** If the file opened as the journal file is not a well-formed
danielk1977ece80f12004-06-23 01:05:26 +00001774** journal file then all pages up to the first corrupted page are rolled
1775** back (or no pages if the journal header is corrupted). The journal file
1776** is then deleted and SQLITE_OK returned, just as if no corruption had
1777** been encountered.
1778**
1779** If an I/O or malloc() error occurs, the journal-file is not deleted
1780** and an error code is returned.
drhed7c8552001-04-11 14:29:21 +00001781*/
danielk1977e277be02007-03-23 18:12:06 +00001782static int pager_playback(Pager *pPager, int isHot){
danielk1977b4b47412007-08-17 15:53:36 +00001783 sqlite3_vfs *pVfs = pPager->pVfs;
drheb206252004-10-01 02:00:31 +00001784 i64 szJ; /* Size of the journal file in bytes */
danielk1977c3e8f5e2004-06-28 01:16:46 +00001785 u32 nRec; /* Number of Records in the journal */
drhd9b02572001-04-15 00:37:09 +00001786 int i; /* Loop counter */
1787 Pgno mxPg = 0; /* Size of the original file in pages */
drhae2b40c2004-06-09 19:03:54 +00001788 int rc; /* Result code of a subroutine */
danielk1977ce98bba2008-04-03 10:13:01 +00001789 int res = 0; /* Value returned by sqlite3OsAccess() */
danielk197713adf8a2004-06-03 16:08:41 +00001790 char *zMaster = 0; /* Name of master journal file if any */
drhed7c8552001-04-11 14:29:21 +00001791
drhc3a64ba2001-11-22 00:01:27 +00001792 /* Figure out how many records are in the journal. Abort early if
1793 ** the journal is empty.
drhed7c8552001-04-11 14:29:21 +00001794 */
drh8cfbf082001-09-19 13:22:39 +00001795 assert( pPager->journalOpen );
drh054889e2005-11-30 03:20:31 +00001796 rc = sqlite3OsFileSize(pPager->jfd, &szJ);
danielk1977334cdb62007-03-26 08:05:12 +00001797 if( rc!=SQLITE_OK || szJ==0 ){
drhc3a64ba2001-11-22 00:01:27 +00001798 goto end_playback;
1799 }
drh240c5792004-02-08 00:40:52 +00001800
danielk197776572402004-06-25 02:38:54 +00001801 /* Read the master journal name from the journal, if it is present.
1802 ** If a master journal file name is specified, but the file is not
1803 ** present on disk, then the journal is not hot and does not need to be
1804 ** played back.
drh240c5792004-02-08 00:40:52 +00001805 */
danielk197765839c62007-08-30 08:08:17 +00001806 zMaster = pPager->pTmpSpace;
1807 rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1);
danielk1977ce98bba2008-04-03 10:13:01 +00001808 if( rc!=SQLITE_OK || (zMaster[0]
1809 && (res=sqlite3OsAccess(pVfs, zMaster, SQLITE_ACCESS_EXISTS))==0 )
danielk1977b4b47412007-08-17 15:53:36 +00001810 ){
danielk197776572402004-06-25 02:38:54 +00001811 zMaster = 0;
drhc3a64ba2001-11-22 00:01:27 +00001812 goto end_playback;
1813 }
danielk197765839c62007-08-30 08:08:17 +00001814 zMaster = 0;
danielk1977ce98bba2008-04-03 10:13:01 +00001815 if( res<0 ){
1816 rc = SQLITE_IOERR_NOMEM;
1817 goto end_playback;
1818 }
1819 pPager->journalOff = 0;
drhc3a64ba2001-11-22 00:01:27 +00001820
danielk197776572402004-06-25 02:38:54 +00001821 /* This loop terminates either when the readJournalHdr() call returns
1822 ** SQLITE_DONE or an IO error occurs. */
1823 while( 1 ){
drhae2b40c2004-06-09 19:03:54 +00001824
danielk197776572402004-06-25 02:38:54 +00001825 /* Read the next journal header from the journal file. If there are
1826 ** not enough bytes left in the journal file for a complete header, or
1827 ** it is corrupted, then a process must of failed while writing it.
1828 ** This indicates nothing more needs to be rolled back.
1829 */
1830 rc = readJournalHdr(pPager, szJ, &nRec, &mxPg);
1831 if( rc!=SQLITE_OK ){
drh968af522003-02-11 14:55:40 +00001832 if( rc==SQLITE_DONE ){
drh968af522003-02-11 14:55:40 +00001833 rc = SQLITE_OK;
1834 }
danielk197776572402004-06-25 02:38:54 +00001835 goto end_playback;
1836 }
1837
1838 /* If nRec is 0xffffffff, then this journal was created by a process
1839 ** working in no-sync mode. This means that the rest of the journal
1840 ** file consists of pages, there are no more journal headers. Compute
1841 ** the value of nRec based on this assumption.
1842 */
1843 if( nRec==0xffffffff ){
1844 assert( pPager->journalOff==JOURNAL_HDR_SZ(pPager) );
1845 nRec = (szJ - JOURNAL_HDR_SZ(pPager))/JOURNAL_PG_SZ(pPager);
1846 }
1847
danielk1977e277be02007-03-23 18:12:06 +00001848 /* If nRec is 0 and this rollback is of a transaction created by this
drh8940f4e2007-08-11 00:26:20 +00001849 ** process and if this is the final header in the journal, then it means
1850 ** that this part of the journal was being filled but has not yet been
1851 ** synced to disk. Compute the number of pages based on the remaining
1852 ** size of the file.
1853 **
1854 ** The third term of the test was added to fix ticket #2565.
danielk1977e277be02007-03-23 18:12:06 +00001855 */
drh8940f4e2007-08-11 00:26:20 +00001856 if( nRec==0 && !isHot &&
1857 pPager->journalHdr+JOURNAL_HDR_SZ(pPager)==pPager->journalOff ){
danielk1977e277be02007-03-23 18:12:06 +00001858 nRec = (szJ - pPager->journalOff) / JOURNAL_PG_SZ(pPager);
1859 }
1860
danielk197776572402004-06-25 02:38:54 +00001861 /* If this is the first header read from the journal, truncate the
drh85b623f2007-12-13 21:54:09 +00001862 ** database file back to its original size.
danielk197776572402004-06-25 02:38:54 +00001863 */
danielk1977e180dd92007-04-05 17:15:52 +00001864 if( pPager->journalOff==JOURNAL_HDR_SZ(pPager) ){
drhcb4c40b2004-08-18 19:09:43 +00001865 rc = pager_truncate(pPager, mxPg);
danielk197776572402004-06-25 02:38:54 +00001866 if( rc!=SQLITE_OK ){
1867 goto end_playback;
1868 }
danielk197776572402004-06-25 02:38:54 +00001869 }
1870
danielk197776572402004-06-25 02:38:54 +00001871 /* Copy original pages out of the journal and back into the database file.
1872 */
1873 for(i=0; i<nRec; i++){
danielk197762079062007-08-15 17:08:46 +00001874 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001875 if( rc!=SQLITE_OK ){
1876 if( rc==SQLITE_DONE ){
1877 rc = SQLITE_OK;
1878 pPager->journalOff = szJ;
1879 break;
1880 }else{
1881 goto end_playback;
1882 }
1883 }
drh968af522003-02-11 14:55:40 +00001884 }
drhed7c8552001-04-11 14:29:21 +00001885 }
drh580eeaf2006-02-24 03:09:37 +00001886 /*NOTREACHED*/
1887 assert( 0 );
drh4a0681e2003-02-13 01:58:20 +00001888
1889end_playback:
danielk19778191bff2004-06-28 04:52:30 +00001890 if( rc==SQLITE_OK ){
danielk197765839c62007-08-30 08:08:17 +00001891 zMaster = pPager->pTmpSpace;
1892 rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1);
1893 }
1894 if( rc==SQLITE_OK ){
drh80e35f42007-03-30 14:06:34 +00001895 rc = pager_end_transaction(pPager);
danielk19778191bff2004-06-28 04:52:30 +00001896 }
danielk197765839c62007-08-30 08:08:17 +00001897 if( rc==SQLITE_OK && zMaster[0] ){
danielk1977979f38e2007-03-27 16:19:51 +00001898 /* If there was a master journal and this routine will return success,
danielk197732554c12005-01-22 03:39:39 +00001899 ** see if it is possible to delete the master journal.
danielk197713adf8a2004-06-03 16:08:41 +00001900 */
danielk197765839c62007-08-30 08:08:17 +00001901 rc = pager_delmaster(pPager, zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001902 }
danielk197776572402004-06-25 02:38:54 +00001903
1904 /* The Pager.sectorSize variable may have been updated while rolling
drh3ceeb752007-03-29 18:19:52 +00001905 ** back a journal created by a process with a different sector size
danielk197776572402004-06-25 02:38:54 +00001906 ** value. Reset it to the correct value for this process.
1907 */
drhc80f0582007-05-01 16:59:48 +00001908 setSectorSize(pPager);
drhd9b02572001-04-15 00:37:09 +00001909 return rc;
drhed7c8552001-04-11 14:29:21 +00001910}
1911
1912/*
drhac69b052004-05-12 13:30:07 +00001913** Playback the statement journal.
drhfa86c412002-02-02 15:01:15 +00001914**
1915** This is similar to playing back the transaction journal but with
1916** a few extra twists.
1917**
drh663fc632002-02-02 18:49:19 +00001918** (1) The number of pages in the database file at the start of
drhac69b052004-05-12 13:30:07 +00001919** the statement is stored in pPager->stmtSize, not in the
drh663fc632002-02-02 18:49:19 +00001920** journal file itself.
drhfa86c412002-02-02 15:01:15 +00001921**
drhac69b052004-05-12 13:30:07 +00001922** (2) In addition to playing back the statement journal, also
drhfa86c412002-02-02 15:01:15 +00001923** playback all pages of the transaction journal beginning
drhac69b052004-05-12 13:30:07 +00001924** at offset pPager->stmtJSize.
drhfa86c412002-02-02 15:01:15 +00001925*/
drh3aac2dd2004-04-26 14:10:20 +00001926static int pager_stmt_playback(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001927 i64 szJ; /* Size of the full journal */
1928 i64 hdrOff;
drh968af522003-02-11 14:55:40 +00001929 int nRec; /* Number of Records */
drhfa86c412002-02-02 15:01:15 +00001930 int i; /* Loop counter */
1931 int rc;
1932
danielk197776572402004-06-25 02:38:54 +00001933 szJ = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +00001934
danielk19774099f6e2007-03-19 11:25:20 +00001935 /* Set hdrOff to be the offset just after the end of the last journal
1936 ** page written before the first journal-header for this statement
1937 ** transaction was written, or the end of the file if no journal
danielk197776572402004-06-25 02:38:54 +00001938 ** header was written.
1939 */
1940 hdrOff = pPager->stmtHdrOff;
1941 assert( pPager->fullSync || !hdrOff );
1942 if( !hdrOff ){
1943 hdrOff = szJ;
1944 }
1945
drhfa86c412002-02-02 15:01:15 +00001946 /* Truncate the database back to its original size.
1947 */
danielk1977e180dd92007-04-05 17:15:52 +00001948 rc = pager_truncate(pPager, pPager->stmtSize);
drh1aa2d8b2007-01-03 15:34:29 +00001949 assert( pPager->state>=PAGER_SHARED );
drhfa86c412002-02-02 15:01:15 +00001950
drhac69b052004-05-12 13:30:07 +00001951 /* Figure out how many records are in the statement journal.
drhfa86c412002-02-02 15:01:15 +00001952 */
drhac69b052004-05-12 13:30:07 +00001953 assert( pPager->stmtInUse && pPager->journalOpen );
drhac69b052004-05-12 13:30:07 +00001954 nRec = pPager->stmtNRec;
drhfa86c412002-02-02 15:01:15 +00001955
drhac69b052004-05-12 13:30:07 +00001956 /* Copy original pages out of the statement journal and back into the
drhae2b40c2004-06-09 19:03:54 +00001957 ** database file. Note that the statement journal omits checksums from
1958 ** each record since power-failure recovery is not important to statement
1959 ** journals.
drhfa86c412002-02-02 15:01:15 +00001960 */
danielk197762079062007-08-15 17:08:46 +00001961 for(i=0; i<nRec; i++){
1962 i64 offset = i*(4+pPager->pageSize);
1963 rc = pager_playback_one_page(pPager, pPager->stfd, offset, 0);
drh968af522003-02-11 14:55:40 +00001964 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001965 if( rc!=SQLITE_OK ) goto end_stmt_playback;
drhfa86c412002-02-02 15:01:15 +00001966 }
1967
danielk197776572402004-06-25 02:38:54 +00001968 /* Now roll some pages back from the transaction journal. Pager.stmtJSize
1969 ** was the size of the journal file when this statement was started, so
1970 ** everything after that needs to be rolled back, either into the
1971 ** database, the memory cache, or both.
1972 **
1973 ** If it is not zero, then Pager.stmtHdrOff is the offset to the start
1974 ** of the first journal header written during this statement transaction.
drhfa86c412002-02-02 15:01:15 +00001975 */
danielk197776572402004-06-25 02:38:54 +00001976 pPager->journalOff = pPager->stmtJSize;
danielk197775edc162004-06-26 01:48:18 +00001977 pPager->cksumInit = pPager->stmtCksum;
danielk19774099f6e2007-03-19 11:25:20 +00001978 while( pPager->journalOff < hdrOff ){
danielk197762079062007-08-15 17:08:46 +00001979 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001980 assert( rc!=SQLITE_DONE );
1981 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1982 }
1983
1984 while( pPager->journalOff < szJ ){
danielk1977f0113002006-01-24 12:09:17 +00001985 u32 nJRec; /* Number of Journal Records */
danielk197776572402004-06-25 02:38:54 +00001986 u32 dummy;
danielk1977f0113002006-01-24 12:09:17 +00001987 rc = readJournalHdr(pPager, szJ, &nJRec, &dummy);
drh968af522003-02-11 14:55:40 +00001988 if( rc!=SQLITE_OK ){
1989 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001990 goto end_stmt_playback;
drh968af522003-02-11 14:55:40 +00001991 }
danielk1977f0113002006-01-24 12:09:17 +00001992 if( nJRec==0 ){
1993 nJRec = (szJ - pPager->journalOff) / (pPager->pageSize+8);
danielk197775edc162004-06-26 01:48:18 +00001994 }
danielk1977f0113002006-01-24 12:09:17 +00001995 for(i=nJRec-1; i>=0 && pPager->journalOff < szJ; i--){
danielk197762079062007-08-15 17:08:46 +00001996 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001997 assert( rc!=SQLITE_DONE );
1998 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1999 }
drhfa86c412002-02-02 15:01:15 +00002000 }
danielk197776572402004-06-25 02:38:54 +00002001
2002 pPager->journalOff = szJ;
drhfa86c412002-02-02 15:01:15 +00002003
drh3aac2dd2004-04-26 14:10:20 +00002004end_stmt_playback:
danielk19778a7aea32006-01-23 15:25:48 +00002005 if( rc==SQLITE_OK) {
danielk197775edc162004-06-26 01:48:18 +00002006 pPager->journalOff = szJ;
2007 /* pager_reload_cache(pPager); */
drhfa86c412002-02-02 15:01:15 +00002008 }
2009 return rc;
2010}
2011
2012/*
drhf57b14a2001-09-14 18:54:08 +00002013** Change the maximum number of in-memory pages that are allowed.
2014*/
danielk19773b8a05f2007-03-19 17:44:26 +00002015void sqlite3PagerSetCachesize(Pager *pPager, int mxPage){
drhf57b14a2001-09-14 18:54:08 +00002016 if( mxPage>10 ){
2017 pPager->mxPage = mxPage;
danielk1977ef317ab2004-06-23 10:43:10 +00002018 }else{
2019 pPager->mxPage = 10;
drhf57b14a2001-09-14 18:54:08 +00002020 }
2021}
2022
2023/*
drh973b6e32003-02-12 14:09:42 +00002024** Adjust the robustness of the database to damage due to OS crashes
2025** or power failures by changing the number of syncs()s when writing
2026** the rollback journal. There are three levels:
2027**
drh054889e2005-11-30 03:20:31 +00002028** OFF sqlite3OsSync() is never called. This is the default
drh973b6e32003-02-12 14:09:42 +00002029** for temporary and transient files.
2030**
2031** NORMAL The journal is synced once before writes begin on the
2032** database. This is normally adequate protection, but
2033** it is theoretically possible, though very unlikely,
2034** that an inopertune power failure could leave the journal
2035** in a state which would cause damage to the database
2036** when it is rolled back.
2037**
2038** FULL The journal is synced twice before writes begin on the
drh34e79ce2004-02-08 06:05:46 +00002039** database (with some additional information - the nRec field
2040** of the journal header - being written in between the two
2041** syncs). If we assume that writing a
drh973b6e32003-02-12 14:09:42 +00002042** single disk sector is atomic, then this mode provides
2043** assurance that the journal will not be corrupted to the
2044** point of causing damage to the database during rollback.
2045**
2046** Numeric values associated with these states are OFF==1, NORMAL=2,
2047** and FULL=3.
2048*/
danielk197793758c82005-01-21 08:13:14 +00002049#ifndef SQLITE_OMIT_PAGER_PRAGMAS
danielk19773b8a05f2007-03-19 17:44:26 +00002050void sqlite3PagerSetSafetyLevel(Pager *pPager, int level, int full_fsync){
drh973b6e32003-02-12 14:09:42 +00002051 pPager->noSync = level==1 || pPager->tempFile;
2052 pPager->fullSync = level==3 && !pPager->tempFile;
danielk1977f036aef2007-08-20 05:36:51 +00002053 pPager->sync_flags = (full_fsync?SQLITE_SYNC_FULL:SQLITE_SYNC_NORMAL);
danielk19771d850a72004-05-31 08:26:49 +00002054 if( pPager->noSync ) pPager->needSync = 0;
drh973b6e32003-02-12 14:09:42 +00002055}
danielk197793758c82005-01-21 08:13:14 +00002056#endif
drh973b6e32003-02-12 14:09:42 +00002057
2058/*
drhaf6df112005-06-07 02:12:30 +00002059** The following global variable is incremented whenever the library
2060** attempts to open a temporary file. This information is used for
2061** testing and analysis only.
2062*/
drh0f7eb612006-08-08 13:51:43 +00002063#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00002064int sqlite3_opentemp_count = 0;
drh0f7eb612006-08-08 13:51:43 +00002065#endif
drhaf6df112005-06-07 02:12:30 +00002066
2067/*
drh3f56e6e2007-03-15 01:16:47 +00002068** Open a temporary file.
2069**
2070** Write the file descriptor into *fd. Return SQLITE_OK on success or some
danielk1977fee2d252007-08-18 10:59:19 +00002071** other error code if we fail. The OS will automatically delete the temporary
2072** file when it is closed.
drhfa86c412002-02-02 15:01:15 +00002073*/
danielk1977b4b47412007-08-17 15:53:36 +00002074static int sqlite3PagerOpentemp(
drh33f4e022007-09-03 15:19:34 +00002075 sqlite3_vfs *pVfs, /* The virtual file system layer */
2076 sqlite3_file *pFile, /* Write the file descriptor here */
2077 char *zFilename, /* Name of the file. Might be NULL */
2078 int vfsFlags /* Flags passed through to the VFS */
danielk1977b4b47412007-08-17 15:53:36 +00002079){
drhfa86c412002-02-02 15:01:15 +00002080 int rc;
drh334b2992007-09-06 23:28:23 +00002081 assert( zFilename!=0 );
drh3f56e6e2007-03-15 01:16:47 +00002082
drh0f7eb612006-08-08 13:51:43 +00002083#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00002084 sqlite3_opentemp_count++; /* Used for testing and analysis only */
drh0f7eb612006-08-08 13:51:43 +00002085#endif
danielk1977b4b47412007-08-17 15:53:36 +00002086
drh33f4e022007-09-03 15:19:34 +00002087 vfsFlags |= SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE |
2088 SQLITE_OPEN_EXCLUSIVE | SQLITE_OPEN_DELETEONCLOSE;
2089 rc = sqlite3OsOpen(pVfs, zFilename, pFile, vfsFlags, 0);
drhae28c012007-08-24 16:29:23 +00002090 assert( rc!=SQLITE_OK || pFile->pMethods );
drhfa86c412002-02-02 15:01:15 +00002091 return rc;
2092}
2093
2094/*
drhed7c8552001-04-11 14:29:21 +00002095** Create a new page cache and put a pointer to the page cache in *ppPager.
drh5e00f6c2001-09-13 13:46:56 +00002096** The file to be cached need not exist. The file is not locked until
danielk19773b8a05f2007-03-19 17:44:26 +00002097** the first call to sqlite3PagerGet() and is only held open until the
2098** last page is released using sqlite3PagerUnref().
drh382c0242001-10-06 16:33:02 +00002099**
drh6446c4d2001-12-15 14:22:18 +00002100** If zFilename is NULL then a randomly-named temporary file is created
drh1cc8c442007-08-24 16:08:29 +00002101** and used as the file to be cached. The file will be deleted
drh6446c4d2001-12-15 14:22:18 +00002102** automatically when it is closed.
drh90f5ecb2004-07-22 01:19:35 +00002103**
2104** If zFilename is ":memory:" then all information is held in cache.
2105** It is never written to disk. This can be used to implement an
2106** in-memory database.
drhed7c8552001-04-11 14:29:21 +00002107*/
danielk19773b8a05f2007-03-19 17:44:26 +00002108int sqlite3PagerOpen(
drh86f8c192007-08-22 00:39:19 +00002109 sqlite3_vfs *pVfs, /* The virtual file system to use */
drh7e3b0a02001-04-28 16:52:40 +00002110 Pager **ppPager, /* Return the Pager structure here */
2111 const char *zFilename, /* Name of the database file to open */
drhda47d772002-12-02 04:25:19 +00002112 int nExtra, /* Extra bytes append to each in-memory page */
drh33f4e022007-09-03 15:19:34 +00002113 int flags, /* flags controlling this file */
2114 int vfsFlags /* flags passed through to sqlite3_vfs.xOpen() */
drh7e3b0a02001-04-28 16:52:40 +00002115){
danielk1977b4b47412007-08-17 15:53:36 +00002116 u8 *pPtr;
danielk1977aef0bf62005-12-30 16:28:01 +00002117 Pager *pPager = 0;
danielk1977cfe9a692004-06-16 12:00:29 +00002118 int rc = SQLITE_OK;
2119 int i;
danielk19778def5ea2004-06-16 10:39:52 +00002120 int tempFile = 0;
drhac69b052004-05-12 13:30:07 +00002121 int memDb = 0;
drh5e00f6c2001-09-13 13:46:56 +00002122 int readOnly = 0;
drh7bec5052005-02-06 02:45:41 +00002123 int useJournal = (flags & PAGER_OMIT_JOURNAL)==0;
2124 int noReadlock = (flags & PAGER_NO_READLOCK)!=0;
danielk1977c7b60172007-08-22 11:22:03 +00002125 int journalFileSize = sqlite3JournalSize(pVfs);
drh1cc8c442007-08-24 16:08:29 +00002126 int nDefaultPage = SQLITE_DEFAULT_PAGE_SIZE;
2127 char *zPathname;
2128 int nPathname;
drh99b90c32008-03-17 13:50:58 +00002129 char *zStmtJrnl;
2130 int nStmtJrnl;
danielk1977b4b47412007-08-17 15:53:36 +00002131
drh86f8c192007-08-22 00:39:19 +00002132 /* The default return is a NULL pointer */
drhd9b02572001-04-15 00:37:09 +00002133 *ppPager = 0;
danielk1977aef0bf62005-12-30 16:28:01 +00002134
drh1cc8c442007-08-24 16:08:29 +00002135 /* Compute the full pathname */
danielk1977adfb9b02007-09-17 07:02:56 +00002136 nPathname = pVfs->mxPathname+1;
drh99b90c32008-03-17 13:50:58 +00002137 zPathname = sqlite3_malloc(nPathname*2);
drh1cc8c442007-08-24 16:08:29 +00002138 if( zPathname==0 ){
2139 return SQLITE_NOMEM;
2140 }
2141 if( zFilename && zFilename[0] ){
2142#ifndef SQLITE_OMIT_MEMORYDB
2143 if( strcmp(zFilename,":memory:")==0 ){
2144 memDb = 1;
2145 zPathname[0] = 0;
2146 }else
2147#endif
2148 {
danielk1977adfb9b02007-09-17 07:02:56 +00002149 rc = sqlite3OsFullPathname(pVfs, zFilename, nPathname, zPathname);
drh1cc8c442007-08-24 16:08:29 +00002150 }
2151 }else{
danielk1977adfb9b02007-09-17 07:02:56 +00002152 rc = sqlite3OsGetTempname(pVfs, nPathname, zPathname);
drhae28c012007-08-24 16:29:23 +00002153 }
2154 if( rc!=SQLITE_OK ){
2155 sqlite3_free(zPathname);
2156 return rc;
drh1cc8c442007-08-24 16:08:29 +00002157 }
2158 nPathname = strlen(zPathname);
2159
drh99b90c32008-03-17 13:50:58 +00002160 /* Put the statement journal in temporary disk space since this is
2161 ** sometimes RAM disk or other optimized storage. Unlikely the main
2162 ** main journal file, the statement journal does not need to be
2163 ** colocated with the database nor does it need to be persistent.
2164 */
2165 zStmtJrnl = &zPathname[nPathname+1];
2166 rc = sqlite3OsGetTempname(pVfs, pVfs->mxPathname+1, zStmtJrnl);
2167 if( rc!=SQLITE_OK ){
2168 sqlite3_free(zPathname);
2169 return rc;
2170 }
2171 nStmtJrnl = strlen(zStmtJrnl);
2172
danielk1977b4b47412007-08-17 15:53:36 +00002173 /* Allocate memory for the pager structure */
2174 pPager = sqlite3MallocZero(
2175 sizeof(*pPager) + /* Pager structure */
danielk1977c7b60172007-08-22 11:22:03 +00002176 journalFileSize + /* The journal file structure */
drh17c0ba22008-02-26 18:40:11 +00002177 pVfs->szOsFile * 3 + /* The main db and two journal files */
drh99b90c32008-03-17 13:50:58 +00002178 3*nPathname + 40 + /* zFilename, zDirectory, zJournal */
2179 nStmtJrnl /* zStmtJrnl */
danielk1977b4b47412007-08-17 15:53:36 +00002180 );
2181 if( !pPager ){
drh1cc8c442007-08-24 16:08:29 +00002182 sqlite3_free(zPathname);
danielk1977b4b47412007-08-17 15:53:36 +00002183 return SQLITE_NOMEM;
2184 }
2185 pPtr = (u8 *)&pPager[1];
drh33f4e022007-09-03 15:19:34 +00002186 pPager->vfsFlags = vfsFlags;
danielk1977b4b47412007-08-17 15:53:36 +00002187 pPager->fd = (sqlite3_file*)&pPtr[pVfs->szOsFile*0];
danielk1977c7b60172007-08-22 11:22:03 +00002188 pPager->stfd = (sqlite3_file*)&pPtr[pVfs->szOsFile*1];
2189 pPager->jfd = (sqlite3_file*)&pPtr[pVfs->szOsFile*2];
2190 pPager->zFilename = (char*)&pPtr[pVfs->szOsFile*2+journalFileSize];
drh1cc8c442007-08-24 16:08:29 +00002191 pPager->zDirectory = &pPager->zFilename[nPathname+1];
2192 pPager->zJournal = &pPager->zDirectory[nPathname+1];
drh334b2992007-09-06 23:28:23 +00002193 pPager->zStmtJrnl = &pPager->zJournal[nPathname+10];
danielk1977b4b47412007-08-17 15:53:36 +00002194 pPager->pVfs = pVfs;
drh1cc8c442007-08-24 16:08:29 +00002195 memcpy(pPager->zFilename, zPathname, nPathname+1);
drh99b90c32008-03-17 13:50:58 +00002196 memcpy(pPager->zStmtJrnl, zStmtJrnl, nStmtJrnl+1);
drh1cc8c442007-08-24 16:08:29 +00002197 sqlite3_free(zPathname);
danielk1977b4b47412007-08-17 15:53:36 +00002198
drh153c62c2007-08-24 03:51:33 +00002199 /* Open the pager file.
danielk1977aef0bf62005-12-30 16:28:01 +00002200 */
drhae28c012007-08-24 16:29:23 +00002201 if( zFilename && zFilename[0] && !memDb ){
drh1cc8c442007-08-24 16:08:29 +00002202 if( nPathname>(pVfs->mxPathname - sizeof("-journal")) ){
2203 rc = SQLITE_CANTOPEN;
2204 }else{
drh1cc8c442007-08-24 16:08:29 +00002205 int fout = 0;
drh33f4e022007-09-03 15:19:34 +00002206 rc = sqlite3OsOpen(pVfs, pPager->zFilename, pPager->fd,
2207 pPager->vfsFlags, &fout);
drh1cc8c442007-08-24 16:08:29 +00002208 readOnly = (fout&SQLITE_OPEN_READONLY);
2209
2210 /* If the file was successfully opened for read/write access,
2211 ** choose a default page size in case we have to create the
2212 ** database file. The default page size is the maximum of:
2213 **
2214 ** + SQLITE_DEFAULT_PAGE_SIZE,
2215 ** + The value returned by sqlite3OsSectorSize()
2216 ** + The largest page size that can be written atomically.
2217 */
2218 if( rc==SQLITE_OK && !readOnly ){
2219 int iSectorSize = sqlite3OsSectorSize(pPager->fd);
2220 if( nDefaultPage<iSectorSize ){
2221 nDefaultPage = iSectorSize;
2222 }
danielk19779663b8f2007-08-24 11:52:28 +00002223#ifdef SQLITE_ENABLE_ATOMIC_WRITE
drh1cc8c442007-08-24 16:08:29 +00002224 {
2225 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
2226 int ii;
2227 assert(SQLITE_IOCAP_ATOMIC512==(512>>8));
2228 assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8));
2229 assert(SQLITE_MAX_DEFAULT_PAGE_SIZE<=65536);
2230 for(ii=nDefaultPage; ii<=SQLITE_MAX_DEFAULT_PAGE_SIZE; ii=ii*2){
2231 if( iDc&(SQLITE_IOCAP_ATOMIC|(ii>>8)) ) nDefaultPage = ii;
danielk19779663b8f2007-08-24 11:52:28 +00002232 }
danielk1977b4b47412007-08-17 15:53:36 +00002233 }
drh1cc8c442007-08-24 16:08:29 +00002234#endif
2235 if( nDefaultPage>SQLITE_MAX_DEFAULT_PAGE_SIZE ){
2236 nDefaultPage = SQLITE_MAX_DEFAULT_PAGE_SIZE;
2237 }
danielk19778def5ea2004-06-16 10:39:52 +00002238 }
drhac69b052004-05-12 13:30:07 +00002239 }
drh1cc8c442007-08-24 16:08:29 +00002240 }else if( !memDb ){
danielk19777a2b1ee2007-08-21 14:27:01 +00002241 /* If a temporary file is requested, it is not opened immediately.
2242 ** In this case we accept the default page size and delay actually
2243 ** opening the file until the first call to OsWrite().
2244 */
danielk19777a2b1ee2007-08-21 14:27:01 +00002245 tempFile = 1;
2246 pPager->state = PAGER_EXCLUSIVE;
drh5e00f6c2001-09-13 13:46:56 +00002247 }
danielk1977aef0bf62005-12-30 16:28:01 +00002248
danielk1977b4b47412007-08-17 15:53:36 +00002249 if( pPager && rc==SQLITE_OK ){
danielk19779663b8f2007-08-24 11:52:28 +00002250 pPager->pTmpSpace = (char *)sqlite3_malloc(nDefaultPage);
drh3e7a6092002-12-07 21:45:14 +00002251 }
danielk1977aef0bf62005-12-30 16:28:01 +00002252
drh153c62c2007-08-24 03:51:33 +00002253 /* If an error occured in either of the blocks above.
2254 ** Free the Pager structure and close the file.
2255 ** Since the pager is not allocated there is no need to set
danielk1977aef0bf62005-12-30 16:28:01 +00002256 ** any Pager.errMask variables.
2257 */
danielk1977b4b47412007-08-17 15:53:36 +00002258 if( !pPager || !pPager->pTmpSpace ){
2259 sqlite3OsClose(pPager->fd);
drh17435752007-08-16 04:30:38 +00002260 sqlite3_free(pPager);
danielk1977aef0bf62005-12-30 16:28:01 +00002261 return ((rc==SQLITE_OK)?SQLITE_NOMEM:rc);
drhed7c8552001-04-11 14:29:21 +00002262 }
danielk1977aef0bf62005-12-30 16:28:01 +00002263
drh153c62c2007-08-24 03:51:33 +00002264 PAGERTRACE3("OPEN %d %s\n", FILEHANDLEID(pPager->fd), pPager->zFilename);
2265 IOTRACE(("OPEN %p %s\n", pPager, pPager->zFilename))
danielk1977aef0bf62005-12-30 16:28:01 +00002266
danielk1977b4b47412007-08-17 15:53:36 +00002267 /* Fill in Pager.zDirectory[] */
drh1cc8c442007-08-24 16:08:29 +00002268 memcpy(pPager->zDirectory, pPager->zFilename, nPathname+1);
danielk1977b4b47412007-08-17 15:53:36 +00002269 for(i=strlen(pPager->zDirectory); i>0 && pPager->zDirectory[i-1]!='/'; i--){}
drha76c82e2003-07-27 18:59:42 +00002270 if( i>0 ) pPager->zDirectory[i-1] = 0;
danielk1977b4b47412007-08-17 15:53:36 +00002271
drh99b90c32008-03-17 13:50:58 +00002272 /* Fill in Pager.zJournal[] */
drh1cc8c442007-08-24 16:08:29 +00002273 memcpy(pPager->zJournal, pPager->zFilename, nPathname);
2274 memcpy(&pPager->zJournal[nPathname], "-journal", 9);
danielk1977b4b47412007-08-17 15:53:36 +00002275
drh3b59a5c2006-01-15 20:28:28 +00002276 /* pPager->journalOpen = 0; */
drhac69b052004-05-12 13:30:07 +00002277 pPager->useJournal = useJournal && !memDb;
drh7bec5052005-02-06 02:45:41 +00002278 pPager->noReadlock = noReadlock && readOnly;
drh3b59a5c2006-01-15 20:28:28 +00002279 /* pPager->stmtOpen = 0; */
2280 /* pPager->stmtInUse = 0; */
2281 /* pPager->nRef = 0; */
drhac69b052004-05-12 13:30:07 +00002282 pPager->dbSize = memDb-1;
danielk19779663b8f2007-08-24 11:52:28 +00002283 pPager->pageSize = nDefaultPage;
drh3b59a5c2006-01-15 20:28:28 +00002284 /* pPager->stmtSize = 0; */
2285 /* pPager->stmtJSize = 0; */
2286 /* pPager->nPage = 0; */
drh90f5ecb2004-07-22 01:19:35 +00002287 pPager->mxPage = 100;
drhf8e632b2007-05-08 14:51:36 +00002288 pPager->mxPgno = SQLITE_MAX_PAGE_COUNT;
drh3b59a5c2006-01-15 20:28:28 +00002289 /* pPager->state = PAGER_UNLOCK; */
drh1cc8c442007-08-24 16:08:29 +00002290 assert( pPager->state == (tempFile ? PAGER_EXCLUSIVE : PAGER_UNLOCK) );
drh3b59a5c2006-01-15 20:28:28 +00002291 /* pPager->errMask = 0; */
drh5e00f6c2001-09-13 13:46:56 +00002292 pPager->tempFile = tempFile;
drh369339d2007-03-30 16:01:55 +00002293 assert( tempFile==PAGER_LOCKINGMODE_NORMAL
2294 || tempFile==PAGER_LOCKINGMODE_EXCLUSIVE );
2295 assert( PAGER_LOCKINGMODE_EXCLUSIVE==1 );
2296 pPager->exclusiveMode = tempFile;
drhac69b052004-05-12 13:30:07 +00002297 pPager->memDb = memDb;
drh5e00f6c2001-09-13 13:46:56 +00002298 pPager->readOnly = readOnly;
drh3b59a5c2006-01-15 20:28:28 +00002299 /* pPager->needSync = 0; */
drhda47d772002-12-02 04:25:19 +00002300 pPager->noSync = pPager->tempFile || !useJournal;
danielk197775edc162004-06-26 01:48:18 +00002301 pPager->fullSync = (pPager->noSync?0:1);
danielk1977f036aef2007-08-20 05:36:51 +00002302 pPager->sync_flags = SQLITE_SYNC_NORMAL;
drh3b59a5c2006-01-15 20:28:28 +00002303 /* pPager->pFirst = 0; */
2304 /* pPager->pFirstSynced = 0; */
2305 /* pPager->pLast = 0; */
drh887dc4c2004-10-22 16:22:57 +00002306 pPager->nExtra = FORCE_ALIGNMENT(nExtra);
danielk19777a2b1ee2007-08-21 14:27:01 +00002307 assert(pPager->fd->pMethods||memDb||tempFile);
danielk1977b4721172007-03-19 05:54:48 +00002308 if( !memDb ){
drhc80f0582007-05-01 16:59:48 +00002309 setSectorSize(pPager);
danielk1977b4721172007-03-19 05:54:48 +00002310 }
drh3b59a5c2006-01-15 20:28:28 +00002311 /* pPager->pBusyHandler = 0; */
2312 /* memset(pPager->aHash, 0, sizeof(pPager->aHash)); */
drhed7c8552001-04-11 14:29:21 +00002313 *ppPager = pPager;
drh6f7adc82006-01-11 21:41:20 +00002314#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
drh86f8c192007-08-22 00:39:19 +00002315 pPager->iInUseMM = 0;
2316 pPager->iInUseDB = 0;
2317 if( !memDb ){
2318 sqlite3_mutex *mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MEM2);
2319 sqlite3_mutex_enter(mutex);
2320 pPager->pNext = sqlite3PagerList;
2321 if( sqlite3PagerList ){
2322 assert( sqlite3PagerList->pPrev==0 );
2323 sqlite3PagerList->pPrev = pPager;
2324 }
2325 pPager->pPrev = 0;
2326 sqlite3PagerList = pPager;
2327 sqlite3_mutex_leave(mutex);
2328 }
danielk197752622822006-01-09 09:59:49 +00002329#endif
drhed7c8552001-04-11 14:29:21 +00002330 return SQLITE_OK;
2331}
2332
2333/*
drh90f5ecb2004-07-22 01:19:35 +00002334** Set the busy handler function.
2335*/
danielk19773b8a05f2007-03-19 17:44:26 +00002336void sqlite3PagerSetBusyhandler(Pager *pPager, BusyHandler *pBusyHandler){
drh90f5ecb2004-07-22 01:19:35 +00002337 pPager->pBusyHandler = pBusyHandler;
2338}
2339
2340/*
drh72f82862001-05-24 21:06:34 +00002341** Set the destructor for this pager. If not NULL, the destructor is called
drh5e00f6c2001-09-13 13:46:56 +00002342** when the reference count on each page reaches zero. The destructor can
2343** be used to clean up information in the extra segment appended to each page.
drh72f82862001-05-24 21:06:34 +00002344**
danielk19773b8a05f2007-03-19 17:44:26 +00002345** The destructor is not called as a result sqlite3PagerClose().
2346** Destructors are only called by sqlite3PagerUnref().
drh72f82862001-05-24 21:06:34 +00002347*/
danielk19773b8a05f2007-03-19 17:44:26 +00002348void sqlite3PagerSetDestructor(Pager *pPager, void (*xDesc)(DbPage*,int)){
drh72f82862001-05-24 21:06:34 +00002349 pPager->xDestructor = xDesc;
2350}
2351
2352/*
drha6abd042004-06-09 17:37:22 +00002353** Set the reinitializer for this pager. If not NULL, the reinitializer
2354** is called when the content of a page in cache is restored to its original
2355** value as a result of a rollback. The callback gives higher-level code
2356** an opportunity to restore the EXTRA section to agree with the restored
2357** page data.
2358*/
danielk19773b8a05f2007-03-19 17:44:26 +00002359void sqlite3PagerSetReiniter(Pager *pPager, void (*xReinit)(DbPage*,int)){
drha6abd042004-06-09 17:37:22 +00002360 pPager->xReiniter = xReinit;
2361}
2362
2363/*
danielk1977a1644fd2007-08-29 12:31:25 +00002364** Set the page size to *pPageSize. If the suggest new page size is
2365** inappropriate, then an alternative page size is set to that
2366** value before returning.
drh90f5ecb2004-07-22 01:19:35 +00002367*/
danielk1977a1644fd2007-08-29 12:31:25 +00002368int sqlite3PagerSetPagesize(Pager *pPager, u16 *pPageSize){
2369 int rc = SQLITE_OK;
2370 u16 pageSize = *pPageSize;
danielk19779663b8f2007-08-24 11:52:28 +00002371 assert( pageSize==0 || (pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE) );
danielk1977a1644fd2007-08-29 12:31:25 +00002372 if( pageSize && pageSize!=pPager->pageSize
2373 && !pPager->memDb && pPager->nRef==0
2374 ){
2375 char *pNew = (char *)sqlite3_malloc(pageSize);
2376 if( !pNew ){
2377 rc = SQLITE_NOMEM;
2378 }else{
2379 pagerEnter(pPager);
2380 pager_reset(pPager);
2381 pPager->pageSize = pageSize;
2382 setSectorSize(pPager);
2383 sqlite3_free(pPager->pTmpSpace);
2384 pPager->pTmpSpace = pNew;
2385 pagerLeave(pPager);
2386 }
drh1c7880e2005-05-20 20:01:55 +00002387 }
danielk1977a1644fd2007-08-29 12:31:25 +00002388 *pPageSize = pPager->pageSize;
2389 return rc;
drh90f5ecb2004-07-22 01:19:35 +00002390}
2391
2392/*
drh26b79942007-11-28 16:19:56 +00002393** Return a pointer to the "temporary page" buffer held internally
2394** by the pager. This is a buffer that is big enough to hold the
2395** entire content of a database page. This buffer is used internally
2396** during rollback and will be overwritten whenever a rollback
2397** occurs. But other modules are free to use it too, as long as
2398** no rollbacks are happening.
2399*/
2400void *sqlite3PagerTempSpace(Pager *pPager){
2401 return pPager->pTmpSpace;
2402}
2403
2404/*
drhf8e632b2007-05-08 14:51:36 +00002405** Attempt to set the maximum database page count if mxPage is positive.
2406** Make no changes if mxPage is zero or negative. And never reduce the
2407** maximum page count below the current size of the database.
2408**
2409** Regardless of mxPage, return the current maximum page count.
2410*/
2411int sqlite3PagerMaxPageCount(Pager *pPager, int mxPage){
2412 if( mxPage>0 ){
2413 pPager->mxPgno = mxPage;
2414 }
2415 sqlite3PagerPagecount(pPager);
2416 return pPager->mxPgno;
2417}
2418
2419/*
drhc9ac5ca2005-11-04 22:03:30 +00002420** The following set of routines are used to disable the simulated
2421** I/O error mechanism. These routines are used to avoid simulated
2422** errors in places where we do not care about errors.
2423**
2424** Unless -DSQLITE_TEST=1 is used, these routines are all no-ops
2425** and generate no code.
2426*/
2427#ifdef SQLITE_TEST
2428extern int sqlite3_io_error_pending;
2429extern int sqlite3_io_error_hit;
2430static int saved_cnt;
drhc9ac5ca2005-11-04 22:03:30 +00002431void disable_simulated_io_errors(void){
2432 saved_cnt = sqlite3_io_error_pending;
2433 sqlite3_io_error_pending = -1;
2434}
2435void enable_simulated_io_errors(void){
2436 sqlite3_io_error_pending = saved_cnt;
2437}
2438#else
drh152410f2005-11-05 15:11:22 +00002439# define disable_simulated_io_errors()
2440# define enable_simulated_io_errors()
drhc9ac5ca2005-11-04 22:03:30 +00002441#endif
2442
2443/*
drh90f5ecb2004-07-22 01:19:35 +00002444** Read the first N bytes from the beginning of the file into memory
danielk1977aef0bf62005-12-30 16:28:01 +00002445** that pDest points to.
2446**
2447** No error checking is done. The rational for this is that this function
2448** may be called even if the file does not exist or contain a header. In
2449** these cases sqlite3OsRead() will return an error, to which the correct
2450** response is to zero the memory at pDest and continue. A real IO error
2451** will presumably recur and be picked up later (Todo: Think about this).
drh90f5ecb2004-07-22 01:19:35 +00002452*/
danielk19773b8a05f2007-03-19 17:44:26 +00002453int sqlite3PagerReadFileheader(Pager *pPager, int N, unsigned char *pDest){
drh551b7732006-11-06 21:20:25 +00002454 int rc = SQLITE_OK;
drh90f5ecb2004-07-22 01:19:35 +00002455 memset(pDest, 0, N);
danielk19777a2b1ee2007-08-21 14:27:01 +00002456 assert(MEMDB||pPager->fd->pMethods||pPager->tempFile);
2457 if( pPager->fd->pMethods ){
drhb0603412007-02-28 04:47:26 +00002458 IOTRACE(("DBHDR %p 0 %d\n", pPager, N))
danielk197762079062007-08-15 17:08:46 +00002459 rc = sqlite3OsRead(pPager->fd, pDest, N, 0);
drh551b7732006-11-06 21:20:25 +00002460 if( rc==SQLITE_IOERR_SHORT_READ ){
2461 rc = SQLITE_OK;
2462 }
drh90f5ecb2004-07-22 01:19:35 +00002463 }
drh551b7732006-11-06 21:20:25 +00002464 return rc;
drh90f5ecb2004-07-22 01:19:35 +00002465}
2466
2467/*
drh5e00f6c2001-09-13 13:46:56 +00002468** Return the total number of pages in the disk file associated with
danielk197715f411d2005-09-16 10:18:45 +00002469** pPager.
2470**
2471** If the PENDING_BYTE lies on the page directly after the end of the
2472** file, then consider this page part of the file too. For example, if
2473** PENDING_BYTE is byte 4096 (the first byte of page 5) and the size of the
2474** file is 4096 bytes, 5 is returned instead of 4.
drhed7c8552001-04-11 14:29:21 +00002475*/
danielk19773b8a05f2007-03-19 17:44:26 +00002476int sqlite3PagerPagecount(Pager *pPager){
danielk19777a2b1ee2007-08-21 14:27:01 +00002477 i64 n = 0;
drhe49f9822006-09-15 12:29:16 +00002478 int rc;
drhd9b02572001-04-15 00:37:09 +00002479 assert( pPager!=0 );
drha7aea3d2007-03-15 12:51:16 +00002480 if( pPager->errCode ){
danielk197743468d92008-02-26 06:05:31 +00002481 return -1;
drha7aea3d2007-03-15 12:51:16 +00002482 }
drhed7c8552001-04-11 14:29:21 +00002483 if( pPager->dbSize>=0 ){
danielk197715f411d2005-09-16 10:18:45 +00002484 n = pPager->dbSize;
2485 } else {
danielk19777a2b1ee2007-08-21 14:27:01 +00002486 assert(pPager->fd->pMethods||pPager->tempFile);
2487 if( (pPager->fd->pMethods)
2488 && (rc = sqlite3OsFileSize(pPager->fd, &n))!=SQLITE_OK ){
danielk1977ae72d982007-10-03 08:46:44 +00002489 pPager->nRef++;
drhe49f9822006-09-15 12:29:16 +00002490 pager_error(pPager, rc);
danielk1977ae72d982007-10-03 08:46:44 +00002491 pPager->nRef--;
danielk197743468d92008-02-26 06:05:31 +00002492 return -1;
danielk197715f411d2005-09-16 10:18:45 +00002493 }
2494 if( n>0 && n<pPager->pageSize ){
2495 n = 1;
2496 }else{
2497 n /= pPager->pageSize;
2498 }
2499 if( pPager->state!=PAGER_UNLOCK ){
2500 pPager->dbSize = n;
2501 }
drhed7c8552001-04-11 14:29:21 +00002502 }
danielk197715f411d2005-09-16 10:18:45 +00002503 if( n==(PENDING_BYTE/pPager->pageSize) ){
drh1f595712004-06-15 01:40:29 +00002504 n++;
2505 }
drhf8e632b2007-05-08 14:51:36 +00002506 if( n>pPager->mxPgno ){
2507 pPager->mxPgno = n;
2508 }
drhed7c8552001-04-11 14:29:21 +00002509 return n;
2510}
2511
drhf07e7d52006-04-07 13:54:46 +00002512
2513#ifndef SQLITE_OMIT_MEMORYDB
2514/*
2515** Clear a PgHistory block
2516*/
2517static void clearHistory(PgHistory *pHist){
drh17435752007-08-16 04:30:38 +00002518 sqlite3_free(pHist->pOrig);
2519 sqlite3_free(pHist->pStmt);
drhf07e7d52006-04-07 13:54:46 +00002520 pHist->pOrig = 0;
2521 pHist->pStmt = 0;
2522}
2523#else
2524#define clearHistory(x)
2525#endif
2526
drhed7c8552001-04-11 14:29:21 +00002527/*
drhf7c57532003-04-25 13:22:51 +00002528** Forward declaration
2529*/
danielk197776572402004-06-25 02:38:54 +00002530static int syncJournal(Pager*);
drhac69b052004-05-12 13:30:07 +00002531
2532/*
drh85b623f2007-12-13 21:54:09 +00002533** Unlink pPg from its hash chain. Also set the page number to 0 to indicate
danielk1977f5fdda82004-11-03 08:44:05 +00002534** that the page is not part of any hash chain. This is required because the
danielk19773b8a05f2007-03-19 17:44:26 +00002535** sqlite3PagerMovepage() routine can leave a page in the
danielk1977f5fdda82004-11-03 08:44:05 +00002536** pNextFree/pPrevFree list that is not a part of any hash-chain.
2537*/
2538static void unlinkHashChain(Pager *pPager, PgHdr *pPg){
2539 if( pPg->pgno==0 ){
drh3765df42006-06-28 18:18:09 +00002540 assert( pPg->pNextHash==0 && pPg->pPrevHash==0 );
danielk1977f5fdda82004-11-03 08:44:05 +00002541 return;
2542 }
2543 if( pPg->pNextHash ){
2544 pPg->pNextHash->pPrevHash = pPg->pPrevHash;
2545 }
2546 if( pPg->pPrevHash ){
drh8ca0c722006-05-07 17:49:38 +00002547 assert( pPager->aHash[pPg->pgno & (pPager->nHash-1)]!=pPg );
danielk1977f5fdda82004-11-03 08:44:05 +00002548 pPg->pPrevHash->pNextHash = pPg->pNextHash;
2549 }else{
drh8ca0c722006-05-07 17:49:38 +00002550 int h = pPg->pgno & (pPager->nHash-1);
danielk1977f5fdda82004-11-03 08:44:05 +00002551 pPager->aHash[h] = pPg->pNextHash;
2552 }
drh5229ae42006-03-23 23:29:04 +00002553 if( MEMDB ){
drh5229ae42006-03-23 23:29:04 +00002554 clearHistory(PGHDR_TO_HIST(pPg, pPager));
2555 }
danielk1977f5fdda82004-11-03 08:44:05 +00002556 pPg->pgno = 0;
2557 pPg->pNextHash = pPg->pPrevHash = 0;
2558}
2559
2560/*
drhac69b052004-05-12 13:30:07 +00002561** Unlink a page from the free list (the list of all pages where nRef==0)
2562** and from its hash collision chain.
2563*/
2564static void unlinkPage(PgHdr *pPg){
2565 Pager *pPager = pPg->pPager;
2566
danielk19779f61c2f2007-08-27 17:27:49 +00002567 /* Unlink from free page list */
2568 lruListRemove(pPg);
drhac69b052004-05-12 13:30:07 +00002569
2570 /* Unlink from the pgno hash table */
danielk1977f5fdda82004-11-03 08:44:05 +00002571 unlinkHashChain(pPager, pPg);
drhac69b052004-05-12 13:30:07 +00002572}
2573
2574/*
danielk1977e180dd92007-04-05 17:15:52 +00002575** This routine is used to truncate the cache when a database
2576** is truncated. Drop from the cache all pages whose pgno is
2577** larger than pPager->dbSize and is unreferenced.
2578**
drhac69b052004-05-12 13:30:07 +00002579** Referenced pages larger than pPager->dbSize are zeroed.
danielk1977e180dd92007-04-05 17:15:52 +00002580**
2581** Actually, at the point this routine is called, it would be
2582** an error to have a referenced page. But rather than delete
2583** that page and guarantee a subsequent segfault, it seems better
2584** to zero it and hope that we error out sanely.
drhac69b052004-05-12 13:30:07 +00002585*/
danielk1977e180dd92007-04-05 17:15:52 +00002586static void pager_truncate_cache(Pager *pPager){
drhac69b052004-05-12 13:30:07 +00002587 PgHdr *pPg;
2588 PgHdr **ppPg;
2589 int dbSize = pPager->dbSize;
2590
2591 ppPg = &pPager->pAll;
2592 while( (pPg = *ppPg)!=0 ){
2593 if( pPg->pgno<=dbSize ){
2594 ppPg = &pPg->pNextAll;
2595 }else if( pPg->nRef>0 ){
2596 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
2597 ppPg = &pPg->pNextAll;
2598 }else{
2599 *ppPg = pPg->pNextAll;
drh538f5702007-04-13 02:14:30 +00002600 IOTRACE(("PGFREE %p %d\n", pPager, pPg->pgno));
2601 PAGER_INCR(sqlite3_pager_pgfree_count);
drhac69b052004-05-12 13:30:07 +00002602 unlinkPage(pPg);
drh605ad8f2006-05-03 23:34:05 +00002603 makeClean(pPg);
drh0d180202008-02-14 23:26:56 +00002604 sqlite3_free(pPg->pData);
drh17435752007-08-16 04:30:38 +00002605 sqlite3_free(pPg);
drhac69b052004-05-12 13:30:07 +00002606 pPager->nPage--;
2607 }
2608 }
2609}
2610
drhf7c57532003-04-25 13:22:51 +00002611/*
danielk197717221812005-02-15 03:38:05 +00002612** Try to obtain a lock on a file. Invoke the busy callback if the lock
drha4afb652005-07-09 02:16:02 +00002613** is currently not available. Repeat until the busy callback returns
danielk197717221812005-02-15 03:38:05 +00002614** false or until the lock succeeds.
2615**
2616** Return SQLITE_OK on success and an error code if we cannot obtain
2617** the lock.
2618*/
2619static int pager_wait_on_lock(Pager *pPager, int locktype){
2620 int rc;
drh1aa2d8b2007-01-03 15:34:29 +00002621
2622 /* The OS lock values must be the same as the Pager lock values */
danielk197717221812005-02-15 03:38:05 +00002623 assert( PAGER_SHARED==SHARED_LOCK );
2624 assert( PAGER_RESERVED==RESERVED_LOCK );
2625 assert( PAGER_EXCLUSIVE==EXCLUSIVE_LOCK );
drh1aa2d8b2007-01-03 15:34:29 +00002626
2627 /* If the file is currently unlocked then the size must be unknown */
2628 assert( pPager->state>=PAGER_SHARED || pPager->dbSize<0 || MEMDB );
2629
danielk197717221812005-02-15 03:38:05 +00002630 if( pPager->state>=locktype ){
2631 rc = SQLITE_OK;
2632 }else{
drhbefdf832008-03-14 19:33:05 +00002633 if( pPager->pBusyHandler ) pPager->pBusyHandler->nBusy = 0;
danielk197717221812005-02-15 03:38:05 +00002634 do {
drh054889e2005-11-30 03:20:31 +00002635 rc = sqlite3OsLock(pPager->fd, locktype);
drha4afb652005-07-09 02:16:02 +00002636 }while( rc==SQLITE_BUSY && sqlite3InvokeBusyHandler(pPager->pBusyHandler) );
danielk197717221812005-02-15 03:38:05 +00002637 if( rc==SQLITE_OK ){
2638 pPager->state = locktype;
drhb0603412007-02-28 04:47:26 +00002639 IOTRACE(("LOCK %p %d\n", pPager, locktype))
danielk197717221812005-02-15 03:38:05 +00002640 }
2641 }
2642 return rc;
2643}
2644
2645/*
drhf7c57532003-04-25 13:22:51 +00002646** Truncate the file to the number of pages specified.
2647*/
danielk19773b8a05f2007-03-19 17:44:26 +00002648int sqlite3PagerTruncate(Pager *pPager, Pgno nPage){
drhf7c57532003-04-25 13:22:51 +00002649 int rc;
drh1aa2d8b2007-01-03 15:34:29 +00002650 assert( pPager->state>=PAGER_SHARED || MEMDB );
danielk19773b8a05f2007-03-19 17:44:26 +00002651 sqlite3PagerPagecount(pPager);
danielk1977efaaf572006-01-16 11:29:19 +00002652 if( pPager->errCode ){
2653 rc = pPager->errCode;
drh2e6d11b2003-04-25 15:37:57 +00002654 return rc;
2655 }
drh7d02cb72003-06-04 16:24:39 +00002656 if( nPage>=(unsigned)pPager->dbSize ){
drhf7c57532003-04-25 13:22:51 +00002657 return SQLITE_OK;
2658 }
drhb7f91642004-10-31 02:22:47 +00002659 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00002660 pPager->dbSize = nPage;
danielk1977e180dd92007-04-05 17:15:52 +00002661 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00002662 return SQLITE_OK;
2663 }
drh86f8c192007-08-22 00:39:19 +00002664 pagerEnter(pPager);
danielk197776572402004-06-25 02:38:54 +00002665 rc = syncJournal(pPager);
drh86f8c192007-08-22 00:39:19 +00002666 pagerLeave(pPager);
danielk1977369f27e2004-06-15 11:40:04 +00002667 if( rc!=SQLITE_OK ){
2668 return rc;
2669 }
danielk197717221812005-02-15 03:38:05 +00002670
2671 /* Get an exclusive lock on the database before truncating. */
drh86f8c192007-08-22 00:39:19 +00002672 pagerEnter(pPager);
danielk197717221812005-02-15 03:38:05 +00002673 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
drh86f8c192007-08-22 00:39:19 +00002674 pagerLeave(pPager);
danielk197717221812005-02-15 03:38:05 +00002675 if( rc!=SQLITE_OK ){
2676 return rc;
2677 }
2678
drhcb4c40b2004-08-18 19:09:43 +00002679 rc = pager_truncate(pPager, nPage);
drhf7c57532003-04-25 13:22:51 +00002680 return rc;
2681}
2682
2683/*
drhed7c8552001-04-11 14:29:21 +00002684** Shutdown the page cache. Free all memory and close all files.
2685**
2686** If a transaction was in progress when this routine is called, that
2687** transaction is rolled back. All outstanding pages are invalidated
2688** and their memory is freed. Any attempt to use a page associated
2689** with this page cache after this function returns will likely
2690** result in a coredump.
danielk1977aef0bf62005-12-30 16:28:01 +00002691**
2692** This function always succeeds. If a transaction is active an attempt
2693** is made to roll it back. If an error occurs during the rollback
2694** a hot journal may be left in the filesystem but no error is returned
2695** to the caller.
drhed7c8552001-04-11 14:29:21 +00002696*/
danielk19773b8a05f2007-03-19 17:44:26 +00002697int sqlite3PagerClose(Pager *pPager){
drh6f7adc82006-01-11 21:41:20 +00002698#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
drh86f8c192007-08-22 00:39:19 +00002699 if( !MEMDB ){
2700 sqlite3_mutex *mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MEM2);
2701 sqlite3_mutex_enter(mutex);
2702 if( pPager->pPrev ){
2703 pPager->pPrev->pNext = pPager->pNext;
2704 }else{
2705 sqlite3PagerList = pPager->pNext;
2706 }
2707 if( pPager->pNext ){
2708 pPager->pNext->pPrev = pPager->pPrev;
2709 }
2710 sqlite3_mutex_leave(mutex);
2711 }
danielk197713f72992005-12-18 08:51:22 +00002712#endif
2713
drhbafda092007-01-03 23:36:22 +00002714 disable_simulated_io_errors();
drhc2ee76c2007-01-04 14:58:14 +00002715 pPager->errCode = 0;
danielk197741483462007-03-24 16:45:04 +00002716 pPager->exclusiveMode = 0;
drhbafda092007-01-03 23:36:22 +00002717 pager_reset(pPager);
danielk1977e277be02007-03-23 18:12:06 +00002718 pagerUnlockAndRollback(pPager);
drhbafda092007-01-03 23:36:22 +00002719 enable_simulated_io_errors();
drh4f0c5872007-03-26 22:05:01 +00002720 PAGERTRACE2("CLOSE %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002721 IOTRACE(("CLOSE %p\n", pPager))
danielk1977e94ddc92005-03-21 03:53:38 +00002722 if( pPager->journalOpen ){
danielk1977b4b47412007-08-17 15:53:36 +00002723 sqlite3OsClose(pPager->jfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002724 }
drhf5e7bb52008-02-18 14:47:33 +00002725 sqlite3BitvecDestroy(pPager->pInJournal);
danielk1977e94ddc92005-03-21 03:53:38 +00002726 if( pPager->stmtOpen ){
danielk1977b4b47412007-08-17 15:53:36 +00002727 sqlite3OsClose(pPager->stfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002728 }
danielk1977b4b47412007-08-17 15:53:36 +00002729 sqlite3OsClose(pPager->fd);
drh0f892532002-05-30 12:27:03 +00002730 /* Temp files are automatically deleted by the OS
2731 ** if( pPager->tempFile ){
drh66560ad2006-01-06 14:32:19 +00002732 ** sqlite3OsDelete(pPager->zFilename);
drh0f892532002-05-30 12:27:03 +00002733 ** }
2734 */
danielk1977aca790a2005-01-13 11:07:52 +00002735
drh17435752007-08-16 04:30:38 +00002736 sqlite3_free(pPager->aHash);
2737 sqlite3_free(pPager->pTmpSpace);
2738 sqlite3_free(pPager);
drhed7c8552001-04-11 14:29:21 +00002739 return SQLITE_OK;
2740}
2741
drh87cc3b32007-05-08 21:45:27 +00002742#if !defined(NDEBUG) || defined(SQLITE_TEST)
drhed7c8552001-04-11 14:29:21 +00002743/*
drh5e00f6c2001-09-13 13:46:56 +00002744** Return the page number for the given page data.
drhed7c8552001-04-11 14:29:21 +00002745*/
danielk19773b8a05f2007-03-19 17:44:26 +00002746Pgno sqlite3PagerPagenumber(DbPage *p){
drhed7c8552001-04-11 14:29:21 +00002747 return p->pgno;
2748}
drh87cc3b32007-05-08 21:45:27 +00002749#endif
drhed7c8552001-04-11 14:29:21 +00002750
2751/*
drhc8629a12004-05-08 20:07:40 +00002752** The page_ref() function increments the reference count for a page.
2753** If the page is currently on the freelist (the reference count is zero) then
drh7e3b0a02001-04-28 16:52:40 +00002754** remove it from the freelist.
drhc8629a12004-05-08 20:07:40 +00002755**
2756** For non-test systems, page_ref() is a macro that calls _page_ref()
2757** online of the reference count is zero. For test systems, page_ref()
2758** is a real function so that we can set breakpoints and trace it.
drh7e3b0a02001-04-28 16:52:40 +00002759*/
drh836faa42003-01-11 13:30:57 +00002760static void _page_ref(PgHdr *pPg){
drh7e3b0a02001-04-28 16:52:40 +00002761 if( pPg->nRef==0 ){
2762 /* The page is currently on the freelist. Remove it. */
danielk19779f61c2f2007-08-27 17:27:49 +00002763 lruListRemove(pPg);
drh7e3b0a02001-04-28 16:52:40 +00002764 pPg->pPager->nRef++;
2765 }
2766 pPg->nRef++;
drhdf0b3b02001-06-23 11:36:20 +00002767}
danielk1977aca790a2005-01-13 11:07:52 +00002768#ifdef SQLITE_DEBUG
drhc8629a12004-05-08 20:07:40 +00002769 static void page_ref(PgHdr *pPg){
2770 if( pPg->nRef==0 ){
2771 _page_ref(pPg);
2772 }else{
2773 pPg->nRef++;
drhc8629a12004-05-08 20:07:40 +00002774 }
2775 }
2776#else
2777# define page_ref(P) ((P)->nRef==0?_page_ref(P):(void)(P)->nRef++)
2778#endif
drhdf0b3b02001-06-23 11:36:20 +00002779
2780/*
2781** Increment the reference count for a page. The input pointer is
2782** a reference to the page data.
2783*/
danielk19773b8a05f2007-03-19 17:44:26 +00002784int sqlite3PagerRef(DbPage *pPg){
drh86f8c192007-08-22 00:39:19 +00002785 pagerEnter(pPg->pPager);
drhdf0b3b02001-06-23 11:36:20 +00002786 page_ref(pPg);
drh86f8c192007-08-22 00:39:19 +00002787 pagerLeave(pPg->pPager);
drh8c42ca92001-06-22 19:15:00 +00002788 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +00002789}
2790
2791/*
drh34e79ce2004-02-08 06:05:46 +00002792** Sync the journal. In other words, make sure all the pages that have
2793** been written to the journal have actually reached the surface of the
2794** disk. It is not safe to modify the original database file until after
2795** the journal has been synced. If the original database is modified before
2796** the journal is synced and a power failure occurs, the unsynced journal
2797** data would be lost and we would be unable to completely rollback the
2798** database changes. Database corruption would occur.
2799**
2800** This routine also updates the nRec field in the header of the journal.
2801** (See comments on the pager_playback() routine for additional information.)
2802** If the sync mode is FULL, two syncs will occur. First the whole journal
2803** is synced, then the nRec field is updated, then a second sync occurs.
drhb19a2bc2001-09-16 00:13:26 +00002804**
drh34e79ce2004-02-08 06:05:46 +00002805** For temporary databases, we do not care if we are able to rollback
danielk19774cd2cd52007-08-23 14:48:23 +00002806** after a power failure, so no sync occurs.
2807**
2808** If the IOCAP_SEQUENTIAL flag is set for the persistent media on which
2809** the database is stored, then OsSync() is never called on the journal
2810** file. In this case all that is required is to update the nRec field in
2811** the journal header.
drhfa86c412002-02-02 15:01:15 +00002812**
drh34e79ce2004-02-08 06:05:46 +00002813** This routine clears the needSync field of every page current held in
2814** memory.
drh50e5dad2001-09-15 00:57:28 +00002815*/
danielk197776572402004-06-25 02:38:54 +00002816static int syncJournal(Pager *pPager){
drh50e5dad2001-09-15 00:57:28 +00002817 PgHdr *pPg;
2818 int rc = SQLITE_OK;
drh03eb96a2002-11-10 23:32:56 +00002819
danielk19774cd2cd52007-08-23 14:48:23 +00002820
drh03eb96a2002-11-10 23:32:56 +00002821 /* Sync the journal before modifying the main database
2822 ** (assuming there is a journal and it needs to be synced.)
2823 */
danielk197776572402004-06-25 02:38:54 +00002824 if( pPager->needSync ){
drhfa86c412002-02-02 15:01:15 +00002825 if( !pPager->tempFile ){
danielk19774cd2cd52007-08-23 14:48:23 +00002826 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
drhdb48ee02003-01-16 13:42:43 +00002827 assert( pPager->journalOpen );
danielk19774cd2cd52007-08-23 14:48:23 +00002828
danielk19774cd2cd52007-08-23 14:48:23 +00002829 if( 0==(iDc&SQLITE_IOCAP_SAFE_APPEND) ){
danielk197776572402004-06-25 02:38:54 +00002830 /* Write the nRec value into the journal file header. If in
2831 ** full-synchronous mode, sync the journal first. This ensures that
2832 ** all data has really hit the disk before nRec is updated to mark
danielk19774cd2cd52007-08-23 14:48:23 +00002833 ** it as a candidate for rollback.
2834 **
2835 ** This is not required if the persistent media supports the
2836 ** SAFE_APPEND property. Because in this case it is not possible
2837 ** for garbage data to be appended to the file, the nRec field
2838 ** is populated with 0xFFFFFFFF when the journal header is written
2839 ** and never needs to be updated.
danielk197776572402004-06-25 02:38:54 +00002840 */
danielk19774cd2cd52007-08-23 14:48:23 +00002841 i64 jrnlOff;
2842 if( pPager->fullSync && 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
drh4f0c5872007-03-26 22:05:01 +00002843 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002844 IOTRACE(("JSYNC %p\n", pPager))
danielk1977f036aef2007-08-20 05:36:51 +00002845 rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags);
drhd8d66e82003-02-12 02:10:15 +00002846 if( rc!=0 ) return rc;
2847 }
danielk197713adf8a2004-06-03 16:08:41 +00002848
danielk197762079062007-08-15 17:08:46 +00002849 jrnlOff = pPager->journalHdr + sizeof(aJournalMagic);
2850 IOTRACE(("JHDR %p %lld %d\n", pPager, jrnlOff, 4));
2851 rc = write32bits(pPager->jfd, jrnlOff, pPager->nRec);
drhb4746b92005-09-09 01:32:06 +00002852 if( rc ) return rc;
drh968af522003-02-11 14:55:40 +00002853 }
danielk19774cd2cd52007-08-23 14:48:23 +00002854 if( 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
2855 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
2856 IOTRACE(("JSYNC %p\n", pPager))
2857 rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags|
2858 (pPager->sync_flags==SQLITE_SYNC_FULL?SQLITE_SYNC_DATAONLY:0)
2859 );
2860 if( rc!=0 ) return rc;
2861 }
drhdb48ee02003-01-16 13:42:43 +00002862 pPager->journalStarted = 1;
drhfa86c412002-02-02 15:01:15 +00002863 }
drh50e5dad2001-09-15 00:57:28 +00002864 pPager->needSync = 0;
drh341eae82003-01-21 02:39:36 +00002865
2866 /* Erase the needSync flag from every page.
2867 */
2868 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2869 pPg->needSync = 0;
2870 }
danielk19779f61c2f2007-08-27 17:27:49 +00002871 lruListSetFirstSynced(pPager);
drh50e5dad2001-09-15 00:57:28 +00002872 }
drh03eb96a2002-11-10 23:32:56 +00002873
drh341eae82003-01-21 02:39:36 +00002874#ifndef NDEBUG
2875 /* If the Pager.needSync flag is clear then the PgHdr.needSync
2876 ** flag must also be clear for all pages. Verify that this
2877 ** invariant is true.
drh03eb96a2002-11-10 23:32:56 +00002878 */
drh341eae82003-01-21 02:39:36 +00002879 else{
2880 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2881 assert( pPg->needSync==0 );
2882 }
danielk19779f61c2f2007-08-27 17:27:49 +00002883 assert( pPager->lru.pFirstSynced==pPager->lru.pFirst );
drh03eb96a2002-11-10 23:32:56 +00002884 }
drh341eae82003-01-21 02:39:36 +00002885#endif
drhdb48ee02003-01-16 13:42:43 +00002886
drh81a20f22001-10-12 17:30:04 +00002887 return rc;
drh50e5dad2001-09-15 00:57:28 +00002888}
2889
2890/*
drhdc3e10b2006-06-15 14:31:06 +00002891** Merge two lists of pages connected by pDirty and in pgno order.
2892** Do not both fixing the pPrevDirty pointers.
2893*/
2894static PgHdr *merge_pagelist(PgHdr *pA, PgHdr *pB){
2895 PgHdr result, *pTail;
2896 pTail = &result;
2897 while( pA && pB ){
2898 if( pA->pgno<pB->pgno ){
2899 pTail->pDirty = pA;
2900 pTail = pA;
2901 pA = pA->pDirty;
2902 }else{
2903 pTail->pDirty = pB;
2904 pTail = pB;
2905 pB = pB->pDirty;
2906 }
2907 }
2908 if( pA ){
2909 pTail->pDirty = pA;
2910 }else if( pB ){
2911 pTail->pDirty = pB;
2912 }else{
2913 pTail->pDirty = 0;
2914 }
2915 return result.pDirty;
2916}
2917
2918/*
2919** Sort the list of pages in accending order by pgno. Pages are
2920** connected by pDirty pointers. The pPrevDirty pointers are
2921** corrupted by this sort.
2922*/
danielk197724168722007-04-02 05:07:47 +00002923#define N_SORT_BUCKET_ALLOC 25
2924#define N_SORT_BUCKET 25
2925#ifdef SQLITE_TEST
2926 int sqlite3_pager_n_sort_bucket = 0;
2927 #undef N_SORT_BUCKET
2928 #define N_SORT_BUCKET \
2929 (sqlite3_pager_n_sort_bucket?sqlite3_pager_n_sort_bucket:N_SORT_BUCKET_ALLOC)
2930#endif
drhdc3e10b2006-06-15 14:31:06 +00002931static PgHdr *sort_pagelist(PgHdr *pIn){
danielk197724168722007-04-02 05:07:47 +00002932 PgHdr *a[N_SORT_BUCKET_ALLOC], *p;
drhdc3e10b2006-06-15 14:31:06 +00002933 int i;
2934 memset(a, 0, sizeof(a));
2935 while( pIn ){
2936 p = pIn;
2937 pIn = p->pDirty;
2938 p->pDirty = 0;
2939 for(i=0; i<N_SORT_BUCKET-1; i++){
2940 if( a[i]==0 ){
2941 a[i] = p;
2942 break;
2943 }else{
2944 p = merge_pagelist(a[i], p);
2945 a[i] = 0;
2946 }
2947 }
2948 if( i==N_SORT_BUCKET-1 ){
danielk197724168722007-04-02 05:07:47 +00002949 /* Coverage: To get here, there need to be 2^(N_SORT_BUCKET)
2950 ** elements in the input list. This is possible, but impractical.
2951 ** Testing this line is the point of global variable
2952 ** sqlite3_pager_n_sort_bucket.
2953 */
drhdc3e10b2006-06-15 14:31:06 +00002954 a[i] = merge_pagelist(a[i], p);
2955 }
2956 }
2957 p = a[0];
2958 for(i=1; i<N_SORT_BUCKET; i++){
2959 p = merge_pagelist(p, a[i]);
2960 }
2961 return p;
2962}
2963
2964/*
drh2554f8b2003-01-22 01:26:44 +00002965** Given a list of pages (connected by the PgHdr.pDirty pointer) write
2966** every one of those pages out to the database file and mark them all
2967** as clean.
2968*/
2969static int pager_write_pagelist(PgHdr *pList){
2970 Pager *pPager;
drh153c62c2007-08-24 03:51:33 +00002971 PgHdr *p;
drh2554f8b2003-01-22 01:26:44 +00002972 int rc;
2973
2974 if( pList==0 ) return SQLITE_OK;
2975 pPager = pList->pPager;
danielk19779eed5052004-06-04 10:38:30 +00002976
2977 /* At this point there may be either a RESERVED or EXCLUSIVE lock on the
2978 ** database file. If there is already an EXCLUSIVE lock, the following
drh054889e2005-11-30 03:20:31 +00002979 ** calls to sqlite3OsLock() are no-ops.
danielk19779eed5052004-06-04 10:38:30 +00002980 **
drha6abd042004-06-09 17:37:22 +00002981 ** Moving the lock from RESERVED to EXCLUSIVE actually involves going
2982 ** through an intermediate state PENDING. A PENDING lock prevents new
2983 ** readers from attaching to the database but is unsufficient for us to
2984 ** write. The idea of a PENDING lock is to prevent new readers from
2985 ** coming in while we wait for existing readers to clear.
danielk19779eed5052004-06-04 10:38:30 +00002986 **
drha6abd042004-06-09 17:37:22 +00002987 ** While the pager is in the RESERVED state, the original database file
2988 ** is unchanged and we can rollback without having to playback the
2989 ** journal into the original database file. Once we transition to
2990 ** EXCLUSIVE, it means the database file has been changed and any rollback
2991 ** will require a journal playback.
danielk19779eed5052004-06-04 10:38:30 +00002992 */
drh684917c2004-10-05 02:41:42 +00002993 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
danielk19779eed5052004-06-04 10:38:30 +00002994 if( rc!=SQLITE_OK ){
2995 return rc;
2996 }
2997
drhdc3e10b2006-06-15 14:31:06 +00002998 pList = sort_pagelist(pList);
drh153c62c2007-08-24 03:51:33 +00002999 for(p=pList; p; p=p->pDirty){
3000 assert( p->dirty );
3001 p->dirty = 0;
3002 }
drh2554f8b2003-01-22 01:26:44 +00003003 while( pList ){
danielk19777a2b1ee2007-08-21 14:27:01 +00003004
3005 /* If the file has not yet been opened, open it now. */
3006 if( !pPager->fd->pMethods ){
3007 assert(pPager->tempFile);
drh33f4e022007-09-03 15:19:34 +00003008 rc = sqlite3PagerOpentemp(pPager->pVfs, pPager->fd, pPager->zFilename,
3009 pPager->vfsFlags);
danielk19777a2b1ee2007-08-21 14:27:01 +00003010 if( rc ) return rc;
3011 }
3012
danielk1977687566d2004-11-02 12:56:41 +00003013 /* If there are dirty pages in the page cache with page numbers greater
danielk19773b8a05f2007-03-19 17:44:26 +00003014 ** than Pager.dbSize, this means sqlite3PagerTruncate() was called to
danielk1977687566d2004-11-02 12:56:41 +00003015 ** make the file smaller (presumably by auto-vacuum code). Do not write
3016 ** any such pages to the file.
3017 */
3018 if( pList->pgno<=pPager->dbSize ){
danielk197762079062007-08-15 17:08:46 +00003019 i64 offset = (pList->pgno-1)*(i64)pPager->pageSize;
drhc001c582006-03-06 18:23:16 +00003020 char *pData = CODEC2(pPager, PGHDR_TO_DATA(pList), pList->pgno, 6);
drh477731b2007-06-16 03:06:27 +00003021 PAGERTRACE4("STORE %d page %d hash(%08x)\n",
3022 PAGERID(pPager), pList->pgno, pager_pagehash(pList));
drh538f5702007-04-13 02:14:30 +00003023 IOTRACE(("PGOUT %p %d\n", pPager, pList->pgno));
danielk197762079062007-08-15 17:08:46 +00003024 rc = sqlite3OsWrite(pPager->fd, pData, pPager->pageSize, offset);
drh538f5702007-04-13 02:14:30 +00003025 PAGER_INCR(sqlite3_pager_writedb_count);
3026 PAGER_INCR(pPager->nWrite);
drh86a88112007-04-16 15:02:19 +00003027 if( pList->pgno==1 ){
3028 memcpy(&pPager->dbFileVers, &pData[24], sizeof(pPager->dbFileVers));
3029 }
danielk1977687566d2004-11-02 12:56:41 +00003030 }
3031#ifndef NDEBUG
3032 else{
drh4f0c5872007-03-26 22:05:01 +00003033 PAGERTRACE3("NOSTORE %d page %d\n", PAGERID(pPager), pList->pgno);
danielk1977687566d2004-11-02 12:56:41 +00003034 }
3035#endif
drh2554f8b2003-01-22 01:26:44 +00003036 if( rc ) return rc;
danielk19773c407372005-02-15 02:54:14 +00003037#ifdef SQLITE_CHECK_PAGES
3038 pList->pageHash = pager_pagehash(pList);
3039#endif
drh2554f8b2003-01-22 01:26:44 +00003040 pList = pList->pDirty;
3041 }
3042 return SQLITE_OK;
3043}
3044
3045/*
3046** Collect every dirty page into a dirty list and
3047** return a pointer to the head of that list. All pages are
3048** collected even if they are still in use.
3049*/
3050static PgHdr *pager_get_all_dirty_pages(Pager *pPager){
drh8f2e9a12008-02-26 14:46:04 +00003051
3052#ifndef NDEBUG
3053 /* Verify the sanity of the dirty list when we are running
3054 ** in debugging mode. This is expensive, so do not
3055 ** do this on a normal build. */
3056 int n1 = 0;
3057 int n2 = 0;
3058 PgHdr *p;
3059 for(p=pPager->pAll; p; p=p->pNextAll){ if( p->dirty ) n1++; }
3060 for(p=pPager->pDirty; p; p=p->pDirty){ n2++; }
3061 assert( n1==n2 );
3062#endif
3063
drh605ad8f2006-05-03 23:34:05 +00003064 return pPager->pDirty;
drh2554f8b2003-01-22 01:26:44 +00003065}
3066
3067/*
drh19db9352008-03-27 22:42:51 +00003068** Return 1 if there is a hot journal on the given pager.
drh165ffe92005-03-15 17:09:30 +00003069** A hot journal is one that needs to be played back.
3070**
3071** If the current size of the database file is 0 but a journal file
3072** exists, that is probably an old journal left over from a prior
3073** database with the same name. Just delete the journal.
drh19db9352008-03-27 22:42:51 +00003074**
3075** Return negative if unable to determine the status of the journal.
drh165ffe92005-03-15 17:09:30 +00003076*/
3077static int hasHotJournal(Pager *pPager){
danielk1977b4b47412007-08-17 15:53:36 +00003078 sqlite3_vfs *pVfs = pPager->pVfs;
drh19db9352008-03-27 22:42:51 +00003079 int rc;
drh165ffe92005-03-15 17:09:30 +00003080 if( !pPager->useJournal ) return 0;
drhd3cf2472007-11-27 16:55:07 +00003081 if( !pPager->fd->pMethods ) return 0;
drh19db9352008-03-27 22:42:51 +00003082 rc = sqlite3OsAccess(pVfs, pPager->zJournal, SQLITE_ACCESS_EXISTS);
3083 if( rc<=0 ){
3084 return rc;
drhbb5f18d2007-04-06 18:23:17 +00003085 }
3086 if( sqlite3OsCheckReservedLock(pPager->fd) ){
3087 return 0;
3088 }
danielk19773b8a05f2007-03-19 17:44:26 +00003089 if( sqlite3PagerPagecount(pPager)==0 ){
danielk1977fee2d252007-08-18 10:59:19 +00003090 sqlite3OsDelete(pVfs, pPager->zJournal, 0);
drh165ffe92005-03-15 17:09:30 +00003091 return 0;
3092 }else{
3093 return 1;
3094 }
3095}
3096
danielk19775591df52005-12-20 09:19:37 +00003097/*
danielk1977aef0bf62005-12-30 16:28:01 +00003098** Try to find a page in the cache that can be recycled.
3099**
3100** This routine may return SQLITE_IOERR, SQLITE_FULL or SQLITE_OK. It
danielk1977efaaf572006-01-16 11:29:19 +00003101** does not set the pPager->errCode variable.
danielk19775591df52005-12-20 09:19:37 +00003102*/
danielk1977843e65f2007-09-01 16:16:15 +00003103static int pager_recycle(Pager *pPager, PgHdr **ppPg){
danielk197713f72992005-12-18 08:51:22 +00003104 PgHdr *pPg;
3105 *ppPg = 0;
3106
danielk1977843e65f2007-09-01 16:16:15 +00003107 /* It is illegal to call this function unless the pager object
3108 ** pointed to by pPager has at least one free page (page with nRef==0).
3109 */
danielk1977c551edc2007-04-05 13:12:13 +00003110 assert(!MEMDB);
danielk1977843e65f2007-09-01 16:16:15 +00003111 assert(pPager->lru.pFirst);
danielk1977c551edc2007-04-05 13:12:13 +00003112
danielk197713f72992005-12-18 08:51:22 +00003113 /* Find a page to recycle. Try to locate a page that does not
3114 ** require us to do an fsync() on the journal.
3115 */
danielk19779f61c2f2007-08-27 17:27:49 +00003116 pPg = pPager->lru.pFirstSynced;
danielk197713f72992005-12-18 08:51:22 +00003117
3118 /* If we could not find a page that does not require an fsync()
3119 ** on the journal file then fsync the journal file. This is a
3120 ** very slow operation, so we work hard to avoid it. But sometimes
3121 ** it can't be helped.
3122 */
danielk1977843e65f2007-09-01 16:16:15 +00003123 if( pPg==0 && pPager->lru.pFirst){
danielk19774cd2cd52007-08-23 14:48:23 +00003124 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
danielk197713f72992005-12-18 08:51:22 +00003125 int rc = syncJournal(pPager);
3126 if( rc!=0 ){
danielk1977aef0bf62005-12-30 16:28:01 +00003127 return rc;
danielk197713f72992005-12-18 08:51:22 +00003128 }
danielk19774cd2cd52007-08-23 14:48:23 +00003129 if( pPager->fullSync && 0==(iDc&SQLITE_IOCAP_SAFE_APPEND) ){
danielk197713f72992005-12-18 08:51:22 +00003130 /* If in full-sync mode, write a new journal header into the
3131 ** journal file. This is done to avoid ever modifying a journal
3132 ** header that is involved in the rollback of pages that have
3133 ** already been written to the database (in case the header is
3134 ** trashed when the nRec field is updated).
3135 */
3136 pPager->nRec = 0;
3137 assert( pPager->journalOff > 0 );
danielk19774099f6e2007-03-19 11:25:20 +00003138 assert( pPager->doNotSync==0 );
danielk197713f72992005-12-18 08:51:22 +00003139 rc = writeJournalHdr(pPager);
3140 if( rc!=0 ){
danielk1977aef0bf62005-12-30 16:28:01 +00003141 return rc;
danielk197713f72992005-12-18 08:51:22 +00003142 }
3143 }
danielk19779f61c2f2007-08-27 17:27:49 +00003144 pPg = pPager->lru.pFirst;
danielk197713f72992005-12-18 08:51:22 +00003145 }
danielk197713f72992005-12-18 08:51:22 +00003146
3147 assert( pPg->nRef==0 );
3148
3149 /* Write the page to the database file if it is dirty.
3150 */
3151 if( pPg->dirty ){
3152 int rc;
3153 assert( pPg->needSync==0 );
drh605ad8f2006-05-03 23:34:05 +00003154 makeClean(pPg);
3155 pPg->dirty = 1;
danielk197713f72992005-12-18 08:51:22 +00003156 pPg->pDirty = 0;
3157 rc = pager_write_pagelist( pPg );
drh153c62c2007-08-24 03:51:33 +00003158 pPg->dirty = 0;
danielk197713f72992005-12-18 08:51:22 +00003159 if( rc!=SQLITE_OK ){
danielk1977aef0bf62005-12-30 16:28:01 +00003160 return rc;
danielk197713f72992005-12-18 08:51:22 +00003161 }
3162 }
3163 assert( pPg->dirty==0 );
3164
3165 /* If the page we are recycling is marked as alwaysRollback, then
3166 ** set the global alwaysRollback flag, thus disabling the
drh80e35f42007-03-30 14:06:34 +00003167 ** sqlite3PagerDontRollback() optimization for the rest of this transaction.
danielk197713f72992005-12-18 08:51:22 +00003168 ** It is necessary to do this because the page marked alwaysRollback
3169 ** might be reloaded at a later time but at that point we won't remember
3170 ** that is was marked alwaysRollback. This means that all pages must
3171 ** be marked as alwaysRollback from here on out.
3172 */
3173 if( pPg->alwaysRollback ){
drh602c2372007-03-01 00:29:13 +00003174 IOTRACE(("ALWAYS_ROLLBACK %p\n", pPager))
danielk197713f72992005-12-18 08:51:22 +00003175 pPager->alwaysRollback = 1;
3176 }
3177
3178 /* Unlink the old page from the free list and the hash table
3179 */
3180 unlinkPage(pPg);
drh7c4ac0c2007-04-05 11:25:58 +00003181 assert( pPg->pgno==0 );
danielk197713f72992005-12-18 08:51:22 +00003182
3183 *ppPg = pPg;
3184 return SQLITE_OK;
3185}
3186
drh86f8c192007-08-22 00:39:19 +00003187#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
danielk197713f72992005-12-18 08:51:22 +00003188/*
3189** This function is called to free superfluous dynamically allocated memory
3190** held by the pager system. Memory in use by any SQLite pager allocated
drh17435752007-08-16 04:30:38 +00003191** by the current thread may be sqlite3_free()ed.
danielk197713f72992005-12-18 08:51:22 +00003192**
3193** nReq is the number of bytes of memory required. Once this much has
drh86f8c192007-08-22 00:39:19 +00003194** been released, the function returns. The return value is the total number
danielk197713f72992005-12-18 08:51:22 +00003195** of bytes of memory released.
3196*/
danielk19773b8a05f2007-03-19 17:44:26 +00003197int sqlite3PagerReleaseMemory(int nReq){
drh86f8c192007-08-22 00:39:19 +00003198 int nReleased = 0; /* Bytes of memory released so far */
3199 sqlite3_mutex *mutex; /* The MEM2 mutex */
3200 Pager *pPager; /* For looping over pagers */
drhe5fe6902007-12-07 18:55:28 +00003201 BusyHandler *savedBusy; /* Saved copy of the busy handler */
danielk19779f61c2f2007-08-27 17:27:49 +00003202 int rc = SQLITE_OK;
danielk197713f72992005-12-18 08:51:22 +00003203
drh86f8c192007-08-22 00:39:19 +00003204 /* Acquire the memory-management mutex
danielk1977441b09a2006-01-05 13:48:29 +00003205 */
drh86f8c192007-08-22 00:39:19 +00003206 mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MEM2);
3207 sqlite3_mutex_enter(mutex);
3208
3209 /* Signal all database connections that memory management wants
3210 ** to have access to the pagers.
3211 */
3212 for(pPager=sqlite3PagerList; pPager; pPager=pPager->pNext){
3213 pPager->iInUseMM = 1;
danielk1977441b09a2006-01-05 13:48:29 +00003214 }
3215
danielk19779f61c2f2007-08-27 17:27:49 +00003216 while( rc==SQLITE_OK && (nReq<0 || nReleased<nReq) ){
3217 PgHdr *pPg;
3218 PgHdr *pRecycled;
3219
3220 /* Try to find a page to recycle that does not require a sync(). If
3221 ** this is not possible, find one that does require a sync().
3222 */
3223 sqlite3_mutex_enter(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
3224 pPg = sqlite3LruPageList.pFirstSynced;
3225 while( pPg && (pPg->needSync || pPg->pPager->iInUseDB) ){
3226 pPg = pPg->gfree.pNext;
3227 }
3228 if( !pPg ){
3229 pPg = sqlite3LruPageList.pFirst;
3230 while( pPg && pPg->pPager->iInUseDB ){
3231 pPg = pPg->gfree.pNext;
3232 }
3233 }
3234 sqlite3_mutex_leave(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
danielk197713f72992005-12-18 08:51:22 +00003235
danielk197784f786f2007-08-28 08:00:17 +00003236 /* If pPg==0, then the block above has failed to find a page to
3237 ** recycle. In this case return early - no further memory will
3238 ** be released.
3239 */
danielk19779f61c2f2007-08-27 17:27:49 +00003240 if( !pPg ) break;
danielk197713f72992005-12-18 08:51:22 +00003241
danielk19779f61c2f2007-08-27 17:27:49 +00003242 pPager = pPg->pPager;
3243 assert(!pPg->needSync || pPg==pPager->lru.pFirst);
3244 assert(pPg->needSync || pPg==pPager->lru.pFirstSynced);
3245
drhe5fe6902007-12-07 18:55:28 +00003246 savedBusy = pPager->pBusyHandler;
3247 pPager->pBusyHandler = 0;
danielk1977843e65f2007-09-01 16:16:15 +00003248 rc = pager_recycle(pPager, &pRecycled);
drhe5fe6902007-12-07 18:55:28 +00003249 pPager->pBusyHandler = savedBusy;
danielk19779f61c2f2007-08-27 17:27:49 +00003250 assert(pRecycled==pPg || rc!=SQLITE_OK);
3251 if( rc==SQLITE_OK ){
3252 /* We've found a page to free. At this point the page has been
3253 ** removed from the page hash-table, free-list and synced-list
3254 ** (pFirstSynced). It is still in the all pages (pAll) list.
3255 ** Remove it from this list before freeing.
3256 **
3257 ** Todo: Check the Pager.pStmt list to make sure this is Ok. It
3258 ** probably is though.
danielk197713f72992005-12-18 08:51:22 +00003259 */
danielk19779f61c2f2007-08-27 17:27:49 +00003260 PgHdr *pTmp;
3261 assert( pPg );
3262 if( pPg==pPager->pAll ){
3263 pPager->pAll = pPg->pNextAll;
3264 }else{
3265 for( pTmp=pPager->pAll; pTmp->pNextAll!=pPg; pTmp=pTmp->pNextAll ){}
3266 pTmp->pNextAll = pPg->pNextAll;
danielk197713f72992005-12-18 08:51:22 +00003267 }
danielk19779f61c2f2007-08-27 17:27:49 +00003268 nReleased += (
3269 sizeof(*pPg) + pPager->pageSize
3270 + sizeof(u32) + pPager->nExtra
3271 + MEMDB*sizeof(PgHistory)
3272 );
3273 IOTRACE(("PGFREE %p %d *\n", pPager, pPg->pgno));
3274 PAGER_INCR(sqlite3_pager_pgfree_count);
drh0d180202008-02-14 23:26:56 +00003275 sqlite3_free(pPg->pData);
danielk19779f61c2f2007-08-27 17:27:49 +00003276 sqlite3_free(pPg);
danielk197784f786f2007-08-28 08:00:17 +00003277 pPager->nPage--;
danielk19779f61c2f2007-08-27 17:27:49 +00003278 }else{
3279 /* An error occured whilst writing to the database file or
3280 ** journal in pager_recycle(). The error is not returned to the
3281 ** caller of this function. Instead, set the Pager.errCode variable.
3282 ** The error will be returned to the user (or users, in the case
3283 ** of a shared pager cache) of the pager for which the error occured.
3284 */
3285 assert(
3286 (rc&0xff)==SQLITE_IOERR ||
3287 rc==SQLITE_FULL ||
3288 rc==SQLITE_BUSY
3289 );
3290 assert( pPager->state>=PAGER_RESERVED );
3291 pager_error(pPager, rc);
danielk197713f72992005-12-18 08:51:22 +00003292 }
3293 }
danielk1977aef0bf62005-12-30 16:28:01 +00003294
drh86f8c192007-08-22 00:39:19 +00003295 /* Clear the memory management flags and release the mutex
3296 */
3297 for(pPager=sqlite3PagerList; pPager; pPager=pPager->pNext){
3298 pPager->iInUseMM = 0;
3299 }
3300 sqlite3_mutex_leave(mutex);
3301
3302 /* Return the number of bytes released
3303 */
danielk197713f72992005-12-18 08:51:22 +00003304 return nReleased;
3305}
drh86f8c192007-08-22 00:39:19 +00003306#endif /* SQLITE_ENABLE_MEMORY_MANAGEMENT */
danielk197713f72992005-12-18 08:51:22 +00003307
drh165ffe92005-03-15 17:09:30 +00003308/*
danielk1977e180dd92007-04-05 17:15:52 +00003309** Read the content of page pPg out of the database file.
3310*/
3311static int readDbPage(Pager *pPager, PgHdr *pPg, Pgno pgno){
3312 int rc;
danielk197762079062007-08-15 17:08:46 +00003313 i64 offset;
danielk1977e180dd92007-04-05 17:15:52 +00003314 assert( MEMDB==0 );
danielk19777a2b1ee2007-08-21 14:27:01 +00003315 assert(pPager->fd->pMethods||pPager->tempFile);
3316 if( !pPager->fd->pMethods ){
3317 return SQLITE_IOERR_SHORT_READ;
3318 }
danielk197762079062007-08-15 17:08:46 +00003319 offset = (pgno-1)*(i64)pPager->pageSize;
3320 rc = sqlite3OsRead(pPager->fd, PGHDR_TO_DATA(pPg), pPager->pageSize, offset);
drh538f5702007-04-13 02:14:30 +00003321 PAGER_INCR(sqlite3_pager_readdb_count);
3322 PAGER_INCR(pPager->nRead);
3323 IOTRACE(("PGIN %p %d\n", pPager, pgno));
drh86a88112007-04-16 15:02:19 +00003324 if( pgno==1 ){
3325 memcpy(&pPager->dbFileVers, &((u8*)PGHDR_TO_DATA(pPg))[24],
3326 sizeof(pPager->dbFileVers));
3327 }
danielk1977e180dd92007-04-05 17:15:52 +00003328 CODEC1(pPager, PGHDR_TO_DATA(pPg), pPg->pgno, 3);
drh477731b2007-06-16 03:06:27 +00003329 PAGERTRACE4("FETCH %d page %d hash(%08x)\n",
3330 PAGERID(pPager), pPg->pgno, pager_pagehash(pPg));
danielk1977e180dd92007-04-05 17:15:52 +00003331 return rc;
3332}
3333
3334
3335/*
danielk1977e277be02007-03-23 18:12:06 +00003336** This function is called to obtain the shared lock required before
3337** data may be read from the pager cache. If the shared lock has already
3338** been obtained, this function is a no-op.
danielk1977393f0682007-03-31 10:00:48 +00003339**
3340** Immediately after obtaining the shared lock (if required), this function
3341** checks for a hot-journal file. If one is found, an emergency rollback
3342** is performed immediately.
danielk1977e277be02007-03-23 18:12:06 +00003343*/
3344static int pagerSharedLock(Pager *pPager){
3345 int rc = SQLITE_OK;
danielk1977ae72d982007-10-03 08:46:44 +00003346 int isHot = 0;
danielk1977e277be02007-03-23 18:12:06 +00003347
danielk1977ae72d982007-10-03 08:46:44 +00003348 /* If this database is opened for exclusive access, has no outstanding
3349 ** page references and is in an error-state, now is the chance to clear
3350 ** the error. Discard the contents of the pager-cache and treat any
3351 ** open journal file as a hot-journal.
3352 */
3353 if( !MEMDB && pPager->exclusiveMode && pPager->nRef==0 && pPager->errCode ){
3354 if( pPager->journalOpen ){
3355 isHot = 1;
3356 }
3357 pager_reset(pPager);
3358 pPager->errCode = SQLITE_OK;
3359 }
3360
3361 /* If the pager is still in an error state, do not proceed. The error
3362 ** state will be cleared at some point in the future when all page
3363 ** references are dropped and the cache can be discarded.
3364 */
3365 if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
3366 return pPager->errCode;
3367 }
3368
3369 if( pPager->state==PAGER_UNLOCK || isHot ){
danielk1977b4b47412007-08-17 15:53:36 +00003370 sqlite3_vfs *pVfs = pPager->pVfs;
danielk1977e277be02007-03-23 18:12:06 +00003371 if( !MEMDB ){
3372 assert( pPager->nRef==0 );
3373 if( !pPager->noReadlock ){
3374 rc = pager_wait_on_lock(pPager, SHARED_LOCK);
3375 if( rc!=SQLITE_OK ){
3376 return pager_error(pPager, rc);
3377 }
3378 assert( pPager->state>=SHARED_LOCK );
3379 }
3380
3381 /* If a journal file exists, and there is no RESERVED lock on the
3382 ** database file, then it either needs to be played back or deleted.
3383 */
drh19db9352008-03-27 22:42:51 +00003384 rc = hasHotJournal(pPager);
3385 if( rc<0 ){
danielk1977a3e52182008-04-14 16:37:10 +00003386 return SQLITE_IOERR_NOMEM;
drh19db9352008-03-27 22:42:51 +00003387 }
3388 if( rc==1 || isHot ){
danielk1977e277be02007-03-23 18:12:06 +00003389 /* Get an EXCLUSIVE lock on the database file. At this point it is
3390 ** important that a RESERVED lock is not obtained on the way to the
3391 ** EXCLUSIVE lock. If it were, another process might open the
3392 ** database file, detect the RESERVED lock, and conclude that the
3393 ** database is safe to read while this process is still rolling it
3394 ** back.
3395 **
3396 ** Because the intermediate RESERVED lock is not requested, the
3397 ** second process will get to this point in the code and fail to
drh85b623f2007-12-13 21:54:09 +00003398 ** obtain its own EXCLUSIVE lock on the database file.
danielk1977e277be02007-03-23 18:12:06 +00003399 */
danielk1977ae72d982007-10-03 08:46:44 +00003400 if( pPager->state<EXCLUSIVE_LOCK ){
3401 rc = sqlite3OsLock(pPager->fd, EXCLUSIVE_LOCK);
3402 if( rc!=SQLITE_OK ){
3403 pager_unlock(pPager);
3404 return pager_error(pPager, rc);
3405 }
3406 pPager->state = PAGER_EXCLUSIVE;
danielk1977e277be02007-03-23 18:12:06 +00003407 }
danielk1977e277be02007-03-23 18:12:06 +00003408
3409 /* Open the journal for reading only. Return SQLITE_BUSY if
3410 ** we are unable to open the journal file.
3411 **
3412 ** The journal file does not need to be locked itself. The
3413 ** journal file is never open unless the main database file holds
3414 ** a write lock, so there is never any chance of two or more
3415 ** processes opening the journal at the same time.
danielk1977979f38e2007-03-27 16:19:51 +00003416 **
drhfd131da2007-08-07 17:13:03 +00003417 ** Open the journal for read/write access. This is because in
3418 ** exclusive-access mode the file descriptor will be kept open and
danielk1977979f38e2007-03-27 16:19:51 +00003419 ** possibly used for a transaction later on. On some systems, the
3420 ** OsTruncate() call used in exclusive-access mode also requires
3421 ** a read/write file handle.
danielk1977e277be02007-03-23 18:12:06 +00003422 */
danielk1977ae72d982007-10-03 08:46:44 +00003423 if( !isHot ){
danielk1977ce98bba2008-04-03 10:13:01 +00003424 int res = sqlite3OsAccess(pVfs,pPager->zJournal,SQLITE_ACCESS_EXISTS);
3425 if( res==1 ){
danielk1977ae72d982007-10-03 08:46:44 +00003426 int fout = 0;
3427 int f = SQLITE_OPEN_READWRITE|SQLITE_OPEN_MAIN_JOURNAL;
3428 assert( !pPager->tempFile );
3429 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, f, &fout);
3430 assert( rc!=SQLITE_OK || pPager->jfd->pMethods );
3431 if( fout&SQLITE_OPEN_READONLY ){
3432 rc = SQLITE_BUSY;
3433 sqlite3OsClose(pPager->jfd);
3434 }
danielk1977ce98bba2008-04-03 10:13:01 +00003435 }else{
3436 rc = (res==0?SQLITE_BUSY:SQLITE_IOERR_NOMEM);
danielk1977979f38e2007-03-27 16:19:51 +00003437 }
3438 }
danielk1977e277be02007-03-23 18:12:06 +00003439 if( rc!=SQLITE_OK ){
3440 pager_unlock(pPager);
drh1aa5af12008-03-07 19:51:14 +00003441 switch( rc ){
3442 case SQLITE_NOMEM:
3443 case SQLITE_IOERR_UNLOCK:
3444 case SQLITE_IOERR_NOMEM:
3445 return rc;
3446 default:
3447 return SQLITE_BUSY;
3448 }
danielk1977e277be02007-03-23 18:12:06 +00003449 }
3450 pPager->journalOpen = 1;
3451 pPager->journalStarted = 0;
3452 pPager->journalOff = 0;
3453 pPager->setMaster = 0;
3454 pPager->journalHdr = 0;
3455
3456 /* Playback and delete the journal. Drop the database write
3457 ** lock and reacquire the read lock.
3458 */
3459 rc = pager_playback(pPager, 1);
3460 if( rc!=SQLITE_OK ){
3461 return pager_error(pPager, rc);
3462 }
danielk1977c5859712007-03-26 12:26:27 +00003463 assert(pPager->state==PAGER_SHARED ||
3464 (pPager->exclusiveMode && pPager->state>PAGER_SHARED)
3465 );
danielk1977e277be02007-03-23 18:12:06 +00003466 }
3467
3468 if( pPager->pAll ){
danielk197724168722007-04-02 05:07:47 +00003469 /* The shared-lock has just been acquired on the database file
3470 ** and there are already pages in the cache (from a previous
drh86a88112007-04-16 15:02:19 +00003471 ** read or write transaction). Check to see if the database
3472 ** has been modified. If the database has changed, flush the
3473 ** cache.
3474 **
3475 ** Database changes is detected by looking at 15 bytes beginning
3476 ** at offset 24 into the file. The first 4 of these 16 bytes are
3477 ** a 32-bit counter that is incremented with each change. The
3478 ** other bytes change randomly with each file change when
3479 ** a codec is in use.
3480 **
3481 ** There is a vanishingly small chance that a change will not be
drh6fa51032007-05-09 20:35:31 +00003482 ** detected. The chance of an undetected change is so small that
drh86a88112007-04-16 15:02:19 +00003483 ** it can be neglected.
danielk197724168722007-04-02 05:07:47 +00003484 */
drh86a88112007-04-16 15:02:19 +00003485 char dbFileVers[sizeof(pPager->dbFileVers)];
danielk1977e180dd92007-04-05 17:15:52 +00003486 sqlite3PagerPagecount(pPager);
danielk197724168722007-04-02 05:07:47 +00003487
danielk1977e180dd92007-04-05 17:15:52 +00003488 if( pPager->errCode ){
3489 return pPager->errCode;
danielk1977e277be02007-03-23 18:12:06 +00003490 }
3491
danielk1977e180dd92007-04-05 17:15:52 +00003492 if( pPager->dbSize>0 ){
drhae5e4452007-05-03 17:18:36 +00003493 IOTRACE(("CKVERS %p %d\n", pPager, sizeof(dbFileVers)));
danielk197762079062007-08-15 17:08:46 +00003494 rc = sqlite3OsRead(pPager->fd, &dbFileVers, sizeof(dbFileVers), 24);
danielk1977e180dd92007-04-05 17:15:52 +00003495 if( rc!=SQLITE_OK ){
3496 return rc;
3497 }
drh86a88112007-04-16 15:02:19 +00003498 }else{
3499 memset(dbFileVers, 0, sizeof(dbFileVers));
danielk1977e180dd92007-04-05 17:15:52 +00003500 }
3501
drh86a88112007-04-16 15:02:19 +00003502 if( memcmp(pPager->dbFileVers, dbFileVers, sizeof(dbFileVers))!=0 ){
danielk1977e180dd92007-04-05 17:15:52 +00003503 pager_reset(pPager);
danielk1977e277be02007-03-23 18:12:06 +00003504 }
3505 }
3506 }
danielk1977c5859712007-03-26 12:26:27 +00003507 assert( pPager->exclusiveMode || pPager->state<=PAGER_SHARED );
3508 if( pPager->state==PAGER_UNLOCK ){
3509 pPager->state = PAGER_SHARED;
3510 }
danielk1977e277be02007-03-23 18:12:06 +00003511 }
3512
3513 return rc;
3514}
3515
3516/*
danielk1977e180dd92007-04-05 17:15:52 +00003517** Allocate a PgHdr object. Either create a new one or reuse
3518** an existing one that is not otherwise in use.
3519**
3520** A new PgHdr structure is created if any of the following are
3521** true:
3522**
3523** (1) We have not exceeded our maximum allocated cache size
3524** as set by the "PRAGMA cache_size" command.
3525**
3526** (2) There are no unused PgHdr objects available at this time.
3527**
3528** (3) This is an in-memory database.
3529**
3530** (4) There are no PgHdr objects that do not require a journal
3531** file sync and a sync of the journal file is currently
3532** prohibited.
3533**
3534** Otherwise, reuse an existing PgHdr. In other words, reuse an
3535** existing PgHdr if all of the following are true:
3536**
3537** (1) We have reached or exceeded the maximum cache size
3538** allowed by "PRAGMA cache_size".
3539**
3540** (2) There is a PgHdr available with PgHdr->nRef==0
3541**
3542** (3) We are not in an in-memory database
3543**
3544** (4) Either there is an available PgHdr that does not need
3545** to be synced to disk or else disk syncing is currently
3546** allowed.
danielk197724168722007-04-02 05:07:47 +00003547*/
3548static int pagerAllocatePage(Pager *pPager, PgHdr **ppPg){
3549 int rc = SQLITE_OK;
3550 PgHdr *pPg;
drh1e3af332007-10-20 13:17:54 +00003551 int nByteHdr;
danielk197724168722007-04-02 05:07:47 +00003552
danielk1977e180dd92007-04-05 17:15:52 +00003553 /* Create a new PgHdr if any of the four conditions defined
danielk19772a6bdf62007-08-20 16:07:00 +00003554 ** above are met: */
danielk1977e180dd92007-04-05 17:15:52 +00003555 if( pPager->nPage<pPager->mxPage
danielk19779f61c2f2007-08-27 17:27:49 +00003556 || pPager->lru.pFirst==0
danielk1977e180dd92007-04-05 17:15:52 +00003557 || MEMDB
danielk19779f61c2f2007-08-27 17:27:49 +00003558 || (pPager->lru.pFirstSynced==0 && pPager->doNotSync)
danielk1977e180dd92007-04-05 17:15:52 +00003559 ){
drh0d180202008-02-14 23:26:56 +00003560 void *pData;
danielk197724168722007-04-02 05:07:47 +00003561 if( pPager->nPage>=pPager->nHash ){
3562 pager_resize_hash_table(pPager,
3563 pPager->nHash<256 ? 256 : pPager->nHash*2);
3564 if( pPager->nHash==0 ){
3565 rc = SQLITE_NOMEM;
3566 goto pager_allocate_out;
3567 }
3568 }
drhed138fb2007-08-22 22:04:37 +00003569 pagerLeave(pPager);
drh1e3af332007-10-20 13:17:54 +00003570 nByteHdr = sizeof(*pPg) + sizeof(u32) + pPager->nExtra
3571 + MEMDB*sizeof(PgHistory);
drh0d180202008-02-14 23:26:56 +00003572 pPg = sqlite3_malloc( nByteHdr );
3573 if( pPg ){
3574 pData = sqlite3_malloc( pPager->pageSize );
3575 if( pData==0 ){
3576 sqlite3_free(pPg);
3577 pPg = 0;
3578 }
3579 }
drhed138fb2007-08-22 22:04:37 +00003580 pagerEnter(pPager);
danielk197724168722007-04-02 05:07:47 +00003581 if( pPg==0 ){
3582 rc = SQLITE_NOMEM;
3583 goto pager_allocate_out;
3584 }
drh1e3af332007-10-20 13:17:54 +00003585 memset(pPg, 0, nByteHdr);
drh0d180202008-02-14 23:26:56 +00003586 pPg->pData = pData;
danielk197724168722007-04-02 05:07:47 +00003587 pPg->pPager = pPager;
3588 pPg->pNextAll = pPager->pAll;
3589 pPager->pAll = pPg;
3590 pPager->nPage++;
danielk197724168722007-04-02 05:07:47 +00003591 }else{
3592 /* Recycle an existing page with a zero ref-count. */
danielk1977843e65f2007-09-01 16:16:15 +00003593 rc = pager_recycle(pPager, &pPg);
danielk1977e965ac72007-06-13 15:22:28 +00003594 if( rc==SQLITE_BUSY ){
3595 rc = SQLITE_IOERR_BLOCKED;
3596 }
danielk197724168722007-04-02 05:07:47 +00003597 if( rc!=SQLITE_OK ){
3598 goto pager_allocate_out;
3599 }
3600 assert( pPager->state>=SHARED_LOCK );
3601 assert(pPg);
3602 }
3603 *ppPg = pPg;
3604
3605pager_allocate_out:
3606 return rc;
3607}
3608
3609/*
drhd33d5a82007-04-26 12:11:28 +00003610** Make sure we have the content for a page. If the page was
3611** previously acquired with noContent==1, then the content was
3612** just initialized to zeros instead of being read from disk.
3613** But now we need the real data off of disk. So make sure we
3614** have it. Read it in if we do not have it already.
3615*/
3616static int pager_get_content(PgHdr *pPg){
3617 if( pPg->needRead ){
3618 int rc = readDbPage(pPg->pPager, pPg, pPg->pgno);
3619 if( rc==SQLITE_OK ){
3620 pPg->needRead = 0;
3621 }else{
3622 return rc;
3623 }
3624 }
3625 return SQLITE_OK;
3626}
3627
3628/*
drhd9b02572001-04-15 00:37:09 +00003629** Acquire a page.
3630**
drh58a11682001-11-10 13:51:08 +00003631** A read lock on the disk file is obtained when the first page is acquired.
drh5e00f6c2001-09-13 13:46:56 +00003632** This read lock is dropped when the last page is released.
drhd9b02572001-04-15 00:37:09 +00003633**
drhd33d5a82007-04-26 12:11:28 +00003634** This routine works for any page number greater than 0. If the database
drh306dc212001-05-21 13:45:10 +00003635** file is smaller than the requested page, then no actual disk
3636** read occurs and the memory image of the page is initialized to
3637** all zeros. The extra data appended to a page is always initialized
3638** to zeros the first time a page is loaded into memory.
3639**
drhd9b02572001-04-15 00:37:09 +00003640** The acquisition might fail for several reasons. In all cases,
3641** an appropriate error code is returned and *ppPage is set to NULL.
drh7e3b0a02001-04-28 16:52:40 +00003642**
drhd33d5a82007-04-26 12:11:28 +00003643** See also sqlite3PagerLookup(). Both this routine and Lookup() attempt
drh7e3b0a02001-04-28 16:52:40 +00003644** to find a page in the in-memory cache first. If the page is not already
drhd33d5a82007-04-26 12:11:28 +00003645** in memory, this routine goes to disk to read it in whereas Lookup()
drh7e3b0a02001-04-28 16:52:40 +00003646** just returns 0. This routine acquires a read-lock the first time it
3647** has to go to disk, and could also playback an old journal if necessary.
drhd33d5a82007-04-26 12:11:28 +00003648** Since Lookup() never goes to disk, it never has to deal with locks
drh7e3b0a02001-04-28 16:52:40 +00003649** or journal files.
drh0787db62007-03-04 13:15:27 +00003650**
drh538f5702007-04-13 02:14:30 +00003651** If noContent is false, the page contents are actually read from disk.
3652** If noContent is true, it means that we do not care about the contents
3653** of the page at this time, so do not do a disk read. Just fill in the
3654** page content with zeros. But mark the fact that we have not read the
3655** content by setting the PgHdr.needRead flag. Later on, if
drhd33d5a82007-04-26 12:11:28 +00003656** sqlite3PagerWrite() is called on this page or if this routine is
3657** called again with noContent==0, that means that the content is needed
3658** and the disk read should occur at that point.
drhed7c8552001-04-11 14:29:21 +00003659*/
drh86f8c192007-08-22 00:39:19 +00003660static int pagerAcquire(
drh538f5702007-04-13 02:14:30 +00003661 Pager *pPager, /* The pager open on the database file */
3662 Pgno pgno, /* Page number to fetch */
3663 DbPage **ppPage, /* Write a pointer to the page here */
3664 int noContent /* Do not bother reading content from disk if true */
3665){
drhed7c8552001-04-11 14:29:21 +00003666 PgHdr *pPg;
drh165ffe92005-03-15 17:09:30 +00003667 int rc;
drhed7c8552001-04-11 14:29:21 +00003668
danielk1977e277be02007-03-23 18:12:06 +00003669 assert( pPager->state==PAGER_UNLOCK || pPager->nRef>0 || pgno==1 );
3670
danielk197726836652005-01-17 01:33:13 +00003671 /* The maximum page number is 2^31. Return SQLITE_CORRUPT if a page
3672 ** number greater than this, or zero, is requested.
3673 */
drh267cb322005-09-16 17:16:52 +00003674 if( pgno>PAGER_MAX_PGNO || pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh49285702005-09-17 15:20:26 +00003675 return SQLITE_CORRUPT_BKPT;
danielk197726836652005-01-17 01:33:13 +00003676 }
3677
drhd9b02572001-04-15 00:37:09 +00003678 /* Make sure we have not hit any critical errors.
3679 */
drh836faa42003-01-11 13:30:57 +00003680 assert( pPager!=0 );
drh2e6d11b2003-04-25 15:37:57 +00003681 *ppPage = 0;
drhd9b02572001-04-15 00:37:09 +00003682
danielk197713adf8a2004-06-03 16:08:41 +00003683 /* If this is the first page accessed, then get a SHARED lock
danielk1977334cdb62007-03-26 08:05:12 +00003684 ** on the database file. pagerSharedLock() is a no-op if
3685 ** a database lock is already held.
drhed7c8552001-04-11 14:29:21 +00003686 */
danielk1977e277be02007-03-23 18:12:06 +00003687 rc = pagerSharedLock(pPager);
3688 if( rc!=SQLITE_OK ){
3689 return rc;
drhed7c8552001-04-11 14:29:21 +00003690 }
danielk1977e277be02007-03-23 18:12:06 +00003691 assert( pPager->state!=PAGER_UNLOCK );
3692
3693 pPg = pager_lookup(pPager, pgno);
drhed7c8552001-04-11 14:29:21 +00003694 if( pPg==0 ){
drhd9b02572001-04-15 00:37:09 +00003695 /* The requested page is not in the page cache. */
danielk1977979f38e2007-03-27 16:19:51 +00003696 int nMax;
drhed7c8552001-04-11 14:29:21 +00003697 int h;
drh538f5702007-04-13 02:14:30 +00003698 PAGER_INCR(pPager->nMiss);
danielk197724168722007-04-02 05:07:47 +00003699 rc = pagerAllocatePage(pPager, &pPg);
3700 if( rc!=SQLITE_OK ){
3701 return rc;
drhed7c8552001-04-11 14:29:21 +00003702 }
danielk197724168722007-04-02 05:07:47 +00003703
drhed7c8552001-04-11 14:29:21 +00003704 pPg->pgno = pgno;
danielk1977f35843b2007-04-07 15:03:17 +00003705 assert( !MEMDB || pgno>pPager->stmtSize );
drhf5e7bb52008-02-18 14:47:33 +00003706 pPg->inJournal = sqlite3BitvecTest(pPager->pInJournal, pgno);
3707 pPg->needSync = 0;
danielk1977f35843b2007-04-07 15:03:17 +00003708
drh605ad8f2006-05-03 23:34:05 +00003709 makeClean(pPg);
drhed7c8552001-04-11 14:29:21 +00003710 pPg->nRef = 1;
danielk197775bab7d2006-01-23 13:09:45 +00003711
drhd9b02572001-04-15 00:37:09 +00003712 pPager->nRef++;
drh2e6d11b2003-04-25 15:37:57 +00003713 if( pPager->nExtra>0 ){
drh90f5ecb2004-07-22 01:19:35 +00003714 memset(PGHDR_TO_EXTRA(pPg, pPager), 0, pPager->nExtra);
drh2e6d11b2003-04-25 15:37:57 +00003715 }
danielk1977979f38e2007-03-27 16:19:51 +00003716 nMax = sqlite3PagerPagecount(pPager);
danielk1977efaaf572006-01-16 11:29:19 +00003717 if( pPager->errCode ){
danielk1977efaaf572006-01-16 11:29:19 +00003718 rc = pPager->errCode;
danielk1977ae72d982007-10-03 08:46:44 +00003719 sqlite3PagerUnref(pPg);
drh2e6d11b2003-04-25 15:37:57 +00003720 return rc;
3721 }
danielk197775bab7d2006-01-23 13:09:45 +00003722
3723 /* Populate the page with data, either by reading from the database
3724 ** file, or by setting the entire page to zero.
3725 */
drhd215acf2007-04-13 04:01:58 +00003726 if( nMax<(int)pgno || MEMDB || (noContent && !pPager->alwaysRollback) ){
drhf8e632b2007-05-08 14:51:36 +00003727 if( pgno>pPager->mxPgno ){
danielk1977de3bea72007-05-09 15:56:39 +00003728 sqlite3PagerUnref(pPg);
drhf8e632b2007-05-08 14:51:36 +00003729 return SQLITE_FULL;
3730 }
drh90f5ecb2004-07-22 01:19:35 +00003731 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
drhd215acf2007-04-13 04:01:58 +00003732 pPg->needRead = noContent && !pPager->alwaysRollback;
drh538f5702007-04-13 02:14:30 +00003733 IOTRACE(("ZERO %p %d\n", pPager, pgno));
drh306dc212001-05-21 13:45:10 +00003734 }else{
danielk1977e180dd92007-04-05 17:15:52 +00003735 rc = readDbPage(pPager, pPg, pgno);
drh551b7732006-11-06 21:20:25 +00003736 if( rc!=SQLITE_OK && rc!=SQLITE_IOERR_SHORT_READ ){
3737 pPg->pgno = 0;
danielk19773b8a05f2007-03-19 17:44:26 +00003738 sqlite3PagerUnref(pPg);
drh551b7732006-11-06 21:20:25 +00003739 return rc;
drh81a20f22001-10-12 17:30:04 +00003740 }
danielk1977b4626a32007-04-28 15:47:43 +00003741 pPg->needRead = 0;
drh306dc212001-05-21 13:45:10 +00003742 }
danielk197775bab7d2006-01-23 13:09:45 +00003743
3744 /* Link the page into the page hash table */
drh8ca0c722006-05-07 17:49:38 +00003745 h = pgno & (pPager->nHash-1);
drh3765df42006-06-28 18:18:09 +00003746 assert( pgno!=0 );
danielk197775bab7d2006-01-23 13:09:45 +00003747 pPg->pNextHash = pPager->aHash[h];
3748 pPager->aHash[h] = pPg;
3749 if( pPg->pNextHash ){
3750 assert( pPg->pNextHash->pPrevHash==0 );
3751 pPg->pNextHash->pPrevHash = pPg;
3752 }
3753
danielk19773c407372005-02-15 02:54:14 +00003754#ifdef SQLITE_CHECK_PAGES
3755 pPg->pageHash = pager_pagehash(pPg);
3756#endif
drhed7c8552001-04-11 14:29:21 +00003757 }else{
drhd9b02572001-04-15 00:37:09 +00003758 /* The requested page is in the page cache. */
danielk1977e277be02007-03-23 18:12:06 +00003759 assert(pPager->nRef>0 || pgno==1);
drh538f5702007-04-13 02:14:30 +00003760 PAGER_INCR(pPager->nHit);
drhd33d5a82007-04-26 12:11:28 +00003761 if( !noContent ){
3762 rc = pager_get_content(pPg);
3763 if( rc ){
3764 return rc;
3765 }
3766 }
drhdf0b3b02001-06-23 11:36:20 +00003767 page_ref(pPg);
drhed7c8552001-04-11 14:29:21 +00003768 }
danielk19773b8a05f2007-03-19 17:44:26 +00003769 *ppPage = pPg;
drhed7c8552001-04-11 14:29:21 +00003770 return SQLITE_OK;
3771}
drh86f8c192007-08-22 00:39:19 +00003772int sqlite3PagerAcquire(
3773 Pager *pPager, /* The pager open on the database file */
3774 Pgno pgno, /* Page number to fetch */
3775 DbPage **ppPage, /* Write a pointer to the page here */
3776 int noContent /* Do not bother reading content from disk if true */
3777){
3778 int rc;
3779 pagerEnter(pPager);
3780 rc = pagerAcquire(pPager, pgno, ppPage, noContent);
3781 pagerLeave(pPager);
3782 return rc;
3783}
3784
drhed7c8552001-04-11 14:29:21 +00003785
3786/*
drh7e3b0a02001-04-28 16:52:40 +00003787** Acquire a page if it is already in the in-memory cache. Do
3788** not read the page from disk. Return a pointer to the page,
3789** or 0 if the page is not in cache.
3790**
danielk19773b8a05f2007-03-19 17:44:26 +00003791** See also sqlite3PagerGet(). The difference between this routine
3792** and sqlite3PagerGet() is that _get() will go to the disk and read
drh7e3b0a02001-04-28 16:52:40 +00003793** in the page if the page is not already in cache. This routine
drh5e00f6c2001-09-13 13:46:56 +00003794** returns NULL if the page is not in cache or if a disk I/O error
3795** has ever happened.
drh7e3b0a02001-04-28 16:52:40 +00003796*/
danielk19773b8a05f2007-03-19 17:44:26 +00003797DbPage *sqlite3PagerLookup(Pager *pPager, Pgno pgno){
drh86f8c192007-08-22 00:39:19 +00003798 PgHdr *pPg = 0;
drh7e3b0a02001-04-28 16:52:40 +00003799
drh836faa42003-01-11 13:30:57 +00003800 assert( pPager!=0 );
3801 assert( pgno!=0 );
danielk1977e277be02007-03-23 18:12:06 +00003802
drh86f8c192007-08-22 00:39:19 +00003803 pagerEnter(pPager);
danielk1977e277be02007-03-23 18:12:06 +00003804 if( pPager->state==PAGER_UNLOCK ){
danielk1977334cdb62007-03-26 08:05:12 +00003805 assert( !pPager->pAll || pPager->exclusiveMode );
drh86f8c192007-08-22 00:39:19 +00003806 }else if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
3807 /* Do nothing */
3808 }else if( (pPg = pager_lookup(pPager, pgno))!=0 ){
3809 page_ref(pPg);
danielk1977e277be02007-03-23 18:12:06 +00003810 }
drh86f8c192007-08-22 00:39:19 +00003811 pagerLeave(pPager);
danielk19773b8a05f2007-03-19 17:44:26 +00003812 return pPg;
drh7e3b0a02001-04-28 16:52:40 +00003813}
3814
3815/*
drhed7c8552001-04-11 14:29:21 +00003816** Release a page.
3817**
3818** If the number of references to the page drop to zero, then the
3819** page is added to the LRU list. When all references to all pages
drhd9b02572001-04-15 00:37:09 +00003820** are released, a rollback occurs and the lock on the database is
drhed7c8552001-04-11 14:29:21 +00003821** removed.
3822*/
danielk19773b8a05f2007-03-19 17:44:26 +00003823int sqlite3PagerUnref(DbPage *pPg){
danielk1977ae72d982007-10-03 08:46:44 +00003824 Pager *pPager = pPg->pPager;
drhd9b02572001-04-15 00:37:09 +00003825
3826 /* Decrement the reference count for this page
3827 */
drhed7c8552001-04-11 14:29:21 +00003828 assert( pPg->nRef>0 );
drh86f8c192007-08-22 00:39:19 +00003829 pagerEnter(pPg->pPager);
drhed7c8552001-04-11 14:29:21 +00003830 pPg->nRef--;
drhd9b02572001-04-15 00:37:09 +00003831
danielk19773c407372005-02-15 02:54:14 +00003832 CHECK_PAGE(pPg);
3833
drh72f82862001-05-24 21:06:34 +00003834 /* When the number of references to a page reach 0, call the
3835 ** destructor and add the page to the freelist.
drhd9b02572001-04-15 00:37:09 +00003836 */
drhed7c8552001-04-11 14:29:21 +00003837 if( pPg->nRef==0 ){
danielk19779f61c2f2007-08-27 17:27:49 +00003838
3839 lruListAdd(pPg);
drh72f82862001-05-24 21:06:34 +00003840 if( pPager->xDestructor ){
danielk19773b8a05f2007-03-19 17:44:26 +00003841 pPager->xDestructor(pPg, pPager->pageSize);
drh72f82862001-05-24 21:06:34 +00003842 }
drhd9b02572001-04-15 00:37:09 +00003843
3844 /* When all pages reach the freelist, drop the read lock from
3845 ** the database file.
3846 */
3847 pPager->nRef--;
3848 assert( pPager->nRef>=0 );
danielk19773dedc192007-03-27 17:37:31 +00003849 if( pPager->nRef==0 && (!pPager->exclusiveMode || pPager->journalOff>0) ){
danielk1977e277be02007-03-23 18:12:06 +00003850 pagerUnlockAndRollback(pPager);
drhd9b02572001-04-15 00:37:09 +00003851 }
drhed7c8552001-04-11 14:29:21 +00003852 }
danielk1977ae72d982007-10-03 08:46:44 +00003853 pagerLeave(pPager);
drhd9b02572001-04-15 00:37:09 +00003854 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +00003855}
3856
3857/*
drha6abd042004-06-09 17:37:22 +00003858** Create a journal file for pPager. There should already be a RESERVED
3859** or EXCLUSIVE lock on the database file when this routine is called.
drhda47d772002-12-02 04:25:19 +00003860**
3861** Return SQLITE_OK if everything. Return an error code and release the
3862** write lock if anything goes wrong.
3863*/
3864static int pager_open_journal(Pager *pPager){
danielk1977b4b47412007-08-17 15:53:36 +00003865 sqlite3_vfs *pVfs = pPager->pVfs;
3866 int flags = (SQLITE_OPEN_READWRITE|SQLITE_OPEN_EXCLUSIVE|SQLITE_OPEN_CREATE);
3867
drhda47d772002-12-02 04:25:19 +00003868 int rc;
drhb7f91642004-10-31 02:22:47 +00003869 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +00003870 assert( pPager->state>=PAGER_RESERVED );
drhda47d772002-12-02 04:25:19 +00003871 assert( pPager->useJournal );
drhf5e7bb52008-02-18 14:47:33 +00003872 assert( pPager->pInJournal==0 );
danielk19773b8a05f2007-03-19 17:44:26 +00003873 sqlite3PagerPagecount(pPager);
drhed138fb2007-08-22 22:04:37 +00003874 pagerLeave(pPager);
drhf5e7bb52008-02-18 14:47:33 +00003875 pPager->pInJournal = sqlite3BitvecCreate(pPager->dbSize);
drhed138fb2007-08-22 22:04:37 +00003876 pagerEnter(pPager);
drhf5e7bb52008-02-18 14:47:33 +00003877 if( pPager->pInJournal==0 ){
drh9c105bb2004-10-02 20:38:28 +00003878 rc = SQLITE_NOMEM;
3879 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00003880 }
danielk1977b4b47412007-08-17 15:53:36 +00003881
drhfdc40e92008-04-17 20:59:37 +00003882 if( pPager->journalOpen==0 ){
3883 if( pPager->tempFile ){
3884 flags |= (SQLITE_OPEN_DELETEONCLOSE|SQLITE_OPEN_TEMP_JOURNAL);
3885 }else{
3886 flags |= (SQLITE_OPEN_MAIN_JOURNAL);
drh600e46a2007-03-28 01:59:33 +00003887 }
drhfdc40e92008-04-17 20:59:37 +00003888#ifdef SQLITE_ENABLE_ATOMIC_WRITE
3889 rc = sqlite3JournalOpen(
3890 pVfs, pPager->zJournal, pPager->jfd, flags, jrnlBufferSize(pPager)
3891 );
3892#else
3893 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, flags, 0);
3894#endif
3895 assert( rc!=SQLITE_OK || pPager->jfd->pMethods );
3896 pPager->journalOff = 0;
3897 pPager->setMaster = 0;
3898 pPager->journalHdr = 0;
3899 if( rc!=SQLITE_OK ){
3900 if( rc==SQLITE_NOMEM ){
3901 sqlite3OsDelete(pVfs, pPager->zJournal, 0);
3902 }
3903 goto failed_to_open_journal;
3904 }
drhda47d772002-12-02 04:25:19 +00003905 }
3906 pPager->journalOpen = 1;
drhdb48ee02003-01-16 13:42:43 +00003907 pPager->journalStarted = 0;
drhda47d772002-12-02 04:25:19 +00003908 pPager->needSync = 0;
3909 pPager->alwaysRollback = 0;
drh968af522003-02-11 14:55:40 +00003910 pPager->nRec = 0;
danielk1977efaaf572006-01-16 11:29:19 +00003911 if( pPager->errCode ){
3912 rc = pPager->errCode;
drhdd5b2fa2005-03-28 03:39:55 +00003913 goto failed_to_open_journal;
drh2e6d11b2003-04-25 15:37:57 +00003914 }
drhda47d772002-12-02 04:25:19 +00003915 pPager->origDbSize = pPager->dbSize;
drhae2b40c2004-06-09 19:03:54 +00003916
danielk197776572402004-06-25 02:38:54 +00003917 rc = writeJournalHdr(pPager);
3918
drhac69b052004-05-12 13:30:07 +00003919 if( pPager->stmtAutoopen && rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00003920 rc = sqlite3PagerStmtBegin(pPager);
drhda47d772002-12-02 04:25:19 +00003921 }
danielk1977ae72d982007-10-03 08:46:44 +00003922 if( rc!=SQLITE_OK && rc!=SQLITE_NOMEM && rc!=SQLITE_IOERR_NOMEM ){
drh80e35f42007-03-30 14:06:34 +00003923 rc = pager_end_transaction(pPager);
drhda47d772002-12-02 04:25:19 +00003924 if( rc==SQLITE_OK ){
3925 rc = SQLITE_FULL;
3926 }
3927 }
drh9c105bb2004-10-02 20:38:28 +00003928 return rc;
3929
3930failed_to_open_journal:
drhf5e7bb52008-02-18 14:47:33 +00003931 sqlite3BitvecDestroy(pPager->pInJournal);
3932 pPager->pInJournal = 0;
drh9c105bb2004-10-02 20:38:28 +00003933 return rc;
drhda47d772002-12-02 04:25:19 +00003934}
3935
3936/*
drh4b845d72002-03-05 12:41:19 +00003937** Acquire a write-lock on the database. The lock is removed when
3938** the any of the following happen:
3939**
drh80e35f42007-03-30 14:06:34 +00003940** * sqlite3PagerCommitPhaseTwo() is called.
danielk19773b8a05f2007-03-19 17:44:26 +00003941** * sqlite3PagerRollback() is called.
3942** * sqlite3PagerClose() is called.
3943** * sqlite3PagerUnref() is called to on every outstanding page.
drh4b845d72002-03-05 12:41:19 +00003944**
danielk197713adf8a2004-06-03 16:08:41 +00003945** The first parameter to this routine is a pointer to any open page of the
3946** database file. Nothing changes about the page - it is used merely to
3947** acquire a pointer to the Pager structure and as proof that there is
3948** already a read-lock on the database.
drh4b845d72002-03-05 12:41:19 +00003949**
danielk197713adf8a2004-06-03 16:08:41 +00003950** The second parameter indicates how much space in bytes to reserve for a
3951** master journal file-name at the start of the journal when it is created.
3952**
3953** A journal file is opened if this is not a temporary file. For temporary
3954** files, the opening of the journal file is deferred until there is an
3955** actual need to write to the journal.
drhda47d772002-12-02 04:25:19 +00003956**
drha6abd042004-06-09 17:37:22 +00003957** If the database is already reserved for writing, this routine is a no-op.
drh684917c2004-10-05 02:41:42 +00003958**
3959** If exFlag is true, go ahead and get an EXCLUSIVE lock on the file
3960** immediately instead of waiting until we try to flush the cache. The
3961** exFlag is ignored if a transaction is already active.
drh4b845d72002-03-05 12:41:19 +00003962*/
danielk19773b8a05f2007-03-19 17:44:26 +00003963int sqlite3PagerBegin(DbPage *pPg, int exFlag){
drh4b845d72002-03-05 12:41:19 +00003964 Pager *pPager = pPg->pPager;
3965 int rc = SQLITE_OK;
drh86f8c192007-08-22 00:39:19 +00003966 pagerEnter(pPager);
drh4b845d72002-03-05 12:41:19 +00003967 assert( pPg->nRef>0 );
drha6abd042004-06-09 17:37:22 +00003968 assert( pPager->state!=PAGER_UNLOCK );
3969 if( pPager->state==PAGER_SHARED ){
drhf5e7bb52008-02-18 14:47:33 +00003970 assert( pPager->pInJournal==0 );
drhb7f91642004-10-31 02:22:47 +00003971 if( MEMDB ){
drha6abd042004-06-09 17:37:22 +00003972 pPager->state = PAGER_EXCLUSIVE;
drhac69b052004-05-12 13:30:07 +00003973 pPager->origDbSize = pPager->dbSize;
3974 }else{
drh054889e2005-11-30 03:20:31 +00003975 rc = sqlite3OsLock(pPager->fd, RESERVED_LOCK);
drh684917c2004-10-05 02:41:42 +00003976 if( rc==SQLITE_OK ){
3977 pPager->state = PAGER_RESERVED;
3978 if( exFlag ){
3979 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
3980 }
3981 }
danielk19779eed5052004-06-04 10:38:30 +00003982 if( rc!=SQLITE_OK ){
drh86f8c192007-08-22 00:39:19 +00003983 pagerLeave(pPager);
danielk19779eed5052004-06-04 10:38:30 +00003984 return rc;
drhac69b052004-05-12 13:30:07 +00003985 }
drha6abd042004-06-09 17:37:22 +00003986 pPager->dirtyCache = 0;
drh4f0c5872007-03-26 22:05:01 +00003987 PAGERTRACE2("TRANSACTION %d\n", PAGERID(pPager));
drhfdc40e92008-04-17 20:59:37 +00003988 if( pPager->useJournal && !pPager->tempFile
3989 && pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
drhac69b052004-05-12 13:30:07 +00003990 rc = pager_open_journal(pPager);
3991 }
drh4b845d72002-03-05 12:41:19 +00003992 }
danielk1977334cdb62007-03-26 08:05:12 +00003993 }else if( pPager->journalOpen && pPager->journalOff==0 ){
3994 /* This happens when the pager was in exclusive-access mode last
3995 ** time a (read or write) transaction was successfully concluded
3996 ** by this connection. Instead of deleting the journal file it was
3997 ** kept open and truncated to 0 bytes.
3998 */
3999 assert( pPager->nRec==0 );
4000 assert( pPager->origDbSize==0 );
drhf5e7bb52008-02-18 14:47:33 +00004001 assert( pPager->pInJournal==0 );
danielk1977334cdb62007-03-26 08:05:12 +00004002 sqlite3PagerPagecount(pPager);
drhed138fb2007-08-22 22:04:37 +00004003 pagerLeave(pPager);
drhf5e7bb52008-02-18 14:47:33 +00004004 pPager->pInJournal = sqlite3BitvecCreate( pPager->dbSize );
drhed138fb2007-08-22 22:04:37 +00004005 pagerEnter(pPager);
drhf5e7bb52008-02-18 14:47:33 +00004006 if( !pPager->pInJournal ){
danielk1977334cdb62007-03-26 08:05:12 +00004007 rc = SQLITE_NOMEM;
4008 }else{
drh369339d2007-03-30 16:01:55 +00004009 pPager->origDbSize = pPager->dbSize;
danielk1977334cdb62007-03-26 08:05:12 +00004010 rc = writeJournalHdr(pPager);
4011 }
drh4b845d72002-03-05 12:41:19 +00004012 }
danielk1977334cdb62007-03-26 08:05:12 +00004013 assert( !pPager->journalOpen || pPager->journalOff>0 || rc!=SQLITE_OK );
drh86f8c192007-08-22 00:39:19 +00004014 pagerLeave(pPager);
drh4b845d72002-03-05 12:41:19 +00004015 return rc;
4016}
4017
4018/*
drh605ad8f2006-05-03 23:34:05 +00004019** Make a page dirty. Set its dirty flag and add it to the dirty
4020** page list.
4021*/
4022static void makeDirty(PgHdr *pPg){
4023 if( pPg->dirty==0 ){
4024 Pager *pPager = pPg->pPager;
4025 pPg->dirty = 1;
4026 pPg->pDirty = pPager->pDirty;
4027 if( pPager->pDirty ){
4028 pPager->pDirty->pPrevDirty = pPg;
4029 }
4030 pPg->pPrevDirty = 0;
4031 pPager->pDirty = pPg;
4032 }
4033}
4034
4035/*
4036** Make a page clean. Clear its dirty bit and remove it from the
4037** dirty page list.
4038*/
4039static void makeClean(PgHdr *pPg){
4040 if( pPg->dirty ){
4041 pPg->dirty = 0;
4042 if( pPg->pDirty ){
drh153c62c2007-08-24 03:51:33 +00004043 assert( pPg->pDirty->pPrevDirty==pPg );
drh605ad8f2006-05-03 23:34:05 +00004044 pPg->pDirty->pPrevDirty = pPg->pPrevDirty;
4045 }
4046 if( pPg->pPrevDirty ){
drh153c62c2007-08-24 03:51:33 +00004047 assert( pPg->pPrevDirty->pDirty==pPg );
drh605ad8f2006-05-03 23:34:05 +00004048 pPg->pPrevDirty->pDirty = pPg->pDirty;
4049 }else{
drh153c62c2007-08-24 03:51:33 +00004050 assert( pPg->pPager->pDirty==pPg );
drh605ad8f2006-05-03 23:34:05 +00004051 pPg->pPager->pDirty = pPg->pDirty;
4052 }
4053 }
4054}
4055
4056
4057/*
drhed7c8552001-04-11 14:29:21 +00004058** Mark a data page as writeable. The page is written into the journal
4059** if it is not there already. This routine must be called before making
4060** changes to a page.
4061**
4062** The first time this routine is called, the pager creates a new
drha6abd042004-06-09 17:37:22 +00004063** journal and acquires a RESERVED lock on the database. If the RESERVED
drhed7c8552001-04-11 14:29:21 +00004064** lock could not be acquired, this routine returns SQLITE_BUSY. The
drh306dc212001-05-21 13:45:10 +00004065** calling routine must check for that return value and be careful not to
drhed7c8552001-04-11 14:29:21 +00004066** change any page data until this routine returns SQLITE_OK.
drhd9b02572001-04-15 00:37:09 +00004067**
4068** If the journal file could not be written because the disk is full,
4069** then this routine returns SQLITE_FULL and does an immediate rollback.
4070** All subsequent write attempts also return SQLITE_FULL until there
danielk19773b8a05f2007-03-19 17:44:26 +00004071** is a call to sqlite3PagerCommit() or sqlite3PagerRollback() to
drhd9b02572001-04-15 00:37:09 +00004072** reset.
drhed7c8552001-04-11 14:29:21 +00004073*/
danielk19773b8a05f2007-03-19 17:44:26 +00004074static int pager_write(PgHdr *pPg){
4075 void *pData = PGHDR_TO_DATA(pPg);
drh69688d52001-04-14 16:38:23 +00004076 Pager *pPager = pPg->pPager;
drhd79caeb2001-04-15 02:27:24 +00004077 int rc = SQLITE_OK;
drh69688d52001-04-14 16:38:23 +00004078
drh6446c4d2001-12-15 14:22:18 +00004079 /* Check for errors
4080 */
danielk1977efaaf572006-01-16 11:29:19 +00004081 if( pPager->errCode ){
4082 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00004083 }
drh5e00f6c2001-09-13 13:46:56 +00004084 if( pPager->readOnly ){
4085 return SQLITE_PERM;
4086 }
drh6446c4d2001-12-15 14:22:18 +00004087
danielk197776572402004-06-25 02:38:54 +00004088 assert( !pPager->setMaster );
4089
danielk19773c407372005-02-15 02:54:14 +00004090 CHECK_PAGE(pPg);
4091
drh538f5702007-04-13 02:14:30 +00004092 /* If this page was previously acquired with noContent==1, that means
4093 ** we didn't really read in the content of the page. This can happen
4094 ** (for example) when the page is being moved to the freelist. But
4095 ** now we are (perhaps) moving the page off of the freelist for
4096 ** reuse and we need to know its original content so that content
4097 ** can be stored in the rollback journal. So do the read at this
4098 ** time.
4099 */
drhd33d5a82007-04-26 12:11:28 +00004100 rc = pager_get_content(pPg);
4101 if( rc ){
4102 return rc;
drh538f5702007-04-13 02:14:30 +00004103 }
4104
drh6446c4d2001-12-15 14:22:18 +00004105 /* Mark the page as dirty. If the page has already been written
4106 ** to the journal then we can return right away.
4107 */
drh605ad8f2006-05-03 23:34:05 +00004108 makeDirty(pPg);
danielk1977f35843b2007-04-07 15:03:17 +00004109 if( pPg->inJournal && (pageInStatement(pPg) || pPager->stmtInUse==0) ){
drha6abd042004-06-09 17:37:22 +00004110 pPager->dirtyCache = 1;
danielk1977a0bf2652004-11-04 14:30:04 +00004111 }else{
drh6446c4d2001-12-15 14:22:18 +00004112
danielk1977a0bf2652004-11-04 14:30:04 +00004113 /* If we get this far, it means that the page needs to be
4114 ** written to the transaction journal or the ckeckpoint journal
4115 ** or both.
4116 **
4117 ** First check to see that the transaction journal exists and
4118 ** create it if it does not.
4119 */
4120 assert( pPager->state!=PAGER_UNLOCK );
danielk19773b8a05f2007-03-19 17:44:26 +00004121 rc = sqlite3PagerBegin(pPg, 0);
danielk1977a0bf2652004-11-04 14:30:04 +00004122 if( rc!=SQLITE_OK ){
4123 return rc;
4124 }
4125 assert( pPager->state>=PAGER_RESERVED );
drhfdc40e92008-04-17 20:59:37 +00004126 if( !pPager->journalOpen && pPager->useJournal
4127 && pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
danielk1977a0bf2652004-11-04 14:30:04 +00004128 rc = pager_open_journal(pPager);
4129 if( rc!=SQLITE_OK ) return rc;
4130 }
danielk1977a0bf2652004-11-04 14:30:04 +00004131 pPager->dirtyCache = 1;
4132
4133 /* The transaction journal now exists and we have a RESERVED or an
4134 ** EXCLUSIVE lock on the main database file. Write the current page to
4135 ** the transaction journal if it is not there already.
4136 */
drhfdc40e92008-04-17 20:59:37 +00004137 if( !pPg->inJournal && (pPager->journalOpen || MEMDB) ){
danielk1977a0bf2652004-11-04 14:30:04 +00004138 if( (int)pPg->pgno <= pPager->origDbSize ){
danielk1977a0bf2652004-11-04 14:30:04 +00004139 if( MEMDB ){
4140 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
drh4f0c5872007-03-26 22:05:01 +00004141 PAGERTRACE3("JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00004142 assert( pHist->pOrig==0 );
drh17435752007-08-16 04:30:38 +00004143 pHist->pOrig = sqlite3_malloc( pPager->pageSize );
danielk1977662278e2007-11-05 15:30:12 +00004144 if( !pHist->pOrig ){
4145 return SQLITE_NOMEM;
danielk1977a0bf2652004-11-04 14:30:04 +00004146 }
danielk1977662278e2007-11-05 15:30:12 +00004147 memcpy(pHist->pOrig, PGHDR_TO_DATA(pPg), pPager->pageSize);
danielk1977a0bf2652004-11-04 14:30:04 +00004148 }else{
drhbf4bca52007-09-06 22:19:14 +00004149 u32 cksum;
4150 char *pData2;
danielk1977dd97a492007-08-22 18:54:32 +00004151
drh267cb322005-09-16 17:16:52 +00004152 /* We should never write to the journal file the page that
4153 ** contains the database locks. The following assert verifies
4154 ** that we do not. */
4155 assert( pPg->pgno!=PAGER_MJ_PGNO(pPager) );
drhc001c582006-03-06 18:23:16 +00004156 pData2 = CODEC2(pPager, pData, pPg->pgno, 7);
drh37527852006-03-16 16:19:56 +00004157 cksum = pager_cksum(pPager, (u8*)pData2);
drhbf4bca52007-09-06 22:19:14 +00004158 rc = write32bits(pPager->jfd, pPager->journalOff, pPg->pgno);
4159 if( rc==SQLITE_OK ){
4160 rc = sqlite3OsWrite(pPager->jfd, pData2, pPager->pageSize,
4161 pPager->journalOff + 4);
4162 pPager->journalOff += pPager->pageSize+4;
4163 }
4164 if( rc==SQLITE_OK ){
4165 rc = write32bits(pPager->jfd, pPager->journalOff, cksum);
4166 pPager->journalOff += 4;
4167 }
4168 IOTRACE(("JOUT %p %d %lld %d\n", pPager, pPg->pgno,
danielk1977667a6c92007-09-10 06:12:04 +00004169 pPager->journalOff, pPager->pageSize));
drh538f5702007-04-13 02:14:30 +00004170 PAGER_INCR(sqlite3_pager_writej_count);
drh477731b2007-06-16 03:06:27 +00004171 PAGERTRACE5("JOURNAL %d page %d needSync=%d hash(%08x)\n",
4172 PAGERID(pPager), pPg->pgno, pPg->needSync, pager_pagehash(pPg));
danielk197707cb5602006-01-20 10:55:05 +00004173
drhfd131da2007-08-07 17:13:03 +00004174 /* An error has occured writing to the journal file. The
danielk197707cb5602006-01-20 10:55:05 +00004175 ** transaction will be rolled back by the layer above.
4176 */
danielk1977a0bf2652004-11-04 14:30:04 +00004177 if( rc!=SQLITE_OK ){
danielk1977a0bf2652004-11-04 14:30:04 +00004178 return rc;
4179 }
danielk197707cb5602006-01-20 10:55:05 +00004180
danielk1977a0bf2652004-11-04 14:30:04 +00004181 pPager->nRec++;
drhf5e7bb52008-02-18 14:47:33 +00004182 assert( pPager->pInJournal!=0 );
4183 sqlite3BitvecSet(pPager->pInJournal, pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00004184 pPg->needSync = !pPager->noSync;
4185 if( pPager->stmtInUse ){
drhf5e7bb52008-02-18 14:47:33 +00004186 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00004187 }
drhac69b052004-05-12 13:30:07 +00004188 }
danielk197713adf8a2004-06-03 16:08:41 +00004189 }else{
danielk1977a0bf2652004-11-04 14:30:04 +00004190 pPg->needSync = !pPager->journalStarted && !pPager->noSync;
drh4f0c5872007-03-26 22:05:01 +00004191 PAGERTRACE4("APPEND %d page %d needSync=%d\n",
danielk1977ef73ee92004-11-06 12:26:07 +00004192 PAGERID(pPager), pPg->pgno, pPg->needSync);
danielk1977a0bf2652004-11-04 14:30:04 +00004193 }
4194 if( pPg->needSync ){
4195 pPager->needSync = 1;
4196 }
4197 pPg->inJournal = 1;
4198 }
4199
4200 /* If the statement journal is open and the page is not in it,
4201 ** then write the current page to the statement journal. Note that
4202 ** the statement journal format differs from the standard journal format
4203 ** in that it omits the checksums and the header.
4204 */
danielk1977f35843b2007-04-07 15:03:17 +00004205 if( pPager->stmtInUse
4206 && !pageInStatement(pPg)
4207 && (int)pPg->pgno<=pPager->stmtSize
4208 ){
danielk1977a0bf2652004-11-04 14:30:04 +00004209 assert( pPg->inJournal || (int)pPg->pgno>pPager->origDbSize );
4210 if( MEMDB ){
4211 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
4212 assert( pHist->pStmt==0 );
drh17435752007-08-16 04:30:38 +00004213 pHist->pStmt = sqlite3_malloc( pPager->pageSize );
danielk1977a0bf2652004-11-04 14:30:04 +00004214 if( pHist->pStmt ){
4215 memcpy(pHist->pStmt, PGHDR_TO_DATA(pPg), pPager->pageSize);
4216 }
drh4f0c5872007-03-26 22:05:01 +00004217 PAGERTRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk1977f35843b2007-04-07 15:03:17 +00004218 page_add_to_stmt_list(pPg);
danielk1977a0bf2652004-11-04 14:30:04 +00004219 }else{
danielk197762079062007-08-15 17:08:46 +00004220 i64 offset = pPager->stmtNRec*(4+pPager->pageSize);
drhbf4bca52007-09-06 22:19:14 +00004221 char *pData2 = CODEC2(pPager, pData, pPg->pgno, 7);
4222 rc = write32bits(pPager->stfd, offset, pPg->pgno);
4223 if( rc==SQLITE_OK ){
4224 rc = sqlite3OsWrite(pPager->stfd, pData2, pPager->pageSize, offset+4);
4225 }
drh4f0c5872007-03-26 22:05:01 +00004226 PAGERTRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
drhac69b052004-05-12 13:30:07 +00004227 if( rc!=SQLITE_OK ){
drhac69b052004-05-12 13:30:07 +00004228 return rc;
4229 }
danielk1977a0bf2652004-11-04 14:30:04 +00004230 pPager->stmtNRec++;
drhf5e7bb52008-02-18 14:47:33 +00004231 assert( pPager->pInStmt!=0 );
4232 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
drhdb48ee02003-01-16 13:42:43 +00004233 }
drhd9b02572001-04-15 00:37:09 +00004234 }
drhfa86c412002-02-02 15:01:15 +00004235 }
4236
4237 /* Update the database size and return.
4238 */
drh1aa2d8b2007-01-03 15:34:29 +00004239 assert( pPager->state>=PAGER_SHARED );
drh1ab43002002-01-14 09:28:19 +00004240 if( pPager->dbSize<(int)pPg->pgno ){
drh306dc212001-05-21 13:45:10 +00004241 pPager->dbSize = pPg->pgno;
drhb7f91642004-10-31 02:22:47 +00004242 if( !MEMDB && pPager->dbSize==PENDING_BYTE/pPager->pageSize ){
drh1f595712004-06-15 01:40:29 +00004243 pPager->dbSize++;
4244 }
drh306dc212001-05-21 13:45:10 +00004245 }
drh69688d52001-04-14 16:38:23 +00004246 return rc;
drhed7c8552001-04-11 14:29:21 +00004247}
4248
4249/*
danielk19774099f6e2007-03-19 11:25:20 +00004250** This function is used to mark a data-page as writable. It uses
4251** pager_write() to open a journal file (if it is not already open)
4252** and write the page *pData to the journal.
4253**
4254** The difference between this function and pager_write() is that this
4255** function also deals with the special case where 2 or more pages
4256** fit on a single disk sector. In this case all co-resident pages
4257** must have been written to the journal file before returning.
4258*/
danielk19773b8a05f2007-03-19 17:44:26 +00004259int sqlite3PagerWrite(DbPage *pDbPage){
danielk19774099f6e2007-03-19 11:25:20 +00004260 int rc = SQLITE_OK;
4261
danielk19773b8a05f2007-03-19 17:44:26 +00004262 PgHdr *pPg = pDbPage;
danielk19774099f6e2007-03-19 11:25:20 +00004263 Pager *pPager = pPg->pPager;
4264 Pgno nPagePerSector = (pPager->sectorSize/pPager->pageSize);
4265
drh86f8c192007-08-22 00:39:19 +00004266 pagerEnter(pPager);
danielk19774099f6e2007-03-19 11:25:20 +00004267 if( !MEMDB && nPagePerSector>1 ){
4268 Pgno nPageCount; /* Total number of pages in database file */
4269 Pgno pg1; /* First page of the sector pPg is located on. */
4270 int nPage; /* Number of pages starting at pg1 to journal */
4271 int ii;
danielk1977dd97a492007-08-22 18:54:32 +00004272 int needSync = 0;
danielk19774099f6e2007-03-19 11:25:20 +00004273
4274 /* Set the doNotSync flag to 1. This is because we cannot allow a journal
4275 ** header to be written between the pages journaled by this function.
4276 */
4277 assert( pPager->doNotSync==0 );
4278 pPager->doNotSync = 1;
4279
4280 /* This trick assumes that both the page-size and sector-size are
4281 ** an integer power of 2. It sets variable pg1 to the identifier
4282 ** of the first page of the sector pPg is located on.
4283 */
4284 pg1 = ((pPg->pgno-1) & ~(nPagePerSector-1)) + 1;
4285
danielk19773b8a05f2007-03-19 17:44:26 +00004286 nPageCount = sqlite3PagerPagecount(pPager);
danielk19774099f6e2007-03-19 11:25:20 +00004287 if( pPg->pgno>nPageCount ){
4288 nPage = (pPg->pgno - pg1)+1;
4289 }else if( (pg1+nPagePerSector-1)>nPageCount ){
4290 nPage = nPageCount+1-pg1;
4291 }else{
4292 nPage = nPagePerSector;
4293 }
4294 assert(nPage>0);
4295 assert(pg1<=pPg->pgno);
4296 assert((pg1+nPage)>pPg->pgno);
4297
4298 for(ii=0; ii<nPage && rc==SQLITE_OK; ii++){
4299 Pgno pg = pg1+ii;
danielk1977dd97a492007-08-22 18:54:32 +00004300 PgHdr *pPage;
drhf5e7bb52008-02-18 14:47:33 +00004301 if( pg==pPg->pgno || !sqlite3BitvecTest(pPager->pInJournal, pg) ){
danielk19774099f6e2007-03-19 11:25:20 +00004302 if( pg!=PAGER_MJ_PGNO(pPager) ){
danielk19773b8a05f2007-03-19 17:44:26 +00004303 rc = sqlite3PagerGet(pPager, pg, &pPage);
danielk19774099f6e2007-03-19 11:25:20 +00004304 if( rc==SQLITE_OK ){
4305 rc = pager_write(pPage);
danielk1977dd97a492007-08-22 18:54:32 +00004306 if( pPage->needSync ){
4307 needSync = 1;
4308 }
danielk19773b8a05f2007-03-19 17:44:26 +00004309 sqlite3PagerUnref(pPage);
danielk19774099f6e2007-03-19 11:25:20 +00004310 }
4311 }
drhc81945e2008-03-10 14:12:53 +00004312 }else if( (pPage = pager_lookup(pPager, pg))!=0 ){
danielk1977dd97a492007-08-22 18:54:32 +00004313 if( pPage->needSync ){
4314 needSync = 1;
4315 }
danielk19774099f6e2007-03-19 11:25:20 +00004316 }
4317 }
4318
danielk1977dd97a492007-08-22 18:54:32 +00004319 /* If the PgHdr.needSync flag is set for any of the nPage pages
4320 ** starting at pg1, then it needs to be set for all of them. Because
4321 ** writing to any of these nPage pages may damage the others, the
4322 ** journal file must contain sync()ed copies of all of them
4323 ** before any of them can be written out to the database file.
4324 */
4325 if( needSync ){
4326 for(ii=0; ii<nPage && needSync; ii++){
4327 PgHdr *pPage = pager_lookup(pPager, pg1+ii);
4328 if( pPage ) pPage->needSync = 1;
4329 }
4330 assert(pPager->needSync);
4331 }
4332
danielk19774099f6e2007-03-19 11:25:20 +00004333 assert( pPager->doNotSync==1 );
4334 pPager->doNotSync = 0;
4335 }else{
danielk19773b8a05f2007-03-19 17:44:26 +00004336 rc = pager_write(pDbPage);
danielk19774099f6e2007-03-19 11:25:20 +00004337 }
drh86f8c192007-08-22 00:39:19 +00004338 pagerLeave(pPager);
danielk19774099f6e2007-03-19 11:25:20 +00004339 return rc;
4340}
4341
4342/*
drhaacc5432002-01-06 17:07:40 +00004343** Return TRUE if the page given in the argument was previously passed
danielk19773b8a05f2007-03-19 17:44:26 +00004344** to sqlite3PagerWrite(). In other words, return TRUE if it is ok
drh6019e162001-07-02 17:51:45 +00004345** to change the content of the page.
4346*/
danielk19777d3a6662006-01-23 16:21:05 +00004347#ifndef NDEBUG
danielk19773b8a05f2007-03-19 17:44:26 +00004348int sqlite3PagerIswriteable(DbPage *pPg){
drh6019e162001-07-02 17:51:45 +00004349 return pPg->dirty;
4350}
danielk19777d3a6662006-01-23 16:21:05 +00004351#endif
drh6019e162001-07-02 17:51:45 +00004352
danielk1977b84f96f2005-01-20 11:32:23 +00004353#ifndef SQLITE_OMIT_VACUUM
drh6019e162001-07-02 17:51:45 +00004354/*
drh001bbcb2003-03-19 03:14:00 +00004355** Replace the content of a single page with the information in the third
4356** argument.
4357*/
danielk19773b8a05f2007-03-19 17:44:26 +00004358int sqlite3PagerOverwrite(Pager *pPager, Pgno pgno, void *pData){
4359 PgHdr *pPg;
drh001bbcb2003-03-19 03:14:00 +00004360 int rc;
4361
drh86f8c192007-08-22 00:39:19 +00004362 pagerEnter(pPager);
danielk19773b8a05f2007-03-19 17:44:26 +00004363 rc = sqlite3PagerGet(pPager, pgno, &pPg);
drh001bbcb2003-03-19 03:14:00 +00004364 if( rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00004365 rc = sqlite3PagerWrite(pPg);
drh001bbcb2003-03-19 03:14:00 +00004366 if( rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00004367 memcpy(sqlite3PagerGetData(pPg), pData, pPager->pageSize);
drh001bbcb2003-03-19 03:14:00 +00004368 }
danielk19773b8a05f2007-03-19 17:44:26 +00004369 sqlite3PagerUnref(pPg);
drh001bbcb2003-03-19 03:14:00 +00004370 }
drh86f8c192007-08-22 00:39:19 +00004371 pagerLeave(pPager);
drh001bbcb2003-03-19 03:14:00 +00004372 return rc;
4373}
danielk1977b84f96f2005-01-20 11:32:23 +00004374#endif
drh001bbcb2003-03-19 03:14:00 +00004375
4376/*
drh30e58752002-03-02 20:41:57 +00004377** A call to this routine tells the pager that it is not necessary to
drh538f5702007-04-13 02:14:30 +00004378** write the information on page pPg back to the disk, even though
drh30e58752002-03-02 20:41:57 +00004379** that page might be marked as dirty.
4380**
4381** The overlying software layer calls this routine when all of the data
4382** on the given page is unused. The pager marks the page as clean so
4383** that it does not get written to disk.
4384**
4385** Tests show that this optimization, together with the
danielk19773b8a05f2007-03-19 17:44:26 +00004386** sqlite3PagerDontRollback() below, more than double the speed
drh30e58752002-03-02 20:41:57 +00004387** of large INSERT operations and quadruple the speed of large DELETEs.
drh8e298f92002-07-06 16:28:47 +00004388**
4389** When this routine is called, set the alwaysRollback flag to true.
danielk19773b8a05f2007-03-19 17:44:26 +00004390** Subsequent calls to sqlite3PagerDontRollback() for the same page
drh8e298f92002-07-06 16:28:47 +00004391** will thereafter be ignored. This is necessary to avoid a problem
4392** where a page with data is added to the freelist during one part of
4393** a transaction then removed from the freelist during a later part
4394** of the same transaction and reused for some other purpose. When it
4395** is first added to the freelist, this routine is called. When reused,
drh80e35f42007-03-30 14:06:34 +00004396** the sqlite3PagerDontRollback() routine is called. But because the
4397** page contains critical data, we still need to be sure it gets
4398** rolled back in spite of the sqlite3PagerDontRollback() call.
drh30e58752002-03-02 20:41:57 +00004399*/
drh538f5702007-04-13 02:14:30 +00004400void sqlite3PagerDontWrite(DbPage *pDbPage){
4401 PgHdr *pPg = pDbPage;
4402 Pager *pPager = pPg->pPager;
drh8e298f92002-07-06 16:28:47 +00004403
drhb7f91642004-10-31 02:22:47 +00004404 if( MEMDB ) return;
drh86f8c192007-08-22 00:39:19 +00004405 pagerEnter(pPager);
drh8e298f92002-07-06 16:28:47 +00004406 pPg->alwaysRollback = 1;
drh43617e92006-03-06 20:55:46 +00004407 if( pPg->dirty && !pPager->stmtInUse ){
drh1aa2d8b2007-01-03 15:34:29 +00004408 assert( pPager->state>=PAGER_SHARED );
drh8124a302002-06-25 14:43:57 +00004409 if( pPager->dbSize==(int)pPg->pgno && pPager->origDbSize<pPager->dbSize ){
4410 /* If this pages is the last page in the file and the file has grown
4411 ** during the current transaction, then do NOT mark the page as clean.
4412 ** When the database file grows, we must make sure that the last page
4413 ** gets written at least once so that the disk file will be the correct
4414 ** size. If you do not write this page and the size of the file
4415 ** on the disk ends up being too small, that can lead to database
4416 ** corruption during the next transaction.
4417 */
4418 }else{
drh538f5702007-04-13 02:14:30 +00004419 PAGERTRACE3("DONT_WRITE page %d of %d\n", pPg->pgno, PAGERID(pPager));
4420 IOTRACE(("CLEAN %p %d\n", pPager, pPg->pgno))
drh605ad8f2006-05-03 23:34:05 +00004421 makeClean(pPg);
danielk19773c407372005-02-15 02:54:14 +00004422#ifdef SQLITE_CHECK_PAGES
4423 pPg->pageHash = pager_pagehash(pPg);
4424#endif
drh8124a302002-06-25 14:43:57 +00004425 }
drh30e58752002-03-02 20:41:57 +00004426 }
drh86f8c192007-08-22 00:39:19 +00004427 pagerLeave(pPager);
drh30e58752002-03-02 20:41:57 +00004428}
4429
4430/*
4431** A call to this routine tells the pager that if a rollback occurs,
4432** it is not necessary to restore the data on the given page. This
4433** means that the pager does not have to record the given page in the
4434** rollback journal.
drh538f5702007-04-13 02:14:30 +00004435**
4436** If we have not yet actually read the content of this page (if
4437** the PgHdr.needRead flag is set) then this routine acts as a promise
4438** that we will never need to read the page content in the future.
4439** so the needRead flag can be cleared at this point.
drh30e58752002-03-02 20:41:57 +00004440*/
danielk19773b8a05f2007-03-19 17:44:26 +00004441void sqlite3PagerDontRollback(DbPage *pPg){
drh30e58752002-03-02 20:41:57 +00004442 Pager *pPager = pPg->pPager;
4443
drh86f8c192007-08-22 00:39:19 +00004444 pagerEnter(pPager);
drhd3627af2006-12-18 18:34:51 +00004445 assert( pPager->state>=PAGER_RESERVED );
danielk1977a55e9352008-01-21 13:04:34 +00004446
4447 /* If the journal file is not open, or DontWrite() has been called on
4448 ** this page (DontWrite() sets the alwaysRollback flag), then this
4449 ** function is a no-op.
4450 */
4451 if( pPager->journalOpen==0 || pPg->alwaysRollback || pPager->alwaysRollback ){
danielk197787c29a92008-01-18 11:33:16 +00004452 pagerLeave(pPager);
4453 return;
4454 }
danielk1977a55e9352008-01-21 13:04:34 +00004455 assert( !MEMDB ); /* For a memdb, pPager->journalOpen is always 0 */
4456
drhc5d0bd92008-04-14 01:00:57 +00004457#ifdef SQLITE_SECURE_DELETE
4458 if( pPg->inJournal || (int)pPg->pgno > pPager->origDbSize ){
4459 return;
4460 }
4461#endif
4462
4463 /* If SECURE_DELETE is disabled, then there is no way that this
4464 ** routine can be called on a page for which sqlite3PagerDontWrite()
4465 ** has not been previously called during the same transaction.
4466 ** And if DontWrite() has previously been called, the following
4467 ** conditions must be met.
danielk1977a55e9352008-01-21 13:04:34 +00004468 */
4469 assert( !pPg->inJournal && (int)pPg->pgno <= pPager->origDbSize );
4470
drhf5e7bb52008-02-18 14:47:33 +00004471 assert( pPager->pInJournal!=0 );
4472 sqlite3BitvecSet(pPager->pInJournal, pPg->pgno);
danielk1977a55e9352008-01-21 13:04:34 +00004473 pPg->inJournal = 1;
4474 pPg->needRead = 0;
4475 if( pPager->stmtInUse ){
drhc5d0bd92008-04-14 01:00:57 +00004476 assert( pPager->stmtSize >= pPager->origDbSize );
drhf5e7bb52008-02-18 14:47:33 +00004477 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
drh30e58752002-03-02 20:41:57 +00004478 }
danielk1977a55e9352008-01-21 13:04:34 +00004479 PAGERTRACE3("DONT_ROLLBACK page %d of %d\n", pPg->pgno, PAGERID(pPager));
4480 IOTRACE(("GARBAGE %p %d\n", pPager, pPg->pgno))
drh86f8c192007-08-22 00:39:19 +00004481 pagerLeave(pPager);
drh30e58752002-03-02 20:41:57 +00004482}
4483
drhac69b052004-05-12 13:30:07 +00004484
drh30e58752002-03-02 20:41:57 +00004485/*
drh80e35f42007-03-30 14:06:34 +00004486** This routine is called to increment the database file change-counter,
4487** stored at byte 24 of the pager file.
4488*/
danielk1977c7b60172007-08-22 11:22:03 +00004489static int pager_incr_changecounter(Pager *pPager, int isDirect){
drh80e35f42007-03-30 14:06:34 +00004490 PgHdr *pPgHdr;
4491 u32 change_counter;
danielk1977c7b60172007-08-22 11:22:03 +00004492 int rc = SQLITE_OK;
drh80e35f42007-03-30 14:06:34 +00004493
4494 if( !pPager->changeCountDone ){
4495 /* Open page 1 of the file for writing. */
4496 rc = sqlite3PagerGet(pPager, 1, &pPgHdr);
4497 if( rc!=SQLITE_OK ) return rc;
danielk1977c7b60172007-08-22 11:22:03 +00004498
4499 if( !isDirect ){
4500 rc = sqlite3PagerWrite(pPgHdr);
danielk1977ae72d982007-10-03 08:46:44 +00004501 if( rc!=SQLITE_OK ){
4502 sqlite3PagerUnref(pPgHdr);
4503 return rc;
4504 }
danielk1977c7b60172007-08-22 11:22:03 +00004505 }
4506
drh80e35f42007-03-30 14:06:34 +00004507 /* Increment the value just read and write it back to byte 24. */
drhb1003912007-07-20 00:33:36 +00004508 change_counter = sqlite3Get4byte((u8*)pPager->dbFileVers);
drh80e35f42007-03-30 14:06:34 +00004509 change_counter++;
4510 put32bits(((char*)PGHDR_TO_DATA(pPgHdr))+24, change_counter);
danielk1977c7b60172007-08-22 11:22:03 +00004511
4512 if( isDirect && pPager->fd->pMethods ){
4513 const void *zBuf = PGHDR_TO_DATA(pPgHdr);
4514 rc = sqlite3OsWrite(pPager->fd, zBuf, pPager->pageSize, 0);
4515 }
4516
drh80e35f42007-03-30 14:06:34 +00004517 /* Release the page reference. */
4518 sqlite3PagerUnref(pPgHdr);
4519 pPager->changeCountDone = 1;
4520 }
danielk1977c7b60172007-08-22 11:22:03 +00004521 return rc;
drh80e35f42007-03-30 14:06:34 +00004522}
4523
4524/*
danielk1977f653d782008-03-20 11:04:21 +00004525** Sync the pager file to disk.
4526*/
4527int sqlite3PagerSync(Pager *pPager){
4528 int rc;
4529 pagerEnter(pPager);
4530 rc = sqlite3OsSync(pPager->fd, pPager->sync_flags);
4531 pagerLeave(pPager);
4532 return rc;
4533}
4534
4535/*
drh80e35f42007-03-30 14:06:34 +00004536** Sync the database file for the pager pPager. zMaster points to the name
4537** of a master journal file that should be written into the individual
4538** journal file. zMaster may be NULL, which is interpreted as no master
4539** journal (a single database transaction).
4540**
4541** This routine ensures that the journal is synced, all dirty pages written
4542** to the database file and the database file synced. The only thing that
4543** remains to commit the transaction is to delete the journal file (or
4544** master journal file if specified).
4545**
4546** Note that if zMaster==NULL, this does not overwrite a previous value
4547** passed to an sqlite3PagerCommitPhaseOne() call.
4548**
4549** If parameter nTrunc is non-zero, then the pager file is truncated to
4550** nTrunc pages (this is used by auto-vacuum databases).
danielk1977f653d782008-03-20 11:04:21 +00004551**
4552** If the final parameter - noSync - is true, then the database file itself
4553** is not synced. The caller must call sqlite3PagerSync() directly to
4554** sync the database file before calling CommitPhaseTwo() to delete the
4555** journal file in this case.
drh80e35f42007-03-30 14:06:34 +00004556*/
danielk1977f653d782008-03-20 11:04:21 +00004557int sqlite3PagerCommitPhaseOne(
4558 Pager *pPager,
4559 const char *zMaster,
4560 Pgno nTrunc,
4561 int noSync
4562){
drh80e35f42007-03-30 14:06:34 +00004563 int rc = SQLITE_OK;
4564
4565 PAGERTRACE4("DATABASE SYNC: File=%s zMaster=%s nTrunc=%d\n",
4566 pPager->zFilename, zMaster, nTrunc);
drh86f8c192007-08-22 00:39:19 +00004567 pagerEnter(pPager);
drh80e35f42007-03-30 14:06:34 +00004568
4569 /* If this is an in-memory db, or no pages have been written to, or this
4570 ** function has already been called, it is a no-op.
4571 */
4572 if( pPager->state!=PAGER_SYNCED && !MEMDB && pPager->dirtyCache ){
4573 PgHdr *pPg;
drh80e35f42007-03-30 14:06:34 +00004574
danielk1977c7b60172007-08-22 11:22:03 +00004575#ifdef SQLITE_ENABLE_ATOMIC_WRITE
4576 /* The atomic-write optimization can be used if all of the
4577 ** following are true:
4578 **
4579 ** + The file-system supports the atomic-write property for
4580 ** blocks of size page-size, and
4581 ** + This commit is not part of a multi-file transaction, and
4582 ** + Exactly one page has been modified and store in the journal file.
4583 **
4584 ** If the optimization can be used, then the journal file will never
4585 ** be created for this transaction.
4586 */
danielk1977f55b8992007-08-24 08:15:53 +00004587 int useAtomicWrite = (
4588 !zMaster &&
4589 pPager->journalOff==jrnlBufferSize(pPager) &&
4590 nTrunc==0 &&
4591 (0==pPager->pDirty || 0==pPager->pDirty->pDirty)
4592 );
4593 if( useAtomicWrite ){
danielk1977c7b60172007-08-22 11:22:03 +00004594 /* Update the nRec field in the journal file. */
4595 int offset = pPager->journalHdr + sizeof(aJournalMagic);
4596 assert(pPager->nRec==1);
4597 rc = write32bits(pPager->jfd, offset, pPager->nRec);
4598
4599 /* Update the db file change counter. The following call will modify
4600 ** the in-memory representation of page 1 to include the updated
4601 ** change counter and then write page 1 directly to the database
4602 ** file. Because of the atomic-write property of the host file-system,
4603 ** this is safe.
4604 */
danielk1977ae72d982007-10-03 08:46:44 +00004605 if( rc==SQLITE_OK ){
4606 rc = pager_incr_changecounter(pPager, 1);
4607 }
danielk1977f55b8992007-08-24 08:15:53 +00004608 }else{
4609 rc = sqlite3JournalCreate(pPager->jfd);
danielk1977f55b8992007-08-24 08:15:53 +00004610 }
4611
danielk1977ae72d982007-10-03 08:46:44 +00004612 if( !useAtomicWrite && rc==SQLITE_OK )
danielk1977c7b60172007-08-22 11:22:03 +00004613#endif
4614
drh80e35f42007-03-30 14:06:34 +00004615 /* If a master journal file name has already been written to the
4616 ** journal file, then no sync is required. This happens when it is
4617 ** written, then the process fails to upgrade from a RESERVED to an
4618 ** EXCLUSIVE lock. The next time the process tries to commit the
4619 ** transaction the m-j name will have already been written.
4620 */
4621 if( !pPager->setMaster ){
danielk1977f55b8992007-08-24 08:15:53 +00004622 assert( pPager->journalOpen );
danielk1977c7b60172007-08-22 11:22:03 +00004623 rc = pager_incr_changecounter(pPager, 0);
drh80e35f42007-03-30 14:06:34 +00004624 if( rc!=SQLITE_OK ) goto sync_exit;
4625#ifndef SQLITE_OMIT_AUTOVACUUM
4626 if( nTrunc!=0 ){
4627 /* If this transaction has made the database smaller, then all pages
4628 ** being discarded by the truncation must be written to the journal
4629 ** file.
4630 */
4631 Pgno i;
4632 int iSkip = PAGER_MJ_PGNO(pPager);
4633 for( i=nTrunc+1; i<=pPager->origDbSize; i++ ){
drhf5e7bb52008-02-18 14:47:33 +00004634 if( !sqlite3BitvecTest(pPager->pInJournal, i) && i!=iSkip ){
drh80e35f42007-03-30 14:06:34 +00004635 rc = sqlite3PagerGet(pPager, i, &pPg);
4636 if( rc!=SQLITE_OK ) goto sync_exit;
4637 rc = sqlite3PagerWrite(pPg);
4638 sqlite3PagerUnref(pPg);
4639 if( rc!=SQLITE_OK ) goto sync_exit;
4640 }
4641 }
4642 }
4643#endif
4644 rc = writeMasterJournal(pPager, zMaster);
4645 if( rc!=SQLITE_OK ) goto sync_exit;
4646 rc = syncJournal(pPager);
drh80e35f42007-03-30 14:06:34 +00004647 }
danielk1977c7b60172007-08-22 11:22:03 +00004648 if( rc!=SQLITE_OK ) goto sync_exit;
drh80e35f42007-03-30 14:06:34 +00004649
4650#ifndef SQLITE_OMIT_AUTOVACUUM
4651 if( nTrunc!=0 ){
4652 rc = sqlite3PagerTruncate(pPager, nTrunc);
4653 if( rc!=SQLITE_OK ) goto sync_exit;
4654 }
4655#endif
4656
4657 /* Write all dirty pages to the database file */
4658 pPg = pager_get_all_dirty_pages(pPager);
4659 rc = pager_write_pagelist(pPg);
drh153c62c2007-08-24 03:51:33 +00004660 if( rc!=SQLITE_OK ){
drh04c3a462008-02-26 16:16:45 +00004661 assert( rc!=SQLITE_IOERR_BLOCKED );
4662 /* The error might have left the dirty list all fouled up here,
4663 ** but that does not matter because if the if the dirty list did
4664 ** get corrupted, then the transaction will roll back and
4665 ** discard the dirty list. There is an assert in
4666 ** pager_get_all_dirty_pages() that verifies that no attempt
4667 ** is made to use an invalid dirty list.
4668 */
drh153c62c2007-08-24 03:51:33 +00004669 goto sync_exit;
4670 }
drh3cdd7d32007-03-30 14:46:01 +00004671 pPager->pDirty = 0;
drh80e35f42007-03-30 14:06:34 +00004672
4673 /* Sync the database file. */
danielk1977f653d782008-03-20 11:04:21 +00004674 if( !pPager->noSync && !noSync ){
danielk1977f036aef2007-08-20 05:36:51 +00004675 rc = sqlite3OsSync(pPager->fd, pPager->sync_flags);
drh80e35f42007-03-30 14:06:34 +00004676 }
4677 IOTRACE(("DBSYNC %p\n", pPager))
4678
4679 pPager->state = PAGER_SYNCED;
4680 }else if( MEMDB && nTrunc!=0 ){
4681 rc = sqlite3PagerTruncate(pPager, nTrunc);
4682 }
4683
4684sync_exit:
danielk1977e965ac72007-06-13 15:22:28 +00004685 if( rc==SQLITE_IOERR_BLOCKED ){
4686 /* pager_incr_changecounter() may attempt to obtain an exclusive
4687 * lock to spill the cache and return IOERR_BLOCKED. But since
drh85b623f2007-12-13 21:54:09 +00004688 * there is no chance the cache is inconsistent, it is
danielk1977e965ac72007-06-13 15:22:28 +00004689 * better to return SQLITE_BUSY.
4690 */
4691 rc = SQLITE_BUSY;
4692 }
drh86f8c192007-08-22 00:39:19 +00004693 pagerLeave(pPager);
drh80e35f42007-03-30 14:06:34 +00004694 return rc;
4695}
4696
4697
4698/*
drhed7c8552001-04-11 14:29:21 +00004699** Commit all changes to the database and release the write lock.
drhd9b02572001-04-15 00:37:09 +00004700**
4701** If the commit fails for any reason, a rollback attempt is made
4702** and an error code is returned. If the commit worked, SQLITE_OK
4703** is returned.
drhed7c8552001-04-11 14:29:21 +00004704*/
drh80e35f42007-03-30 14:06:34 +00004705int sqlite3PagerCommitPhaseTwo(Pager *pPager){
drha1b351a2001-09-14 16:42:12 +00004706 int rc;
drhed7c8552001-04-11 14:29:21 +00004707 PgHdr *pPg;
drhd9b02572001-04-15 00:37:09 +00004708
danielk1977efaaf572006-01-16 11:29:19 +00004709 if( pPager->errCode ){
danielk19777f7bc662006-01-23 13:47:47 +00004710 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00004711 }
drha6abd042004-06-09 17:37:22 +00004712 if( pPager->state<PAGER_RESERVED ){
drhd9b02572001-04-15 00:37:09 +00004713 return SQLITE_ERROR;
4714 }
drh86f8c192007-08-22 00:39:19 +00004715 pagerEnter(pPager);
drh4f0c5872007-03-26 22:05:01 +00004716 PAGERTRACE2("COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004717 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004718 pPg = pager_get_all_dirty_pages(pPager);
4719 while( pPg ){
danielk1977f35843b2007-04-07 15:03:17 +00004720 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
4721 clearHistory(pHist);
drhac69b052004-05-12 13:30:07 +00004722 pPg->dirty = 0;
4723 pPg->inJournal = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004724 pHist->inStmt = 0;
drh5229ae42006-03-23 23:29:04 +00004725 pPg->needSync = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004726 pHist->pPrevStmt = pHist->pNextStmt = 0;
drhac69b052004-05-12 13:30:07 +00004727 pPg = pPg->pDirty;
4728 }
drh605ad8f2006-05-03 23:34:05 +00004729 pPager->pDirty = 0;
danielk1977eac7a362004-06-16 07:45:24 +00004730#ifndef NDEBUG
4731 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
4732 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
4733 assert( !pPg->alwaysRollback );
4734 assert( !pHist->pOrig );
4735 assert( !pHist->pStmt );
4736 }
4737#endif
drhac69b052004-05-12 13:30:07 +00004738 pPager->pStmt = 0;
drha6abd042004-06-09 17:37:22 +00004739 pPager->state = PAGER_SHARED;
danielk197787c29a92008-01-18 11:33:16 +00004740 pagerLeave(pPager);
drhac69b052004-05-12 13:30:07 +00004741 return SQLITE_OK;
4742 }
drh3cdd7d32007-03-30 14:46:01 +00004743 assert( pPager->journalOpen || !pPager->dirtyCache );
4744 assert( pPager->state==PAGER_SYNCED || !pPager->dirtyCache );
4745 rc = pager_end_transaction(pPager);
drh86f8c192007-08-22 00:39:19 +00004746 rc = pager_error(pPager, rc);
4747 pagerLeave(pPager);
4748 return rc;
drhed7c8552001-04-11 14:29:21 +00004749}
4750
4751/*
drha6abd042004-06-09 17:37:22 +00004752** Rollback all changes. The database falls back to PAGER_SHARED mode.
drhed7c8552001-04-11 14:29:21 +00004753** All in-memory cache pages revert to their original data contents.
4754** The journal is deleted.
drhd9b02572001-04-15 00:37:09 +00004755**
4756** This routine cannot fail unless some other process is not following
drh4f0ee682007-03-30 20:43:40 +00004757** the correct locking protocol or unless some other
drhd9b02572001-04-15 00:37:09 +00004758** process is writing trash into the journal file (SQLITE_CORRUPT) or
4759** unless a prior malloc() failed (SQLITE_NOMEM). Appropriate error
4760** codes are returned for all these occasions. Otherwise,
4761** SQLITE_OK is returned.
drhed7c8552001-04-11 14:29:21 +00004762*/
danielk19773b8a05f2007-03-19 17:44:26 +00004763int sqlite3PagerRollback(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +00004764 int rc;
drh4f0c5872007-03-26 22:05:01 +00004765 PAGERTRACE2("ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004766 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004767 PgHdr *p;
4768 for(p=pPager->pAll; p; p=p->pNextAll){
4769 PgHistory *pHist;
danielk1977eac7a362004-06-16 07:45:24 +00004770 assert( !p->alwaysRollback );
4771 if( !p->dirty ){
4772 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pOrig );
4773 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pStmt );
4774 continue;
4775 }
4776
drhac69b052004-05-12 13:30:07 +00004777 pHist = PGHDR_TO_HIST(p, pPager);
4778 if( pHist->pOrig ){
4779 memcpy(PGHDR_TO_DATA(p), pHist->pOrig, pPager->pageSize);
drh4f0c5872007-03-26 22:05:01 +00004780 PAGERTRACE3("ROLLBACK-PAGE %d of %d\n", p->pgno, PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00004781 }else{
drh4f0c5872007-03-26 22:05:01 +00004782 PAGERTRACE3("PAGE %d is clean on %d\n", p->pgno, PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00004783 }
4784 clearHistory(pHist);
4785 p->dirty = 0;
4786 p->inJournal = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004787 pHist->inStmt = 0;
4788 pHist->pPrevStmt = pHist->pNextStmt = 0;
danielk1977369f27e2004-06-15 11:40:04 +00004789 if( pPager->xReiniter ){
danielk19773b8a05f2007-03-19 17:44:26 +00004790 pPager->xReiniter(p, pPager->pageSize);
danielk1977369f27e2004-06-15 11:40:04 +00004791 }
drhac69b052004-05-12 13:30:07 +00004792 }
drh605ad8f2006-05-03 23:34:05 +00004793 pPager->pDirty = 0;
drhac69b052004-05-12 13:30:07 +00004794 pPager->pStmt = 0;
4795 pPager->dbSize = pPager->origDbSize;
danielk1977e180dd92007-04-05 17:15:52 +00004796 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00004797 pPager->stmtInUse = 0;
drha6abd042004-06-09 17:37:22 +00004798 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00004799 return SQLITE_OK;
4800 }
4801
drh86f8c192007-08-22 00:39:19 +00004802 pagerEnter(pPager);
drha6abd042004-06-09 17:37:22 +00004803 if( !pPager->dirtyCache || !pPager->journalOpen ){
drh80e35f42007-03-30 14:06:34 +00004804 rc = pager_end_transaction(pPager);
drh86f8c192007-08-22 00:39:19 +00004805 pagerLeave(pPager);
drhda47d772002-12-02 04:25:19 +00004806 return rc;
4807 }
drhdb48ee02003-01-16 13:42:43 +00004808
danielk1977efaaf572006-01-16 11:29:19 +00004809 if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
drha6abd042004-06-09 17:37:22 +00004810 if( pPager->state>=PAGER_EXCLUSIVE ){
danielk1977e277be02007-03-23 18:12:06 +00004811 pager_playback(pPager, 0);
drh4b845d72002-03-05 12:41:19 +00004812 }
drh86f8c192007-08-22 00:39:19 +00004813 pagerLeave(pPager);
danielk1977efaaf572006-01-16 11:29:19 +00004814 return pPager->errCode;
drhed7c8552001-04-11 14:29:21 +00004815 }
drha6abd042004-06-09 17:37:22 +00004816 if( pPager->state==PAGER_RESERVED ){
danielk197717221812005-02-15 03:38:05 +00004817 int rc2;
danielk1977e277be02007-03-23 18:12:06 +00004818 rc = pager_playback(pPager, 0);
drh80e35f42007-03-30 14:06:34 +00004819 rc2 = pager_end_transaction(pPager);
drha6abd042004-06-09 17:37:22 +00004820 if( rc==SQLITE_OK ){
4821 rc = rc2;
4822 }
4823 }else{
danielk1977e277be02007-03-23 18:12:06 +00004824 rc = pager_playback(pPager, 0);
drhd9b02572001-04-15 00:37:09 +00004825 }
danielk1977e180dd92007-04-05 17:15:52 +00004826 /* pager_reset(pPager); */
drhd9b02572001-04-15 00:37:09 +00004827 pPager->dbSize = -1;
danielk197707cb5602006-01-20 10:55:05 +00004828
4829 /* If an error occurs during a ROLLBACK, we can no longer trust the pager
4830 ** cache. So call pager_error() on the way out to make any error
4831 ** persistent.
4832 */
drh86f8c192007-08-22 00:39:19 +00004833 rc = pager_error(pPager, rc);
4834 pagerLeave(pPager);
4835 return rc;
drh98808ba2001-10-18 12:34:46 +00004836}
drhd9b02572001-04-15 00:37:09 +00004837
4838/*
drh5e00f6c2001-09-13 13:46:56 +00004839** Return TRUE if the database file is opened read-only. Return FALSE
4840** if the database is (in theory) writable.
4841*/
danielk19773b8a05f2007-03-19 17:44:26 +00004842int sqlite3PagerIsreadonly(Pager *pPager){
drhbe0072d2001-09-13 14:46:09 +00004843 return pPager->readOnly;
drh5e00f6c2001-09-13 13:46:56 +00004844}
4845
4846/*
drh0f7eb612006-08-08 13:51:43 +00004847** Return the number of references to the pager.
4848*/
danielk19773b8a05f2007-03-19 17:44:26 +00004849int sqlite3PagerRefcount(Pager *pPager){
drh0f7eb612006-08-08 13:51:43 +00004850 return pPager->nRef;
4851}
4852
4853#ifdef SQLITE_TEST
4854/*
drhd9b02572001-04-15 00:37:09 +00004855** This routine is used for testing and analysis only.
4856*/
danielk19773b8a05f2007-03-19 17:44:26 +00004857int *sqlite3PagerStats(Pager *pPager){
danielk197742741be2005-01-08 12:42:39 +00004858 static int a[11];
drhd9b02572001-04-15 00:37:09 +00004859 a[0] = pPager->nRef;
4860 a[1] = pPager->nPage;
4861 a[2] = pPager->mxPage;
4862 a[3] = pPager->dbSize;
4863 a[4] = pPager->state;
danielk1977efaaf572006-01-16 11:29:19 +00004864 a[5] = pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00004865 a[6] = pPager->nHit;
4866 a[7] = pPager->nMiss;
drh7c4ac0c2007-04-05 11:25:58 +00004867 a[8] = 0; /* Used to be pPager->nOvfl */
danielk197742741be2005-01-08 12:42:39 +00004868 a[9] = pPager->nRead;
4869 a[10] = pPager->nWrite;
drhd9b02572001-04-15 00:37:09 +00004870 return a;
4871}
drh0f7eb612006-08-08 13:51:43 +00004872#endif
drhdd793422001-06-28 01:54:48 +00004873
drhfa86c412002-02-02 15:01:15 +00004874/*
drhac69b052004-05-12 13:30:07 +00004875** Set the statement rollback point.
drhfa86c412002-02-02 15:01:15 +00004876**
4877** This routine should be called with the transaction journal already
drhac69b052004-05-12 13:30:07 +00004878** open. A new statement journal is created that can be used to rollback
drhaaab5722002-02-19 13:39:21 +00004879** changes of a single SQL command within a larger transaction.
drhfa86c412002-02-02 15:01:15 +00004880*/
drh86f8c192007-08-22 00:39:19 +00004881static int pagerStmtBegin(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00004882 int rc;
drhac69b052004-05-12 13:30:07 +00004883 assert( !pPager->stmtInUse );
drh1aa2d8b2007-01-03 15:34:29 +00004884 assert( pPager->state>=PAGER_SHARED );
drhdc3ff9c2004-08-18 02:10:15 +00004885 assert( pPager->dbSize>=0 );
drh4f0c5872007-03-26 22:05:01 +00004886 PAGERTRACE2("STMT-BEGIN %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004887 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004888 pPager->stmtInUse = 1;
4889 pPager->stmtSize = pPager->dbSize;
4890 return SQLITE_OK;
4891 }
drhda47d772002-12-02 04:25:19 +00004892 if( !pPager->journalOpen ){
drhac69b052004-05-12 13:30:07 +00004893 pPager->stmtAutoopen = 1;
drhda47d772002-12-02 04:25:19 +00004894 return SQLITE_OK;
4895 }
drhfa86c412002-02-02 15:01:15 +00004896 assert( pPager->journalOpen );
drhed138fb2007-08-22 22:04:37 +00004897 pagerLeave(pPager);
drhf5e7bb52008-02-18 14:47:33 +00004898 assert( pPager->pInStmt==0 );
4899 pPager->pInStmt = sqlite3BitvecCreate(pPager->dbSize);
drhed138fb2007-08-22 22:04:37 +00004900 pagerEnter(pPager);
drhf5e7bb52008-02-18 14:47:33 +00004901 if( pPager->pInStmt==0 ){
danielk1977261919c2005-12-06 12:52:59 +00004902 /* sqlite3OsLock(pPager->fd, SHARED_LOCK); */
drhfa86c412002-02-02 15:01:15 +00004903 return SQLITE_NOMEM;
4904 }
danielk197776572402004-06-25 02:38:54 +00004905 pPager->stmtJSize = pPager->journalOff;
drhac69b052004-05-12 13:30:07 +00004906 pPager->stmtSize = pPager->dbSize;
danielk197776572402004-06-25 02:38:54 +00004907 pPager->stmtHdrOff = 0;
danielk197775edc162004-06-26 01:48:18 +00004908 pPager->stmtCksum = pPager->cksumInit;
drhac69b052004-05-12 13:30:07 +00004909 if( !pPager->stmtOpen ){
drh334b2992007-09-06 23:28:23 +00004910 rc = sqlite3PagerOpentemp(pPager->pVfs, pPager->stfd, pPager->zStmtJrnl,
drh33f4e022007-09-03 15:19:34 +00004911 SQLITE_OPEN_SUBJOURNAL);
drh334b2992007-09-06 23:28:23 +00004912 if( rc ){
4913 goto stmt_begin_failed;
4914 }
drhac69b052004-05-12 13:30:07 +00004915 pPager->stmtOpen = 1;
4916 pPager->stmtNRec = 0;
drh0f892532002-05-30 12:27:03 +00004917 }
drhac69b052004-05-12 13:30:07 +00004918 pPager->stmtInUse = 1;
drhfa86c412002-02-02 15:01:15 +00004919 return SQLITE_OK;
4920
drhac69b052004-05-12 13:30:07 +00004921stmt_begin_failed:
drhf5e7bb52008-02-18 14:47:33 +00004922 if( pPager->pInStmt ){
4923 sqlite3BitvecDestroy(pPager->pInStmt);
4924 pPager->pInStmt = 0;
drhfa86c412002-02-02 15:01:15 +00004925 }
4926 return rc;
4927}
drh86f8c192007-08-22 00:39:19 +00004928int sqlite3PagerStmtBegin(Pager *pPager){
4929 int rc;
4930 pagerEnter(pPager);
4931 rc = pagerStmtBegin(pPager);
4932 pagerLeave(pPager);
4933 return rc;
4934}
drhfa86c412002-02-02 15:01:15 +00004935
4936/*
drhac69b052004-05-12 13:30:07 +00004937** Commit a statement.
drhfa86c412002-02-02 15:01:15 +00004938*/
danielk19773b8a05f2007-03-19 17:44:26 +00004939int sqlite3PagerStmtCommit(Pager *pPager){
drh86f8c192007-08-22 00:39:19 +00004940 pagerEnter(pPager);
drhac69b052004-05-12 13:30:07 +00004941 if( pPager->stmtInUse ){
drh03eb96a2002-11-10 23:32:56 +00004942 PgHdr *pPg, *pNext;
drh4f0c5872007-03-26 22:05:01 +00004943 PAGERTRACE2("STMT-COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004944 if( !MEMDB ){
drh054889e2005-11-30 03:20:31 +00004945 /* sqlite3OsTruncate(pPager->stfd, 0); */
drhf5e7bb52008-02-18 14:47:33 +00004946 sqlite3BitvecDestroy(pPager->pInStmt);
4947 pPager->pInStmt = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004948 }else{
4949 for(pPg=pPager->pStmt; pPg; pPg=pNext){
drhac69b052004-05-12 13:30:07 +00004950 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
danielk1977f35843b2007-04-07 15:03:17 +00004951 pNext = pHist->pNextStmt;
4952 assert( pHist->inStmt );
4953 pHist->inStmt = 0;
4954 pHist->pPrevStmt = pHist->pNextStmt = 0;
drh17435752007-08-16 04:30:38 +00004955 sqlite3_free(pHist->pStmt);
drhac69b052004-05-12 13:30:07 +00004956 pHist->pStmt = 0;
4957 }
4958 }
4959 pPager->stmtNRec = 0;
4960 pPager->stmtInUse = 0;
4961 pPager->pStmt = 0;
drh663fc632002-02-02 18:49:19 +00004962 }
drhac69b052004-05-12 13:30:07 +00004963 pPager->stmtAutoopen = 0;
drh86f8c192007-08-22 00:39:19 +00004964 pagerLeave(pPager);
drhfa86c412002-02-02 15:01:15 +00004965 return SQLITE_OK;
4966}
4967
4968/*
drhac69b052004-05-12 13:30:07 +00004969** Rollback a statement.
drhfa86c412002-02-02 15:01:15 +00004970*/
danielk19773b8a05f2007-03-19 17:44:26 +00004971int sqlite3PagerStmtRollback(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00004972 int rc;
drh86f8c192007-08-22 00:39:19 +00004973 pagerEnter(pPager);
drhac69b052004-05-12 13:30:07 +00004974 if( pPager->stmtInUse ){
drh4f0c5872007-03-26 22:05:01 +00004975 PAGERTRACE2("STMT-ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004976 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004977 PgHdr *pPg;
danielk1977f35843b2007-04-07 15:03:17 +00004978 PgHistory *pHist;
4979 for(pPg=pPager->pStmt; pPg; pPg=pHist->pNextStmt){
4980 pHist = PGHDR_TO_HIST(pPg, pPager);
drhac69b052004-05-12 13:30:07 +00004981 if( pHist->pStmt ){
4982 memcpy(PGHDR_TO_DATA(pPg), pHist->pStmt, pPager->pageSize);
drh17435752007-08-16 04:30:38 +00004983 sqlite3_free(pHist->pStmt);
drhac69b052004-05-12 13:30:07 +00004984 pHist->pStmt = 0;
4985 }
4986 }
4987 pPager->dbSize = pPager->stmtSize;
danielk1977e180dd92007-04-05 17:15:52 +00004988 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00004989 rc = SQLITE_OK;
4990 }else{
4991 rc = pager_stmt_playback(pPager);
4992 }
danielk19773b8a05f2007-03-19 17:44:26 +00004993 sqlite3PagerStmtCommit(pPager);
drh663fc632002-02-02 18:49:19 +00004994 }else{
4995 rc = SQLITE_OK;
4996 }
drhac69b052004-05-12 13:30:07 +00004997 pPager->stmtAutoopen = 0;
drh86f8c192007-08-22 00:39:19 +00004998 pagerLeave(pPager);
drhfa86c412002-02-02 15:01:15 +00004999 return rc;
5000}
5001
drh73509ee2003-04-06 20:44:45 +00005002/*
5003** Return the full pathname of the database file.
5004*/
danielk19773b8a05f2007-03-19 17:44:26 +00005005const char *sqlite3PagerFilename(Pager *pPager){
drh73509ee2003-04-06 20:44:45 +00005006 return pPager->zFilename;
5007}
5008
drhb20ea9d2004-02-09 01:20:36 +00005009/*
drhd0679ed2007-08-28 22:24:34 +00005010** Return the VFS structure for the pager.
5011*/
5012const sqlite3_vfs *sqlite3PagerVfs(Pager *pPager){
5013 return pPager->pVfs;
5014}
5015
5016/*
drhcc6bb3e2007-08-31 16:11:35 +00005017** Return the file handle for the database file associated
5018** with the pager. This might return NULL if the file has
5019** not yet been opened.
5020*/
5021sqlite3_file *sqlite3PagerFile(Pager *pPager){
5022 return pPager->fd;
5023}
5024
5025/*
danielk19775865e3d2004-06-14 06:03:57 +00005026** Return the directory of the database file.
5027*/
danielk19773b8a05f2007-03-19 17:44:26 +00005028const char *sqlite3PagerDirname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00005029 return pPager->zDirectory;
5030}
5031
5032/*
5033** Return the full pathname of the journal file.
5034*/
danielk19773b8a05f2007-03-19 17:44:26 +00005035const char *sqlite3PagerJournalname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00005036 return pPager->zJournal;
5037}
5038
5039/*
drh2c8997b2005-08-27 16:36:48 +00005040** Return true if fsync() calls are disabled for this pager. Return FALSE
5041** if fsync()s are executed normally.
5042*/
danielk19773b8a05f2007-03-19 17:44:26 +00005043int sqlite3PagerNosync(Pager *pPager){
drh2c8997b2005-08-27 16:36:48 +00005044 return pPager->noSync;
5045}
5046
drh7c4ac0c2007-04-05 11:25:58 +00005047#ifdef SQLITE_HAS_CODEC
drh2c8997b2005-08-27 16:36:48 +00005048/*
drhb20ea9d2004-02-09 01:20:36 +00005049** Set the codec for this pager
5050*/
danielk19773b8a05f2007-03-19 17:44:26 +00005051void sqlite3PagerSetCodec(
drhb20ea9d2004-02-09 01:20:36 +00005052 Pager *pPager,
drhc001c582006-03-06 18:23:16 +00005053 void *(*xCodec)(void*,void*,Pgno,int),
drhb20ea9d2004-02-09 01:20:36 +00005054 void *pCodecArg
5055){
5056 pPager->xCodec = xCodec;
5057 pPager->pCodecArg = pCodecArg;
5058}
drh7c4ac0c2007-04-05 11:25:58 +00005059#endif
drhb20ea9d2004-02-09 01:20:36 +00005060
danielk1977687566d2004-11-02 12:56:41 +00005061#ifndef SQLITE_OMIT_AUTOVACUUM
5062/*
danielk197787c29a92008-01-18 11:33:16 +00005063** Move the page pPg to location pgno in the file.
danielk1977687566d2004-11-02 12:56:41 +00005064**
drh5e385312007-06-16 04:42:12 +00005065** There must be no references to the page previously located at
5066** pgno (which we call pPgOld) though that page is allowed to be
5067** in cache. If the page previous located at pgno is not already
5068** in the rollback journal, it is not put there by by this routine.
danielk1977687566d2004-11-02 12:56:41 +00005069**
drh5e385312007-06-16 04:42:12 +00005070** References to the page pPg remain valid. Updating any
5071** meta-data associated with pPg (i.e. data stored in the nExtra bytes
danielk1977687566d2004-11-02 12:56:41 +00005072** allocated along with the page) is the responsibility of the caller.
5073**
danielk19775fd057a2005-03-09 13:09:43 +00005074** A transaction must be active when this routine is called. It used to be
5075** required that a statement transaction was not active, but this restriction
5076** has been removed (CREATE INDEX needs to move a page when a statement
5077** transaction is active).
danielk1977687566d2004-11-02 12:56:41 +00005078*/
danielk19773b8a05f2007-03-19 17:44:26 +00005079int sqlite3PagerMovepage(Pager *pPager, DbPage *pPg, Pgno pgno){
drh5e385312007-06-16 04:42:12 +00005080 PgHdr *pPgOld; /* The page being overwritten. */
danielk1977f5fdda82004-11-03 08:44:05 +00005081 int h;
danielk197794daf7f2004-11-08 09:26:09 +00005082 Pgno needSyncPgno = 0;
danielk1977687566d2004-11-02 12:56:41 +00005083
drh86f8c192007-08-22 00:39:19 +00005084 pagerEnter(pPager);
danielk1977687566d2004-11-02 12:56:41 +00005085 assert( pPg->nRef>0 );
5086
drh4f0c5872007-03-26 22:05:01 +00005087 PAGERTRACE5("MOVE %d page %d (needSync=%d) moves to %d\n",
danielk1977599fcba2004-11-08 07:13:13 +00005088 PAGERID(pPager), pPg->pgno, pPg->needSync, pgno);
drhb0603412007-02-28 04:47:26 +00005089 IOTRACE(("MOVE %p %d %d\n", pPager, pPg->pgno, pgno))
danielk1977ef73ee92004-11-06 12:26:07 +00005090
danielk1977b4626a32007-04-28 15:47:43 +00005091 pager_get_content(pPg);
danielk197794daf7f2004-11-08 09:26:09 +00005092 if( pPg->needSync ){
5093 needSyncPgno = pPg->pgno;
drh4f0aee42007-06-16 18:39:41 +00005094 assert( pPg->inJournal || (int)pgno>pPager->origDbSize );
danielk197794daf7f2004-11-08 09:26:09 +00005095 assert( pPg->dirty );
danielk1977ae825582004-11-23 09:06:55 +00005096 assert( pPager->needSync );
danielk197794daf7f2004-11-08 09:26:09 +00005097 }
5098
drh85b623f2007-12-13 21:54:09 +00005099 /* Unlink pPg from its hash-chain */
danielk1977f5fdda82004-11-03 08:44:05 +00005100 unlinkHashChain(pPager, pPg);
danielk1977687566d2004-11-02 12:56:41 +00005101
danielk1977ef73ee92004-11-06 12:26:07 +00005102 /* If the cache contains a page with page-number pgno, remove it
drh85b623f2007-12-13 21:54:09 +00005103 ** from its hash chain. Also, if the PgHdr.needSync was set for
danielk1977599fcba2004-11-08 07:13:13 +00005104 ** page pgno before the 'move' operation, it needs to be retained
5105 ** for the page moved there.
danielk1977f5fdda82004-11-03 08:44:05 +00005106 */
drh5e385312007-06-16 04:42:12 +00005107 pPg->needSync = 0;
danielk1977687566d2004-11-02 12:56:41 +00005108 pPgOld = pager_lookup(pPager, pgno);
5109 if( pPgOld ){
danielk1977f5fdda82004-11-03 08:44:05 +00005110 assert( pPgOld->nRef==0 );
5111 unlinkHashChain(pPager, pPgOld);
drh605ad8f2006-05-03 23:34:05 +00005112 makeClean(pPgOld);
drh5e385312007-06-16 04:42:12 +00005113 pPg->needSync = pPgOld->needSync;
5114 }else{
5115 pPg->needSync = 0;
5116 }
drhf5e7bb52008-02-18 14:47:33 +00005117 pPg->inJournal = sqlite3BitvecTest(pPager->pInJournal, pgno);
danielk1977687566d2004-11-02 12:56:41 +00005118
danielk1977f5fdda82004-11-03 08:44:05 +00005119 /* Change the page number for pPg and insert it into the new hash-chain. */
drh3765df42006-06-28 18:18:09 +00005120 assert( pgno!=0 );
danielk1977f5fdda82004-11-03 08:44:05 +00005121 pPg->pgno = pgno;
drh8ca0c722006-05-07 17:49:38 +00005122 h = pgno & (pPager->nHash-1);
danielk1977f5fdda82004-11-03 08:44:05 +00005123 if( pPager->aHash[h] ){
5124 assert( pPager->aHash[h]->pPrevHash==0 );
5125 pPager->aHash[h]->pPrevHash = pPg;
5126 }
5127 pPg->pNextHash = pPager->aHash[h];
5128 pPager->aHash[h] = pPg;
5129 pPg->pPrevHash = 0;
5130
drh605ad8f2006-05-03 23:34:05 +00005131 makeDirty(pPg);
danielk1977687566d2004-11-02 12:56:41 +00005132 pPager->dirtyCache = 1;
5133
danielk197794daf7f2004-11-08 09:26:09 +00005134 if( needSyncPgno ){
5135 /* If needSyncPgno is non-zero, then the journal file needs to be
5136 ** sync()ed before any data is written to database file page needSyncPgno.
5137 ** Currently, no such page exists in the page-cache and the
drhf5e7bb52008-02-18 14:47:33 +00005138 ** Pager.pInJournal bit has been set. This needs to be remedied by loading
danielk197794daf7f2004-11-08 09:26:09 +00005139 ** the page into the pager-cache and setting the PgHdr.needSync flag.
danielk1977ae825582004-11-23 09:06:55 +00005140 **
danielk1977a98d7b42008-01-18 13:42:54 +00005141 ** If the attempt to load the page into the page-cache fails, (due
drhf5e7bb52008-02-18 14:47:33 +00005142 ** to a malloc() or IO failure), clear the bit in the pInJournal[]
danielk1977a98d7b42008-01-18 13:42:54 +00005143 ** array. Otherwise, if the page is loaded and written again in
5144 ** this transaction, it may be written to the database file before
5145 ** it is synced into the journal file. This way, it may end up in
5146 ** the journal file twice, but that is not a problem.
5147 **
danielk19773b8a05f2007-03-19 17:44:26 +00005148 ** The sqlite3PagerGet() call may cause the journal to sync. So make
danielk1977ae825582004-11-23 09:06:55 +00005149 ** sure the Pager.needSync flag is set too.
danielk197794daf7f2004-11-08 09:26:09 +00005150 */
5151 int rc;
danielk19773b8a05f2007-03-19 17:44:26 +00005152 PgHdr *pPgHdr;
danielk1977ae825582004-11-23 09:06:55 +00005153 assert( pPager->needSync );
danielk19773b8a05f2007-03-19 17:44:26 +00005154 rc = sqlite3PagerGet(pPager, needSyncPgno, &pPgHdr);
danielk197787c29a92008-01-18 11:33:16 +00005155 if( rc!=SQLITE_OK ){
drhf5e7bb52008-02-18 14:47:33 +00005156 if( pPager->pInJournal && (int)needSyncPgno<=pPager->origDbSize ){
5157 sqlite3BitvecClear(pPager->pInJournal, needSyncPgno);
danielk1977a98d7b42008-01-18 13:42:54 +00005158 }
danielk197787c29a92008-01-18 11:33:16 +00005159 pagerLeave(pPager);
5160 return rc;
5161 }
danielk1977ae825582004-11-23 09:06:55 +00005162 pPager->needSync = 1;
danielk19773b8a05f2007-03-19 17:44:26 +00005163 pPgHdr->needSync = 1;
5164 pPgHdr->inJournal = 1;
5165 makeDirty(pPgHdr);
5166 sqlite3PagerUnref(pPgHdr);
danielk197794daf7f2004-11-08 09:26:09 +00005167 }
5168
drh86f8c192007-08-22 00:39:19 +00005169 pagerLeave(pPager);
danielk1977687566d2004-11-02 12:56:41 +00005170 return SQLITE_OK;
5171}
5172#endif
5173
danielk19773b8a05f2007-03-19 17:44:26 +00005174/*
5175** Return a pointer to the data for the specified page.
5176*/
5177void *sqlite3PagerGetData(DbPage *pPg){
5178 return PGHDR_TO_DATA(pPg);
5179}
5180
5181/*
5182** Return a pointer to the Pager.nExtra bytes of "extra" space
5183** allocated along with the specified page.
5184*/
5185void *sqlite3PagerGetExtra(DbPage *pPg){
5186 Pager *pPager = pPg->pPager;
5187 return (pPager?PGHDR_TO_EXTRA(pPg, pPager):0);
5188}
5189
danielk197741483462007-03-24 16:45:04 +00005190/*
5191** Get/set the locking-mode for this pager. Parameter eMode must be one
5192** of PAGER_LOCKINGMODE_QUERY, PAGER_LOCKINGMODE_NORMAL or
5193** PAGER_LOCKINGMODE_EXCLUSIVE. If the parameter is not _QUERY, then
5194** the locking-mode is set to the value specified.
5195**
5196** The returned value is either PAGER_LOCKINGMODE_NORMAL or
5197** PAGER_LOCKINGMODE_EXCLUSIVE, indicating the current (possibly updated)
5198** locking-mode.
5199*/
5200int sqlite3PagerLockingMode(Pager *pPager, int eMode){
drh369339d2007-03-30 16:01:55 +00005201 assert( eMode==PAGER_LOCKINGMODE_QUERY
5202 || eMode==PAGER_LOCKINGMODE_NORMAL
5203 || eMode==PAGER_LOCKINGMODE_EXCLUSIVE );
5204 assert( PAGER_LOCKINGMODE_QUERY<0 );
5205 assert( PAGER_LOCKINGMODE_NORMAL>=0 && PAGER_LOCKINGMODE_EXCLUSIVE>=0 );
5206 if( eMode>=0 && !pPager->tempFile ){
danielk197741483462007-03-24 16:45:04 +00005207 pPager->exclusiveMode = eMode;
5208 }
5209 return (int)pPager->exclusiveMode;
5210}
5211
drh3b020132008-04-17 17:02:01 +00005212/*
5213** Get/set the journal-mode for this pager. Parameter eMode must be one
5214** of PAGER_JOURNALMODE_QUERY, PAGER_JOURNALMODE_DELETE or
5215** PAGER_JOURNALMODE_PERSIST. If the parameter is not _QUERY, then
5216** the journal-mode is set to the value specified.
5217**
5218** The returned value is either PAGER_JOURNALMODE_DELETE or
5219** PAGER_JOURNALMODE_PERSIST, indicating the current (possibly updated)
5220** journal-mode.
5221*/
5222int sqlite3PagerJournalMode(Pager *pPager, int eMode){
5223 assert( eMode==PAGER_JOURNALMODE_QUERY
5224 || eMode==PAGER_JOURNALMODE_DELETE
drhfdc40e92008-04-17 20:59:37 +00005225 || eMode==PAGER_JOURNALMODE_PERSIST
5226 || eMode==PAGER_JOURNALMODE_OFF );
drh3b020132008-04-17 17:02:01 +00005227 assert( PAGER_JOURNALMODE_QUERY<0 );
5228 assert( PAGER_JOURNALMODE_DELETE>=0 && PAGER_JOURNALMODE_PERSIST>=0 );
drhfdc40e92008-04-17 20:59:37 +00005229 if( eMode>=0 ){
5230 pPager->journalMode = eMode;
drh3b020132008-04-17 17:02:01 +00005231 }
drhfdc40e92008-04-17 20:59:37 +00005232 return (int)pPager->journalMode;
drh3b020132008-04-17 17:02:01 +00005233}
5234
drhd919fe12007-12-11 19:34:44 +00005235#ifdef SQLITE_TEST
drhdd793422001-06-28 01:54:48 +00005236/*
5237** Print a listing of all referenced pages and their ref count.
5238*/
danielk19773b8a05f2007-03-19 17:44:26 +00005239void sqlite3PagerRefdump(Pager *pPager){
drhdd793422001-06-28 01:54:48 +00005240 PgHdr *pPg;
5241 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
5242 if( pPg->nRef<=0 ) continue;
drhfe63d1c2004-09-08 20:13:04 +00005243 sqlite3DebugPrintf("PAGE %3d addr=%p nRef=%d\n",
5244 pPg->pgno, PGHDR_TO_DATA(pPg), pPg->nRef);
drhdd793422001-06-28 01:54:48 +00005245 }
5246}
5247#endif
drh2e66f0b2005-04-28 17:18:48 +00005248
5249#endif /* SQLITE_OMIT_DISKIO */