Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(261)

Side by Side Diff: third_party/sqlite/sqlite-src-3170000/src/pager.c

Issue 2747283002: [sql] Import reference version of SQLite 3.17.. (Closed)
Patch Set: Created 3 years, 9 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
OLDNEW
(Empty)
1 /*
2 ** 2001 September 15
3 **
4 ** The author disclaims copyright to this source code. In place of
5 ** a legal notice, here is a blessing:
6 **
7 ** 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.
10 **
11 *************************************************************************
12 ** This is the implementation of the page cache subsystem or "pager".
13 **
14 ** 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.
20 */
21 #ifndef SQLITE_OMIT_DISKIO
22 #include "sqliteInt.h"
23 #include "wal.h"
24
25
26 /******************* NOTES ON THE DESIGN OF THE PAGER ************************
27 **
28 ** This comment block describes invariants that hold when using a rollback
29 ** journal. These invariants do not apply for journal_mode=WAL,
30 ** journal_mode=MEMORY, or journal_mode=OFF.
31 **
32 ** Within this comment block, a page is deemed to have been synced
33 ** automatically as soon as it is written when PRAGMA synchronous=OFF.
34 ** Otherwise, the page is not synced until the xSync method of the VFS
35 ** is called successfully on the file containing the page.
36 **
37 ** Definition: A page of the database file is said to be "overwriteable" if
38 ** one or more of the following are true about the page:
39 **
40 ** (a) The original content of the page as it was at the beginning of
41 ** the transaction has been written into the rollback journal and
42 ** synced.
43 **
44 ** (b) The page was a freelist leaf page at the start of the transaction.
45 **
46 ** (c) The page number is greater than the largest page that existed in
47 ** the database file at the start of the transaction.
48 **
49 ** (1) A page of the database file is never overwritten unless one of the
50 ** following are true:
51 **
52 ** (a) The page and all other pages on the same sector are overwriteable.
53 **
54 ** (b) The atomic page write optimization is enabled, and the entire
55 ** transaction other than the update of the transaction sequence
56 ** number consists of a single page change.
57 **
58 ** (2) The content of a page written into the rollback journal exactly matches
59 ** both the content in the database when the rollback journal was written
60 ** and the content in the database at the beginning of the current
61 ** transaction.
62 **
63 ** (3) Writes to the database file are an integer multiple of the page size
64 ** in length and are aligned on a page boundary.
65 **
66 ** (4) Reads from the database file are either aligned on a page boundary and
67 ** an integer multiple of the page size in length or are taken from the
68 ** first 100 bytes of the database file.
69 **
70 ** (5) All writes to the database file are synced prior to the rollback journal
71 ** being deleted, truncated, or zeroed.
72 **
73 ** (6) If a master journal file is used, then all writes to the database file
74 ** are synced prior to the master journal being deleted.
75 **
76 ** Definition: Two databases (or the same database at two points it time)
77 ** are said to be "logically equivalent" if they give the same answer to
78 ** all queries. Note in particular the content of freelist leaf
79 ** pages can be changed arbitrarily without affecting the logical equivalence
80 ** of the database.
81 **
82 ** (7) At any time, if any subset, including the empty set and the total set,
83 ** of the unsynced changes to a rollback journal are removed and the
84 ** journal is rolled back, the resulting database file will be logically
85 ** equivalent to the database file at the beginning of the transaction.
86 **
87 ** (8) When a transaction is rolled back, the xTruncate method of the VFS
88 ** is called to restore the database file to the same size it was at
89 ** the beginning of the transaction. (In some VFSes, the xTruncate
90 ** method is a no-op, but that does not change the fact the SQLite will
91 ** invoke it.)
92 **
93 ** (9) Whenever the database file is modified, at least one bit in the range
94 ** of bytes from 24 through 39 inclusive will be changed prior to releasing
95 ** the EXCLUSIVE lock, thus signaling other connections on the same
96 ** database to flush their caches.
97 **
98 ** (10) The pattern of bits in bytes 24 through 39 shall not repeat in less
99 ** than one billion transactions.
100 **
101 ** (11) A database file is well-formed at the beginning and at the conclusion
102 ** of every transaction.
103 **
104 ** (12) An EXCLUSIVE lock is held on the database file when writing to
105 ** the database file.
106 **
107 ** (13) A SHARED lock is held on the database file while reading any
108 ** content out of the database file.
109 **
110 ******************************************************************************/
111
112 /*
113 ** Macros for troubleshooting. Normally turned off
114 */
115 #if 0
116 int sqlite3PagerTrace=1; /* True to enable tracing */
117 #define sqlite3DebugPrintf printf
118 #define PAGERTRACE(X) if( sqlite3PagerTrace ){ sqlite3DebugPrintf X; }
119 #else
120 #define PAGERTRACE(X)
121 #endif
122
123 /*
124 ** The following two macros are used within the PAGERTRACE() macros above
125 ** to print out file-descriptors.
126 **
127 ** PAGERID() takes a pointer to a Pager struct as its argument. The
128 ** associated file-descriptor is returned. FILEHANDLEID() takes an sqlite3_file
129 ** struct as its argument.
130 */
131 #define PAGERID(p) ((int)(p->fd))
132 #define FILEHANDLEID(fd) ((int)fd)
133
134 /*
135 ** The Pager.eState variable stores the current 'state' of a pager. A
136 ** pager may be in any one of the seven states shown in the following
137 ** state diagram.
138 **
139 ** OPEN <------+------+
140 ** | | |
141 ** V | |
142 ** +---------> READER-------+ |
143 ** | | |
144 ** | V |
145 ** |<-------WRITER_LOCKED------> ERROR
146 ** | | ^
147 ** | V |
148 ** |<------WRITER_CACHEMOD-------->|
149 ** | | |
150 ** | V |
151 ** |<-------WRITER_DBMOD---------->|
152 ** | | |
153 ** | V |
154 ** +<------WRITER_FINISHED-------->+
155 **
156 **
157 ** List of state transitions and the C [function] that performs each:
158 **
159 ** OPEN -> READER [sqlite3PagerSharedLock]
160 ** READER -> OPEN [pager_unlock]
161 **
162 ** READER -> WRITER_LOCKED [sqlite3PagerBegin]
163 ** WRITER_LOCKED -> WRITER_CACHEMOD [pager_open_journal]
164 ** WRITER_CACHEMOD -> WRITER_DBMOD [syncJournal]
165 ** WRITER_DBMOD -> WRITER_FINISHED [sqlite3PagerCommitPhaseOne]
166 ** WRITER_*** -> READER [pager_end_transaction]
167 **
168 ** WRITER_*** -> ERROR [pager_error]
169 ** ERROR -> OPEN [pager_unlock]
170 **
171 **
172 ** OPEN:
173 **
174 ** The pager starts up in this state. Nothing is guaranteed in this
175 ** state - the file may or may not be locked and the database size is
176 ** unknown. The database may not be read or written.
177 **
178 ** * No read or write transaction is active.
179 ** * Any lock, or no lock at all, may be held on the database file.
180 ** * The dbSize, dbOrigSize and dbFileSize variables may not be trusted.
181 **
182 ** READER:
183 **
184 ** In this state all the requirements for reading the database in
185 ** rollback (non-WAL) mode are met. Unless the pager is (or recently
186 ** was) in exclusive-locking mode, a user-level read transaction is
187 ** open. The database size is known in this state.
188 **
189 ** A connection running with locking_mode=normal enters this state when
190 ** it opens a read-transaction on the database and returns to state
191 ** OPEN after the read-transaction is completed. However a connection
192 ** running in locking_mode=exclusive (including temp databases) remains in
193 ** this state even after the read-transaction is closed. The only way
194 ** a locking_mode=exclusive connection can transition from READER to OPEN
195 ** is via the ERROR state (see below).
196 **
197 ** * A read transaction may be active (but a write-transaction cannot).
198 ** * A SHARED or greater lock is held on the database file.
199 ** * The dbSize variable may be trusted (even if a user-level read
200 ** transaction is not active). The dbOrigSize and dbFileSize variables
201 ** may not be trusted at this point.
202 ** * If the database is a WAL database, then the WAL connection is open.
203 ** * Even if a read-transaction is not open, it is guaranteed that
204 ** there is no hot-journal in the file-system.
205 **
206 ** WRITER_LOCKED:
207 **
208 ** The pager moves to this state from READER when a write-transaction
209 ** is first opened on the database. In WRITER_LOCKED state, all locks
210 ** required to start a write-transaction are held, but no actual
211 ** modifications to the cache or database have taken place.
212 **
213 ** In rollback mode, a RESERVED or (if the transaction was opened with
214 ** BEGIN EXCLUSIVE) EXCLUSIVE lock is obtained on the database file when
215 ** moving to this state, but the journal file is not written to or opened
216 ** to in this state. If the transaction is committed or rolled back while
217 ** in WRITER_LOCKED state, all that is required is to unlock the database
218 ** file.
219 **
220 ** IN WAL mode, WalBeginWriteTransaction() is called to lock the log file.
221 ** If the connection is running with locking_mode=exclusive, an attempt
222 ** is made to obtain an EXCLUSIVE lock on the database file.
223 **
224 ** * A write transaction is active.
225 ** * If the connection is open in rollback-mode, a RESERVED or greater
226 ** lock is held on the database file.
227 ** * If the connection is open in WAL-mode, a WAL write transaction
228 ** is open (i.e. sqlite3WalBeginWriteTransaction() has been successfully
229 ** called).
230 ** * The dbSize, dbOrigSize and dbFileSize variables are all valid.
231 ** * The contents of the pager cache have not been modified.
232 ** * The journal file may or may not be open.
233 ** * Nothing (not even the first header) has been written to the journal.
234 **
235 ** WRITER_CACHEMOD:
236 **
237 ** A pager moves from WRITER_LOCKED state to this state when a page is
238 ** first modified by the upper layer. In rollback mode the journal file
239 ** is opened (if it is not already open) and a header written to the
240 ** start of it. The database file on disk has not been modified.
241 **
242 ** * A write transaction is active.
243 ** * A RESERVED or greater lock is held on the database file.
244 ** * The journal file is open and the first header has been written
245 ** to it, but the header has not been synced to disk.
246 ** * The contents of the page cache have been modified.
247 **
248 ** WRITER_DBMOD:
249 **
250 ** The pager transitions from WRITER_CACHEMOD into WRITER_DBMOD state
251 ** when it modifies the contents of the database file. WAL connections
252 ** never enter this state (since they do not modify the database file,
253 ** just the log file).
254 **
255 ** * A write transaction is active.
256 ** * An EXCLUSIVE or greater lock is held on the database file.
257 ** * The journal file is open and the first header has been written
258 ** and synced to disk.
259 ** * The contents of the page cache have been modified (and possibly
260 ** written to disk).
261 **
262 ** WRITER_FINISHED:
263 **
264 ** It is not possible for a WAL connection to enter this state.
265 **
266 ** A rollback-mode pager changes to WRITER_FINISHED state from WRITER_DBMOD
267 ** state after the entire transaction has been successfully written into the
268 ** database file. In this state the transaction may be committed simply
269 ** by finalizing the journal file. Once in WRITER_FINISHED state, it is
270 ** not possible to modify the database further. At this point, the upper
271 ** layer must either commit or rollback the transaction.
272 **
273 ** * A write transaction is active.
274 ** * An EXCLUSIVE or greater lock is held on the database file.
275 ** * All writing and syncing of journal and database data has finished.
276 ** If no error occurred, all that remains is to finalize the journal to
277 ** commit the transaction. If an error did occur, the caller will need
278 ** to rollback the transaction.
279 **
280 ** ERROR:
281 **
282 ** The ERROR state is entered when an IO or disk-full error (including
283 ** SQLITE_IOERR_NOMEM) occurs at a point in the code that makes it
284 ** difficult to be sure that the in-memory pager state (cache contents,
285 ** db size etc.) are consistent with the contents of the file-system.
286 **
287 ** Temporary pager files may enter the ERROR state, but in-memory pagers
288 ** cannot.
289 **
290 ** For example, if an IO error occurs while performing a rollback,
291 ** the contents of the page-cache may be left in an inconsistent state.
292 ** At this point it would be dangerous to change back to READER state
293 ** (as usually happens after a rollback). Any subsequent readers might
294 ** report database corruption (due to the inconsistent cache), and if
295 ** they upgrade to writers, they may inadvertently corrupt the database
296 ** file. To avoid this hazard, the pager switches into the ERROR state
297 ** instead of READER following such an error.
298 **
299 ** Once it has entered the ERROR state, any attempt to use the pager
300 ** to read or write data returns an error. Eventually, once all
301 ** outstanding transactions have been abandoned, the pager is able to
302 ** transition back to OPEN state, discarding the contents of the
303 ** page-cache and any other in-memory state at the same time. Everything
304 ** is reloaded from disk (and, if necessary, hot-journal rollback peformed)
305 ** when a read-transaction is next opened on the pager (transitioning
306 ** the pager into READER state). At that point the system has recovered
307 ** from the error.
308 **
309 ** Specifically, the pager jumps into the ERROR state if:
310 **
311 ** 1. An error occurs while attempting a rollback. This happens in
312 ** function sqlite3PagerRollback().
313 **
314 ** 2. An error occurs while attempting to finalize a journal file
315 ** following a commit in function sqlite3PagerCommitPhaseTwo().
316 **
317 ** 3. An error occurs while attempting to write to the journal or
318 ** database file in function pagerStress() in order to free up
319 ** memory.
320 **
321 ** In other cases, the error is returned to the b-tree layer. The b-tree
322 ** layer then attempts a rollback operation. If the error condition
323 ** persists, the pager enters the ERROR state via condition (1) above.
324 **
325 ** Condition (3) is necessary because it can be triggered by a read-only
326 ** statement executed within a transaction. In this case, if the error
327 ** code were simply returned to the user, the b-tree layer would not
328 ** automatically attempt a rollback, as it assumes that an error in a
329 ** read-only statement cannot leave the pager in an internally inconsistent
330 ** state.
331 **
332 ** * The Pager.errCode variable is set to something other than SQLITE_OK.
333 ** * There are one or more outstanding references to pages (after the
334 ** last reference is dropped the pager should move back to OPEN state).
335 ** * The pager is not an in-memory pager.
336 **
337 **
338 ** Notes:
339 **
340 ** * A pager is never in WRITER_DBMOD or WRITER_FINISHED state if the
341 ** connection is open in WAL mode. A WAL connection is always in one
342 ** of the first four states.
343 **
344 ** * Normally, a connection open in exclusive mode is never in PAGER_OPEN
345 ** state. There are two exceptions: immediately after exclusive-mode has
346 ** been turned on (and before any read or write transactions are
347 ** executed), and when the pager is leaving the "error state".
348 **
349 ** * See also: assert_pager_state().
350 */
351 #define PAGER_OPEN 0
352 #define PAGER_READER 1
353 #define PAGER_WRITER_LOCKED 2
354 #define PAGER_WRITER_CACHEMOD 3
355 #define PAGER_WRITER_DBMOD 4
356 #define PAGER_WRITER_FINISHED 5
357 #define PAGER_ERROR 6
358
359 /*
360 ** The Pager.eLock variable is almost always set to one of the
361 ** following locking-states, according to the lock currently held on
362 ** the database file: NO_LOCK, SHARED_LOCK, RESERVED_LOCK or EXCLUSIVE_LOCK.
363 ** This variable is kept up to date as locks are taken and released by
364 ** the pagerLockDb() and pagerUnlockDb() wrappers.
365 **
366 ** If the VFS xLock() or xUnlock() returns an error other than SQLITE_BUSY
367 ** (i.e. one of the SQLITE_IOERR subtypes), it is not clear whether or not
368 ** the operation was successful. In these circumstances pagerLockDb() and
369 ** pagerUnlockDb() take a conservative approach - eLock is always updated
370 ** when unlocking the file, and only updated when locking the file if the
371 ** VFS call is successful. This way, the Pager.eLock variable may be set
372 ** to a less exclusive (lower) value than the lock that is actually held
373 ** at the system level, but it is never set to a more exclusive value.
374 **
375 ** This is usually safe. If an xUnlock fails or appears to fail, there may
376 ** be a few redundant xLock() calls or a lock may be held for longer than
377 ** required, but nothing really goes wrong.
378 **
379 ** The exception is when the database file is unlocked as the pager moves
380 ** from ERROR to OPEN state. At this point there may be a hot-journal file
381 ** in the file-system that needs to be rolled back (as part of an OPEN->SHARED
382 ** transition, by the same pager or any other). If the call to xUnlock()
383 ** fails at this point and the pager is left holding an EXCLUSIVE lock, this
384 ** can confuse the call to xCheckReservedLock() call made later as part
385 ** of hot-journal detection.
386 **
387 ** xCheckReservedLock() is defined as returning true "if there is a RESERVED
388 ** lock held by this process or any others". So xCheckReservedLock may
389 ** return true because the caller itself is holding an EXCLUSIVE lock (but
390 ** doesn't know it because of a previous error in xUnlock). If this happens
391 ** a hot-journal may be mistaken for a journal being created by an active
392 ** transaction in another process, causing SQLite to read from the database
393 ** without rolling it back.
394 **
395 ** To work around this, if a call to xUnlock() fails when unlocking the
396 ** database in the ERROR state, Pager.eLock is set to UNKNOWN_LOCK. It
397 ** is only changed back to a real locking state after a successful call
398 ** to xLock(EXCLUSIVE). Also, the code to do the OPEN->SHARED state transition
399 ** omits the check for a hot-journal if Pager.eLock is set to UNKNOWN_LOCK
400 ** lock. Instead, it assumes a hot-journal exists and obtains an EXCLUSIVE
401 ** lock on the database file before attempting to roll it back. See function
402 ** PagerSharedLock() for more detail.
403 **
404 ** Pager.eLock may only be set to UNKNOWN_LOCK when the pager is in
405 ** PAGER_OPEN state.
406 */
407 #define UNKNOWN_LOCK (EXCLUSIVE_LOCK+1)
408
409 /*
410 ** A macro used for invoking the codec if there is one
411 */
412 #ifdef SQLITE_HAS_CODEC
413 # define CODEC1(P,D,N,X,E) \
414 if( P->xCodec && P->xCodec(P->pCodec,D,N,X)==0 ){ E; }
415 # define CODEC2(P,D,N,X,E,O) \
416 if( P->xCodec==0 ){ O=(char*)D; }else \
417 if( (O=(char*)(P->xCodec(P->pCodec,D,N,X)))==0 ){ E; }
418 #else
419 # define CODEC1(P,D,N,X,E) /* NO-OP */
420 # define CODEC2(P,D,N,X,E,O) O=(char*)D
421 #endif
422
423 /*
424 ** The maximum allowed sector size. 64KiB. If the xSectorsize() method
425 ** returns a value larger than this, then MAX_SECTOR_SIZE is used instead.
426 ** This could conceivably cause corruption following a power failure on
427 ** such a system. This is currently an undocumented limit.
428 */
429 #define MAX_SECTOR_SIZE 0x10000
430
431
432 /*
433 ** An instance of the following structure is allocated for each active
434 ** savepoint and statement transaction in the system. All such structures
435 ** are stored in the Pager.aSavepoint[] array, which is allocated and
436 ** resized using sqlite3Realloc().
437 **
438 ** When a savepoint is created, the PagerSavepoint.iHdrOffset field is
439 ** set to 0. If a journal-header is written into the main journal while
440 ** the savepoint is active, then iHdrOffset is set to the byte offset
441 ** immediately following the last journal record written into the main
442 ** journal before the journal-header. This is required during savepoint
443 ** rollback (see pagerPlaybackSavepoint()).
444 */
445 typedef struct PagerSavepoint PagerSavepoint;
446 struct PagerSavepoint {
447 i64 iOffset; /* Starting offset in main journal */
448 i64 iHdrOffset; /* See above */
449 Bitvec *pInSavepoint; /* Set of pages in this savepoint */
450 Pgno nOrig; /* Original number of pages in file */
451 Pgno iSubRec; /* Index of first record in sub-journal */
452 #ifndef SQLITE_OMIT_WAL
453 u32 aWalData[WAL_SAVEPOINT_NDATA]; /* WAL savepoint context */
454 #endif
455 };
456
457 /*
458 ** Bits of the Pager.doNotSpill flag. See further description below.
459 */
460 #define SPILLFLAG_OFF 0x01 /* Never spill cache. Set via pragma */
461 #define SPILLFLAG_ROLLBACK 0x02 /* Current rolling back, so do not spill */
462 #define SPILLFLAG_NOSYNC 0x04 /* Spill is ok, but do not sync */
463
464 /*
465 ** An open page cache is an instance of struct Pager. A description of
466 ** some of the more important member variables follows:
467 **
468 ** eState
469 **
470 ** The current 'state' of the pager object. See the comment and state
471 ** diagram above for a description of the pager state.
472 **
473 ** eLock
474 **
475 ** For a real on-disk database, the current lock held on the database file -
476 ** NO_LOCK, SHARED_LOCK, RESERVED_LOCK or EXCLUSIVE_LOCK.
477 **
478 ** For a temporary or in-memory database (neither of which require any
479 ** locks), this variable is always set to EXCLUSIVE_LOCK. Since such
480 ** databases always have Pager.exclusiveMode==1, this tricks the pager
481 ** logic into thinking that it already has all the locks it will ever
482 ** need (and no reason to release them).
483 **
484 ** In some (obscure) circumstances, this variable may also be set to
485 ** UNKNOWN_LOCK. See the comment above the #define of UNKNOWN_LOCK for
486 ** details.
487 **
488 ** changeCountDone
489 **
490 ** This boolean variable is used to make sure that the change-counter
491 ** (the 4-byte header field at byte offset 24 of the database file) is
492 ** not updated more often than necessary.
493 **
494 ** It is set to true when the change-counter field is updated, which
495 ** can only happen if an exclusive lock is held on the database file.
496 ** It is cleared (set to false) whenever an exclusive lock is
497 ** relinquished on the database file. Each time a transaction is committed,
498 ** The changeCountDone flag is inspected. If it is true, the work of
499 ** updating the change-counter is omitted for the current transaction.
500 **
501 ** This mechanism means that when running in exclusive mode, a connection
502 ** need only update the change-counter once, for the first transaction
503 ** committed.
504 **
505 ** setMaster
506 **
507 ** When PagerCommitPhaseOne() is called to commit a transaction, it may
508 ** (or may not) specify a master-journal name to be written into the
509 ** journal file before it is synced to disk.
510 **
511 ** Whether or not a journal file contains a master-journal pointer affects
512 ** the way in which the journal file is finalized after the transaction is
513 ** committed or rolled back when running in "journal_mode=PERSIST" mode.
514 ** If a journal file does not contain a master-journal pointer, it is
515 ** finalized by overwriting the first journal header with zeroes. If
516 ** it does contain a master-journal pointer the journal file is finalized
517 ** by truncating it to zero bytes, just as if the connection were
518 ** running in "journal_mode=truncate" mode.
519 **
520 ** Journal files that contain master journal pointers cannot be finalized
521 ** simply by overwriting the first journal-header with zeroes, as the
522 ** master journal pointer could interfere with hot-journal rollback of any
523 ** subsequently interrupted transaction that reuses the journal file.
524 **
525 ** The flag is cleared as soon as the journal file is finalized (either
526 ** by PagerCommitPhaseTwo or PagerRollback). If an IO error prevents the
527 ** journal file from being successfully finalized, the setMaster flag
528 ** is cleared anyway (and the pager will move to ERROR state).
529 **
530 ** doNotSpill
531 **
532 ** This variables control the behavior of cache-spills (calls made by
533 ** the pcache module to the pagerStress() routine to write cached data
534 ** to the file-system in order to free up memory).
535 **
536 ** When bits SPILLFLAG_OFF or SPILLFLAG_ROLLBACK of doNotSpill are set,
537 ** writing to the database from pagerStress() is disabled altogether.
538 ** The SPILLFLAG_ROLLBACK case is done in a very obscure case that
539 ** comes up during savepoint rollback that requires the pcache module
540 ** to allocate a new page to prevent the journal file from being written
541 ** while it is being traversed by code in pager_playback(). The SPILLFLAG_OFF
542 ** case is a user preference.
543 **
544 ** If the SPILLFLAG_NOSYNC bit is set, writing to the database from
545 ** pagerStress() is permitted, but syncing the journal file is not.
546 ** This flag is set by sqlite3PagerWrite() when the file-system sector-size
547 ** is larger than the database page-size in order to prevent a journal sync
548 ** from happening in between the journalling of two pages on the same sector.
549 **
550 ** subjInMemory
551 **
552 ** This is a boolean variable. If true, then any required sub-journal
553 ** is opened as an in-memory journal file. If false, then in-memory
554 ** sub-journals are only used for in-memory pager files.
555 **
556 ** This variable is updated by the upper layer each time a new
557 ** write-transaction is opened.
558 **
559 ** dbSize, dbOrigSize, dbFileSize
560 **
561 ** Variable dbSize is set to the number of pages in the database file.
562 ** It is valid in PAGER_READER and higher states (all states except for
563 ** OPEN and ERROR).
564 **
565 ** dbSize is set based on the size of the database file, which may be
566 ** larger than the size of the database (the value stored at offset
567 ** 28 of the database header by the btree). If the size of the file
568 ** is not an integer multiple of the page-size, the value stored in
569 ** dbSize is rounded down (i.e. a 5KB file with 2K page-size has dbSize==2).
570 ** Except, any file that is greater than 0 bytes in size is considered
571 ** to have at least one page. (i.e. a 1KB file with 2K page-size leads
572 ** to dbSize==1).
573 **
574 ** During a write-transaction, if pages with page-numbers greater than
575 ** dbSize are modified in the cache, dbSize is updated accordingly.
576 ** Similarly, if the database is truncated using PagerTruncateImage(),
577 ** dbSize is updated.
578 **
579 ** Variables dbOrigSize and dbFileSize are valid in states
580 ** PAGER_WRITER_LOCKED and higher. dbOrigSize is a copy of the dbSize
581 ** variable at the start of the transaction. It is used during rollback,
582 ** and to determine whether or not pages need to be journalled before
583 ** being modified.
584 **
585 ** Throughout a write-transaction, dbFileSize contains the size of
586 ** the file on disk in pages. It is set to a copy of dbSize when the
587 ** write-transaction is first opened, and updated when VFS calls are made
588 ** to write or truncate the database file on disk.
589 **
590 ** The only reason the dbFileSize variable is required is to suppress
591 ** unnecessary calls to xTruncate() after committing a transaction. If,
592 ** when a transaction is committed, the dbFileSize variable indicates
593 ** that the database file is larger than the database image (Pager.dbSize),
594 ** pager_truncate() is called. The pager_truncate() call uses xFilesize()
595 ** to measure the database file on disk, and then truncates it if required.
596 ** dbFileSize is not used when rolling back a transaction. In this case
597 ** pager_truncate() is called unconditionally (which means there may be
598 ** a call to xFilesize() that is not strictly required). In either case,
599 ** pager_truncate() may cause the file to become smaller or larger.
600 **
601 ** dbHintSize
602 **
603 ** The dbHintSize variable is used to limit the number of calls made to
604 ** the VFS xFileControl(FCNTL_SIZE_HINT) method.
605 **
606 ** dbHintSize is set to a copy of the dbSize variable when a
607 ** write-transaction is opened (at the same time as dbFileSize and
608 ** dbOrigSize). If the xFileControl(FCNTL_SIZE_HINT) method is called,
609 ** dbHintSize is increased to the number of pages that correspond to the
610 ** size-hint passed to the method call. See pager_write_pagelist() for
611 ** details.
612 **
613 ** errCode
614 **
615 ** The Pager.errCode variable is only ever used in PAGER_ERROR state. It
616 ** is set to zero in all other states. In PAGER_ERROR state, Pager.errCode
617 ** is always set to SQLITE_FULL, SQLITE_IOERR or one of the SQLITE_IOERR_XXX
618 ** sub-codes.
619 */
620 struct Pager {
621 sqlite3_vfs *pVfs; /* OS functions to use for IO */
622 u8 exclusiveMode; /* Boolean. True if locking_mode==EXCLUSIVE */
623 u8 journalMode; /* One of the PAGER_JOURNALMODE_* values */
624 u8 useJournal; /* Use a rollback journal on this file */
625 u8 noSync; /* Do not sync the journal if true */
626 u8 fullSync; /* Do extra syncs of the journal for robustness */
627 u8 extraSync; /* sync directory after journal delete */
628 u8 ckptSyncFlags; /* SYNC_NORMAL or SYNC_FULL for checkpoint */
629 u8 walSyncFlags; /* SYNC_NORMAL or SYNC_FULL for wal writes */
630 u8 syncFlags; /* SYNC_NORMAL or SYNC_FULL otherwise */
631 u8 tempFile; /* zFilename is a temporary or immutable file */
632 u8 noLock; /* Do not lock (except in WAL mode) */
633 u8 readOnly; /* True for a read-only database */
634 u8 memDb; /* True to inhibit all file I/O */
635
636 /**************************************************************************
637 ** The following block contains those class members that change during
638 ** routine operation. Class members not in this block are either fixed
639 ** when the pager is first created or else only change when there is a
640 ** significant mode change (such as changing the page_size, locking_mode,
641 ** or the journal_mode). From another view, these class members describe
642 ** the "state" of the pager, while other class members describe the
643 ** "configuration" of the pager.
644 */
645 u8 eState; /* Pager state (OPEN, READER, WRITER_LOCKED..) */
646 u8 eLock; /* Current lock held on database file */
647 u8 changeCountDone; /* Set after incrementing the change-counter */
648 u8 setMaster; /* True if a m-j name has been written to jrnl */
649 u8 doNotSpill; /* Do not spill the cache when non-zero */
650 u8 subjInMemory; /* True to use in-memory sub-journals */
651 u8 bUseFetch; /* True to use xFetch() */
652 u8 hasHeldSharedLock; /* True if a shared lock has ever been held */
653 Pgno dbSize; /* Number of pages in the database */
654 Pgno dbOrigSize; /* dbSize before the current transaction */
655 Pgno dbFileSize; /* Number of pages in the database file */
656 Pgno dbHintSize; /* Value passed to FCNTL_SIZE_HINT call */
657 int errCode; /* One of several kinds of errors */
658 int nRec; /* Pages journalled since last j-header written */
659 u32 cksumInit; /* Quasi-random value added to every checksum */
660 u32 nSubRec; /* Number of records written to sub-journal */
661 Bitvec *pInJournal; /* One bit for each page in the database file */
662 sqlite3_file *fd; /* File descriptor for database */
663 sqlite3_file *jfd; /* File descriptor for main journal */
664 sqlite3_file *sjfd; /* File descriptor for sub-journal */
665 i64 journalOff; /* Current write offset in the journal file */
666 i64 journalHdr; /* Byte offset to previous journal header */
667 sqlite3_backup *pBackup; /* Pointer to list of ongoing backup processes */
668 PagerSavepoint *aSavepoint; /* Array of active savepoints */
669 int nSavepoint; /* Number of elements in aSavepoint[] */
670 u32 iDataVersion; /* Changes whenever database content changes */
671 char dbFileVers[16]; /* Changes whenever database file changes */
672
673 int nMmapOut; /* Number of mmap pages currently outstanding */
674 sqlite3_int64 szMmap; /* Desired maximum mmap size */
675 PgHdr *pMmapFreelist; /* List of free mmap page headers (pDirty) */
676 /*
677 ** End of the routinely-changing class members
678 ***************************************************************************/
679
680 u16 nExtra; /* Add this many bytes to each in-memory page */
681 i16 nReserve; /* Number of unused bytes at end of each page */
682 u32 vfsFlags; /* Flags for sqlite3_vfs.xOpen() */
683 u32 sectorSize; /* Assumed sector size during rollback */
684 int pageSize; /* Number of bytes in a page */
685 Pgno mxPgno; /* Maximum allowed size of the database */
686 i64 journalSizeLimit; /* Size limit for persistent journal files */
687 char *zFilename; /* Name of the database file */
688 char *zJournal; /* Name of the journal file */
689 int (*xBusyHandler)(void*); /* Function to call when busy */
690 void *pBusyHandlerArg; /* Context argument for xBusyHandler */
691 int aStat[3]; /* Total cache hits, misses and writes */
692 #ifdef SQLITE_TEST
693 int nRead; /* Database pages read */
694 #endif
695 void (*xReiniter)(DbPage*); /* Call this routine when reloading pages */
696 int (*xGet)(Pager*,Pgno,DbPage**,int); /* Routine to fetch a patch */
697 #ifdef SQLITE_HAS_CODEC
698 void *(*xCodec)(void*,void*,Pgno,int); /* Routine for en/decoding data */
699 void (*xCodecSizeChng)(void*,int,int); /* Notify of page size changes */
700 void (*xCodecFree)(void*); /* Destructor for the codec */
701 void *pCodec; /* First argument to xCodec... methods */
702 #endif
703 char *pTmpSpace; /* Pager.pageSize bytes of space for tmp use */
704 PCache *pPCache; /* Pointer to page cache object */
705 #ifndef SQLITE_OMIT_WAL
706 Wal *pWal; /* Write-ahead log used by "journal_mode=wal" */
707 char *zWal; /* File name for write-ahead log */
708 #endif
709 };
710
711 /*
712 ** Indexes for use with Pager.aStat[]. The Pager.aStat[] array contains
713 ** the values accessed by passing SQLITE_DBSTATUS_CACHE_HIT, CACHE_MISS
714 ** or CACHE_WRITE to sqlite3_db_status().
715 */
716 #define PAGER_STAT_HIT 0
717 #define PAGER_STAT_MISS 1
718 #define PAGER_STAT_WRITE 2
719
720 /*
721 ** The following global variables hold counters used for
722 ** testing purposes only. These variables do not exist in
723 ** a non-testing build. These variables are not thread-safe.
724 */
725 #ifdef SQLITE_TEST
726 int sqlite3_pager_readdb_count = 0; /* Number of full pages read from DB */
727 int sqlite3_pager_writedb_count = 0; /* Number of full pages written to DB */
728 int sqlite3_pager_writej_count = 0; /* Number of pages written to journal */
729 # define PAGER_INCR(v) v++
730 #else
731 # define PAGER_INCR(v)
732 #endif
733
734
735
736 /*
737 ** Journal files begin with the following magic string. The data
738 ** was obtained from /dev/random. It is used only as a sanity check.
739 **
740 ** Since version 2.8.0, the journal format contains additional sanity
741 ** checking information. If the power fails while the journal is being
742 ** written, semi-random garbage data might appear in the journal
743 ** file after power is restored. If an attempt is then made
744 ** to roll the journal back, the database could be corrupted. The additional
745 ** sanity checking data is an attempt to discover the garbage in the
746 ** journal and ignore it.
747 **
748 ** The sanity checking information for the new journal format consists
749 ** of a 32-bit checksum on each page of data. The checksum covers both
750 ** the page number and the pPager->pageSize bytes of data for the page.
751 ** This cksum is initialized to a 32-bit random value that appears in the
752 ** journal file right after the header. The random initializer is important,
753 ** because garbage data that appears at the end of a journal is likely
754 ** data that was once in other files that have now been deleted. If the
755 ** garbage data came from an obsolete journal file, the checksums might
756 ** be correct. But by initializing the checksum to random value which
757 ** is different for every journal, we minimize that risk.
758 */
759 static const unsigned char aJournalMagic[] = {
760 0xd9, 0xd5, 0x05, 0xf9, 0x20, 0xa1, 0x63, 0xd7,
761 };
762
763 /*
764 ** The size of the of each page record in the journal is given by
765 ** the following macro.
766 */
767 #define JOURNAL_PG_SZ(pPager) ((pPager->pageSize) + 8)
768
769 /*
770 ** The journal header size for this pager. This is usually the same
771 ** size as a single disk sector. See also setSectorSize().
772 */
773 #define JOURNAL_HDR_SZ(pPager) (pPager->sectorSize)
774
775 /*
776 ** The macro MEMDB is true if we are dealing with an in-memory database.
777 ** We do this as a macro so that if the SQLITE_OMIT_MEMORYDB macro is set,
778 ** the value of MEMDB will be a constant and the compiler will optimize
779 ** out code that would never execute.
780 */
781 #ifdef SQLITE_OMIT_MEMORYDB
782 # define MEMDB 0
783 #else
784 # define MEMDB pPager->memDb
785 #endif
786
787 /*
788 ** The macro USEFETCH is true if we are allowed to use the xFetch and xUnfetch
789 ** interfaces to access the database using memory-mapped I/O.
790 */
791 #if SQLITE_MAX_MMAP_SIZE>0
792 # define USEFETCH(x) ((x)->bUseFetch)
793 #else
794 # define USEFETCH(x) 0
795 #endif
796
797 /*
798 ** The maximum legal page number is (2^31 - 1).
799 */
800 #define PAGER_MAX_PGNO 2147483647
801
802 /*
803 ** The argument to this macro is a file descriptor (type sqlite3_file*).
804 ** Return 0 if it is not open, or non-zero (but not 1) if it is.
805 **
806 ** This is so that expressions can be written as:
807 **
808 ** if( isOpen(pPager->jfd) ){ ...
809 **
810 ** instead of
811 **
812 ** if( pPager->jfd->pMethods ){ ...
813 */
814 #define isOpen(pFd) ((pFd)->pMethods!=0)
815
816 /*
817 ** Return true if this pager uses a write-ahead log to read page pgno.
818 ** Return false if the pager reads pgno directly from the database.
819 */
820 #if !defined(SQLITE_OMIT_WAL) && defined(SQLITE_DIRECT_OVERFLOW_READ)
821 int sqlite3PagerUseWal(Pager *pPager, Pgno pgno){
822 u32 iRead = 0;
823 int rc;
824 if( pPager->pWal==0 ) return 0;
825 rc = sqlite3WalFindFrame(pPager->pWal, pgno, &iRead);
826 return rc || iRead;
827 }
828 #endif
829 #ifndef SQLITE_OMIT_WAL
830 # define pagerUseWal(x) ((x)->pWal!=0)
831 #else
832 # define pagerUseWal(x) 0
833 # define pagerRollbackWal(x) 0
834 # define pagerWalFrames(v,w,x,y) 0
835 # define pagerOpenWalIfPresent(z) SQLITE_OK
836 # define pagerBeginReadTransaction(z) SQLITE_OK
837 #endif
838
839 #ifndef NDEBUG
840 /*
841 ** Usage:
842 **
843 ** assert( assert_pager_state(pPager) );
844 **
845 ** This function runs many asserts to try to find inconsistencies in
846 ** the internal state of the Pager object.
847 */
848 static int assert_pager_state(Pager *p){
849 Pager *pPager = p;
850
851 /* State must be valid. */
852 assert( p->eState==PAGER_OPEN
853 || p->eState==PAGER_READER
854 || p->eState==PAGER_WRITER_LOCKED
855 || p->eState==PAGER_WRITER_CACHEMOD
856 || p->eState==PAGER_WRITER_DBMOD
857 || p->eState==PAGER_WRITER_FINISHED
858 || p->eState==PAGER_ERROR
859 );
860
861 /* Regardless of the current state, a temp-file connection always behaves
862 ** as if it has an exclusive lock on the database file. It never updates
863 ** the change-counter field, so the changeCountDone flag is always set.
864 */
865 assert( p->tempFile==0 || p->eLock==EXCLUSIVE_LOCK );
866 assert( p->tempFile==0 || pPager->changeCountDone );
867
868 /* If the useJournal flag is clear, the journal-mode must be "OFF".
869 ** And if the journal-mode is "OFF", the journal file must not be open.
870 */
871 assert( p->journalMode==PAGER_JOURNALMODE_OFF || p->useJournal );
872 assert( p->journalMode!=PAGER_JOURNALMODE_OFF || !isOpen(p->jfd) );
873
874 /* Check that MEMDB implies noSync. And an in-memory journal. Since
875 ** this means an in-memory pager performs no IO at all, it cannot encounter
876 ** either SQLITE_IOERR or SQLITE_FULL during rollback or while finalizing
877 ** a journal file. (although the in-memory journal implementation may
878 ** return SQLITE_IOERR_NOMEM while the journal file is being written). It
879 ** is therefore not possible for an in-memory pager to enter the ERROR
880 ** state.
881 */
882 if( MEMDB ){
883 assert( !isOpen(p->fd) );
884 assert( p->noSync );
885 assert( p->journalMode==PAGER_JOURNALMODE_OFF
886 || p->journalMode==PAGER_JOURNALMODE_MEMORY
887 );
888 assert( p->eState!=PAGER_ERROR && p->eState!=PAGER_OPEN );
889 assert( pagerUseWal(p)==0 );
890 }
891
892 /* If changeCountDone is set, a RESERVED lock or greater must be held
893 ** on the file.
894 */
895 assert( pPager->changeCountDone==0 || pPager->eLock>=RESERVED_LOCK );
896 assert( p->eLock!=PENDING_LOCK );
897
898 switch( p->eState ){
899 case PAGER_OPEN:
900 assert( !MEMDB );
901 assert( pPager->errCode==SQLITE_OK );
902 assert( sqlite3PcacheRefCount(pPager->pPCache)==0 || pPager->tempFile );
903 break;
904
905 case PAGER_READER:
906 assert( pPager->errCode==SQLITE_OK );
907 assert( p->eLock!=UNKNOWN_LOCK );
908 assert( p->eLock>=SHARED_LOCK );
909 break;
910
911 case PAGER_WRITER_LOCKED:
912 assert( p->eLock!=UNKNOWN_LOCK );
913 assert( pPager->errCode==SQLITE_OK );
914 if( !pagerUseWal(pPager) ){
915 assert( p->eLock>=RESERVED_LOCK );
916 }
917 assert( pPager->dbSize==pPager->dbOrigSize );
918 assert( pPager->dbOrigSize==pPager->dbFileSize );
919 assert( pPager->dbOrigSize==pPager->dbHintSize );
920 assert( pPager->setMaster==0 );
921 break;
922
923 case PAGER_WRITER_CACHEMOD:
924 assert( p->eLock!=UNKNOWN_LOCK );
925 assert( pPager->errCode==SQLITE_OK );
926 if( !pagerUseWal(pPager) ){
927 /* It is possible that if journal_mode=wal here that neither the
928 ** journal file nor the WAL file are open. This happens during
929 ** a rollback transaction that switches from journal_mode=off
930 ** to journal_mode=wal.
931 */
932 assert( p->eLock>=RESERVED_LOCK );
933 assert( isOpen(p->jfd)
934 || p->journalMode==PAGER_JOURNALMODE_OFF
935 || p->journalMode==PAGER_JOURNALMODE_WAL
936 );
937 }
938 assert( pPager->dbOrigSize==pPager->dbFileSize );
939 assert( pPager->dbOrigSize==pPager->dbHintSize );
940 break;
941
942 case PAGER_WRITER_DBMOD:
943 assert( p->eLock==EXCLUSIVE_LOCK );
944 assert( pPager->errCode==SQLITE_OK );
945 assert( !pagerUseWal(pPager) );
946 assert( p->eLock>=EXCLUSIVE_LOCK );
947 assert( isOpen(p->jfd)
948 || p->journalMode==PAGER_JOURNALMODE_OFF
949 || p->journalMode==PAGER_JOURNALMODE_WAL
950 );
951 assert( pPager->dbOrigSize<=pPager->dbHintSize );
952 break;
953
954 case PAGER_WRITER_FINISHED:
955 assert( p->eLock==EXCLUSIVE_LOCK );
956 assert( pPager->errCode==SQLITE_OK );
957 assert( !pagerUseWal(pPager) );
958 assert( isOpen(p->jfd)
959 || p->journalMode==PAGER_JOURNALMODE_OFF
960 || p->journalMode==PAGER_JOURNALMODE_WAL
961 );
962 break;
963
964 case PAGER_ERROR:
965 /* There must be at least one outstanding reference to the pager if
966 ** in ERROR state. Otherwise the pager should have already dropped
967 ** back to OPEN state.
968 */
969 assert( pPager->errCode!=SQLITE_OK );
970 assert( sqlite3PcacheRefCount(pPager->pPCache)>0 || pPager->tempFile );
971 break;
972 }
973
974 return 1;
975 }
976 #endif /* ifndef NDEBUG */
977
978 #ifdef SQLITE_DEBUG
979 /*
980 ** Return a pointer to a human readable string in a static buffer
981 ** containing the state of the Pager object passed as an argument. This
982 ** is intended to be used within debuggers. For example, as an alternative
983 ** to "print *pPager" in gdb:
984 **
985 ** (gdb) printf "%s", print_pager_state(pPager)
986 */
987 static char *print_pager_state(Pager *p){
988 static char zRet[1024];
989
990 sqlite3_snprintf(1024, zRet,
991 "Filename: %s\n"
992 "State: %s errCode=%d\n"
993 "Lock: %s\n"
994 "Locking mode: locking_mode=%s\n"
995 "Journal mode: journal_mode=%s\n"
996 "Backing store: tempFile=%d memDb=%d useJournal=%d\n"
997 "Journal: journalOff=%lld journalHdr=%lld\n"
998 "Size: dbsize=%d dbOrigSize=%d dbFileSize=%d\n"
999 , p->zFilename
1000 , p->eState==PAGER_OPEN ? "OPEN" :
1001 p->eState==PAGER_READER ? "READER" :
1002 p->eState==PAGER_WRITER_LOCKED ? "WRITER_LOCKED" :
1003 p->eState==PAGER_WRITER_CACHEMOD ? "WRITER_CACHEMOD" :
1004 p->eState==PAGER_WRITER_DBMOD ? "WRITER_DBMOD" :
1005 p->eState==PAGER_WRITER_FINISHED ? "WRITER_FINISHED" :
1006 p->eState==PAGER_ERROR ? "ERROR" : "?error?"
1007 , (int)p->errCode
1008 , p->eLock==NO_LOCK ? "NO_LOCK" :
1009 p->eLock==RESERVED_LOCK ? "RESERVED" :
1010 p->eLock==EXCLUSIVE_LOCK ? "EXCLUSIVE" :
1011 p->eLock==SHARED_LOCK ? "SHARED" :
1012 p->eLock==UNKNOWN_LOCK ? "UNKNOWN" : "?error?"
1013 , p->exclusiveMode ? "exclusive" : "normal"
1014 , p->journalMode==PAGER_JOURNALMODE_MEMORY ? "memory" :
1015 p->journalMode==PAGER_JOURNALMODE_OFF ? "off" :
1016 p->journalMode==PAGER_JOURNALMODE_DELETE ? "delete" :
1017 p->journalMode==PAGER_JOURNALMODE_PERSIST ? "persist" :
1018 p->journalMode==PAGER_JOURNALMODE_TRUNCATE ? "truncate" :
1019 p->journalMode==PAGER_JOURNALMODE_WAL ? "wal" : "?error?"
1020 , (int)p->tempFile, (int)p->memDb, (int)p->useJournal
1021 , p->journalOff, p->journalHdr
1022 , (int)p->dbSize, (int)p->dbOrigSize, (int)p->dbFileSize
1023 );
1024
1025 return zRet;
1026 }
1027 #endif
1028
1029 /* Forward references to the various page getters */
1030 static int getPageNormal(Pager*,Pgno,DbPage**,int);
1031 static int getPageError(Pager*,Pgno,DbPage**,int);
1032 #if SQLITE_MAX_MMAP_SIZE>0
1033 static int getPageMMap(Pager*,Pgno,DbPage**,int);
1034 #endif
1035
1036 /*
1037 ** Set the Pager.xGet method for the appropriate routine used to fetch
1038 ** content from the pager.
1039 */
1040 static void setGetterMethod(Pager *pPager){
1041 if( pPager->errCode ){
1042 pPager->xGet = getPageError;
1043 #if SQLITE_MAX_MMAP_SIZE>0
1044 }else if( USEFETCH(pPager)
1045 #ifdef SQLITE_HAS_CODEC
1046 && pPager->xCodec==0
1047 #endif
1048 ){
1049 pPager->xGet = getPageMMap;
1050 #endif /* SQLITE_MAX_MMAP_SIZE>0 */
1051 }else{
1052 pPager->xGet = getPageNormal;
1053 }
1054 }
1055
1056 /*
1057 ** Return true if it is necessary to write page *pPg into the sub-journal.
1058 ** A page needs to be written into the sub-journal if there exists one
1059 ** or more open savepoints for which:
1060 **
1061 ** * The page-number is less than or equal to PagerSavepoint.nOrig, and
1062 ** * The bit corresponding to the page-number is not set in
1063 ** PagerSavepoint.pInSavepoint.
1064 */
1065 static int subjRequiresPage(PgHdr *pPg){
1066 Pager *pPager = pPg->pPager;
1067 PagerSavepoint *p;
1068 Pgno pgno = pPg->pgno;
1069 int i;
1070 for(i=0; i<pPager->nSavepoint; i++){
1071 p = &pPager->aSavepoint[i];
1072 if( p->nOrig>=pgno && 0==sqlite3BitvecTestNotNull(p->pInSavepoint, pgno) ){
1073 return 1;
1074 }
1075 }
1076 return 0;
1077 }
1078
1079 #ifdef SQLITE_DEBUG
1080 /*
1081 ** Return true if the page is already in the journal file.
1082 */
1083 static int pageInJournal(Pager *pPager, PgHdr *pPg){
1084 return sqlite3BitvecTest(pPager->pInJournal, pPg->pgno);
1085 }
1086 #endif
1087
1088 /*
1089 ** Read a 32-bit integer from the given file descriptor. Store the integer
1090 ** that is read in *pRes. Return SQLITE_OK if everything worked, or an
1091 ** error code is something goes wrong.
1092 **
1093 ** All values are stored on disk as big-endian.
1094 */
1095 static int read32bits(sqlite3_file *fd, i64 offset, u32 *pRes){
1096 unsigned char ac[4];
1097 int rc = sqlite3OsRead(fd, ac, sizeof(ac), offset);
1098 if( rc==SQLITE_OK ){
1099 *pRes = sqlite3Get4byte(ac);
1100 }
1101 return rc;
1102 }
1103
1104 /*
1105 ** Write a 32-bit integer into a string buffer in big-endian byte order.
1106 */
1107 #define put32bits(A,B) sqlite3Put4byte((u8*)A,B)
1108
1109
1110 /*
1111 ** Write a 32-bit integer into the given file descriptor. Return SQLITE_OK
1112 ** on success or an error code is something goes wrong.
1113 */
1114 static int write32bits(sqlite3_file *fd, i64 offset, u32 val){
1115 char ac[4];
1116 put32bits(ac, val);
1117 return sqlite3OsWrite(fd, ac, 4, offset);
1118 }
1119
1120 /*
1121 ** Unlock the database file to level eLock, which must be either NO_LOCK
1122 ** or SHARED_LOCK. Regardless of whether or not the call to xUnlock()
1123 ** succeeds, set the Pager.eLock variable to match the (attempted) new lock.
1124 **
1125 ** Except, if Pager.eLock is set to UNKNOWN_LOCK when this function is
1126 ** called, do not modify it. See the comment above the #define of
1127 ** UNKNOWN_LOCK for an explanation of this.
1128 */
1129 static int pagerUnlockDb(Pager *pPager, int eLock){
1130 int rc = SQLITE_OK;
1131
1132 assert( !pPager->exclusiveMode || pPager->eLock==eLock );
1133 assert( eLock==NO_LOCK || eLock==SHARED_LOCK );
1134 assert( eLock!=NO_LOCK || pagerUseWal(pPager)==0 );
1135 if( isOpen(pPager->fd) ){
1136 assert( pPager->eLock>=eLock );
1137 rc = pPager->noLock ? SQLITE_OK : sqlite3OsUnlock(pPager->fd, eLock);
1138 if( pPager->eLock!=UNKNOWN_LOCK ){
1139 pPager->eLock = (u8)eLock;
1140 }
1141 IOTRACE(("UNLOCK %p %d\n", pPager, eLock))
1142 }
1143 return rc;
1144 }
1145
1146 /*
1147 ** Lock the database file to level eLock, which must be either SHARED_LOCK,
1148 ** RESERVED_LOCK or EXCLUSIVE_LOCK. If the caller is successful, set the
1149 ** Pager.eLock variable to the new locking state.
1150 **
1151 ** Except, if Pager.eLock is set to UNKNOWN_LOCK when this function is
1152 ** called, do not modify it unless the new locking state is EXCLUSIVE_LOCK.
1153 ** See the comment above the #define of UNKNOWN_LOCK for an explanation
1154 ** of this.
1155 */
1156 static int pagerLockDb(Pager *pPager, int eLock){
1157 int rc = SQLITE_OK;
1158
1159 assert( eLock==SHARED_LOCK || eLock==RESERVED_LOCK || eLock==EXCLUSIVE_LOCK );
1160 if( pPager->eLock<eLock || pPager->eLock==UNKNOWN_LOCK ){
1161 rc = pPager->noLock ? SQLITE_OK : sqlite3OsLock(pPager->fd, eLock);
1162 if( rc==SQLITE_OK && (pPager->eLock!=UNKNOWN_LOCK||eLock==EXCLUSIVE_LOCK) ){
1163 pPager->eLock = (u8)eLock;
1164 IOTRACE(("LOCK %p %d\n", pPager, eLock))
1165 }
1166 }
1167 return rc;
1168 }
1169
1170 /*
1171 ** This function determines whether or not the atomic-write optimization
1172 ** can be used with this pager. The optimization can be used if:
1173 **
1174 ** (a) the value returned by OsDeviceCharacteristics() indicates that
1175 ** a database page may be written atomically, and
1176 ** (b) the value returned by OsSectorSize() is less than or equal
1177 ** to the page size.
1178 **
1179 ** The optimization is also always enabled for temporary files. It is
1180 ** an error to call this function if pPager is opened on an in-memory
1181 ** database.
1182 **
1183 ** If the optimization cannot be used, 0 is returned. If it can be used,
1184 ** then the value returned is the size of the journal file when it
1185 ** contains rollback data for exactly one page.
1186 */
1187 #ifdef SQLITE_ENABLE_ATOMIC_WRITE
1188 static int jrnlBufferSize(Pager *pPager){
1189 assert( !MEMDB );
1190 if( !pPager->tempFile ){
1191 int dc; /* Device characteristics */
1192 int nSector; /* Sector size */
1193 int szPage; /* Page size */
1194
1195 assert( isOpen(pPager->fd) );
1196 dc = sqlite3OsDeviceCharacteristics(pPager->fd);
1197 nSector = pPager->sectorSize;
1198 szPage = pPager->pageSize;
1199
1200 assert(SQLITE_IOCAP_ATOMIC512==(512>>8));
1201 assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8));
1202 if( 0==(dc&(SQLITE_IOCAP_ATOMIC|(szPage>>8)) || nSector>szPage) ){
1203 return 0;
1204 }
1205 }
1206
1207 return JOURNAL_HDR_SZ(pPager) + JOURNAL_PG_SZ(pPager);
1208 }
1209 #else
1210 # define jrnlBufferSize(x) 0
1211 #endif
1212
1213 /*
1214 ** If SQLITE_CHECK_PAGES is defined then we do some sanity checking
1215 ** on the cache using a hash function. This is used for testing
1216 ** and debugging only.
1217 */
1218 #ifdef SQLITE_CHECK_PAGES
1219 /*
1220 ** Return a 32-bit hash of the page data for pPage.
1221 */
1222 static u32 pager_datahash(int nByte, unsigned char *pData){
1223 u32 hash = 0;
1224 int i;
1225 for(i=0; i<nByte; i++){
1226 hash = (hash*1039) + pData[i];
1227 }
1228 return hash;
1229 }
1230 static u32 pager_pagehash(PgHdr *pPage){
1231 return pager_datahash(pPage->pPager->pageSize, (unsigned char *)pPage->pData);
1232 }
1233 static void pager_set_pagehash(PgHdr *pPage){
1234 pPage->pageHash = pager_pagehash(pPage);
1235 }
1236
1237 /*
1238 ** The CHECK_PAGE macro takes a PgHdr* as an argument. If SQLITE_CHECK_PAGES
1239 ** is defined, and NDEBUG is not defined, an assert() statement checks
1240 ** that the page is either dirty or still matches the calculated page-hash.
1241 */
1242 #define CHECK_PAGE(x) checkPage(x)
1243 static void checkPage(PgHdr *pPg){
1244 Pager *pPager = pPg->pPager;
1245 assert( pPager->eState!=PAGER_ERROR );
1246 assert( (pPg->flags&PGHDR_DIRTY) || pPg->pageHash==pager_pagehash(pPg) );
1247 }
1248
1249 #else
1250 #define pager_datahash(X,Y) 0
1251 #define pager_pagehash(X) 0
1252 #define pager_set_pagehash(X)
1253 #define CHECK_PAGE(x)
1254 #endif /* SQLITE_CHECK_PAGES */
1255
1256 /*
1257 ** When this is called the journal file for pager pPager must be open.
1258 ** This function attempts to read a master journal file name from the
1259 ** end of the file and, if successful, copies it into memory supplied
1260 ** by the caller. See comments above writeMasterJournal() for the format
1261 ** used to store a master journal file name at the end of a journal file.
1262 **
1263 ** zMaster must point to a buffer of at least nMaster bytes allocated by
1264 ** the caller. This should be sqlite3_vfs.mxPathname+1 (to ensure there is
1265 ** enough space to write the master journal name). If the master journal
1266 ** name in the journal is longer than nMaster bytes (including a
1267 ** nul-terminator), then this is handled as if no master journal name
1268 ** were present in the journal.
1269 **
1270 ** If a master journal file name is present at the end of the journal
1271 ** file, then it is copied into the buffer pointed to by zMaster. A
1272 ** nul-terminator byte is appended to the buffer following the master
1273 ** journal file name.
1274 **
1275 ** If it is determined that no master journal file name is present
1276 ** zMaster[0] is set to 0 and SQLITE_OK returned.
1277 **
1278 ** If an error occurs while reading from the journal file, an SQLite
1279 ** error code is returned.
1280 */
1281 static int readMasterJournal(sqlite3_file *pJrnl, char *zMaster, u32 nMaster){
1282 int rc; /* Return code */
1283 u32 len; /* Length in bytes of master journal name */
1284 i64 szJ; /* Total size in bytes of journal file pJrnl */
1285 u32 cksum; /* MJ checksum value read from journal */
1286 u32 u; /* Unsigned loop counter */
1287 unsigned char aMagic[8]; /* A buffer to hold the magic header */
1288 zMaster[0] = '\0';
1289
1290 if( SQLITE_OK!=(rc = sqlite3OsFileSize(pJrnl, &szJ))
1291 || szJ<16
1292 || SQLITE_OK!=(rc = read32bits(pJrnl, szJ-16, &len))
1293 || len>=nMaster
1294 || len==0
1295 || SQLITE_OK!=(rc = read32bits(pJrnl, szJ-12, &cksum))
1296 || SQLITE_OK!=(rc = sqlite3OsRead(pJrnl, aMagic, 8, szJ-8))
1297 || memcmp(aMagic, aJournalMagic, 8)
1298 || SQLITE_OK!=(rc = sqlite3OsRead(pJrnl, zMaster, len, szJ-16-len))
1299 ){
1300 return rc;
1301 }
1302
1303 /* See if the checksum matches the master journal name */
1304 for(u=0; u<len; u++){
1305 cksum -= zMaster[u];
1306 }
1307 if( cksum ){
1308 /* If the checksum doesn't add up, then one or more of the disk sectors
1309 ** containing the master journal filename is corrupted. This means
1310 ** definitely roll back, so just return SQLITE_OK and report a (nul)
1311 ** master-journal filename.
1312 */
1313 len = 0;
1314 }
1315 zMaster[len] = '\0';
1316
1317 return SQLITE_OK;
1318 }
1319
1320 /*
1321 ** Return the offset of the sector boundary at or immediately
1322 ** following the value in pPager->journalOff, assuming a sector
1323 ** size of pPager->sectorSize bytes.
1324 **
1325 ** i.e for a sector size of 512:
1326 **
1327 ** Pager.journalOff Return value
1328 ** ---------------------------------------
1329 ** 0 0
1330 ** 512 512
1331 ** 100 512
1332 ** 2000 2048
1333 **
1334 */
1335 static i64 journalHdrOffset(Pager *pPager){
1336 i64 offset = 0;
1337 i64 c = pPager->journalOff;
1338 if( c ){
1339 offset = ((c-1)/JOURNAL_HDR_SZ(pPager) + 1) * JOURNAL_HDR_SZ(pPager);
1340 }
1341 assert( offset%JOURNAL_HDR_SZ(pPager)==0 );
1342 assert( offset>=c );
1343 assert( (offset-c)<JOURNAL_HDR_SZ(pPager) );
1344 return offset;
1345 }
1346
1347 /*
1348 ** The journal file must be open when this function is called.
1349 **
1350 ** This function is a no-op if the journal file has not been written to
1351 ** within the current transaction (i.e. if Pager.journalOff==0).
1352 **
1353 ** If doTruncate is non-zero or the Pager.journalSizeLimit variable is
1354 ** set to 0, then truncate the journal file to zero bytes in size. Otherwise,
1355 ** zero the 28-byte header at the start of the journal file. In either case,
1356 ** if the pager is not in no-sync mode, sync the journal file immediately
1357 ** after writing or truncating it.
1358 **
1359 ** If Pager.journalSizeLimit is set to a positive, non-zero value, and
1360 ** following the truncation or zeroing described above the size of the
1361 ** journal file in bytes is larger than this value, then truncate the
1362 ** journal file to Pager.journalSizeLimit bytes. The journal file does
1363 ** not need to be synced following this operation.
1364 **
1365 ** If an IO error occurs, abandon processing and return the IO error code.
1366 ** Otherwise, return SQLITE_OK.
1367 */
1368 static int zeroJournalHdr(Pager *pPager, int doTruncate){
1369 int rc = SQLITE_OK; /* Return code */
1370 assert( isOpen(pPager->jfd) );
1371 assert( !sqlite3JournalIsInMemory(pPager->jfd) );
1372 if( pPager->journalOff ){
1373 const i64 iLimit = pPager->journalSizeLimit; /* Local cache of jsl */
1374
1375 IOTRACE(("JZEROHDR %p\n", pPager))
1376 if( doTruncate || iLimit==0 ){
1377 rc = sqlite3OsTruncate(pPager->jfd, 0);
1378 }else{
1379 static const char zeroHdr[28] = {0};
1380 rc = sqlite3OsWrite(pPager->jfd, zeroHdr, sizeof(zeroHdr), 0);
1381 }
1382 if( rc==SQLITE_OK && !pPager->noSync ){
1383 rc = sqlite3OsSync(pPager->jfd, SQLITE_SYNC_DATAONLY|pPager->syncFlags);
1384 }
1385
1386 /* At this point the transaction is committed but the write lock
1387 ** is still held on the file. If there is a size limit configured for
1388 ** the persistent journal and the journal file currently consumes more
1389 ** space than that limit allows for, truncate it now. There is no need
1390 ** to sync the file following this operation.
1391 */
1392 if( rc==SQLITE_OK && iLimit>0 ){
1393 i64 sz;
1394 rc = sqlite3OsFileSize(pPager->jfd, &sz);
1395 if( rc==SQLITE_OK && sz>iLimit ){
1396 rc = sqlite3OsTruncate(pPager->jfd, iLimit);
1397 }
1398 }
1399 }
1400 return rc;
1401 }
1402
1403 /*
1404 ** The journal file must be open when this routine is called. A journal
1405 ** header (JOURNAL_HDR_SZ bytes) is written into the journal file at the
1406 ** current location.
1407 **
1408 ** The format for the journal header is as follows:
1409 ** - 8 bytes: Magic identifying journal format.
1410 ** - 4 bytes: Number of records in journal, or -1 no-sync mode is on.
1411 ** - 4 bytes: Random number used for page hash.
1412 ** - 4 bytes: Initial database page count.
1413 ** - 4 bytes: Sector size used by the process that wrote this journal.
1414 ** - 4 bytes: Database page size.
1415 **
1416 ** Followed by (JOURNAL_HDR_SZ - 28) bytes of unused space.
1417 */
1418 static int writeJournalHdr(Pager *pPager){
1419 int rc = SQLITE_OK; /* Return code */
1420 char *zHeader = pPager->pTmpSpace; /* Temporary space used to build header */
1421 u32 nHeader = (u32)pPager->pageSize;/* Size of buffer pointed to by zHeader */
1422 u32 nWrite; /* Bytes of header sector written */
1423 int ii; /* Loop counter */
1424
1425 assert( isOpen(pPager->jfd) ); /* Journal file must be open. */
1426
1427 if( nHeader>JOURNAL_HDR_SZ(pPager) ){
1428 nHeader = JOURNAL_HDR_SZ(pPager);
1429 }
1430
1431 /* If there are active savepoints and any of them were created
1432 ** since the most recent journal header was written, update the
1433 ** PagerSavepoint.iHdrOffset fields now.
1434 */
1435 for(ii=0; ii<pPager->nSavepoint; ii++){
1436 if( pPager->aSavepoint[ii].iHdrOffset==0 ){
1437 pPager->aSavepoint[ii].iHdrOffset = pPager->journalOff;
1438 }
1439 }
1440
1441 pPager->journalHdr = pPager->journalOff = journalHdrOffset(pPager);
1442
1443 /*
1444 ** Write the nRec Field - the number of page records that follow this
1445 ** journal header. Normally, zero is written to this value at this time.
1446 ** After the records are added to the journal (and the journal synced,
1447 ** if in full-sync mode), the zero is overwritten with the true number
1448 ** of records (see syncJournal()).
1449 **
1450 ** A faster alternative is to write 0xFFFFFFFF to the nRec field. When
1451 ** reading the journal this value tells SQLite to assume that the
1452 ** rest of the journal file contains valid page records. This assumption
1453 ** is dangerous, as if a failure occurred whilst writing to the journal
1454 ** file it may contain some garbage data. There are two scenarios
1455 ** where this risk can be ignored:
1456 **
1457 ** * When the pager is in no-sync mode. Corruption can follow a
1458 ** power failure in this case anyway.
1459 **
1460 ** * When the SQLITE_IOCAP_SAFE_APPEND flag is set. This guarantees
1461 ** that garbage data is never appended to the journal file.
1462 */
1463 assert( isOpen(pPager->fd) || pPager->noSync );
1464 if( pPager->noSync || (pPager->journalMode==PAGER_JOURNALMODE_MEMORY)
1465 || (sqlite3OsDeviceCharacteristics(pPager->fd)&SQLITE_IOCAP_SAFE_APPEND)
1466 ){
1467 memcpy(zHeader, aJournalMagic, sizeof(aJournalMagic));
1468 put32bits(&zHeader[sizeof(aJournalMagic)], 0xffffffff);
1469 }else{
1470 memset(zHeader, 0, sizeof(aJournalMagic)+4);
1471 }
1472
1473 /* The random check-hash initializer */
1474 sqlite3_randomness(sizeof(pPager->cksumInit), &pPager->cksumInit);
1475 put32bits(&zHeader[sizeof(aJournalMagic)+4], pPager->cksumInit);
1476 /* The initial database size */
1477 put32bits(&zHeader[sizeof(aJournalMagic)+8], pPager->dbOrigSize);
1478 /* The assumed sector size for this process */
1479 put32bits(&zHeader[sizeof(aJournalMagic)+12], pPager->sectorSize);
1480
1481 /* The page size */
1482 put32bits(&zHeader[sizeof(aJournalMagic)+16], pPager->pageSize);
1483
1484 /* Initializing the tail of the buffer is not necessary. Everything
1485 ** works find if the following memset() is omitted. But initializing
1486 ** the memory prevents valgrind from complaining, so we are willing to
1487 ** take the performance hit.
1488 */
1489 memset(&zHeader[sizeof(aJournalMagic)+20], 0,
1490 nHeader-(sizeof(aJournalMagic)+20));
1491
1492 /* In theory, it is only necessary to write the 28 bytes that the
1493 ** journal header consumes to the journal file here. Then increment the
1494 ** Pager.journalOff variable by JOURNAL_HDR_SZ so that the next
1495 ** record is written to the following sector (leaving a gap in the file
1496 ** that will be implicitly filled in by the OS).
1497 **
1498 ** However it has been discovered that on some systems this pattern can
1499 ** be significantly slower than contiguously writing data to the file,
1500 ** even if that means explicitly writing data to the block of
1501 ** (JOURNAL_HDR_SZ - 28) bytes that will not be used. So that is what
1502 ** is done.
1503 **
1504 ** The loop is required here in case the sector-size is larger than the
1505 ** database page size. Since the zHeader buffer is only Pager.pageSize
1506 ** bytes in size, more than one call to sqlite3OsWrite() may be required
1507 ** to populate the entire journal header sector.
1508 */
1509 for(nWrite=0; rc==SQLITE_OK&&nWrite<JOURNAL_HDR_SZ(pPager); nWrite+=nHeader){
1510 IOTRACE(("JHDR %p %lld %d\n", pPager, pPager->journalHdr, nHeader))
1511 rc = sqlite3OsWrite(pPager->jfd, zHeader, nHeader, pPager->journalOff);
1512 assert( pPager->journalHdr <= pPager->journalOff );
1513 pPager->journalOff += nHeader;
1514 }
1515
1516 return rc;
1517 }
1518
1519 /*
1520 ** The journal file must be open when this is called. A journal header file
1521 ** (JOURNAL_HDR_SZ bytes) is read from the current location in the journal
1522 ** file. The current location in the journal file is given by
1523 ** pPager->journalOff. See comments above function writeJournalHdr() for
1524 ** a description of the journal header format.
1525 **
1526 ** If the header is read successfully, *pNRec is set to the number of
1527 ** page records following this header and *pDbSize is set to the size of the
1528 ** database before the transaction began, in pages. Also, pPager->cksumInit
1529 ** is set to the value read from the journal header. SQLITE_OK is returned
1530 ** in this case.
1531 **
1532 ** If the journal header file appears to be corrupted, SQLITE_DONE is
1533 ** returned and *pNRec and *PDbSize are undefined. If JOURNAL_HDR_SZ bytes
1534 ** cannot be read from the journal file an error code is returned.
1535 */
1536 static int readJournalHdr(
1537 Pager *pPager, /* Pager object */
1538 int isHot,
1539 i64 journalSize, /* Size of the open journal file in bytes */
1540 u32 *pNRec, /* OUT: Value read from the nRec field */
1541 u32 *pDbSize /* OUT: Value of original database size field */
1542 ){
1543 int rc; /* Return code */
1544 unsigned char aMagic[8]; /* A buffer to hold the magic header */
1545 i64 iHdrOff; /* Offset of journal header being read */
1546
1547 assert( isOpen(pPager->jfd) ); /* Journal file must be open. */
1548
1549 /* Advance Pager.journalOff to the start of the next sector. If the
1550 ** journal file is too small for there to be a header stored at this
1551 ** point, return SQLITE_DONE.
1552 */
1553 pPager->journalOff = journalHdrOffset(pPager);
1554 if( pPager->journalOff+JOURNAL_HDR_SZ(pPager) > journalSize ){
1555 return SQLITE_DONE;
1556 }
1557 iHdrOff = pPager->journalOff;
1558
1559 /* Read in the first 8 bytes of the journal header. If they do not match
1560 ** the magic string found at the start of each journal header, return
1561 ** SQLITE_DONE. If an IO error occurs, return an error code. Otherwise,
1562 ** proceed.
1563 */
1564 if( isHot || iHdrOff!=pPager->journalHdr ){
1565 rc = sqlite3OsRead(pPager->jfd, aMagic, sizeof(aMagic), iHdrOff);
1566 if( rc ){
1567 return rc;
1568 }
1569 if( memcmp(aMagic, aJournalMagic, sizeof(aMagic))!=0 ){
1570 return SQLITE_DONE;
1571 }
1572 }
1573
1574 /* Read the first three 32-bit fields of the journal header: The nRec
1575 ** field, the checksum-initializer and the database size at the start
1576 ** of the transaction. Return an error code if anything goes wrong.
1577 */
1578 if( SQLITE_OK!=(rc = read32bits(pPager->jfd, iHdrOff+8, pNRec))
1579 || SQLITE_OK!=(rc = read32bits(pPager->jfd, iHdrOff+12, &pPager->cksumInit))
1580 || SQLITE_OK!=(rc = read32bits(pPager->jfd, iHdrOff+16, pDbSize))
1581 ){
1582 return rc;
1583 }
1584
1585 if( pPager->journalOff==0 ){
1586 u32 iPageSize; /* Page-size field of journal header */
1587 u32 iSectorSize; /* Sector-size field of journal header */
1588
1589 /* Read the page-size and sector-size journal header fields. */
1590 if( SQLITE_OK!=(rc = read32bits(pPager->jfd, iHdrOff+20, &iSectorSize))
1591 || SQLITE_OK!=(rc = read32bits(pPager->jfd, iHdrOff+24, &iPageSize))
1592 ){
1593 return rc;
1594 }
1595
1596 /* Versions of SQLite prior to 3.5.8 set the page-size field of the
1597 ** journal header to zero. In this case, assume that the Pager.pageSize
1598 ** variable is already set to the correct page size.
1599 */
1600 if( iPageSize==0 ){
1601 iPageSize = pPager->pageSize;
1602 }
1603
1604 /* Check that the values read from the page-size and sector-size fields
1605 ** are within range. To be 'in range', both values need to be a power
1606 ** of two greater than or equal to 512 or 32, and not greater than their
1607 ** respective compile time maximum limits.
1608 */
1609 if( iPageSize<512 || iSectorSize<32
1610 || iPageSize>SQLITE_MAX_PAGE_SIZE || iSectorSize>MAX_SECTOR_SIZE
1611 || ((iPageSize-1)&iPageSize)!=0 || ((iSectorSize-1)&iSectorSize)!=0
1612 ){
1613 /* If the either the page-size or sector-size in the journal-header is
1614 ** invalid, then the process that wrote the journal-header must have
1615 ** crashed before the header was synced. In this case stop reading
1616 ** the journal file here.
1617 */
1618 return SQLITE_DONE;
1619 }
1620
1621 /* Update the page-size to match the value read from the journal.
1622 ** Use a testcase() macro to make sure that malloc failure within
1623 ** PagerSetPagesize() is tested.
1624 */
1625 rc = sqlite3PagerSetPagesize(pPager, &iPageSize, -1);
1626 testcase( rc!=SQLITE_OK );
1627
1628 /* Update the assumed sector-size to match the value used by
1629 ** the process that created this journal. If this journal was
1630 ** created by a process other than this one, then this routine
1631 ** is being called from within pager_playback(). The local value
1632 ** of Pager.sectorSize is restored at the end of that routine.
1633 */
1634 pPager->sectorSize = iSectorSize;
1635 }
1636
1637 pPager->journalOff += JOURNAL_HDR_SZ(pPager);
1638 return rc;
1639 }
1640
1641
1642 /*
1643 ** Write the supplied master journal name into the journal file for pager
1644 ** pPager at the current location. The master journal name must be the last
1645 ** thing written to a journal file. If the pager is in full-sync mode, the
1646 ** journal file descriptor is advanced to the next sector boundary before
1647 ** anything is written. The format is:
1648 **
1649 ** + 4 bytes: PAGER_MJ_PGNO.
1650 ** + N bytes: Master journal filename in utf-8.
1651 ** + 4 bytes: N (length of master journal name in bytes, no nul-terminator).
1652 ** + 4 bytes: Master journal name checksum.
1653 ** + 8 bytes: aJournalMagic[].
1654 **
1655 ** The master journal page checksum is the sum of the bytes in the master
1656 ** journal name, where each byte is interpreted as a signed 8-bit integer.
1657 **
1658 ** If zMaster is a NULL pointer (occurs for a single database transaction),
1659 ** this call is a no-op.
1660 */
1661 static int writeMasterJournal(Pager *pPager, const char *zMaster){
1662 int rc; /* Return code */
1663 int nMaster; /* Length of string zMaster */
1664 i64 iHdrOff; /* Offset of header in journal file */
1665 i64 jrnlSize; /* Size of journal file on disk */
1666 u32 cksum = 0; /* Checksum of string zMaster */
1667
1668 assert( pPager->setMaster==0 );
1669 assert( !pagerUseWal(pPager) );
1670
1671 if( !zMaster
1672 || pPager->journalMode==PAGER_JOURNALMODE_MEMORY
1673 || !isOpen(pPager->jfd)
1674 ){
1675 return SQLITE_OK;
1676 }
1677 pPager->setMaster = 1;
1678 assert( pPager->journalHdr <= pPager->journalOff );
1679
1680 /* Calculate the length in bytes and the checksum of zMaster */
1681 for(nMaster=0; zMaster[nMaster]; nMaster++){
1682 cksum += zMaster[nMaster];
1683 }
1684
1685 /* If in full-sync mode, advance to the next disk sector before writing
1686 ** the master journal name. This is in case the previous page written to
1687 ** the journal has already been synced.
1688 */
1689 if( pPager->fullSync ){
1690 pPager->journalOff = journalHdrOffset(pPager);
1691 }
1692 iHdrOff = pPager->journalOff;
1693
1694 /* Write the master journal data to the end of the journal file. If
1695 ** an error occurs, return the error code to the caller.
1696 */
1697 if( (0 != (rc = write32bits(pPager->jfd, iHdrOff, PAGER_MJ_PGNO(pPager))))
1698 || (0 != (rc = sqlite3OsWrite(pPager->jfd, zMaster, nMaster, iHdrOff+4)))
1699 || (0 != (rc = write32bits(pPager->jfd, iHdrOff+4+nMaster, nMaster)))
1700 || (0 != (rc = write32bits(pPager->jfd, iHdrOff+4+nMaster+4, cksum)))
1701 || (0 != (rc = sqlite3OsWrite(pPager->jfd, aJournalMagic, 8,
1702 iHdrOff+4+nMaster+8)))
1703 ){
1704 return rc;
1705 }
1706 pPager->journalOff += (nMaster+20);
1707
1708 /* If the pager is in peristent-journal mode, then the physical
1709 ** journal-file may extend past the end of the master-journal name
1710 ** and 8 bytes of magic data just written to the file. This is
1711 ** dangerous because the code to rollback a hot-journal file
1712 ** will not be able to find the master-journal name to determine
1713 ** whether or not the journal is hot.
1714 **
1715 ** Easiest thing to do in this scenario is to truncate the journal
1716 ** file to the required size.
1717 */
1718 if( SQLITE_OK==(rc = sqlite3OsFileSize(pPager->jfd, &jrnlSize))
1719 && jrnlSize>pPager->journalOff
1720 ){
1721 rc = sqlite3OsTruncate(pPager->jfd, pPager->journalOff);
1722 }
1723 return rc;
1724 }
1725
1726 /*
1727 ** Discard the entire contents of the in-memory page-cache.
1728 */
1729 static void pager_reset(Pager *pPager){
1730 pPager->iDataVersion++;
1731 sqlite3BackupRestart(pPager->pBackup);
1732 sqlite3PcacheClear(pPager->pPCache);
1733 }
1734
1735 /*
1736 ** Return the pPager->iDataVersion value
1737 */
1738 u32 sqlite3PagerDataVersion(Pager *pPager){
1739 assert( pPager->eState>PAGER_OPEN );
1740 return pPager->iDataVersion;
1741 }
1742
1743 /*
1744 ** Free all structures in the Pager.aSavepoint[] array and set both
1745 ** Pager.aSavepoint and Pager.nSavepoint to zero. Close the sub-journal
1746 ** if it is open and the pager is not in exclusive mode.
1747 */
1748 static void releaseAllSavepoints(Pager *pPager){
1749 int ii; /* Iterator for looping through Pager.aSavepoint */
1750 for(ii=0; ii<pPager->nSavepoint; ii++){
1751 sqlite3BitvecDestroy(pPager->aSavepoint[ii].pInSavepoint);
1752 }
1753 if( !pPager->exclusiveMode || sqlite3JournalIsInMemory(pPager->sjfd) ){
1754 sqlite3OsClose(pPager->sjfd);
1755 }
1756 sqlite3_free(pPager->aSavepoint);
1757 pPager->aSavepoint = 0;
1758 pPager->nSavepoint = 0;
1759 pPager->nSubRec = 0;
1760 }
1761
1762 /*
1763 ** Set the bit number pgno in the PagerSavepoint.pInSavepoint
1764 ** bitvecs of all open savepoints. Return SQLITE_OK if successful
1765 ** or SQLITE_NOMEM if a malloc failure occurs.
1766 */
1767 static int addToSavepointBitvecs(Pager *pPager, Pgno pgno){
1768 int ii; /* Loop counter */
1769 int rc = SQLITE_OK; /* Result code */
1770
1771 for(ii=0; ii<pPager->nSavepoint; ii++){
1772 PagerSavepoint *p = &pPager->aSavepoint[ii];
1773 if( pgno<=p->nOrig ){
1774 rc |= sqlite3BitvecSet(p->pInSavepoint, pgno);
1775 testcase( rc==SQLITE_NOMEM );
1776 assert( rc==SQLITE_OK || rc==SQLITE_NOMEM );
1777 }
1778 }
1779 return rc;
1780 }
1781
1782 /*
1783 ** This function is a no-op if the pager is in exclusive mode and not
1784 ** in the ERROR state. Otherwise, it switches the pager to PAGER_OPEN
1785 ** state.
1786 **
1787 ** If the pager is not in exclusive-access mode, the database file is
1788 ** completely unlocked. If the file is unlocked and the file-system does
1789 ** not exhibit the UNDELETABLE_WHEN_OPEN property, the journal file is
1790 ** closed (if it is open).
1791 **
1792 ** If the pager is in ERROR state when this function is called, the
1793 ** contents of the pager cache are discarded before switching back to
1794 ** the OPEN state. Regardless of whether the pager is in exclusive-mode
1795 ** or not, any journal file left in the file-system will be treated
1796 ** as a hot-journal and rolled back the next time a read-transaction
1797 ** is opened (by this or by any other connection).
1798 */
1799 static void pager_unlock(Pager *pPager){
1800
1801 assert( pPager->eState==PAGER_READER
1802 || pPager->eState==PAGER_OPEN
1803 || pPager->eState==PAGER_ERROR
1804 );
1805
1806 sqlite3BitvecDestroy(pPager->pInJournal);
1807 pPager->pInJournal = 0;
1808 releaseAllSavepoints(pPager);
1809
1810 if( pagerUseWal(pPager) ){
1811 assert( !isOpen(pPager->jfd) );
1812 sqlite3WalEndReadTransaction(pPager->pWal);
1813 pPager->eState = PAGER_OPEN;
1814 }else if( !pPager->exclusiveMode ){
1815 int rc; /* Error code returned by pagerUnlockDb() */
1816 int iDc = isOpen(pPager->fd)?sqlite3OsDeviceCharacteristics(pPager->fd):0;
1817
1818 /* If the operating system support deletion of open files, then
1819 ** close the journal file when dropping the database lock. Otherwise
1820 ** another connection with journal_mode=delete might delete the file
1821 ** out from under us.
1822 */
1823 assert( (PAGER_JOURNALMODE_MEMORY & 5)!=1 );
1824 assert( (PAGER_JOURNALMODE_OFF & 5)!=1 );
1825 assert( (PAGER_JOURNALMODE_WAL & 5)!=1 );
1826 assert( (PAGER_JOURNALMODE_DELETE & 5)!=1 );
1827 assert( (PAGER_JOURNALMODE_TRUNCATE & 5)==1 );
1828 assert( (PAGER_JOURNALMODE_PERSIST & 5)==1 );
1829 if( 0==(iDc & SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN)
1830 || 1!=(pPager->journalMode & 5)
1831 ){
1832 sqlite3OsClose(pPager->jfd);
1833 }
1834
1835 /* If the pager is in the ERROR state and the call to unlock the database
1836 ** file fails, set the current lock to UNKNOWN_LOCK. See the comment
1837 ** above the #define for UNKNOWN_LOCK for an explanation of why this
1838 ** is necessary.
1839 */
1840 rc = pagerUnlockDb(pPager, NO_LOCK);
1841 if( rc!=SQLITE_OK && pPager->eState==PAGER_ERROR ){
1842 pPager->eLock = UNKNOWN_LOCK;
1843 }
1844
1845 /* The pager state may be changed from PAGER_ERROR to PAGER_OPEN here
1846 ** without clearing the error code. This is intentional - the error
1847 ** code is cleared and the cache reset in the block below.
1848 */
1849 assert( pPager->errCode || pPager->eState!=PAGER_ERROR );
1850 pPager->changeCountDone = 0;
1851 pPager->eState = PAGER_OPEN;
1852 }
1853
1854 /* If Pager.errCode is set, the contents of the pager cache cannot be
1855 ** trusted. Now that there are no outstanding references to the pager,
1856 ** it can safely move back to PAGER_OPEN state. This happens in both
1857 ** normal and exclusive-locking mode.
1858 */
1859 assert( pPager->errCode==SQLITE_OK || !MEMDB );
1860 if( pPager->errCode ){
1861 if( pPager->tempFile==0 ){
1862 pager_reset(pPager);
1863 pPager->changeCountDone = 0;
1864 pPager->eState = PAGER_OPEN;
1865 }else{
1866 pPager->eState = (isOpen(pPager->jfd) ? PAGER_OPEN : PAGER_READER);
1867 }
1868 if( USEFETCH(pPager) ) sqlite3OsUnfetch(pPager->fd, 0, 0);
1869 pPager->errCode = SQLITE_OK;
1870 setGetterMethod(pPager);
1871 }
1872
1873 pPager->journalOff = 0;
1874 pPager->journalHdr = 0;
1875 pPager->setMaster = 0;
1876 }
1877
1878 /*
1879 ** This function is called whenever an IOERR or FULL error that requires
1880 ** the pager to transition into the ERROR state may ahve occurred.
1881 ** The first argument is a pointer to the pager structure, the second
1882 ** the error-code about to be returned by a pager API function. The
1883 ** value returned is a copy of the second argument to this function.
1884 **
1885 ** If the second argument is SQLITE_FULL, SQLITE_IOERR or one of the
1886 ** IOERR sub-codes, the pager enters the ERROR state and the error code
1887 ** is stored in Pager.errCode. While the pager remains in the ERROR state,
1888 ** all major API calls on the Pager will immediately return Pager.errCode.
1889 **
1890 ** The ERROR state indicates that the contents of the pager-cache
1891 ** cannot be trusted. This state can be cleared by completely discarding
1892 ** the contents of the pager-cache. If a transaction was active when
1893 ** the persistent error occurred, then the rollback journal may need
1894 ** to be replayed to restore the contents of the database file (as if
1895 ** it were a hot-journal).
1896 */
1897 static int pager_error(Pager *pPager, int rc){
1898 int rc2 = rc & 0xff;
1899 assert( rc==SQLITE_OK || !MEMDB );
1900 assert(
1901 pPager->errCode==SQLITE_FULL ||
1902 pPager->errCode==SQLITE_OK ||
1903 (pPager->errCode & 0xff)==SQLITE_IOERR
1904 );
1905 if( rc2==SQLITE_FULL || rc2==SQLITE_IOERR ){
1906 pPager->errCode = rc;
1907 pPager->eState = PAGER_ERROR;
1908 setGetterMethod(pPager);
1909 }
1910 return rc;
1911 }
1912
1913 static int pager_truncate(Pager *pPager, Pgno nPage);
1914
1915 /*
1916 ** The write transaction open on pPager is being committed (bCommit==1)
1917 ** or rolled back (bCommit==0).
1918 **
1919 ** Return TRUE if and only if all dirty pages should be flushed to disk.
1920 **
1921 ** Rules:
1922 **
1923 ** * For non-TEMP databases, always sync to disk. This is necessary
1924 ** for transactions to be durable.
1925 **
1926 ** * Sync TEMP database only on a COMMIT (not a ROLLBACK) when the backing
1927 ** file has been created already (via a spill on pagerStress()) and
1928 ** when the number of dirty pages in memory exceeds 25% of the total
1929 ** cache size.
1930 */
1931 static int pagerFlushOnCommit(Pager *pPager, int bCommit){
1932 if( pPager->tempFile==0 ) return 1;
1933 if( !bCommit ) return 0;
1934 if( !isOpen(pPager->fd) ) return 0;
1935 return (sqlite3PCachePercentDirty(pPager->pPCache)>=25);
1936 }
1937
1938 /*
1939 ** This routine ends a transaction. A transaction is usually ended by
1940 ** either a COMMIT or a ROLLBACK operation. This routine may be called
1941 ** after rollback of a hot-journal, or if an error occurs while opening
1942 ** the journal file or writing the very first journal-header of a
1943 ** database transaction.
1944 **
1945 ** This routine is never called in PAGER_ERROR state. If it is called
1946 ** in PAGER_NONE or PAGER_SHARED state and the lock held is less
1947 ** exclusive than a RESERVED lock, it is a no-op.
1948 **
1949 ** Otherwise, any active savepoints are released.
1950 **
1951 ** If the journal file is open, then it is "finalized". Once a journal
1952 ** file has been finalized it is not possible to use it to roll back a
1953 ** transaction. Nor will it be considered to be a hot-journal by this
1954 ** or any other database connection. Exactly how a journal is finalized
1955 ** depends on whether or not the pager is running in exclusive mode and
1956 ** the current journal-mode (Pager.journalMode value), as follows:
1957 **
1958 ** journalMode==MEMORY
1959 ** Journal file descriptor is simply closed. This destroys an
1960 ** in-memory journal.
1961 **
1962 ** journalMode==TRUNCATE
1963 ** Journal file is truncated to zero bytes in size.
1964 **
1965 ** journalMode==PERSIST
1966 ** The first 28 bytes of the journal file are zeroed. This invalidates
1967 ** the first journal header in the file, and hence the entire journal
1968 ** file. An invalid journal file cannot be rolled back.
1969 **
1970 ** journalMode==DELETE
1971 ** The journal file is closed and deleted using sqlite3OsDelete().
1972 **
1973 ** If the pager is running in exclusive mode, this method of finalizing
1974 ** the journal file is never used. Instead, if the journalMode is
1975 ** DELETE and the pager is in exclusive mode, the method described under
1976 ** journalMode==PERSIST is used instead.
1977 **
1978 ** After the journal is finalized, the pager moves to PAGER_READER state.
1979 ** If running in non-exclusive rollback mode, the lock on the file is
1980 ** downgraded to a SHARED_LOCK.
1981 **
1982 ** SQLITE_OK is returned if no error occurs. If an error occurs during
1983 ** any of the IO operations to finalize the journal file or unlock the
1984 ** database then the IO error code is returned to the user. If the
1985 ** operation to finalize the journal file fails, then the code still
1986 ** tries to unlock the database file if not in exclusive mode. If the
1987 ** unlock operation fails as well, then the first error code related
1988 ** to the first error encountered (the journal finalization one) is
1989 ** returned.
1990 */
1991 static int pager_end_transaction(Pager *pPager, int hasMaster, int bCommit){
1992 int rc = SQLITE_OK; /* Error code from journal finalization operation */
1993 int rc2 = SQLITE_OK; /* Error code from db file unlock operation */
1994
1995 /* Do nothing if the pager does not have an open write transaction
1996 ** or at least a RESERVED lock. This function may be called when there
1997 ** is no write-transaction active but a RESERVED or greater lock is
1998 ** held under two circumstances:
1999 **
2000 ** 1. After a successful hot-journal rollback, it is called with
2001 ** eState==PAGER_NONE and eLock==EXCLUSIVE_LOCK.
2002 **
2003 ** 2. If a connection with locking_mode=exclusive holding an EXCLUSIVE
2004 ** lock switches back to locking_mode=normal and then executes a
2005 ** read-transaction, this function is called with eState==PAGER_READER
2006 ** and eLock==EXCLUSIVE_LOCK when the read-transaction is closed.
2007 */
2008 assert( assert_pager_state(pPager) );
2009 assert( pPager->eState!=PAGER_ERROR );
2010 if( pPager->eState<PAGER_WRITER_LOCKED && pPager->eLock<RESERVED_LOCK ){
2011 return SQLITE_OK;
2012 }
2013
2014 releaseAllSavepoints(pPager);
2015 assert( isOpen(pPager->jfd) || pPager->pInJournal==0 );
2016 if( isOpen(pPager->jfd) ){
2017 assert( !pagerUseWal(pPager) );
2018
2019 /* Finalize the journal file. */
2020 if( sqlite3JournalIsInMemory(pPager->jfd) ){
2021 /* assert( pPager->journalMode==PAGER_JOURNALMODE_MEMORY ); */
2022 sqlite3OsClose(pPager->jfd);
2023 }else if( pPager->journalMode==PAGER_JOURNALMODE_TRUNCATE ){
2024 if( pPager->journalOff==0 ){
2025 rc = SQLITE_OK;
2026 }else{
2027 rc = sqlite3OsTruncate(pPager->jfd, 0);
2028 if( rc==SQLITE_OK && pPager->fullSync ){
2029 /* Make sure the new file size is written into the inode right away.
2030 ** Otherwise the journal might resurrect following a power loss and
2031 ** cause the last transaction to roll back. See
2032 ** https://bugzilla.mozilla.org/show_bug.cgi?id=1072773
2033 */
2034 rc = sqlite3OsSync(pPager->jfd, pPager->syncFlags);
2035 }
2036 }
2037 pPager->journalOff = 0;
2038 }else if( pPager->journalMode==PAGER_JOURNALMODE_PERSIST
2039 || (pPager->exclusiveMode && pPager->journalMode!=PAGER_JOURNALMODE_WAL)
2040 ){
2041 rc = zeroJournalHdr(pPager, hasMaster||pPager->tempFile);
2042 pPager->journalOff = 0;
2043 }else{
2044 /* This branch may be executed with Pager.journalMode==MEMORY if
2045 ** a hot-journal was just rolled back. In this case the journal
2046 ** file should be closed and deleted. If this connection writes to
2047 ** the database file, it will do so using an in-memory journal.
2048 */
2049 int bDelete = !pPager->tempFile;
2050 assert( sqlite3JournalIsInMemory(pPager->jfd)==0 );
2051 assert( pPager->journalMode==PAGER_JOURNALMODE_DELETE
2052 || pPager->journalMode==PAGER_JOURNALMODE_MEMORY
2053 || pPager->journalMode==PAGER_JOURNALMODE_WAL
2054 );
2055 sqlite3OsClose(pPager->jfd);
2056 if( bDelete ){
2057 rc = sqlite3OsDelete(pPager->pVfs, pPager->zJournal, pPager->extraSync);
2058 }
2059 }
2060 }
2061
2062 #ifdef SQLITE_CHECK_PAGES
2063 sqlite3PcacheIterateDirty(pPager->pPCache, pager_set_pagehash);
2064 if( pPager->dbSize==0 && sqlite3PcacheRefCount(pPager->pPCache)>0 ){
2065 PgHdr *p = sqlite3PagerLookup(pPager, 1);
2066 if( p ){
2067 p->pageHash = 0;
2068 sqlite3PagerUnrefNotNull(p);
2069 }
2070 }
2071 #endif
2072
2073 sqlite3BitvecDestroy(pPager->pInJournal);
2074 pPager->pInJournal = 0;
2075 pPager->nRec = 0;
2076 if( rc==SQLITE_OK ){
2077 if( MEMDB || pagerFlushOnCommit(pPager, bCommit) ){
2078 sqlite3PcacheCleanAll(pPager->pPCache);
2079 }else{
2080 sqlite3PcacheClearWritable(pPager->pPCache);
2081 }
2082 sqlite3PcacheTruncate(pPager->pPCache, pPager->dbSize);
2083 }
2084
2085 if( pagerUseWal(pPager) ){
2086 /* Drop the WAL write-lock, if any. Also, if the connection was in
2087 ** locking_mode=exclusive mode but is no longer, drop the EXCLUSIVE
2088 ** lock held on the database file.
2089 */
2090 rc2 = sqlite3WalEndWriteTransaction(pPager->pWal);
2091 assert( rc2==SQLITE_OK );
2092 }else if( rc==SQLITE_OK && bCommit && pPager->dbFileSize>pPager->dbSize ){
2093 /* This branch is taken when committing a transaction in rollback-journal
2094 ** mode if the database file on disk is larger than the database image.
2095 ** At this point the journal has been finalized and the transaction
2096 ** successfully committed, but the EXCLUSIVE lock is still held on the
2097 ** file. So it is safe to truncate the database file to its minimum
2098 ** required size. */
2099 assert( pPager->eLock==EXCLUSIVE_LOCK );
2100 rc = pager_truncate(pPager, pPager->dbSize);
2101 }
2102
2103 if( rc==SQLITE_OK && bCommit && isOpen(pPager->fd) ){
2104 rc = sqlite3OsFileControl(pPager->fd, SQLITE_FCNTL_COMMIT_PHASETWO, 0);
2105 if( rc==SQLITE_NOTFOUND ) rc = SQLITE_OK;
2106 }
2107
2108 if( !pPager->exclusiveMode
2109 && (!pagerUseWal(pPager) || sqlite3WalExclusiveMode(pPager->pWal, 0))
2110 ){
2111 rc2 = pagerUnlockDb(pPager, SHARED_LOCK);
2112 pPager->changeCountDone = 0;
2113 }
2114 pPager->eState = PAGER_READER;
2115 pPager->setMaster = 0;
2116
2117 return (rc==SQLITE_OK?rc2:rc);
2118 }
2119
2120 /*
2121 ** Execute a rollback if a transaction is active and unlock the
2122 ** database file.
2123 **
2124 ** If the pager has already entered the ERROR state, do not attempt
2125 ** the rollback at this time. Instead, pager_unlock() is called. The
2126 ** call to pager_unlock() will discard all in-memory pages, unlock
2127 ** the database file and move the pager back to OPEN state. If this
2128 ** means that there is a hot-journal left in the file-system, the next
2129 ** connection to obtain a shared lock on the pager (which may be this one)
2130 ** will roll it back.
2131 **
2132 ** If the pager has not already entered the ERROR state, but an IO or
2133 ** malloc error occurs during a rollback, then this will itself cause
2134 ** the pager to enter the ERROR state. Which will be cleared by the
2135 ** call to pager_unlock(), as described above.
2136 */
2137 static void pagerUnlockAndRollback(Pager *pPager){
2138 if( pPager->eState!=PAGER_ERROR && pPager->eState!=PAGER_OPEN ){
2139 assert( assert_pager_state(pPager) );
2140 if( pPager->eState>=PAGER_WRITER_LOCKED ){
2141 sqlite3BeginBenignMalloc();
2142 sqlite3PagerRollback(pPager);
2143 sqlite3EndBenignMalloc();
2144 }else if( !pPager->exclusiveMode ){
2145 assert( pPager->eState==PAGER_READER );
2146 pager_end_transaction(pPager, 0, 0);
2147 }
2148 }
2149 pager_unlock(pPager);
2150 }
2151
2152 /*
2153 ** Parameter aData must point to a buffer of pPager->pageSize bytes
2154 ** of data. Compute and return a checksum based ont the contents of the
2155 ** page of data and the current value of pPager->cksumInit.
2156 **
2157 ** This is not a real checksum. It is really just the sum of the
2158 ** random initial value (pPager->cksumInit) and every 200th byte
2159 ** of the page data, starting with byte offset (pPager->pageSize%200).
2160 ** Each byte is interpreted as an 8-bit unsigned integer.
2161 **
2162 ** Changing the formula used to compute this checksum results in an
2163 ** incompatible journal file format.
2164 **
2165 ** If journal corruption occurs due to a power failure, the most likely
2166 ** scenario is that one end or the other of the record will be changed.
2167 ** It is much less likely that the two ends of the journal record will be
2168 ** correct and the middle be corrupt. Thus, this "checksum" scheme,
2169 ** though fast and simple, catches the mostly likely kind of corruption.
2170 */
2171 static u32 pager_cksum(Pager *pPager, const u8 *aData){
2172 u32 cksum = pPager->cksumInit; /* Checksum value to return */
2173 int i = pPager->pageSize-200; /* Loop counter */
2174 while( i>0 ){
2175 cksum += aData[i];
2176 i -= 200;
2177 }
2178 return cksum;
2179 }
2180
2181 /*
2182 ** Report the current page size and number of reserved bytes back
2183 ** to the codec.
2184 */
2185 #ifdef SQLITE_HAS_CODEC
2186 static void pagerReportSize(Pager *pPager){
2187 if( pPager->xCodecSizeChng ){
2188 pPager->xCodecSizeChng(pPager->pCodec, pPager->pageSize,
2189 (int)pPager->nReserve);
2190 }
2191 }
2192 #else
2193 # define pagerReportSize(X) /* No-op if we do not support a codec */
2194 #endif
2195
2196 #ifdef SQLITE_HAS_CODEC
2197 /*
2198 ** Make sure the number of reserved bits is the same in the destination
2199 ** pager as it is in the source. This comes up when a VACUUM changes the
2200 ** number of reserved bits to the "optimal" amount.
2201 */
2202 void sqlite3PagerAlignReserve(Pager *pDest, Pager *pSrc){
2203 if( pDest->nReserve!=pSrc->nReserve ){
2204 pDest->nReserve = pSrc->nReserve;
2205 pagerReportSize(pDest);
2206 }
2207 }
2208 #endif
2209
2210 /*
2211 ** Read a single page from either the journal file (if isMainJrnl==1) or
2212 ** from the sub-journal (if isMainJrnl==0) and playback that page.
2213 ** The page begins at offset *pOffset into the file. The *pOffset
2214 ** value is increased to the start of the next page in the journal.
2215 **
2216 ** The main rollback journal uses checksums - the statement journal does
2217 ** not.
2218 **
2219 ** If the page number of the page record read from the (sub-)journal file
2220 ** is greater than the current value of Pager.dbSize, then playback is
2221 ** skipped and SQLITE_OK is returned.
2222 **
2223 ** If pDone is not NULL, then it is a record of pages that have already
2224 ** been played back. If the page at *pOffset has already been played back
2225 ** (if the corresponding pDone bit is set) then skip the playback.
2226 ** Make sure the pDone bit corresponding to the *pOffset page is set
2227 ** prior to returning.
2228 **
2229 ** If the page record is successfully read from the (sub-)journal file
2230 ** and played back, then SQLITE_OK is returned. If an IO error occurs
2231 ** while reading the record from the (sub-)journal file or while writing
2232 ** to the database file, then the IO error code is returned. If data
2233 ** is successfully read from the (sub-)journal file but appears to be
2234 ** corrupted, SQLITE_DONE is returned. Data is considered corrupted in
2235 ** two circumstances:
2236 **
2237 ** * If the record page-number is illegal (0 or PAGER_MJ_PGNO), or
2238 ** * If the record is being rolled back from the main journal file
2239 ** and the checksum field does not match the record content.
2240 **
2241 ** Neither of these two scenarios are possible during a savepoint rollback.
2242 **
2243 ** If this is a savepoint rollback, then memory may have to be dynamically
2244 ** allocated by this function. If this is the case and an allocation fails,
2245 ** SQLITE_NOMEM is returned.
2246 */
2247 static int pager_playback_one_page(
2248 Pager *pPager, /* The pager being played back */
2249 i64 *pOffset, /* Offset of record to playback */
2250 Bitvec *pDone, /* Bitvec of pages already played back */
2251 int isMainJrnl, /* 1 -> main journal. 0 -> sub-journal. */
2252 int isSavepnt /* True for a savepoint rollback */
2253 ){
2254 int rc;
2255 PgHdr *pPg; /* An existing page in the cache */
2256 Pgno pgno; /* The page number of a page in journal */
2257 u32 cksum; /* Checksum used for sanity checking */
2258 char *aData; /* Temporary storage for the page */
2259 sqlite3_file *jfd; /* The file descriptor for the journal file */
2260 int isSynced; /* True if journal page is synced */
2261
2262 assert( (isMainJrnl&~1)==0 ); /* isMainJrnl is 0 or 1 */
2263 assert( (isSavepnt&~1)==0 ); /* isSavepnt is 0 or 1 */
2264 assert( isMainJrnl || pDone ); /* pDone always used on sub-journals */
2265 assert( isSavepnt || pDone==0 ); /* pDone never used on non-savepoint */
2266
2267 aData = pPager->pTmpSpace;
2268 assert( aData ); /* Temp storage must have already been allocated */
2269 assert( pagerUseWal(pPager)==0 || (!isMainJrnl && isSavepnt) );
2270
2271 /* Either the state is greater than PAGER_WRITER_CACHEMOD (a transaction
2272 ** or savepoint rollback done at the request of the caller) or this is
2273 ** a hot-journal rollback. If it is a hot-journal rollback, the pager
2274 ** is in state OPEN and holds an EXCLUSIVE lock. Hot-journal rollback
2275 ** only reads from the main journal, not the sub-journal.
2276 */
2277 assert( pPager->eState>=PAGER_WRITER_CACHEMOD
2278 || (pPager->eState==PAGER_OPEN && pPager->eLock==EXCLUSIVE_LOCK)
2279 );
2280 assert( pPager->eState>=PAGER_WRITER_CACHEMOD || isMainJrnl );
2281
2282 /* Read the page number and page data from the journal or sub-journal
2283 ** file. Return an error code to the caller if an IO error occurs.
2284 */
2285 jfd = isMainJrnl ? pPager->jfd : pPager->sjfd;
2286 rc = read32bits(jfd, *pOffset, &pgno);
2287 if( rc!=SQLITE_OK ) return rc;
2288 rc = sqlite3OsRead(jfd, (u8*)aData, pPager->pageSize, (*pOffset)+4);
2289 if( rc!=SQLITE_OK ) return rc;
2290 *pOffset += pPager->pageSize + 4 + isMainJrnl*4;
2291
2292 /* Sanity checking on the page. This is more important that I originally
2293 ** thought. If a power failure occurs while the journal is being written,
2294 ** it could cause invalid data to be written into the journal. We need to
2295 ** detect this invalid data (with high probability) and ignore it.
2296 */
2297 if( pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
2298 assert( !isSavepnt );
2299 return SQLITE_DONE;
2300 }
2301 if( pgno>(Pgno)pPager->dbSize || sqlite3BitvecTest(pDone, pgno) ){
2302 return SQLITE_OK;
2303 }
2304 if( isMainJrnl ){
2305 rc = read32bits(jfd, (*pOffset)-4, &cksum);
2306 if( rc ) return rc;
2307 if( !isSavepnt && pager_cksum(pPager, (u8*)aData)!=cksum ){
2308 return SQLITE_DONE;
2309 }
2310 }
2311
2312 /* If this page has already been played back before during the current
2313 ** rollback, then don't bother to play it back again.
2314 */
2315 if( pDone && (rc = sqlite3BitvecSet(pDone, pgno))!=SQLITE_OK ){
2316 return rc;
2317 }
2318
2319 /* When playing back page 1, restore the nReserve setting
2320 */
2321 if( pgno==1 && pPager->nReserve!=((u8*)aData)[20] ){
2322 pPager->nReserve = ((u8*)aData)[20];
2323 pagerReportSize(pPager);
2324 }
2325
2326 /* If the pager is in CACHEMOD state, then there must be a copy of this
2327 ** page in the pager cache. In this case just update the pager cache,
2328 ** not the database file. The page is left marked dirty in this case.
2329 **
2330 ** An exception to the above rule: If the database is in no-sync mode
2331 ** and a page is moved during an incremental vacuum then the page may
2332 ** not be in the pager cache. Later: if a malloc() or IO error occurs
2333 ** during a Movepage() call, then the page may not be in the cache
2334 ** either. So the condition described in the above paragraph is not
2335 ** assert()able.
2336 **
2337 ** If in WRITER_DBMOD, WRITER_FINISHED or OPEN state, then we update the
2338 ** pager cache if it exists and the main file. The page is then marked
2339 ** not dirty. Since this code is only executed in PAGER_OPEN state for
2340 ** a hot-journal rollback, it is guaranteed that the page-cache is empty
2341 ** if the pager is in OPEN state.
2342 **
2343 ** Ticket #1171: The statement journal might contain page content that is
2344 ** different from the page content at the start of the transaction.
2345 ** This occurs when a page is changed prior to the start of a statement
2346 ** then changed again within the statement. When rolling back such a
2347 ** statement we must not write to the original database unless we know
2348 ** for certain that original page contents are synced into the main rollback
2349 ** journal. Otherwise, a power loss might leave modified data in the
2350 ** database file without an entry in the rollback journal that can
2351 ** restore the database to its original form. Two conditions must be
2352 ** met before writing to the database files. (1) the database must be
2353 ** locked. (2) we know that the original page content is fully synced
2354 ** in the main journal either because the page is not in cache or else
2355 ** the page is marked as needSync==0.
2356 **
2357 ** 2008-04-14: When attempting to vacuum a corrupt database file, it
2358 ** is possible to fail a statement on a database that does not yet exist.
2359 ** Do not attempt to write if database file has never been opened.
2360 */
2361 if( pagerUseWal(pPager) ){
2362 pPg = 0;
2363 }else{
2364 pPg = sqlite3PagerLookup(pPager, pgno);
2365 }
2366 assert( pPg || !MEMDB );
2367 assert( pPager->eState!=PAGER_OPEN || pPg==0 || pPager->tempFile );
2368 PAGERTRACE(("PLAYBACK %d page %d hash(%08x) %s\n",
2369 PAGERID(pPager), pgno, pager_datahash(pPager->pageSize, (u8*)aData),
2370 (isMainJrnl?"main-journal":"sub-journal")
2371 ));
2372 if( isMainJrnl ){
2373 isSynced = pPager->noSync || (*pOffset <= pPager->journalHdr);
2374 }else{
2375 isSynced = (pPg==0 || 0==(pPg->flags & PGHDR_NEED_SYNC));
2376 }
2377 if( isOpen(pPager->fd)
2378 && (pPager->eState>=PAGER_WRITER_DBMOD || pPager->eState==PAGER_OPEN)
2379 && isSynced
2380 ){
2381 i64 ofst = (pgno-1)*(i64)pPager->pageSize;
2382 testcase( !isSavepnt && pPg!=0 && (pPg->flags&PGHDR_NEED_SYNC)!=0 );
2383 assert( !pagerUseWal(pPager) );
2384 rc = sqlite3OsWrite(pPager->fd, (u8 *)aData, pPager->pageSize, ofst);
2385 if( pgno>pPager->dbFileSize ){
2386 pPager->dbFileSize = pgno;
2387 }
2388 if( pPager->pBackup ){
2389 CODEC1(pPager, aData, pgno, 3, rc=SQLITE_NOMEM_BKPT);
2390 sqlite3BackupUpdate(pPager->pBackup, pgno, (u8*)aData);
2391 CODEC2(pPager, aData, pgno, 7, rc=SQLITE_NOMEM_BKPT, aData);
2392 }
2393 }else if( !isMainJrnl && pPg==0 ){
2394 /* If this is a rollback of a savepoint and data was not written to
2395 ** the database and the page is not in-memory, there is a potential
2396 ** problem. When the page is next fetched by the b-tree layer, it
2397 ** will be read from the database file, which may or may not be
2398 ** current.
2399 **
2400 ** There are a couple of different ways this can happen. All are quite
2401 ** obscure. When running in synchronous mode, this can only happen
2402 ** if the page is on the free-list at the start of the transaction, then
2403 ** populated, then moved using sqlite3PagerMovepage().
2404 **
2405 ** The solution is to add an in-memory page to the cache containing
2406 ** the data just read from the sub-journal. Mark the page as dirty
2407 ** and if the pager requires a journal-sync, then mark the page as
2408 ** requiring a journal-sync before it is written.
2409 */
2410 assert( isSavepnt );
2411 assert( (pPager->doNotSpill & SPILLFLAG_ROLLBACK)==0 );
2412 pPager->doNotSpill |= SPILLFLAG_ROLLBACK;
2413 rc = sqlite3PagerGet(pPager, pgno, &pPg, 1);
2414 assert( (pPager->doNotSpill & SPILLFLAG_ROLLBACK)!=0 );
2415 pPager->doNotSpill &= ~SPILLFLAG_ROLLBACK;
2416 if( rc!=SQLITE_OK ) return rc;
2417 sqlite3PcacheMakeDirty(pPg);
2418 }
2419 if( pPg ){
2420 /* No page should ever be explicitly rolled back that is in use, except
2421 ** for page 1 which is held in use in order to keep the lock on the
2422 ** database active. However such a page may be rolled back as a result
2423 ** of an internal error resulting in an automatic call to
2424 ** sqlite3PagerRollback().
2425 */
2426 void *pData;
2427 pData = pPg->pData;
2428 memcpy(pData, (u8*)aData, pPager->pageSize);
2429 pPager->xReiniter(pPg);
2430 /* It used to be that sqlite3PcacheMakeClean(pPg) was called here. But
2431 ** that call was dangerous and had no detectable benefit since the cache
2432 ** is normally cleaned by sqlite3PcacheCleanAll() after rollback and so
2433 ** has been removed. */
2434 pager_set_pagehash(pPg);
2435
2436 /* If this was page 1, then restore the value of Pager.dbFileVers.
2437 ** Do this before any decoding. */
2438 if( pgno==1 ){
2439 memcpy(&pPager->dbFileVers, &((u8*)pData)[24],sizeof(pPager->dbFileVers));
2440 }
2441
2442 /* Decode the page just read from disk */
2443 CODEC1(pPager, pData, pPg->pgno, 3, rc=SQLITE_NOMEM_BKPT);
2444 sqlite3PcacheRelease(pPg);
2445 }
2446 return rc;
2447 }
2448
2449 /*
2450 ** Parameter zMaster is the name of a master journal file. A single journal
2451 ** file that referred to the master journal file has just been rolled back.
2452 ** This routine checks if it is possible to delete the master journal file,
2453 ** and does so if it is.
2454 **
2455 ** Argument zMaster may point to Pager.pTmpSpace. So that buffer is not
2456 ** available for use within this function.
2457 **
2458 ** When a master journal file is created, it is populated with the names
2459 ** of all of its child journals, one after another, formatted as utf-8
2460 ** encoded text. The end of each child journal file is marked with a
2461 ** nul-terminator byte (0x00). i.e. the entire contents of a master journal
2462 ** file for a transaction involving two databases might be:
2463 **
2464 ** "/home/bill/a.db-journal\x00/home/bill/b.db-journal\x00"
2465 **
2466 ** A master journal file may only be deleted once all of its child
2467 ** journals have been rolled back.
2468 **
2469 ** This function reads the contents of the master-journal file into
2470 ** memory and loops through each of the child journal names. For
2471 ** each child journal, it checks if:
2472 **
2473 ** * if the child journal exists, and if so
2474 ** * if the child journal contains a reference to master journal
2475 ** file zMaster
2476 **
2477 ** If a child journal can be found that matches both of the criteria
2478 ** above, this function returns without doing anything. Otherwise, if
2479 ** no such child journal can be found, file zMaster is deleted from
2480 ** the file-system using sqlite3OsDelete().
2481 **
2482 ** If an IO error within this function, an error code is returned. This
2483 ** function allocates memory by calling sqlite3Malloc(). If an allocation
2484 ** fails, SQLITE_NOMEM is returned. Otherwise, if no IO or malloc errors
2485 ** occur, SQLITE_OK is returned.
2486 **
2487 ** TODO: This function allocates a single block of memory to load
2488 ** the entire contents of the master journal file. This could be
2489 ** a couple of kilobytes or so - potentially larger than the page
2490 ** size.
2491 */
2492 static int pager_delmaster(Pager *pPager, const char *zMaster){
2493 sqlite3_vfs *pVfs = pPager->pVfs;
2494 int rc; /* Return code */
2495 sqlite3_file *pMaster; /* Malloc'd master-journal file descriptor */
2496 sqlite3_file *pJournal; /* Malloc'd child-journal file descriptor */
2497 char *zMasterJournal = 0; /* Contents of master journal file */
2498 i64 nMasterJournal; /* Size of master journal file */
2499 char *zJournal; /* Pointer to one journal within MJ file */
2500 char *zMasterPtr; /* Space to hold MJ filename from a journal file */
2501 int nMasterPtr; /* Amount of space allocated to zMasterPtr[] */
2502
2503 /* Allocate space for both the pJournal and pMaster file descriptors.
2504 ** If successful, open the master journal file for reading.
2505 */
2506 pMaster = (sqlite3_file *)sqlite3MallocZero(pVfs->szOsFile * 2);
2507 pJournal = (sqlite3_file *)(((u8 *)pMaster) + pVfs->szOsFile);
2508 if( !pMaster ){
2509 rc = SQLITE_NOMEM_BKPT;
2510 }else{
2511 const int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MASTER_JOURNAL);
2512 rc = sqlite3OsOpen(pVfs, zMaster, pMaster, flags, 0);
2513 }
2514 if( rc!=SQLITE_OK ) goto delmaster_out;
2515
2516 /* Load the entire master journal file into space obtained from
2517 ** sqlite3_malloc() and pointed to by zMasterJournal. Also obtain
2518 ** sufficient space (in zMasterPtr) to hold the names of master
2519 ** journal files extracted from regular rollback-journals.
2520 */
2521 rc = sqlite3OsFileSize(pMaster, &nMasterJournal);
2522 if( rc!=SQLITE_OK ) goto delmaster_out;
2523 nMasterPtr = pVfs->mxPathname+1;
2524 zMasterJournal = sqlite3Malloc(nMasterJournal + nMasterPtr + 1);
2525 if( !zMasterJournal ){
2526 rc = SQLITE_NOMEM_BKPT;
2527 goto delmaster_out;
2528 }
2529 zMasterPtr = &zMasterJournal[nMasterJournal+1];
2530 rc = sqlite3OsRead(pMaster, zMasterJournal, (int)nMasterJournal, 0);
2531 if( rc!=SQLITE_OK ) goto delmaster_out;
2532 zMasterJournal[nMasterJournal] = 0;
2533
2534 zJournal = zMasterJournal;
2535 while( (zJournal-zMasterJournal)<nMasterJournal ){
2536 int exists;
2537 rc = sqlite3OsAccess(pVfs, zJournal, SQLITE_ACCESS_EXISTS, &exists);
2538 if( rc!=SQLITE_OK ){
2539 goto delmaster_out;
2540 }
2541 if( exists ){
2542 /* One of the journals pointed to by the master journal exists.
2543 ** Open it and check if it points at the master journal. If
2544 ** so, return without deleting the master journal file.
2545 */
2546 int c;
2547 int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MAIN_JOURNAL);
2548 rc = sqlite3OsOpen(pVfs, zJournal, pJournal, flags, 0);
2549 if( rc!=SQLITE_OK ){
2550 goto delmaster_out;
2551 }
2552
2553 rc = readMasterJournal(pJournal, zMasterPtr, nMasterPtr);
2554 sqlite3OsClose(pJournal);
2555 if( rc!=SQLITE_OK ){
2556 goto delmaster_out;
2557 }
2558
2559 c = zMasterPtr[0]!=0 && strcmp(zMasterPtr, zMaster)==0;
2560 if( c ){
2561 /* We have a match. Do not delete the master journal file. */
2562 goto delmaster_out;
2563 }
2564 }
2565 zJournal += (sqlite3Strlen30(zJournal)+1);
2566 }
2567
2568 sqlite3OsClose(pMaster);
2569 rc = sqlite3OsDelete(pVfs, zMaster, 0);
2570
2571 delmaster_out:
2572 sqlite3_free(zMasterJournal);
2573 if( pMaster ){
2574 sqlite3OsClose(pMaster);
2575 assert( !isOpen(pJournal) );
2576 sqlite3_free(pMaster);
2577 }
2578 return rc;
2579 }
2580
2581
2582 /*
2583 ** This function is used to change the actual size of the database
2584 ** file in the file-system. This only happens when committing a transaction,
2585 ** or rolling back a transaction (including rolling back a hot-journal).
2586 **
2587 ** If the main database file is not open, or the pager is not in either
2588 ** DBMOD or OPEN state, this function is a no-op. Otherwise, the size
2589 ** of the file is changed to nPage pages (nPage*pPager->pageSize bytes).
2590 ** If the file on disk is currently larger than nPage pages, then use the VFS
2591 ** xTruncate() method to truncate it.
2592 **
2593 ** Or, it might be the case that the file on disk is smaller than
2594 ** nPage pages. Some operating system implementations can get confused if
2595 ** you try to truncate a file to some size that is larger than it
2596 ** currently is, so detect this case and write a single zero byte to
2597 ** the end of the new file instead.
2598 **
2599 ** If successful, return SQLITE_OK. If an IO error occurs while modifying
2600 ** the database file, return the error code to the caller.
2601 */
2602 static int pager_truncate(Pager *pPager, Pgno nPage){
2603 int rc = SQLITE_OK;
2604 assert( pPager->eState!=PAGER_ERROR );
2605 assert( pPager->eState!=PAGER_READER );
2606
2607 if( isOpen(pPager->fd)
2608 && (pPager->eState>=PAGER_WRITER_DBMOD || pPager->eState==PAGER_OPEN)
2609 ){
2610 i64 currentSize, newSize;
2611 int szPage = pPager->pageSize;
2612 assert( pPager->eLock==EXCLUSIVE_LOCK );
2613 /* TODO: Is it safe to use Pager.dbFileSize here? */
2614 rc = sqlite3OsFileSize(pPager->fd, &currentSize);
2615 newSize = szPage*(i64)nPage;
2616 if( rc==SQLITE_OK && currentSize!=newSize ){
2617 if( currentSize>newSize ){
2618 rc = sqlite3OsTruncate(pPager->fd, newSize);
2619 }else if( (currentSize+szPage)<=newSize ){
2620 char *pTmp = pPager->pTmpSpace;
2621 memset(pTmp, 0, szPage);
2622 testcase( (newSize-szPage) == currentSize );
2623 testcase( (newSize-szPage) > currentSize );
2624 rc = sqlite3OsWrite(pPager->fd, pTmp, szPage, newSize-szPage);
2625 }
2626 if( rc==SQLITE_OK ){
2627 pPager->dbFileSize = nPage;
2628 }
2629 }
2630 }
2631 return rc;
2632 }
2633
2634 /*
2635 ** Return a sanitized version of the sector-size of OS file pFile. The
2636 ** return value is guaranteed to lie between 32 and MAX_SECTOR_SIZE.
2637 */
2638 int sqlite3SectorSize(sqlite3_file *pFile){
2639 int iRet = sqlite3OsSectorSize(pFile);
2640 if( iRet<32 ){
2641 iRet = 512;
2642 }else if( iRet>MAX_SECTOR_SIZE ){
2643 assert( MAX_SECTOR_SIZE>=512 );
2644 iRet = MAX_SECTOR_SIZE;
2645 }
2646 return iRet;
2647 }
2648
2649 /*
2650 ** Set the value of the Pager.sectorSize variable for the given
2651 ** pager based on the value returned by the xSectorSize method
2652 ** of the open database file. The sector size will be used
2653 ** to determine the size and alignment of journal header and
2654 ** master journal pointers within created journal files.
2655 **
2656 ** For temporary files the effective sector size is always 512 bytes.
2657 **
2658 ** Otherwise, for non-temporary files, the effective sector size is
2659 ** the value returned by the xSectorSize() method rounded up to 32 if
2660 ** it is less than 32, or rounded down to MAX_SECTOR_SIZE if it
2661 ** is greater than MAX_SECTOR_SIZE.
2662 **
2663 ** If the file has the SQLITE_IOCAP_POWERSAFE_OVERWRITE property, then set
2664 ** the effective sector size to its minimum value (512). The purpose of
2665 ** pPager->sectorSize is to define the "blast radius" of bytes that
2666 ** might change if a crash occurs while writing to a single byte in
2667 ** that range. But with POWERSAFE_OVERWRITE, the blast radius is zero
2668 ** (that is what POWERSAFE_OVERWRITE means), so we minimize the sector
2669 ** size. For backwards compatibility of the rollback journal file format,
2670 ** we cannot reduce the effective sector size below 512.
2671 */
2672 static void setSectorSize(Pager *pPager){
2673 assert( isOpen(pPager->fd) || pPager->tempFile );
2674
2675 if( pPager->tempFile
2676 || (sqlite3OsDeviceCharacteristics(pPager->fd) &
2677 SQLITE_IOCAP_POWERSAFE_OVERWRITE)!=0
2678 ){
2679 /* Sector size doesn't matter for temporary files. Also, the file
2680 ** may not have been opened yet, in which case the OsSectorSize()
2681 ** call will segfault. */
2682 pPager->sectorSize = 512;
2683 }else{
2684 pPager->sectorSize = sqlite3SectorSize(pPager->fd);
2685 }
2686 }
2687
2688 /*
2689 ** Playback the journal and thus restore the database file to
2690 ** the state it was in before we started making changes.
2691 **
2692 ** The journal file format is as follows:
2693 **
2694 ** (1) 8 byte prefix. A copy of aJournalMagic[].
2695 ** (2) 4 byte big-endian integer which is the number of valid page records
2696 ** in the journal. If this value is 0xffffffff, then compute the
2697 ** number of page records from the journal size.
2698 ** (3) 4 byte big-endian integer which is the initial value for the
2699 ** sanity checksum.
2700 ** (4) 4 byte integer which is the number of pages to truncate the
2701 ** database to during a rollback.
2702 ** (5) 4 byte big-endian integer which is the sector size. The header
2703 ** is this many bytes in size.
2704 ** (6) 4 byte big-endian integer which is the page size.
2705 ** (7) zero padding out to the next sector size.
2706 ** (8) Zero or more pages instances, each as follows:
2707 ** + 4 byte page number.
2708 ** + pPager->pageSize bytes of data.
2709 ** + 4 byte checksum
2710 **
2711 ** When we speak of the journal header, we mean the first 7 items above.
2712 ** Each entry in the journal is an instance of the 8th item.
2713 **
2714 ** Call the value from the second bullet "nRec". nRec is the number of
2715 ** valid page entries in the journal. In most cases, you can compute the
2716 ** value of nRec from the size of the journal file. But if a power
2717 ** failure occurred while the journal was being written, it could be the
2718 ** case that the size of the journal file had already been increased but
2719 ** the extra entries had not yet made it safely to disk. In such a case,
2720 ** the value of nRec computed from the file size would be too large. For
2721 ** that reason, we always use the nRec value in the header.
2722 **
2723 ** If the nRec value is 0xffffffff it means that nRec should be computed
2724 ** from the file size. This value is used when the user selects the
2725 ** no-sync option for the journal. A power failure could lead to corruption
2726 ** in this case. But for things like temporary table (which will be
2727 ** deleted when the power is restored) we don't care.
2728 **
2729 ** If the file opened as the journal file is not a well-formed
2730 ** journal file then all pages up to the first corrupted page are rolled
2731 ** back (or no pages if the journal header is corrupted). The journal file
2732 ** is then deleted and SQLITE_OK returned, just as if no corruption had
2733 ** been encountered.
2734 **
2735 ** If an I/O or malloc() error occurs, the journal-file is not deleted
2736 ** and an error code is returned.
2737 **
2738 ** The isHot parameter indicates that we are trying to rollback a journal
2739 ** that might be a hot journal. Or, it could be that the journal is
2740 ** preserved because of JOURNALMODE_PERSIST or JOURNALMODE_TRUNCATE.
2741 ** If the journal really is hot, reset the pager cache prior rolling
2742 ** back any content. If the journal is merely persistent, no reset is
2743 ** needed.
2744 */
2745 static int pager_playback(Pager *pPager, int isHot){
2746 sqlite3_vfs *pVfs = pPager->pVfs;
2747 i64 szJ; /* Size of the journal file in bytes */
2748 u32 nRec; /* Number of Records in the journal */
2749 u32 u; /* Unsigned loop counter */
2750 Pgno mxPg = 0; /* Size of the original file in pages */
2751 int rc; /* Result code of a subroutine */
2752 int res = 1; /* Value returned by sqlite3OsAccess() */
2753 char *zMaster = 0; /* Name of master journal file if any */
2754 int needPagerReset; /* True to reset page prior to first page rollback */
2755 int nPlayback = 0; /* Total number of pages restored from journal */
2756
2757 /* Figure out how many records are in the journal. Abort early if
2758 ** the journal is empty.
2759 */
2760 assert( isOpen(pPager->jfd) );
2761 rc = sqlite3OsFileSize(pPager->jfd, &szJ);
2762 if( rc!=SQLITE_OK ){
2763 goto end_playback;
2764 }
2765
2766 /* Read the master journal name from the journal, if it is present.
2767 ** If a master journal file name is specified, but the file is not
2768 ** present on disk, then the journal is not hot and does not need to be
2769 ** played back.
2770 **
2771 ** TODO: Technically the following is an error because it assumes that
2772 ** buffer Pager.pTmpSpace is (mxPathname+1) bytes or larger. i.e. that
2773 ** (pPager->pageSize >= pPager->pVfs->mxPathname+1). Using os_unix.c,
2774 ** mxPathname is 512, which is the same as the minimum allowable value
2775 ** for pageSize.
2776 */
2777 zMaster = pPager->pTmpSpace;
2778 rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1);
2779 if( rc==SQLITE_OK && zMaster[0] ){
2780 rc = sqlite3OsAccess(pVfs, zMaster, SQLITE_ACCESS_EXISTS, &res);
2781 }
2782 zMaster = 0;
2783 if( rc!=SQLITE_OK || !res ){
2784 goto end_playback;
2785 }
2786 pPager->journalOff = 0;
2787 needPagerReset = isHot;
2788
2789 /* This loop terminates either when a readJournalHdr() or
2790 ** pager_playback_one_page() call returns SQLITE_DONE or an IO error
2791 ** occurs.
2792 */
2793 while( 1 ){
2794 /* Read the next journal header from the journal file. If there are
2795 ** not enough bytes left in the journal file for a complete header, or
2796 ** it is corrupted, then a process must have failed while writing it.
2797 ** This indicates nothing more needs to be rolled back.
2798 */
2799 rc = readJournalHdr(pPager, isHot, szJ, &nRec, &mxPg);
2800 if( rc!=SQLITE_OK ){
2801 if( rc==SQLITE_DONE ){
2802 rc = SQLITE_OK;
2803 }
2804 goto end_playback;
2805 }
2806
2807 /* If nRec is 0xffffffff, then this journal was created by a process
2808 ** working in no-sync mode. This means that the rest of the journal
2809 ** file consists of pages, there are no more journal headers. Compute
2810 ** the value of nRec based on this assumption.
2811 */
2812 if( nRec==0xffffffff ){
2813 assert( pPager->journalOff==JOURNAL_HDR_SZ(pPager) );
2814 nRec = (int)((szJ - JOURNAL_HDR_SZ(pPager))/JOURNAL_PG_SZ(pPager));
2815 }
2816
2817 /* If nRec is 0 and this rollback is of a transaction created by this
2818 ** process and if this is the final header in the journal, then it means
2819 ** that this part of the journal was being filled but has not yet been
2820 ** synced to disk. Compute the number of pages based on the remaining
2821 ** size of the file.
2822 **
2823 ** The third term of the test was added to fix ticket #2565.
2824 ** When rolling back a hot journal, nRec==0 always means that the next
2825 ** chunk of the journal contains zero pages to be rolled back. But
2826 ** when doing a ROLLBACK and the nRec==0 chunk is the last chunk in
2827 ** the journal, it means that the journal might contain additional
2828 ** pages that need to be rolled back and that the number of pages
2829 ** should be computed based on the journal file size.
2830 */
2831 if( nRec==0 && !isHot &&
2832 pPager->journalHdr+JOURNAL_HDR_SZ(pPager)==pPager->journalOff ){
2833 nRec = (int)((szJ - pPager->journalOff) / JOURNAL_PG_SZ(pPager));
2834 }
2835
2836 /* If this is the first header read from the journal, truncate the
2837 ** database file back to its original size.
2838 */
2839 if( pPager->journalOff==JOURNAL_HDR_SZ(pPager) ){
2840 rc = pager_truncate(pPager, mxPg);
2841 if( rc!=SQLITE_OK ){
2842 goto end_playback;
2843 }
2844 pPager->dbSize = mxPg;
2845 }
2846
2847 /* Copy original pages out of the journal and back into the
2848 ** database file and/or page cache.
2849 */
2850 for(u=0; u<nRec; u++){
2851 if( needPagerReset ){
2852 pager_reset(pPager);
2853 needPagerReset = 0;
2854 }
2855 rc = pager_playback_one_page(pPager,&pPager->journalOff,0,1,0);
2856 if( rc==SQLITE_OK ){
2857 nPlayback++;
2858 }else{
2859 if( rc==SQLITE_DONE ){
2860 pPager->journalOff = szJ;
2861 break;
2862 }else if( rc==SQLITE_IOERR_SHORT_READ ){
2863 /* If the journal has been truncated, simply stop reading and
2864 ** processing the journal. This might happen if the journal was
2865 ** not completely written and synced prior to a crash. In that
2866 ** case, the database should have never been written in the
2867 ** first place so it is OK to simply abandon the rollback. */
2868 rc = SQLITE_OK;
2869 goto end_playback;
2870 }else{
2871 /* If we are unable to rollback, quit and return the error
2872 ** code. This will cause the pager to enter the error state
2873 ** so that no further harm will be done. Perhaps the next
2874 ** process to come along will be able to rollback the database.
2875 */
2876 goto end_playback;
2877 }
2878 }
2879 }
2880 }
2881 /*NOTREACHED*/
2882 assert( 0 );
2883
2884 end_playback:
2885 /* Following a rollback, the database file should be back in its original
2886 ** state prior to the start of the transaction, so invoke the
2887 ** SQLITE_FCNTL_DB_UNCHANGED file-control method to disable the
2888 ** assertion that the transaction counter was modified.
2889 */
2890 #ifdef SQLITE_DEBUG
2891 if( pPager->fd->pMethods ){
2892 sqlite3OsFileControlHint(pPager->fd,SQLITE_FCNTL_DB_UNCHANGED,0);
2893 }
2894 #endif
2895
2896 /* If this playback is happening automatically as a result of an IO or
2897 ** malloc error that occurred after the change-counter was updated but
2898 ** before the transaction was committed, then the change-counter
2899 ** modification may just have been reverted. If this happens in exclusive
2900 ** mode, then subsequent transactions performed by the connection will not
2901 ** update the change-counter at all. This may lead to cache inconsistency
2902 ** problems for other processes at some point in the future. So, just
2903 ** in case this has happened, clear the changeCountDone flag now.
2904 */
2905 pPager->changeCountDone = pPager->tempFile;
2906
2907 if( rc==SQLITE_OK ){
2908 zMaster = pPager->pTmpSpace;
2909 rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1);
2910 testcase( rc!=SQLITE_OK );
2911 }
2912 if( rc==SQLITE_OK
2913 && (pPager->eState>=PAGER_WRITER_DBMOD || pPager->eState==PAGER_OPEN)
2914 ){
2915 rc = sqlite3PagerSync(pPager, 0);
2916 }
2917 if( rc==SQLITE_OK ){
2918 rc = pager_end_transaction(pPager, zMaster[0]!='\0', 0);
2919 testcase( rc!=SQLITE_OK );
2920 }
2921 if( rc==SQLITE_OK && zMaster[0] && res ){
2922 /* If there was a master journal and this routine will return success,
2923 ** see if it is possible to delete the master journal.
2924 */
2925 rc = pager_delmaster(pPager, zMaster);
2926 testcase( rc!=SQLITE_OK );
2927 }
2928 if( isHot && nPlayback ){
2929 sqlite3_log(SQLITE_NOTICE_RECOVER_ROLLBACK, "recovered %d pages from %s",
2930 nPlayback, pPager->zJournal);
2931 }
2932
2933 /* The Pager.sectorSize variable may have been updated while rolling
2934 ** back a journal created by a process with a different sector size
2935 ** value. Reset it to the correct value for this process.
2936 */
2937 setSectorSize(pPager);
2938 return rc;
2939 }
2940
2941
2942 /*
2943 ** Read the content for page pPg out of the database file and into
2944 ** pPg->pData. A shared lock or greater must be held on the database
2945 ** file before this function is called.
2946 **
2947 ** If page 1 is read, then the value of Pager.dbFileVers[] is set to
2948 ** the value read from the database file.
2949 **
2950 ** If an IO error occurs, then the IO error is returned to the caller.
2951 ** Otherwise, SQLITE_OK is returned.
2952 */
2953 static int readDbPage(PgHdr *pPg, u32 iFrame){
2954 Pager *pPager = pPg->pPager; /* Pager object associated with page pPg */
2955 Pgno pgno = pPg->pgno; /* Page number to read */
2956 int rc = SQLITE_OK; /* Return code */
2957 int pgsz = pPager->pageSize; /* Number of bytes to read */
2958
2959 assert( pPager->eState>=PAGER_READER && !MEMDB );
2960 assert( isOpen(pPager->fd) );
2961
2962 #ifndef SQLITE_OMIT_WAL
2963 if( iFrame ){
2964 /* Try to pull the page from the write-ahead log. */
2965 rc = sqlite3WalReadFrame(pPager->pWal, iFrame, pgsz, pPg->pData);
2966 }else
2967 #endif
2968 {
2969 i64 iOffset = (pgno-1)*(i64)pPager->pageSize;
2970 rc = sqlite3OsRead(pPager->fd, pPg->pData, pgsz, iOffset);
2971 if( rc==SQLITE_IOERR_SHORT_READ ){
2972 rc = SQLITE_OK;
2973 }
2974 }
2975
2976 if( pgno==1 ){
2977 if( rc ){
2978 /* If the read is unsuccessful, set the dbFileVers[] to something
2979 ** that will never be a valid file version. dbFileVers[] is a copy
2980 ** of bytes 24..39 of the database. Bytes 28..31 should always be
2981 ** zero or the size of the database in page. Bytes 32..35 and 35..39
2982 ** should be page numbers which are never 0xffffffff. So filling
2983 ** pPager->dbFileVers[] with all 0xff bytes should suffice.
2984 **
2985 ** For an encrypted database, the situation is more complex: bytes
2986 ** 24..39 of the database are white noise. But the probability of
2987 ** white noise equaling 16 bytes of 0xff is vanishingly small so
2988 ** we should still be ok.
2989 */
2990 memset(pPager->dbFileVers, 0xff, sizeof(pPager->dbFileVers));
2991 }else{
2992 u8 *dbFileVers = &((u8*)pPg->pData)[24];
2993 memcpy(&pPager->dbFileVers, dbFileVers, sizeof(pPager->dbFileVers));
2994 }
2995 }
2996 CODEC1(pPager, pPg->pData, pgno, 3, rc = SQLITE_NOMEM_BKPT);
2997
2998 PAGER_INCR(sqlite3_pager_readdb_count);
2999 PAGER_INCR(pPager->nRead);
3000 IOTRACE(("PGIN %p %d\n", pPager, pgno));
3001 PAGERTRACE(("FETCH %d page %d hash(%08x)\n",
3002 PAGERID(pPager), pgno, pager_pagehash(pPg)));
3003
3004 return rc;
3005 }
3006
3007 /*
3008 ** Update the value of the change-counter at offsets 24 and 92 in
3009 ** the header and the sqlite version number at offset 96.
3010 **
3011 ** This is an unconditional update. See also the pager_incr_changecounter()
3012 ** routine which only updates the change-counter if the update is actually
3013 ** needed, as determined by the pPager->changeCountDone state variable.
3014 */
3015 static void pager_write_changecounter(PgHdr *pPg){
3016 u32 change_counter;
3017
3018 /* Increment the value just read and write it back to byte 24. */
3019 change_counter = sqlite3Get4byte((u8*)pPg->pPager->dbFileVers)+1;
3020 put32bits(((char*)pPg->pData)+24, change_counter);
3021
3022 /* Also store the SQLite version number in bytes 96..99 and in
3023 ** bytes 92..95 store the change counter for which the version number
3024 ** is valid. */
3025 put32bits(((char*)pPg->pData)+92, change_counter);
3026 put32bits(((char*)pPg->pData)+96, SQLITE_VERSION_NUMBER);
3027 }
3028
3029 #ifndef SQLITE_OMIT_WAL
3030 /*
3031 ** This function is invoked once for each page that has already been
3032 ** written into the log file when a WAL transaction is rolled back.
3033 ** Parameter iPg is the page number of said page. The pCtx argument
3034 ** is actually a pointer to the Pager structure.
3035 **
3036 ** If page iPg is present in the cache, and has no outstanding references,
3037 ** it is discarded. Otherwise, if there are one or more outstanding
3038 ** references, the page content is reloaded from the database. If the
3039 ** attempt to reload content from the database is required and fails,
3040 ** return an SQLite error code. Otherwise, SQLITE_OK.
3041 */
3042 static int pagerUndoCallback(void *pCtx, Pgno iPg){
3043 int rc = SQLITE_OK;
3044 Pager *pPager = (Pager *)pCtx;
3045 PgHdr *pPg;
3046
3047 assert( pagerUseWal(pPager) );
3048 pPg = sqlite3PagerLookup(pPager, iPg);
3049 if( pPg ){
3050 if( sqlite3PcachePageRefcount(pPg)==1 ){
3051 sqlite3PcacheDrop(pPg);
3052 }else{
3053 u32 iFrame = 0;
3054 rc = sqlite3WalFindFrame(pPager->pWal, pPg->pgno, &iFrame);
3055 if( rc==SQLITE_OK ){
3056 rc = readDbPage(pPg, iFrame);
3057 }
3058 if( rc==SQLITE_OK ){
3059 pPager->xReiniter(pPg);
3060 }
3061 sqlite3PagerUnrefNotNull(pPg);
3062 }
3063 }
3064
3065 /* Normally, if a transaction is rolled back, any backup processes are
3066 ** updated as data is copied out of the rollback journal and into the
3067 ** database. This is not generally possible with a WAL database, as
3068 ** rollback involves simply truncating the log file. Therefore, if one
3069 ** or more frames have already been written to the log (and therefore
3070 ** also copied into the backup databases) as part of this transaction,
3071 ** the backups must be restarted.
3072 */
3073 sqlite3BackupRestart(pPager->pBackup);
3074
3075 return rc;
3076 }
3077
3078 /*
3079 ** This function is called to rollback a transaction on a WAL database.
3080 */
3081 static int pagerRollbackWal(Pager *pPager){
3082 int rc; /* Return Code */
3083 PgHdr *pList; /* List of dirty pages to revert */
3084
3085 /* For all pages in the cache that are currently dirty or have already
3086 ** been written (but not committed) to the log file, do one of the
3087 ** following:
3088 **
3089 ** + Discard the cached page (if refcount==0), or
3090 ** + Reload page content from the database (if refcount>0).
3091 */
3092 pPager->dbSize = pPager->dbOrigSize;
3093 rc = sqlite3WalUndo(pPager->pWal, pagerUndoCallback, (void *)pPager);
3094 pList = sqlite3PcacheDirtyList(pPager->pPCache);
3095 while( pList && rc==SQLITE_OK ){
3096 PgHdr *pNext = pList->pDirty;
3097 rc = pagerUndoCallback((void *)pPager, pList->pgno);
3098 pList = pNext;
3099 }
3100
3101 return rc;
3102 }
3103
3104 /*
3105 ** This function is a wrapper around sqlite3WalFrames(). As well as logging
3106 ** the contents of the list of pages headed by pList (connected by pDirty),
3107 ** this function notifies any active backup processes that the pages have
3108 ** changed.
3109 **
3110 ** The list of pages passed into this routine is always sorted by page number.
3111 ** Hence, if page 1 appears anywhere on the list, it will be the first page.
3112 */
3113 static int pagerWalFrames(
3114 Pager *pPager, /* Pager object */
3115 PgHdr *pList, /* List of frames to log */
3116 Pgno nTruncate, /* Database size after this commit */
3117 int isCommit /* True if this is a commit */
3118 ){
3119 int rc; /* Return code */
3120 int nList; /* Number of pages in pList */
3121 PgHdr *p; /* For looping over pages */
3122
3123 assert( pPager->pWal );
3124 assert( pList );
3125 #ifdef SQLITE_DEBUG
3126 /* Verify that the page list is in accending order */
3127 for(p=pList; p && p->pDirty; p=p->pDirty){
3128 assert( p->pgno < p->pDirty->pgno );
3129 }
3130 #endif
3131
3132 assert( pList->pDirty==0 || isCommit );
3133 if( isCommit ){
3134 /* If a WAL transaction is being committed, there is no point in writing
3135 ** any pages with page numbers greater than nTruncate into the WAL file.
3136 ** They will never be read by any client. So remove them from the pDirty
3137 ** list here. */
3138 PgHdr **ppNext = &pList;
3139 nList = 0;
3140 for(p=pList; (*ppNext = p)!=0; p=p->pDirty){
3141 if( p->pgno<=nTruncate ){
3142 ppNext = &p->pDirty;
3143 nList++;
3144 }
3145 }
3146 assert( pList );
3147 }else{
3148 nList = 1;
3149 }
3150 pPager->aStat[PAGER_STAT_WRITE] += nList;
3151
3152 if( pList->pgno==1 ) pager_write_changecounter(pList);
3153 rc = sqlite3WalFrames(pPager->pWal,
3154 pPager->pageSize, pList, nTruncate, isCommit, pPager->walSyncFlags
3155 );
3156 if( rc==SQLITE_OK && pPager->pBackup ){
3157 for(p=pList; p; p=p->pDirty){
3158 sqlite3BackupUpdate(pPager->pBackup, p->pgno, (u8 *)p->pData);
3159 }
3160 }
3161
3162 #ifdef SQLITE_CHECK_PAGES
3163 pList = sqlite3PcacheDirtyList(pPager->pPCache);
3164 for(p=pList; p; p=p->pDirty){
3165 pager_set_pagehash(p);
3166 }
3167 #endif
3168
3169 return rc;
3170 }
3171
3172 /*
3173 ** Begin a read transaction on the WAL.
3174 **
3175 ** This routine used to be called "pagerOpenSnapshot()" because it essentially
3176 ** makes a snapshot of the database at the current point in time and preserves
3177 ** that snapshot for use by the reader in spite of concurrently changes by
3178 ** other writers or checkpointers.
3179 */
3180 static int pagerBeginReadTransaction(Pager *pPager){
3181 int rc; /* Return code */
3182 int changed = 0; /* True if cache must be reset */
3183
3184 assert( pagerUseWal(pPager) );
3185 assert( pPager->eState==PAGER_OPEN || pPager->eState==PAGER_READER );
3186
3187 /* sqlite3WalEndReadTransaction() was not called for the previous
3188 ** transaction in locking_mode=EXCLUSIVE. So call it now. If we
3189 ** are in locking_mode=NORMAL and EndRead() was previously called,
3190 ** the duplicate call is harmless.
3191 */
3192 sqlite3WalEndReadTransaction(pPager->pWal);
3193
3194 rc = sqlite3WalBeginReadTransaction(pPager->pWal, &changed);
3195 if( rc!=SQLITE_OK || changed ){
3196 pager_reset(pPager);
3197 if( USEFETCH(pPager) ) sqlite3OsUnfetch(pPager->fd, 0, 0);
3198 }
3199
3200 return rc;
3201 }
3202 #endif
3203
3204 /*
3205 ** This function is called as part of the transition from PAGER_OPEN
3206 ** to PAGER_READER state to determine the size of the database file
3207 ** in pages (assuming the page size currently stored in Pager.pageSize).
3208 **
3209 ** If no error occurs, SQLITE_OK is returned and the size of the database
3210 ** in pages is stored in *pnPage. Otherwise, an error code (perhaps
3211 ** SQLITE_IOERR_FSTAT) is returned and *pnPage is left unmodified.
3212 */
3213 static int pagerPagecount(Pager *pPager, Pgno *pnPage){
3214 Pgno nPage; /* Value to return via *pnPage */
3215
3216 /* Query the WAL sub-system for the database size. The WalDbsize()
3217 ** function returns zero if the WAL is not open (i.e. Pager.pWal==0), or
3218 ** if the database size is not available. The database size is not
3219 ** available from the WAL sub-system if the log file is empty or
3220 ** contains no valid committed transactions.
3221 */
3222 assert( pPager->eState==PAGER_OPEN );
3223 assert( pPager->eLock>=SHARED_LOCK );
3224 assert( isOpen(pPager->fd) );
3225 assert( pPager->tempFile==0 );
3226 nPage = sqlite3WalDbsize(pPager->pWal);
3227
3228 /* If the number of pages in the database is not available from the
3229 ** WAL sub-system, determine the page counte based on the size of
3230 ** the database file. If the size of the database file is not an
3231 ** integer multiple of the page-size, round up the result.
3232 */
3233 if( nPage==0 && ALWAYS(isOpen(pPager->fd)) ){
3234 i64 n = 0; /* Size of db file in bytes */
3235 int rc = sqlite3OsFileSize(pPager->fd, &n);
3236 if( rc!=SQLITE_OK ){
3237 return rc;
3238 }
3239 nPage = (Pgno)((n+pPager->pageSize-1) / pPager->pageSize);
3240 }
3241
3242 /* If the current number of pages in the file is greater than the
3243 ** configured maximum pager number, increase the allowed limit so
3244 ** that the file can be read.
3245 */
3246 if( nPage>pPager->mxPgno ){
3247 pPager->mxPgno = (Pgno)nPage;
3248 }
3249
3250 *pnPage = nPage;
3251 return SQLITE_OK;
3252 }
3253
3254 #ifndef SQLITE_OMIT_WAL
3255 /*
3256 ** Check if the *-wal file that corresponds to the database opened by pPager
3257 ** exists if the database is not empy, or verify that the *-wal file does
3258 ** not exist (by deleting it) if the database file is empty.
3259 **
3260 ** If the database is not empty and the *-wal file exists, open the pager
3261 ** in WAL mode. If the database is empty or if no *-wal file exists and
3262 ** if no error occurs, make sure Pager.journalMode is not set to
3263 ** PAGER_JOURNALMODE_WAL.
3264 **
3265 ** Return SQLITE_OK or an error code.
3266 **
3267 ** The caller must hold a SHARED lock on the database file to call this
3268 ** function. Because an EXCLUSIVE lock on the db file is required to delete
3269 ** a WAL on a none-empty database, this ensures there is no race condition
3270 ** between the xAccess() below and an xDelete() being executed by some
3271 ** other connection.
3272 */
3273 static int pagerOpenWalIfPresent(Pager *pPager){
3274 int rc = SQLITE_OK;
3275 assert( pPager->eState==PAGER_OPEN );
3276 assert( pPager->eLock>=SHARED_LOCK );
3277
3278 if( !pPager->tempFile ){
3279 int isWal; /* True if WAL file exists */
3280 Pgno nPage; /* Size of the database file */
3281
3282 rc = pagerPagecount(pPager, &nPage);
3283 if( rc ) return rc;
3284 if( nPage==0 ){
3285 rc = sqlite3OsDelete(pPager->pVfs, pPager->zWal, 0);
3286 if( rc==SQLITE_IOERR_DELETE_NOENT ) rc = SQLITE_OK;
3287 isWal = 0;
3288 }else{
3289 rc = sqlite3OsAccess(
3290 pPager->pVfs, pPager->zWal, SQLITE_ACCESS_EXISTS, &isWal
3291 );
3292 }
3293 if( rc==SQLITE_OK ){
3294 if( isWal ){
3295 testcase( sqlite3PcachePagecount(pPager->pPCache)==0 );
3296 rc = sqlite3PagerOpenWal(pPager, 0);
3297 }else if( pPager->journalMode==PAGER_JOURNALMODE_WAL ){
3298 pPager->journalMode = PAGER_JOURNALMODE_DELETE;
3299 }
3300 }
3301 }
3302 return rc;
3303 }
3304 #endif
3305
3306 /*
3307 ** Playback savepoint pSavepoint. Or, if pSavepoint==NULL, then playback
3308 ** the entire master journal file. The case pSavepoint==NULL occurs when
3309 ** a ROLLBACK TO command is invoked on a SAVEPOINT that is a transaction
3310 ** savepoint.
3311 **
3312 ** When pSavepoint is not NULL (meaning a non-transaction savepoint is
3313 ** being rolled back), then the rollback consists of up to three stages,
3314 ** performed in the order specified:
3315 **
3316 ** * Pages are played back from the main journal starting at byte
3317 ** offset PagerSavepoint.iOffset and continuing to
3318 ** PagerSavepoint.iHdrOffset, or to the end of the main journal
3319 ** file if PagerSavepoint.iHdrOffset is zero.
3320 **
3321 ** * If PagerSavepoint.iHdrOffset is not zero, then pages are played
3322 ** back starting from the journal header immediately following
3323 ** PagerSavepoint.iHdrOffset to the end of the main journal file.
3324 **
3325 ** * Pages are then played back from the sub-journal file, starting
3326 ** with the PagerSavepoint.iSubRec and continuing to the end of
3327 ** the journal file.
3328 **
3329 ** Throughout the rollback process, each time a page is rolled back, the
3330 ** corresponding bit is set in a bitvec structure (variable pDone in the
3331 ** implementation below). This is used to ensure that a page is only
3332 ** rolled back the first time it is encountered in either journal.
3333 **
3334 ** If pSavepoint is NULL, then pages are only played back from the main
3335 ** journal file. There is no need for a bitvec in this case.
3336 **
3337 ** In either case, before playback commences the Pager.dbSize variable
3338 ** is reset to the value that it held at the start of the savepoint
3339 ** (or transaction). No page with a page-number greater than this value
3340 ** is played back. If one is encountered it is simply skipped.
3341 */
3342 static int pagerPlaybackSavepoint(Pager *pPager, PagerSavepoint *pSavepoint){
3343 i64 szJ; /* Effective size of the main journal */
3344 i64 iHdrOff; /* End of first segment of main-journal records */
3345 int rc = SQLITE_OK; /* Return code */
3346 Bitvec *pDone = 0; /* Bitvec to ensure pages played back only once */
3347
3348 assert( pPager->eState!=PAGER_ERROR );
3349 assert( pPager->eState>=PAGER_WRITER_LOCKED );
3350
3351 /* Allocate a bitvec to use to store the set of pages rolled back */
3352 if( pSavepoint ){
3353 pDone = sqlite3BitvecCreate(pSavepoint->nOrig);
3354 if( !pDone ){
3355 return SQLITE_NOMEM_BKPT;
3356 }
3357 }
3358
3359 /* Set the database size back to the value it was before the savepoint
3360 ** being reverted was opened.
3361 */
3362 pPager->dbSize = pSavepoint ? pSavepoint->nOrig : pPager->dbOrigSize;
3363 pPager->changeCountDone = pPager->tempFile;
3364
3365 if( !pSavepoint && pagerUseWal(pPager) ){
3366 return pagerRollbackWal(pPager);
3367 }
3368
3369 /* Use pPager->journalOff as the effective size of the main rollback
3370 ** journal. The actual file might be larger than this in
3371 ** PAGER_JOURNALMODE_TRUNCATE or PAGER_JOURNALMODE_PERSIST. But anything
3372 ** past pPager->journalOff is off-limits to us.
3373 */
3374 szJ = pPager->journalOff;
3375 assert( pagerUseWal(pPager)==0 || szJ==0 );
3376
3377 /* Begin by rolling back records from the main journal starting at
3378 ** PagerSavepoint.iOffset and continuing to the next journal header.
3379 ** There might be records in the main journal that have a page number
3380 ** greater than the current database size (pPager->dbSize) but those
3381 ** will be skipped automatically. Pages are added to pDone as they
3382 ** are played back.
3383 */
3384 if( pSavepoint && !pagerUseWal(pPager) ){
3385 iHdrOff = pSavepoint->iHdrOffset ? pSavepoint->iHdrOffset : szJ;
3386 pPager->journalOff = pSavepoint->iOffset;
3387 while( rc==SQLITE_OK && pPager->journalOff<iHdrOff ){
3388 rc = pager_playback_one_page(pPager, &pPager->journalOff, pDone, 1, 1);
3389 }
3390 assert( rc!=SQLITE_DONE );
3391 }else{
3392 pPager->journalOff = 0;
3393 }
3394
3395 /* Continue rolling back records out of the main journal starting at
3396 ** the first journal header seen and continuing until the effective end
3397 ** of the main journal file. Continue to skip out-of-range pages and
3398 ** continue adding pages rolled back to pDone.
3399 */
3400 while( rc==SQLITE_OK && pPager->journalOff<szJ ){
3401 u32 ii; /* Loop counter */
3402 u32 nJRec = 0; /* Number of Journal Records */
3403 u32 dummy;
3404 rc = readJournalHdr(pPager, 0, szJ, &nJRec, &dummy);
3405 assert( rc!=SQLITE_DONE );
3406
3407 /*
3408 ** The "pPager->journalHdr+JOURNAL_HDR_SZ(pPager)==pPager->journalOff"
3409 ** test is related to ticket #2565. See the discussion in the
3410 ** pager_playback() function for additional information.
3411 */
3412 if( nJRec==0
3413 && pPager->journalHdr+JOURNAL_HDR_SZ(pPager)==pPager->journalOff
3414 ){
3415 nJRec = (u32)((szJ - pPager->journalOff)/JOURNAL_PG_SZ(pPager));
3416 }
3417 for(ii=0; rc==SQLITE_OK && ii<nJRec && pPager->journalOff<szJ; ii++){
3418 rc = pager_playback_one_page(pPager, &pPager->journalOff, pDone, 1, 1);
3419 }
3420 assert( rc!=SQLITE_DONE );
3421 }
3422 assert( rc!=SQLITE_OK || pPager->journalOff>=szJ );
3423
3424 /* Finally, rollback pages from the sub-journal. Page that were
3425 ** previously rolled back out of the main journal (and are hence in pDone)
3426 ** will be skipped. Out-of-range pages are also skipped.
3427 */
3428 if( pSavepoint ){
3429 u32 ii; /* Loop counter */
3430 i64 offset = (i64)pSavepoint->iSubRec*(4+pPager->pageSize);
3431
3432 if( pagerUseWal(pPager) ){
3433 rc = sqlite3WalSavepointUndo(pPager->pWal, pSavepoint->aWalData);
3434 }
3435 for(ii=pSavepoint->iSubRec; rc==SQLITE_OK && ii<pPager->nSubRec; ii++){
3436 assert( offset==(i64)ii*(4+pPager->pageSize) );
3437 rc = pager_playback_one_page(pPager, &offset, pDone, 0, 1);
3438 }
3439 assert( rc!=SQLITE_DONE );
3440 }
3441
3442 sqlite3BitvecDestroy(pDone);
3443 if( rc==SQLITE_OK ){
3444 pPager->journalOff = szJ;
3445 }
3446
3447 return rc;
3448 }
3449
3450 /*
3451 ** Change the maximum number of in-memory pages that are allowed
3452 ** before attempting to recycle clean and unused pages.
3453 */
3454 void sqlite3PagerSetCachesize(Pager *pPager, int mxPage){
3455 sqlite3PcacheSetCachesize(pPager->pPCache, mxPage);
3456 }
3457
3458 /*
3459 ** Change the maximum number of in-memory pages that are allowed
3460 ** before attempting to spill pages to journal.
3461 */
3462 int sqlite3PagerSetSpillsize(Pager *pPager, int mxPage){
3463 return sqlite3PcacheSetSpillsize(pPager->pPCache, mxPage);
3464 }
3465
3466 /*
3467 ** Invoke SQLITE_FCNTL_MMAP_SIZE based on the current value of szMmap.
3468 */
3469 static void pagerFixMaplimit(Pager *pPager){
3470 #if SQLITE_MAX_MMAP_SIZE>0
3471 sqlite3_file *fd = pPager->fd;
3472 if( isOpen(fd) && fd->pMethods->iVersion>=3 ){
3473 sqlite3_int64 sz;
3474 sz = pPager->szMmap;
3475 pPager->bUseFetch = (sz>0);
3476 setGetterMethod(pPager);
3477 sqlite3OsFileControlHint(pPager->fd, SQLITE_FCNTL_MMAP_SIZE, &sz);
3478 }
3479 #endif
3480 }
3481
3482 /*
3483 ** Change the maximum size of any memory mapping made of the database file.
3484 */
3485 void sqlite3PagerSetMmapLimit(Pager *pPager, sqlite3_int64 szMmap){
3486 pPager->szMmap = szMmap;
3487 pagerFixMaplimit(pPager);
3488 }
3489
3490 /*
3491 ** Free as much memory as possible from the pager.
3492 */
3493 void sqlite3PagerShrink(Pager *pPager){
3494 sqlite3PcacheShrink(pPager->pPCache);
3495 }
3496
3497 /*
3498 ** Adjust settings of the pager to those specified in the pgFlags parameter.
3499 **
3500 ** The "level" in pgFlags & PAGER_SYNCHRONOUS_MASK sets the robustness
3501 ** of the database to damage due to OS crashes or power failures by
3502 ** changing the number of syncs()s when writing the journals.
3503 ** There are four levels:
3504 **
3505 ** OFF sqlite3OsSync() is never called. This is the default
3506 ** for temporary and transient files.
3507 **
3508 ** NORMAL The journal is synced once before writes begin on the
3509 ** database. This is normally adequate protection, but
3510 ** it is theoretically possible, though very unlikely,
3511 ** that an inopertune power failure could leave the journal
3512 ** in a state which would cause damage to the database
3513 ** when it is rolled back.
3514 **
3515 ** FULL The journal is synced twice before writes begin on the
3516 ** database (with some additional information - the nRec field
3517 ** of the journal header - being written in between the two
3518 ** syncs). If we assume that writing a
3519 ** single disk sector is atomic, then this mode provides
3520 ** assurance that the journal will not be corrupted to the
3521 ** point of causing damage to the database during rollback.
3522 **
3523 ** EXTRA This is like FULL except that is also syncs the directory
3524 ** that contains the rollback journal after the rollback
3525 ** journal is unlinked.
3526 **
3527 ** The above is for a rollback-journal mode. For WAL mode, OFF continues
3528 ** to mean that no syncs ever occur. NORMAL means that the WAL is synced
3529 ** prior to the start of checkpoint and that the database file is synced
3530 ** at the conclusion of the checkpoint if the entire content of the WAL
3531 ** was written back into the database. But no sync operations occur for
3532 ** an ordinary commit in NORMAL mode with WAL. FULL means that the WAL
3533 ** file is synced following each commit operation, in addition to the
3534 ** syncs associated with NORMAL. There is no difference between FULL
3535 ** and EXTRA for WAL mode.
3536 **
3537 ** Do not confuse synchronous=FULL with SQLITE_SYNC_FULL. The
3538 ** SQLITE_SYNC_FULL macro means to use the MacOSX-style full-fsync
3539 ** using fcntl(F_FULLFSYNC). SQLITE_SYNC_NORMAL means to do an
3540 ** ordinary fsync() call. There is no difference between SQLITE_SYNC_FULL
3541 ** and SQLITE_SYNC_NORMAL on platforms other than MacOSX. But the
3542 ** synchronous=FULL versus synchronous=NORMAL setting determines when
3543 ** the xSync primitive is called and is relevant to all platforms.
3544 **
3545 ** Numeric values associated with these states are OFF==1, NORMAL=2,
3546 ** and FULL=3.
3547 */
3548 #ifndef SQLITE_OMIT_PAGER_PRAGMAS
3549 void sqlite3PagerSetFlags(
3550 Pager *pPager, /* The pager to set safety level for */
3551 unsigned pgFlags /* Various flags */
3552 ){
3553 unsigned level = pgFlags & PAGER_SYNCHRONOUS_MASK;
3554 if( pPager->tempFile ){
3555 pPager->noSync = 1;
3556 pPager->fullSync = 0;
3557 pPager->extraSync = 0;
3558 }else{
3559 pPager->noSync = level==PAGER_SYNCHRONOUS_OFF ?1:0;
3560 pPager->fullSync = level>=PAGER_SYNCHRONOUS_FULL ?1:0;
3561 pPager->extraSync = level==PAGER_SYNCHRONOUS_EXTRA ?1:0;
3562 }
3563 if( pPager->noSync ){
3564 pPager->syncFlags = 0;
3565 pPager->ckptSyncFlags = 0;
3566 }else if( pgFlags & PAGER_FULLFSYNC ){
3567 pPager->syncFlags = SQLITE_SYNC_FULL;
3568 pPager->ckptSyncFlags = SQLITE_SYNC_FULL;
3569 }else if( pgFlags & PAGER_CKPT_FULLFSYNC ){
3570 pPager->syncFlags = SQLITE_SYNC_NORMAL;
3571 pPager->ckptSyncFlags = SQLITE_SYNC_FULL;
3572 }else{
3573 pPager->syncFlags = SQLITE_SYNC_NORMAL;
3574 pPager->ckptSyncFlags = SQLITE_SYNC_NORMAL;
3575 }
3576 pPager->walSyncFlags = pPager->syncFlags;
3577 if( pPager->fullSync ){
3578 pPager->walSyncFlags |= WAL_SYNC_TRANSACTIONS;
3579 }
3580 if( pgFlags & PAGER_CACHESPILL ){
3581 pPager->doNotSpill &= ~SPILLFLAG_OFF;
3582 }else{
3583 pPager->doNotSpill |= SPILLFLAG_OFF;
3584 }
3585 }
3586 #endif
3587
3588 /*
3589 ** The following global variable is incremented whenever the library
3590 ** attempts to open a temporary file. This information is used for
3591 ** testing and analysis only.
3592 */
3593 #ifdef SQLITE_TEST
3594 int sqlite3_opentemp_count = 0;
3595 #endif
3596
3597 /*
3598 ** Open a temporary file.
3599 **
3600 ** Write the file descriptor into *pFile. Return SQLITE_OK on success
3601 ** or some other error code if we fail. The OS will automatically
3602 ** delete the temporary file when it is closed.
3603 **
3604 ** The flags passed to the VFS layer xOpen() call are those specified
3605 ** by parameter vfsFlags ORed with the following:
3606 **
3607 ** SQLITE_OPEN_READWRITE
3608 ** SQLITE_OPEN_CREATE
3609 ** SQLITE_OPEN_EXCLUSIVE
3610 ** SQLITE_OPEN_DELETEONCLOSE
3611 */
3612 static int pagerOpentemp(
3613 Pager *pPager, /* The pager object */
3614 sqlite3_file *pFile, /* Write the file descriptor here */
3615 int vfsFlags /* Flags passed through to the VFS */
3616 ){
3617 int rc; /* Return code */
3618
3619 #ifdef SQLITE_TEST
3620 sqlite3_opentemp_count++; /* Used for testing and analysis only */
3621 #endif
3622
3623 vfsFlags |= SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE |
3624 SQLITE_OPEN_EXCLUSIVE | SQLITE_OPEN_DELETEONCLOSE;
3625 rc = sqlite3OsOpen(pPager->pVfs, 0, pFile, vfsFlags, 0);
3626 assert( rc!=SQLITE_OK || isOpen(pFile) );
3627 return rc;
3628 }
3629
3630 /*
3631 ** Set the busy handler function.
3632 **
3633 ** The pager invokes the busy-handler if sqlite3OsLock() returns
3634 ** SQLITE_BUSY when trying to upgrade from no-lock to a SHARED lock,
3635 ** or when trying to upgrade from a RESERVED lock to an EXCLUSIVE
3636 ** lock. It does *not* invoke the busy handler when upgrading from
3637 ** SHARED to RESERVED, or when upgrading from SHARED to EXCLUSIVE
3638 ** (which occurs during hot-journal rollback). Summary:
3639 **
3640 ** Transition | Invokes xBusyHandler
3641 ** --------------------------------------------------------
3642 ** NO_LOCK -> SHARED_LOCK | Yes
3643 ** SHARED_LOCK -> RESERVED_LOCK | No
3644 ** SHARED_LOCK -> EXCLUSIVE_LOCK | No
3645 ** RESERVED_LOCK -> EXCLUSIVE_LOCK | Yes
3646 **
3647 ** If the busy-handler callback returns non-zero, the lock is
3648 ** retried. If it returns zero, then the SQLITE_BUSY error is
3649 ** returned to the caller of the pager API function.
3650 */
3651 void sqlite3PagerSetBusyhandler(
3652 Pager *pPager, /* Pager object */
3653 int (*xBusyHandler)(void *), /* Pointer to busy-handler function */
3654 void *pBusyHandlerArg /* Argument to pass to xBusyHandler */
3655 ){
3656 pPager->xBusyHandler = xBusyHandler;
3657 pPager->pBusyHandlerArg = pBusyHandlerArg;
3658
3659 if( isOpen(pPager->fd) ){
3660 void **ap = (void **)&pPager->xBusyHandler;
3661 assert( ((int(*)(void *))(ap[0]))==xBusyHandler );
3662 assert( ap[1]==pBusyHandlerArg );
3663 sqlite3OsFileControlHint(pPager->fd, SQLITE_FCNTL_BUSYHANDLER, (void *)ap);
3664 }
3665 }
3666
3667 /*
3668 ** Change the page size used by the Pager object. The new page size
3669 ** is passed in *pPageSize.
3670 **
3671 ** If the pager is in the error state when this function is called, it
3672 ** is a no-op. The value returned is the error state error code (i.e.
3673 ** one of SQLITE_IOERR, an SQLITE_IOERR_xxx sub-code or SQLITE_FULL).
3674 **
3675 ** Otherwise, if all of the following are true:
3676 **
3677 ** * the new page size (value of *pPageSize) is valid (a power
3678 ** of two between 512 and SQLITE_MAX_PAGE_SIZE, inclusive), and
3679 **
3680 ** * there are no outstanding page references, and
3681 **
3682 ** * the database is either not an in-memory database or it is
3683 ** an in-memory database that currently consists of zero pages.
3684 **
3685 ** then the pager object page size is set to *pPageSize.
3686 **
3687 ** If the page size is changed, then this function uses sqlite3PagerMalloc()
3688 ** to obtain a new Pager.pTmpSpace buffer. If this allocation attempt
3689 ** fails, SQLITE_NOMEM is returned and the page size remains unchanged.
3690 ** In all other cases, SQLITE_OK is returned.
3691 **
3692 ** If the page size is not changed, either because one of the enumerated
3693 ** conditions above is not true, the pager was in error state when this
3694 ** function was called, or because the memory allocation attempt failed,
3695 ** then *pPageSize is set to the old, retained page size before returning.
3696 */
3697 int sqlite3PagerSetPagesize(Pager *pPager, u32 *pPageSize, int nReserve){
3698 int rc = SQLITE_OK;
3699
3700 /* It is not possible to do a full assert_pager_state() here, as this
3701 ** function may be called from within PagerOpen(), before the state
3702 ** of the Pager object is internally consistent.
3703 **
3704 ** At one point this function returned an error if the pager was in
3705 ** PAGER_ERROR state. But since PAGER_ERROR state guarantees that
3706 ** there is at least one outstanding page reference, this function
3707 ** is a no-op for that case anyhow.
3708 */
3709
3710 u32 pageSize = *pPageSize;
3711 assert( pageSize==0 || (pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE) );
3712 if( (pPager->memDb==0 || pPager->dbSize==0)
3713 && sqlite3PcacheRefCount(pPager->pPCache)==0
3714 && pageSize && pageSize!=(u32)pPager->pageSize
3715 ){
3716 char *pNew = NULL; /* New temp space */
3717 i64 nByte = 0;
3718
3719 if( pPager->eState>PAGER_OPEN && isOpen(pPager->fd) ){
3720 rc = sqlite3OsFileSize(pPager->fd, &nByte);
3721 }
3722 if( rc==SQLITE_OK ){
3723 pNew = (char *)sqlite3PageMalloc(pageSize);
3724 if( !pNew ) rc = SQLITE_NOMEM_BKPT;
3725 }
3726
3727 if( rc==SQLITE_OK ){
3728 pager_reset(pPager);
3729 rc = sqlite3PcacheSetPageSize(pPager->pPCache, pageSize);
3730 }
3731 if( rc==SQLITE_OK ){
3732 sqlite3PageFree(pPager->pTmpSpace);
3733 pPager->pTmpSpace = pNew;
3734 pPager->dbSize = (Pgno)((nByte+pageSize-1)/pageSize);
3735 pPager->pageSize = pageSize;
3736 }else{
3737 sqlite3PageFree(pNew);
3738 }
3739 }
3740
3741 *pPageSize = pPager->pageSize;
3742 if( rc==SQLITE_OK ){
3743 if( nReserve<0 ) nReserve = pPager->nReserve;
3744 assert( nReserve>=0 && nReserve<1000 );
3745 pPager->nReserve = (i16)nReserve;
3746 pagerReportSize(pPager);
3747 pagerFixMaplimit(pPager);
3748 }
3749 return rc;
3750 }
3751
3752 /*
3753 ** Return a pointer to the "temporary page" buffer held internally
3754 ** by the pager. This is a buffer that is big enough to hold the
3755 ** entire content of a database page. This buffer is used internally
3756 ** during rollback and will be overwritten whenever a rollback
3757 ** occurs. But other modules are free to use it too, as long as
3758 ** no rollbacks are happening.
3759 */
3760 void *sqlite3PagerTempSpace(Pager *pPager){
3761 return pPager->pTmpSpace;
3762 }
3763
3764 /*
3765 ** Attempt to set the maximum database page count if mxPage is positive.
3766 ** Make no changes if mxPage is zero or negative. And never reduce the
3767 ** maximum page count below the current size of the database.
3768 **
3769 ** Regardless of mxPage, return the current maximum page count.
3770 */
3771 int sqlite3PagerMaxPageCount(Pager *pPager, int mxPage){
3772 if( mxPage>0 ){
3773 pPager->mxPgno = mxPage;
3774 }
3775 assert( pPager->eState!=PAGER_OPEN ); /* Called only by OP_MaxPgcnt */
3776 assert( pPager->mxPgno>=pPager->dbSize ); /* OP_MaxPgcnt enforces this */
3777 return pPager->mxPgno;
3778 }
3779
3780 /*
3781 ** The following set of routines are used to disable the simulated
3782 ** I/O error mechanism. These routines are used to avoid simulated
3783 ** errors in places where we do not care about errors.
3784 **
3785 ** Unless -DSQLITE_TEST=1 is used, these routines are all no-ops
3786 ** and generate no code.
3787 */
3788 #ifdef SQLITE_TEST
3789 extern int sqlite3_io_error_pending;
3790 extern int sqlite3_io_error_hit;
3791 static int saved_cnt;
3792 void disable_simulated_io_errors(void){
3793 saved_cnt = sqlite3_io_error_pending;
3794 sqlite3_io_error_pending = -1;
3795 }
3796 void enable_simulated_io_errors(void){
3797 sqlite3_io_error_pending = saved_cnt;
3798 }
3799 #else
3800 # define disable_simulated_io_errors()
3801 # define enable_simulated_io_errors()
3802 #endif
3803
3804 /*
3805 ** Read the first N bytes from the beginning of the file into memory
3806 ** that pDest points to.
3807 **
3808 ** If the pager was opened on a transient file (zFilename==""), or
3809 ** opened on a file less than N bytes in size, the output buffer is
3810 ** zeroed and SQLITE_OK returned. The rationale for this is that this
3811 ** function is used to read database headers, and a new transient or
3812 ** zero sized database has a header than consists entirely of zeroes.
3813 **
3814 ** If any IO error apart from SQLITE_IOERR_SHORT_READ is encountered,
3815 ** the error code is returned to the caller and the contents of the
3816 ** output buffer undefined.
3817 */
3818 int sqlite3PagerReadFileheader(Pager *pPager, int N, unsigned char *pDest){
3819 int rc = SQLITE_OK;
3820 memset(pDest, 0, N);
3821 assert( isOpen(pPager->fd) || pPager->tempFile );
3822
3823 /* This routine is only called by btree immediately after creating
3824 ** the Pager object. There has not been an opportunity to transition
3825 ** to WAL mode yet.
3826 */
3827 assert( !pagerUseWal(pPager) );
3828
3829 if( isOpen(pPager->fd) ){
3830 IOTRACE(("DBHDR %p 0 %d\n", pPager, N))
3831 rc = sqlite3OsRead(pPager->fd, pDest, N, 0);
3832 if( rc==SQLITE_IOERR_SHORT_READ ){
3833 rc = SQLITE_OK;
3834 }
3835 }
3836 return rc;
3837 }
3838
3839 /*
3840 ** This function may only be called when a read-transaction is open on
3841 ** the pager. It returns the total number of pages in the database.
3842 **
3843 ** However, if the file is between 1 and <page-size> bytes in size, then
3844 ** this is considered a 1 page file.
3845 */
3846 void sqlite3PagerPagecount(Pager *pPager, int *pnPage){
3847 assert( pPager->eState>=PAGER_READER );
3848 assert( pPager->eState!=PAGER_WRITER_FINISHED );
3849 *pnPage = (int)pPager->dbSize;
3850 }
3851
3852
3853 /*
3854 ** Try to obtain a lock of type locktype on the database file. If
3855 ** a similar or greater lock is already held, this function is a no-op
3856 ** (returning SQLITE_OK immediately).
3857 **
3858 ** Otherwise, attempt to obtain the lock using sqlite3OsLock(). Invoke
3859 ** the busy callback if the lock is currently not available. Repeat
3860 ** until the busy callback returns false or until the attempt to
3861 ** obtain the lock succeeds.
3862 **
3863 ** Return SQLITE_OK on success and an error code if we cannot obtain
3864 ** the lock. If the lock is obtained successfully, set the Pager.state
3865 ** variable to locktype before returning.
3866 */
3867 static int pager_wait_on_lock(Pager *pPager, int locktype){
3868 int rc; /* Return code */
3869
3870 /* Check that this is either a no-op (because the requested lock is
3871 ** already held), or one of the transitions that the busy-handler
3872 ** may be invoked during, according to the comment above
3873 ** sqlite3PagerSetBusyhandler().
3874 */
3875 assert( (pPager->eLock>=locktype)
3876 || (pPager->eLock==NO_LOCK && locktype==SHARED_LOCK)
3877 || (pPager->eLock==RESERVED_LOCK && locktype==EXCLUSIVE_LOCK)
3878 );
3879
3880 do {
3881 rc = pagerLockDb(pPager, locktype);
3882 }while( rc==SQLITE_BUSY && pPager->xBusyHandler(pPager->pBusyHandlerArg) );
3883 return rc;
3884 }
3885
3886 /*
3887 ** Function assertTruncateConstraint(pPager) checks that one of the
3888 ** following is true for all dirty pages currently in the page-cache:
3889 **
3890 ** a) The page number is less than or equal to the size of the
3891 ** current database image, in pages, OR
3892 **
3893 ** b) if the page content were written at this time, it would not
3894 ** be necessary to write the current content out to the sub-journal
3895 ** (as determined by function subjRequiresPage()).
3896 **
3897 ** If the condition asserted by this function were not true, and the
3898 ** dirty page were to be discarded from the cache via the pagerStress()
3899 ** routine, pagerStress() would not write the current page content to
3900 ** the database file. If a savepoint transaction were rolled back after
3901 ** this happened, the correct behavior would be to restore the current
3902 ** content of the page. However, since this content is not present in either
3903 ** the database file or the portion of the rollback journal and
3904 ** sub-journal rolled back the content could not be restored and the
3905 ** database image would become corrupt. It is therefore fortunate that
3906 ** this circumstance cannot arise.
3907 */
3908 #if defined(SQLITE_DEBUG)
3909 static void assertTruncateConstraintCb(PgHdr *pPg){
3910 assert( pPg->flags&PGHDR_DIRTY );
3911 assert( !subjRequiresPage(pPg) || pPg->pgno<=pPg->pPager->dbSize );
3912 }
3913 static void assertTruncateConstraint(Pager *pPager){
3914 sqlite3PcacheIterateDirty(pPager->pPCache, assertTruncateConstraintCb);
3915 }
3916 #else
3917 # define assertTruncateConstraint(pPager)
3918 #endif
3919
3920 /*
3921 ** Truncate the in-memory database file image to nPage pages. This
3922 ** function does not actually modify the database file on disk. It
3923 ** just sets the internal state of the pager object so that the
3924 ** truncation will be done when the current transaction is committed.
3925 **
3926 ** This function is only called right before committing a transaction.
3927 ** Once this function has been called, the transaction must either be
3928 ** rolled back or committed. It is not safe to call this function and
3929 ** then continue writing to the database.
3930 */
3931 void sqlite3PagerTruncateImage(Pager *pPager, Pgno nPage){
3932 assert( pPager->dbSize>=nPage );
3933 assert( pPager->eState>=PAGER_WRITER_CACHEMOD );
3934 pPager->dbSize = nPage;
3935
3936 /* At one point the code here called assertTruncateConstraint() to
3937 ** ensure that all pages being truncated away by this operation are,
3938 ** if one or more savepoints are open, present in the savepoint
3939 ** journal so that they can be restored if the savepoint is rolled
3940 ** back. This is no longer necessary as this function is now only
3941 ** called right before committing a transaction. So although the
3942 ** Pager object may still have open savepoints (Pager.nSavepoint!=0),
3943 ** they cannot be rolled back. So the assertTruncateConstraint() call
3944 ** is no longer correct. */
3945 }
3946
3947
3948 /*
3949 ** This function is called before attempting a hot-journal rollback. It
3950 ** syncs the journal file to disk, then sets pPager->journalHdr to the
3951 ** size of the journal file so that the pager_playback() routine knows
3952 ** that the entire journal file has been synced.
3953 **
3954 ** Syncing a hot-journal to disk before attempting to roll it back ensures
3955 ** that if a power-failure occurs during the rollback, the process that
3956 ** attempts rollback following system recovery sees the same journal
3957 ** content as this process.
3958 **
3959 ** If everything goes as planned, SQLITE_OK is returned. Otherwise,
3960 ** an SQLite error code.
3961 */
3962 static int pagerSyncHotJournal(Pager *pPager){
3963 int rc = SQLITE_OK;
3964 if( !pPager->noSync ){
3965 rc = sqlite3OsSync(pPager->jfd, SQLITE_SYNC_NORMAL);
3966 }
3967 if( rc==SQLITE_OK ){
3968 rc = sqlite3OsFileSize(pPager->jfd, &pPager->journalHdr);
3969 }
3970 return rc;
3971 }
3972
3973 #if SQLITE_MAX_MMAP_SIZE>0
3974 /*
3975 ** Obtain a reference to a memory mapped page object for page number pgno.
3976 ** The new object will use the pointer pData, obtained from xFetch().
3977 ** If successful, set *ppPage to point to the new page reference
3978 ** and return SQLITE_OK. Otherwise, return an SQLite error code and set
3979 ** *ppPage to zero.
3980 **
3981 ** Page references obtained by calling this function should be released
3982 ** by calling pagerReleaseMapPage().
3983 */
3984 static int pagerAcquireMapPage(
3985 Pager *pPager, /* Pager object */
3986 Pgno pgno, /* Page number */
3987 void *pData, /* xFetch()'d data for this page */
3988 PgHdr **ppPage /* OUT: Acquired page object */
3989 ){
3990 PgHdr *p; /* Memory mapped page to return */
3991
3992 if( pPager->pMmapFreelist ){
3993 *ppPage = p = pPager->pMmapFreelist;
3994 pPager->pMmapFreelist = p->pDirty;
3995 p->pDirty = 0;
3996 assert( pPager->nExtra>=8 );
3997 memset(p->pExtra, 0, 8);
3998 }else{
3999 *ppPage = p = (PgHdr *)sqlite3MallocZero(sizeof(PgHdr) + pPager->nExtra);
4000 if( p==0 ){
4001 sqlite3OsUnfetch(pPager->fd, (i64)(pgno-1) * pPager->pageSize, pData);
4002 return SQLITE_NOMEM_BKPT;
4003 }
4004 p->pExtra = (void *)&p[1];
4005 p->flags = PGHDR_MMAP;
4006 p->nRef = 1;
4007 p->pPager = pPager;
4008 }
4009
4010 assert( p->pExtra==(void *)&p[1] );
4011 assert( p->pPage==0 );
4012 assert( p->flags==PGHDR_MMAP );
4013 assert( p->pPager==pPager );
4014 assert( p->nRef==1 );
4015
4016 p->pgno = pgno;
4017 p->pData = pData;
4018 pPager->nMmapOut++;
4019
4020 return SQLITE_OK;
4021 }
4022 #endif
4023
4024 /*
4025 ** Release a reference to page pPg. pPg must have been returned by an
4026 ** earlier call to pagerAcquireMapPage().
4027 */
4028 static void pagerReleaseMapPage(PgHdr *pPg){
4029 Pager *pPager = pPg->pPager;
4030 pPager->nMmapOut--;
4031 pPg->pDirty = pPager->pMmapFreelist;
4032 pPager->pMmapFreelist = pPg;
4033
4034 assert( pPager->fd->pMethods->iVersion>=3 );
4035 sqlite3OsUnfetch(pPager->fd, (i64)(pPg->pgno-1)*pPager->pageSize, pPg->pData);
4036 }
4037
4038 /*
4039 ** Free all PgHdr objects stored in the Pager.pMmapFreelist list.
4040 */
4041 static void pagerFreeMapHdrs(Pager *pPager){
4042 PgHdr *p;
4043 PgHdr *pNext;
4044 for(p=pPager->pMmapFreelist; p; p=pNext){
4045 pNext = p->pDirty;
4046 sqlite3_free(p);
4047 }
4048 }
4049
4050
4051 /*
4052 ** Shutdown the page cache. Free all memory and close all files.
4053 **
4054 ** If a transaction was in progress when this routine is called, that
4055 ** transaction is rolled back. All outstanding pages are invalidated
4056 ** and their memory is freed. Any attempt to use a page associated
4057 ** with this page cache after this function returns will likely
4058 ** result in a coredump.
4059 **
4060 ** This function always succeeds. If a transaction is active an attempt
4061 ** is made to roll it back. If an error occurs during the rollback
4062 ** a hot journal may be left in the filesystem but no error is returned
4063 ** to the caller.
4064 */
4065 int sqlite3PagerClose(Pager *pPager, sqlite3 *db){
4066 u8 *pTmp = (u8 *)pPager->pTmpSpace;
4067
4068 assert( db || pagerUseWal(pPager)==0 );
4069 assert( assert_pager_state(pPager) );
4070 disable_simulated_io_errors();
4071 sqlite3BeginBenignMalloc();
4072 pagerFreeMapHdrs(pPager);
4073 /* pPager->errCode = 0; */
4074 pPager->exclusiveMode = 0;
4075 #ifndef SQLITE_OMIT_WAL
4076 assert( db || pPager->pWal==0 );
4077 sqlite3WalClose(pPager->pWal, db, pPager->ckptSyncFlags, pPager->pageSize,
4078 (db && (db->flags & SQLITE_NoCkptOnClose) ? 0 : pTmp)
4079 );
4080 pPager->pWal = 0;
4081 #endif
4082 pager_reset(pPager);
4083 if( MEMDB ){
4084 pager_unlock(pPager);
4085 }else{
4086 /* If it is open, sync the journal file before calling UnlockAndRollback.
4087 ** If this is not done, then an unsynced portion of the open journal
4088 ** file may be played back into the database. If a power failure occurs
4089 ** while this is happening, the database could become corrupt.
4090 **
4091 ** If an error occurs while trying to sync the journal, shift the pager
4092 ** into the ERROR state. This causes UnlockAndRollback to unlock the
4093 ** database and close the journal file without attempting to roll it
4094 ** back or finalize it. The next database user will have to do hot-journal
4095 ** rollback before accessing the database file.
4096 */
4097 if( isOpen(pPager->jfd) ){
4098 pager_error(pPager, pagerSyncHotJournal(pPager));
4099 }
4100 pagerUnlockAndRollback(pPager);
4101 }
4102 sqlite3EndBenignMalloc();
4103 enable_simulated_io_errors();
4104 PAGERTRACE(("CLOSE %d\n", PAGERID(pPager)));
4105 IOTRACE(("CLOSE %p\n", pPager))
4106 sqlite3OsClose(pPager->jfd);
4107 sqlite3OsClose(pPager->fd);
4108 sqlite3PageFree(pTmp);
4109 sqlite3PcacheClose(pPager->pPCache);
4110
4111 #ifdef SQLITE_HAS_CODEC
4112 if( pPager->xCodecFree ) pPager->xCodecFree(pPager->pCodec);
4113 #endif
4114
4115 assert( !pPager->aSavepoint && !pPager->pInJournal );
4116 assert( !isOpen(pPager->jfd) && !isOpen(pPager->sjfd) );
4117
4118 sqlite3_free(pPager);
4119 return SQLITE_OK;
4120 }
4121
4122 #if !defined(NDEBUG) || defined(SQLITE_TEST)
4123 /*
4124 ** Return the page number for page pPg.
4125 */
4126 Pgno sqlite3PagerPagenumber(DbPage *pPg){
4127 return pPg->pgno;
4128 }
4129 #endif
4130
4131 /*
4132 ** Increment the reference count for page pPg.
4133 */
4134 void sqlite3PagerRef(DbPage *pPg){
4135 sqlite3PcacheRef(pPg);
4136 }
4137
4138 /*
4139 ** Sync the journal. In other words, make sure all the pages that have
4140 ** been written to the journal have actually reached the surface of the
4141 ** disk and can be restored in the event of a hot-journal rollback.
4142 **
4143 ** If the Pager.noSync flag is set, then this function is a no-op.
4144 ** Otherwise, the actions required depend on the journal-mode and the
4145 ** device characteristics of the file-system, as follows:
4146 **
4147 ** * If the journal file is an in-memory journal file, no action need
4148 ** be taken.
4149 **
4150 ** * Otherwise, if the device does not support the SAFE_APPEND property,
4151 ** then the nRec field of the most recently written journal header
4152 ** is updated to contain the number of journal records that have
4153 ** been written following it. If the pager is operating in full-sync
4154 ** mode, then the journal file is synced before this field is updated.
4155 **
4156 ** * If the device does not support the SEQUENTIAL property, then
4157 ** journal file is synced.
4158 **
4159 ** Or, in pseudo-code:
4160 **
4161 ** if( NOT <in-memory journal> ){
4162 ** if( NOT SAFE_APPEND ){
4163 ** if( <full-sync mode> ) xSync(<journal file>);
4164 ** <update nRec field>
4165 ** }
4166 ** if( NOT SEQUENTIAL ) xSync(<journal file>);
4167 ** }
4168 **
4169 ** If successful, this routine clears the PGHDR_NEED_SYNC flag of every
4170 ** page currently held in memory before returning SQLITE_OK. If an IO
4171 ** error is encountered, then the IO error code is returned to the caller.
4172 */
4173 static int syncJournal(Pager *pPager, int newHdr){
4174 int rc; /* Return code */
4175
4176 assert( pPager->eState==PAGER_WRITER_CACHEMOD
4177 || pPager->eState==PAGER_WRITER_DBMOD
4178 );
4179 assert( assert_pager_state(pPager) );
4180 assert( !pagerUseWal(pPager) );
4181
4182 rc = sqlite3PagerExclusiveLock(pPager);
4183 if( rc!=SQLITE_OK ) return rc;
4184
4185 if( !pPager->noSync ){
4186 assert( !pPager->tempFile );
4187 if( isOpen(pPager->jfd) && pPager->journalMode!=PAGER_JOURNALMODE_MEMORY ){
4188 const int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
4189 assert( isOpen(pPager->jfd) );
4190
4191 if( 0==(iDc&SQLITE_IOCAP_SAFE_APPEND) ){
4192 /* This block deals with an obscure problem. If the last connection
4193 ** that wrote to this database was operating in persistent-journal
4194 ** mode, then the journal file may at this point actually be larger
4195 ** than Pager.journalOff bytes. If the next thing in the journal
4196 ** file happens to be a journal-header (written as part of the
4197 ** previous connection's transaction), and a crash or power-failure
4198 ** occurs after nRec is updated but before this connection writes
4199 ** anything else to the journal file (or commits/rolls back its
4200 ** transaction), then SQLite may become confused when doing the
4201 ** hot-journal rollback following recovery. It may roll back all
4202 ** of this connections data, then proceed to rolling back the old,
4203 ** out-of-date data that follows it. Database corruption.
4204 **
4205 ** To work around this, if the journal file does appear to contain
4206 ** a valid header following Pager.journalOff, then write a 0x00
4207 ** byte to the start of it to prevent it from being recognized.
4208 **
4209 ** Variable iNextHdrOffset is set to the offset at which this
4210 ** problematic header will occur, if it exists. aMagic is used
4211 ** as a temporary buffer to inspect the first couple of bytes of
4212 ** the potential journal header.
4213 */
4214 i64 iNextHdrOffset;
4215 u8 aMagic[8];
4216 u8 zHeader[sizeof(aJournalMagic)+4];
4217
4218 memcpy(zHeader, aJournalMagic, sizeof(aJournalMagic));
4219 put32bits(&zHeader[sizeof(aJournalMagic)], pPager->nRec);
4220
4221 iNextHdrOffset = journalHdrOffset(pPager);
4222 rc = sqlite3OsRead(pPager->jfd, aMagic, 8, iNextHdrOffset);
4223 if( rc==SQLITE_OK && 0==memcmp(aMagic, aJournalMagic, 8) ){
4224 static const u8 zerobyte = 0;
4225 rc = sqlite3OsWrite(pPager->jfd, &zerobyte, 1, iNextHdrOffset);
4226 }
4227 if( rc!=SQLITE_OK && rc!=SQLITE_IOERR_SHORT_READ ){
4228 return rc;
4229 }
4230
4231 /* Write the nRec value into the journal file header. If in
4232 ** full-synchronous mode, sync the journal first. This ensures that
4233 ** all data has really hit the disk before nRec is updated to mark
4234 ** it as a candidate for rollback.
4235 **
4236 ** This is not required if the persistent media supports the
4237 ** SAFE_APPEND property. Because in this case it is not possible
4238 ** for garbage data to be appended to the file, the nRec field
4239 ** is populated with 0xFFFFFFFF when the journal header is written
4240 ** and never needs to be updated.
4241 */
4242 if( pPager->fullSync && 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
4243 PAGERTRACE(("SYNC journal of %d\n", PAGERID(pPager)));
4244 IOTRACE(("JSYNC %p\n", pPager))
4245 rc = sqlite3OsSync(pPager->jfd, pPager->syncFlags);
4246 if( rc!=SQLITE_OK ) return rc;
4247 }
4248 IOTRACE(("JHDR %p %lld\n", pPager, pPager->journalHdr));
4249 rc = sqlite3OsWrite(
4250 pPager->jfd, zHeader, sizeof(zHeader), pPager->journalHdr
4251 );
4252 if( rc!=SQLITE_OK ) return rc;
4253 }
4254 if( 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
4255 PAGERTRACE(("SYNC journal of %d\n", PAGERID(pPager)));
4256 IOTRACE(("JSYNC %p\n", pPager))
4257 rc = sqlite3OsSync(pPager->jfd, pPager->syncFlags|
4258 (pPager->syncFlags==SQLITE_SYNC_FULL?SQLITE_SYNC_DATAONLY:0)
4259 );
4260 if( rc!=SQLITE_OK ) return rc;
4261 }
4262
4263 pPager->journalHdr = pPager->journalOff;
4264 if( newHdr && 0==(iDc&SQLITE_IOCAP_SAFE_APPEND) ){
4265 pPager->nRec = 0;
4266 rc = writeJournalHdr(pPager);
4267 if( rc!=SQLITE_OK ) return rc;
4268 }
4269 }else{
4270 pPager->journalHdr = pPager->journalOff;
4271 }
4272 }
4273
4274 /* Unless the pager is in noSync mode, the journal file was just
4275 ** successfully synced. Either way, clear the PGHDR_NEED_SYNC flag on
4276 ** all pages.
4277 */
4278 sqlite3PcacheClearSyncFlags(pPager->pPCache);
4279 pPager->eState = PAGER_WRITER_DBMOD;
4280 assert( assert_pager_state(pPager) );
4281 return SQLITE_OK;
4282 }
4283
4284 /*
4285 ** The argument is the first in a linked list of dirty pages connected
4286 ** by the PgHdr.pDirty pointer. This function writes each one of the
4287 ** in-memory pages in the list to the database file. The argument may
4288 ** be NULL, representing an empty list. In this case this function is
4289 ** a no-op.
4290 **
4291 ** The pager must hold at least a RESERVED lock when this function
4292 ** is called. Before writing anything to the database file, this lock
4293 ** is upgraded to an EXCLUSIVE lock. If the lock cannot be obtained,
4294 ** SQLITE_BUSY is returned and no data is written to the database file.
4295 **
4296 ** If the pager is a temp-file pager and the actual file-system file
4297 ** is not yet open, it is created and opened before any data is
4298 ** written out.
4299 **
4300 ** Once the lock has been upgraded and, if necessary, the file opened,
4301 ** the pages are written out to the database file in list order. Writing
4302 ** a page is skipped if it meets either of the following criteria:
4303 **
4304 ** * The page number is greater than Pager.dbSize, or
4305 ** * The PGHDR_DONT_WRITE flag is set on the page.
4306 **
4307 ** If writing out a page causes the database file to grow, Pager.dbFileSize
4308 ** is updated accordingly. If page 1 is written out, then the value cached
4309 ** in Pager.dbFileVers[] is updated to match the new value stored in
4310 ** the database file.
4311 **
4312 ** If everything is successful, SQLITE_OK is returned. If an IO error
4313 ** occurs, an IO error code is returned. Or, if the EXCLUSIVE lock cannot
4314 ** be obtained, SQLITE_BUSY is returned.
4315 */
4316 static int pager_write_pagelist(Pager *pPager, PgHdr *pList){
4317 int rc = SQLITE_OK; /* Return code */
4318
4319 /* This function is only called for rollback pagers in WRITER_DBMOD state. */
4320 assert( !pagerUseWal(pPager) );
4321 assert( pPager->tempFile || pPager->eState==PAGER_WRITER_DBMOD );
4322 assert( pPager->eLock==EXCLUSIVE_LOCK );
4323 assert( isOpen(pPager->fd) || pList->pDirty==0 );
4324
4325 /* If the file is a temp-file has not yet been opened, open it now. It
4326 ** is not possible for rc to be other than SQLITE_OK if this branch
4327 ** is taken, as pager_wait_on_lock() is a no-op for temp-files.
4328 */
4329 if( !isOpen(pPager->fd) ){
4330 assert( pPager->tempFile && rc==SQLITE_OK );
4331 rc = pagerOpentemp(pPager, pPager->fd, pPager->vfsFlags);
4332 }
4333
4334 /* Before the first write, give the VFS a hint of what the final
4335 ** file size will be.
4336 */
4337 assert( rc!=SQLITE_OK || isOpen(pPager->fd) );
4338 if( rc==SQLITE_OK
4339 && pPager->dbHintSize<pPager->dbSize
4340 && (pList->pDirty || pList->pgno>pPager->dbHintSize)
4341 ){
4342 sqlite3_int64 szFile = pPager->pageSize * (sqlite3_int64)pPager->dbSize;
4343 sqlite3OsFileControlHint(pPager->fd, SQLITE_FCNTL_SIZE_HINT, &szFile);
4344 pPager->dbHintSize = pPager->dbSize;
4345 }
4346
4347 while( rc==SQLITE_OK && pList ){
4348 Pgno pgno = pList->pgno;
4349
4350 /* If there are dirty pages in the page cache with page numbers greater
4351 ** than Pager.dbSize, this means sqlite3PagerTruncateImage() was called to
4352 ** make the file smaller (presumably by auto-vacuum code). Do not write
4353 ** any such pages to the file.
4354 **
4355 ** Also, do not write out any page that has the PGHDR_DONT_WRITE flag
4356 ** set (set by sqlite3PagerDontWrite()).
4357 */
4358 if( pgno<=pPager->dbSize && 0==(pList->flags&PGHDR_DONT_WRITE) ){
4359 i64 offset = (pgno-1)*(i64)pPager->pageSize; /* Offset to write */
4360 char *pData; /* Data to write */
4361
4362 assert( (pList->flags&PGHDR_NEED_SYNC)==0 );
4363 if( pList->pgno==1 ) pager_write_changecounter(pList);
4364
4365 /* Encode the database */
4366 CODEC2(pPager, pList->pData, pgno, 6, return SQLITE_NOMEM_BKPT, pData);
4367
4368 /* Write out the page data. */
4369 rc = sqlite3OsWrite(pPager->fd, pData, pPager->pageSize, offset);
4370
4371 /* If page 1 was just written, update Pager.dbFileVers to match
4372 ** the value now stored in the database file. If writing this
4373 ** page caused the database file to grow, update dbFileSize.
4374 */
4375 if( pgno==1 ){
4376 memcpy(&pPager->dbFileVers, &pData[24], sizeof(pPager->dbFileVers));
4377 }
4378 if( pgno>pPager->dbFileSize ){
4379 pPager->dbFileSize = pgno;
4380 }
4381 pPager->aStat[PAGER_STAT_WRITE]++;
4382
4383 /* Update any backup objects copying the contents of this pager. */
4384 sqlite3BackupUpdate(pPager->pBackup, pgno, (u8*)pList->pData);
4385
4386 PAGERTRACE(("STORE %d page %d hash(%08x)\n",
4387 PAGERID(pPager), pgno, pager_pagehash(pList)));
4388 IOTRACE(("PGOUT %p %d\n", pPager, pgno));
4389 PAGER_INCR(sqlite3_pager_writedb_count);
4390 }else{
4391 PAGERTRACE(("NOSTORE %d page %d\n", PAGERID(pPager), pgno));
4392 }
4393 pager_set_pagehash(pList);
4394 pList = pList->pDirty;
4395 }
4396
4397 return rc;
4398 }
4399
4400 /*
4401 ** Ensure that the sub-journal file is open. If it is already open, this
4402 ** function is a no-op.
4403 **
4404 ** SQLITE_OK is returned if everything goes according to plan. An
4405 ** SQLITE_IOERR_XXX error code is returned if a call to sqlite3OsOpen()
4406 ** fails.
4407 */
4408 static int openSubJournal(Pager *pPager){
4409 int rc = SQLITE_OK;
4410 if( !isOpen(pPager->sjfd) ){
4411 const int flags = SQLITE_OPEN_SUBJOURNAL | SQLITE_OPEN_READWRITE
4412 | SQLITE_OPEN_CREATE | SQLITE_OPEN_EXCLUSIVE
4413 | SQLITE_OPEN_DELETEONCLOSE;
4414 int nStmtSpill = sqlite3Config.nStmtSpill;
4415 if( pPager->journalMode==PAGER_JOURNALMODE_MEMORY || pPager->subjInMemory ){
4416 nStmtSpill = -1;
4417 }
4418 rc = sqlite3JournalOpen(pPager->pVfs, 0, pPager->sjfd, flags, nStmtSpill);
4419 }
4420 return rc;
4421 }
4422
4423 /*
4424 ** Append a record of the current state of page pPg to the sub-journal.
4425 **
4426 ** If successful, set the bit corresponding to pPg->pgno in the bitvecs
4427 ** for all open savepoints before returning.
4428 **
4429 ** This function returns SQLITE_OK if everything is successful, an IO
4430 ** error code if the attempt to write to the sub-journal fails, or
4431 ** SQLITE_NOMEM if a malloc fails while setting a bit in a savepoint
4432 ** bitvec.
4433 */
4434 static int subjournalPage(PgHdr *pPg){
4435 int rc = SQLITE_OK;
4436 Pager *pPager = pPg->pPager;
4437 if( pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
4438
4439 /* Open the sub-journal, if it has not already been opened */
4440 assert( pPager->useJournal );
4441 assert( isOpen(pPager->jfd) || pagerUseWal(pPager) );
4442 assert( isOpen(pPager->sjfd) || pPager->nSubRec==0 );
4443 assert( pagerUseWal(pPager)
4444 || pageInJournal(pPager, pPg)
4445 || pPg->pgno>pPager->dbOrigSize
4446 );
4447 rc = openSubJournal(pPager);
4448
4449 /* If the sub-journal was opened successfully (or was already open),
4450 ** write the journal record into the file. */
4451 if( rc==SQLITE_OK ){
4452 void *pData = pPg->pData;
4453 i64 offset = (i64)pPager->nSubRec*(4+pPager->pageSize);
4454 char *pData2;
4455
4456 CODEC2(pPager, pData, pPg->pgno, 7, return SQLITE_NOMEM_BKPT, pData2);
4457 PAGERTRACE(("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno));
4458 rc = write32bits(pPager->sjfd, offset, pPg->pgno);
4459 if( rc==SQLITE_OK ){
4460 rc = sqlite3OsWrite(pPager->sjfd, pData2, pPager->pageSize, offset+4);
4461 }
4462 }
4463 }
4464 if( rc==SQLITE_OK ){
4465 pPager->nSubRec++;
4466 assert( pPager->nSavepoint>0 );
4467 rc = addToSavepointBitvecs(pPager, pPg->pgno);
4468 }
4469 return rc;
4470 }
4471 static int subjournalPageIfRequired(PgHdr *pPg){
4472 if( subjRequiresPage(pPg) ){
4473 return subjournalPage(pPg);
4474 }else{
4475 return SQLITE_OK;
4476 }
4477 }
4478
4479 /*
4480 ** This function is called by the pcache layer when it has reached some
4481 ** soft memory limit. The first argument is a pointer to a Pager object
4482 ** (cast as a void*). The pager is always 'purgeable' (not an in-memory
4483 ** database). The second argument is a reference to a page that is
4484 ** currently dirty but has no outstanding references. The page
4485 ** is always associated with the Pager object passed as the first
4486 ** argument.
4487 **
4488 ** The job of this function is to make pPg clean by writing its contents
4489 ** out to the database file, if possible. This may involve syncing the
4490 ** journal file.
4491 **
4492 ** If successful, sqlite3PcacheMakeClean() is called on the page and
4493 ** SQLITE_OK returned. If an IO error occurs while trying to make the
4494 ** page clean, the IO error code is returned. If the page cannot be
4495 ** made clean for some other reason, but no error occurs, then SQLITE_OK
4496 ** is returned by sqlite3PcacheMakeClean() is not called.
4497 */
4498 static int pagerStress(void *p, PgHdr *pPg){
4499 Pager *pPager = (Pager *)p;
4500 int rc = SQLITE_OK;
4501
4502 assert( pPg->pPager==pPager );
4503 assert( pPg->flags&PGHDR_DIRTY );
4504
4505 /* The doNotSpill NOSYNC bit is set during times when doing a sync of
4506 ** journal (and adding a new header) is not allowed. This occurs
4507 ** during calls to sqlite3PagerWrite() while trying to journal multiple
4508 ** pages belonging to the same sector.
4509 **
4510 ** The doNotSpill ROLLBACK and OFF bits inhibits all cache spilling
4511 ** regardless of whether or not a sync is required. This is set during
4512 ** a rollback or by user request, respectively.
4513 **
4514 ** Spilling is also prohibited when in an error state since that could
4515 ** lead to database corruption. In the current implementation it
4516 ** is impossible for sqlite3PcacheFetch() to be called with createFlag==3
4517 ** while in the error state, hence it is impossible for this routine to
4518 ** be called in the error state. Nevertheless, we include a NEVER()
4519 ** test for the error state as a safeguard against future changes.
4520 */
4521 if( NEVER(pPager->errCode) ) return SQLITE_OK;
4522 testcase( pPager->doNotSpill & SPILLFLAG_ROLLBACK );
4523 testcase( pPager->doNotSpill & SPILLFLAG_OFF );
4524 testcase( pPager->doNotSpill & SPILLFLAG_NOSYNC );
4525 if( pPager->doNotSpill
4526 && ((pPager->doNotSpill & (SPILLFLAG_ROLLBACK|SPILLFLAG_OFF))!=0
4527 || (pPg->flags & PGHDR_NEED_SYNC)!=0)
4528 ){
4529 return SQLITE_OK;
4530 }
4531
4532 pPg->pDirty = 0;
4533 if( pagerUseWal(pPager) ){
4534 /* Write a single frame for this page to the log. */
4535 rc = subjournalPageIfRequired(pPg);
4536 if( rc==SQLITE_OK ){
4537 rc = pagerWalFrames(pPager, pPg, 0, 0);
4538 }
4539 }else{
4540
4541 /* Sync the journal file if required. */
4542 if( pPg->flags&PGHDR_NEED_SYNC
4543 || pPager->eState==PAGER_WRITER_CACHEMOD
4544 ){
4545 rc = syncJournal(pPager, 1);
4546 }
4547
4548 /* Write the contents of the page out to the database file. */
4549 if( rc==SQLITE_OK ){
4550 assert( (pPg->flags&PGHDR_NEED_SYNC)==0 );
4551 rc = pager_write_pagelist(pPager, pPg);
4552 }
4553 }
4554
4555 /* Mark the page as clean. */
4556 if( rc==SQLITE_OK ){
4557 PAGERTRACE(("STRESS %d page %d\n", PAGERID(pPager), pPg->pgno));
4558 sqlite3PcacheMakeClean(pPg);
4559 }
4560
4561 return pager_error(pPager, rc);
4562 }
4563
4564 /*
4565 ** Flush all unreferenced dirty pages to disk.
4566 */
4567 int sqlite3PagerFlush(Pager *pPager){
4568 int rc = pPager->errCode;
4569 if( !MEMDB ){
4570 PgHdr *pList = sqlite3PcacheDirtyList(pPager->pPCache);
4571 assert( assert_pager_state(pPager) );
4572 while( rc==SQLITE_OK && pList ){
4573 PgHdr *pNext = pList->pDirty;
4574 if( pList->nRef==0 ){
4575 rc = pagerStress((void*)pPager, pList);
4576 }
4577 pList = pNext;
4578 }
4579 }
4580
4581 return rc;
4582 }
4583
4584 /*
4585 ** Allocate and initialize a new Pager object and put a pointer to it
4586 ** in *ppPager. The pager should eventually be freed by passing it
4587 ** to sqlite3PagerClose().
4588 **
4589 ** The zFilename argument is the path to the database file to open.
4590 ** If zFilename is NULL then a randomly-named temporary file is created
4591 ** and used as the file to be cached. Temporary files are be deleted
4592 ** automatically when they are closed. If zFilename is ":memory:" then
4593 ** all information is held in cache. It is never written to disk.
4594 ** This can be used to implement an in-memory database.
4595 **
4596 ** The nExtra parameter specifies the number of bytes of space allocated
4597 ** along with each page reference. This space is available to the user
4598 ** via the sqlite3PagerGetExtra() API. When a new page is allocated, the
4599 ** first 8 bytes of this space are zeroed but the remainder is uninitialized.
4600 ** (The extra space is used by btree as the MemPage object.)
4601 **
4602 ** The flags argument is used to specify properties that affect the
4603 ** operation of the pager. It should be passed some bitwise combination
4604 ** of the PAGER_* flags.
4605 **
4606 ** The vfsFlags parameter is a bitmask to pass to the flags parameter
4607 ** of the xOpen() method of the supplied VFS when opening files.
4608 **
4609 ** If the pager object is allocated and the specified file opened
4610 ** successfully, SQLITE_OK is returned and *ppPager set to point to
4611 ** the new pager object. If an error occurs, *ppPager is set to NULL
4612 ** and error code returned. This function may return SQLITE_NOMEM
4613 ** (sqlite3Malloc() is used to allocate memory), SQLITE_CANTOPEN or
4614 ** various SQLITE_IO_XXX errors.
4615 */
4616 int sqlite3PagerOpen(
4617 sqlite3_vfs *pVfs, /* The virtual file system to use */
4618 Pager **ppPager, /* OUT: Return the Pager structure here */
4619 const char *zFilename, /* Name of the database file to open */
4620 int nExtra, /* Extra bytes append to each in-memory page */
4621 int flags, /* flags controlling this file */
4622 int vfsFlags, /* flags passed through to sqlite3_vfs.xOpen() */
4623 void (*xReinit)(DbPage*) /* Function to reinitialize pages */
4624 ){
4625 u8 *pPtr;
4626 Pager *pPager = 0; /* Pager object to allocate and return */
4627 int rc = SQLITE_OK; /* Return code */
4628 int tempFile = 0; /* True for temp files (incl. in-memory files) */
4629 int memDb = 0; /* True if this is an in-memory file */
4630 int readOnly = 0; /* True if this is a read-only file */
4631 int journalFileSize; /* Bytes to allocate for each journal fd */
4632 char *zPathname = 0; /* Full path to database file */
4633 int nPathname = 0; /* Number of bytes in zPathname */
4634 int useJournal = (flags & PAGER_OMIT_JOURNAL)==0; /* False to omit journal */
4635 int pcacheSize = sqlite3PcacheSize(); /* Bytes to allocate for PCache */
4636 u32 szPageDflt = SQLITE_DEFAULT_PAGE_SIZE; /* Default page size */
4637 const char *zUri = 0; /* URI args to copy */
4638 int nUri = 0; /* Number of bytes of URI args at *zUri */
4639
4640 /* Figure out how much space is required for each journal file-handle
4641 ** (there are two of them, the main journal and the sub-journal). */
4642 journalFileSize = ROUND8(sqlite3JournalSize(pVfs));
4643
4644 /* Set the output variable to NULL in case an error occurs. */
4645 *ppPager = 0;
4646
4647 #ifndef SQLITE_OMIT_MEMORYDB
4648 if( flags & PAGER_MEMORY ){
4649 memDb = 1;
4650 if( zFilename && zFilename[0] ){
4651 zPathname = sqlite3DbStrDup(0, zFilename);
4652 if( zPathname==0 ) return SQLITE_NOMEM_BKPT;
4653 nPathname = sqlite3Strlen30(zPathname);
4654 zFilename = 0;
4655 }
4656 }
4657 #endif
4658
4659 /* Compute and store the full pathname in an allocated buffer pointed
4660 ** to by zPathname, length nPathname. Or, if this is a temporary file,
4661 ** leave both nPathname and zPathname set to 0.
4662 */
4663 if( zFilename && zFilename[0] ){
4664 const char *z;
4665 nPathname = pVfs->mxPathname+1;
4666 zPathname = sqlite3DbMallocRaw(0, nPathname*2);
4667 if( zPathname==0 ){
4668 return SQLITE_NOMEM_BKPT;
4669 }
4670 zPathname[0] = 0; /* Make sure initialized even if FullPathname() fails */
4671 rc = sqlite3OsFullPathname(pVfs, zFilename, nPathname, zPathname);
4672 nPathname = sqlite3Strlen30(zPathname);
4673 z = zUri = &zFilename[sqlite3Strlen30(zFilename)+1];
4674 while( *z ){
4675 z += sqlite3Strlen30(z)+1;
4676 z += sqlite3Strlen30(z)+1;
4677 }
4678 nUri = (int)(&z[1] - zUri);
4679 assert( nUri>=0 );
4680 if( rc==SQLITE_OK && nPathname+8>pVfs->mxPathname ){
4681 /* This branch is taken when the journal path required by
4682 ** the database being opened will be more than pVfs->mxPathname
4683 ** bytes in length. This means the database cannot be opened,
4684 ** as it will not be possible to open the journal file or even
4685 ** check for a hot-journal before reading.
4686 */
4687 rc = SQLITE_CANTOPEN_BKPT;
4688 }
4689 if( rc!=SQLITE_OK ){
4690 sqlite3DbFree(0, zPathname);
4691 return rc;
4692 }
4693 }
4694
4695 /* Allocate memory for the Pager structure, PCache object, the
4696 ** three file descriptors, the database file name and the journal
4697 ** file name. The layout in memory is as follows:
4698 **
4699 ** Pager object (sizeof(Pager) bytes)
4700 ** PCache object (sqlite3PcacheSize() bytes)
4701 ** Database file handle (pVfs->szOsFile bytes)
4702 ** Sub-journal file handle (journalFileSize bytes)
4703 ** Main journal file handle (journalFileSize bytes)
4704 ** Database file name (nPathname+1 bytes)
4705 ** Journal file name (nPathname+8+1 bytes)
4706 */
4707 pPtr = (u8 *)sqlite3MallocZero(
4708 ROUND8(sizeof(*pPager)) + /* Pager structure */
4709 ROUND8(pcacheSize) + /* PCache object */
4710 ROUND8(pVfs->szOsFile) + /* The main db file */
4711 journalFileSize * 2 + /* The two journal files */
4712 nPathname + 1 + nUri + /* zFilename */
4713 nPathname + 8 + 2 /* zJournal */
4714 #ifndef SQLITE_OMIT_WAL
4715 + nPathname + 4 + 2 /* zWal */
4716 #endif
4717 );
4718 assert( EIGHT_BYTE_ALIGNMENT(SQLITE_INT_TO_PTR(journalFileSize)) );
4719 if( !pPtr ){
4720 sqlite3DbFree(0, zPathname);
4721 return SQLITE_NOMEM_BKPT;
4722 }
4723 pPager = (Pager*)(pPtr);
4724 pPager->pPCache = (PCache*)(pPtr += ROUND8(sizeof(*pPager)));
4725 pPager->fd = (sqlite3_file*)(pPtr += ROUND8(pcacheSize));
4726 pPager->sjfd = (sqlite3_file*)(pPtr += ROUND8(pVfs->szOsFile));
4727 pPager->jfd = (sqlite3_file*)(pPtr += journalFileSize);
4728 pPager->zFilename = (char*)(pPtr += journalFileSize);
4729 assert( EIGHT_BYTE_ALIGNMENT(pPager->jfd) );
4730
4731 /* Fill in the Pager.zFilename and Pager.zJournal buffers, if required. */
4732 if( zPathname ){
4733 assert( nPathname>0 );
4734 pPager->zJournal = (char*)(pPtr += nPathname + 1 + nUri);
4735 memcpy(pPager->zFilename, zPathname, nPathname);
4736 if( nUri ) memcpy(&pPager->zFilename[nPathname+1], zUri, nUri);
4737 memcpy(pPager->zJournal, zPathname, nPathname);
4738 memcpy(&pPager->zJournal[nPathname], "-journal\000", 8+2);
4739 sqlite3FileSuffix3(pPager->zFilename, pPager->zJournal);
4740 #ifndef SQLITE_OMIT_WAL
4741 pPager->zWal = &pPager->zJournal[nPathname+8+1];
4742 memcpy(pPager->zWal, zPathname, nPathname);
4743 memcpy(&pPager->zWal[nPathname], "-wal\000", 4+1);
4744 sqlite3FileSuffix3(pPager->zFilename, pPager->zWal);
4745 #endif
4746 sqlite3DbFree(0, zPathname);
4747 }
4748 pPager->pVfs = pVfs;
4749 pPager->vfsFlags = vfsFlags;
4750
4751 /* Open the pager file.
4752 */
4753 if( zFilename && zFilename[0] ){
4754 int fout = 0; /* VFS flags returned by xOpen() */
4755 rc = sqlite3OsOpen(pVfs, pPager->zFilename, pPager->fd, vfsFlags, &fout);
4756 assert( !memDb );
4757 readOnly = (fout&SQLITE_OPEN_READONLY);
4758
4759 /* If the file was successfully opened for read/write access,
4760 ** choose a default page size in case we have to create the
4761 ** database file. The default page size is the maximum of:
4762 **
4763 ** + SQLITE_DEFAULT_PAGE_SIZE,
4764 ** + The value returned by sqlite3OsSectorSize()
4765 ** + The largest page size that can be written atomically.
4766 */
4767 if( rc==SQLITE_OK ){
4768 int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
4769 if( !readOnly ){
4770 setSectorSize(pPager);
4771 assert(SQLITE_DEFAULT_PAGE_SIZE<=SQLITE_MAX_DEFAULT_PAGE_SIZE);
4772 if( szPageDflt<pPager->sectorSize ){
4773 if( pPager->sectorSize>SQLITE_MAX_DEFAULT_PAGE_SIZE ){
4774 szPageDflt = SQLITE_MAX_DEFAULT_PAGE_SIZE;
4775 }else{
4776 szPageDflt = (u32)pPager->sectorSize;
4777 }
4778 }
4779 #ifdef SQLITE_ENABLE_ATOMIC_WRITE
4780 {
4781 int ii;
4782 assert(SQLITE_IOCAP_ATOMIC512==(512>>8));
4783 assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8));
4784 assert(SQLITE_MAX_DEFAULT_PAGE_SIZE<=65536);
4785 for(ii=szPageDflt; ii<=SQLITE_MAX_DEFAULT_PAGE_SIZE; ii=ii*2){
4786 if( iDc&(SQLITE_IOCAP_ATOMIC|(ii>>8)) ){
4787 szPageDflt = ii;
4788 }
4789 }
4790 }
4791 #endif
4792 }
4793 pPager->noLock = sqlite3_uri_boolean(zFilename, "nolock", 0);
4794 if( (iDc & SQLITE_IOCAP_IMMUTABLE)!=0
4795 || sqlite3_uri_boolean(zFilename, "immutable", 0) ){
4796 vfsFlags |= SQLITE_OPEN_READONLY;
4797 goto act_like_temp_file;
4798 }
4799 }
4800 }else{
4801 /* If a temporary file is requested, it is not opened immediately.
4802 ** In this case we accept the default page size and delay actually
4803 ** opening the file until the first call to OsWrite().
4804 **
4805 ** This branch is also run for an in-memory database. An in-memory
4806 ** database is the same as a temp-file that is never written out to
4807 ** disk and uses an in-memory rollback journal.
4808 **
4809 ** This branch also runs for files marked as immutable.
4810 */
4811 act_like_temp_file:
4812 tempFile = 1;
4813 pPager->eState = PAGER_READER; /* Pretend we already have a lock */
4814 pPager->eLock = EXCLUSIVE_LOCK; /* Pretend we are in EXCLUSIVE mode */
4815 pPager->noLock = 1; /* Do no locking */
4816 readOnly = (vfsFlags&SQLITE_OPEN_READONLY);
4817 }
4818
4819 /* The following call to PagerSetPagesize() serves to set the value of
4820 ** Pager.pageSize and to allocate the Pager.pTmpSpace buffer.
4821 */
4822 if( rc==SQLITE_OK ){
4823 assert( pPager->memDb==0 );
4824 rc = sqlite3PagerSetPagesize(pPager, &szPageDflt, -1);
4825 testcase( rc!=SQLITE_OK );
4826 }
4827
4828 /* Initialize the PCache object. */
4829 if( rc==SQLITE_OK ){
4830 nExtra = ROUND8(nExtra);
4831 assert( nExtra>=8 && nExtra<1000 );
4832 rc = sqlite3PcacheOpen(szPageDflt, nExtra, !memDb,
4833 !memDb?pagerStress:0, (void *)pPager, pPager->pPCache);
4834 }
4835
4836 /* If an error occurred above, free the Pager structure and close the file.
4837 */
4838 if( rc!=SQLITE_OK ){
4839 sqlite3OsClose(pPager->fd);
4840 sqlite3PageFree(pPager->pTmpSpace);
4841 sqlite3_free(pPager);
4842 return rc;
4843 }
4844
4845 PAGERTRACE(("OPEN %d %s\n", FILEHANDLEID(pPager->fd), pPager->zFilename));
4846 IOTRACE(("OPEN %p %s\n", pPager, pPager->zFilename))
4847
4848 pPager->useJournal = (u8)useJournal;
4849 /* pPager->stmtOpen = 0; */
4850 /* pPager->stmtInUse = 0; */
4851 /* pPager->nRef = 0; */
4852 /* pPager->stmtSize = 0; */
4853 /* pPager->stmtJSize = 0; */
4854 /* pPager->nPage = 0; */
4855 pPager->mxPgno = SQLITE_MAX_PAGE_COUNT;
4856 /* pPager->state = PAGER_UNLOCK; */
4857 /* pPager->errMask = 0; */
4858 pPager->tempFile = (u8)tempFile;
4859 assert( tempFile==PAGER_LOCKINGMODE_NORMAL
4860 || tempFile==PAGER_LOCKINGMODE_EXCLUSIVE );
4861 assert( PAGER_LOCKINGMODE_EXCLUSIVE==1 );
4862 pPager->exclusiveMode = (u8)tempFile;
4863 pPager->changeCountDone = pPager->tempFile;
4864 pPager->memDb = (u8)memDb;
4865 pPager->readOnly = (u8)readOnly;
4866 assert( useJournal || pPager->tempFile );
4867 pPager->noSync = pPager->tempFile;
4868 if( pPager->noSync ){
4869 assert( pPager->fullSync==0 );
4870 assert( pPager->extraSync==0 );
4871 assert( pPager->syncFlags==0 );
4872 assert( pPager->walSyncFlags==0 );
4873 assert( pPager->ckptSyncFlags==0 );
4874 }else{
4875 pPager->fullSync = 1;
4876 pPager->extraSync = 0;
4877 pPager->syncFlags = SQLITE_SYNC_NORMAL;
4878 pPager->walSyncFlags = SQLITE_SYNC_NORMAL | WAL_SYNC_TRANSACTIONS;
4879 pPager->ckptSyncFlags = SQLITE_SYNC_NORMAL;
4880 }
4881 /* pPager->pFirst = 0; */
4882 /* pPager->pFirstSynced = 0; */
4883 /* pPager->pLast = 0; */
4884 pPager->nExtra = (u16)nExtra;
4885 pPager->journalSizeLimit = SQLITE_DEFAULT_JOURNAL_SIZE_LIMIT;
4886 assert( isOpen(pPager->fd) || tempFile );
4887 setSectorSize(pPager);
4888 if( !useJournal ){
4889 pPager->journalMode = PAGER_JOURNALMODE_OFF;
4890 }else if( memDb ){
4891 pPager->journalMode = PAGER_JOURNALMODE_MEMORY;
4892 }
4893 /* pPager->xBusyHandler = 0; */
4894 /* pPager->pBusyHandlerArg = 0; */
4895 pPager->xReiniter = xReinit;
4896 setGetterMethod(pPager);
4897 /* memset(pPager->aHash, 0, sizeof(pPager->aHash)); */
4898 /* pPager->szMmap = SQLITE_DEFAULT_MMAP_SIZE // will be set by btree.c */
4899
4900 *ppPager = pPager;
4901 return SQLITE_OK;
4902 }
4903
4904
4905 /* Verify that the database file has not be deleted or renamed out from
4906 ** under the pager. Return SQLITE_OK if the database is still were it ought
4907 ** to be on disk. Return non-zero (SQLITE_READONLY_DBMOVED or some other error
4908 ** code from sqlite3OsAccess()) if the database has gone missing.
4909 */
4910 static int databaseIsUnmoved(Pager *pPager){
4911 int bHasMoved = 0;
4912 int rc;
4913
4914 if( pPager->tempFile ) return SQLITE_OK;
4915 if( pPager->dbSize==0 ) return SQLITE_OK;
4916 assert( pPager->zFilename && pPager->zFilename[0] );
4917 rc = sqlite3OsFileControl(pPager->fd, SQLITE_FCNTL_HAS_MOVED, &bHasMoved);
4918 if( rc==SQLITE_NOTFOUND ){
4919 /* If the HAS_MOVED file-control is unimplemented, assume that the file
4920 ** has not been moved. That is the historical behavior of SQLite: prior to
4921 ** version 3.8.3, it never checked */
4922 rc = SQLITE_OK;
4923 }else if( rc==SQLITE_OK && bHasMoved ){
4924 rc = SQLITE_READONLY_DBMOVED;
4925 }
4926 return rc;
4927 }
4928
4929
4930 /*
4931 ** This function is called after transitioning from PAGER_UNLOCK to
4932 ** PAGER_SHARED state. It tests if there is a hot journal present in
4933 ** the file-system for the given pager. A hot journal is one that
4934 ** needs to be played back. According to this function, a hot-journal
4935 ** file exists if the following criteria are met:
4936 **
4937 ** * The journal file exists in the file system, and
4938 ** * No process holds a RESERVED or greater lock on the database file, and
4939 ** * The database file itself is greater than 0 bytes in size, and
4940 ** * The first byte of the journal file exists and is not 0x00.
4941 **
4942 ** If the current size of the database file is 0 but a journal file
4943 ** exists, that is probably an old journal left over from a prior
4944 ** database with the same name. In this case the journal file is
4945 ** just deleted using OsDelete, *pExists is set to 0 and SQLITE_OK
4946 ** is returned.
4947 **
4948 ** This routine does not check if there is a master journal filename
4949 ** at the end of the file. If there is, and that master journal file
4950 ** does not exist, then the journal file is not really hot. In this
4951 ** case this routine will return a false-positive. The pager_playback()
4952 ** routine will discover that the journal file is not really hot and
4953 ** will not roll it back.
4954 **
4955 ** If a hot-journal file is found to exist, *pExists is set to 1 and
4956 ** SQLITE_OK returned. If no hot-journal file is present, *pExists is
4957 ** set to 0 and SQLITE_OK returned. If an IO error occurs while trying
4958 ** to determine whether or not a hot-journal file exists, the IO error
4959 ** code is returned and the value of *pExists is undefined.
4960 */
4961 static int hasHotJournal(Pager *pPager, int *pExists){
4962 sqlite3_vfs * const pVfs = pPager->pVfs;
4963 int rc = SQLITE_OK; /* Return code */
4964 int exists = 1; /* True if a journal file is present */
4965 int jrnlOpen = !!isOpen(pPager->jfd);
4966
4967 assert( pPager->useJournal );
4968 assert( isOpen(pPager->fd) );
4969 assert( pPager->eState==PAGER_OPEN );
4970
4971 assert( jrnlOpen==0 || ( sqlite3OsDeviceCharacteristics(pPager->jfd) &
4972 SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN
4973 ));
4974
4975 *pExists = 0;
4976 if( !jrnlOpen ){
4977 rc = sqlite3OsAccess(pVfs, pPager->zJournal, SQLITE_ACCESS_EXISTS, &exists);
4978 }
4979 if( rc==SQLITE_OK && exists ){
4980 int locked = 0; /* True if some process holds a RESERVED lock */
4981
4982 /* Race condition here: Another process might have been holding the
4983 ** the RESERVED lock and have a journal open at the sqlite3OsAccess()
4984 ** call above, but then delete the journal and drop the lock before
4985 ** we get to the following sqlite3OsCheckReservedLock() call. If that
4986 ** is the case, this routine might think there is a hot journal when
4987 ** in fact there is none. This results in a false-positive which will
4988 ** be dealt with by the playback routine. Ticket #3883.
4989 */
4990 rc = sqlite3OsCheckReservedLock(pPager->fd, &locked);
4991 if( rc==SQLITE_OK && !locked ){
4992 Pgno nPage; /* Number of pages in database file */
4993
4994 assert( pPager->tempFile==0 );
4995 rc = pagerPagecount(pPager, &nPage);
4996 if( rc==SQLITE_OK ){
4997 /* If the database is zero pages in size, that means that either (1) the
4998 ** journal is a remnant from a prior database with the same name where
4999 ** the database file but not the journal was deleted, or (2) the initial
5000 ** transaction that populates a new database is being rolled back.
5001 ** In either case, the journal file can be deleted. However, take care
5002 ** not to delete the journal file if it is already open due to
5003 ** journal_mode=PERSIST.
5004 */
5005 if( nPage==0 && !jrnlOpen ){
5006 sqlite3BeginBenignMalloc();
5007 if( pagerLockDb(pPager, RESERVED_LOCK)==SQLITE_OK ){
5008 sqlite3OsDelete(pVfs, pPager->zJournal, 0);
5009 if( !pPager->exclusiveMode ) pagerUnlockDb(pPager, SHARED_LOCK);
5010 }
5011 sqlite3EndBenignMalloc();
5012 }else{
5013 /* The journal file exists and no other connection has a reserved
5014 ** or greater lock on the database file. Now check that there is
5015 ** at least one non-zero bytes at the start of the journal file.
5016 ** If there is, then we consider this journal to be hot. If not,
5017 ** it can be ignored.
5018 */
5019 if( !jrnlOpen ){
5020 int f = SQLITE_OPEN_READONLY|SQLITE_OPEN_MAIN_JOURNAL;
5021 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, f, &f);
5022 }
5023 if( rc==SQLITE_OK ){
5024 u8 first = 0;
5025 rc = sqlite3OsRead(pPager->jfd, (void *)&first, 1, 0);
5026 if( rc==SQLITE_IOERR_SHORT_READ ){
5027 rc = SQLITE_OK;
5028 }
5029 if( !jrnlOpen ){
5030 sqlite3OsClose(pPager->jfd);
5031 }
5032 *pExists = (first!=0);
5033 }else if( rc==SQLITE_CANTOPEN ){
5034 /* If we cannot open the rollback journal file in order to see if
5035 ** it has a zero header, that might be due to an I/O error, or
5036 ** it might be due to the race condition described above and in
5037 ** ticket #3883. Either way, assume that the journal is hot.
5038 ** This might be a false positive. But if it is, then the
5039 ** automatic journal playback and recovery mechanism will deal
5040 ** with it under an EXCLUSIVE lock where we do not need to
5041 ** worry so much with race conditions.
5042 */
5043 *pExists = 1;
5044 rc = SQLITE_OK;
5045 }
5046 }
5047 }
5048 }
5049 }
5050
5051 return rc;
5052 }
5053
5054 /*
5055 ** This function is called to obtain a shared lock on the database file.
5056 ** It is illegal to call sqlite3PagerGet() until after this function
5057 ** has been successfully called. If a shared-lock is already held when
5058 ** this function is called, it is a no-op.
5059 **
5060 ** The following operations are also performed by this function.
5061 **
5062 ** 1) If the pager is currently in PAGER_OPEN state (no lock held
5063 ** on the database file), then an attempt is made to obtain a
5064 ** SHARED lock on the database file. Immediately after obtaining
5065 ** the SHARED lock, the file-system is checked for a hot-journal,
5066 ** which is played back if present. Following any hot-journal
5067 ** rollback, the contents of the cache are validated by checking
5068 ** the 'change-counter' field of the database file header and
5069 ** discarded if they are found to be invalid.
5070 **
5071 ** 2) If the pager is running in exclusive-mode, and there are currently
5072 ** no outstanding references to any pages, and is in the error state,
5073 ** then an attempt is made to clear the error state by discarding
5074 ** the contents of the page cache and rolling back any open journal
5075 ** file.
5076 **
5077 ** If everything is successful, SQLITE_OK is returned. If an IO error
5078 ** occurs while locking the database, checking for a hot-journal file or
5079 ** rolling back a journal file, the IO error code is returned.
5080 */
5081 int sqlite3PagerSharedLock(Pager *pPager){
5082 int rc = SQLITE_OK; /* Return code */
5083
5084 /* This routine is only called from b-tree and only when there are no
5085 ** outstanding pages. This implies that the pager state should either
5086 ** be OPEN or READER. READER is only possible if the pager is or was in
5087 ** exclusive access mode. */
5088 assert( sqlite3PcacheRefCount(pPager->pPCache)==0 );
5089 assert( assert_pager_state(pPager) );
5090 assert( pPager->eState==PAGER_OPEN || pPager->eState==PAGER_READER );
5091 assert( pPager->errCode==SQLITE_OK );
5092
5093 if( !pagerUseWal(pPager) && pPager->eState==PAGER_OPEN ){
5094 int bHotJournal = 1; /* True if there exists a hot journal-file */
5095
5096 assert( !MEMDB );
5097 assert( pPager->tempFile==0 || pPager->eLock==EXCLUSIVE_LOCK );
5098
5099 rc = pager_wait_on_lock(pPager, SHARED_LOCK);
5100 if( rc!=SQLITE_OK ){
5101 assert( pPager->eLock==NO_LOCK || pPager->eLock==UNKNOWN_LOCK );
5102 goto failed;
5103 }
5104
5105 /* If a journal file exists, and there is no RESERVED lock on the
5106 ** database file, then it either needs to be played back or deleted.
5107 */
5108 if( pPager->eLock<=SHARED_LOCK ){
5109 rc = hasHotJournal(pPager, &bHotJournal);
5110 }
5111 if( rc!=SQLITE_OK ){
5112 goto failed;
5113 }
5114 if( bHotJournal ){
5115 if( pPager->readOnly ){
5116 rc = SQLITE_READONLY_ROLLBACK;
5117 goto failed;
5118 }
5119
5120 /* Get an EXCLUSIVE lock on the database file. At this point it is
5121 ** important that a RESERVED lock is not obtained on the way to the
5122 ** EXCLUSIVE lock. If it were, another process might open the
5123 ** database file, detect the RESERVED lock, and conclude that the
5124 ** database is safe to read while this process is still rolling the
5125 ** hot-journal back.
5126 **
5127 ** Because the intermediate RESERVED lock is not requested, any
5128 ** other process attempting to access the database file will get to
5129 ** this point in the code and fail to obtain its own EXCLUSIVE lock
5130 ** on the database file.
5131 **
5132 ** Unless the pager is in locking_mode=exclusive mode, the lock is
5133 ** downgraded to SHARED_LOCK before this function returns.
5134 */
5135 rc = pagerLockDb(pPager, EXCLUSIVE_LOCK);
5136 if( rc!=SQLITE_OK ){
5137 goto failed;
5138 }
5139
5140 /* If it is not already open and the file exists on disk, open the
5141 ** journal for read/write access. Write access is required because
5142 ** in exclusive-access mode the file descriptor will be kept open
5143 ** and possibly used for a transaction later on. Also, write-access
5144 ** is usually required to finalize the journal in journal_mode=persist
5145 ** mode (and also for journal_mode=truncate on some systems).
5146 **
5147 ** If the journal does not exist, it usually means that some
5148 ** other connection managed to get in and roll it back before
5149 ** this connection obtained the exclusive lock above. Or, it
5150 ** may mean that the pager was in the error-state when this
5151 ** function was called and the journal file does not exist.
5152 */
5153 if( !isOpen(pPager->jfd) ){
5154 sqlite3_vfs * const pVfs = pPager->pVfs;
5155 int bExists; /* True if journal file exists */
5156 rc = sqlite3OsAccess(
5157 pVfs, pPager->zJournal, SQLITE_ACCESS_EXISTS, &bExists);
5158 if( rc==SQLITE_OK && bExists ){
5159 int fout = 0;
5160 int f = SQLITE_OPEN_READWRITE|SQLITE_OPEN_MAIN_JOURNAL;
5161 assert( !pPager->tempFile );
5162 rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, f, &fout);
5163 assert( rc!=SQLITE_OK || isOpen(pPager->jfd) );
5164 if( rc==SQLITE_OK && fout&SQLITE_OPEN_READONLY ){
5165 rc = SQLITE_CANTOPEN_BKPT;
5166 sqlite3OsClose(pPager->jfd);
5167 }
5168 }
5169 }
5170
5171 /* Playback and delete the journal. Drop the database write
5172 ** lock and reacquire the read lock. Purge the cache before
5173 ** playing back the hot-journal so that we don't end up with
5174 ** an inconsistent cache. Sync the hot journal before playing
5175 ** it back since the process that crashed and left the hot journal
5176 ** probably did not sync it and we are required to always sync
5177 ** the journal before playing it back.
5178 */
5179 if( isOpen(pPager->jfd) ){
5180 assert( rc==SQLITE_OK );
5181 rc = pagerSyncHotJournal(pPager);
5182 if( rc==SQLITE_OK ){
5183 rc = pager_playback(pPager, !pPager->tempFile);
5184 pPager->eState = PAGER_OPEN;
5185 }
5186 }else if( !pPager->exclusiveMode ){
5187 pagerUnlockDb(pPager, SHARED_LOCK);
5188 }
5189
5190 if( rc!=SQLITE_OK ){
5191 /* This branch is taken if an error occurs while trying to open
5192 ** or roll back a hot-journal while holding an EXCLUSIVE lock. The
5193 ** pager_unlock() routine will be called before returning to unlock
5194 ** the file. If the unlock attempt fails, then Pager.eLock must be
5195 ** set to UNKNOWN_LOCK (see the comment above the #define for
5196 ** UNKNOWN_LOCK above for an explanation).
5197 **
5198 ** In order to get pager_unlock() to do this, set Pager.eState to
5199 ** PAGER_ERROR now. This is not actually counted as a transition
5200 ** to ERROR state in the state diagram at the top of this file,
5201 ** since we know that the same call to pager_unlock() will very
5202 ** shortly transition the pager object to the OPEN state. Calling
5203 ** assert_pager_state() would fail now, as it should not be possible
5204 ** to be in ERROR state when there are zero outstanding page
5205 ** references.
5206 */
5207 pager_error(pPager, rc);
5208 goto failed;
5209 }
5210
5211 assert( pPager->eState==PAGER_OPEN );
5212 assert( (pPager->eLock==SHARED_LOCK)
5213 || (pPager->exclusiveMode && pPager->eLock>SHARED_LOCK)
5214 );
5215 }
5216
5217 if( !pPager->tempFile && pPager->hasHeldSharedLock ){
5218 /* The shared-lock has just been acquired then check to
5219 ** see if the database has been modified. If the database has changed,
5220 ** flush the cache. The hasHeldSharedLock flag prevents this from
5221 ** occurring on the very first access to a file, in order to save a
5222 ** single unnecessary sqlite3OsRead() call at the start-up.
5223 **
5224 ** Database changes are detected by looking at 15 bytes beginning
5225 ** at offset 24 into the file. The first 4 of these 16 bytes are
5226 ** a 32-bit counter that is incremented with each change. The
5227 ** other bytes change randomly with each file change when
5228 ** a codec is in use.
5229 **
5230 ** There is a vanishingly small chance that a change will not be
5231 ** detected. The chance of an undetected change is so small that
5232 ** it can be neglected.
5233 */
5234 Pgno nPage = 0;
5235 char dbFileVers[sizeof(pPager->dbFileVers)];
5236
5237 rc = pagerPagecount(pPager, &nPage);
5238 if( rc ) goto failed;
5239
5240 if( nPage>0 ){
5241 IOTRACE(("CKVERS %p %d\n", pPager, sizeof(dbFileVers)));
5242 rc = sqlite3OsRead(pPager->fd, &dbFileVers, sizeof(dbFileVers), 24);
5243 if( rc!=SQLITE_OK && rc!=SQLITE_IOERR_SHORT_READ ){
5244 goto failed;
5245 }
5246 }else{
5247 memset(dbFileVers, 0, sizeof(dbFileVers));
5248 }
5249
5250 if( memcmp(pPager->dbFileVers, dbFileVers, sizeof(dbFileVers))!=0 ){
5251 pager_reset(pPager);
5252
5253 /* Unmap the database file. It is possible that external processes
5254 ** may have truncated the database file and then extended it back
5255 ** to its original size while this process was not holding a lock.
5256 ** In this case there may exist a Pager.pMap mapping that appears
5257 ** to be the right size but is not actually valid. Avoid this
5258 ** possibility by unmapping the db here. */
5259 if( USEFETCH(pPager) ){
5260 sqlite3OsUnfetch(pPager->fd, 0, 0);
5261 }
5262 }
5263 }
5264
5265 /* If there is a WAL file in the file-system, open this database in WAL
5266 ** mode. Otherwise, the following function call is a no-op.
5267 */
5268 rc = pagerOpenWalIfPresent(pPager);
5269 #ifndef SQLITE_OMIT_WAL
5270 assert( pPager->pWal==0 || rc==SQLITE_OK );
5271 #endif
5272 }
5273
5274 if( pagerUseWal(pPager) ){
5275 assert( rc==SQLITE_OK );
5276 rc = pagerBeginReadTransaction(pPager);
5277 }
5278
5279 if( pPager->tempFile==0 && pPager->eState==PAGER_OPEN && rc==SQLITE_OK ){
5280 rc = pagerPagecount(pPager, &pPager->dbSize);
5281 }
5282
5283 failed:
5284 if( rc!=SQLITE_OK ){
5285 assert( !MEMDB );
5286 pager_unlock(pPager);
5287 assert( pPager->eState==PAGER_OPEN );
5288 }else{
5289 pPager->eState = PAGER_READER;
5290 pPager->hasHeldSharedLock = 1;
5291 }
5292 return rc;
5293 }
5294
5295 /*
5296 ** If the reference count has reached zero, rollback any active
5297 ** transaction and unlock the pager.
5298 **
5299 ** Except, in locking_mode=EXCLUSIVE when there is nothing to in
5300 ** the rollback journal, the unlock is not performed and there is
5301 ** nothing to rollback, so this routine is a no-op.
5302 */
5303 static void pagerUnlockIfUnused(Pager *pPager){
5304 if( pPager->nMmapOut==0 && (sqlite3PcacheRefCount(pPager->pPCache)==0) ){
5305 pagerUnlockAndRollback(pPager);
5306 }
5307 }
5308
5309 /*
5310 ** The page getter methods each try to acquire a reference to a
5311 ** page with page number pgno. If the requested reference is
5312 ** successfully obtained, it is copied to *ppPage and SQLITE_OK returned.
5313 **
5314 ** There are different implementations of the getter method depending
5315 ** on the current state of the pager.
5316 **
5317 ** getPageNormal() -- The normal getter
5318 ** getPageError() -- Used if the pager is in an error state
5319 ** getPageMmap() -- Used if memory-mapped I/O is enabled
5320 **
5321 ** If the requested page is already in the cache, it is returned.
5322 ** Otherwise, a new page object is allocated and populated with data
5323 ** read from the database file. In some cases, the pcache module may
5324 ** choose not to allocate a new page object and may reuse an existing
5325 ** object with no outstanding references.
5326 **
5327 ** The extra data appended to a page is always initialized to zeros the
5328 ** first time a page is loaded into memory. If the page requested is
5329 ** already in the cache when this function is called, then the extra
5330 ** data is left as it was when the page object was last used.
5331 **
5332 ** If the database image is smaller than the requested page or if
5333 ** the flags parameter contains the PAGER_GET_NOCONTENT bit and the
5334 ** requested page is not already stored in the cache, then no
5335 ** actual disk read occurs. In this case the memory image of the
5336 ** page is initialized to all zeros.
5337 **
5338 ** If PAGER_GET_NOCONTENT is true, it means that we do not care about
5339 ** the contents of the page. This occurs in two scenarios:
5340 **
5341 ** a) When reading a free-list leaf page from the database, and
5342 **
5343 ** b) When a savepoint is being rolled back and we need to load
5344 ** a new page into the cache to be filled with the data read
5345 ** from the savepoint journal.
5346 **
5347 ** If PAGER_GET_NOCONTENT is true, then the data returned is zeroed instead
5348 ** of being read from the database. Additionally, the bits corresponding
5349 ** to pgno in Pager.pInJournal (bitvec of pages already written to the
5350 ** journal file) and the PagerSavepoint.pInSavepoint bitvecs of any open
5351 ** savepoints are set. This means if the page is made writable at any
5352 ** point in the future, using a call to sqlite3PagerWrite(), its contents
5353 ** will not be journaled. This saves IO.
5354 **
5355 ** The acquisition might fail for several reasons. In all cases,
5356 ** an appropriate error code is returned and *ppPage is set to NULL.
5357 **
5358 ** See also sqlite3PagerLookup(). Both this routine and Lookup() attempt
5359 ** to find a page in the in-memory cache first. If the page is not already
5360 ** in memory, this routine goes to disk to read it in whereas Lookup()
5361 ** just returns 0. This routine acquires a read-lock the first time it
5362 ** has to go to disk, and could also playback an old journal if necessary.
5363 ** Since Lookup() never goes to disk, it never has to deal with locks
5364 ** or journal files.
5365 */
5366 static int getPageNormal(
5367 Pager *pPager, /* The pager open on the database file */
5368 Pgno pgno, /* Page number to fetch */
5369 DbPage **ppPage, /* Write a pointer to the page here */
5370 int flags /* PAGER_GET_XXX flags */
5371 ){
5372 int rc = SQLITE_OK;
5373 PgHdr *pPg;
5374 u8 noContent; /* True if PAGER_GET_NOCONTENT is set */
5375 sqlite3_pcache_page *pBase;
5376
5377 assert( pPager->errCode==SQLITE_OK );
5378 assert( pPager->eState>=PAGER_READER );
5379 assert( assert_pager_state(pPager) );
5380 assert( pPager->hasHeldSharedLock==1 );
5381
5382 if( pgno==0 ) return SQLITE_CORRUPT_BKPT;
5383 pBase = sqlite3PcacheFetch(pPager->pPCache, pgno, 3);
5384 if( pBase==0 ){
5385 pPg = 0;
5386 rc = sqlite3PcacheFetchStress(pPager->pPCache, pgno, &pBase);
5387 if( rc!=SQLITE_OK ) goto pager_acquire_err;
5388 if( pBase==0 ){
5389 rc = SQLITE_NOMEM_BKPT;
5390 goto pager_acquire_err;
5391 }
5392 }
5393 pPg = *ppPage = sqlite3PcacheFetchFinish(pPager->pPCache, pgno, pBase);
5394 assert( pPg==(*ppPage) );
5395 assert( pPg->pgno==pgno );
5396 assert( pPg->pPager==pPager || pPg->pPager==0 );
5397
5398 noContent = (flags & PAGER_GET_NOCONTENT)!=0;
5399 if( pPg->pPager && !noContent ){
5400 /* In this case the pcache already contains an initialized copy of
5401 ** the page. Return without further ado. */
5402 assert( pgno<=PAGER_MAX_PGNO && pgno!=PAGER_MJ_PGNO(pPager) );
5403 pPager->aStat[PAGER_STAT_HIT]++;
5404 return SQLITE_OK;
5405
5406 }else{
5407 /* The pager cache has created a new page. Its content needs to
5408 ** be initialized. But first some error checks:
5409 **
5410 ** (1) The maximum page number is 2^31
5411 ** (2) Never try to fetch the locking page
5412 */
5413 if( pgno>PAGER_MAX_PGNO || pgno==PAGER_MJ_PGNO(pPager) ){
5414 rc = SQLITE_CORRUPT_BKPT;
5415 goto pager_acquire_err;
5416 }
5417
5418 pPg->pPager = pPager;
5419
5420 assert( !isOpen(pPager->fd) || !MEMDB );
5421 if( !isOpen(pPager->fd) || pPager->dbSize<pgno || noContent ){
5422 if( pgno>pPager->mxPgno ){
5423 rc = SQLITE_FULL;
5424 goto pager_acquire_err;
5425 }
5426 if( noContent ){
5427 /* Failure to set the bits in the InJournal bit-vectors is benign.
5428 ** It merely means that we might do some extra work to journal a
5429 ** page that does not need to be journaled. Nevertheless, be sure
5430 ** to test the case where a malloc error occurs while trying to set
5431 ** a bit in a bit vector.
5432 */
5433 sqlite3BeginBenignMalloc();
5434 if( pgno<=pPager->dbOrigSize ){
5435 TESTONLY( rc = ) sqlite3BitvecSet(pPager->pInJournal, pgno);
5436 testcase( rc==SQLITE_NOMEM );
5437 }
5438 TESTONLY( rc = ) addToSavepointBitvecs(pPager, pgno);
5439 testcase( rc==SQLITE_NOMEM );
5440 sqlite3EndBenignMalloc();
5441 }
5442 memset(pPg->pData, 0, pPager->pageSize);
5443 IOTRACE(("ZERO %p %d\n", pPager, pgno));
5444 }else{
5445 u32 iFrame = 0; /* Frame to read from WAL file */
5446 if( pagerUseWal(pPager) ){
5447 rc = sqlite3WalFindFrame(pPager->pWal, pgno, &iFrame);
5448 if( rc!=SQLITE_OK ) goto pager_acquire_err;
5449 }
5450 assert( pPg->pPager==pPager );
5451 pPager->aStat[PAGER_STAT_MISS]++;
5452 rc = readDbPage(pPg, iFrame);
5453 if( rc!=SQLITE_OK ){
5454 goto pager_acquire_err;
5455 }
5456 }
5457 pager_set_pagehash(pPg);
5458 }
5459 return SQLITE_OK;
5460
5461 pager_acquire_err:
5462 assert( rc!=SQLITE_OK );
5463 if( pPg ){
5464 sqlite3PcacheDrop(pPg);
5465 }
5466 pagerUnlockIfUnused(pPager);
5467 *ppPage = 0;
5468 return rc;
5469 }
5470
5471 #if SQLITE_MAX_MMAP_SIZE>0
5472 /* The page getter for when memory-mapped I/O is enabled */
5473 static int getPageMMap(
5474 Pager *pPager, /* The pager open on the database file */
5475 Pgno pgno, /* Page number to fetch */
5476 DbPage **ppPage, /* Write a pointer to the page here */
5477 int flags /* PAGER_GET_XXX flags */
5478 ){
5479 int rc = SQLITE_OK;
5480 PgHdr *pPg = 0;
5481 u32 iFrame = 0; /* Frame to read from WAL file */
5482
5483 /* It is acceptable to use a read-only (mmap) page for any page except
5484 ** page 1 if there is no write-transaction open or the ACQUIRE_READONLY
5485 ** flag was specified by the caller. And so long as the db is not a
5486 ** temporary or in-memory database. */
5487 const int bMmapOk = (pgno>1
5488 && (pPager->eState==PAGER_READER || (flags & PAGER_GET_READONLY))
5489 );
5490
5491 assert( USEFETCH(pPager) );
5492 #ifdef SQLITE_HAS_CODEC
5493 assert( pPager->xCodec==0 );
5494 #endif
5495
5496 /* Optimization note: Adding the "pgno<=1" term before "pgno==0" here
5497 ** allows the compiler optimizer to reuse the results of the "pgno>1"
5498 ** test in the previous statement, and avoid testing pgno==0 in the
5499 ** common case where pgno is large. */
5500 if( pgno<=1 && pgno==0 ){
5501 return SQLITE_CORRUPT_BKPT;
5502 }
5503 assert( pPager->eState>=PAGER_READER );
5504 assert( assert_pager_state(pPager) );
5505 assert( pPager->hasHeldSharedLock==1 );
5506 assert( pPager->errCode==SQLITE_OK );
5507
5508 if( bMmapOk && pagerUseWal(pPager) ){
5509 rc = sqlite3WalFindFrame(pPager->pWal, pgno, &iFrame);
5510 if( rc!=SQLITE_OK ){
5511 *ppPage = 0;
5512 return rc;
5513 }
5514 }
5515 if( bMmapOk && iFrame==0 ){
5516 void *pData = 0;
5517 rc = sqlite3OsFetch(pPager->fd,
5518 (i64)(pgno-1) * pPager->pageSize, pPager->pageSize, &pData
5519 );
5520 if( rc==SQLITE_OK && pData ){
5521 if( pPager->eState>PAGER_READER || pPager->tempFile ){
5522 pPg = sqlite3PagerLookup(pPager, pgno);
5523 }
5524 if( pPg==0 ){
5525 rc = pagerAcquireMapPage(pPager, pgno, pData, &pPg);
5526 }else{
5527 sqlite3OsUnfetch(pPager->fd, (i64)(pgno-1)*pPager->pageSize, pData);
5528 }
5529 if( pPg ){
5530 assert( rc==SQLITE_OK );
5531 *ppPage = pPg;
5532 return SQLITE_OK;
5533 }
5534 }
5535 if( rc!=SQLITE_OK ){
5536 *ppPage = 0;
5537 return rc;
5538 }
5539 }
5540 return getPageNormal(pPager, pgno, ppPage, flags);
5541 }
5542 #endif /* SQLITE_MAX_MMAP_SIZE>0 */
5543
5544 /* The page getter method for when the pager is an error state */
5545 static int getPageError(
5546 Pager *pPager, /* The pager open on the database file */
5547 Pgno pgno, /* Page number to fetch */
5548 DbPage **ppPage, /* Write a pointer to the page here */
5549 int flags /* PAGER_GET_XXX flags */
5550 ){
5551 UNUSED_PARAMETER(pgno);
5552 UNUSED_PARAMETER(flags);
5553 assert( pPager->errCode!=SQLITE_OK );
5554 *ppPage = 0;
5555 return pPager->errCode;
5556 }
5557
5558
5559 /* Dispatch all page fetch requests to the appropriate getter method.
5560 */
5561 int sqlite3PagerGet(
5562 Pager *pPager, /* The pager open on the database file */
5563 Pgno pgno, /* Page number to fetch */
5564 DbPage **ppPage, /* Write a pointer to the page here */
5565 int flags /* PAGER_GET_XXX flags */
5566 ){
5567 return pPager->xGet(pPager, pgno, ppPage, flags);
5568 }
5569
5570 /*
5571 ** Acquire a page if it is already in the in-memory cache. Do
5572 ** not read the page from disk. Return a pointer to the page,
5573 ** or 0 if the page is not in cache.
5574 **
5575 ** See also sqlite3PagerGet(). The difference between this routine
5576 ** and sqlite3PagerGet() is that _get() will go to the disk and read
5577 ** in the page if the page is not already in cache. This routine
5578 ** returns NULL if the page is not in cache or if a disk I/O error
5579 ** has ever happened.
5580 */
5581 DbPage *sqlite3PagerLookup(Pager *pPager, Pgno pgno){
5582 sqlite3_pcache_page *pPage;
5583 assert( pPager!=0 );
5584 assert( pgno!=0 );
5585 assert( pPager->pPCache!=0 );
5586 pPage = sqlite3PcacheFetch(pPager->pPCache, pgno, 0);
5587 assert( pPage==0 || pPager->hasHeldSharedLock );
5588 if( pPage==0 ) return 0;
5589 return sqlite3PcacheFetchFinish(pPager->pPCache, pgno, pPage);
5590 }
5591
5592 /*
5593 ** Release a page reference.
5594 **
5595 ** If the number of references to the page drop to zero, then the
5596 ** page is added to the LRU list. When all references to all pages
5597 ** are released, a rollback occurs and the lock on the database is
5598 ** removed.
5599 */
5600 void sqlite3PagerUnrefNotNull(DbPage *pPg){
5601 Pager *pPager;
5602 assert( pPg!=0 );
5603 pPager = pPg->pPager;
5604 if( pPg->flags & PGHDR_MMAP ){
5605 pagerReleaseMapPage(pPg);
5606 }else{
5607 sqlite3PcacheRelease(pPg);
5608 }
5609 pagerUnlockIfUnused(pPager);
5610 }
5611 void sqlite3PagerUnref(DbPage *pPg){
5612 if( pPg ) sqlite3PagerUnrefNotNull(pPg);
5613 }
5614
5615 /*
5616 ** This function is called at the start of every write transaction.
5617 ** There must already be a RESERVED or EXCLUSIVE lock on the database
5618 ** file when this routine is called.
5619 **
5620 ** Open the journal file for pager pPager and write a journal header
5621 ** to the start of it. If there are active savepoints, open the sub-journal
5622 ** as well. This function is only used when the journal file is being
5623 ** opened to write a rollback log for a transaction. It is not used
5624 ** when opening a hot journal file to roll it back.
5625 **
5626 ** If the journal file is already open (as it may be in exclusive mode),
5627 ** then this function just writes a journal header to the start of the
5628 ** already open file.
5629 **
5630 ** Whether or not the journal file is opened by this function, the
5631 ** Pager.pInJournal bitvec structure is allocated.
5632 **
5633 ** Return SQLITE_OK if everything is successful. Otherwise, return
5634 ** SQLITE_NOMEM if the attempt to allocate Pager.pInJournal fails, or
5635 ** an IO error code if opening or writing the journal file fails.
5636 */
5637 static int pager_open_journal(Pager *pPager){
5638 int rc = SQLITE_OK; /* Return code */
5639 sqlite3_vfs * const pVfs = pPager->pVfs; /* Local cache of vfs pointer */
5640
5641 assert( pPager->eState==PAGER_WRITER_LOCKED );
5642 assert( assert_pager_state(pPager) );
5643 assert( pPager->pInJournal==0 );
5644
5645 /* If already in the error state, this function is a no-op. But on
5646 ** the other hand, this routine is never called if we are already in
5647 ** an error state. */
5648 if( NEVER(pPager->errCode) ) return pPager->errCode;
5649
5650 if( !pagerUseWal(pPager) && pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
5651 pPager->pInJournal = sqlite3BitvecCreate(pPager->dbSize);
5652 if( pPager->pInJournal==0 ){
5653 return SQLITE_NOMEM_BKPT;
5654 }
5655
5656 /* Open the journal file if it is not already open. */
5657 if( !isOpen(pPager->jfd) ){
5658 if( pPager->journalMode==PAGER_JOURNALMODE_MEMORY ){
5659 sqlite3MemJournalOpen(pPager->jfd);
5660 }else{
5661 int flags = SQLITE_OPEN_READWRITE|SQLITE_OPEN_CREATE;
5662 int nSpill;
5663
5664 if( pPager->tempFile ){
5665 flags |= (SQLITE_OPEN_DELETEONCLOSE|SQLITE_OPEN_TEMP_JOURNAL);
5666 nSpill = sqlite3Config.nStmtSpill;
5667 }else{
5668 flags |= SQLITE_OPEN_MAIN_JOURNAL;
5669 nSpill = jrnlBufferSize(pPager);
5670 }
5671
5672 /* Verify that the database still has the same name as it did when
5673 ** it was originally opened. */
5674 rc = databaseIsUnmoved(pPager);
5675 if( rc==SQLITE_OK ){
5676 rc = sqlite3JournalOpen (
5677 pVfs, pPager->zJournal, pPager->jfd, flags, nSpill
5678 );
5679 }
5680 }
5681 assert( rc!=SQLITE_OK || isOpen(pPager->jfd) );
5682 }
5683
5684
5685 /* Write the first journal header to the journal file and open
5686 ** the sub-journal if necessary.
5687 */
5688 if( rc==SQLITE_OK ){
5689 /* TODO: Check if all of these are really required. */
5690 pPager->nRec = 0;
5691 pPager->journalOff = 0;
5692 pPager->setMaster = 0;
5693 pPager->journalHdr = 0;
5694 rc = writeJournalHdr(pPager);
5695 }
5696 }
5697
5698 if( rc!=SQLITE_OK ){
5699 sqlite3BitvecDestroy(pPager->pInJournal);
5700 pPager->pInJournal = 0;
5701 }else{
5702 assert( pPager->eState==PAGER_WRITER_LOCKED );
5703 pPager->eState = PAGER_WRITER_CACHEMOD;
5704 }
5705
5706 return rc;
5707 }
5708
5709 /*
5710 ** Begin a write-transaction on the specified pager object. If a
5711 ** write-transaction has already been opened, this function is a no-op.
5712 **
5713 ** If the exFlag argument is false, then acquire at least a RESERVED
5714 ** lock on the database file. If exFlag is true, then acquire at least
5715 ** an EXCLUSIVE lock. If such a lock is already held, no locking
5716 ** functions need be called.
5717 **
5718 ** If the subjInMemory argument is non-zero, then any sub-journal opened
5719 ** within this transaction will be opened as an in-memory file. This
5720 ** has no effect if the sub-journal is already opened (as it may be when
5721 ** running in exclusive mode) or if the transaction does not require a
5722 ** sub-journal. If the subjInMemory argument is zero, then any required
5723 ** sub-journal is implemented in-memory if pPager is an in-memory database,
5724 ** or using a temporary file otherwise.
5725 */
5726 int sqlite3PagerBegin(Pager *pPager, int exFlag, int subjInMemory){
5727 int rc = SQLITE_OK;
5728
5729 if( pPager->errCode ) return pPager->errCode;
5730 assert( pPager->eState>=PAGER_READER && pPager->eState<PAGER_ERROR );
5731 pPager->subjInMemory = (u8)subjInMemory;
5732
5733 if( ALWAYS(pPager->eState==PAGER_READER) ){
5734 assert( pPager->pInJournal==0 );
5735
5736 if( pagerUseWal(pPager) ){
5737 /* If the pager is configured to use locking_mode=exclusive, and an
5738 ** exclusive lock on the database is not already held, obtain it now.
5739 */
5740 if( pPager->exclusiveMode && sqlite3WalExclusiveMode(pPager->pWal, -1) ){
5741 rc = pagerLockDb(pPager, EXCLUSIVE_LOCK);
5742 if( rc!=SQLITE_OK ){
5743 return rc;
5744 }
5745 (void)sqlite3WalExclusiveMode(pPager->pWal, 1);
5746 }
5747
5748 /* Grab the write lock on the log file. If successful, upgrade to
5749 ** PAGER_RESERVED state. Otherwise, return an error code to the caller.
5750 ** The busy-handler is not invoked if another connection already
5751 ** holds the write-lock. If possible, the upper layer will call it.
5752 */
5753 rc = sqlite3WalBeginWriteTransaction(pPager->pWal);
5754 }else{
5755 /* Obtain a RESERVED lock on the database file. If the exFlag parameter
5756 ** is true, then immediately upgrade this to an EXCLUSIVE lock. The
5757 ** busy-handler callback can be used when upgrading to the EXCLUSIVE
5758 ** lock, but not when obtaining the RESERVED lock.
5759 */
5760 rc = pagerLockDb(pPager, RESERVED_LOCK);
5761 if( rc==SQLITE_OK && exFlag ){
5762 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
5763 }
5764 }
5765
5766 if( rc==SQLITE_OK ){
5767 /* Change to WRITER_LOCKED state.
5768 **
5769 ** WAL mode sets Pager.eState to PAGER_WRITER_LOCKED or CACHEMOD
5770 ** when it has an open transaction, but never to DBMOD or FINISHED.
5771 ** This is because in those states the code to roll back savepoint
5772 ** transactions may copy data from the sub-journal into the database
5773 ** file as well as into the page cache. Which would be incorrect in
5774 ** WAL mode.
5775 */
5776 pPager->eState = PAGER_WRITER_LOCKED;
5777 pPager->dbHintSize = pPager->dbSize;
5778 pPager->dbFileSize = pPager->dbSize;
5779 pPager->dbOrigSize = pPager->dbSize;
5780 pPager->journalOff = 0;
5781 }
5782
5783 assert( rc==SQLITE_OK || pPager->eState==PAGER_READER );
5784 assert( rc!=SQLITE_OK || pPager->eState==PAGER_WRITER_LOCKED );
5785 assert( assert_pager_state(pPager) );
5786 }
5787
5788 PAGERTRACE(("TRANSACTION %d\n", PAGERID(pPager)));
5789 return rc;
5790 }
5791
5792 /*
5793 ** Write page pPg onto the end of the rollback journal.
5794 */
5795 static SQLITE_NOINLINE int pagerAddPageToRollbackJournal(PgHdr *pPg){
5796 Pager *pPager = pPg->pPager;
5797 int rc;
5798 u32 cksum;
5799 char *pData2;
5800 i64 iOff = pPager->journalOff;
5801
5802 /* We should never write to the journal file the page that
5803 ** contains the database locks. The following assert verifies
5804 ** that we do not. */
5805 assert( pPg->pgno!=PAGER_MJ_PGNO(pPager) );
5806
5807 assert( pPager->journalHdr<=pPager->journalOff );
5808 CODEC2(pPager, pPg->pData, pPg->pgno, 7, return SQLITE_NOMEM_BKPT, pData2);
5809 cksum = pager_cksum(pPager, (u8*)pData2);
5810
5811 /* Even if an IO or diskfull error occurs while journalling the
5812 ** page in the block above, set the need-sync flag for the page.
5813 ** Otherwise, when the transaction is rolled back, the logic in
5814 ** playback_one_page() will think that the page needs to be restored
5815 ** in the database file. And if an IO error occurs while doing so,
5816 ** then corruption may follow.
5817 */
5818 pPg->flags |= PGHDR_NEED_SYNC;
5819
5820 rc = write32bits(pPager->jfd, iOff, pPg->pgno);
5821 if( rc!=SQLITE_OK ) return rc;
5822 rc = sqlite3OsWrite(pPager->jfd, pData2, pPager->pageSize, iOff+4);
5823 if( rc!=SQLITE_OK ) return rc;
5824 rc = write32bits(pPager->jfd, iOff+pPager->pageSize+4, cksum);
5825 if( rc!=SQLITE_OK ) return rc;
5826
5827 IOTRACE(("JOUT %p %d %lld %d\n", pPager, pPg->pgno,
5828 pPager->journalOff, pPager->pageSize));
5829 PAGER_INCR(sqlite3_pager_writej_count);
5830 PAGERTRACE(("JOURNAL %d page %d needSync=%d hash(%08x)\n",
5831 PAGERID(pPager), pPg->pgno,
5832 ((pPg->flags&PGHDR_NEED_SYNC)?1:0), pager_pagehash(pPg)));
5833
5834 pPager->journalOff += 8 + pPager->pageSize;
5835 pPager->nRec++;
5836 assert( pPager->pInJournal!=0 );
5837 rc = sqlite3BitvecSet(pPager->pInJournal, pPg->pgno);
5838 testcase( rc==SQLITE_NOMEM );
5839 assert( rc==SQLITE_OK || rc==SQLITE_NOMEM );
5840 rc |= addToSavepointBitvecs(pPager, pPg->pgno);
5841 assert( rc==SQLITE_OK || rc==SQLITE_NOMEM );
5842 return rc;
5843 }
5844
5845 /*
5846 ** Mark a single data page as writeable. The page is written into the
5847 ** main journal or sub-journal as required. If the page is written into
5848 ** one of the journals, the corresponding bit is set in the
5849 ** Pager.pInJournal bitvec and the PagerSavepoint.pInSavepoint bitvecs
5850 ** of any open savepoints as appropriate.
5851 */
5852 static int pager_write(PgHdr *pPg){
5853 Pager *pPager = pPg->pPager;
5854 int rc = SQLITE_OK;
5855
5856 /* This routine is not called unless a write-transaction has already
5857 ** been started. The journal file may or may not be open at this point.
5858 ** It is never called in the ERROR state.
5859 */
5860 assert( pPager->eState==PAGER_WRITER_LOCKED
5861 || pPager->eState==PAGER_WRITER_CACHEMOD
5862 || pPager->eState==PAGER_WRITER_DBMOD
5863 );
5864 assert( assert_pager_state(pPager) );
5865 assert( pPager->errCode==0 );
5866 assert( pPager->readOnly==0 );
5867 CHECK_PAGE(pPg);
5868
5869 /* The journal file needs to be opened. Higher level routines have already
5870 ** obtained the necessary locks to begin the write-transaction, but the
5871 ** rollback journal might not yet be open. Open it now if this is the case.
5872 **
5873 ** This is done before calling sqlite3PcacheMakeDirty() on the page.
5874 ** Otherwise, if it were done after calling sqlite3PcacheMakeDirty(), then
5875 ** an error might occur and the pager would end up in WRITER_LOCKED state
5876 ** with pages marked as dirty in the cache.
5877 */
5878 if( pPager->eState==PAGER_WRITER_LOCKED ){
5879 rc = pager_open_journal(pPager);
5880 if( rc!=SQLITE_OK ) return rc;
5881 }
5882 assert( pPager->eState>=PAGER_WRITER_CACHEMOD );
5883 assert( assert_pager_state(pPager) );
5884
5885 /* Mark the page that is about to be modified as dirty. */
5886 sqlite3PcacheMakeDirty(pPg);
5887
5888 /* If a rollback journal is in use, them make sure the page that is about
5889 ** to change is in the rollback journal, or if the page is a new page off
5890 ** then end of the file, make sure it is marked as PGHDR_NEED_SYNC.
5891 */
5892 assert( (pPager->pInJournal!=0) == isOpen(pPager->jfd) );
5893 if( pPager->pInJournal!=0
5894 && sqlite3BitvecTestNotNull(pPager->pInJournal, pPg->pgno)==0
5895 ){
5896 assert( pagerUseWal(pPager)==0 );
5897 if( pPg->pgno<=pPager->dbOrigSize ){
5898 rc = pagerAddPageToRollbackJournal(pPg);
5899 if( rc!=SQLITE_OK ){
5900 return rc;
5901 }
5902 }else{
5903 if( pPager->eState!=PAGER_WRITER_DBMOD ){
5904 pPg->flags |= PGHDR_NEED_SYNC;
5905 }
5906 PAGERTRACE(("APPEND %d page %d needSync=%d\n",
5907 PAGERID(pPager), pPg->pgno,
5908 ((pPg->flags&PGHDR_NEED_SYNC)?1:0)));
5909 }
5910 }
5911
5912 /* The PGHDR_DIRTY bit is set above when the page was added to the dirty-list
5913 ** and before writing the page into the rollback journal. Wait until now,
5914 ** after the page has been successfully journalled, before setting the
5915 ** PGHDR_WRITEABLE bit that indicates that the page can be safely modified.
5916 */
5917 pPg->flags |= PGHDR_WRITEABLE;
5918
5919 /* If the statement journal is open and the page is not in it,
5920 ** then write the page into the statement journal.
5921 */
5922 if( pPager->nSavepoint>0 ){
5923 rc = subjournalPageIfRequired(pPg);
5924 }
5925
5926 /* Update the database size and return. */
5927 if( pPager->dbSize<pPg->pgno ){
5928 pPager->dbSize = pPg->pgno;
5929 }
5930 return rc;
5931 }
5932
5933 /*
5934 ** This is a variant of sqlite3PagerWrite() that runs when the sector size
5935 ** is larger than the page size. SQLite makes the (reasonable) assumption that
5936 ** all bytes of a sector are written together by hardware. Hence, all bytes of
5937 ** a sector need to be journalled in case of a power loss in the middle of
5938 ** a write.
5939 **
5940 ** Usually, the sector size is less than or equal to the page size, in which
5941 ** case pages can be individually written. This routine only runs in the
5942 ** exceptional case where the page size is smaller than the sector size.
5943 */
5944 static SQLITE_NOINLINE int pagerWriteLargeSector(PgHdr *pPg){
5945 int rc = SQLITE_OK; /* Return code */
5946 Pgno nPageCount; /* Total number of pages in database file */
5947 Pgno pg1; /* First page of the sector pPg is located on. */
5948 int nPage = 0; /* Number of pages starting at pg1 to journal */
5949 int ii; /* Loop counter */
5950 int needSync = 0; /* True if any page has PGHDR_NEED_SYNC */
5951 Pager *pPager = pPg->pPager; /* The pager that owns pPg */
5952 Pgno nPagePerSector = (pPager->sectorSize/pPager->pageSize);
5953
5954 /* Set the doNotSpill NOSYNC bit to 1. This is because we cannot allow
5955 ** a journal header to be written between the pages journaled by
5956 ** this function.
5957 */
5958 assert( !MEMDB );
5959 assert( (pPager->doNotSpill & SPILLFLAG_NOSYNC)==0 );
5960 pPager->doNotSpill |= SPILLFLAG_NOSYNC;
5961
5962 /* This trick assumes that both the page-size and sector-size are
5963 ** an integer power of 2. It sets variable pg1 to the identifier
5964 ** of the first page of the sector pPg is located on.
5965 */
5966 pg1 = ((pPg->pgno-1) & ~(nPagePerSector-1)) + 1;
5967
5968 nPageCount = pPager->dbSize;
5969 if( pPg->pgno>nPageCount ){
5970 nPage = (pPg->pgno - pg1)+1;
5971 }else if( (pg1+nPagePerSector-1)>nPageCount ){
5972 nPage = nPageCount+1-pg1;
5973 }else{
5974 nPage = nPagePerSector;
5975 }
5976 assert(nPage>0);
5977 assert(pg1<=pPg->pgno);
5978 assert((pg1+nPage)>pPg->pgno);
5979
5980 for(ii=0; ii<nPage && rc==SQLITE_OK; ii++){
5981 Pgno pg = pg1+ii;
5982 PgHdr *pPage;
5983 if( pg==pPg->pgno || !sqlite3BitvecTest(pPager->pInJournal, pg) ){
5984 if( pg!=PAGER_MJ_PGNO(pPager) ){
5985 rc = sqlite3PagerGet(pPager, pg, &pPage, 0);
5986 if( rc==SQLITE_OK ){
5987 rc = pager_write(pPage);
5988 if( pPage->flags&PGHDR_NEED_SYNC ){
5989 needSync = 1;
5990 }
5991 sqlite3PagerUnrefNotNull(pPage);
5992 }
5993 }
5994 }else if( (pPage = sqlite3PagerLookup(pPager, pg))!=0 ){
5995 if( pPage->flags&PGHDR_NEED_SYNC ){
5996 needSync = 1;
5997 }
5998 sqlite3PagerUnrefNotNull(pPage);
5999 }
6000 }
6001
6002 /* If the PGHDR_NEED_SYNC flag is set for any of the nPage pages
6003 ** starting at pg1, then it needs to be set for all of them. Because
6004 ** writing to any of these nPage pages may damage the others, the
6005 ** journal file must contain sync()ed copies of all of them
6006 ** before any of them can be written out to the database file.
6007 */
6008 if( rc==SQLITE_OK && needSync ){
6009 assert( !MEMDB );
6010 for(ii=0; ii<nPage; ii++){
6011 PgHdr *pPage = sqlite3PagerLookup(pPager, pg1+ii);
6012 if( pPage ){
6013 pPage->flags |= PGHDR_NEED_SYNC;
6014 sqlite3PagerUnrefNotNull(pPage);
6015 }
6016 }
6017 }
6018
6019 assert( (pPager->doNotSpill & SPILLFLAG_NOSYNC)!=0 );
6020 pPager->doNotSpill &= ~SPILLFLAG_NOSYNC;
6021 return rc;
6022 }
6023
6024 /*
6025 ** Mark a data page as writeable. This routine must be called before
6026 ** making changes to a page. The caller must check the return value
6027 ** of this function and be careful not to change any page data unless
6028 ** this routine returns SQLITE_OK.
6029 **
6030 ** The difference between this function and pager_write() is that this
6031 ** function also deals with the special case where 2 or more pages
6032 ** fit on a single disk sector. In this case all co-resident pages
6033 ** must have been written to the journal file before returning.
6034 **
6035 ** If an error occurs, SQLITE_NOMEM or an IO error code is returned
6036 ** as appropriate. Otherwise, SQLITE_OK.
6037 */
6038 int sqlite3PagerWrite(PgHdr *pPg){
6039 Pager *pPager = pPg->pPager;
6040 assert( (pPg->flags & PGHDR_MMAP)==0 );
6041 assert( pPager->eState>=PAGER_WRITER_LOCKED );
6042 assert( assert_pager_state(pPager) );
6043 if( (pPg->flags & PGHDR_WRITEABLE)!=0 && pPager->dbSize>=pPg->pgno ){
6044 if( pPager->nSavepoint ) return subjournalPageIfRequired(pPg);
6045 return SQLITE_OK;
6046 }else if( pPager->errCode ){
6047 return pPager->errCode;
6048 }else if( pPager->sectorSize > (u32)pPager->pageSize ){
6049 assert( pPager->tempFile==0 );
6050 return pagerWriteLargeSector(pPg);
6051 }else{
6052 return pager_write(pPg);
6053 }
6054 }
6055
6056 /*
6057 ** Return TRUE if the page given in the argument was previously passed
6058 ** to sqlite3PagerWrite(). In other words, return TRUE if it is ok
6059 ** to change the content of the page.
6060 */
6061 #ifndef NDEBUG
6062 int sqlite3PagerIswriteable(DbPage *pPg){
6063 return pPg->flags & PGHDR_WRITEABLE;
6064 }
6065 #endif
6066
6067 /*
6068 ** A call to this routine tells the pager that it is not necessary to
6069 ** write the information on page pPg back to the disk, even though
6070 ** that page might be marked as dirty. This happens, for example, when
6071 ** the page has been added as a leaf of the freelist and so its
6072 ** content no longer matters.
6073 **
6074 ** The overlying software layer calls this routine when all of the data
6075 ** on the given page is unused. The pager marks the page as clean so
6076 ** that it does not get written to disk.
6077 **
6078 ** Tests show that this optimization can quadruple the speed of large
6079 ** DELETE operations.
6080 **
6081 ** This optimization cannot be used with a temp-file, as the page may
6082 ** have been dirty at the start of the transaction. In that case, if
6083 ** memory pressure forces page pPg out of the cache, the data does need
6084 ** to be written out to disk so that it may be read back in if the
6085 ** current transaction is rolled back.
6086 */
6087 void sqlite3PagerDontWrite(PgHdr *pPg){
6088 Pager *pPager = pPg->pPager;
6089 if( !pPager->tempFile && (pPg->flags&PGHDR_DIRTY) && pPager->nSavepoint==0 ){
6090 PAGERTRACE(("DONT_WRITE page %d of %d\n", pPg->pgno, PAGERID(pPager)));
6091 IOTRACE(("CLEAN %p %d\n", pPager, pPg->pgno))
6092 pPg->flags |= PGHDR_DONT_WRITE;
6093 pPg->flags &= ~PGHDR_WRITEABLE;
6094 testcase( pPg->flags & PGHDR_NEED_SYNC );
6095 pager_set_pagehash(pPg);
6096 }
6097 }
6098
6099 /*
6100 ** This routine is called to increment the value of the database file
6101 ** change-counter, stored as a 4-byte big-endian integer starting at
6102 ** byte offset 24 of the pager file. The secondary change counter at
6103 ** 92 is also updated, as is the SQLite version number at offset 96.
6104 **
6105 ** But this only happens if the pPager->changeCountDone flag is false.
6106 ** To avoid excess churning of page 1, the update only happens once.
6107 ** See also the pager_write_changecounter() routine that does an
6108 ** unconditional update of the change counters.
6109 **
6110 ** If the isDirectMode flag is zero, then this is done by calling
6111 ** sqlite3PagerWrite() on page 1, then modifying the contents of the
6112 ** page data. In this case the file will be updated when the current
6113 ** transaction is committed.
6114 **
6115 ** The isDirectMode flag may only be non-zero if the library was compiled
6116 ** with the SQLITE_ENABLE_ATOMIC_WRITE macro defined. In this case,
6117 ** if isDirect is non-zero, then the database file is updated directly
6118 ** by writing an updated version of page 1 using a call to the
6119 ** sqlite3OsWrite() function.
6120 */
6121 static int pager_incr_changecounter(Pager *pPager, int isDirectMode){
6122 int rc = SQLITE_OK;
6123
6124 assert( pPager->eState==PAGER_WRITER_CACHEMOD
6125 || pPager->eState==PAGER_WRITER_DBMOD
6126 );
6127 assert( assert_pager_state(pPager) );
6128
6129 /* Declare and initialize constant integer 'isDirect'. If the
6130 ** atomic-write optimization is enabled in this build, then isDirect
6131 ** is initialized to the value passed as the isDirectMode parameter
6132 ** to this function. Otherwise, it is always set to zero.
6133 **
6134 ** The idea is that if the atomic-write optimization is not
6135 ** enabled at compile time, the compiler can omit the tests of
6136 ** 'isDirect' below, as well as the block enclosed in the
6137 ** "if( isDirect )" condition.
6138 */
6139 #ifndef SQLITE_ENABLE_ATOMIC_WRITE
6140 # define DIRECT_MODE 0
6141 assert( isDirectMode==0 );
6142 UNUSED_PARAMETER(isDirectMode);
6143 #else
6144 # define DIRECT_MODE isDirectMode
6145 #endif
6146
6147 if( !pPager->changeCountDone && ALWAYS(pPager->dbSize>0) ){
6148 PgHdr *pPgHdr; /* Reference to page 1 */
6149
6150 assert( !pPager->tempFile && isOpen(pPager->fd) );
6151
6152 /* Open page 1 of the file for writing. */
6153 rc = sqlite3PagerGet(pPager, 1, &pPgHdr, 0);
6154 assert( pPgHdr==0 || rc==SQLITE_OK );
6155
6156 /* If page one was fetched successfully, and this function is not
6157 ** operating in direct-mode, make page 1 writable. When not in
6158 ** direct mode, page 1 is always held in cache and hence the PagerGet()
6159 ** above is always successful - hence the ALWAYS on rc==SQLITE_OK.
6160 */
6161 if( !DIRECT_MODE && ALWAYS(rc==SQLITE_OK) ){
6162 rc = sqlite3PagerWrite(pPgHdr);
6163 }
6164
6165 if( rc==SQLITE_OK ){
6166 /* Actually do the update of the change counter */
6167 pager_write_changecounter(pPgHdr);
6168
6169 /* If running in direct mode, write the contents of page 1 to the file. */
6170 if( DIRECT_MODE ){
6171 const void *zBuf;
6172 assert( pPager->dbFileSize>0 );
6173 CODEC2(pPager, pPgHdr->pData, 1, 6, rc=SQLITE_NOMEM_BKPT, zBuf);
6174 if( rc==SQLITE_OK ){
6175 rc = sqlite3OsWrite(pPager->fd, zBuf, pPager->pageSize, 0);
6176 pPager->aStat[PAGER_STAT_WRITE]++;
6177 }
6178 if( rc==SQLITE_OK ){
6179 /* Update the pager's copy of the change-counter. Otherwise, the
6180 ** next time a read transaction is opened the cache will be
6181 ** flushed (as the change-counter values will not match). */
6182 const void *pCopy = (const void *)&((const char *)zBuf)[24];
6183 memcpy(&pPager->dbFileVers, pCopy, sizeof(pPager->dbFileVers));
6184 pPager->changeCountDone = 1;
6185 }
6186 }else{
6187 pPager->changeCountDone = 1;
6188 }
6189 }
6190
6191 /* Release the page reference. */
6192 sqlite3PagerUnref(pPgHdr);
6193 }
6194 return rc;
6195 }
6196
6197 /*
6198 ** Sync the database file to disk. This is a no-op for in-memory databases
6199 ** or pages with the Pager.noSync flag set.
6200 **
6201 ** If successful, or if called on a pager for which it is a no-op, this
6202 ** function returns SQLITE_OK. Otherwise, an IO error code is returned.
6203 */
6204 int sqlite3PagerSync(Pager *pPager, const char *zMaster){
6205 int rc = SQLITE_OK;
6206
6207 if( isOpen(pPager->fd) ){
6208 void *pArg = (void*)zMaster;
6209 rc = sqlite3OsFileControl(pPager->fd, SQLITE_FCNTL_SYNC, pArg);
6210 if( rc==SQLITE_NOTFOUND ) rc = SQLITE_OK;
6211 }
6212 if( rc==SQLITE_OK && !pPager->noSync ){
6213 assert( !MEMDB );
6214 rc = sqlite3OsSync(pPager->fd, pPager->syncFlags);
6215 }
6216 return rc;
6217 }
6218
6219 /*
6220 ** This function may only be called while a write-transaction is active in
6221 ** rollback. If the connection is in WAL mode, this call is a no-op.
6222 ** Otherwise, if the connection does not already have an EXCLUSIVE lock on
6223 ** the database file, an attempt is made to obtain one.
6224 **
6225 ** If the EXCLUSIVE lock is already held or the attempt to obtain it is
6226 ** successful, or the connection is in WAL mode, SQLITE_OK is returned.
6227 ** Otherwise, either SQLITE_BUSY or an SQLITE_IOERR_XXX error code is
6228 ** returned.
6229 */
6230 int sqlite3PagerExclusiveLock(Pager *pPager){
6231 int rc = pPager->errCode;
6232 assert( assert_pager_state(pPager) );
6233 if( rc==SQLITE_OK ){
6234 assert( pPager->eState==PAGER_WRITER_CACHEMOD
6235 || pPager->eState==PAGER_WRITER_DBMOD
6236 || pPager->eState==PAGER_WRITER_LOCKED
6237 );
6238 assert( assert_pager_state(pPager) );
6239 if( 0==pagerUseWal(pPager) ){
6240 rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
6241 }
6242 }
6243 return rc;
6244 }
6245
6246 /*
6247 ** Sync the database file for the pager pPager. zMaster points to the name
6248 ** of a master journal file that should be written into the individual
6249 ** journal file. zMaster may be NULL, which is interpreted as no master
6250 ** journal (a single database transaction).
6251 **
6252 ** This routine ensures that:
6253 **
6254 ** * The database file change-counter is updated,
6255 ** * the journal is synced (unless the atomic-write optimization is used),
6256 ** * all dirty pages are written to the database file,
6257 ** * the database file is truncated (if required), and
6258 ** * the database file synced.
6259 **
6260 ** The only thing that remains to commit the transaction is to finalize
6261 ** (delete, truncate or zero the first part of) the journal file (or
6262 ** delete the master journal file if specified).
6263 **
6264 ** Note that if zMaster==NULL, this does not overwrite a previous value
6265 ** passed to an sqlite3PagerCommitPhaseOne() call.
6266 **
6267 ** If the final parameter - noSync - is true, then the database file itself
6268 ** is not synced. The caller must call sqlite3PagerSync() directly to
6269 ** sync the database file before calling CommitPhaseTwo() to delete the
6270 ** journal file in this case.
6271 */
6272 int sqlite3PagerCommitPhaseOne(
6273 Pager *pPager, /* Pager object */
6274 const char *zMaster, /* If not NULL, the master journal name */
6275 int noSync /* True to omit the xSync on the db file */
6276 ){
6277 int rc = SQLITE_OK; /* Return code */
6278
6279 assert( pPager->eState==PAGER_WRITER_LOCKED
6280 || pPager->eState==PAGER_WRITER_CACHEMOD
6281 || pPager->eState==PAGER_WRITER_DBMOD
6282 || pPager->eState==PAGER_ERROR
6283 );
6284 assert( assert_pager_state(pPager) );
6285
6286 /* If a prior error occurred, report that error again. */
6287 if( NEVER(pPager->errCode) ) return pPager->errCode;
6288
6289 /* Provide the ability to easily simulate an I/O error during testing */
6290 if( sqlite3FaultSim(400) ) return SQLITE_IOERR;
6291
6292 PAGERTRACE(("DATABASE SYNC: File=%s zMaster=%s nSize=%d\n",
6293 pPager->zFilename, zMaster, pPager->dbSize));
6294
6295 /* If no database changes have been made, return early. */
6296 if( pPager->eState<PAGER_WRITER_CACHEMOD ) return SQLITE_OK;
6297
6298 assert( MEMDB==0 || pPager->tempFile );
6299 assert( isOpen(pPager->fd) || pPager->tempFile );
6300 if( 0==pagerFlushOnCommit(pPager, 1) ){
6301 /* If this is an in-memory db, or no pages have been written to, or this
6302 ** function has already been called, it is mostly a no-op. However, any
6303 ** backup in progress needs to be restarted. */
6304 sqlite3BackupRestart(pPager->pBackup);
6305 }else{
6306 if( pagerUseWal(pPager) ){
6307 PgHdr *pList = sqlite3PcacheDirtyList(pPager->pPCache);
6308 PgHdr *pPageOne = 0;
6309 if( pList==0 ){
6310 /* Must have at least one page for the WAL commit flag.
6311 ** Ticket [2d1a5c67dfc2363e44f29d9bbd57f] 2011-05-18 */
6312 rc = sqlite3PagerGet(pPager, 1, &pPageOne, 0);
6313 pList = pPageOne;
6314 pList->pDirty = 0;
6315 }
6316 assert( rc==SQLITE_OK );
6317 if( ALWAYS(pList) ){
6318 rc = pagerWalFrames(pPager, pList, pPager->dbSize, 1);
6319 }
6320 sqlite3PagerUnref(pPageOne);
6321 if( rc==SQLITE_OK ){
6322 sqlite3PcacheCleanAll(pPager->pPCache);
6323 }
6324 }else{
6325 /* The following block updates the change-counter. Exactly how it
6326 ** does this depends on whether or not the atomic-update optimization
6327 ** was enabled at compile time, and if this transaction meets the
6328 ** runtime criteria to use the operation:
6329 **
6330 ** * The file-system supports the atomic-write property for
6331 ** blocks of size page-size, and
6332 ** * This commit is not part of a multi-file transaction, and
6333 ** * Exactly one page has been modified and store in the journal file.
6334 **
6335 ** If the optimization was not enabled at compile time, then the
6336 ** pager_incr_changecounter() function is called to update the change
6337 ** counter in 'indirect-mode'. If the optimization is compiled in but
6338 ** is not applicable to this transaction, call sqlite3JournalCreate()
6339 ** to make sure the journal file has actually been created, then call
6340 ** pager_incr_changecounter() to update the change-counter in indirect
6341 ** mode.
6342 **
6343 ** Otherwise, if the optimization is both enabled and applicable,
6344 ** then call pager_incr_changecounter() to update the change-counter
6345 ** in 'direct' mode. In this case the journal file will never be
6346 ** created for this transaction.
6347 */
6348 #ifdef SQLITE_ENABLE_ATOMIC_WRITE
6349 PgHdr *pPg;
6350 assert( isOpen(pPager->jfd)
6351 || pPager->journalMode==PAGER_JOURNALMODE_OFF
6352 || pPager->journalMode==PAGER_JOURNALMODE_WAL
6353 );
6354 if( !zMaster && isOpen(pPager->jfd)
6355 && pPager->journalOff==jrnlBufferSize(pPager)
6356 && pPager->dbSize>=pPager->dbOrigSize
6357 && (0==(pPg = sqlite3PcacheDirtyList(pPager->pPCache)) || 0==pPg->pDirty)
6358 ){
6359 /* Update the db file change counter via the direct-write method. The
6360 ** following call will modify the in-memory representation of page 1
6361 ** to include the updated change counter and then write page 1
6362 ** directly to the database file. Because of the atomic-write
6363 ** property of the host file-system, this is safe.
6364 */
6365 rc = pager_incr_changecounter(pPager, 1);
6366 }else{
6367 rc = sqlite3JournalCreate(pPager->jfd);
6368 if( rc==SQLITE_OK ){
6369 rc = pager_incr_changecounter(pPager, 0);
6370 }
6371 }
6372 #else
6373 rc = pager_incr_changecounter(pPager, 0);
6374 #endif
6375 if( rc!=SQLITE_OK ) goto commit_phase_one_exit;
6376
6377 /* Write the master journal name into the journal file. If a master
6378 ** journal file name has already been written to the journal file,
6379 ** or if zMaster is NULL (no master journal), then this call is a no-op.
6380 */
6381 rc = writeMasterJournal(pPager, zMaster);
6382 if( rc!=SQLITE_OK ) goto commit_phase_one_exit;
6383
6384 /* Sync the journal file and write all dirty pages to the database.
6385 ** If the atomic-update optimization is being used, this sync will not
6386 ** create the journal file or perform any real IO.
6387 **
6388 ** Because the change-counter page was just modified, unless the
6389 ** atomic-update optimization is used it is almost certain that the
6390 ** journal requires a sync here. However, in locking_mode=exclusive
6391 ** on a system under memory pressure it is just possible that this is
6392 ** not the case. In this case it is likely enough that the redundant
6393 ** xSync() call will be changed to a no-op by the OS anyhow.
6394 */
6395 rc = syncJournal(pPager, 0);
6396 if( rc!=SQLITE_OK ) goto commit_phase_one_exit;
6397
6398 rc = pager_write_pagelist(pPager,sqlite3PcacheDirtyList(pPager->pPCache));
6399 if( rc!=SQLITE_OK ){
6400 assert( rc!=SQLITE_IOERR_BLOCKED );
6401 goto commit_phase_one_exit;
6402 }
6403 sqlite3PcacheCleanAll(pPager->pPCache);
6404
6405 /* If the file on disk is smaller than the database image, use
6406 ** pager_truncate to grow the file here. This can happen if the database
6407 ** image was extended as part of the current transaction and then the
6408 ** last page in the db image moved to the free-list. In this case the
6409 ** last page is never written out to disk, leaving the database file
6410 ** undersized. Fix this now if it is the case. */
6411 if( pPager->dbSize>pPager->dbFileSize ){
6412 Pgno nNew = pPager->dbSize - (pPager->dbSize==PAGER_MJ_PGNO(pPager));
6413 assert( pPager->eState==PAGER_WRITER_DBMOD );
6414 rc = pager_truncate(pPager, nNew);
6415 if( rc!=SQLITE_OK ) goto commit_phase_one_exit;
6416 }
6417
6418 /* Finally, sync the database file. */
6419 if( !noSync ){
6420 rc = sqlite3PagerSync(pPager, zMaster);
6421 }
6422 IOTRACE(("DBSYNC %p\n", pPager))
6423 }
6424 }
6425
6426 commit_phase_one_exit:
6427 if( rc==SQLITE_OK && !pagerUseWal(pPager) ){
6428 pPager->eState = PAGER_WRITER_FINISHED;
6429 }
6430 return rc;
6431 }
6432
6433
6434 /*
6435 ** When this function is called, the database file has been completely
6436 ** updated to reflect the changes made by the current transaction and
6437 ** synced to disk. The journal file still exists in the file-system
6438 ** though, and if a failure occurs at this point it will eventually
6439 ** be used as a hot-journal and the current transaction rolled back.
6440 **
6441 ** This function finalizes the journal file, either by deleting,
6442 ** truncating or partially zeroing it, so that it cannot be used
6443 ** for hot-journal rollback. Once this is done the transaction is
6444 ** irrevocably committed.
6445 **
6446 ** If an error occurs, an IO error code is returned and the pager
6447 ** moves into the error state. Otherwise, SQLITE_OK is returned.
6448 */
6449 int sqlite3PagerCommitPhaseTwo(Pager *pPager){
6450 int rc = SQLITE_OK; /* Return code */
6451
6452 /* This routine should not be called if a prior error has occurred.
6453 ** But if (due to a coding error elsewhere in the system) it does get
6454 ** called, just return the same error code without doing anything. */
6455 if( NEVER(pPager->errCode) ) return pPager->errCode;
6456
6457 assert( pPager->eState==PAGER_WRITER_LOCKED
6458 || pPager->eState==PAGER_WRITER_FINISHED
6459 || (pagerUseWal(pPager) && pPager->eState==PAGER_WRITER_CACHEMOD)
6460 );
6461 assert( assert_pager_state(pPager) );
6462
6463 /* An optimization. If the database was not actually modified during
6464 ** this transaction, the pager is running in exclusive-mode and is
6465 ** using persistent journals, then this function is a no-op.
6466 **
6467 ** The start of the journal file currently contains a single journal
6468 ** header with the nRec field set to 0. If such a journal is used as
6469 ** a hot-journal during hot-journal rollback, 0 changes will be made
6470 ** to the database file. So there is no need to zero the journal
6471 ** header. Since the pager is in exclusive mode, there is no need
6472 ** to drop any locks either.
6473 */
6474 if( pPager->eState==PAGER_WRITER_LOCKED
6475 && pPager->exclusiveMode
6476 && pPager->journalMode==PAGER_JOURNALMODE_PERSIST
6477 ){
6478 assert( pPager->journalOff==JOURNAL_HDR_SZ(pPager) || !pPager->journalOff );
6479 pPager->eState = PAGER_READER;
6480 return SQLITE_OK;
6481 }
6482
6483 PAGERTRACE(("COMMIT %d\n", PAGERID(pPager)));
6484 pPager->iDataVersion++;
6485 rc = pager_end_transaction(pPager, pPager->setMaster, 1);
6486 return pager_error(pPager, rc);
6487 }
6488
6489 /*
6490 ** If a write transaction is open, then all changes made within the
6491 ** transaction are reverted and the current write-transaction is closed.
6492 ** The pager falls back to PAGER_READER state if successful, or PAGER_ERROR
6493 ** state if an error occurs.
6494 **
6495 ** If the pager is already in PAGER_ERROR state when this function is called,
6496 ** it returns Pager.errCode immediately. No work is performed in this case.
6497 **
6498 ** Otherwise, in rollback mode, this function performs two functions:
6499 **
6500 ** 1) It rolls back the journal file, restoring all database file and
6501 ** in-memory cache pages to the state they were in when the transaction
6502 ** was opened, and
6503 **
6504 ** 2) It finalizes the journal file, so that it is not used for hot
6505 ** rollback at any point in the future.
6506 **
6507 ** Finalization of the journal file (task 2) is only performed if the
6508 ** rollback is successful.
6509 **
6510 ** In WAL mode, all cache-entries containing data modified within the
6511 ** current transaction are either expelled from the cache or reverted to
6512 ** their pre-transaction state by re-reading data from the database or
6513 ** WAL files. The WAL transaction is then closed.
6514 */
6515 int sqlite3PagerRollback(Pager *pPager){
6516 int rc = SQLITE_OK; /* Return code */
6517 PAGERTRACE(("ROLLBACK %d\n", PAGERID(pPager)));
6518
6519 /* PagerRollback() is a no-op if called in READER or OPEN state. If
6520 ** the pager is already in the ERROR state, the rollback is not
6521 ** attempted here. Instead, the error code is returned to the caller.
6522 */
6523 assert( assert_pager_state(pPager) );
6524 if( pPager->eState==PAGER_ERROR ) return pPager->errCode;
6525 if( pPager->eState<=PAGER_READER ) return SQLITE_OK;
6526
6527 if( pagerUseWal(pPager) ){
6528 int rc2;
6529 rc = sqlite3PagerSavepoint(pPager, SAVEPOINT_ROLLBACK, -1);
6530 rc2 = pager_end_transaction(pPager, pPager->setMaster, 0);
6531 if( rc==SQLITE_OK ) rc = rc2;
6532 }else if( !isOpen(pPager->jfd) || pPager->eState==PAGER_WRITER_LOCKED ){
6533 int eState = pPager->eState;
6534 rc = pager_end_transaction(pPager, 0, 0);
6535 if( !MEMDB && eState>PAGER_WRITER_LOCKED ){
6536 /* This can happen using journal_mode=off. Move the pager to the error
6537 ** state to indicate that the contents of the cache may not be trusted.
6538 ** Any active readers will get SQLITE_ABORT.
6539 */
6540 pPager->errCode = SQLITE_ABORT;
6541 pPager->eState = PAGER_ERROR;
6542 setGetterMethod(pPager);
6543 return rc;
6544 }
6545 }else{
6546 rc = pager_playback(pPager, 0);
6547 }
6548
6549 assert( pPager->eState==PAGER_READER || rc!=SQLITE_OK );
6550 assert( rc==SQLITE_OK || rc==SQLITE_FULL || rc==SQLITE_CORRUPT
6551 || rc==SQLITE_NOMEM || (rc&0xFF)==SQLITE_IOERR
6552 || rc==SQLITE_CANTOPEN
6553 );
6554
6555 /* If an error occurs during a ROLLBACK, we can no longer trust the pager
6556 ** cache. So call pager_error() on the way out to make any error persistent.
6557 */
6558 return pager_error(pPager, rc);
6559 }
6560
6561 /*
6562 ** Return TRUE if the database file is opened read-only. Return FALSE
6563 ** if the database is (in theory) writable.
6564 */
6565 u8 sqlite3PagerIsreadonly(Pager *pPager){
6566 return pPager->readOnly;
6567 }
6568
6569 #ifdef SQLITE_DEBUG
6570 /*
6571 ** Return the sum of the reference counts for all pages held by pPager.
6572 */
6573 int sqlite3PagerRefcount(Pager *pPager){
6574 return sqlite3PcacheRefCount(pPager->pPCache);
6575 }
6576 #endif
6577
6578 /*
6579 ** Return the approximate number of bytes of memory currently
6580 ** used by the pager and its associated cache.
6581 */
6582 int sqlite3PagerMemUsed(Pager *pPager){
6583 int perPageSize = pPager->pageSize + pPager->nExtra + sizeof(PgHdr)
6584 + 5*sizeof(void*);
6585 return perPageSize*sqlite3PcachePagecount(pPager->pPCache)
6586 + sqlite3MallocSize(pPager)
6587 + pPager->pageSize;
6588 }
6589
6590 /*
6591 ** Return the number of references to the specified page.
6592 */
6593 int sqlite3PagerPageRefcount(DbPage *pPage){
6594 return sqlite3PcachePageRefcount(pPage);
6595 }
6596
6597 #ifdef SQLITE_TEST
6598 /*
6599 ** This routine is used for testing and analysis only.
6600 */
6601 int *sqlite3PagerStats(Pager *pPager){
6602 static int a[11];
6603 a[0] = sqlite3PcacheRefCount(pPager->pPCache);
6604 a[1] = sqlite3PcachePagecount(pPager->pPCache);
6605 a[2] = sqlite3PcacheGetCachesize(pPager->pPCache);
6606 a[3] = pPager->eState==PAGER_OPEN ? -1 : (int) pPager->dbSize;
6607 a[4] = pPager->eState;
6608 a[5] = pPager->errCode;
6609 a[6] = pPager->aStat[PAGER_STAT_HIT];
6610 a[7] = pPager->aStat[PAGER_STAT_MISS];
6611 a[8] = 0; /* Used to be pPager->nOvfl */
6612 a[9] = pPager->nRead;
6613 a[10] = pPager->aStat[PAGER_STAT_WRITE];
6614 return a;
6615 }
6616 #endif
6617
6618 /*
6619 ** Parameter eStat must be either SQLITE_DBSTATUS_CACHE_HIT or
6620 ** SQLITE_DBSTATUS_CACHE_MISS. Before returning, *pnVal is incremented by the
6621 ** current cache hit or miss count, according to the value of eStat. If the
6622 ** reset parameter is non-zero, the cache hit or miss count is zeroed before
6623 ** returning.
6624 */
6625 void sqlite3PagerCacheStat(Pager *pPager, int eStat, int reset, int *pnVal){
6626
6627 assert( eStat==SQLITE_DBSTATUS_CACHE_HIT
6628 || eStat==SQLITE_DBSTATUS_CACHE_MISS
6629 || eStat==SQLITE_DBSTATUS_CACHE_WRITE
6630 );
6631
6632 assert( SQLITE_DBSTATUS_CACHE_HIT+1==SQLITE_DBSTATUS_CACHE_MISS );
6633 assert( SQLITE_DBSTATUS_CACHE_HIT+2==SQLITE_DBSTATUS_CACHE_WRITE );
6634 assert( PAGER_STAT_HIT==0 && PAGER_STAT_MISS==1 && PAGER_STAT_WRITE==2 );
6635
6636 *pnVal += pPager->aStat[eStat - SQLITE_DBSTATUS_CACHE_HIT];
6637 if( reset ){
6638 pPager->aStat[eStat - SQLITE_DBSTATUS_CACHE_HIT] = 0;
6639 }
6640 }
6641
6642 /*
6643 ** Return true if this is an in-memory or temp-file backed pager.
6644 */
6645 int sqlite3PagerIsMemdb(Pager *pPager){
6646 return pPager->tempFile;
6647 }
6648
6649 /*
6650 ** Check that there are at least nSavepoint savepoints open. If there are
6651 ** currently less than nSavepoints open, then open one or more savepoints
6652 ** to make up the difference. If the number of savepoints is already
6653 ** equal to nSavepoint, then this function is a no-op.
6654 **
6655 ** If a memory allocation fails, SQLITE_NOMEM is returned. If an error
6656 ** occurs while opening the sub-journal file, then an IO error code is
6657 ** returned. Otherwise, SQLITE_OK.
6658 */
6659 static SQLITE_NOINLINE int pagerOpenSavepoint(Pager *pPager, int nSavepoint){
6660 int rc = SQLITE_OK; /* Return code */
6661 int nCurrent = pPager->nSavepoint; /* Current number of savepoints */
6662 int ii; /* Iterator variable */
6663 PagerSavepoint *aNew; /* New Pager.aSavepoint array */
6664
6665 assert( pPager->eState>=PAGER_WRITER_LOCKED );
6666 assert( assert_pager_state(pPager) );
6667 assert( nSavepoint>nCurrent && pPager->useJournal );
6668
6669 /* Grow the Pager.aSavepoint array using realloc(). Return SQLITE_NOMEM
6670 ** if the allocation fails. Otherwise, zero the new portion in case a
6671 ** malloc failure occurs while populating it in the for(...) loop below.
6672 */
6673 aNew = (PagerSavepoint *)sqlite3Realloc(
6674 pPager->aSavepoint, sizeof(PagerSavepoint)*nSavepoint
6675 );
6676 if( !aNew ){
6677 return SQLITE_NOMEM_BKPT;
6678 }
6679 memset(&aNew[nCurrent], 0, (nSavepoint-nCurrent) * sizeof(PagerSavepoint));
6680 pPager->aSavepoint = aNew;
6681
6682 /* Populate the PagerSavepoint structures just allocated. */
6683 for(ii=nCurrent; ii<nSavepoint; ii++){
6684 aNew[ii].nOrig = pPager->dbSize;
6685 if( isOpen(pPager->jfd) && pPager->journalOff>0 ){
6686 aNew[ii].iOffset = pPager->journalOff;
6687 }else{
6688 aNew[ii].iOffset = JOURNAL_HDR_SZ(pPager);
6689 }
6690 aNew[ii].iSubRec = pPager->nSubRec;
6691 aNew[ii].pInSavepoint = sqlite3BitvecCreate(pPager->dbSize);
6692 if( !aNew[ii].pInSavepoint ){
6693 return SQLITE_NOMEM_BKPT;
6694 }
6695 if( pagerUseWal(pPager) ){
6696 sqlite3WalSavepoint(pPager->pWal, aNew[ii].aWalData);
6697 }
6698 pPager->nSavepoint = ii+1;
6699 }
6700 assert( pPager->nSavepoint==nSavepoint );
6701 assertTruncateConstraint(pPager);
6702 return rc;
6703 }
6704 int sqlite3PagerOpenSavepoint(Pager *pPager, int nSavepoint){
6705 assert( pPager->eState>=PAGER_WRITER_LOCKED );
6706 assert( assert_pager_state(pPager) );
6707
6708 if( nSavepoint>pPager->nSavepoint && pPager->useJournal ){
6709 return pagerOpenSavepoint(pPager, nSavepoint);
6710 }else{
6711 return SQLITE_OK;
6712 }
6713 }
6714
6715
6716 /*
6717 ** This function is called to rollback or release (commit) a savepoint.
6718 ** The savepoint to release or rollback need not be the most recently
6719 ** created savepoint.
6720 **
6721 ** Parameter op is always either SAVEPOINT_ROLLBACK or SAVEPOINT_RELEASE.
6722 ** If it is SAVEPOINT_RELEASE, then release and destroy the savepoint with
6723 ** index iSavepoint. If it is SAVEPOINT_ROLLBACK, then rollback all changes
6724 ** that have occurred since the specified savepoint was created.
6725 **
6726 ** The savepoint to rollback or release is identified by parameter
6727 ** iSavepoint. A value of 0 means to operate on the outermost savepoint
6728 ** (the first created). A value of (Pager.nSavepoint-1) means operate
6729 ** on the most recently created savepoint. If iSavepoint is greater than
6730 ** (Pager.nSavepoint-1), then this function is a no-op.
6731 **
6732 ** If a negative value is passed to this function, then the current
6733 ** transaction is rolled back. This is different to calling
6734 ** sqlite3PagerRollback() because this function does not terminate
6735 ** the transaction or unlock the database, it just restores the
6736 ** contents of the database to its original state.
6737 **
6738 ** In any case, all savepoints with an index greater than iSavepoint
6739 ** are destroyed. If this is a release operation (op==SAVEPOINT_RELEASE),
6740 ** then savepoint iSavepoint is also destroyed.
6741 **
6742 ** This function may return SQLITE_NOMEM if a memory allocation fails,
6743 ** or an IO error code if an IO error occurs while rolling back a
6744 ** savepoint. If no errors occur, SQLITE_OK is returned.
6745 */
6746 int sqlite3PagerSavepoint(Pager *pPager, int op, int iSavepoint){
6747 int rc = pPager->errCode;
6748
6749 #ifdef SQLITE_ENABLE_ZIPVFS
6750 if( op==SAVEPOINT_RELEASE ) rc = SQLITE_OK;
6751 #endif
6752
6753 assert( op==SAVEPOINT_RELEASE || op==SAVEPOINT_ROLLBACK );
6754 assert( iSavepoint>=0 || op==SAVEPOINT_ROLLBACK );
6755
6756 if( rc==SQLITE_OK && iSavepoint<pPager->nSavepoint ){
6757 int ii; /* Iterator variable */
6758 int nNew; /* Number of remaining savepoints after this op. */
6759
6760 /* Figure out how many savepoints will still be active after this
6761 ** operation. Store this value in nNew. Then free resources associated
6762 ** with any savepoints that are destroyed by this operation.
6763 */
6764 nNew = iSavepoint + (( op==SAVEPOINT_RELEASE ) ? 0 : 1);
6765 for(ii=nNew; ii<pPager->nSavepoint; ii++){
6766 sqlite3BitvecDestroy(pPager->aSavepoint[ii].pInSavepoint);
6767 }
6768 pPager->nSavepoint = nNew;
6769
6770 /* If this is a release of the outermost savepoint, truncate
6771 ** the sub-journal to zero bytes in size. */
6772 if( op==SAVEPOINT_RELEASE ){
6773 if( nNew==0 && isOpen(pPager->sjfd) ){
6774 /* Only truncate if it is an in-memory sub-journal. */
6775 if( sqlite3JournalIsInMemory(pPager->sjfd) ){
6776 rc = sqlite3OsTruncate(pPager->sjfd, 0);
6777 assert( rc==SQLITE_OK );
6778 }
6779 pPager->nSubRec = 0;
6780 }
6781 }
6782 /* Else this is a rollback operation, playback the specified savepoint.
6783 ** If this is a temp-file, it is possible that the journal file has
6784 ** not yet been opened. In this case there have been no changes to
6785 ** the database file, so the playback operation can be skipped.
6786 */
6787 else if( pagerUseWal(pPager) || isOpen(pPager->jfd) ){
6788 PagerSavepoint *pSavepoint = (nNew==0)?0:&pPager->aSavepoint[nNew-1];
6789 rc = pagerPlaybackSavepoint(pPager, pSavepoint);
6790 assert(rc!=SQLITE_DONE);
6791 }
6792
6793 #ifdef SQLITE_ENABLE_ZIPVFS
6794 /* If the cache has been modified but the savepoint cannot be rolled
6795 ** back journal_mode=off, put the pager in the error state. This way,
6796 ** if the VFS used by this pager includes ZipVFS, the entire transaction
6797 ** can be rolled back at the ZipVFS level. */
6798 else if(
6799 pPager->journalMode==PAGER_JOURNALMODE_OFF
6800 && pPager->eState>=PAGER_WRITER_CACHEMOD
6801 ){
6802 pPager->errCode = SQLITE_ABORT;
6803 pPager->eState = PAGER_ERROR;
6804 setGetterMethod(pPager);
6805 }
6806 #endif
6807 }
6808
6809 return rc;
6810 }
6811
6812 /*
6813 ** Return the full pathname of the database file.
6814 **
6815 ** Except, if the pager is in-memory only, then return an empty string if
6816 ** nullIfMemDb is true. This routine is called with nullIfMemDb==1 when
6817 ** used to report the filename to the user, for compatibility with legacy
6818 ** behavior. But when the Btree needs to know the filename for matching to
6819 ** shared cache, it uses nullIfMemDb==0 so that in-memory databases can
6820 ** participate in shared-cache.
6821 */
6822 const char *sqlite3PagerFilename(Pager *pPager, int nullIfMemDb){
6823 return (nullIfMemDb && pPager->memDb) ? "" : pPager->zFilename;
6824 }
6825
6826 /*
6827 ** Return the VFS structure for the pager.
6828 */
6829 sqlite3_vfs *sqlite3PagerVfs(Pager *pPager){
6830 return pPager->pVfs;
6831 }
6832
6833 /*
6834 ** Return the file handle for the database file associated
6835 ** with the pager. This might return NULL if the file has
6836 ** not yet been opened.
6837 */
6838 sqlite3_file *sqlite3PagerFile(Pager *pPager){
6839 return pPager->fd;
6840 }
6841
6842 /*
6843 ** Return the file handle for the journal file (if it exists).
6844 ** This will be either the rollback journal or the WAL file.
6845 */
6846 sqlite3_file *sqlite3PagerJrnlFile(Pager *pPager){
6847 #if SQLITE_OMIT_WAL
6848 return pPager->jfd;
6849 #else
6850 return pPager->pWal ? sqlite3WalFile(pPager->pWal) : pPager->jfd;
6851 #endif
6852 }
6853
6854 /*
6855 ** Return the full pathname of the journal file.
6856 */
6857 const char *sqlite3PagerJournalname(Pager *pPager){
6858 return pPager->zJournal;
6859 }
6860
6861 #ifdef SQLITE_HAS_CODEC
6862 /*
6863 ** Set or retrieve the codec for this pager
6864 */
6865 void sqlite3PagerSetCodec(
6866 Pager *pPager,
6867 void *(*xCodec)(void*,void*,Pgno,int),
6868 void (*xCodecSizeChng)(void*,int,int),
6869 void (*xCodecFree)(void*),
6870 void *pCodec
6871 ){
6872 if( pPager->xCodecFree ) pPager->xCodecFree(pPager->pCodec);
6873 pPager->xCodec = pPager->memDb ? 0 : xCodec;
6874 pPager->xCodecSizeChng = xCodecSizeChng;
6875 pPager->xCodecFree = xCodecFree;
6876 pPager->pCodec = pCodec;
6877 setGetterMethod(pPager);
6878 pagerReportSize(pPager);
6879 }
6880 void *sqlite3PagerGetCodec(Pager *pPager){
6881 return pPager->pCodec;
6882 }
6883
6884 /*
6885 ** This function is called by the wal module when writing page content
6886 ** into the log file.
6887 **
6888 ** This function returns a pointer to a buffer containing the encrypted
6889 ** page content. If a malloc fails, this function may return NULL.
6890 */
6891 void *sqlite3PagerCodec(PgHdr *pPg){
6892 void *aData = 0;
6893 CODEC2(pPg->pPager, pPg->pData, pPg->pgno, 6, return 0, aData);
6894 return aData;
6895 }
6896
6897 /*
6898 ** Return the current pager state
6899 */
6900 int sqlite3PagerState(Pager *pPager){
6901 return pPager->eState;
6902 }
6903 #endif /* SQLITE_HAS_CODEC */
6904
6905 #ifndef SQLITE_OMIT_AUTOVACUUM
6906 /*
6907 ** Move the page pPg to location pgno in the file.
6908 **
6909 ** There must be no references to the page previously located at
6910 ** pgno (which we call pPgOld) though that page is allowed to be
6911 ** in cache. If the page previously located at pgno is not already
6912 ** in the rollback journal, it is not put there by by this routine.
6913 **
6914 ** References to the page pPg remain valid. Updating any
6915 ** meta-data associated with pPg (i.e. data stored in the nExtra bytes
6916 ** allocated along with the page) is the responsibility of the caller.
6917 **
6918 ** A transaction must be active when this routine is called. It used to be
6919 ** required that a statement transaction was not active, but this restriction
6920 ** has been removed (CREATE INDEX needs to move a page when a statement
6921 ** transaction is active).
6922 **
6923 ** If the fourth argument, isCommit, is non-zero, then this page is being
6924 ** moved as part of a database reorganization just before the transaction
6925 ** is being committed. In this case, it is guaranteed that the database page
6926 ** pPg refers to will not be written to again within this transaction.
6927 **
6928 ** This function may return SQLITE_NOMEM or an IO error code if an error
6929 ** occurs. Otherwise, it returns SQLITE_OK.
6930 */
6931 int sqlite3PagerMovepage(Pager *pPager, DbPage *pPg, Pgno pgno, int isCommit){
6932 PgHdr *pPgOld; /* The page being overwritten. */
6933 Pgno needSyncPgno = 0; /* Old value of pPg->pgno, if sync is required */
6934 int rc; /* Return code */
6935 Pgno origPgno; /* The original page number */
6936
6937 assert( pPg->nRef>0 );
6938 assert( pPager->eState==PAGER_WRITER_CACHEMOD
6939 || pPager->eState==PAGER_WRITER_DBMOD
6940 );
6941 assert( assert_pager_state(pPager) );
6942
6943 /* In order to be able to rollback, an in-memory database must journal
6944 ** the page we are moving from.
6945 */
6946 assert( pPager->tempFile || !MEMDB );
6947 if( pPager->tempFile ){
6948 rc = sqlite3PagerWrite(pPg);
6949 if( rc ) return rc;
6950 }
6951
6952 /* If the page being moved is dirty and has not been saved by the latest
6953 ** savepoint, then save the current contents of the page into the
6954 ** sub-journal now. This is required to handle the following scenario:
6955 **
6956 ** BEGIN;
6957 ** <journal page X, then modify it in memory>
6958 ** SAVEPOINT one;
6959 ** <Move page X to location Y>
6960 ** ROLLBACK TO one;
6961 **
6962 ** If page X were not written to the sub-journal here, it would not
6963 ** be possible to restore its contents when the "ROLLBACK TO one"
6964 ** statement were is processed.
6965 **
6966 ** subjournalPage() may need to allocate space to store pPg->pgno into
6967 ** one or more savepoint bitvecs. This is the reason this function
6968 ** may return SQLITE_NOMEM.
6969 */
6970 if( (pPg->flags & PGHDR_DIRTY)!=0
6971 && SQLITE_OK!=(rc = subjournalPageIfRequired(pPg))
6972 ){
6973 return rc;
6974 }
6975
6976 PAGERTRACE(("MOVE %d page %d (needSync=%d) moves to %d\n",
6977 PAGERID(pPager), pPg->pgno, (pPg->flags&PGHDR_NEED_SYNC)?1:0, pgno));
6978 IOTRACE(("MOVE %p %d %d\n", pPager, pPg->pgno, pgno))
6979
6980 /* If the journal needs to be sync()ed before page pPg->pgno can
6981 ** be written to, store pPg->pgno in local variable needSyncPgno.
6982 **
6983 ** If the isCommit flag is set, there is no need to remember that
6984 ** the journal needs to be sync()ed before database page pPg->pgno
6985 ** can be written to. The caller has already promised not to write to it.
6986 */
6987 if( (pPg->flags&PGHDR_NEED_SYNC) && !isCommit ){
6988 needSyncPgno = pPg->pgno;
6989 assert( pPager->journalMode==PAGER_JOURNALMODE_OFF ||
6990 pageInJournal(pPager, pPg) || pPg->pgno>pPager->dbOrigSize );
6991 assert( pPg->flags&PGHDR_DIRTY );
6992 }
6993
6994 /* If the cache contains a page with page-number pgno, remove it
6995 ** from its hash chain. Also, if the PGHDR_NEED_SYNC flag was set for
6996 ** page pgno before the 'move' operation, it needs to be retained
6997 ** for the page moved there.
6998 */
6999 pPg->flags &= ~PGHDR_NEED_SYNC;
7000 pPgOld = sqlite3PagerLookup(pPager, pgno);
7001 assert( !pPgOld || pPgOld->nRef==1 );
7002 if( pPgOld ){
7003 pPg->flags |= (pPgOld->flags&PGHDR_NEED_SYNC);
7004 if( pPager->tempFile ){
7005 /* Do not discard pages from an in-memory database since we might
7006 ** need to rollback later. Just move the page out of the way. */
7007 sqlite3PcacheMove(pPgOld, pPager->dbSize+1);
7008 }else{
7009 sqlite3PcacheDrop(pPgOld);
7010 }
7011 }
7012
7013 origPgno = pPg->pgno;
7014 sqlite3PcacheMove(pPg, pgno);
7015 sqlite3PcacheMakeDirty(pPg);
7016
7017 /* For an in-memory database, make sure the original page continues
7018 ** to exist, in case the transaction needs to roll back. Use pPgOld
7019 ** as the original page since it has already been allocated.
7020 */
7021 if( pPager->tempFile && pPgOld ){
7022 sqlite3PcacheMove(pPgOld, origPgno);
7023 sqlite3PagerUnrefNotNull(pPgOld);
7024 }
7025
7026 if( needSyncPgno ){
7027 /* If needSyncPgno is non-zero, then the journal file needs to be
7028 ** sync()ed before any data is written to database file page needSyncPgno.
7029 ** Currently, no such page exists in the page-cache and the
7030 ** "is journaled" bitvec flag has been set. This needs to be remedied by
7031 ** loading the page into the pager-cache and setting the PGHDR_NEED_SYNC
7032 ** flag.
7033 **
7034 ** If the attempt to load the page into the page-cache fails, (due
7035 ** to a malloc() or IO failure), clear the bit in the pInJournal[]
7036 ** array. Otherwise, if the page is loaded and written again in
7037 ** this transaction, it may be written to the database file before
7038 ** it is synced into the journal file. This way, it may end up in
7039 ** the journal file twice, but that is not a problem.
7040 */
7041 PgHdr *pPgHdr;
7042 rc = sqlite3PagerGet(pPager, needSyncPgno, &pPgHdr, 0);
7043 if( rc!=SQLITE_OK ){
7044 if( needSyncPgno<=pPager->dbOrigSize ){
7045 assert( pPager->pTmpSpace!=0 );
7046 sqlite3BitvecClear(pPager->pInJournal, needSyncPgno, pPager->pTmpSpace);
7047 }
7048 return rc;
7049 }
7050 pPgHdr->flags |= PGHDR_NEED_SYNC;
7051 sqlite3PcacheMakeDirty(pPgHdr);
7052 sqlite3PagerUnrefNotNull(pPgHdr);
7053 }
7054
7055 return SQLITE_OK;
7056 }
7057 #endif
7058
7059 /*
7060 ** The page handle passed as the first argument refers to a dirty page
7061 ** with a page number other than iNew. This function changes the page's
7062 ** page number to iNew and sets the value of the PgHdr.flags field to
7063 ** the value passed as the third parameter.
7064 */
7065 void sqlite3PagerRekey(DbPage *pPg, Pgno iNew, u16 flags){
7066 assert( pPg->pgno!=iNew );
7067 pPg->flags = flags;
7068 sqlite3PcacheMove(pPg, iNew);
7069 }
7070
7071 /*
7072 ** Return a pointer to the data for the specified page.
7073 */
7074 void *sqlite3PagerGetData(DbPage *pPg){
7075 assert( pPg->nRef>0 || pPg->pPager->memDb );
7076 return pPg->pData;
7077 }
7078
7079 /*
7080 ** Return a pointer to the Pager.nExtra bytes of "extra" space
7081 ** allocated along with the specified page.
7082 */
7083 void *sqlite3PagerGetExtra(DbPage *pPg){
7084 return pPg->pExtra;
7085 }
7086
7087 /*
7088 ** Get/set the locking-mode for this pager. Parameter eMode must be one
7089 ** of PAGER_LOCKINGMODE_QUERY, PAGER_LOCKINGMODE_NORMAL or
7090 ** PAGER_LOCKINGMODE_EXCLUSIVE. If the parameter is not _QUERY, then
7091 ** the locking-mode is set to the value specified.
7092 **
7093 ** The returned value is either PAGER_LOCKINGMODE_NORMAL or
7094 ** PAGER_LOCKINGMODE_EXCLUSIVE, indicating the current (possibly updated)
7095 ** locking-mode.
7096 */
7097 int sqlite3PagerLockingMode(Pager *pPager, int eMode){
7098 assert( eMode==PAGER_LOCKINGMODE_QUERY
7099 || eMode==PAGER_LOCKINGMODE_NORMAL
7100 || eMode==PAGER_LOCKINGMODE_EXCLUSIVE );
7101 assert( PAGER_LOCKINGMODE_QUERY<0 );
7102 assert( PAGER_LOCKINGMODE_NORMAL>=0 && PAGER_LOCKINGMODE_EXCLUSIVE>=0 );
7103 assert( pPager->exclusiveMode || 0==sqlite3WalHeapMemory(pPager->pWal) );
7104 if( eMode>=0 && !pPager->tempFile && !sqlite3WalHeapMemory(pPager->pWal) ){
7105 pPager->exclusiveMode = (u8)eMode;
7106 }
7107 return (int)pPager->exclusiveMode;
7108 }
7109
7110 /*
7111 ** Set the journal-mode for this pager. Parameter eMode must be one of:
7112 **
7113 ** PAGER_JOURNALMODE_DELETE
7114 ** PAGER_JOURNALMODE_TRUNCATE
7115 ** PAGER_JOURNALMODE_PERSIST
7116 ** PAGER_JOURNALMODE_OFF
7117 ** PAGER_JOURNALMODE_MEMORY
7118 ** PAGER_JOURNALMODE_WAL
7119 **
7120 ** The journalmode is set to the value specified if the change is allowed.
7121 ** The change may be disallowed for the following reasons:
7122 **
7123 ** * An in-memory database can only have its journal_mode set to _OFF
7124 ** or _MEMORY.
7125 **
7126 ** * Temporary databases cannot have _WAL journalmode.
7127 **
7128 ** The returned indicate the current (possibly updated) journal-mode.
7129 */
7130 int sqlite3PagerSetJournalMode(Pager *pPager, int eMode){
7131 u8 eOld = pPager->journalMode; /* Prior journalmode */
7132
7133 #ifdef SQLITE_DEBUG
7134 /* The print_pager_state() routine is intended to be used by the debugger
7135 ** only. We invoke it once here to suppress a compiler warning. */
7136 print_pager_state(pPager);
7137 #endif
7138
7139
7140 /* The eMode parameter is always valid */
7141 assert( eMode==PAGER_JOURNALMODE_DELETE
7142 || eMode==PAGER_JOURNALMODE_TRUNCATE
7143 || eMode==PAGER_JOURNALMODE_PERSIST
7144 || eMode==PAGER_JOURNALMODE_OFF
7145 || eMode==PAGER_JOURNALMODE_WAL
7146 || eMode==PAGER_JOURNALMODE_MEMORY );
7147
7148 /* This routine is only called from the OP_JournalMode opcode, and
7149 ** the logic there will never allow a temporary file to be changed
7150 ** to WAL mode.
7151 */
7152 assert( pPager->tempFile==0 || eMode!=PAGER_JOURNALMODE_WAL );
7153
7154 /* Do allow the journalmode of an in-memory database to be set to
7155 ** anything other than MEMORY or OFF
7156 */
7157 if( MEMDB ){
7158 assert( eOld==PAGER_JOURNALMODE_MEMORY || eOld==PAGER_JOURNALMODE_OFF );
7159 if( eMode!=PAGER_JOURNALMODE_MEMORY && eMode!=PAGER_JOURNALMODE_OFF ){
7160 eMode = eOld;
7161 }
7162 }
7163
7164 if( eMode!=eOld ){
7165
7166 /* Change the journal mode. */
7167 assert( pPager->eState!=PAGER_ERROR );
7168 pPager->journalMode = (u8)eMode;
7169
7170 /* When transistioning from TRUNCATE or PERSIST to any other journal
7171 ** mode except WAL, unless the pager is in locking_mode=exclusive mode,
7172 ** delete the journal file.
7173 */
7174 assert( (PAGER_JOURNALMODE_TRUNCATE & 5)==1 );
7175 assert( (PAGER_JOURNALMODE_PERSIST & 5)==1 );
7176 assert( (PAGER_JOURNALMODE_DELETE & 5)==0 );
7177 assert( (PAGER_JOURNALMODE_MEMORY & 5)==4 );
7178 assert( (PAGER_JOURNALMODE_OFF & 5)==0 );
7179 assert( (PAGER_JOURNALMODE_WAL & 5)==5 );
7180
7181 assert( isOpen(pPager->fd) || pPager->exclusiveMode );
7182 if( !pPager->exclusiveMode && (eOld & 5)==1 && (eMode & 1)==0 ){
7183
7184 /* In this case we would like to delete the journal file. If it is
7185 ** not possible, then that is not a problem. Deleting the journal file
7186 ** here is an optimization only.
7187 **
7188 ** Before deleting the journal file, obtain a RESERVED lock on the
7189 ** database file. This ensures that the journal file is not deleted
7190 ** while it is in use by some other client.
7191 */
7192 sqlite3OsClose(pPager->jfd);
7193 if( pPager->eLock>=RESERVED_LOCK ){
7194 sqlite3OsDelete(pPager->pVfs, pPager->zJournal, 0);
7195 }else{
7196 int rc = SQLITE_OK;
7197 int state = pPager->eState;
7198 assert( state==PAGER_OPEN || state==PAGER_READER );
7199 if( state==PAGER_OPEN ){
7200 rc = sqlite3PagerSharedLock(pPager);
7201 }
7202 if( pPager->eState==PAGER_READER ){
7203 assert( rc==SQLITE_OK );
7204 rc = pagerLockDb(pPager, RESERVED_LOCK);
7205 }
7206 if( rc==SQLITE_OK ){
7207 sqlite3OsDelete(pPager->pVfs, pPager->zJournal, 0);
7208 }
7209 if( rc==SQLITE_OK && state==PAGER_READER ){
7210 pagerUnlockDb(pPager, SHARED_LOCK);
7211 }else if( state==PAGER_OPEN ){
7212 pager_unlock(pPager);
7213 }
7214 assert( state==pPager->eState );
7215 }
7216 }else if( eMode==PAGER_JOURNALMODE_OFF ){
7217 sqlite3OsClose(pPager->jfd);
7218 }
7219 }
7220
7221 /* Return the new journal mode */
7222 return (int)pPager->journalMode;
7223 }
7224
7225 /*
7226 ** Return the current journal mode.
7227 */
7228 int sqlite3PagerGetJournalMode(Pager *pPager){
7229 return (int)pPager->journalMode;
7230 }
7231
7232 /*
7233 ** Return TRUE if the pager is in a state where it is OK to change the
7234 ** journalmode. Journalmode changes can only happen when the database
7235 ** is unmodified.
7236 */
7237 int sqlite3PagerOkToChangeJournalMode(Pager *pPager){
7238 assert( assert_pager_state(pPager) );
7239 if( pPager->eState>=PAGER_WRITER_CACHEMOD ) return 0;
7240 if( NEVER(isOpen(pPager->jfd) && pPager->journalOff>0) ) return 0;
7241 return 1;
7242 }
7243
7244 /*
7245 ** Get/set the size-limit used for persistent journal files.
7246 **
7247 ** Setting the size limit to -1 means no limit is enforced.
7248 ** An attempt to set a limit smaller than -1 is a no-op.
7249 */
7250 i64 sqlite3PagerJournalSizeLimit(Pager *pPager, i64 iLimit){
7251 if( iLimit>=-1 ){
7252 pPager->journalSizeLimit = iLimit;
7253 sqlite3WalLimit(pPager->pWal, iLimit);
7254 }
7255 return pPager->journalSizeLimit;
7256 }
7257
7258 /*
7259 ** Return a pointer to the pPager->pBackup variable. The backup module
7260 ** in backup.c maintains the content of this variable. This module
7261 ** uses it opaquely as an argument to sqlite3BackupRestart() and
7262 ** sqlite3BackupUpdate() only.
7263 */
7264 sqlite3_backup **sqlite3PagerBackupPtr(Pager *pPager){
7265 return &pPager->pBackup;
7266 }
7267
7268 #ifndef SQLITE_OMIT_VACUUM
7269 /*
7270 ** Unless this is an in-memory or temporary database, clear the pager cache.
7271 */
7272 void sqlite3PagerClearCache(Pager *pPager){
7273 assert( MEMDB==0 || pPager->tempFile );
7274 if( pPager->tempFile==0 ) pager_reset(pPager);
7275 }
7276 #endif
7277
7278
7279 #ifndef SQLITE_OMIT_WAL
7280 /*
7281 ** This function is called when the user invokes "PRAGMA wal_checkpoint",
7282 ** "PRAGMA wal_blocking_checkpoint" or calls the sqlite3_wal_checkpoint()
7283 ** or wal_blocking_checkpoint() API functions.
7284 **
7285 ** Parameter eMode is one of SQLITE_CHECKPOINT_PASSIVE, FULL or RESTART.
7286 */
7287 int sqlite3PagerCheckpoint(
7288 Pager *pPager, /* Checkpoint on this pager */
7289 sqlite3 *db, /* Db handle used to check for interrupts */
7290 int eMode, /* Type of checkpoint */
7291 int *pnLog, /* OUT: Final number of frames in log */
7292 int *pnCkpt /* OUT: Final number of checkpointed frames */
7293 ){
7294 int rc = SQLITE_OK;
7295 if( pPager->pWal ){
7296 rc = sqlite3WalCheckpoint(pPager->pWal, db, eMode,
7297 (eMode==SQLITE_CHECKPOINT_PASSIVE ? 0 : pPager->xBusyHandler),
7298 pPager->pBusyHandlerArg,
7299 pPager->ckptSyncFlags, pPager->pageSize, (u8 *)pPager->pTmpSpace,
7300 pnLog, pnCkpt
7301 );
7302 }
7303 return rc;
7304 }
7305
7306 int sqlite3PagerWalCallback(Pager *pPager){
7307 return sqlite3WalCallback(pPager->pWal);
7308 }
7309
7310 /*
7311 ** Return true if the underlying VFS for the given pager supports the
7312 ** primitives necessary for write-ahead logging.
7313 */
7314 int sqlite3PagerWalSupported(Pager *pPager){
7315 const sqlite3_io_methods *pMethods = pPager->fd->pMethods;
7316 if( pPager->noLock ) return 0;
7317 return pPager->exclusiveMode || (pMethods->iVersion>=2 && pMethods->xShmMap);
7318 }
7319
7320 /*
7321 ** Attempt to take an exclusive lock on the database file. If a PENDING lock
7322 ** is obtained instead, immediately release it.
7323 */
7324 static int pagerExclusiveLock(Pager *pPager){
7325 int rc; /* Return code */
7326
7327 assert( pPager->eLock==SHARED_LOCK || pPager->eLock==EXCLUSIVE_LOCK );
7328 rc = pagerLockDb(pPager, EXCLUSIVE_LOCK);
7329 if( rc!=SQLITE_OK ){
7330 /* If the attempt to grab the exclusive lock failed, release the
7331 ** pending lock that may have been obtained instead. */
7332 pagerUnlockDb(pPager, SHARED_LOCK);
7333 }
7334
7335 return rc;
7336 }
7337
7338 /*
7339 ** Call sqlite3WalOpen() to open the WAL handle. If the pager is in
7340 ** exclusive-locking mode when this function is called, take an EXCLUSIVE
7341 ** lock on the database file and use heap-memory to store the wal-index
7342 ** in. Otherwise, use the normal shared-memory.
7343 */
7344 static int pagerOpenWal(Pager *pPager){
7345 int rc = SQLITE_OK;
7346
7347 assert( pPager->pWal==0 && pPager->tempFile==0 );
7348 assert( pPager->eLock==SHARED_LOCK || pPager->eLock==EXCLUSIVE_LOCK );
7349
7350 /* If the pager is already in exclusive-mode, the WAL module will use
7351 ** heap-memory for the wal-index instead of the VFS shared-memory
7352 ** implementation. Take the exclusive lock now, before opening the WAL
7353 ** file, to make sure this is safe.
7354 */
7355 if( pPager->exclusiveMode ){
7356 rc = pagerExclusiveLock(pPager);
7357 }
7358
7359 /* Open the connection to the log file. If this operation fails,
7360 ** (e.g. due to malloc() failure), return an error code.
7361 */
7362 if( rc==SQLITE_OK ){
7363 rc = sqlite3WalOpen(pPager->pVfs,
7364 pPager->fd, pPager->zWal, pPager->exclusiveMode,
7365 pPager->journalSizeLimit, &pPager->pWal
7366 );
7367 }
7368 pagerFixMaplimit(pPager);
7369
7370 return rc;
7371 }
7372
7373
7374 /*
7375 ** The caller must be holding a SHARED lock on the database file to call
7376 ** this function.
7377 **
7378 ** If the pager passed as the first argument is open on a real database
7379 ** file (not a temp file or an in-memory database), and the WAL file
7380 ** is not already open, make an attempt to open it now. If successful,
7381 ** return SQLITE_OK. If an error occurs or the VFS used by the pager does
7382 ** not support the xShmXXX() methods, return an error code. *pbOpen is
7383 ** not modified in either case.
7384 **
7385 ** If the pager is open on a temp-file (or in-memory database), or if
7386 ** the WAL file is already open, set *pbOpen to 1 and return SQLITE_OK
7387 ** without doing anything.
7388 */
7389 int sqlite3PagerOpenWal(
7390 Pager *pPager, /* Pager object */
7391 int *pbOpen /* OUT: Set to true if call is a no-op */
7392 ){
7393 int rc = SQLITE_OK; /* Return code */
7394
7395 assert( assert_pager_state(pPager) );
7396 assert( pPager->eState==PAGER_OPEN || pbOpen );
7397 assert( pPager->eState==PAGER_READER || !pbOpen );
7398 assert( pbOpen==0 || *pbOpen==0 );
7399 assert( pbOpen!=0 || (!pPager->tempFile && !pPager->pWal) );
7400
7401 if( !pPager->tempFile && !pPager->pWal ){
7402 if( !sqlite3PagerWalSupported(pPager) ) return SQLITE_CANTOPEN;
7403
7404 /* Close any rollback journal previously open */
7405 sqlite3OsClose(pPager->jfd);
7406
7407 rc = pagerOpenWal(pPager);
7408 if( rc==SQLITE_OK ){
7409 pPager->journalMode = PAGER_JOURNALMODE_WAL;
7410 pPager->eState = PAGER_OPEN;
7411 }
7412 }else{
7413 *pbOpen = 1;
7414 }
7415
7416 return rc;
7417 }
7418
7419 /*
7420 ** This function is called to close the connection to the log file prior
7421 ** to switching from WAL to rollback mode.
7422 **
7423 ** Before closing the log file, this function attempts to take an
7424 ** EXCLUSIVE lock on the database file. If this cannot be obtained, an
7425 ** error (SQLITE_BUSY) is returned and the log connection is not closed.
7426 ** If successful, the EXCLUSIVE lock is not released before returning.
7427 */
7428 int sqlite3PagerCloseWal(Pager *pPager, sqlite3 *db){
7429 int rc = SQLITE_OK;
7430
7431 assert( pPager->journalMode==PAGER_JOURNALMODE_WAL );
7432
7433 /* If the log file is not already open, but does exist in the file-system,
7434 ** it may need to be checkpointed before the connection can switch to
7435 ** rollback mode. Open it now so this can happen.
7436 */
7437 if( !pPager->pWal ){
7438 int logexists = 0;
7439 rc = pagerLockDb(pPager, SHARED_LOCK);
7440 if( rc==SQLITE_OK ){
7441 rc = sqlite3OsAccess(
7442 pPager->pVfs, pPager->zWal, SQLITE_ACCESS_EXISTS, &logexists
7443 );
7444 }
7445 if( rc==SQLITE_OK && logexists ){
7446 rc = pagerOpenWal(pPager);
7447 }
7448 }
7449
7450 /* Checkpoint and close the log. Because an EXCLUSIVE lock is held on
7451 ** the database file, the log and log-summary files will be deleted.
7452 */
7453 if( rc==SQLITE_OK && pPager->pWal ){
7454 rc = pagerExclusiveLock(pPager);
7455 if( rc==SQLITE_OK ){
7456 rc = sqlite3WalClose(pPager->pWal, db, pPager->ckptSyncFlags,
7457 pPager->pageSize, (u8*)pPager->pTmpSpace);
7458 pPager->pWal = 0;
7459 pagerFixMaplimit(pPager);
7460 if( rc && !pPager->exclusiveMode ) pagerUnlockDb(pPager, SHARED_LOCK);
7461 }
7462 }
7463 return rc;
7464 }
7465
7466 #ifdef SQLITE_ENABLE_SNAPSHOT
7467 /*
7468 ** If this is a WAL database, obtain a snapshot handle for the snapshot
7469 ** currently open. Otherwise, return an error.
7470 */
7471 int sqlite3PagerSnapshotGet(Pager *pPager, sqlite3_snapshot **ppSnapshot){
7472 int rc = SQLITE_ERROR;
7473 if( pPager->pWal ){
7474 rc = sqlite3WalSnapshotGet(pPager->pWal, ppSnapshot);
7475 }
7476 return rc;
7477 }
7478
7479 /*
7480 ** If this is a WAL database, store a pointer to pSnapshot. Next time a
7481 ** read transaction is opened, attempt to read from the snapshot it
7482 ** identifies. If this is not a WAL database, return an error.
7483 */
7484 int sqlite3PagerSnapshotOpen(Pager *pPager, sqlite3_snapshot *pSnapshot){
7485 int rc = SQLITE_OK;
7486 if( pPager->pWal ){
7487 sqlite3WalSnapshotOpen(pPager->pWal, pSnapshot);
7488 }else{
7489 rc = SQLITE_ERROR;
7490 }
7491 return rc;
7492 }
7493
7494 /*
7495 ** If this is a WAL database, call sqlite3WalSnapshotRecover(). If this
7496 ** is not a WAL database, return an error.
7497 */
7498 int sqlite3PagerSnapshotRecover(Pager *pPager){
7499 int rc;
7500 if( pPager->pWal ){
7501 rc = sqlite3WalSnapshotRecover(pPager->pWal);
7502 }else{
7503 rc = SQLITE_ERROR;
7504 }
7505 return rc;
7506 }
7507 #endif /* SQLITE_ENABLE_SNAPSHOT */
7508 #endif /* !SQLITE_OMIT_WAL */
7509
7510 #ifdef SQLITE_ENABLE_ZIPVFS
7511 /*
7512 ** A read-lock must be held on the pager when this function is called. If
7513 ** the pager is in WAL mode and the WAL file currently contains one or more
7514 ** frames, return the size in bytes of the page images stored within the
7515 ** WAL frames. Otherwise, if this is not a WAL database or the WAL file
7516 ** is empty, return 0.
7517 */
7518 int sqlite3PagerWalFramesize(Pager *pPager){
7519 assert( pPager->eState>=PAGER_READER );
7520 return sqlite3WalFramesize(pPager->pWal);
7521 }
7522 #endif
7523
7524 #endif /* SQLITE_OMIT_DISKIO */
OLDNEW
« no previous file with comments | « third_party/sqlite/sqlite-src-3170000/src/pager.h ('k') | third_party/sqlite/sqlite-src-3170000/src/parse.y » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698