blob: 31f374a6f98c287c16989ef61571cec1293f16ce [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**
drh26b79942007-11-28 16:19:56 +000021** @(#) $Id: pager.c,v 1.396 2007/11/28 16:19:56 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**
50** PAGERID() takes a pointer to a Pager struct as it's argument. The
danielk197762079062007-08-15 17:08:46 +000051** associated file-descriptor is returned. FILEHANDLEID() takes an sqlite3_file
danielk1977599fcba2004-11-08 07:13:13 +000052** struct as it's argument.
53*/
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
148** fsync() operation before it's memory can be reclaimed. If no such
149** 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**
216** inJournal = (pPager->aInJournal[(pgno-1)/8] & (1<<((pgno-1)%8))!=0
217**
218** The pPager->aInJournal[] array is only valid for the original
219** 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 */
drh603240c2002-03-05 01:11:12 +0000368 u8 *aInJournal; /* One bit for each page in the database file */
drhac69b052004-05-12 13:30:07 +0000369 u8 *aInStmt; /* 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/*
drh726de592004-06-10 23:35:50 +0000536** Enable reference count tracking (for debugging) here:
drhdd793422001-06-28 01:54:48 +0000537*/
drh7c4ac0c2007-04-05 11:25:58 +0000538#ifdef SQLITE_DEBUG
drh3aac2dd2004-04-26 14:10:20 +0000539 int pager3_refinfo_enable = 0;
drhdd793422001-06-28 01:54:48 +0000540 static void pager_refinfo(PgHdr *p){
541 static int cnt = 0;
drh3aac2dd2004-04-26 14:10:20 +0000542 if( !pager3_refinfo_enable ) return;
drhfe63d1c2004-09-08 20:13:04 +0000543 sqlite3DebugPrintf(
drh24c9a2e2007-01-05 02:00:47 +0000544 "REFCNT: %4d addr=%p nRef=%-3d total=%d\n",
545 p->pgno, PGHDR_TO_DATA(p), p->nRef, p->pPager->nRef
drhdd793422001-06-28 01:54:48 +0000546 );
547 cnt++; /* Something to set a breakpoint on */
548 }
549# define REFINFO(X) pager_refinfo(X)
550#else
551# define REFINFO(X)
552#endif
553
danielk197784f786f2007-08-28 08:00:17 +0000554/*
555** Add page pPg to the end of the linked list managed by structure
556** pList (pPg becomes the last entry in the list - the most recently
557** used). Argument pLink should point to either pPg->free or pPg->gfree,
558** depending on whether pPg is being added to the pager-specific or
559** global LRU list.
560*/
danielk19779f61c2f2007-08-27 17:27:49 +0000561static void listAdd(PagerLruList *pList, PagerLruLink *pLink, PgHdr *pPg){
562 pLink->pNext = 0;
563 pLink->pPrev = pList->pLast;
564
danielk197784f786f2007-08-28 08:00:17 +0000565#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
566 assert(pLink==&pPg->free || pLink==&pPg->gfree);
567 assert(pLink==&pPg->gfree || pList!=&sqlite3LruPageList);
568#endif
569
danielk19779f61c2f2007-08-27 17:27:49 +0000570 if( pList->pLast ){
571 int iOff = (char *)pLink - (char *)pPg;
572 PagerLruLink *pLastLink = (PagerLruLink *)(&((u8 *)pList->pLast)[iOff]);
573 pLastLink->pNext = pPg;
574 }else{
575 assert(!pList->pFirst);
576 pList->pFirst = pPg;
577 }
578
579 pList->pLast = pPg;
580 if( !pList->pFirstSynced && pPg->needSync==0 ){
581 pList->pFirstSynced = pPg;
582 }
583}
584
danielk197784f786f2007-08-28 08:00:17 +0000585/*
586** Remove pPg from the list managed by the structure pointed to by pList.
587**
588** Argument pLink should point to either pPg->free or pPg->gfree, depending
589** on whether pPg is being added to the pager-specific or global LRU list.
590*/
danielk19779f61c2f2007-08-27 17:27:49 +0000591static void listRemove(PagerLruList *pList, PagerLruLink *pLink, PgHdr *pPg){
592 int iOff = (char *)pLink - (char *)pPg;
593
danielk197784f786f2007-08-28 08:00:17 +0000594#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
595 assert(pLink==&pPg->free || pLink==&pPg->gfree);
596 assert(pLink==&pPg->gfree || pList!=&sqlite3LruPageList);
597#endif
598
danielk19779f61c2f2007-08-27 17:27:49 +0000599 if( pPg==pList->pFirst ){
600 pList->pFirst = pLink->pNext;
601 }
602 if( pPg==pList->pLast ){
603 pList->pLast = pLink->pPrev;
604 }
605 if( pLink->pPrev ){
606 PagerLruLink *pPrevLink = (PagerLruLink *)(&((u8 *)pLink->pPrev)[iOff]);
607 pPrevLink->pNext = pLink->pNext;
608 }
609 if( pLink->pNext ){
610 PagerLruLink *pNextLink = (PagerLruLink *)(&((u8 *)pLink->pNext)[iOff]);
611 pNextLink->pPrev = pLink->pPrev;
612 }
613 if( pPg==pList->pFirstSynced ){
614 PgHdr *p = pLink->pNext;
615 while( p && p->needSync ){
616 PagerLruLink *pL = (PagerLruLink *)(&((u8 *)p)[iOff]);
617 p = pL->pNext;
618 }
619 pList->pFirstSynced = p;
620 }
621
622 pLink->pNext = pLink->pPrev = 0;
623}
624
625/*
danielk197784f786f2007-08-28 08:00:17 +0000626** Add page pPg to the list of free pages for the pager. If
627** memory-management is enabled, also add the page to the global
628** list of free pages.
danielk19779f61c2f2007-08-27 17:27:49 +0000629*/
630static void lruListAdd(PgHdr *pPg){
631 listAdd(&pPg->pPager->lru, &pPg->free, pPg);
632#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
633 if( !pPg->pPager->memDb ){
634 sqlite3_mutex_enter(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
635 listAdd(&sqlite3LruPageList, &pPg->gfree, pPg);
636 sqlite3_mutex_leave(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
637 }
638#endif
639}
640
641/*
danielk197784f786f2007-08-28 08:00:17 +0000642** Remove page pPg from the list of free pages for the associated pager.
643** If memory-management is enabled, also remove pPg from the global list
644** of free pages.
danielk19779f61c2f2007-08-27 17:27:49 +0000645*/
646static void lruListRemove(PgHdr *pPg){
647 listRemove(&pPg->pPager->lru, &pPg->free, pPg);
648#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
649 if( !pPg->pPager->memDb ){
650 sqlite3_mutex_enter(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
651 listRemove(&sqlite3LruPageList, &pPg->gfree, pPg);
652 sqlite3_mutex_leave(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
653 }
654#endif
655}
656
657/*
danielk197784f786f2007-08-28 08:00:17 +0000658** This function is called just after the needSync flag has been cleared
659** from all pages managed by pPager (usually because the journal file
660** has just been synced). It updates the pPager->lru.pFirstSynced variable
661** and, if memory-management is enabled, the sqlite3LruPageList.pFirstSynced
662** variable also.
danielk19779f61c2f2007-08-27 17:27:49 +0000663*/
664static void lruListSetFirstSynced(Pager *pPager){
665 pPager->lru.pFirstSynced = pPager->lru.pFirst;
666#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
667 if( !pPager->memDb ){
668 PgHdr *p;
669 sqlite3_mutex_enter(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
670 for(p=sqlite3LruPageList.pFirst; p && p->needSync; p=p->gfree.pNext);
671 assert(p==pPager->lru.pFirstSynced || p==sqlite3LruPageList.pFirstSynced);
672 sqlite3LruPageList.pFirstSynced = p;
673 sqlite3_mutex_leave(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
674 }
675#endif
676}
677
danielk1977f35843b2007-04-07 15:03:17 +0000678/*
679** Return true if page *pPg has already been written to the statement
680** journal (or statement snapshot has been created, if *pPg is part
681** of an in-memory database).
682*/
683static int pageInStatement(PgHdr *pPg){
684 Pager *pPager = pPg->pPager;
685 if( MEMDB ){
686 return PGHDR_TO_HIST(pPg, pPager)->inStmt;
687 }else{
688 Pgno pgno = pPg->pgno;
689 u8 *a = pPager->aInStmt;
690 return (a && (int)pgno<=pPager->stmtSize && (a[pgno/8] & (1<<(pgno&7))));
691 }
692}
drh8ca0c722006-05-07 17:49:38 +0000693
694/*
695** Change the size of the pager hash table to N. N must be a power
696** of two.
697*/
698static void pager_resize_hash_table(Pager *pPager, int N){
699 PgHdr **aHash, *pPg;
700 assert( N>0 && (N&(N-1))==0 );
drhed138fb2007-08-22 22:04:37 +0000701 pagerLeave(pPager);
danielk1977a1644fd2007-08-29 12:31:25 +0000702 sqlite3MallocBenignFailure((int)pPager->aHash);
drh17435752007-08-16 04:30:38 +0000703 aHash = sqlite3MallocZero( sizeof(aHash[0])*N );
drhed138fb2007-08-22 22:04:37 +0000704 pagerEnter(pPager);
drh8ca0c722006-05-07 17:49:38 +0000705 if( aHash==0 ){
706 /* Failure to rehash is not an error. It is only a performance hit. */
707 return;
708 }
drh17435752007-08-16 04:30:38 +0000709 sqlite3_free(pPager->aHash);
drh8ca0c722006-05-07 17:49:38 +0000710 pPager->nHash = N;
711 pPager->aHash = aHash;
712 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
drh3765df42006-06-28 18:18:09 +0000713 int h;
714 if( pPg->pgno==0 ){
715 assert( pPg->pNextHash==0 && pPg->pPrevHash==0 );
716 continue;
717 }
718 h = pPg->pgno & (N-1);
drh8ca0c722006-05-07 17:49:38 +0000719 pPg->pNextHash = aHash[h];
720 if( aHash[h] ){
721 aHash[h]->pPrevHash = pPg;
722 }
723 aHash[h] = pPg;
724 pPg->pPrevHash = 0;
725 }
726}
727
drhdd793422001-06-28 01:54:48 +0000728/*
drh34e79ce2004-02-08 06:05:46 +0000729** Read a 32-bit integer from the given file descriptor. Store the integer
730** that is read in *pRes. Return SQLITE_OK if everything worked, or an
731** error code is something goes wrong.
drh726de592004-06-10 23:35:50 +0000732**
733** All values are stored on disk as big-endian.
drh94f33312002-08-12 12:29:56 +0000734*/
danielk197762079062007-08-15 17:08:46 +0000735static int read32bits(sqlite3_file *fd, i64 offset, u32 *pRes){
drh3b59a5c2006-01-15 20:28:28 +0000736 unsigned char ac[4];
danielk197762079062007-08-15 17:08:46 +0000737 int rc = sqlite3OsRead(fd, ac, sizeof(ac), offset);
drhae2b40c2004-06-09 19:03:54 +0000738 if( rc==SQLITE_OK ){
drha3152892007-05-05 11:48:52 +0000739 *pRes = sqlite3Get4byte(ac);
drh94f33312002-08-12 12:29:56 +0000740 }
drh94f33312002-08-12 12:29:56 +0000741 return rc;
742}
743
744/*
drh97b57482006-01-10 20:32:32 +0000745** Write a 32-bit integer into a string buffer in big-endian byte order.
746*/
drha3152892007-05-05 11:48:52 +0000747#define put32bits(A,B) sqlite3Put4byte((u8*)A,B)
drh97b57482006-01-10 20:32:32 +0000748
749/*
drh34e79ce2004-02-08 06:05:46 +0000750** Write a 32-bit integer into the given file descriptor. Return SQLITE_OK
751** on success or an error code is something goes wrong.
drh94f33312002-08-12 12:29:56 +0000752*/
danielk197762079062007-08-15 17:08:46 +0000753static int write32bits(sqlite3_file *fd, i64 offset, u32 val){
danielk1977bab45c62006-01-16 15:14:27 +0000754 char ac[4];
drh97b57482006-01-10 20:32:32 +0000755 put32bits(ac, val);
danielk197762079062007-08-15 17:08:46 +0000756 return sqlite3OsWrite(fd, ac, 4, offset);
drh94f33312002-08-12 12:29:56 +0000757}
758
drh2554f8b2003-01-22 01:26:44 +0000759/*
danielk19777a2b1ee2007-08-21 14:27:01 +0000760** If file pFd is open, call sqlite3OsUnlock() on it.
761*/
762static int osUnlock(sqlite3_file *pFd, int eLock){
763 if( !pFd->pMethods ){
764 return SQLITE_OK;
765 }
766 return sqlite3OsUnlock(pFd, eLock);
767}
768
769/*
danielk1977c7b60172007-08-22 11:22:03 +0000770** This function determines whether or not the atomic-write optimization
771** can be used with this pager. The optimization can be used if:
772**
773** (a) the value returned by OsDeviceCharacteristics() indicates that
774** a database page may be written atomically, and
775** (b) the value returned by OsSectorSize() is less than or equal
776** to the page size.
777**
778** If the optimization cannot be used, 0 is returned. If it can be used,
779** then the value returned is the size of the journal file when it
780** contains rollback data for exactly one page.
781*/
782#ifdef SQLITE_ENABLE_ATOMIC_WRITE
783static int jrnlBufferSize(Pager *pPager){
784 int dc; /* Device characteristics */
785 int nSector; /* Sector size */
786 int nPage; /* Page size */
787 sqlite3_file *fd = pPager->fd;
788
789 if( fd->pMethods ){
790 dc = sqlite3OsDeviceCharacteristics(fd);
791 nSector = sqlite3OsSectorSize(fd);
792 nPage = pPager->pageSize;
793 }
794
795 assert(SQLITE_IOCAP_ATOMIC512==(512>>8));
796 assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8));
797
danielk1977f8940ae2007-08-23 11:07:10 +0000798 if( !fd->pMethods || (dc&(SQLITE_IOCAP_ATOMIC|(nPage>>8))&&nSector<=nPage) ){
danielk1977c7b60172007-08-22 11:22:03 +0000799 return JOURNAL_HDR_SZ(pPager) + JOURNAL_PG_SZ(pPager);
800 }
801 return 0;
802}
803#endif
804
805/*
danielk1977aef0bf62005-12-30 16:28:01 +0000806** This function should be called when an error occurs within the pager
danielk1977a96a7102006-01-16 12:46:41 +0000807** code. The first argument is a pointer to the pager structure, the
808** second the error-code about to be returned by a pager API function.
809** The value returned is a copy of the second argument to this function.
810**
drh4f0ee682007-03-30 20:43:40 +0000811** If the second argument is SQLITE_IOERR, SQLITE_CORRUPT, or SQLITE_FULL
danielk1977ae72d982007-10-03 08:46:44 +0000812** the error becomes persistent. Until the persisten error is cleared,
813** subsequent API calls on this Pager will immediately return the same
814** error code.
815**
816** A persistent error indicates that the contents of the pager-cache
817** cannot be trusted. This state can be cleared by completely discarding
818** the contents of the pager-cache. If a transaction was active when
819** the persistent error occured, then the rollback journal may need
820** to be replayed.
danielk1977aef0bf62005-12-30 16:28:01 +0000821*/
danielk1977ae72d982007-10-03 08:46:44 +0000822static void pager_unlock(Pager *pPager);
danielk1977aef0bf62005-12-30 16:28:01 +0000823static int pager_error(Pager *pPager, int rc){
drh4ac285a2006-09-15 07:28:50 +0000824 int rc2 = rc & 0xff;
drh34f56212007-08-10 23:56:35 +0000825 assert(
826 pPager->errCode==SQLITE_FULL ||
827 pPager->errCode==SQLITE_OK ||
828 (pPager->errCode & 0xff)==SQLITE_IOERR
829 );
danielk1977979f38e2007-03-27 16:19:51 +0000830 if(
drh4ac285a2006-09-15 07:28:50 +0000831 rc2==SQLITE_FULL ||
832 rc2==SQLITE_IOERR ||
drh4f0ee682007-03-30 20:43:40 +0000833 rc2==SQLITE_CORRUPT
danielk1977efaaf572006-01-16 11:29:19 +0000834 ){
835 pPager->errCode = rc;
danielk1977ae72d982007-10-03 08:46:44 +0000836 if( pPager->state==PAGER_UNLOCK && pPager->nRef==0 ){
837 /* If the pager is already unlocked, call pager_unlock() now to
838 ** clear the error state and ensure that the pager-cache is
839 ** completely empty.
840 */
841 pager_unlock(pPager);
842 }
danielk1977aef0bf62005-12-30 16:28:01 +0000843 }
844 return rc;
845}
846
drh477731b2007-06-16 03:06:27 +0000847/*
848** If SQLITE_CHECK_PAGES is defined then we do some sanity checking
849** on the cache using a hash function. This is used for testing
850** and debugging only.
851*/
danielk19773c407372005-02-15 02:54:14 +0000852#ifdef SQLITE_CHECK_PAGES
853/*
854** Return a 32-bit hash of the page data for pPage.
855*/
drh477731b2007-06-16 03:06:27 +0000856static u32 pager_datahash(int nByte, unsigned char *pData){
danielk19773c407372005-02-15 02:54:14 +0000857 u32 hash = 0;
858 int i;
drh477731b2007-06-16 03:06:27 +0000859 for(i=0; i<nByte; i++){
860 hash = (hash*1039) + pData[i];
danielk19773c407372005-02-15 02:54:14 +0000861 }
862 return hash;
863}
drh477731b2007-06-16 03:06:27 +0000864static u32 pager_pagehash(PgHdr *pPage){
865 return pager_datahash(pPage->pPager->pageSize,
866 (unsigned char *)PGHDR_TO_DATA(pPage));
867}
danielk19773c407372005-02-15 02:54:14 +0000868
869/*
870** The CHECK_PAGE macro takes a PgHdr* as an argument. If SQLITE_CHECK_PAGES
871** is defined, and NDEBUG is not defined, an assert() statement checks
872** that the page is either dirty or still matches the calculated page-hash.
873*/
874#define CHECK_PAGE(x) checkPage(x)
875static void checkPage(PgHdr *pPg){
876 Pager *pPager = pPg->pPager;
danielk1977efaaf572006-01-16 11:29:19 +0000877 assert( !pPg->pageHash || pPager->errCode || MEMDB || pPg->dirty ||
danielk19773c407372005-02-15 02:54:14 +0000878 pPg->pageHash==pager_pagehash(pPg) );
879}
880
881#else
drh8ffa8172007-06-18 17:25:17 +0000882#define pager_datahash(X,Y) 0
drh477731b2007-06-16 03:06:27 +0000883#define pager_pagehash(X) 0
danielk19773c407372005-02-15 02:54:14 +0000884#define CHECK_PAGE(x)
885#endif
886
drhed7c8552001-04-11 14:29:21 +0000887/*
danielk197776572402004-06-25 02:38:54 +0000888** When this is called the journal file for pager pPager must be open.
889** The master journal file name is read from the end of the file and
danielk197765839c62007-08-30 08:08:17 +0000890** written into memory supplied by the caller.
danielk197776572402004-06-25 02:38:54 +0000891**
danielk197765839c62007-08-30 08:08:17 +0000892** zMaster must point to a buffer of at least nMaster bytes allocated by
893** the caller. This should be sqlite3_vfs.mxPathname+1 (to ensure there is
894** enough space to write the master journal name). If the master journal
895** name in the journal is longer than nMaster bytes (including a
896** nul-terminator), then this is handled as if no master journal name
897** were present in the journal.
898**
899** If no master journal file name is present zMaster[0] is set to 0 and
danielk197776572402004-06-25 02:38:54 +0000900** SQLITE_OK returned.
901*/
danielk197765839c62007-08-30 08:08:17 +0000902static int readMasterJournal(sqlite3_file *pJrnl, char *zMaster, int nMaster){
danielk197776572402004-06-25 02:38:54 +0000903 int rc;
904 u32 len;
drheb206252004-10-01 02:00:31 +0000905 i64 szJ;
danielk1977c3e8f5e2004-06-28 01:16:46 +0000906 u32 cksum;
danielk1977cafadba2004-06-25 11:11:54 +0000907 int i;
danielk197776572402004-06-25 02:38:54 +0000908 unsigned char aMagic[8]; /* A buffer to hold the magic header */
909
danielk197765839c62007-08-30 08:08:17 +0000910 zMaster[0] = '\0';
danielk197776572402004-06-25 02:38:54 +0000911
drh054889e2005-11-30 03:20:31 +0000912 rc = sqlite3OsFileSize(pJrnl, &szJ);
danielk1977cafadba2004-06-25 11:11:54 +0000913 if( rc!=SQLITE_OK || szJ<16 ) return rc;
danielk197776572402004-06-25 02:38:54 +0000914
danielk197762079062007-08-15 17:08:46 +0000915 rc = read32bits(pJrnl, szJ-16, &len);
danielk197776572402004-06-25 02:38:54 +0000916 if( rc!=SQLITE_OK ) return rc;
917
danielk197765839c62007-08-30 08:08:17 +0000918 if( len>=nMaster ){
919 return SQLITE_OK;
920 }
921
danielk197762079062007-08-15 17:08:46 +0000922 rc = read32bits(pJrnl, szJ-12, &cksum);
danielk1977cafadba2004-06-25 11:11:54 +0000923 if( rc!=SQLITE_OK ) return rc;
924
danielk197762079062007-08-15 17:08:46 +0000925 rc = sqlite3OsRead(pJrnl, aMagic, 8, szJ-8);
danielk197776572402004-06-25 02:38:54 +0000926 if( rc!=SQLITE_OK || memcmp(aMagic, aJournalMagic, 8) ) return rc;
927
danielk197765839c62007-08-30 08:08:17 +0000928 rc = sqlite3OsRead(pJrnl, zMaster, len, szJ-16-len);
danielk197776572402004-06-25 02:38:54 +0000929 if( rc!=SQLITE_OK ){
danielk197776572402004-06-25 02:38:54 +0000930 return rc;
931 }
danielk197765839c62007-08-30 08:08:17 +0000932 zMaster[len] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000933
934 /* See if the checksum matches the master journal name */
935 for(i=0; i<len; i++){
danielk197765839c62007-08-30 08:08:17 +0000936 cksum -= zMaster[i];
937 }
danielk19778191bff2004-06-28 04:52:30 +0000938 if( cksum ){
939 /* If the checksum doesn't add up, then one or more of the disk sectors
940 ** containing the master journal filename is corrupted. This means
941 ** definitely roll back, so just return SQLITE_OK and report a (nul)
942 ** master-journal filename.
943 */
danielk197765839c62007-08-30 08:08:17 +0000944 zMaster[0] = '\0';
danielk1977cafadba2004-06-25 11:11:54 +0000945 }
danielk197776572402004-06-25 02:38:54 +0000946
947 return SQLITE_OK;
948}
949
950/*
951** Seek the journal file descriptor to the next sector boundary where a
952** journal header may be read or written. Pager.journalOff is updated with
953** the new seek offset.
954**
955** i.e for a sector size of 512:
956**
957** Input Offset Output Offset
958** ---------------------------------------
959** 0 0
960** 512 512
961** 100 512
962** 2000 2048
963**
964*/
danielk197762079062007-08-15 17:08:46 +0000965static void seekJournalHdr(Pager *pPager){
drheb206252004-10-01 02:00:31 +0000966 i64 offset = 0;
967 i64 c = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +0000968 if( c ){
969 offset = ((c-1)/JOURNAL_HDR_SZ(pPager) + 1) * JOURNAL_HDR_SZ(pPager);
970 }
971 assert( offset%JOURNAL_HDR_SZ(pPager)==0 );
972 assert( offset>=c );
973 assert( (offset-c)<JOURNAL_HDR_SZ(pPager) );
974 pPager->journalOff = offset;
danielk197776572402004-06-25 02:38:54 +0000975}
976
977/*
978** The journal file must be open when this routine is called. A journal
979** header (JOURNAL_HDR_SZ bytes) is written into the journal file at the
980** current location.
981**
982** The format for the journal header is as follows:
983** - 8 bytes: Magic identifying journal format.
984** - 4 bytes: Number of records in journal, or -1 no-sync mode is on.
985** - 4 bytes: Random number used for page hash.
986** - 4 bytes: Initial database page count.
987** - 4 bytes: Sector size used by the process that wrote this journal.
988**
danielk1977f42f25c2004-06-25 07:21:28 +0000989** Followed by (JOURNAL_HDR_SZ - 24) bytes of unused space.
danielk197776572402004-06-25 02:38:54 +0000990*/
991static int writeJournalHdr(Pager *pPager){
drh97b57482006-01-10 20:32:32 +0000992 char zHeader[sizeof(aJournalMagic)+16];
danielk19774099f6e2007-03-19 11:25:20 +0000993 int rc;
danielk197776572402004-06-25 02:38:54 +0000994
danielk19774099f6e2007-03-19 11:25:20 +0000995 if( pPager->stmtHdrOff==0 ){
996 pPager->stmtHdrOff = pPager->journalOff;
997 }
998
danielk197762079062007-08-15 17:08:46 +0000999 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +00001000 pPager->journalHdr = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +00001001
drh97b57482006-01-10 20:32:32 +00001002 memcpy(zHeader, aJournalMagic, sizeof(aJournalMagic));
danielk19774cd2cd52007-08-23 14:48:23 +00001003
1004 /*
1005 ** Write the nRec Field - the number of page records that follow this
1006 ** journal header. Normally, zero is written to this value at this time.
1007 ** After the records are added to the journal (and the journal synced,
1008 ** if in full-sync mode), the zero is overwritten with the true number
1009 ** of records (see syncJournal()).
1010 **
1011 ** A faster alternative is to write 0xFFFFFFFF to the nRec field. When
1012 ** reading the journal this value tells SQLite to assume that the
1013 ** rest of the journal file contains valid page records. This assumption
1014 ** is dangerous, as if a failure occured whilst writing to the journal
1015 ** file it may contain some garbage data. There are two scenarios
1016 ** where this risk can be ignored:
1017 **
1018 ** * When the pager is in no-sync mode. Corruption can follow a
1019 ** power failure in this case anyway.
1020 **
1021 ** * When the SQLITE_IOCAP_SAFE_APPEND flag is set. This guarantees
1022 ** that garbage data is never appended to the journal file.
1023 */
1024 assert(pPager->fd->pMethods||pPager->noSync);
1025 if( (pPager->noSync)
1026 || (sqlite3OsDeviceCharacteristics(pPager->fd)&SQLITE_IOCAP_SAFE_APPEND)
1027 ){
1028 put32bits(&zHeader[sizeof(aJournalMagic)], 0xffffffff);
1029 }else{
1030 put32bits(&zHeader[sizeof(aJournalMagic)], 0);
1031 }
1032
drh97b57482006-01-10 20:32:32 +00001033 /* The random check-hash initialiser */
1034 sqlite3Randomness(sizeof(pPager->cksumInit), &pPager->cksumInit);
1035 put32bits(&zHeader[sizeof(aJournalMagic)+4], pPager->cksumInit);
1036 /* The initial database size */
1037 put32bits(&zHeader[sizeof(aJournalMagic)+8], pPager->dbSize);
1038 /* The assumed sector size for this process */
1039 put32bits(&zHeader[sizeof(aJournalMagic)+12], pPager->sectorSize);
drhb0603412007-02-28 04:47:26 +00001040 IOTRACE(("JHDR %p %lld %d\n", pPager, pPager->journalHdr, sizeof(zHeader)))
danielk197762079062007-08-15 17:08:46 +00001041 rc = sqlite3OsWrite(pPager->jfd, zHeader, sizeof(zHeader),pPager->journalOff);
1042 pPager->journalOff += JOURNAL_HDR_SZ(pPager);
danielk197776572402004-06-25 02:38:54 +00001043
1044 /* The journal header has been written successfully. Seek the journal
1045 ** file descriptor to the end of the journal header sector.
1046 */
1047 if( rc==SQLITE_OK ){
drhb0603412007-02-28 04:47:26 +00001048 IOTRACE(("JTAIL %p %lld\n", pPager, pPager->journalOff-1))
danielk197762079062007-08-15 17:08:46 +00001049 rc = sqlite3OsWrite(pPager->jfd, "\000", 1, pPager->journalOff-1);
danielk197776572402004-06-25 02:38:54 +00001050 }
1051 return rc;
1052}
1053
1054/*
1055** The journal file must be open when this is called. A journal header file
1056** (JOURNAL_HDR_SZ bytes) is read from the current location in the journal
1057** file. See comments above function writeJournalHdr() for a description of
1058** the journal header format.
1059**
1060** If the header is read successfully, *nRec is set to the number of
1061** page records following this header and *dbSize is set to the size of the
1062** database before the transaction began, in pages. Also, pPager->cksumInit
1063** is set to the value read from the journal header. SQLITE_OK is returned
1064** in this case.
1065**
1066** If the journal header file appears to be corrupted, SQLITE_DONE is
1067** returned and *nRec and *dbSize are not set. If JOURNAL_HDR_SZ bytes
1068** cannot be read from the journal file an error code is returned.
1069*/
1070static int readJournalHdr(
1071 Pager *pPager,
drheb206252004-10-01 02:00:31 +00001072 i64 journalSize,
danielk197776572402004-06-25 02:38:54 +00001073 u32 *pNRec,
1074 u32 *pDbSize
1075){
1076 int rc;
1077 unsigned char aMagic[8]; /* A buffer to hold the magic header */
danielk197762079062007-08-15 17:08:46 +00001078 i64 jrnlOff;
danielk197776572402004-06-25 02:38:54 +00001079
danielk197762079062007-08-15 17:08:46 +00001080 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +00001081 if( pPager->journalOff+JOURNAL_HDR_SZ(pPager) > journalSize ){
1082 return SQLITE_DONE;
1083 }
danielk197762079062007-08-15 17:08:46 +00001084 jrnlOff = pPager->journalOff;
danielk197776572402004-06-25 02:38:54 +00001085
danielk197762079062007-08-15 17:08:46 +00001086 rc = sqlite3OsRead(pPager->jfd, aMagic, sizeof(aMagic), jrnlOff);
danielk197776572402004-06-25 02:38:54 +00001087 if( rc ) return rc;
danielk197762079062007-08-15 17:08:46 +00001088 jrnlOff += sizeof(aMagic);
danielk197776572402004-06-25 02:38:54 +00001089
1090 if( memcmp(aMagic, aJournalMagic, sizeof(aMagic))!=0 ){
1091 return SQLITE_DONE;
1092 }
1093
danielk197762079062007-08-15 17:08:46 +00001094 rc = read32bits(pPager->jfd, jrnlOff, pNRec);
danielk197776572402004-06-25 02:38:54 +00001095 if( rc ) return rc;
1096
danielk197762079062007-08-15 17:08:46 +00001097 rc = read32bits(pPager->jfd, jrnlOff+4, &pPager->cksumInit);
danielk197776572402004-06-25 02:38:54 +00001098 if( rc ) return rc;
1099
danielk197762079062007-08-15 17:08:46 +00001100 rc = read32bits(pPager->jfd, jrnlOff+8, pDbSize);
danielk197776572402004-06-25 02:38:54 +00001101 if( rc ) return rc;
1102
1103 /* Update the assumed sector-size to match the value used by
1104 ** the process that created this journal. If this journal was
1105 ** created by a process other than this one, then this routine
1106 ** is being called from within pager_playback(). The local value
1107 ** of Pager.sectorSize is restored at the end of that routine.
1108 */
danielk197762079062007-08-15 17:08:46 +00001109 rc = read32bits(pPager->jfd, jrnlOff+12, (u32 *)&pPager->sectorSize);
danielk197776572402004-06-25 02:38:54 +00001110 if( rc ) return rc;
1111
1112 pPager->journalOff += JOURNAL_HDR_SZ(pPager);
danielk197762079062007-08-15 17:08:46 +00001113 return SQLITE_OK;
danielk197776572402004-06-25 02:38:54 +00001114}
1115
1116
1117/*
1118** Write the supplied master journal name into the journal file for pager
danielk1977cafadba2004-06-25 11:11:54 +00001119** pPager at the current location. The master journal name must be the last
1120** thing written to a journal file. If the pager is in full-sync mode, the
1121** journal file descriptor is advanced to the next sector boundary before
1122** anything is written. The format is:
1123**
1124** + 4 bytes: PAGER_MJ_PGNO.
1125** + N bytes: length of master journal name.
1126** + 4 bytes: N
1127** + 4 bytes: Master journal name checksum.
1128** + 8 bytes: aJournalMagic[].
1129**
1130** The master journal page checksum is the sum of the bytes in the master
1131** journal name.
danielk1977aef0bf62005-12-30 16:28:01 +00001132**
1133** If zMaster is a NULL pointer (occurs for a single database transaction),
1134** this call is a no-op.
danielk197776572402004-06-25 02:38:54 +00001135*/
1136static int writeMasterJournal(Pager *pPager, const char *zMaster){
1137 int rc;
1138 int len;
danielk1977cafadba2004-06-25 11:11:54 +00001139 int i;
danielk197762079062007-08-15 17:08:46 +00001140 i64 jrnlOff;
drh97b57482006-01-10 20:32:32 +00001141 u32 cksum = 0;
1142 char zBuf[sizeof(aJournalMagic)+2*4];
danielk197776572402004-06-25 02:38:54 +00001143
1144 if( !zMaster || pPager->setMaster) return SQLITE_OK;
1145 pPager->setMaster = 1;
1146
1147 len = strlen(zMaster);
danielk1977cafadba2004-06-25 11:11:54 +00001148 for(i=0; i<len; i++){
1149 cksum += zMaster[i];
1150 }
danielk197776572402004-06-25 02:38:54 +00001151
1152 /* If in full-sync mode, advance to the next disk sector before writing
1153 ** the master journal name. This is in case the previous page written to
1154 ** the journal has already been synced.
1155 */
1156 if( pPager->fullSync ){
danielk197762079062007-08-15 17:08:46 +00001157 seekJournalHdr(pPager);
danielk197776572402004-06-25 02:38:54 +00001158 }
danielk197762079062007-08-15 17:08:46 +00001159 jrnlOff = pPager->journalOff;
danielk1977cafadba2004-06-25 11:11:54 +00001160 pPager->journalOff += (len+20);
danielk197776572402004-06-25 02:38:54 +00001161
danielk197762079062007-08-15 17:08:46 +00001162 rc = write32bits(pPager->jfd, jrnlOff, PAGER_MJ_PGNO(pPager));
danielk197776572402004-06-25 02:38:54 +00001163 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +00001164 jrnlOff += 4;
danielk197776572402004-06-25 02:38:54 +00001165
danielk197762079062007-08-15 17:08:46 +00001166 rc = sqlite3OsWrite(pPager->jfd, zMaster, len, jrnlOff);
danielk197776572402004-06-25 02:38:54 +00001167 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +00001168 jrnlOff += len;
danielk197776572402004-06-25 02:38:54 +00001169
drh97b57482006-01-10 20:32:32 +00001170 put32bits(zBuf, len);
1171 put32bits(&zBuf[4], cksum);
1172 memcpy(&zBuf[8], aJournalMagic, sizeof(aJournalMagic));
danielk197762079062007-08-15 17:08:46 +00001173 rc = sqlite3OsWrite(pPager->jfd, zBuf, 8+sizeof(aJournalMagic), jrnlOff);
drh2c8997b2005-08-27 16:36:48 +00001174 pPager->needSync = !pPager->noSync;
danielk197776572402004-06-25 02:38:54 +00001175 return rc;
1176}
1177
1178/*
drh03eb96a2002-11-10 23:32:56 +00001179** Add or remove a page from the list of all pages that are in the
drhac69b052004-05-12 13:30:07 +00001180** statement journal.
drh03eb96a2002-11-10 23:32:56 +00001181**
1182** The Pager keeps a separate list of pages that are currently in
danielk19773b8a05f2007-03-19 17:44:26 +00001183** the statement journal. This helps the sqlite3PagerStmtCommit()
drh03eb96a2002-11-10 23:32:56 +00001184** routine run MUCH faster for the common case where there are many
drhac69b052004-05-12 13:30:07 +00001185** pages in memory but only a few are in the statement journal.
drh03eb96a2002-11-10 23:32:56 +00001186*/
drh3aac2dd2004-04-26 14:10:20 +00001187static void page_add_to_stmt_list(PgHdr *pPg){
drh03eb96a2002-11-10 23:32:56 +00001188 Pager *pPager = pPg->pPager;
danielk1977f35843b2007-04-07 15:03:17 +00001189 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
1190 assert( MEMDB );
1191 if( !pHist->inStmt ){
1192 assert( pHist->pPrevStmt==0 && pHist->pNextStmt==0 );
1193 if( pPager->pStmt ){
1194 PGHDR_TO_HIST(pPager->pStmt, pPager)->pPrevStmt = pPg;
1195 }
1196 pHist->pNextStmt = pPager->pStmt;
1197 pPager->pStmt = pPg;
1198 pHist->inStmt = 1;
drh03eb96a2002-11-10 23:32:56 +00001199 }
drh03eb96a2002-11-10 23:32:56 +00001200}
1201
1202/*
drhed7c8552001-04-11 14:29:21 +00001203** Find a page in the hash table given its page number. Return
1204** a pointer to the page or NULL if not found.
1205*/
drhd9b02572001-04-15 00:37:09 +00001206static PgHdr *pager_lookup(Pager *pPager, Pgno pgno){
drh8ca0c722006-05-07 17:49:38 +00001207 PgHdr *p;
1208 if( pPager->aHash==0 ) return 0;
1209 p = pPager->aHash[pgno & (pPager->nHash-1)];
drhed7c8552001-04-11 14:29:21 +00001210 while( p && p->pgno!=pgno ){
1211 p = p->pNextHash;
1212 }
1213 return p;
1214}
1215
1216/*
danielk1977e180dd92007-04-05 17:15:52 +00001217** Clear the in-memory cache. This routine
drhed7c8552001-04-11 14:29:21 +00001218** sets the state of the pager back to what it was when it was first
1219** opened. Any outstanding pages are invalidated and subsequent attempts
1220** to access those pages will likely result in a coredump.
1221*/
drhd9b02572001-04-15 00:37:09 +00001222static void pager_reset(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +00001223 PgHdr *pPg, *pNext;
danielk1977efaaf572006-01-16 11:29:19 +00001224 if( pPager->errCode ) return;
drhd9b02572001-04-15 00:37:09 +00001225 for(pPg=pPager->pAll; pPg; pPg=pNext){
drh538f5702007-04-13 02:14:30 +00001226 IOTRACE(("PGFREE %p %d\n", pPager, pPg->pgno));
1227 PAGER_INCR(sqlite3_pager_pgfree_count);
drhd9b02572001-04-15 00:37:09 +00001228 pNext = pPg->pNextAll;
danielk19779f61c2f2007-08-27 17:27:49 +00001229 lruListRemove(pPg);
drh17435752007-08-16 04:30:38 +00001230 sqlite3_free(pPg);
drhed7c8552001-04-11 14:29:21 +00001231 }
danielk19779f61c2f2007-08-27 17:27:49 +00001232 assert(pPager->lru.pFirst==0);
1233 assert(pPager->lru.pFirstSynced==0);
1234 assert(pPager->lru.pLast==0);
danielk1977b94bf852007-03-19 13:53:37 +00001235 pPager->pStmt = 0;
drhd9b02572001-04-15 00:37:09 +00001236 pPager->pAll = 0;
danielk1977ae72d982007-10-03 08:46:44 +00001237 pPager->pDirty = 0;
drh8ca0c722006-05-07 17:49:38 +00001238 pPager->nHash = 0;
drh17435752007-08-16 04:30:38 +00001239 sqlite3_free(pPager->aHash);
drhed7c8552001-04-11 14:29:21 +00001240 pPager->nPage = 0;
drh8ca0c722006-05-07 17:49:38 +00001241 pPager->aHash = 0;
drhed7c8552001-04-11 14:29:21 +00001242 pPager->nRef = 0;
danielk1977e277be02007-03-23 18:12:06 +00001243}
1244
1245/*
danielk1977ae72d982007-10-03 08:46:44 +00001246** Unlock the database file.
1247**
1248** If the pager is currently in error state, discard the contents of
1249** the cache and reset the Pager structure internal state. If there is
1250** an open journal-file, then the next time a shared-lock is obtained
1251** on the pager file (by this or any other process), it will be
1252** treated as a hot-journal and rolled back.
1253*/
1254static void pager_unlock(Pager *pPager){
1255 if( !pPager->exclusiveMode ){
1256 if( !MEMDB ){
1257 if( pPager->fd->pMethods ){
1258 osUnlock(pPager->fd, NO_LOCK);
1259 }
1260 pPager->dbSize = -1;
1261 IOTRACE(("UNLOCK %p\n", pPager))
1262
1263 /* If Pager.errCode is set, the contents of the pager cache cannot be
1264 ** trusted. Now that the pager file is unlocked, the contents of the
1265 ** cache can be discarded and the error code safely cleared.
1266 */
1267 if( pPager->errCode ){
1268 pPager->errCode = SQLITE_OK;
1269 pager_reset(pPager);
1270 if( pPager->stmtOpen ){
1271 sqlite3OsClose(pPager->stfd);
danielk1977c4f6f622007-10-03 15:22:25 +00001272 sqlite3_free(pPager->aInStmt);
1273 pPager->aInStmt = 0;
danielk1977ae72d982007-10-03 08:46:44 +00001274 }
1275 if( pPager->journalOpen ){
1276 sqlite3OsClose(pPager->jfd);
1277 pPager->journalOpen = 0;
danielk1977c4f6f622007-10-03 15:22:25 +00001278 sqlite3_free(pPager->aInJournal);
1279 pPager->aInJournal = 0;
danielk1977ae72d982007-10-03 08:46:44 +00001280 }
1281 pPager->stmtOpen = 0;
1282 pPager->stmtInUse = 0;
1283 pPager->journalOff = 0;
1284 pPager->journalStarted = 0;
1285 pPager->stmtAutoopen = 0;
1286 pPager->origDbSize = 0;
1287 }
1288 }
1289
1290 if( !MEMDB || pPager->errCode==SQLITE_OK ){
1291 pPager->state = PAGER_UNLOCK;
1292 pPager->changeCountDone = 0;
1293 }
1294 }
1295}
1296
1297/*
1298** Execute a rollback if a transaction is active and unlock the
1299** database file. If the pager has already entered the error state,
1300** do not attempt the rollback.
1301*/
1302static void pagerUnlockAndRollback(Pager *p){
1303 assert( p->state>=PAGER_RESERVED || p->journalOpen==0 );
1304 if( p->errCode==SQLITE_OK && p->state>=PAGER_RESERVED ){
1305 sqlite3PagerRollback(p);
1306 }
1307 pager_unlock(p);
1308 assert( p->errCode || !p->journalOpen || (p->exclusiveMode&&!p->journalOff) );
1309 assert( p->errCode || !p->stmtOpen || p->exclusiveMode );
1310}
1311
1312/*
drh80e35f42007-03-30 14:06:34 +00001313** This routine ends a transaction. A transaction is ended by either
1314** a COMMIT or a ROLLBACK.
1315**
drhed7c8552001-04-11 14:29:21 +00001316** When this routine is called, the pager has the journal file open and
drh80e35f42007-03-30 14:06:34 +00001317** a RESERVED or EXCLUSIVE lock on the database. This routine will release
1318** the database lock and acquires a SHARED lock in its place if that is
1319** the appropriate thing to do. Release locks usually is appropriate,
1320** unless we are in exclusive access mode or unless this is a
1321** COMMIT AND BEGIN or ROLLBACK AND BEGIN operation.
1322**
1323** The journal file is either deleted or truncated.
drh50457892003-09-06 01:10:47 +00001324**
1325** TODO: Consider keeping the journal file open for temporary databases.
1326** This might give a performance improvement on windows where opening
1327** a file is an expensive operation.
drhed7c8552001-04-11 14:29:21 +00001328*/
drh80e35f42007-03-30 14:06:34 +00001329static int pager_end_transaction(Pager *pPager){
drhd9b02572001-04-15 00:37:09 +00001330 PgHdr *pPg;
danielk197741483462007-03-24 16:45:04 +00001331 int rc = SQLITE_OK;
danielk1977979f38e2007-03-27 16:19:51 +00001332 int rc2 = SQLITE_OK;
drhb7f91642004-10-31 02:22:47 +00001333 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +00001334 if( pPager->state<PAGER_RESERVED ){
1335 return SQLITE_OK;
1336 }
danielk19773b8a05f2007-03-19 17:44:26 +00001337 sqlite3PagerStmtCommit(pPager);
danielk1977334cdb62007-03-26 08:05:12 +00001338 if( pPager->stmtOpen && !pPager->exclusiveMode ){
danielk1977b4b47412007-08-17 15:53:36 +00001339 sqlite3OsClose(pPager->stfd);
danielk1977979f38e2007-03-27 16:19:51 +00001340 pPager->stmtOpen = 0;
drh0f892532002-05-30 12:27:03 +00001341 }
drhda47d772002-12-02 04:25:19 +00001342 if( pPager->journalOpen ){
drh01fa4c32007-04-02 11:22:22 +00001343 if( pPager->exclusiveMode
1344 && (rc = sqlite3OsTruncate(pPager->jfd, 0))==SQLITE_OK ){;
danielk197741483462007-03-24 16:45:04 +00001345 pPager->journalOff = 0;
danielk1977334cdb62007-03-26 08:05:12 +00001346 pPager->journalStarted = 0;
danielk197741483462007-03-24 16:45:04 +00001347 }else{
danielk1977b4b47412007-08-17 15:53:36 +00001348 sqlite3OsClose(pPager->jfd);
danielk197741483462007-03-24 16:45:04 +00001349 pPager->journalOpen = 0;
drh01fa4c32007-04-02 11:22:22 +00001350 if( rc==SQLITE_OK ){
danielk1977fee2d252007-08-18 10:59:19 +00001351 rc = sqlite3OsDelete(pPager->pVfs, pPager->zJournal, 0);
danielk19777152de82007-03-29 17:28:14 +00001352 }
danielk197741483462007-03-24 16:45:04 +00001353 }
drh17435752007-08-16 04:30:38 +00001354 sqlite3_free( pPager->aInJournal );
drhda47d772002-12-02 04:25:19 +00001355 pPager->aInJournal = 0;
1356 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
1357 pPg->inJournal = 0;
1358 pPg->dirty = 0;
drhdb48ee02003-01-16 13:42:43 +00001359 pPg->needSync = 0;
danielk197741483462007-03-24 16:45:04 +00001360 pPg->alwaysRollback = 0;
danielk19773c407372005-02-15 02:54:14 +00001361#ifdef SQLITE_CHECK_PAGES
1362 pPg->pageHash = pager_pagehash(pPg);
1363#endif
drhda47d772002-12-02 04:25:19 +00001364 }
drh605ad8f2006-05-03 23:34:05 +00001365 pPager->pDirty = 0;
danielk1977ef317ab2004-06-23 10:43:10 +00001366 pPager->dirtyCache = 0;
danielk1977ef317ab2004-06-23 10:43:10 +00001367 pPager->nRec = 0;
drhda47d772002-12-02 04:25:19 +00001368 }else{
drh88b01a12005-03-28 18:04:27 +00001369 assert( pPager->aInJournal==0 );
drha6abd042004-06-09 17:37:22 +00001370 assert( pPager->dirtyCache==0 || pPager->useJournal==0 );
drhd9b02572001-04-15 00:37:09 +00001371 }
danielk1977979f38e2007-03-27 16:19:51 +00001372
danielk197741483462007-03-24 16:45:04 +00001373 if( !pPager->exclusiveMode ){
danielk19777a2b1ee2007-08-21 14:27:01 +00001374 rc2 = osUnlock(pPager->fd, SHARED_LOCK);
danielk197741483462007-03-24 16:45:04 +00001375 pPager->state = PAGER_SHARED;
danielk1977334cdb62007-03-26 08:05:12 +00001376 }else if( pPager->state==PAGER_SYNCED ){
1377 pPager->state = PAGER_EXCLUSIVE;
danielk197741483462007-03-24 16:45:04 +00001378 }
danielk1977334cdb62007-03-26 08:05:12 +00001379 pPager->origDbSize = 0;
danielk197776572402004-06-25 02:38:54 +00001380 pPager->setMaster = 0;
danielk1977c4da5b92006-01-21 12:08:54 +00001381 pPager->needSync = 0;
danielk19779f61c2f2007-08-27 17:27:49 +00001382 lruListSetFirstSynced(pPager);
drh588f5bc2007-01-02 18:41:54 +00001383 pPager->dbSize = -1;
danielk1977979f38e2007-03-27 16:19:51 +00001384
1385 return (rc==SQLITE_OK?rc2:rc);
drhed7c8552001-04-11 14:29:21 +00001386}
1387
drhed7c8552001-04-11 14:29:21 +00001388/*
drh968af522003-02-11 14:55:40 +00001389** Compute and return a checksum for the page of data.
drh34e79ce2004-02-08 06:05:46 +00001390**
1391** This is not a real checksum. It is really just the sum of the
drh726de592004-06-10 23:35:50 +00001392** random initial value and the page number. We experimented with
1393** a checksum of the entire data, but that was found to be too slow.
1394**
1395** Note that the page number is stored at the beginning of data and
1396** the checksum is stored at the end. This is important. If journal
1397** corruption occurs due to a power failure, the most likely scenario
1398** is that one end or the other of the record will be changed. It is
1399** much less likely that the two ends of the journal record will be
1400** correct and the middle be corrupt. Thus, this "checksum" scheme,
1401** though fast and simple, catches the mostly likely kind of corruption.
1402**
1403** FIX ME: Consider adding every 200th (or so) byte of the data to the
1404** checksum. That way if a single page spans 3 or more disk sectors and
1405** only the middle sector is corrupt, we will still have a reasonable
1406** chance of failing the checksum and thus detecting the problem.
drh968af522003-02-11 14:55:40 +00001407*/
drh74161702006-02-24 02:53:49 +00001408static u32 pager_cksum(Pager *pPager, const u8 *aData){
danielk1977ef317ab2004-06-23 10:43:10 +00001409 u32 cksum = pPager->cksumInit;
1410 int i = pPager->pageSize-200;
1411 while( i>0 ){
1412 cksum += aData[i];
1413 i -= 200;
1414 }
drh968af522003-02-11 14:55:40 +00001415 return cksum;
1416}
1417
drh605ad8f2006-05-03 23:34:05 +00001418/* Forward declaration */
1419static void makeClean(PgHdr*);
1420
drh968af522003-02-11 14:55:40 +00001421/*
drhfa86c412002-02-02 15:01:15 +00001422** Read a single page from the journal file opened on file descriptor
1423** jfd. Playback this one page.
drh968af522003-02-11 14:55:40 +00001424**
drh726de592004-06-10 23:35:50 +00001425** If useCksum==0 it means this journal does not use checksums. Checksums
1426** are not used in statement journals because statement journals do not
1427** need to survive power failures.
drhfa86c412002-02-02 15:01:15 +00001428*/
danielk197762079062007-08-15 17:08:46 +00001429static int pager_playback_one_page(
1430 Pager *pPager,
1431 sqlite3_file *jfd,
1432 i64 offset,
1433 int useCksum
1434){
drhfa86c412002-02-02 15:01:15 +00001435 int rc;
drhae2b40c2004-06-09 19:03:54 +00001436 PgHdr *pPg; /* An existing page in the cache */
1437 Pgno pgno; /* The page number of a page in journal */
1438 u32 cksum; /* Checksum used for sanity checking */
danielk19778186df82007-03-06 13:45:59 +00001439 u8 *aData = (u8 *)pPager->pTmpSpace; /* Temp storage for a page */
drhfa86c412002-02-02 15:01:15 +00001440
drh96362842005-03-20 22:47:56 +00001441 /* useCksum should be true for the main journal and false for
1442 ** statement journals. Verify that this is always the case
1443 */
drh9cbe6352005-11-29 03:13:21 +00001444 assert( jfd == (useCksum ? pPager->jfd : pPager->stfd) );
danielk19778186df82007-03-06 13:45:59 +00001445 assert( aData );
drh96362842005-03-20 22:47:56 +00001446
danielk197762079062007-08-15 17:08:46 +00001447 rc = read32bits(jfd, offset, &pgno);
drh99ee3602003-02-16 19:13:36 +00001448 if( rc!=SQLITE_OK ) return rc;
danielk197762079062007-08-15 17:08:46 +00001449 rc = sqlite3OsRead(jfd, aData, pPager->pageSize, offset+4);
drh99ee3602003-02-16 19:13:36 +00001450 if( rc!=SQLITE_OK ) return rc;
danielk197776572402004-06-25 02:38:54 +00001451 pPager->journalOff += pPager->pageSize + 4;
drhfa86c412002-02-02 15:01:15 +00001452
drh968af522003-02-11 14:55:40 +00001453 /* Sanity checking on the page. This is more important that I originally
1454 ** thought. If a power failure occurs while the journal is being written,
1455 ** it could cause invalid data to be written into the journal. We need to
1456 ** detect this invalid data (with high probability) and ignore it.
1457 */
danielk197775edc162004-06-26 01:48:18 +00001458 if( pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh968af522003-02-11 14:55:40 +00001459 return SQLITE_DONE;
1460 }
drhae2b40c2004-06-09 19:03:54 +00001461 if( pgno>(unsigned)pPager->dbSize ){
drh968af522003-02-11 14:55:40 +00001462 return SQLITE_OK;
1463 }
drhae2b40c2004-06-09 19:03:54 +00001464 if( useCksum ){
danielk197762079062007-08-15 17:08:46 +00001465 rc = read32bits(jfd, offset+pPager->pageSize+4, &cksum);
drh99ee3602003-02-16 19:13:36 +00001466 if( rc ) return rc;
danielk197776572402004-06-25 02:38:54 +00001467 pPager->journalOff += 4;
drh74161702006-02-24 02:53:49 +00001468 if( pager_cksum(pPager, aData)!=cksum ){
drh968af522003-02-11 14:55:40 +00001469 return SQLITE_DONE;
1470 }
1471 }
drhfa86c412002-02-02 15:01:15 +00001472
danielk1977aa5ccdf2004-06-14 05:10:42 +00001473 assert( pPager->state==PAGER_RESERVED || pPager->state>=PAGER_EXCLUSIVE );
danielk1977a3f3a5f2004-06-10 04:32:16 +00001474
1475 /* If the pager is in RESERVED state, then there must be a copy of this
1476 ** page in the pager cache. In this case just update the pager cache,
danielk19770de0bb32004-06-10 05:59:24 +00001477 ** not the database file. The page is left marked dirty in this case.
1478 **
danielk19772df71c72007-05-24 07:22:42 +00001479 ** An exception to the above rule: If the database is in no-sync mode
1480 ** and a page is moved during an incremental vacuum then the page may
danielk1977369f3a02007-05-24 09:41:20 +00001481 ** not be in the pager cache. Later: if a malloc() or IO error occurs
1482 ** during a Movepage() call, then the page may not be in the cache
1483 ** either. So the condition described in the above paragraph is not
1484 ** assert()able.
danielk19772df71c72007-05-24 07:22:42 +00001485 **
danielk1977a3f3a5f2004-06-10 04:32:16 +00001486 ** If in EXCLUSIVE state, then we update the pager cache if it exists
1487 ** and the main file. The page is then marked not dirty.
drh96362842005-03-20 22:47:56 +00001488 **
1489 ** Ticket #1171: The statement journal might contain page content that is
1490 ** different from the page content at the start of the transaction.
1491 ** This occurs when a page is changed prior to the start of a statement
1492 ** then changed again within the statement. When rolling back such a
1493 ** statement we must not write to the original database unless we know
drh5e385312007-06-16 04:42:12 +00001494 ** for certain that original page contents are synced into the main rollback
1495 ** journal. Otherwise, a power loss might leave modified data in the
1496 ** database file without an entry in the rollback journal that can
1497 ** restore the database to its original form. Two conditions must be
1498 ** met before writing to the database files. (1) the database must be
1499 ** locked. (2) we know that the original page content is fully synced
1500 ** in the main journal either because the page is not in cache or else
1501 ** the page is marked as needSync==0.
drhfa86c412002-02-02 15:01:15 +00001502 */
drhae2b40c2004-06-09 19:03:54 +00001503 pPg = pager_lookup(pPager, pgno);
drh477731b2007-06-16 03:06:27 +00001504 PAGERTRACE4("PLAYBACK %d page %d hash(%08x)\n",
1505 PAGERID(pPager), pgno, pager_datahash(pPager->pageSize, aData));
drh96362842005-03-20 22:47:56 +00001506 if( pPager->state>=PAGER_EXCLUSIVE && (pPg==0 || pPg->needSync==0) ){
danielk197762079062007-08-15 17:08:46 +00001507 i64 offset = (pgno-1)*(i64)pPager->pageSize;
1508 rc = sqlite3OsWrite(pPager->fd, aData, pPager->pageSize, offset);
drh605ad8f2006-05-03 23:34:05 +00001509 if( pPg ){
1510 makeClean(pPg);
1511 }
danielk1977a3f3a5f2004-06-10 04:32:16 +00001512 }
drhfa86c412002-02-02 15:01:15 +00001513 if( pPg ){
danielk197728129562005-01-11 10:25:06 +00001514 /* No page should ever be explicitly rolled back that is in use, except
1515 ** for page 1 which is held in use in order to keep the lock on the
1516 ** database active. However such a page may be rolled back as a result
1517 ** of an internal error resulting in an automatic call to
danielk19773b8a05f2007-03-19 17:44:26 +00001518 ** sqlite3PagerRollback().
drhacf4ac92003-12-17 23:57:34 +00001519 */
drhb6f41482004-05-14 01:58:11 +00001520 void *pData;
danielk197728129562005-01-11 10:25:06 +00001521 /* assert( pPg->nRef==0 || pPg->pgno==1 ); */
drhb6f41482004-05-14 01:58:11 +00001522 pData = PGHDR_TO_DATA(pPg);
drhae2b40c2004-06-09 19:03:54 +00001523 memcpy(pData, aData, pPager->pageSize);
danielk19779038bb62007-04-09 11:20:54 +00001524 if( pPager->xReiniter ){
1525 pPager->xReiniter(pPg, pPager->pageSize);
drhde647132004-05-07 17:57:49 +00001526 }
danielk19773c407372005-02-15 02:54:14 +00001527#ifdef SQLITE_CHECK_PAGES
drh96362842005-03-20 22:47:56 +00001528 pPg->pageHash = pager_pagehash(pPg);
danielk19773c407372005-02-15 02:54:14 +00001529#endif
drh86a88112007-04-16 15:02:19 +00001530 /* If this was page 1, then restore the value of Pager.dbFileVers.
1531 ** Do this before any decoding. */
danielk197741483462007-03-24 16:45:04 +00001532 if( pgno==1 ){
drh86a88112007-04-16 15:02:19 +00001533 memcpy(&pPager->dbFileVers, &((u8*)pData)[24],sizeof(pPager->dbFileVers));
danielk197741483462007-03-24 16:45:04 +00001534 }
drh86a88112007-04-16 15:02:19 +00001535
1536 /* Decode the page just read from disk */
1537 CODEC1(pPager, pData, pPg->pgno, 3);
drhfa86c412002-02-02 15:01:15 +00001538 }
1539 return rc;
1540}
1541
1542/*
danielk197713adf8a2004-06-03 16:08:41 +00001543** Parameter zMaster is the name of a master journal file. A single journal
1544** file that referred to the master journal file has just been rolled back.
1545** This routine checks if it is possible to delete the master journal file,
1546** and does so if it is.
drh726de592004-06-10 23:35:50 +00001547**
danielk197765839c62007-08-30 08:08:17 +00001548** Argument zMaster may point to Pager.pTmpSpace. So that buffer is not
1549** available for use within this function.
1550**
1551**
drh726de592004-06-10 23:35:50 +00001552** The master journal file contains the names of all child journals.
1553** To tell if a master journal can be deleted, check to each of the
1554** children. If all children are either missing or do not refer to
1555** a different master journal, then this master journal can be deleted.
danielk197713adf8a2004-06-03 16:08:41 +00001556*/
danielk1977b4b47412007-08-17 15:53:36 +00001557static int pager_delmaster(Pager *pPager, const char *zMaster){
1558 sqlite3_vfs *pVfs = pPager->pVfs;
danielk197713adf8a2004-06-03 16:08:41 +00001559 int rc;
1560 int master_open = 0;
danielk1977b4b47412007-08-17 15:53:36 +00001561 sqlite3_file *pMaster;
1562 sqlite3_file *pJournal;
danielk197713adf8a2004-06-03 16:08:41 +00001563 char *zMasterJournal = 0; /* Contents of master journal file */
drheb206252004-10-01 02:00:31 +00001564 i64 nMasterJournal; /* Size of master journal file */
danielk197713adf8a2004-06-03 16:08:41 +00001565
1566 /* Open the master journal file exclusively in case some other process
1567 ** is running this routine also. Not that it makes too much difference.
1568 */
danielk1977b4b47412007-08-17 15:53:36 +00001569 pMaster = (sqlite3_file *)sqlite3_malloc(pVfs->szOsFile * 2);
danielk1977fee2d252007-08-18 10:59:19 +00001570 pJournal = (sqlite3_file *)(((u8 *)pMaster) + pVfs->szOsFile);
danielk1977b4b47412007-08-17 15:53:36 +00001571 if( !pMaster ){
1572 rc = SQLITE_NOMEM;
1573 }else{
danielk1977fee2d252007-08-18 10:59:19 +00001574 int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MASTER_JOURNAL);
1575 rc = sqlite3OsOpen(pVfs, zMaster, pMaster, flags, 0);
danielk1977b4b47412007-08-17 15:53:36 +00001576 }
danielk197713adf8a2004-06-03 16:08:41 +00001577 if( rc!=SQLITE_OK ) goto delmaster_out;
1578 master_open = 1;
danielk1977b4b47412007-08-17 15:53:36 +00001579
1580 rc = sqlite3OsFileSize(pMaster, &nMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001581 if( rc!=SQLITE_OK ) goto delmaster_out;
1582
1583 if( nMasterJournal>0 ){
danielk19775865e3d2004-06-14 06:03:57 +00001584 char *zJournal;
danielk197776572402004-06-25 02:38:54 +00001585 char *zMasterPtr = 0;
danielk197765839c62007-08-30 08:08:17 +00001586 int nMasterPtr = pPager->pVfs->mxPathname+1;
danielk19775865e3d2004-06-14 06:03:57 +00001587
1588 /* Load the entire master journal file into space obtained from
drh17435752007-08-16 04:30:38 +00001589 ** sqlite3_malloc() and pointed to by zMasterJournal.
danielk19775865e3d2004-06-14 06:03:57 +00001590 */
danielk197765839c62007-08-30 08:08:17 +00001591 zMasterJournal = (char *)sqlite3_malloc(nMasterJournal + nMasterPtr);
danielk197713adf8a2004-06-03 16:08:41 +00001592 if( !zMasterJournal ){
1593 rc = SQLITE_NOMEM;
1594 goto delmaster_out;
1595 }
danielk197765839c62007-08-30 08:08:17 +00001596 zMasterPtr = &zMasterJournal[nMasterJournal];
danielk1977b4b47412007-08-17 15:53:36 +00001597 rc = sqlite3OsRead(pMaster, zMasterJournal, nMasterJournal, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001598 if( rc!=SQLITE_OK ) goto delmaster_out;
1599
danielk19775865e3d2004-06-14 06:03:57 +00001600 zJournal = zMasterJournal;
1601 while( (zJournal-zMasterJournal)<nMasterJournal ){
danielk1977b4b47412007-08-17 15:53:36 +00001602 if( sqlite3OsAccess(pVfs, zJournal, SQLITE_ACCESS_EXISTS) ){
danielk197713adf8a2004-06-03 16:08:41 +00001603 /* One of the journals pointed to by the master journal exists.
1604 ** Open it and check if it points at the master journal. If
1605 ** so, return without deleting the master journal file.
1606 */
drh3b7b78b2004-11-24 01:16:43 +00001607 int c;
danielk1977fee2d252007-08-18 10:59:19 +00001608 int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MAIN_JOURNAL);
1609 rc = sqlite3OsOpen(pVfs, zJournal, pJournal, flags, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001610 if( rc!=SQLITE_OK ){
danielk197713adf8a2004-06-03 16:08:41 +00001611 goto delmaster_out;
1612 }
danielk197713adf8a2004-06-03 16:08:41 +00001613
danielk197765839c62007-08-30 08:08:17 +00001614 rc = readMasterJournal(pJournal, zMasterPtr, nMasterPtr);
danielk1977b4b47412007-08-17 15:53:36 +00001615 sqlite3OsClose(pJournal);
danielk19779eed5052004-06-04 10:38:30 +00001616 if( rc!=SQLITE_OK ){
danielk19779eed5052004-06-04 10:38:30 +00001617 goto delmaster_out;
1618 }
danielk197776572402004-06-25 02:38:54 +00001619
danielk197765839c62007-08-30 08:08:17 +00001620 c = zMasterPtr[0]!=0 && strcmp(zMasterPtr, zMaster)==0;
drh3b7b78b2004-11-24 01:16:43 +00001621 if( c ){
danielk197776572402004-06-25 02:38:54 +00001622 /* We have a match. Do not delete the master journal file. */
1623 goto delmaster_out;
danielk197713adf8a2004-06-03 16:08:41 +00001624 }
1625 }
danielk19775865e3d2004-06-14 06:03:57 +00001626 zJournal += (strlen(zJournal)+1);
danielk197713adf8a2004-06-03 16:08:41 +00001627 }
1628 }
1629
danielk1977fee2d252007-08-18 10:59:19 +00001630 rc = sqlite3OsDelete(pVfs, zMaster, 0);
danielk197713adf8a2004-06-03 16:08:41 +00001631
1632delmaster_out:
1633 if( zMasterJournal ){
drh17435752007-08-16 04:30:38 +00001634 sqlite3_free(zMasterJournal);
danielk197713adf8a2004-06-03 16:08:41 +00001635 }
1636 if( master_open ){
danielk1977b4b47412007-08-17 15:53:36 +00001637 sqlite3OsClose(pMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001638 }
danielk1977b4b47412007-08-17 15:53:36 +00001639 sqlite3_free(pMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001640 return rc;
1641}
1642
drha6abd042004-06-09 17:37:22 +00001643
danielk1977e180dd92007-04-05 17:15:52 +00001644static void pager_truncate_cache(Pager *pPager);
1645
drha6abd042004-06-09 17:37:22 +00001646/*
drhcb4c40b2004-08-18 19:09:43 +00001647** Truncate the main file of the given pager to the number of pages
danielk1977e180dd92007-04-05 17:15:52 +00001648** indicated. Also truncate the cached representation of the file.
drhcb4c40b2004-08-18 19:09:43 +00001649*/
1650static int pager_truncate(Pager *pPager, int nPage){
danielk1977e180dd92007-04-05 17:15:52 +00001651 int rc = SQLITE_OK;
danielk19777a2b1ee2007-08-21 14:27:01 +00001652 if( pPager->state>=PAGER_EXCLUSIVE && pPager->fd->pMethods ){
danielk1977e180dd92007-04-05 17:15:52 +00001653 rc = sqlite3OsTruncate(pPager->fd, pPager->pageSize*(i64)nPage);
1654 }
1655 if( rc==SQLITE_OK ){
1656 pPager->dbSize = nPage;
1657 pager_truncate_cache(pPager);
1658 }
1659 return rc;
drhcb4c40b2004-08-18 19:09:43 +00001660}
1661
1662/*
drhc80f0582007-05-01 16:59:48 +00001663** Set the sectorSize for the given pager.
1664**
1665** The sector size is the larger of the sector size reported
1666** by sqlite3OsSectorSize() and the pageSize.
1667*/
1668static void setSectorSize(Pager *pPager){
danielk19777a2b1ee2007-08-21 14:27:01 +00001669 assert(pPager->fd->pMethods||pPager->tempFile);
1670 if( !pPager->tempFile ){
1671 /* Sector size doesn't matter for temporary files. Also, the file
1672 ** may not have been opened yet, in whcih case the OsSectorSize()
1673 ** call will segfault.
1674 */
1675 pPager->sectorSize = sqlite3OsSectorSize(pPager->fd);
1676 }
drhc80f0582007-05-01 16:59:48 +00001677 if( pPager->sectorSize<pPager->pageSize ){
1678 pPager->sectorSize = pPager->pageSize;
1679 }
1680}
1681
1682/*
drhed7c8552001-04-11 14:29:21 +00001683** Playback the journal and thus restore the database file to
1684** the state it was in before we started making changes.
1685**
drh34e79ce2004-02-08 06:05:46 +00001686** The journal file format is as follows:
1687**
drhae2b40c2004-06-09 19:03:54 +00001688** (1) 8 byte prefix. A copy of aJournalMagic[].
1689** (2) 4 byte big-endian integer which is the number of valid page records
drh34e79ce2004-02-08 06:05:46 +00001690** in the journal. If this value is 0xffffffff, then compute the
drhae2b40c2004-06-09 19:03:54 +00001691** number of page records from the journal size.
1692** (3) 4 byte big-endian integer which is the initial value for the
1693** sanity checksum.
1694** (4) 4 byte integer which is the number of pages to truncate the
drh34e79ce2004-02-08 06:05:46 +00001695** database to during a rollback.
drhae2b40c2004-06-09 19:03:54 +00001696** (5) 4 byte integer which is the number of bytes in the master journal
1697** name. The value may be zero (indicate that there is no master
1698** journal.)
1699** (6) N bytes of the master journal name. The name will be nul-terminated
1700** and might be shorter than the value read from (5). If the first byte
1701** of the name is \000 then there is no master journal. The master
1702** journal name is stored in UTF-8.
1703** (7) Zero or more pages instances, each as follows:
drh34e79ce2004-02-08 06:05:46 +00001704** + 4 byte page number.
drhae2b40c2004-06-09 19:03:54 +00001705** + pPager->pageSize bytes of data.
1706** + 4 byte checksum
drh34e79ce2004-02-08 06:05:46 +00001707**
drhae2b40c2004-06-09 19:03:54 +00001708** When we speak of the journal header, we mean the first 6 items above.
1709** Each entry in the journal is an instance of the 7th item.
drh34e79ce2004-02-08 06:05:46 +00001710**
1711** Call the value from the second bullet "nRec". nRec is the number of
1712** valid page entries in the journal. In most cases, you can compute the
1713** value of nRec from the size of the journal file. But if a power
1714** failure occurred while the journal was being written, it could be the
1715** case that the size of the journal file had already been increased but
1716** the extra entries had not yet made it safely to disk. In such a case,
1717** the value of nRec computed from the file size would be too large. For
1718** that reason, we always use the nRec value in the header.
1719**
1720** If the nRec value is 0xffffffff it means that nRec should be computed
1721** from the file size. This value is used when the user selects the
1722** no-sync option for the journal. A power failure could lead to corruption
1723** in this case. But for things like temporary table (which will be
1724** deleted when the power is restored) we don't care.
1725**
drhd9b02572001-04-15 00:37:09 +00001726** If the file opened as the journal file is not a well-formed
danielk1977ece80f12004-06-23 01:05:26 +00001727** journal file then all pages up to the first corrupted page are rolled
1728** back (or no pages if the journal header is corrupted). The journal file
1729** is then deleted and SQLITE_OK returned, just as if no corruption had
1730** been encountered.
1731**
1732** If an I/O or malloc() error occurs, the journal-file is not deleted
1733** and an error code is returned.
drhed7c8552001-04-11 14:29:21 +00001734*/
danielk1977e277be02007-03-23 18:12:06 +00001735static int pager_playback(Pager *pPager, int isHot){
danielk1977b4b47412007-08-17 15:53:36 +00001736 sqlite3_vfs *pVfs = pPager->pVfs;
drheb206252004-10-01 02:00:31 +00001737 i64 szJ; /* Size of the journal file in bytes */
danielk1977c3e8f5e2004-06-28 01:16:46 +00001738 u32 nRec; /* Number of Records in the journal */
drhd9b02572001-04-15 00:37:09 +00001739 int i; /* Loop counter */
1740 Pgno mxPg = 0; /* Size of the original file in pages */
drhae2b40c2004-06-09 19:03:54 +00001741 int rc; /* Result code of a subroutine */
danielk197713adf8a2004-06-03 16:08:41 +00001742 char *zMaster = 0; /* Name of master journal file if any */
drhed7c8552001-04-11 14:29:21 +00001743
drhc3a64ba2001-11-22 00:01:27 +00001744 /* Figure out how many records are in the journal. Abort early if
1745 ** the journal is empty.
drhed7c8552001-04-11 14:29:21 +00001746 */
drh8cfbf082001-09-19 13:22:39 +00001747 assert( pPager->journalOpen );
drh054889e2005-11-30 03:20:31 +00001748 rc = sqlite3OsFileSize(pPager->jfd, &szJ);
danielk1977334cdb62007-03-26 08:05:12 +00001749 if( rc!=SQLITE_OK || szJ==0 ){
drhc3a64ba2001-11-22 00:01:27 +00001750 goto end_playback;
1751 }
drh240c5792004-02-08 00:40:52 +00001752
danielk197776572402004-06-25 02:38:54 +00001753 /* Read the master journal name from the journal, if it is present.
1754 ** If a master journal file name is specified, but the file is not
1755 ** present on disk, then the journal is not hot and does not need to be
1756 ** played back.
drh240c5792004-02-08 00:40:52 +00001757 */
danielk197765839c62007-08-30 08:08:17 +00001758 zMaster = pPager->pTmpSpace;
1759 rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1);
danielk197776572402004-06-25 02:38:54 +00001760 assert( rc!=SQLITE_DONE );
danielk1977b4b47412007-08-17 15:53:36 +00001761 if( rc!=SQLITE_OK
danielk197765839c62007-08-30 08:08:17 +00001762 || (zMaster[0] && !sqlite3OsAccess(pVfs, zMaster, SQLITE_ACCESS_EXISTS))
danielk1977b4b47412007-08-17 15:53:36 +00001763 ){
danielk197776572402004-06-25 02:38:54 +00001764 zMaster = 0;
1765 if( rc==SQLITE_DONE ) rc = SQLITE_OK;
drhc3a64ba2001-11-22 00:01:27 +00001766 goto end_playback;
1767 }
danielk197776572402004-06-25 02:38:54 +00001768 pPager->journalOff = 0;
danielk197765839c62007-08-30 08:08:17 +00001769 zMaster = 0;
drhc3a64ba2001-11-22 00:01:27 +00001770
danielk197776572402004-06-25 02:38:54 +00001771 /* This loop terminates either when the readJournalHdr() call returns
1772 ** SQLITE_DONE or an IO error occurs. */
1773 while( 1 ){
drhae2b40c2004-06-09 19:03:54 +00001774
danielk197776572402004-06-25 02:38:54 +00001775 /* Read the next journal header from the journal file. If there are
1776 ** not enough bytes left in the journal file for a complete header, or
1777 ** it is corrupted, then a process must of failed while writing it.
1778 ** This indicates nothing more needs to be rolled back.
1779 */
1780 rc = readJournalHdr(pPager, szJ, &nRec, &mxPg);
1781 if( rc!=SQLITE_OK ){
drh968af522003-02-11 14:55:40 +00001782 if( rc==SQLITE_DONE ){
drh968af522003-02-11 14:55:40 +00001783 rc = SQLITE_OK;
1784 }
danielk197776572402004-06-25 02:38:54 +00001785 goto end_playback;
1786 }
1787
1788 /* If nRec is 0xffffffff, then this journal was created by a process
1789 ** working in no-sync mode. This means that the rest of the journal
1790 ** file consists of pages, there are no more journal headers. Compute
1791 ** the value of nRec based on this assumption.
1792 */
1793 if( nRec==0xffffffff ){
1794 assert( pPager->journalOff==JOURNAL_HDR_SZ(pPager) );
1795 nRec = (szJ - JOURNAL_HDR_SZ(pPager))/JOURNAL_PG_SZ(pPager);
1796 }
1797
danielk1977e277be02007-03-23 18:12:06 +00001798 /* If nRec is 0 and this rollback is of a transaction created by this
drh8940f4e2007-08-11 00:26:20 +00001799 ** process and if this is the final header in the journal, then it means
1800 ** that this part of the journal was being filled but has not yet been
1801 ** synced to disk. Compute the number of pages based on the remaining
1802 ** size of the file.
1803 **
1804 ** The third term of the test was added to fix ticket #2565.
danielk1977e277be02007-03-23 18:12:06 +00001805 */
drh8940f4e2007-08-11 00:26:20 +00001806 if( nRec==0 && !isHot &&
1807 pPager->journalHdr+JOURNAL_HDR_SZ(pPager)==pPager->journalOff ){
danielk1977e277be02007-03-23 18:12:06 +00001808 nRec = (szJ - pPager->journalOff) / JOURNAL_PG_SZ(pPager);
1809 }
1810
danielk197776572402004-06-25 02:38:54 +00001811 /* If this is the first header read from the journal, truncate the
1812 ** database file back to it's original size.
1813 */
danielk1977e180dd92007-04-05 17:15:52 +00001814 if( pPager->journalOff==JOURNAL_HDR_SZ(pPager) ){
drhcb4c40b2004-08-18 19:09:43 +00001815 rc = pager_truncate(pPager, mxPg);
danielk197776572402004-06-25 02:38:54 +00001816 if( rc!=SQLITE_OK ){
1817 goto end_playback;
1818 }
danielk197776572402004-06-25 02:38:54 +00001819 }
1820
danielk197776572402004-06-25 02:38:54 +00001821 /* Copy original pages out of the journal and back into the database file.
1822 */
1823 for(i=0; i<nRec; i++){
danielk197762079062007-08-15 17:08:46 +00001824 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001825 if( rc!=SQLITE_OK ){
1826 if( rc==SQLITE_DONE ){
1827 rc = SQLITE_OK;
1828 pPager->journalOff = szJ;
1829 break;
1830 }else{
1831 goto end_playback;
1832 }
1833 }
drh968af522003-02-11 14:55:40 +00001834 }
drhed7c8552001-04-11 14:29:21 +00001835 }
drh580eeaf2006-02-24 03:09:37 +00001836 /*NOTREACHED*/
1837 assert( 0 );
drh4a0681e2003-02-13 01:58:20 +00001838
1839end_playback:
danielk19778191bff2004-06-28 04:52:30 +00001840 if( rc==SQLITE_OK ){
danielk197765839c62007-08-30 08:08:17 +00001841 zMaster = pPager->pTmpSpace;
1842 rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1);
1843 }
1844 if( rc==SQLITE_OK ){
drh80e35f42007-03-30 14:06:34 +00001845 rc = pager_end_transaction(pPager);
danielk19778191bff2004-06-28 04:52:30 +00001846 }
danielk197765839c62007-08-30 08:08:17 +00001847 if( rc==SQLITE_OK && zMaster[0] ){
danielk1977979f38e2007-03-27 16:19:51 +00001848 /* If there was a master journal and this routine will return success,
danielk197732554c12005-01-22 03:39:39 +00001849 ** see if it is possible to delete the master journal.
danielk197713adf8a2004-06-03 16:08:41 +00001850 */
danielk197765839c62007-08-30 08:08:17 +00001851 rc = pager_delmaster(pPager, zMaster);
danielk197713adf8a2004-06-03 16:08:41 +00001852 }
danielk197776572402004-06-25 02:38:54 +00001853
1854 /* The Pager.sectorSize variable may have been updated while rolling
drh3ceeb752007-03-29 18:19:52 +00001855 ** back a journal created by a process with a different sector size
danielk197776572402004-06-25 02:38:54 +00001856 ** value. Reset it to the correct value for this process.
1857 */
drhc80f0582007-05-01 16:59:48 +00001858 setSectorSize(pPager);
drhd9b02572001-04-15 00:37:09 +00001859 return rc;
drhed7c8552001-04-11 14:29:21 +00001860}
1861
1862/*
drhac69b052004-05-12 13:30:07 +00001863** Playback the statement journal.
drhfa86c412002-02-02 15:01:15 +00001864**
1865** This is similar to playing back the transaction journal but with
1866** a few extra twists.
1867**
drh663fc632002-02-02 18:49:19 +00001868** (1) The number of pages in the database file at the start of
drhac69b052004-05-12 13:30:07 +00001869** the statement is stored in pPager->stmtSize, not in the
drh663fc632002-02-02 18:49:19 +00001870** journal file itself.
drhfa86c412002-02-02 15:01:15 +00001871**
drhac69b052004-05-12 13:30:07 +00001872** (2) In addition to playing back the statement journal, also
drhfa86c412002-02-02 15:01:15 +00001873** playback all pages of the transaction journal beginning
drhac69b052004-05-12 13:30:07 +00001874** at offset pPager->stmtJSize.
drhfa86c412002-02-02 15:01:15 +00001875*/
drh3aac2dd2004-04-26 14:10:20 +00001876static int pager_stmt_playback(Pager *pPager){
drheb206252004-10-01 02:00:31 +00001877 i64 szJ; /* Size of the full journal */
1878 i64 hdrOff;
drh968af522003-02-11 14:55:40 +00001879 int nRec; /* Number of Records */
drhfa86c412002-02-02 15:01:15 +00001880 int i; /* Loop counter */
1881 int rc;
1882
danielk197776572402004-06-25 02:38:54 +00001883 szJ = pPager->journalOff;
1884#ifndef NDEBUG
1885 {
drheb206252004-10-01 02:00:31 +00001886 i64 os_szJ;
drh054889e2005-11-30 03:20:31 +00001887 rc = sqlite3OsFileSize(pPager->jfd, &os_szJ);
danielk197776572402004-06-25 02:38:54 +00001888 if( rc!=SQLITE_OK ) return rc;
1889 assert( szJ==os_szJ );
1890 }
1891#endif
1892
danielk19774099f6e2007-03-19 11:25:20 +00001893 /* Set hdrOff to be the offset just after the end of the last journal
1894 ** page written before the first journal-header for this statement
1895 ** transaction was written, or the end of the file if no journal
danielk197776572402004-06-25 02:38:54 +00001896 ** header was written.
1897 */
1898 hdrOff = pPager->stmtHdrOff;
1899 assert( pPager->fullSync || !hdrOff );
1900 if( !hdrOff ){
1901 hdrOff = szJ;
1902 }
1903
drhfa86c412002-02-02 15:01:15 +00001904 /* Truncate the database back to its original size.
1905 */
danielk1977e180dd92007-04-05 17:15:52 +00001906 rc = pager_truncate(pPager, pPager->stmtSize);
drh1aa2d8b2007-01-03 15:34:29 +00001907 assert( pPager->state>=PAGER_SHARED );
drhfa86c412002-02-02 15:01:15 +00001908
drhac69b052004-05-12 13:30:07 +00001909 /* Figure out how many records are in the statement journal.
drhfa86c412002-02-02 15:01:15 +00001910 */
drhac69b052004-05-12 13:30:07 +00001911 assert( pPager->stmtInUse && pPager->journalOpen );
drhac69b052004-05-12 13:30:07 +00001912 nRec = pPager->stmtNRec;
drhfa86c412002-02-02 15:01:15 +00001913
drhac69b052004-05-12 13:30:07 +00001914 /* Copy original pages out of the statement journal and back into the
drhae2b40c2004-06-09 19:03:54 +00001915 ** database file. Note that the statement journal omits checksums from
1916 ** each record since power-failure recovery is not important to statement
1917 ** journals.
drhfa86c412002-02-02 15:01:15 +00001918 */
danielk197762079062007-08-15 17:08:46 +00001919 for(i=0; i<nRec; i++){
1920 i64 offset = i*(4+pPager->pageSize);
1921 rc = pager_playback_one_page(pPager, pPager->stfd, offset, 0);
drh968af522003-02-11 14:55:40 +00001922 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001923 if( rc!=SQLITE_OK ) goto end_stmt_playback;
drhfa86c412002-02-02 15:01:15 +00001924 }
1925
danielk197776572402004-06-25 02:38:54 +00001926 /* Now roll some pages back from the transaction journal. Pager.stmtJSize
1927 ** was the size of the journal file when this statement was started, so
1928 ** everything after that needs to be rolled back, either into the
1929 ** database, the memory cache, or both.
1930 **
1931 ** If it is not zero, then Pager.stmtHdrOff is the offset to the start
1932 ** of the first journal header written during this statement transaction.
drhfa86c412002-02-02 15:01:15 +00001933 */
danielk197776572402004-06-25 02:38:54 +00001934 pPager->journalOff = pPager->stmtJSize;
danielk197775edc162004-06-26 01:48:18 +00001935 pPager->cksumInit = pPager->stmtCksum;
danielk19774099f6e2007-03-19 11:25:20 +00001936 while( pPager->journalOff < hdrOff ){
danielk197762079062007-08-15 17:08:46 +00001937 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001938 assert( rc!=SQLITE_DONE );
1939 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1940 }
1941
1942 while( pPager->journalOff < szJ ){
danielk1977f0113002006-01-24 12:09:17 +00001943 u32 nJRec; /* Number of Journal Records */
danielk197776572402004-06-25 02:38:54 +00001944 u32 dummy;
danielk1977f0113002006-01-24 12:09:17 +00001945 rc = readJournalHdr(pPager, szJ, &nJRec, &dummy);
drh968af522003-02-11 14:55:40 +00001946 if( rc!=SQLITE_OK ){
1947 assert( rc!=SQLITE_DONE );
drh3aac2dd2004-04-26 14:10:20 +00001948 goto end_stmt_playback;
drh968af522003-02-11 14:55:40 +00001949 }
danielk1977f0113002006-01-24 12:09:17 +00001950 if( nJRec==0 ){
1951 nJRec = (szJ - pPager->journalOff) / (pPager->pageSize+8);
danielk197775edc162004-06-26 01:48:18 +00001952 }
danielk1977f0113002006-01-24 12:09:17 +00001953 for(i=nJRec-1; i>=0 && pPager->journalOff < szJ; i--){
danielk197762079062007-08-15 17:08:46 +00001954 rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1);
danielk197776572402004-06-25 02:38:54 +00001955 assert( rc!=SQLITE_DONE );
1956 if( rc!=SQLITE_OK ) goto end_stmt_playback;
1957 }
drhfa86c412002-02-02 15:01:15 +00001958 }
danielk197776572402004-06-25 02:38:54 +00001959
1960 pPager->journalOff = szJ;
drhfa86c412002-02-02 15:01:15 +00001961
drh3aac2dd2004-04-26 14:10:20 +00001962end_stmt_playback:
danielk19778a7aea32006-01-23 15:25:48 +00001963 if( rc==SQLITE_OK) {
danielk197775edc162004-06-26 01:48:18 +00001964 pPager->journalOff = szJ;
1965 /* pager_reload_cache(pPager); */
drhfa86c412002-02-02 15:01:15 +00001966 }
1967 return rc;
1968}
1969
1970/*
drhf57b14a2001-09-14 18:54:08 +00001971** Change the maximum number of in-memory pages that are allowed.
1972*/
danielk19773b8a05f2007-03-19 17:44:26 +00001973void sqlite3PagerSetCachesize(Pager *pPager, int mxPage){
drhf57b14a2001-09-14 18:54:08 +00001974 if( mxPage>10 ){
1975 pPager->mxPage = mxPage;
danielk1977ef317ab2004-06-23 10:43:10 +00001976 }else{
1977 pPager->mxPage = 10;
drhf57b14a2001-09-14 18:54:08 +00001978 }
1979}
1980
1981/*
drh973b6e32003-02-12 14:09:42 +00001982** Adjust the robustness of the database to damage due to OS crashes
1983** or power failures by changing the number of syncs()s when writing
1984** the rollback journal. There are three levels:
1985**
drh054889e2005-11-30 03:20:31 +00001986** OFF sqlite3OsSync() is never called. This is the default
drh973b6e32003-02-12 14:09:42 +00001987** for temporary and transient files.
1988**
1989** NORMAL The journal is synced once before writes begin on the
1990** database. This is normally adequate protection, but
1991** it is theoretically possible, though very unlikely,
1992** that an inopertune power failure could leave the journal
1993** in a state which would cause damage to the database
1994** when it is rolled back.
1995**
1996** FULL The journal is synced twice before writes begin on the
drh34e79ce2004-02-08 06:05:46 +00001997** database (with some additional information - the nRec field
1998** of the journal header - being written in between the two
1999** syncs). If we assume that writing a
drh973b6e32003-02-12 14:09:42 +00002000** single disk sector is atomic, then this mode provides
2001** assurance that the journal will not be corrupted to the
2002** point of causing damage to the database during rollback.
2003**
2004** Numeric values associated with these states are OFF==1, NORMAL=2,
2005** and FULL=3.
2006*/
danielk197793758c82005-01-21 08:13:14 +00002007#ifndef SQLITE_OMIT_PAGER_PRAGMAS
danielk19773b8a05f2007-03-19 17:44:26 +00002008void sqlite3PagerSetSafetyLevel(Pager *pPager, int level, int full_fsync){
drh973b6e32003-02-12 14:09:42 +00002009 pPager->noSync = level==1 || pPager->tempFile;
2010 pPager->fullSync = level==3 && !pPager->tempFile;
danielk1977f036aef2007-08-20 05:36:51 +00002011 pPager->sync_flags = (full_fsync?SQLITE_SYNC_FULL:SQLITE_SYNC_NORMAL);
danielk19771d850a72004-05-31 08:26:49 +00002012 if( pPager->noSync ) pPager->needSync = 0;
drh973b6e32003-02-12 14:09:42 +00002013}
danielk197793758c82005-01-21 08:13:14 +00002014#endif
drh973b6e32003-02-12 14:09:42 +00002015
2016/*
drhaf6df112005-06-07 02:12:30 +00002017** The following global variable is incremented whenever the library
2018** attempts to open a temporary file. This information is used for
2019** testing and analysis only.
2020*/
drh0f7eb612006-08-08 13:51:43 +00002021#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00002022int sqlite3_opentemp_count = 0;
drh0f7eb612006-08-08 13:51:43 +00002023#endif
drhaf6df112005-06-07 02:12:30 +00002024
2025/*
drh3f56e6e2007-03-15 01:16:47 +00002026** Open a temporary file.
2027**
2028** Write the file descriptor into *fd. Return SQLITE_OK on success or some
danielk1977fee2d252007-08-18 10:59:19 +00002029** other error code if we fail. The OS will automatically delete the temporary
2030** file when it is closed.
drhfa86c412002-02-02 15:01:15 +00002031*/
danielk1977b4b47412007-08-17 15:53:36 +00002032static int sqlite3PagerOpentemp(
drh33f4e022007-09-03 15:19:34 +00002033 sqlite3_vfs *pVfs, /* The virtual file system layer */
2034 sqlite3_file *pFile, /* Write the file descriptor here */
2035 char *zFilename, /* Name of the file. Might be NULL */
2036 int vfsFlags /* Flags passed through to the VFS */
danielk1977b4b47412007-08-17 15:53:36 +00002037){
drhfa86c412002-02-02 15:01:15 +00002038 int rc;
drh334b2992007-09-06 23:28:23 +00002039 assert( zFilename!=0 );
drh3f56e6e2007-03-15 01:16:47 +00002040
drh0f7eb612006-08-08 13:51:43 +00002041#ifdef SQLITE_TEST
drhaf6df112005-06-07 02:12:30 +00002042 sqlite3_opentemp_count++; /* Used for testing and analysis only */
drh0f7eb612006-08-08 13:51:43 +00002043#endif
danielk1977b4b47412007-08-17 15:53:36 +00002044
drh33f4e022007-09-03 15:19:34 +00002045 vfsFlags |= SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE |
2046 SQLITE_OPEN_EXCLUSIVE | SQLITE_OPEN_DELETEONCLOSE;
2047 rc = sqlite3OsOpen(pVfs, zFilename, pFile, vfsFlags, 0);
drhae28c012007-08-24 16:29:23 +00002048 assert( rc!=SQLITE_OK || pFile->pMethods );
drhfa86c412002-02-02 15:01:15 +00002049 return rc;
2050}
2051
2052/*
drhed7c8552001-04-11 14:29:21 +00002053** Create a new page cache and put a pointer to the page cache in *ppPager.
drh5e00f6c2001-09-13 13:46:56 +00002054** The file to be cached need not exist. The file is not locked until
danielk19773b8a05f2007-03-19 17:44:26 +00002055** the first call to sqlite3PagerGet() and is only held open until the
2056** last page is released using sqlite3PagerUnref().
drh382c0242001-10-06 16:33:02 +00002057**
drh6446c4d2001-12-15 14:22:18 +00002058** If zFilename is NULL then a randomly-named temporary file is created
drh1cc8c442007-08-24 16:08:29 +00002059** and used as the file to be cached. The file will be deleted
drh6446c4d2001-12-15 14:22:18 +00002060** automatically when it is closed.
drh90f5ecb2004-07-22 01:19:35 +00002061**
2062** If zFilename is ":memory:" then all information is held in cache.
2063** It is never written to disk. This can be used to implement an
2064** in-memory database.
drhed7c8552001-04-11 14:29:21 +00002065*/
danielk19773b8a05f2007-03-19 17:44:26 +00002066int sqlite3PagerOpen(
drh86f8c192007-08-22 00:39:19 +00002067 sqlite3_vfs *pVfs, /* The virtual file system to use */
drh7e3b0a02001-04-28 16:52:40 +00002068 Pager **ppPager, /* Return the Pager structure here */
2069 const char *zFilename, /* Name of the database file to open */
drhda47d772002-12-02 04:25:19 +00002070 int nExtra, /* Extra bytes append to each in-memory page */
drh33f4e022007-09-03 15:19:34 +00002071 int flags, /* flags controlling this file */
2072 int vfsFlags /* flags passed through to sqlite3_vfs.xOpen() */
drh7e3b0a02001-04-28 16:52:40 +00002073){
danielk1977b4b47412007-08-17 15:53:36 +00002074 u8 *pPtr;
danielk1977aef0bf62005-12-30 16:28:01 +00002075 Pager *pPager = 0;
danielk1977cfe9a692004-06-16 12:00:29 +00002076 int rc = SQLITE_OK;
2077 int i;
danielk19778def5ea2004-06-16 10:39:52 +00002078 int tempFile = 0;
drhac69b052004-05-12 13:30:07 +00002079 int memDb = 0;
drh5e00f6c2001-09-13 13:46:56 +00002080 int readOnly = 0;
drh7bec5052005-02-06 02:45:41 +00002081 int useJournal = (flags & PAGER_OMIT_JOURNAL)==0;
2082 int noReadlock = (flags & PAGER_NO_READLOCK)!=0;
danielk1977c7b60172007-08-22 11:22:03 +00002083 int journalFileSize = sqlite3JournalSize(pVfs);
drh1cc8c442007-08-24 16:08:29 +00002084 int nDefaultPage = SQLITE_DEFAULT_PAGE_SIZE;
2085 char *zPathname;
2086 int nPathname;
danielk1977b4b47412007-08-17 15:53:36 +00002087
drh86f8c192007-08-22 00:39:19 +00002088 /* The default return is a NULL pointer */
drhd9b02572001-04-15 00:37:09 +00002089 *ppPager = 0;
danielk1977aef0bf62005-12-30 16:28:01 +00002090
drh1cc8c442007-08-24 16:08:29 +00002091 /* Compute the full pathname */
danielk1977adfb9b02007-09-17 07:02:56 +00002092 nPathname = pVfs->mxPathname+1;
2093 zPathname = sqlite3_malloc(nPathname);
drh1cc8c442007-08-24 16:08:29 +00002094 if( zPathname==0 ){
2095 return SQLITE_NOMEM;
2096 }
2097 if( zFilename && zFilename[0] ){
2098#ifndef SQLITE_OMIT_MEMORYDB
2099 if( strcmp(zFilename,":memory:")==0 ){
2100 memDb = 1;
2101 zPathname[0] = 0;
2102 }else
2103#endif
2104 {
danielk1977adfb9b02007-09-17 07:02:56 +00002105 rc = sqlite3OsFullPathname(pVfs, zFilename, nPathname, zPathname);
drh1cc8c442007-08-24 16:08:29 +00002106 }
2107 }else{
danielk1977adfb9b02007-09-17 07:02:56 +00002108 rc = sqlite3OsGetTempname(pVfs, nPathname, zPathname);
drhae28c012007-08-24 16:29:23 +00002109 }
2110 if( rc!=SQLITE_OK ){
2111 sqlite3_free(zPathname);
2112 return rc;
drh1cc8c442007-08-24 16:08:29 +00002113 }
2114 nPathname = strlen(zPathname);
2115
danielk1977b4b47412007-08-17 15:53:36 +00002116 /* Allocate memory for the pager structure */
2117 pPager = sqlite3MallocZero(
2118 sizeof(*pPager) + /* Pager structure */
danielk1977c7b60172007-08-22 11:22:03 +00002119 journalFileSize + /* The journal file structure */
2120 pVfs->szOsFile * 2 + /* The db and stmt journal files */
drh334b2992007-09-06 23:28:23 +00002121 4*nPathname + 40 /* zFilename, zDirectory, zJournal, zStmtJrnl */
danielk1977b4b47412007-08-17 15:53:36 +00002122 );
2123 if( !pPager ){
drh1cc8c442007-08-24 16:08:29 +00002124 sqlite3_free(zPathname);
danielk1977b4b47412007-08-17 15:53:36 +00002125 return SQLITE_NOMEM;
2126 }
2127 pPtr = (u8 *)&pPager[1];
drh33f4e022007-09-03 15:19:34 +00002128 pPager->vfsFlags = vfsFlags;
danielk1977b4b47412007-08-17 15:53:36 +00002129 pPager->fd = (sqlite3_file*)&pPtr[pVfs->szOsFile*0];
danielk1977c7b60172007-08-22 11:22:03 +00002130 pPager->stfd = (sqlite3_file*)&pPtr[pVfs->szOsFile*1];
2131 pPager->jfd = (sqlite3_file*)&pPtr[pVfs->szOsFile*2];
2132 pPager->zFilename = (char*)&pPtr[pVfs->szOsFile*2+journalFileSize];
drh1cc8c442007-08-24 16:08:29 +00002133 pPager->zDirectory = &pPager->zFilename[nPathname+1];
2134 pPager->zJournal = &pPager->zDirectory[nPathname+1];
drh334b2992007-09-06 23:28:23 +00002135 pPager->zStmtJrnl = &pPager->zJournal[nPathname+10];
danielk1977b4b47412007-08-17 15:53:36 +00002136 pPager->pVfs = pVfs;
drh1cc8c442007-08-24 16:08:29 +00002137 memcpy(pPager->zFilename, zPathname, nPathname+1);
2138 sqlite3_free(zPathname);
danielk1977b4b47412007-08-17 15:53:36 +00002139
drh153c62c2007-08-24 03:51:33 +00002140 /* Open the pager file.
danielk1977aef0bf62005-12-30 16:28:01 +00002141 */
drhae28c012007-08-24 16:29:23 +00002142 if( zFilename && zFilename[0] && !memDb ){
drh1cc8c442007-08-24 16:08:29 +00002143 if( nPathname>(pVfs->mxPathname - sizeof("-journal")) ){
2144 rc = SQLITE_CANTOPEN;
2145 }else{
drh1cc8c442007-08-24 16:08:29 +00002146 int fout = 0;
drh33f4e022007-09-03 15:19:34 +00002147 rc = sqlite3OsOpen(pVfs, pPager->zFilename, pPager->fd,
2148 pPager->vfsFlags, &fout);
drh1cc8c442007-08-24 16:08:29 +00002149 readOnly = (fout&SQLITE_OPEN_READONLY);
2150
2151 /* If the file was successfully opened for read/write access,
2152 ** choose a default page size in case we have to create the
2153 ** database file. The default page size is the maximum of:
2154 **
2155 ** + SQLITE_DEFAULT_PAGE_SIZE,
2156 ** + The value returned by sqlite3OsSectorSize()
2157 ** + The largest page size that can be written atomically.
2158 */
2159 if( rc==SQLITE_OK && !readOnly ){
2160 int iSectorSize = sqlite3OsSectorSize(pPager->fd);
2161 if( nDefaultPage<iSectorSize ){
2162 nDefaultPage = iSectorSize;
2163 }
danielk19779663b8f2007-08-24 11:52:28 +00002164#ifdef SQLITE_ENABLE_ATOMIC_WRITE
drh1cc8c442007-08-24 16:08:29 +00002165 {
2166 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
2167 int ii;
2168 assert(SQLITE_IOCAP_ATOMIC512==(512>>8));
2169 assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8));
2170 assert(SQLITE_MAX_DEFAULT_PAGE_SIZE<=65536);
2171 for(ii=nDefaultPage; ii<=SQLITE_MAX_DEFAULT_PAGE_SIZE; ii=ii*2){
2172 if( iDc&(SQLITE_IOCAP_ATOMIC|(ii>>8)) ) nDefaultPage = ii;
danielk19779663b8f2007-08-24 11:52:28 +00002173 }
danielk1977b4b47412007-08-17 15:53:36 +00002174 }
drh1cc8c442007-08-24 16:08:29 +00002175#endif
2176 if( nDefaultPage>SQLITE_MAX_DEFAULT_PAGE_SIZE ){
2177 nDefaultPage = SQLITE_MAX_DEFAULT_PAGE_SIZE;
2178 }
danielk19778def5ea2004-06-16 10:39:52 +00002179 }
drhac69b052004-05-12 13:30:07 +00002180 }
drh1cc8c442007-08-24 16:08:29 +00002181 }else if( !memDb ){
danielk19777a2b1ee2007-08-21 14:27:01 +00002182 /* If a temporary file is requested, it is not opened immediately.
2183 ** In this case we accept the default page size and delay actually
2184 ** opening the file until the first call to OsWrite().
2185 */
danielk19777a2b1ee2007-08-21 14:27:01 +00002186 tempFile = 1;
2187 pPager->state = PAGER_EXCLUSIVE;
drh5e00f6c2001-09-13 13:46:56 +00002188 }
danielk1977aef0bf62005-12-30 16:28:01 +00002189
danielk1977b4b47412007-08-17 15:53:36 +00002190 if( pPager && rc==SQLITE_OK ){
danielk19779663b8f2007-08-24 11:52:28 +00002191 pPager->pTmpSpace = (char *)sqlite3_malloc(nDefaultPage);
drh3e7a6092002-12-07 21:45:14 +00002192 }
danielk1977aef0bf62005-12-30 16:28:01 +00002193
drh153c62c2007-08-24 03:51:33 +00002194 /* If an error occured in either of the blocks above.
2195 ** Free the Pager structure and close the file.
2196 ** Since the pager is not allocated there is no need to set
danielk1977aef0bf62005-12-30 16:28:01 +00002197 ** any Pager.errMask variables.
2198 */
danielk1977b4b47412007-08-17 15:53:36 +00002199 if( !pPager || !pPager->pTmpSpace ){
2200 sqlite3OsClose(pPager->fd);
drh17435752007-08-16 04:30:38 +00002201 sqlite3_free(pPager);
danielk1977aef0bf62005-12-30 16:28:01 +00002202 return ((rc==SQLITE_OK)?SQLITE_NOMEM:rc);
drhed7c8552001-04-11 14:29:21 +00002203 }
danielk1977aef0bf62005-12-30 16:28:01 +00002204
drh153c62c2007-08-24 03:51:33 +00002205 PAGERTRACE3("OPEN %d %s\n", FILEHANDLEID(pPager->fd), pPager->zFilename);
2206 IOTRACE(("OPEN %p %s\n", pPager, pPager->zFilename))
danielk1977aef0bf62005-12-30 16:28:01 +00002207
danielk1977b4b47412007-08-17 15:53:36 +00002208 /* Fill in Pager.zDirectory[] */
drh1cc8c442007-08-24 16:08:29 +00002209 memcpy(pPager->zDirectory, pPager->zFilename, nPathname+1);
danielk1977b4b47412007-08-17 15:53:36 +00002210 for(i=strlen(pPager->zDirectory); i>0 && pPager->zDirectory[i-1]!='/'; i--){}
drha76c82e2003-07-27 18:59:42 +00002211 if( i>0 ) pPager->zDirectory[i-1] = 0;
danielk1977b4b47412007-08-17 15:53:36 +00002212
drh334b2992007-09-06 23:28:23 +00002213 /* Fill in Pager.zJournal[] and Pager.zStmtJrnl[] */
drh1cc8c442007-08-24 16:08:29 +00002214 memcpy(pPager->zJournal, pPager->zFilename, nPathname);
2215 memcpy(&pPager->zJournal[nPathname], "-journal", 9);
drh334b2992007-09-06 23:28:23 +00002216 memcpy(pPager->zStmtJrnl, pPager->zFilename, nPathname);
2217 memcpy(&pPager->zStmtJrnl[nPathname], "-stmtjrnl", 10);
danielk1977b4b47412007-08-17 15:53:36 +00002218
drh3b59a5c2006-01-15 20:28:28 +00002219 /* pPager->journalOpen = 0; */
drhac69b052004-05-12 13:30:07 +00002220 pPager->useJournal = useJournal && !memDb;
drh7bec5052005-02-06 02:45:41 +00002221 pPager->noReadlock = noReadlock && readOnly;
drh3b59a5c2006-01-15 20:28:28 +00002222 /* pPager->stmtOpen = 0; */
2223 /* pPager->stmtInUse = 0; */
2224 /* pPager->nRef = 0; */
drhac69b052004-05-12 13:30:07 +00002225 pPager->dbSize = memDb-1;
danielk19779663b8f2007-08-24 11:52:28 +00002226 pPager->pageSize = nDefaultPage;
drh3b59a5c2006-01-15 20:28:28 +00002227 /* pPager->stmtSize = 0; */
2228 /* pPager->stmtJSize = 0; */
2229 /* pPager->nPage = 0; */
drh90f5ecb2004-07-22 01:19:35 +00002230 pPager->mxPage = 100;
drhf8e632b2007-05-08 14:51:36 +00002231 pPager->mxPgno = SQLITE_MAX_PAGE_COUNT;
drh3b59a5c2006-01-15 20:28:28 +00002232 /* pPager->state = PAGER_UNLOCK; */
drh1cc8c442007-08-24 16:08:29 +00002233 assert( pPager->state == (tempFile ? PAGER_EXCLUSIVE : PAGER_UNLOCK) );
drh3b59a5c2006-01-15 20:28:28 +00002234 /* pPager->errMask = 0; */
drh5e00f6c2001-09-13 13:46:56 +00002235 pPager->tempFile = tempFile;
drh369339d2007-03-30 16:01:55 +00002236 assert( tempFile==PAGER_LOCKINGMODE_NORMAL
2237 || tempFile==PAGER_LOCKINGMODE_EXCLUSIVE );
2238 assert( PAGER_LOCKINGMODE_EXCLUSIVE==1 );
2239 pPager->exclusiveMode = tempFile;
drhac69b052004-05-12 13:30:07 +00002240 pPager->memDb = memDb;
drh5e00f6c2001-09-13 13:46:56 +00002241 pPager->readOnly = readOnly;
drh3b59a5c2006-01-15 20:28:28 +00002242 /* pPager->needSync = 0; */
drhda47d772002-12-02 04:25:19 +00002243 pPager->noSync = pPager->tempFile || !useJournal;
danielk197775edc162004-06-26 01:48:18 +00002244 pPager->fullSync = (pPager->noSync?0:1);
danielk1977f036aef2007-08-20 05:36:51 +00002245 pPager->sync_flags = SQLITE_SYNC_NORMAL;
drh3b59a5c2006-01-15 20:28:28 +00002246 /* pPager->pFirst = 0; */
2247 /* pPager->pFirstSynced = 0; */
2248 /* pPager->pLast = 0; */
drh887dc4c2004-10-22 16:22:57 +00002249 pPager->nExtra = FORCE_ALIGNMENT(nExtra);
danielk19777a2b1ee2007-08-21 14:27:01 +00002250 assert(pPager->fd->pMethods||memDb||tempFile);
danielk1977b4721172007-03-19 05:54:48 +00002251 if( !memDb ){
drhc80f0582007-05-01 16:59:48 +00002252 setSectorSize(pPager);
danielk1977b4721172007-03-19 05:54:48 +00002253 }
drh3b59a5c2006-01-15 20:28:28 +00002254 /* pPager->pBusyHandler = 0; */
2255 /* memset(pPager->aHash, 0, sizeof(pPager->aHash)); */
drhed7c8552001-04-11 14:29:21 +00002256 *ppPager = pPager;
drh6f7adc82006-01-11 21:41:20 +00002257#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
drh86f8c192007-08-22 00:39:19 +00002258 pPager->iInUseMM = 0;
2259 pPager->iInUseDB = 0;
2260 if( !memDb ){
2261 sqlite3_mutex *mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MEM2);
2262 sqlite3_mutex_enter(mutex);
2263 pPager->pNext = sqlite3PagerList;
2264 if( sqlite3PagerList ){
2265 assert( sqlite3PagerList->pPrev==0 );
2266 sqlite3PagerList->pPrev = pPager;
2267 }
2268 pPager->pPrev = 0;
2269 sqlite3PagerList = pPager;
2270 sqlite3_mutex_leave(mutex);
2271 }
danielk197752622822006-01-09 09:59:49 +00002272#endif
drhed7c8552001-04-11 14:29:21 +00002273 return SQLITE_OK;
2274}
2275
2276/*
drh90f5ecb2004-07-22 01:19:35 +00002277** Set the busy handler function.
2278*/
danielk19773b8a05f2007-03-19 17:44:26 +00002279void sqlite3PagerSetBusyhandler(Pager *pPager, BusyHandler *pBusyHandler){
drh90f5ecb2004-07-22 01:19:35 +00002280 pPager->pBusyHandler = pBusyHandler;
2281}
2282
2283/*
drh72f82862001-05-24 21:06:34 +00002284** Set the destructor for this pager. If not NULL, the destructor is called
drh5e00f6c2001-09-13 13:46:56 +00002285** when the reference count on each page reaches zero. The destructor can
2286** be used to clean up information in the extra segment appended to each page.
drh72f82862001-05-24 21:06:34 +00002287**
danielk19773b8a05f2007-03-19 17:44:26 +00002288** The destructor is not called as a result sqlite3PagerClose().
2289** Destructors are only called by sqlite3PagerUnref().
drh72f82862001-05-24 21:06:34 +00002290*/
danielk19773b8a05f2007-03-19 17:44:26 +00002291void sqlite3PagerSetDestructor(Pager *pPager, void (*xDesc)(DbPage*,int)){
drh72f82862001-05-24 21:06:34 +00002292 pPager->xDestructor = xDesc;
2293}
2294
2295/*
drha6abd042004-06-09 17:37:22 +00002296** Set the reinitializer for this pager. If not NULL, the reinitializer
2297** is called when the content of a page in cache is restored to its original
2298** value as a result of a rollback. The callback gives higher-level code
2299** an opportunity to restore the EXTRA section to agree with the restored
2300** page data.
2301*/
danielk19773b8a05f2007-03-19 17:44:26 +00002302void sqlite3PagerSetReiniter(Pager *pPager, void (*xReinit)(DbPage*,int)){
drha6abd042004-06-09 17:37:22 +00002303 pPager->xReiniter = xReinit;
2304}
2305
2306/*
danielk1977a1644fd2007-08-29 12:31:25 +00002307** Set the page size to *pPageSize. If the suggest new page size is
2308** inappropriate, then an alternative page size is set to that
2309** value before returning.
drh90f5ecb2004-07-22 01:19:35 +00002310*/
danielk1977a1644fd2007-08-29 12:31:25 +00002311int sqlite3PagerSetPagesize(Pager *pPager, u16 *pPageSize){
2312 int rc = SQLITE_OK;
2313 u16 pageSize = *pPageSize;
danielk19779663b8f2007-08-24 11:52:28 +00002314 assert( pageSize==0 || (pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE) );
danielk1977a1644fd2007-08-29 12:31:25 +00002315 if( pageSize && pageSize!=pPager->pageSize
2316 && !pPager->memDb && pPager->nRef==0
2317 ){
2318 char *pNew = (char *)sqlite3_malloc(pageSize);
2319 if( !pNew ){
2320 rc = SQLITE_NOMEM;
2321 }else{
2322 pagerEnter(pPager);
2323 pager_reset(pPager);
2324 pPager->pageSize = pageSize;
2325 setSectorSize(pPager);
2326 sqlite3_free(pPager->pTmpSpace);
2327 pPager->pTmpSpace = pNew;
2328 pagerLeave(pPager);
2329 }
drh1c7880e2005-05-20 20:01:55 +00002330 }
danielk1977a1644fd2007-08-29 12:31:25 +00002331 *pPageSize = pPager->pageSize;
2332 return rc;
drh90f5ecb2004-07-22 01:19:35 +00002333}
2334
2335/*
drh26b79942007-11-28 16:19:56 +00002336** Return a pointer to the "temporary page" buffer held internally
2337** by the pager. This is a buffer that is big enough to hold the
2338** entire content of a database page. This buffer is used internally
2339** during rollback and will be overwritten whenever a rollback
2340** occurs. But other modules are free to use it too, as long as
2341** no rollbacks are happening.
2342*/
2343void *sqlite3PagerTempSpace(Pager *pPager){
2344 return pPager->pTmpSpace;
2345}
2346
2347/*
drhf8e632b2007-05-08 14:51:36 +00002348** Attempt to set the maximum database page count if mxPage is positive.
2349** Make no changes if mxPage is zero or negative. And never reduce the
2350** maximum page count below the current size of the database.
2351**
2352** Regardless of mxPage, return the current maximum page count.
2353*/
2354int sqlite3PagerMaxPageCount(Pager *pPager, int mxPage){
2355 if( mxPage>0 ){
2356 pPager->mxPgno = mxPage;
2357 }
2358 sqlite3PagerPagecount(pPager);
2359 return pPager->mxPgno;
2360}
2361
2362/*
drhc9ac5ca2005-11-04 22:03:30 +00002363** The following set of routines are used to disable the simulated
2364** I/O error mechanism. These routines are used to avoid simulated
2365** errors in places where we do not care about errors.
2366**
2367** Unless -DSQLITE_TEST=1 is used, these routines are all no-ops
2368** and generate no code.
2369*/
2370#ifdef SQLITE_TEST
2371extern int sqlite3_io_error_pending;
2372extern int sqlite3_io_error_hit;
2373static int saved_cnt;
drhc9ac5ca2005-11-04 22:03:30 +00002374void disable_simulated_io_errors(void){
2375 saved_cnt = sqlite3_io_error_pending;
2376 sqlite3_io_error_pending = -1;
2377}
2378void enable_simulated_io_errors(void){
2379 sqlite3_io_error_pending = saved_cnt;
2380}
2381#else
drh152410f2005-11-05 15:11:22 +00002382# define disable_simulated_io_errors()
2383# define enable_simulated_io_errors()
drhc9ac5ca2005-11-04 22:03:30 +00002384#endif
2385
2386/*
drh90f5ecb2004-07-22 01:19:35 +00002387** Read the first N bytes from the beginning of the file into memory
danielk1977aef0bf62005-12-30 16:28:01 +00002388** that pDest points to.
2389**
2390** No error checking is done. The rational for this is that this function
2391** may be called even if the file does not exist or contain a header. In
2392** these cases sqlite3OsRead() will return an error, to which the correct
2393** response is to zero the memory at pDest and continue. A real IO error
2394** will presumably recur and be picked up later (Todo: Think about this).
drh90f5ecb2004-07-22 01:19:35 +00002395*/
danielk19773b8a05f2007-03-19 17:44:26 +00002396int sqlite3PagerReadFileheader(Pager *pPager, int N, unsigned char *pDest){
drh551b7732006-11-06 21:20:25 +00002397 int rc = SQLITE_OK;
drh90f5ecb2004-07-22 01:19:35 +00002398 memset(pDest, 0, N);
danielk19777a2b1ee2007-08-21 14:27:01 +00002399 assert(MEMDB||pPager->fd->pMethods||pPager->tempFile);
2400 if( pPager->fd->pMethods ){
drhb0603412007-02-28 04:47:26 +00002401 IOTRACE(("DBHDR %p 0 %d\n", pPager, N))
danielk197762079062007-08-15 17:08:46 +00002402 rc = sqlite3OsRead(pPager->fd, pDest, N, 0);
drh551b7732006-11-06 21:20:25 +00002403 if( rc==SQLITE_IOERR_SHORT_READ ){
2404 rc = SQLITE_OK;
2405 }
drh90f5ecb2004-07-22 01:19:35 +00002406 }
drh551b7732006-11-06 21:20:25 +00002407 return rc;
drh90f5ecb2004-07-22 01:19:35 +00002408}
2409
2410/*
drh5e00f6c2001-09-13 13:46:56 +00002411** Return the total number of pages in the disk file associated with
danielk197715f411d2005-09-16 10:18:45 +00002412** pPager.
2413**
2414** If the PENDING_BYTE lies on the page directly after the end of the
2415** file, then consider this page part of the file too. For example, if
2416** PENDING_BYTE is byte 4096 (the first byte of page 5) and the size of the
2417** file is 4096 bytes, 5 is returned instead of 4.
drhed7c8552001-04-11 14:29:21 +00002418*/
danielk19773b8a05f2007-03-19 17:44:26 +00002419int sqlite3PagerPagecount(Pager *pPager){
danielk19777a2b1ee2007-08-21 14:27:01 +00002420 i64 n = 0;
drhe49f9822006-09-15 12:29:16 +00002421 int rc;
drhd9b02572001-04-15 00:37:09 +00002422 assert( pPager!=0 );
drha7aea3d2007-03-15 12:51:16 +00002423 if( pPager->errCode ){
2424 return 0;
2425 }
drhed7c8552001-04-11 14:29:21 +00002426 if( pPager->dbSize>=0 ){
danielk197715f411d2005-09-16 10:18:45 +00002427 n = pPager->dbSize;
2428 } else {
danielk19777a2b1ee2007-08-21 14:27:01 +00002429 assert(pPager->fd->pMethods||pPager->tempFile);
2430 if( (pPager->fd->pMethods)
2431 && (rc = sqlite3OsFileSize(pPager->fd, &n))!=SQLITE_OK ){
danielk1977ae72d982007-10-03 08:46:44 +00002432 pPager->nRef++;
drhe49f9822006-09-15 12:29:16 +00002433 pager_error(pPager, rc);
danielk1977ae72d982007-10-03 08:46:44 +00002434 pPager->nRef--;
danielk197715f411d2005-09-16 10:18:45 +00002435 return 0;
2436 }
2437 if( n>0 && n<pPager->pageSize ){
2438 n = 1;
2439 }else{
2440 n /= pPager->pageSize;
2441 }
2442 if( pPager->state!=PAGER_UNLOCK ){
2443 pPager->dbSize = n;
2444 }
drhed7c8552001-04-11 14:29:21 +00002445 }
danielk197715f411d2005-09-16 10:18:45 +00002446 if( n==(PENDING_BYTE/pPager->pageSize) ){
drh1f595712004-06-15 01:40:29 +00002447 n++;
2448 }
drhf8e632b2007-05-08 14:51:36 +00002449 if( n>pPager->mxPgno ){
2450 pPager->mxPgno = n;
2451 }
drhed7c8552001-04-11 14:29:21 +00002452 return n;
2453}
2454
drhf07e7d52006-04-07 13:54:46 +00002455
2456#ifndef SQLITE_OMIT_MEMORYDB
2457/*
2458** Clear a PgHistory block
2459*/
2460static void clearHistory(PgHistory *pHist){
drh17435752007-08-16 04:30:38 +00002461 sqlite3_free(pHist->pOrig);
2462 sqlite3_free(pHist->pStmt);
drhf07e7d52006-04-07 13:54:46 +00002463 pHist->pOrig = 0;
2464 pHist->pStmt = 0;
2465}
2466#else
2467#define clearHistory(x)
2468#endif
2469
drhed7c8552001-04-11 14:29:21 +00002470/*
drhf7c57532003-04-25 13:22:51 +00002471** Forward declaration
2472*/
danielk197776572402004-06-25 02:38:54 +00002473static int syncJournal(Pager*);
drhac69b052004-05-12 13:30:07 +00002474
2475/*
danielk1977f5fdda82004-11-03 08:44:05 +00002476** Unlink pPg from it's hash chain. Also set the page number to 0 to indicate
2477** that the page is not part of any hash chain. This is required because the
danielk19773b8a05f2007-03-19 17:44:26 +00002478** sqlite3PagerMovepage() routine can leave a page in the
danielk1977f5fdda82004-11-03 08:44:05 +00002479** pNextFree/pPrevFree list that is not a part of any hash-chain.
2480*/
2481static void unlinkHashChain(Pager *pPager, PgHdr *pPg){
2482 if( pPg->pgno==0 ){
drh3765df42006-06-28 18:18:09 +00002483 assert( pPg->pNextHash==0 && pPg->pPrevHash==0 );
danielk1977f5fdda82004-11-03 08:44:05 +00002484 return;
2485 }
2486 if( pPg->pNextHash ){
2487 pPg->pNextHash->pPrevHash = pPg->pPrevHash;
2488 }
2489 if( pPg->pPrevHash ){
drh8ca0c722006-05-07 17:49:38 +00002490 assert( pPager->aHash[pPg->pgno & (pPager->nHash-1)]!=pPg );
danielk1977f5fdda82004-11-03 08:44:05 +00002491 pPg->pPrevHash->pNextHash = pPg->pNextHash;
2492 }else{
drh8ca0c722006-05-07 17:49:38 +00002493 int h = pPg->pgno & (pPager->nHash-1);
danielk1977f5fdda82004-11-03 08:44:05 +00002494 pPager->aHash[h] = pPg->pNextHash;
2495 }
drh5229ae42006-03-23 23:29:04 +00002496 if( MEMDB ){
drh5229ae42006-03-23 23:29:04 +00002497 clearHistory(PGHDR_TO_HIST(pPg, pPager));
2498 }
danielk1977f5fdda82004-11-03 08:44:05 +00002499 pPg->pgno = 0;
2500 pPg->pNextHash = pPg->pPrevHash = 0;
2501}
2502
2503/*
drhac69b052004-05-12 13:30:07 +00002504** Unlink a page from the free list (the list of all pages where nRef==0)
2505** and from its hash collision chain.
2506*/
2507static void unlinkPage(PgHdr *pPg){
2508 Pager *pPager = pPg->pPager;
2509
danielk19779f61c2f2007-08-27 17:27:49 +00002510 /* Unlink from free page list */
2511 lruListRemove(pPg);
drhac69b052004-05-12 13:30:07 +00002512
2513 /* Unlink from the pgno hash table */
danielk1977f5fdda82004-11-03 08:44:05 +00002514 unlinkHashChain(pPager, pPg);
drhac69b052004-05-12 13:30:07 +00002515}
2516
2517/*
danielk1977e180dd92007-04-05 17:15:52 +00002518** This routine is used to truncate the cache when a database
2519** is truncated. Drop from the cache all pages whose pgno is
2520** larger than pPager->dbSize and is unreferenced.
2521**
drhac69b052004-05-12 13:30:07 +00002522** Referenced pages larger than pPager->dbSize are zeroed.
danielk1977e180dd92007-04-05 17:15:52 +00002523**
2524** Actually, at the point this routine is called, it would be
2525** an error to have a referenced page. But rather than delete
2526** that page and guarantee a subsequent segfault, it seems better
2527** to zero it and hope that we error out sanely.
drhac69b052004-05-12 13:30:07 +00002528*/
danielk1977e180dd92007-04-05 17:15:52 +00002529static void pager_truncate_cache(Pager *pPager){
drhac69b052004-05-12 13:30:07 +00002530 PgHdr *pPg;
2531 PgHdr **ppPg;
2532 int dbSize = pPager->dbSize;
2533
2534 ppPg = &pPager->pAll;
2535 while( (pPg = *ppPg)!=0 ){
2536 if( pPg->pgno<=dbSize ){
2537 ppPg = &pPg->pNextAll;
2538 }else if( pPg->nRef>0 ){
2539 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
2540 ppPg = &pPg->pNextAll;
2541 }else{
2542 *ppPg = pPg->pNextAll;
drh538f5702007-04-13 02:14:30 +00002543 IOTRACE(("PGFREE %p %d\n", pPager, pPg->pgno));
2544 PAGER_INCR(sqlite3_pager_pgfree_count);
drhac69b052004-05-12 13:30:07 +00002545 unlinkPage(pPg);
drh605ad8f2006-05-03 23:34:05 +00002546 makeClean(pPg);
drh17435752007-08-16 04:30:38 +00002547 sqlite3_free(pPg);
drhac69b052004-05-12 13:30:07 +00002548 pPager->nPage--;
2549 }
2550 }
2551}
2552
drhf7c57532003-04-25 13:22:51 +00002553/*
danielk197717221812005-02-15 03:38:05 +00002554** Try to obtain a lock on a file. Invoke the busy callback if the lock
drha4afb652005-07-09 02:16:02 +00002555** is currently not available. Repeat until the busy callback returns
danielk197717221812005-02-15 03:38:05 +00002556** false or until the lock succeeds.
2557**
2558** Return SQLITE_OK on success and an error code if we cannot obtain
2559** the lock.
2560*/
2561static int pager_wait_on_lock(Pager *pPager, int locktype){
2562 int rc;
drh1aa2d8b2007-01-03 15:34:29 +00002563
2564 /* The OS lock values must be the same as the Pager lock values */
danielk197717221812005-02-15 03:38:05 +00002565 assert( PAGER_SHARED==SHARED_LOCK );
2566 assert( PAGER_RESERVED==RESERVED_LOCK );
2567 assert( PAGER_EXCLUSIVE==EXCLUSIVE_LOCK );
drh1aa2d8b2007-01-03 15:34:29 +00002568
2569 /* If the file is currently unlocked then the size must be unknown */
2570 assert( pPager->state>=PAGER_SHARED || pPager->dbSize<0 || MEMDB );
2571
danielk197717221812005-02-15 03:38:05 +00002572 if( pPager->state>=locktype ){
2573 rc = SQLITE_OK;
2574 }else{
danielk197717221812005-02-15 03:38:05 +00002575 do {
drh054889e2005-11-30 03:20:31 +00002576 rc = sqlite3OsLock(pPager->fd, locktype);
drha4afb652005-07-09 02:16:02 +00002577 }while( rc==SQLITE_BUSY && sqlite3InvokeBusyHandler(pPager->pBusyHandler) );
danielk197717221812005-02-15 03:38:05 +00002578 if( rc==SQLITE_OK ){
2579 pPager->state = locktype;
drhb0603412007-02-28 04:47:26 +00002580 IOTRACE(("LOCK %p %d\n", pPager, locktype))
danielk197717221812005-02-15 03:38:05 +00002581 }
2582 }
2583 return rc;
2584}
2585
2586/*
drhf7c57532003-04-25 13:22:51 +00002587** Truncate the file to the number of pages specified.
2588*/
danielk19773b8a05f2007-03-19 17:44:26 +00002589int sqlite3PagerTruncate(Pager *pPager, Pgno nPage){
drhf7c57532003-04-25 13:22:51 +00002590 int rc;
drh1aa2d8b2007-01-03 15:34:29 +00002591 assert( pPager->state>=PAGER_SHARED || MEMDB );
danielk19773b8a05f2007-03-19 17:44:26 +00002592 sqlite3PagerPagecount(pPager);
danielk1977efaaf572006-01-16 11:29:19 +00002593 if( pPager->errCode ){
2594 rc = pPager->errCode;
drh2e6d11b2003-04-25 15:37:57 +00002595 return rc;
2596 }
drh7d02cb72003-06-04 16:24:39 +00002597 if( nPage>=(unsigned)pPager->dbSize ){
drhf7c57532003-04-25 13:22:51 +00002598 return SQLITE_OK;
2599 }
drhb7f91642004-10-31 02:22:47 +00002600 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00002601 pPager->dbSize = nPage;
danielk1977e180dd92007-04-05 17:15:52 +00002602 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00002603 return SQLITE_OK;
2604 }
drh86f8c192007-08-22 00:39:19 +00002605 pagerEnter(pPager);
danielk197776572402004-06-25 02:38:54 +00002606 rc = syncJournal(pPager);
drh86f8c192007-08-22 00:39:19 +00002607 pagerLeave(pPager);
danielk1977369f27e2004-06-15 11:40:04 +00002608 if( rc!=SQLITE_OK ){
2609 return rc;
2610 }
danielk197717221812005-02-15 03:38:05 +00002611
2612 /* Get an exclusive lock on the database before truncating. */
drh86f8c192007-08-22 00:39:19 +00002613 pagerEnter(pPager);
danielk197717221812005-02-15 03:38:05 +00002614 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
drh86f8c192007-08-22 00:39:19 +00002615 pagerLeave(pPager);
danielk197717221812005-02-15 03:38:05 +00002616 if( rc!=SQLITE_OK ){
2617 return rc;
2618 }
2619
drhcb4c40b2004-08-18 19:09:43 +00002620 rc = pager_truncate(pPager, nPage);
drhf7c57532003-04-25 13:22:51 +00002621 return rc;
2622}
2623
2624/*
drhed7c8552001-04-11 14:29:21 +00002625** Shutdown the page cache. Free all memory and close all files.
2626**
2627** If a transaction was in progress when this routine is called, that
2628** transaction is rolled back. All outstanding pages are invalidated
2629** and their memory is freed. Any attempt to use a page associated
2630** with this page cache after this function returns will likely
2631** result in a coredump.
danielk1977aef0bf62005-12-30 16:28:01 +00002632**
2633** This function always succeeds. If a transaction is active an attempt
2634** is made to roll it back. If an error occurs during the rollback
2635** a hot journal may be left in the filesystem but no error is returned
2636** to the caller.
drhed7c8552001-04-11 14:29:21 +00002637*/
danielk19773b8a05f2007-03-19 17:44:26 +00002638int sqlite3PagerClose(Pager *pPager){
drh6f7adc82006-01-11 21:41:20 +00002639#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
drh86f8c192007-08-22 00:39:19 +00002640 if( !MEMDB ){
2641 sqlite3_mutex *mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MEM2);
2642 sqlite3_mutex_enter(mutex);
2643 if( pPager->pPrev ){
2644 pPager->pPrev->pNext = pPager->pNext;
2645 }else{
2646 sqlite3PagerList = pPager->pNext;
2647 }
2648 if( pPager->pNext ){
2649 pPager->pNext->pPrev = pPager->pPrev;
2650 }
2651 sqlite3_mutex_leave(mutex);
2652 }
danielk197713f72992005-12-18 08:51:22 +00002653#endif
2654
drhbafda092007-01-03 23:36:22 +00002655 disable_simulated_io_errors();
drhc2ee76c2007-01-04 14:58:14 +00002656 pPager->errCode = 0;
danielk197741483462007-03-24 16:45:04 +00002657 pPager->exclusiveMode = 0;
drhbafda092007-01-03 23:36:22 +00002658 pager_reset(pPager);
danielk1977e277be02007-03-23 18:12:06 +00002659 pagerUnlockAndRollback(pPager);
drhbafda092007-01-03 23:36:22 +00002660 enable_simulated_io_errors();
drh4f0c5872007-03-26 22:05:01 +00002661 PAGERTRACE2("CLOSE %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002662 IOTRACE(("CLOSE %p\n", pPager))
danielk1977efaaf572006-01-16 11:29:19 +00002663 assert( pPager->errCode || (pPager->journalOpen==0 && pPager->stmtOpen==0) );
danielk1977e94ddc92005-03-21 03:53:38 +00002664 if( pPager->journalOpen ){
danielk1977b4b47412007-08-17 15:53:36 +00002665 sqlite3OsClose(pPager->jfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002666 }
drh17435752007-08-16 04:30:38 +00002667 sqlite3_free(pPager->aInJournal);
danielk1977e94ddc92005-03-21 03:53:38 +00002668 if( pPager->stmtOpen ){
danielk1977b4b47412007-08-17 15:53:36 +00002669 sqlite3OsClose(pPager->stfd);
danielk1977e94ddc92005-03-21 03:53:38 +00002670 }
danielk1977b4b47412007-08-17 15:53:36 +00002671 sqlite3OsClose(pPager->fd);
drh0f892532002-05-30 12:27:03 +00002672 /* Temp files are automatically deleted by the OS
2673 ** if( pPager->tempFile ){
drh66560ad2006-01-06 14:32:19 +00002674 ** sqlite3OsDelete(pPager->zFilename);
drh0f892532002-05-30 12:27:03 +00002675 ** }
2676 */
danielk1977aca790a2005-01-13 11:07:52 +00002677
drh17435752007-08-16 04:30:38 +00002678 sqlite3_free(pPager->aHash);
2679 sqlite3_free(pPager->pTmpSpace);
2680 sqlite3_free(pPager);
drhed7c8552001-04-11 14:29:21 +00002681 return SQLITE_OK;
2682}
2683
drh87cc3b32007-05-08 21:45:27 +00002684#if !defined(NDEBUG) || defined(SQLITE_TEST)
drhed7c8552001-04-11 14:29:21 +00002685/*
drh5e00f6c2001-09-13 13:46:56 +00002686** Return the page number for the given page data.
drhed7c8552001-04-11 14:29:21 +00002687*/
danielk19773b8a05f2007-03-19 17:44:26 +00002688Pgno sqlite3PagerPagenumber(DbPage *p){
drhed7c8552001-04-11 14:29:21 +00002689 return p->pgno;
2690}
drh87cc3b32007-05-08 21:45:27 +00002691#endif
drhed7c8552001-04-11 14:29:21 +00002692
2693/*
drhc8629a12004-05-08 20:07:40 +00002694** The page_ref() function increments the reference count for a page.
2695** If the page is currently on the freelist (the reference count is zero) then
drh7e3b0a02001-04-28 16:52:40 +00002696** remove it from the freelist.
drhc8629a12004-05-08 20:07:40 +00002697**
2698** For non-test systems, page_ref() is a macro that calls _page_ref()
2699** online of the reference count is zero. For test systems, page_ref()
2700** is a real function so that we can set breakpoints and trace it.
drh7e3b0a02001-04-28 16:52:40 +00002701*/
drh836faa42003-01-11 13:30:57 +00002702static void _page_ref(PgHdr *pPg){
drh7e3b0a02001-04-28 16:52:40 +00002703 if( pPg->nRef==0 ){
2704 /* The page is currently on the freelist. Remove it. */
danielk19779f61c2f2007-08-27 17:27:49 +00002705 lruListRemove(pPg);
drh7e3b0a02001-04-28 16:52:40 +00002706 pPg->pPager->nRef++;
2707 }
2708 pPg->nRef++;
drhdd793422001-06-28 01:54:48 +00002709 REFINFO(pPg);
drhdf0b3b02001-06-23 11:36:20 +00002710}
danielk1977aca790a2005-01-13 11:07:52 +00002711#ifdef SQLITE_DEBUG
drhc8629a12004-05-08 20:07:40 +00002712 static void page_ref(PgHdr *pPg){
2713 if( pPg->nRef==0 ){
2714 _page_ref(pPg);
2715 }else{
2716 pPg->nRef++;
2717 REFINFO(pPg);
2718 }
2719 }
2720#else
2721# define page_ref(P) ((P)->nRef==0?_page_ref(P):(void)(P)->nRef++)
2722#endif
drhdf0b3b02001-06-23 11:36:20 +00002723
2724/*
2725** Increment the reference count for a page. The input pointer is
2726** a reference to the page data.
2727*/
danielk19773b8a05f2007-03-19 17:44:26 +00002728int sqlite3PagerRef(DbPage *pPg){
drh86f8c192007-08-22 00:39:19 +00002729 pagerEnter(pPg->pPager);
drhdf0b3b02001-06-23 11:36:20 +00002730 page_ref(pPg);
drh86f8c192007-08-22 00:39:19 +00002731 pagerLeave(pPg->pPager);
drh8c42ca92001-06-22 19:15:00 +00002732 return SQLITE_OK;
drh7e3b0a02001-04-28 16:52:40 +00002733}
2734
2735/*
drh34e79ce2004-02-08 06:05:46 +00002736** Sync the journal. In other words, make sure all the pages that have
2737** been written to the journal have actually reached the surface of the
2738** disk. It is not safe to modify the original database file until after
2739** the journal has been synced. If the original database is modified before
2740** the journal is synced and a power failure occurs, the unsynced journal
2741** data would be lost and we would be unable to completely rollback the
2742** database changes. Database corruption would occur.
2743**
2744** This routine also updates the nRec field in the header of the journal.
2745** (See comments on the pager_playback() routine for additional information.)
2746** If the sync mode is FULL, two syncs will occur. First the whole journal
2747** is synced, then the nRec field is updated, then a second sync occurs.
drhb19a2bc2001-09-16 00:13:26 +00002748**
drh34e79ce2004-02-08 06:05:46 +00002749** For temporary databases, we do not care if we are able to rollback
danielk19774cd2cd52007-08-23 14:48:23 +00002750** after a power failure, so no sync occurs.
2751**
2752** If the IOCAP_SEQUENTIAL flag is set for the persistent media on which
2753** the database is stored, then OsSync() is never called on the journal
2754** file. In this case all that is required is to update the nRec field in
2755** the journal header.
drhfa86c412002-02-02 15:01:15 +00002756**
drh34e79ce2004-02-08 06:05:46 +00002757** This routine clears the needSync field of every page current held in
2758** memory.
drh50e5dad2001-09-15 00:57:28 +00002759*/
danielk197776572402004-06-25 02:38:54 +00002760static int syncJournal(Pager *pPager){
drh50e5dad2001-09-15 00:57:28 +00002761 PgHdr *pPg;
2762 int rc = SQLITE_OK;
drh03eb96a2002-11-10 23:32:56 +00002763
danielk19774cd2cd52007-08-23 14:48:23 +00002764
drh03eb96a2002-11-10 23:32:56 +00002765 /* Sync the journal before modifying the main database
2766 ** (assuming there is a journal and it needs to be synced.)
2767 */
danielk197776572402004-06-25 02:38:54 +00002768 if( pPager->needSync ){
drhfa86c412002-02-02 15:01:15 +00002769 if( !pPager->tempFile ){
danielk19774cd2cd52007-08-23 14:48:23 +00002770 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
drhdb48ee02003-01-16 13:42:43 +00002771 assert( pPager->journalOpen );
danielk19774cd2cd52007-08-23 14:48:23 +00002772
drh946966f2004-02-25 02:20:41 +00002773 /* assert( !pPager->noSync ); // noSync might be set if synchronous
2774 ** was turned off after the transaction was started. Ticket #615 */
drh968af522003-02-11 14:55:40 +00002775#ifndef NDEBUG
2776 {
drh34e79ce2004-02-08 06:05:46 +00002777 /* Make sure the pPager->nRec counter we are keeping agrees
2778 ** with the nRec computed from the size of the journal file.
2779 */
drheb206252004-10-01 02:00:31 +00002780 i64 jSz;
drh054889e2005-11-30 03:20:31 +00002781 rc = sqlite3OsFileSize(pPager->jfd, &jSz);
drh968af522003-02-11 14:55:40 +00002782 if( rc!=0 ) return rc;
danielk197776572402004-06-25 02:38:54 +00002783 assert( pPager->journalOff==jSz );
drh968af522003-02-11 14:55:40 +00002784 }
2785#endif
danielk19774cd2cd52007-08-23 14:48:23 +00002786 if( 0==(iDc&SQLITE_IOCAP_SAFE_APPEND) ){
danielk197776572402004-06-25 02:38:54 +00002787 /* Write the nRec value into the journal file header. If in
2788 ** full-synchronous mode, sync the journal first. This ensures that
2789 ** all data has really hit the disk before nRec is updated to mark
danielk19774cd2cd52007-08-23 14:48:23 +00002790 ** it as a candidate for rollback.
2791 **
2792 ** This is not required if the persistent media supports the
2793 ** SAFE_APPEND property. Because in this case it is not possible
2794 ** for garbage data to be appended to the file, the nRec field
2795 ** is populated with 0xFFFFFFFF when the journal header is written
2796 ** and never needs to be updated.
danielk197776572402004-06-25 02:38:54 +00002797 */
danielk19774cd2cd52007-08-23 14:48:23 +00002798 i64 jrnlOff;
2799 if( pPager->fullSync && 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
drh4f0c5872007-03-26 22:05:01 +00002800 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00002801 IOTRACE(("JSYNC %p\n", pPager))
danielk1977f036aef2007-08-20 05:36:51 +00002802 rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags);
drhd8d66e82003-02-12 02:10:15 +00002803 if( rc!=0 ) return rc;
2804 }
danielk197713adf8a2004-06-03 16:08:41 +00002805
danielk197762079062007-08-15 17:08:46 +00002806 jrnlOff = pPager->journalHdr + sizeof(aJournalMagic);
2807 IOTRACE(("JHDR %p %lld %d\n", pPager, jrnlOff, 4));
2808 rc = write32bits(pPager->jfd, jrnlOff, pPager->nRec);
drhb4746b92005-09-09 01:32:06 +00002809 if( rc ) return rc;
drh968af522003-02-11 14:55:40 +00002810 }
danielk19774cd2cd52007-08-23 14:48:23 +00002811 if( 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
2812 PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager));
2813 IOTRACE(("JSYNC %p\n", pPager))
2814 rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags|
2815 (pPager->sync_flags==SQLITE_SYNC_FULL?SQLITE_SYNC_DATAONLY:0)
2816 );
2817 if( rc!=0 ) return rc;
2818 }
drhdb48ee02003-01-16 13:42:43 +00002819 pPager->journalStarted = 1;
drhfa86c412002-02-02 15:01:15 +00002820 }
drh50e5dad2001-09-15 00:57:28 +00002821 pPager->needSync = 0;
drh341eae82003-01-21 02:39:36 +00002822
2823 /* Erase the needSync flag from every page.
2824 */
2825 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2826 pPg->needSync = 0;
2827 }
danielk19779f61c2f2007-08-27 17:27:49 +00002828 lruListSetFirstSynced(pPager);
drh50e5dad2001-09-15 00:57:28 +00002829 }
drh03eb96a2002-11-10 23:32:56 +00002830
drh341eae82003-01-21 02:39:36 +00002831#ifndef NDEBUG
2832 /* If the Pager.needSync flag is clear then the PgHdr.needSync
2833 ** flag must also be clear for all pages. Verify that this
2834 ** invariant is true.
drh03eb96a2002-11-10 23:32:56 +00002835 */
drh341eae82003-01-21 02:39:36 +00002836 else{
2837 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
2838 assert( pPg->needSync==0 );
2839 }
danielk19779f61c2f2007-08-27 17:27:49 +00002840 assert( pPager->lru.pFirstSynced==pPager->lru.pFirst );
drh03eb96a2002-11-10 23:32:56 +00002841 }
drh341eae82003-01-21 02:39:36 +00002842#endif
drhdb48ee02003-01-16 13:42:43 +00002843
drh81a20f22001-10-12 17:30:04 +00002844 return rc;
drh50e5dad2001-09-15 00:57:28 +00002845}
2846
2847/*
drhdc3e10b2006-06-15 14:31:06 +00002848** Merge two lists of pages connected by pDirty and in pgno order.
2849** Do not both fixing the pPrevDirty pointers.
2850*/
2851static PgHdr *merge_pagelist(PgHdr *pA, PgHdr *pB){
2852 PgHdr result, *pTail;
2853 pTail = &result;
2854 while( pA && pB ){
2855 if( pA->pgno<pB->pgno ){
2856 pTail->pDirty = pA;
2857 pTail = pA;
2858 pA = pA->pDirty;
2859 }else{
2860 pTail->pDirty = pB;
2861 pTail = pB;
2862 pB = pB->pDirty;
2863 }
2864 }
2865 if( pA ){
2866 pTail->pDirty = pA;
2867 }else if( pB ){
2868 pTail->pDirty = pB;
2869 }else{
2870 pTail->pDirty = 0;
2871 }
2872 return result.pDirty;
2873}
2874
2875/*
2876** Sort the list of pages in accending order by pgno. Pages are
2877** connected by pDirty pointers. The pPrevDirty pointers are
2878** corrupted by this sort.
2879*/
danielk197724168722007-04-02 05:07:47 +00002880#define N_SORT_BUCKET_ALLOC 25
2881#define N_SORT_BUCKET 25
2882#ifdef SQLITE_TEST
2883 int sqlite3_pager_n_sort_bucket = 0;
2884 #undef N_SORT_BUCKET
2885 #define N_SORT_BUCKET \
2886 (sqlite3_pager_n_sort_bucket?sqlite3_pager_n_sort_bucket:N_SORT_BUCKET_ALLOC)
2887#endif
drhdc3e10b2006-06-15 14:31:06 +00002888static PgHdr *sort_pagelist(PgHdr *pIn){
danielk197724168722007-04-02 05:07:47 +00002889 PgHdr *a[N_SORT_BUCKET_ALLOC], *p;
drhdc3e10b2006-06-15 14:31:06 +00002890 int i;
2891 memset(a, 0, sizeof(a));
2892 while( pIn ){
2893 p = pIn;
2894 pIn = p->pDirty;
2895 p->pDirty = 0;
2896 for(i=0; i<N_SORT_BUCKET-1; i++){
2897 if( a[i]==0 ){
2898 a[i] = p;
2899 break;
2900 }else{
2901 p = merge_pagelist(a[i], p);
2902 a[i] = 0;
2903 }
2904 }
2905 if( i==N_SORT_BUCKET-1 ){
danielk197724168722007-04-02 05:07:47 +00002906 /* Coverage: To get here, there need to be 2^(N_SORT_BUCKET)
2907 ** elements in the input list. This is possible, but impractical.
2908 ** Testing this line is the point of global variable
2909 ** sqlite3_pager_n_sort_bucket.
2910 */
drhdc3e10b2006-06-15 14:31:06 +00002911 a[i] = merge_pagelist(a[i], p);
2912 }
2913 }
2914 p = a[0];
2915 for(i=1; i<N_SORT_BUCKET; i++){
2916 p = merge_pagelist(p, a[i]);
2917 }
2918 return p;
2919}
2920
2921/*
drh2554f8b2003-01-22 01:26:44 +00002922** Given a list of pages (connected by the PgHdr.pDirty pointer) write
2923** every one of those pages out to the database file and mark them all
2924** as clean.
2925*/
2926static int pager_write_pagelist(PgHdr *pList){
2927 Pager *pPager;
drh153c62c2007-08-24 03:51:33 +00002928 PgHdr *p;
drh2554f8b2003-01-22 01:26:44 +00002929 int rc;
2930
2931 if( pList==0 ) return SQLITE_OK;
2932 pPager = pList->pPager;
danielk19779eed5052004-06-04 10:38:30 +00002933
2934 /* At this point there may be either a RESERVED or EXCLUSIVE lock on the
2935 ** database file. If there is already an EXCLUSIVE lock, the following
drh054889e2005-11-30 03:20:31 +00002936 ** calls to sqlite3OsLock() are no-ops.
danielk19779eed5052004-06-04 10:38:30 +00002937 **
drha6abd042004-06-09 17:37:22 +00002938 ** Moving the lock from RESERVED to EXCLUSIVE actually involves going
2939 ** through an intermediate state PENDING. A PENDING lock prevents new
2940 ** readers from attaching to the database but is unsufficient for us to
2941 ** write. The idea of a PENDING lock is to prevent new readers from
2942 ** coming in while we wait for existing readers to clear.
danielk19779eed5052004-06-04 10:38:30 +00002943 **
drha6abd042004-06-09 17:37:22 +00002944 ** While the pager is in the RESERVED state, the original database file
2945 ** is unchanged and we can rollback without having to playback the
2946 ** journal into the original database file. Once we transition to
2947 ** EXCLUSIVE, it means the database file has been changed and any rollback
2948 ** will require a journal playback.
danielk19779eed5052004-06-04 10:38:30 +00002949 */
drh684917c2004-10-05 02:41:42 +00002950 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
danielk19779eed5052004-06-04 10:38:30 +00002951 if( rc!=SQLITE_OK ){
2952 return rc;
2953 }
2954
drhdc3e10b2006-06-15 14:31:06 +00002955 pList = sort_pagelist(pList);
drh153c62c2007-08-24 03:51:33 +00002956 for(p=pList; p; p=p->pDirty){
2957 assert( p->dirty );
2958 p->dirty = 0;
2959 }
drh2554f8b2003-01-22 01:26:44 +00002960 while( pList ){
danielk19777a2b1ee2007-08-21 14:27:01 +00002961
2962 /* If the file has not yet been opened, open it now. */
2963 if( !pPager->fd->pMethods ){
2964 assert(pPager->tempFile);
drh33f4e022007-09-03 15:19:34 +00002965 rc = sqlite3PagerOpentemp(pPager->pVfs, pPager->fd, pPager->zFilename,
2966 pPager->vfsFlags);
danielk19777a2b1ee2007-08-21 14:27:01 +00002967 if( rc ) return rc;
2968 }
2969
danielk1977687566d2004-11-02 12:56:41 +00002970 /* If there are dirty pages in the page cache with page numbers greater
danielk19773b8a05f2007-03-19 17:44:26 +00002971 ** than Pager.dbSize, this means sqlite3PagerTruncate() was called to
danielk1977687566d2004-11-02 12:56:41 +00002972 ** make the file smaller (presumably by auto-vacuum code). Do not write
2973 ** any such pages to the file.
2974 */
2975 if( pList->pgno<=pPager->dbSize ){
danielk197762079062007-08-15 17:08:46 +00002976 i64 offset = (pList->pgno-1)*(i64)pPager->pageSize;
drhc001c582006-03-06 18:23:16 +00002977 char *pData = CODEC2(pPager, PGHDR_TO_DATA(pList), pList->pgno, 6);
drh477731b2007-06-16 03:06:27 +00002978 PAGERTRACE4("STORE %d page %d hash(%08x)\n",
2979 PAGERID(pPager), pList->pgno, pager_pagehash(pList));
drh538f5702007-04-13 02:14:30 +00002980 IOTRACE(("PGOUT %p %d\n", pPager, pList->pgno));
danielk197762079062007-08-15 17:08:46 +00002981 rc = sqlite3OsWrite(pPager->fd, pData, pPager->pageSize, offset);
drh538f5702007-04-13 02:14:30 +00002982 PAGER_INCR(sqlite3_pager_writedb_count);
2983 PAGER_INCR(pPager->nWrite);
drh86a88112007-04-16 15:02:19 +00002984 if( pList->pgno==1 ){
2985 memcpy(&pPager->dbFileVers, &pData[24], sizeof(pPager->dbFileVers));
2986 }
danielk1977687566d2004-11-02 12:56:41 +00002987 }
2988#ifndef NDEBUG
2989 else{
drh4f0c5872007-03-26 22:05:01 +00002990 PAGERTRACE3("NOSTORE %d page %d\n", PAGERID(pPager), pList->pgno);
danielk1977687566d2004-11-02 12:56:41 +00002991 }
2992#endif
drh2554f8b2003-01-22 01:26:44 +00002993 if( rc ) return rc;
danielk19773c407372005-02-15 02:54:14 +00002994#ifdef SQLITE_CHECK_PAGES
2995 pList->pageHash = pager_pagehash(pList);
2996#endif
drh2554f8b2003-01-22 01:26:44 +00002997 pList = pList->pDirty;
2998 }
2999 return SQLITE_OK;
3000}
3001
3002/*
3003** Collect every dirty page into a dirty list and
3004** return a pointer to the head of that list. All pages are
3005** collected even if they are still in use.
3006*/
3007static PgHdr *pager_get_all_dirty_pages(Pager *pPager){
drh605ad8f2006-05-03 23:34:05 +00003008 return pPager->pDirty;
drh2554f8b2003-01-22 01:26:44 +00003009}
3010
3011/*
drh165ffe92005-03-15 17:09:30 +00003012** Return TRUE if there is a hot journal on the given pager.
3013** A hot journal is one that needs to be played back.
3014**
3015** If the current size of the database file is 0 but a journal file
3016** exists, that is probably an old journal left over from a prior
3017** database with the same name. Just delete the journal.
3018*/
3019static int hasHotJournal(Pager *pPager){
danielk1977b4b47412007-08-17 15:53:36 +00003020 sqlite3_vfs *pVfs = pPager->pVfs;
drh165ffe92005-03-15 17:09:30 +00003021 if( !pPager->useJournal ) return 0;
drhd3cf2472007-11-27 16:55:07 +00003022 if( !pPager->fd->pMethods ) return 0;
danielk1977b4b47412007-08-17 15:53:36 +00003023 if( !sqlite3OsAccess(pVfs, pPager->zJournal, SQLITE_ACCESS_EXISTS) ){
drhbb5f18d2007-04-06 18:23:17 +00003024 return 0;
3025 }
3026 if( sqlite3OsCheckReservedLock(pPager->fd) ){
3027 return 0;
3028 }
danielk19773b8a05f2007-03-19 17:44:26 +00003029 if( sqlite3PagerPagecount(pPager)==0 ){
danielk1977fee2d252007-08-18 10:59:19 +00003030 sqlite3OsDelete(pVfs, pPager->zJournal, 0);
drh165ffe92005-03-15 17:09:30 +00003031 return 0;
3032 }else{
3033 return 1;
3034 }
3035}
3036
danielk19775591df52005-12-20 09:19:37 +00003037/*
danielk1977aef0bf62005-12-30 16:28:01 +00003038** Try to find a page in the cache that can be recycled.
3039**
3040** This routine may return SQLITE_IOERR, SQLITE_FULL or SQLITE_OK. It
danielk1977efaaf572006-01-16 11:29:19 +00003041** does not set the pPager->errCode variable.
danielk19775591df52005-12-20 09:19:37 +00003042*/
danielk1977843e65f2007-09-01 16:16:15 +00003043static int pager_recycle(Pager *pPager, PgHdr **ppPg){
danielk197713f72992005-12-18 08:51:22 +00003044 PgHdr *pPg;
3045 *ppPg = 0;
3046
danielk1977843e65f2007-09-01 16:16:15 +00003047 /* It is illegal to call this function unless the pager object
3048 ** pointed to by pPager has at least one free page (page with nRef==0).
3049 */
danielk1977c551edc2007-04-05 13:12:13 +00003050 assert(!MEMDB);
danielk1977843e65f2007-09-01 16:16:15 +00003051 assert(pPager->lru.pFirst);
danielk1977c551edc2007-04-05 13:12:13 +00003052
danielk197713f72992005-12-18 08:51:22 +00003053 /* Find a page to recycle. Try to locate a page that does not
3054 ** require us to do an fsync() on the journal.
3055 */
danielk19779f61c2f2007-08-27 17:27:49 +00003056 pPg = pPager->lru.pFirstSynced;
danielk197713f72992005-12-18 08:51:22 +00003057
3058 /* If we could not find a page that does not require an fsync()
3059 ** on the journal file then fsync the journal file. This is a
3060 ** very slow operation, so we work hard to avoid it. But sometimes
3061 ** it can't be helped.
3062 */
danielk1977843e65f2007-09-01 16:16:15 +00003063 if( pPg==0 && pPager->lru.pFirst){
danielk19774cd2cd52007-08-23 14:48:23 +00003064 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
danielk197713f72992005-12-18 08:51:22 +00003065 int rc = syncJournal(pPager);
3066 if( rc!=0 ){
danielk1977aef0bf62005-12-30 16:28:01 +00003067 return rc;
danielk197713f72992005-12-18 08:51:22 +00003068 }
danielk19774cd2cd52007-08-23 14:48:23 +00003069 if( pPager->fullSync && 0==(iDc&SQLITE_IOCAP_SAFE_APPEND) ){
danielk197713f72992005-12-18 08:51:22 +00003070 /* If in full-sync mode, write a new journal header into the
3071 ** journal file. This is done to avoid ever modifying a journal
3072 ** header that is involved in the rollback of pages that have
3073 ** already been written to the database (in case the header is
3074 ** trashed when the nRec field is updated).
3075 */
3076 pPager->nRec = 0;
3077 assert( pPager->journalOff > 0 );
danielk19774099f6e2007-03-19 11:25:20 +00003078 assert( pPager->doNotSync==0 );
danielk197713f72992005-12-18 08:51:22 +00003079 rc = writeJournalHdr(pPager);
3080 if( rc!=0 ){
danielk1977aef0bf62005-12-30 16:28:01 +00003081 return rc;
danielk197713f72992005-12-18 08:51:22 +00003082 }
3083 }
danielk19779f61c2f2007-08-27 17:27:49 +00003084 pPg = pPager->lru.pFirst;
danielk197713f72992005-12-18 08:51:22 +00003085 }
danielk197713f72992005-12-18 08:51:22 +00003086
3087 assert( pPg->nRef==0 );
3088
3089 /* Write the page to the database file if it is dirty.
3090 */
3091 if( pPg->dirty ){
3092 int rc;
3093 assert( pPg->needSync==0 );
drh605ad8f2006-05-03 23:34:05 +00003094 makeClean(pPg);
3095 pPg->dirty = 1;
danielk197713f72992005-12-18 08:51:22 +00003096 pPg->pDirty = 0;
3097 rc = pager_write_pagelist( pPg );
drh153c62c2007-08-24 03:51:33 +00003098 pPg->dirty = 0;
danielk197713f72992005-12-18 08:51:22 +00003099 if( rc!=SQLITE_OK ){
danielk1977aef0bf62005-12-30 16:28:01 +00003100 return rc;
danielk197713f72992005-12-18 08:51:22 +00003101 }
3102 }
3103 assert( pPg->dirty==0 );
3104
3105 /* If the page we are recycling is marked as alwaysRollback, then
3106 ** set the global alwaysRollback flag, thus disabling the
drh80e35f42007-03-30 14:06:34 +00003107 ** sqlite3PagerDontRollback() optimization for the rest of this transaction.
danielk197713f72992005-12-18 08:51:22 +00003108 ** It is necessary to do this because the page marked alwaysRollback
3109 ** might be reloaded at a later time but at that point we won't remember
3110 ** that is was marked alwaysRollback. This means that all pages must
3111 ** be marked as alwaysRollback from here on out.
3112 */
3113 if( pPg->alwaysRollback ){
drh602c2372007-03-01 00:29:13 +00003114 IOTRACE(("ALWAYS_ROLLBACK %p\n", pPager))
danielk197713f72992005-12-18 08:51:22 +00003115 pPager->alwaysRollback = 1;
3116 }
3117
3118 /* Unlink the old page from the free list and the hash table
3119 */
3120 unlinkPage(pPg);
drh7c4ac0c2007-04-05 11:25:58 +00003121 assert( pPg->pgno==0 );
danielk197713f72992005-12-18 08:51:22 +00003122
3123 *ppPg = pPg;
3124 return SQLITE_OK;
3125}
3126
drh86f8c192007-08-22 00:39:19 +00003127#ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
danielk197713f72992005-12-18 08:51:22 +00003128/*
3129** This function is called to free superfluous dynamically allocated memory
3130** held by the pager system. Memory in use by any SQLite pager allocated
drh17435752007-08-16 04:30:38 +00003131** by the current thread may be sqlite3_free()ed.
danielk197713f72992005-12-18 08:51:22 +00003132**
3133** nReq is the number of bytes of memory required. Once this much has
drh86f8c192007-08-22 00:39:19 +00003134** been released, the function returns. The return value is the total number
danielk197713f72992005-12-18 08:51:22 +00003135** of bytes of memory released.
3136*/
danielk19773b8a05f2007-03-19 17:44:26 +00003137int sqlite3PagerReleaseMemory(int nReq){
drh86f8c192007-08-22 00:39:19 +00003138 int nReleased = 0; /* Bytes of memory released so far */
3139 sqlite3_mutex *mutex; /* The MEM2 mutex */
3140 Pager *pPager; /* For looping over pagers */
danielk19779f61c2f2007-08-27 17:27:49 +00003141 int rc = SQLITE_OK;
danielk197713f72992005-12-18 08:51:22 +00003142
drh86f8c192007-08-22 00:39:19 +00003143 /* Acquire the memory-management mutex
danielk1977441b09a2006-01-05 13:48:29 +00003144 */
drh86f8c192007-08-22 00:39:19 +00003145 mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_MEM2);
3146 sqlite3_mutex_enter(mutex);
3147
3148 /* Signal all database connections that memory management wants
3149 ** to have access to the pagers.
3150 */
3151 for(pPager=sqlite3PagerList; pPager; pPager=pPager->pNext){
3152 pPager->iInUseMM = 1;
danielk1977441b09a2006-01-05 13:48:29 +00003153 }
3154
danielk19779f61c2f2007-08-27 17:27:49 +00003155 while( rc==SQLITE_OK && (nReq<0 || nReleased<nReq) ){
3156 PgHdr *pPg;
3157 PgHdr *pRecycled;
3158
3159 /* Try to find a page to recycle that does not require a sync(). If
3160 ** this is not possible, find one that does require a sync().
3161 */
3162 sqlite3_mutex_enter(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
3163 pPg = sqlite3LruPageList.pFirstSynced;
3164 while( pPg && (pPg->needSync || pPg->pPager->iInUseDB) ){
3165 pPg = pPg->gfree.pNext;
3166 }
3167 if( !pPg ){
3168 pPg = sqlite3LruPageList.pFirst;
3169 while( pPg && pPg->pPager->iInUseDB ){
3170 pPg = pPg->gfree.pNext;
3171 }
3172 }
3173 sqlite3_mutex_leave(sqlite3_mutex_alloc(SQLITE_MUTEX_STATIC_LRU));
danielk197713f72992005-12-18 08:51:22 +00003174
danielk197784f786f2007-08-28 08:00:17 +00003175 /* If pPg==0, then the block above has failed to find a page to
3176 ** recycle. In this case return early - no further memory will
3177 ** be released.
3178 */
danielk19779f61c2f2007-08-27 17:27:49 +00003179 if( !pPg ) break;
danielk197713f72992005-12-18 08:51:22 +00003180
danielk19779f61c2f2007-08-27 17:27:49 +00003181 pPager = pPg->pPager;
3182 assert(!pPg->needSync || pPg==pPager->lru.pFirst);
3183 assert(pPg->needSync || pPg==pPager->lru.pFirstSynced);
3184
danielk1977843e65f2007-09-01 16:16:15 +00003185 rc = pager_recycle(pPager, &pRecycled);
danielk19779f61c2f2007-08-27 17:27:49 +00003186 assert(pRecycled==pPg || rc!=SQLITE_OK);
3187 if( rc==SQLITE_OK ){
3188 /* We've found a page to free. At this point the page has been
3189 ** removed from the page hash-table, free-list and synced-list
3190 ** (pFirstSynced). It is still in the all pages (pAll) list.
3191 ** Remove it from this list before freeing.
3192 **
3193 ** Todo: Check the Pager.pStmt list to make sure this is Ok. It
3194 ** probably is though.
danielk197713f72992005-12-18 08:51:22 +00003195 */
danielk19779f61c2f2007-08-27 17:27:49 +00003196 PgHdr *pTmp;
3197 assert( pPg );
3198 if( pPg==pPager->pAll ){
3199 pPager->pAll = pPg->pNextAll;
3200 }else{
3201 for( pTmp=pPager->pAll; pTmp->pNextAll!=pPg; pTmp=pTmp->pNextAll ){}
3202 pTmp->pNextAll = pPg->pNextAll;
danielk197713f72992005-12-18 08:51:22 +00003203 }
danielk19779f61c2f2007-08-27 17:27:49 +00003204 nReleased += (
3205 sizeof(*pPg) + pPager->pageSize
3206 + sizeof(u32) + pPager->nExtra
3207 + MEMDB*sizeof(PgHistory)
3208 );
3209 IOTRACE(("PGFREE %p %d *\n", pPager, pPg->pgno));
3210 PAGER_INCR(sqlite3_pager_pgfree_count);
3211 sqlite3_free(pPg);
danielk197784f786f2007-08-28 08:00:17 +00003212 pPager->nPage--;
danielk19779f61c2f2007-08-27 17:27:49 +00003213 }else{
3214 /* An error occured whilst writing to the database file or
3215 ** journal in pager_recycle(). The error is not returned to the
3216 ** caller of this function. Instead, set the Pager.errCode variable.
3217 ** The error will be returned to the user (or users, in the case
3218 ** of a shared pager cache) of the pager for which the error occured.
3219 */
3220 assert(
3221 (rc&0xff)==SQLITE_IOERR ||
3222 rc==SQLITE_FULL ||
3223 rc==SQLITE_BUSY
3224 );
3225 assert( pPager->state>=PAGER_RESERVED );
3226 pager_error(pPager, rc);
danielk197713f72992005-12-18 08:51:22 +00003227 }
3228 }
danielk1977aef0bf62005-12-30 16:28:01 +00003229
drh86f8c192007-08-22 00:39:19 +00003230 /* Clear the memory management flags and release the mutex
3231 */
3232 for(pPager=sqlite3PagerList; pPager; pPager=pPager->pNext){
3233 pPager->iInUseMM = 0;
3234 }
3235 sqlite3_mutex_leave(mutex);
3236
3237 /* Return the number of bytes released
3238 */
danielk197713f72992005-12-18 08:51:22 +00003239 return nReleased;
3240}
drh86f8c192007-08-22 00:39:19 +00003241#endif /* SQLITE_ENABLE_MEMORY_MANAGEMENT */
danielk197713f72992005-12-18 08:51:22 +00003242
drh165ffe92005-03-15 17:09:30 +00003243/*
danielk1977e180dd92007-04-05 17:15:52 +00003244** Read the content of page pPg out of the database file.
3245*/
3246static int readDbPage(Pager *pPager, PgHdr *pPg, Pgno pgno){
3247 int rc;
danielk197762079062007-08-15 17:08:46 +00003248 i64 offset;
danielk1977e180dd92007-04-05 17:15:52 +00003249 assert( MEMDB==0 );
danielk19777a2b1ee2007-08-21 14:27:01 +00003250 assert(pPager->fd->pMethods||pPager->tempFile);
3251 if( !pPager->fd->pMethods ){
3252 return SQLITE_IOERR_SHORT_READ;
3253 }
danielk197762079062007-08-15 17:08:46 +00003254 offset = (pgno-1)*(i64)pPager->pageSize;
3255 rc = sqlite3OsRead(pPager->fd, PGHDR_TO_DATA(pPg), pPager->pageSize, offset);
drh538f5702007-04-13 02:14:30 +00003256 PAGER_INCR(sqlite3_pager_readdb_count);
3257 PAGER_INCR(pPager->nRead);
3258 IOTRACE(("PGIN %p %d\n", pPager, pgno));
drh86a88112007-04-16 15:02:19 +00003259 if( pgno==1 ){
3260 memcpy(&pPager->dbFileVers, &((u8*)PGHDR_TO_DATA(pPg))[24],
3261 sizeof(pPager->dbFileVers));
3262 }
danielk1977e180dd92007-04-05 17:15:52 +00003263 CODEC1(pPager, PGHDR_TO_DATA(pPg), pPg->pgno, 3);
drh477731b2007-06-16 03:06:27 +00003264 PAGERTRACE4("FETCH %d page %d hash(%08x)\n",
3265 PAGERID(pPager), pPg->pgno, pager_pagehash(pPg));
danielk1977e180dd92007-04-05 17:15:52 +00003266 return rc;
3267}
3268
3269
3270/*
danielk1977e277be02007-03-23 18:12:06 +00003271** This function is called to obtain the shared lock required before
3272** data may be read from the pager cache. If the shared lock has already
3273** been obtained, this function is a no-op.
danielk1977393f0682007-03-31 10:00:48 +00003274**
3275** Immediately after obtaining the shared lock (if required), this function
3276** checks for a hot-journal file. If one is found, an emergency rollback
3277** is performed immediately.
danielk1977e277be02007-03-23 18:12:06 +00003278*/
3279static int pagerSharedLock(Pager *pPager){
3280 int rc = SQLITE_OK;
danielk1977ae72d982007-10-03 08:46:44 +00003281 int isHot = 0;
danielk1977e277be02007-03-23 18:12:06 +00003282
danielk1977ae72d982007-10-03 08:46:44 +00003283 /* If this database is opened for exclusive access, has no outstanding
3284 ** page references and is in an error-state, now is the chance to clear
3285 ** the error. Discard the contents of the pager-cache and treat any
3286 ** open journal file as a hot-journal.
3287 */
3288 if( !MEMDB && pPager->exclusiveMode && pPager->nRef==0 && pPager->errCode ){
3289 if( pPager->journalOpen ){
3290 isHot = 1;
3291 }
3292 pager_reset(pPager);
3293 pPager->errCode = SQLITE_OK;
3294 }
3295
3296 /* If the pager is still in an error state, do not proceed. The error
3297 ** state will be cleared at some point in the future when all page
3298 ** references are dropped and the cache can be discarded.
3299 */
3300 if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
3301 return pPager->errCode;
3302 }
3303
3304 if( pPager->state==PAGER_UNLOCK || isHot ){
danielk1977b4b47412007-08-17 15:53:36 +00003305 sqlite3_vfs *pVfs = pPager->pVfs;
danielk1977e277be02007-03-23 18:12:06 +00003306 if( !MEMDB ){
3307 assert( pPager->nRef==0 );
3308 if( !pPager->noReadlock ){
3309 rc = pager_wait_on_lock(pPager, SHARED_LOCK);
3310 if( rc!=SQLITE_OK ){
3311 return pager_error(pPager, rc);
3312 }
3313 assert( pPager->state>=SHARED_LOCK );
3314 }
3315
3316 /* If a journal file exists, and there is no RESERVED lock on the
3317 ** database file, then it either needs to be played back or deleted.
3318 */
danielk1977ae72d982007-10-03 08:46:44 +00003319 if( hasHotJournal(pPager) || isHot ){
danielk1977e277be02007-03-23 18:12:06 +00003320 /* Get an EXCLUSIVE lock on the database file. At this point it is
3321 ** important that a RESERVED lock is not obtained on the way to the
3322 ** EXCLUSIVE lock. If it were, another process might open the
3323 ** database file, detect the RESERVED lock, and conclude that the
3324 ** database is safe to read while this process is still rolling it
3325 ** back.
3326 **
3327 ** Because the intermediate RESERVED lock is not requested, the
3328 ** second process will get to this point in the code and fail to
3329 ** obtain it's own EXCLUSIVE lock on the database file.
3330 */
danielk1977ae72d982007-10-03 08:46:44 +00003331 if( pPager->state<EXCLUSIVE_LOCK ){
3332 rc = sqlite3OsLock(pPager->fd, EXCLUSIVE_LOCK);
3333 if( rc!=SQLITE_OK ){
3334 pager_unlock(pPager);
3335 return pager_error(pPager, rc);
3336 }
3337 pPager->state = PAGER_EXCLUSIVE;
danielk1977e277be02007-03-23 18:12:06 +00003338 }
danielk1977e277be02007-03-23 18:12:06 +00003339
3340 /* Open the journal for reading only. Return SQLITE_BUSY if
3341 ** we are unable to open the journal file.
3342 **
3343 ** The journal file does not need to be locked itself. The
3344 ** journal file is never open unless the main database file holds
3345 ** a write lock, so there is never any chance of two or more
3346 ** processes opening the journal at the same time.
danielk1977979f38e2007-03-27 16:19:51 +00003347 **
drhfd131da2007-08-07 17:13:03 +00003348 ** Open the journal for read/write access. This is because in
3349 ** exclusive-access mode the file descriptor will be kept open and
danielk1977979f38e2007-03-27 16:19:51 +00003350 ** possibly used for a transaction later on. On some systems, the
3351 ** OsTruncate() call used in exclusive-access mode also requires
3352 ** a read/write file handle.
danielk1977e277be02007-03-23 18:12:06 +00003353 */
danielk1977ae72d982007-10-03 08:46:44 +00003354 if( !isHot ){
3355 rc = SQLITE_BUSY;
3356 if( sqlite3OsAccess(pVfs, pPager->zJournal, SQLITE_ACCESS_EXISTS) ){
3357 int fout = 0;
3358 int f = SQLITE_OPEN_READWRITE|SQLITE_OPEN_MAIN_JOURNAL;
3359 assert( !pPager->tempFile );
3360 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, f, &fout);
3361 assert( rc!=SQLITE_OK || pPager->jfd->pMethods );
3362 if( fout&SQLITE_OPEN_READONLY ){
3363 rc = SQLITE_BUSY;
3364 sqlite3OsClose(pPager->jfd);
3365 }
danielk1977979f38e2007-03-27 16:19:51 +00003366 }
3367 }
danielk1977e277be02007-03-23 18:12:06 +00003368 if( rc!=SQLITE_OK ){
3369 pager_unlock(pPager);
danielk1977ae72d982007-10-03 08:46:44 +00003370 return ((rc==SQLITE_NOMEM||rc==SQLITE_IOERR_NOMEM)?rc:SQLITE_BUSY);
danielk1977e277be02007-03-23 18:12:06 +00003371 }
3372 pPager->journalOpen = 1;
3373 pPager->journalStarted = 0;
3374 pPager->journalOff = 0;
3375 pPager->setMaster = 0;
3376 pPager->journalHdr = 0;
3377
3378 /* Playback and delete the journal. Drop the database write
3379 ** lock and reacquire the read lock.
3380 */
3381 rc = pager_playback(pPager, 1);
3382 if( rc!=SQLITE_OK ){
3383 return pager_error(pPager, rc);
3384 }
danielk1977c5859712007-03-26 12:26:27 +00003385 assert(pPager->state==PAGER_SHARED ||
3386 (pPager->exclusiveMode && pPager->state>PAGER_SHARED)
3387 );
danielk1977e277be02007-03-23 18:12:06 +00003388 }
3389
3390 if( pPager->pAll ){
danielk197724168722007-04-02 05:07:47 +00003391 /* The shared-lock has just been acquired on the database file
3392 ** and there are already pages in the cache (from a previous
drh86a88112007-04-16 15:02:19 +00003393 ** read or write transaction). Check to see if the database
3394 ** has been modified. If the database has changed, flush the
3395 ** cache.
3396 **
3397 ** Database changes is detected by looking at 15 bytes beginning
3398 ** at offset 24 into the file. The first 4 of these 16 bytes are
3399 ** a 32-bit counter that is incremented with each change. The
3400 ** other bytes change randomly with each file change when
3401 ** a codec is in use.
3402 **
3403 ** There is a vanishingly small chance that a change will not be
drh6fa51032007-05-09 20:35:31 +00003404 ** detected. The chance of an undetected change is so small that
drh86a88112007-04-16 15:02:19 +00003405 ** it can be neglected.
danielk197724168722007-04-02 05:07:47 +00003406 */
drh86a88112007-04-16 15:02:19 +00003407 char dbFileVers[sizeof(pPager->dbFileVers)];
danielk1977e180dd92007-04-05 17:15:52 +00003408 sqlite3PagerPagecount(pPager);
danielk197724168722007-04-02 05:07:47 +00003409
danielk1977e180dd92007-04-05 17:15:52 +00003410 if( pPager->errCode ){
3411 return pPager->errCode;
danielk1977e277be02007-03-23 18:12:06 +00003412 }
3413
danielk1977e180dd92007-04-05 17:15:52 +00003414 if( pPager->dbSize>0 ){
drhae5e4452007-05-03 17:18:36 +00003415 IOTRACE(("CKVERS %p %d\n", pPager, sizeof(dbFileVers)));
danielk197762079062007-08-15 17:08:46 +00003416 rc = sqlite3OsRead(pPager->fd, &dbFileVers, sizeof(dbFileVers), 24);
danielk1977e180dd92007-04-05 17:15:52 +00003417 if( rc!=SQLITE_OK ){
3418 return rc;
3419 }
drh86a88112007-04-16 15:02:19 +00003420 }else{
3421 memset(dbFileVers, 0, sizeof(dbFileVers));
danielk1977e180dd92007-04-05 17:15:52 +00003422 }
3423
drh86a88112007-04-16 15:02:19 +00003424 if( memcmp(pPager->dbFileVers, dbFileVers, sizeof(dbFileVers))!=0 ){
danielk1977e180dd92007-04-05 17:15:52 +00003425 pager_reset(pPager);
danielk1977e277be02007-03-23 18:12:06 +00003426 }
3427 }
3428 }
danielk1977c5859712007-03-26 12:26:27 +00003429 assert( pPager->exclusiveMode || pPager->state<=PAGER_SHARED );
3430 if( pPager->state==PAGER_UNLOCK ){
3431 pPager->state = PAGER_SHARED;
3432 }
danielk1977e277be02007-03-23 18:12:06 +00003433 }
3434
3435 return rc;
3436}
3437
3438/*
danielk1977e180dd92007-04-05 17:15:52 +00003439** Allocate a PgHdr object. Either create a new one or reuse
3440** an existing one that is not otherwise in use.
3441**
3442** A new PgHdr structure is created if any of the following are
3443** true:
3444**
3445** (1) We have not exceeded our maximum allocated cache size
3446** as set by the "PRAGMA cache_size" command.
3447**
3448** (2) There are no unused PgHdr objects available at this time.
3449**
3450** (3) This is an in-memory database.
3451**
3452** (4) There are no PgHdr objects that do not require a journal
3453** file sync and a sync of the journal file is currently
3454** prohibited.
3455**
3456** Otherwise, reuse an existing PgHdr. In other words, reuse an
3457** existing PgHdr if all of the following are true:
3458**
3459** (1) We have reached or exceeded the maximum cache size
3460** allowed by "PRAGMA cache_size".
3461**
3462** (2) There is a PgHdr available with PgHdr->nRef==0
3463**
3464** (3) We are not in an in-memory database
3465**
3466** (4) Either there is an available PgHdr that does not need
3467** to be synced to disk or else disk syncing is currently
3468** allowed.
danielk197724168722007-04-02 05:07:47 +00003469*/
3470static int pagerAllocatePage(Pager *pPager, PgHdr **ppPg){
3471 int rc = SQLITE_OK;
3472 PgHdr *pPg;
drh1e3af332007-10-20 13:17:54 +00003473 int nByteHdr;
danielk197724168722007-04-02 05:07:47 +00003474
danielk1977e180dd92007-04-05 17:15:52 +00003475 /* Create a new PgHdr if any of the four conditions defined
danielk19772a6bdf62007-08-20 16:07:00 +00003476 ** above are met: */
danielk1977e180dd92007-04-05 17:15:52 +00003477 if( pPager->nPage<pPager->mxPage
danielk19779f61c2f2007-08-27 17:27:49 +00003478 || pPager->lru.pFirst==0
danielk1977e180dd92007-04-05 17:15:52 +00003479 || MEMDB
danielk19779f61c2f2007-08-27 17:27:49 +00003480 || (pPager->lru.pFirstSynced==0 && pPager->doNotSync)
danielk1977e180dd92007-04-05 17:15:52 +00003481 ){
danielk197724168722007-04-02 05:07:47 +00003482 if( pPager->nPage>=pPager->nHash ){
3483 pager_resize_hash_table(pPager,
3484 pPager->nHash<256 ? 256 : pPager->nHash*2);
3485 if( pPager->nHash==0 ){
3486 rc = SQLITE_NOMEM;
3487 goto pager_allocate_out;
3488 }
3489 }
drhed138fb2007-08-22 22:04:37 +00003490 pagerLeave(pPager);
drh1e3af332007-10-20 13:17:54 +00003491 nByteHdr = sizeof(*pPg) + sizeof(u32) + pPager->nExtra
3492 + MEMDB*sizeof(PgHistory);
3493 pPg = sqlite3_malloc( nByteHdr + pPager->pageSize );
drhed138fb2007-08-22 22:04:37 +00003494 pagerEnter(pPager);
danielk197724168722007-04-02 05:07:47 +00003495 if( pPg==0 ){
3496 rc = SQLITE_NOMEM;
3497 goto pager_allocate_out;
3498 }
drh1e3af332007-10-20 13:17:54 +00003499 memset(pPg, 0, nByteHdr);
3500 pPg->pData = (void*)(nByteHdr + (char*)pPg);
danielk197724168722007-04-02 05:07:47 +00003501 pPg->pPager = pPager;
3502 pPg->pNextAll = pPager->pAll;
3503 pPager->pAll = pPg;
3504 pPager->nPage++;
danielk197724168722007-04-02 05:07:47 +00003505 }else{
3506 /* Recycle an existing page with a zero ref-count. */
danielk1977843e65f2007-09-01 16:16:15 +00003507 rc = pager_recycle(pPager, &pPg);
danielk1977e965ac72007-06-13 15:22:28 +00003508 if( rc==SQLITE_BUSY ){
3509 rc = SQLITE_IOERR_BLOCKED;
3510 }
danielk197724168722007-04-02 05:07:47 +00003511 if( rc!=SQLITE_OK ){
3512 goto pager_allocate_out;
3513 }
3514 assert( pPager->state>=SHARED_LOCK );
3515 assert(pPg);
3516 }
3517 *ppPg = pPg;
3518
3519pager_allocate_out:
3520 return rc;
3521}
3522
3523/*
drhd33d5a82007-04-26 12:11:28 +00003524** Make sure we have the content for a page. If the page was
3525** previously acquired with noContent==1, then the content was
3526** just initialized to zeros instead of being read from disk.
3527** But now we need the real data off of disk. So make sure we
3528** have it. Read it in if we do not have it already.
3529*/
3530static int pager_get_content(PgHdr *pPg){
3531 if( pPg->needRead ){
3532 int rc = readDbPage(pPg->pPager, pPg, pPg->pgno);
3533 if( rc==SQLITE_OK ){
3534 pPg->needRead = 0;
3535 }else{
3536 return rc;
3537 }
3538 }
3539 return SQLITE_OK;
3540}
3541
3542/*
drhd9b02572001-04-15 00:37:09 +00003543** Acquire a page.
3544**
drh58a11682001-11-10 13:51:08 +00003545** A read lock on the disk file is obtained when the first page is acquired.
drh5e00f6c2001-09-13 13:46:56 +00003546** This read lock is dropped when the last page is released.
drhd9b02572001-04-15 00:37:09 +00003547**
drhd33d5a82007-04-26 12:11:28 +00003548** This routine works for any page number greater than 0. If the database
drh306dc212001-05-21 13:45:10 +00003549** file is smaller than the requested page, then no actual disk
3550** read occurs and the memory image of the page is initialized to
3551** all zeros. The extra data appended to a page is always initialized
3552** to zeros the first time a page is loaded into memory.
3553**
drhd9b02572001-04-15 00:37:09 +00003554** The acquisition might fail for several reasons. In all cases,
3555** an appropriate error code is returned and *ppPage is set to NULL.
drh7e3b0a02001-04-28 16:52:40 +00003556**
drhd33d5a82007-04-26 12:11:28 +00003557** See also sqlite3PagerLookup(). Both this routine and Lookup() attempt
drh7e3b0a02001-04-28 16:52:40 +00003558** to find a page in the in-memory cache first. If the page is not already
drhd33d5a82007-04-26 12:11:28 +00003559** in memory, this routine goes to disk to read it in whereas Lookup()
drh7e3b0a02001-04-28 16:52:40 +00003560** just returns 0. This routine acquires a read-lock the first time it
3561** has to go to disk, and could also playback an old journal if necessary.
drhd33d5a82007-04-26 12:11:28 +00003562** Since Lookup() never goes to disk, it never has to deal with locks
drh7e3b0a02001-04-28 16:52:40 +00003563** or journal files.
drh0787db62007-03-04 13:15:27 +00003564**
drh538f5702007-04-13 02:14:30 +00003565** If noContent is false, the page contents are actually read from disk.
3566** If noContent is true, it means that we do not care about the contents
3567** of the page at this time, so do not do a disk read. Just fill in the
3568** page content with zeros. But mark the fact that we have not read the
3569** content by setting the PgHdr.needRead flag. Later on, if
drhd33d5a82007-04-26 12:11:28 +00003570** sqlite3PagerWrite() is called on this page or if this routine is
3571** called again with noContent==0, that means that the content is needed
3572** and the disk read should occur at that point.
drhed7c8552001-04-11 14:29:21 +00003573*/
drh86f8c192007-08-22 00:39:19 +00003574static int pagerAcquire(
drh538f5702007-04-13 02:14:30 +00003575 Pager *pPager, /* The pager open on the database file */
3576 Pgno pgno, /* Page number to fetch */
3577 DbPage **ppPage, /* Write a pointer to the page here */
3578 int noContent /* Do not bother reading content from disk if true */
3579){
drhed7c8552001-04-11 14:29:21 +00003580 PgHdr *pPg;
drh165ffe92005-03-15 17:09:30 +00003581 int rc;
drhed7c8552001-04-11 14:29:21 +00003582
danielk1977e277be02007-03-23 18:12:06 +00003583 assert( pPager->state==PAGER_UNLOCK || pPager->nRef>0 || pgno==1 );
3584
danielk197726836652005-01-17 01:33:13 +00003585 /* The maximum page number is 2^31. Return SQLITE_CORRUPT if a page
3586 ** number greater than this, or zero, is requested.
3587 */
drh267cb322005-09-16 17:16:52 +00003588 if( pgno>PAGER_MAX_PGNO || pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
drh49285702005-09-17 15:20:26 +00003589 return SQLITE_CORRUPT_BKPT;
danielk197726836652005-01-17 01:33:13 +00003590 }
3591
drhd9b02572001-04-15 00:37:09 +00003592 /* Make sure we have not hit any critical errors.
3593 */
drh836faa42003-01-11 13:30:57 +00003594 assert( pPager!=0 );
drh2e6d11b2003-04-25 15:37:57 +00003595 *ppPage = 0;
drhd9b02572001-04-15 00:37:09 +00003596
danielk197713adf8a2004-06-03 16:08:41 +00003597 /* If this is the first page accessed, then get a SHARED lock
danielk1977334cdb62007-03-26 08:05:12 +00003598 ** on the database file. pagerSharedLock() is a no-op if
3599 ** a database lock is already held.
drhed7c8552001-04-11 14:29:21 +00003600 */
danielk1977e277be02007-03-23 18:12:06 +00003601 rc = pagerSharedLock(pPager);
3602 if( rc!=SQLITE_OK ){
3603 return rc;
drhed7c8552001-04-11 14:29:21 +00003604 }
danielk1977e277be02007-03-23 18:12:06 +00003605 assert( pPager->state!=PAGER_UNLOCK );
3606
3607 pPg = pager_lookup(pPager, pgno);
drhed7c8552001-04-11 14:29:21 +00003608 if( pPg==0 ){
drhd9b02572001-04-15 00:37:09 +00003609 /* The requested page is not in the page cache. */
danielk1977979f38e2007-03-27 16:19:51 +00003610 int nMax;
drhed7c8552001-04-11 14:29:21 +00003611 int h;
drh538f5702007-04-13 02:14:30 +00003612 PAGER_INCR(pPager->nMiss);
danielk197724168722007-04-02 05:07:47 +00003613 rc = pagerAllocatePage(pPager, &pPg);
3614 if( rc!=SQLITE_OK ){
3615 return rc;
drhed7c8552001-04-11 14:29:21 +00003616 }
danielk197724168722007-04-02 05:07:47 +00003617
drhed7c8552001-04-11 14:29:21 +00003618 pPg->pgno = pgno;
danielk1977f35843b2007-04-07 15:03:17 +00003619 assert( !MEMDB || pgno>pPager->stmtSize );
drh1ab43002002-01-14 09:28:19 +00003620 if( pPager->aInJournal && (int)pgno<=pPager->origDbSize ){
danielk19771e536952007-08-16 10:09:01 +00003621#if 0
danielk19774adee202004-05-08 08:23:19 +00003622 sqlite3CheckMemory(pPager->aInJournal, pgno/8);
danielk19771e536952007-08-16 10:09:01 +00003623#endif
drhdb48ee02003-01-16 13:42:43 +00003624 assert( pPager->journalOpen );
drh6019e162001-07-02 17:51:45 +00003625 pPg->inJournal = (pPager->aInJournal[pgno/8] & (1<<(pgno&7)))!=0;
drhdb48ee02003-01-16 13:42:43 +00003626 pPg->needSync = 0;
drh6019e162001-07-02 17:51:45 +00003627 }else{
3628 pPg->inJournal = 0;
drhdb48ee02003-01-16 13:42:43 +00003629 pPg->needSync = 0;
drh6019e162001-07-02 17:51:45 +00003630 }
danielk1977f35843b2007-04-07 15:03:17 +00003631
drh605ad8f2006-05-03 23:34:05 +00003632 makeClean(pPg);
drhed7c8552001-04-11 14:29:21 +00003633 pPg->nRef = 1;
drhdd793422001-06-28 01:54:48 +00003634 REFINFO(pPg);
danielk197775bab7d2006-01-23 13:09:45 +00003635
drhd9b02572001-04-15 00:37:09 +00003636 pPager->nRef++;
drh2e6d11b2003-04-25 15:37:57 +00003637 if( pPager->nExtra>0 ){
drh90f5ecb2004-07-22 01:19:35 +00003638 memset(PGHDR_TO_EXTRA(pPg, pPager), 0, pPager->nExtra);
drh2e6d11b2003-04-25 15:37:57 +00003639 }
danielk1977979f38e2007-03-27 16:19:51 +00003640 nMax = sqlite3PagerPagecount(pPager);
danielk1977efaaf572006-01-16 11:29:19 +00003641 if( pPager->errCode ){
danielk1977efaaf572006-01-16 11:29:19 +00003642 rc = pPager->errCode;
danielk1977ae72d982007-10-03 08:46:44 +00003643 sqlite3PagerUnref(pPg);
drh2e6d11b2003-04-25 15:37:57 +00003644 return rc;
3645 }
danielk197775bab7d2006-01-23 13:09:45 +00003646
3647 /* Populate the page with data, either by reading from the database
3648 ** file, or by setting the entire page to zero.
3649 */
drhd215acf2007-04-13 04:01:58 +00003650 if( nMax<(int)pgno || MEMDB || (noContent && !pPager->alwaysRollback) ){
drhf8e632b2007-05-08 14:51:36 +00003651 if( pgno>pPager->mxPgno ){
danielk1977de3bea72007-05-09 15:56:39 +00003652 sqlite3PagerUnref(pPg);
drhf8e632b2007-05-08 14:51:36 +00003653 return SQLITE_FULL;
3654 }
drh90f5ecb2004-07-22 01:19:35 +00003655 memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize);
drhd215acf2007-04-13 04:01:58 +00003656 pPg->needRead = noContent && !pPager->alwaysRollback;
drh538f5702007-04-13 02:14:30 +00003657 IOTRACE(("ZERO %p %d\n", pPager, pgno));
drh306dc212001-05-21 13:45:10 +00003658 }else{
danielk1977e180dd92007-04-05 17:15:52 +00003659 rc = readDbPage(pPager, pPg, pgno);
drh551b7732006-11-06 21:20:25 +00003660 if( rc!=SQLITE_OK && rc!=SQLITE_IOERR_SHORT_READ ){
3661 pPg->pgno = 0;
danielk19773b8a05f2007-03-19 17:44:26 +00003662 sqlite3PagerUnref(pPg);
drh551b7732006-11-06 21:20:25 +00003663 return rc;
drh81a20f22001-10-12 17:30:04 +00003664 }
danielk1977b4626a32007-04-28 15:47:43 +00003665 pPg->needRead = 0;
drh306dc212001-05-21 13:45:10 +00003666 }
danielk197775bab7d2006-01-23 13:09:45 +00003667
3668 /* Link the page into the page hash table */
drh8ca0c722006-05-07 17:49:38 +00003669 h = pgno & (pPager->nHash-1);
drh3765df42006-06-28 18:18:09 +00003670 assert( pgno!=0 );
danielk197775bab7d2006-01-23 13:09:45 +00003671 pPg->pNextHash = pPager->aHash[h];
3672 pPager->aHash[h] = pPg;
3673 if( pPg->pNextHash ){
3674 assert( pPg->pNextHash->pPrevHash==0 );
3675 pPg->pNextHash->pPrevHash = pPg;
3676 }
3677
danielk19773c407372005-02-15 02:54:14 +00003678#ifdef SQLITE_CHECK_PAGES
3679 pPg->pageHash = pager_pagehash(pPg);
3680#endif
drhed7c8552001-04-11 14:29:21 +00003681 }else{
drhd9b02572001-04-15 00:37:09 +00003682 /* The requested page is in the page cache. */
danielk1977e277be02007-03-23 18:12:06 +00003683 assert(pPager->nRef>0 || pgno==1);
drh538f5702007-04-13 02:14:30 +00003684 PAGER_INCR(pPager->nHit);
drhd33d5a82007-04-26 12:11:28 +00003685 if( !noContent ){
3686 rc = pager_get_content(pPg);
3687 if( rc ){
3688 return rc;
3689 }
3690 }
drhdf0b3b02001-06-23 11:36:20 +00003691 page_ref(pPg);
drhed7c8552001-04-11 14:29:21 +00003692 }
danielk19773b8a05f2007-03-19 17:44:26 +00003693 *ppPage = pPg;
drhed7c8552001-04-11 14:29:21 +00003694 return SQLITE_OK;
3695}
drh86f8c192007-08-22 00:39:19 +00003696int sqlite3PagerAcquire(
3697 Pager *pPager, /* The pager open on the database file */
3698 Pgno pgno, /* Page number to fetch */
3699 DbPage **ppPage, /* Write a pointer to the page here */
3700 int noContent /* Do not bother reading content from disk if true */
3701){
3702 int rc;
3703 pagerEnter(pPager);
3704 rc = pagerAcquire(pPager, pgno, ppPage, noContent);
3705 pagerLeave(pPager);
3706 return rc;
3707}
3708
drhed7c8552001-04-11 14:29:21 +00003709
3710/*
drh7e3b0a02001-04-28 16:52:40 +00003711** Acquire a page if it is already in the in-memory cache. Do
3712** not read the page from disk. Return a pointer to the page,
3713** or 0 if the page is not in cache.
3714**
danielk19773b8a05f2007-03-19 17:44:26 +00003715** See also sqlite3PagerGet(). The difference between this routine
3716** and sqlite3PagerGet() is that _get() will go to the disk and read
drh7e3b0a02001-04-28 16:52:40 +00003717** in the page if the page is not already in cache. This routine
drh5e00f6c2001-09-13 13:46:56 +00003718** returns NULL if the page is not in cache or if a disk I/O error
3719** has ever happened.
drh7e3b0a02001-04-28 16:52:40 +00003720*/
danielk19773b8a05f2007-03-19 17:44:26 +00003721DbPage *sqlite3PagerLookup(Pager *pPager, Pgno pgno){
drh86f8c192007-08-22 00:39:19 +00003722 PgHdr *pPg = 0;
drh7e3b0a02001-04-28 16:52:40 +00003723
drh836faa42003-01-11 13:30:57 +00003724 assert( pPager!=0 );
3725 assert( pgno!=0 );
danielk1977e277be02007-03-23 18:12:06 +00003726
drh86f8c192007-08-22 00:39:19 +00003727 pagerEnter(pPager);
danielk1977e277be02007-03-23 18:12:06 +00003728 if( pPager->state==PAGER_UNLOCK ){
danielk1977334cdb62007-03-26 08:05:12 +00003729 assert( !pPager->pAll || pPager->exclusiveMode );
drh86f8c192007-08-22 00:39:19 +00003730 }else if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
3731 /* Do nothing */
3732 }else if( (pPg = pager_lookup(pPager, pgno))!=0 ){
3733 page_ref(pPg);
danielk1977e277be02007-03-23 18:12:06 +00003734 }
drh86f8c192007-08-22 00:39:19 +00003735 pagerLeave(pPager);
danielk19773b8a05f2007-03-19 17:44:26 +00003736 return pPg;
drh7e3b0a02001-04-28 16:52:40 +00003737}
3738
3739/*
drhed7c8552001-04-11 14:29:21 +00003740** Release a page.
3741**
3742** If the number of references to the page drop to zero, then the
3743** page is added to the LRU list. When all references to all pages
drhd9b02572001-04-15 00:37:09 +00003744** are released, a rollback occurs and the lock on the database is
drhed7c8552001-04-11 14:29:21 +00003745** removed.
3746*/
danielk19773b8a05f2007-03-19 17:44:26 +00003747int sqlite3PagerUnref(DbPage *pPg){
danielk1977ae72d982007-10-03 08:46:44 +00003748 Pager *pPager = pPg->pPager;
drhd9b02572001-04-15 00:37:09 +00003749
3750 /* Decrement the reference count for this page
3751 */
drhed7c8552001-04-11 14:29:21 +00003752 assert( pPg->nRef>0 );
drh86f8c192007-08-22 00:39:19 +00003753 pagerEnter(pPg->pPager);
drhed7c8552001-04-11 14:29:21 +00003754 pPg->nRef--;
drhdd793422001-06-28 01:54:48 +00003755 REFINFO(pPg);
drhd9b02572001-04-15 00:37:09 +00003756
danielk19773c407372005-02-15 02:54:14 +00003757 CHECK_PAGE(pPg);
3758
drh72f82862001-05-24 21:06:34 +00003759 /* When the number of references to a page reach 0, call the
3760 ** destructor and add the page to the freelist.
drhd9b02572001-04-15 00:37:09 +00003761 */
drhed7c8552001-04-11 14:29:21 +00003762 if( pPg->nRef==0 ){
danielk19779f61c2f2007-08-27 17:27:49 +00003763
3764 lruListAdd(pPg);
drh72f82862001-05-24 21:06:34 +00003765 if( pPager->xDestructor ){
danielk19773b8a05f2007-03-19 17:44:26 +00003766 pPager->xDestructor(pPg, pPager->pageSize);
drh72f82862001-05-24 21:06:34 +00003767 }
drhd9b02572001-04-15 00:37:09 +00003768
3769 /* When all pages reach the freelist, drop the read lock from
3770 ** the database file.
3771 */
3772 pPager->nRef--;
3773 assert( pPager->nRef>=0 );
danielk19773dedc192007-03-27 17:37:31 +00003774 if( pPager->nRef==0 && (!pPager->exclusiveMode || pPager->journalOff>0) ){
danielk1977e277be02007-03-23 18:12:06 +00003775 pagerUnlockAndRollback(pPager);
drhd9b02572001-04-15 00:37:09 +00003776 }
drhed7c8552001-04-11 14:29:21 +00003777 }
danielk1977ae72d982007-10-03 08:46:44 +00003778 pagerLeave(pPager);
drhd9b02572001-04-15 00:37:09 +00003779 return SQLITE_OK;
drhed7c8552001-04-11 14:29:21 +00003780}
3781
3782/*
drha6abd042004-06-09 17:37:22 +00003783** Create a journal file for pPager. There should already be a RESERVED
3784** or EXCLUSIVE lock on the database file when this routine is called.
drhda47d772002-12-02 04:25:19 +00003785**
3786** Return SQLITE_OK if everything. Return an error code and release the
3787** write lock if anything goes wrong.
3788*/
3789static int pager_open_journal(Pager *pPager){
danielk1977b4b47412007-08-17 15:53:36 +00003790 sqlite3_vfs *pVfs = pPager->pVfs;
3791 int flags = (SQLITE_OPEN_READWRITE|SQLITE_OPEN_EXCLUSIVE|SQLITE_OPEN_CREATE);
3792
drhda47d772002-12-02 04:25:19 +00003793 int rc;
drhb7f91642004-10-31 02:22:47 +00003794 assert( !MEMDB );
drha6abd042004-06-09 17:37:22 +00003795 assert( pPager->state>=PAGER_RESERVED );
drhda47d772002-12-02 04:25:19 +00003796 assert( pPager->journalOpen==0 );
3797 assert( pPager->useJournal );
drh88b01a12005-03-28 18:04:27 +00003798 assert( pPager->aInJournal==0 );
danielk19773b8a05f2007-03-19 17:44:26 +00003799 sqlite3PagerPagecount(pPager);
drhed138fb2007-08-22 22:04:37 +00003800 pagerLeave(pPager);
drh17435752007-08-16 04:30:38 +00003801 pPager->aInJournal = sqlite3MallocZero( pPager->dbSize/8 + 1 );
drhed138fb2007-08-22 22:04:37 +00003802 pagerEnter(pPager);
drhda47d772002-12-02 04:25:19 +00003803 if( pPager->aInJournal==0 ){
drh9c105bb2004-10-02 20:38:28 +00003804 rc = SQLITE_NOMEM;
3805 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00003806 }
danielk1977b4b47412007-08-17 15:53:36 +00003807
3808 if( pPager->tempFile ){
danielk1977fee2d252007-08-18 10:59:19 +00003809 flags |= (SQLITE_OPEN_DELETEONCLOSE|SQLITE_OPEN_TEMP_JOURNAL);
3810 }else{
3811 flags |= (SQLITE_OPEN_MAIN_JOURNAL);
danielk1977b4b47412007-08-17 15:53:36 +00003812 }
danielk1977c7b60172007-08-22 11:22:03 +00003813#ifdef SQLITE_ENABLE_ATOMIC_WRITE
3814 rc = sqlite3JournalOpen(
3815 pVfs, pPager->zJournal, pPager->jfd, flags, jrnlBufferSize(pPager)
3816 );
3817#else
danielk1977b4b47412007-08-17 15:53:36 +00003818 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, flags, 0);
danielk1977c7b60172007-08-22 11:22:03 +00003819#endif
danielk1977b4b47412007-08-17 15:53:36 +00003820 assert( rc!=SQLITE_OK || pPager->jfd->pMethods );
danielk197776572402004-06-25 02:38:54 +00003821 pPager->journalOff = 0;
3822 pPager->setMaster = 0;
3823 pPager->journalHdr = 0;
drhda47d772002-12-02 04:25:19 +00003824 if( rc!=SQLITE_OK ){
drh600e46a2007-03-28 01:59:33 +00003825 if( rc==SQLITE_NOMEM ){
danielk1977fee2d252007-08-18 10:59:19 +00003826 sqlite3OsDelete(pVfs, pPager->zJournal, 0);
drh600e46a2007-03-28 01:59:33 +00003827 }
drh9c105bb2004-10-02 20:38:28 +00003828 goto failed_to_open_journal;
drhda47d772002-12-02 04:25:19 +00003829 }
3830 pPager->journalOpen = 1;
drhdb48ee02003-01-16 13:42:43 +00003831 pPager->journalStarted = 0;
drhda47d772002-12-02 04:25:19 +00003832 pPager->needSync = 0;
3833 pPager->alwaysRollback = 0;
drh968af522003-02-11 14:55:40 +00003834 pPager->nRec = 0;
danielk1977efaaf572006-01-16 11:29:19 +00003835 if( pPager->errCode ){
3836 rc = pPager->errCode;
drhdd5b2fa2005-03-28 03:39:55 +00003837 goto failed_to_open_journal;
drh2e6d11b2003-04-25 15:37:57 +00003838 }
drhda47d772002-12-02 04:25:19 +00003839 pPager->origDbSize = pPager->dbSize;
drhae2b40c2004-06-09 19:03:54 +00003840
danielk197776572402004-06-25 02:38:54 +00003841 rc = writeJournalHdr(pPager);
3842
drhac69b052004-05-12 13:30:07 +00003843 if( pPager->stmtAutoopen && rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00003844 rc = sqlite3PagerStmtBegin(pPager);
drhda47d772002-12-02 04:25:19 +00003845 }
danielk1977ae72d982007-10-03 08:46:44 +00003846 if( rc!=SQLITE_OK && rc!=SQLITE_NOMEM && rc!=SQLITE_IOERR_NOMEM ){
drh80e35f42007-03-30 14:06:34 +00003847 rc = pager_end_transaction(pPager);
drhda47d772002-12-02 04:25:19 +00003848 if( rc==SQLITE_OK ){
3849 rc = SQLITE_FULL;
3850 }
3851 }
drh9c105bb2004-10-02 20:38:28 +00003852 return rc;
3853
3854failed_to_open_journal:
drh17435752007-08-16 04:30:38 +00003855 sqlite3_free(pPager->aInJournal);
drh9c105bb2004-10-02 20:38:28 +00003856 pPager->aInJournal = 0;
drh9c105bb2004-10-02 20:38:28 +00003857 return rc;
drhda47d772002-12-02 04:25:19 +00003858}
3859
3860/*
drh4b845d72002-03-05 12:41:19 +00003861** Acquire a write-lock on the database. The lock is removed when
3862** the any of the following happen:
3863**
drh80e35f42007-03-30 14:06:34 +00003864** * sqlite3PagerCommitPhaseTwo() is called.
danielk19773b8a05f2007-03-19 17:44:26 +00003865** * sqlite3PagerRollback() is called.
3866** * sqlite3PagerClose() is called.
3867** * sqlite3PagerUnref() is called to on every outstanding page.
drh4b845d72002-03-05 12:41:19 +00003868**
danielk197713adf8a2004-06-03 16:08:41 +00003869** The first parameter to this routine is a pointer to any open page of the
3870** database file. Nothing changes about the page - it is used merely to
3871** acquire a pointer to the Pager structure and as proof that there is
3872** already a read-lock on the database.
drh4b845d72002-03-05 12:41:19 +00003873**
danielk197713adf8a2004-06-03 16:08:41 +00003874** The second parameter indicates how much space in bytes to reserve for a
3875** master journal file-name at the start of the journal when it is created.
3876**
3877** A journal file is opened if this is not a temporary file. For temporary
3878** files, the opening of the journal file is deferred until there is an
3879** actual need to write to the journal.
drhda47d772002-12-02 04:25:19 +00003880**
drha6abd042004-06-09 17:37:22 +00003881** If the database is already reserved for writing, this routine is a no-op.
drh684917c2004-10-05 02:41:42 +00003882**
3883** If exFlag is true, go ahead and get an EXCLUSIVE lock on the file
3884** immediately instead of waiting until we try to flush the cache. The
3885** exFlag is ignored if a transaction is already active.
drh4b845d72002-03-05 12:41:19 +00003886*/
danielk19773b8a05f2007-03-19 17:44:26 +00003887int sqlite3PagerBegin(DbPage *pPg, int exFlag){
drh4b845d72002-03-05 12:41:19 +00003888 Pager *pPager = pPg->pPager;
3889 int rc = SQLITE_OK;
drh86f8c192007-08-22 00:39:19 +00003890 pagerEnter(pPager);
drh4b845d72002-03-05 12:41:19 +00003891 assert( pPg->nRef>0 );
drha6abd042004-06-09 17:37:22 +00003892 assert( pPager->state!=PAGER_UNLOCK );
3893 if( pPager->state==PAGER_SHARED ){
drh4b845d72002-03-05 12:41:19 +00003894 assert( pPager->aInJournal==0 );
drhb7f91642004-10-31 02:22:47 +00003895 if( MEMDB ){
drha6abd042004-06-09 17:37:22 +00003896 pPager->state = PAGER_EXCLUSIVE;
drhac69b052004-05-12 13:30:07 +00003897 pPager->origDbSize = pPager->dbSize;
3898 }else{
drh054889e2005-11-30 03:20:31 +00003899 rc = sqlite3OsLock(pPager->fd, RESERVED_LOCK);
drh684917c2004-10-05 02:41:42 +00003900 if( rc==SQLITE_OK ){
3901 pPager->state = PAGER_RESERVED;
3902 if( exFlag ){
3903 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
3904 }
3905 }
danielk19779eed5052004-06-04 10:38:30 +00003906 if( rc!=SQLITE_OK ){
drh86f8c192007-08-22 00:39:19 +00003907 pagerLeave(pPager);
danielk19779eed5052004-06-04 10:38:30 +00003908 return rc;
drhac69b052004-05-12 13:30:07 +00003909 }
drha6abd042004-06-09 17:37:22 +00003910 pPager->dirtyCache = 0;
drh4f0c5872007-03-26 22:05:01 +00003911 PAGERTRACE2("TRANSACTION %d\n", PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00003912 if( pPager->useJournal && !pPager->tempFile ){
3913 rc = pager_open_journal(pPager);
3914 }
drh4b845d72002-03-05 12:41:19 +00003915 }
danielk1977334cdb62007-03-26 08:05:12 +00003916 }else if( pPager->journalOpen && pPager->journalOff==0 ){
3917 /* This happens when the pager was in exclusive-access mode last
3918 ** time a (read or write) transaction was successfully concluded
3919 ** by this connection. Instead of deleting the journal file it was
3920 ** kept open and truncated to 0 bytes.
3921 */
3922 assert( pPager->nRec==0 );
3923 assert( pPager->origDbSize==0 );
drh369339d2007-03-30 16:01:55 +00003924 assert( pPager->aInJournal==0 );
danielk1977334cdb62007-03-26 08:05:12 +00003925 sqlite3PagerPagecount(pPager);
drhed138fb2007-08-22 22:04:37 +00003926 pagerLeave(pPager);
drh17435752007-08-16 04:30:38 +00003927 pPager->aInJournal = sqlite3MallocZero( pPager->dbSize/8 + 1 );
drhed138fb2007-08-22 22:04:37 +00003928 pagerEnter(pPager);
danielk1977334cdb62007-03-26 08:05:12 +00003929 if( !pPager->aInJournal ){
3930 rc = SQLITE_NOMEM;
3931 }else{
drh369339d2007-03-30 16:01:55 +00003932 pPager->origDbSize = pPager->dbSize;
danielk1977334cdb62007-03-26 08:05:12 +00003933 rc = writeJournalHdr(pPager);
3934 }
drh4b845d72002-03-05 12:41:19 +00003935 }
danielk1977334cdb62007-03-26 08:05:12 +00003936 assert( !pPager->journalOpen || pPager->journalOff>0 || rc!=SQLITE_OK );
drh86f8c192007-08-22 00:39:19 +00003937 pagerLeave(pPager);
drh4b845d72002-03-05 12:41:19 +00003938 return rc;
3939}
3940
3941/*
drh605ad8f2006-05-03 23:34:05 +00003942** Make a page dirty. Set its dirty flag and add it to the dirty
3943** page list.
3944*/
3945static void makeDirty(PgHdr *pPg){
3946 if( pPg->dirty==0 ){
3947 Pager *pPager = pPg->pPager;
3948 pPg->dirty = 1;
3949 pPg->pDirty = pPager->pDirty;
3950 if( pPager->pDirty ){
3951 pPager->pDirty->pPrevDirty = pPg;
3952 }
3953 pPg->pPrevDirty = 0;
3954 pPager->pDirty = pPg;
3955 }
3956}
3957
3958/*
3959** Make a page clean. Clear its dirty bit and remove it from the
3960** dirty page list.
3961*/
3962static void makeClean(PgHdr *pPg){
3963 if( pPg->dirty ){
3964 pPg->dirty = 0;
3965 if( pPg->pDirty ){
drh153c62c2007-08-24 03:51:33 +00003966 assert( pPg->pDirty->pPrevDirty==pPg );
drh605ad8f2006-05-03 23:34:05 +00003967 pPg->pDirty->pPrevDirty = pPg->pPrevDirty;
3968 }
3969 if( pPg->pPrevDirty ){
drh153c62c2007-08-24 03:51:33 +00003970 assert( pPg->pPrevDirty->pDirty==pPg );
drh605ad8f2006-05-03 23:34:05 +00003971 pPg->pPrevDirty->pDirty = pPg->pDirty;
3972 }else{
drh153c62c2007-08-24 03:51:33 +00003973 assert( pPg->pPager->pDirty==pPg );
drh605ad8f2006-05-03 23:34:05 +00003974 pPg->pPager->pDirty = pPg->pDirty;
3975 }
3976 }
3977}
3978
3979
3980/*
drhed7c8552001-04-11 14:29:21 +00003981** Mark a data page as writeable. The page is written into the journal
3982** if it is not there already. This routine must be called before making
3983** changes to a page.
3984**
3985** The first time this routine is called, the pager creates a new
drha6abd042004-06-09 17:37:22 +00003986** journal and acquires a RESERVED lock on the database. If the RESERVED
drhed7c8552001-04-11 14:29:21 +00003987** lock could not be acquired, this routine returns SQLITE_BUSY. The
drh306dc212001-05-21 13:45:10 +00003988** calling routine must check for that return value and be careful not to
drhed7c8552001-04-11 14:29:21 +00003989** change any page data until this routine returns SQLITE_OK.
drhd9b02572001-04-15 00:37:09 +00003990**
3991** If the journal file could not be written because the disk is full,
3992** then this routine returns SQLITE_FULL and does an immediate rollback.
3993** All subsequent write attempts also return SQLITE_FULL until there
danielk19773b8a05f2007-03-19 17:44:26 +00003994** is a call to sqlite3PagerCommit() or sqlite3PagerRollback() to
drhd9b02572001-04-15 00:37:09 +00003995** reset.
drhed7c8552001-04-11 14:29:21 +00003996*/
danielk19773b8a05f2007-03-19 17:44:26 +00003997static int pager_write(PgHdr *pPg){
3998 void *pData = PGHDR_TO_DATA(pPg);
drh69688d52001-04-14 16:38:23 +00003999 Pager *pPager = pPg->pPager;
drhd79caeb2001-04-15 02:27:24 +00004000 int rc = SQLITE_OK;
drh69688d52001-04-14 16:38:23 +00004001
drh6446c4d2001-12-15 14:22:18 +00004002 /* Check for errors
4003 */
danielk1977efaaf572006-01-16 11:29:19 +00004004 if( pPager->errCode ){
4005 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00004006 }
drh5e00f6c2001-09-13 13:46:56 +00004007 if( pPager->readOnly ){
4008 return SQLITE_PERM;
4009 }
drh6446c4d2001-12-15 14:22:18 +00004010
danielk197776572402004-06-25 02:38:54 +00004011 assert( !pPager->setMaster );
4012
danielk19773c407372005-02-15 02:54:14 +00004013 CHECK_PAGE(pPg);
4014
drh538f5702007-04-13 02:14:30 +00004015 /* If this page was previously acquired with noContent==1, that means
4016 ** we didn't really read in the content of the page. This can happen
4017 ** (for example) when the page is being moved to the freelist. But
4018 ** now we are (perhaps) moving the page off of the freelist for
4019 ** reuse and we need to know its original content so that content
4020 ** can be stored in the rollback journal. So do the read at this
4021 ** time.
4022 */
drhd33d5a82007-04-26 12:11:28 +00004023 rc = pager_get_content(pPg);
4024 if( rc ){
4025 return rc;
drh538f5702007-04-13 02:14:30 +00004026 }
4027
drh6446c4d2001-12-15 14:22:18 +00004028 /* Mark the page as dirty. If the page has already been written
4029 ** to the journal then we can return right away.
4030 */
drh605ad8f2006-05-03 23:34:05 +00004031 makeDirty(pPg);
danielk1977f35843b2007-04-07 15:03:17 +00004032 if( pPg->inJournal && (pageInStatement(pPg) || pPager->stmtInUse==0) ){
drha6abd042004-06-09 17:37:22 +00004033 pPager->dirtyCache = 1;
danielk1977a0bf2652004-11-04 14:30:04 +00004034 }else{
drh6446c4d2001-12-15 14:22:18 +00004035
danielk1977a0bf2652004-11-04 14:30:04 +00004036 /* If we get this far, it means that the page needs to be
4037 ** written to the transaction journal or the ckeckpoint journal
4038 ** or both.
4039 **
4040 ** First check to see that the transaction journal exists and
4041 ** create it if it does not.
4042 */
4043 assert( pPager->state!=PAGER_UNLOCK );
danielk19773b8a05f2007-03-19 17:44:26 +00004044 rc = sqlite3PagerBegin(pPg, 0);
danielk1977a0bf2652004-11-04 14:30:04 +00004045 if( rc!=SQLITE_OK ){
4046 return rc;
4047 }
4048 assert( pPager->state>=PAGER_RESERVED );
4049 if( !pPager->journalOpen && pPager->useJournal ){
4050 rc = pager_open_journal(pPager);
4051 if( rc!=SQLITE_OK ) return rc;
4052 }
4053 assert( pPager->journalOpen || !pPager->useJournal );
4054 pPager->dirtyCache = 1;
4055
4056 /* The transaction journal now exists and we have a RESERVED or an
4057 ** EXCLUSIVE lock on the main database file. Write the current page to
4058 ** the transaction journal if it is not there already.
4059 */
4060 if( !pPg->inJournal && (pPager->useJournal || MEMDB) ){
4061 if( (int)pPg->pgno <= pPager->origDbSize ){
danielk1977a0bf2652004-11-04 14:30:04 +00004062 if( MEMDB ){
4063 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
drh4f0c5872007-03-26 22:05:01 +00004064 PAGERTRACE3("JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk1977a0bf2652004-11-04 14:30:04 +00004065 assert( pHist->pOrig==0 );
drh17435752007-08-16 04:30:38 +00004066 pHist->pOrig = sqlite3_malloc( pPager->pageSize );
danielk1977662278e2007-11-05 15:30:12 +00004067 if( !pHist->pOrig ){
4068 return SQLITE_NOMEM;
danielk1977a0bf2652004-11-04 14:30:04 +00004069 }
danielk1977662278e2007-11-05 15:30:12 +00004070 memcpy(pHist->pOrig, PGHDR_TO_DATA(pPg), pPager->pageSize);
danielk1977a0bf2652004-11-04 14:30:04 +00004071 }else{
drhbf4bca52007-09-06 22:19:14 +00004072 u32 cksum;
4073 char *pData2;
danielk1977dd97a492007-08-22 18:54:32 +00004074
drh267cb322005-09-16 17:16:52 +00004075 /* We should never write to the journal file the page that
4076 ** contains the database locks. The following assert verifies
4077 ** that we do not. */
4078 assert( pPg->pgno!=PAGER_MJ_PGNO(pPager) );
drhc001c582006-03-06 18:23:16 +00004079 pData2 = CODEC2(pPager, pData, pPg->pgno, 7);
drh37527852006-03-16 16:19:56 +00004080 cksum = pager_cksum(pPager, (u8*)pData2);
drhbf4bca52007-09-06 22:19:14 +00004081 rc = write32bits(pPager->jfd, pPager->journalOff, pPg->pgno);
4082 if( rc==SQLITE_OK ){
4083 rc = sqlite3OsWrite(pPager->jfd, pData2, pPager->pageSize,
4084 pPager->journalOff + 4);
4085 pPager->journalOff += pPager->pageSize+4;
4086 }
4087 if( rc==SQLITE_OK ){
4088 rc = write32bits(pPager->jfd, pPager->journalOff, cksum);
4089 pPager->journalOff += 4;
4090 }
4091 IOTRACE(("JOUT %p %d %lld %d\n", pPager, pPg->pgno,
danielk1977667a6c92007-09-10 06:12:04 +00004092 pPager->journalOff, pPager->pageSize));
drh538f5702007-04-13 02:14:30 +00004093 PAGER_INCR(sqlite3_pager_writej_count);
drh477731b2007-06-16 03:06:27 +00004094 PAGERTRACE5("JOURNAL %d page %d needSync=%d hash(%08x)\n",
4095 PAGERID(pPager), pPg->pgno, pPg->needSync, pager_pagehash(pPg));
danielk197707cb5602006-01-20 10:55:05 +00004096
drhfd131da2007-08-07 17:13:03 +00004097 /* An error has occured writing to the journal file. The
danielk197707cb5602006-01-20 10:55:05 +00004098 ** transaction will be rolled back by the layer above.
4099 */
danielk1977a0bf2652004-11-04 14:30:04 +00004100 if( rc!=SQLITE_OK ){
danielk1977a0bf2652004-11-04 14:30:04 +00004101 return rc;
4102 }
danielk197707cb5602006-01-20 10:55:05 +00004103
danielk1977a0bf2652004-11-04 14:30:04 +00004104 pPager->nRec++;
4105 assert( pPager->aInJournal!=0 );
4106 pPager->aInJournal[pPg->pgno/8] |= 1<<(pPg->pgno&7);
4107 pPg->needSync = !pPager->noSync;
4108 if( pPager->stmtInUse ){
4109 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
danielk1977a0bf2652004-11-04 14:30:04 +00004110 }
drhac69b052004-05-12 13:30:07 +00004111 }
danielk197713adf8a2004-06-03 16:08:41 +00004112 }else{
danielk1977a0bf2652004-11-04 14:30:04 +00004113 pPg->needSync = !pPager->journalStarted && !pPager->noSync;
drh4f0c5872007-03-26 22:05:01 +00004114 PAGERTRACE4("APPEND %d page %d needSync=%d\n",
danielk1977ef73ee92004-11-06 12:26:07 +00004115 PAGERID(pPager), pPg->pgno, pPg->needSync);
danielk1977a0bf2652004-11-04 14:30:04 +00004116 }
4117 if( pPg->needSync ){
4118 pPager->needSync = 1;
4119 }
4120 pPg->inJournal = 1;
4121 }
4122
4123 /* If the statement journal is open and the page is not in it,
4124 ** then write the current page to the statement journal. Note that
4125 ** the statement journal format differs from the standard journal format
4126 ** in that it omits the checksums and the header.
4127 */
danielk1977f35843b2007-04-07 15:03:17 +00004128 if( pPager->stmtInUse
4129 && !pageInStatement(pPg)
4130 && (int)pPg->pgno<=pPager->stmtSize
4131 ){
danielk1977a0bf2652004-11-04 14:30:04 +00004132 assert( pPg->inJournal || (int)pPg->pgno>pPager->origDbSize );
4133 if( MEMDB ){
4134 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
4135 assert( pHist->pStmt==0 );
drh17435752007-08-16 04:30:38 +00004136 pHist->pStmt = sqlite3_malloc( pPager->pageSize );
danielk1977a0bf2652004-11-04 14:30:04 +00004137 if( pHist->pStmt ){
4138 memcpy(pHist->pStmt, PGHDR_TO_DATA(pPg), pPager->pageSize);
4139 }
drh4f0c5872007-03-26 22:05:01 +00004140 PAGERTRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
danielk1977f35843b2007-04-07 15:03:17 +00004141 page_add_to_stmt_list(pPg);
danielk1977a0bf2652004-11-04 14:30:04 +00004142 }else{
danielk197762079062007-08-15 17:08:46 +00004143 i64 offset = pPager->stmtNRec*(4+pPager->pageSize);
drhbf4bca52007-09-06 22:19:14 +00004144 char *pData2 = CODEC2(pPager, pData, pPg->pgno, 7);
4145 rc = write32bits(pPager->stfd, offset, pPg->pgno);
4146 if( rc==SQLITE_OK ){
4147 rc = sqlite3OsWrite(pPager->stfd, pData2, pPager->pageSize, offset+4);
4148 }
drh4f0c5872007-03-26 22:05:01 +00004149 PAGERTRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno);
drhac69b052004-05-12 13:30:07 +00004150 if( rc!=SQLITE_OK ){
drhac69b052004-05-12 13:30:07 +00004151 return rc;
4152 }
danielk1977a0bf2652004-11-04 14:30:04 +00004153 pPager->stmtNRec++;
4154 assert( pPager->aInStmt!=0 );
4155 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drhdb48ee02003-01-16 13:42:43 +00004156 }
drhd9b02572001-04-15 00:37:09 +00004157 }
drhfa86c412002-02-02 15:01:15 +00004158 }
4159
4160 /* Update the database size and return.
4161 */
drh1aa2d8b2007-01-03 15:34:29 +00004162 assert( pPager->state>=PAGER_SHARED );
drh1ab43002002-01-14 09:28:19 +00004163 if( pPager->dbSize<(int)pPg->pgno ){
drh306dc212001-05-21 13:45:10 +00004164 pPager->dbSize = pPg->pgno;
drhb7f91642004-10-31 02:22:47 +00004165 if( !MEMDB && pPager->dbSize==PENDING_BYTE/pPager->pageSize ){
drh1f595712004-06-15 01:40:29 +00004166 pPager->dbSize++;
4167 }
drh306dc212001-05-21 13:45:10 +00004168 }
drh69688d52001-04-14 16:38:23 +00004169 return rc;
drhed7c8552001-04-11 14:29:21 +00004170}
4171
4172/*
danielk19774099f6e2007-03-19 11:25:20 +00004173** This function is used to mark a data-page as writable. It uses
4174** pager_write() to open a journal file (if it is not already open)
4175** and write the page *pData to the journal.
4176**
4177** The difference between this function and pager_write() is that this
4178** function also deals with the special case where 2 or more pages
4179** fit on a single disk sector. In this case all co-resident pages
4180** must have been written to the journal file before returning.
4181*/
danielk19773b8a05f2007-03-19 17:44:26 +00004182int sqlite3PagerWrite(DbPage *pDbPage){
danielk19774099f6e2007-03-19 11:25:20 +00004183 int rc = SQLITE_OK;
4184
danielk19773b8a05f2007-03-19 17:44:26 +00004185 PgHdr *pPg = pDbPage;
danielk19774099f6e2007-03-19 11:25:20 +00004186 Pager *pPager = pPg->pPager;
4187 Pgno nPagePerSector = (pPager->sectorSize/pPager->pageSize);
4188
drh86f8c192007-08-22 00:39:19 +00004189 pagerEnter(pPager);
danielk19774099f6e2007-03-19 11:25:20 +00004190 if( !MEMDB && nPagePerSector>1 ){
4191 Pgno nPageCount; /* Total number of pages in database file */
4192 Pgno pg1; /* First page of the sector pPg is located on. */
4193 int nPage; /* Number of pages starting at pg1 to journal */
4194 int ii;
danielk1977dd97a492007-08-22 18:54:32 +00004195 int needSync = 0;
danielk19774099f6e2007-03-19 11:25:20 +00004196
4197 /* Set the doNotSync flag to 1. This is because we cannot allow a journal
4198 ** header to be written between the pages journaled by this function.
4199 */
4200 assert( pPager->doNotSync==0 );
4201 pPager->doNotSync = 1;
4202
4203 /* This trick assumes that both the page-size and sector-size are
4204 ** an integer power of 2. It sets variable pg1 to the identifier
4205 ** of the first page of the sector pPg is located on.
4206 */
4207 pg1 = ((pPg->pgno-1) & ~(nPagePerSector-1)) + 1;
4208
danielk19773b8a05f2007-03-19 17:44:26 +00004209 nPageCount = sqlite3PagerPagecount(pPager);
danielk19774099f6e2007-03-19 11:25:20 +00004210 if( pPg->pgno>nPageCount ){
4211 nPage = (pPg->pgno - pg1)+1;
4212 }else if( (pg1+nPagePerSector-1)>nPageCount ){
4213 nPage = nPageCount+1-pg1;
4214 }else{
4215 nPage = nPagePerSector;
4216 }
4217 assert(nPage>0);
4218 assert(pg1<=pPg->pgno);
4219 assert((pg1+nPage)>pPg->pgno);
4220
4221 for(ii=0; ii<nPage && rc==SQLITE_OK; ii++){
4222 Pgno pg = pg1+ii;
danielk1977dd97a492007-08-22 18:54:32 +00004223 PgHdr *pPage;
danielk19774099f6e2007-03-19 11:25:20 +00004224 if( !pPager->aInJournal || pg==pPg->pgno ||
4225 pg>pPager->origDbSize || !(pPager->aInJournal[pg/8]&(1<<(pg&7)))
4226 ) {
4227 if( pg!=PAGER_MJ_PGNO(pPager) ){
danielk19773b8a05f2007-03-19 17:44:26 +00004228 rc = sqlite3PagerGet(pPager, pg, &pPage);
danielk19774099f6e2007-03-19 11:25:20 +00004229 if( rc==SQLITE_OK ){
4230 rc = pager_write(pPage);
danielk1977dd97a492007-08-22 18:54:32 +00004231 if( pPage->needSync ){
4232 needSync = 1;
4233 }
danielk19773b8a05f2007-03-19 17:44:26 +00004234 sqlite3PagerUnref(pPage);
danielk19774099f6e2007-03-19 11:25:20 +00004235 }
4236 }
danielk1977dd97a492007-08-22 18:54:32 +00004237 }else if( (pPage = pager_lookup(pPager, pg)) ){
4238 if( pPage->needSync ){
4239 needSync = 1;
4240 }
danielk19774099f6e2007-03-19 11:25:20 +00004241 }
4242 }
4243
danielk1977dd97a492007-08-22 18:54:32 +00004244 /* If the PgHdr.needSync flag is set for any of the nPage pages
4245 ** starting at pg1, then it needs to be set for all of them. Because
4246 ** writing to any of these nPage pages may damage the others, the
4247 ** journal file must contain sync()ed copies of all of them
4248 ** before any of them can be written out to the database file.
4249 */
4250 if( needSync ){
4251 for(ii=0; ii<nPage && needSync; ii++){
4252 PgHdr *pPage = pager_lookup(pPager, pg1+ii);
4253 if( pPage ) pPage->needSync = 1;
4254 }
4255 assert(pPager->needSync);
4256 }
4257
danielk19774099f6e2007-03-19 11:25:20 +00004258 assert( pPager->doNotSync==1 );
4259 pPager->doNotSync = 0;
4260 }else{
danielk19773b8a05f2007-03-19 17:44:26 +00004261 rc = pager_write(pDbPage);
danielk19774099f6e2007-03-19 11:25:20 +00004262 }
drh86f8c192007-08-22 00:39:19 +00004263 pagerLeave(pPager);
danielk19774099f6e2007-03-19 11:25:20 +00004264 return rc;
4265}
4266
4267/*
drhaacc5432002-01-06 17:07:40 +00004268** Return TRUE if the page given in the argument was previously passed
danielk19773b8a05f2007-03-19 17:44:26 +00004269** to sqlite3PagerWrite(). In other words, return TRUE if it is ok
drh6019e162001-07-02 17:51:45 +00004270** to change the content of the page.
4271*/
danielk19777d3a6662006-01-23 16:21:05 +00004272#ifndef NDEBUG
danielk19773b8a05f2007-03-19 17:44:26 +00004273int sqlite3PagerIswriteable(DbPage *pPg){
drh6019e162001-07-02 17:51:45 +00004274 return pPg->dirty;
4275}
danielk19777d3a6662006-01-23 16:21:05 +00004276#endif
drh6019e162001-07-02 17:51:45 +00004277
danielk1977b84f96f2005-01-20 11:32:23 +00004278#ifndef SQLITE_OMIT_VACUUM
drh6019e162001-07-02 17:51:45 +00004279/*
drh001bbcb2003-03-19 03:14:00 +00004280** Replace the content of a single page with the information in the third
4281** argument.
4282*/
danielk19773b8a05f2007-03-19 17:44:26 +00004283int sqlite3PagerOverwrite(Pager *pPager, Pgno pgno, void *pData){
4284 PgHdr *pPg;
drh001bbcb2003-03-19 03:14:00 +00004285 int rc;
4286
drh86f8c192007-08-22 00:39:19 +00004287 pagerEnter(pPager);
danielk19773b8a05f2007-03-19 17:44:26 +00004288 rc = sqlite3PagerGet(pPager, pgno, &pPg);
drh001bbcb2003-03-19 03:14:00 +00004289 if( rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00004290 rc = sqlite3PagerWrite(pPg);
drh001bbcb2003-03-19 03:14:00 +00004291 if( rc==SQLITE_OK ){
danielk19773b8a05f2007-03-19 17:44:26 +00004292 memcpy(sqlite3PagerGetData(pPg), pData, pPager->pageSize);
drh001bbcb2003-03-19 03:14:00 +00004293 }
danielk19773b8a05f2007-03-19 17:44:26 +00004294 sqlite3PagerUnref(pPg);
drh001bbcb2003-03-19 03:14:00 +00004295 }
drh86f8c192007-08-22 00:39:19 +00004296 pagerLeave(pPager);
drh001bbcb2003-03-19 03:14:00 +00004297 return rc;
4298}
danielk1977b84f96f2005-01-20 11:32:23 +00004299#endif
drh001bbcb2003-03-19 03:14:00 +00004300
4301/*
drh30e58752002-03-02 20:41:57 +00004302** A call to this routine tells the pager that it is not necessary to
drh538f5702007-04-13 02:14:30 +00004303** write the information on page pPg back to the disk, even though
drh30e58752002-03-02 20:41:57 +00004304** that page might be marked as dirty.
4305**
4306** The overlying software layer calls this routine when all of the data
4307** on the given page is unused. The pager marks the page as clean so
4308** that it does not get written to disk.
4309**
4310** Tests show that this optimization, together with the
danielk19773b8a05f2007-03-19 17:44:26 +00004311** sqlite3PagerDontRollback() below, more than double the speed
drh30e58752002-03-02 20:41:57 +00004312** of large INSERT operations and quadruple the speed of large DELETEs.
drh8e298f92002-07-06 16:28:47 +00004313**
4314** When this routine is called, set the alwaysRollback flag to true.
danielk19773b8a05f2007-03-19 17:44:26 +00004315** Subsequent calls to sqlite3PagerDontRollback() for the same page
drh8e298f92002-07-06 16:28:47 +00004316** will thereafter be ignored. This is necessary to avoid a problem
4317** where a page with data is added to the freelist during one part of
4318** a transaction then removed from the freelist during a later part
4319** of the same transaction and reused for some other purpose. When it
4320** is first added to the freelist, this routine is called. When reused,
drh80e35f42007-03-30 14:06:34 +00004321** the sqlite3PagerDontRollback() routine is called. But because the
4322** page contains critical data, we still need to be sure it gets
4323** rolled back in spite of the sqlite3PagerDontRollback() call.
drh30e58752002-03-02 20:41:57 +00004324*/
drh538f5702007-04-13 02:14:30 +00004325void sqlite3PagerDontWrite(DbPage *pDbPage){
4326 PgHdr *pPg = pDbPage;
4327 Pager *pPager = pPg->pPager;
drh8e298f92002-07-06 16:28:47 +00004328
drhb7f91642004-10-31 02:22:47 +00004329 if( MEMDB ) return;
drh86f8c192007-08-22 00:39:19 +00004330 pagerEnter(pPager);
drh8e298f92002-07-06 16:28:47 +00004331 pPg->alwaysRollback = 1;
drh43617e92006-03-06 20:55:46 +00004332 if( pPg->dirty && !pPager->stmtInUse ){
drh1aa2d8b2007-01-03 15:34:29 +00004333 assert( pPager->state>=PAGER_SHARED );
drh8124a302002-06-25 14:43:57 +00004334 if( pPager->dbSize==(int)pPg->pgno && pPager->origDbSize<pPager->dbSize ){
4335 /* If this pages is the last page in the file and the file has grown
4336 ** during the current transaction, then do NOT mark the page as clean.
4337 ** When the database file grows, we must make sure that the last page
4338 ** gets written at least once so that the disk file will be the correct
4339 ** size. If you do not write this page and the size of the file
4340 ** on the disk ends up being too small, that can lead to database
4341 ** corruption during the next transaction.
4342 */
4343 }else{
drh538f5702007-04-13 02:14:30 +00004344 PAGERTRACE3("DONT_WRITE page %d of %d\n", pPg->pgno, PAGERID(pPager));
4345 IOTRACE(("CLEAN %p %d\n", pPager, pPg->pgno))
drh605ad8f2006-05-03 23:34:05 +00004346 makeClean(pPg);
danielk19773c407372005-02-15 02:54:14 +00004347#ifdef SQLITE_CHECK_PAGES
4348 pPg->pageHash = pager_pagehash(pPg);
4349#endif
drh8124a302002-06-25 14:43:57 +00004350 }
drh30e58752002-03-02 20:41:57 +00004351 }
drh86f8c192007-08-22 00:39:19 +00004352 pagerLeave(pPager);
drh30e58752002-03-02 20:41:57 +00004353}
4354
4355/*
4356** A call to this routine tells the pager that if a rollback occurs,
4357** it is not necessary to restore the data on the given page. This
4358** means that the pager does not have to record the given page in the
4359** rollback journal.
drh538f5702007-04-13 02:14:30 +00004360**
4361** If we have not yet actually read the content of this page (if
4362** the PgHdr.needRead flag is set) then this routine acts as a promise
4363** that we will never need to read the page content in the future.
4364** so the needRead flag can be cleared at this point.
drh30e58752002-03-02 20:41:57 +00004365*/
danielk19773b8a05f2007-03-19 17:44:26 +00004366void sqlite3PagerDontRollback(DbPage *pPg){
drh30e58752002-03-02 20:41:57 +00004367 Pager *pPager = pPg->pPager;
4368
drh86f8c192007-08-22 00:39:19 +00004369 pagerEnter(pPager);
drhd3627af2006-12-18 18:34:51 +00004370 assert( pPager->state>=PAGER_RESERVED );
4371 if( pPager->journalOpen==0 ) return;
drhb7f91642004-10-31 02:22:47 +00004372 if( pPg->alwaysRollback || pPager->alwaysRollback || MEMDB ) return;
drh30e58752002-03-02 20:41:57 +00004373 if( !pPg->inJournal && (int)pPg->pgno <= pPager->origDbSize ){
4374 assert( pPager->aInJournal!=0 );
4375 pPager->aInJournal[pPg->pgno/8] |= 1<<(pPg->pgno&7);
4376 pPg->inJournal = 1;
drh538f5702007-04-13 02:14:30 +00004377 pPg->needRead = 0;
drhac69b052004-05-12 13:30:07 +00004378 if( pPager->stmtInUse ){
4379 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drh30e58752002-03-02 20:41:57 +00004380 }
drh4f0c5872007-03-26 22:05:01 +00004381 PAGERTRACE3("DONT_ROLLBACK page %d of %d\n", pPg->pgno, PAGERID(pPager));
drhb0603412007-02-28 04:47:26 +00004382 IOTRACE(("GARBAGE %p %d\n", pPager, pPg->pgno))
drh30e58752002-03-02 20:41:57 +00004383 }
danielk1977f35843b2007-04-07 15:03:17 +00004384 if( pPager->stmtInUse
4385 && !pageInStatement(pPg)
4386 && (int)pPg->pgno<=pPager->stmtSize
4387 ){
drh30e58752002-03-02 20:41:57 +00004388 assert( pPg->inJournal || (int)pPg->pgno>pPager->origDbSize );
drhac69b052004-05-12 13:30:07 +00004389 assert( pPager->aInStmt!=0 );
4390 pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7);
drh30e58752002-03-02 20:41:57 +00004391 }
drh86f8c192007-08-22 00:39:19 +00004392 pagerLeave(pPager);
drh30e58752002-03-02 20:41:57 +00004393}
4394
drhac69b052004-05-12 13:30:07 +00004395
drh30e58752002-03-02 20:41:57 +00004396/*
drh80e35f42007-03-30 14:06:34 +00004397** This routine is called to increment the database file change-counter,
4398** stored at byte 24 of the pager file.
4399*/
danielk1977c7b60172007-08-22 11:22:03 +00004400static int pager_incr_changecounter(Pager *pPager, int isDirect){
drh80e35f42007-03-30 14:06:34 +00004401 PgHdr *pPgHdr;
4402 u32 change_counter;
danielk1977c7b60172007-08-22 11:22:03 +00004403 int rc = SQLITE_OK;
drh80e35f42007-03-30 14:06:34 +00004404
4405 if( !pPager->changeCountDone ){
4406 /* Open page 1 of the file for writing. */
4407 rc = sqlite3PagerGet(pPager, 1, &pPgHdr);
4408 if( rc!=SQLITE_OK ) return rc;
danielk1977c7b60172007-08-22 11:22:03 +00004409
4410 if( !isDirect ){
4411 rc = sqlite3PagerWrite(pPgHdr);
danielk1977ae72d982007-10-03 08:46:44 +00004412 if( rc!=SQLITE_OK ){
4413 sqlite3PagerUnref(pPgHdr);
4414 return rc;
4415 }
danielk1977c7b60172007-08-22 11:22:03 +00004416 }
4417
drh80e35f42007-03-30 14:06:34 +00004418 /* Increment the value just read and write it back to byte 24. */
drhb1003912007-07-20 00:33:36 +00004419 change_counter = sqlite3Get4byte((u8*)pPager->dbFileVers);
drh80e35f42007-03-30 14:06:34 +00004420 change_counter++;
4421 put32bits(((char*)PGHDR_TO_DATA(pPgHdr))+24, change_counter);
danielk1977c7b60172007-08-22 11:22:03 +00004422
4423 if( isDirect && pPager->fd->pMethods ){
4424 const void *zBuf = PGHDR_TO_DATA(pPgHdr);
4425 rc = sqlite3OsWrite(pPager->fd, zBuf, pPager->pageSize, 0);
4426 }
4427
drh80e35f42007-03-30 14:06:34 +00004428 /* Release the page reference. */
4429 sqlite3PagerUnref(pPgHdr);
4430 pPager->changeCountDone = 1;
4431 }
danielk1977c7b60172007-08-22 11:22:03 +00004432 return rc;
drh80e35f42007-03-30 14:06:34 +00004433}
4434
4435/*
4436** Sync the database file for the pager pPager. zMaster points to the name
4437** of a master journal file that should be written into the individual
4438** journal file. zMaster may be NULL, which is interpreted as no master
4439** journal (a single database transaction).
4440**
4441** This routine ensures that the journal is synced, all dirty pages written
4442** to the database file and the database file synced. The only thing that
4443** remains to commit the transaction is to delete the journal file (or
4444** master journal file if specified).
4445**
4446** Note that if zMaster==NULL, this does not overwrite a previous value
4447** passed to an sqlite3PagerCommitPhaseOne() call.
4448**
4449** If parameter nTrunc is non-zero, then the pager file is truncated to
4450** nTrunc pages (this is used by auto-vacuum databases).
4451*/
4452int sqlite3PagerCommitPhaseOne(Pager *pPager, const char *zMaster, Pgno nTrunc){
4453 int rc = SQLITE_OK;
4454
4455 PAGERTRACE4("DATABASE SYNC: File=%s zMaster=%s nTrunc=%d\n",
4456 pPager->zFilename, zMaster, nTrunc);
drh86f8c192007-08-22 00:39:19 +00004457 pagerEnter(pPager);
drh80e35f42007-03-30 14:06:34 +00004458
4459 /* If this is an in-memory db, or no pages have been written to, or this
4460 ** function has already been called, it is a no-op.
4461 */
4462 if( pPager->state!=PAGER_SYNCED && !MEMDB && pPager->dirtyCache ){
4463 PgHdr *pPg;
drh80e35f42007-03-30 14:06:34 +00004464
danielk1977c7b60172007-08-22 11:22:03 +00004465#ifdef SQLITE_ENABLE_ATOMIC_WRITE
4466 /* The atomic-write optimization can be used if all of the
4467 ** following are true:
4468 **
4469 ** + The file-system supports the atomic-write property for
4470 ** blocks of size page-size, and
4471 ** + This commit is not part of a multi-file transaction, and
4472 ** + Exactly one page has been modified and store in the journal file.
4473 **
4474 ** If the optimization can be used, then the journal file will never
4475 ** be created for this transaction.
4476 */
danielk1977f55b8992007-08-24 08:15:53 +00004477 int useAtomicWrite = (
4478 !zMaster &&
4479 pPager->journalOff==jrnlBufferSize(pPager) &&
4480 nTrunc==0 &&
4481 (0==pPager->pDirty || 0==pPager->pDirty->pDirty)
4482 );
4483 if( useAtomicWrite ){
danielk1977c7b60172007-08-22 11:22:03 +00004484 /* Update the nRec field in the journal file. */
4485 int offset = pPager->journalHdr + sizeof(aJournalMagic);
4486 assert(pPager->nRec==1);
4487 rc = write32bits(pPager->jfd, offset, pPager->nRec);
4488
4489 /* Update the db file change counter. The following call will modify
4490 ** the in-memory representation of page 1 to include the updated
4491 ** change counter and then write page 1 directly to the database
4492 ** file. Because of the atomic-write property of the host file-system,
4493 ** this is safe.
4494 */
danielk1977ae72d982007-10-03 08:46:44 +00004495 if( rc==SQLITE_OK ){
4496 rc = pager_incr_changecounter(pPager, 1);
4497 }
danielk1977f55b8992007-08-24 08:15:53 +00004498 }else{
4499 rc = sqlite3JournalCreate(pPager->jfd);
danielk1977f55b8992007-08-24 08:15:53 +00004500 }
4501
danielk1977ae72d982007-10-03 08:46:44 +00004502 if( !useAtomicWrite && rc==SQLITE_OK )
danielk1977c7b60172007-08-22 11:22:03 +00004503#endif
4504
drh80e35f42007-03-30 14:06:34 +00004505 /* If a master journal file name has already been written to the
4506 ** journal file, then no sync is required. This happens when it is
4507 ** written, then the process fails to upgrade from a RESERVED to an
4508 ** EXCLUSIVE lock. The next time the process tries to commit the
4509 ** transaction the m-j name will have already been written.
4510 */
4511 if( !pPager->setMaster ){
danielk1977f55b8992007-08-24 08:15:53 +00004512 assert( pPager->journalOpen );
danielk1977c7b60172007-08-22 11:22:03 +00004513 rc = pager_incr_changecounter(pPager, 0);
drh80e35f42007-03-30 14:06:34 +00004514 if( rc!=SQLITE_OK ) goto sync_exit;
4515#ifndef SQLITE_OMIT_AUTOVACUUM
4516 if( nTrunc!=0 ){
4517 /* If this transaction has made the database smaller, then all pages
4518 ** being discarded by the truncation must be written to the journal
4519 ** file.
4520 */
4521 Pgno i;
4522 int iSkip = PAGER_MJ_PGNO(pPager);
4523 for( i=nTrunc+1; i<=pPager->origDbSize; i++ ){
4524 if( !(pPager->aInJournal[i/8] & (1<<(i&7))) && i!=iSkip ){
4525 rc = sqlite3PagerGet(pPager, i, &pPg);
4526 if( rc!=SQLITE_OK ) goto sync_exit;
4527 rc = sqlite3PagerWrite(pPg);
4528 sqlite3PagerUnref(pPg);
4529 if( rc!=SQLITE_OK ) goto sync_exit;
4530 }
4531 }
4532 }
4533#endif
4534 rc = writeMasterJournal(pPager, zMaster);
4535 if( rc!=SQLITE_OK ) goto sync_exit;
4536 rc = syncJournal(pPager);
drh80e35f42007-03-30 14:06:34 +00004537 }
danielk1977c7b60172007-08-22 11:22:03 +00004538 if( rc!=SQLITE_OK ) goto sync_exit;
drh80e35f42007-03-30 14:06:34 +00004539
4540#ifndef SQLITE_OMIT_AUTOVACUUM
4541 if( nTrunc!=0 ){
4542 rc = sqlite3PagerTruncate(pPager, nTrunc);
4543 if( rc!=SQLITE_OK ) goto sync_exit;
4544 }
4545#endif
4546
4547 /* Write all dirty pages to the database file */
4548 pPg = pager_get_all_dirty_pages(pPager);
4549 rc = pager_write_pagelist(pPg);
drh153c62c2007-08-24 03:51:33 +00004550 if( rc!=SQLITE_OK ){
4551 while( pPg && !pPg->dirty ){ pPg = pPg->pDirty; }
4552 pPager->pDirty = pPg;
4553 goto sync_exit;
4554 }
drh3cdd7d32007-03-30 14:46:01 +00004555 pPager->pDirty = 0;
drh80e35f42007-03-30 14:06:34 +00004556
4557 /* Sync the database file. */
drh1cc8c442007-08-24 16:08:29 +00004558 if( !pPager->noSync ){
danielk1977f036aef2007-08-20 05:36:51 +00004559 rc = sqlite3OsSync(pPager->fd, pPager->sync_flags);
drh80e35f42007-03-30 14:06:34 +00004560 }
4561 IOTRACE(("DBSYNC %p\n", pPager))
4562
4563 pPager->state = PAGER_SYNCED;
4564 }else if( MEMDB && nTrunc!=0 ){
4565 rc = sqlite3PagerTruncate(pPager, nTrunc);
4566 }
4567
4568sync_exit:
danielk1977e965ac72007-06-13 15:22:28 +00004569 if( rc==SQLITE_IOERR_BLOCKED ){
4570 /* pager_incr_changecounter() may attempt to obtain an exclusive
4571 * lock to spill the cache and return IOERR_BLOCKED. But since
4572 * there is no chance the cache is inconsistent, it's
4573 * better to return SQLITE_BUSY.
4574 */
4575 rc = SQLITE_BUSY;
4576 }
drh86f8c192007-08-22 00:39:19 +00004577 pagerLeave(pPager);
drh80e35f42007-03-30 14:06:34 +00004578 return rc;
4579}
4580
4581
4582/*
drhed7c8552001-04-11 14:29:21 +00004583** Commit all changes to the database and release the write lock.
drhd9b02572001-04-15 00:37:09 +00004584**
4585** If the commit fails for any reason, a rollback attempt is made
4586** and an error code is returned. If the commit worked, SQLITE_OK
4587** is returned.
drhed7c8552001-04-11 14:29:21 +00004588*/
drh80e35f42007-03-30 14:06:34 +00004589int sqlite3PagerCommitPhaseTwo(Pager *pPager){
drha1b351a2001-09-14 16:42:12 +00004590 int rc;
drhed7c8552001-04-11 14:29:21 +00004591 PgHdr *pPg;
drhd9b02572001-04-15 00:37:09 +00004592
danielk1977efaaf572006-01-16 11:29:19 +00004593 if( pPager->errCode ){
danielk19777f7bc662006-01-23 13:47:47 +00004594 return pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00004595 }
drha6abd042004-06-09 17:37:22 +00004596 if( pPager->state<PAGER_RESERVED ){
drhd9b02572001-04-15 00:37:09 +00004597 return SQLITE_ERROR;
4598 }
drh86f8c192007-08-22 00:39:19 +00004599 pagerEnter(pPager);
drh4f0c5872007-03-26 22:05:01 +00004600 PAGERTRACE2("COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004601 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004602 pPg = pager_get_all_dirty_pages(pPager);
4603 while( pPg ){
danielk1977f35843b2007-04-07 15:03:17 +00004604 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
4605 clearHistory(pHist);
drhac69b052004-05-12 13:30:07 +00004606 pPg->dirty = 0;
4607 pPg->inJournal = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004608 pHist->inStmt = 0;
drh5229ae42006-03-23 23:29:04 +00004609 pPg->needSync = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004610 pHist->pPrevStmt = pHist->pNextStmt = 0;
drhac69b052004-05-12 13:30:07 +00004611 pPg = pPg->pDirty;
4612 }
drh605ad8f2006-05-03 23:34:05 +00004613 pPager->pDirty = 0;
danielk1977eac7a362004-06-16 07:45:24 +00004614#ifndef NDEBUG
4615 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
4616 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
4617 assert( !pPg->alwaysRollback );
4618 assert( !pHist->pOrig );
4619 assert( !pHist->pStmt );
4620 }
4621#endif
drhac69b052004-05-12 13:30:07 +00004622 pPager->pStmt = 0;
drha6abd042004-06-09 17:37:22 +00004623 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00004624 return SQLITE_OK;
4625 }
drh3cdd7d32007-03-30 14:46:01 +00004626 assert( pPager->journalOpen || !pPager->dirtyCache );
4627 assert( pPager->state==PAGER_SYNCED || !pPager->dirtyCache );
4628 rc = pager_end_transaction(pPager);
drh86f8c192007-08-22 00:39:19 +00004629 rc = pager_error(pPager, rc);
4630 pagerLeave(pPager);
4631 return rc;
drhed7c8552001-04-11 14:29:21 +00004632}
4633
4634/*
drha6abd042004-06-09 17:37:22 +00004635** Rollback all changes. The database falls back to PAGER_SHARED mode.
drhed7c8552001-04-11 14:29:21 +00004636** All in-memory cache pages revert to their original data contents.
4637** The journal is deleted.
drhd9b02572001-04-15 00:37:09 +00004638**
4639** This routine cannot fail unless some other process is not following
drh4f0ee682007-03-30 20:43:40 +00004640** the correct locking protocol or unless some other
drhd9b02572001-04-15 00:37:09 +00004641** process is writing trash into the journal file (SQLITE_CORRUPT) or
4642** unless a prior malloc() failed (SQLITE_NOMEM). Appropriate error
4643** codes are returned for all these occasions. Otherwise,
4644** SQLITE_OK is returned.
drhed7c8552001-04-11 14:29:21 +00004645*/
danielk19773b8a05f2007-03-19 17:44:26 +00004646int sqlite3PagerRollback(Pager *pPager){
drhed7c8552001-04-11 14:29:21 +00004647 int rc;
drh4f0c5872007-03-26 22:05:01 +00004648 PAGERTRACE2("ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004649 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004650 PgHdr *p;
4651 for(p=pPager->pAll; p; p=p->pNextAll){
4652 PgHistory *pHist;
danielk1977eac7a362004-06-16 07:45:24 +00004653 assert( !p->alwaysRollback );
4654 if( !p->dirty ){
4655 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pOrig );
4656 assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pStmt );
4657 continue;
4658 }
4659
drhac69b052004-05-12 13:30:07 +00004660 pHist = PGHDR_TO_HIST(p, pPager);
4661 if( pHist->pOrig ){
4662 memcpy(PGHDR_TO_DATA(p), pHist->pOrig, pPager->pageSize);
drh4f0c5872007-03-26 22:05:01 +00004663 PAGERTRACE3("ROLLBACK-PAGE %d of %d\n", p->pgno, PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00004664 }else{
drh4f0c5872007-03-26 22:05:01 +00004665 PAGERTRACE3("PAGE %d is clean on %d\n", p->pgno, PAGERID(pPager));
drhac69b052004-05-12 13:30:07 +00004666 }
4667 clearHistory(pHist);
4668 p->dirty = 0;
4669 p->inJournal = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004670 pHist->inStmt = 0;
4671 pHist->pPrevStmt = pHist->pNextStmt = 0;
danielk1977369f27e2004-06-15 11:40:04 +00004672 if( pPager->xReiniter ){
danielk19773b8a05f2007-03-19 17:44:26 +00004673 pPager->xReiniter(p, pPager->pageSize);
danielk1977369f27e2004-06-15 11:40:04 +00004674 }
drhac69b052004-05-12 13:30:07 +00004675 }
drh605ad8f2006-05-03 23:34:05 +00004676 pPager->pDirty = 0;
drhac69b052004-05-12 13:30:07 +00004677 pPager->pStmt = 0;
4678 pPager->dbSize = pPager->origDbSize;
danielk1977e180dd92007-04-05 17:15:52 +00004679 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00004680 pPager->stmtInUse = 0;
drha6abd042004-06-09 17:37:22 +00004681 pPager->state = PAGER_SHARED;
drhac69b052004-05-12 13:30:07 +00004682 return SQLITE_OK;
4683 }
4684
drh86f8c192007-08-22 00:39:19 +00004685 pagerEnter(pPager);
drha6abd042004-06-09 17:37:22 +00004686 if( !pPager->dirtyCache || !pPager->journalOpen ){
drh80e35f42007-03-30 14:06:34 +00004687 rc = pager_end_transaction(pPager);
drh86f8c192007-08-22 00:39:19 +00004688 pagerLeave(pPager);
drhda47d772002-12-02 04:25:19 +00004689 return rc;
4690 }
drhdb48ee02003-01-16 13:42:43 +00004691
danielk1977efaaf572006-01-16 11:29:19 +00004692 if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){
drha6abd042004-06-09 17:37:22 +00004693 if( pPager->state>=PAGER_EXCLUSIVE ){
danielk1977e277be02007-03-23 18:12:06 +00004694 pager_playback(pPager, 0);
drh4b845d72002-03-05 12:41:19 +00004695 }
drh86f8c192007-08-22 00:39:19 +00004696 pagerLeave(pPager);
danielk1977efaaf572006-01-16 11:29:19 +00004697 return pPager->errCode;
drhed7c8552001-04-11 14:29:21 +00004698 }
drha6abd042004-06-09 17:37:22 +00004699 if( pPager->state==PAGER_RESERVED ){
danielk197717221812005-02-15 03:38:05 +00004700 int rc2;
danielk1977e277be02007-03-23 18:12:06 +00004701 rc = pager_playback(pPager, 0);
drh80e35f42007-03-30 14:06:34 +00004702 rc2 = pager_end_transaction(pPager);
drha6abd042004-06-09 17:37:22 +00004703 if( rc==SQLITE_OK ){
4704 rc = rc2;
4705 }
4706 }else{
danielk1977e277be02007-03-23 18:12:06 +00004707 rc = pager_playback(pPager, 0);
drhd9b02572001-04-15 00:37:09 +00004708 }
danielk1977e180dd92007-04-05 17:15:52 +00004709 /* pager_reset(pPager); */
drhd9b02572001-04-15 00:37:09 +00004710 pPager->dbSize = -1;
danielk197707cb5602006-01-20 10:55:05 +00004711
4712 /* If an error occurs during a ROLLBACK, we can no longer trust the pager
4713 ** cache. So call pager_error() on the way out to make any error
4714 ** persistent.
4715 */
drh86f8c192007-08-22 00:39:19 +00004716 rc = pager_error(pPager, rc);
4717 pagerLeave(pPager);
4718 return rc;
drh98808ba2001-10-18 12:34:46 +00004719}
drhd9b02572001-04-15 00:37:09 +00004720
4721/*
drh5e00f6c2001-09-13 13:46:56 +00004722** Return TRUE if the database file is opened read-only. Return FALSE
4723** if the database is (in theory) writable.
4724*/
danielk19773b8a05f2007-03-19 17:44:26 +00004725int sqlite3PagerIsreadonly(Pager *pPager){
drhbe0072d2001-09-13 14:46:09 +00004726 return pPager->readOnly;
drh5e00f6c2001-09-13 13:46:56 +00004727}
4728
4729/*
drh0f7eb612006-08-08 13:51:43 +00004730** Return the number of references to the pager.
4731*/
danielk19773b8a05f2007-03-19 17:44:26 +00004732int sqlite3PagerRefcount(Pager *pPager){
drh0f7eb612006-08-08 13:51:43 +00004733 return pPager->nRef;
4734}
4735
4736#ifdef SQLITE_TEST
4737/*
drhd9b02572001-04-15 00:37:09 +00004738** This routine is used for testing and analysis only.
4739*/
danielk19773b8a05f2007-03-19 17:44:26 +00004740int *sqlite3PagerStats(Pager *pPager){
danielk197742741be2005-01-08 12:42:39 +00004741 static int a[11];
drhd9b02572001-04-15 00:37:09 +00004742 a[0] = pPager->nRef;
4743 a[1] = pPager->nPage;
4744 a[2] = pPager->mxPage;
4745 a[3] = pPager->dbSize;
4746 a[4] = pPager->state;
danielk1977efaaf572006-01-16 11:29:19 +00004747 a[5] = pPager->errCode;
drhd9b02572001-04-15 00:37:09 +00004748 a[6] = pPager->nHit;
4749 a[7] = pPager->nMiss;
drh7c4ac0c2007-04-05 11:25:58 +00004750 a[8] = 0; /* Used to be pPager->nOvfl */
danielk197742741be2005-01-08 12:42:39 +00004751 a[9] = pPager->nRead;
4752 a[10] = pPager->nWrite;
drhd9b02572001-04-15 00:37:09 +00004753 return a;
4754}
drh0f7eb612006-08-08 13:51:43 +00004755#endif
drhdd793422001-06-28 01:54:48 +00004756
drhfa86c412002-02-02 15:01:15 +00004757/*
drhac69b052004-05-12 13:30:07 +00004758** Set the statement rollback point.
drhfa86c412002-02-02 15:01:15 +00004759**
4760** This routine should be called with the transaction journal already
drhac69b052004-05-12 13:30:07 +00004761** open. A new statement journal is created that can be used to rollback
drhaaab5722002-02-19 13:39:21 +00004762** changes of a single SQL command within a larger transaction.
drhfa86c412002-02-02 15:01:15 +00004763*/
drh86f8c192007-08-22 00:39:19 +00004764static int pagerStmtBegin(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00004765 int rc;
drhac69b052004-05-12 13:30:07 +00004766 assert( !pPager->stmtInUse );
drh1aa2d8b2007-01-03 15:34:29 +00004767 assert( pPager->state>=PAGER_SHARED );
drhdc3ff9c2004-08-18 02:10:15 +00004768 assert( pPager->dbSize>=0 );
drh4f0c5872007-03-26 22:05:01 +00004769 PAGERTRACE2("STMT-BEGIN %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004770 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004771 pPager->stmtInUse = 1;
4772 pPager->stmtSize = pPager->dbSize;
4773 return SQLITE_OK;
4774 }
drhda47d772002-12-02 04:25:19 +00004775 if( !pPager->journalOpen ){
drhac69b052004-05-12 13:30:07 +00004776 pPager->stmtAutoopen = 1;
drhda47d772002-12-02 04:25:19 +00004777 return SQLITE_OK;
4778 }
drhfa86c412002-02-02 15:01:15 +00004779 assert( pPager->journalOpen );
drhed138fb2007-08-22 22:04:37 +00004780 pagerLeave(pPager);
danielk1977c4f6f622007-10-03 15:22:25 +00004781 assert( pPager->aInStmt==0 );
drh17435752007-08-16 04:30:38 +00004782 pPager->aInStmt = sqlite3MallocZero( pPager->dbSize/8 + 1 );
drhed138fb2007-08-22 22:04:37 +00004783 pagerEnter(pPager);
drhac69b052004-05-12 13:30:07 +00004784 if( pPager->aInStmt==0 ){
danielk1977261919c2005-12-06 12:52:59 +00004785 /* sqlite3OsLock(pPager->fd, SHARED_LOCK); */
drhfa86c412002-02-02 15:01:15 +00004786 return SQLITE_NOMEM;
4787 }
drh968af522003-02-11 14:55:40 +00004788#ifndef NDEBUG
drh054889e2005-11-30 03:20:31 +00004789 rc = sqlite3OsFileSize(pPager->jfd, &pPager->stmtJSize);
drhac69b052004-05-12 13:30:07 +00004790 if( rc ) goto stmt_begin_failed;
danielk197776572402004-06-25 02:38:54 +00004791 assert( pPager->stmtJSize == pPager->journalOff );
drh968af522003-02-11 14:55:40 +00004792#endif
danielk197776572402004-06-25 02:38:54 +00004793 pPager->stmtJSize = pPager->journalOff;
drhac69b052004-05-12 13:30:07 +00004794 pPager->stmtSize = pPager->dbSize;
danielk197776572402004-06-25 02:38:54 +00004795 pPager->stmtHdrOff = 0;
danielk197775edc162004-06-26 01:48:18 +00004796 pPager->stmtCksum = pPager->cksumInit;
drhac69b052004-05-12 13:30:07 +00004797 if( !pPager->stmtOpen ){
drh334b2992007-09-06 23:28:23 +00004798 rc = sqlite3PagerOpentemp(pPager->pVfs, pPager->stfd, pPager->zStmtJrnl,
drh33f4e022007-09-03 15:19:34 +00004799 SQLITE_OPEN_SUBJOURNAL);
drh334b2992007-09-06 23:28:23 +00004800 if( rc ){
4801 goto stmt_begin_failed;
4802 }
drhac69b052004-05-12 13:30:07 +00004803 pPager->stmtOpen = 1;
4804 pPager->stmtNRec = 0;
drh0f892532002-05-30 12:27:03 +00004805 }
drhac69b052004-05-12 13:30:07 +00004806 pPager->stmtInUse = 1;
drhfa86c412002-02-02 15:01:15 +00004807 return SQLITE_OK;
4808
drhac69b052004-05-12 13:30:07 +00004809stmt_begin_failed:
4810 if( pPager->aInStmt ){
drh17435752007-08-16 04:30:38 +00004811 sqlite3_free(pPager->aInStmt);
drhac69b052004-05-12 13:30:07 +00004812 pPager->aInStmt = 0;
drhfa86c412002-02-02 15:01:15 +00004813 }
4814 return rc;
4815}
drh86f8c192007-08-22 00:39:19 +00004816int sqlite3PagerStmtBegin(Pager *pPager){
4817 int rc;
4818 pagerEnter(pPager);
4819 rc = pagerStmtBegin(pPager);
4820 pagerLeave(pPager);
4821 return rc;
4822}
drhfa86c412002-02-02 15:01:15 +00004823
4824/*
drhac69b052004-05-12 13:30:07 +00004825** Commit a statement.
drhfa86c412002-02-02 15:01:15 +00004826*/
danielk19773b8a05f2007-03-19 17:44:26 +00004827int sqlite3PagerStmtCommit(Pager *pPager){
drh86f8c192007-08-22 00:39:19 +00004828 pagerEnter(pPager);
drhac69b052004-05-12 13:30:07 +00004829 if( pPager->stmtInUse ){
drh03eb96a2002-11-10 23:32:56 +00004830 PgHdr *pPg, *pNext;
drh4f0c5872007-03-26 22:05:01 +00004831 PAGERTRACE2("STMT-COMMIT %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004832 if( !MEMDB ){
drh054889e2005-11-30 03:20:31 +00004833 /* sqlite3OsTruncate(pPager->stfd, 0); */
drh17435752007-08-16 04:30:38 +00004834 sqlite3_free( pPager->aInStmt );
drhac69b052004-05-12 13:30:07 +00004835 pPager->aInStmt = 0;
danielk1977f35843b2007-04-07 15:03:17 +00004836 }else{
4837 for(pPg=pPager->pStmt; pPg; pPg=pNext){
drhac69b052004-05-12 13:30:07 +00004838 PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager);
danielk1977f35843b2007-04-07 15:03:17 +00004839 pNext = pHist->pNextStmt;
4840 assert( pHist->inStmt );
4841 pHist->inStmt = 0;
4842 pHist->pPrevStmt = pHist->pNextStmt = 0;
drh17435752007-08-16 04:30:38 +00004843 sqlite3_free(pHist->pStmt);
drhac69b052004-05-12 13:30:07 +00004844 pHist->pStmt = 0;
4845 }
4846 }
4847 pPager->stmtNRec = 0;
4848 pPager->stmtInUse = 0;
4849 pPager->pStmt = 0;
drh663fc632002-02-02 18:49:19 +00004850 }
drhac69b052004-05-12 13:30:07 +00004851 pPager->stmtAutoopen = 0;
drh86f8c192007-08-22 00:39:19 +00004852 pagerLeave(pPager);
drhfa86c412002-02-02 15:01:15 +00004853 return SQLITE_OK;
4854}
4855
4856/*
drhac69b052004-05-12 13:30:07 +00004857** Rollback a statement.
drhfa86c412002-02-02 15:01:15 +00004858*/
danielk19773b8a05f2007-03-19 17:44:26 +00004859int sqlite3PagerStmtRollback(Pager *pPager){
drhfa86c412002-02-02 15:01:15 +00004860 int rc;
drh86f8c192007-08-22 00:39:19 +00004861 pagerEnter(pPager);
drhac69b052004-05-12 13:30:07 +00004862 if( pPager->stmtInUse ){
drh4f0c5872007-03-26 22:05:01 +00004863 PAGERTRACE2("STMT-ROLLBACK %d\n", PAGERID(pPager));
drhb7f91642004-10-31 02:22:47 +00004864 if( MEMDB ){
drhac69b052004-05-12 13:30:07 +00004865 PgHdr *pPg;
danielk1977f35843b2007-04-07 15:03:17 +00004866 PgHistory *pHist;
4867 for(pPg=pPager->pStmt; pPg; pPg=pHist->pNextStmt){
4868 pHist = PGHDR_TO_HIST(pPg, pPager);
drhac69b052004-05-12 13:30:07 +00004869 if( pHist->pStmt ){
4870 memcpy(PGHDR_TO_DATA(pPg), pHist->pStmt, pPager->pageSize);
drh17435752007-08-16 04:30:38 +00004871 sqlite3_free(pHist->pStmt);
drhac69b052004-05-12 13:30:07 +00004872 pHist->pStmt = 0;
4873 }
4874 }
4875 pPager->dbSize = pPager->stmtSize;
danielk1977e180dd92007-04-05 17:15:52 +00004876 pager_truncate_cache(pPager);
drhac69b052004-05-12 13:30:07 +00004877 rc = SQLITE_OK;
4878 }else{
4879 rc = pager_stmt_playback(pPager);
4880 }
danielk19773b8a05f2007-03-19 17:44:26 +00004881 sqlite3PagerStmtCommit(pPager);
drh663fc632002-02-02 18:49:19 +00004882 }else{
4883 rc = SQLITE_OK;
4884 }
drhac69b052004-05-12 13:30:07 +00004885 pPager->stmtAutoopen = 0;
drh86f8c192007-08-22 00:39:19 +00004886 pagerLeave(pPager);
drhfa86c412002-02-02 15:01:15 +00004887 return rc;
4888}
4889
drh73509ee2003-04-06 20:44:45 +00004890/*
4891** Return the full pathname of the database file.
4892*/
danielk19773b8a05f2007-03-19 17:44:26 +00004893const char *sqlite3PagerFilename(Pager *pPager){
drh73509ee2003-04-06 20:44:45 +00004894 return pPager->zFilename;
4895}
4896
drhb20ea9d2004-02-09 01:20:36 +00004897/*
drhd0679ed2007-08-28 22:24:34 +00004898** Return the VFS structure for the pager.
4899*/
4900const sqlite3_vfs *sqlite3PagerVfs(Pager *pPager){
4901 return pPager->pVfs;
4902}
4903
4904/*
drhcc6bb3e2007-08-31 16:11:35 +00004905** Return the file handle for the database file associated
4906** with the pager. This might return NULL if the file has
4907** not yet been opened.
4908*/
4909sqlite3_file *sqlite3PagerFile(Pager *pPager){
4910 return pPager->fd;
4911}
4912
4913/*
danielk19775865e3d2004-06-14 06:03:57 +00004914** Return the directory of the database file.
4915*/
danielk19773b8a05f2007-03-19 17:44:26 +00004916const char *sqlite3PagerDirname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00004917 return pPager->zDirectory;
4918}
4919
4920/*
4921** Return the full pathname of the journal file.
4922*/
danielk19773b8a05f2007-03-19 17:44:26 +00004923const char *sqlite3PagerJournalname(Pager *pPager){
danielk19775865e3d2004-06-14 06:03:57 +00004924 return pPager->zJournal;
4925}
4926
4927/*
drh2c8997b2005-08-27 16:36:48 +00004928** Return true if fsync() calls are disabled for this pager. Return FALSE
4929** if fsync()s are executed normally.
4930*/
danielk19773b8a05f2007-03-19 17:44:26 +00004931int sqlite3PagerNosync(Pager *pPager){
drh2c8997b2005-08-27 16:36:48 +00004932 return pPager->noSync;
4933}
4934
drh7c4ac0c2007-04-05 11:25:58 +00004935#ifdef SQLITE_HAS_CODEC
drh2c8997b2005-08-27 16:36:48 +00004936/*
drhb20ea9d2004-02-09 01:20:36 +00004937** Set the codec for this pager
4938*/
danielk19773b8a05f2007-03-19 17:44:26 +00004939void sqlite3PagerSetCodec(
drhb20ea9d2004-02-09 01:20:36 +00004940 Pager *pPager,
drhc001c582006-03-06 18:23:16 +00004941 void *(*xCodec)(void*,void*,Pgno,int),
drhb20ea9d2004-02-09 01:20:36 +00004942 void *pCodecArg
4943){
4944 pPager->xCodec = xCodec;
4945 pPager->pCodecArg = pCodecArg;
4946}
drh7c4ac0c2007-04-05 11:25:58 +00004947#endif
drhb20ea9d2004-02-09 01:20:36 +00004948
danielk1977687566d2004-11-02 12:56:41 +00004949#ifndef SQLITE_OMIT_AUTOVACUUM
4950/*
drh5e385312007-06-16 04:42:12 +00004951** Move the page pPg to location pgno in the file.
danielk1977687566d2004-11-02 12:56:41 +00004952**
drh5e385312007-06-16 04:42:12 +00004953** There must be no references to the page previously located at
4954** pgno (which we call pPgOld) though that page is allowed to be
4955** in cache. If the page previous located at pgno is not already
4956** in the rollback journal, it is not put there by by this routine.
danielk1977687566d2004-11-02 12:56:41 +00004957**
drh5e385312007-06-16 04:42:12 +00004958** References to the page pPg remain valid. Updating any
4959** meta-data associated with pPg (i.e. data stored in the nExtra bytes
danielk1977687566d2004-11-02 12:56:41 +00004960** allocated along with the page) is the responsibility of the caller.
4961**
danielk19775fd057a2005-03-09 13:09:43 +00004962** A transaction must be active when this routine is called. It used to be
4963** required that a statement transaction was not active, but this restriction
4964** has been removed (CREATE INDEX needs to move a page when a statement
4965** transaction is active).
danielk1977687566d2004-11-02 12:56:41 +00004966*/
danielk19773b8a05f2007-03-19 17:44:26 +00004967int sqlite3PagerMovepage(Pager *pPager, DbPage *pPg, Pgno pgno){
drh5e385312007-06-16 04:42:12 +00004968 PgHdr *pPgOld; /* The page being overwritten. */
danielk1977f5fdda82004-11-03 08:44:05 +00004969 int h;
danielk197794daf7f2004-11-08 09:26:09 +00004970 Pgno needSyncPgno = 0;
danielk1977687566d2004-11-02 12:56:41 +00004971
drh86f8c192007-08-22 00:39:19 +00004972 pagerEnter(pPager);
danielk1977687566d2004-11-02 12:56:41 +00004973 assert( pPg->nRef>0 );
4974
drh4f0c5872007-03-26 22:05:01 +00004975 PAGERTRACE5("MOVE %d page %d (needSync=%d) moves to %d\n",
danielk1977599fcba2004-11-08 07:13:13 +00004976 PAGERID(pPager), pPg->pgno, pPg->needSync, pgno);
drhb0603412007-02-28 04:47:26 +00004977 IOTRACE(("MOVE %p %d %d\n", pPager, pPg->pgno, pgno))
danielk1977ef73ee92004-11-06 12:26:07 +00004978
danielk1977b4626a32007-04-28 15:47:43 +00004979 pager_get_content(pPg);
danielk197794daf7f2004-11-08 09:26:09 +00004980 if( pPg->needSync ){
4981 needSyncPgno = pPg->pgno;
drh4f0aee42007-06-16 18:39:41 +00004982 assert( pPg->inJournal || (int)pgno>pPager->origDbSize );
danielk197794daf7f2004-11-08 09:26:09 +00004983 assert( pPg->dirty );
danielk1977ae825582004-11-23 09:06:55 +00004984 assert( pPager->needSync );
danielk197794daf7f2004-11-08 09:26:09 +00004985 }
4986
danielk1977687566d2004-11-02 12:56:41 +00004987 /* Unlink pPg from it's hash-chain */
danielk1977f5fdda82004-11-03 08:44:05 +00004988 unlinkHashChain(pPager, pPg);
danielk1977687566d2004-11-02 12:56:41 +00004989
danielk1977ef73ee92004-11-06 12:26:07 +00004990 /* If the cache contains a page with page-number pgno, remove it
danielk1977599fcba2004-11-08 07:13:13 +00004991 ** from it's hash chain. Also, if the PgHdr.needSync was set for
4992 ** page pgno before the 'move' operation, it needs to be retained
4993 ** for the page moved there.
danielk1977f5fdda82004-11-03 08:44:05 +00004994 */
drh5e385312007-06-16 04:42:12 +00004995 pPg->needSync = 0;
danielk1977687566d2004-11-02 12:56:41 +00004996 pPgOld = pager_lookup(pPager, pgno);
4997 if( pPgOld ){
danielk1977f5fdda82004-11-03 08:44:05 +00004998 assert( pPgOld->nRef==0 );
4999 unlinkHashChain(pPager, pPgOld);
drh605ad8f2006-05-03 23:34:05 +00005000 makeClean(pPgOld);
drh5e385312007-06-16 04:42:12 +00005001 pPg->needSync = pPgOld->needSync;
5002 }else{
5003 pPg->needSync = 0;
5004 }
5005 if( pPager->aInJournal && (int)pgno<=pPager->origDbSize ){
5006 pPg->inJournal = (pPager->aInJournal[pgno/8] & (1<<(pgno&7)))!=0;
drh5e385312007-06-16 04:42:12 +00005007 }else{
5008 pPg->inJournal = 0;
drh732c8172007-06-16 11:17:45 +00005009 assert( pPg->needSync==0 || (int)pgno>pPager->origDbSize );
danielk1977687566d2004-11-02 12:56:41 +00005010 }
5011
danielk1977f5fdda82004-11-03 08:44:05 +00005012 /* Change the page number for pPg and insert it into the new hash-chain. */
drh3765df42006-06-28 18:18:09 +00005013 assert( pgno!=0 );
danielk1977f5fdda82004-11-03 08:44:05 +00005014 pPg->pgno = pgno;
drh8ca0c722006-05-07 17:49:38 +00005015 h = pgno & (pPager->nHash-1);
danielk1977f5fdda82004-11-03 08:44:05 +00005016 if( pPager->aHash[h] ){
5017 assert( pPager->aHash[h]->pPrevHash==0 );
5018 pPager->aHash[h]->pPrevHash = pPg;
5019 }
5020 pPg->pNextHash = pPager->aHash[h];
5021 pPager->aHash[h] = pPg;
5022 pPg->pPrevHash = 0;
5023
drh605ad8f2006-05-03 23:34:05 +00005024 makeDirty(pPg);
danielk1977687566d2004-11-02 12:56:41 +00005025 pPager->dirtyCache = 1;
5026
danielk197794daf7f2004-11-08 09:26:09 +00005027 if( needSyncPgno ){
5028 /* If needSyncPgno is non-zero, then the journal file needs to be
5029 ** sync()ed before any data is written to database file page needSyncPgno.
5030 ** Currently, no such page exists in the page-cache and the
5031 ** Pager.aInJournal bit has been set. This needs to be remedied by loading
5032 ** the page into the pager-cache and setting the PgHdr.needSync flag.
danielk1977ae825582004-11-23 09:06:55 +00005033 **
danielk19773b8a05f2007-03-19 17:44:26 +00005034 ** The sqlite3PagerGet() call may cause the journal to sync. So make
danielk1977ae825582004-11-23 09:06:55 +00005035 ** sure the Pager.needSync flag is set too.
danielk197794daf7f2004-11-08 09:26:09 +00005036 */
5037 int rc;
danielk19773b8a05f2007-03-19 17:44:26 +00005038 PgHdr *pPgHdr;
danielk1977ae825582004-11-23 09:06:55 +00005039 assert( pPager->needSync );
danielk19773b8a05f2007-03-19 17:44:26 +00005040 rc = sqlite3PagerGet(pPager, needSyncPgno, &pPgHdr);
danielk197794daf7f2004-11-08 09:26:09 +00005041 if( rc!=SQLITE_OK ) return rc;
danielk1977ae825582004-11-23 09:06:55 +00005042 pPager->needSync = 1;
danielk19773b8a05f2007-03-19 17:44:26 +00005043 pPgHdr->needSync = 1;
5044 pPgHdr->inJournal = 1;
5045 makeDirty(pPgHdr);
5046 sqlite3PagerUnref(pPgHdr);
danielk197794daf7f2004-11-08 09:26:09 +00005047 }
5048
drh86f8c192007-08-22 00:39:19 +00005049 pagerLeave(pPager);
danielk1977687566d2004-11-02 12:56:41 +00005050 return SQLITE_OK;
5051}
5052#endif
5053
danielk19773b8a05f2007-03-19 17:44:26 +00005054/*
5055** Return a pointer to the data for the specified page.
5056*/
5057void *sqlite3PagerGetData(DbPage *pPg){
5058 return PGHDR_TO_DATA(pPg);
5059}
5060
5061/*
5062** Return a pointer to the Pager.nExtra bytes of "extra" space
5063** allocated along with the specified page.
5064*/
5065void *sqlite3PagerGetExtra(DbPage *pPg){
5066 Pager *pPager = pPg->pPager;
5067 return (pPager?PGHDR_TO_EXTRA(pPg, pPager):0);
5068}
5069
danielk197741483462007-03-24 16:45:04 +00005070/*
5071** Get/set the locking-mode for this pager. Parameter eMode must be one
5072** of PAGER_LOCKINGMODE_QUERY, PAGER_LOCKINGMODE_NORMAL or
5073** PAGER_LOCKINGMODE_EXCLUSIVE. If the parameter is not _QUERY, then
5074** the locking-mode is set to the value specified.
5075**
5076** The returned value is either PAGER_LOCKINGMODE_NORMAL or
5077** PAGER_LOCKINGMODE_EXCLUSIVE, indicating the current (possibly updated)
5078** locking-mode.
5079*/
5080int sqlite3PagerLockingMode(Pager *pPager, int eMode){
drh369339d2007-03-30 16:01:55 +00005081 assert( eMode==PAGER_LOCKINGMODE_QUERY
5082 || eMode==PAGER_LOCKINGMODE_NORMAL
5083 || eMode==PAGER_LOCKINGMODE_EXCLUSIVE );
5084 assert( PAGER_LOCKINGMODE_QUERY<0 );
5085 assert( PAGER_LOCKINGMODE_NORMAL>=0 && PAGER_LOCKINGMODE_EXCLUSIVE>=0 );
5086 if( eMode>=0 && !pPager->tempFile ){
danielk197741483462007-03-24 16:45:04 +00005087 pPager->exclusiveMode = eMode;
5088 }
5089 return (int)pPager->exclusiveMode;
5090}
5091
danielk197793758c82005-01-21 08:13:14 +00005092#ifdef SQLITE_DEBUG
drhdd793422001-06-28 01:54:48 +00005093/*
5094** Print a listing of all referenced pages and their ref count.
5095*/
danielk19773b8a05f2007-03-19 17:44:26 +00005096void sqlite3PagerRefdump(Pager *pPager){
drhdd793422001-06-28 01:54:48 +00005097 PgHdr *pPg;
5098 for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){
5099 if( pPg->nRef<=0 ) continue;
drhfe63d1c2004-09-08 20:13:04 +00005100 sqlite3DebugPrintf("PAGE %3d addr=%p nRef=%d\n",
5101 pPg->pgno, PGHDR_TO_DATA(pPg), pPg->nRef);
drhdd793422001-06-28 01:54:48 +00005102 }
5103}
5104#endif
drh2e66f0b2005-04-28 17:18:48 +00005105
5106#endif /* SQLITE_OMIT_DISKIO */