blob: 61614a6b7a7035802236640de4f745e093e08f0c [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**
drh334c80d2008-03-28 17:41:13 +000021** @(#) $Id: pager.c,v 1.422 2008/03/28 17:41:14 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.
drhfa86c412002-02-02 15:01:15 +00001505 */
drhae2b40c2004-06-09 19:03:54 +00001506 pPg = pager_lookup(pPager, pgno);
drh477731b2007-06-16 03:06:27 +00001507 PAGERTRACE4("PLAYBACK %d page %d hash(%08x)\n",
1508 PAGERID(pPager), pgno, pager_datahash(pPager->pageSize, aData));
drh96362842005-03-20 22:47:56 +00001509 if( pPager->state>=PAGER_EXCLUSIVE && (pPg==0 || pPg->needSync==0) ){
danielk197762079062007-08-15 17:08:46 +00001510 i64 offset = (pgno-1)*(i64)pPager->pageSize;
1511 rc = sqlite3OsWrite(pPager->fd, aData, pPager->pageSize, offset);
drh605ad8f2006-05-03 23:34:05 +00001512 if( pPg ){
1513 makeClean(pPg);
1514 }
danielk1977a3f3a5f2004-06-10 04:32:16 +00001515 }
drhfa86c412002-02-02 15:01:15 +00001516 if( pPg ){
danielk197728129562005-01-11 10:25:06 +00001517 /* No page should ever be explicitly rolled back that is in use, except
1518 ** for page 1 which is held in use in order to keep the lock on the
1519 ** database active. However such a page may be rolled back as a result
1520 ** of an internal error resulting in an automatic call to
danielk19773b8a05f2007-03-19 17:44:26 +00001521 ** sqlite3PagerRollback().
drhacf4ac92003-12-17 23:57:34 +00001522 */
drhb6f41482004-05-14 01:58:11 +00001523 void *pData;
danielk197728129562005-01-11 10:25:06 +00001524 /* assert( pPg->nRef==0 || pPg->pgno==1 ); */
drhb6f41482004-05-14 01:58:11 +00001525 pData = PGHDR_TO_DATA(pPg);
drhae2b40c2004-06-09 19:03:54 +00001526 memcpy(pData, aData, pPager->pageSize);
danielk19779038bb62007-04-09 11:20:54 +00001527 if( pPager->xReiniter ){
1528 pPager->xReiniter(pPg, pPager->pageSize);
drhde647132004-05-07 17:57:49 +00001529 }
danielk19773c407372005-02-15 02:54:14 +00001530#ifdef SQLITE_CHECK_PAGES
drh96362842005-03-20 22:47:56 +00001531 pPg->pageHash = pager_pagehash(pPg);
danielk19773c407372005-02-15 02:54:14 +00001532#endif
drh86a88112007-04-16 15:02:19 +00001533 /* If this was page 1, then restore the value of Pager.dbFileVers.
1534 ** Do this before any decoding. */
danielk197741483462007-03-24 16:45:04 +00001535 if( pgno==1 ){
drh86a88112007-04-16 15:02:19 +00001536 memcpy(&pPager->dbFileVers, &((u8*)pData)[24],sizeof(pPager->dbFileVers));
danielk197741483462007-03-24 16:45:04 +00001537 }
drh86a88112007-04-16 15:02:19 +00001538
1539 /* Decode the page just read from disk */
1540 CODEC1(pPager, pData, pPg->pgno, 3);
drhfa86c412002-02-02 15:01:15 +00001541 }
1542 return rc;
1543}
1544
1545/*
danielk197713adf8a2004-06-03 16:08:41 +00001546** Parameter zMaster is the name of a master journal file. A single journal
1547** file that referred to the master journal file has just been rolled back.
1548** This routine checks if it is possible to delete the master journal file,
1549** and does so if it is.
drh726de592004-06-10 23:35:50 +00001550**
danielk197765839c62007-08-30 08:08:17 +00001551** Argument zMaster may point to Pager.pTmpSpace. So that buffer is not
1552** available for use within this function.
1553**
1554**
drh726de592004-06-10 23:35:50 +00001555** The master journal file contains the names of all child journals.
1556** To tell if a master journal can be deleted, check to each of the
1557** children. If all children are either missing or do not refer to
1558** a different master journal, then this master journal can be deleted.
danielk197713adf8a2004-06-03 16:08:41 +00001559*/
danielk1977b4b47412007-08-17 15:53:36 +00001560static int pager_delmaster(Pager *pPager, const char *zMaster){
1561 sqlite3_vfs *pVfs = pPager->pVfs;
danielk197713adf8a2004-06-03 16:08:41 +00001562 int rc;
1563 int master_open = 0;
danielk1977b4b47412007-08-17 15:53:36 +00001564 sqlite3_file *pMaster;
1565 sqlite3_file *pJournal;
danielk197713adf8a2004-06-03 16:08:41 +00001566 char *zMasterJournal = 0; /* Contents of master journal file */
drheb206252004-10-01 02:00:31 +00001567 i64 nMasterJournal; /* Size of master journal file */
danielk197713adf8a2004-06-03 16:08:41 +00001568
1569 /* Open the master journal file exclusively in case some other process
1570 ** is running this routine also. Not that it makes too much difference.
1571 */
danielk1977b4b47412007-08-17 15:53:36 +00001572 pMaster = (sqlite3_file *)sqlite3_malloc(pVfs->szOsFile * 2);
danielk1977fee2d252007-08-18 10:59:19 +00001573 pJournal = (sqlite3_file *)(((u8 *)pMaster) + pVfs->szOsFile);
danielk1977b4b47412007-08-17 15:53:36 +00001574 if( !pMaster ){
1575 rc = SQLITE_NOMEM;
1576 }else{
danielk1977fee2d252007-08-18 10:59:19 +00001577 int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MASTER_JOURNAL);
1578 rc = sqlite3OsOpen(pVfs, zMaster, pMaster, flags, 0);
danielk1977b4b47412007-08-17 15:53:36 +00001579 }
danielk197713adf8a2004-06-03 16:08:41 +00001580 if( rc!=SQLITE_OK ) goto delmaster_out;
1581 master_open = 1;
danielk1977b4b47412007-08-17 15:53:36 +00001582
1583 rc = sqlite3OsFileSize(pMaster, &nMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001584 if( rc!=SQLITE_OK ) goto delmaster_out;
1585
1586 if( nMasterJournal>0 ){
danielk19775865e3d2004-06-14 06:03:57 +00001587 char *zJournal;
danielk197776572402004-06-25 02:38:54 +00001588 char *zMasterPtr = 0;
danielk197765839c62007-08-30 08:08:17 +00001589 int nMasterPtr = pPager->pVfs->mxPathname+1;
danielk19775865e3d2004-06-14 06:03:57 +00001590
1591 /* Load the entire master journal file into space obtained from
drh17435752007-08-16 04:30:38 +00001592 ** sqlite3_malloc() and pointed to by zMasterJournal.
danielk19775865e3d2004-06-14 06:03:57 +00001593 */
danielk197765839c62007-08-30 08:08:17 +00001594 zMasterJournal = (char *)sqlite3_malloc(nMasterJournal + nMasterPtr);
danielk197713adf8a2004-06-03 16:08:41 +00001595 if( !zMasterJournal ){
1596 rc = SQLITE_NOMEM;
1597 goto delmaster_out;
1598 }
danielk197765839c62007-08-30 08:08:17 +00001599 zMasterPtr = &zMasterJournal[nMasterJournal];
danielk1977b4b47412007-08-17 15:53:36 +00001600 rc = sqlite3OsRead(pMaster, zMasterJournal, nMasterJournal, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001601 if( rc!=SQLITE_OK ) goto delmaster_out;
1602
danielk19775865e3d2004-06-14 06:03:57 +00001603 zJournal = zMasterJournal;
1604 while( (zJournal-zMasterJournal)<nMasterJournal ){
drh19db9352008-03-27 22:42:51 +00001605 rc = sqlite3OsAccess(pVfs, zJournal, SQLITE_ACCESS_EXISTS);
1606 if( rc!=0 && rc!=1 ){
1607 rc = SQLITE_IOERR_NOMEM;
1608 goto delmaster_out;
1609 }
1610 if( rc==1 ){
danielk197713adf8a2004-06-03 16:08:41 +00001611 /* One of the journals pointed to by the master journal exists.
1612 ** Open it and check if it points at the master journal. If
1613 ** so, return without deleting the master journal file.
1614 */
drh3b7b78b2004-11-24 01:16:43 +00001615 int c;
danielk1977fee2d252007-08-18 10:59:19 +00001616 int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MAIN_JOURNAL);
1617 rc = sqlite3OsOpen(pVfs, zJournal, pJournal, flags, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001618 if( rc!=SQLITE_OK ){
danielk197713adf8a2004-06-03 16:08:41 +00001619 goto delmaster_out;
1620 }
danielk197713adf8a2004-06-03 16:08:41 +00001621
danielk197765839c62007-08-30 08:08:17 +00001622 rc = readMasterJournal(pJournal, zMasterPtr, nMasterPtr);
danielk1977b4b47412007-08-17 15:53:36 +00001623 sqlite3OsClose(pJournal);
danielk19779eed5052004-06-04 10:38:30 +00001624 if( rc!=SQLITE_OK ){
danielk19779eed5052004-06-04 10:38:30 +00001625 goto delmaster_out;
1626 }
danielk197776572402004-06-25 02:38:54 +00001627
danielk197765839c62007-08-30 08:08:17 +00001628 c = zMasterPtr[0]!=0 && strcmp(zMasterPtr, zMaster)==0;
drh3b7b78b2004-11-24 01:16:43 +00001629 if( c ){
danielk197776572402004-06-25 02:38:54 +00001630 /* We have a match. Do not delete the master journal file. */
1631 goto delmaster_out;
danielk197713adf8a2004-06-03 16:08:41 +00001632 }
1633 }
danielk19775865e3d2004-06-14 06:03:57 +00001634 zJournal += (strlen(zJournal)+1);
danielk197713adf8a2004-06-03 16:08:41 +00001635 }
1636 }
1637
danielk1977fee2d252007-08-18 10:59:19 +00001638 rc = sqlite3OsDelete(pVfs, zMaster, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001639
1640delmaster_out:
1641 if( zMasterJournal ){
drh17435752007-08-16 04:30:38 +00001642 sqlite3_free(zMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001643 }
1644 if( master_open ){
danielk1977b4b47412007-08-17 15:53:36 +00001645 sqlite3OsClose(pMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001646 }
danielk1977b4b47412007-08-17 15:53:36 +00001647 sqlite3_free(pMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001648 return rc;
1649}
1650
drha6abd042004-06-09 17:37:22 +00001651
danielk1977e180dd92007-04-05 17:15:52 +00001652static void pager_truncate_cache(Pager *pPager);
1653
drha6abd042004-06-09 17:37:22 +00001654/*
drhcb4c40b2004-08-18 19:09:43 +00001655** Truncate the main file of the given pager to the number of pages
danielk1977e180dd92007-04-05 17:15:52 +00001656** indicated. Also truncate the cached representation of the file.
drh7fe3f7e2007-11-29 18:44:27 +00001657**
1658** Might might be the case that the file on disk is smaller than nPage.
1659** This can happen, for example, if we are in the middle of a transaction
1660** which has extended the file size and the new pages are still all held
1661** in cache, then an INSERT or UPDATE does a statement rollback. Some
1662** operating system implementations can get confused if you try to
1663** truncate a file to some size that is larger than it currently is,
1664** so detect this case and do not do the truncation.
drhcb4c40b2004-08-18 19:09:43 +00001665*/
1666static int pager_truncate(Pager *pPager, int nPage){
danielk1977e180dd92007-04-05 17:15:52 +00001667 int rc = SQLITE_OK;
danielk19777a2b1ee2007-08-21 14:27:01 +00001668 if( pPager->state>=PAGER_EXCLUSIVE && pPager->fd->pMethods ){
drh7fe3f7e2007-11-29 18:44:27 +00001669 i64 currentSize, newSize;
1670 rc = sqlite3OsFileSize(pPager->fd, &currentSize);
1671 newSize = pPager->pageSize*(i64)nPage;
1672 if( rc==SQLITE_OK && currentSize>newSize ){
1673 rc = sqlite3OsTruncate(pPager->fd, newSize);
1674 }
danielk1977e180dd92007-04-05 17:15:52 +00001675 }
1676 if( rc==SQLITE_OK ){
1677 pPager->dbSize = nPage;
1678 pager_truncate_cache(pPager);
1679 }
1680 return rc;
drhcb4c40b2004-08-18 19:09:43 +00001681}
1682
1683/*
drhc80f0582007-05-01 16:59:48 +00001684** Set the sectorSize for the given pager.
1685**
drh334c80d2008-03-28 17:41:13 +00001686** The sector size is at least as big as the sector size reported
1687** by sqlite3OsSectorSize(). The minimum sector size is 512.
drhc80f0582007-05-01 16:59:48 +00001688*/
1689static void setSectorSize(Pager *pPager){
danielk19777a2b1ee2007-08-21 14:27:01 +00001690 assert(pPager->fd->pMethods||pPager->tempFile);
1691 if( !pPager->tempFile ){
1692 /* Sector size doesn't matter for temporary files. Also, the file
1693 ** may not have been opened yet, in whcih case the OsSectorSize()
1694 ** call will segfault.
1695 */
1696 pPager->sectorSize = sqlite3OsSectorSize(pPager->fd);
1697 }
drh334c80d2008-03-28 17:41:13 +00001698 if( pPager->sectorSize<512 ){
1699 pPager->sectorSize = 512;
drhc80f0582007-05-01 16:59:48 +00001700 }
1701}
1702
1703/*
drhed7c8552001-04-11 14:29:21 +00001704** Playback the journal and thus restore the database file to
1705** the state it was in before we started making changes.
1706**
drh34e79ce2004-02-08 06:05:46 +00001707** The journal file format is as follows:
1708**
drhae2b40c2004-06-09 19:03:54 +00001709** (1) 8 byte prefix. A copy of aJournalMagic[].
1710** (2) 4 byte big-endian integer which is the number of valid page records
drh34e79ce2004-02-08 06:05:46 +00001711** in the journal. If this value is 0xffffffff, then compute the
drhae2b40c2004-06-09 19:03:54 +00001712** number of page records from the journal size.
1713** (3) 4 byte big-endian integer which is the initial value for the
1714** sanity checksum.
1715** (4) 4 byte integer which is the number of pages to truncate the
drh34e79ce2004-02-08 06:05:46 +00001716** database to during a rollback.
drh334c80d2008-03-28 17:41:13 +00001717** (5) 4 byte big-endian integer which is the sector size. The header
1718** is this many bytes in size.
1719** (6) 4 byte big-endian integer which is the page case.
1720** (7) 4 byte integer which is the number of bytes in the master journal
drhae2b40c2004-06-09 19:03:54 +00001721** name. The value may be zero (indicate that there is no master
1722** journal.)
drh334c80d2008-03-28 17:41:13 +00001723** (8) N bytes of the master journal name. The name will be nul-terminated
drhae2b40c2004-06-09 19:03:54 +00001724** and might be shorter than the value read from (5). If the first byte
1725** of the name is \000 then there is no master journal. The master
1726** journal name is stored in UTF-8.
drh334c80d2008-03-28 17:41:13 +00001727** (9) Zero or more pages instances, each as follows:
drh34e79ce2004-02-08 06:05:46 +00001728** + 4 byte page number.
drhae2b40c2004-06-09 19:03:54 +00001729** + pPager->pageSize bytes of data.
1730** + 4 byte checksum
drh34e79ce2004-02-08 06:05:46 +00001731**
drh334c80d2008-03-28 17:41:13 +00001732** When we speak of the journal header, we mean the first 8 items above.
1733** Each entry in the journal is an instance of the 9th item.
drh34e79ce2004-02-08 06:05:46 +00001734**
1735** Call the value from the second bullet "nRec". nRec is the number of
1736** valid page entries in the journal. In most cases, you can compute the
1737** value of nRec from the size of the journal file. But if a power
1738** failure occurred while the journal was being written, it could be the
1739** case that the size of the journal file had already been increased but
1740** the extra entries had not yet made it safely to disk. In such a case,
1741** the value of nRec computed from the file size would be too large. For
1742** that reason, we always use the nRec value in the header.
1743**
1744** If the nRec value is 0xffffffff it means that nRec should be computed
1745** from the file size. This value is used when the user selects the
1746** no-sync option for the journal. A power failure could lead to corruption
1747** in this case. But for things like temporary table (which will be
1748** deleted when the power is restored) we don't care.
1749**
drhd9b02572001-04-15 00:37:09 +00001750** If the file opened as the journal file is not a well-formed
danielk1977ece80f12004-06-23 01:05:26 +00001751** journal file then all pages up to the first corrupted page are rolled
1752** back (or no pages if the journal header is corrupted). The journal file
1753** is then deleted and SQLITE_OK returned, just as if no corruption had
1754** been encountered.
1755**
1756** If an I/O or malloc() error occurs, the journal-file is not deleted
1757** and an error code is returned.
drhed7c8552001-04-11 14:29:21 +00001758*/
danielk1977e277be02007-03-23 18:12:06 +00001759static int pager_playback(Pager *pPager, int isHot){
danielk1977b4b47412007-08-17 15:53:36 +00001760 sqlite3_vfs *pVfs = pPager->pVfs;
drheb206252004-10-01 02:00:31 +00001761 i64 szJ; /* Size of the journal file in bytes */
danielk1977c3e8f5e2004-06-28 01:16:46 +00001762 u32 nRec; /* Number of Records in the journal */
drhd9b02572001-04-15 00:37:09 +00001763 int i; /* Loop counter */
1764 Pgno mxPg = 0; /* Size of the original file in pages */
drhae2b40c2004-06-09 19:03:54 +00001765 int rc; /* Result code of a subroutine */
danielk197713adf8a2004-06-03 16:08:41 +00001766 char *zMaster = 0; /* Name of master journal file if any */
drhed7c8552001-04-11 14:29:21 +00001767
drhc3a64ba2001-11-22 00:01:27 +00001768 /* Figure out how many records are in the journal. Abort early if
1769 ** the journal is empty.
drhed7c8552001-04-11 14:29:21 +00001770 */
drh8cfbf082001-09-19 13:22:39 +00001771 assert( pPager->journalOpen );
drh054889e2005-11-30 03:20:31 +00001772 rc = sqlite3OsFileSize(pPager->jfd, &szJ);
danielk1977334cdb62007-03-26 08:05:12 +00001773 if( rc!=SQLITE_OK || szJ==0 ){
drhc3a64ba2001-11-22 00:01:27 +00001774 goto end_playback;
1775 }
drh240c5792004-02-08 00:40:52 +00001776
danielk197776572402004-06-25 02:38:54 +00001777 /* Read the master journal name from the journal, if it is present.
1778 ** If a master journal file name is specified, but the file is not
1779 ** present on disk, then the journal is not hot and does not need to be
1780 ** played back.
drh240c5792004-02-08 00:40:52 +00001781 */
danielk197765839c62007-08-30 08:08:17 +00001782 zMaster = pPager->pTmpSpace;
1783 rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1);
danielk1977b4b47412007-08-17 15:53:36 +00001784 if( rc!=SQLITE_OK
drh19db9352008-03-27 22:42:51 +00001785 || (zMaster[0] && sqlite3OsAccess(pVfs, zMaster, SQLITE_ACCESS_EXISTS)==0 )
danielk1977b4b47412007-08-17 15:53:36 +00001786 ){
danielk197776572402004-06-25 02:38:54 +00001787 zMaster = 0;
drhc3a64ba2001-11-22 00:01:27 +00001788 goto end_playback;
1789 }
danielk197776572402004-06-25 02:38:54 +00001790 pPager->journalOff = 0;
danielk197765839c62007-08-30 08:08:17 +00001791 zMaster = 0;
drhc3a64ba2001-11-22 00:01:27 +00001792
danielk197776572402004-06-25 02:38:54 +00001793 /* This loop terminates either when the readJournalHdr() call returns
1794 ** SQLITE_DONE or an IO error occurs. */
1795 while( 1 ){
drhae2b40c2004-06-09 19:03:54 +00001796
danielk197776572402004-06-25 02:38:54 +00001797 /* Read the next journal header from the journal file. If there are
1798 ** not enough bytes left in the journal file for a complete header, or
1799 ** it is corrupted, then a process must of failed while writing it.
1800 ** This indicates nothing more needs to be rolled back.
1801 */
1802 rc = readJournalHdr(pPager, szJ, &nRec, &mxPg);
1803 if( rc!=SQLITE_OK ){
drh968af522003-02-11 14:55:40 +00001804 if( rc==SQLITE_DONE ){
drh968af522003-02-11 14:55:40 +00001805 rc = SQLITE_OK;
1806 }
danielk197776572402004-06-25 02:38:54 +00001807 goto end_playback;
1808 }
1809
1810 /* If nRec is 0xffffffff, then this journal was created by a process
1811 ** working in no-sync mode. This means that the rest of the journal
1812 ** file consists of pages, there are no more journal headers. Compute
1813 ** the value of nRec based on this assumption.
1814 */
1815 if( nRec==0xffffffff ){
1816 assert( pPager->journalOff==JOURNAL_HDR_SZ(pPager) );
1817 nRec = (szJ - JOURNAL_HDR_SZ(pPager))/JOURNAL_PG_SZ(pPager);
1818 }
1819
danielk1977e277be02007-03-23 18:12:06 +00001820 /* If nRec is 0 and this rollback is of a transaction created by this
drh8940f4e2007-08-11 00:26:20 +00001821 ** process and if this is the final header in the journal, then it means
1822 ** that this part of the journal was being filled but has not yet been
1823 ** synced to disk. Compute the number of pages based on the remaining
1824 ** size of the file.
1825 **
1826 ** The third term of the test was added to fix ticket #2565.
danielk1977e277be02007-03-23 18:12:06 +00001827 */
drh8940f4e2007-08-11 00:26:20 +00001828 if( nRec==0 && !isHot &&
1829 pPager->journalHdr+JOURNAL_HDR_SZ(pPager)==pPager->journalOff ){
danielk1977e277be02007-03-23 18:12:06 +00001830 nRec = (szJ - pPager->journalOff) / JOURNAL_PG_SZ(pPager);
1831 }
1832
danielk197776572402004-06-25 02:38:54 +00001833 /* If this is the first header read from the journal, truncate the
drh85b623f2007-12-13 21:54:09 +00001834 ** database file back to its original size.
danielk197776572402004-06-25 02:38:54 +00001835 */
danielk1977e180dd92007-04-05 17:15:52 +00001836 if( pPager->journalOff==JOURNAL_HDR_SZ(pPager) ){
drhcb4c40b2004-08-18 19:09:43 +00001837 rc = pager_truncate(pPager, mxPg);
danielk197776572402004-06-25 02:38:54 +00001838 if( rc!=SQLITE_OK ){
1839 goto end_playback;
1840 }
danielk197776572402004-06-25 02:38:54 +00001841 }
1842
danielk197776572402004-06-25 02:38:54 +00001843 /* Copy original pages out of the journal and back into the database file.
1844 */
1845 for(i=0; i<nRec; i++){
danielk197762079062007-08-15 17:08:46 +00001846 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001847 if( rc!=SQLITE_OK ){
1848 if( rc==SQLITE_DONE ){
1849 rc = SQLITE_OK;
1850 pPager->journalOff = szJ;
1851 break;
1852 }else{
1853 goto end_playback;
1854 }
1855 }
drh968af522003-02-11 14:55:40 +00001856 }
drhed7c8552001-04-11 14:29:21 +00001857 }
drh580eeaf2006-02-24 03:09:37 +00001858 /*NOTREACHED*/
1859 assert( 0 );
drh4a0681e2003-02-13 01:58:20 +00001860
1861end_playback:
danielk19778191bff2004-06-28 04:52:30 +00001862 if( rc==SQLITE_OK ){
danielk197765839c62007-08-30 08:08:17 +00001863 zMaster = pPager->pTmpSpace;
1864 rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1);
1865 }
1866 if( rc==SQLITE_OK ){
drh80e35f42007-03-30 14:06:34 +00001867 rc = pager_end_transaction(pPager);
danielk19778191bff2004-06-28 04:52:30 +00001868 }
danielk197765839c62007-08-30 08:08:17 +00001869 if( rc==SQLITE_OK && zMaster[0] ){
danielk1977979f38e2007-03-27 16:19:51 +00001870 /* If there was a master journal and this routine will return success,
danielk197732554c12005-01-22 03:39:39 +00001871 ** see if it is possible to delete the master journal.
danielk197713adf8a2004-06-03 16:08:41 +00001872 */
danielk197765839c62007-08-30 08:08:17 +00001873 rc = pager_delmaster(pPager, zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001874 }
danielk197776572402004-06-25 02:38:54 +00001875
1876 /* The Pager.sectorSize variable may have been updated while rolling
drh3ceeb752007-03-29 18:19:52 +00001877 ** back a journal created by a process with a different sector size
danielk197776572402004-06-25 02:38:54 +00001878 ** value. Reset it to the correct value for this process.
1879 */
drhc80f0582007-05-01 16:59:48 +00001880 setSectorSize(pPager);
drhd9b02572001-04-15 00:37:09 +00001881 return rc;
drhed7c8552001-04-11 14:29:21 +00001882}
1883
1884/*
drhac69b052004-05-12 13:30:07 +00001885** Playback the statement journal.
drhfa86c412002-02-02 15:01:15 +00001886**
1887** This is similar to playing back the transaction journal but with
1888** a few extra twists.
1889**
drh663fc632002-02-02 18:49:19 +00001890** (1) The number of pages in the database file at the start of
drhac69b052004-05-12 13:30:07 +00001891** the statement is stored in pPager->stmtSize, not in the
drh663fc632002-02-02 18:49:19 +00001892** journal file itself.
drhfa86c412002-02-02 15:01:15 +00001893**
drhac69b052004-05-12 13:30:07 +00001894** (2) In addition to playing back the statement journal, also
drhfa86c412002-02-02 15:01:15 +00001895** playback all pages of the transaction journal beginning
drhac69b052004-05-12 13:30:07 +00001896** at offset pPager->stmtJSize.
drhfa86c412002-02-02 15:01:15 +00001897*/
drh3aac2dd2004-04-26 14:10:20 +00001898static int pager_stmt_playback(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001899 i64 szJ; /* Size of the full journal */
1900 i64 hdrOff;
drh968af522003-02-11 14:55:40 +00001901 int nRec; /* Number of Records */
drhfa86c412002-02-02 15:01:15 +00001902 int i; /* Loop counter */
1903 int rc;
1904
danielk197776572402004-06-25 02:38:54 +00001905 szJ = pPager->journalOff;
1906#ifndef NDEBUG
1907 {
drheb206252004-10-01 02:00:31 +00001908 i64 os_szJ;
drh054889e2005-11-30 03:20:31 +00001909 rc = sqlite3OsFileSize(pPager->jfd, &os_szJ);
danielk197776572402004-06-25 02:38:54 +00001910 if( rc!=SQLITE_OK ) return rc;
1911 assert( szJ==os_szJ );
1912 }
1913#endif
1914
danielk19774099f6e2007-03-19 11:25:20 +00001915 /* Set hdrOff to be the offset just after the end of the last journal
1916 ** page written before the first journal-header for this statement
1917 ** transaction was written, or the end of the file if no journal
danielk197776572402004-06-25 02:38:54 +00001918 ** header was written.
1919 */
1920 hdrOff = pPager->stmtHdrOff;
1921 assert( pPager->fullSync || !hdrOff );
1922 if( !hdrOff ){
1923 hdrOff = szJ;
1924 }
1925
drhfa86c412002-02-02 15:01:15 +00001926 /* Truncate the database back to its original size.
1927 */
danielk1977e180dd92007-04-05 17:15:52 +00001928 rc = pager_truncate(pPager, pPager->stmtSize);
drh1aa2d8b2007-01-03 15:34:29 +00001929 assert( pPager->state>=PAGER_SHARED );
drhfa86c412002-02-02 15:01:15 +00001930
drhac69b052004-05-12 13:30:07 +00001931 /* Figure out how many records are in the statement journal.
drhfa86c412002-02-02 15:01:15 +00001932 */
drhac69b052004-05-12 13:30:07 +00001933 assert( pPager->stmtInUse && pPager->journalOpen );
drhac69b052004-05-12 13:30:07 +00001934 nRec = pPager->stmtNRec;
drhfa86c412002-02-02 15:01:15 +00001935
drhac69b052004-05-12 13:30:07 +00001936 /* Copy original pages out of the statement journal and back into the
drhae2b40c2004-06-09 19:03:54 +00001937 ** database file. Note that the statement journal omits checksums from
1938 ** each record since power-failure recovery is not important to statement
1939 ** journals.
drhfa86c412002-02-02 15:01:15 +00001940 */
danielk197762079062007-08-15 17:08:46 +00001941 for(i=0; i<nRec; i++){
1942 i64 offset = i*(4+pPager->pageSize);
1943 rc = pager_playback_one_page(pPager, pPager->stfd, offset, 0);
drh968af522003-02-11 14:55:40 +00001944 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001945 if( rc!=SQLITE_OK ) goto end_stmt_playback;
drhfa86c412002-02-02 15:01:15 +00001946 }
1947
danielk197776572402004-06-25 02:38:54 +00001948 /* Now roll some pages back from the transaction journal. Pager.stmtJSize
1949 ** was the size of the journal file when this statement was started, so
1950 ** everything after that needs to be rolled back, either into the
1951 ** database, the memory cache, or both.
1952 **
1953 ** If it is not zero, then Pager.stmtHdrOff is the offset to the start
1954 ** of the first journal header written during this statement transaction.
drhfa86c412002-02-02 15:01:15 +00001955 */
danielk197776572402004-06-25 02:38:54 +00001956 pPager->journalOff = pPager->stmtJSize;
danielk197775edc162004-06-26 01:48:18 +00001957 pPager->cksumInit = pPager->stmtCksum;
danielk19774099f6e2007-03-19 11:25:20 +00001958 while( pPager->journalOff < hdrOff ){
danielk197762079062007-08-15 17:08:46 +00001959 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001960 assert( rc!=SQLITE_DONE );
1961 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1962 }
1963
1964 while( pPager->journalOff < szJ ){
danielk1977f0113002006-01-24 12:09:17 +00001965 u32 nJRec; /* Number of Journal Records */
danielk197776572402004-06-25 02:38:54 +00001966 u32 dummy;
danielk1977f0113002006-01-24 12:09:17 +00001967 rc = readJournalHdr(pPager, szJ, &nJRec, &dummy);
drh968af522003-02-11 14:55:40 +00001968 if( rc!=SQLITE_OK ){
1969 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001970 goto end_stmt_playback;
drh968af522003-02-11 14:55:40 +00001971 }
danielk1977f0113002006-01-24 12:09:17 +00001972 if( nJRec==0 ){
1973 nJRec = (szJ - pPager->journalOff) / (pPager->pageSize+8);
danielk197775edc162004-06-26 01:48:18 +00001974 }
danielk1977f0113002006-01-24 12:09:17 +00001975 for(i=nJRec-1; i>=0 && pPager->journalOff < szJ; i--){
danielk197762079062007-08-15 17:08:46 +00001976 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001977 assert( rc!=SQLITE_DONE );
1978 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1979 }
drhfa86c412002-02-02 15:01:15 +00001980 }
danielk197776572402004-06-25 02:38:54 +00001981
1982 pPager->journalOff = szJ;
drhfa86c412002-02-02 15:01:15 +00001983
drh3aac2dd2004-04-26 14:10:20 +00001984end_stmt_playback:
danielk19778a7aea32006-01-23 15:25:48 +00001985 if( rc==SQLITE_OK) {
danielk197775edc162004-06-26 01:48:18 +00001986 pPager->journalOff = szJ;
1987 /* pager_reload_cache(pPager); */
drhfa86c412002-02-02 15:01:15 +00001988 }
1989 return rc;
1990}
1991
1992/*
drhf57b14a2001-09-14 18:54:08 +00001993** Change the maximum number of in-memory pages that are allowed.
1994*/
danielk19773b8a05f2007-03-19 17:44:26 +00001995void sqlite3PagerSetCachesize(Pager *pPager, int mxPage){
drhf57b14a2001-09-14 18:54:08 +00001996 if( mxPage>10 ){
1997 pPager->mxPage = mxPage;
danielk1977ef317ab2004-06-23 10:43:10 +00001998 }else{
1999 pPager->mxPage = 10;
drhf57b14a2001-09-14 18:54:08 +00002000 }
2001}
2002
2003/*
drh973b6e32003-02-12 14:09:42 +00002004** Adjust the robustness of the database to damage due to OS crashes
2005** or power failures by changing the number of syncs()s when writing
2006** the rollback journal. There are three levels:
2007**
drh054889e2005-11-30 03:20:31 +00002008** OFF sqlite3OsSync() is never called. This is the default
drh973b6e32003-02-12 14:09:42 +00002009** for temporary and transient files.
2010**
2011** NORMAL The journal is synced once before writes begin on the
2012** database. This is normally adequate protection, but
2013** it is theoretically possible, though very unlikely,
2014** that an inopertune power failure could leave the journal
2015** in a state which would cause damage to the database
2016** when it is rolled back.
2017**
2018** FULL The journal is synced twice before writes begin on the
drh34e79ce2004-02-08 06:05:46 +00002019** database (with some additional information - the nRec field
2020** of the journal header - being written in between the two
2021** syncs). If we assume that writing a
drh973b6e32003-02-12 14:09:42 +00002022** single disk sector is atomic, then this mode provides
2023** assurance that the journal will not be corrupted to the
2024** point of causing damage to the database during rollback.
2025**
2026** Numeric values associated with these states are OFF==1, NORMAL=2,
2027** and FULL=3.
2028*/
danielk197793758c82005-01-21 08:13:14 +00002029#ifndef SQLITE_OMIT_PAGER_PRAGMAS
danielk19773b8a05f2007-03-19 17:44:26 +00002030void sqlite3PagerSetSafetyLevel(Pager *pPager, int level, int full_fsync){
drh973b6e32003-02-12 14:09:42 +00002031 pPager->noSync = level==1 || pPager->tempFile;
2032 pPager->fullSync = level==3 && !pPager->tempFile;
danielk1977f036aef2007-08-20 05:36:51 +00002033 pPager->sync_flags = (full_fsync?SQLITE_SYNC_FULL:SQLITE_SYNC_NORMAL);
danielk19771d850a72004-05-31 08:26:49 +00002034 if( pPager->noSync ) pPager->needSync = 0;
drh973b6e32003-02-12 14:09:42 +00002035}
danielk197793758c82005-01-21 08:13:14 +00002036#endif
drh973b6e32003-02-12 14:09:42 +00002037
2038/*
drhaf6df112005-06-07 02:12:30 +00002039** The following global variable is incremented whenever the library
2040** attempts to open a temporary file. This information is used for
2041** testing and analysis only.
2042*/
drh0f7eb612006-08-08 13:51:43 +00002043#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00002044int sqlite3_opentemp_count = 0;
drh0f7eb612006-08-08 13:51:43 +00002045#endif
drhaf6df112005-06-07 02:12:30 +00002046
2047/*
drh3f56e6e2007-03-15 01:16:47 +00002048** Open a temporary file.
2049**
2050** Write the file descriptor into *fd. Return SQLITE_OK on success or some
danielk1977fee2d252007-08-18 10:59:19 +00002051** other error code if we fail. The OS will automatically delete the temporary
2052** file when it is closed.
drhfa86c412002-02-02 15:01:15 +00002053*/
danielk1977b4b47412007-08-17 15:53:36 +00002054static int sqlite3PagerOpentemp(
drh33f4e022007-09-03 15:19:34 +00002055 sqlite3_vfs *pVfs, /* The virtual file system layer */
2056 sqlite3_file *pFile, /* Write the file descriptor here */
2057 char *zFilename, /* Name of the file. Might be NULL */
2058 int vfsFlags /* Flags passed through to the VFS */
danielk1977b4b47412007-08-17 15:53:36 +00002059){
drhfa86c412002-02-02 15:01:15 +00002060 int rc;
drh334b2992007-09-06 23:28:23 +00002061 assert( zFilename!=0 );
drh3f56e6e2007-03-15 01:16:47 +00002062
drh0f7eb612006-08-08 13:51:43 +00002063#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00002064 sqlite3_opentemp_count++; /* Used for testing and analysis only */
drh0f7eb612006-08-08 13:51:43 +00002065#endif
danielk1977b4b47412007-08-17 15:53:36 +00002066
drh33f4e022007-09-03 15:19:34 +00002067 vfsFlags |= SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE |
2068 SQLITE_OPEN_EXCLUSIVE | SQLITE_OPEN_DELETEONCLOSE;
2069 rc = sqlite3OsOpen(pVfs, zFilename, pFile, vfsFlags, 0);
drhae28c012007-08-24 16:29:23 +00002070 assert( rc!=SQLITE_OK || pFile->pMethods );
drhfa86c412002-02-02 15:01:15 +00002071 return rc;
2072}
2073
2074/*
drhed7c8552001-04-11 14:29:21 +00002075** Create a new page cache and put a pointer to the page cache in *ppPager.
drh5e00f6c2001-09-13 13:46:56 +00002076** The file to be cached need not exist. The file is not locked until
danielk19773b8a05f2007-03-19 17:44:26 +00002077** the first call to sqlite3PagerGet() and is only held open until the
2078** last page is released using sqlite3PagerUnref().
drh382c0242001-10-06 16:33:02 +00002079**
drh6446c4d2001-12-15 14:22:18 +00002080** If zFilename is NULL then a randomly-named temporary file is created
drh1cc8c442007-08-24 16:08:29 +00002081** and used as the file to be cached. The file will be deleted
drh6446c4d2001-12-15 14:22:18 +00002082** automatically when it is closed.
drh90f5ecb2004-07-22 01:19:35 +00002083**
2084** If zFilename is ":memory:" then all information is held in cache.
2085** It is never written to disk. This can be used to implement an
2086** in-memory database.
drhed7c8552001-04-11 14:29:21 +00002087*/
danielk19773b8a05f2007-03-19 17:44:26 +00002088int sqlite3PagerOpen(
drh86f8c192007-08-22 00:39:19 +00002089 sqlite3_vfs *pVfs, /* The virtual file system to use */
drh7e3b0a02001-04-28 16:52:40 +00002090 Pager **ppPager, /* Return the Pager structure here */
2091 const char *zFilename, /* Name of the database file to open */
drhda47d772002-12-02 04:25:19 +00002092 int nExtra, /* Extra bytes append to each in-memory page */
drh33f4e022007-09-03 15:19:34 +00002093 int flags, /* flags controlling this file */
2094 int vfsFlags /* flags passed through to sqlite3_vfs.xOpen() */
drh7e3b0a02001-04-28 16:52:40 +00002095){
danielk1977b4b47412007-08-17 15:53:36 +00002096 u8 *pPtr;
danielk1977aef0bf62005-12-30 16:28:01 +00002097 Pager *pPager = 0;
danielk1977cfe9a692004-06-16 12:00:29 +00002098 int rc = SQLITE_OK;
2099 int i;
danielk19778def5ea2004-06-16 10:39:52 +00002100 int tempFile = 0;
drhac69b052004-05-12 13:30:07 +00002101 int memDb = 0;
drh5e00f6c2001-09-13 13:46:56 +00002102 int readOnly = 0;
drh7bec5052005-02-06 02:45:41 +00002103 int useJournal = (flags & PAGER_OMIT_JOURNAL)==0;
2104 int noReadlock = (flags & PAGER_NO_READLOCK)!=0;
danielk1977c7b60172007-08-22 11:22:03 +00002105 int journalFileSize = sqlite3JournalSize(pVfs);
drh1cc8c442007-08-24 16:08:29 +00002106 int nDefaultPage = SQLITE_DEFAULT_PAGE_SIZE;
2107 char *zPathname;
2108 int nPathname;
drh99b90c32008-03-17 13:50:58 +00002109 char *zStmtJrnl;
2110 int nStmtJrnl;
danielk1977b4b47412007-08-17 15:53:36 +00002111
drh86f8c192007-08-22 00:39:19 +00002112 /* The default return is a NULL pointer */
drhd9b02572001-04-15 00:37:09 +00002113 *ppPager = 0;
danielk1977aef0bf62005-12-30 16:28:01 +00002114
drh1cc8c442007-08-24 16:08:29 +00002115 /* Compute the full pathname */
danielk1977adfb9b02007-09-17 07:02:56 +00002116 nPathname = pVfs->mxPathname+1;
drh99b90c32008-03-17 13:50:58 +00002117 zPathname = sqlite3_malloc(nPathname*2);
drh1cc8c442007-08-24 16:08:29 +00002118 if( zPathname==0 ){
2119 return SQLITE_NOMEM;
2120 }
2121 if( zFilename && zFilename[0] ){
2122#ifndef SQLITE_OMIT_MEMORYDB
2123 if( strcmp(zFilename,":memory:")==0 ){
2124 memDb = 1;
2125 zPathname[0] = 0;
2126 }else
2127#endif
2128 {
danielk1977adfb9b02007-09-17 07:02:56 +00002129 rc = sqlite3OsFullPathname(pVfs, zFilename, nPathname, zPathname);
drh1cc8c442007-08-24 16:08:29 +00002130 }
2131 }else{
danielk1977adfb9b02007-09-17 07:02:56 +00002132 rc = sqlite3OsGetTempname(pVfs, nPathname, zPathname);
drhae28c012007-08-24 16:29:23 +00002133 }
2134 if( rc!=SQLITE_OK ){
2135 sqlite3_free(zPathname);
2136 return rc;
drh1cc8c442007-08-24 16:08:29 +00002137 }
2138 nPathname = strlen(zPathname);
2139
drh99b90c32008-03-17 13:50:58 +00002140 /* Put the statement journal in temporary disk space since this is
2141 ** sometimes RAM disk or other optimized storage. Unlikely the main
2142 ** main journal file, the statement journal does not need to be
2143 ** colocated with the database nor does it need to be persistent.
2144 */
2145 zStmtJrnl = &zPathname[nPathname+1];
2146 rc = sqlite3OsGetTempname(pVfs, pVfs->mxPathname+1, zStmtJrnl);
2147 if( rc!=SQLITE_OK ){
2148 sqlite3_free(zPathname);
2149 return rc;
2150 }
2151 nStmtJrnl = strlen(zStmtJrnl);
2152
danielk1977b4b47412007-08-17 15:53:36 +00002153 /* Allocate memory for the pager structure */
2154 pPager = sqlite3MallocZero(
2155 sizeof(*pPager) + /* Pager structure */
danielk1977c7b60172007-08-22 11:22:03 +00002156 journalFileSize + /* The journal file structure */
drh17c0ba22008-02-26 18:40:11 +00002157 pVfs->szOsFile * 3 + /* The main db and two journal files */
drh99b90c32008-03-17 13:50:58 +00002158 3*nPathname + 40 + /* zFilename, zDirectory, zJournal */
2159 nStmtJrnl /* zStmtJrnl */
danielk1977b4b47412007-08-17 15:53:36 +00002160 );
2161 if( !pPager ){
drh1cc8c442007-08-24 16:08:29 +00002162 sqlite3_free(zPathname);
danielk1977b4b47412007-08-17 15:53:36 +00002163 return SQLITE_NOMEM;
2164 }
2165 pPtr = (u8 *)&pPager[1];
drh33f4e022007-09-03 15:19:34 +00002166 pPager->vfsFlags = vfsFlags;
danielk1977b4b47412007-08-17 15:53:36 +00002167 pPager->fd = (sqlite3_file*)&pPtr[pVfs->szOsFile*0];
danielk1977c7b60172007-08-22 11:22:03 +00002168 pPager->stfd = (sqlite3_file*)&pPtr[pVfs->szOsFile*1];
2169 pPager->jfd = (sqlite3_file*)&pPtr[pVfs->szOsFile*2];
2170 pPager->zFilename = (char*)&pPtr[pVfs->szOsFile*2+journalFileSize];
drh1cc8c442007-08-24 16:08:29 +00002171 pPager->zDirectory = &pPager->zFilename[nPathname+1];
2172 pPager->zJournal = &pPager->zDirectory[nPathname+1];
drh334b2992007-09-06 23:28:23 +00002173 pPager->zStmtJrnl = &pPager->zJournal[nPathname+10];
danielk1977b4b47412007-08-17 15:53:36 +00002174 pPager->pVfs = pVfs;
drh1cc8c442007-08-24 16:08:29 +00002175 memcpy(pPager->zFilename, zPathname, nPathname+1);
drh99b90c32008-03-17 13:50:58 +00002176 memcpy(pPager->zStmtJrnl, zStmtJrnl, nStmtJrnl+1);
drh1cc8c442007-08-24 16:08:29 +00002177 sqlite3_free(zPathname);
danielk1977b4b47412007-08-17 15:53:36 +00002178
drh153c62c2007-08-24 03:51:33 +00002179 /* Open the pager file.
danielk1977aef0bf62005-12-30 16:28:01 +00002180 */
drhae28c012007-08-24 16:29:23 +00002181 if( zFilename && zFilename[0] && !memDb ){
drh1cc8c442007-08-24 16:08:29 +00002182 if( nPathname>(pVfs->mxPathname - sizeof("-journal")) ){
2183 rc = SQLITE_CANTOPEN;
2184 }else{
drh1cc8c442007-08-24 16:08:29 +00002185 int fout = 0;
drh33f4e022007-09-03 15:19:34 +00002186 rc = sqlite3OsOpen(pVfs, pPager->zFilename, pPager->fd,
2187 pPager->vfsFlags, &fout);
drh1cc8c442007-08-24 16:08:29 +00002188 readOnly = (fout&SQLITE_OPEN_READONLY);
2189
2190 /* If the file was successfully opened for read/write access,
2191 ** choose a default page size in case we have to create the
2192 ** database file. The default page size is the maximum of:
2193 **
2194 ** + SQLITE_DEFAULT_PAGE_SIZE,
2195 ** + The value returned by sqlite3OsSectorSize()
2196 ** + The largest page size that can be written atomically.
2197 */
2198 if( rc==SQLITE_OK && !readOnly ){
2199 int iSectorSize = sqlite3OsSectorSize(pPager->fd);
2200 if( nDefaultPage<iSectorSize ){
2201 nDefaultPage = iSectorSize;
2202 }
danielk19779663b8f2007-08-24 11:52:28 +00002203#ifdef SQLITE_ENABLE_ATOMIC_WRITE
drh1cc8c442007-08-24 16:08:29 +00002204 {
2205 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
2206 int ii;
2207 assert(SQLITE_IOCAP_ATOMIC512==(512>>8));
2208 assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8));
2209 assert(SQLITE_MAX_DEFAULT_PAGE_SIZE<=65536);
2210 for(ii=nDefaultPage; ii<=SQLITE_MAX_DEFAULT_PAGE_SIZE; ii=ii*2){
2211 if( iDc&(SQLITE_IOCAP_ATOMIC|(ii>>8)) ) nDefaultPage = ii;
danielk19779663b8f2007-08-24 11:52:28 +00002212 }
danielk1977b4b47412007-08-17 15:53:36 +00002213 }
drh1cc8c442007-08-24 16:08:29 +00002214#endif
2215 if( nDefaultPage>SQLITE_MAX_DEFAULT_PAGE_SIZE ){
2216 nDefaultPage = SQLITE_MAX_DEFAULT_PAGE_SIZE;
2217 }
danielk19778def5ea2004-06-16 10:39:52 +00002218 }
drhac69b052004-05-12 13:30:07 +00002219 }
drh1cc8c442007-08-24 16:08:29 +00002220 }else if( !memDb ){
danielk19777a2b1ee2007-08-21 14:27:01 +00002221 /* If a temporary file is requested, it is not opened immediately.
2222 ** In this case we accept the default page size and delay actually
2223 ** opening the file until the first call to OsWrite().
2224 */
danielk19777a2b1ee2007-08-21 14:27:01 +00002225 tempFile = 1;
2226 pPager->state = PAGER_EXCLUSIVE;
drh5e00f6c2001-09-13 13:46:56 +00002227 }
danielk1977aef0bf62005-12-30 16:28:01 +00002228
danielk1977b4b47412007-08-17 15:53:36 +00002229 if( pPager && rc==SQLITE_OK ){
danielk19779663b8f2007-08-24 11:52:28 +00002230 pPager->pTmpSpace = (char *)sqlite3_malloc(nDefaultPage);
drh3e7a6092002-12-07 21:45:14 +00002231 }
danielk1977aef0bf62005-12-30 16:28:01 +00002232
drh153c62c2007-08-24 03:51:33 +00002233 /* If an error occured in either of the blocks above.
2234 ** Free the Pager structure and close the file.
2235 ** Since the pager is not allocated there is no need to set
danielk1977aef0bf62005-12-30 16:28:01 +00002236 ** any Pager.errMask variables.
2237 */
danielk1977b4b47412007-08-17 15:53:36 +00002238 if( !pPager || !pPager->pTmpSpace ){
2239 sqlite3OsClose(pPager->fd);
drh17435752007-08-16 04:30:38 +00002240 sqlite3_free(pPager);
danielk1977aef0bf62005-12-30 16:28:01 +00002241 return ((rc==SQLITE_OK)?SQLITE_NOMEM:rc);
drhed7c8552001-04-11 14:29:21 +00002242 }
danielk1977aef0bf62005-12-30 16:28:01 +00002243
drh153c62c2007-08-24 03:51:33 +00002244 PAGERTRACE3("OPEN %d %s\n", FILEHANDLEID(pPager->fd), pPager->zFilename);
2245 IOTRACE(("OPEN %p %s\n", pPager, pPager->zFilename))
danielk1977aef0bf62005-12-30 16:28:01 +00002246
danielk1977b4b47412007-08-17 15:53:36 +00002247 /* Fill in Pager.zDirectory[] */
drh1cc8c442007-08-24 16:08:29 +00002248 memcpy(pPager->zDirectory, pPager->zFilename, nPathname+1);
danielk1977b4b47412007-08-17 15:53:36 +00002249 for(i=strlen(pPager->zDirectory); i>0 && pPager->zDirectory[i-1]!='/'; i--){}
drha76c82e2003-07-27 18:59:42 +00002250 if( i>0 ) pPager->zDirectory[i-1] = 0;
danielk1977b4b47412007-08-17 15:53:36 +00002251
drh99b90c32008-03-17 13:50:58 +00002252 /* Fill in Pager.zJournal[] */
drh1cc8c442007-08-24 16:08:29 +00002253 memcpy(pPager->zJournal, pPager->zFilename, nPathname);
2254 memcpy(&pPager->zJournal[nPathname], "-journal", 9);
danielk1977b4b47412007-08-17 15:53:36 +00002255
drh3b59a5c2006-01-15 20:28:28 +00002256 /* pPager->journalOpen = 0; */
drhac69b052004-05-12 13:30:07 +00002257 pPager->useJournal = useJournal && !memDb;
drh7bec5052005-02-06 02:45:41 +00002258 pPager->noReadlock = noReadlock && readOnly;
drh3b59a5c2006-01-15 20:28:28 +00002259 /* pPager->stmtOpen = 0; */
2260 /* pPager->stmtInUse = 0; */
2261 /* pPager->nRef = 0; */
drhac69b052004-05-12 13:30:07 +00002262 pPager->dbSize = memDb-1;
danielk19779663b8f2007-08-24 11:52:28 +00002263 pPager->pageSize = nDefaultPage;
drh3b59a5c2006-01-15 20:28:28 +00002264 /* pPager->stmtSize = 0; */
2265 /* pPager->stmtJSize = 0; */
2266 /* pPager->nPage = 0; */
drh90f5ecb2004-07-22 01:19:35 +00002267 pPager->mxPage = 100;
drhf8e632b2007-05-08 14:51:36 +00002268 pPager->mxPgno = SQLITE_MAX_PAGE_COUNT;
drh3b59a5c2006-01-15 20:28:28 +00002269 /* pPager->state = PAGER_UNLOCK; */
drh1cc8c442007-08-24 16:08:29 +00002270 assert( pPager->state == (tempFile ? PAGER_EXCLUSIVE : PAGER_UNLOCK) );
drh3b59a5c2006-01-15 20:28:28 +00002271 /* pPager->errMask = 0; */
drh5e00f6c2001-09-13 13:46:56 +00002272 pPager->tempFile = tempFile;
drh369339d2007-03-30 16:01:55 +00002273 assert( tempFile==PAGER_LOCKINGMODE_NORMAL
2274 || tempFile==PAGER_LOCKINGMODE_EXCLUSIVE );
2275 assert( PAGER_LOCKINGMODE_EXCLUSIVE==1 );
2276 pPager->exclusiveMode = tempFile;
drhac69b052004-05-12 13:30:07 +00002277 pPager->memDb = memDb;
drh5e00f6c2001-09-13 13:46:56 +00002278 pPager->readOnly = readOnly;
drh3b59a5c2006-01-15 20:28:28 +00002279 /* pPager->needSync = 0; */
drhda47d772002-12-02 04:25:19 +00002280 pPager->noSync = pPager->tempFile || !useJournal;
danielk197775edc162004-06-26 01:48:18 +00002281 pPager->fullSync = (pPager->noSync?0:1);
danielk1977f036aef2007-08-20 05:36:51 +00002282 pPager->sync_flags = SQLITE_SYNC_NORMAL;
drh3b59a5c2006-01-15 20:28:28 +00002283 /* pPager->pFirst = 0; */
2284 /* pPager->pFirstSynced = 0; */
2285 /* pPager->pLast = 0; */
drh887dc4c2004-10-22 16:22:57 +00002286 pPager->nExtra = FORCE_ALIGNMENT(nExtra);
danielk19777a2b1ee2007-08-21 14:27:01 +00002287 assert(pPager->fd->pMethods||memDb||tempFile);
danielk1977b4721172007-03-19 05:54:48 +00002288 if( !memDb ){
drhc80f0582007-05-01 16:59:48 +00002289 setSectorSize(pPager);
danielk1977b4721172007-03-19 05:54:48 +00002290 }
drh3b59a5c2006-01-15 20:28:28 +00002291 /* pPager->pBusyHandler = 0; */
2292 /* memset(pPager->aHash, 0, sizeof(pPager->aHash)); */
drhed7c8552001-04-11 14:29:21 +00002293 *ppPager = pPager;
drh6f7adc82006-01-11 21:41:20 +00002294#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
drh86f8c192007-08-22 00:39:19 +00002295 pPager->iInUseMM = 0;
2296 pPager->iInUseDB = 0;
2297 if( !memDb ){
2298 sqlite3_mutex *mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MEM2);
2299 sqlite3_mutex_enter(mutex);
2300 pPager->pNext = sqlite3PagerList;
2301 if( sqlite3PagerList ){
2302 assert( sqlite3PagerList->pPrev==0 );
2303 sqlite3PagerList->pPrev = pPager;
2304 }
2305 pPager->pPrev = 0;
2306 sqlite3PagerList = pPager;
2307 sqlite3_mutex_leave(mutex);
2308 }
danielk197752622822006-01-09 09:59:49 +00002309#endif
drhed7c8552001-04-11 14:29:21 +00002310 return SQLITE_OK;
2311}
2312
2313/*
drh90f5ecb2004-07-22 01:19:35 +00002314** Set the busy handler function.
2315*/
danielk19773b8a05f2007-03-19 17:44:26 +00002316void sqlite3PagerSetBusyhandler(Pager *pPager, BusyHandler *pBusyHandler){
drh90f5ecb2004-07-22 01:19:35 +00002317 pPager->pBusyHandler = pBusyHandler;
2318}
2319
2320/*
drh72f82862001-05-24 21:06:34 +00002321** Set the destructor for this pager. If not NULL, the destructor is called
drh5e00f6c2001-09-13 13:46:56 +00002322** when the reference count on each page reaches zero. The destructor can
2323** be used to clean up information in the extra segment appended to each page.
drh72f82862001-05-24 21:06:34 +00002324**
danielk19773b8a05f2007-03-19 17:44:26 +00002325** The destructor is not called as a result sqlite3PagerClose().
2326** Destructors are only called by sqlite3PagerUnref().
drh72f82862001-05-24 21:06:34 +00002327*/
danielk19773b8a05f2007-03-19 17:44:26 +00002328void sqlite3PagerSetDestructor(Pager *pPager, void (*xDesc)(DbPage*,int)){
drh72f82862001-05-24 21:06:34 +00002329 pPager->xDestructor = xDesc;
2330}
2331
2332/*
drha6abd042004-06-09 17:37:22 +00002333** Set the reinitializer for this pager. If not NULL, the reinitializer
2334** is called when the content of a page in cache is restored to its original
2335** value as a result of a rollback. The callback gives higher-level code
2336** an opportunity to restore the EXTRA section to agree with the restored
2337** page data.
2338*/
danielk19773b8a05f2007-03-19 17:44:26 +00002339void sqlite3PagerSetReiniter(Pager *pPager, void (*xReinit)(DbPage*,int)){
drha6abd042004-06-09 17:37:22 +00002340 pPager->xReiniter = xReinit;
2341}
2342
2343/*
danielk1977a1644fd2007-08-29 12:31:25 +00002344** Set the page size to *pPageSize. If the suggest new page size is
2345** inappropriate, then an alternative page size is set to that
2346** value before returning.
drh90f5ecb2004-07-22 01:19:35 +00002347*/
danielk1977a1644fd2007-08-29 12:31:25 +00002348int sqlite3PagerSetPagesize(Pager *pPager, u16 *pPageSize){
2349 int rc = SQLITE_OK;
2350 u16 pageSize = *pPageSize;
danielk19779663b8f2007-08-24 11:52:28 +00002351 assert( pageSize==0 || (pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE) );
danielk1977a1644fd2007-08-29 12:31:25 +00002352 if( pageSize && pageSize!=pPager->pageSize
2353 && !pPager->memDb && pPager->nRef==0
2354 ){
2355 char *pNew = (char *)sqlite3_malloc(pageSize);
2356 if( !pNew ){
2357 rc = SQLITE_NOMEM;
2358 }else{
2359 pagerEnter(pPager);
2360 pager_reset(pPager);
2361 pPager->pageSize = pageSize;
2362 setSectorSize(pPager);
2363 sqlite3_free(pPager->pTmpSpace);
2364 pPager->pTmpSpace = pNew;
2365 pagerLeave(pPager);
2366 }
drh1c7880e2005-05-20 20:01:55 +00002367 }
danielk1977a1644fd2007-08-29 12:31:25 +00002368 *pPageSize = pPager->pageSize;
2369 return rc;
drh90f5ecb2004-07-22 01:19:35 +00002370}
2371
2372/*
drh26b79942007-11-28 16:19:56 +00002373** Return a pointer to the "temporary page" buffer held internally
2374** by the pager. This is a buffer that is big enough to hold the
2375** entire content of a database page. This buffer is used internally
2376** during rollback and will be overwritten whenever a rollback
2377** occurs. But other modules are free to use it too, as long as
2378** no rollbacks are happening.
2379*/
2380void *sqlite3PagerTempSpace(Pager *pPager){
2381 return pPager->pTmpSpace;
2382}
2383
2384/*
drhf8e632b2007-05-08 14:51:36 +00002385** Attempt to set the maximum database page count if mxPage is positive.
2386** Make no changes if mxPage is zero or negative. And never reduce the
2387** maximum page count below the current size of the database.
2388**
2389** Regardless of mxPage, return the current maximum page count.
2390*/
2391int sqlite3PagerMaxPageCount(Pager *pPager, int mxPage){
2392 if( mxPage>0 ){
2393 pPager->mxPgno = mxPage;
2394 }
2395 sqlite3PagerPagecount(pPager);
2396 return pPager->mxPgno;
2397}
2398
2399/*
drhc9ac5ca2005-11-04 22:03:30 +00002400** The following set of routines are used to disable the simulated
2401** I/O error mechanism. These routines are used to avoid simulated
2402** errors in places where we do not care about errors.
2403**
2404** Unless -DSQLITE_TEST=1 is used, these routines are all no-ops
2405** and generate no code.
2406*/
2407#ifdef SQLITE_TEST
2408extern int sqlite3_io_error_pending;
2409extern int sqlite3_io_error_hit;
2410static int saved_cnt;
drhc9ac5ca2005-11-04 22:03:30 +00002411void disable_simulated_io_errors(void){
2412 saved_cnt = sqlite3_io_error_pending;
2413 sqlite3_io_error_pending = -1;
2414}
2415void enable_simulated_io_errors(void){
2416 sqlite3_io_error_pending = saved_cnt;
2417}
2418#else
drh152410f2005-11-05 15:11:22 +00002419# define disable_simulated_io_errors()
2420# define enable_simulated_io_errors()
drhc9ac5ca2005-11-04 22:03:30 +00002421#endif
2422
2423/*
drh90f5ecb2004-07-22 01:19:35 +00002424** Read the first N bytes from the beginning of the file into memory
danielk1977aef0bf62005-12-30 16:28:01 +00002425** that pDest points to.
2426**
2427** No error checking is done. The rational for this is that this function
2428** may be called even if the file does not exist or contain a header. In
2429** these cases sqlite3OsRead() will return an error, to which the correct
2430** response is to zero the memory at pDest and continue. A real IO error
2431** will presumably recur and be picked up later (Todo: Think about this).
drh90f5ecb2004-07-22 01:19:35 +00002432*/
danielk19773b8a05f2007-03-19 17:44:26 +00002433int sqlite3PagerReadFileheader(Pager *pPager, int N, unsigned char *pDest){
drh551b7732006-11-06 21:20:25 +00002434 int rc = SQLITE_OK;
drh90f5ecb2004-07-22 01:19:35 +00002435 memset(pDest, 0, N);
danielk19777a2b1ee2007-08-21 14:27:01 +00002436 assert(MEMDB||pPager->fd->pMethods||pPager->tempFile);
2437 if( pPager->fd->pMethods ){
drhb0603412007-02-28 04:47:26 +00002438 IOTRACE(("DBHDR %p 0 %d\n", pPager, N))
danielk197762079062007-08-15 17:08:46 +00002439 rc = sqlite3OsRead(pPager->fd, pDest, N, 0);
drh551b7732006-11-06 21:20:25 +00002440 if( rc==SQLITE_IOERR_SHORT_READ ){
2441 rc = SQLITE_OK;
2442 }
drh90f5ecb2004-07-22 01:19:35 +00002443 }
drh551b7732006-11-06 21:20:25 +00002444 return rc;
drh90f5ecb2004-07-22 01:19:35 +00002445}
2446
2447/*
drh5e00f6c2001-09-13 13:46:56 +00002448** Return the total number of pages in the disk file associated with
danielk197715f411d2005-09-16 10:18:45 +00002449** pPager.
2450**
2451** If the PENDING_BYTE lies on the page directly after the end of the
2452** file, then consider this page part of the file too. For example, if
2453** PENDING_BYTE is byte 4096 (the first byte of page 5) and the size of the
2454** file is 4096 bytes, 5 is returned instead of 4.
drhed7c8552001-04-11 14:29:21 +00002455*/
danielk19773b8a05f2007-03-19 17:44:26 +00002456int sqlite3PagerPagecount(Pager *pPager){
danielk19777a2b1ee2007-08-21 14:27:01 +00002457 i64 n = 0;
drhe49f9822006-09-15 12:29:16 +00002458 int rc;
drhd9b02572001-04-15 00:37:09 +00002459 assert( pPager!=0 );
drha7aea3d2007-03-15 12:51:16 +00002460 if( pPager->errCode ){
danielk197743468d92008-02-26 06:05:31 +00002461 return -1;
drha7aea3d2007-03-15 12:51:16 +00002462 }
drhed7c8552001-04-11 14:29:21 +00002463 if( pPager->dbSize>=0 ){
danielk197715f411d2005-09-16 10:18:45 +00002464 n = pPager->dbSize;
2465 } else {
danielk19777a2b1ee2007-08-21 14:27:01 +00002466 assert(pPager->fd->pMethods||pPager->tempFile);
2467 if( (pPager->fd->pMethods)
2468 && (rc = sqlite3OsFileSize(pPager->fd, &n))!=SQLITE_OK ){
danielk1977ae72d982007-10-03 08:46:44 +00002469 pPager->nRef++;
drhe49f9822006-09-15 12:29:16 +00002470 pager_error(pPager, rc);
danielk1977ae72d982007-10-03 08:46:44 +00002471 pPager->nRef--;
danielk197743468d92008-02-26 06:05:31 +00002472 return -1;
danielk197715f411d2005-09-16 10:18:45 +00002473 }
2474 if( n>0 && n<pPager->pageSize ){
2475 n = 1;
2476 }else{
2477 n /= pPager->pageSize;
2478 }
2479 if( pPager->state!=PAGER_UNLOCK ){
2480 pPager->dbSize = n;
2481 }
drhed7c8552001-04-11 14:29:21 +00002482 }
danielk197715f411d2005-09-16 10:18:45 +00002483 if( n==(PENDING_BYTE/pPager->pageSize) ){
drh1f595712004-06-15 01:40:29 +00002484 n++;
2485 }
drhf8e632b2007-05-08 14:51:36 +00002486 if( n>pPager->mxPgno ){
2487 pPager->mxPgno = n;
2488 }
drhed7c8552001-04-11 14:29:21 +00002489 return n;
2490}
2491
drhf07e7d52006-04-07 13:54:46 +00002492
2493#ifndef SQLITE_OMIT_MEMORYDB
2494/*
2495** Clear a PgHistory block
2496*/
2497static void clearHistory(PgHistory *pHist){
drh17435752007-08-16 04:30:38 +00002498 sqlite3_free(pHist->pOrig);
2499 sqlite3_free(pHist->pStmt);
drhf07e7d52006-04-07 13:54:46 +00002500 pHist->pOrig = 0;
2501 pHist->pStmt = 0;
2502}
2503#else
2504#define clearHistory(x)
2505#endif
2506
drhed7c8552001-04-11 14:29:21 +00002507/*
drhf7c57532003-04-25 13:22:51 +00002508** Forward declaration
2509*/
danielk197776572402004-06-25 02:38:54 +00002510static int syncJournal(Pager*);
drhac69b052004-05-12 13:30:07 +00002511
2512/*
drh85b623f2007-12-13 21:54:09 +00002513** Unlink pPg from its hash chain. Also set the page number to 0 to indicate
danielk1977f5fdda82004-11-03 08:44:05 +00002514** that the page is not part of any hash chain. This is required because the
danielk19773b8a05f2007-03-19 17:44:26 +00002515** sqlite3PagerMovepage() routine can leave a page in the
danielk1977f5fdda82004-11-03 08:44:05 +00002516** pNextFree/pPrevFree list that is not a part of any hash-chain.
2517*/
2518static void unlinkHashChain(Pager *pPager, PgHdr *pPg){
2519 if( pPg->pgno==0 ){
drh3765df42006-06-28 18:18:09 +00002520 assert( pPg->pNextHash==0 && pPg->pPrevHash==0 );
danielk1977f5fdda82004-11-03 08:44:05 +00002521 return;
2522 }
2523 if( pPg->pNextHash ){
2524 pPg->pNextHash->pPrevHash = pPg->pPrevHash;
2525 }
2526 if( pPg->pPrevHash ){
drh8ca0c722006-05-07 17:49:38 +00002527 assert( pPager->aHash[pPg->pgno & (pPager->nHash-1)]!=pPg );
danielk1977f5fdda82004-11-03 08:44:05 +00002528 pPg->pPrevHash->pNextHash = pPg->pNextHash;
2529 }else{
drh8ca0c722006-05-07 17:49:38 +00002530 int h = pPg->pgno & (pPager->nHash-1);
danielk1977f5fdda82004-11-03 08:44:05 +00002531 pPager->aHash[h] = pPg->pNextHash;
2532 }
drh5229ae42006-03-23 23:29:04 +00002533 if( MEMDB ){
drh5229ae42006-03-23 23:29:04 +00002534 clearHistory(PGHDR_TO_HIST(pPg, pPager));
2535 }
danielk1977f5fdda82004-11-03 08:44:05 +00002536 pPg->pgno = 0;
2537 pPg->pNextHash = pPg->pPrevHash = 0;
2538}
2539
2540/*
drhac69b052004-05-12 13:30:07 +00002541** Unlink a page from the free list (the list of all pages where nRef==0)
2542** and from its hash collision chain.
2543*/
2544static void unlinkPage(PgHdr *pPg){
2545 Pager *pPager = pPg->pPager;
2546
danielk19779f61c2f2007-08-27 17:27:49 +00002547 /* Unlink from free page list */
2548 lruListRemove(pPg);
drhac69b052004-05-12 13:30:07 +00002549
2550 /* Unlink from the pgno hash table */
danielk1977f5fdda82004-11-03 08:44:05 +00002551 unlinkHashChain(pPager, pPg);
drhac69b052004-05-12 13:30:07 +00002552}
2553
2554/*
danielk1977e180dd92007-04-05 17:15:52 +00002555** This routine is used to truncate the cache when a database
2556** is truncated. Drop from the cache all pages whose pgno is
2557** larger than pPager->dbSize and is unreferenced.
2558**
drhac69b052004-05-12 13:30:07 +00002559** Referenced pages larger than pPager->dbSize are zeroed.
danielk1977e180dd92007-04-05 17:15:52 +00002560**
2561** Actually, at the point this routine is called, it would be
2562** an error to have a referenced page. But rather than delete
2563** that page and guarantee a subsequent segfault, it seems better
2564** to zero it and hope that we error out sanely.
drhac69b052004-05-12 13:30:07 +00002565*/
danielk1977e180dd92007-04-05 17:15:52 +00002566static void pager_truncate_cache(Pager *pPager){
drhac69b052004-05-12 13:30:07 +00002567 PgHdr *pPg;
2568 PgHdr **ppPg;
2569 int dbSize = pPager->dbSize;
2570
2571 ppPg = &pPager->pAll;
2572 while( (pPg = *ppPg)!=0 ){
2573 if( pPg->pgno<=dbSize ){
2574 ppPg = &pPg->pNextAll;
2575 }else if( pPg->nRef>0 ){
2576 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
2577 ppPg = &pPg->pNextAll;
2578 }else{
2579 *ppPg = pPg->pNextAll;
drh538f5702007-04-13 02:14:30 +00002580 IOTRACE(("PGFREE %p %d\n", pPager, pPg->pgno));
2581 PAGER_INCR(sqlite3_pager_pgfree_count);
drhac69b052004-05-12 13:30:07 +00002582 unlinkPage(pPg);
drh605ad8f2006-05-03 23:34:05 +00002583 makeClean(pPg);
drh0d180202008-02-14 23:26:56 +00002584 sqlite3_free(pPg->pData);
drh17435752007-08-16 04:30:38 +00002585 sqlite3_free(pPg);
drhac69b052004-05-12 13:30:07 +00002586 pPager->nPage--;
2587 }
2588 }
2589}
2590
drhf7c57532003-04-25 13:22:51 +00002591/*
danielk197717221812005-02-15 03:38:05 +00002592** Try to obtain a lock on a file. Invoke the busy callback if the lock
drha4afb652005-07-09 02:16:02 +00002593** is currently not available. Repeat until the busy callback returns
danielk197717221812005-02-15 03:38:05 +00002594** false or until the lock succeeds.
2595**
2596** Return SQLITE_OK on success and an error code if we cannot obtain
2597** the lock.
2598*/
2599static int pager_wait_on_lock(Pager *pPager, int locktype){
2600 int rc;
drh1aa2d8b2007-01-03 15:34:29 +00002601
2602 /* The OS lock values must be the same as the Pager lock values */
danielk197717221812005-02-15 03:38:05 +00002603 assert( PAGER_SHARED==SHARED_LOCK );
2604 assert( PAGER_RESERVED==RESERVED_LOCK );
2605 assert( PAGER_EXCLUSIVE==EXCLUSIVE_LOCK );
drh1aa2d8b2007-01-03 15:34:29 +00002606
2607 /* If the file is currently unlocked then the size must be unknown */
2608 assert( pPager->state>=PAGER_SHARED || pPager->dbSize<0 || MEMDB );
2609
danielk197717221812005-02-15 03:38:05 +00002610 if( pPager->state>=locktype ){
2611 rc = SQLITE_OK;
2612 }else{
drhbefdf832008-03-14 19:33:05 +00002613 if( pPager->pBusyHandler ) pPager->pBusyHandler->nBusy = 0;
danielk197717221812005-02-15 03:38:05 +00002614 do {
drh054889e2005-11-30 03:20:31 +00002615 rc = sqlite3OsLock(pPager->fd, locktype);
drha4afb652005-07-09 02:16:02 +00002616 }while( rc==SQLITE_BUSY && sqlite3InvokeBusyHandler(pPager->pBusyHandler) );
danielk197717221812005-02-15 03:38:05 +00002617 if( rc==SQLITE_OK ){
2618 pPager->state = locktype;
drhb0603412007-02-28 04:47:26 +00002619 IOTRACE(("LOCK %p %d\n", pPager, locktype))
danielk197717221812005-02-15 03:38:05 +00002620 }
2621 }
2622 return rc;
2623}
2624
2625/*
drhf7c57532003-04-25 13:22:51 +00002626** Truncate the file to the number of pages specified.
2627*/
danielk19773b8a05f2007-03-19 17:44:26 +00002628int sqlite3PagerTruncate(Pager *pPager, Pgno nPage){
drhf7c57532003-04-25 13:22:51 +00002629 int rc;
drh1aa2d8b2007-01-03 15:34:29 +00002630 assert( pPager->state>=PAGER_SHARED || MEMDB );
danielk19773b8a05f2007-03-19 17:44:26 +00002631 sqlite3PagerPagecount(pPager);
danielk1977efaaf572006-01-16 11:29:19 +00002632 if( pPager->errCode ){
2633 rc = pPager->errCode;
drh2e6d11b2003-04-25 15:37:57 +00002634 return rc;
2635 }
drh7d02cb72003-06-04 16:24:39 +00002636 if( nPage>=(unsigned)pPager->dbSize ){
drhf7c57532003-04-25 13:22:51 +00002637 return SQLITE_OK;
2638 }
drhb7f91642004-10-31 02:22:47 +00002639 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00002640 pPager->dbSize = nPage;
danielk1977e180dd92007-04-05 17:15:52 +00002641 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00002642 return SQLITE_OK;
2643 }
drh86f8c192007-08-22 00:39:19 +00002644 pagerEnter(pPager);
danielk197776572402004-06-25 02:38:54 +00002645 rc = syncJournal(pPager);
drh86f8c192007-08-22 00:39:19 +00002646 pagerLeave(pPager);
danielk1977369f27e2004-06-15 11:40:04 +00002647 if( rc!=SQLITE_OK ){
2648 return rc;
2649 }
danielk197717221812005-02-15 03:38:05 +00002650
2651 /* Get an exclusive lock on the database before truncating. */
drh86f8c192007-08-22 00:39:19 +00002652 pagerEnter(pPager);
danielk197717221812005-02-15 03:38:05 +00002653 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
drh86f8c192007-08-22 00:39:19 +00002654 pagerLeave(pPager);
danielk197717221812005-02-15 03:38:05 +00002655 if( rc!=SQLITE_OK ){
2656 return rc;
2657 }
2658
drhcb4c40b2004-08-18 19:09:43 +00002659 rc = pager_truncate(pPager, nPage);
drhf7c57532003-04-25 13:22:51 +00002660 return rc;
2661}
2662
2663/*
drhed7c8552001-04-11 14:29:21 +00002664** Shutdown the page cache. Free all memory and close all files.
2665**
2666** If a transaction was in progress when this routine is called, that
2667** transaction is rolled back. All outstanding pages are invalidated
2668** and their memory is freed. Any attempt to use a page associated
2669** with this page cache after this function returns will likely
2670** result in a coredump.
danielk1977aef0bf62005-12-30 16:28:01 +00002671**
2672** This function always succeeds. If a transaction is active an attempt
2673** is made to roll it back. If an error occurs during the rollback
2674** a hot journal may be left in the filesystem but no error is returned
2675** to the caller.
drhed7c8552001-04-11 14:29:21 +00002676*/
danielk19773b8a05f2007-03-19 17:44:26 +00002677int sqlite3PagerClose(Pager *pPager){
drh6f7adc82006-01-11 21:41:20 +00002678#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
drh86f8c192007-08-22 00:39:19 +00002679 if( !MEMDB ){
2680 sqlite3_mutex *mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MEM2);
2681 sqlite3_mutex_enter(mutex);
2682 if( pPager->pPrev ){
2683 pPager->pPrev->pNext = pPager->pNext;
2684 }else{
2685 sqlite3PagerList = pPager->pNext;
2686 }
2687 if( pPager->pNext ){
2688 pPager->pNext->pPrev = pPager->pPrev;
2689 }
2690 sqlite3_mutex_leave(mutex);
2691 }
danielk197713f72992005-12-18 08:51:22 +00002692#endif
2693
drhbafda092007-01-03 23:36:22 +00002694 disable_simulated_io_errors();
drhc2ee76c2007-01-04 14:58:14 +00002695 pPager->errCode = 0;
danielk197741483462007-03-24 16:45:04 +00002696 pPager->exclusiveMode = 0;
drhbafda092007-01-03 23:36:22 +00002697 pager_reset(pPager);
danielk1977e277be02007-03-23 18:12:06 +00002698 pagerUnlockAndRollback(pPager);
drhbafda092007-01-03 23:36:22 +00002699 enable_simulated_io_errors();
drh4f0c5872007-03-26 22:05:01 +00002700 PAGERTRACE2("CLOSE %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002701 IOTRACE(("CLOSE %p\n", pPager))
danielk1977efaaf572006-01-16 11:29:19 +00002702 assert( pPager->errCode || (pPager->journalOpen==0 && pPager->stmtOpen==0) );
danielk1977e94ddc92005-03-21 03:53:38 +00002703 if( pPager->journalOpen ){
danielk1977b4b47412007-08-17 15:53:36 +00002704 sqlite3OsClose(pPager->jfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002705 }
drhf5e7bb52008-02-18 14:47:33 +00002706 sqlite3BitvecDestroy(pPager->pInJournal);
danielk1977e94ddc92005-03-21 03:53:38 +00002707 if( pPager->stmtOpen ){
danielk1977b4b47412007-08-17 15:53:36 +00002708 sqlite3OsClose(pPager->stfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002709 }
danielk1977b4b47412007-08-17 15:53:36 +00002710 sqlite3OsClose(pPager->fd);
drh0f892532002-05-30 12:27:03 +00002711 /* Temp files are automatically deleted by the OS
2712 ** if( pPager->tempFile ){
drh66560ad2006-01-06 14:32:19 +00002713 ** sqlite3OsDelete(pPager->zFilename);
drh0f892532002-05-30 12:27:03 +00002714 ** }
2715 */
danielk1977aca790a2005-01-13 11:07:52 +00002716
drh17435752007-08-16 04:30:38 +00002717 sqlite3_free(pPager->aHash);
2718 sqlite3_free(pPager->pTmpSpace);
2719 sqlite3_free(pPager);
drhed7c8552001-04-11 14:29:21 +00002720 return SQLITE_OK;
2721}
2722
drh87cc3b32007-05-08 21:45:27 +00002723#if !defined(NDEBUG) || defined(SQLITE_TEST)
drhed7c8552001-04-11 14:29:21 +00002724/*
drh5e00f6c2001-09-13 13:46:56 +00002725** Return the page number for the given page data.
drhed7c8552001-04-11 14:29:21 +00002726*/
danielk19773b8a05f2007-03-19 17:44:26 +00002727Pgno sqlite3PagerPagenumber(DbPage *p){
drhed7c8552001-04-11 14:29:21 +00002728 return p->pgno;
2729}
drh87cc3b32007-05-08 21:45:27 +00002730#endif
drhed7c8552001-04-11 14:29:21 +00002731
2732/*
drhc8629a12004-05-08 20:07:40 +00002733** The page_ref() function increments the reference count for a page.
2734** If the page is currently on the freelist (the reference count is zero) then
drh7e3b0a02001-04-28 16:52:40 +00002735** remove it from the freelist.
drhc8629a12004-05-08 20:07:40 +00002736**
2737** For non-test systems, page_ref() is a macro that calls _page_ref()
2738** online of the reference count is zero. For test systems, page_ref()
2739** is a real function so that we can set breakpoints and trace it.
drh7e3b0a02001-04-28 16:52:40 +00002740*/
drh836faa42003-01-11 13:30:57 +00002741static void _page_ref(PgHdr *pPg){
drh7e3b0a02001-04-28 16:52:40 +00002742 if( pPg->nRef==0 ){
2743 /* The page is currently on the freelist. Remove it. */
danielk19779f61c2f2007-08-27 17:27:49 +00002744 lruListRemove(pPg);
drh7e3b0a02001-04-28 16:52:40 +00002745 pPg->pPager->nRef++;
2746 }
2747 pPg->nRef++;
drhdf0b3b02001-06-23 11:36:20 +00002748}
danielk1977aca790a2005-01-13 11:07:52 +00002749#ifdef SQLITE_DEBUG
drhc8629a12004-05-08 20:07:40 +00002750 static void page_ref(PgHdr *pPg){
2751 if( pPg->nRef==0 ){
2752 _page_ref(pPg);
2753 }else{
2754 pPg->nRef++;
drhc8629a12004-05-08 20:07:40 +00002755 }
2756 }
2757#else
2758# define page_ref(P) ((P)->nRef==0?_page_ref(P):(void)(P)->nRef++)
2759#endif
drhdf0b3b02001-06-23 11:36:20 +00002760
2761/*
2762** Increment the reference count for a page. The input pointer is
2763** a reference to the page data.
2764*/
danielk19773b8a05f2007-03-19 17:44:26 +00002765int sqlite3PagerRef(DbPage *pPg){
drh86f8c192007-08-22 00:39:19 +00002766 pagerEnter(pPg->pPager);
drhdf0b3b02001-06-23 11:36:20 +00002767 page_ref(pPg);
drh86f8c192007-08-22 00:39:19 +00002768 pagerLeave(pPg->pPager);
drh8c42ca92001-06-22 19:15:00 +00002769 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +00002770}
2771
2772/*
drh34e79ce2004-02-08 06:05:46 +00002773** Sync the journal. In other words, make sure all the pages that have
2774** been written to the journal have actually reached the surface of the
2775** disk. It is not safe to modify the original database file until after
2776** the journal has been synced. If the original database is modified before
2777** the journal is synced and a power failure occurs, the unsynced journal
2778** data would be lost and we would be unable to completely rollback the
2779** database changes. Database corruption would occur.
2780**
2781** This routine also updates the nRec field in the header of the journal.
2782** (See comments on the pager_playback() routine for additional information.)
2783** If the sync mode is FULL, two syncs will occur. First the whole journal
2784** is synced, then the nRec field is updated, then a second sync occurs.
drhb19a2bc2001-09-16 00:13:26 +00002785**
drh34e79ce2004-02-08 06:05:46 +00002786** For temporary databases, we do not care if we are able to rollback
danielk19774cd2cd52007-08-23 14:48:23 +00002787** after a power failure, so no sync occurs.
2788**
2789** If the IOCAP_SEQUENTIAL flag is set for the persistent media on which
2790** the database is stored, then OsSync() is never called on the journal
2791** file. In this case all that is required is to update the nRec field in
2792** the journal header.
drhfa86c412002-02-02 15:01:15 +00002793**
drh34e79ce2004-02-08 06:05:46 +00002794** This routine clears the needSync field of every page current held in
2795** memory.
drh50e5dad2001-09-15 00:57:28 +00002796*/
danielk197776572402004-06-25 02:38:54 +00002797static int syncJournal(Pager *pPager){
drh50e5dad2001-09-15 00:57:28 +00002798 PgHdr *pPg;
2799 int rc = SQLITE_OK;
drh03eb96a2002-11-10 23:32:56 +00002800
danielk19774cd2cd52007-08-23 14:48:23 +00002801
drh03eb96a2002-11-10 23:32:56 +00002802 /* Sync the journal before modifying the main database
2803 ** (assuming there is a journal and it needs to be synced.)
2804 */
danielk197776572402004-06-25 02:38:54 +00002805 if( pPager->needSync ){
drhfa86c412002-02-02 15:01:15 +00002806 if( !pPager->tempFile ){
danielk19774cd2cd52007-08-23 14:48:23 +00002807 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
drhdb48ee02003-01-16 13:42:43 +00002808 assert( pPager->journalOpen );
danielk19774cd2cd52007-08-23 14:48:23 +00002809
drh946966f2004-02-25 02:20:41 +00002810 /* assert( !pPager->noSync ); // noSync might be set if synchronous
2811 ** was turned off after the transaction was started. Ticket #615 */
drh968af522003-02-11 14:55:40 +00002812#ifndef NDEBUG
2813 {
drh34e79ce2004-02-08 06:05:46 +00002814 /* Make sure the pPager->nRec counter we are keeping agrees
2815 ** with the nRec computed from the size of the journal file.
2816 */
drheb206252004-10-01 02:00:31 +00002817 i64 jSz;
drh054889e2005-11-30 03:20:31 +00002818 rc = sqlite3OsFileSize(pPager->jfd, &jSz);
drh968af522003-02-11 14:55:40 +00002819 if( rc!=0 ) return rc;
danielk197776572402004-06-25 02:38:54 +00002820 assert( pPager->journalOff==jSz );
drh968af522003-02-11 14:55:40 +00002821 }
2822#endif
danielk19774cd2cd52007-08-23 14:48:23 +00002823 if( 0==(iDc&SQLITE_IOCAP_SAFE_APPEND) ){
danielk197776572402004-06-25 02:38:54 +00002824 /* Write the nRec value into the journal file header. If in
2825 ** full-synchronous mode, sync the journal first. This ensures that
2826 ** all data has really hit the disk before nRec is updated to mark
danielk19774cd2cd52007-08-23 14:48:23 +00002827 ** it as a candidate for rollback.
2828 **
2829 ** This is not required if the persistent media supports the
2830 ** SAFE_APPEND property. Because in this case it is not possible
2831 ** for garbage data to be appended to the file, the nRec field
2832 ** is populated with 0xFFFFFFFF when the journal header is written
2833 ** and never needs to be updated.
danielk197776572402004-06-25 02:38:54 +00002834 */
danielk19774cd2cd52007-08-23 14:48:23 +00002835 i64 jrnlOff;
2836 if( pPager->fullSync && 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
drh4f0c5872007-03-26 22:05:01 +00002837 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002838 IOTRACE(("JSYNC %p\n", pPager))
danielk1977f036aef2007-08-20 05:36:51 +00002839 rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags);
drhd8d66e82003-02-12 02:10:15 +00002840 if( rc!=0 ) return rc;
2841 }
danielk197713adf8a2004-06-03 16:08:41 +00002842
danielk197762079062007-08-15 17:08:46 +00002843 jrnlOff = pPager->journalHdr + sizeof(aJournalMagic);
2844 IOTRACE(("JHDR %p %lld %d\n", pPager, jrnlOff, 4));
2845 rc = write32bits(pPager->jfd, jrnlOff, pPager->nRec);
drhb4746b92005-09-09 01:32:06 +00002846 if( rc ) return rc;
drh968af522003-02-11 14:55:40 +00002847 }
danielk19774cd2cd52007-08-23 14:48:23 +00002848 if( 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
2849 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
2850 IOTRACE(("JSYNC %p\n", pPager))
2851 rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags|
2852 (pPager->sync_flags==SQLITE_SYNC_FULL?SQLITE_SYNC_DATAONLY:0)
2853 );
2854 if( rc!=0 ) return rc;
2855 }
drhdb48ee02003-01-16 13:42:43 +00002856 pPager->journalStarted = 1;
drhfa86c412002-02-02 15:01:15 +00002857 }
drh50e5dad2001-09-15 00:57:28 +00002858 pPager->needSync = 0;
drh341eae82003-01-21 02:39:36 +00002859
2860 /* Erase the needSync flag from every page.
2861 */
2862 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2863 pPg->needSync = 0;
2864 }
danielk19779f61c2f2007-08-27 17:27:49 +00002865 lruListSetFirstSynced(pPager);
drh50e5dad2001-09-15 00:57:28 +00002866 }
drh03eb96a2002-11-10 23:32:56 +00002867
drh341eae82003-01-21 02:39:36 +00002868#ifndef NDEBUG
2869 /* If the Pager.needSync flag is clear then the PgHdr.needSync
2870 ** flag must also be clear for all pages. Verify that this
2871 ** invariant is true.
drh03eb96a2002-11-10 23:32:56 +00002872 */
drh341eae82003-01-21 02:39:36 +00002873 else{
2874 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2875 assert( pPg->needSync==0 );
2876 }
danielk19779f61c2f2007-08-27 17:27:49 +00002877 assert( pPager->lru.pFirstSynced==pPager->lru.pFirst );
drh03eb96a2002-11-10 23:32:56 +00002878 }
drh341eae82003-01-21 02:39:36 +00002879#endif
drhdb48ee02003-01-16 13:42:43 +00002880
drh81a20f22001-10-12 17:30:04 +00002881 return rc;
drh50e5dad2001-09-15 00:57:28 +00002882}
2883
2884/*
drhdc3e10b2006-06-15 14:31:06 +00002885** Merge two lists of pages connected by pDirty and in pgno order.
2886** Do not both fixing the pPrevDirty pointers.
2887*/
2888static PgHdr *merge_pagelist(PgHdr *pA, PgHdr *pB){
2889 PgHdr result, *pTail;
2890 pTail = &result;
2891 while( pA && pB ){
2892 if( pA->pgno<pB->pgno ){
2893 pTail->pDirty = pA;
2894 pTail = pA;
2895 pA = pA->pDirty;
2896 }else{
2897 pTail->pDirty = pB;
2898 pTail = pB;
2899 pB = pB->pDirty;
2900 }
2901 }
2902 if( pA ){
2903 pTail->pDirty = pA;
2904 }else if( pB ){
2905 pTail->pDirty = pB;
2906 }else{
2907 pTail->pDirty = 0;
2908 }
2909 return result.pDirty;
2910}
2911
2912/*
2913** Sort the list of pages in accending order by pgno. Pages are
2914** connected by pDirty pointers. The pPrevDirty pointers are
2915** corrupted by this sort.
2916*/
danielk197724168722007-04-02 05:07:47 +00002917#define N_SORT_BUCKET_ALLOC 25
2918#define N_SORT_BUCKET 25
2919#ifdef SQLITE_TEST
2920 int sqlite3_pager_n_sort_bucket = 0;
2921 #undef N_SORT_BUCKET
2922 #define N_SORT_BUCKET \
2923 (sqlite3_pager_n_sort_bucket?sqlite3_pager_n_sort_bucket:N_SORT_BUCKET_ALLOC)
2924#endif
drhdc3e10b2006-06-15 14:31:06 +00002925static PgHdr *sort_pagelist(PgHdr *pIn){
danielk197724168722007-04-02 05:07:47 +00002926 PgHdr *a[N_SORT_BUCKET_ALLOC], *p;
drhdc3e10b2006-06-15 14:31:06 +00002927 int i;
2928 memset(a, 0, sizeof(a));
2929 while( pIn ){
2930 p = pIn;
2931 pIn = p->pDirty;
2932 p->pDirty = 0;
2933 for(i=0; i<N_SORT_BUCKET-1; i++){
2934 if( a[i]==0 ){
2935 a[i] = p;
2936 break;
2937 }else{
2938 p = merge_pagelist(a[i], p);
2939 a[i] = 0;
2940 }
2941 }
2942 if( i==N_SORT_BUCKET-1 ){
danielk197724168722007-04-02 05:07:47 +00002943 /* Coverage: To get here, there need to be 2^(N_SORT_BUCKET)
2944 ** elements in the input list. This is possible, but impractical.
2945 ** Testing this line is the point of global variable
2946 ** sqlite3_pager_n_sort_bucket.
2947 */
drhdc3e10b2006-06-15 14:31:06 +00002948 a[i] = merge_pagelist(a[i], p);
2949 }
2950 }
2951 p = a[0];
2952 for(i=1; i<N_SORT_BUCKET; i++){
2953 p = merge_pagelist(p, a[i]);
2954 }
2955 return p;
2956}
2957
2958/*
drh2554f8b2003-01-22 01:26:44 +00002959** Given a list of pages (connected by the PgHdr.pDirty pointer) write
2960** every one of those pages out to the database file and mark them all
2961** as clean.
2962*/
2963static int pager_write_pagelist(PgHdr *pList){
2964 Pager *pPager;
drh153c62c2007-08-24 03:51:33 +00002965 PgHdr *p;
drh2554f8b2003-01-22 01:26:44 +00002966 int rc;
2967
2968 if( pList==0 ) return SQLITE_OK;
2969 pPager = pList->pPager;
danielk19779eed5052004-06-04 10:38:30 +00002970
2971 /* At this point there may be either a RESERVED or EXCLUSIVE lock on the
2972 ** database file. If there is already an EXCLUSIVE lock, the following
drh054889e2005-11-30 03:20:31 +00002973 ** calls to sqlite3OsLock() are no-ops.
danielk19779eed5052004-06-04 10:38:30 +00002974 **
drha6abd042004-06-09 17:37:22 +00002975 ** Moving the lock from RESERVED to EXCLUSIVE actually involves going
2976 ** through an intermediate state PENDING. A PENDING lock prevents new
2977 ** readers from attaching to the database but is unsufficient for us to
2978 ** write. The idea of a PENDING lock is to prevent new readers from
2979 ** coming in while we wait for existing readers to clear.
danielk19779eed5052004-06-04 10:38:30 +00002980 **
drha6abd042004-06-09 17:37:22 +00002981 ** While the pager is in the RESERVED state, the original database file
2982 ** is unchanged and we can rollback without having to playback the
2983 ** journal into the original database file. Once we transition to
2984 ** EXCLUSIVE, it means the database file has been changed and any rollback
2985 ** will require a journal playback.
danielk19779eed5052004-06-04 10:38:30 +00002986 */
drh684917c2004-10-05 02:41:42 +00002987 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
danielk19779eed5052004-06-04 10:38:30 +00002988 if( rc!=SQLITE_OK ){
2989 return rc;
2990 }
2991
drhdc3e10b2006-06-15 14:31:06 +00002992 pList = sort_pagelist(pList);
drh153c62c2007-08-24 03:51:33 +00002993 for(p=pList; p; p=p->pDirty){
2994 assert( p->dirty );
2995 p->dirty = 0;
2996 }
drh2554f8b2003-01-22 01:26:44 +00002997 while( pList ){
danielk19777a2b1ee2007-08-21 14:27:01 +00002998
2999 /* If the file has not yet been opened, open it now. */
3000 if( !pPager->fd->pMethods ){
3001 assert(pPager->tempFile);
drh33f4e022007-09-03 15:19:34 +00003002 rc = sqlite3PagerOpentemp(pPager->pVfs, pPager->fd, pPager->zFilename,
3003 pPager->vfsFlags);
danielk19777a2b1ee2007-08-21 14:27:01 +00003004 if( rc ) return rc;
3005 }
3006
danielk1977687566d2004-11-02 12:56:41 +00003007 /* If there are dirty pages in the page cache with page numbers greater
danielk19773b8a05f2007-03-19 17:44:26 +00003008 ** than Pager.dbSize, this means sqlite3PagerTruncate() was called to
danielk1977687566d2004-11-02 12:56:41 +00003009 ** make the file smaller (presumably by auto-vacuum code). Do not write
3010 ** any such pages to the file.
3011 */
3012 if( pList->pgno<=pPager->dbSize ){
danielk197762079062007-08-15 17:08:46 +00003013 i64 offset = (pList->pgno-1)*(i64)pPager->pageSize;
drhc001c582006-03-06 18:23:16 +00003014 char *pData = CODEC2(pPager, PGHDR_TO_DATA(pList), pList->pgno, 6);
drh477731b2007-06-16 03:06:27 +00003015 PAGERTRACE4("STORE %d page %d hash(%08x)\n",
3016 PAGERID(pPager), pList->pgno, pager_pagehash(pList));
drh538f5702007-04-13 02:14:30 +00003017 IOTRACE(("PGOUT %p %d\n", pPager, pList->pgno));
danielk197762079062007-08-15 17:08:46 +00003018 rc = sqlite3OsWrite(pPager->fd, pData, pPager->pageSize, offset);
drh538f5702007-04-13 02:14:30 +00003019 PAGER_INCR(sqlite3_pager_writedb_count);
3020 PAGER_INCR(pPager->nWrite);
drh86a88112007-04-16 15:02:19 +00003021 if( pList->pgno==1 ){
3022 memcpy(&pPager->dbFileVers, &pData[24], sizeof(pPager->dbFileVers));
3023 }
danielk1977687566d2004-11-02 12:56:41 +00003024 }
3025#ifndef NDEBUG
3026 else{
drh4f0c5872007-03-26 22:05:01 +00003027 PAGERTRACE3("NOSTORE %d page %d\n", PAGERID(pPager), pList->pgno);
danielk1977687566d2004-11-02 12:56:41 +00003028 }
3029#endif
drh2554f8b2003-01-22 01:26:44 +00003030 if( rc ) return rc;
danielk19773c407372005-02-15 02:54:14 +00003031#ifdef SQLITE_CHECK_PAGES
3032 pList->pageHash = pager_pagehash(pList);
3033#endif
drh2554f8b2003-01-22 01:26:44 +00003034 pList = pList->pDirty;
3035 }
3036 return SQLITE_OK;
3037}
3038
3039/*
3040** Collect every dirty page into a dirty list and
3041** return a pointer to the head of that list. All pages are
3042** collected even if they are still in use.
3043*/
3044static PgHdr *pager_get_all_dirty_pages(Pager *pPager){
drh8f2e9a12008-02-26 14:46:04 +00003045
3046#ifndef NDEBUG
3047 /* Verify the sanity of the dirty list when we are running
3048 ** in debugging mode. This is expensive, so do not
3049 ** do this on a normal build. */
3050 int n1 = 0;
3051 int n2 = 0;
3052 PgHdr *p;
3053 for(p=pPager->pAll; p; p=p->pNextAll){ if( p->dirty ) n1++; }
3054 for(p=pPager->pDirty; p; p=p->pDirty){ n2++; }
3055 assert( n1==n2 );
3056#endif
3057
drh605ad8f2006-05-03 23:34:05 +00003058 return pPager->pDirty;
drh2554f8b2003-01-22 01:26:44 +00003059}
3060
3061/*
drh19db9352008-03-27 22:42:51 +00003062** Return 1 if there is a hot journal on the given pager.
drh165ffe92005-03-15 17:09:30 +00003063** A hot journal is one that needs to be played back.
3064**
3065** If the current size of the database file is 0 but a journal file
3066** exists, that is probably an old journal left over from a prior
3067** database with the same name. Just delete the journal.
drh19db9352008-03-27 22:42:51 +00003068**
3069** Return negative if unable to determine the status of the journal.
drh165ffe92005-03-15 17:09:30 +00003070*/
3071static int hasHotJournal(Pager *pPager){
danielk1977b4b47412007-08-17 15:53:36 +00003072 sqlite3_vfs *pVfs = pPager->pVfs;
drh19db9352008-03-27 22:42:51 +00003073 int rc;
drh165ffe92005-03-15 17:09:30 +00003074 if( !pPager->useJournal ) return 0;
drhd3cf2472007-11-27 16:55:07 +00003075 if( !pPager->fd->pMethods ) return 0;
drh19db9352008-03-27 22:42:51 +00003076 rc = sqlite3OsAccess(pVfs, pPager->zJournal, SQLITE_ACCESS_EXISTS);
3077 if( rc<=0 ){
3078 return rc;
drhbb5f18d2007-04-06 18:23:17 +00003079 }
3080 if( sqlite3OsCheckReservedLock(pPager->fd) ){
3081 return 0;
3082 }
danielk19773b8a05f2007-03-19 17:44:26 +00003083 if( sqlite3PagerPagecount(pPager)==0 ){
danielk1977fee2d252007-08-18 10:59:19 +00003084 sqlite3OsDelete(pVfs, pPager->zJournal, 0);
drh165ffe92005-03-15 17:09:30 +00003085 return 0;
3086 }else{
3087 return 1;
3088 }
3089}
3090
danielk19775591df52005-12-20 09:19:37 +00003091/*
danielk1977aef0bf62005-12-30 16:28:01 +00003092** Try to find a page in the cache that can be recycled.
3093**
3094** This routine may return SQLITE_IOERR, SQLITE_FULL or SQLITE_OK. It
danielk1977efaaf572006-01-16 11:29:19 +00003095** does not set the pPager->errCode variable.
danielk19775591df52005-12-20 09:19:37 +00003096*/
danielk1977843e65f2007-09-01 16:16:15 +00003097static int pager_recycle(Pager *pPager, PgHdr **ppPg){
danielk197713f72992005-12-18 08:51:22 +00003098 PgHdr *pPg;
3099 *ppPg = 0;
3100
danielk1977843e65f2007-09-01 16:16:15 +00003101 /* It is illegal to call this function unless the pager object
3102 ** pointed to by pPager has at least one free page (page with nRef==0).
3103 */
danielk1977c551edc2007-04-05 13:12:13 +00003104 assert(!MEMDB);
danielk1977843e65f2007-09-01 16:16:15 +00003105 assert(pPager->lru.pFirst);
danielk1977c551edc2007-04-05 13:12:13 +00003106
danielk197713f72992005-12-18 08:51:22 +00003107 /* Find a page to recycle. Try to locate a page that does not
3108 ** require us to do an fsync() on the journal.
3109 */
danielk19779f61c2f2007-08-27 17:27:49 +00003110 pPg = pPager->lru.pFirstSynced;
danielk197713f72992005-12-18 08:51:22 +00003111
3112 /* If we could not find a page that does not require an fsync()
3113 ** on the journal file then fsync the journal file. This is a
3114 ** very slow operation, so we work hard to avoid it. But sometimes
3115 ** it can't be helped.
3116 */
danielk1977843e65f2007-09-01 16:16:15 +00003117 if( pPg==0 && pPager->lru.pFirst){
danielk19774cd2cd52007-08-23 14:48:23 +00003118 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
danielk197713f72992005-12-18 08:51:22 +00003119 int rc = syncJournal(pPager);
3120 if( rc!=0 ){
danielk1977aef0bf62005-12-30 16:28:01 +00003121 return rc;
danielk197713f72992005-12-18 08:51:22 +00003122 }
danielk19774cd2cd52007-08-23 14:48:23 +00003123 if( pPager->fullSync && 0==(iDc&SQLITE_IOCAP_SAFE_APPEND) ){
danielk197713f72992005-12-18 08:51:22 +00003124 /* If in full-sync mode, write a new journal header into the
3125 ** journal file. This is done to avoid ever modifying a journal
3126 ** header that is involved in the rollback of pages that have
3127 ** already been written to the database (in case the header is
3128 ** trashed when the nRec field is updated).
3129 */
3130 pPager->nRec = 0;
3131 assert( pPager->journalOff > 0 );
danielk19774099f6e2007-03-19 11:25:20 +00003132 assert( pPager->doNotSync==0 );
danielk197713f72992005-12-18 08:51:22 +00003133 rc = writeJournalHdr(pPager);
3134 if( rc!=0 ){
danielk1977aef0bf62005-12-30 16:28:01 +00003135 return rc;
danielk197713f72992005-12-18 08:51:22 +00003136 }
3137 }
danielk19779f61c2f2007-08-27 17:27:49 +00003138 pPg = pPager->lru.pFirst;
danielk197713f72992005-12-18 08:51:22 +00003139 }
danielk197713f72992005-12-18 08:51:22 +00003140
3141 assert( pPg->nRef==0 );
3142
3143 /* Write the page to the database file if it is dirty.
3144 */
3145 if( pPg->dirty ){
3146 int rc;
3147 assert( pPg->needSync==0 );
drh605ad8f2006-05-03 23:34:05 +00003148 makeClean(pPg);
3149 pPg->dirty = 1;
danielk197713f72992005-12-18 08:51:22 +00003150 pPg->pDirty = 0;
3151 rc = pager_write_pagelist( pPg );
drh153c62c2007-08-24 03:51:33 +00003152 pPg->dirty = 0;
danielk197713f72992005-12-18 08:51:22 +00003153 if( rc!=SQLITE_OK ){
danielk1977aef0bf62005-12-30 16:28:01 +00003154 return rc;
danielk197713f72992005-12-18 08:51:22 +00003155 }
3156 }
3157 assert( pPg->dirty==0 );
3158
3159 /* If the page we are recycling is marked as alwaysRollback, then
3160 ** set the global alwaysRollback flag, thus disabling the
drh80e35f42007-03-30 14:06:34 +00003161 ** sqlite3PagerDontRollback() optimization for the rest of this transaction.
danielk197713f72992005-12-18 08:51:22 +00003162 ** It is necessary to do this because the page marked alwaysRollback
3163 ** might be reloaded at a later time but at that point we won't remember
3164 ** that is was marked alwaysRollback. This means that all pages must
3165 ** be marked as alwaysRollback from here on out.
3166 */
3167 if( pPg->alwaysRollback ){
drh602c2372007-03-01 00:29:13 +00003168 IOTRACE(("ALWAYS_ROLLBACK %p\n", pPager))
danielk197713f72992005-12-18 08:51:22 +00003169 pPager->alwaysRollback = 1;
3170 }
3171
3172 /* Unlink the old page from the free list and the hash table
3173 */
3174 unlinkPage(pPg);
drh7c4ac0c2007-04-05 11:25:58 +00003175 assert( pPg->pgno==0 );
danielk197713f72992005-12-18 08:51:22 +00003176
3177 *ppPg = pPg;
3178 return SQLITE_OK;
3179}
3180
drh86f8c192007-08-22 00:39:19 +00003181#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
danielk197713f72992005-12-18 08:51:22 +00003182/*
3183** This function is called to free superfluous dynamically allocated memory
3184** held by the pager system. Memory in use by any SQLite pager allocated
drh17435752007-08-16 04:30:38 +00003185** by the current thread may be sqlite3_free()ed.
danielk197713f72992005-12-18 08:51:22 +00003186**
3187** nReq is the number of bytes of memory required. Once this much has
drh86f8c192007-08-22 00:39:19 +00003188** been released, the function returns. The return value is the total number
danielk197713f72992005-12-18 08:51:22 +00003189** of bytes of memory released.
3190*/
danielk19773b8a05f2007-03-19 17:44:26 +00003191int sqlite3PagerReleaseMemory(int nReq){
drh86f8c192007-08-22 00:39:19 +00003192 int nReleased = 0; /* Bytes of memory released so far */
3193 sqlite3_mutex *mutex; /* The MEM2 mutex */
3194 Pager *pPager; /* For looping over pagers */
drhe5fe6902007-12-07 18:55:28 +00003195 BusyHandler *savedBusy; /* Saved copy of the busy handler */
danielk19779f61c2f2007-08-27 17:27:49 +00003196 int rc = SQLITE_OK;
danielk197713f72992005-12-18 08:51:22 +00003197
drh86f8c192007-08-22 00:39:19 +00003198 /* Acquire the memory-management mutex
danielk1977441b09a2006-01-05 13:48:29 +00003199 */
drh86f8c192007-08-22 00:39:19 +00003200 mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MEM2);
3201 sqlite3_mutex_enter(mutex);
3202
3203 /* Signal all database connections that memory management wants
3204 ** to have access to the pagers.
3205 */
3206 for(pPager=sqlite3PagerList; pPager; pPager=pPager->pNext){
3207 pPager->iInUseMM = 1;
danielk1977441b09a2006-01-05 13:48:29 +00003208 }
3209
danielk19779f61c2f2007-08-27 17:27:49 +00003210 while( rc==SQLITE_OK && (nReq<0 || nReleased<nReq) ){
3211 PgHdr *pPg;
3212 PgHdr *pRecycled;
3213
3214 /* Try to find a page to recycle that does not require a sync(). If
3215 ** this is not possible, find one that does require a sync().
3216 */
3217 sqlite3_mutex_enter(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
3218 pPg = sqlite3LruPageList.pFirstSynced;
3219 while( pPg && (pPg->needSync || pPg->pPager->iInUseDB) ){
3220 pPg = pPg->gfree.pNext;
3221 }
3222 if( !pPg ){
3223 pPg = sqlite3LruPageList.pFirst;
3224 while( pPg && pPg->pPager->iInUseDB ){
3225 pPg = pPg->gfree.pNext;
3226 }
3227 }
3228 sqlite3_mutex_leave(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
danielk197713f72992005-12-18 08:51:22 +00003229
danielk197784f786f2007-08-28 08:00:17 +00003230 /* If pPg==0, then the block above has failed to find a page to
3231 ** recycle. In this case return early - no further memory will
3232 ** be released.
3233 */
danielk19779f61c2f2007-08-27 17:27:49 +00003234 if( !pPg ) break;
danielk197713f72992005-12-18 08:51:22 +00003235
danielk19779f61c2f2007-08-27 17:27:49 +00003236 pPager = pPg->pPager;
3237 assert(!pPg->needSync || pPg==pPager->lru.pFirst);
3238 assert(pPg->needSync || pPg==pPager->lru.pFirstSynced);
3239
drhe5fe6902007-12-07 18:55:28 +00003240 savedBusy = pPager->pBusyHandler;
3241 pPager->pBusyHandler = 0;
danielk1977843e65f2007-09-01 16:16:15 +00003242 rc = pager_recycle(pPager, &pRecycled);
drhe5fe6902007-12-07 18:55:28 +00003243 pPager->pBusyHandler = savedBusy;
danielk19779f61c2f2007-08-27 17:27:49 +00003244 assert(pRecycled==pPg || rc!=SQLITE_OK);
3245 if( rc==SQLITE_OK ){
3246 /* We've found a page to free. At this point the page has been
3247 ** removed from the page hash-table, free-list and synced-list
3248 ** (pFirstSynced). It is still in the all pages (pAll) list.
3249 ** Remove it from this list before freeing.
3250 **
3251 ** Todo: Check the Pager.pStmt list to make sure this is Ok. It
3252 ** probably is though.
danielk197713f72992005-12-18 08:51:22 +00003253 */
danielk19779f61c2f2007-08-27 17:27:49 +00003254 PgHdr *pTmp;
3255 assert( pPg );
3256 if( pPg==pPager->pAll ){
3257 pPager->pAll = pPg->pNextAll;
3258 }else{
3259 for( pTmp=pPager->pAll; pTmp->pNextAll!=pPg; pTmp=pTmp->pNextAll ){}
3260 pTmp->pNextAll = pPg->pNextAll;
danielk197713f72992005-12-18 08:51:22 +00003261 }
danielk19779f61c2f2007-08-27 17:27:49 +00003262 nReleased += (
3263 sizeof(*pPg) + pPager->pageSize
3264 + sizeof(u32) + pPager->nExtra
3265 + MEMDB*sizeof(PgHistory)
3266 );
3267 IOTRACE(("PGFREE %p %d *\n", pPager, pPg->pgno));
3268 PAGER_INCR(sqlite3_pager_pgfree_count);
drh0d180202008-02-14 23:26:56 +00003269 sqlite3_free(pPg->pData);
danielk19779f61c2f2007-08-27 17:27:49 +00003270 sqlite3_free(pPg);
danielk197784f786f2007-08-28 08:00:17 +00003271 pPager->nPage--;
danielk19779f61c2f2007-08-27 17:27:49 +00003272 }else{
3273 /* An error occured whilst writing to the database file or
3274 ** journal in pager_recycle(). The error is not returned to the
3275 ** caller of this function. Instead, set the Pager.errCode variable.
3276 ** The error will be returned to the user (or users, in the case
3277 ** of a shared pager cache) of the pager for which the error occured.
3278 */
3279 assert(
3280 (rc&0xff)==SQLITE_IOERR ||
3281 rc==SQLITE_FULL ||
3282 rc==SQLITE_BUSY
3283 );
3284 assert( pPager->state>=PAGER_RESERVED );
3285 pager_error(pPager, rc);
danielk197713f72992005-12-18 08:51:22 +00003286 }
3287 }
danielk1977aef0bf62005-12-30 16:28:01 +00003288
drh86f8c192007-08-22 00:39:19 +00003289 /* Clear the memory management flags and release the mutex
3290 */
3291 for(pPager=sqlite3PagerList; pPager; pPager=pPager->pNext){
3292 pPager->iInUseMM = 0;
3293 }
3294 sqlite3_mutex_leave(mutex);
3295
3296 /* Return the number of bytes released
3297 */
danielk197713f72992005-12-18 08:51:22 +00003298 return nReleased;
3299}
drh86f8c192007-08-22 00:39:19 +00003300#endif /* SQLITE_ENABLE_MEMORY_MANAGEMENT */
danielk197713f72992005-12-18 08:51:22 +00003301
drh165ffe92005-03-15 17:09:30 +00003302/*
danielk1977e180dd92007-04-05 17:15:52 +00003303** Read the content of page pPg out of the database file.
3304*/
3305static int readDbPage(Pager *pPager, PgHdr *pPg, Pgno pgno){
3306 int rc;
danielk197762079062007-08-15 17:08:46 +00003307 i64 offset;
danielk1977e180dd92007-04-05 17:15:52 +00003308 assert( MEMDB==0 );
danielk19777a2b1ee2007-08-21 14:27:01 +00003309 assert(pPager->fd->pMethods||pPager->tempFile);
3310 if( !pPager->fd->pMethods ){
3311 return SQLITE_IOERR_SHORT_READ;
3312 }
danielk197762079062007-08-15 17:08:46 +00003313 offset = (pgno-1)*(i64)pPager->pageSize;
3314 rc = sqlite3OsRead(pPager->fd, PGHDR_TO_DATA(pPg), pPager->pageSize, offset);
drh538f5702007-04-13 02:14:30 +00003315 PAGER_INCR(sqlite3_pager_readdb_count);
3316 PAGER_INCR(pPager->nRead);
3317 IOTRACE(("PGIN %p %d\n", pPager, pgno));
drh86a88112007-04-16 15:02:19 +00003318 if( pgno==1 ){
3319 memcpy(&pPager->dbFileVers, &((u8*)PGHDR_TO_DATA(pPg))[24],
3320 sizeof(pPager->dbFileVers));
3321 }
danielk1977e180dd92007-04-05 17:15:52 +00003322 CODEC1(pPager, PGHDR_TO_DATA(pPg), pPg->pgno, 3);
drh477731b2007-06-16 03:06:27 +00003323 PAGERTRACE4("FETCH %d page %d hash(%08x)\n",
3324 PAGERID(pPager), pPg->pgno, pager_pagehash(pPg));
danielk1977e180dd92007-04-05 17:15:52 +00003325 return rc;
3326}
3327
3328
3329/*
danielk1977e277be02007-03-23 18:12:06 +00003330** This function is called to obtain the shared lock required before
3331** data may be read from the pager cache. If the shared lock has already
3332** been obtained, this function is a no-op.
danielk1977393f0682007-03-31 10:00:48 +00003333**
3334** Immediately after obtaining the shared lock (if required), this function
3335** checks for a hot-journal file. If one is found, an emergency rollback
3336** is performed immediately.
danielk1977e277be02007-03-23 18:12:06 +00003337*/
3338static int pagerSharedLock(Pager *pPager){
3339 int rc = SQLITE_OK;
danielk1977ae72d982007-10-03 08:46:44 +00003340 int isHot = 0;
danielk1977e277be02007-03-23 18:12:06 +00003341
danielk1977ae72d982007-10-03 08:46:44 +00003342 /* If this database is opened for exclusive access, has no outstanding
3343 ** page references and is in an error-state, now is the chance to clear
3344 ** the error. Discard the contents of the pager-cache and treat any
3345 ** open journal file as a hot-journal.
3346 */
3347 if( !MEMDB && pPager->exclusiveMode && pPager->nRef==0 && pPager->errCode ){
3348 if( pPager->journalOpen ){
3349 isHot = 1;
3350 }
3351 pager_reset(pPager);
3352 pPager->errCode = SQLITE_OK;
3353 }
3354
3355 /* If the pager is still in an error state, do not proceed. The error
3356 ** state will be cleared at some point in the future when all page
3357 ** references are dropped and the cache can be discarded.
3358 */
3359 if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
3360 return pPager->errCode;
3361 }
3362
3363 if( pPager->state==PAGER_UNLOCK || isHot ){
danielk1977b4b47412007-08-17 15:53:36 +00003364 sqlite3_vfs *pVfs = pPager->pVfs;
danielk1977e277be02007-03-23 18:12:06 +00003365 if( !MEMDB ){
3366 assert( pPager->nRef==0 );
3367 if( !pPager->noReadlock ){
3368 rc = pager_wait_on_lock(pPager, SHARED_LOCK);
3369 if( rc!=SQLITE_OK ){
3370 return pager_error(pPager, rc);
3371 }
3372 assert( pPager->state>=SHARED_LOCK );
3373 }
3374
3375 /* If a journal file exists, and there is no RESERVED lock on the
3376 ** database file, then it either needs to be played back or deleted.
3377 */
drh19db9352008-03-27 22:42:51 +00003378 rc = hasHotJournal(pPager);
3379 if( rc<0 ){
3380 return pager_error(pPager, SQLITE_IOERR_NOMEM);
3381 }
3382 if( rc==1 || isHot ){
danielk1977e277be02007-03-23 18:12:06 +00003383 /* Get an EXCLUSIVE lock on the database file. At this point it is
3384 ** important that a RESERVED lock is not obtained on the way to the
3385 ** EXCLUSIVE lock. If it were, another process might open the
3386 ** database file, detect the RESERVED lock, and conclude that the
3387 ** database is safe to read while this process is still rolling it
3388 ** back.
3389 **
3390 ** Because the intermediate RESERVED lock is not requested, the
3391 ** second process will get to this point in the code and fail to
drh85b623f2007-12-13 21:54:09 +00003392 ** obtain its own EXCLUSIVE lock on the database file.
danielk1977e277be02007-03-23 18:12:06 +00003393 */
danielk1977ae72d982007-10-03 08:46:44 +00003394 if( pPager->state<EXCLUSIVE_LOCK ){
3395 rc = sqlite3OsLock(pPager->fd, EXCLUSIVE_LOCK);
3396 if( rc!=SQLITE_OK ){
3397 pager_unlock(pPager);
3398 return pager_error(pPager, rc);
3399 }
3400 pPager->state = PAGER_EXCLUSIVE;
danielk1977e277be02007-03-23 18:12:06 +00003401 }
danielk1977e277be02007-03-23 18:12:06 +00003402
3403 /* Open the journal for reading only. Return SQLITE_BUSY if
3404 ** we are unable to open the journal file.
3405 **
3406 ** The journal file does not need to be locked itself. The
3407 ** journal file is never open unless the main database file holds
3408 ** a write lock, so there is never any chance of two or more
3409 ** processes opening the journal at the same time.
danielk1977979f38e2007-03-27 16:19:51 +00003410 **
drhfd131da2007-08-07 17:13:03 +00003411 ** Open the journal for read/write access. This is because in
3412 ** exclusive-access mode the file descriptor will be kept open and
danielk1977979f38e2007-03-27 16:19:51 +00003413 ** possibly used for a transaction later on. On some systems, the
3414 ** OsTruncate() call used in exclusive-access mode also requires
3415 ** a read/write file handle.
danielk1977e277be02007-03-23 18:12:06 +00003416 */
danielk1977ae72d982007-10-03 08:46:44 +00003417 if( !isHot ){
3418 rc = SQLITE_BUSY;
drh19db9352008-03-27 22:42:51 +00003419 if( sqlite3OsAccess(pVfs, pPager->zJournal,SQLITE_ACCESS_EXISTS)==1 ){
danielk1977ae72d982007-10-03 08:46:44 +00003420 int fout = 0;
3421 int f = SQLITE_OPEN_READWRITE|SQLITE_OPEN_MAIN_JOURNAL;
3422 assert( !pPager->tempFile );
3423 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, f, &fout);
3424 assert( rc!=SQLITE_OK || pPager->jfd->pMethods );
3425 if( fout&SQLITE_OPEN_READONLY ){
3426 rc = SQLITE_BUSY;
3427 sqlite3OsClose(pPager->jfd);
3428 }
danielk1977979f38e2007-03-27 16:19:51 +00003429 }
3430 }
danielk1977e277be02007-03-23 18:12:06 +00003431 if( rc!=SQLITE_OK ){
3432 pager_unlock(pPager);
drh1aa5af12008-03-07 19:51:14 +00003433 switch( rc ){
3434 case SQLITE_NOMEM:
3435 case SQLITE_IOERR_UNLOCK:
3436 case SQLITE_IOERR_NOMEM:
3437 return rc;
3438 default:
3439 return SQLITE_BUSY;
3440 }
danielk1977e277be02007-03-23 18:12:06 +00003441 }
3442 pPager->journalOpen = 1;
3443 pPager->journalStarted = 0;
3444 pPager->journalOff = 0;
3445 pPager->setMaster = 0;
3446 pPager->journalHdr = 0;
3447
3448 /* Playback and delete the journal. Drop the database write
3449 ** lock and reacquire the read lock.
3450 */
3451 rc = pager_playback(pPager, 1);
3452 if( rc!=SQLITE_OK ){
3453 return pager_error(pPager, rc);
3454 }
danielk1977c5859712007-03-26 12:26:27 +00003455 assert(pPager->state==PAGER_SHARED ||
3456 (pPager->exclusiveMode && pPager->state>PAGER_SHARED)
3457 );
danielk1977e277be02007-03-23 18:12:06 +00003458 }
3459
3460 if( pPager->pAll ){
danielk197724168722007-04-02 05:07:47 +00003461 /* The shared-lock has just been acquired on the database file
3462 ** and there are already pages in the cache (from a previous
drh86a88112007-04-16 15:02:19 +00003463 ** read or write transaction). Check to see if the database
3464 ** has been modified. If the database has changed, flush the
3465 ** cache.
3466 **
3467 ** Database changes is detected by looking at 15 bytes beginning
3468 ** at offset 24 into the file. The first 4 of these 16 bytes are
3469 ** a 32-bit counter that is incremented with each change. The
3470 ** other bytes change randomly with each file change when
3471 ** a codec is in use.
3472 **
3473 ** There is a vanishingly small chance that a change will not be
drh6fa51032007-05-09 20:35:31 +00003474 ** detected. The chance of an undetected change is so small that
drh86a88112007-04-16 15:02:19 +00003475 ** it can be neglected.
danielk197724168722007-04-02 05:07:47 +00003476 */
drh86a88112007-04-16 15:02:19 +00003477 char dbFileVers[sizeof(pPager->dbFileVers)];
danielk1977e180dd92007-04-05 17:15:52 +00003478 sqlite3PagerPagecount(pPager);
danielk197724168722007-04-02 05:07:47 +00003479
danielk1977e180dd92007-04-05 17:15:52 +00003480 if( pPager->errCode ){
3481 return pPager->errCode;
danielk1977e277be02007-03-23 18:12:06 +00003482 }
3483
danielk1977e180dd92007-04-05 17:15:52 +00003484 if( pPager->dbSize>0 ){
drhae5e4452007-05-03 17:18:36 +00003485 IOTRACE(("CKVERS %p %d\n", pPager, sizeof(dbFileVers)));
danielk197762079062007-08-15 17:08:46 +00003486 rc = sqlite3OsRead(pPager->fd, &dbFileVers, sizeof(dbFileVers), 24);
danielk1977e180dd92007-04-05 17:15:52 +00003487 if( rc!=SQLITE_OK ){
3488 return rc;
3489 }
drh86a88112007-04-16 15:02:19 +00003490 }else{
3491 memset(dbFileVers, 0, sizeof(dbFileVers));
danielk1977e180dd92007-04-05 17:15:52 +00003492 }
3493
drh86a88112007-04-16 15:02:19 +00003494 if( memcmp(pPager->dbFileVers, dbFileVers, sizeof(dbFileVers))!=0 ){
danielk1977e180dd92007-04-05 17:15:52 +00003495 pager_reset(pPager);
danielk1977e277be02007-03-23 18:12:06 +00003496 }
3497 }
3498 }
danielk1977c5859712007-03-26 12:26:27 +00003499 assert( pPager->exclusiveMode || pPager->state<=PAGER_SHARED );
3500 if( pPager->state==PAGER_UNLOCK ){
3501 pPager->state = PAGER_SHARED;
3502 }
danielk1977e277be02007-03-23 18:12:06 +00003503 }
3504
3505 return rc;
3506}
3507
3508/*
danielk1977e180dd92007-04-05 17:15:52 +00003509** Allocate a PgHdr object. Either create a new one or reuse
3510** an existing one that is not otherwise in use.
3511**
3512** A new PgHdr structure is created if any of the following are
3513** true:
3514**
3515** (1) We have not exceeded our maximum allocated cache size
3516** as set by the "PRAGMA cache_size" command.
3517**
3518** (2) There are no unused PgHdr objects available at this time.
3519**
3520** (3) This is an in-memory database.
3521**
3522** (4) There are no PgHdr objects that do not require a journal
3523** file sync and a sync of the journal file is currently
3524** prohibited.
3525**
3526** Otherwise, reuse an existing PgHdr. In other words, reuse an
3527** existing PgHdr if all of the following are true:
3528**
3529** (1) We have reached or exceeded the maximum cache size
3530** allowed by "PRAGMA cache_size".
3531**
3532** (2) There is a PgHdr available with PgHdr->nRef==0
3533**
3534** (3) We are not in an in-memory database
3535**
3536** (4) Either there is an available PgHdr that does not need
3537** to be synced to disk or else disk syncing is currently
3538** allowed.
danielk197724168722007-04-02 05:07:47 +00003539*/
3540static int pagerAllocatePage(Pager *pPager, PgHdr **ppPg){
3541 int rc = SQLITE_OK;
3542 PgHdr *pPg;
drh1e3af332007-10-20 13:17:54 +00003543 int nByteHdr;
danielk197724168722007-04-02 05:07:47 +00003544
danielk1977e180dd92007-04-05 17:15:52 +00003545 /* Create a new PgHdr if any of the four conditions defined
danielk19772a6bdf62007-08-20 16:07:00 +00003546 ** above are met: */
danielk1977e180dd92007-04-05 17:15:52 +00003547 if( pPager->nPage<pPager->mxPage
danielk19779f61c2f2007-08-27 17:27:49 +00003548 || pPager->lru.pFirst==0
danielk1977e180dd92007-04-05 17:15:52 +00003549 || MEMDB
danielk19779f61c2f2007-08-27 17:27:49 +00003550 || (pPager->lru.pFirstSynced==0 && pPager->doNotSync)
danielk1977e180dd92007-04-05 17:15:52 +00003551 ){
drh0d180202008-02-14 23:26:56 +00003552 void *pData;
danielk197724168722007-04-02 05:07:47 +00003553 if( pPager->nPage>=pPager->nHash ){
3554 pager_resize_hash_table(pPager,
3555 pPager->nHash<256 ? 256 : pPager->nHash*2);
3556 if( pPager->nHash==0 ){
3557 rc = SQLITE_NOMEM;
3558 goto pager_allocate_out;
3559 }
3560 }
drhed138fb2007-08-22 22:04:37 +00003561 pagerLeave(pPager);
drh1e3af332007-10-20 13:17:54 +00003562 nByteHdr = sizeof(*pPg) + sizeof(u32) + pPager->nExtra
3563 + MEMDB*sizeof(PgHistory);
drh0d180202008-02-14 23:26:56 +00003564 pPg = sqlite3_malloc( nByteHdr );
3565 if( pPg ){
3566 pData = sqlite3_malloc( pPager->pageSize );
3567 if( pData==0 ){
3568 sqlite3_free(pPg);
3569 pPg = 0;
3570 }
3571 }
drhed138fb2007-08-22 22:04:37 +00003572 pagerEnter(pPager);
danielk197724168722007-04-02 05:07:47 +00003573 if( pPg==0 ){
3574 rc = SQLITE_NOMEM;
3575 goto pager_allocate_out;
3576 }
drh1e3af332007-10-20 13:17:54 +00003577 memset(pPg, 0, nByteHdr);
drh0d180202008-02-14 23:26:56 +00003578 pPg->pData = pData;
danielk197724168722007-04-02 05:07:47 +00003579 pPg->pPager = pPager;
3580 pPg->pNextAll = pPager->pAll;
3581 pPager->pAll = pPg;
3582 pPager->nPage++;
danielk197724168722007-04-02 05:07:47 +00003583 }else{
3584 /* Recycle an existing page with a zero ref-count. */
danielk1977843e65f2007-09-01 16:16:15 +00003585 rc = pager_recycle(pPager, &pPg);
danielk1977e965ac72007-06-13 15:22:28 +00003586 if( rc==SQLITE_BUSY ){
3587 rc = SQLITE_IOERR_BLOCKED;
3588 }
danielk197724168722007-04-02 05:07:47 +00003589 if( rc!=SQLITE_OK ){
3590 goto pager_allocate_out;
3591 }
3592 assert( pPager->state>=SHARED_LOCK );
3593 assert(pPg);
3594 }
3595 *ppPg = pPg;
3596
3597pager_allocate_out:
3598 return rc;
3599}
3600
3601/*
drhd33d5a82007-04-26 12:11:28 +00003602** Make sure we have the content for a page. If the page was
3603** previously acquired with noContent==1, then the content was
3604** just initialized to zeros instead of being read from disk.
3605** But now we need the real data off of disk. So make sure we
3606** have it. Read it in if we do not have it already.
3607*/
3608static int pager_get_content(PgHdr *pPg){
3609 if( pPg->needRead ){
3610 int rc = readDbPage(pPg->pPager, pPg, pPg->pgno);
3611 if( rc==SQLITE_OK ){
3612 pPg->needRead = 0;
3613 }else{
3614 return rc;
3615 }
3616 }
3617 return SQLITE_OK;
3618}
3619
3620/*
drhd9b02572001-04-15 00:37:09 +00003621** Acquire a page.
3622**
drh58a11682001-11-10 13:51:08 +00003623** A read lock on the disk file is obtained when the first page is acquired.
drh5e00f6c2001-09-13 13:46:56 +00003624** This read lock is dropped when the last page is released.
drhd9b02572001-04-15 00:37:09 +00003625**
drhd33d5a82007-04-26 12:11:28 +00003626** This routine works for any page number greater than 0. If the database
drh306dc212001-05-21 13:45:10 +00003627** file is smaller than the requested page, then no actual disk
3628** read occurs and the memory image of the page is initialized to
3629** all zeros. The extra data appended to a page is always initialized
3630** to zeros the first time a page is loaded into memory.
3631**
drhd9b02572001-04-15 00:37:09 +00003632** The acquisition might fail for several reasons. In all cases,
3633** an appropriate error code is returned and *ppPage is set to NULL.
drh7e3b0a02001-04-28 16:52:40 +00003634**
drhd33d5a82007-04-26 12:11:28 +00003635** See also sqlite3PagerLookup(). Both this routine and Lookup() attempt
drh7e3b0a02001-04-28 16:52:40 +00003636** to find a page in the in-memory cache first. If the page is not already
drhd33d5a82007-04-26 12:11:28 +00003637** in memory, this routine goes to disk to read it in whereas Lookup()
drh7e3b0a02001-04-28 16:52:40 +00003638** just returns 0. This routine acquires a read-lock the first time it
3639** has to go to disk, and could also playback an old journal if necessary.
drhd33d5a82007-04-26 12:11:28 +00003640** Since Lookup() never goes to disk, it never has to deal with locks
drh7e3b0a02001-04-28 16:52:40 +00003641** or journal files.
drh0787db62007-03-04 13:15:27 +00003642**
drh538f5702007-04-13 02:14:30 +00003643** If noContent is false, the page contents are actually read from disk.
3644** If noContent is true, it means that we do not care about the contents
3645** of the page at this time, so do not do a disk read. Just fill in the
3646** page content with zeros. But mark the fact that we have not read the
3647** content by setting the PgHdr.needRead flag. Later on, if
drhd33d5a82007-04-26 12:11:28 +00003648** sqlite3PagerWrite() is called on this page or if this routine is
3649** called again with noContent==0, that means that the content is needed
3650** and the disk read should occur at that point.
drhed7c8552001-04-11 14:29:21 +00003651*/
drh86f8c192007-08-22 00:39:19 +00003652static int pagerAcquire(
drh538f5702007-04-13 02:14:30 +00003653 Pager *pPager, /* The pager open on the database file */
3654 Pgno pgno, /* Page number to fetch */
3655 DbPage **ppPage, /* Write a pointer to the page here */
3656 int noContent /* Do not bother reading content from disk if true */
3657){
drhed7c8552001-04-11 14:29:21 +00003658 PgHdr *pPg;
drh165ffe92005-03-15 17:09:30 +00003659 int rc;
drhed7c8552001-04-11 14:29:21 +00003660
danielk1977e277be02007-03-23 18:12:06 +00003661 assert( pPager->state==PAGER_UNLOCK || pPager->nRef>0 || pgno==1 );
3662
danielk197726836652005-01-17 01:33:13 +00003663 /* The maximum page number is 2^31. Return SQLITE_CORRUPT if a page
3664 ** number greater than this, or zero, is requested.
3665 */
drh267cb322005-09-16 17:16:52 +00003666 if( pgno>PAGER_MAX_PGNO || pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh49285702005-09-17 15:20:26 +00003667 return SQLITE_CORRUPT_BKPT;
danielk197726836652005-01-17 01:33:13 +00003668 }
3669
drhd9b02572001-04-15 00:37:09 +00003670 /* Make sure we have not hit any critical errors.
3671 */
drh836faa42003-01-11 13:30:57 +00003672 assert( pPager!=0 );
drh2e6d11b2003-04-25 15:37:57 +00003673 *ppPage = 0;
drhd9b02572001-04-15 00:37:09 +00003674
danielk197713adf8a2004-06-03 16:08:41 +00003675 /* If this is the first page accessed, then get a SHARED lock
danielk1977334cdb62007-03-26 08:05:12 +00003676 ** on the database file. pagerSharedLock() is a no-op if
3677 ** a database lock is already held.
drhed7c8552001-04-11 14:29:21 +00003678 */
danielk1977e277be02007-03-23 18:12:06 +00003679 rc = pagerSharedLock(pPager);
3680 if( rc!=SQLITE_OK ){
3681 return rc;
drhed7c8552001-04-11 14:29:21 +00003682 }
danielk1977e277be02007-03-23 18:12:06 +00003683 assert( pPager->state!=PAGER_UNLOCK );
3684
3685 pPg = pager_lookup(pPager, pgno);
drhed7c8552001-04-11 14:29:21 +00003686 if( pPg==0 ){
drhd9b02572001-04-15 00:37:09 +00003687 /* The requested page is not in the page cache. */
danielk1977979f38e2007-03-27 16:19:51 +00003688 int nMax;
drhed7c8552001-04-11 14:29:21 +00003689 int h;
drh538f5702007-04-13 02:14:30 +00003690 PAGER_INCR(pPager->nMiss);
danielk197724168722007-04-02 05:07:47 +00003691 rc = pagerAllocatePage(pPager, &pPg);
3692 if( rc!=SQLITE_OK ){
3693 return rc;
drhed7c8552001-04-11 14:29:21 +00003694 }
danielk197724168722007-04-02 05:07:47 +00003695
drhed7c8552001-04-11 14:29:21 +00003696 pPg->pgno = pgno;
danielk1977f35843b2007-04-07 15:03:17 +00003697 assert( !MEMDB || pgno>pPager->stmtSize );
drhf5e7bb52008-02-18 14:47:33 +00003698 pPg->inJournal = sqlite3BitvecTest(pPager->pInJournal, pgno);
3699 pPg->needSync = 0;
danielk1977f35843b2007-04-07 15:03:17 +00003700
drh605ad8f2006-05-03 23:34:05 +00003701 makeClean(pPg);
drhed7c8552001-04-11 14:29:21 +00003702 pPg->nRef = 1;
danielk197775bab7d2006-01-23 13:09:45 +00003703
drhd9b02572001-04-15 00:37:09 +00003704 pPager->nRef++;
drh2e6d11b2003-04-25 15:37:57 +00003705 if( pPager->nExtra>0 ){
drh90f5ecb2004-07-22 01:19:35 +00003706 memset(PGHDR_TO_EXTRA(pPg, pPager), 0, pPager->nExtra);
drh2e6d11b2003-04-25 15:37:57 +00003707 }
danielk1977979f38e2007-03-27 16:19:51 +00003708 nMax = sqlite3PagerPagecount(pPager);
danielk1977efaaf572006-01-16 11:29:19 +00003709 if( pPager->errCode ){
danielk1977efaaf572006-01-16 11:29:19 +00003710 rc = pPager->errCode;
danielk1977ae72d982007-10-03 08:46:44 +00003711 sqlite3PagerUnref(pPg);
drh2e6d11b2003-04-25 15:37:57 +00003712 return rc;
3713 }
danielk197775bab7d2006-01-23 13:09:45 +00003714
3715 /* Populate the page with data, either by reading from the database
3716 ** file, or by setting the entire page to zero.
3717 */
drhd215acf2007-04-13 04:01:58 +00003718 if( nMax<(int)pgno || MEMDB || (noContent && !pPager->alwaysRollback) ){
drhf8e632b2007-05-08 14:51:36 +00003719 if( pgno>pPager->mxPgno ){
danielk1977de3bea72007-05-09 15:56:39 +00003720 sqlite3PagerUnref(pPg);
drhf8e632b2007-05-08 14:51:36 +00003721 return SQLITE_FULL;
3722 }
drh90f5ecb2004-07-22 01:19:35 +00003723 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
drhd215acf2007-04-13 04:01:58 +00003724 pPg->needRead = noContent && !pPager->alwaysRollback;
drh538f5702007-04-13 02:14:30 +00003725 IOTRACE(("ZERO %p %d\n", pPager, pgno));
drh306dc212001-05-21 13:45:10 +00003726 }else{
danielk1977e180dd92007-04-05 17:15:52 +00003727 rc = readDbPage(pPager, pPg, pgno);
drh551b7732006-11-06 21:20:25 +00003728 if( rc!=SQLITE_OK && rc!=SQLITE_IOERR_SHORT_READ ){
3729 pPg->pgno = 0;
danielk19773b8a05f2007-03-19 17:44:26 +00003730 sqlite3PagerUnref(pPg);
drh551b7732006-11-06 21:20:25 +00003731 return rc;
drh81a20f22001-10-12 17:30:04 +00003732 }
danielk1977b4626a32007-04-28 15:47:43 +00003733 pPg->needRead = 0;
drh306dc212001-05-21 13:45:10 +00003734 }
danielk197775bab7d2006-01-23 13:09:45 +00003735
3736 /* Link the page into the page hash table */
drh8ca0c722006-05-07 17:49:38 +00003737 h = pgno & (pPager->nHash-1);
drh3765df42006-06-28 18:18:09 +00003738 assert( pgno!=0 );
danielk197775bab7d2006-01-23 13:09:45 +00003739 pPg->pNextHash = pPager->aHash[h];
3740 pPager->aHash[h] = pPg;
3741 if( pPg->pNextHash ){
3742 assert( pPg->pNextHash->pPrevHash==0 );
3743 pPg->pNextHash->pPrevHash = pPg;
3744 }
3745
danielk19773c407372005-02-15 02:54:14 +00003746#ifdef SQLITE_CHECK_PAGES
3747 pPg->pageHash = pager_pagehash(pPg);
3748#endif
drhed7c8552001-04-11 14:29:21 +00003749 }else{
drhd9b02572001-04-15 00:37:09 +00003750 /* The requested page is in the page cache. */
danielk1977e277be02007-03-23 18:12:06 +00003751 assert(pPager->nRef>0 || pgno==1);
drh538f5702007-04-13 02:14:30 +00003752 PAGER_INCR(pPager->nHit);
drhd33d5a82007-04-26 12:11:28 +00003753 if( !noContent ){
3754 rc = pager_get_content(pPg);
3755 if( rc ){
3756 return rc;
3757 }
3758 }
drhdf0b3b02001-06-23 11:36:20 +00003759 page_ref(pPg);
drhed7c8552001-04-11 14:29:21 +00003760 }
danielk19773b8a05f2007-03-19 17:44:26 +00003761 *ppPage = pPg;
drhed7c8552001-04-11 14:29:21 +00003762 return SQLITE_OK;
3763}
drh86f8c192007-08-22 00:39:19 +00003764int sqlite3PagerAcquire(
3765 Pager *pPager, /* The pager open on the database file */
3766 Pgno pgno, /* Page number to fetch */
3767 DbPage **ppPage, /* Write a pointer to the page here */
3768 int noContent /* Do not bother reading content from disk if true */
3769){
3770 int rc;
3771 pagerEnter(pPager);
3772 rc = pagerAcquire(pPager, pgno, ppPage, noContent);
3773 pagerLeave(pPager);
3774 return rc;
3775}
3776
drhed7c8552001-04-11 14:29:21 +00003777
3778/*
drh7e3b0a02001-04-28 16:52:40 +00003779** Acquire a page if it is already in the in-memory cache. Do
3780** not read the page from disk. Return a pointer to the page,
3781** or 0 if the page is not in cache.
3782**
danielk19773b8a05f2007-03-19 17:44:26 +00003783** See also sqlite3PagerGet(). The difference between this routine
3784** and sqlite3PagerGet() is that _get() will go to the disk and read
drh7e3b0a02001-04-28 16:52:40 +00003785** in the page if the page is not already in cache. This routine
drh5e00f6c2001-09-13 13:46:56 +00003786** returns NULL if the page is not in cache or if a disk I/O error
3787** has ever happened.
drh7e3b0a02001-04-28 16:52:40 +00003788*/
danielk19773b8a05f2007-03-19 17:44:26 +00003789DbPage *sqlite3PagerLookup(Pager *pPager, Pgno pgno){
drh86f8c192007-08-22 00:39:19 +00003790 PgHdr *pPg = 0;
drh7e3b0a02001-04-28 16:52:40 +00003791
drh836faa42003-01-11 13:30:57 +00003792 assert( pPager!=0 );
3793 assert( pgno!=0 );
danielk1977e277be02007-03-23 18:12:06 +00003794
drh86f8c192007-08-22 00:39:19 +00003795 pagerEnter(pPager);
danielk1977e277be02007-03-23 18:12:06 +00003796 if( pPager->state==PAGER_UNLOCK ){
danielk1977334cdb62007-03-26 08:05:12 +00003797 assert( !pPager->pAll || pPager->exclusiveMode );
drh86f8c192007-08-22 00:39:19 +00003798 }else if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
3799 /* Do nothing */
3800 }else if( (pPg = pager_lookup(pPager, pgno))!=0 ){
3801 page_ref(pPg);
danielk1977e277be02007-03-23 18:12:06 +00003802 }
drh86f8c192007-08-22 00:39:19 +00003803 pagerLeave(pPager);
danielk19773b8a05f2007-03-19 17:44:26 +00003804 return pPg;
drh7e3b0a02001-04-28 16:52:40 +00003805}
3806
3807/*
drhed7c8552001-04-11 14:29:21 +00003808** Release a page.
3809**
3810** If the number of references to the page drop to zero, then the
3811** page is added to the LRU list. When all references to all pages
drhd9b02572001-04-15 00:37:09 +00003812** are released, a rollback occurs and the lock on the database is
drhed7c8552001-04-11 14:29:21 +00003813** removed.
3814*/
danielk19773b8a05f2007-03-19 17:44:26 +00003815int sqlite3PagerUnref(DbPage *pPg){
danielk1977ae72d982007-10-03 08:46:44 +00003816 Pager *pPager = pPg->pPager;
drhd9b02572001-04-15 00:37:09 +00003817
3818 /* Decrement the reference count for this page
3819 */
drhed7c8552001-04-11 14:29:21 +00003820 assert( pPg->nRef>0 );
drh86f8c192007-08-22 00:39:19 +00003821 pagerEnter(pPg->pPager);
drhed7c8552001-04-11 14:29:21 +00003822 pPg->nRef--;
drhd9b02572001-04-15 00:37:09 +00003823
danielk19773c407372005-02-15 02:54:14 +00003824 CHECK_PAGE(pPg);
3825
drh72f82862001-05-24 21:06:34 +00003826 /* When the number of references to a page reach 0, call the
3827 ** destructor and add the page to the freelist.
drhd9b02572001-04-15 00:37:09 +00003828 */
drhed7c8552001-04-11 14:29:21 +00003829 if( pPg->nRef==0 ){
danielk19779f61c2f2007-08-27 17:27:49 +00003830
3831 lruListAdd(pPg);
drh72f82862001-05-24 21:06:34 +00003832 if( pPager->xDestructor ){
danielk19773b8a05f2007-03-19 17:44:26 +00003833 pPager->xDestructor(pPg, pPager->pageSize);
drh72f82862001-05-24 21:06:34 +00003834 }
drhd9b02572001-04-15 00:37:09 +00003835
3836 /* When all pages reach the freelist, drop the read lock from
3837 ** the database file.
3838 */
3839 pPager->nRef--;
3840 assert( pPager->nRef>=0 );
danielk19773dedc192007-03-27 17:37:31 +00003841 if( pPager->nRef==0 && (!pPager->exclusiveMode || pPager->journalOff>0) ){
danielk1977e277be02007-03-23 18:12:06 +00003842 pagerUnlockAndRollback(pPager);
drhd9b02572001-04-15 00:37:09 +00003843 }
drhed7c8552001-04-11 14:29:21 +00003844 }
danielk1977ae72d982007-10-03 08:46:44 +00003845 pagerLeave(pPager);
drhd9b02572001-04-15 00:37:09 +00003846 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +00003847}
3848
3849/*
drha6abd042004-06-09 17:37:22 +00003850** Create a journal file for pPager. There should already be a RESERVED
3851** or EXCLUSIVE lock on the database file when this routine is called.
drhda47d772002-12-02 04:25:19 +00003852**
3853** Return SQLITE_OK if everything. Return an error code and release the
3854** write lock if anything goes wrong.
3855*/
3856static int pager_open_journal(Pager *pPager){
danielk1977b4b47412007-08-17 15:53:36 +00003857 sqlite3_vfs *pVfs = pPager->pVfs;
3858 int flags = (SQLITE_OPEN_READWRITE|SQLITE_OPEN_EXCLUSIVE|SQLITE_OPEN_CREATE);
3859
drhda47d772002-12-02 04:25:19 +00003860 int rc;
drhb7f91642004-10-31 02:22:47 +00003861 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +00003862 assert( pPager->state>=PAGER_RESERVED );
drhda47d772002-12-02 04:25:19 +00003863 assert( pPager->journalOpen==0 );
3864 assert( pPager->useJournal );
drhf5e7bb52008-02-18 14:47:33 +00003865 assert( pPager->pInJournal==0 );
danielk19773b8a05f2007-03-19 17:44:26 +00003866 sqlite3PagerPagecount(pPager);
drhed138fb2007-08-22 22:04:37 +00003867 pagerLeave(pPager);
drhf5e7bb52008-02-18 14:47:33 +00003868 pPager->pInJournal = sqlite3BitvecCreate(pPager->dbSize);
drhed138fb2007-08-22 22:04:37 +00003869 pagerEnter(pPager);
drhf5e7bb52008-02-18 14:47:33 +00003870 if( pPager->pInJournal==0 ){
drh9c105bb2004-10-02 20:38:28 +00003871 rc = SQLITE_NOMEM;
3872 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00003873 }
danielk1977b4b47412007-08-17 15:53:36 +00003874
3875 if( pPager->tempFile ){
danielk1977fee2d252007-08-18 10:59:19 +00003876 flags |= (SQLITE_OPEN_DELETEONCLOSE|SQLITE_OPEN_TEMP_JOURNAL);
3877 }else{
3878 flags |= (SQLITE_OPEN_MAIN_JOURNAL);
danielk1977b4b47412007-08-17 15:53:36 +00003879 }
danielk1977c7b60172007-08-22 11:22:03 +00003880#ifdef SQLITE_ENABLE_ATOMIC_WRITE
3881 rc = sqlite3JournalOpen(
3882 pVfs, pPager->zJournal, pPager->jfd, flags, jrnlBufferSize(pPager)
3883 );
3884#else
danielk1977b4b47412007-08-17 15:53:36 +00003885 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, flags, 0);
danielk1977c7b60172007-08-22 11:22:03 +00003886#endif
danielk1977b4b47412007-08-17 15:53:36 +00003887 assert( rc!=SQLITE_OK || pPager->jfd->pMethods );
danielk197776572402004-06-25 02:38:54 +00003888 pPager->journalOff = 0;
3889 pPager->setMaster = 0;
3890 pPager->journalHdr = 0;
drhda47d772002-12-02 04:25:19 +00003891 if( rc!=SQLITE_OK ){
drh600e46a2007-03-28 01:59:33 +00003892 if( rc==SQLITE_NOMEM ){
danielk1977fee2d252007-08-18 10:59:19 +00003893 sqlite3OsDelete(pVfs, pPager->zJournal, 0);
drh600e46a2007-03-28 01:59:33 +00003894 }
drh9c105bb2004-10-02 20:38:28 +00003895 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00003896 }
3897 pPager->journalOpen = 1;
drhdb48ee02003-01-16 13:42:43 +00003898 pPager->journalStarted = 0;
drhda47d772002-12-02 04:25:19 +00003899 pPager->needSync = 0;
3900 pPager->alwaysRollback = 0;
drh968af522003-02-11 14:55:40 +00003901 pPager->nRec = 0;
danielk1977efaaf572006-01-16 11:29:19 +00003902 if( pPager->errCode ){
3903 rc = pPager->errCode;
drhdd5b2fa2005-03-28 03:39:55 +00003904 goto failed_to_open_journal;
drh2e6d11b2003-04-25 15:37:57 +00003905 }
drhda47d772002-12-02 04:25:19 +00003906 pPager->origDbSize = pPager->dbSize;
drhae2b40c2004-06-09 19:03:54 +00003907
danielk197776572402004-06-25 02:38:54 +00003908 rc = writeJournalHdr(pPager);
3909
drhac69b052004-05-12 13:30:07 +00003910 if( pPager->stmtAutoopen && rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00003911 rc = sqlite3PagerStmtBegin(pPager);
drhda47d772002-12-02 04:25:19 +00003912 }
danielk1977ae72d982007-10-03 08:46:44 +00003913 if( rc!=SQLITE_OK && rc!=SQLITE_NOMEM && rc!=SQLITE_IOERR_NOMEM ){
drh80e35f42007-03-30 14:06:34 +00003914 rc = pager_end_transaction(pPager);
drhda47d772002-12-02 04:25:19 +00003915 if( rc==SQLITE_OK ){
3916 rc = SQLITE_FULL;
3917 }
3918 }
drh9c105bb2004-10-02 20:38:28 +00003919 return rc;
3920
3921failed_to_open_journal:
drhf5e7bb52008-02-18 14:47:33 +00003922 sqlite3BitvecDestroy(pPager->pInJournal);
3923 pPager->pInJournal = 0;
drh9c105bb2004-10-02 20:38:28 +00003924 return rc;
drhda47d772002-12-02 04:25:19 +00003925}
3926
3927/*
drh4b845d72002-03-05 12:41:19 +00003928** Acquire a write-lock on the database. The lock is removed when
3929** the any of the following happen:
3930**
drh80e35f42007-03-30 14:06:34 +00003931** * sqlite3PagerCommitPhaseTwo() is called.
danielk19773b8a05f2007-03-19 17:44:26 +00003932** * sqlite3PagerRollback() is called.
3933** * sqlite3PagerClose() is called.
3934** * sqlite3PagerUnref() is called to on every outstanding page.
drh4b845d72002-03-05 12:41:19 +00003935**
danielk197713adf8a2004-06-03 16:08:41 +00003936** The first parameter to this routine is a pointer to any open page of the
3937** database file. Nothing changes about the page - it is used merely to
3938** acquire a pointer to the Pager structure and as proof that there is
3939** already a read-lock on the database.
drh4b845d72002-03-05 12:41:19 +00003940**
danielk197713adf8a2004-06-03 16:08:41 +00003941** The second parameter indicates how much space in bytes to reserve for a
3942** master journal file-name at the start of the journal when it is created.
3943**
3944** A journal file is opened if this is not a temporary file. For temporary
3945** files, the opening of the journal file is deferred until there is an
3946** actual need to write to the journal.
drhda47d772002-12-02 04:25:19 +00003947**
drha6abd042004-06-09 17:37:22 +00003948** If the database is already reserved for writing, this routine is a no-op.
drh684917c2004-10-05 02:41:42 +00003949**
3950** If exFlag is true, go ahead and get an EXCLUSIVE lock on the file
3951** immediately instead of waiting until we try to flush the cache. The
3952** exFlag is ignored if a transaction is already active.
drh4b845d72002-03-05 12:41:19 +00003953*/
danielk19773b8a05f2007-03-19 17:44:26 +00003954int sqlite3PagerBegin(DbPage *pPg, int exFlag){
drh4b845d72002-03-05 12:41:19 +00003955 Pager *pPager = pPg->pPager;
3956 int rc = SQLITE_OK;
drh86f8c192007-08-22 00:39:19 +00003957 pagerEnter(pPager);
drh4b845d72002-03-05 12:41:19 +00003958 assert( pPg->nRef>0 );
drha6abd042004-06-09 17:37:22 +00003959 assert( pPager->state!=PAGER_UNLOCK );
3960 if( pPager->state==PAGER_SHARED ){
drhf5e7bb52008-02-18 14:47:33 +00003961 assert( pPager->pInJournal==0 );
drhb7f91642004-10-31 02:22:47 +00003962 if( MEMDB ){
drha6abd042004-06-09 17:37:22 +00003963 pPager->state = PAGER_EXCLUSIVE;
drhac69b052004-05-12 13:30:07 +00003964 pPager->origDbSize = pPager->dbSize;
3965 }else{
drh054889e2005-11-30 03:20:31 +00003966 rc = sqlite3OsLock(pPager->fd, RESERVED_LOCK);
drh684917c2004-10-05 02:41:42 +00003967 if( rc==SQLITE_OK ){
3968 pPager->state = PAGER_RESERVED;
3969 if( exFlag ){
3970 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
3971 }
3972 }
danielk19779eed5052004-06-04 10:38:30 +00003973 if( rc!=SQLITE_OK ){
drh86f8c192007-08-22 00:39:19 +00003974 pagerLeave(pPager);
danielk19779eed5052004-06-04 10:38:30 +00003975 return rc;
drhac69b052004-05-12 13:30:07 +00003976 }
drha6abd042004-06-09 17:37:22 +00003977 pPager->dirtyCache = 0;
drh4f0c5872007-03-26 22:05:01 +00003978 PAGERTRACE2("TRANSACTION %d\n", PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00003979 if( pPager->useJournal && !pPager->tempFile ){
3980 rc = pager_open_journal(pPager);
3981 }
drh4b845d72002-03-05 12:41:19 +00003982 }
danielk1977334cdb62007-03-26 08:05:12 +00003983 }else if( pPager->journalOpen && pPager->journalOff==0 ){
3984 /* This happens when the pager was in exclusive-access mode last
3985 ** time a (read or write) transaction was successfully concluded
3986 ** by this connection. Instead of deleting the journal file it was
3987 ** kept open and truncated to 0 bytes.
3988 */
3989 assert( pPager->nRec==0 );
3990 assert( pPager->origDbSize==0 );
drhf5e7bb52008-02-18 14:47:33 +00003991 assert( pPager->pInJournal==0 );
danielk1977334cdb62007-03-26 08:05:12 +00003992 sqlite3PagerPagecount(pPager);
drhed138fb2007-08-22 22:04:37 +00003993 pagerLeave(pPager);
drhf5e7bb52008-02-18 14:47:33 +00003994 pPager->pInJournal = sqlite3BitvecCreate( pPager->dbSize );
drhed138fb2007-08-22 22:04:37 +00003995 pagerEnter(pPager);
drhf5e7bb52008-02-18 14:47:33 +00003996 if( !pPager->pInJournal ){
danielk1977334cdb62007-03-26 08:05:12 +00003997 rc = SQLITE_NOMEM;
3998 }else{
drh369339d2007-03-30 16:01:55 +00003999 pPager->origDbSize = pPager->dbSize;
danielk1977334cdb62007-03-26 08:05:12 +00004000 rc = writeJournalHdr(pPager);
4001 }
drh4b845d72002-03-05 12:41:19 +00004002 }
danielk1977334cdb62007-03-26 08:05:12 +00004003 assert( !pPager->journalOpen || pPager->journalOff>0 || rc!=SQLITE_OK );
drh86f8c192007-08-22 00:39:19 +00004004 pagerLeave(pPager);
drh4b845d72002-03-05 12:41:19 +00004005 return rc;
4006}
4007
4008/*
drh605ad8f2006-05-03 23:34:05 +00004009** Make a page dirty. Set its dirty flag and add it to the dirty
4010** page list.
4011*/
4012static void makeDirty(PgHdr *pPg){
4013 if( pPg->dirty==0 ){
4014 Pager *pPager = pPg->pPager;
4015 pPg->dirty = 1;
4016 pPg->pDirty = pPager->pDirty;
4017 if( pPager->pDirty ){
4018 pPager->pDirty->pPrevDirty = pPg;
4019 }
4020 pPg->pPrevDirty = 0;
4021 pPager->pDirty = pPg;
4022 }
4023}
4024
4025/*
4026** Make a page clean. Clear its dirty bit and remove it from the
4027** dirty page list.
4028*/
4029static void makeClean(PgHdr *pPg){
4030 if( pPg->dirty ){
4031 pPg->dirty = 0;
4032 if( pPg->pDirty ){
drh153c62c2007-08-24 03:51:33 +00004033 assert( pPg->pDirty->pPrevDirty==pPg );
drh605ad8f2006-05-03 23:34:05 +00004034 pPg->pDirty->pPrevDirty = pPg->pPrevDirty;
4035 }
4036 if( pPg->pPrevDirty ){
drh153c62c2007-08-24 03:51:33 +00004037 assert( pPg->pPrevDirty->pDirty==pPg );
drh605ad8f2006-05-03 23:34:05 +00004038 pPg->pPrevDirty->pDirty = pPg->pDirty;
4039 }else{
drh153c62c2007-08-24 03:51:33 +00004040 assert( pPg->pPager->pDirty==pPg );
drh605ad8f2006-05-03 23:34:05 +00004041 pPg->pPager->pDirty = pPg->pDirty;
4042 }
4043 }
4044}
4045
4046
4047/*
drhed7c8552001-04-11 14:29:21 +00004048** Mark a data page as writeable. The page is written into the journal
4049** if it is not there already. This routine must be called before making
4050** changes to a page.
4051**
4052** The first time this routine is called, the pager creates a new
drha6abd042004-06-09 17:37:22 +00004053** journal and acquires a RESERVED lock on the database. If the RESERVED
drhed7c8552001-04-11 14:29:21 +00004054** lock could not be acquired, this routine returns SQLITE_BUSY. The
drh306dc212001-05-21 13:45:10 +00004055** calling routine must check for that return value and be careful not to
drhed7c8552001-04-11 14:29:21 +00004056** change any page data until this routine returns SQLITE_OK.
drhd9b02572001-04-15 00:37:09 +00004057**
4058** If the journal file could not be written because the disk is full,
4059** then this routine returns SQLITE_FULL and does an immediate rollback.
4060** All subsequent write attempts also return SQLITE_FULL until there
danielk19773b8a05f2007-03-19 17:44:26 +00004061** is a call to sqlite3PagerCommit() or sqlite3PagerRollback() to
drhd9b02572001-04-15 00:37:09 +00004062** reset.
drhed7c8552001-04-11 14:29:21 +00004063*/
danielk19773b8a05f2007-03-19 17:44:26 +00004064static int pager_write(PgHdr *pPg){
4065 void *pData = PGHDR_TO_DATA(pPg);
drh69688d52001-04-14 16:38:23 +00004066 Pager *pPager = pPg->pPager;
drhd79caeb2001-04-15 02:27:24 +00004067 int rc = SQLITE_OK;
drh69688d52001-04-14 16:38:23 +00004068
drh6446c4d2001-12-15 14:22:18 +00004069 /* Check for errors
4070 */
danielk1977efaaf572006-01-16 11:29:19 +00004071 if( pPager->errCode ){
4072 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00004073 }
drh5e00f6c2001-09-13 13:46:56 +00004074 if( pPager->readOnly ){
4075 return SQLITE_PERM;
4076 }
drh6446c4d2001-12-15 14:22:18 +00004077
danielk197776572402004-06-25 02:38:54 +00004078 assert( !pPager->setMaster );
4079
danielk19773c407372005-02-15 02:54:14 +00004080 CHECK_PAGE(pPg);
4081
drh538f5702007-04-13 02:14:30 +00004082 /* If this page was previously acquired with noContent==1, that means
4083 ** we didn't really read in the content of the page. This can happen
4084 ** (for example) when the page is being moved to the freelist. But
4085 ** now we are (perhaps) moving the page off of the freelist for
4086 ** reuse and we need to know its original content so that content
4087 ** can be stored in the rollback journal. So do the read at this
4088 ** time.
4089 */
drhd33d5a82007-04-26 12:11:28 +00004090 rc = pager_get_content(pPg);
4091 if( rc ){
4092 return rc;
drh538f5702007-04-13 02:14:30 +00004093 }
4094
drh6446c4d2001-12-15 14:22:18 +00004095 /* Mark the page as dirty. If the page has already been written
4096 ** to the journal then we can return right away.
4097 */
drh605ad8f2006-05-03 23:34:05 +00004098 makeDirty(pPg);
danielk1977f35843b2007-04-07 15:03:17 +00004099 if( pPg->inJournal && (pageInStatement(pPg) || pPager->stmtInUse==0) ){
drha6abd042004-06-09 17:37:22 +00004100 pPager->dirtyCache = 1;
danielk1977a0bf2652004-11-04 14:30:04 +00004101 }else{
drh6446c4d2001-12-15 14:22:18 +00004102
danielk1977a0bf2652004-11-04 14:30:04 +00004103 /* If we get this far, it means that the page needs to be
4104 ** written to the transaction journal or the ckeckpoint journal
4105 ** or both.
4106 **
4107 ** First check to see that the transaction journal exists and
4108 ** create it if it does not.
4109 */
4110 assert( pPager->state!=PAGER_UNLOCK );
danielk19773b8a05f2007-03-19 17:44:26 +00004111 rc = sqlite3PagerBegin(pPg, 0);
danielk1977a0bf2652004-11-04 14:30:04 +00004112 if( rc!=SQLITE_OK ){
4113 return rc;
4114 }
4115 assert( pPager->state>=PAGER_RESERVED );
4116 if( !pPager->journalOpen && pPager->useJournal ){
4117 rc = pager_open_journal(pPager);
4118 if( rc!=SQLITE_OK ) return rc;
4119 }
4120 assert( pPager->journalOpen || !pPager->useJournal );
4121 pPager->dirtyCache = 1;
4122
4123 /* The transaction journal now exists and we have a RESERVED or an
4124 ** EXCLUSIVE lock on the main database file. Write the current page to
4125 ** the transaction journal if it is not there already.
4126 */
4127 if( !pPg->inJournal && (pPager->useJournal || MEMDB) ){
4128 if( (int)pPg->pgno <= pPager->origDbSize ){
danielk1977a0bf2652004-11-04 14:30:04 +00004129 if( MEMDB ){
4130 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
drh4f0c5872007-03-26 22:05:01 +00004131 PAGERTRACE3("JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00004132 assert( pHist->pOrig==0 );
drh17435752007-08-16 04:30:38 +00004133 pHist->pOrig = sqlite3_malloc( pPager->pageSize );
danielk1977662278e2007-11-05 15:30:12 +00004134 if( !pHist->pOrig ){
4135 return SQLITE_NOMEM;
danielk1977a0bf2652004-11-04 14:30:04 +00004136 }
danielk1977662278e2007-11-05 15:30:12 +00004137 memcpy(pHist->pOrig, PGHDR_TO_DATA(pPg), pPager->pageSize);
danielk1977a0bf2652004-11-04 14:30:04 +00004138 }else{
drhbf4bca52007-09-06 22:19:14 +00004139 u32 cksum;
4140 char *pData2;
danielk1977dd97a492007-08-22 18:54:32 +00004141
drh267cb322005-09-16 17:16:52 +00004142 /* We should never write to the journal file the page that
4143 ** contains the database locks. The following assert verifies
4144 ** that we do not. */
4145 assert( pPg->pgno!=PAGER_MJ_PGNO(pPager) );
drhc001c582006-03-06 18:23:16 +00004146 pData2 = CODEC2(pPager, pData, pPg->pgno, 7);
drh37527852006-03-16 16:19:56 +00004147 cksum = pager_cksum(pPager, (u8*)pData2);
drhbf4bca52007-09-06 22:19:14 +00004148 rc = write32bits(pPager->jfd, pPager->journalOff, pPg->pgno);
4149 if( rc==SQLITE_OK ){
4150 rc = sqlite3OsWrite(pPager->jfd, pData2, pPager->pageSize,
4151 pPager->journalOff + 4);
4152 pPager->journalOff += pPager->pageSize+4;
4153 }
4154 if( rc==SQLITE_OK ){
4155 rc = write32bits(pPager->jfd, pPager->journalOff, cksum);
4156 pPager->journalOff += 4;
4157 }
4158 IOTRACE(("JOUT %p %d %lld %d\n", pPager, pPg->pgno,
danielk1977667a6c92007-09-10 06:12:04 +00004159 pPager->journalOff, pPager->pageSize));
drh538f5702007-04-13 02:14:30 +00004160 PAGER_INCR(sqlite3_pager_writej_count);
drh477731b2007-06-16 03:06:27 +00004161 PAGERTRACE5("JOURNAL %d page %d needSync=%d hash(%08x)\n",
4162 PAGERID(pPager), pPg->pgno, pPg->needSync, pager_pagehash(pPg));
danielk197707cb5602006-01-20 10:55:05 +00004163
drhfd131da2007-08-07 17:13:03 +00004164 /* An error has occured writing to the journal file. The
danielk197707cb5602006-01-20 10:55:05 +00004165 ** transaction will be rolled back by the layer above.
4166 */
danielk1977a0bf2652004-11-04 14:30:04 +00004167 if( rc!=SQLITE_OK ){
danielk1977a0bf2652004-11-04 14:30:04 +00004168 return rc;
4169 }
danielk197707cb5602006-01-20 10:55:05 +00004170
danielk1977a0bf2652004-11-04 14:30:04 +00004171 pPager->nRec++;
drhf5e7bb52008-02-18 14:47:33 +00004172 assert( pPager->pInJournal!=0 );
4173 sqlite3BitvecSet(pPager->pInJournal, pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00004174 pPg->needSync = !pPager->noSync;
4175 if( pPager->stmtInUse ){
drhf5e7bb52008-02-18 14:47:33 +00004176 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00004177 }
drhac69b052004-05-12 13:30:07 +00004178 }
danielk197713adf8a2004-06-03 16:08:41 +00004179 }else{
danielk1977a0bf2652004-11-04 14:30:04 +00004180 pPg->needSync = !pPager->journalStarted && !pPager->noSync;
drh4f0c5872007-03-26 22:05:01 +00004181 PAGERTRACE4("APPEND %d page %d needSync=%d\n",
danielk1977ef73ee92004-11-06 12:26:07 +00004182 PAGERID(pPager), pPg->pgno, pPg->needSync);
danielk1977a0bf2652004-11-04 14:30:04 +00004183 }
4184 if( pPg->needSync ){
4185 pPager->needSync = 1;
4186 }
4187 pPg->inJournal = 1;
4188 }
4189
4190 /* If the statement journal is open and the page is not in it,
4191 ** then write the current page to the statement journal. Note that
4192 ** the statement journal format differs from the standard journal format
4193 ** in that it omits the checksums and the header.
4194 */
danielk1977f35843b2007-04-07 15:03:17 +00004195 if( pPager->stmtInUse
4196 && !pageInStatement(pPg)
4197 && (int)pPg->pgno<=pPager->stmtSize
4198 ){
danielk1977a0bf2652004-11-04 14:30:04 +00004199 assert( pPg->inJournal || (int)pPg->pgno>pPager->origDbSize );
4200 if( MEMDB ){
4201 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
4202 assert( pHist->pStmt==0 );
drh17435752007-08-16 04:30:38 +00004203 pHist->pStmt = sqlite3_malloc( pPager->pageSize );
danielk1977a0bf2652004-11-04 14:30:04 +00004204 if( pHist->pStmt ){
4205 memcpy(pHist->pStmt, PGHDR_TO_DATA(pPg), pPager->pageSize);
4206 }
drh4f0c5872007-03-26 22:05:01 +00004207 PAGERTRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk1977f35843b2007-04-07 15:03:17 +00004208 page_add_to_stmt_list(pPg);
danielk1977a0bf2652004-11-04 14:30:04 +00004209 }else{
danielk197762079062007-08-15 17:08:46 +00004210 i64 offset = pPager->stmtNRec*(4+pPager->pageSize);
drhbf4bca52007-09-06 22:19:14 +00004211 char *pData2 = CODEC2(pPager, pData, pPg->pgno, 7);
4212 rc = write32bits(pPager->stfd, offset, pPg->pgno);
4213 if( rc==SQLITE_OK ){
4214 rc = sqlite3OsWrite(pPager->stfd, pData2, pPager->pageSize, offset+4);
4215 }
drh4f0c5872007-03-26 22:05:01 +00004216 PAGERTRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
drhac69b052004-05-12 13:30:07 +00004217 if( rc!=SQLITE_OK ){
drhac69b052004-05-12 13:30:07 +00004218 return rc;
4219 }
danielk1977a0bf2652004-11-04 14:30:04 +00004220 pPager->stmtNRec++;
drhf5e7bb52008-02-18 14:47:33 +00004221 assert( pPager->pInStmt!=0 );
4222 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
drhdb48ee02003-01-16 13:42:43 +00004223 }
drhd9b02572001-04-15 00:37:09 +00004224 }
drhfa86c412002-02-02 15:01:15 +00004225 }
4226
4227 /* Update the database size and return.
4228 */
drh1aa2d8b2007-01-03 15:34:29 +00004229 assert( pPager->state>=PAGER_SHARED );
drh1ab43002002-01-14 09:28:19 +00004230 if( pPager->dbSize<(int)pPg->pgno ){
drh306dc212001-05-21 13:45:10 +00004231 pPager->dbSize = pPg->pgno;
drhb7f91642004-10-31 02:22:47 +00004232 if( !MEMDB && pPager->dbSize==PENDING_BYTE/pPager->pageSize ){
drh1f595712004-06-15 01:40:29 +00004233 pPager->dbSize++;
4234 }
drh306dc212001-05-21 13:45:10 +00004235 }
drh69688d52001-04-14 16:38:23 +00004236 return rc;
drhed7c8552001-04-11 14:29:21 +00004237}
4238
4239/*
danielk19774099f6e2007-03-19 11:25:20 +00004240** This function is used to mark a data-page as writable. It uses
4241** pager_write() to open a journal file (if it is not already open)
4242** and write the page *pData to the journal.
4243**
4244** The difference between this function and pager_write() is that this
4245** function also deals with the special case where 2 or more pages
4246** fit on a single disk sector. In this case all co-resident pages
4247** must have been written to the journal file before returning.
4248*/
danielk19773b8a05f2007-03-19 17:44:26 +00004249int sqlite3PagerWrite(DbPage *pDbPage){
danielk19774099f6e2007-03-19 11:25:20 +00004250 int rc = SQLITE_OK;
4251
danielk19773b8a05f2007-03-19 17:44:26 +00004252 PgHdr *pPg = pDbPage;
danielk19774099f6e2007-03-19 11:25:20 +00004253 Pager *pPager = pPg->pPager;
4254 Pgno nPagePerSector = (pPager->sectorSize/pPager->pageSize);
4255
drh86f8c192007-08-22 00:39:19 +00004256 pagerEnter(pPager);
danielk19774099f6e2007-03-19 11:25:20 +00004257 if( !MEMDB && nPagePerSector>1 ){
4258 Pgno nPageCount; /* Total number of pages in database file */
4259 Pgno pg1; /* First page of the sector pPg is located on. */
4260 int nPage; /* Number of pages starting at pg1 to journal */
4261 int ii;
danielk1977dd97a492007-08-22 18:54:32 +00004262 int needSync = 0;
danielk19774099f6e2007-03-19 11:25:20 +00004263
4264 /* Set the doNotSync flag to 1. This is because we cannot allow a journal
4265 ** header to be written between the pages journaled by this function.
4266 */
4267 assert( pPager->doNotSync==0 );
4268 pPager->doNotSync = 1;
4269
4270 /* This trick assumes that both the page-size and sector-size are
4271 ** an integer power of 2. It sets variable pg1 to the identifier
4272 ** of the first page of the sector pPg is located on.
4273 */
4274 pg1 = ((pPg->pgno-1) & ~(nPagePerSector-1)) + 1;
4275
danielk19773b8a05f2007-03-19 17:44:26 +00004276 nPageCount = sqlite3PagerPagecount(pPager);
danielk19774099f6e2007-03-19 11:25:20 +00004277 if( pPg->pgno>nPageCount ){
4278 nPage = (pPg->pgno - pg1)+1;
4279 }else if( (pg1+nPagePerSector-1)>nPageCount ){
4280 nPage = nPageCount+1-pg1;
4281 }else{
4282 nPage = nPagePerSector;
4283 }
4284 assert(nPage>0);
4285 assert(pg1<=pPg->pgno);
4286 assert((pg1+nPage)>pPg->pgno);
4287
4288 for(ii=0; ii<nPage && rc==SQLITE_OK; ii++){
4289 Pgno pg = pg1+ii;
danielk1977dd97a492007-08-22 18:54:32 +00004290 PgHdr *pPage;
drhf5e7bb52008-02-18 14:47:33 +00004291 if( pg==pPg->pgno || !sqlite3BitvecTest(pPager->pInJournal, pg) ){
danielk19774099f6e2007-03-19 11:25:20 +00004292 if( pg!=PAGER_MJ_PGNO(pPager) ){
danielk19773b8a05f2007-03-19 17:44:26 +00004293 rc = sqlite3PagerGet(pPager, pg, &pPage);
danielk19774099f6e2007-03-19 11:25:20 +00004294 if( rc==SQLITE_OK ){
4295 rc = pager_write(pPage);
danielk1977dd97a492007-08-22 18:54:32 +00004296 if( pPage->needSync ){
4297 needSync = 1;
4298 }
danielk19773b8a05f2007-03-19 17:44:26 +00004299 sqlite3PagerUnref(pPage);
danielk19774099f6e2007-03-19 11:25:20 +00004300 }
4301 }
drhc81945e2008-03-10 14:12:53 +00004302 }else if( (pPage = pager_lookup(pPager, pg))!=0 ){
danielk1977dd97a492007-08-22 18:54:32 +00004303 if( pPage->needSync ){
4304 needSync = 1;
4305 }
danielk19774099f6e2007-03-19 11:25:20 +00004306 }
4307 }
4308
danielk1977dd97a492007-08-22 18:54:32 +00004309 /* If the PgHdr.needSync flag is set for any of the nPage pages
4310 ** starting at pg1, then it needs to be set for all of them. Because
4311 ** writing to any of these nPage pages may damage the others, the
4312 ** journal file must contain sync()ed copies of all of them
4313 ** before any of them can be written out to the database file.
4314 */
4315 if( needSync ){
4316 for(ii=0; ii<nPage && needSync; ii++){
4317 PgHdr *pPage = pager_lookup(pPager, pg1+ii);
4318 if( pPage ) pPage->needSync = 1;
4319 }
4320 assert(pPager->needSync);
4321 }
4322
danielk19774099f6e2007-03-19 11:25:20 +00004323 assert( pPager->doNotSync==1 );
4324 pPager->doNotSync = 0;
4325 }else{
danielk19773b8a05f2007-03-19 17:44:26 +00004326 rc = pager_write(pDbPage);
danielk19774099f6e2007-03-19 11:25:20 +00004327 }
drh86f8c192007-08-22 00:39:19 +00004328 pagerLeave(pPager);
danielk19774099f6e2007-03-19 11:25:20 +00004329 return rc;
4330}
4331
4332/*
drhaacc5432002-01-06 17:07:40 +00004333** Return TRUE if the page given in the argument was previously passed
danielk19773b8a05f2007-03-19 17:44:26 +00004334** to sqlite3PagerWrite(). In other words, return TRUE if it is ok
drh6019e162001-07-02 17:51:45 +00004335** to change the content of the page.
4336*/
danielk19777d3a6662006-01-23 16:21:05 +00004337#ifndef NDEBUG
danielk19773b8a05f2007-03-19 17:44:26 +00004338int sqlite3PagerIswriteable(DbPage *pPg){
drh6019e162001-07-02 17:51:45 +00004339 return pPg->dirty;
4340}
danielk19777d3a6662006-01-23 16:21:05 +00004341#endif
drh6019e162001-07-02 17:51:45 +00004342
danielk1977b84f96f2005-01-20 11:32:23 +00004343#ifndef SQLITE_OMIT_VACUUM
drh6019e162001-07-02 17:51:45 +00004344/*
drh001bbcb2003-03-19 03:14:00 +00004345** Replace the content of a single page with the information in the third
4346** argument.
4347*/
danielk19773b8a05f2007-03-19 17:44:26 +00004348int sqlite3PagerOverwrite(Pager *pPager, Pgno pgno, void *pData){
4349 PgHdr *pPg;
drh001bbcb2003-03-19 03:14:00 +00004350 int rc;
4351
drh86f8c192007-08-22 00:39:19 +00004352 pagerEnter(pPager);
danielk19773b8a05f2007-03-19 17:44:26 +00004353 rc = sqlite3PagerGet(pPager, pgno, &pPg);
drh001bbcb2003-03-19 03:14:00 +00004354 if( rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00004355 rc = sqlite3PagerWrite(pPg);
drh001bbcb2003-03-19 03:14:00 +00004356 if( rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00004357 memcpy(sqlite3PagerGetData(pPg), pData, pPager->pageSize);
drh001bbcb2003-03-19 03:14:00 +00004358 }
danielk19773b8a05f2007-03-19 17:44:26 +00004359 sqlite3PagerUnref(pPg);
drh001bbcb2003-03-19 03:14:00 +00004360 }
drh86f8c192007-08-22 00:39:19 +00004361 pagerLeave(pPager);
drh001bbcb2003-03-19 03:14:00 +00004362 return rc;
4363}
danielk1977b84f96f2005-01-20 11:32:23 +00004364#endif
drh001bbcb2003-03-19 03:14:00 +00004365
4366/*
drh30e58752002-03-02 20:41:57 +00004367** A call to this routine tells the pager that it is not necessary to
drh538f5702007-04-13 02:14:30 +00004368** write the information on page pPg back to the disk, even though
drh30e58752002-03-02 20:41:57 +00004369** that page might be marked as dirty.
4370**
4371** The overlying software layer calls this routine when all of the data
4372** on the given page is unused. The pager marks the page as clean so
4373** that it does not get written to disk.
4374**
4375** Tests show that this optimization, together with the
danielk19773b8a05f2007-03-19 17:44:26 +00004376** sqlite3PagerDontRollback() below, more than double the speed
drh30e58752002-03-02 20:41:57 +00004377** of large INSERT operations and quadruple the speed of large DELETEs.
drh8e298f92002-07-06 16:28:47 +00004378**
4379** When this routine is called, set the alwaysRollback flag to true.
danielk19773b8a05f2007-03-19 17:44:26 +00004380** Subsequent calls to sqlite3PagerDontRollback() for the same page
drh8e298f92002-07-06 16:28:47 +00004381** will thereafter be ignored. This is necessary to avoid a problem
4382** where a page with data is added to the freelist during one part of
4383** a transaction then removed from the freelist during a later part
4384** of the same transaction and reused for some other purpose. When it
4385** is first added to the freelist, this routine is called. When reused,
drh80e35f42007-03-30 14:06:34 +00004386** the sqlite3PagerDontRollback() routine is called. But because the
4387** page contains critical data, we still need to be sure it gets
4388** rolled back in spite of the sqlite3PagerDontRollback() call.
drh30e58752002-03-02 20:41:57 +00004389*/
drh538f5702007-04-13 02:14:30 +00004390void sqlite3PagerDontWrite(DbPage *pDbPage){
4391 PgHdr *pPg = pDbPage;
4392 Pager *pPager = pPg->pPager;
drh8e298f92002-07-06 16:28:47 +00004393
drhb7f91642004-10-31 02:22:47 +00004394 if( MEMDB ) return;
drh86f8c192007-08-22 00:39:19 +00004395 pagerEnter(pPager);
drh8e298f92002-07-06 16:28:47 +00004396 pPg->alwaysRollback = 1;
drh43617e92006-03-06 20:55:46 +00004397 if( pPg->dirty && !pPager->stmtInUse ){
drh1aa2d8b2007-01-03 15:34:29 +00004398 assert( pPager->state>=PAGER_SHARED );
drh8124a302002-06-25 14:43:57 +00004399 if( pPager->dbSize==(int)pPg->pgno && pPager->origDbSize<pPager->dbSize ){
4400 /* If this pages is the last page in the file and the file has grown
4401 ** during the current transaction, then do NOT mark the page as clean.
4402 ** When the database file grows, we must make sure that the last page
4403 ** gets written at least once so that the disk file will be the correct
4404 ** size. If you do not write this page and the size of the file
4405 ** on the disk ends up being too small, that can lead to database
4406 ** corruption during the next transaction.
4407 */
4408 }else{
drh538f5702007-04-13 02:14:30 +00004409 PAGERTRACE3("DONT_WRITE page %d of %d\n", pPg->pgno, PAGERID(pPager));
4410 IOTRACE(("CLEAN %p %d\n", pPager, pPg->pgno))
drh605ad8f2006-05-03 23:34:05 +00004411 makeClean(pPg);
danielk19773c407372005-02-15 02:54:14 +00004412#ifdef SQLITE_CHECK_PAGES
4413 pPg->pageHash = pager_pagehash(pPg);
4414#endif
drh8124a302002-06-25 14:43:57 +00004415 }
drh30e58752002-03-02 20:41:57 +00004416 }
drh86f8c192007-08-22 00:39:19 +00004417 pagerLeave(pPager);
drh30e58752002-03-02 20:41:57 +00004418}
4419
4420/*
4421** A call to this routine tells the pager that if a rollback occurs,
4422** it is not necessary to restore the data on the given page. This
4423** means that the pager does not have to record the given page in the
4424** rollback journal.
drh538f5702007-04-13 02:14:30 +00004425**
4426** If we have not yet actually read the content of this page (if
4427** the PgHdr.needRead flag is set) then this routine acts as a promise
4428** that we will never need to read the page content in the future.
4429** so the needRead flag can be cleared at this point.
danielk1977a55e9352008-01-21 13:04:34 +00004430**
4431** This routine is only called from a single place in the sqlite btree
4432** code (when a leaf is removed from the free-list). This allows the
4433** following assumptions to be made about pPg:
4434**
4435** 1. PagerDontWrite() has been called on the page, OR
4436** PagerWrite() has not yet been called on the page.
4437**
4438** 2. The page existed when the transaction was started.
4439**
4440** Details: DontRollback() (this routine) is only called when a leaf is
4441** removed from the free list. DontWrite() is called whenever a page
4442** becomes a free-list leaf.
drh30e58752002-03-02 20:41:57 +00004443*/
danielk19773b8a05f2007-03-19 17:44:26 +00004444void sqlite3PagerDontRollback(DbPage *pPg){
drh30e58752002-03-02 20:41:57 +00004445 Pager *pPager = pPg->pPager;
4446
drh86f8c192007-08-22 00:39:19 +00004447 pagerEnter(pPager);
drhd3627af2006-12-18 18:34:51 +00004448 assert( pPager->state>=PAGER_RESERVED );
danielk1977a55e9352008-01-21 13:04:34 +00004449
4450 /* If the journal file is not open, or DontWrite() has been called on
4451 ** this page (DontWrite() sets the alwaysRollback flag), then this
4452 ** function is a no-op.
4453 */
4454 if( pPager->journalOpen==0 || pPg->alwaysRollback || pPager->alwaysRollback ){
danielk197787c29a92008-01-18 11:33:16 +00004455 pagerLeave(pPager);
4456 return;
4457 }
danielk1977a55e9352008-01-21 13:04:34 +00004458 assert( !MEMDB ); /* For a memdb, pPager->journalOpen is always 0 */
4459
4460 /* Check that PagerWrite() has not yet been called on this page, and
4461 ** that the page existed when the transaction started.
4462 */
4463 assert( !pPg->inJournal && (int)pPg->pgno <= pPager->origDbSize );
4464
drhf5e7bb52008-02-18 14:47:33 +00004465 assert( pPager->pInJournal!=0 );
4466 sqlite3BitvecSet(pPager->pInJournal, pPg->pgno);
danielk1977a55e9352008-01-21 13:04:34 +00004467 pPg->inJournal = 1;
4468 pPg->needRead = 0;
4469 if( pPager->stmtInUse ){
4470 assert( pPager->stmtSize <= pPager->origDbSize );
drhf5e7bb52008-02-18 14:47:33 +00004471 sqlite3BitvecSet(pPager->pInStmt, pPg->pgno);
drh30e58752002-03-02 20:41:57 +00004472 }
danielk1977a55e9352008-01-21 13:04:34 +00004473 PAGERTRACE3("DONT_ROLLBACK page %d of %d\n", pPg->pgno, PAGERID(pPager));
4474 IOTRACE(("GARBAGE %p %d\n", pPager, pPg->pgno))
drh86f8c192007-08-22 00:39:19 +00004475 pagerLeave(pPager);
drh30e58752002-03-02 20:41:57 +00004476}
4477
drhac69b052004-05-12 13:30:07 +00004478
drh30e58752002-03-02 20:41:57 +00004479/*
drh80e35f42007-03-30 14:06:34 +00004480** This routine is called to increment the database file change-counter,
4481** stored at byte 24 of the pager file.
4482*/
danielk1977c7b60172007-08-22 11:22:03 +00004483static int pager_incr_changecounter(Pager *pPager, int isDirect){
drh80e35f42007-03-30 14:06:34 +00004484 PgHdr *pPgHdr;
4485 u32 change_counter;
danielk1977c7b60172007-08-22 11:22:03 +00004486 int rc = SQLITE_OK;
drh80e35f42007-03-30 14:06:34 +00004487
4488 if( !pPager->changeCountDone ){
4489 /* Open page 1 of the file for writing. */
4490 rc = sqlite3PagerGet(pPager, 1, &pPgHdr);
4491 if( rc!=SQLITE_OK ) return rc;
danielk1977c7b60172007-08-22 11:22:03 +00004492
4493 if( !isDirect ){
4494 rc = sqlite3PagerWrite(pPgHdr);
danielk1977ae72d982007-10-03 08:46:44 +00004495 if( rc!=SQLITE_OK ){
4496 sqlite3PagerUnref(pPgHdr);
4497 return rc;
4498 }
danielk1977c7b60172007-08-22 11:22:03 +00004499 }
4500
drh80e35f42007-03-30 14:06:34 +00004501 /* Increment the value just read and write it back to byte 24. */
drhb1003912007-07-20 00:33:36 +00004502 change_counter = sqlite3Get4byte((u8*)pPager->dbFileVers);
drh80e35f42007-03-30 14:06:34 +00004503 change_counter++;
4504 put32bits(((char*)PGHDR_TO_DATA(pPgHdr))+24, change_counter);
danielk1977c7b60172007-08-22 11:22:03 +00004505
4506 if( isDirect && pPager->fd->pMethods ){
4507 const void *zBuf = PGHDR_TO_DATA(pPgHdr);
4508 rc = sqlite3OsWrite(pPager->fd, zBuf, pPager->pageSize, 0);
4509 }
4510
drh80e35f42007-03-30 14:06:34 +00004511 /* Release the page reference. */
4512 sqlite3PagerUnref(pPgHdr);
4513 pPager->changeCountDone = 1;
4514 }
danielk1977c7b60172007-08-22 11:22:03 +00004515 return rc;
drh80e35f42007-03-30 14:06:34 +00004516}
4517
4518/*
danielk1977f653d782008-03-20 11:04:21 +00004519** Sync the pager file to disk.
4520*/
4521int sqlite3PagerSync(Pager *pPager){
4522 int rc;
4523 pagerEnter(pPager);
4524 rc = sqlite3OsSync(pPager->fd, pPager->sync_flags);
4525 pagerLeave(pPager);
4526 return rc;
4527}
4528
4529/*
drh80e35f42007-03-30 14:06:34 +00004530** Sync the database file for the pager pPager. zMaster points to the name
4531** of a master journal file that should be written into the individual
4532** journal file. zMaster may be NULL, which is interpreted as no master
4533** journal (a single database transaction).
4534**
4535** This routine ensures that the journal is synced, all dirty pages written
4536** to the database file and the database file synced. The only thing that
4537** remains to commit the transaction is to delete the journal file (or
4538** master journal file if specified).
4539**
4540** Note that if zMaster==NULL, this does not overwrite a previous value
4541** passed to an sqlite3PagerCommitPhaseOne() call.
4542**
4543** If parameter nTrunc is non-zero, then the pager file is truncated to
4544** nTrunc pages (this is used by auto-vacuum databases).
danielk1977f653d782008-03-20 11:04:21 +00004545**
4546** If the final parameter - noSync - is true, then the database file itself
4547** is not synced. The caller must call sqlite3PagerSync() directly to
4548** sync the database file before calling CommitPhaseTwo() to delete the
4549** journal file in this case.
drh80e35f42007-03-30 14:06:34 +00004550*/
danielk1977f653d782008-03-20 11:04:21 +00004551int sqlite3PagerCommitPhaseOne(
4552 Pager *pPager,
4553 const char *zMaster,
4554 Pgno nTrunc,
4555 int noSync
4556){
drh80e35f42007-03-30 14:06:34 +00004557 int rc = SQLITE_OK;
4558
4559 PAGERTRACE4("DATABASE SYNC: File=%s zMaster=%s nTrunc=%d\n",
4560 pPager->zFilename, zMaster, nTrunc);
drh86f8c192007-08-22 00:39:19 +00004561 pagerEnter(pPager);
drh80e35f42007-03-30 14:06:34 +00004562
4563 /* If this is an in-memory db, or no pages have been written to, or this
4564 ** function has already been called, it is a no-op.
4565 */
4566 if( pPager->state!=PAGER_SYNCED && !MEMDB && pPager->dirtyCache ){
4567 PgHdr *pPg;
drh80e35f42007-03-30 14:06:34 +00004568
danielk1977c7b60172007-08-22 11:22:03 +00004569#ifdef SQLITE_ENABLE_ATOMIC_WRITE
4570 /* The atomic-write optimization can be used if all of the
4571 ** following are true:
4572 **
4573 ** + The file-system supports the atomic-write property for
4574 ** blocks of size page-size, and
4575 ** + This commit is not part of a multi-file transaction, and
4576 ** + Exactly one page has been modified and store in the journal file.
4577 **
4578 ** If the optimization can be used, then the journal file will never
4579 ** be created for this transaction.
4580 */
danielk1977f55b8992007-08-24 08:15:53 +00004581 int useAtomicWrite = (
4582 !zMaster &&
4583 pPager->journalOff==jrnlBufferSize(pPager) &&
4584 nTrunc==0 &&
4585 (0==pPager->pDirty || 0==pPager->pDirty->pDirty)
4586 );
4587 if( useAtomicWrite ){
danielk1977c7b60172007-08-22 11:22:03 +00004588 /* Update the nRec field in the journal file. */
4589 int offset = pPager->journalHdr + sizeof(aJournalMagic);
4590 assert(pPager->nRec==1);
4591 rc = write32bits(pPager->jfd, offset, pPager->nRec);
4592
4593 /* Update the db file change counter. The following call will modify
4594 ** the in-memory representation of page 1 to include the updated
4595 ** change counter and then write page 1 directly to the database
4596 ** file. Because of the atomic-write property of the host file-system,
4597 ** this is safe.
4598 */
danielk1977ae72d982007-10-03 08:46:44 +00004599 if( rc==SQLITE_OK ){
4600 rc = pager_incr_changecounter(pPager, 1);
4601 }
danielk1977f55b8992007-08-24 08:15:53 +00004602 }else{
4603 rc = sqlite3JournalCreate(pPager->jfd);
danielk1977f55b8992007-08-24 08:15:53 +00004604 }
4605
danielk1977ae72d982007-10-03 08:46:44 +00004606 if( !useAtomicWrite && rc==SQLITE_OK )
danielk1977c7b60172007-08-22 11:22:03 +00004607#endif
4608
drh80e35f42007-03-30 14:06:34 +00004609 /* If a master journal file name has already been written to the
4610 ** journal file, then no sync is required. This happens when it is
4611 ** written, then the process fails to upgrade from a RESERVED to an
4612 ** EXCLUSIVE lock. The next time the process tries to commit the
4613 ** transaction the m-j name will have already been written.
4614 */
4615 if( !pPager->setMaster ){
danielk1977f55b8992007-08-24 08:15:53 +00004616 assert( pPager->journalOpen );
danielk1977c7b60172007-08-22 11:22:03 +00004617 rc = pager_incr_changecounter(pPager, 0);
drh80e35f42007-03-30 14:06:34 +00004618 if( rc!=SQLITE_OK ) goto sync_exit;
4619#ifndef SQLITE_OMIT_AUTOVACUUM
4620 if( nTrunc!=0 ){
4621 /* If this transaction has made the database smaller, then all pages
4622 ** being discarded by the truncation must be written to the journal
4623 ** file.
4624 */
4625 Pgno i;
4626 int iSkip = PAGER_MJ_PGNO(pPager);
4627 for( i=nTrunc+1; i<=pPager->origDbSize; i++ ){
drhf5e7bb52008-02-18 14:47:33 +00004628 if( !sqlite3BitvecTest(pPager->pInJournal, i) && i!=iSkip ){
drh80e35f42007-03-30 14:06:34 +00004629 rc = sqlite3PagerGet(pPager, i, &pPg);
4630 if( rc!=SQLITE_OK ) goto sync_exit;
4631 rc = sqlite3PagerWrite(pPg);
4632 sqlite3PagerUnref(pPg);
4633 if( rc!=SQLITE_OK ) goto sync_exit;
4634 }
4635 }
4636 }
4637#endif
4638 rc = writeMasterJournal(pPager, zMaster);
4639 if( rc!=SQLITE_OK ) goto sync_exit;
4640 rc = syncJournal(pPager);
drh80e35f42007-03-30 14:06:34 +00004641 }
danielk1977c7b60172007-08-22 11:22:03 +00004642 if( rc!=SQLITE_OK ) goto sync_exit;
drh80e35f42007-03-30 14:06:34 +00004643
4644#ifndef SQLITE_OMIT_AUTOVACUUM
4645 if( nTrunc!=0 ){
4646 rc = sqlite3PagerTruncate(pPager, nTrunc);
4647 if( rc!=SQLITE_OK ) goto sync_exit;
4648 }
4649#endif
4650
4651 /* Write all dirty pages to the database file */
4652 pPg = pager_get_all_dirty_pages(pPager);
4653 rc = pager_write_pagelist(pPg);
drh153c62c2007-08-24 03:51:33 +00004654 if( rc!=SQLITE_OK ){
drh04c3a462008-02-26 16:16:45 +00004655 assert( rc!=SQLITE_IOERR_BLOCKED );
4656 /* The error might have left the dirty list all fouled up here,
4657 ** but that does not matter because if the if the dirty list did
4658 ** get corrupted, then the transaction will roll back and
4659 ** discard the dirty list. There is an assert in
4660 ** pager_get_all_dirty_pages() that verifies that no attempt
4661 ** is made to use an invalid dirty list.
4662 */
drh153c62c2007-08-24 03:51:33 +00004663 goto sync_exit;
4664 }
drh3cdd7d32007-03-30 14:46:01 +00004665 pPager->pDirty = 0;
drh80e35f42007-03-30 14:06:34 +00004666
4667 /* Sync the database file. */
danielk1977f653d782008-03-20 11:04:21 +00004668 if( !pPager->noSync && !noSync ){
danielk1977f036aef2007-08-20 05:36:51 +00004669 rc = sqlite3OsSync(pPager->fd, pPager->sync_flags);
drh80e35f42007-03-30 14:06:34 +00004670 }
4671 IOTRACE(("DBSYNC %p\n", pPager))
4672
4673 pPager->state = PAGER_SYNCED;
4674 }else if( MEMDB && nTrunc!=0 ){
4675 rc = sqlite3PagerTruncate(pPager, nTrunc);
4676 }
4677
4678sync_exit:
danielk1977e965ac72007-06-13 15:22:28 +00004679 if( rc==SQLITE_IOERR_BLOCKED ){
4680 /* pager_incr_changecounter() may attempt to obtain an exclusive
4681 * lock to spill the cache and return IOERR_BLOCKED. But since
drh85b623f2007-12-13 21:54:09 +00004682 * there is no chance the cache is inconsistent, it is
danielk1977e965ac72007-06-13 15:22:28 +00004683 * better to return SQLITE_BUSY.
4684 */
4685 rc = SQLITE_BUSY;
4686 }
drh86f8c192007-08-22 00:39:19 +00004687 pagerLeave(pPager);
drh80e35f42007-03-30 14:06:34 +00004688 return rc;
4689}
4690
4691
4692/*
drhed7c8552001-04-11 14:29:21 +00004693** Commit all changes to the database and release the write lock.
drhd9b02572001-04-15 00:37:09 +00004694**
4695** If the commit fails for any reason, a rollback attempt is made
4696** and an error code is returned. If the commit worked, SQLITE_OK
4697** is returned.
drhed7c8552001-04-11 14:29:21 +00004698*/
drh80e35f42007-03-30 14:06:34 +00004699int sqlite3PagerCommitPhaseTwo(Pager *pPager){
drha1b351a2001-09-14 16:42:12 +00004700 int rc;
drhed7c8552001-04-11 14:29:21 +00004701 PgHdr *pPg;
drhd9b02572001-04-15 00:37:09 +00004702
danielk1977efaaf572006-01-16 11:29:19 +00004703 if( pPager->errCode ){
danielk19777f7bc662006-01-23 13:47:47 +00004704 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00004705 }
drha6abd042004-06-09 17:37:22 +00004706 if( pPager->state<PAGER_RESERVED ){
drhd9b02572001-04-15 00:37:09 +00004707 return SQLITE_ERROR;
4708 }
drh86f8c192007-08-22 00:39:19 +00004709 pagerEnter(pPager);
drh4f0c5872007-03-26 22:05:01 +00004710 PAGERTRACE2("COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004711 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004712 pPg = pager_get_all_dirty_pages(pPager);
4713 while( pPg ){
danielk1977f35843b2007-04-07 15:03:17 +00004714 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
4715 clearHistory(pHist);
drhac69b052004-05-12 13:30:07 +00004716 pPg->dirty = 0;
4717 pPg->inJournal = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004718 pHist->inStmt = 0;
drh5229ae42006-03-23 23:29:04 +00004719 pPg->needSync = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004720 pHist->pPrevStmt = pHist->pNextStmt = 0;
drhac69b052004-05-12 13:30:07 +00004721 pPg = pPg->pDirty;
4722 }
drh605ad8f2006-05-03 23:34:05 +00004723 pPager->pDirty = 0;
danielk1977eac7a362004-06-16 07:45:24 +00004724#ifndef NDEBUG
4725 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
4726 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
4727 assert( !pPg->alwaysRollback );
4728 assert( !pHist->pOrig );
4729 assert( !pHist->pStmt );
4730 }
4731#endif
drhac69b052004-05-12 13:30:07 +00004732 pPager->pStmt = 0;
drha6abd042004-06-09 17:37:22 +00004733 pPager->state = PAGER_SHARED;
danielk197787c29a92008-01-18 11:33:16 +00004734 pagerLeave(pPager);
drhac69b052004-05-12 13:30:07 +00004735 return SQLITE_OK;
4736 }
drh3cdd7d32007-03-30 14:46:01 +00004737 assert( pPager->journalOpen || !pPager->dirtyCache );
4738 assert( pPager->state==PAGER_SYNCED || !pPager->dirtyCache );
4739 rc = pager_end_transaction(pPager);
drh86f8c192007-08-22 00:39:19 +00004740 rc = pager_error(pPager, rc);
4741 pagerLeave(pPager);
4742 return rc;
drhed7c8552001-04-11 14:29:21 +00004743}
4744
4745/*
drha6abd042004-06-09 17:37:22 +00004746** Rollback all changes. The database falls back to PAGER_SHARED mode.
drhed7c8552001-04-11 14:29:21 +00004747** All in-memory cache pages revert to their original data contents.
4748** The journal is deleted.
drhd9b02572001-04-15 00:37:09 +00004749**
4750** This routine cannot fail unless some other process is not following
drh4f0ee682007-03-30 20:43:40 +00004751** the correct locking protocol or unless some other
drhd9b02572001-04-15 00:37:09 +00004752** process is writing trash into the journal file (SQLITE_CORRUPT) or
4753** unless a prior malloc() failed (SQLITE_NOMEM). Appropriate error
4754** codes are returned for all these occasions. Otherwise,
4755** SQLITE_OK is returned.
drhed7c8552001-04-11 14:29:21 +00004756*/
danielk19773b8a05f2007-03-19 17:44:26 +00004757int sqlite3PagerRollback(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +00004758 int rc;
drh4f0c5872007-03-26 22:05:01 +00004759 PAGERTRACE2("ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004760 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004761 PgHdr *p;
4762 for(p=pPager->pAll; p; p=p->pNextAll){
4763 PgHistory *pHist;
danielk1977eac7a362004-06-16 07:45:24 +00004764 assert( !p->alwaysRollback );
4765 if( !p->dirty ){
4766 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pOrig );
4767 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pStmt );
4768 continue;
4769 }
4770
drhac69b052004-05-12 13:30:07 +00004771 pHist = PGHDR_TO_HIST(p, pPager);
4772 if( pHist->pOrig ){
4773 memcpy(PGHDR_TO_DATA(p), pHist->pOrig, pPager->pageSize);
drh4f0c5872007-03-26 22:05:01 +00004774 PAGERTRACE3("ROLLBACK-PAGE %d of %d\n", p->pgno, PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00004775 }else{
drh4f0c5872007-03-26 22:05:01 +00004776 PAGERTRACE3("PAGE %d is clean on %d\n", p->pgno, PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00004777 }
4778 clearHistory(pHist);
4779 p->dirty = 0;
4780 p->inJournal = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004781 pHist->inStmt = 0;
4782 pHist->pPrevStmt = pHist->pNextStmt = 0;
danielk1977369f27e2004-06-15 11:40:04 +00004783 if( pPager->xReiniter ){
danielk19773b8a05f2007-03-19 17:44:26 +00004784 pPager->xReiniter(p, pPager->pageSize);
danielk1977369f27e2004-06-15 11:40:04 +00004785 }
drhac69b052004-05-12 13:30:07 +00004786 }
drh605ad8f2006-05-03 23:34:05 +00004787 pPager->pDirty = 0;
drhac69b052004-05-12 13:30:07 +00004788 pPager->pStmt = 0;
4789 pPager->dbSize = pPager->origDbSize;
danielk1977e180dd92007-04-05 17:15:52 +00004790 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00004791 pPager->stmtInUse = 0;
drha6abd042004-06-09 17:37:22 +00004792 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00004793 return SQLITE_OK;
4794 }
4795
drh86f8c192007-08-22 00:39:19 +00004796 pagerEnter(pPager);
drha6abd042004-06-09 17:37:22 +00004797 if( !pPager->dirtyCache || !pPager->journalOpen ){
drh80e35f42007-03-30 14:06:34 +00004798 rc = pager_end_transaction(pPager);
drh86f8c192007-08-22 00:39:19 +00004799 pagerLeave(pPager);
drhda47d772002-12-02 04:25:19 +00004800 return rc;
4801 }
drhdb48ee02003-01-16 13:42:43 +00004802
danielk1977efaaf572006-01-16 11:29:19 +00004803 if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
drha6abd042004-06-09 17:37:22 +00004804 if( pPager->state>=PAGER_EXCLUSIVE ){
danielk1977e277be02007-03-23 18:12:06 +00004805 pager_playback(pPager, 0);
drh4b845d72002-03-05 12:41:19 +00004806 }
drh86f8c192007-08-22 00:39:19 +00004807 pagerLeave(pPager);
danielk1977efaaf572006-01-16 11:29:19 +00004808 return pPager->errCode;
drhed7c8552001-04-11 14:29:21 +00004809 }
drha6abd042004-06-09 17:37:22 +00004810 if( pPager->state==PAGER_RESERVED ){
danielk197717221812005-02-15 03:38:05 +00004811 int rc2;
danielk1977e277be02007-03-23 18:12:06 +00004812 rc = pager_playback(pPager, 0);
drh80e35f42007-03-30 14:06:34 +00004813 rc2 = pager_end_transaction(pPager);
drha6abd042004-06-09 17:37:22 +00004814 if( rc==SQLITE_OK ){
4815 rc = rc2;
4816 }
4817 }else{
danielk1977e277be02007-03-23 18:12:06 +00004818 rc = pager_playback(pPager, 0);
drhd9b02572001-04-15 00:37:09 +00004819 }
danielk1977e180dd92007-04-05 17:15:52 +00004820 /* pager_reset(pPager); */
drhd9b02572001-04-15 00:37:09 +00004821 pPager->dbSize = -1;
danielk197707cb5602006-01-20 10:55:05 +00004822
4823 /* If an error occurs during a ROLLBACK, we can no longer trust the pager
4824 ** cache. So call pager_error() on the way out to make any error
4825 ** persistent.
4826 */
drh86f8c192007-08-22 00:39:19 +00004827 rc = pager_error(pPager, rc);
4828 pagerLeave(pPager);
4829 return rc;
drh98808ba2001-10-18 12:34:46 +00004830}
drhd9b02572001-04-15 00:37:09 +00004831
4832/*
drh5e00f6c2001-09-13 13:46:56 +00004833** Return TRUE if the database file is opened read-only. Return FALSE
4834** if the database is (in theory) writable.
4835*/
danielk19773b8a05f2007-03-19 17:44:26 +00004836int sqlite3PagerIsreadonly(Pager *pPager){
drhbe0072d2001-09-13 14:46:09 +00004837 return pPager->readOnly;
drh5e00f6c2001-09-13 13:46:56 +00004838}
4839
4840/*
drh0f7eb612006-08-08 13:51:43 +00004841** Return the number of references to the pager.
4842*/
danielk19773b8a05f2007-03-19 17:44:26 +00004843int sqlite3PagerRefcount(Pager *pPager){
drh0f7eb612006-08-08 13:51:43 +00004844 return pPager->nRef;
4845}
4846
4847#ifdef SQLITE_TEST
4848/*
drhd9b02572001-04-15 00:37:09 +00004849** This routine is used for testing and analysis only.
4850*/
danielk19773b8a05f2007-03-19 17:44:26 +00004851int *sqlite3PagerStats(Pager *pPager){
danielk197742741be2005-01-08 12:42:39 +00004852 static int a[11];
drhd9b02572001-04-15 00:37:09 +00004853 a[0] = pPager->nRef;
4854 a[1] = pPager->nPage;
4855 a[2] = pPager->mxPage;
4856 a[3] = pPager->dbSize;
4857 a[4] = pPager->state;
danielk1977efaaf572006-01-16 11:29:19 +00004858 a[5] = pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00004859 a[6] = pPager->nHit;
4860 a[7] = pPager->nMiss;
drh7c4ac0c2007-04-05 11:25:58 +00004861 a[8] = 0; /* Used to be pPager->nOvfl */
danielk197742741be2005-01-08 12:42:39 +00004862 a[9] = pPager->nRead;
4863 a[10] = pPager->nWrite;
drhd9b02572001-04-15 00:37:09 +00004864 return a;
4865}
drh0f7eb612006-08-08 13:51:43 +00004866#endif
drhdd793422001-06-28 01:54:48 +00004867
drhfa86c412002-02-02 15:01:15 +00004868/*
drhac69b052004-05-12 13:30:07 +00004869** Set the statement rollback point.
drhfa86c412002-02-02 15:01:15 +00004870**
4871** This routine should be called with the transaction journal already
drhac69b052004-05-12 13:30:07 +00004872** open. A new statement journal is created that can be used to rollback
drhaaab5722002-02-19 13:39:21 +00004873** changes of a single SQL command within a larger transaction.
drhfa86c412002-02-02 15:01:15 +00004874*/
drh86f8c192007-08-22 00:39:19 +00004875static int pagerStmtBegin(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00004876 int rc;
drhac69b052004-05-12 13:30:07 +00004877 assert( !pPager->stmtInUse );
drh1aa2d8b2007-01-03 15:34:29 +00004878 assert( pPager->state>=PAGER_SHARED );
drhdc3ff9c2004-08-18 02:10:15 +00004879 assert( pPager->dbSize>=0 );
drh4f0c5872007-03-26 22:05:01 +00004880 PAGERTRACE2("STMT-BEGIN %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004881 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004882 pPager->stmtInUse = 1;
4883 pPager->stmtSize = pPager->dbSize;
4884 return SQLITE_OK;
4885 }
drhda47d772002-12-02 04:25:19 +00004886 if( !pPager->journalOpen ){
drhac69b052004-05-12 13:30:07 +00004887 pPager->stmtAutoopen = 1;
drhda47d772002-12-02 04:25:19 +00004888 return SQLITE_OK;
4889 }
drhfa86c412002-02-02 15:01:15 +00004890 assert( pPager->journalOpen );
drhed138fb2007-08-22 22:04:37 +00004891 pagerLeave(pPager);
drhf5e7bb52008-02-18 14:47:33 +00004892 assert( pPager->pInStmt==0 );
4893 pPager->pInStmt = sqlite3BitvecCreate(pPager->dbSize);
drhed138fb2007-08-22 22:04:37 +00004894 pagerEnter(pPager);
drhf5e7bb52008-02-18 14:47:33 +00004895 if( pPager->pInStmt==0 ){
danielk1977261919c2005-12-06 12:52:59 +00004896 /* sqlite3OsLock(pPager->fd, SHARED_LOCK); */
drhfa86c412002-02-02 15:01:15 +00004897 return SQLITE_NOMEM;
4898 }
drh968af522003-02-11 14:55:40 +00004899#ifndef NDEBUG
drh054889e2005-11-30 03:20:31 +00004900 rc = sqlite3OsFileSize(pPager->jfd, &pPager->stmtJSize);
drhac69b052004-05-12 13:30:07 +00004901 if( rc ) goto stmt_begin_failed;
danielk197776572402004-06-25 02:38:54 +00004902 assert( pPager->stmtJSize == pPager->journalOff );
drh968af522003-02-11 14:55:40 +00004903#endif
danielk197776572402004-06-25 02:38:54 +00004904 pPager->stmtJSize = pPager->journalOff;
drhac69b052004-05-12 13:30:07 +00004905 pPager->stmtSize = pPager->dbSize;
danielk197776572402004-06-25 02:38:54 +00004906 pPager->stmtHdrOff = 0;
danielk197775edc162004-06-26 01:48:18 +00004907 pPager->stmtCksum = pPager->cksumInit;
drhac69b052004-05-12 13:30:07 +00004908 if( !pPager->stmtOpen ){
drh334b2992007-09-06 23:28:23 +00004909 rc = sqlite3PagerOpentemp(pPager->pVfs, pPager->stfd, pPager->zStmtJrnl,
drh33f4e022007-09-03 15:19:34 +00004910 SQLITE_OPEN_SUBJOURNAL);
drh334b2992007-09-06 23:28:23 +00004911 if( rc ){
4912 goto stmt_begin_failed;
4913 }
drhac69b052004-05-12 13:30:07 +00004914 pPager->stmtOpen = 1;
4915 pPager->stmtNRec = 0;
drh0f892532002-05-30 12:27:03 +00004916 }
drhac69b052004-05-12 13:30:07 +00004917 pPager->stmtInUse = 1;
drhfa86c412002-02-02 15:01:15 +00004918 return SQLITE_OK;
4919
drhac69b052004-05-12 13:30:07 +00004920stmt_begin_failed:
drhf5e7bb52008-02-18 14:47:33 +00004921 if( pPager->pInStmt ){
4922 sqlite3BitvecDestroy(pPager->pInStmt);
4923 pPager->pInStmt = 0;
drhfa86c412002-02-02 15:01:15 +00004924 }
4925 return rc;
4926}
drh86f8c192007-08-22 00:39:19 +00004927int sqlite3PagerStmtBegin(Pager *pPager){
4928 int rc;
4929 pagerEnter(pPager);
4930 rc = pagerStmtBegin(pPager);
4931 pagerLeave(pPager);
4932 return rc;
4933}
drhfa86c412002-02-02 15:01:15 +00004934
4935/*
drhac69b052004-05-12 13:30:07 +00004936** Commit a statement.
drhfa86c412002-02-02 15:01:15 +00004937*/
danielk19773b8a05f2007-03-19 17:44:26 +00004938int sqlite3PagerStmtCommit(Pager *pPager){
drh86f8c192007-08-22 00:39:19 +00004939 pagerEnter(pPager);
drhac69b052004-05-12 13:30:07 +00004940 if( pPager->stmtInUse ){
drh03eb96a2002-11-10 23:32:56 +00004941 PgHdr *pPg, *pNext;
drh4f0c5872007-03-26 22:05:01 +00004942 PAGERTRACE2("STMT-COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004943 if( !MEMDB ){
drh054889e2005-11-30 03:20:31 +00004944 /* sqlite3OsTruncate(pPager->stfd, 0); */
drhf5e7bb52008-02-18 14:47:33 +00004945 sqlite3BitvecDestroy(pPager->pInStmt);
4946 pPager->pInStmt = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004947 }else{
4948 for(pPg=pPager->pStmt; pPg; pPg=pNext){
drhac69b052004-05-12 13:30:07 +00004949 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
danielk1977f35843b2007-04-07 15:03:17 +00004950 pNext = pHist->pNextStmt;
4951 assert( pHist->inStmt );
4952 pHist->inStmt = 0;
4953 pHist->pPrevStmt = pHist->pNextStmt = 0;
drh17435752007-08-16 04:30:38 +00004954 sqlite3_free(pHist->pStmt);
drhac69b052004-05-12 13:30:07 +00004955 pHist->pStmt = 0;
4956 }
4957 }
4958 pPager->stmtNRec = 0;
4959 pPager->stmtInUse = 0;
4960 pPager->pStmt = 0;
drh663fc632002-02-02 18:49:19 +00004961 }
drhac69b052004-05-12 13:30:07 +00004962 pPager->stmtAutoopen = 0;
drh86f8c192007-08-22 00:39:19 +00004963 pagerLeave(pPager);
drhfa86c412002-02-02 15:01:15 +00004964 return SQLITE_OK;
4965}
4966
4967/*
drhac69b052004-05-12 13:30:07 +00004968** Rollback a statement.
drhfa86c412002-02-02 15:01:15 +00004969*/
danielk19773b8a05f2007-03-19 17:44:26 +00004970int sqlite3PagerStmtRollback(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00004971 int rc;
drh86f8c192007-08-22 00:39:19 +00004972 pagerEnter(pPager);
drhac69b052004-05-12 13:30:07 +00004973 if( pPager->stmtInUse ){
drh4f0c5872007-03-26 22:05:01 +00004974 PAGERTRACE2("STMT-ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004975 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004976 PgHdr *pPg;
danielk1977f35843b2007-04-07 15:03:17 +00004977 PgHistory *pHist;
4978 for(pPg=pPager->pStmt; pPg; pPg=pHist->pNextStmt){
4979 pHist = PGHDR_TO_HIST(pPg, pPager);
drhac69b052004-05-12 13:30:07 +00004980 if( pHist->pStmt ){
4981 memcpy(PGHDR_TO_DATA(pPg), pHist->pStmt, pPager->pageSize);
drh17435752007-08-16 04:30:38 +00004982 sqlite3_free(pHist->pStmt);
drhac69b052004-05-12 13:30:07 +00004983 pHist->pStmt = 0;
4984 }
4985 }
4986 pPager->dbSize = pPager->stmtSize;
danielk1977e180dd92007-04-05 17:15:52 +00004987 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00004988 rc = SQLITE_OK;
4989 }else{
4990 rc = pager_stmt_playback(pPager);
4991 }
danielk19773b8a05f2007-03-19 17:44:26 +00004992 sqlite3PagerStmtCommit(pPager);
drh663fc632002-02-02 18:49:19 +00004993 }else{
4994 rc = SQLITE_OK;
4995 }
drhac69b052004-05-12 13:30:07 +00004996 pPager->stmtAutoopen = 0;
drh86f8c192007-08-22 00:39:19 +00004997 pagerLeave(pPager);
drhfa86c412002-02-02 15:01:15 +00004998 return rc;
4999}
5000
drh73509ee2003-04-06 20:44:45 +00005001/*
5002** Return the full pathname of the database file.
5003*/
danielk19773b8a05f2007-03-19 17:44:26 +00005004const char *sqlite3PagerFilename(Pager *pPager){
drh73509ee2003-04-06 20:44:45 +00005005 return pPager->zFilename;
5006}
5007
drhb20ea9d2004-02-09 01:20:36 +00005008/*
drhd0679ed2007-08-28 22:24:34 +00005009** Return the VFS structure for the pager.
5010*/
5011const sqlite3_vfs *sqlite3PagerVfs(Pager *pPager){
5012 return pPager->pVfs;
5013}
5014
5015/*
drhcc6bb3e2007-08-31 16:11:35 +00005016** Return the file handle for the database file associated
5017** with the pager. This might return NULL if the file has
5018** not yet been opened.
5019*/
5020sqlite3_file *sqlite3PagerFile(Pager *pPager){
5021 return pPager->fd;
5022}
5023
5024/*
danielk19775865e3d2004-06-14 06:03:57 +00005025** Return the directory of the database file.
5026*/
danielk19773b8a05f2007-03-19 17:44:26 +00005027const char *sqlite3PagerDirname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00005028 return pPager->zDirectory;
5029}
5030
5031/*
5032** Return the full pathname of the journal file.
5033*/
danielk19773b8a05f2007-03-19 17:44:26 +00005034const char *sqlite3PagerJournalname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00005035 return pPager->zJournal;
5036}
5037
5038/*
drh2c8997b2005-08-27 16:36:48 +00005039** Return true if fsync() calls are disabled for this pager. Return FALSE
5040** if fsync()s are executed normally.
5041*/
danielk19773b8a05f2007-03-19 17:44:26 +00005042int sqlite3PagerNosync(Pager *pPager){
drh2c8997b2005-08-27 16:36:48 +00005043 return pPager->noSync;
5044}
5045
drh7c4ac0c2007-04-05 11:25:58 +00005046#ifdef SQLITE_HAS_CODEC
drh2c8997b2005-08-27 16:36:48 +00005047/*
drhb20ea9d2004-02-09 01:20:36 +00005048** Set the codec for this pager
5049*/
danielk19773b8a05f2007-03-19 17:44:26 +00005050void sqlite3PagerSetCodec(
drhb20ea9d2004-02-09 01:20:36 +00005051 Pager *pPager,
drhc001c582006-03-06 18:23:16 +00005052 void *(*xCodec)(void*,void*,Pgno,int),
drhb20ea9d2004-02-09 01:20:36 +00005053 void *pCodecArg
5054){
5055 pPager->xCodec = xCodec;
5056 pPager->pCodecArg = pCodecArg;
5057}
drh7c4ac0c2007-04-05 11:25:58 +00005058#endif
drhb20ea9d2004-02-09 01:20:36 +00005059
danielk1977687566d2004-11-02 12:56:41 +00005060#ifndef SQLITE_OMIT_AUTOVACUUM
5061/*
danielk197787c29a92008-01-18 11:33:16 +00005062** Move the page pPg to location pgno in the file.
danielk1977687566d2004-11-02 12:56:41 +00005063**
drh5e385312007-06-16 04:42:12 +00005064** There must be no references to the page previously located at
5065** pgno (which we call pPgOld) though that page is allowed to be
5066** in cache. If the page previous located at pgno is not already
5067** in the rollback journal, it is not put there by by this routine.
danielk1977687566d2004-11-02 12:56:41 +00005068**
drh5e385312007-06-16 04:42:12 +00005069** References to the page pPg remain valid. Updating any
5070** meta-data associated with pPg (i.e. data stored in the nExtra bytes
danielk1977687566d2004-11-02 12:56:41 +00005071** allocated along with the page) is the responsibility of the caller.
5072**
danielk19775fd057a2005-03-09 13:09:43 +00005073** A transaction must be active when this routine is called. It used to be
5074** required that a statement transaction was not active, but this restriction
5075** has been removed (CREATE INDEX needs to move a page when a statement
5076** transaction is active).
danielk1977687566d2004-11-02 12:56:41 +00005077*/
danielk19773b8a05f2007-03-19 17:44:26 +00005078int sqlite3PagerMovepage(Pager *pPager, DbPage *pPg, Pgno pgno){
drh5e385312007-06-16 04:42:12 +00005079 PgHdr *pPgOld; /* The page being overwritten. */
danielk1977f5fdda82004-11-03 08:44:05 +00005080 int h;
danielk197794daf7f2004-11-08 09:26:09 +00005081 Pgno needSyncPgno = 0;
danielk1977687566d2004-11-02 12:56:41 +00005082
drh86f8c192007-08-22 00:39:19 +00005083 pagerEnter(pPager);
danielk1977687566d2004-11-02 12:56:41 +00005084 assert( pPg->nRef>0 );
5085
drh4f0c5872007-03-26 22:05:01 +00005086 PAGERTRACE5("MOVE %d page %d (needSync=%d) moves to %d\n",
danielk1977599fcba2004-11-08 07:13:13 +00005087 PAGERID(pPager), pPg->pgno, pPg->needSync, pgno);
drhb0603412007-02-28 04:47:26 +00005088 IOTRACE(("MOVE %p %d %d\n", pPager, pPg->pgno, pgno))
danielk1977ef73ee92004-11-06 12:26:07 +00005089
danielk1977b4626a32007-04-28 15:47:43 +00005090 pager_get_content(pPg);
danielk197794daf7f2004-11-08 09:26:09 +00005091 if( pPg->needSync ){
5092 needSyncPgno = pPg->pgno;
drh4f0aee42007-06-16 18:39:41 +00005093 assert( pPg->inJournal || (int)pgno>pPager->origDbSize );
danielk197794daf7f2004-11-08 09:26:09 +00005094 assert( pPg->dirty );
danielk1977ae825582004-11-23 09:06:55 +00005095 assert( pPager->needSync );
danielk197794daf7f2004-11-08 09:26:09 +00005096 }
5097
drh85b623f2007-12-13 21:54:09 +00005098 /* Unlink pPg from its hash-chain */
danielk1977f5fdda82004-11-03 08:44:05 +00005099 unlinkHashChain(pPager, pPg);
danielk1977687566d2004-11-02 12:56:41 +00005100
danielk1977ef73ee92004-11-06 12:26:07 +00005101 /* If the cache contains a page with page-number pgno, remove it
drh85b623f2007-12-13 21:54:09 +00005102 ** from its hash chain. Also, if the PgHdr.needSync was set for
danielk1977599fcba2004-11-08 07:13:13 +00005103 ** page pgno before the 'move' operation, it needs to be retained
5104 ** for the page moved there.
danielk1977f5fdda82004-11-03 08:44:05 +00005105 */
drh5e385312007-06-16 04:42:12 +00005106 pPg->needSync = 0;
danielk1977687566d2004-11-02 12:56:41 +00005107 pPgOld = pager_lookup(pPager, pgno);
5108 if( pPgOld ){
danielk1977f5fdda82004-11-03 08:44:05 +00005109 assert( pPgOld->nRef==0 );
5110 unlinkHashChain(pPager, pPgOld);
drh605ad8f2006-05-03 23:34:05 +00005111 makeClean(pPgOld);
drh5e385312007-06-16 04:42:12 +00005112 pPg->needSync = pPgOld->needSync;
5113 }else{
5114 pPg->needSync = 0;
5115 }
drhf5e7bb52008-02-18 14:47:33 +00005116 pPg->inJournal = sqlite3BitvecTest(pPager->pInJournal, pgno);
danielk1977687566d2004-11-02 12:56:41 +00005117
danielk1977f5fdda82004-11-03 08:44:05 +00005118 /* Change the page number for pPg and insert it into the new hash-chain. */
drh3765df42006-06-28 18:18:09 +00005119 assert( pgno!=0 );
danielk1977f5fdda82004-11-03 08:44:05 +00005120 pPg->pgno = pgno;
drh8ca0c722006-05-07 17:49:38 +00005121 h = pgno & (pPager->nHash-1);
danielk1977f5fdda82004-11-03 08:44:05 +00005122 if( pPager->aHash[h] ){
5123 assert( pPager->aHash[h]->pPrevHash==0 );
5124 pPager->aHash[h]->pPrevHash = pPg;
5125 }
5126 pPg->pNextHash = pPager->aHash[h];
5127 pPager->aHash[h] = pPg;
5128 pPg->pPrevHash = 0;
5129
drh605ad8f2006-05-03 23:34:05 +00005130 makeDirty(pPg);
danielk1977687566d2004-11-02 12:56:41 +00005131 pPager->dirtyCache = 1;
5132
danielk197794daf7f2004-11-08 09:26:09 +00005133 if( needSyncPgno ){
5134 /* If needSyncPgno is non-zero, then the journal file needs to be
5135 ** sync()ed before any data is written to database file page needSyncPgno.
5136 ** Currently, no such page exists in the page-cache and the
drhf5e7bb52008-02-18 14:47:33 +00005137 ** Pager.pInJournal bit has been set. This needs to be remedied by loading
danielk197794daf7f2004-11-08 09:26:09 +00005138 ** the page into the pager-cache and setting the PgHdr.needSync flag.
danielk1977ae825582004-11-23 09:06:55 +00005139 **
danielk1977a98d7b42008-01-18 13:42:54 +00005140 ** If the attempt to load the page into the page-cache fails, (due
drhf5e7bb52008-02-18 14:47:33 +00005141 ** to a malloc() or IO failure), clear the bit in the pInJournal[]
danielk1977a98d7b42008-01-18 13:42:54 +00005142 ** array. Otherwise, if the page is loaded and written again in
5143 ** this transaction, it may be written to the database file before
5144 ** it is synced into the journal file. This way, it may end up in
5145 ** the journal file twice, but that is not a problem.
5146 **
danielk19773b8a05f2007-03-19 17:44:26 +00005147 ** The sqlite3PagerGet() call may cause the journal to sync. So make
danielk1977ae825582004-11-23 09:06:55 +00005148 ** sure the Pager.needSync flag is set too.
danielk197794daf7f2004-11-08 09:26:09 +00005149 */
5150 int rc;
danielk19773b8a05f2007-03-19 17:44:26 +00005151 PgHdr *pPgHdr;
danielk1977ae825582004-11-23 09:06:55 +00005152 assert( pPager->needSync );
danielk19773b8a05f2007-03-19 17:44:26 +00005153 rc = sqlite3PagerGet(pPager, needSyncPgno, &pPgHdr);
danielk197787c29a92008-01-18 11:33:16 +00005154 if( rc!=SQLITE_OK ){
drhf5e7bb52008-02-18 14:47:33 +00005155 if( pPager->pInJournal && (int)needSyncPgno<=pPager->origDbSize ){
5156 sqlite3BitvecClear(pPager->pInJournal, needSyncPgno);
danielk1977a98d7b42008-01-18 13:42:54 +00005157 }
danielk197787c29a92008-01-18 11:33:16 +00005158 pagerLeave(pPager);
5159 return rc;
5160 }
danielk1977ae825582004-11-23 09:06:55 +00005161 pPager->needSync = 1;
danielk19773b8a05f2007-03-19 17:44:26 +00005162 pPgHdr->needSync = 1;
5163 pPgHdr->inJournal = 1;
5164 makeDirty(pPgHdr);
5165 sqlite3PagerUnref(pPgHdr);
danielk197794daf7f2004-11-08 09:26:09 +00005166 }
5167
drh86f8c192007-08-22 00:39:19 +00005168 pagerLeave(pPager);
danielk1977687566d2004-11-02 12:56:41 +00005169 return SQLITE_OK;
5170}
5171#endif
5172
danielk19773b8a05f2007-03-19 17:44:26 +00005173/*
5174** Return a pointer to the data for the specified page.
5175*/
5176void *sqlite3PagerGetData(DbPage *pPg){
5177 return PGHDR_TO_DATA(pPg);
5178}
5179
5180/*
5181** Return a pointer to the Pager.nExtra bytes of "extra" space
5182** allocated along with the specified page.
5183*/
5184void *sqlite3PagerGetExtra(DbPage *pPg){
5185 Pager *pPager = pPg->pPager;
5186 return (pPager?PGHDR_TO_EXTRA(pPg, pPager):0);
5187}
5188
danielk197741483462007-03-24 16:45:04 +00005189/*
5190** Get/set the locking-mode for this pager. Parameter eMode must be one
5191** of PAGER_LOCKINGMODE_QUERY, PAGER_LOCKINGMODE_NORMAL or
5192** PAGER_LOCKINGMODE_EXCLUSIVE. If the parameter is not _QUERY, then
5193** the locking-mode is set to the value specified.
5194**
5195** The returned value is either PAGER_LOCKINGMODE_NORMAL or
5196** PAGER_LOCKINGMODE_EXCLUSIVE, indicating the current (possibly updated)
5197** locking-mode.
5198*/
5199int sqlite3PagerLockingMode(Pager *pPager, int eMode){
drh369339d2007-03-30 16:01:55 +00005200 assert( eMode==PAGER_LOCKINGMODE_QUERY
5201 || eMode==PAGER_LOCKINGMODE_NORMAL
5202 || eMode==PAGER_LOCKINGMODE_EXCLUSIVE );
5203 assert( PAGER_LOCKINGMODE_QUERY<0 );
5204 assert( PAGER_LOCKINGMODE_NORMAL>=0 && PAGER_LOCKINGMODE_EXCLUSIVE>=0 );
5205 if( eMode>=0 && !pPager->tempFile ){
danielk197741483462007-03-24 16:45:04 +00005206 pPager->exclusiveMode = eMode;
5207 }
5208 return (int)pPager->exclusiveMode;
5209}
5210
drhd919fe12007-12-11 19:34:44 +00005211#ifdef SQLITE_TEST
drhdd793422001-06-28 01:54:48 +00005212/*
5213** Print a listing of all referenced pages and their ref count.
5214*/
danielk19773b8a05f2007-03-19 17:44:26 +00005215void sqlite3PagerRefdump(Pager *pPager){
drhdd793422001-06-28 01:54:48 +00005216 PgHdr *pPg;
5217 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
5218 if( pPg->nRef<=0 ) continue;
drhfe63d1c2004-09-08 20:13:04 +00005219 sqlite3DebugPrintf("PAGE %3d addr=%p nRef=%d\n",
5220 pPg->pgno, PGHDR_TO_DATA(pPg), pPg->nRef);
drhdd793422001-06-28 01:54:48 +00005221 }
5222}
5223#endif
drh2e66f0b2005-04-28 17:18:48 +00005224
5225#endif /* SQLITE_OMIT_DISKIO */