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