blob: 7473b18ccb6bfbd094c9fb52373985ba226069d7 [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**
drh4c02a232008-04-14 23:13:45 +000021** @(#) $Id: pager.c,v 1.426 2008/04/14 23:13:46 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 */
353 u8 changeCountDone; /* Set after incrementing the change-counter */
drh33f4e022007-09-03 15:19:34 +0000354 u32 vfsFlags; /* Flags for sqlite3_vfs.xOpen() */
drhe49f9822006-09-15 12:29:16 +0000355 int errCode; /* One of several kinds of errors */
drhfcd35c72005-05-21 02:48:08 +0000356 int dbSize; /* Number of pages in the file */
357 int origDbSize; /* dbSize before the current change */
358 int stmtSize; /* Size of database (in pages) at stmt_begin() */
359 int nRec; /* Number of pages written to the journal */
360 u32 cksumInit; /* Quasi-random value added to every checksum */
361 int stmtNRec; /* Number of records in stmt subjournal */
362 int nExtra; /* Add this many bytes to each in-memory page */
363 int pageSize; /* Number of bytes in a page */
364 int nPage; /* Total number of in-memory pages */
drhfcd35c72005-05-21 02:48:08 +0000365 int nRef; /* Number of in-memory pages with PgHdr.nRef>0 */
366 int mxPage; /* Maximum number of pages to hold in cache */
drhf8e632b2007-05-08 14:51:36 +0000367 Pgno mxPgno; /* Maximum allowed size of the database */
drhf5e7bb52008-02-18 14:47:33 +0000368 Bitvec *pInJournal; /* One bit for each page in the database file */
369 Bitvec *pInStmt; /* One bit for each page in the database */
drhfcd35c72005-05-21 02:48:08 +0000370 char *zFilename; /* Name of the database file */
371 char *zJournal; /* Name of the journal file */
372 char *zDirectory; /* Directory hold database and journal files */
drh334b2992007-09-06 23:28:23 +0000373 char *zStmtJrnl; /* Name of the statement journal file */
danielk197762079062007-08-15 17:08:46 +0000374 sqlite3_file *fd, *jfd; /* File descriptors for database and journal */
375 sqlite3_file *stfd; /* File descriptor for the statement subjournal*/
drh726de592004-06-10 23:35:50 +0000376 BusyHandler *pBusyHandler; /* Pointer to sqlite.busyHandler */
danielk19779f61c2f2007-08-27 17:27:49 +0000377 PagerLruList lru; /* LRU list of free pages */
drhd9b02572001-04-15 00:37:09 +0000378 PgHdr *pAll; /* List of all pages */
drhac69b052004-05-12 13:30:07 +0000379 PgHdr *pStmt; /* List of pages in the statement subjournal */
drh605ad8f2006-05-03 23:34:05 +0000380 PgHdr *pDirty; /* List of all dirty pages */
drheb206252004-10-01 02:00:31 +0000381 i64 journalOff; /* Current byte offset in the journal file */
382 i64 journalHdr; /* Byte offset to previous journal header */
383 i64 stmtHdrOff; /* First journal header written this statement */
384 i64 stmtCksum; /* cksumInit when statement was started */
drh6d156e42005-05-20 20:11:20 +0000385 i64 stmtJSize; /* Size of journal at stmt_begin() */
danielk197776572402004-06-25 02:38:54 +0000386 int sectorSize; /* Assumed sector size during rollback */
drhfcd35c72005-05-21 02:48:08 +0000387#ifdef SQLITE_TEST
drh7c4ac0c2007-04-05 11:25:58 +0000388 int nHit, nMiss; /* Cache hits and missing */
389 int nRead, nWrite; /* Database pages read/written */
drhfcd35c72005-05-21 02:48:08 +0000390#endif
danielk19773b8a05f2007-03-19 17:44:26 +0000391 void (*xDestructor)(DbPage*,int); /* Call this routine when freeing pages */
392 void (*xReiniter)(DbPage*,int); /* Call this routine when reloading pages */
drh7c4ac0c2007-04-05 11:25:58 +0000393#ifdef SQLITE_HAS_CODEC
drhc001c582006-03-06 18:23:16 +0000394 void *(*xCodec)(void*,void*,Pgno,int); /* Routine for en/decoding data */
drh6d156e42005-05-20 20:11:20 +0000395 void *pCodecArg; /* First argument to xCodec() */
drh7c4ac0c2007-04-05 11:25:58 +0000396#endif
drh8ca0c722006-05-07 17:49:38 +0000397 int nHash; /* Size of the pager hash table */
398 PgHdr **aHash; /* Hash table to map page number to PgHdr */
drh6f7adc82006-01-11 21:41:20 +0000399#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
drh86f8c192007-08-22 00:39:19 +0000400 Pager *pNext; /* Doubly linked list of pagers on which */
401 Pager *pPrev; /* sqlite3_release_memory() will work */
402 int iInUseMM; /* Non-zero if unavailable to MM */
403 int iInUseDB; /* Non-zero if in sqlite3_release_memory() */
danielk197713f72992005-12-18 08:51:22 +0000404#endif
danielk19778186df82007-03-06 13:45:59 +0000405 char *pTmpSpace; /* Pager.pageSize bytes of space for tmp use */
drh86a88112007-04-16 15:02:19 +0000406 char dbFileVers[16]; /* Changes whenever database file changes */
drhd9b02572001-04-15 00:37:09 +0000407};
408
409/*
drh538f5702007-04-13 02:14:30 +0000410** The following global variables hold counters used for
411** testing purposes only. These variables do not exist in
412** a non-testing build. These variables are not thread-safe.
drhfcd35c72005-05-21 02:48:08 +0000413*/
414#ifdef SQLITE_TEST
drh538f5702007-04-13 02:14:30 +0000415int sqlite3_pager_readdb_count = 0; /* Number of full pages read from DB */
416int sqlite3_pager_writedb_count = 0; /* Number of full pages written to DB */
417int sqlite3_pager_writej_count = 0; /* Number of pages written to journal */
418int sqlite3_pager_pgfree_count = 0; /* Number of cache pages freed */
419# define PAGER_INCR(v) v++
drhfcd35c72005-05-21 02:48:08 +0000420#else
drh538f5702007-04-13 02:14:30 +0000421# define PAGER_INCR(v)
drhfcd35c72005-05-21 02:48:08 +0000422#endif
423
drh86f8c192007-08-22 00:39:19 +0000424/*
425** The following variable points to the head of a double-linked list
426** of all pagers that are eligible for page stealing by the
427** sqlite3_release_memory() interface. Access to this list is
428** protected by the SQLITE_MUTEX_STATIC_MEM2 mutex.
429*/
430#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
431static Pager *sqlite3PagerList = 0;
danielk19779f61c2f2007-08-27 17:27:49 +0000432static PagerLruList sqlite3LruPageList = {0, 0, 0};
drh86f8c192007-08-22 00:39:19 +0000433#endif
drh538f5702007-04-13 02:14:30 +0000434
435
drhfcd35c72005-05-21 02:48:08 +0000436/*
drh5e00f6c2001-09-13 13:46:56 +0000437** Journal files begin with the following magic string. The data
438** was obtained from /dev/random. It is used only as a sanity check.
drh94f33312002-08-12 12:29:56 +0000439**
drhae2b40c2004-06-09 19:03:54 +0000440** Since version 2.8.0, the journal format contains additional sanity
441** checking information. If the power fails while the journal is begin
442** written, semi-random garbage data might appear in the journal
443** file after power is restored. If an attempt is then made
drh968af522003-02-11 14:55:40 +0000444** to roll the journal back, the database could be corrupted. The additional
445** sanity checking data is an attempt to discover the garbage in the
446** journal and ignore it.
447**
drhae2b40c2004-06-09 19:03:54 +0000448** The sanity checking information for the new journal format consists
drh968af522003-02-11 14:55:40 +0000449** of a 32-bit checksum on each page of data. The checksum covers both
drh90f5ecb2004-07-22 01:19:35 +0000450** the page number and the pPager->pageSize bytes of data for the page.
drh968af522003-02-11 14:55:40 +0000451** This cksum is initialized to a 32-bit random value that appears in the
452** journal file right after the header. The random initializer is important,
453** because garbage data that appears at the end of a journal is likely
454** data that was once in other files that have now been deleted. If the
455** garbage data came from an obsolete journal file, the checksums might
456** be correct. But by initializing the checksum to random value which
457** is different for every journal, we minimize that risk.
drhd9b02572001-04-15 00:37:09 +0000458*/
drhae2b40c2004-06-09 19:03:54 +0000459static const unsigned char aJournalMagic[] = {
460 0xd9, 0xd5, 0x05, 0xf9, 0x20, 0xa1, 0x63, 0xd7,
drhed7c8552001-04-11 14:29:21 +0000461};
462
463/*
drh726de592004-06-10 23:35:50 +0000464** The size of the header and of each page in the journal is determined
465** by the following macros.
drh968af522003-02-11 14:55:40 +0000466*/
drhae2b40c2004-06-09 19:03:54 +0000467#define JOURNAL_PG_SZ(pPager) ((pPager->pageSize) + 8)
drh968af522003-02-11 14:55:40 +0000468
danielk197776572402004-06-25 02:38:54 +0000469/*
470** The journal header size for this pager. In the future, this could be
471** set to some value read from the disk controller. The important
472** characteristic is that it is the same size as a disk sector.
473*/
474#define JOURNAL_HDR_SZ(pPager) (pPager->sectorSize)
475
drhb7f91642004-10-31 02:22:47 +0000476/*
477** The macro MEMDB is true if we are dealing with an in-memory database.
478** We do this as a macro so that if the SQLITE_OMIT_MEMORYDB macro is set,
479** the value of MEMDB will be a constant and the compiler will optimize
480** out code that would never execute.
481*/
482#ifdef SQLITE_OMIT_MEMORYDB
483# define MEMDB 0
484#else
485# define MEMDB pPager->memDb
486#endif
487
488/*
danielk197776572402004-06-25 02:38:54 +0000489** Page number PAGER_MJ_PGNO is never used in an SQLite database (it is
490** reserved for working around a windows/posix incompatibility). It is
491** used in the journal to signify that the remainder of the journal file
492** is devoted to storing a master journal name - there are no more pages to
493** roll back. See comments for function writeMasterJournal() for details.
494*/
danielk1977599fcba2004-11-08 07:13:13 +0000495/* #define PAGER_MJ_PGNO(x) (PENDING_BYTE/((x)->pageSize)) */
496#define PAGER_MJ_PGNO(x) ((PENDING_BYTE/((x)->pageSize))+1)
danielk197713adf8a2004-06-03 16:08:41 +0000497
drh968af522003-02-11 14:55:40 +0000498/*
danielk197726836652005-01-17 01:33:13 +0000499** The maximum legal page number is (2^31 - 1).
500*/
501#define PAGER_MAX_PGNO 2147483647
502
503/*
drh86f8c192007-08-22 00:39:19 +0000504** The pagerEnter() and pagerLeave() routines acquire and release
505** a mutex on each pager. The mutex is recursive.
506**
507** This is a special-purpose mutex. It only provides mutual exclusion
508** between the Btree and the Memory Management sqlite3_release_memory()
509** function. It does not prevent, for example, two Btrees from accessing
510** the same pager at the same time. Other general-purpose mutexes in
511** the btree layer handle that chore.
512*/
513#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
514 static void pagerEnter(Pager *p){
515 p->iInUseDB++;
516 if( p->iInUseMM && p->iInUseDB==1 ){
517 sqlite3_mutex *mutex;
518 mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MEM2);
519 p->iInUseDB = 0;
520 sqlite3_mutex_enter(mutex);
521 p->iInUseDB = 1;
522 sqlite3_mutex_leave(mutex);
523 }
524 assert( p->iInUseMM==0 );
525 }
526 static void pagerLeave(Pager *p){
527 p->iInUseDB--;
528 assert( p->iInUseDB>=0 );
529 }
530#else
531# define pagerEnter(X)
532# define pagerLeave(X)
533#endif
534
535/*
danielk197784f786f2007-08-28 08:00:17 +0000536** Add page pPg to the end of the linked list managed by structure
537** pList (pPg becomes the last entry in the list - the most recently
538** used). Argument pLink should point to either pPg->free or pPg->gfree,
539** depending on whether pPg is being added to the pager-specific or
540** global LRU list.
541*/
danielk19779f61c2f2007-08-27 17:27:49 +0000542static void listAdd(PagerLruList *pList, PagerLruLink *pLink, PgHdr *pPg){
543 pLink->pNext = 0;
544 pLink->pPrev = pList->pLast;
545
danielk197784f786f2007-08-28 08:00:17 +0000546#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
547 assert(pLink==&pPg->free || pLink==&pPg->gfree);
548 assert(pLink==&pPg->gfree || pList!=&sqlite3LruPageList);
549#endif
550
danielk19779f61c2f2007-08-27 17:27:49 +0000551 if( pList->pLast ){
552 int iOff = (char *)pLink - (char *)pPg;
553 PagerLruLink *pLastLink = (PagerLruLink *)(&((u8 *)pList->pLast)[iOff]);
554 pLastLink->pNext = pPg;
555 }else{
556 assert(!pList->pFirst);
557 pList->pFirst = pPg;
558 }
559
560 pList->pLast = pPg;
561 if( !pList->pFirstSynced && pPg->needSync==0 ){
562 pList->pFirstSynced = pPg;
563 }
564}
565
danielk197784f786f2007-08-28 08:00:17 +0000566/*
567** Remove pPg from the list managed by the structure pointed to by pList.
568**
569** Argument pLink should point to either pPg->free or pPg->gfree, depending
570** on whether pPg is being added to the pager-specific or global LRU list.
571*/
danielk19779f61c2f2007-08-27 17:27:49 +0000572static void listRemove(PagerLruList *pList, PagerLruLink *pLink, PgHdr *pPg){
573 int iOff = (char *)pLink - (char *)pPg;
574
danielk197784f786f2007-08-28 08:00:17 +0000575#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
576 assert(pLink==&pPg->free || pLink==&pPg->gfree);
577 assert(pLink==&pPg->gfree || pList!=&sqlite3LruPageList);
578#endif
579
danielk19779f61c2f2007-08-27 17:27:49 +0000580 if( pPg==pList->pFirst ){
581 pList->pFirst = pLink->pNext;
582 }
583 if( pPg==pList->pLast ){
584 pList->pLast = pLink->pPrev;
585 }
586 if( pLink->pPrev ){
587 PagerLruLink *pPrevLink = (PagerLruLink *)(&((u8 *)pLink->pPrev)[iOff]);
588 pPrevLink->pNext = pLink->pNext;
589 }
590 if( pLink->pNext ){
591 PagerLruLink *pNextLink = (PagerLruLink *)(&((u8 *)pLink->pNext)[iOff]);
592 pNextLink->pPrev = pLink->pPrev;
593 }
594 if( pPg==pList->pFirstSynced ){
595 PgHdr *p = pLink->pNext;
596 while( p && p->needSync ){
597 PagerLruLink *pL = (PagerLruLink *)(&((u8 *)p)[iOff]);
598 p = pL->pNext;
599 }
600 pList->pFirstSynced = p;
601 }
602
603 pLink->pNext = pLink->pPrev = 0;
604}
605
606/*
danielk197784f786f2007-08-28 08:00:17 +0000607** Add page pPg to the list of free pages for the pager. If
608** memory-management is enabled, also add the page to the global
609** list of free pages.
danielk19779f61c2f2007-08-27 17:27:49 +0000610*/
611static void lruListAdd(PgHdr *pPg){
612 listAdd(&pPg->pPager->lru, &pPg->free, pPg);
613#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
614 if( !pPg->pPager->memDb ){
615 sqlite3_mutex_enter(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
616 listAdd(&sqlite3LruPageList, &pPg->gfree, pPg);
617 sqlite3_mutex_leave(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
618 }
619#endif
620}
621
622/*
danielk197784f786f2007-08-28 08:00:17 +0000623** Remove page pPg from the list of free pages for the associated pager.
624** If memory-management is enabled, also remove pPg from the global list
625** of free pages.
danielk19779f61c2f2007-08-27 17:27:49 +0000626*/
627static void lruListRemove(PgHdr *pPg){
628 listRemove(&pPg->pPager->lru, &pPg->free, pPg);
629#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
630 if( !pPg->pPager->memDb ){
631 sqlite3_mutex_enter(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
632 listRemove(&sqlite3LruPageList, &pPg->gfree, pPg);
633 sqlite3_mutex_leave(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
634 }
635#endif
636}
637
638/*
danielk197784f786f2007-08-28 08:00:17 +0000639** This function is called just after the needSync flag has been cleared
640** from all pages managed by pPager (usually because the journal file
641** has just been synced). It updates the pPager->lru.pFirstSynced variable
642** and, if memory-management is enabled, the sqlite3LruPageList.pFirstSynced
643** variable also.
danielk19779f61c2f2007-08-27 17:27:49 +0000644*/
645static void lruListSetFirstSynced(Pager *pPager){
646 pPager->lru.pFirstSynced = pPager->lru.pFirst;
647#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
648 if( !pPager->memDb ){
649 PgHdr *p;
650 sqlite3_mutex_enter(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
651 for(p=sqlite3LruPageList.pFirst; p && p->needSync; p=p->gfree.pNext);
652 assert(p==pPager->lru.pFirstSynced || p==sqlite3LruPageList.pFirstSynced);
653 sqlite3LruPageList.pFirstSynced = p;
654 sqlite3_mutex_leave(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
655 }
656#endif
657}
658
danielk1977f35843b2007-04-07 15:03:17 +0000659/*
660** Return true if page *pPg has already been written to the statement
661** journal (or statement snapshot has been created, if *pPg is part
662** of an in-memory database).
663*/
664static int pageInStatement(PgHdr *pPg){
665 Pager *pPager = pPg->pPager;
666 if( MEMDB ){
667 return PGHDR_TO_HIST(pPg, pPager)->inStmt;
668 }else{
drhf5e7bb52008-02-18 14:47:33 +0000669 return sqlite3BitvecTest(pPager->pInStmt, pPg->pgno);
danielk1977f35843b2007-04-07 15:03:17 +0000670 }
671}
drh8ca0c722006-05-07 17:49:38 +0000672
673/*
674** Change the size of the pager hash table to N. N must be a power
675** of two.
676*/
677static void pager_resize_hash_table(Pager *pPager, int N){
678 PgHdr **aHash, *pPg;
679 assert( N>0 && (N&(N-1))==0 );
drheee4c8c2008-02-18 22:24:57 +0000680#ifdef SQLITE_MALLOC_SOFT_LIMIT
681 if( N*sizeof(aHash[0])>SQLITE_MALLOC_SOFT_LIMIT ){
682 N = SQLITE_MALLOC_SOFT_LIMIT/sizeof(aHash[0]);
683 }
684 if( N==pPager->nHash ) return;
685#endif
drhed138fb2007-08-22 22:04:37 +0000686 pagerLeave(pPager);
drh643167f2008-01-22 21:30:53 +0000687 sqlite3FaultBenign(SQLITE_FAULTINJECTOR_MALLOC, pPager->aHash!=0);
drh17435752007-08-16 04:30:38 +0000688 aHash = sqlite3MallocZero( sizeof(aHash[0])*N );
drh643167f2008-01-22 21:30:53 +0000689 sqlite3FaultBenign(SQLITE_FAULTINJECTOR_MALLOC, 0);
drhed138fb2007-08-22 22:04:37 +0000690 pagerEnter(pPager);
drh8ca0c722006-05-07 17:49:38 +0000691 if( aHash==0 ){
692 /* Failure to rehash is not an error. It is only a performance hit. */
693 return;
694 }
drh17435752007-08-16 04:30:38 +0000695 sqlite3_free(pPager->aHash);
drh8ca0c722006-05-07 17:49:38 +0000696 pPager->nHash = N;
697 pPager->aHash = aHash;
698 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
drh3765df42006-06-28 18:18:09 +0000699 int h;
700 if( pPg->pgno==0 ){
701 assert( pPg->pNextHash==0 && pPg->pPrevHash==0 );
702 continue;
703 }
704 h = pPg->pgno & (N-1);
drh8ca0c722006-05-07 17:49:38 +0000705 pPg->pNextHash = aHash[h];
706 if( aHash[h] ){
707 aHash[h]->pPrevHash = pPg;
708 }
709 aHash[h] = pPg;
710 pPg->pPrevHash = 0;
711 }
712}
713
drhdd793422001-06-28 01:54:48 +0000714/*
drh34e79ce2004-02-08 06:05:46 +0000715** Read a 32-bit integer from the given file descriptor. Store the integer
716** that is read in *pRes. Return SQLITE_OK if everything worked, or an
717** error code is something goes wrong.
drh726de592004-06-10 23:35:50 +0000718**
719** All values are stored on disk as big-endian.
drh94f33312002-08-12 12:29:56 +0000720*/
danielk197762079062007-08-15 17:08:46 +0000721static int read32bits(sqlite3_file *fd, i64 offset, u32 *pRes){
drh3b59a5c2006-01-15 20:28:28 +0000722 unsigned char ac[4];
danielk197762079062007-08-15 17:08:46 +0000723 int rc = sqlite3OsRead(fd, ac, sizeof(ac), offset);
drhae2b40c2004-06-09 19:03:54 +0000724 if( rc==SQLITE_OK ){
drha3152892007-05-05 11:48:52 +0000725 *pRes = sqlite3Get4byte(ac);
drh94f33312002-08-12 12:29:56 +0000726 }
drh94f33312002-08-12 12:29:56 +0000727 return rc;
728}
729
730/*
drh97b57482006-01-10 20:32:32 +0000731** Write a 32-bit integer into a string buffer in big-endian byte order.
732*/
drha3152892007-05-05 11:48:52 +0000733#define put32bits(A,B) sqlite3Put4byte((u8*)A,B)
drh97b57482006-01-10 20:32:32 +0000734
735/*
drh34e79ce2004-02-08 06:05:46 +0000736** Write a 32-bit integer into the given file descriptor. Return SQLITE_OK
737** on success or an error code is something goes wrong.
drh94f33312002-08-12 12:29:56 +0000738*/
danielk197762079062007-08-15 17:08:46 +0000739static int write32bits(sqlite3_file *fd, i64 offset, u32 val){
danielk1977bab45c62006-01-16 15:14:27 +0000740 char ac[4];
drh97b57482006-01-10 20:32:32 +0000741 put32bits(ac, val);
danielk197762079062007-08-15 17:08:46 +0000742 return sqlite3OsWrite(fd, ac, 4, offset);
drh94f33312002-08-12 12:29:56 +0000743}
744
drh2554f8b2003-01-22 01:26:44 +0000745/*
danielk19777a2b1ee2007-08-21 14:27:01 +0000746** If file pFd is open, call sqlite3OsUnlock() on it.
747*/
748static int osUnlock(sqlite3_file *pFd, int eLock){
749 if( !pFd->pMethods ){
750 return SQLITE_OK;
751 }
752 return sqlite3OsUnlock(pFd, eLock);
753}
754
755/*
danielk1977c7b60172007-08-22 11:22:03 +0000756** This function determines whether or not the atomic-write optimization
757** can be used with this pager. The optimization can be used if:
758**
759** (a) the value returned by OsDeviceCharacteristics() indicates that
760** a database page may be written atomically, and
761** (b) the value returned by OsSectorSize() is less than or equal
762** to the page size.
763**
764** If the optimization cannot be used, 0 is returned. If it can be used,
765** then the value returned is the size of the journal file when it
766** contains rollback data for exactly one page.
767*/
768#ifdef SQLITE_ENABLE_ATOMIC_WRITE
769static int jrnlBufferSize(Pager *pPager){
770 int dc; /* Device characteristics */
771 int nSector; /* Sector size */
772 int nPage; /* Page size */
773 sqlite3_file *fd = pPager->fd;
774
775 if( fd->pMethods ){
776 dc = sqlite3OsDeviceCharacteristics(fd);
777 nSector = sqlite3OsSectorSize(fd);
778 nPage = pPager->pageSize;
779 }
780
781 assert(SQLITE_IOCAP_ATOMIC512==(512>>8));
782 assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8));
783
danielk1977f8940ae2007-08-23 11:07:10 +0000784 if( !fd->pMethods || (dc&(SQLITE_IOCAP_ATOMIC|(nPage>>8))&&nSector<=nPage) ){
danielk1977c7b60172007-08-22 11:22:03 +0000785 return JOURNAL_HDR_SZ(pPager) + JOURNAL_PG_SZ(pPager);
786 }
787 return 0;
788}
789#endif
790
791/*
danielk1977aef0bf62005-12-30 16:28:01 +0000792** This function should be called when an error occurs within the pager
danielk1977a96a7102006-01-16 12:46:41 +0000793** code. The first argument is a pointer to the pager structure, the
794** second the error-code about to be returned by a pager API function.
795** The value returned is a copy of the second argument to this function.
796**
drh4f0ee682007-03-30 20:43:40 +0000797** If the second argument is SQLITE_IOERR, SQLITE_CORRUPT, or SQLITE_FULL
danielk1977ae72d982007-10-03 08:46:44 +0000798** the error becomes persistent. Until the persisten error is cleared,
799** subsequent API calls on this Pager will immediately return the same
800** error code.
801**
802** A persistent error indicates that the contents of the pager-cache
803** cannot be trusted. This state can be cleared by completely discarding
804** the contents of the pager-cache. If a transaction was active when
805** the persistent error occured, then the rollback journal may need
806** to be replayed.
danielk1977aef0bf62005-12-30 16:28:01 +0000807*/
danielk1977ae72d982007-10-03 08:46:44 +0000808static void pager_unlock(Pager *pPager);
danielk1977aef0bf62005-12-30 16:28:01 +0000809static int pager_error(Pager *pPager, int rc){
drh4ac285a2006-09-15 07:28:50 +0000810 int rc2 = rc & 0xff;
drh34f56212007-08-10 23:56:35 +0000811 assert(
812 pPager->errCode==SQLITE_FULL ||
813 pPager->errCode==SQLITE_OK ||
814 (pPager->errCode & 0xff)==SQLITE_IOERR
815 );
danielk1977979f38e2007-03-27 16:19:51 +0000816 if(
drh4ac285a2006-09-15 07:28:50 +0000817 rc2==SQLITE_FULL ||
818 rc2==SQLITE_IOERR ||
drh4f0ee682007-03-30 20:43:40 +0000819 rc2==SQLITE_CORRUPT
danielk1977efaaf572006-01-16 11:29:19 +0000820 ){
821 pPager->errCode = rc;
danielk1977ae72d982007-10-03 08:46:44 +0000822 if( pPager->state==PAGER_UNLOCK && pPager->nRef==0 ){
823 /* If the pager is already unlocked, call pager_unlock() now to
824 ** clear the error state and ensure that the pager-cache is
825 ** completely empty.
826 */
827 pager_unlock(pPager);
828 }
danielk1977aef0bf62005-12-30 16:28:01 +0000829 }
830 return rc;
831}
832
drh477731b2007-06-16 03:06:27 +0000833/*
834** If SQLITE_CHECK_PAGES is defined then we do some sanity checking
835** on the cache using a hash function. This is used for testing
836** and debugging only.
837*/
danielk19773c407372005-02-15 02:54:14 +0000838#ifdef SQLITE_CHECK_PAGES
839/*
840** Return a 32-bit hash of the page data for pPage.
841*/
drh477731b2007-06-16 03:06:27 +0000842static u32 pager_datahash(int nByte, unsigned char *pData){
danielk19773c407372005-02-15 02:54:14 +0000843 u32 hash = 0;
844 int i;
drh477731b2007-06-16 03:06:27 +0000845 for(i=0; i<nByte; i++){
846 hash = (hash*1039) + pData[i];
danielk19773c407372005-02-15 02:54:14 +0000847 }
848 return hash;
849}
drh477731b2007-06-16 03:06:27 +0000850static u32 pager_pagehash(PgHdr *pPage){
851 return pager_datahash(pPage->pPager->pageSize,
852 (unsigned char *)PGHDR_TO_DATA(pPage));
853}
danielk19773c407372005-02-15 02:54:14 +0000854
855/*
856** The CHECK_PAGE macro takes a PgHdr* as an argument. If SQLITE_CHECK_PAGES
857** is defined, and NDEBUG is not defined, an assert() statement checks
858** that the page is either dirty or still matches the calculated page-hash.
859*/
860#define CHECK_PAGE(x) checkPage(x)
861static void checkPage(PgHdr *pPg){
862 Pager *pPager = pPg->pPager;
danielk1977efaaf572006-01-16 11:29:19 +0000863 assert( !pPg->pageHash || pPager->errCode || MEMDB || pPg->dirty ||
danielk19773c407372005-02-15 02:54:14 +0000864 pPg->pageHash==pager_pagehash(pPg) );
865}
866
867#else
drh8ffa8172007-06-18 17:25:17 +0000868#define pager_datahash(X,Y) 0
drh477731b2007-06-16 03:06:27 +0000869#define pager_pagehash(X) 0
danielk19773c407372005-02-15 02:54:14 +0000870#define CHECK_PAGE(x)
871#endif
872
drhed7c8552001-04-11 14:29:21 +0000873/*
danielk197776572402004-06-25 02:38:54 +0000874** When this is called the journal file for pager pPager must be open.
875** The master journal file name is read from the end of the file and
danielk197765839c62007-08-30 08:08:17 +0000876** written into memory supplied by the caller.
danielk197776572402004-06-25 02:38:54 +0000877**
danielk197765839c62007-08-30 08:08:17 +0000878** zMaster must point to a buffer of at least nMaster bytes allocated by
879** the caller. This should be sqlite3_vfs.mxPathname+1 (to ensure there is
880** enough space to write the master journal name). If the master journal
881** name in the journal is longer than nMaster bytes (including a
882** nul-terminator), then this is handled as if no master journal name
883** were present in the journal.
884**
885** If no master journal file name is present zMaster[0] is set to 0 and
danielk197776572402004-06-25 02:38:54 +0000886** SQLITE_OK returned.
887*/
danielk197765839c62007-08-30 08:08:17 +0000888static int readMasterJournal(sqlite3_file *pJrnl, char *zMaster, int nMaster){
danielk197776572402004-06-25 02:38:54 +0000889 int rc;
890 u32 len;
drheb206252004-10-01 02:00:31 +0000891 i64 szJ;
danielk1977c3e8f5e2004-06-28 01:16:46 +0000892 u32 cksum;
danielk1977cafadba2004-06-25 11:11:54 +0000893 int i;
danielk197776572402004-06-25 02:38:54 +0000894 unsigned char aMagic[8]; /* A buffer to hold the magic header */
895
danielk197765839c62007-08-30 08:08:17 +0000896 zMaster[0] = '\0';
danielk197776572402004-06-25 02:38:54 +0000897
drh054889e2005-11-30 03:20:31 +0000898 rc = sqlite3OsFileSize(pJrnl, &szJ);
danielk1977cafadba2004-06-25 11:11:54 +0000899 if( rc!=SQLITE_OK || szJ<16 ) return rc;
danielk197776572402004-06-25 02:38:54 +0000900
danielk197762079062007-08-15 17:08:46 +0000901 rc = read32bits(pJrnl, szJ-16, &len);
danielk197776572402004-06-25 02:38:54 +0000902 if( rc!=SQLITE_OK ) return rc;
903
danielk197765839c62007-08-30 08:08:17 +0000904 if( len>=nMaster ){
905 return SQLITE_OK;
906 }
907
danielk197762079062007-08-15 17:08:46 +0000908 rc = read32bits(pJrnl, szJ-12, &cksum);
danielk1977cafadba2004-06-25 11:11:54 +0000909 if( rc!=SQLITE_OK ) return rc;
910
danielk197762079062007-08-15 17:08:46 +0000911 rc = sqlite3OsRead(pJrnl, aMagic, 8, szJ-8);
danielk197776572402004-06-25 02:38:54 +0000912 if( rc!=SQLITE_OK || memcmp(aMagic, aJournalMagic, 8) ) return rc;
913
danielk197765839c62007-08-30 08:08:17 +0000914 rc = sqlite3OsRead(pJrnl, zMaster, len, szJ-16-len);
danielk197776572402004-06-25 02:38:54 +0000915 if( rc!=SQLITE_OK ){
danielk197776572402004-06-25 02:38:54 +0000916 return rc;
917 }
danielk197765839c62007-08-30 08:08:17 +0000918 zMaster[len] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000919
920 /* See if the checksum matches the master journal name */
921 for(i=0; i<len; i++){
danielk197765839c62007-08-30 08:08:17 +0000922 cksum -= zMaster[i];
923 }
danielk19778191bff2004-06-28 04:52:30 +0000924 if( cksum ){
925 /* If the checksum doesn't add up, then one or more of the disk sectors
926 ** containing the master journal filename is corrupted. This means
927 ** definitely roll back, so just return SQLITE_OK and report a (nul)
928 ** master-journal filename.
929 */
danielk197765839c62007-08-30 08:08:17 +0000930 zMaster[0] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000931 }
danielk197776572402004-06-25 02:38:54 +0000932
933 return SQLITE_OK;
934}
935
936/*
937** Seek the journal file descriptor to the next sector boundary where a
938** journal header may be read or written. Pager.journalOff is updated with
939** the new seek offset.
940**
941** i.e for a sector size of 512:
942**
943** Input Offset Output Offset
944** ---------------------------------------
945** 0 0
946** 512 512
947** 100 512
948** 2000 2048
949**
950*/
danielk197762079062007-08-15 17:08:46 +0000951static void seekJournalHdr(Pager *pPager){
drheb206252004-10-01 02:00:31 +0000952 i64 offset = 0;
953 i64 c = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000954 if( c ){
955 offset = ((c-1)/JOURNAL_HDR_SZ(pPager) + 1) * JOURNAL_HDR_SZ(pPager);
956 }
957 assert( offset%JOURNAL_HDR_SZ(pPager)==0 );
958 assert( offset>=c );
959 assert( (offset-c)<JOURNAL_HDR_SZ(pPager) );
960 pPager->journalOff = offset;
danielk197776572402004-06-25 02:38:54 +0000961}
962
963/*
964** The journal file must be open when this routine is called. A journal
965** header (JOURNAL_HDR_SZ bytes) is written into the journal file at the
966** current location.
967**
968** The format for the journal header is as follows:
969** - 8 bytes: Magic identifying journal format.
970** - 4 bytes: Number of records in journal, or -1 no-sync mode is on.
971** - 4 bytes: Random number used for page hash.
972** - 4 bytes: Initial database page count.
973** - 4 bytes: Sector size used by the process that wrote this journal.
danielk197767c007b2008-03-20 04:45:49 +0000974** - 4 bytes: Database page size.
danielk197776572402004-06-25 02:38:54 +0000975**
danielk197767c007b2008-03-20 04:45:49 +0000976** Followed by (JOURNAL_HDR_SZ - 28) bytes of unused space.
danielk197776572402004-06-25 02:38:54 +0000977*/
978static int writeJournalHdr(Pager *pPager){
danielk197767c007b2008-03-20 04:45:49 +0000979 char zHeader[sizeof(aJournalMagic)+20];
danielk19774099f6e2007-03-19 11:25:20 +0000980 int rc;
danielk197776572402004-06-25 02:38:54 +0000981
danielk19774099f6e2007-03-19 11:25:20 +0000982 if( pPager->stmtHdrOff==0 ){
983 pPager->stmtHdrOff = pPager->journalOff;
984 }
985
danielk197762079062007-08-15 17:08:46 +0000986 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +0000987 pPager->journalHdr = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000988
drh97b57482006-01-10 20:32:32 +0000989 memcpy(zHeader, aJournalMagic, sizeof(aJournalMagic));
danielk19774cd2cd52007-08-23 14:48:23 +0000990
991 /*
992 ** Write the nRec Field - the number of page records that follow this
993 ** journal header. Normally, zero is written to this value at this time.
994 ** After the records are added to the journal (and the journal synced,
995 ** if in full-sync mode), the zero is overwritten with the true number
996 ** of records (see syncJournal()).
997 **
998 ** A faster alternative is to write 0xFFFFFFFF to the nRec field. When
999 ** reading the journal this value tells SQLite to assume that the
1000 ** rest of the journal file contains valid page records. This assumption
1001 ** is dangerous, as if a failure occured whilst writing to the journal
1002 ** file it may contain some garbage data. There are two scenarios
1003 ** where this risk can be ignored:
1004 **
1005 ** * When the pager is in no-sync mode. Corruption can follow a
1006 ** power failure in this case anyway.
1007 **
1008 ** * When the SQLITE_IOCAP_SAFE_APPEND flag is set. This guarantees
1009 ** that garbage data is never appended to the journal file.
1010 */
1011 assert(pPager->fd->pMethods||pPager->noSync);
1012 if( (pPager->noSync)
1013 || (sqlite3OsDeviceCharacteristics(pPager->fd)&SQLITE_IOCAP_SAFE_APPEND)
1014 ){
1015 put32bits(&zHeader[sizeof(aJournalMagic)], 0xffffffff);
1016 }else{
1017 put32bits(&zHeader[sizeof(aJournalMagic)], 0);
1018 }
1019
drh97b57482006-01-10 20:32:32 +00001020 /* The random check-hash initialiser */
drh2fa18682008-03-19 14:15:34 +00001021 sqlite3_randomness(sizeof(pPager->cksumInit), &pPager->cksumInit);
drh97b57482006-01-10 20:32:32 +00001022 put32bits(&zHeader[sizeof(aJournalMagic)+4], pPager->cksumInit);
1023 /* The initial database size */
1024 put32bits(&zHeader[sizeof(aJournalMagic)+8], pPager->dbSize);
1025 /* The assumed sector size for this process */
1026 put32bits(&zHeader[sizeof(aJournalMagic)+12], pPager->sectorSize);
danielk197767c007b2008-03-20 04:45:49 +00001027 if( pPager->journalHdr==0 ){
1028 /* The page size */
1029 put32bits(&zHeader[sizeof(aJournalMagic)+16], pPager->pageSize);
1030 }
drhb0603412007-02-28 04:47:26 +00001031 IOTRACE(("JHDR %p %lld %d\n", pPager, pPager->journalHdr, sizeof(zHeader)))
danielk197762079062007-08-15 17:08:46 +00001032 rc = sqlite3OsWrite(pPager->jfd, zHeader, sizeof(zHeader),pPager->journalOff);
1033 pPager->journalOff += JOURNAL_HDR_SZ(pPager);
danielk197776572402004-06-25 02:38:54 +00001034
1035 /* The journal header has been written successfully. Seek the journal
1036 ** file descriptor to the end of the journal header sector.
1037 */
1038 if( rc==SQLITE_OK ){
drhb0603412007-02-28 04:47:26 +00001039 IOTRACE(("JTAIL %p %lld\n", pPager, pPager->journalOff-1))
danielk197762079062007-08-15 17:08:46 +00001040 rc = sqlite3OsWrite(pPager->jfd, "\000", 1, pPager->journalOff-1);
danielk197776572402004-06-25 02:38:54 +00001041 }
1042 return rc;
1043}
1044
1045/*
1046** The journal file must be open when this is called. A journal header file
1047** (JOURNAL_HDR_SZ bytes) is read from the current location in the journal
1048** file. See comments above function writeJournalHdr() for a description of
1049** the journal header format.
1050**
1051** If the header is read successfully, *nRec is set to the number of
1052** page records following this header and *dbSize is set to the size of the
1053** database before the transaction began, in pages. Also, pPager->cksumInit
1054** is set to the value read from the journal header. SQLITE_OK is returned
1055** in this case.
1056**
1057** If the journal header file appears to be corrupted, SQLITE_DONE is
1058** returned and *nRec and *dbSize are not set. If JOURNAL_HDR_SZ bytes
1059** cannot be read from the journal file an error code is returned.
1060*/
1061static int readJournalHdr(
1062 Pager *pPager,
drheb206252004-10-01 02:00:31 +00001063 i64 journalSize,
danielk197776572402004-06-25 02:38:54 +00001064 u32 *pNRec,
1065 u32 *pDbSize
1066){
1067 int rc;
1068 unsigned char aMagic[8]; /* A buffer to hold the magic header */
danielk197762079062007-08-15 17:08:46 +00001069 i64 jrnlOff;
danielk197767c007b2008-03-20 04:45:49 +00001070 int iPageSize;
danielk197776572402004-06-25 02:38:54 +00001071
danielk197762079062007-08-15 17:08:46 +00001072 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +00001073 if( pPager->journalOff+JOURNAL_HDR_SZ(pPager) > journalSize ){
1074 return SQLITE_DONE;
1075 }
danielk197762079062007-08-15 17:08:46 +00001076 jrnlOff = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +00001077
danielk197762079062007-08-15 17:08:46 +00001078 rc = sqlite3OsRead(pPager->jfd, aMagic, sizeof(aMagic), jrnlOff);
danielk197776572402004-06-25 02:38:54 +00001079 if( rc ) return rc;
danielk197762079062007-08-15 17:08:46 +00001080 jrnlOff += sizeof(aMagic);
danielk197776572402004-06-25 02:38:54 +00001081
1082 if( memcmp(aMagic, aJournalMagic, sizeof(aMagic))!=0 ){
1083 return SQLITE_DONE;
1084 }
1085
danielk197762079062007-08-15 17:08:46 +00001086 rc = read32bits(pPager->jfd, jrnlOff, pNRec);
danielk197776572402004-06-25 02:38:54 +00001087 if( rc ) return rc;
1088
danielk197762079062007-08-15 17:08:46 +00001089 rc = read32bits(pPager->jfd, jrnlOff+4, &pPager->cksumInit);
danielk197776572402004-06-25 02:38:54 +00001090 if( rc ) return rc;
1091
danielk197762079062007-08-15 17:08:46 +00001092 rc = read32bits(pPager->jfd, jrnlOff+8, pDbSize);
danielk197776572402004-06-25 02:38:54 +00001093 if( rc ) return rc;
1094
danielk197767c007b2008-03-20 04:45:49 +00001095 rc = read32bits(pPager->jfd, jrnlOff+16, (u32 *)&iPageSize);
1096 if( rc==SQLITE_OK
1097 && iPageSize>=512
1098 && iPageSize<=SQLITE_MAX_PAGE_SIZE
1099 && ((iPageSize-1)&iPageSize)==0
1100 ){
1101 u16 pagesize = iPageSize;
1102 rc = sqlite3PagerSetPagesize(pPager, &pagesize);
1103 }
1104 if( rc ) return rc;
1105
danielk197776572402004-06-25 02:38:54 +00001106 /* Update the assumed sector-size to match the value used by
1107 ** the process that created this journal. If this journal was
1108 ** created by a process other than this one, then this routine
1109 ** is being called from within pager_playback(). The local value
1110 ** of Pager.sectorSize is restored at the end of that routine.
1111 */
danielk197762079062007-08-15 17:08:46 +00001112 rc = read32bits(pPager->jfd, jrnlOff+12, (u32 *)&pPager->sectorSize);
danielk197776572402004-06-25 02:38:54 +00001113 if( rc ) return rc;
1114
1115 pPager->journalOff += JOURNAL_HDR_SZ(pPager);
danielk197762079062007-08-15 17:08:46 +00001116 return SQLITE_OK;
danielk197776572402004-06-25 02:38:54 +00001117}
1118
1119
1120/*
1121** Write the supplied master journal name into the journal file for pager
danielk1977cafadba2004-06-25 11:11:54 +00001122** pPager at the current location. The master journal name must be the last
1123** thing written to a journal file. If the pager is in full-sync mode, the
1124** journal file descriptor is advanced to the next sector boundary before
1125** anything is written. The format is:
1126**
1127** + 4 bytes: PAGER_MJ_PGNO.
1128** + N bytes: length of master journal name.
1129** + 4 bytes: N
1130** + 4 bytes: Master journal name checksum.
1131** + 8 bytes: aJournalMagic[].
1132**
1133** The master journal page checksum is the sum of the bytes in the master
1134** journal name.
danielk1977aef0bf62005-12-30 16:28:01 +00001135**
1136** If zMaster is a NULL pointer (occurs for a single database transaction),
1137** this call is a no-op.
danielk197776572402004-06-25 02:38:54 +00001138*/
1139static int writeMasterJournal(Pager *pPager, const char *zMaster){
1140 int rc;
1141 int len;
danielk1977cafadba2004-06-25 11:11:54 +00001142 int i;
danielk197762079062007-08-15 17:08:46 +00001143 i64 jrnlOff;
drh97b57482006-01-10 20:32:32 +00001144 u32 cksum = 0;
1145 char zBuf[sizeof(aJournalMagic)+2*4];
danielk197776572402004-06-25 02:38:54 +00001146
1147 if( !zMaster || pPager->setMaster) return SQLITE_OK;
1148 pPager->setMaster = 1;
1149
1150 len = strlen(zMaster);
danielk1977cafadba2004-06-25 11:11:54 +00001151 for(i=0; i<len; i++){
1152 cksum += zMaster[i];
1153 }
danielk197776572402004-06-25 02:38:54 +00001154
1155 /* If in full-sync mode, advance to the next disk sector before writing
1156 ** the master journal name. This is in case the previous page written to
1157 ** the journal has already been synced.
1158 */
1159 if( pPager->fullSync ){
danielk197762079062007-08-15 17:08:46 +00001160 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +00001161 }
danielk197762079062007-08-15 17:08:46 +00001162 jrnlOff = pPager->journalOff;
danielk1977cafadba2004-06-25 11:11:54 +00001163 pPager->journalOff += (len+20);
danielk197776572402004-06-25 02:38:54 +00001164
danielk197762079062007-08-15 17:08:46 +00001165 rc = write32bits(pPager->jfd, jrnlOff, PAGER_MJ_PGNO(pPager));
danielk197776572402004-06-25 02:38:54 +00001166 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +00001167 jrnlOff += 4;
danielk197776572402004-06-25 02:38:54 +00001168
danielk197762079062007-08-15 17:08:46 +00001169 rc = sqlite3OsWrite(pPager->jfd, zMaster, len, jrnlOff);
danielk197776572402004-06-25 02:38:54 +00001170 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +00001171 jrnlOff += len;
danielk197776572402004-06-25 02:38:54 +00001172
drh97b57482006-01-10 20:32:32 +00001173 put32bits(zBuf, len);
1174 put32bits(&zBuf[4], cksum);
1175 memcpy(&zBuf[8], aJournalMagic, sizeof(aJournalMagic));
danielk197762079062007-08-15 17:08:46 +00001176 rc = sqlite3OsWrite(pPager->jfd, zBuf, 8+sizeof(aJournalMagic), jrnlOff);
drh2c8997b2005-08-27 16:36:48 +00001177 pPager->needSync = !pPager->noSync;
danielk197776572402004-06-25 02:38:54 +00001178 return rc;
1179}
1180
1181/*
drh03eb96a2002-11-10 23:32:56 +00001182** Add or remove a page from the list of all pages that are in the
drhac69b052004-05-12 13:30:07 +00001183** statement journal.
drh03eb96a2002-11-10 23:32:56 +00001184**
1185** The Pager keeps a separate list of pages that are currently in
danielk19773b8a05f2007-03-19 17:44:26 +00001186** the statement journal. This helps the sqlite3PagerStmtCommit()
drh03eb96a2002-11-10 23:32:56 +00001187** routine run MUCH faster for the common case where there are many
drhac69b052004-05-12 13:30:07 +00001188** pages in memory but only a few are in the statement journal.
drh03eb96a2002-11-10 23:32:56 +00001189*/
drh3aac2dd2004-04-26 14:10:20 +00001190static void page_add_to_stmt_list(PgHdr *pPg){
drh03eb96a2002-11-10 23:32:56 +00001191 Pager *pPager = pPg->pPager;
danielk1977f35843b2007-04-07 15:03:17 +00001192 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
1193 assert( MEMDB );
1194 if( !pHist->inStmt ){
1195 assert( pHist->pPrevStmt==0 && pHist->pNextStmt==0 );
1196 if( pPager->pStmt ){
1197 PGHDR_TO_HIST(pPager->pStmt, pPager)->pPrevStmt = pPg;
1198 }
1199 pHist->pNextStmt = pPager->pStmt;
1200 pPager->pStmt = pPg;
1201 pHist->inStmt = 1;
drh03eb96a2002-11-10 23:32:56 +00001202 }
drh03eb96a2002-11-10 23:32:56 +00001203}
1204
1205/*
drhed7c8552001-04-11 14:29:21 +00001206** Find a page in the hash table given its page number. Return
1207** a pointer to the page or NULL if not found.
1208*/
drhd9b02572001-04-15 00:37:09 +00001209static PgHdr *pager_lookup(Pager *pPager, Pgno pgno){
drh8ca0c722006-05-07 17:49:38 +00001210 PgHdr *p;
1211 if( pPager->aHash==0 ) return 0;
1212 p = pPager->aHash[pgno & (pPager->nHash-1)];
drhed7c8552001-04-11 14:29:21 +00001213 while( p && p->pgno!=pgno ){
1214 p = p->pNextHash;
1215 }
1216 return p;
1217}
1218
1219/*
danielk1977e180dd92007-04-05 17:15:52 +00001220** Clear the in-memory cache. This routine
drhed7c8552001-04-11 14:29:21 +00001221** sets the state of the pager back to what it was when it was first
1222** opened. Any outstanding pages are invalidated and subsequent attempts
1223** to access those pages will likely result in a coredump.
1224*/
drhd9b02572001-04-15 00:37:09 +00001225static void pager_reset(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +00001226 PgHdr *pPg, *pNext;
danielk1977efaaf572006-01-16 11:29:19 +00001227 if( pPager->errCode ) return;
drhd9b02572001-04-15 00:37:09 +00001228 for(pPg=pPager->pAll; pPg; pPg=pNext){
drh538f5702007-04-13 02:14:30 +00001229 IOTRACE(("PGFREE %p %d\n", pPager, pPg->pgno));
1230 PAGER_INCR(sqlite3_pager_pgfree_count);
drhd9b02572001-04-15 00:37:09 +00001231 pNext = pPg->pNextAll;
danielk19779f61c2f2007-08-27 17:27:49 +00001232 lruListRemove(pPg);
drh0d180202008-02-14 23:26:56 +00001233 sqlite3_free(pPg->pData);
drh17435752007-08-16 04:30:38 +00001234 sqlite3_free(pPg);
drhed7c8552001-04-11 14:29:21 +00001235 }
danielk19779f61c2f2007-08-27 17:27:49 +00001236 assert(pPager->lru.pFirst==0);
1237 assert(pPager->lru.pFirstSynced==0);
1238 assert(pPager->lru.pLast==0);
danielk1977b94bf852007-03-19 13:53:37 +00001239 pPager->pStmt = 0;
drhd9b02572001-04-15 00:37:09 +00001240 pPager->pAll = 0;
danielk1977ae72d982007-10-03 08:46:44 +00001241 pPager->pDirty = 0;
drh8ca0c722006-05-07 17:49:38 +00001242 pPager->nHash = 0;
drh17435752007-08-16 04:30:38 +00001243 sqlite3_free(pPager->aHash);
drhed7c8552001-04-11 14:29:21 +00001244 pPager->nPage = 0;
drh8ca0c722006-05-07 17:49:38 +00001245 pPager->aHash = 0;
drhed7c8552001-04-11 14:29:21 +00001246 pPager->nRef = 0;
danielk1977e277be02007-03-23 18:12:06 +00001247}
1248
1249/*
danielk1977ae72d982007-10-03 08:46:44 +00001250** Unlock the database file.
1251**
1252** If the pager is currently in error state, discard the contents of
1253** the cache and reset the Pager structure internal state. If there is
1254** an open journal-file, then the next time a shared-lock is obtained
1255** on the pager file (by this or any other process), it will be
1256** treated as a hot-journal and rolled back.
1257*/
1258static void pager_unlock(Pager *pPager){
1259 if( !pPager->exclusiveMode ){
1260 if( !MEMDB ){
drh1aa5af12008-03-07 19:51:14 +00001261 int rc = osUnlock(pPager->fd, NO_LOCK);
drh308aa322008-03-07 20:14:38 +00001262 if( rc ) pPager->errCode = rc;
danielk1977ae72d982007-10-03 08:46:44 +00001263 pPager->dbSize = -1;
1264 IOTRACE(("UNLOCK %p\n", pPager))
1265
1266 /* If Pager.errCode is set, the contents of the pager cache cannot be
1267 ** trusted. Now that the pager file is unlocked, the contents of the
1268 ** cache can be discarded and the error code safely cleared.
1269 */
1270 if( pPager->errCode ){
drh1aa5af12008-03-07 19:51:14 +00001271 if( rc==SQLITE_OK ) pPager->errCode = SQLITE_OK;
danielk1977ae72d982007-10-03 08:46:44 +00001272 pager_reset(pPager);
1273 if( pPager->stmtOpen ){
1274 sqlite3OsClose(pPager->stfd);
drhf5e7bb52008-02-18 14:47:33 +00001275 sqlite3BitvecDestroy(pPager->pInStmt);
1276 pPager->pInStmt = 0;
danielk1977ae72d982007-10-03 08:46:44 +00001277 }
1278 if( pPager->journalOpen ){
1279 sqlite3OsClose(pPager->jfd);
1280 pPager->journalOpen = 0;
drhf5e7bb52008-02-18 14:47:33 +00001281 sqlite3BitvecDestroy(pPager->pInJournal);
1282 pPager->pInJournal = 0;
danielk1977ae72d982007-10-03 08:46:44 +00001283 }
1284 pPager->stmtOpen = 0;
1285 pPager->stmtInUse = 0;
1286 pPager->journalOff = 0;
1287 pPager->journalStarted = 0;
1288 pPager->stmtAutoopen = 0;
1289 pPager->origDbSize = 0;
1290 }
1291 }
1292
1293 if( !MEMDB || pPager->errCode==SQLITE_OK ){
1294 pPager->state = PAGER_UNLOCK;
1295 pPager->changeCountDone = 0;
1296 }
1297 }
1298}
1299
1300/*
1301** Execute a rollback if a transaction is active and unlock the
1302** database file. If the pager has already entered the error state,
1303** do not attempt the rollback.
1304*/
1305static void pagerUnlockAndRollback(Pager *p){
1306 assert( p->state>=PAGER_RESERVED || p->journalOpen==0 );
1307 if( p->errCode==SQLITE_OK && p->state>=PAGER_RESERVED ){
1308 sqlite3PagerRollback(p);
1309 }
1310 pager_unlock(p);
1311 assert( p->errCode || !p->journalOpen || (p->exclusiveMode&&!p->journalOff) );
1312 assert( p->errCode || !p->stmtOpen || p->exclusiveMode );
1313}
1314
1315/*
drh80e35f42007-03-30 14:06:34 +00001316** This routine ends a transaction. A transaction is ended by either
1317** a COMMIT or a ROLLBACK.
1318**
drhed7c8552001-04-11 14:29:21 +00001319** When this routine is called, the pager has the journal file open and
drh80e35f42007-03-30 14:06:34 +00001320** a RESERVED or EXCLUSIVE lock on the database. This routine will release
1321** the database lock and acquires a SHARED lock in its place if that is
1322** the appropriate thing to do. Release locks usually is appropriate,
1323** unless we are in exclusive access mode or unless this is a
1324** COMMIT AND BEGIN or ROLLBACK AND BEGIN operation.
1325**
1326** The journal file is either deleted or truncated.
drh50457892003-09-06 01:10:47 +00001327**
1328** TODO: Consider keeping the journal file open for temporary databases.
1329** This might give a performance improvement on windows where opening
1330** a file is an expensive operation.
drhed7c8552001-04-11 14:29:21 +00001331*/
drh80e35f42007-03-30 14:06:34 +00001332static int pager_end_transaction(Pager *pPager){
drhd9b02572001-04-15 00:37:09 +00001333 PgHdr *pPg;
danielk197741483462007-03-24 16:45:04 +00001334 int rc = SQLITE_OK;
danielk1977979f38e2007-03-27 16:19:51 +00001335 int rc2 = SQLITE_OK;
drhb7f91642004-10-31 02:22:47 +00001336 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +00001337 if( pPager->state<PAGER_RESERVED ){
1338 return SQLITE_OK;
1339 }
danielk19773b8a05f2007-03-19 17:44:26 +00001340 sqlite3PagerStmtCommit(pPager);
danielk1977334cdb62007-03-26 08:05:12 +00001341 if( pPager->stmtOpen && !pPager->exclusiveMode ){
danielk1977b4b47412007-08-17 15:53:36 +00001342 sqlite3OsClose(pPager->stfd);
danielk1977979f38e2007-03-27 16:19:51 +00001343 pPager->stmtOpen = 0;
drh0f892532002-05-30 12:27:03 +00001344 }
drhda47d772002-12-02 04:25:19 +00001345 if( pPager->journalOpen ){
drh01fa4c32007-04-02 11:22:22 +00001346 if( pPager->exclusiveMode
1347 && (rc = sqlite3OsTruncate(pPager->jfd, 0))==SQLITE_OK ){;
danielk197741483462007-03-24 16:45:04 +00001348 pPager->journalOff = 0;
danielk1977334cdb62007-03-26 08:05:12 +00001349 pPager->journalStarted = 0;
danielk197741483462007-03-24 16:45:04 +00001350 }else{
danielk1977b4b47412007-08-17 15:53:36 +00001351 sqlite3OsClose(pPager->jfd);
danielk197741483462007-03-24 16:45:04 +00001352 pPager->journalOpen = 0;
drh01fa4c32007-04-02 11:22:22 +00001353 if( rc==SQLITE_OK ){
danielk1977fee2d252007-08-18 10:59:19 +00001354 rc = sqlite3OsDelete(pPager->pVfs, pPager->zJournal, 0);
danielk19777152de82007-03-29 17:28:14 +00001355 }
danielk197741483462007-03-24 16:45:04 +00001356 }
drhf5e7bb52008-02-18 14:47:33 +00001357 sqlite3BitvecDestroy(pPager->pInJournal);
1358 pPager->pInJournal = 0;
drhda47d772002-12-02 04:25:19 +00001359 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
1360 pPg->inJournal = 0;
1361 pPg->dirty = 0;
drhdb48ee02003-01-16 13:42:43 +00001362 pPg->needSync = 0;
danielk197741483462007-03-24 16:45:04 +00001363 pPg->alwaysRollback = 0;
danielk19773c407372005-02-15 02:54:14 +00001364#ifdef SQLITE_CHECK_PAGES
1365 pPg->pageHash = pager_pagehash(pPg);
1366#endif
drhda47d772002-12-02 04:25:19 +00001367 }
drh605ad8f2006-05-03 23:34:05 +00001368 pPager->pDirty = 0;
danielk1977ef317ab2004-06-23 10:43:10 +00001369 pPager->dirtyCache = 0;
danielk1977ef317ab2004-06-23 10:43:10 +00001370 pPager->nRec = 0;
drhda47d772002-12-02 04:25:19 +00001371 }else{
drhf5e7bb52008-02-18 14:47:33 +00001372 assert( pPager->pInJournal==0 );
drha6abd042004-06-09 17:37:22 +00001373 assert( pPager->dirtyCache==0 || pPager->useJournal==0 );
drhd9b02572001-04-15 00:37:09 +00001374 }
danielk1977979f38e2007-03-27 16:19:51 +00001375
danielk197741483462007-03-24 16:45:04 +00001376 if( !pPager->exclusiveMode ){
danielk19777a2b1ee2007-08-21 14:27:01 +00001377 rc2 = osUnlock(pPager->fd, SHARED_LOCK);
danielk197741483462007-03-24 16:45:04 +00001378 pPager->state = PAGER_SHARED;
danielk1977334cdb62007-03-26 08:05:12 +00001379 }else if( pPager->state==PAGER_SYNCED ){
1380 pPager->state = PAGER_EXCLUSIVE;
danielk197741483462007-03-24 16:45:04 +00001381 }
danielk1977334cdb62007-03-26 08:05:12 +00001382 pPager->origDbSize = 0;
danielk197776572402004-06-25 02:38:54 +00001383 pPager->setMaster = 0;
danielk1977c4da5b92006-01-21 12:08:54 +00001384 pPager->needSync = 0;
danielk19779f61c2f2007-08-27 17:27:49 +00001385 lruListSetFirstSynced(pPager);
drh588f5bc2007-01-02 18:41:54 +00001386 pPager->dbSize = -1;
danielk1977979f38e2007-03-27 16:19:51 +00001387
1388 return (rc==SQLITE_OK?rc2:rc);
drhed7c8552001-04-11 14:29:21 +00001389}
1390
drhed7c8552001-04-11 14:29:21 +00001391/*
drh968af522003-02-11 14:55:40 +00001392** Compute and return a checksum for the page of data.
drh34e79ce2004-02-08 06:05:46 +00001393**
1394** This is not a real checksum. It is really just the sum of the
drh726de592004-06-10 23:35:50 +00001395** random initial value and the page number. We experimented with
1396** a checksum of the entire data, but that was found to be too slow.
1397**
1398** Note that the page number is stored at the beginning of data and
1399** the checksum is stored at the end. This is important. If journal
1400** corruption occurs due to a power failure, the most likely scenario
1401** is that one end or the other of the record will be changed. It is
1402** much less likely that the two ends of the journal record will be
1403** correct and the middle be corrupt. Thus, this "checksum" scheme,
1404** though fast and simple, catches the mostly likely kind of corruption.
1405**
1406** FIX ME: Consider adding every 200th (or so) byte of the data to the
1407** checksum. That way if a single page spans 3 or more disk sectors and
1408** only the middle sector is corrupt, we will still have a reasonable
1409** chance of failing the checksum and thus detecting the problem.
drh968af522003-02-11 14:55:40 +00001410*/
drh74161702006-02-24 02:53:49 +00001411static u32 pager_cksum(Pager *pPager, const u8 *aData){
danielk1977ef317ab2004-06-23 10:43:10 +00001412 u32 cksum = pPager->cksumInit;
1413 int i = pPager->pageSize-200;
1414 while( i>0 ){
1415 cksum += aData[i];
1416 i -= 200;
1417 }
drh968af522003-02-11 14:55:40 +00001418 return cksum;
1419}
1420
drh605ad8f2006-05-03 23:34:05 +00001421/* Forward declaration */
1422static void makeClean(PgHdr*);
1423
drh968af522003-02-11 14:55:40 +00001424/*
drhfa86c412002-02-02 15:01:15 +00001425** Read a single page from the journal file opened on file descriptor
1426** jfd. Playback this one page.
drh968af522003-02-11 14:55:40 +00001427**
drh726de592004-06-10 23:35:50 +00001428** If useCksum==0 it means this journal does not use checksums. Checksums
1429** are not used in statement journals because statement journals do not
1430** need to survive power failures.
drhfa86c412002-02-02 15:01:15 +00001431*/
danielk197762079062007-08-15 17:08:46 +00001432static int pager_playback_one_page(
1433 Pager *pPager,
1434 sqlite3_file *jfd,
1435 i64 offset,
1436 int useCksum
1437){
drhfa86c412002-02-02 15:01:15 +00001438 int rc;
drhae2b40c2004-06-09 19:03:54 +00001439 PgHdr *pPg; /* An existing page in the cache */
1440 Pgno pgno; /* The page number of a page in journal */
1441 u32 cksum; /* Checksum used for sanity checking */
danielk19778186df82007-03-06 13:45:59 +00001442 u8 *aData = (u8 *)pPager->pTmpSpace; /* Temp storage for a page */
drhfa86c412002-02-02 15:01:15 +00001443
drh96362842005-03-20 22:47:56 +00001444 /* useCksum should be true for the main journal and false for
1445 ** statement journals. Verify that this is always the case
1446 */
drh9cbe6352005-11-29 03:13:21 +00001447 assert( jfd == (useCksum ? pPager->jfd : pPager->stfd) );
danielk19778186df82007-03-06 13:45:59 +00001448 assert( aData );
drh96362842005-03-20 22:47:56 +00001449
danielk197762079062007-08-15 17:08:46 +00001450 rc = read32bits(jfd, offset, &pgno);
drh99ee3602003-02-16 19:13:36 +00001451 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +00001452 rc = sqlite3OsRead(jfd, aData, pPager->pageSize, offset+4);
drh99ee3602003-02-16 19:13:36 +00001453 if( rc!=SQLITE_OK ) return rc;
danielk197776572402004-06-25 02:38:54 +00001454 pPager->journalOff += pPager->pageSize + 4;
drhfa86c412002-02-02 15:01:15 +00001455
drh968af522003-02-11 14:55:40 +00001456 /* Sanity checking on the page. This is more important that I originally
1457 ** thought. If a power failure occurs while the journal is being written,
1458 ** it could cause invalid data to be written into the journal. We need to
1459 ** detect this invalid data (with high probability) and ignore it.
1460 */
danielk197775edc162004-06-26 01:48:18 +00001461 if( pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh968af522003-02-11 14:55:40 +00001462 return SQLITE_DONE;
1463 }
drhae2b40c2004-06-09 19:03:54 +00001464 if( pgno>(unsigned)pPager->dbSize ){
drh968af522003-02-11 14:55:40 +00001465 return SQLITE_OK;
1466 }
drhae2b40c2004-06-09 19:03:54 +00001467 if( useCksum ){
danielk197762079062007-08-15 17:08:46 +00001468 rc = read32bits(jfd, offset+pPager->pageSize+4, &cksum);
drh99ee3602003-02-16 19:13:36 +00001469 if( rc ) return rc;
danielk197776572402004-06-25 02:38:54 +00001470 pPager->journalOff += 4;
drh74161702006-02-24 02:53:49 +00001471 if( pager_cksum(pPager, aData)!=cksum ){
drh968af522003-02-11 14:55:40 +00001472 return SQLITE_DONE;
1473 }
1474 }
drhfa86c412002-02-02 15:01:15 +00001475
danielk1977aa5ccdf2004-06-14 05:10:42 +00001476 assert( pPager->state==PAGER_RESERVED || pPager->state>=PAGER_EXCLUSIVE );
danielk1977a3f3a5f2004-06-10 04:32:16 +00001477
1478 /* If the pager is in RESERVED state, then there must be a copy of this
1479 ** page in the pager cache. In this case just update the pager cache,
danielk19770de0bb32004-06-10 05:59:24 +00001480 ** not the database file. The page is left marked dirty in this case.
1481 **
danielk19772df71c72007-05-24 07:22:42 +00001482 ** An exception to the above rule: If the database is in no-sync mode
1483 ** and a page is moved during an incremental vacuum then the page may
danielk1977369f3a02007-05-24 09:41:20 +00001484 ** not be in the pager cache. Later: if a malloc() or IO error occurs
1485 ** during a Movepage() call, then the page may not be in the cache
1486 ** either. So the condition described in the above paragraph is not
1487 ** assert()able.
danielk19772df71c72007-05-24 07:22:42 +00001488 **
danielk1977a3f3a5f2004-06-10 04:32:16 +00001489 ** If in EXCLUSIVE state, then we update the pager cache if it exists
1490 ** and the main file. The page is then marked not dirty.
drh96362842005-03-20 22:47:56 +00001491 **
1492 ** Ticket #1171: The statement journal might contain page content that is
1493 ** different from the page content at the start of the transaction.
1494 ** This occurs when a page is changed prior to the start of a statement
1495 ** then changed again within the statement. When rolling back such a
1496 ** statement we must not write to the original database unless we know
drh5e385312007-06-16 04:42:12 +00001497 ** for certain that original page contents are synced into the main rollback
1498 ** journal. Otherwise, a power loss might leave modified data in the
1499 ** database file without an entry in the rollback journal that can
1500 ** restore the database to its original form. Two conditions must be
1501 ** met before writing to the database files. (1) the database must be
1502 ** locked. (2) we know that the original page content is fully synced
1503 ** in the main journal either because the page is not in cache or else
1504 ** the page is marked as needSync==0.
drh4c02a232008-04-14 23:13:45 +00001505 **
1506 ** 2008-04-14: When attempting to vacuum a corrupt database file, it
1507 ** is possible to fail a statement on a database that does not yet exist.
1508 ** Do not attempt to write if database file has never been opened.
drhfa86c412002-02-02 15:01:15 +00001509 */
drhae2b40c2004-06-09 19:03:54 +00001510 pPg = pager_lookup(pPager, pgno);
drh477731b2007-06-16 03:06:27 +00001511 PAGERTRACE4("PLAYBACK %d page %d hash(%08x)\n",
1512 PAGERID(pPager), pgno, pager_datahash(pPager->pageSize, aData));
drh4c02a232008-04-14 23:13:45 +00001513 if( pPager->state>=PAGER_EXCLUSIVE && (pPg==0 || pPg->needSync==0)
1514 && pPager->fd->pMethods ){
danielk197762079062007-08-15 17:08:46 +00001515 i64 offset = (pgno-1)*(i64)pPager->pageSize;
1516 rc = sqlite3OsWrite(pPager->fd, aData, pPager->pageSize, offset);
drh605ad8f2006-05-03 23:34:05 +00001517 if( pPg ){
1518 makeClean(pPg);
1519 }
danielk1977a3f3a5f2004-06-10 04:32:16 +00001520 }
drhfa86c412002-02-02 15:01:15 +00001521 if( pPg ){
danielk197728129562005-01-11 10:25:06 +00001522 /* No page should ever be explicitly rolled back that is in use, except
1523 ** for page 1 which is held in use in order to keep the lock on the
1524 ** database active. However such a page may be rolled back as a result
1525 ** of an internal error resulting in an automatic call to
danielk19773b8a05f2007-03-19 17:44:26 +00001526 ** sqlite3PagerRollback().
drhacf4ac92003-12-17 23:57:34 +00001527 */
drhb6f41482004-05-14 01:58:11 +00001528 void *pData;
danielk197728129562005-01-11 10:25:06 +00001529 /* assert( pPg->nRef==0 || pPg->pgno==1 ); */
drhb6f41482004-05-14 01:58:11 +00001530 pData = PGHDR_TO_DATA(pPg);
drhae2b40c2004-06-09 19:03:54 +00001531 memcpy(pData, aData, pPager->pageSize);
danielk19779038bb62007-04-09 11:20:54 +00001532 if( pPager->xReiniter ){
1533 pPager->xReiniter(pPg, pPager->pageSize);
drhde647132004-05-07 17:57:49 +00001534 }
danielk19773c407372005-02-15 02:54:14 +00001535#ifdef SQLITE_CHECK_PAGES
drh96362842005-03-20 22:47:56 +00001536 pPg->pageHash = pager_pagehash(pPg);
danielk19773c407372005-02-15 02:54:14 +00001537#endif
drh86a88112007-04-16 15:02:19 +00001538 /* If this was page 1, then restore the value of Pager.dbFileVers.
1539 ** Do this before any decoding. */
danielk197741483462007-03-24 16:45:04 +00001540 if( pgno==1 ){
drh86a88112007-04-16 15:02:19 +00001541 memcpy(&pPager->dbFileVers, &((u8*)pData)[24],sizeof(pPager->dbFileVers));
danielk197741483462007-03-24 16:45:04 +00001542 }
drh86a88112007-04-16 15:02:19 +00001543
1544 /* Decode the page just read from disk */
1545 CODEC1(pPager, pData, pPg->pgno, 3);
drhfa86c412002-02-02 15:01:15 +00001546 }
1547 return rc;
1548}
1549
1550/*
danielk197713adf8a2004-06-03 16:08:41 +00001551** Parameter zMaster is the name of a master journal file. A single journal
1552** file that referred to the master journal file has just been rolled back.
1553** This routine checks if it is possible to delete the master journal file,
1554** and does so if it is.
drh726de592004-06-10 23:35:50 +00001555**
danielk197765839c62007-08-30 08:08:17 +00001556** Argument zMaster may point to Pager.pTmpSpace. So that buffer is not
1557** available for use within this function.
1558**
1559**
drh726de592004-06-10 23:35:50 +00001560** The master journal file contains the names of all child journals.
1561** To tell if a master journal can be deleted, check to each of the
1562** children. If all children are either missing or do not refer to
1563** a different master journal, then this master journal can be deleted.
danielk197713adf8a2004-06-03 16:08:41 +00001564*/
danielk1977b4b47412007-08-17 15:53:36 +00001565static int pager_delmaster(Pager *pPager, const char *zMaster){
1566 sqlite3_vfs *pVfs = pPager->pVfs;
danielk197713adf8a2004-06-03 16:08:41 +00001567 int rc;
1568 int master_open = 0;
danielk1977b4b47412007-08-17 15:53:36 +00001569 sqlite3_file *pMaster;
1570 sqlite3_file *pJournal;
danielk197713adf8a2004-06-03 16:08:41 +00001571 char *zMasterJournal = 0; /* Contents of master journal file */
drheb206252004-10-01 02:00:31 +00001572 i64 nMasterJournal; /* Size of master journal file */
danielk197713adf8a2004-06-03 16:08:41 +00001573
1574 /* Open the master journal file exclusively in case some other process
1575 ** is running this routine also. Not that it makes too much difference.
1576 */
danielk1977b4b47412007-08-17 15:53:36 +00001577 pMaster = (sqlite3_file *)sqlite3_malloc(pVfs->szOsFile * 2);
danielk1977fee2d252007-08-18 10:59:19 +00001578 pJournal = (sqlite3_file *)(((u8 *)pMaster) + pVfs->szOsFile);
danielk1977b4b47412007-08-17 15:53:36 +00001579 if( !pMaster ){
1580 rc = SQLITE_NOMEM;
1581 }else{
danielk1977fee2d252007-08-18 10:59:19 +00001582 int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MASTER_JOURNAL);
1583 rc = sqlite3OsOpen(pVfs, zMaster, pMaster, flags, 0);
danielk1977b4b47412007-08-17 15:53:36 +00001584 }
danielk197713adf8a2004-06-03 16:08:41 +00001585 if( rc!=SQLITE_OK ) goto delmaster_out;
1586 master_open = 1;
danielk1977b4b47412007-08-17 15:53:36 +00001587
1588 rc = sqlite3OsFileSize(pMaster, &nMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001589 if( rc!=SQLITE_OK ) goto delmaster_out;
1590
1591 if( nMasterJournal>0 ){
danielk19775865e3d2004-06-14 06:03:57 +00001592 char *zJournal;
danielk197776572402004-06-25 02:38:54 +00001593 char *zMasterPtr = 0;
danielk197765839c62007-08-30 08:08:17 +00001594 int nMasterPtr = pPager->pVfs->mxPathname+1;
danielk19775865e3d2004-06-14 06:03:57 +00001595
1596 /* Load the entire master journal file into space obtained from
drh17435752007-08-16 04:30:38 +00001597 ** sqlite3_malloc() and pointed to by zMasterJournal.
danielk19775865e3d2004-06-14 06:03:57 +00001598 */
danielk197765839c62007-08-30 08:08:17 +00001599 zMasterJournal = (char *)sqlite3_malloc(nMasterJournal + nMasterPtr);
danielk197713adf8a2004-06-03 16:08:41 +00001600 if( !zMasterJournal ){
1601 rc = SQLITE_NOMEM;
1602 goto delmaster_out;
1603 }
danielk197765839c62007-08-30 08:08:17 +00001604 zMasterPtr = &zMasterJournal[nMasterJournal];
danielk1977b4b47412007-08-17 15:53:36 +00001605 rc = sqlite3OsRead(pMaster, zMasterJournal, nMasterJournal, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001606 if( rc!=SQLITE_OK ) goto delmaster_out;
1607
danielk19775865e3d2004-06-14 06:03:57 +00001608 zJournal = zMasterJournal;
1609 while( (zJournal-zMasterJournal)<nMasterJournal ){
drh19db9352008-03-27 22:42:51 +00001610 rc = sqlite3OsAccess(pVfs, zJournal, SQLITE_ACCESS_EXISTS);
1611 if( rc!=0 && rc!=1 ){
1612 rc = SQLITE_IOERR_NOMEM;
1613 goto delmaster_out;
1614 }
1615 if( rc==1 ){
danielk197713adf8a2004-06-03 16:08:41 +00001616 /* One of the journals pointed to by the master journal exists.
1617 ** Open it and check if it points at the master journal. If
1618 ** so, return without deleting the master journal file.
1619 */
drh3b7b78b2004-11-24 01:16:43 +00001620 int c;
danielk1977fee2d252007-08-18 10:59:19 +00001621 int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MAIN_JOURNAL);
1622 rc = sqlite3OsOpen(pVfs, zJournal, pJournal, flags, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001623 if( rc!=SQLITE_OK ){
danielk197713adf8a2004-06-03 16:08:41 +00001624 goto delmaster_out;
1625 }
danielk197713adf8a2004-06-03 16:08:41 +00001626
danielk197765839c62007-08-30 08:08:17 +00001627 rc = readMasterJournal(pJournal, zMasterPtr, nMasterPtr);
danielk1977b4b47412007-08-17 15:53:36 +00001628 sqlite3OsClose(pJournal);
danielk19779eed5052004-06-04 10:38:30 +00001629 if( rc!=SQLITE_OK ){
danielk19779eed5052004-06-04 10:38:30 +00001630 goto delmaster_out;
1631 }
danielk197776572402004-06-25 02:38:54 +00001632
danielk197765839c62007-08-30 08:08:17 +00001633 c = zMasterPtr[0]!=0 && strcmp(zMasterPtr, zMaster)==0;
drh3b7b78b2004-11-24 01:16:43 +00001634 if( c ){
danielk197776572402004-06-25 02:38:54 +00001635 /* We have a match. Do not delete the master journal file. */
1636 goto delmaster_out;
danielk197713adf8a2004-06-03 16:08:41 +00001637 }
1638 }
danielk19775865e3d2004-06-14 06:03:57 +00001639 zJournal += (strlen(zJournal)+1);
danielk197713adf8a2004-06-03 16:08:41 +00001640 }
1641 }
1642
danielk1977fee2d252007-08-18 10:59:19 +00001643 rc = sqlite3OsDelete(pVfs, zMaster, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001644
1645delmaster_out:
1646 if( zMasterJournal ){
drh17435752007-08-16 04:30:38 +00001647 sqlite3_free(zMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001648 }
1649 if( master_open ){
danielk1977b4b47412007-08-17 15:53:36 +00001650 sqlite3OsClose(pMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001651 }
danielk1977b4b47412007-08-17 15:53:36 +00001652 sqlite3_free(pMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001653 return rc;
1654}
1655
drha6abd042004-06-09 17:37:22 +00001656
danielk1977e180dd92007-04-05 17:15:52 +00001657static void pager_truncate_cache(Pager *pPager);
1658
drha6abd042004-06-09 17:37:22 +00001659/*
drhcb4c40b2004-08-18 19:09:43 +00001660** Truncate the main file of the given pager to the number of pages
danielk1977e180dd92007-04-05 17:15:52 +00001661** indicated. Also truncate the cached representation of the file.
drh7fe3f7e2007-11-29 18:44:27 +00001662**
1663** Might might be the case that the file on disk is smaller than nPage.
1664** This can happen, for example, if we are in the middle of a transaction
1665** which has extended the file size and the new pages are still all held
1666** in cache, then an INSERT or UPDATE does a statement rollback. Some
1667** operating system implementations can get confused if you try to
1668** truncate a file to some size that is larger than it currently is,
1669** so detect this case and do not do the truncation.
drhcb4c40b2004-08-18 19:09:43 +00001670*/
1671static int pager_truncate(Pager *pPager, int nPage){
danielk1977e180dd92007-04-05 17:15:52 +00001672 int rc = SQLITE_OK;
danielk19777a2b1ee2007-08-21 14:27:01 +00001673 if( pPager->state>=PAGER_EXCLUSIVE && pPager->fd->pMethods ){
drh7fe3f7e2007-11-29 18:44:27 +00001674 i64 currentSize, newSize;
1675 rc = sqlite3OsFileSize(pPager->fd, &currentSize);
1676 newSize = pPager->pageSize*(i64)nPage;
1677 if( rc==SQLITE_OK && currentSize>newSize ){
1678 rc = sqlite3OsTruncate(pPager->fd, newSize);
1679 }
danielk1977e180dd92007-04-05 17:15:52 +00001680 }
1681 if( rc==SQLITE_OK ){
1682 pPager->dbSize = nPage;
1683 pager_truncate_cache(pPager);
1684 }
1685 return rc;
drhcb4c40b2004-08-18 19:09:43 +00001686}
1687
1688/*
drhc80f0582007-05-01 16:59:48 +00001689** Set the sectorSize for the given pager.
1690**
drh334c80d2008-03-28 17:41:13 +00001691** The sector size is at least as big as the sector size reported
1692** by sqlite3OsSectorSize(). The minimum sector size is 512.
drhc80f0582007-05-01 16:59:48 +00001693*/
1694static void setSectorSize(Pager *pPager){
danielk19777a2b1ee2007-08-21 14:27:01 +00001695 assert(pPager->fd->pMethods||pPager->tempFile);
1696 if( !pPager->tempFile ){
1697 /* Sector size doesn't matter for temporary files. Also, the file
1698 ** may not have been opened yet, in whcih case the OsSectorSize()
1699 ** call will segfault.
1700 */
1701 pPager->sectorSize = sqlite3OsSectorSize(pPager->fd);
1702 }
drh334c80d2008-03-28 17:41:13 +00001703 if( pPager->sectorSize<512 ){
1704 pPager->sectorSize = 512;
drhc80f0582007-05-01 16:59:48 +00001705 }
1706}
1707
1708/*
drhed7c8552001-04-11 14:29:21 +00001709** Playback the journal and thus restore the database file to
1710** the state it was in before we started making changes.
1711**
drh34e79ce2004-02-08 06:05:46 +00001712** The journal file format is as follows:
1713**
drhae2b40c2004-06-09 19:03:54 +00001714** (1) 8 byte prefix. A copy of aJournalMagic[].
1715** (2) 4 byte big-endian integer which is the number of valid page records
drh34e79ce2004-02-08 06:05:46 +00001716** in the journal. If this value is 0xffffffff, then compute the
drhae2b40c2004-06-09 19:03:54 +00001717** number of page records from the journal size.
1718** (3) 4 byte big-endian integer which is the initial value for the
1719** sanity checksum.
1720** (4) 4 byte integer which is the number of pages to truncate the
drh34e79ce2004-02-08 06:05:46 +00001721** database to during a rollback.
drh334c80d2008-03-28 17:41:13 +00001722** (5) 4 byte big-endian integer which is the sector size. The header
1723** is this many bytes in size.
1724** (6) 4 byte big-endian integer which is the page case.
1725** (7) 4 byte integer which is the number of bytes in the master journal
drhae2b40c2004-06-09 19:03:54 +00001726** name. The value may be zero (indicate that there is no master
1727** journal.)
drh334c80d2008-03-28 17:41:13 +00001728** (8) N bytes of the master journal name. The name will be nul-terminated
drhae2b40c2004-06-09 19:03:54 +00001729** and might be shorter than the value read from (5). If the first byte
1730** of the name is \000 then there is no master journal. The master
1731** journal name is stored in UTF-8.
drh334c80d2008-03-28 17:41:13 +00001732** (9) Zero or more pages instances, each as follows:
drh34e79ce2004-02-08 06:05:46 +00001733** + 4 byte page number.
drhae2b40c2004-06-09 19:03:54 +00001734** + pPager->pageSize bytes of data.
1735** + 4 byte checksum
drh34e79ce2004-02-08 06:05:46 +00001736**
drh334c80d2008-03-28 17:41:13 +00001737** When we speak of the journal header, we mean the first 8 items above.
1738** Each entry in the journal is an instance of the 9th item.
drh34e79ce2004-02-08 06:05:46 +00001739**
1740** Call the value from the second bullet "nRec". nRec is the number of
1741** valid page entries in the journal. In most cases, you can compute the
1742** value of nRec from the size of the journal file. But if a power
1743** failure occurred while the journal was being written, it could be the
1744** case that the size of the journal file had already been increased but
1745** the extra entries had not yet made it safely to disk. In such a case,
1746** the value of nRec computed from the file size would be too large. For
1747** that reason, we always use the nRec value in the header.
1748**
1749** If the nRec value is 0xffffffff it means that nRec should be computed
1750** from the file size. This value is used when the user selects the
1751** no-sync option for the journal. A power failure could lead to corruption
1752** in this case. But for things like temporary table (which will be
1753** deleted when the power is restored) we don't care.
1754**
drhd9b02572001-04-15 00:37:09 +00001755** If the file opened as the journal file is not a well-formed
danielk1977ece80f12004-06-23 01:05:26 +00001756** journal file then all pages up to the first corrupted page are rolled
1757** back (or no pages if the journal header is corrupted). The journal file
1758** is then deleted and SQLITE_OK returned, just as if no corruption had
1759** been encountered.
1760**
1761** If an I/O or malloc() error occurs, the journal-file is not deleted
1762** and an error code is returned.
drhed7c8552001-04-11 14:29:21 +00001763*/
danielk1977e277be02007-03-23 18:12:06 +00001764static int pager_playback(Pager *pPager, int isHot){
danielk1977b4b47412007-08-17 15:53:36 +00001765 sqlite3_vfs *pVfs = pPager->pVfs;
drheb206252004-10-01 02:00:31 +00001766 i64 szJ; /* Size of the journal file in bytes */
danielk1977c3e8f5e2004-06-28 01:16:46 +00001767 u32 nRec; /* Number of Records in the journal */
drhd9b02572001-04-15 00:37:09 +00001768 int i; /* Loop counter */
1769 Pgno mxPg = 0; /* Size of the original file in pages */
drhae2b40c2004-06-09 19:03:54 +00001770 int rc; /* Result code of a subroutine */
danielk1977ce98bba2008-04-03 10:13:01 +00001771 int res = 0; /* Value returned by sqlite3OsAccess() */
danielk197713adf8a2004-06-03 16:08:41 +00001772 char *zMaster = 0; /* Name of master journal file if any */
drhed7c8552001-04-11 14:29:21 +00001773
drhc3a64ba2001-11-22 00:01:27 +00001774 /* Figure out how many records are in the journal. Abort early if
1775 ** the journal is empty.
drhed7c8552001-04-11 14:29:21 +00001776 */
drh8cfbf082001-09-19 13:22:39 +00001777 assert( pPager->journalOpen );
drh054889e2005-11-30 03:20:31 +00001778 rc = sqlite3OsFileSize(pPager->jfd, &szJ);
danielk1977334cdb62007-03-26 08:05:12 +00001779 if( rc!=SQLITE_OK || szJ==0 ){
drhc3a64ba2001-11-22 00:01:27 +00001780 goto end_playback;
1781 }
drh240c5792004-02-08 00:40:52 +00001782
danielk197776572402004-06-25 02:38:54 +00001783 /* Read the master journal name from the journal, if it is present.
1784 ** If a master journal file name is specified, but the file is not
1785 ** present on disk, then the journal is not hot and does not need to be
1786 ** played back.
drh240c5792004-02-08 00:40:52 +00001787 */
danielk197765839c62007-08-30 08:08:17 +00001788 zMaster = pPager->pTmpSpace;
1789 rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1);
danielk1977ce98bba2008-04-03 10:13:01 +00001790 if( rc!=SQLITE_OK || (zMaster[0]
1791 && (res=sqlite3OsAccess(pVfs, zMaster, SQLITE_ACCESS_EXISTS))==0 )
danielk1977b4b47412007-08-17 15:53:36 +00001792 ){
danielk197776572402004-06-25 02:38:54 +00001793 zMaster = 0;
drhc3a64ba2001-11-22 00:01:27 +00001794 goto end_playback;
1795 }
danielk197765839c62007-08-30 08:08:17 +00001796 zMaster = 0;
danielk1977ce98bba2008-04-03 10:13:01 +00001797 if( res<0 ){
1798 rc = SQLITE_IOERR_NOMEM;
1799 goto end_playback;
1800 }
1801 pPager->journalOff = 0;
drhc3a64ba2001-11-22 00:01:27 +00001802
danielk197776572402004-06-25 02:38:54 +00001803 /* This loop terminates either when the readJournalHdr() call returns
1804 ** SQLITE_DONE or an IO error occurs. */
1805 while( 1 ){
drhae2b40c2004-06-09 19:03:54 +00001806
danielk197776572402004-06-25 02:38:54 +00001807 /* Read the next journal header from the journal file. If there are
1808 ** not enough bytes left in the journal file for a complete header, or
1809 ** it is corrupted, then a process must of failed while writing it.
1810 ** This indicates nothing more needs to be rolled back.
1811 */
1812 rc = readJournalHdr(pPager, szJ, &nRec, &mxPg);
1813 if( rc!=SQLITE_OK ){
drh968af522003-02-11 14:55:40 +00001814 if( rc==SQLITE_DONE ){
drh968af522003-02-11 14:55:40 +00001815 rc = SQLITE_OK;
1816 }
danielk197776572402004-06-25 02:38:54 +00001817 goto end_playback;
1818 }
1819
1820 /* If nRec is 0xffffffff, then this journal was created by a process
1821 ** working in no-sync mode. This means that the rest of the journal
1822 ** file consists of pages, there are no more journal headers. Compute
1823 ** the value of nRec based on this assumption.
1824 */
1825 if( nRec==0xffffffff ){
1826 assert( pPager->journalOff==JOURNAL_HDR_SZ(pPager) );
1827 nRec = (szJ - JOURNAL_HDR_SZ(pPager))/JOURNAL_PG_SZ(pPager);
1828 }
1829
danielk1977e277be02007-03-23 18:12:06 +00001830 /* If nRec is 0 and this rollback is of a transaction created by this
drh8940f4e2007-08-11 00:26:20 +00001831 ** process and if this is the final header in the journal, then it means
1832 ** that this part of the journal was being filled but has not yet been
1833 ** synced to disk. Compute the number of pages based on the remaining
1834 ** size of the file.
1835 **
1836 ** The third term of the test was added to fix ticket #2565.
danielk1977e277be02007-03-23 18:12:06 +00001837 */
drh8940f4e2007-08-11 00:26:20 +00001838 if( nRec==0 && !isHot &&
1839 pPager->journalHdr+JOURNAL_HDR_SZ(pPager)==pPager->journalOff ){
danielk1977e277be02007-03-23 18:12:06 +00001840 nRec = (szJ - pPager->journalOff) / JOURNAL_PG_SZ(pPager);
1841 }
1842
danielk197776572402004-06-25 02:38:54 +00001843 /* If this is the first header read from the journal, truncate the
drh85b623f2007-12-13 21:54:09 +00001844 ** database file back to its original size.
danielk197776572402004-06-25 02:38:54 +00001845 */
danielk1977e180dd92007-04-05 17:15:52 +00001846 if( pPager->journalOff==JOURNAL_HDR_SZ(pPager) ){
drhcb4c40b2004-08-18 19:09:43 +00001847 rc = pager_truncate(pPager, mxPg);
danielk197776572402004-06-25 02:38:54 +00001848 if( rc!=SQLITE_OK ){
1849 goto end_playback;
1850 }
danielk197776572402004-06-25 02:38:54 +00001851 }
1852
danielk197776572402004-06-25 02:38:54 +00001853 /* Copy original pages out of the journal and back into the database file.
1854 */
1855 for(i=0; i<nRec; i++){
danielk197762079062007-08-15 17:08:46 +00001856 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001857 if( rc!=SQLITE_OK ){
1858 if( rc==SQLITE_DONE ){
1859 rc = SQLITE_OK;
1860 pPager->journalOff = szJ;
1861 break;
1862 }else{
1863 goto end_playback;
1864 }
1865 }
drh968af522003-02-11 14:55:40 +00001866 }
drhed7c8552001-04-11 14:29:21 +00001867 }
drh580eeaf2006-02-24 03:09:37 +00001868 /*NOTREACHED*/
1869 assert( 0 );
drh4a0681e2003-02-13 01:58:20 +00001870
1871end_playback:
danielk19778191bff2004-06-28 04:52:30 +00001872 if( rc==SQLITE_OK ){
danielk197765839c62007-08-30 08:08:17 +00001873 zMaster = pPager->pTmpSpace;
1874 rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1);
1875 }
1876 if( rc==SQLITE_OK ){
drh80e35f42007-03-30 14:06:34 +00001877 rc = pager_end_transaction(pPager);
danielk19778191bff2004-06-28 04:52:30 +00001878 }
danielk197765839c62007-08-30 08:08:17 +00001879 if( rc==SQLITE_OK && zMaster[0] ){
danielk1977979f38e2007-03-27 16:19:51 +00001880 /* If there was a master journal and this routine will return success,
danielk197732554c12005-01-22 03:39:39 +00001881 ** see if it is possible to delete the master journal.
danielk197713adf8a2004-06-03 16:08:41 +00001882 */
danielk197765839c62007-08-30 08:08:17 +00001883 rc = pager_delmaster(pPager, zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001884 }
danielk197776572402004-06-25 02:38:54 +00001885
1886 /* The Pager.sectorSize variable may have been updated while rolling
drh3ceeb752007-03-29 18:19:52 +00001887 ** back a journal created by a process with a different sector size
danielk197776572402004-06-25 02:38:54 +00001888 ** value. Reset it to the correct value for this process.
1889 */
drhc80f0582007-05-01 16:59:48 +00001890 setSectorSize(pPager);
drhd9b02572001-04-15 00:37:09 +00001891 return rc;
drhed7c8552001-04-11 14:29:21 +00001892}
1893
1894/*
drhac69b052004-05-12 13:30:07 +00001895** Playback the statement journal.
drhfa86c412002-02-02 15:01:15 +00001896**
1897** This is similar to playing back the transaction journal but with
1898** a few extra twists.
1899**
drh663fc632002-02-02 18:49:19 +00001900** (1) The number of pages in the database file at the start of
drhac69b052004-05-12 13:30:07 +00001901** the statement is stored in pPager->stmtSize, not in the
drh663fc632002-02-02 18:49:19 +00001902** journal file itself.
drhfa86c412002-02-02 15:01:15 +00001903**
drhac69b052004-05-12 13:30:07 +00001904** (2) In addition to playing back the statement journal, also
drhfa86c412002-02-02 15:01:15 +00001905** playback all pages of the transaction journal beginning
drhac69b052004-05-12 13:30:07 +00001906** at offset pPager->stmtJSize.
drhfa86c412002-02-02 15:01:15 +00001907*/
drh3aac2dd2004-04-26 14:10:20 +00001908static int pager_stmt_playback(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001909 i64 szJ; /* Size of the full journal */
1910 i64 hdrOff;
drh968af522003-02-11 14:55:40 +00001911 int nRec; /* Number of Records */
drhfa86c412002-02-02 15:01:15 +00001912 int i; /* Loop counter */
1913 int rc;
1914
danielk197776572402004-06-25 02:38:54 +00001915 szJ = pPager->journalOff;
1916#ifndef NDEBUG
1917 {
drheb206252004-10-01 02:00:31 +00001918 i64 os_szJ;
drh054889e2005-11-30 03:20:31 +00001919 rc = sqlite3OsFileSize(pPager->jfd, &os_szJ);
danielk197776572402004-06-25 02:38:54 +00001920 if( rc!=SQLITE_OK ) return rc;
1921 assert( szJ==os_szJ );
1922 }
1923#endif
1924
danielk19774099f6e2007-03-19 11:25:20 +00001925 /* Set hdrOff to be the offset just after the end of the last journal
1926 ** page written before the first journal-header for this statement
1927 ** transaction was written, or the end of the file if no journal
danielk197776572402004-06-25 02:38:54 +00001928 ** header was written.
1929 */
1930 hdrOff = pPager->stmtHdrOff;
1931 assert( pPager->fullSync || !hdrOff );
1932 if( !hdrOff ){
1933 hdrOff = szJ;
1934 }
1935
drhfa86c412002-02-02 15:01:15 +00001936 /* Truncate the database back to its original size.
1937 */
danielk1977e180dd92007-04-05 17:15:52 +00001938 rc = pager_truncate(pPager, pPager->stmtSize);
drh1aa2d8b2007-01-03 15:34:29 +00001939 assert( pPager->state>=PAGER_SHARED );
drhfa86c412002-02-02 15:01:15 +00001940
drhac69b052004-05-12 13:30:07 +00001941 /* Figure out how many records are in the statement journal.
drhfa86c412002-02-02 15:01:15 +00001942 */
drhac69b052004-05-12 13:30:07 +00001943 assert( pPager->stmtInUse && pPager->journalOpen );
drhac69b052004-05-12 13:30:07 +00001944 nRec = pPager->stmtNRec;
drhfa86c412002-02-02 15:01:15 +00001945
drhac69b052004-05-12 13:30:07 +00001946 /* Copy original pages out of the statement journal and back into the
drhae2b40c2004-06-09 19:03:54 +00001947 ** database file. Note that the statement journal omits checksums from
1948 ** each record since power-failure recovery is not important to statement
1949 ** journals.
drhfa86c412002-02-02 15:01:15 +00001950 */
danielk197762079062007-08-15 17:08:46 +00001951 for(i=0; i<nRec; i++){
1952 i64 offset = i*(4+pPager->pageSize);
1953 rc = pager_playback_one_page(pPager, pPager->stfd, offset, 0);
drh968af522003-02-11 14:55:40 +00001954 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001955 if( rc!=SQLITE_OK ) goto end_stmt_playback;
drhfa86c412002-02-02 15:01:15 +00001956 }
1957
danielk197776572402004-06-25 02:38:54 +00001958 /* Now roll some pages back from the transaction journal. Pager.stmtJSize
1959 ** was the size of the journal file when this statement was started, so
1960 ** everything after that needs to be rolled back, either into the
1961 ** database, the memory cache, or both.
1962 **
1963 ** If it is not zero, then Pager.stmtHdrOff is the offset to the start
1964 ** of the first journal header written during this statement transaction.
drhfa86c412002-02-02 15:01:15 +00001965 */
danielk197776572402004-06-25 02:38:54 +00001966 pPager->journalOff = pPager->stmtJSize;
danielk197775edc162004-06-26 01:48:18 +00001967 pPager->cksumInit = pPager->stmtCksum;
danielk19774099f6e2007-03-19 11:25:20 +00001968 while( pPager->journalOff < hdrOff ){
danielk197762079062007-08-15 17:08:46 +00001969 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001970 assert( rc!=SQLITE_DONE );
1971 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1972 }
1973
1974 while( pPager->journalOff < szJ ){
danielk1977f0113002006-01-24 12:09:17 +00001975 u32 nJRec; /* Number of Journal Records */
danielk197776572402004-06-25 02:38:54 +00001976 u32 dummy;
danielk1977f0113002006-01-24 12:09:17 +00001977 rc = readJournalHdr(pPager, szJ, &nJRec, &dummy);
drh968af522003-02-11 14:55:40 +00001978 if( rc!=SQLITE_OK ){
1979 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001980 goto end_stmt_playback;
drh968af522003-02-11 14:55:40 +00001981 }
danielk1977f0113002006-01-24 12:09:17 +00001982 if( nJRec==0 ){
1983 nJRec = (szJ - pPager->journalOff) / (pPager->pageSize+8);
danielk197775edc162004-06-26 01:48:18 +00001984 }
danielk1977f0113002006-01-24 12:09:17 +00001985 for(i=nJRec-1; i>=0 && pPager->journalOff < szJ; i--){
danielk197762079062007-08-15 17:08:46 +00001986 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001987 assert( rc!=SQLITE_DONE );
1988 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1989 }
drhfa86c412002-02-02 15:01:15 +00001990 }
danielk197776572402004-06-25 02:38:54 +00001991
1992 pPager->journalOff = szJ;
drhfa86c412002-02-02 15:01:15 +00001993
drh3aac2dd2004-04-26 14:10:20 +00001994end_stmt_playback:
danielk19778a7aea32006-01-23 15:25:48 +00001995 if( rc==SQLITE_OK) {
danielk197775edc162004-06-26 01:48:18 +00001996 pPager->journalOff = szJ;
1997 /* pager_reload_cache(pPager); */
drhfa86c412002-02-02 15:01:15 +00001998 }
1999 return rc;
2000}
2001
2002/*
drhf57b14a2001-09-14 18:54:08 +00002003** Change the maximum number of in-memory pages that are allowed.
2004*/
danielk19773b8a05f2007-03-19 17:44:26 +00002005void sqlite3PagerSetCachesize(Pager *pPager, int mxPage){
drhf57b14a2001-09-14 18:54:08 +00002006 if( mxPage>10 ){
2007 pPager->mxPage = mxPage;
danielk1977ef317ab2004-06-23 10:43:10 +00002008 }else{
2009 pPager->mxPage = 10;
drhf57b14a2001-09-14 18:54:08 +00002010 }
2011}
2012
2013/*
drh973b6e32003-02-12 14:09:42 +00002014** Adjust the robustness of the database to damage due to OS crashes
2015** or power failures by changing the number of syncs()s when writing
2016** the rollback journal. There are three levels:
2017**
drh054889e2005-11-30 03:20:31 +00002018** OFF sqlite3OsSync() is never called. This is the default
drh973b6e32003-02-12 14:09:42 +00002019** for temporary and transient files.
2020**
2021** NORMAL The journal is synced once before writes begin on the
2022** database. This is normally adequate protection, but
2023** it is theoretically possible, though very unlikely,
2024** that an inopertune power failure could leave the journal
2025** in a state which would cause damage to the database
2026** when it is rolled back.
2027**
2028** FULL The journal is synced twice before writes begin on the
drh34e79ce2004-02-08 06:05:46 +00002029** database (with some additional information - the nRec field
2030** of the journal header - being written in between the two
2031** syncs). If we assume that writing a
drh973b6e32003-02-12 14:09:42 +00002032** single disk sector is atomic, then this mode provides
2033** assurance that the journal will not be corrupted to the
2034** point of causing damage to the database during rollback.
2035**
2036** Numeric values associated with these states are OFF==1, NORMAL=2,
2037** and FULL=3.
2038*/
danielk197793758c82005-01-21 08:13:14 +00002039#ifndef SQLITE_OMIT_PAGER_PRAGMAS
danielk19773b8a05f2007-03-19 17:44:26 +00002040void sqlite3PagerSetSafetyLevel(Pager *pPager, int level, int full_fsync){
drh973b6e32003-02-12 14:09:42 +00002041 pPager->noSync = level==1 || pPager->tempFile;
2042 pPager->fullSync = level==3 && !pPager->tempFile;
danielk1977f036aef2007-08-20 05:36:51 +00002043 pPager->sync_flags = (full_fsync?SQLITE_SYNC_FULL:SQLITE_SYNC_NORMAL);
danielk19771d850a72004-05-31 08:26:49 +00002044 if( pPager->noSync ) pPager->needSync = 0;
drh973b6e32003-02-12 14:09:42 +00002045}
danielk197793758c82005-01-21 08:13:14 +00002046#endif
drh973b6e32003-02-12 14:09:42 +00002047
2048/*
drhaf6df112005-06-07 02:12:30 +00002049** The following global variable is incremented whenever the library
2050** attempts to open a temporary file. This information is used for
2051** testing and analysis only.
2052*/
drh0f7eb612006-08-08 13:51:43 +00002053#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00002054int sqlite3_opentemp_count = 0;
drh0f7eb612006-08-08 13:51:43 +00002055#endif
drhaf6df112005-06-07 02:12:30 +00002056
2057/*
drh3f56e6e2007-03-15 01:16:47 +00002058** Open a temporary file.
2059**
2060** Write the file descriptor into *fd. Return SQLITE_OK on success or some
danielk1977fee2d252007-08-18 10:59:19 +00002061** other error code if we fail. The OS will automatically delete the temporary
2062** file when it is closed.
drhfa86c412002-02-02 15:01:15 +00002063*/
danielk1977b4b47412007-08-17 15:53:36 +00002064static int sqlite3PagerOpentemp(
drh33f4e022007-09-03 15:19:34 +00002065 sqlite3_vfs *pVfs, /* The virtual file system layer */
2066 sqlite3_file *pFile, /* Write the file descriptor here */
2067 char *zFilename, /* Name of the file. Might be NULL */
2068 int vfsFlags /* Flags passed through to the VFS */
danielk1977b4b47412007-08-17 15:53:36 +00002069){
drhfa86c412002-02-02 15:01:15 +00002070 int rc;
drh334b2992007-09-06 23:28:23 +00002071 assert( zFilename!=0 );
drh3f56e6e2007-03-15 01:16:47 +00002072
drh0f7eb612006-08-08 13:51:43 +00002073#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00002074 sqlite3_opentemp_count++; /* Used for testing and analysis only */
drh0f7eb612006-08-08 13:51:43 +00002075#endif
danielk1977b4b47412007-08-17 15:53:36 +00002076
drh33f4e022007-09-03 15:19:34 +00002077 vfsFlags |= SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE |
2078 SQLITE_OPEN_EXCLUSIVE | SQLITE_OPEN_DELETEONCLOSE;
2079 rc = sqlite3OsOpen(pVfs, zFilename, pFile, vfsFlags, 0);
drhae28c012007-08-24 16:29:23 +00002080 assert( rc!=SQLITE_OK || pFile->pMethods );
drhfa86c412002-02-02 15:01:15 +00002081 return rc;
2082}
2083
2084/*
drhed7c8552001-04-11 14:29:21 +00002085** Create a new page cache and put a pointer to the page cache in *ppPager.
drh5e00f6c2001-09-13 13:46:56 +00002086** The file to be cached need not exist. The file is not locked until
danielk19773b8a05f2007-03-19 17:44:26 +00002087** the first call to sqlite3PagerGet() and is only held open until the
2088** last page is released using sqlite3PagerUnref().
drh382c0242001-10-06 16:33:02 +00002089**
drh6446c4d2001-12-15 14:22:18 +00002090** If zFilename is NULL then a randomly-named temporary file is created
drh1cc8c442007-08-24 16:08:29 +00002091** and used as the file to be cached. The file will be deleted
drh6446c4d2001-12-15 14:22:18 +00002092** automatically when it is closed.
drh90f5ecb2004-07-22 01:19:35 +00002093**
2094** If zFilename is ":memory:" then all information is held in cache.
2095** It is never written to disk. This can be used to implement an
2096** in-memory database.
drhed7c8552001-04-11 14:29:21 +00002097*/
danielk19773b8a05f2007-03-19 17:44:26 +00002098int sqlite3PagerOpen(
drh86f8c192007-08-22 00:39:19 +00002099 sqlite3_vfs *pVfs, /* The virtual file system to use */
drh7e3b0a02001-04-28 16:52:40 +00002100 Pager **ppPager, /* Return the Pager structure here */
2101 const char *zFilename, /* Name of the database file to open */
drhda47d772002-12-02 04:25:19 +00002102 int nExtra, /* Extra bytes append to each in-memory page */
drh33f4e022007-09-03 15:19:34 +00002103 int flags, /* flags controlling this file */
2104 int vfsFlags /* flags passed through to sqlite3_vfs.xOpen() */
drh7e3b0a02001-04-28 16:52:40 +00002105){
danielk1977b4b47412007-08-17 15:53:36 +00002106 u8 *pPtr;
danielk1977aef0bf62005-12-30 16:28:01 +00002107 Pager *pPager = 0;
danielk1977cfe9a692004-06-16 12:00:29 +00002108 int rc = SQLITE_OK;
2109 int i;
danielk19778def5ea2004-06-16 10:39:52 +00002110 int tempFile = 0;
drhac69b052004-05-12 13:30:07 +00002111 int memDb = 0;
drh5e00f6c2001-09-13 13:46:56 +00002112 int readOnly = 0;
drh7bec5052005-02-06 02:45:41 +00002113 int useJournal = (flags & PAGER_OMIT_JOURNAL)==0;
2114 int noReadlock = (flags & PAGER_NO_READLOCK)!=0;
danielk1977c7b60172007-08-22 11:22:03 +00002115 int journalFileSize = sqlite3JournalSize(pVfs);
drh1cc8c442007-08-24 16:08:29 +00002116 int nDefaultPage = SQLITE_DEFAULT_PAGE_SIZE;
2117 char *zPathname;
2118 int nPathname;
drh99b90c32008-03-17 13:50:58 +00002119 char *zStmtJrnl;
2120 int nStmtJrnl;
danielk1977b4b47412007-08-17 15:53:36 +00002121
drh86f8c192007-08-22 00:39:19 +00002122 /* The default return is a NULL pointer */
drhd9b02572001-04-15 00:37:09 +00002123 *ppPager = 0;
danielk1977aef0bf62005-12-30 16:28:01 +00002124
drh1cc8c442007-08-24 16:08:29 +00002125 /* Compute the full pathname */
danielk1977adfb9b02007-09-17 07:02:56 +00002126 nPathname = pVfs->mxPathname+1;
drh99b90c32008-03-17 13:50:58 +00002127 zPathname = sqlite3_malloc(nPathname*2);
drh1cc8c442007-08-24 16:08:29 +00002128 if( zPathname==0 ){
2129 return SQLITE_NOMEM;
2130 }
2131 if( zFilename && zFilename[0] ){
2132#ifndef SQLITE_OMIT_MEMORYDB
2133 if( strcmp(zFilename,":memory:")==0 ){
2134 memDb = 1;
2135 zPathname[0] = 0;
2136 }else
2137#endif
2138 {
danielk1977adfb9b02007-09-17 07:02:56 +00002139 rc = sqlite3OsFullPathname(pVfs, zFilename, nPathname, zPathname);
drh1cc8c442007-08-24 16:08:29 +00002140 }
2141 }else{
danielk1977adfb9b02007-09-17 07:02:56 +00002142 rc = sqlite3OsGetTempname(pVfs, nPathname, zPathname);
drhae28c012007-08-24 16:29:23 +00002143 }
2144 if( rc!=SQLITE_OK ){
2145 sqlite3_free(zPathname);
2146 return rc;
drh1cc8c442007-08-24 16:08:29 +00002147 }
2148 nPathname = strlen(zPathname);
2149
drh99b90c32008-03-17 13:50:58 +00002150 /* Put the statement journal in temporary disk space since this is
2151 ** sometimes RAM disk or other optimized storage. Unlikely the main
2152 ** main journal file, the statement journal does not need to be
2153 ** colocated with the database nor does it need to be persistent.
2154 */
2155 zStmtJrnl = &zPathname[nPathname+1];
2156 rc = sqlite3OsGetTempname(pVfs, pVfs->mxPathname+1, zStmtJrnl);
2157 if( rc!=SQLITE_OK ){
2158 sqlite3_free(zPathname);
2159 return rc;
2160 }
2161 nStmtJrnl = strlen(zStmtJrnl);
2162
danielk1977b4b47412007-08-17 15:53:36 +00002163 /* Allocate memory for the pager structure */
2164 pPager = sqlite3MallocZero(
2165 sizeof(*pPager) + /* Pager structure */
danielk1977c7b60172007-08-22 11:22:03 +00002166 journalFileSize + /* The journal file structure */
drh17c0ba22008-02-26 18:40:11 +00002167 pVfs->szOsFile * 3 + /* The main db and two journal files */
drh99b90c32008-03-17 13:50:58 +00002168 3*nPathname + 40 + /* zFilename, zDirectory, zJournal */
2169 nStmtJrnl /* zStmtJrnl */
danielk1977b4b47412007-08-17 15:53:36 +00002170 );
2171 if( !pPager ){
drh1cc8c442007-08-24 16:08:29 +00002172 sqlite3_free(zPathname);
danielk1977b4b47412007-08-17 15:53:36 +00002173 return SQLITE_NOMEM;
2174 }
2175 pPtr = (u8 *)&pPager[1];
drh33f4e022007-09-03 15:19:34 +00002176 pPager->vfsFlags = vfsFlags;
danielk1977b4b47412007-08-17 15:53:36 +00002177 pPager->fd = (sqlite3_file*)&pPtr[pVfs->szOsFile*0];
danielk1977c7b60172007-08-22 11:22:03 +00002178 pPager->stfd = (sqlite3_file*)&pPtr[pVfs->szOsFile*1];
2179 pPager->jfd = (sqlite3_file*)&pPtr[pVfs->szOsFile*2];
2180 pPager->zFilename = (char*)&pPtr[pVfs->szOsFile*2+journalFileSize];
drh1cc8c442007-08-24 16:08:29 +00002181 pPager->zDirectory = &pPager->zFilename[nPathname+1];
2182 pPager->zJournal = &pPager->zDirectory[nPathname+1];
drh334b2992007-09-06 23:28:23 +00002183 pPager->zStmtJrnl = &pPager->zJournal[nPathname+10];
danielk1977b4b47412007-08-17 15:53:36 +00002184 pPager->pVfs = pVfs;
drh1cc8c442007-08-24 16:08:29 +00002185 memcpy(pPager->zFilename, zPathname, nPathname+1);
drh99b90c32008-03-17 13:50:58 +00002186 memcpy(pPager->zStmtJrnl, zStmtJrnl, nStmtJrnl+1);
drh1cc8c442007-08-24 16:08:29 +00002187 sqlite3_free(zPathname);
danielk1977b4b47412007-08-17 15:53:36 +00002188
drh153c62c2007-08-24 03:51:33 +00002189 /* Open the pager file.
danielk1977aef0bf62005-12-30 16:28:01 +00002190 */
drhae28c012007-08-24 16:29:23 +00002191 if( zFilename && zFilename[0] && !memDb ){
drh1cc8c442007-08-24 16:08:29 +00002192 if( nPathname>(pVfs->mxPathname - sizeof("-journal")) ){
2193 rc = SQLITE_CANTOPEN;
2194 }else{
drh1cc8c442007-08-24 16:08:29 +00002195 int fout = 0;
drh33f4e022007-09-03 15:19:34 +00002196 rc = sqlite3OsOpen(pVfs, pPager->zFilename, pPager->fd,
2197 pPager->vfsFlags, &fout);
drh1cc8c442007-08-24 16:08:29 +00002198 readOnly = (fout&SQLITE_OPEN_READONLY);
2199
2200 /* If the file was successfully opened for read/write access,
2201 ** choose a default page size in case we have to create the
2202 ** database file. The default page size is the maximum of:
2203 **
2204 ** + SQLITE_DEFAULT_PAGE_SIZE,
2205 ** + The value returned by sqlite3OsSectorSize()
2206 ** + The largest page size that can be written atomically.
2207 */
2208 if( rc==SQLITE_OK && !readOnly ){
2209 int iSectorSize = sqlite3OsSectorSize(pPager->fd);
2210 if( nDefaultPage<iSectorSize ){
2211 nDefaultPage = iSectorSize;
2212 }
danielk19779663b8f2007-08-24 11:52:28 +00002213#ifdef SQLITE_ENABLE_ATOMIC_WRITE
drh1cc8c442007-08-24 16:08:29 +00002214 {
2215 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
2216 int ii;
2217 assert(SQLITE_IOCAP_ATOMIC512==(512>>8));
2218 assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8));
2219 assert(SQLITE_MAX_DEFAULT_PAGE_SIZE<=65536);
2220 for(ii=nDefaultPage; ii<=SQLITE_MAX_DEFAULT_PAGE_SIZE; ii=ii*2){
2221 if( iDc&(SQLITE_IOCAP_ATOMIC|(ii>>8)) ) nDefaultPage = ii;
danielk19779663b8f2007-08-24 11:52:28 +00002222 }
danielk1977b4b47412007-08-17 15:53:36 +00002223 }
drh1cc8c442007-08-24 16:08:29 +00002224#endif
2225 if( nDefaultPage>SQLITE_MAX_DEFAULT_PAGE_SIZE ){
2226 nDefaultPage = SQLITE_MAX_DEFAULT_PAGE_SIZE;
2227 }
danielk19778def5ea2004-06-16 10:39:52 +00002228 }
drhac69b052004-05-12 13:30:07 +00002229 }
drh1cc8c442007-08-24 16:08:29 +00002230 }else if( !memDb ){
danielk19777a2b1ee2007-08-21 14:27:01 +00002231 /* If a temporary file is requested, it is not opened immediately.
2232 ** In this case we accept the default page size and delay actually
2233 ** opening the file until the first call to OsWrite().
2234 */
danielk19777a2b1ee2007-08-21 14:27:01 +00002235 tempFile = 1;
2236 pPager->state = PAGER_EXCLUSIVE;
drh5e00f6c2001-09-13 13:46:56 +00002237 }
danielk1977aef0bf62005-12-30 16:28:01 +00002238
danielk1977b4b47412007-08-17 15:53:36 +00002239 if( pPager && rc==SQLITE_OK ){
danielk19779663b8f2007-08-24 11:52:28 +00002240 pPager->pTmpSpace = (char *)sqlite3_malloc(nDefaultPage);
drh3e7a6092002-12-07 21:45:14 +00002241 }
danielk1977aef0bf62005-12-30 16:28:01 +00002242
drh153c62c2007-08-24 03:51:33 +00002243 /* If an error occured in either of the blocks above.
2244 ** Free the Pager structure and close the file.
2245 ** Since the pager is not allocated there is no need to set
danielk1977aef0bf62005-12-30 16:28:01 +00002246 ** any Pager.errMask variables.
2247 */
danielk1977b4b47412007-08-17 15:53:36 +00002248 if( !pPager || !pPager->pTmpSpace ){
2249 sqlite3OsClose(pPager->fd);
drh17435752007-08-16 04:30:38 +00002250 sqlite3_free(pPager);
danielk1977aef0bf62005-12-30 16:28:01 +00002251 return ((rc==SQLITE_OK)?SQLITE_NOMEM:rc);
drhed7c8552001-04-11 14:29:21 +00002252 }
danielk1977aef0bf62005-12-30 16:28:01 +00002253
drh153c62c2007-08-24 03:51:33 +00002254 PAGERTRACE3("OPEN %d %s\n", FILEHANDLEID(pPager->fd), pPager->zFilename);
2255 IOTRACE(("OPEN %p %s\n", pPager, pPager->zFilename))
danielk1977aef0bf62005-12-30 16:28:01 +00002256
danielk1977b4b47412007-08-17 15:53:36 +00002257 /* Fill in Pager.zDirectory[] */
drh1cc8c442007-08-24 16:08:29 +00002258 memcpy(pPager->zDirectory, pPager->zFilename, nPathname+1);
danielk1977b4b47412007-08-17 15:53:36 +00002259 for(i=strlen(pPager->zDirectory); i>0 && pPager->zDirectory[i-1]!='/'; i--){}
drha76c82e2003-07-27 18:59:42 +00002260 if( i>0 ) pPager->zDirectory[i-1] = 0;
danielk1977b4b47412007-08-17 15:53:36 +00002261
drh99b90c32008-03-17 13:50:58 +00002262 /* Fill in Pager.zJournal[] */
drh1cc8c442007-08-24 16:08:29 +00002263 memcpy(pPager->zJournal, pPager->zFilename, nPathname);
2264 memcpy(&pPager->zJournal[nPathname], "-journal", 9);
danielk1977b4b47412007-08-17 15:53:36 +00002265
drh3b59a5c2006-01-15 20:28:28 +00002266 /* pPager->journalOpen = 0; */
drhac69b052004-05-12 13:30:07 +00002267 pPager->useJournal = useJournal && !memDb;
drh7bec5052005-02-06 02:45:41 +00002268 pPager->noReadlock = noReadlock && readOnly;
drh3b59a5c2006-01-15 20:28:28 +00002269 /* pPager->stmtOpen = 0; */
2270 /* pPager->stmtInUse = 0; */
2271 /* pPager->nRef = 0; */
drhac69b052004-05-12 13:30:07 +00002272 pPager->dbSize = memDb-1;
danielk19779663b8f2007-08-24 11:52:28 +00002273 pPager->pageSize = nDefaultPage;
drh3b59a5c2006-01-15 20:28:28 +00002274 /* pPager->stmtSize = 0; */
2275 /* pPager->stmtJSize = 0; */
2276 /* pPager->nPage = 0; */
drh90f5ecb2004-07-22 01:19:35 +00002277 pPager->mxPage = 100;
drhf8e632b2007-05-08 14:51:36 +00002278 pPager->mxPgno = SQLITE_MAX_PAGE_COUNT;
drh3b59a5c2006-01-15 20:28:28 +00002279 /* pPager->state = PAGER_UNLOCK; */
drh1cc8c442007-08-24 16:08:29 +00002280 assert( pPager->state == (tempFile ? PAGER_EXCLUSIVE : PAGER_UNLOCK) );
drh3b59a5c2006-01-15 20:28:28 +00002281 /* pPager->errMask = 0; */
drh5e00f6c2001-09-13 13:46:56 +00002282 pPager->tempFile = tempFile;
drh369339d2007-03-30 16:01:55 +00002283 assert( tempFile==PAGER_LOCKINGMODE_NORMAL
2284 || tempFile==PAGER_LOCKINGMODE_EXCLUSIVE );
2285 assert( PAGER_LOCKINGMODE_EXCLUSIVE==1 );
2286 pPager->exclusiveMode = tempFile;
drhac69b052004-05-12 13:30:07 +00002287 pPager->memDb = memDb;
drh5e00f6c2001-09-13 13:46:56 +00002288 pPager->readOnly = readOnly;
drh3b59a5c2006-01-15 20:28:28 +00002289 /* pPager->needSync = 0; */
drhda47d772002-12-02 04:25:19 +00002290 pPager->noSync = pPager->tempFile || !useJournal;
danielk197775edc162004-06-26 01:48:18 +00002291 pPager->fullSync = (pPager->noSync?0:1);
danielk1977f036aef2007-08-20 05:36:51 +00002292 pPager->sync_flags = SQLITE_SYNC_NORMAL;
drh3b59a5c2006-01-15 20:28:28 +00002293 /* pPager->pFirst = 0; */
2294 /* pPager->pFirstSynced = 0; */
2295 /* pPager->pLast = 0; */
drh887dc4c2004-10-22 16:22:57 +00002296 pPager->nExtra = FORCE_ALIGNMENT(nExtra);
danielk19777a2b1ee2007-08-21 14:27:01 +00002297 assert(pPager->fd->pMethods||memDb||tempFile);
danielk1977b4721172007-03-19 05:54:48 +00002298 if( !memDb ){
drhc80f0582007-05-01 16:59:48 +00002299 setSectorSize(pPager);
danielk1977b4721172007-03-19 05:54:48 +00002300 }
drh3b59a5c2006-01-15 20:28:28 +00002301 /* pPager->pBusyHandler = 0; */
2302 /* memset(pPager->aHash, 0, sizeof(pPager->aHash)); */
drhed7c8552001-04-11 14:29:21 +00002303 *ppPager = pPager;
drh6f7adc82006-01-11 21:41:20 +00002304#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
drh86f8c192007-08-22 00:39:19 +00002305 pPager->iInUseMM = 0;
2306 pPager->iInUseDB = 0;
2307 if( !memDb ){
2308 sqlite3_mutex *mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MEM2);
2309 sqlite3_mutex_enter(mutex);
2310 pPager->pNext = sqlite3PagerList;
2311 if( sqlite3PagerList ){
2312 assert( sqlite3PagerList->pPrev==0 );
2313 sqlite3PagerList->pPrev = pPager;
2314 }
2315 pPager->pPrev = 0;
2316 sqlite3PagerList = pPager;
2317 sqlite3_mutex_leave(mutex);
2318 }
danielk197752622822006-01-09 09:59:49 +00002319#endif
drhed7c8552001-04-11 14:29:21 +00002320 return SQLITE_OK;
2321}
2322
2323/*
drh90f5ecb2004-07-22 01:19:35 +00002324** Set the busy handler function.
2325*/
danielk19773b8a05f2007-03-19 17:44:26 +00002326void sqlite3PagerSetBusyhandler(Pager *pPager, BusyHandler *pBusyHandler){
drh90f5ecb2004-07-22 01:19:35 +00002327 pPager->pBusyHandler = pBusyHandler;
2328}
2329
2330/*
drh72f82862001-05-24 21:06:34 +00002331** Set the destructor for this pager. If not NULL, the destructor is called
drh5e00f6c2001-09-13 13:46:56 +00002332** when the reference count on each page reaches zero. The destructor can
2333** be used to clean up information in the extra segment appended to each page.
drh72f82862001-05-24 21:06:34 +00002334**
danielk19773b8a05f2007-03-19 17:44:26 +00002335** The destructor is not called as a result sqlite3PagerClose().
2336** Destructors are only called by sqlite3PagerUnref().
drh72f82862001-05-24 21:06:34 +00002337*/
danielk19773b8a05f2007-03-19 17:44:26 +00002338void sqlite3PagerSetDestructor(Pager *pPager, void (*xDesc)(DbPage*,int)){
drh72f82862001-05-24 21:06:34 +00002339 pPager->xDestructor = xDesc;
2340}
2341
2342/*
drha6abd042004-06-09 17:37:22 +00002343** Set the reinitializer for this pager. If not NULL, the reinitializer
2344** is called when the content of a page in cache is restored to its original
2345** value as a result of a rollback. The callback gives higher-level code
2346** an opportunity to restore the EXTRA section to agree with the restored
2347** page data.
2348*/
danielk19773b8a05f2007-03-19 17:44:26 +00002349void sqlite3PagerSetReiniter(Pager *pPager, void (*xReinit)(DbPage*,int)){
drha6abd042004-06-09 17:37:22 +00002350 pPager->xReiniter = xReinit;
2351}
2352
2353/*
danielk1977a1644fd2007-08-29 12:31:25 +00002354** Set the page size to *pPageSize. If the suggest new page size is
2355** inappropriate, then an alternative page size is set to that
2356** value before returning.
drh90f5ecb2004-07-22 01:19:35 +00002357*/
danielk1977a1644fd2007-08-29 12:31:25 +00002358int sqlite3PagerSetPagesize(Pager *pPager, u16 *pPageSize){
2359 int rc = SQLITE_OK;
2360 u16 pageSize = *pPageSize;
danielk19779663b8f2007-08-24 11:52:28 +00002361 assert( pageSize==0 || (pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE) );
danielk1977a1644fd2007-08-29 12:31:25 +00002362 if( pageSize && pageSize!=pPager->pageSize
2363 && !pPager->memDb && pPager->nRef==0
2364 ){
2365 char *pNew = (char *)sqlite3_malloc(pageSize);
2366 if( !pNew ){
2367 rc = SQLITE_NOMEM;
2368 }else{
2369 pagerEnter(pPager);
2370 pager_reset(pPager);
2371 pPager->pageSize = pageSize;
2372 setSectorSize(pPager);
2373 sqlite3_free(pPager->pTmpSpace);
2374 pPager->pTmpSpace = pNew;
2375 pagerLeave(pPager);
2376 }
drh1c7880e2005-05-20 20:01:55 +00002377 }
danielk1977a1644fd2007-08-29 12:31:25 +00002378 *pPageSize = pPager->pageSize;
2379 return rc;
drh90f5ecb2004-07-22 01:19:35 +00002380}
2381
2382/*
drh26b79942007-11-28 16:19:56 +00002383** Return a pointer to the "temporary page" buffer held internally
2384** by the pager. This is a buffer that is big enough to hold the
2385** entire content of a database page. This buffer is used internally
2386** during rollback and will be overwritten whenever a rollback
2387** occurs. But other modules are free to use it too, as long as
2388** no rollbacks are happening.
2389*/
2390void *sqlite3PagerTempSpace(Pager *pPager){
2391 return pPager->pTmpSpace;
2392}
2393
2394/*
drhf8e632b2007-05-08 14:51:36 +00002395** Attempt to set the maximum database page count if mxPage is positive.
2396** Make no changes if mxPage is zero or negative. And never reduce the
2397** maximum page count below the current size of the database.
2398**
2399** Regardless of mxPage, return the current maximum page count.
2400*/
2401int sqlite3PagerMaxPageCount(Pager *pPager, int mxPage){
2402 if( mxPage>0 ){
2403 pPager->mxPgno = mxPage;
2404 }
2405 sqlite3PagerPagecount(pPager);
2406 return pPager->mxPgno;
2407}
2408
2409/*
drhc9ac5ca2005-11-04 22:03:30 +00002410** The following set of routines are used to disable the simulated
2411** I/O error mechanism. These routines are used to avoid simulated
2412** errors in places where we do not care about errors.
2413**
2414** Unless -DSQLITE_TEST=1 is used, these routines are all no-ops
2415** and generate no code.
2416*/
2417#ifdef SQLITE_TEST
2418extern int sqlite3_io_error_pending;
2419extern int sqlite3_io_error_hit;
2420static int saved_cnt;
drhc9ac5ca2005-11-04 22:03:30 +00002421void disable_simulated_io_errors(void){
2422 saved_cnt = sqlite3_io_error_pending;
2423 sqlite3_io_error_pending = -1;
2424}
2425void enable_simulated_io_errors(void){
2426 sqlite3_io_error_pending = saved_cnt;
2427}
2428#else
drh152410f2005-11-05 15:11:22 +00002429# define disable_simulated_io_errors()
2430# define enable_simulated_io_errors()
drhc9ac5ca2005-11-04 22:03:30 +00002431#endif
2432
2433/*
drh90f5ecb2004-07-22 01:19:35 +00002434** Read the first N bytes from the beginning of the file into memory
danielk1977aef0bf62005-12-30 16:28:01 +00002435** that pDest points to.
2436**
2437** No error checking is done. The rational for this is that this function
2438** may be called even if the file does not exist or contain a header. In
2439** these cases sqlite3OsRead() will return an error, to which the correct
2440** response is to zero the memory at pDest and continue. A real IO error
2441** will presumably recur and be picked up later (Todo: Think about this).
drh90f5ecb2004-07-22 01:19:35 +00002442*/
danielk19773b8a05f2007-03-19 17:44:26 +00002443int sqlite3PagerReadFileheader(Pager *pPager, int N, unsigned char *pDest){
drh551b7732006-11-06 21:20:25 +00002444 int rc = SQLITE_OK;
drh90f5ecb2004-07-22 01:19:35 +00002445 memset(pDest, 0, N);
danielk19777a2b1ee2007-08-21 14:27:01 +00002446 assert(MEMDB||pPager->fd->pMethods||pPager->tempFile);
2447 if( pPager->fd->pMethods ){
drhb0603412007-02-28 04:47:26 +00002448 IOTRACE(("DBHDR %p 0 %d\n", pPager, N))
danielk197762079062007-08-15 17:08:46 +00002449 rc = sqlite3OsRead(pPager->fd, pDest, N, 0);
drh551b7732006-11-06 21:20:25 +00002450 if( rc==SQLITE_IOERR_SHORT_READ ){
2451 rc = SQLITE_OK;
2452 }
drh90f5ecb2004-07-22 01:19:35 +00002453 }
drh551b7732006-11-06 21:20:25 +00002454 return rc;
drh90f5ecb2004-07-22 01:19:35 +00002455}
2456
2457/*
drh5e00f6c2001-09-13 13:46:56 +00002458** Return the total number of pages in the disk file associated with
danielk197715f411d2005-09-16 10:18:45 +00002459** pPager.
2460**
2461** If the PENDING_BYTE lies on the page directly after the end of the
2462** file, then consider this page part of the file too. For example, if
2463** PENDING_BYTE is byte 4096 (the first byte of page 5) and the size of the
2464** file is 4096 bytes, 5 is returned instead of 4.
drhed7c8552001-04-11 14:29:21 +00002465*/
danielk19773b8a05f2007-03-19 17:44:26 +00002466int sqlite3PagerPagecount(Pager *pPager){
danielk19777a2b1ee2007-08-21 14:27:01 +00002467 i64 n = 0;
drhe49f9822006-09-15 12:29:16 +00002468 int rc;
drhd9b02572001-04-15 00:37:09 +00002469 assert( pPager!=0 );
drha7aea3d2007-03-15 12:51:16 +00002470 if( pPager->errCode ){
danielk197743468d92008-02-26 06:05:31 +00002471 return -1;
drha7aea3d2007-03-15 12:51:16 +00002472 }
drhed7c8552001-04-11 14:29:21 +00002473 if( pPager->dbSize>=0 ){
danielk197715f411d2005-09-16 10:18:45 +00002474 n = pPager->dbSize;
2475 } else {
danielk19777a2b1ee2007-08-21 14:27:01 +00002476 assert(pPager->fd->pMethods||pPager->tempFile);
2477 if( (pPager->fd->pMethods)
2478 && (rc = sqlite3OsFileSize(pPager->fd, &n))!=SQLITE_OK ){
danielk1977ae72d982007-10-03 08:46:44 +00002479 pPager->nRef++;
drhe49f9822006-09-15 12:29:16 +00002480 pager_error(pPager, rc);
danielk1977ae72d982007-10-03 08:46:44 +00002481 pPager->nRef--;
danielk197743468d92008-02-26 06:05:31 +00002482 return -1;
danielk197715f411d2005-09-16 10:18:45 +00002483 }
2484 if( n>0 && n<pPager->pageSize ){
2485 n = 1;
2486 }else{
2487 n /= pPager->pageSize;
2488 }
2489 if( pPager->state!=PAGER_UNLOCK ){
2490 pPager->dbSize = n;
2491 }
drhed7c8552001-04-11 14:29:21 +00002492 }
danielk197715f411d2005-09-16 10:18:45 +00002493 if( n==(PENDING_BYTE/pPager->pageSize) ){
drh1f595712004-06-15 01:40:29 +00002494 n++;
2495 }
drhf8e632b2007-05-08 14:51:36 +00002496 if( n>pPager->mxPgno ){
2497 pPager->mxPgno = n;
2498 }
drhed7c8552001-04-11 14:29:21 +00002499 return n;
2500}
2501
drhf07e7d52006-04-07 13:54:46 +00002502
2503#ifndef SQLITE_OMIT_MEMORYDB
2504/*
2505** Clear a PgHistory block
2506*/
2507static void clearHistory(PgHistory *pHist){
drh17435752007-08-16 04:30:38 +00002508 sqlite3_free(pHist->pOrig);
2509 sqlite3_free(pHist->pStmt);
drhf07e7d52006-04-07 13:54:46 +00002510 pHist->pOrig = 0;
2511 pHist->pStmt = 0;
2512}
2513#else
2514#define clearHistory(x)
2515#endif
2516
drhed7c8552001-04-11 14:29:21 +00002517/*
drhf7c57532003-04-25 13:22:51 +00002518** Forward declaration
2519*/
danielk197776572402004-06-25 02:38:54 +00002520static int syncJournal(Pager*);
drhac69b052004-05-12 13:30:07 +00002521
2522/*
drh85b623f2007-12-13 21:54:09 +00002523** Unlink pPg from its hash chain. Also set the page number to 0 to indicate
danielk1977f5fdda82004-11-03 08:44:05 +00002524** that the page is not part of any hash chain. This is required because the
danielk19773b8a05f2007-03-19 17:44:26 +00002525** sqlite3PagerMovepage() routine can leave a page in the
danielk1977f5fdda82004-11-03 08:44:05 +00002526** pNextFree/pPrevFree list that is not a part of any hash-chain.
2527*/
2528static void unlinkHashChain(Pager *pPager, PgHdr *pPg){
2529 if( pPg->pgno==0 ){
drh3765df42006-06-28 18:18:09 +00002530 assert( pPg->pNextHash==0 && pPg->pPrevHash==0 );
danielk1977f5fdda82004-11-03 08:44:05 +00002531 return;
2532 }
2533 if( pPg->pNextHash ){
2534 pPg->pNextHash->pPrevHash = pPg->pPrevHash;
2535 }
2536 if( pPg->pPrevHash ){
drh8ca0c722006-05-07 17:49:38 +00002537 assert( pPager->aHash[pPg->pgno & (pPager->nHash-1)]!=pPg );
danielk1977f5fdda82004-11-03 08:44:05 +00002538 pPg->pPrevHash->pNextHash = pPg->pNextHash;
2539 }else{
drh8ca0c722006-05-07 17:49:38 +00002540 int h = pPg->pgno & (pPager->nHash-1);
danielk1977f5fdda82004-11-03 08:44:05 +00002541 pPager->aHash[h] = pPg->pNextHash;
2542 }
drh5229ae42006-03-23 23:29:04 +00002543 if( MEMDB ){
drh5229ae42006-03-23 23:29:04 +00002544 clearHistory(PGHDR_TO_HIST(pPg, pPager));
2545 }
danielk1977f5fdda82004-11-03 08:44:05 +00002546 pPg->pgno = 0;
2547 pPg->pNextHash = pPg->pPrevHash = 0;
2548}
2549
2550/*
drhac69b052004-05-12 13:30:07 +00002551** Unlink a page from the free list (the list of all pages where nRef==0)
2552** and from its hash collision chain.
2553*/
2554static void unlinkPage(PgHdr *pPg){
2555 Pager *pPager = pPg->pPager;
2556
danielk19779f61c2f2007-08-27 17:27:49 +00002557 /* Unlink from free page list */
2558 lruListRemove(pPg);
drhac69b052004-05-12 13:30:07 +00002559
2560 /* Unlink from the pgno hash table */
danielk1977f5fdda82004-11-03 08:44:05 +00002561 unlinkHashChain(pPager, pPg);
drhac69b052004-05-12 13:30:07 +00002562}
2563
2564/*
danielk1977e180dd92007-04-05 17:15:52 +00002565** This routine is used to truncate the cache when a database
2566** is truncated. Drop from the cache all pages whose pgno is
2567** larger than pPager->dbSize and is unreferenced.
2568**
drhac69b052004-05-12 13:30:07 +00002569** Referenced pages larger than pPager->dbSize are zeroed.
danielk1977e180dd92007-04-05 17:15:52 +00002570**
2571** Actually, at the point this routine is called, it would be
2572** an error to have a referenced page. But rather than delete
2573** that page and guarantee a subsequent segfault, it seems better
2574** to zero it and hope that we error out sanely.
drhac69b052004-05-12 13:30:07 +00002575*/
danielk1977e180dd92007-04-05 17:15:52 +00002576static void pager_truncate_cache(Pager *pPager){
drhac69b052004-05-12 13:30:07 +00002577 PgHdr *pPg;
2578 PgHdr **ppPg;
2579 int dbSize = pPager->dbSize;
2580
2581 ppPg = &pPager->pAll;
2582 while( (pPg = *ppPg)!=0 ){
2583 if( pPg->pgno<=dbSize ){
2584 ppPg = &pPg->pNextAll;
2585 }else if( pPg->nRef>0 ){
2586 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
2587 ppPg = &pPg->pNextAll;
2588 }else{
2589 *ppPg = pPg->pNextAll;
drh538f5702007-04-13 02:14:30 +00002590 IOTRACE(("PGFREE %p %d\n", pPager, pPg->pgno));
2591 PAGER_INCR(sqlite3_pager_pgfree_count);
drhac69b052004-05-12 13:30:07 +00002592 unlinkPage(pPg);
drh605ad8f2006-05-03 23:34:05 +00002593 makeClean(pPg);
drh0d180202008-02-14 23:26:56 +00002594 sqlite3_free(pPg->pData);
drh17435752007-08-16 04:30:38 +00002595 sqlite3_free(pPg);
drhac69b052004-05-12 13:30:07 +00002596 pPager->nPage--;
2597 }
2598 }
2599}
2600
drhf7c57532003-04-25 13:22:51 +00002601/*
danielk197717221812005-02-15 03:38:05 +00002602** Try to obtain a lock on a file. Invoke the busy callback if the lock
drha4afb652005-07-09 02:16:02 +00002603** is currently not available. Repeat until the busy callback returns
danielk197717221812005-02-15 03:38:05 +00002604** false or until the lock succeeds.
2605**
2606** Return SQLITE_OK on success and an error code if we cannot obtain
2607** the lock.
2608*/
2609static int pager_wait_on_lock(Pager *pPager, int locktype){
2610 int rc;
drh1aa2d8b2007-01-03 15:34:29 +00002611
2612 /* The OS lock values must be the same as the Pager lock values */
danielk197717221812005-02-15 03:38:05 +00002613 assert( PAGER_SHARED==SHARED_LOCK );
2614 assert( PAGER_RESERVED==RESERVED_LOCK );
2615 assert( PAGER_EXCLUSIVE==EXCLUSIVE_LOCK );
drh1aa2d8b2007-01-03 15:34:29 +00002616
2617 /* If the file is currently unlocked then the size must be unknown */
2618 assert( pPager->state>=PAGER_SHARED || pPager->dbSize<0 || MEMDB );
2619
danielk197717221812005-02-15 03:38:05 +00002620 if( pPager->state>=locktype ){
2621 rc = SQLITE_OK;
2622 }else{
drhbefdf832008-03-14 19:33:05 +00002623 if( pPager->pBusyHandler ) pPager->pBusyHandler->nBusy = 0;
danielk197717221812005-02-15 03:38:05 +00002624 do {
drh054889e2005-11-30 03:20:31 +00002625 rc = sqlite3OsLock(pPager->fd, locktype);
drha4afb652005-07-09 02:16:02 +00002626 }while( rc==SQLITE_BUSY && sqlite3InvokeBusyHandler(pPager->pBusyHandler) );
danielk197717221812005-02-15 03:38:05 +00002627 if( rc==SQLITE_OK ){
2628 pPager->state = locktype;
drhb0603412007-02-28 04:47:26 +00002629 IOTRACE(("LOCK %p %d\n", pPager, locktype))
danielk197717221812005-02-15 03:38:05 +00002630 }
2631 }
2632 return rc;
2633}
2634
2635/*
drhf7c57532003-04-25 13:22:51 +00002636** Truncate the file to the number of pages specified.
2637*/
danielk19773b8a05f2007-03-19 17:44:26 +00002638int sqlite3PagerTruncate(Pager *pPager, Pgno nPage){
drhf7c57532003-04-25 13:22:51 +00002639 int rc;
drh1aa2d8b2007-01-03 15:34:29 +00002640 assert( pPager->state>=PAGER_SHARED || MEMDB );
danielk19773b8a05f2007-03-19 17:44:26 +00002641 sqlite3PagerPagecount(pPager);
danielk1977efaaf572006-01-16 11:29:19 +00002642 if( pPager->errCode ){
2643 rc = pPager->errCode;
drh2e6d11b2003-04-25 15:37:57 +00002644 return rc;
2645 }
drh7d02cb72003-06-04 16:24:39 +00002646 if( nPage>=(unsigned)pPager->dbSize ){
drhf7c57532003-04-25 13:22:51 +00002647 return SQLITE_OK;
2648 }
drhb7f91642004-10-31 02:22:47 +00002649 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00002650 pPager->dbSize = nPage;
danielk1977e180dd92007-04-05 17:15:52 +00002651 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00002652 return SQLITE_OK;
2653 }
drh86f8c192007-08-22 00:39:19 +00002654 pagerEnter(pPager);
danielk197776572402004-06-25 02:38:54 +00002655 rc = syncJournal(pPager);
drh86f8c192007-08-22 00:39:19 +00002656 pagerLeave(pPager);
danielk1977369f27e2004-06-15 11:40:04 +00002657 if( rc!=SQLITE_OK ){
2658 return rc;
2659 }
danielk197717221812005-02-15 03:38:05 +00002660
2661 /* Get an exclusive lock on the database before truncating. */
drh86f8c192007-08-22 00:39:19 +00002662 pagerEnter(pPager);
danielk197717221812005-02-15 03:38:05 +00002663 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
drh86f8c192007-08-22 00:39:19 +00002664 pagerLeave(pPager);
danielk197717221812005-02-15 03:38:05 +00002665 if( rc!=SQLITE_OK ){
2666 return rc;
2667 }
2668
drhcb4c40b2004-08-18 19:09:43 +00002669 rc = pager_truncate(pPager, nPage);
drhf7c57532003-04-25 13:22:51 +00002670 return rc;
2671}
2672
2673/*
drhed7c8552001-04-11 14:29:21 +00002674** Shutdown the page cache. Free all memory and close all files.
2675**
2676** If a transaction was in progress when this routine is called, that
2677** transaction is rolled back. All outstanding pages are invalidated
2678** and their memory is freed. Any attempt to use a page associated
2679** with this page cache after this function returns will likely
2680** result in a coredump.
danielk1977aef0bf62005-12-30 16:28:01 +00002681**
2682** This function always succeeds. If a transaction is active an attempt
2683** is made to roll it back. If an error occurs during the rollback
2684** a hot journal may be left in the filesystem but no error is returned
2685** to the caller.
drhed7c8552001-04-11 14:29:21 +00002686*/
danielk19773b8a05f2007-03-19 17:44:26 +00002687int sqlite3PagerClose(Pager *pPager){
drh6f7adc82006-01-11 21:41:20 +00002688#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
drh86f8c192007-08-22 00:39:19 +00002689 if( !MEMDB ){
2690 sqlite3_mutex *mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MEM2);
2691 sqlite3_mutex_enter(mutex);
2692 if( pPager->pPrev ){
2693 pPager->pPrev->pNext = pPager->pNext;
2694 }else{
2695 sqlite3PagerList = pPager->pNext;
2696 }
2697 if( pPager->pNext ){
2698 pPager->pNext->pPrev = pPager->pPrev;
2699 }
2700 sqlite3_mutex_leave(mutex);
2701 }
danielk197713f72992005-12-18 08:51:22 +00002702#endif
2703
drhbafda092007-01-03 23:36:22 +00002704 disable_simulated_io_errors();
drhc2ee76c2007-01-04 14:58:14 +00002705 pPager->errCode = 0;
danielk197741483462007-03-24 16:45:04 +00002706 pPager->exclusiveMode = 0;
drhbafda092007-01-03 23:36:22 +00002707 pager_reset(pPager);
danielk1977e277be02007-03-23 18:12:06 +00002708 pagerUnlockAndRollback(pPager);
drhbafda092007-01-03 23:36:22 +00002709 enable_simulated_io_errors();
drh4f0c5872007-03-26 22:05:01 +00002710 PAGERTRACE2("CLOSE %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002711 IOTRACE(("CLOSE %p\n", pPager))
danielk1977efaaf572006-01-16 11:29:19 +00002712 assert( pPager->errCode || (pPager->journalOpen==0 && pPager->stmtOpen==0) );
danielk1977e94ddc92005-03-21 03:53:38 +00002713 if( pPager->journalOpen ){
danielk1977b4b47412007-08-17 15:53:36 +00002714 sqlite3OsClose(pPager->jfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002715 }
drhf5e7bb52008-02-18 14:47:33 +00002716 sqlite3BitvecDestroy(pPager->pInJournal);
danielk1977e94ddc92005-03-21 03:53:38 +00002717 if( pPager->stmtOpen ){
danielk1977b4b47412007-08-17 15:53:36 +00002718 sqlite3OsClose(pPager->stfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002719 }
danielk1977b4b47412007-08-17 15:53:36 +00002720 sqlite3OsClose(pPager->fd);
drh0f892532002-05-30 12:27:03 +00002721 /* Temp files are automatically deleted by the OS
2722 ** if( pPager->tempFile ){
drh66560ad2006-01-06 14:32:19 +00002723 ** sqlite3OsDelete(pPager->zFilename);
drh0f892532002-05-30 12:27:03 +00002724 ** }
2725 */
danielk1977aca790a2005-01-13 11:07:52 +00002726
drh17435752007-08-16 04:30:38 +00002727 sqlite3_free(pPager->aHash);
2728 sqlite3_free(pPager->pTmpSpace);
2729 sqlite3_free(pPager);
drhed7c8552001-04-11 14:29:21 +00002730 return SQLITE_OK;
2731}
2732
drh87cc3b32007-05-08 21:45:27 +00002733#if !defined(NDEBUG) || defined(SQLITE_TEST)
drhed7c8552001-04-11 14:29:21 +00002734/*
drh5e00f6c2001-09-13 13:46:56 +00002735** Return the page number for the given page data.
drhed7c8552001-04-11 14:29:21 +00002736*/
danielk19773b8a05f2007-03-19 17:44:26 +00002737Pgno sqlite3PagerPagenumber(DbPage *p){
drhed7c8552001-04-11 14:29:21 +00002738 return p->pgno;
2739}
drh87cc3b32007-05-08 21:45:27 +00002740#endif
drhed7c8552001-04-11 14:29:21 +00002741
2742/*
drhc8629a12004-05-08 20:07:40 +00002743** The page_ref() function increments the reference count for a page.
2744** If the page is currently on the freelist (the reference count is zero) then
drh7e3b0a02001-04-28 16:52:40 +00002745** remove it from the freelist.
drhc8629a12004-05-08 20:07:40 +00002746**
2747** For non-test systems, page_ref() is a macro that calls _page_ref()
2748** online of the reference count is zero. For test systems, page_ref()
2749** is a real function so that we can set breakpoints and trace it.
drh7e3b0a02001-04-28 16:52:40 +00002750*/
drh836faa42003-01-11 13:30:57 +00002751static void _page_ref(PgHdr *pPg){
drh7e3b0a02001-04-28 16:52:40 +00002752 if( pPg->nRef==0 ){
2753 /* The page is currently on the freelist. Remove it. */
danielk19779f61c2f2007-08-27 17:27:49 +00002754 lruListRemove(pPg);
drh7e3b0a02001-04-28 16:52:40 +00002755 pPg->pPager->nRef++;
2756 }
2757 pPg->nRef++;
drhdf0b3b02001-06-23 11:36:20 +00002758}
danielk1977aca790a2005-01-13 11:07:52 +00002759#ifdef SQLITE_DEBUG
drhc8629a12004-05-08 20:07:40 +00002760 static void page_ref(PgHdr *pPg){
2761 if( pPg->nRef==0 ){
2762 _page_ref(pPg);
2763 }else{
2764 pPg->nRef++;
drhc8629a12004-05-08 20:07:40 +00002765 }
2766 }
2767#else
2768# define page_ref(P) ((P)->nRef==0?_page_ref(P):(void)(P)->nRef++)
2769#endif
drhdf0b3b02001-06-23 11:36:20 +00002770
2771/*
2772** Increment the reference count for a page. The input pointer is
2773** a reference to the page data.
2774*/
danielk19773b8a05f2007-03-19 17:44:26 +00002775int sqlite3PagerRef(DbPage *pPg){
drh86f8c192007-08-22 00:39:19 +00002776 pagerEnter(pPg->pPager);
drhdf0b3b02001-06-23 11:36:20 +00002777 page_ref(pPg);
drh86f8c192007-08-22 00:39:19 +00002778 pagerLeave(pPg->pPager);
drh8c42ca92001-06-22 19:15:00 +00002779 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +00002780}
2781
2782/*
drh34e79ce2004-02-08 06:05:46 +00002783** Sync the journal. In other words, make sure all the pages that have
2784** been written to the journal have actually reached the surface of the
2785** disk. It is not safe to modify the original database file until after
2786** the journal has been synced. If the original database is modified before
2787** the journal is synced and a power failure occurs, the unsynced journal
2788** data would be lost and we would be unable to completely rollback the
2789** database changes. Database corruption would occur.
2790**
2791** This routine also updates the nRec field in the header of the journal.
2792** (See comments on the pager_playback() routine for additional information.)
2793** If the sync mode is FULL, two syncs will occur. First the whole journal
2794** is synced, then the nRec field is updated, then a second sync occurs.
drhb19a2bc2001-09-16 00:13:26 +00002795**
drh34e79ce2004-02-08 06:05:46 +00002796** For temporary databases, we do not care if we are able to rollback
danielk19774cd2cd52007-08-23 14:48:23 +00002797** after a power failure, so no sync occurs.
2798**
2799** If the IOCAP_SEQUENTIAL flag is set for the persistent media on which
2800** the database is stored, then OsSync() is never called on the journal
2801** file. In this case all that is required is to update the nRec field in
2802** the journal header.
drhfa86c412002-02-02 15:01:15 +00002803**
drh34e79ce2004-02-08 06:05:46 +00002804** This routine clears the needSync field of every page current held in
2805** memory.
drh50e5dad2001-09-15 00:57:28 +00002806*/
danielk197776572402004-06-25 02:38:54 +00002807static int syncJournal(Pager *pPager){
drh50e5dad2001-09-15 00:57:28 +00002808 PgHdr *pPg;
2809 int rc = SQLITE_OK;
drh03eb96a2002-11-10 23:32:56 +00002810
danielk19774cd2cd52007-08-23 14:48:23 +00002811
drh03eb96a2002-11-10 23:32:56 +00002812 /* Sync the journal before modifying the main database
2813 ** (assuming there is a journal and it needs to be synced.)
2814 */
danielk197776572402004-06-25 02:38:54 +00002815 if( pPager->needSync ){
drhfa86c412002-02-02 15:01:15 +00002816 if( !pPager->tempFile ){
danielk19774cd2cd52007-08-23 14:48:23 +00002817 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
drhdb48ee02003-01-16 13:42:43 +00002818 assert( pPager->journalOpen );
danielk19774cd2cd52007-08-23 14:48:23 +00002819
drh946966f2004-02-25 02:20:41 +00002820 /* assert( !pPager->noSync ); // noSync might be set if synchronous
2821 ** was turned off after the transaction was started. Ticket #615 */
drh968af522003-02-11 14:55:40 +00002822#ifndef NDEBUG
2823 {
drh34e79ce2004-02-08 06:05:46 +00002824 /* Make sure the pPager->nRec counter we are keeping agrees
2825 ** with the nRec computed from the size of the journal file.
2826 */
drheb206252004-10-01 02:00:31 +00002827 i64 jSz;
drh054889e2005-11-30 03:20:31 +00002828 rc = sqlite3OsFileSize(pPager->jfd, &jSz);
drh968af522003-02-11 14:55:40 +00002829 if( rc!=0 ) return rc;
danielk197776572402004-06-25 02:38:54 +00002830 assert( pPager->journalOff==jSz );
drh968af522003-02-11 14:55:40 +00002831 }
2832#endif
danielk19774cd2cd52007-08-23 14:48:23 +00002833 if( 0==(iDc&SQLITE_IOCAP_SAFE_APPEND) ){
danielk197776572402004-06-25 02:38:54 +00002834 /* Write the nRec value into the journal file header. If in
2835 ** full-synchronous mode, sync the journal first. This ensures that
2836 ** all data has really hit the disk before nRec is updated to mark
danielk19774cd2cd52007-08-23 14:48:23 +00002837 ** it as a candidate for rollback.
2838 **
2839 ** This is not required if the persistent media supports the
2840 ** SAFE_APPEND property. Because in this case it is not possible
2841 ** for garbage data to be appended to the file, the nRec field
2842 ** is populated with 0xFFFFFFFF when the journal header is written
2843 ** and never needs to be updated.
danielk197776572402004-06-25 02:38:54 +00002844 */
danielk19774cd2cd52007-08-23 14:48:23 +00002845 i64 jrnlOff;
2846 if( pPager->fullSync && 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
drh4f0c5872007-03-26 22:05:01 +00002847 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002848 IOTRACE(("JSYNC %p\n", pPager))
danielk1977f036aef2007-08-20 05:36:51 +00002849 rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags);
drhd8d66e82003-02-12 02:10:15 +00002850 if( rc!=0 ) return rc;
2851 }
danielk197713adf8a2004-06-03 16:08:41 +00002852
danielk197762079062007-08-15 17:08:46 +00002853 jrnlOff = pPager->journalHdr + sizeof(aJournalMagic);
2854 IOTRACE(("JHDR %p %lld %d\n", pPager, jrnlOff, 4));
2855 rc = write32bits(pPager->jfd, jrnlOff, pPager->nRec);
drhb4746b92005-09-09 01:32:06 +00002856 if( rc ) return rc;
drh968af522003-02-11 14:55:40 +00002857 }
danielk19774cd2cd52007-08-23 14:48:23 +00002858 if( 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
2859 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
2860 IOTRACE(("JSYNC %p\n", pPager))
2861 rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags|
2862 (pPager->sync_flags==SQLITE_SYNC_FULL?SQLITE_SYNC_DATAONLY:0)
2863 );
2864 if( rc!=0 ) return rc;
2865 }
drhdb48ee02003-01-16 13:42:43 +00002866 pPager->journalStarted = 1;
drhfa86c412002-02-02 15:01:15 +00002867 }
drh50e5dad2001-09-15 00:57:28 +00002868 pPager->needSync = 0;
drh341eae82003-01-21 02:39:36 +00002869
2870 /* Erase the needSync flag from every page.
2871 */
2872 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2873 pPg->needSync = 0;
2874 }
danielk19779f61c2f2007-08-27 17:27:49 +00002875 lruListSetFirstSynced(pPager);
drh50e5dad2001-09-15 00:57:28 +00002876 }
drh03eb96a2002-11-10 23:32:56 +00002877
drh341eae82003-01-21 02:39:36 +00002878#ifndef NDEBUG
2879 /* If the Pager.needSync flag is clear then the PgHdr.needSync
2880 ** flag must also be clear for all pages. Verify that this
2881 ** invariant is true.
drh03eb96a2002-11-10 23:32:56 +00002882 */
drh341eae82003-01-21 02:39:36 +00002883 else{
2884 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2885 assert( pPg->needSync==0 );
2886 }
danielk19779f61c2f2007-08-27 17:27:49 +00002887 assert( pPager->lru.pFirstSynced==pPager->lru.pFirst );
drh03eb96a2002-11-10 23:32:56 +00002888 }
drh341eae82003-01-21 02:39:36 +00002889#endif
drhdb48ee02003-01-16 13:42:43 +00002890
drh81a20f22001-10-12 17:30:04 +00002891 return rc;
drh50e5dad2001-09-15 00:57:28 +00002892}
2893
2894/*
drhdc3e10b2006-06-15 14:31:06 +00002895** Merge two lists of pages connected by pDirty and in pgno order.
2896** Do not both fixing the pPrevDirty pointers.
2897*/
2898static PgHdr *merge_pagelist(PgHdr *pA, PgHdr *pB){
2899 PgHdr result, *pTail;
2900 pTail = &result;
2901 while( pA && pB ){
2902 if( pA->pgno<pB->pgno ){
2903 pTail->pDirty = pA;
2904 pTail = pA;
2905 pA = pA->pDirty;
2906 }else{
2907 pTail->pDirty = pB;
2908 pTail = pB;
2909 pB = pB->pDirty;
2910 }
2911 }
2912 if( pA ){
2913 pTail->pDirty = pA;
2914 }else if( pB ){
2915 pTail->pDirty = pB;
2916 }else{
2917 pTail->pDirty = 0;
2918 }
2919 return result.pDirty;
2920}
2921
2922/*
2923** Sort the list of pages in accending order by pgno. Pages are
2924** connected by pDirty pointers. The pPrevDirty pointers are
2925** corrupted by this sort.
2926*/
danielk197724168722007-04-02 05:07:47 +00002927#define N_SORT_BUCKET_ALLOC 25
2928#define N_SORT_BUCKET 25
2929#ifdef SQLITE_TEST
2930 int sqlite3_pager_n_sort_bucket = 0;
2931 #undef N_SORT_BUCKET
2932 #define N_SORT_BUCKET \
2933 (sqlite3_pager_n_sort_bucket?sqlite3_pager_n_sort_bucket:N_SORT_BUCKET_ALLOC)
2934#endif
drhdc3e10b2006-06-15 14:31:06 +00002935static PgHdr *sort_pagelist(PgHdr *pIn){
danielk197724168722007-04-02 05:07:47 +00002936 PgHdr *a[N_SORT_BUCKET_ALLOC], *p;
drhdc3e10b2006-06-15 14:31:06 +00002937 int i;
2938 memset(a, 0, sizeof(a));
2939 while( pIn ){
2940 p = pIn;
2941 pIn = p->pDirty;
2942 p->pDirty = 0;
2943 for(i=0; i<N_SORT_BUCKET-1; i++){
2944 if( a[i]==0 ){
2945 a[i] = p;
2946 break;
2947 }else{
2948 p = merge_pagelist(a[i], p);
2949 a[i] = 0;
2950 }
2951 }
2952 if( i==N_SORT_BUCKET-1 ){
danielk197724168722007-04-02 05:07:47 +00002953 /* Coverage: To get here, there need to be 2^(N_SORT_BUCKET)
2954 ** elements in the input list. This is possible, but impractical.
2955 ** Testing this line is the point of global variable
2956 ** sqlite3_pager_n_sort_bucket.
2957 */
drhdc3e10b2006-06-15 14:31:06 +00002958 a[i] = merge_pagelist(a[i], p);
2959 }
2960 }
2961 p = a[0];
2962 for(i=1; i<N_SORT_BUCKET; i++){
2963 p = merge_pagelist(p, a[i]);
2964 }
2965 return p;
2966}
2967
2968/*
drh2554f8b2003-01-22 01:26:44 +00002969** Given a list of pages (connected by the PgHdr.pDirty pointer) write
2970** every one of those pages out to the database file and mark them all
2971** as clean.
2972*/
2973static int pager_write_pagelist(PgHdr *pList){
2974 Pager *pPager;
drh153c62c2007-08-24 03:51:33 +00002975 PgHdr *p;
drh2554f8b2003-01-22 01:26:44 +00002976 int rc;
2977
2978 if( pList==0 ) return SQLITE_OK;
2979 pPager = pList->pPager;
danielk19779eed5052004-06-04 10:38:30 +00002980
2981 /* At this point there may be either a RESERVED or EXCLUSIVE lock on the
2982 ** database file. If there is already an EXCLUSIVE lock, the following
drh054889e2005-11-30 03:20:31 +00002983 ** calls to sqlite3OsLock() are no-ops.
danielk19779eed5052004-06-04 10:38:30 +00002984 **
drha6abd042004-06-09 17:37:22 +00002985 ** Moving the lock from RESERVED to EXCLUSIVE actually involves going
2986 ** through an intermediate state PENDING. A PENDING lock prevents new
2987 ** readers from attaching to the database but is unsufficient for us to
2988 ** write. The idea of a PENDING lock is to prevent new readers from
2989 ** coming in while we wait for existing readers to clear.
danielk19779eed5052004-06-04 10:38:30 +00002990 **
drha6abd042004-06-09 17:37:22 +00002991 ** While the pager is in the RESERVED state, the original database file
2992 ** is unchanged and we can rollback without having to playback the
2993 ** journal into the original database file. Once we transition to
2994 ** EXCLUSIVE, it means the database file has been changed and any rollback
2995 ** will require a journal playback.
danielk19779eed5052004-06-04 10:38:30 +00002996 */
drh684917c2004-10-05 02:41:42 +00002997 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
danielk19779eed5052004-06-04 10:38:30 +00002998 if( rc!=SQLITE_OK ){
2999 return rc;
3000 }
3001
drhdc3e10b2006-06-15 14:31:06 +00003002 pList = sort_pagelist(pList);
drh153c62c2007-08-24 03:51:33 +00003003 for(p=pList; p; p=p->pDirty){
3004 assert( p->dirty );
3005 p->dirty = 0;
3006 }
drh2554f8b2003-01-22 01:26:44 +00003007 while( pList ){
danielk19777a2b1ee2007-08-21 14:27:01 +00003008
3009 /* If the file has not yet been opened, open it now. */
3010 if( !pPager->fd->pMethods ){
3011 assert(pPager->tempFile);
drh33f4e022007-09-03 15:19:34 +00003012 rc = sqlite3PagerOpentemp(pPager->pVfs, pPager->fd, pPager->zFilename,
3013 pPager->vfsFlags);
danielk19777a2b1ee2007-08-21 14:27:01 +00003014 if( rc ) return rc;
3015 }
3016
danielk1977687566d2004-11-02 12:56:41 +00003017 /* If there are dirty pages in the page cache with page numbers greater
danielk19773b8a05f2007-03-19 17:44:26 +00003018 ** than Pager.dbSize, this means sqlite3PagerTruncate() was called to
danielk1977687566d2004-11-02 12:56:41 +00003019 ** make the file smaller (presumably by auto-vacuum code). Do not write
3020 ** any such pages to the file.
3021 */
3022 if( pList->pgno<=pPager->dbSize ){
danielk197762079062007-08-15 17:08:46 +00003023 i64 offset = (pList->pgno-1)*(i64)pPager->pageSize;
drhc001c582006-03-06 18:23:16 +00003024 char *pData = CODEC2(pPager, PGHDR_TO_DATA(pList), pList->pgno, 6);
drh477731b2007-06-16 03:06:27 +00003025 PAGERTRACE4("STORE %d page %d hash(%08x)\n",
3026 PAGERID(pPager), pList->pgno, pager_pagehash(pList));
drh538f5702007-04-13 02:14:30 +00003027 IOTRACE(("PGOUT %p %d\n", pPager, pList->pgno));
danielk197762079062007-08-15 17:08:46 +00003028 rc = sqlite3OsWrite(pPager->fd, pData, pPager->pageSize, offset);
drh538f5702007-04-13 02:14:30 +00003029 PAGER_INCR(sqlite3_pager_writedb_count);
3030 PAGER_INCR(pPager->nWrite);
drh86a88112007-04-16 15:02:19 +00003031 if( pList->pgno==1 ){
3032 memcpy(&pPager->dbFileVers, &pData[24], sizeof(pPager->dbFileVers));
3033 }
danielk1977687566d2004-11-02 12:56:41 +00003034 }
3035#ifndef NDEBUG
3036 else{
drh4f0c5872007-03-26 22:05:01 +00003037 PAGERTRACE3("NOSTORE %d page %d\n", PAGERID(pPager), pList->pgno);
danielk1977687566d2004-11-02 12:56:41 +00003038 }
3039#endif
drh2554f8b2003-01-22 01:26:44 +00003040 if( rc ) return rc;
danielk19773c407372005-02-15 02:54:14 +00003041#ifdef SQLITE_CHECK_PAGES
3042 pList->pageHash = pager_pagehash(pList);
3043#endif
drh2554f8b2003-01-22 01:26:44 +00003044 pList = pList->pDirty;
3045 }
3046 return SQLITE_OK;
3047}
3048
3049/*
3050** Collect every dirty page into a dirty list and
3051** return a pointer to the head of that list. All pages are
3052** collected even if they are still in use.
3053*/
3054static PgHdr *pager_get_all_dirty_pages(Pager *pPager){
drh8f2e9a12008-02-26 14:46:04 +00003055
3056#ifndef NDEBUG
3057 /* Verify the sanity of the dirty list when we are running
3058 ** in debugging mode. This is expensive, so do not
3059 ** do this on a normal build. */
3060 int n1 = 0;
3061 int n2 = 0;
3062 PgHdr *p;
3063 for(p=pPager->pAll; p; p=p->pNextAll){ if( p->dirty ) n1++; }
3064 for(p=pPager->pDirty; p; p=p->pDirty){ n2++; }
3065 assert( n1==n2 );
3066#endif
3067
drh605ad8f2006-05-03 23:34:05 +00003068 return pPager->pDirty;
drh2554f8b2003-01-22 01:26:44 +00003069}
3070
3071/*
drh19db9352008-03-27 22:42:51 +00003072** Return 1 if there is a hot journal on the given pager.
drh165ffe92005-03-15 17:09:30 +00003073** A hot journal is one that needs to be played back.
3074**
3075** If the current size of the database file is 0 but a journal file
3076** exists, that is probably an old journal left over from a prior
3077** database with the same name. Just delete the journal.
drh19db9352008-03-27 22:42:51 +00003078**
3079** Return negative if unable to determine the status of the journal.
drh165ffe92005-03-15 17:09:30 +00003080*/
3081static int hasHotJournal(Pager *pPager){
danielk1977b4b47412007-08-17 15:53:36 +00003082 sqlite3_vfs *pVfs = pPager->pVfs;
drh19db9352008-03-27 22:42:51 +00003083 int rc;
drh165ffe92005-03-15 17:09:30 +00003084 if( !pPager->useJournal ) return 0;
drhd3cf2472007-11-27 16:55:07 +00003085 if( !pPager->fd->pMethods ) return 0;
drh19db9352008-03-27 22:42:51 +00003086 rc = sqlite3OsAccess(pVfs, pPager->zJournal, SQLITE_ACCESS_EXISTS);
3087 if( rc<=0 ){
3088 return rc;
drhbb5f18d2007-04-06 18:23:17 +00003089 }
3090 if( sqlite3OsCheckReservedLock(pPager->fd) ){
3091 return 0;
3092 }
danielk19773b8a05f2007-03-19 17:44:26 +00003093 if( sqlite3PagerPagecount(pPager)==0 ){
danielk1977fee2d252007-08-18 10:59:19 +00003094 sqlite3OsDelete(pVfs, pPager->zJournal, 0);
drh165ffe92005-03-15 17:09:30 +00003095 return 0;
3096 }else{
3097 return 1;
3098 }
3099}
3100
danielk19775591df52005-12-20 09:19:37 +00003101/*
danielk1977aef0bf62005-12-30 16:28:01 +00003102** Try to find a page in the cache that can be recycled.
3103**
3104** This routine may return SQLITE_IOERR, SQLITE_FULL or SQLITE_OK. It
danielk1977efaaf572006-01-16 11:29:19 +00003105** does not set the pPager->errCode variable.
danielk19775591df52005-12-20 09:19:37 +00003106*/
danielk1977843e65f2007-09-01 16:16:15 +00003107static int pager_recycle(Pager *pPager, PgHdr **ppPg){
danielk197713f72992005-12-18 08:51:22 +00003108 PgHdr *pPg;
3109 *ppPg = 0;
3110
danielk1977843e65f2007-09-01 16:16:15 +00003111 /* It is illegal to call this function unless the pager object
3112 ** pointed to by pPager has at least one free page (page with nRef==0).
3113 */
danielk1977c551edc2007-04-05 13:12:13 +00003114 assert(!MEMDB);
danielk1977843e65f2007-09-01 16:16:15 +00003115 assert(pPager->lru.pFirst);
danielk1977c551edc2007-04-05 13:12:13 +00003116
danielk197713f72992005-12-18 08:51:22 +00003117 /* Find a page to recycle. Try to locate a page that does not
3118 ** require us to do an fsync() on the journal.
3119 */
danielk19779f61c2f2007-08-27 17:27:49 +00003120 pPg = pPager->lru.pFirstSynced;
danielk197713f72992005-12-18 08:51:22 +00003121
3122 /* If we could not find a page that does not require an fsync()
3123 ** on the journal file then fsync the journal file. This is a
3124 ** very slow operation, so we work hard to avoid it. But sometimes
3125 ** it can't be helped.
3126 */
danielk1977843e65f2007-09-01 16:16:15 +00003127 if( pPg==0 && pPager->lru.pFirst){
danielk19774cd2cd52007-08-23 14:48:23 +00003128 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
danielk197713f72992005-12-18 08:51:22 +00003129 int rc = syncJournal(pPager);
3130 if( rc!=0 ){
danielk1977aef0bf62005-12-30 16:28:01 +00003131 return rc;
danielk197713f72992005-12-18 08:51:22 +00003132 }
danielk19774cd2cd52007-08-23 14:48:23 +00003133 if( pPager->fullSync && 0==(iDc&SQLITE_IOCAP_SAFE_APPEND) ){
danielk197713f72992005-12-18 08:51:22 +00003134 /* If in full-sync mode, write a new journal header into the
3135 ** journal file. This is done to avoid ever modifying a journal
3136 ** header that is involved in the rollback of pages that have
3137 ** already been written to the database (in case the header is
3138 ** trashed when the nRec field is updated).
3139 */
3140 pPager->nRec = 0;
3141 assert( pPager->journalOff > 0 );
danielk19774099f6e2007-03-19 11:25:20 +00003142 assert( pPager->doNotSync==0 );
danielk197713f72992005-12-18 08:51:22 +00003143 rc = writeJournalHdr(pPager);
3144 if( rc!=0 ){
danielk1977aef0bf62005-12-30 16:28:01 +00003145 return rc;
danielk197713f72992005-12-18 08:51:22 +00003146 }
3147 }
danielk19779f61c2f2007-08-27 17:27:49 +00003148 pPg = pPager->lru.pFirst;
danielk197713f72992005-12-18 08:51:22 +00003149 }
danielk197713f72992005-12-18 08:51:22 +00003150
3151 assert( pPg->nRef==0 );
3152
3153 /* Write the page to the database file if it is dirty.
3154 */
3155 if( pPg->dirty ){
3156 int rc;
3157 assert( pPg->needSync==0 );
drh605ad8f2006-05-03 23:34:05 +00003158 makeClean(pPg);
3159 pPg->dirty = 1;
danielk197713f72992005-12-18 08:51:22 +00003160 pPg->pDirty = 0;
3161 rc = pager_write_pagelist( pPg );
drh153c62c2007-08-24 03:51:33 +00003162 pPg->dirty = 0;
danielk197713f72992005-12-18 08:51:22 +00003163 if( rc!=SQLITE_OK ){
danielk1977aef0bf62005-12-30 16:28:01 +00003164 return rc;
danielk197713f72992005-12-18 08:51:22 +00003165 }
3166 }
3167 assert( pPg->dirty==0 );
3168
3169 /* If the page we are recycling is marked as alwaysRollback, then
3170 ** set the global alwaysRollback flag, thus disabling the
drh80e35f42007-03-30 14:06:34 +00003171 ** sqlite3PagerDontRollback() optimization for the rest of this transaction.
danielk197713f72992005-12-18 08:51:22 +00003172 ** It is necessary to do this because the page marked alwaysRollback
3173 ** might be reloaded at a later time but at that point we won't remember
3174 ** that is was marked alwaysRollback. This means that all pages must
3175 ** be marked as alwaysRollback from here on out.
3176 */
3177 if( pPg->alwaysRollback ){
drh602c2372007-03-01 00:29:13 +00003178 IOTRACE(("ALWAYS_ROLLBACK %p\n", pPager))
danielk197713f72992005-12-18 08:51:22 +00003179 pPager->alwaysRollback = 1;
3180 }
3181
3182 /* Unlink the old page from the free list and the hash table
3183 */
3184 unlinkPage(pPg);
drh7c4ac0c2007-04-05 11:25:58 +00003185 assert( pPg->pgno==0 );
danielk197713f72992005-12-18 08:51:22 +00003186
3187 *ppPg = pPg;
3188 return SQLITE_OK;
3189}
3190
drh86f8c192007-08-22 00:39:19 +00003191#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
danielk197713f72992005-12-18 08:51:22 +00003192/*
3193** This function is called to free superfluous dynamically allocated memory
3194** held by the pager system. Memory in use by any SQLite pager allocated
drh17435752007-08-16 04:30:38 +00003195** by the current thread may be sqlite3_free()ed.
danielk197713f72992005-12-18 08:51:22 +00003196**
3197** nReq is the number of bytes of memory required. Once this much has
drh86f8c192007-08-22 00:39:19 +00003198** been released, the function returns. The return value is the total number
danielk197713f72992005-12-18 08:51:22 +00003199** of bytes of memory released.
3200*/
danielk19773b8a05f2007-03-19 17:44:26 +00003201int sqlite3PagerReleaseMemory(int nReq){
drh86f8c192007-08-22 00:39:19 +00003202 int nReleased = 0; /* Bytes of memory released so far */
3203 sqlite3_mutex *mutex; /* The MEM2 mutex */
3204 Pager *pPager; /* For looping over pagers */
drhe5fe6902007-12-07 18:55:28 +00003205 BusyHandler *savedBusy; /* Saved copy of the busy handler */
danielk19779f61c2f2007-08-27 17:27:49 +00003206 int rc = SQLITE_OK;
danielk197713f72992005-12-18 08:51:22 +00003207
drh86f8c192007-08-22 00:39:19 +00003208 /* Acquire the memory-management mutex
danielk1977441b09a2006-01-05 13:48:29 +00003209 */
drh86f8c192007-08-22 00:39:19 +00003210 mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MEM2);
3211 sqlite3_mutex_enter(mutex);
3212
3213 /* Signal all database connections that memory management wants
3214 ** to have access to the pagers.
3215 */
3216 for(pPager=sqlite3PagerList; pPager; pPager=pPager->pNext){
3217 pPager->iInUseMM = 1;
danielk1977441b09a2006-01-05 13:48:29 +00003218 }
3219
danielk19779f61c2f2007-08-27 17:27:49 +00003220 while( rc==SQLITE_OK && (nReq<0 || nReleased<nReq) ){
3221 PgHdr *pPg;
3222 PgHdr *pRecycled;
3223
3224 /* Try to find a page to recycle that does not require a sync(). If
3225 ** this is not possible, find one that does require a sync().
3226 */
3227 sqlite3_mutex_enter(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
3228 pPg = sqlite3LruPageList.pFirstSynced;
3229 while( pPg && (pPg->needSync || pPg->pPager->iInUseDB) ){
3230 pPg = pPg->gfree.pNext;
3231 }
3232 if( !pPg ){
3233 pPg = sqlite3LruPageList.pFirst;
3234 while( pPg && pPg->pPager->iInUseDB ){
3235 pPg = pPg->gfree.pNext;
3236 }
3237 }
3238 sqlite3_mutex_leave(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
danielk197713f72992005-12-18 08:51:22 +00003239
danielk197784f786f2007-08-28 08:00:17 +00003240 /* If pPg==0, then the block above has failed to find a page to
3241 ** recycle. In this case return early - no further memory will
3242 ** be released.
3243 */
danielk19779f61c2f2007-08-27 17:27:49 +00003244 if( !pPg ) break;
danielk197713f72992005-12-18 08:51:22 +00003245
danielk19779f61c2f2007-08-27 17:27:49 +00003246 pPager = pPg->pPager;
3247 assert(!pPg->needSync || pPg==pPager->lru.pFirst);
3248 assert(pPg->needSync || pPg==pPager->lru.pFirstSynced);
3249
drhe5fe6902007-12-07 18:55:28 +00003250 savedBusy = pPager->pBusyHandler;
3251 pPager->pBusyHandler = 0;
danielk1977843e65f2007-09-01 16:16:15 +00003252 rc = pager_recycle(pPager, &pRecycled);
drhe5fe6902007-12-07 18:55:28 +00003253 pPager->pBusyHandler = savedBusy;
danielk19779f61c2f2007-08-27 17:27:49 +00003254 assert(pRecycled==pPg || rc!=SQLITE_OK);
3255 if( rc==SQLITE_OK ){
3256 /* We've found a page to free. At this point the page has been
3257 ** removed from the page hash-table, free-list and synced-list
3258 ** (pFirstSynced). It is still in the all pages (pAll) list.
3259 ** Remove it from this list before freeing.
3260 **
3261 ** Todo: Check the Pager.pStmt list to make sure this is Ok. It
3262 ** probably is though.
danielk197713f72992005-12-18 08:51:22 +00003263 */
danielk19779f61c2f2007-08-27 17:27:49 +00003264 PgHdr *pTmp;
3265 assert( pPg );
3266 if( pPg==pPager->pAll ){
3267 pPager->pAll = pPg->pNextAll;
3268 }else{
3269 for( pTmp=pPager->pAll; pTmp->pNextAll!=pPg; pTmp=pTmp->pNextAll ){}
3270 pTmp->pNextAll = pPg->pNextAll;
danielk197713f72992005-12-18 08:51:22 +00003271 }
danielk19779f61c2f2007-08-27 17:27:49 +00003272 nReleased += (
3273 sizeof(*pPg) + pPager->pageSize
3274 + sizeof(u32) + pPager->nExtra
3275 + MEMDB*sizeof(PgHistory)
3276 );
3277 IOTRACE(("PGFREE %p %d *\n", pPager, pPg->pgno));
3278 PAGER_INCR(sqlite3_pager_pgfree_count);
drh0d180202008-02-14 23:26:56 +00003279 sqlite3_free(pPg->pData);
danielk19779f61c2f2007-08-27 17:27:49 +00003280 sqlite3_free(pPg);
danielk197784f786f2007-08-28 08:00:17 +00003281 pPager->nPage--;
danielk19779f61c2f2007-08-27 17:27:49 +00003282 }else{
3283 /* An error occured whilst writing to the database file or
3284 ** journal in pager_recycle(). The error is not returned to the
3285 ** caller of this function. Instead, set the Pager.errCode variable.
3286 ** The error will be returned to the user (or users, in the case
3287 ** of a shared pager cache) of the pager for which the error occured.
3288 */
3289 assert(
3290 (rc&0xff)==SQLITE_IOERR ||
3291 rc==SQLITE_FULL ||
3292 rc==SQLITE_BUSY
3293 );
3294 assert( pPager->state>=PAGER_RESERVED );
3295 pager_error(pPager, rc);
danielk197713f72992005-12-18 08:51:22 +00003296 }
3297 }
danielk1977aef0bf62005-12-30 16:28:01 +00003298
drh86f8c192007-08-22 00:39:19 +00003299 /* Clear the memory management flags and release the mutex
3300 */
3301 for(pPager=sqlite3PagerList; pPager; pPager=pPager->pNext){
3302 pPager->iInUseMM = 0;
3303 }
3304 sqlite3_mutex_leave(mutex);
3305
3306 /* Return the number of bytes released
3307 */
danielk197713f72992005-12-18 08:51:22 +00003308 return nReleased;
3309}
drh86f8c192007-08-22 00:39:19 +00003310#endif /* SQLITE_ENABLE_MEMORY_MANAGEMENT */
danielk197713f72992005-12-18 08:51:22 +00003311
drh165ffe92005-03-15 17:09:30 +00003312/*
danielk1977e180dd92007-04-05 17:15:52 +00003313** Read the content of page pPg out of the database file.
3314*/
3315static int readDbPage(Pager *pPager, PgHdr *pPg, Pgno pgno){
3316 int rc;
danielk197762079062007-08-15 17:08:46 +00003317 i64 offset;
danielk1977e180dd92007-04-05 17:15:52 +00003318 assert( MEMDB==0 );
danielk19777a2b1ee2007-08-21 14:27:01 +00003319 assert(pPager->fd->pMethods||pPager->tempFile);
3320 if( !pPager->fd->pMethods ){
3321 return SQLITE_IOERR_SHORT_READ;
3322 }
danielk197762079062007-08-15 17:08:46 +00003323 offset = (pgno-1)*(i64)pPager->pageSize;
3324 rc = sqlite3OsRead(pPager->fd, PGHDR_TO_DATA(pPg), pPager->pageSize, offset);
drh538f5702007-04-13 02:14:30 +00003325 PAGER_INCR(sqlite3_pager_readdb_count);
3326 PAGER_INCR(pPager->nRead);
3327 IOTRACE(("PGIN %p %d\n", pPager, pgno));
drh86a88112007-04-16 15:02:19 +00003328 if( pgno==1 ){
3329 memcpy(&pPager->dbFileVers, &((u8*)PGHDR_TO_DATA(pPg))[24],
3330 sizeof(pPager->dbFileVers));
3331 }
danielk1977e180dd92007-04-05 17:15:52 +00003332 CODEC1(pPager, PGHDR_TO_DATA(pPg), pPg->pgno, 3);
drh477731b2007-06-16 03:06:27 +00003333 PAGERTRACE4("FETCH %d page %d hash(%08x)\n",
3334 PAGERID(pPager), pPg->pgno, pager_pagehash(pPg));
danielk1977e180dd92007-04-05 17:15:52 +00003335 return rc;
3336}
3337
3338
3339/*
danielk1977e277be02007-03-23 18:12:06 +00003340** This function is called to obtain the shared lock required before
3341** data may be read from the pager cache. If the shared lock has already
3342** been obtained, this function is a no-op.
danielk1977393f0682007-03-31 10:00:48 +00003343**
3344** Immediately after obtaining the shared lock (if required), this function
3345** checks for a hot-journal file. If one is found, an emergency rollback
3346** is performed immediately.
danielk1977e277be02007-03-23 18:12:06 +00003347*/
3348static int pagerSharedLock(Pager *pPager){
3349 int rc = SQLITE_OK;
danielk1977ae72d982007-10-03 08:46:44 +00003350 int isHot = 0;
danielk1977e277be02007-03-23 18:12:06 +00003351
danielk1977ae72d982007-10-03 08:46:44 +00003352 /* If this database is opened for exclusive access, has no outstanding
3353 ** page references and is in an error-state, now is the chance to clear
3354 ** the error. Discard the contents of the pager-cache and treat any
3355 ** open journal file as a hot-journal.
3356 */
3357 if( !MEMDB && pPager->exclusiveMode && pPager->nRef==0 && pPager->errCode ){
3358 if( pPager->journalOpen ){
3359 isHot = 1;
3360 }
3361 pager_reset(pPager);
3362 pPager->errCode = SQLITE_OK;
3363 }
3364
3365 /* If the pager is still in an error state, do not proceed. The error
3366 ** state will be cleared at some point in the future when all page
3367 ** references are dropped and the cache can be discarded.
3368 */
3369 if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
3370 return pPager->errCode;
3371 }
3372
3373 if( pPager->state==PAGER_UNLOCK || isHot ){
danielk1977b4b47412007-08-17 15:53:36 +00003374 sqlite3_vfs *pVfs = pPager->pVfs;
danielk1977e277be02007-03-23 18:12:06 +00003375 if( !MEMDB ){
3376 assert( pPager->nRef==0 );
3377 if( !pPager->noReadlock ){
3378 rc = pager_wait_on_lock(pPager, SHARED_LOCK);
3379 if( rc!=SQLITE_OK ){
3380 return pager_error(pPager, rc);
3381 }
3382 assert( pPager->state>=SHARED_LOCK );
3383 }
3384
3385 /* If a journal file exists, and there is no RESERVED lock on the
3386 ** database file, then it either needs to be played back or deleted.
3387 */
drh19db9352008-03-27 22:42:51 +00003388 rc = hasHotJournal(pPager);
3389 if( rc<0 ){
danielk1977a3e52182008-04-14 16:37:10 +00003390 return SQLITE_IOERR_NOMEM;
drh19db9352008-03-27 22:42:51 +00003391 }
3392 if( rc==1 || isHot ){
danielk1977e277be02007-03-23 18:12:06 +00003393 /* Get an EXCLUSIVE lock on the database file. At this point it is
3394 ** important that a RESERVED lock is not obtained on the way to the
3395 ** EXCLUSIVE lock. If it were, another process might open the
3396 ** database file, detect the RESERVED lock, and conclude that the
3397 ** database is safe to read while this process is still rolling it
3398 ** back.
3399 **
3400 ** Because the intermediate RESERVED lock is not requested, the
3401 ** second process will get to this point in the code and fail to
drh85b623f2007-12-13 21:54:09 +00003402 ** obtain its own EXCLUSIVE lock on the database file.
danielk1977e277be02007-03-23 18:12:06 +00003403 */
danielk1977ae72d982007-10-03 08:46:44 +00003404 if( pPager->state<EXCLUSIVE_LOCK ){
3405 rc = sqlite3OsLock(pPager->fd, EXCLUSIVE_LOCK);
3406 if( rc!=SQLITE_OK ){
3407 pager_unlock(pPager);
3408 return pager_error(pPager, rc);
3409 }
3410 pPager->state = PAGER_EXCLUSIVE;
danielk1977e277be02007-03-23 18:12:06 +00003411 }
danielk1977e277be02007-03-23 18:12:06 +00003412
3413 /* Open the journal for reading only. Return SQLITE_BUSY if
3414 ** we are unable to open the journal file.
3415 **
3416 ** The journal file does not need to be locked itself. The
3417 ** journal file is never open unless the main database file holds
3418 ** a write lock, so there is never any chance of two or more
3419 ** processes opening the journal at the same time.
danielk1977979f38e2007-03-27 16:19:51 +00003420 **
drhfd131da2007-08-07 17:13:03 +00003421 ** Open the journal for read/write access. This is because in
3422 ** exclusive-access mode the file descriptor will be kept open and
danielk1977979f38e2007-03-27 16:19:51 +00003423 ** possibly used for a transaction later on. On some systems, the
3424 ** OsTruncate() call used in exclusive-access mode also requires
3425 ** a read/write file handle.
danielk1977e277be02007-03-23 18:12:06 +00003426 */
danielk1977ae72d982007-10-03 08:46:44 +00003427 if( !isHot ){
danielk1977ce98bba2008-04-03 10:13:01 +00003428 int res = sqlite3OsAccess(pVfs,pPager->zJournal,SQLITE_ACCESS_EXISTS);
3429 if( res==1 ){
danielk1977ae72d982007-10-03 08:46:44 +00003430 int fout = 0;
3431 int f = SQLITE_OPEN_READWRITE|SQLITE_OPEN_MAIN_JOURNAL;
3432 assert( !pPager->tempFile );
3433 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, f, &fout);
3434 assert( rc!=SQLITE_OK || pPager->jfd->pMethods );
3435 if( fout&SQLITE_OPEN_READONLY ){
3436 rc = SQLITE_BUSY;
3437 sqlite3OsClose(pPager->jfd);
3438 }
danielk1977ce98bba2008-04-03 10:13:01 +00003439 }else{
3440 rc = (res==0?SQLITE_BUSY:SQLITE_IOERR_NOMEM);
danielk1977979f38e2007-03-27 16:19:51 +00003441 }
3442 }
danielk1977e277be02007-03-23 18:12:06 +00003443 if( rc!=SQLITE_OK ){
3444 pager_unlock(pPager);
drh1aa5af12008-03-07 19:51:14 +00003445 switch( rc ){
3446 case SQLITE_NOMEM:
3447 case SQLITE_IOERR_UNLOCK:
3448 case SQLITE_IOERR_NOMEM:
3449 return rc;
3450 default:
3451 return SQLITE_BUSY;
3452 }
danielk1977e277be02007-03-23 18:12:06 +00003453 }
3454 pPager->journalOpen = 1;
3455 pPager->journalStarted = 0;
3456 pPager->journalOff = 0;
3457 pPager->setMaster = 0;
3458 pPager->journalHdr = 0;
3459
3460 /* Playback and delete the journal. Drop the database write
3461 ** lock and reacquire the read lock.
3462 */
3463 rc = pager_playback(pPager, 1);
3464 if( rc!=SQLITE_OK ){
3465 return pager_error(pPager, rc);
3466 }
danielk1977c5859712007-03-26 12:26:27 +00003467 assert(pPager->state==PAGER_SHARED ||
3468 (pPager->exclusiveMode && pPager->state>PAGER_SHARED)
3469 );
danielk1977e277be02007-03-23 18:12:06 +00003470 }
3471
3472 if( pPager->pAll ){
danielk197724168722007-04-02 05:07:47 +00003473 /* The shared-lock has just been acquired on the database file
3474 ** and there are already pages in the cache (from a previous
drh86a88112007-04-16 15:02:19 +00003475 ** read or write transaction). Check to see if the database
3476 ** has been modified. If the database has changed, flush the
3477 ** cache.
3478 **
3479 ** Database changes is detected by looking at 15 bytes beginning
3480 ** at offset 24 into the file. The first 4 of these 16 bytes are
3481 ** a 32-bit counter that is incremented with each change. The
3482 ** other bytes change randomly with each file change when
3483 ** a codec is in use.
3484 **
3485 ** There is a vanishingly small chance that a change will not be
drh6fa51032007-05-09 20:35:31 +00003486 ** detected. The chance of an undetected change is so small that
drh86a88112007-04-16 15:02:19 +00003487 ** it can be neglected.
danielk197724168722007-04-02 05:07:47 +00003488 */
drh86a88112007-04-16 15:02:19 +00003489 char dbFileVers[sizeof(pPager->dbFileVers)];
danielk1977e180dd92007-04-05 17:15:52 +00003490 sqlite3PagerPagecount(pPager);
danielk197724168722007-04-02 05:07:47 +00003491
danielk1977e180dd92007-04-05 17:15:52 +00003492 if( pPager->errCode ){
3493 return pPager->errCode;
danielk1977e277be02007-03-23 18:12:06 +00003494 }
3495
danielk1977e180dd92007-04-05 17:15:52 +00003496 if( pPager->dbSize>0 ){
drhae5e4452007-05-03 17:18:36 +00003497 IOTRACE(("CKVERS %p %d\n", pPager, sizeof(dbFileVers)));
danielk197762079062007-08-15 17:08:46 +00003498 rc = sqlite3OsRead(pPager->fd, &dbFileVers, sizeof(dbFileVers), 24);
danielk1977e180dd92007-04-05 17:15:52 +00003499 if( rc!=SQLITE_OK ){
3500 return rc;
3501 }
drh86a88112007-04-16 15:02:19 +00003502 }else{
3503 memset(dbFileVers, 0, sizeof(dbFileVers));
danielk1977e180dd92007-04-05 17:15:52 +00003504 }
3505
drh86a88112007-04-16 15:02:19 +00003506 if( memcmp(pPager->dbFileVers, dbFileVers, sizeof(dbFileVers))!=0 ){
danielk1977e180dd92007-04-05 17:15:52 +00003507 pager_reset(pPager);
danielk1977e277be02007-03-23 18:12:06 +00003508 }
3509 }
3510 }
danielk1977c5859712007-03-26 12:26:27 +00003511 assert( pPager->exclusiveMode || pPager->state<=PAGER_SHARED );
3512 if( pPager->state==PAGER_UNLOCK ){
3513 pPager->state = PAGER_SHARED;
3514 }
danielk1977e277be02007-03-23 18:12:06 +00003515 }
3516
3517 return rc;
3518}
3519
3520/*
danielk1977e180dd92007-04-05 17:15:52 +00003521** Allocate a PgHdr object. Either create a new one or reuse
3522** an existing one that is not otherwise in use.
3523**
3524** A new PgHdr structure is created if any of the following are
3525** true:
3526**
3527** (1) We have not exceeded our maximum allocated cache size
3528** as set by the "PRAGMA cache_size" command.
3529**
3530** (2) There are no unused PgHdr objects available at this time.
3531**
3532** (3) This is an in-memory database.
3533**
3534** (4) There are no PgHdr objects that do not require a journal
3535** file sync and a sync of the journal file is currently
3536** prohibited.
3537**
3538** Otherwise, reuse an existing PgHdr. In other words, reuse an
3539** existing PgHdr if all of the following are true:
3540**
3541** (1) We have reached or exceeded the maximum cache size
3542** allowed by "PRAGMA cache_size".
3543**
3544** (2) There is a PgHdr available with PgHdr->nRef==0
3545**
3546** (3) We are not in an in-memory database
3547**
3548** (4) Either there is an available PgHdr that does not need
3549** to be synced to disk or else disk syncing is currently
3550** allowed.
danielk197724168722007-04-02 05:07:47 +00003551*/
3552static int pagerAllocatePage(Pager *pPager, PgHdr **ppPg){
3553 int rc = SQLITE_OK;
3554 PgHdr *pPg;
drh1e3af332007-10-20 13:17:54 +00003555 int nByteHdr;
danielk197724168722007-04-02 05:07:47 +00003556
danielk1977e180dd92007-04-05 17:15:52 +00003557 /* Create a new PgHdr if any of the four conditions defined
danielk19772a6bdf62007-08-20 16:07:00 +00003558 ** above are met: */
danielk1977e180dd92007-04-05 17:15:52 +00003559 if( pPager->nPage<pPager->mxPage
danielk19779f61c2f2007-08-27 17:27:49 +00003560 || pPager->lru.pFirst==0
danielk1977e180dd92007-04-05 17:15:52 +00003561 || MEMDB
danielk19779f61c2f2007-08-27 17:27:49 +00003562 || (pPager->lru.pFirstSynced==0 && pPager->doNotSync)
danielk1977e180dd92007-04-05 17:15:52 +00003563 ){
drh0d180202008-02-14 23:26:56 +00003564 void *pData;
danielk197724168722007-04-02 05:07:47 +00003565 if( pPager->nPage>=pPager->nHash ){
3566 pager_resize_hash_table(pPager,
3567 pPager->nHash<256 ? 256 : pPager->nHash*2);
3568 if( pPager->nHash==0 ){
3569 rc = SQLITE_NOMEM;
3570 goto pager_allocate_out;
3571 }
3572 }
drhed138fb2007-08-22 22:04:37 +00003573 pagerLeave(pPager);
drh1e3af332007-10-20 13:17:54 +00003574 nByteHdr = sizeof(*pPg) + sizeof(u32) + pPager->nExtra
3575 + MEMDB*sizeof(PgHistory);
drh0d180202008-02-14 23:26:56 +00003576 pPg = sqlite3_malloc( nByteHdr );
3577 if( pPg ){
3578 pData = sqlite3_malloc( pPager->pageSize );
3579 if( pData==0 ){
3580 sqlite3_free(pPg);
3581 pPg = 0;
3582 }
3583 }
drhed138fb2007-08-22 22:04:37 +00003584 pagerEnter(pPager);
danielk197724168722007-04-02 05:07:47 +00003585 if( pPg==0 ){
3586 rc = SQLITE_NOMEM;
3587 goto pager_allocate_out;
3588 }
drh1e3af332007-10-20 13:17:54 +00003589 memset(pPg, 0, nByteHdr);
drh0d180202008-02-14 23:26:56 +00003590 pPg->pData = pData;
danielk197724168722007-04-02 05:07:47 +00003591 pPg->pPager = pPager;
3592 pPg->pNextAll = pPager->pAll;
3593 pPager->pAll = pPg;
3594 pPager->nPage++;
danielk197724168722007-04-02 05:07:47 +00003595 }else{
3596 /* Recycle an existing page with a zero ref-count. */
danielk1977843e65f2007-09-01 16:16:15 +00003597 rc = pager_recycle(pPager, &pPg);
danielk1977e965ac72007-06-13 15:22:28 +00003598 if( rc==SQLITE_BUSY ){
3599 rc = SQLITE_IOERR_BLOCKED;
3600 }
danielk197724168722007-04-02 05:07:47 +00003601 if( rc!=SQLITE_OK ){
3602 goto pager_allocate_out;
3603 }
3604 assert( pPager->state>=SHARED_LOCK );
3605 assert(pPg);
3606 }
3607 *ppPg = pPg;
3608
3609pager_allocate_out:
3610 return rc;
3611}
3612
3613/*
drhd33d5a82007-04-26 12:11:28 +00003614** Make sure we have the content for a page. If the page was
3615** previously acquired with noContent==1, then the content was
3616** just initialized to zeros instead of being read from disk.
3617** But now we need the real data off of disk. So make sure we
3618** have it. Read it in if we do not have it already.
3619*/
3620static int pager_get_content(PgHdr *pPg){
3621 if( pPg->needRead ){
3622 int rc = readDbPage(pPg->pPager, pPg, pPg->pgno);
3623 if( rc==SQLITE_OK ){
3624 pPg->needRead = 0;
3625 }else{
3626 return rc;
3627 }
3628 }
3629 return SQLITE_OK;
3630}
3631
3632/*
drhd9b02572001-04-15 00:37:09 +00003633** Acquire a page.
3634**
drh58a11682001-11-10 13:51:08 +00003635** A read lock on the disk file is obtained when the first page is acquired.
drh5e00f6c2001-09-13 13:46:56 +00003636** This read lock is dropped when the last page is released.
drhd9b02572001-04-15 00:37:09 +00003637**
drhd33d5a82007-04-26 12:11:28 +00003638** This routine works for any page number greater than 0. If the database
drh306dc212001-05-21 13:45:10 +00003639** file is smaller than the requested page, then no actual disk
3640** read occurs and the memory image of the page is initialized to
3641** all zeros. The extra data appended to a page is always initialized
3642** to zeros the first time a page is loaded into memory.
3643**
drhd9b02572001-04-15 00:37:09 +00003644** The acquisition might fail for several reasons. In all cases,
3645** an appropriate error code is returned and *ppPage is set to NULL.
drh7e3b0a02001-04-28 16:52:40 +00003646**
drhd33d5a82007-04-26 12:11:28 +00003647** See also sqlite3PagerLookup(). Both this routine and Lookup() attempt
drh7e3b0a02001-04-28 16:52:40 +00003648** to find a page in the in-memory cache first. If the page is not already
drhd33d5a82007-04-26 12:11:28 +00003649** in memory, this routine goes to disk to read it in whereas Lookup()
drh7e3b0a02001-04-28 16:52:40 +00003650** just returns 0. This routine acquires a read-lock the first time it
3651** has to go to disk, and could also playback an old journal if necessary.
drhd33d5a82007-04-26 12:11:28 +00003652** Since Lookup() never goes to disk, it never has to deal with locks
drh7e3b0a02001-04-28 16:52:40 +00003653** or journal files.
drh0787db62007-03-04 13:15:27 +00003654**
drh538f5702007-04-13 02:14:30 +00003655** If noContent is false, the page contents are actually read from disk.
3656** If noContent is true, it means that we do not care about the contents
3657** of the page at this time, so do not do a disk read. Just fill in the
3658** page content with zeros. But mark the fact that we have not read the
3659** content by setting the PgHdr.needRead flag. Later on, if
drhd33d5a82007-04-26 12:11:28 +00003660** sqlite3PagerWrite() is called on this page or if this routine is
3661** called again with noContent==0, that means that the content is needed
3662** and the disk read should occur at that point.
drhed7c8552001-04-11 14:29:21 +00003663*/
drh86f8c192007-08-22 00:39:19 +00003664static int pagerAcquire(
drh538f5702007-04-13 02:14:30 +00003665 Pager *pPager, /* The pager open on the database file */
3666 Pgno pgno, /* Page number to fetch */
3667 DbPage **ppPage, /* Write a pointer to the page here */
3668 int noContent /* Do not bother reading content from disk if true */
3669){
drhed7c8552001-04-11 14:29:21 +00003670 PgHdr *pPg;
drh165ffe92005-03-15 17:09:30 +00003671 int rc;
drhed7c8552001-04-11 14:29:21 +00003672
danielk1977e277be02007-03-23 18:12:06 +00003673 assert( pPager->state==PAGER_UNLOCK || pPager->nRef>0 || pgno==1 );
3674
danielk197726836652005-01-17 01:33:13 +00003675 /* The maximum page number is 2^31. Return SQLITE_CORRUPT if a page
3676 ** number greater than this, or zero, is requested.
3677 */
drh267cb322005-09-16 17:16:52 +00003678 if( pgno>PAGER_MAX_PGNO || pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh49285702005-09-17 15:20:26 +00003679 return SQLITE_CORRUPT_BKPT;
danielk197726836652005-01-17 01:33:13 +00003680 }
3681
drhd9b02572001-04-15 00:37:09 +00003682 /* Make sure we have not hit any critical errors.
3683 */
drh836faa42003-01-11 13:30:57 +00003684 assert( pPager!=0 );
drh2e6d11b2003-04-25 15:37:57 +00003685 *ppPage = 0;
drhd9b02572001-04-15 00:37:09 +00003686
danielk197713adf8a2004-06-03 16:08:41 +00003687 /* If this is the first page accessed, then get a SHARED lock
danielk1977334cdb62007-03-26 08:05:12 +00003688 ** on the database file. pagerSharedLock() is a no-op if
3689 ** a database lock is already held.
drhed7c8552001-04-11 14:29:21 +00003690 */
danielk1977e277be02007-03-23 18:12:06 +00003691 rc = pagerSharedLock(pPager);
3692 if( rc!=SQLITE_OK ){
3693 return rc;
drhed7c8552001-04-11 14:29:21 +00003694 }
danielk1977e277be02007-03-23 18:12:06 +00003695 assert( pPager->state!=PAGER_UNLOCK );
3696
3697 pPg = pager_lookup(pPager, pgno);
drhed7c8552001-04-11 14:29:21 +00003698 if( pPg==0 ){
drhd9b02572001-04-15 00:37:09 +00003699 /* The requested page is not in the page cache. */
danielk1977979f38e2007-03-27 16:19:51 +00003700 int nMax;
drhed7c8552001-04-11 14:29:21 +00003701 int h;
drh538f5702007-04-13 02:14:30 +00003702 PAGER_INCR(pPager->nMiss);
danielk197724168722007-04-02 05:07:47 +00003703 rc = pagerAllocatePage(pPager, &pPg);
3704 if( rc!=SQLITE_OK ){
3705 return rc;
drhed7c8552001-04-11 14:29:21 +00003706 }
danielk197724168722007-04-02 05:07:47 +00003707
drhed7c8552001-04-11 14:29:21 +00003708 pPg->pgno = pgno;
danielk1977f35843b2007-04-07 15:03:17 +00003709 assert( !MEMDB || pgno>pPager->stmtSize );
drhf5e7bb52008-02-18 14:47:33 +00003710 pPg->inJournal = sqlite3BitvecTest(pPager->pInJournal, pgno);
3711 pPg->needSync = 0;
danielk1977f35843b2007-04-07 15:03:17 +00003712
drh605ad8f2006-05-03 23:34:05 +00003713 makeClean(pPg);
drhed7c8552001-04-11 14:29:21 +00003714 pPg->nRef = 1;
danielk197775bab7d2006-01-23 13:09:45 +00003715
drhd9b02572001-04-15 00:37:09 +00003716 pPager->nRef++;
drh2e6d11b2003-04-25 15:37:57 +00003717 if( pPager->nExtra>0 ){
drh90f5ecb2004-07-22 01:19:35 +00003718 memset(PGHDR_TO_EXTRA(pPg, pPager), 0, pPager->nExtra);
drh2e6d11b2003-04-25 15:37:57 +00003719 }
danielk1977979f38e2007-03-27 16:19:51 +00003720 nMax = sqlite3PagerPagecount(pPager);
danielk1977efaaf572006-01-16 11:29:19 +00003721 if( pPager->errCode ){
danielk1977efaaf572006-01-16 11:29:19 +00003722 rc = pPager->errCode;
danielk1977ae72d982007-10-03 08:46:44 +00003723 sqlite3PagerUnref(pPg);
drh2e6d11b2003-04-25 15:37:57 +00003724 return rc;
3725 }
danielk197775bab7d2006-01-23 13:09:45 +00003726
3727 /* Populate the page with data, either by reading from the database
3728 ** file, or by setting the entire page to zero.
3729 */
drhd215acf2007-04-13 04:01:58 +00003730 if( nMax<(int)pgno || MEMDB || (noContent && !pPager->alwaysRollback) ){
drhf8e632b2007-05-08 14:51:36 +00003731 if( pgno>pPager->mxPgno ){
danielk1977de3bea72007-05-09 15:56:39 +00003732 sqlite3PagerUnref(pPg);
drhf8e632b2007-05-08 14:51:36 +00003733 return SQLITE_FULL;
3734 }
drh90f5ecb2004-07-22 01:19:35 +00003735 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
drhd215acf2007-04-13 04:01:58 +00003736 pPg->needRead = noContent && !pPager->alwaysRollback;
drh538f5702007-04-13 02:14:30 +00003737 IOTRACE(("ZERO %p %d\n", pPager, pgno));
drh306dc212001-05-21 13:45:10 +00003738 }else{
danielk1977e180dd92007-04-05 17:15:52 +00003739 rc = readDbPage(pPager, pPg, pgno);
drh551b7732006-11-06 21:20:25 +00003740 if( rc!=SQLITE_OK && rc!=SQLITE_IOERR_SHORT_READ ){
3741 pPg->pgno = 0;
danielk19773b8a05f2007-03-19 17:44:26 +00003742 sqlite3PagerUnref(pPg);
drh551b7732006-11-06 21:20:25 +00003743 return rc;
drh81a20f22001-10-12 17:30:04 +00003744 }
danielk1977b4626a32007-04-28 15:47:43 +00003745 pPg->needRead = 0;
drh306dc212001-05-21 13:45:10 +00003746 }
danielk197775bab7d2006-01-23 13:09:45 +00003747
3748 /* Link the page into the page hash table */
drh8ca0c722006-05-07 17:49:38 +00003749 h = pgno & (pPager->nHash-1);
drh3765df42006-06-28 18:18:09 +00003750 assert( pgno!=0 );
danielk197775bab7d2006-01-23 13:09:45 +00003751 pPg->pNextHash = pPager->aHash[h];
3752 pPager->aHash[h] = pPg;
3753 if( pPg->pNextHash ){
3754 assert( pPg->pNextHash->pPrevHash==0 );
3755 pPg->pNextHash->pPrevHash = pPg;
3756 }
3757
danielk19773c407372005-02-15 02:54:14 +00003758#ifdef SQLITE_CHECK_PAGES
3759 pPg->pageHash = pager_pagehash(pPg);
3760#endif
drhed7c8552001-04-11 14:29:21 +00003761 }else{
drhd9b02572001-04-15 00:37:09 +00003762 /* The requested page is in the page cache. */
danielk1977e277be02007-03-23 18:12:06 +00003763 assert(pPager->nRef>0 || pgno==1);
drh538f5702007-04-13 02:14:30 +00003764 PAGER_INCR(pPager->nHit);
drhd33d5a82007-04-26 12:11:28 +00003765 if( !noContent ){
3766 rc = pager_get_content(pPg);
3767 if( rc ){
3768 return rc;
3769 }
3770 }
drhdf0b3b02001-06-23 11:36:20 +00003771 page_ref(pPg);
drhed7c8552001-04-11 14:29:21 +00003772 }
danielk19773b8a05f2007-03-19 17:44:26 +00003773 *ppPage = pPg;
drhed7c8552001-04-11 14:29:21 +00003774 return SQLITE_OK;
3775}
drh86f8c192007-08-22 00:39:19 +00003776int sqlite3PagerAcquire(
3777 Pager *pPager, /* The pager open on the database file */
3778 Pgno pgno, /* Page number to fetch */
3779 DbPage **ppPage, /* Write a pointer to the page here */
3780 int noContent /* Do not bother reading content from disk if true */
3781){
3782 int rc;
3783 pagerEnter(pPager);
3784 rc = pagerAcquire(pPager, pgno, ppPage, noContent);
3785 pagerLeave(pPager);
3786 return rc;
3787}
3788
drhed7c8552001-04-11 14:29:21 +00003789
3790/*
drh7e3b0a02001-04-28 16:52:40 +00003791** Acquire a page if it is already in the in-memory cache. Do
3792** not read the page from disk. Return a pointer to the page,
3793** or 0 if the page is not in cache.
3794**
danielk19773b8a05f2007-03-19 17:44:26 +00003795** See also sqlite3PagerGet(). The difference between this routine
3796** and sqlite3PagerGet() is that _get() will go to the disk and read
drh7e3b0a02001-04-28 16:52:40 +00003797** in the page if the page is not already in cache. This routine
drh5e00f6c2001-09-13 13:46:56 +00003798** returns NULL if the page is not in cache or if a disk I/O error
3799** has ever happened.
drh7e3b0a02001-04-28 16:52:40 +00003800*/
danielk19773b8a05f2007-03-19 17:44:26 +00003801DbPage *sqlite3PagerLookup(Pager *pPager, Pgno pgno){
drh86f8c192007-08-22 00:39:19 +00003802 PgHdr *pPg = 0;
drh7e3b0a02001-04-28 16:52:40 +00003803
drh836faa42003-01-11 13:30:57 +00003804 assert( pPager!=0 );
3805 assert( pgno!=0 );
danielk1977e277be02007-03-23 18:12:06 +00003806
drh86f8c192007-08-22 00:39:19 +00003807 pagerEnter(pPager);
danielk1977e277be02007-03-23 18:12:06 +00003808 if( pPager->state==PAGER_UNLOCK ){
danielk1977334cdb62007-03-26 08:05:12 +00003809 assert( !pPager->pAll || pPager->exclusiveMode );
drh86f8c192007-08-22 00:39:19 +00003810 }else if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
3811 /* Do nothing */
3812 }else if( (pPg = pager_lookup(pPager, pgno))!=0 ){
3813 page_ref(pPg);
danielk1977e277be02007-03-23 18:12:06 +00003814 }
drh86f8c192007-08-22 00:39:19 +00003815 pagerLeave(pPager);
danielk19773b8a05f2007-03-19 17:44:26 +00003816 return pPg;
drh7e3b0a02001-04-28 16:52:40 +00003817}
3818
3819/*
drhed7c8552001-04-11 14:29:21 +00003820** Release a page.
3821**
3822** If the number of references to the page drop to zero, then the
3823** page is added to the LRU list. When all references to all pages
drhd9b02572001-04-15 00:37:09 +00003824** are released, a rollback occurs and the lock on the database is
drhed7c8552001-04-11 14:29:21 +00003825** removed.
3826*/
danielk19773b8a05f2007-03-19 17:44:26 +00003827int sqlite3PagerUnref(DbPage *pPg){
danielk1977ae72d982007-10-03 08:46:44 +00003828 Pager *pPager = pPg->pPager;
drhd9b02572001-04-15 00:37:09 +00003829
3830 /* Decrement the reference count for this page
3831 */
drhed7c8552001-04-11 14:29:21 +00003832 assert( pPg->nRef>0 );
drh86f8c192007-08-22 00:39:19 +00003833 pagerEnter(pPg->pPager);
drhed7c8552001-04-11 14:29:21 +00003834 pPg->nRef--;
drhd9b02572001-04-15 00:37:09 +00003835
danielk19773c407372005-02-15 02:54:14 +00003836 CHECK_PAGE(pPg);
3837
drh72f82862001-05-24 21:06:34 +00003838 /* When the number of references to a page reach 0, call the
3839 ** destructor and add the page to the freelist.
drhd9b02572001-04-15 00:37:09 +00003840 */
drhed7c8552001-04-11 14:29:21 +00003841 if( pPg->nRef==0 ){
danielk19779f61c2f2007-08-27 17:27:49 +00003842
3843 lruListAdd(pPg);
drh72f82862001-05-24 21:06:34 +00003844 if( pPager->xDestructor ){
danielk19773b8a05f2007-03-19 17:44:26 +00003845 pPager->xDestructor(pPg, pPager->pageSize);
drh72f82862001-05-24 21:06:34 +00003846 }
drhd9b02572001-04-15 00:37:09 +00003847
3848 /* When all pages reach the freelist, drop the read lock from
3849 ** the database file.
3850 */
3851 pPager->nRef--;
3852 assert( pPager->nRef>=0 );
danielk19773dedc192007-03-27 17:37:31 +00003853 if( pPager->nRef==0 && (!pPager->exclusiveMode || pPager->journalOff>0) ){
danielk1977e277be02007-03-23 18:12:06 +00003854 pagerUnlockAndRollback(pPager);
drhd9b02572001-04-15 00:37:09 +00003855 }
drhed7c8552001-04-11 14:29:21 +00003856 }
danielk1977ae72d982007-10-03 08:46:44 +00003857 pagerLeave(pPager);
drhd9b02572001-04-15 00:37:09 +00003858 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +00003859}
3860
3861/*
drha6abd042004-06-09 17:37:22 +00003862** Create a journal file for pPager. There should already be a RESERVED
3863** or EXCLUSIVE lock on the database file when this routine is called.
drhda47d772002-12-02 04:25:19 +00003864**
3865** Return SQLITE_OK if everything. Return an error code and release the
3866** write lock if anything goes wrong.
3867*/
3868static int pager_open_journal(Pager *pPager){
danielk1977b4b47412007-08-17 15:53:36 +00003869 sqlite3_vfs *pVfs = pPager->pVfs;
3870 int flags = (SQLITE_OPEN_READWRITE|SQLITE_OPEN_EXCLUSIVE|SQLITE_OPEN_CREATE);
3871
drhda47d772002-12-02 04:25:19 +00003872 int rc;
drhb7f91642004-10-31 02:22:47 +00003873 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +00003874 assert( pPager->state>=PAGER_RESERVED );
drhda47d772002-12-02 04:25:19 +00003875 assert( pPager->journalOpen==0 );
3876 assert( pPager->useJournal );
drhf5e7bb52008-02-18 14:47:33 +00003877 assert( pPager->pInJournal==0 );
danielk19773b8a05f2007-03-19 17:44:26 +00003878 sqlite3PagerPagecount(pPager);
drhed138fb2007-08-22 22:04:37 +00003879 pagerLeave(pPager);
drhf5e7bb52008-02-18 14:47:33 +00003880 pPager->pInJournal = sqlite3BitvecCreate(pPager->dbSize);
drhed138fb2007-08-22 22:04:37 +00003881 pagerEnter(pPager);
drhf5e7bb52008-02-18 14:47:33 +00003882 if( pPager->pInJournal==0 ){
drh9c105bb2004-10-02 20:38:28 +00003883 rc = SQLITE_NOMEM;
3884 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00003885 }
danielk1977b4b47412007-08-17 15:53:36 +00003886
3887 if( pPager->tempFile ){
danielk1977fee2d252007-08-18 10:59:19 +00003888 flags |= (SQLITE_OPEN_DELETEONCLOSE|SQLITE_OPEN_TEMP_JOURNAL);
3889 }else{
3890 flags |= (SQLITE_OPEN_MAIN_JOURNAL);
danielk1977b4b47412007-08-17 15:53:36 +00003891 }
danielk1977c7b60172007-08-22 11:22:03 +00003892#ifdef SQLITE_ENABLE_ATOMIC_WRITE
3893 rc = sqlite3JournalOpen(
3894 pVfs, pPager->zJournal, pPager->jfd, flags, jrnlBufferSize(pPager)
3895 );
3896#else
danielk1977b4b47412007-08-17 15:53:36 +00003897 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, flags, 0);
danielk1977c7b60172007-08-22 11:22:03 +00003898#endif
danielk1977b4b47412007-08-17 15:53:36 +00003899 assert( rc!=SQLITE_OK || pPager->jfd->pMethods );
danielk197776572402004-06-25 02:38:54 +00003900 pPager->journalOff = 0;
3901 pPager->setMaster = 0;
3902 pPager->journalHdr = 0;
drhda47d772002-12-02 04:25:19 +00003903 if( rc!=SQLITE_OK ){
drh600e46a2007-03-28 01:59:33 +00003904 if( rc==SQLITE_NOMEM ){
danielk1977fee2d252007-08-18 10:59:19 +00003905 sqlite3OsDelete(pVfs, pPager->zJournal, 0);
drh600e46a2007-03-28 01:59:33 +00003906 }
drh9c105bb2004-10-02 20:38:28 +00003907 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00003908 }
3909 pPager->journalOpen = 1;
drhdb48ee02003-01-16 13:42:43 +00003910 pPager->journalStarted = 0;
drhda47d772002-12-02 04:25:19 +00003911 pPager->needSync = 0;
3912 pPager->alwaysRollback = 0;
drh968af522003-02-11 14:55:40 +00003913 pPager->nRec = 0;
danielk1977efaaf572006-01-16 11:29:19 +00003914 if( pPager->errCode ){
3915 rc = pPager->errCode;
drhdd5b2fa2005-03-28 03:39:55 +00003916 goto failed_to_open_journal;
drh2e6d11b2003-04-25 15:37:57 +00003917 }
drhda47d772002-12-02 04:25:19 +00003918 pPager->origDbSize = pPager->dbSize;
drhae2b40c2004-06-09 19:03:54 +00003919
danielk197776572402004-06-25 02:38:54 +00003920 rc = writeJournalHdr(pPager);
3921
drhac69b052004-05-12 13:30:07 +00003922 if( pPager->stmtAutoopen && rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00003923 rc = sqlite3PagerStmtBegin(pPager);
drhda47d772002-12-02 04:25:19 +00003924 }
danielk1977ae72d982007-10-03 08:46:44 +00003925 if( rc!=SQLITE_OK && rc!=SQLITE_NOMEM && rc!=SQLITE_IOERR_NOMEM ){
drh80e35f42007-03-30 14:06:34 +00003926 rc = pager_end_transaction(pPager);
drhda47d772002-12-02 04:25:19 +00003927 if( rc==SQLITE_OK ){
3928 rc = SQLITE_FULL;
3929 }
3930 }
drh9c105bb2004-10-02 20:38:28 +00003931 return rc;
3932
3933failed_to_open_journal:
drhf5e7bb52008-02-18 14:47:33 +00003934 sqlite3BitvecDestroy(pPager->pInJournal);
3935 pPager->pInJournal = 0;
drh9c105bb2004-10-02 20:38:28 +00003936 return rc;
drhda47d772002-12-02 04:25:19 +00003937}
3938
3939/*
drh4b845d72002-03-05 12:41:19 +00003940** Acquire a write-lock on the database. The lock is removed when
3941** the any of the following happen:
3942**
drh80e35f42007-03-30 14:06:34 +00003943** * sqlite3PagerCommitPhaseTwo() is called.
danielk19773b8a05f2007-03-19 17:44:26 +00003944** * sqlite3PagerRollback() is called.
3945** * sqlite3PagerClose() is called.
3946** * sqlite3PagerUnref() is called to on every outstanding page.
drh4b845d72002-03-05 12:41:19 +00003947**
danielk197713adf8a2004-06-03 16:08:41 +00003948** The first parameter to this routine is a pointer to any open page of the
3949** database file. Nothing changes about the page - it is used merely to
3950** acquire a pointer to the Pager structure and as proof that there is
3951** already a read-lock on the database.
drh4b845d72002-03-05 12:41:19 +00003952**
danielk197713adf8a2004-06-03 16:08:41 +00003953** The second parameter indicates how much space in bytes to reserve for a
3954** master journal file-name at the start of the journal when it is created.
3955**
3956** A journal file is opened if this is not a temporary file. For temporary
3957** files, the opening of the journal file is deferred until there is an
3958** actual need to write to the journal.
drhda47d772002-12-02 04:25:19 +00003959**
drha6abd042004-06-09 17:37:22 +00003960** If the database is already reserved for writing, this routine is a no-op.
drh684917c2004-10-05 02:41:42 +00003961**
3962** If exFlag is true, go ahead and get an EXCLUSIVE lock on the file
3963** immediately instead of waiting until we try to flush the cache. The
3964** exFlag is ignored if a transaction is already active.
drh4b845d72002-03-05 12:41:19 +00003965*/
danielk19773b8a05f2007-03-19 17:44:26 +00003966int sqlite3PagerBegin(DbPage *pPg, int exFlag){
drh4b845d72002-03-05 12:41:19 +00003967 Pager *pPager = pPg->pPager;
3968 int rc = SQLITE_OK;
drh86f8c192007-08-22 00:39:19 +00003969 pagerEnter(pPager);
drh4b845d72002-03-05 12:41:19 +00003970 assert( pPg->nRef>0 );
drha6abd042004-06-09 17:37:22 +00003971 assert( pPager->state!=PAGER_UNLOCK );
3972 if( pPager->state==PAGER_SHARED ){
drhf5e7bb52008-02-18 14:47:33 +00003973 assert( pPager->pInJournal==0 );
drhb7f91642004-10-31 02:22:47 +00003974 if( MEMDB ){
drha6abd042004-06-09 17:37:22 +00003975 pPager->state = PAGER_EXCLUSIVE;
drhac69b052004-05-12 13:30:07 +00003976 pPager->origDbSize = pPager->dbSize;
3977 }else{
drh054889e2005-11-30 03:20:31 +00003978 rc = sqlite3OsLock(pPager->fd, RESERVED_LOCK);
drh684917c2004-10-05 02:41:42 +00003979 if( rc==SQLITE_OK ){
3980 pPager->state = PAGER_RESERVED;
3981 if( exFlag ){
3982 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
3983 }
3984 }
danielk19779eed5052004-06-04 10:38:30 +00003985 if( rc!=SQLITE_OK ){
drh86f8c192007-08-22 00:39:19 +00003986 pagerLeave(pPager);
danielk19779eed5052004-06-04 10:38:30 +00003987 return rc;
drhac69b052004-05-12 13:30:07 +00003988 }
drha6abd042004-06-09 17:37:22 +00003989 pPager->dirtyCache = 0;
drh4f0c5872007-03-26 22:05:01 +00003990 PAGERTRACE2("TRANSACTION %d\n", PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00003991 if( pPager->useJournal && !pPager->tempFile ){
3992 rc = pager_open_journal(pPager);
3993 }
drh4b845d72002-03-05 12:41:19 +00003994 }
danielk1977334cdb62007-03-26 08:05:12 +00003995 }else if( pPager->journalOpen && pPager->journalOff==0 ){
3996 /* This happens when the pager was in exclusive-access mode last
3997 ** time a (read or write) transaction was successfully concluded
3998 ** by this connection. Instead of deleting the journal file it was
3999 ** kept open and truncated to 0 bytes.
4000 */
4001 assert( pPager->nRec==0 );
4002 assert( pPager->origDbSize==0 );
drhf5e7bb52008-02-18 14:47:33 +00004003 assert( pPager->pInJournal==0 );
danielk1977334cdb62007-03-26 08:05:12 +00004004 sqlite3PagerPagecount(pPager);
drhed138fb2007-08-22 22:04:37 +00004005 pagerLeave(pPager);
drhf5e7bb52008-02-18 14:47:33 +00004006 pPager->pInJournal = sqlite3BitvecCreate( pPager->dbSize );
drhed138fb2007-08-22 22:04:37 +00004007 pagerEnter(pPager);
drhf5e7bb52008-02-18 14:47:33 +00004008 if( !pPager->pInJournal ){
danielk1977334cdb62007-03-26 08:05:12 +00004009 rc = SQLITE_NOMEM;
4010 }else{
drh369339d2007-03-30 16:01:55 +00004011 pPager->origDbSize = pPager->dbSize;
danielk1977334cdb62007-03-26 08:05:12 +00004012 rc = writeJournalHdr(pPager);
4013 }
drh4b845d72002-03-05 12:41:19 +00004014 }
danielk1977334cdb62007-03-26 08:05:12 +00004015 assert( !pPager->journalOpen || pPager->journalOff>0 || rc!=SQLITE_OK );
drh86f8c192007-08-22 00:39:19 +00004016 pagerLeave(pPager);
drh4b845d72002-03-05 12:41:19 +00004017 return rc;
4018}
4019
4020/*
drh605ad8f2006-05-03 23:34:05 +00004021** Make a page dirty. Set its dirty flag and add it to the dirty
4022** page list.
4023*/
4024static void makeDirty(PgHdr *pPg){
4025 if( pPg->dirty==0 ){
4026 Pager *pPager = pPg->pPager;
4027 pPg->dirty = 1;
4028 pPg->pDirty = pPager->pDirty;
4029 if( pPager->pDirty ){
4030 pPager->pDirty->pPrevDirty = pPg;
4031 }
4032 pPg->pPrevDirty = 0;
4033 pPager->pDirty = pPg;
4034 }
4035}
4036
4037/*
4038** Make a page clean. Clear its dirty bit and remove it from the
4039** dirty page list.
4040*/
4041static void makeClean(PgHdr *pPg){
4042 if( pPg->dirty ){
4043 pPg->dirty = 0;
4044 if( pPg->pDirty ){
drh153c62c2007-08-24 03:51:33 +00004045 assert( pPg->pDirty->pPrevDirty==pPg );
drh605ad8f2006-05-03 23:34:05 +00004046 pPg->pDirty->pPrevDirty = pPg->pPrevDirty;
4047 }
4048 if( pPg->pPrevDirty ){
drh153c62c2007-08-24 03:51:33 +00004049 assert( pPg->pPrevDirty->pDirty==pPg );
drh605ad8f2006-05-03 23:34:05 +00004050 pPg->pPrevDirty->pDirty = pPg->pDirty;
4051 }else{
drh153c62c2007-08-24 03:51:33 +00004052 assert( pPg->pPager->pDirty==pPg );
drh605ad8f2006-05-03 23:34:05 +00004053 pPg->pPager->pDirty = pPg->pDirty;
4054 }
4055 }
4056}
4057
4058
4059/*
drhed7c8552001-04-11 14:29:21 +00004060** Mark a data page as writeable. The page is written into the journal
4061** if it is not there already. This routine must be called before making
4062** changes to a page.
4063**
4064** The first time this routine is called, the pager creates a new
drha6abd042004-06-09 17:37:22 +00004065** journal and acquires a RESERVED lock on the database. If the RESERVED
drhed7c8552001-04-11 14:29:21 +00004066** lock could not be acquired, this routine returns SQLITE_BUSY. The
drh306dc212001-05-21 13:45:10 +00004067** calling routine must check for that return value and be careful not to
drhed7c8552001-04-11 14:29:21 +00004068** change any page data until this routine returns SQLITE_OK.
drhd9b02572001-04-15 00:37:09 +00004069**
4070** If the journal file could not be written because the disk is full,
4071** then this routine returns SQLITE_FULL and does an immediate rollback.
4072** All subsequent write attempts also return SQLITE_FULL until there
danielk19773b8a05f2007-03-19 17:44:26 +00004073** is a call to sqlite3PagerCommit() or sqlite3PagerRollback() to
drhd9b02572001-04-15 00:37:09 +00004074** reset.
drhed7c8552001-04-11 14:29:21 +00004075*/
danielk19773b8a05f2007-03-19 17:44:26 +00004076static int pager_write(PgHdr *pPg){
4077 void *pData = PGHDR_TO_DATA(pPg);
drh69688d52001-04-14 16:38:23 +00004078 Pager *pPager = pPg->pPager;
drhd79caeb2001-04-15 02:27:24 +00004079 int rc = SQLITE_OK;
drh69688d52001-04-14 16:38:23 +00004080
drh6446c4d2001-12-15 14:22:18 +00004081 /* Check for errors
4082 */
danielk1977efaaf572006-01-16 11:29:19 +00004083 if( pPager->errCode ){
4084 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00004085 }
drh5e00f6c2001-09-13 13:46:56 +00004086 if( pPager->readOnly ){
4087 return SQLITE_PERM;
4088 }
drh6446c4d2001-12-15 14:22:18 +00004089
danielk197776572402004-06-25 02:38:54 +00004090 assert( !pPager->setMaster );
4091
danielk19773c407372005-02-15 02:54:14 +00004092 CHECK_PAGE(pPg);
4093
drh538f5702007-04-13 02:14:30 +00004094 /* If this page was previously acquired with noContent==1, that means
4095 ** we didn't really read in the content of the page. This can happen
4096 ** (for example) when the page is being moved to the freelist. But
4097 ** now we are (perhaps) moving the page off of the freelist for
4098 ** reuse and we need to know its original content so that content
4099 ** can be stored in the rollback journal. So do the read at this
4100 ** time.
4101 */
drhd33d5a82007-04-26 12:11:28 +00004102 rc = pager_get_content(pPg);
4103 if( rc ){
4104 return rc;
drh538f5702007-04-13 02:14:30 +00004105 }
4106
drh6446c4d2001-12-15 14:22:18 +00004107 /* Mark the page as dirty. If the page has already been written
4108 ** to the journal then we can return right away.
4109 */
drh605ad8f2006-05-03 23:34:05 +00004110 makeDirty(pPg);
danielk1977f35843b2007-04-07 15:03:17 +00004111 if( pPg->inJournal && (pageInStatement(pPg) || pPager->stmtInUse==0) ){
drha6abd042004-06-09 17:37:22 +00004112 pPager->dirtyCache = 1;
danielk1977a0bf2652004-11-04 14:30:04 +00004113 }else{
drh6446c4d2001-12-15 14:22:18 +00004114
danielk1977a0bf2652004-11-04 14:30:04 +00004115 /* If we get this far, it means that the page needs to be
4116 ** written to the transaction journal or the ckeckpoint journal
4117 ** or both.
4118 **
4119 ** First check to see that the transaction journal exists and
4120 ** create it if it does not.
4121 */
4122 assert( pPager->state!=PAGER_UNLOCK );
danielk19773b8a05f2007-03-19 17:44:26 +00004123 rc = sqlite3PagerBegin(pPg, 0);
danielk1977a0bf2652004-11-04 14:30:04 +00004124 if( rc!=SQLITE_OK ){
4125 return rc;
4126 }
4127 assert( pPager->state>=PAGER_RESERVED );
4128 if( !pPager->journalOpen && pPager->useJournal ){
4129 rc = pager_open_journal(pPager);
4130 if( rc!=SQLITE_OK ) return rc;
4131 }
4132 assert( pPager->journalOpen || !pPager->useJournal );
4133 pPager->dirtyCache = 1;
4134
4135 /* The transaction journal now exists and we have a RESERVED or an
4136 ** EXCLUSIVE lock on the main database file. Write the current page to
4137 ** the transaction journal if it is not there already.
4138 */
4139 if( !pPg->inJournal && (pPager->useJournal || MEMDB) ){
4140 if( (int)pPg->pgno <= pPager->origDbSize ){
danielk1977a0bf2652004-11-04 14:30:04 +00004141 if( MEMDB ){
4142 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
drh4f0c5872007-03-26 22:05:01 +00004143 PAGERTRACE3("JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00004144 assert( pHist->pOrig==0 );
drh17435752007-08-16 04:30:38 +00004145 pHist->pOrig = sqlite3_malloc( pPager->pageSize );
danielk1977662278e2007-11-05 15:30:12 +00004146 if( !pHist->pOrig ){
4147 return SQLITE_NOMEM;
danielk1977a0bf2652004-11-04 14:30:04 +00004148 }
danielk1977662278e2007-11-05 15:30:12 +00004149 memcpy(pHist->pOrig, PGHDR_TO_DATA(pPg), pPager->pageSize);
danielk1977a0bf2652004-11-04 14:30:04 +00004150 }else{
drhbf4bca52007-09-06 22:19:14 +00004151 u32 cksum;
4152 char *pData2;
danielk1977dd97a492007-08-22 18:54:32 +00004153
drh267cb322005-09-16 17:16:52 +00004154 /* We should never write to the journal file the page that
4155 ** contains the database locks. The following assert verifies
4156 ** that we do not. */
4157 assert( pPg->pgno!=PAGER_MJ_PGNO(pPager) );
drhc001c582006-03-06 18:23:16 +00004158 pData2 = CODEC2(pPager, pData, pPg->pgno, 7);
drh37527852006-03-16 16:19:56 +00004159 cksum = pager_cksum(pPager, (u8*)pData2);
drhbf4bca52007-09-06 22:19:14 +00004160 rc = write32bits(pPager->jfd, pPager->journalOff, pPg->pgno);
4161 if( rc==SQLITE_OK ){
4162 rc = sqlite3OsWrite(pPager->jfd, pData2, pPager->pageSize,
4163 pPager->journalOff + 4);
4164 pPager->journalOff += pPager->pageSize+4;
4165 }
4166 if( rc==SQLITE_OK ){
4167 rc = write32bits(pPager->jfd, pPager->journalOff, cksum);
4168 pPager->journalOff += 4;
4169 }
4170 IOTRACE(("JOUT %p %d %lld %d\n", pPager, pPg->pgno,
danielk1977667a6c92007-09-10 06:12:04 +00004171 pPager->journalOff, pPager->pageSize));
drh538f5702007-04-13 02:14:30 +00004172 PAGER_INCR(sqlite3_pager_writej_count);
drh477731b2007-06-16 03:06:27 +00004173 PAGERTRACE5("JOURNAL %d page %d needSync=%d hash(%08x)\n",
4174 PAGERID(pPager), pPg->pgno, pPg->needSync, pager_pagehash(pPg));
danielk197707cb5602006-01-20 10:55:05 +00004175
drhfd131da2007-08-07 17:13:03 +00004176 /* An error has occured writing to the journal file. The
danielk197707cb5602006-01-20 10:55:05 +00004177 ** transaction will be rolled back by the layer above.
4178 */
danielk1977a0bf2652004-11-04 14:30:04 +00004179 if( rc!=SQLITE_OK ){
danielk1977a0bf2652004-11-04 14:30:04 +00004180 return rc;
4181 }
danielk197707cb5602006-01-20 10:55:05 +00004182
danielk1977a0bf2652004-11-04 14:30:04 +00004183 pPager->nRec++;
drhf5e7bb52008-02-18 14:47:33 +00004184 assert( pPager->pInJournal!=0 );
4185 sqlite3BitvecSet(pPager->pInJournal, pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00004186 pPg->needSync = !pPager->noSync;
4187 if( pPager->stmtInUse ){
drhf5e7bb52008-02-18 14:47:33 +00004188 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00004189 }
drhac69b052004-05-12 13:30:07 +00004190 }
danielk197713adf8a2004-06-03 16:08:41 +00004191 }else{
danielk1977a0bf2652004-11-04 14:30:04 +00004192 pPg->needSync = !pPager->journalStarted && !pPager->noSync;
drh4f0c5872007-03-26 22:05:01 +00004193 PAGERTRACE4("APPEND %d page %d needSync=%d\n",
danielk1977ef73ee92004-11-06 12:26:07 +00004194 PAGERID(pPager), pPg->pgno, pPg->needSync);
danielk1977a0bf2652004-11-04 14:30:04 +00004195 }
4196 if( pPg->needSync ){
4197 pPager->needSync = 1;
4198 }
4199 pPg->inJournal = 1;
4200 }
4201
4202 /* If the statement journal is open and the page is not in it,
4203 ** then write the current page to the statement journal. Note that
4204 ** the statement journal format differs from the standard journal format
4205 ** in that it omits the checksums and the header.
4206 */
danielk1977f35843b2007-04-07 15:03:17 +00004207 if( pPager->stmtInUse
4208 && !pageInStatement(pPg)
4209 && (int)pPg->pgno<=pPager->stmtSize
4210 ){
danielk1977a0bf2652004-11-04 14:30:04 +00004211 assert( pPg->inJournal || (int)pPg->pgno>pPager->origDbSize );
4212 if( MEMDB ){
4213 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
4214 assert( pHist->pStmt==0 );
drh17435752007-08-16 04:30:38 +00004215 pHist->pStmt = sqlite3_malloc( pPager->pageSize );
danielk1977a0bf2652004-11-04 14:30:04 +00004216 if( pHist->pStmt ){
4217 memcpy(pHist->pStmt, PGHDR_TO_DATA(pPg), pPager->pageSize);
4218 }
drh4f0c5872007-03-26 22:05:01 +00004219 PAGERTRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk1977f35843b2007-04-07 15:03:17 +00004220 page_add_to_stmt_list(pPg);
danielk1977a0bf2652004-11-04 14:30:04 +00004221 }else{
danielk197762079062007-08-15 17:08:46 +00004222 i64 offset = pPager->stmtNRec*(4+pPager->pageSize);
drhbf4bca52007-09-06 22:19:14 +00004223 char *pData2 = CODEC2(pPager, pData, pPg->pgno, 7);
4224 rc = write32bits(pPager->stfd, offset, pPg->pgno);
4225 if( rc==SQLITE_OK ){
4226 rc = sqlite3OsWrite(pPager->stfd, pData2, pPager->pageSize, offset+4);
4227 }
drh4f0c5872007-03-26 22:05:01 +00004228 PAGERTRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
drhac69b052004-05-12 13:30:07 +00004229 if( rc!=SQLITE_OK ){
drhac69b052004-05-12 13:30:07 +00004230 return rc;
4231 }
danielk1977a0bf2652004-11-04 14:30:04 +00004232 pPager->stmtNRec++;
drhf5e7bb52008-02-18 14:47:33 +00004233 assert( pPager->pInStmt!=0 );
4234 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
drhdb48ee02003-01-16 13:42:43 +00004235 }
drhd9b02572001-04-15 00:37:09 +00004236 }
drhfa86c412002-02-02 15:01:15 +00004237 }
4238
4239 /* Update the database size and return.
4240 */
drh1aa2d8b2007-01-03 15:34:29 +00004241 assert( pPager->state>=PAGER_SHARED );
drh1ab43002002-01-14 09:28:19 +00004242 if( pPager->dbSize<(int)pPg->pgno ){
drh306dc212001-05-21 13:45:10 +00004243 pPager->dbSize = pPg->pgno;
drhb7f91642004-10-31 02:22:47 +00004244 if( !MEMDB && pPager->dbSize==PENDING_BYTE/pPager->pageSize ){
drh1f595712004-06-15 01:40:29 +00004245 pPager->dbSize++;
4246 }
drh306dc212001-05-21 13:45:10 +00004247 }
drh69688d52001-04-14 16:38:23 +00004248 return rc;
drhed7c8552001-04-11 14:29:21 +00004249}
4250
4251/*
danielk19774099f6e2007-03-19 11:25:20 +00004252** This function is used to mark a data-page as writable. It uses
4253** pager_write() to open a journal file (if it is not already open)
4254** and write the page *pData to the journal.
4255**
4256** The difference between this function and pager_write() is that this
4257** function also deals with the special case where 2 or more pages
4258** fit on a single disk sector. In this case all co-resident pages
4259** must have been written to the journal file before returning.
4260*/
danielk19773b8a05f2007-03-19 17:44:26 +00004261int sqlite3PagerWrite(DbPage *pDbPage){
danielk19774099f6e2007-03-19 11:25:20 +00004262 int rc = SQLITE_OK;
4263
danielk19773b8a05f2007-03-19 17:44:26 +00004264 PgHdr *pPg = pDbPage;
danielk19774099f6e2007-03-19 11:25:20 +00004265 Pager *pPager = pPg->pPager;
4266 Pgno nPagePerSector = (pPager->sectorSize/pPager->pageSize);
4267
drh86f8c192007-08-22 00:39:19 +00004268 pagerEnter(pPager);
danielk19774099f6e2007-03-19 11:25:20 +00004269 if( !MEMDB && nPagePerSector>1 ){
4270 Pgno nPageCount; /* Total number of pages in database file */
4271 Pgno pg1; /* First page of the sector pPg is located on. */
4272 int nPage; /* Number of pages starting at pg1 to journal */
4273 int ii;
danielk1977dd97a492007-08-22 18:54:32 +00004274 int needSync = 0;
danielk19774099f6e2007-03-19 11:25:20 +00004275
4276 /* Set the doNotSync flag to 1. This is because we cannot allow a journal
4277 ** header to be written between the pages journaled by this function.
4278 */
4279 assert( pPager->doNotSync==0 );
4280 pPager->doNotSync = 1;
4281
4282 /* This trick assumes that both the page-size and sector-size are
4283 ** an integer power of 2. It sets variable pg1 to the identifier
4284 ** of the first page of the sector pPg is located on.
4285 */
4286 pg1 = ((pPg->pgno-1) & ~(nPagePerSector-1)) + 1;
4287
danielk19773b8a05f2007-03-19 17:44:26 +00004288 nPageCount = sqlite3PagerPagecount(pPager);
danielk19774099f6e2007-03-19 11:25:20 +00004289 if( pPg->pgno>nPageCount ){
4290 nPage = (pPg->pgno - pg1)+1;
4291 }else if( (pg1+nPagePerSector-1)>nPageCount ){
4292 nPage = nPageCount+1-pg1;
4293 }else{
4294 nPage = nPagePerSector;
4295 }
4296 assert(nPage>0);
4297 assert(pg1<=pPg->pgno);
4298 assert((pg1+nPage)>pPg->pgno);
4299
4300 for(ii=0; ii<nPage && rc==SQLITE_OK; ii++){
4301 Pgno pg = pg1+ii;
danielk1977dd97a492007-08-22 18:54:32 +00004302 PgHdr *pPage;
drhf5e7bb52008-02-18 14:47:33 +00004303 if( pg==pPg->pgno || !sqlite3BitvecTest(pPager->pInJournal, pg) ){
danielk19774099f6e2007-03-19 11:25:20 +00004304 if( pg!=PAGER_MJ_PGNO(pPager) ){
danielk19773b8a05f2007-03-19 17:44:26 +00004305 rc = sqlite3PagerGet(pPager, pg, &pPage);
danielk19774099f6e2007-03-19 11:25:20 +00004306 if( rc==SQLITE_OK ){
4307 rc = pager_write(pPage);
danielk1977dd97a492007-08-22 18:54:32 +00004308 if( pPage->needSync ){
4309 needSync = 1;
4310 }
danielk19773b8a05f2007-03-19 17:44:26 +00004311 sqlite3PagerUnref(pPage);
danielk19774099f6e2007-03-19 11:25:20 +00004312 }
4313 }
drhc81945e2008-03-10 14:12:53 +00004314 }else if( (pPage = pager_lookup(pPager, pg))!=0 ){
danielk1977dd97a492007-08-22 18:54:32 +00004315 if( pPage->needSync ){
4316 needSync = 1;
4317 }
danielk19774099f6e2007-03-19 11:25:20 +00004318 }
4319 }
4320
danielk1977dd97a492007-08-22 18:54:32 +00004321 /* If the PgHdr.needSync flag is set for any of the nPage pages
4322 ** starting at pg1, then it needs to be set for all of them. Because
4323 ** writing to any of these nPage pages may damage the others, the
4324 ** journal file must contain sync()ed copies of all of them
4325 ** before any of them can be written out to the database file.
4326 */
4327 if( needSync ){
4328 for(ii=0; ii<nPage && needSync; ii++){
4329 PgHdr *pPage = pager_lookup(pPager, pg1+ii);
4330 if( pPage ) pPage->needSync = 1;
4331 }
4332 assert(pPager->needSync);
4333 }
4334
danielk19774099f6e2007-03-19 11:25:20 +00004335 assert( pPager->doNotSync==1 );
4336 pPager->doNotSync = 0;
4337 }else{
danielk19773b8a05f2007-03-19 17:44:26 +00004338 rc = pager_write(pDbPage);
danielk19774099f6e2007-03-19 11:25:20 +00004339 }
drh86f8c192007-08-22 00:39:19 +00004340 pagerLeave(pPager);
danielk19774099f6e2007-03-19 11:25:20 +00004341 return rc;
4342}
4343
4344/*
drhaacc5432002-01-06 17:07:40 +00004345** Return TRUE if the page given in the argument was previously passed
danielk19773b8a05f2007-03-19 17:44:26 +00004346** to sqlite3PagerWrite(). In other words, return TRUE if it is ok
drh6019e162001-07-02 17:51:45 +00004347** to change the content of the page.
4348*/
danielk19777d3a6662006-01-23 16:21:05 +00004349#ifndef NDEBUG
danielk19773b8a05f2007-03-19 17:44:26 +00004350int sqlite3PagerIswriteable(DbPage *pPg){
drh6019e162001-07-02 17:51:45 +00004351 return pPg->dirty;
4352}
danielk19777d3a6662006-01-23 16:21:05 +00004353#endif
drh6019e162001-07-02 17:51:45 +00004354
danielk1977b84f96f2005-01-20 11:32:23 +00004355#ifndef SQLITE_OMIT_VACUUM
drh6019e162001-07-02 17:51:45 +00004356/*
drh001bbcb2003-03-19 03:14:00 +00004357** Replace the content of a single page with the information in the third
4358** argument.
4359*/
danielk19773b8a05f2007-03-19 17:44:26 +00004360int sqlite3PagerOverwrite(Pager *pPager, Pgno pgno, void *pData){
4361 PgHdr *pPg;
drh001bbcb2003-03-19 03:14:00 +00004362 int rc;
4363
drh86f8c192007-08-22 00:39:19 +00004364 pagerEnter(pPager);
danielk19773b8a05f2007-03-19 17:44:26 +00004365 rc = sqlite3PagerGet(pPager, pgno, &pPg);
drh001bbcb2003-03-19 03:14:00 +00004366 if( rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00004367 rc = sqlite3PagerWrite(pPg);
drh001bbcb2003-03-19 03:14:00 +00004368 if( rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00004369 memcpy(sqlite3PagerGetData(pPg), pData, pPager->pageSize);
drh001bbcb2003-03-19 03:14:00 +00004370 }
danielk19773b8a05f2007-03-19 17:44:26 +00004371 sqlite3PagerUnref(pPg);
drh001bbcb2003-03-19 03:14:00 +00004372 }
drh86f8c192007-08-22 00:39:19 +00004373 pagerLeave(pPager);
drh001bbcb2003-03-19 03:14:00 +00004374 return rc;
4375}
danielk1977b84f96f2005-01-20 11:32:23 +00004376#endif
drh001bbcb2003-03-19 03:14:00 +00004377
4378/*
drh30e58752002-03-02 20:41:57 +00004379** A call to this routine tells the pager that it is not necessary to
drh538f5702007-04-13 02:14:30 +00004380** write the information on page pPg back to the disk, even though
drh30e58752002-03-02 20:41:57 +00004381** that page might be marked as dirty.
4382**
4383** The overlying software layer calls this routine when all of the data
4384** on the given page is unused. The pager marks the page as clean so
4385** that it does not get written to disk.
4386**
4387** Tests show that this optimization, together with the
danielk19773b8a05f2007-03-19 17:44:26 +00004388** sqlite3PagerDontRollback() below, more than double the speed
drh30e58752002-03-02 20:41:57 +00004389** of large INSERT operations and quadruple the speed of large DELETEs.
drh8e298f92002-07-06 16:28:47 +00004390**
4391** When this routine is called, set the alwaysRollback flag to true.
danielk19773b8a05f2007-03-19 17:44:26 +00004392** Subsequent calls to sqlite3PagerDontRollback() for the same page
drh8e298f92002-07-06 16:28:47 +00004393** will thereafter be ignored. This is necessary to avoid a problem
4394** where a page with data is added to the freelist during one part of
4395** a transaction then removed from the freelist during a later part
4396** of the same transaction and reused for some other purpose. When it
4397** is first added to the freelist, this routine is called. When reused,
drh80e35f42007-03-30 14:06:34 +00004398** the sqlite3PagerDontRollback() routine is called. But because the
4399** page contains critical data, we still need to be sure it gets
4400** rolled back in spite of the sqlite3PagerDontRollback() call.
drh30e58752002-03-02 20:41:57 +00004401*/
drh538f5702007-04-13 02:14:30 +00004402void sqlite3PagerDontWrite(DbPage *pDbPage){
4403 PgHdr *pPg = pDbPage;
4404 Pager *pPager = pPg->pPager;
drh8e298f92002-07-06 16:28:47 +00004405
drhb7f91642004-10-31 02:22:47 +00004406 if( MEMDB ) return;
drh86f8c192007-08-22 00:39:19 +00004407 pagerEnter(pPager);
drh8e298f92002-07-06 16:28:47 +00004408 pPg->alwaysRollback = 1;
drh43617e92006-03-06 20:55:46 +00004409 if( pPg->dirty && !pPager->stmtInUse ){
drh1aa2d8b2007-01-03 15:34:29 +00004410 assert( pPager->state>=PAGER_SHARED );
drh8124a302002-06-25 14:43:57 +00004411 if( pPager->dbSize==(int)pPg->pgno && pPager->origDbSize<pPager->dbSize ){
4412 /* If this pages is the last page in the file and the file has grown
4413 ** during the current transaction, then do NOT mark the page as clean.
4414 ** When the database file grows, we must make sure that the last page
4415 ** gets written at least once so that the disk file will be the correct
4416 ** size. If you do not write this page and the size of the file
4417 ** on the disk ends up being too small, that can lead to database
4418 ** corruption during the next transaction.
4419 */
4420 }else{
drh538f5702007-04-13 02:14:30 +00004421 PAGERTRACE3("DONT_WRITE page %d of %d\n", pPg->pgno, PAGERID(pPager));
4422 IOTRACE(("CLEAN %p %d\n", pPager, pPg->pgno))
drh605ad8f2006-05-03 23:34:05 +00004423 makeClean(pPg);
danielk19773c407372005-02-15 02:54:14 +00004424#ifdef SQLITE_CHECK_PAGES
4425 pPg->pageHash = pager_pagehash(pPg);
4426#endif
drh8124a302002-06-25 14:43:57 +00004427 }
drh30e58752002-03-02 20:41:57 +00004428 }
drh86f8c192007-08-22 00:39:19 +00004429 pagerLeave(pPager);
drh30e58752002-03-02 20:41:57 +00004430}
4431
4432/*
4433** A call to this routine tells the pager that if a rollback occurs,
4434** it is not necessary to restore the data on the given page. This
4435** means that the pager does not have to record the given page in the
4436** rollback journal.
drh538f5702007-04-13 02:14:30 +00004437**
4438** If we have not yet actually read the content of this page (if
4439** the PgHdr.needRead flag is set) then this routine acts as a promise
4440** that we will never need to read the page content in the future.
4441** so the needRead flag can be cleared at this point.
drh30e58752002-03-02 20:41:57 +00004442*/
danielk19773b8a05f2007-03-19 17:44:26 +00004443void sqlite3PagerDontRollback(DbPage *pPg){
drh30e58752002-03-02 20:41:57 +00004444 Pager *pPager = pPg->pPager;
4445
drh86f8c192007-08-22 00:39:19 +00004446 pagerEnter(pPager);
drhd3627af2006-12-18 18:34:51 +00004447 assert( pPager->state>=PAGER_RESERVED );
danielk1977a55e9352008-01-21 13:04:34 +00004448
4449 /* If the journal file is not open, or DontWrite() has been called on
4450 ** this page (DontWrite() sets the alwaysRollback flag), then this
4451 ** function is a no-op.
4452 */
4453 if( pPager->journalOpen==0 || pPg->alwaysRollback || pPager->alwaysRollback ){
danielk197787c29a92008-01-18 11:33:16 +00004454 pagerLeave(pPager);
4455 return;
4456 }
danielk1977a55e9352008-01-21 13:04:34 +00004457 assert( !MEMDB ); /* For a memdb, pPager->journalOpen is always 0 */
4458
drhc5d0bd92008-04-14 01:00:57 +00004459#ifdef SQLITE_SECURE_DELETE
4460 if( pPg->inJournal || (int)pPg->pgno > pPager->origDbSize ){
4461 return;
4462 }
4463#endif
4464
4465 /* If SECURE_DELETE is disabled, then there is no way that this
4466 ** routine can be called on a page for which sqlite3PagerDontWrite()
4467 ** has not been previously called during the same transaction.
4468 ** And if DontWrite() has previously been called, the following
4469 ** conditions must be met.
danielk1977a55e9352008-01-21 13:04:34 +00004470 */
4471 assert( !pPg->inJournal && (int)pPg->pgno <= pPager->origDbSize );
4472
drhf5e7bb52008-02-18 14:47:33 +00004473 assert( pPager->pInJournal!=0 );
4474 sqlite3BitvecSet(pPager->pInJournal, pPg->pgno);
danielk1977a55e9352008-01-21 13:04:34 +00004475 pPg->inJournal = 1;
4476 pPg->needRead = 0;
4477 if( pPager->stmtInUse ){
drhc5d0bd92008-04-14 01:00:57 +00004478 assert( pPager->stmtSize >= pPager->origDbSize );
drhf5e7bb52008-02-18 14:47:33 +00004479 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
drh30e58752002-03-02 20:41:57 +00004480 }
danielk1977a55e9352008-01-21 13:04:34 +00004481 PAGERTRACE3("DONT_ROLLBACK page %d of %d\n", pPg->pgno, PAGERID(pPager));
4482 IOTRACE(("GARBAGE %p %d\n", pPager, pPg->pgno))
drh86f8c192007-08-22 00:39:19 +00004483 pagerLeave(pPager);
drh30e58752002-03-02 20:41:57 +00004484}
4485
drhac69b052004-05-12 13:30:07 +00004486
drh30e58752002-03-02 20:41:57 +00004487/*
drh80e35f42007-03-30 14:06:34 +00004488** This routine is called to increment the database file change-counter,
4489** stored at byte 24 of the pager file.
4490*/
danielk1977c7b60172007-08-22 11:22:03 +00004491static int pager_incr_changecounter(Pager *pPager, int isDirect){
drh80e35f42007-03-30 14:06:34 +00004492 PgHdr *pPgHdr;
4493 u32 change_counter;
danielk1977c7b60172007-08-22 11:22:03 +00004494 int rc = SQLITE_OK;
drh80e35f42007-03-30 14:06:34 +00004495
4496 if( !pPager->changeCountDone ){
4497 /* Open page 1 of the file for writing. */
4498 rc = sqlite3PagerGet(pPager, 1, &pPgHdr);
4499 if( rc!=SQLITE_OK ) return rc;
danielk1977c7b60172007-08-22 11:22:03 +00004500
4501 if( !isDirect ){
4502 rc = sqlite3PagerWrite(pPgHdr);
danielk1977ae72d982007-10-03 08:46:44 +00004503 if( rc!=SQLITE_OK ){
4504 sqlite3PagerUnref(pPgHdr);
4505 return rc;
4506 }
danielk1977c7b60172007-08-22 11:22:03 +00004507 }
4508
drh80e35f42007-03-30 14:06:34 +00004509 /* Increment the value just read and write it back to byte 24. */
drhb1003912007-07-20 00:33:36 +00004510 change_counter = sqlite3Get4byte((u8*)pPager->dbFileVers);
drh80e35f42007-03-30 14:06:34 +00004511 change_counter++;
4512 put32bits(((char*)PGHDR_TO_DATA(pPgHdr))+24, change_counter);
danielk1977c7b60172007-08-22 11:22:03 +00004513
4514 if( isDirect && pPager->fd->pMethods ){
4515 const void *zBuf = PGHDR_TO_DATA(pPgHdr);
4516 rc = sqlite3OsWrite(pPager->fd, zBuf, pPager->pageSize, 0);
4517 }
4518
drh80e35f42007-03-30 14:06:34 +00004519 /* Release the page reference. */
4520 sqlite3PagerUnref(pPgHdr);
4521 pPager->changeCountDone = 1;
4522 }
danielk1977c7b60172007-08-22 11:22:03 +00004523 return rc;
drh80e35f42007-03-30 14:06:34 +00004524}
4525
4526/*
danielk1977f653d782008-03-20 11:04:21 +00004527** Sync the pager file to disk.
4528*/
4529int sqlite3PagerSync(Pager *pPager){
4530 int rc;
4531 pagerEnter(pPager);
4532 rc = sqlite3OsSync(pPager->fd, pPager->sync_flags);
4533 pagerLeave(pPager);
4534 return rc;
4535}
4536
4537/*
drh80e35f42007-03-30 14:06:34 +00004538** Sync the database file for the pager pPager. zMaster points to the name
4539** of a master journal file that should be written into the individual
4540** journal file. zMaster may be NULL, which is interpreted as no master
4541** journal (a single database transaction).
4542**
4543** This routine ensures that the journal is synced, all dirty pages written
4544** to the database file and the database file synced. The only thing that
4545** remains to commit the transaction is to delete the journal file (or
4546** master journal file if specified).
4547**
4548** Note that if zMaster==NULL, this does not overwrite a previous value
4549** passed to an sqlite3PagerCommitPhaseOne() call.
4550**
4551** If parameter nTrunc is non-zero, then the pager file is truncated to
4552** nTrunc pages (this is used by auto-vacuum databases).
danielk1977f653d782008-03-20 11:04:21 +00004553**
4554** If the final parameter - noSync - is true, then the database file itself
4555** is not synced. The caller must call sqlite3PagerSync() directly to
4556** sync the database file before calling CommitPhaseTwo() to delete the
4557** journal file in this case.
drh80e35f42007-03-30 14:06:34 +00004558*/
danielk1977f653d782008-03-20 11:04:21 +00004559int sqlite3PagerCommitPhaseOne(
4560 Pager *pPager,
4561 const char *zMaster,
4562 Pgno nTrunc,
4563 int noSync
4564){
drh80e35f42007-03-30 14:06:34 +00004565 int rc = SQLITE_OK;
4566
4567 PAGERTRACE4("DATABASE SYNC: File=%s zMaster=%s nTrunc=%d\n",
4568 pPager->zFilename, zMaster, nTrunc);
drh86f8c192007-08-22 00:39:19 +00004569 pagerEnter(pPager);
drh80e35f42007-03-30 14:06:34 +00004570
4571 /* If this is an in-memory db, or no pages have been written to, or this
4572 ** function has already been called, it is a no-op.
4573 */
4574 if( pPager->state!=PAGER_SYNCED && !MEMDB && pPager->dirtyCache ){
4575 PgHdr *pPg;
drh80e35f42007-03-30 14:06:34 +00004576
danielk1977c7b60172007-08-22 11:22:03 +00004577#ifdef SQLITE_ENABLE_ATOMIC_WRITE
4578 /* The atomic-write optimization can be used if all of the
4579 ** following are true:
4580 **
4581 ** + The file-system supports the atomic-write property for
4582 ** blocks of size page-size, and
4583 ** + This commit is not part of a multi-file transaction, and
4584 ** + Exactly one page has been modified and store in the journal file.
4585 **
4586 ** If the optimization can be used, then the journal file will never
4587 ** be created for this transaction.
4588 */
danielk1977f55b8992007-08-24 08:15:53 +00004589 int useAtomicWrite = (
4590 !zMaster &&
4591 pPager->journalOff==jrnlBufferSize(pPager) &&
4592 nTrunc==0 &&
4593 (0==pPager->pDirty || 0==pPager->pDirty->pDirty)
4594 );
4595 if( useAtomicWrite ){
danielk1977c7b60172007-08-22 11:22:03 +00004596 /* Update the nRec field in the journal file. */
4597 int offset = pPager->journalHdr + sizeof(aJournalMagic);
4598 assert(pPager->nRec==1);
4599 rc = write32bits(pPager->jfd, offset, pPager->nRec);
4600
4601 /* Update the db file change counter. The following call will modify
4602 ** the in-memory representation of page 1 to include the updated
4603 ** change counter and then write page 1 directly to the database
4604 ** file. Because of the atomic-write property of the host file-system,
4605 ** this is safe.
4606 */
danielk1977ae72d982007-10-03 08:46:44 +00004607 if( rc==SQLITE_OK ){
4608 rc = pager_incr_changecounter(pPager, 1);
4609 }
danielk1977f55b8992007-08-24 08:15:53 +00004610 }else{
4611 rc = sqlite3JournalCreate(pPager->jfd);
danielk1977f55b8992007-08-24 08:15:53 +00004612 }
4613
danielk1977ae72d982007-10-03 08:46:44 +00004614 if( !useAtomicWrite && rc==SQLITE_OK )
danielk1977c7b60172007-08-22 11:22:03 +00004615#endif
4616
drh80e35f42007-03-30 14:06:34 +00004617 /* If a master journal file name has already been written to the
4618 ** journal file, then no sync is required. This happens when it is
4619 ** written, then the process fails to upgrade from a RESERVED to an
4620 ** EXCLUSIVE lock. The next time the process tries to commit the
4621 ** transaction the m-j name will have already been written.
4622 */
4623 if( !pPager->setMaster ){
danielk1977f55b8992007-08-24 08:15:53 +00004624 assert( pPager->journalOpen );
danielk1977c7b60172007-08-22 11:22:03 +00004625 rc = pager_incr_changecounter(pPager, 0);
drh80e35f42007-03-30 14:06:34 +00004626 if( rc!=SQLITE_OK ) goto sync_exit;
4627#ifndef SQLITE_OMIT_AUTOVACUUM
4628 if( nTrunc!=0 ){
4629 /* If this transaction has made the database smaller, then all pages
4630 ** being discarded by the truncation must be written to the journal
4631 ** file.
4632 */
4633 Pgno i;
4634 int iSkip = PAGER_MJ_PGNO(pPager);
4635 for( i=nTrunc+1; i<=pPager->origDbSize; i++ ){
drhf5e7bb52008-02-18 14:47:33 +00004636 if( !sqlite3BitvecTest(pPager->pInJournal, i) && i!=iSkip ){
drh80e35f42007-03-30 14:06:34 +00004637 rc = sqlite3PagerGet(pPager, i, &pPg);
4638 if( rc!=SQLITE_OK ) goto sync_exit;
4639 rc = sqlite3PagerWrite(pPg);
4640 sqlite3PagerUnref(pPg);
4641 if( rc!=SQLITE_OK ) goto sync_exit;
4642 }
4643 }
4644 }
4645#endif
4646 rc = writeMasterJournal(pPager, zMaster);
4647 if( rc!=SQLITE_OK ) goto sync_exit;
4648 rc = syncJournal(pPager);
drh80e35f42007-03-30 14:06:34 +00004649 }
danielk1977c7b60172007-08-22 11:22:03 +00004650 if( rc!=SQLITE_OK ) goto sync_exit;
drh80e35f42007-03-30 14:06:34 +00004651
4652#ifndef SQLITE_OMIT_AUTOVACUUM
4653 if( nTrunc!=0 ){
4654 rc = sqlite3PagerTruncate(pPager, nTrunc);
4655 if( rc!=SQLITE_OK ) goto sync_exit;
4656 }
4657#endif
4658
4659 /* Write all dirty pages to the database file */
4660 pPg = pager_get_all_dirty_pages(pPager);
4661 rc = pager_write_pagelist(pPg);
drh153c62c2007-08-24 03:51:33 +00004662 if( rc!=SQLITE_OK ){
drh04c3a462008-02-26 16:16:45 +00004663 assert( rc!=SQLITE_IOERR_BLOCKED );
4664 /* The error might have left the dirty list all fouled up here,
4665 ** but that does not matter because if the if the dirty list did
4666 ** get corrupted, then the transaction will roll back and
4667 ** discard the dirty list. There is an assert in
4668 ** pager_get_all_dirty_pages() that verifies that no attempt
4669 ** is made to use an invalid dirty list.
4670 */
drh153c62c2007-08-24 03:51:33 +00004671 goto sync_exit;
4672 }
drh3cdd7d32007-03-30 14:46:01 +00004673 pPager->pDirty = 0;
drh80e35f42007-03-30 14:06:34 +00004674
4675 /* Sync the database file. */
danielk1977f653d782008-03-20 11:04:21 +00004676 if( !pPager->noSync && !noSync ){
danielk1977f036aef2007-08-20 05:36:51 +00004677 rc = sqlite3OsSync(pPager->fd, pPager->sync_flags);
drh80e35f42007-03-30 14:06:34 +00004678 }
4679 IOTRACE(("DBSYNC %p\n", pPager))
4680
4681 pPager->state = PAGER_SYNCED;
4682 }else if( MEMDB && nTrunc!=0 ){
4683 rc = sqlite3PagerTruncate(pPager, nTrunc);
4684 }
4685
4686sync_exit:
danielk1977e965ac72007-06-13 15:22:28 +00004687 if( rc==SQLITE_IOERR_BLOCKED ){
4688 /* pager_incr_changecounter() may attempt to obtain an exclusive
4689 * lock to spill the cache and return IOERR_BLOCKED. But since
drh85b623f2007-12-13 21:54:09 +00004690 * there is no chance the cache is inconsistent, it is
danielk1977e965ac72007-06-13 15:22:28 +00004691 * better to return SQLITE_BUSY.
4692 */
4693 rc = SQLITE_BUSY;
4694 }
drh86f8c192007-08-22 00:39:19 +00004695 pagerLeave(pPager);
drh80e35f42007-03-30 14:06:34 +00004696 return rc;
4697}
4698
4699
4700/*
drhed7c8552001-04-11 14:29:21 +00004701** Commit all changes to the database and release the write lock.
drhd9b02572001-04-15 00:37:09 +00004702**
4703** If the commit fails for any reason, a rollback attempt is made
4704** and an error code is returned. If the commit worked, SQLITE_OK
4705** is returned.
drhed7c8552001-04-11 14:29:21 +00004706*/
drh80e35f42007-03-30 14:06:34 +00004707int sqlite3PagerCommitPhaseTwo(Pager *pPager){
drha1b351a2001-09-14 16:42:12 +00004708 int rc;
drhed7c8552001-04-11 14:29:21 +00004709 PgHdr *pPg;
drhd9b02572001-04-15 00:37:09 +00004710
danielk1977efaaf572006-01-16 11:29:19 +00004711 if( pPager->errCode ){
danielk19777f7bc662006-01-23 13:47:47 +00004712 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00004713 }
drha6abd042004-06-09 17:37:22 +00004714 if( pPager->state<PAGER_RESERVED ){
drhd9b02572001-04-15 00:37:09 +00004715 return SQLITE_ERROR;
4716 }
drh86f8c192007-08-22 00:39:19 +00004717 pagerEnter(pPager);
drh4f0c5872007-03-26 22:05:01 +00004718 PAGERTRACE2("COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004719 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004720 pPg = pager_get_all_dirty_pages(pPager);
4721 while( pPg ){
danielk1977f35843b2007-04-07 15:03:17 +00004722 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
4723 clearHistory(pHist);
drhac69b052004-05-12 13:30:07 +00004724 pPg->dirty = 0;
4725 pPg->inJournal = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004726 pHist->inStmt = 0;
drh5229ae42006-03-23 23:29:04 +00004727 pPg->needSync = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004728 pHist->pPrevStmt = pHist->pNextStmt = 0;
drhac69b052004-05-12 13:30:07 +00004729 pPg = pPg->pDirty;
4730 }
drh605ad8f2006-05-03 23:34:05 +00004731 pPager->pDirty = 0;
danielk1977eac7a362004-06-16 07:45:24 +00004732#ifndef NDEBUG
4733 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
4734 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
4735 assert( !pPg->alwaysRollback );
4736 assert( !pHist->pOrig );
4737 assert( !pHist->pStmt );
4738 }
4739#endif
drhac69b052004-05-12 13:30:07 +00004740 pPager->pStmt = 0;
drha6abd042004-06-09 17:37:22 +00004741 pPager->state = PAGER_SHARED;
danielk197787c29a92008-01-18 11:33:16 +00004742 pagerLeave(pPager);
drhac69b052004-05-12 13:30:07 +00004743 return SQLITE_OK;
4744 }
drh3cdd7d32007-03-30 14:46:01 +00004745 assert( pPager->journalOpen || !pPager->dirtyCache );
4746 assert( pPager->state==PAGER_SYNCED || !pPager->dirtyCache );
4747 rc = pager_end_transaction(pPager);
drh86f8c192007-08-22 00:39:19 +00004748 rc = pager_error(pPager, rc);
4749 pagerLeave(pPager);
4750 return rc;
drhed7c8552001-04-11 14:29:21 +00004751}
4752
4753/*
drha6abd042004-06-09 17:37:22 +00004754** Rollback all changes. The database falls back to PAGER_SHARED mode.
drhed7c8552001-04-11 14:29:21 +00004755** All in-memory cache pages revert to their original data contents.
4756** The journal is deleted.
drhd9b02572001-04-15 00:37:09 +00004757**
4758** This routine cannot fail unless some other process is not following
drh4f0ee682007-03-30 20:43:40 +00004759** the correct locking protocol or unless some other
drhd9b02572001-04-15 00:37:09 +00004760** process is writing trash into the journal file (SQLITE_CORRUPT) or
4761** unless a prior malloc() failed (SQLITE_NOMEM). Appropriate error
4762** codes are returned for all these occasions. Otherwise,
4763** SQLITE_OK is returned.
drhed7c8552001-04-11 14:29:21 +00004764*/
danielk19773b8a05f2007-03-19 17:44:26 +00004765int sqlite3PagerRollback(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +00004766 int rc;
drh4f0c5872007-03-26 22:05:01 +00004767 PAGERTRACE2("ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004768 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004769 PgHdr *p;
4770 for(p=pPager->pAll; p; p=p->pNextAll){
4771 PgHistory *pHist;
danielk1977eac7a362004-06-16 07:45:24 +00004772 assert( !p->alwaysRollback );
4773 if( !p->dirty ){
4774 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pOrig );
4775 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pStmt );
4776 continue;
4777 }
4778
drhac69b052004-05-12 13:30:07 +00004779 pHist = PGHDR_TO_HIST(p, pPager);
4780 if( pHist->pOrig ){
4781 memcpy(PGHDR_TO_DATA(p), pHist->pOrig, pPager->pageSize);
drh4f0c5872007-03-26 22:05:01 +00004782 PAGERTRACE3("ROLLBACK-PAGE %d of %d\n", p->pgno, PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00004783 }else{
drh4f0c5872007-03-26 22:05:01 +00004784 PAGERTRACE3("PAGE %d is clean on %d\n", p->pgno, PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00004785 }
4786 clearHistory(pHist);
4787 p->dirty = 0;
4788 p->inJournal = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004789 pHist->inStmt = 0;
4790 pHist->pPrevStmt = pHist->pNextStmt = 0;
danielk1977369f27e2004-06-15 11:40:04 +00004791 if( pPager->xReiniter ){
danielk19773b8a05f2007-03-19 17:44:26 +00004792 pPager->xReiniter(p, pPager->pageSize);
danielk1977369f27e2004-06-15 11:40:04 +00004793 }
drhac69b052004-05-12 13:30:07 +00004794 }
drh605ad8f2006-05-03 23:34:05 +00004795 pPager->pDirty = 0;
drhac69b052004-05-12 13:30:07 +00004796 pPager->pStmt = 0;
4797 pPager->dbSize = pPager->origDbSize;
danielk1977e180dd92007-04-05 17:15:52 +00004798 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00004799 pPager->stmtInUse = 0;
drha6abd042004-06-09 17:37:22 +00004800 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00004801 return SQLITE_OK;
4802 }
4803
drh86f8c192007-08-22 00:39:19 +00004804 pagerEnter(pPager);
drha6abd042004-06-09 17:37:22 +00004805 if( !pPager->dirtyCache || !pPager->journalOpen ){
drh80e35f42007-03-30 14:06:34 +00004806 rc = pager_end_transaction(pPager);
drh86f8c192007-08-22 00:39:19 +00004807 pagerLeave(pPager);
drhda47d772002-12-02 04:25:19 +00004808 return rc;
4809 }
drhdb48ee02003-01-16 13:42:43 +00004810
danielk1977efaaf572006-01-16 11:29:19 +00004811 if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
drha6abd042004-06-09 17:37:22 +00004812 if( pPager->state>=PAGER_EXCLUSIVE ){
danielk1977e277be02007-03-23 18:12:06 +00004813 pager_playback(pPager, 0);
drh4b845d72002-03-05 12:41:19 +00004814 }
drh86f8c192007-08-22 00:39:19 +00004815 pagerLeave(pPager);
danielk1977efaaf572006-01-16 11:29:19 +00004816 return pPager->errCode;
drhed7c8552001-04-11 14:29:21 +00004817 }
drha6abd042004-06-09 17:37:22 +00004818 if( pPager->state==PAGER_RESERVED ){
danielk197717221812005-02-15 03:38:05 +00004819 int rc2;
danielk1977e277be02007-03-23 18:12:06 +00004820 rc = pager_playback(pPager, 0);
drh80e35f42007-03-30 14:06:34 +00004821 rc2 = pager_end_transaction(pPager);
drha6abd042004-06-09 17:37:22 +00004822 if( rc==SQLITE_OK ){
4823 rc = rc2;
4824 }
4825 }else{
danielk1977e277be02007-03-23 18:12:06 +00004826 rc = pager_playback(pPager, 0);
drhd9b02572001-04-15 00:37:09 +00004827 }
danielk1977e180dd92007-04-05 17:15:52 +00004828 /* pager_reset(pPager); */
drhd9b02572001-04-15 00:37:09 +00004829 pPager->dbSize = -1;
danielk197707cb5602006-01-20 10:55:05 +00004830
4831 /* If an error occurs during a ROLLBACK, we can no longer trust the pager
4832 ** cache. So call pager_error() on the way out to make any error
4833 ** persistent.
4834 */
drh86f8c192007-08-22 00:39:19 +00004835 rc = pager_error(pPager, rc);
4836 pagerLeave(pPager);
4837 return rc;
drh98808ba2001-10-18 12:34:46 +00004838}
drhd9b02572001-04-15 00:37:09 +00004839
4840/*
drh5e00f6c2001-09-13 13:46:56 +00004841** Return TRUE if the database file is opened read-only. Return FALSE
4842** if the database is (in theory) writable.
4843*/
danielk19773b8a05f2007-03-19 17:44:26 +00004844int sqlite3PagerIsreadonly(Pager *pPager){
drhbe0072d2001-09-13 14:46:09 +00004845 return pPager->readOnly;
drh5e00f6c2001-09-13 13:46:56 +00004846}
4847
4848/*
drh0f7eb612006-08-08 13:51:43 +00004849** Return the number of references to the pager.
4850*/
danielk19773b8a05f2007-03-19 17:44:26 +00004851int sqlite3PagerRefcount(Pager *pPager){
drh0f7eb612006-08-08 13:51:43 +00004852 return pPager->nRef;
4853}
4854
4855#ifdef SQLITE_TEST
4856/*
drhd9b02572001-04-15 00:37:09 +00004857** This routine is used for testing and analysis only.
4858*/
danielk19773b8a05f2007-03-19 17:44:26 +00004859int *sqlite3PagerStats(Pager *pPager){
danielk197742741be2005-01-08 12:42:39 +00004860 static int a[11];
drhd9b02572001-04-15 00:37:09 +00004861 a[0] = pPager->nRef;
4862 a[1] = pPager->nPage;
4863 a[2] = pPager->mxPage;
4864 a[3] = pPager->dbSize;
4865 a[4] = pPager->state;
danielk1977efaaf572006-01-16 11:29:19 +00004866 a[5] = pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00004867 a[6] = pPager->nHit;
4868 a[7] = pPager->nMiss;
drh7c4ac0c2007-04-05 11:25:58 +00004869 a[8] = 0; /* Used to be pPager->nOvfl */
danielk197742741be2005-01-08 12:42:39 +00004870 a[9] = pPager->nRead;
4871 a[10] = pPager->nWrite;
drhd9b02572001-04-15 00:37:09 +00004872 return a;
4873}
drh0f7eb612006-08-08 13:51:43 +00004874#endif
drhdd793422001-06-28 01:54:48 +00004875
drhfa86c412002-02-02 15:01:15 +00004876/*
drhac69b052004-05-12 13:30:07 +00004877** Set the statement rollback point.
drhfa86c412002-02-02 15:01:15 +00004878**
4879** This routine should be called with the transaction journal already
drhac69b052004-05-12 13:30:07 +00004880** open. A new statement journal is created that can be used to rollback
drhaaab5722002-02-19 13:39:21 +00004881** changes of a single SQL command within a larger transaction.
drhfa86c412002-02-02 15:01:15 +00004882*/
drh86f8c192007-08-22 00:39:19 +00004883static int pagerStmtBegin(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00004884 int rc;
drhac69b052004-05-12 13:30:07 +00004885 assert( !pPager->stmtInUse );
drh1aa2d8b2007-01-03 15:34:29 +00004886 assert( pPager->state>=PAGER_SHARED );
drhdc3ff9c2004-08-18 02:10:15 +00004887 assert( pPager->dbSize>=0 );
drh4f0c5872007-03-26 22:05:01 +00004888 PAGERTRACE2("STMT-BEGIN %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004889 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004890 pPager->stmtInUse = 1;
4891 pPager->stmtSize = pPager->dbSize;
4892 return SQLITE_OK;
4893 }
drhda47d772002-12-02 04:25:19 +00004894 if( !pPager->journalOpen ){
drhac69b052004-05-12 13:30:07 +00004895 pPager->stmtAutoopen = 1;
drhda47d772002-12-02 04:25:19 +00004896 return SQLITE_OK;
4897 }
drhfa86c412002-02-02 15:01:15 +00004898 assert( pPager->journalOpen );
drhed138fb2007-08-22 22:04:37 +00004899 pagerLeave(pPager);
drhf5e7bb52008-02-18 14:47:33 +00004900 assert( pPager->pInStmt==0 );
4901 pPager->pInStmt = sqlite3BitvecCreate(pPager->dbSize);
drhed138fb2007-08-22 22:04:37 +00004902 pagerEnter(pPager);
drhf5e7bb52008-02-18 14:47:33 +00004903 if( pPager->pInStmt==0 ){
danielk1977261919c2005-12-06 12:52:59 +00004904 /* sqlite3OsLock(pPager->fd, SHARED_LOCK); */
drhfa86c412002-02-02 15:01:15 +00004905 return SQLITE_NOMEM;
4906 }
drh968af522003-02-11 14:55:40 +00004907#ifndef NDEBUG
drh054889e2005-11-30 03:20:31 +00004908 rc = sqlite3OsFileSize(pPager->jfd, &pPager->stmtJSize);
drhac69b052004-05-12 13:30:07 +00004909 if( rc ) goto stmt_begin_failed;
danielk197776572402004-06-25 02:38:54 +00004910 assert( pPager->stmtJSize == pPager->journalOff );
drh968af522003-02-11 14:55:40 +00004911#endif
danielk197776572402004-06-25 02:38:54 +00004912 pPager->stmtJSize = pPager->journalOff;
drhac69b052004-05-12 13:30:07 +00004913 pPager->stmtSize = pPager->dbSize;
danielk197776572402004-06-25 02:38:54 +00004914 pPager->stmtHdrOff = 0;
danielk197775edc162004-06-26 01:48:18 +00004915 pPager->stmtCksum = pPager->cksumInit;
drhac69b052004-05-12 13:30:07 +00004916 if( !pPager->stmtOpen ){
drh334b2992007-09-06 23:28:23 +00004917 rc = sqlite3PagerOpentemp(pPager->pVfs, pPager->stfd, pPager->zStmtJrnl,
drh33f4e022007-09-03 15:19:34 +00004918 SQLITE_OPEN_SUBJOURNAL);
drh334b2992007-09-06 23:28:23 +00004919 if( rc ){
4920 goto stmt_begin_failed;
4921 }
drhac69b052004-05-12 13:30:07 +00004922 pPager->stmtOpen = 1;
4923 pPager->stmtNRec = 0;
drh0f892532002-05-30 12:27:03 +00004924 }
drhac69b052004-05-12 13:30:07 +00004925 pPager->stmtInUse = 1;
drhfa86c412002-02-02 15:01:15 +00004926 return SQLITE_OK;
4927
drhac69b052004-05-12 13:30:07 +00004928stmt_begin_failed:
drhf5e7bb52008-02-18 14:47:33 +00004929 if( pPager->pInStmt ){
4930 sqlite3BitvecDestroy(pPager->pInStmt);
4931 pPager->pInStmt = 0;
drhfa86c412002-02-02 15:01:15 +00004932 }
4933 return rc;
4934}
drh86f8c192007-08-22 00:39:19 +00004935int sqlite3PagerStmtBegin(Pager *pPager){
4936 int rc;
4937 pagerEnter(pPager);
4938 rc = pagerStmtBegin(pPager);
4939 pagerLeave(pPager);
4940 return rc;
4941}
drhfa86c412002-02-02 15:01:15 +00004942
4943/*
drhac69b052004-05-12 13:30:07 +00004944** Commit a statement.
drhfa86c412002-02-02 15:01:15 +00004945*/
danielk19773b8a05f2007-03-19 17:44:26 +00004946int sqlite3PagerStmtCommit(Pager *pPager){
drh86f8c192007-08-22 00:39:19 +00004947 pagerEnter(pPager);
drhac69b052004-05-12 13:30:07 +00004948 if( pPager->stmtInUse ){
drh03eb96a2002-11-10 23:32:56 +00004949 PgHdr *pPg, *pNext;
drh4f0c5872007-03-26 22:05:01 +00004950 PAGERTRACE2("STMT-COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004951 if( !MEMDB ){
drh054889e2005-11-30 03:20:31 +00004952 /* sqlite3OsTruncate(pPager->stfd, 0); */
drhf5e7bb52008-02-18 14:47:33 +00004953 sqlite3BitvecDestroy(pPager->pInStmt);
4954 pPager->pInStmt = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004955 }else{
4956 for(pPg=pPager->pStmt; pPg; pPg=pNext){
drhac69b052004-05-12 13:30:07 +00004957 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
danielk1977f35843b2007-04-07 15:03:17 +00004958 pNext = pHist->pNextStmt;
4959 assert( pHist->inStmt );
4960 pHist->inStmt = 0;
4961 pHist->pPrevStmt = pHist->pNextStmt = 0;
drh17435752007-08-16 04:30:38 +00004962 sqlite3_free(pHist->pStmt);
drhac69b052004-05-12 13:30:07 +00004963 pHist->pStmt = 0;
4964 }
4965 }
4966 pPager->stmtNRec = 0;
4967 pPager->stmtInUse = 0;
4968 pPager->pStmt = 0;
drh663fc632002-02-02 18:49:19 +00004969 }
drhac69b052004-05-12 13:30:07 +00004970 pPager->stmtAutoopen = 0;
drh86f8c192007-08-22 00:39:19 +00004971 pagerLeave(pPager);
drhfa86c412002-02-02 15:01:15 +00004972 return SQLITE_OK;
4973}
4974
4975/*
drhac69b052004-05-12 13:30:07 +00004976** Rollback a statement.
drhfa86c412002-02-02 15:01:15 +00004977*/
danielk19773b8a05f2007-03-19 17:44:26 +00004978int sqlite3PagerStmtRollback(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00004979 int rc;
drh86f8c192007-08-22 00:39:19 +00004980 pagerEnter(pPager);
drhac69b052004-05-12 13:30:07 +00004981 if( pPager->stmtInUse ){
drh4f0c5872007-03-26 22:05:01 +00004982 PAGERTRACE2("STMT-ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004983 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004984 PgHdr *pPg;
danielk1977f35843b2007-04-07 15:03:17 +00004985 PgHistory *pHist;
4986 for(pPg=pPager->pStmt; pPg; pPg=pHist->pNextStmt){
4987 pHist = PGHDR_TO_HIST(pPg, pPager);
drhac69b052004-05-12 13:30:07 +00004988 if( pHist->pStmt ){
4989 memcpy(PGHDR_TO_DATA(pPg), pHist->pStmt, pPager->pageSize);
drh17435752007-08-16 04:30:38 +00004990 sqlite3_free(pHist->pStmt);
drhac69b052004-05-12 13:30:07 +00004991 pHist->pStmt = 0;
4992 }
4993 }
4994 pPager->dbSize = pPager->stmtSize;
danielk1977e180dd92007-04-05 17:15:52 +00004995 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00004996 rc = SQLITE_OK;
4997 }else{
4998 rc = pager_stmt_playback(pPager);
4999 }
danielk19773b8a05f2007-03-19 17:44:26 +00005000 sqlite3PagerStmtCommit(pPager);
drh663fc632002-02-02 18:49:19 +00005001 }else{
5002 rc = SQLITE_OK;
5003 }
drhac69b052004-05-12 13:30:07 +00005004 pPager->stmtAutoopen = 0;
drh86f8c192007-08-22 00:39:19 +00005005 pagerLeave(pPager);
drhfa86c412002-02-02 15:01:15 +00005006 return rc;
5007}
5008
drh73509ee2003-04-06 20:44:45 +00005009/*
5010** Return the full pathname of the database file.
5011*/
danielk19773b8a05f2007-03-19 17:44:26 +00005012const char *sqlite3PagerFilename(Pager *pPager){
drh73509ee2003-04-06 20:44:45 +00005013 return pPager->zFilename;
5014}
5015
drhb20ea9d2004-02-09 01:20:36 +00005016/*
drhd0679ed2007-08-28 22:24:34 +00005017** Return the VFS structure for the pager.
5018*/
5019const sqlite3_vfs *sqlite3PagerVfs(Pager *pPager){
5020 return pPager->pVfs;
5021}
5022
5023/*
drhcc6bb3e2007-08-31 16:11:35 +00005024** Return the file handle for the database file associated
5025** with the pager. This might return NULL if the file has
5026** not yet been opened.
5027*/
5028sqlite3_file *sqlite3PagerFile(Pager *pPager){
5029 return pPager->fd;
5030}
5031
5032/*
danielk19775865e3d2004-06-14 06:03:57 +00005033** Return the directory of the database file.
5034*/
danielk19773b8a05f2007-03-19 17:44:26 +00005035const char *sqlite3PagerDirname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00005036 return pPager->zDirectory;
5037}
5038
5039/*
5040** Return the full pathname of the journal file.
5041*/
danielk19773b8a05f2007-03-19 17:44:26 +00005042const char *sqlite3PagerJournalname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00005043 return pPager->zJournal;
5044}
5045
5046/*
drh2c8997b2005-08-27 16:36:48 +00005047** Return true if fsync() calls are disabled for this pager. Return FALSE
5048** if fsync()s are executed normally.
5049*/
danielk19773b8a05f2007-03-19 17:44:26 +00005050int sqlite3PagerNosync(Pager *pPager){
drh2c8997b2005-08-27 16:36:48 +00005051 return pPager->noSync;
5052}
5053
drh7c4ac0c2007-04-05 11:25:58 +00005054#ifdef SQLITE_HAS_CODEC
drh2c8997b2005-08-27 16:36:48 +00005055/*
drhb20ea9d2004-02-09 01:20:36 +00005056** Set the codec for this pager
5057*/
danielk19773b8a05f2007-03-19 17:44:26 +00005058void sqlite3PagerSetCodec(
drhb20ea9d2004-02-09 01:20:36 +00005059 Pager *pPager,
drhc001c582006-03-06 18:23:16 +00005060 void *(*xCodec)(void*,void*,Pgno,int),
drhb20ea9d2004-02-09 01:20:36 +00005061 void *pCodecArg
5062){
5063 pPager->xCodec = xCodec;
5064 pPager->pCodecArg = pCodecArg;
5065}
drh7c4ac0c2007-04-05 11:25:58 +00005066#endif
drhb20ea9d2004-02-09 01:20:36 +00005067
danielk1977687566d2004-11-02 12:56:41 +00005068#ifndef SQLITE_OMIT_AUTOVACUUM
5069/*
danielk197787c29a92008-01-18 11:33:16 +00005070** Move the page pPg to location pgno in the file.
danielk1977687566d2004-11-02 12:56:41 +00005071**
drh5e385312007-06-16 04:42:12 +00005072** There must be no references to the page previously located at
5073** pgno (which we call pPgOld) though that page is allowed to be
5074** in cache. If the page previous located at pgno is not already
5075** in the rollback journal, it is not put there by by this routine.
danielk1977687566d2004-11-02 12:56:41 +00005076**
drh5e385312007-06-16 04:42:12 +00005077** References to the page pPg remain valid. Updating any
5078** meta-data associated with pPg (i.e. data stored in the nExtra bytes
danielk1977687566d2004-11-02 12:56:41 +00005079** allocated along with the page) is the responsibility of the caller.
5080**
danielk19775fd057a2005-03-09 13:09:43 +00005081** A transaction must be active when this routine is called. It used to be
5082** required that a statement transaction was not active, but this restriction
5083** has been removed (CREATE INDEX needs to move a page when a statement
5084** transaction is active).
danielk1977687566d2004-11-02 12:56:41 +00005085*/
danielk19773b8a05f2007-03-19 17:44:26 +00005086int sqlite3PagerMovepage(Pager *pPager, DbPage *pPg, Pgno pgno){
drh5e385312007-06-16 04:42:12 +00005087 PgHdr *pPgOld; /* The page being overwritten. */
danielk1977f5fdda82004-11-03 08:44:05 +00005088 int h;
danielk197794daf7f2004-11-08 09:26:09 +00005089 Pgno needSyncPgno = 0;
danielk1977687566d2004-11-02 12:56:41 +00005090
drh86f8c192007-08-22 00:39:19 +00005091 pagerEnter(pPager);
danielk1977687566d2004-11-02 12:56:41 +00005092 assert( pPg->nRef>0 );
5093
drh4f0c5872007-03-26 22:05:01 +00005094 PAGERTRACE5("MOVE %d page %d (needSync=%d) moves to %d\n",
danielk1977599fcba2004-11-08 07:13:13 +00005095 PAGERID(pPager), pPg->pgno, pPg->needSync, pgno);
drhb0603412007-02-28 04:47:26 +00005096 IOTRACE(("MOVE %p %d %d\n", pPager, pPg->pgno, pgno))
danielk1977ef73ee92004-11-06 12:26:07 +00005097
danielk1977b4626a32007-04-28 15:47:43 +00005098 pager_get_content(pPg);
danielk197794daf7f2004-11-08 09:26:09 +00005099 if( pPg->needSync ){
5100 needSyncPgno = pPg->pgno;
drh4f0aee42007-06-16 18:39:41 +00005101 assert( pPg->inJournal || (int)pgno>pPager->origDbSize );
danielk197794daf7f2004-11-08 09:26:09 +00005102 assert( pPg->dirty );
danielk1977ae825582004-11-23 09:06:55 +00005103 assert( pPager->needSync );
danielk197794daf7f2004-11-08 09:26:09 +00005104 }
5105
drh85b623f2007-12-13 21:54:09 +00005106 /* Unlink pPg from its hash-chain */
danielk1977f5fdda82004-11-03 08:44:05 +00005107 unlinkHashChain(pPager, pPg);
danielk1977687566d2004-11-02 12:56:41 +00005108
danielk1977ef73ee92004-11-06 12:26:07 +00005109 /* If the cache contains a page with page-number pgno, remove it
drh85b623f2007-12-13 21:54:09 +00005110 ** from its hash chain. Also, if the PgHdr.needSync was set for
danielk1977599fcba2004-11-08 07:13:13 +00005111 ** page pgno before the 'move' operation, it needs to be retained
5112 ** for the page moved there.
danielk1977f5fdda82004-11-03 08:44:05 +00005113 */
drh5e385312007-06-16 04:42:12 +00005114 pPg->needSync = 0;
danielk1977687566d2004-11-02 12:56:41 +00005115 pPgOld = pager_lookup(pPager, pgno);
5116 if( pPgOld ){
danielk1977f5fdda82004-11-03 08:44:05 +00005117 assert( pPgOld->nRef==0 );
5118 unlinkHashChain(pPager, pPgOld);
drh605ad8f2006-05-03 23:34:05 +00005119 makeClean(pPgOld);
drh5e385312007-06-16 04:42:12 +00005120 pPg->needSync = pPgOld->needSync;
5121 }else{
5122 pPg->needSync = 0;
5123 }
drhf5e7bb52008-02-18 14:47:33 +00005124 pPg->inJournal = sqlite3BitvecTest(pPager->pInJournal, pgno);
danielk1977687566d2004-11-02 12:56:41 +00005125
danielk1977f5fdda82004-11-03 08:44:05 +00005126 /* Change the page number for pPg and insert it into the new hash-chain. */
drh3765df42006-06-28 18:18:09 +00005127 assert( pgno!=0 );
danielk1977f5fdda82004-11-03 08:44:05 +00005128 pPg->pgno = pgno;
drh8ca0c722006-05-07 17:49:38 +00005129 h = pgno & (pPager->nHash-1);
danielk1977f5fdda82004-11-03 08:44:05 +00005130 if( pPager->aHash[h] ){
5131 assert( pPager->aHash[h]->pPrevHash==0 );
5132 pPager->aHash[h]->pPrevHash = pPg;
5133 }
5134 pPg->pNextHash = pPager->aHash[h];
5135 pPager->aHash[h] = pPg;
5136 pPg->pPrevHash = 0;
5137
drh605ad8f2006-05-03 23:34:05 +00005138 makeDirty(pPg);
danielk1977687566d2004-11-02 12:56:41 +00005139 pPager->dirtyCache = 1;
5140
danielk197794daf7f2004-11-08 09:26:09 +00005141 if( needSyncPgno ){
5142 /* If needSyncPgno is non-zero, then the journal file needs to be
5143 ** sync()ed before any data is written to database file page needSyncPgno.
5144 ** Currently, no such page exists in the page-cache and the
drhf5e7bb52008-02-18 14:47:33 +00005145 ** Pager.pInJournal bit has been set. This needs to be remedied by loading
danielk197794daf7f2004-11-08 09:26:09 +00005146 ** the page into the pager-cache and setting the PgHdr.needSync flag.
danielk1977ae825582004-11-23 09:06:55 +00005147 **
danielk1977a98d7b42008-01-18 13:42:54 +00005148 ** If the attempt to load the page into the page-cache fails, (due
drhf5e7bb52008-02-18 14:47:33 +00005149 ** to a malloc() or IO failure), clear the bit in the pInJournal[]
danielk1977a98d7b42008-01-18 13:42:54 +00005150 ** array. Otherwise, if the page is loaded and written again in
5151 ** this transaction, it may be written to the database file before
5152 ** it is synced into the journal file. This way, it may end up in
5153 ** the journal file twice, but that is not a problem.
5154 **
danielk19773b8a05f2007-03-19 17:44:26 +00005155 ** The sqlite3PagerGet() call may cause the journal to sync. So make
danielk1977ae825582004-11-23 09:06:55 +00005156 ** sure the Pager.needSync flag is set too.
danielk197794daf7f2004-11-08 09:26:09 +00005157 */
5158 int rc;
danielk19773b8a05f2007-03-19 17:44:26 +00005159 PgHdr *pPgHdr;
danielk1977ae825582004-11-23 09:06:55 +00005160 assert( pPager->needSync );
danielk19773b8a05f2007-03-19 17:44:26 +00005161 rc = sqlite3PagerGet(pPager, needSyncPgno, &pPgHdr);
danielk197787c29a92008-01-18 11:33:16 +00005162 if( rc!=SQLITE_OK ){
drhf5e7bb52008-02-18 14:47:33 +00005163 if( pPager->pInJournal && (int)needSyncPgno<=pPager->origDbSize ){
5164 sqlite3BitvecClear(pPager->pInJournal, needSyncPgno);
danielk1977a98d7b42008-01-18 13:42:54 +00005165 }
danielk197787c29a92008-01-18 11:33:16 +00005166 pagerLeave(pPager);
5167 return rc;
5168 }
danielk1977ae825582004-11-23 09:06:55 +00005169 pPager->needSync = 1;
danielk19773b8a05f2007-03-19 17:44:26 +00005170 pPgHdr->needSync = 1;
5171 pPgHdr->inJournal = 1;
5172 makeDirty(pPgHdr);
5173 sqlite3PagerUnref(pPgHdr);
danielk197794daf7f2004-11-08 09:26:09 +00005174 }
5175
drh86f8c192007-08-22 00:39:19 +00005176 pagerLeave(pPager);
danielk1977687566d2004-11-02 12:56:41 +00005177 return SQLITE_OK;
5178}
5179#endif
5180
danielk19773b8a05f2007-03-19 17:44:26 +00005181/*
5182** Return a pointer to the data for the specified page.
5183*/
5184void *sqlite3PagerGetData(DbPage *pPg){
5185 return PGHDR_TO_DATA(pPg);
5186}
5187
5188/*
5189** Return a pointer to the Pager.nExtra bytes of "extra" space
5190** allocated along with the specified page.
5191*/
5192void *sqlite3PagerGetExtra(DbPage *pPg){
5193 Pager *pPager = pPg->pPager;
5194 return (pPager?PGHDR_TO_EXTRA(pPg, pPager):0);
5195}
5196
danielk197741483462007-03-24 16:45:04 +00005197/*
5198** Get/set the locking-mode for this pager. Parameter eMode must be one
5199** of PAGER_LOCKINGMODE_QUERY, PAGER_LOCKINGMODE_NORMAL or
5200** PAGER_LOCKINGMODE_EXCLUSIVE. If the parameter is not _QUERY, then
5201** the locking-mode is set to the value specified.
5202**
5203** The returned value is either PAGER_LOCKINGMODE_NORMAL or
5204** PAGER_LOCKINGMODE_EXCLUSIVE, indicating the current (possibly updated)
5205** locking-mode.
5206*/
5207int sqlite3PagerLockingMode(Pager *pPager, int eMode){
drh369339d2007-03-30 16:01:55 +00005208 assert( eMode==PAGER_LOCKINGMODE_QUERY
5209 || eMode==PAGER_LOCKINGMODE_NORMAL
5210 || eMode==PAGER_LOCKINGMODE_EXCLUSIVE );
5211 assert( PAGER_LOCKINGMODE_QUERY<0 );
5212 assert( PAGER_LOCKINGMODE_NORMAL>=0 && PAGER_LOCKINGMODE_EXCLUSIVE>=0 );
5213 if( eMode>=0 && !pPager->tempFile ){
danielk197741483462007-03-24 16:45:04 +00005214 pPager->exclusiveMode = eMode;
5215 }
5216 return (int)pPager->exclusiveMode;
5217}
5218
drhd919fe12007-12-11 19:34:44 +00005219#ifdef SQLITE_TEST
drhdd793422001-06-28 01:54:48 +00005220/*
5221** Print a listing of all referenced pages and their ref count.
5222*/
danielk19773b8a05f2007-03-19 17:44:26 +00005223void sqlite3PagerRefdump(Pager *pPager){
drhdd793422001-06-28 01:54:48 +00005224 PgHdr *pPg;
5225 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
5226 if( pPg->nRef<=0 ) continue;
drhfe63d1c2004-09-08 20:13:04 +00005227 sqlite3DebugPrintf("PAGE %3d addr=%p nRef=%d\n",
5228 pPg->pgno, PGHDR_TO_DATA(pPg), pPg->nRef);
drhdd793422001-06-28 01:54:48 +00005229 }
5230}
5231#endif
drh2e66f0b2005-04-28 17:18:48 +00005232
5233#endif /* SQLITE_OMIT_DISKIO */