drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1 | /* |
drh | b19a2bc | 2001-09-16 00:13:26 +0000 | [diff] [blame] | 2 | ** 2001 September 15 |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 3 | ** |
drh | b19a2bc | 2001-09-16 00:13:26 +0000 | [diff] [blame] | 4 | ** The author disclaims copyright to this source code. In place of |
| 5 | ** a legal notice, here is a blessing: |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 6 | ** |
drh | b19a2bc | 2001-09-16 00:13:26 +0000 | [diff] [blame] | 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. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 10 | ** |
| 11 | ************************************************************************* |
drh | b19a2bc | 2001-09-16 00:13:26 +0000 | [diff] [blame] | 12 | ** This is the implementation of the page cache subsystem or "pager". |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 13 | ** |
drh | b19a2bc | 2001-09-16 00:13:26 +0000 | [diff] [blame] | 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. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 20 | ** |
drh | c047b9f | 2008-11-21 03:23:43 +0000 | [diff] [blame^] | 21 | ** @(#) $Id: pager.c,v 1.507 2008/11/21 03:23:43 drh Exp $ |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 22 | */ |
drh | 2e66f0b | 2005-04-28 17:18:48 +0000 | [diff] [blame] | 23 | #ifndef SQLITE_OMIT_DISKIO |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 24 | #include "sqliteInt.h" |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 25 | |
| 26 | /* |
drh | db48ee0 | 2003-01-16 13:42:43 +0000 | [diff] [blame] | 27 | ** Macros for troubleshooting. Normally turned off |
| 28 | */ |
danielk1977 | 466be56 | 2004-06-10 02:16:01 +0000 | [diff] [blame] | 29 | #if 0 |
drh | d3627af | 2006-12-18 18:34:51 +0000 | [diff] [blame] | 30 | #define sqlite3DebugPrintf printf |
drh | 4f0c587 | 2007-03-26 22:05:01 +0000 | [diff] [blame] | 31 | #define PAGERTRACE1(X) sqlite3DebugPrintf(X) |
| 32 | #define PAGERTRACE2(X,Y) sqlite3DebugPrintf(X,Y) |
| 33 | #define PAGERTRACE3(X,Y,Z) sqlite3DebugPrintf(X,Y,Z) |
| 34 | #define PAGERTRACE4(X,Y,Z,W) sqlite3DebugPrintf(X,Y,Z,W) |
| 35 | #define PAGERTRACE5(X,Y,Z,W,V) sqlite3DebugPrintf(X,Y,Z,W,V) |
drh | db48ee0 | 2003-01-16 13:42:43 +0000 | [diff] [blame] | 36 | #else |
drh | 4f0c587 | 2007-03-26 22:05:01 +0000 | [diff] [blame] | 37 | #define PAGERTRACE1(X) |
| 38 | #define PAGERTRACE2(X,Y) |
| 39 | #define PAGERTRACE3(X,Y,Z) |
| 40 | #define PAGERTRACE4(X,Y,Z,W) |
| 41 | #define PAGERTRACE5(X,Y,Z,W,V) |
drh | db48ee0 | 2003-01-16 13:42:43 +0000 | [diff] [blame] | 42 | #endif |
| 43 | |
danielk1977 | 599fcba | 2004-11-08 07:13:13 +0000 | [diff] [blame] | 44 | /* |
drh | 4f0c587 | 2007-03-26 22:05:01 +0000 | [diff] [blame] | 45 | ** The following two macros are used within the PAGERTRACEX() macros above |
drh | d86959f | 2005-11-26 03:51:18 +0000 | [diff] [blame] | 46 | ** to print out file-descriptors. |
danielk1977 | 599fcba | 2004-11-08 07:13:13 +0000 | [diff] [blame] | 47 | ** |
drh | 85b623f | 2007-12-13 21:54:09 +0000 | [diff] [blame] | 48 | ** PAGERID() takes a pointer to a Pager struct as its argument. The |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 49 | ** associated file-descriptor is returned. FILEHANDLEID() takes an sqlite3_file |
drh | 85b623f | 2007-12-13 21:54:09 +0000 | [diff] [blame] | 50 | ** struct as its argument. |
danielk1977 | 599fcba | 2004-11-08 07:13:13 +0000 | [diff] [blame] | 51 | */ |
drh | c001c58 | 2006-03-06 18:23:16 +0000 | [diff] [blame] | 52 | #define PAGERID(p) ((int)(p->fd)) |
| 53 | #define FILEHANDLEID(fd) ((int)fd) |
drh | db48ee0 | 2003-01-16 13:42:43 +0000 | [diff] [blame] | 54 | |
| 55 | /* |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 56 | ** The page cache as a whole is always in one of the following |
| 57 | ** states: |
| 58 | ** |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 59 | ** PAGER_UNLOCK The page cache is not currently reading or |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 60 | ** writing the database file. There is no |
| 61 | ** data held in memory. This is the initial |
| 62 | ** state. |
| 63 | ** |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 64 | ** PAGER_SHARED The page cache is reading the database. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 65 | ** Writing is not permitted. There can be |
| 66 | ** multiple readers accessing the same database |
drh | 69688d5 | 2001-04-14 16:38:23 +0000 | [diff] [blame] | 67 | ** file at the same time. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 68 | ** |
drh | 726de59 | 2004-06-10 23:35:50 +0000 | [diff] [blame] | 69 | ** PAGER_RESERVED This process has reserved the database for writing |
| 70 | ** but has not yet made any changes. Only one process |
| 71 | ** at a time can reserve the database. The original |
| 72 | ** database file has not been modified so other |
| 73 | ** processes may still be reading the on-disk |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 74 | ** database file. |
| 75 | ** |
| 76 | ** PAGER_EXCLUSIVE The page cache is writing the database. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 77 | ** Access is exclusive. No other processes or |
| 78 | ** threads can be reading or writing while one |
| 79 | ** process is writing. |
| 80 | ** |
danielk1977 | aa5ccdf | 2004-06-14 05:10:42 +0000 | [diff] [blame] | 81 | ** PAGER_SYNCED The pager moves to this state from PAGER_EXCLUSIVE |
| 82 | ** after all dirty pages have been written to the |
| 83 | ** database file and the file has been synced to |
drh | 369339d | 2007-03-30 16:01:55 +0000 | [diff] [blame] | 84 | ** disk. All that remains to do is to remove or |
| 85 | ** truncate the journal file and the transaction |
| 86 | ** will be committed. |
danielk1977 | aa5ccdf | 2004-06-14 05:10:42 +0000 | [diff] [blame] | 87 | ** |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 88 | ** The page cache comes up in PAGER_UNLOCK. The first time a |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 89 | ** sqlite3PagerGet() occurs, the state transitions to PAGER_SHARED. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 90 | ** After all pages have been released using sqlite_page_unref(), |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 91 | ** the state transitions back to PAGER_UNLOCK. The first time |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 92 | ** that sqlite3PagerWrite() is called, the state transitions to |
drh | 369339d | 2007-03-30 16:01:55 +0000 | [diff] [blame] | 93 | ** PAGER_RESERVED. (Note that sqlite3PagerWrite() can only be |
drh | 306dc21 | 2001-05-21 13:45:10 +0000 | [diff] [blame] | 94 | ** called on an outstanding page which means that the pager must |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 95 | ** be in PAGER_SHARED before it transitions to PAGER_RESERVED.) |
drh | 369339d | 2007-03-30 16:01:55 +0000 | [diff] [blame] | 96 | ** PAGER_RESERVED means that there is an open rollback journal. |
| 97 | ** The transition to PAGER_EXCLUSIVE occurs before any changes |
| 98 | ** are made to the database file, though writes to the rollback |
| 99 | ** journal occurs with just PAGER_RESERVED. After an sqlite3PagerRollback() |
| 100 | ** or sqlite3PagerCommitPhaseTwo(), the state can go back to PAGER_SHARED, |
| 101 | ** or it can stay at PAGER_EXCLUSIVE if we are in exclusive access mode. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 102 | */ |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 103 | #define PAGER_UNLOCK 0 |
drh | 684917c | 2004-10-05 02:41:42 +0000 | [diff] [blame] | 104 | #define PAGER_SHARED 1 /* same as SHARED_LOCK */ |
| 105 | #define PAGER_RESERVED 2 /* same as RESERVED_LOCK */ |
| 106 | #define PAGER_EXCLUSIVE 4 /* same as EXCLUSIVE_LOCK */ |
| 107 | #define PAGER_SYNCED 5 |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 108 | |
drh | 684917c | 2004-10-05 02:41:42 +0000 | [diff] [blame] | 109 | /* |
| 110 | ** If the SQLITE_BUSY_RESERVED_LOCK macro is set to true at compile-time, |
| 111 | ** then failed attempts to get a reserved lock will invoke the busy callback. |
| 112 | ** This is off by default. To see why, consider the following scenario: |
| 113 | ** |
| 114 | ** Suppose thread A already has a shared lock and wants a reserved lock. |
| 115 | ** Thread B already has a reserved lock and wants an exclusive lock. If |
| 116 | ** both threads are using their busy callbacks, it might be a long time |
| 117 | ** be for one of the threads give up and allows the other to proceed. |
| 118 | ** But if the thread trying to get the reserved lock gives up quickly |
| 119 | ** (if it never invokes its busy callback) then the contention will be |
| 120 | ** resolved quickly. |
| 121 | */ |
| 122 | #ifndef SQLITE_BUSY_RESERVED_LOCK |
| 123 | # define SQLITE_BUSY_RESERVED_LOCK 0 |
| 124 | #endif |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 125 | |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 126 | /* |
drh | 887dc4c | 2004-10-22 16:22:57 +0000 | [diff] [blame] | 127 | ** This macro rounds values up so that if the value is an address it |
| 128 | ** is guaranteed to be an address that is aligned to an 8-byte boundary. |
| 129 | */ |
| 130 | #define FORCE_ALIGNMENT(X) (((X)+7)&~7) |
| 131 | |
drh | 9eb9e26 | 2004-02-11 02:18:05 +0000 | [diff] [blame] | 132 | /* |
| 133 | ** A macro used for invoking the codec if there is one |
| 134 | */ |
| 135 | #ifdef SQLITE_HAS_CODEC |
drh | c001c58 | 2006-03-06 18:23:16 +0000 | [diff] [blame] | 136 | # define CODEC1(P,D,N,X) if( P->xCodec!=0 ){ P->xCodec(P->pCodecArg,D,N,X); } |
| 137 | # define CODEC2(P,D,N,X) ((char*)(P->xCodec!=0?P->xCodec(P->pCodecArg,D,N,X):D)) |
drh | 9eb9e26 | 2004-02-11 02:18:05 +0000 | [diff] [blame] | 138 | #else |
drh | c001c58 | 2006-03-06 18:23:16 +0000 | [diff] [blame] | 139 | # define CODEC1(P,D,N,X) /* NO-OP */ |
| 140 | # define CODEC2(P,D,N,X) ((char*)D) |
drh | 9eb9e26 | 2004-02-11 02:18:05 +0000 | [diff] [blame] | 141 | #endif |
| 142 | |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 143 | /* |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 144 | ** A open page cache is an instance of the following structure. |
danielk1977 | efaaf57 | 2006-01-16 11:29:19 +0000 | [diff] [blame] | 145 | ** |
drh | 4f0ee68 | 2007-03-30 20:43:40 +0000 | [diff] [blame] | 146 | ** Pager.errCode may be set to SQLITE_IOERR, SQLITE_CORRUPT, or |
danielk1977 | efaaf57 | 2006-01-16 11:29:19 +0000 | [diff] [blame] | 147 | ** or SQLITE_FULL. Once one of the first three errors occurs, it persists |
| 148 | ** and is returned as the result of every major pager API call. The |
| 149 | ** SQLITE_FULL return code is slightly different. It persists only until the |
| 150 | ** next successful rollback is performed on the pager cache. Also, |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 151 | ** SQLITE_FULL does not affect the sqlite3PagerGet() and sqlite3PagerLookup() |
danielk1977 | efaaf57 | 2006-01-16 11:29:19 +0000 | [diff] [blame] | 152 | ** APIs, they may still be used successfully. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 153 | */ |
| 154 | struct Pager { |
danielk1977 | b4b4741 | 2007-08-17 15:53:36 +0000 | [diff] [blame] | 155 | sqlite3_vfs *pVfs; /* OS functions to use for IO */ |
drh | 603240c | 2002-03-05 01:11:12 +0000 | [diff] [blame] | 156 | u8 journalOpen; /* True if journal file descriptors is valid */ |
drh | 34e79ce | 2004-02-08 06:05:46 +0000 | [diff] [blame] | 157 | u8 journalStarted; /* True if header of journal is synced */ |
| 158 | u8 useJournal; /* Use a rollback journal on this file */ |
drh | 7bec505 | 2005-02-06 02:45:41 +0000 | [diff] [blame] | 159 | u8 noReadlock; /* Do not bother to obtain readlocks */ |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 160 | u8 stmtOpen; /* True if the statement subjournal is open */ |
| 161 | u8 stmtInUse; /* True we are in a statement subtransaction */ |
| 162 | u8 stmtAutoopen; /* Open stmt journal when main journal is opened*/ |
drh | 603240c | 2002-03-05 01:11:12 +0000 | [diff] [blame] | 163 | u8 noSync; /* Do not sync the journal if true */ |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 164 | u8 fullSync; /* Do extra syncs of the journal for robustness */ |
danielk1977 | f036aef | 2007-08-20 05:36:51 +0000 | [diff] [blame] | 165 | u8 sync_flags; /* One of SYNC_NORMAL or SYNC_FULL */ |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 166 | u8 state; /* PAGER_UNLOCK, _SHARED, _RESERVED, etc. */ |
drh | 603240c | 2002-03-05 01:11:12 +0000 | [diff] [blame] | 167 | u8 tempFile; /* zFilename is a temporary file */ |
| 168 | u8 readOnly; /* True for a read-only database */ |
| 169 | u8 needSync; /* True if an fsync() is needed on the journal */ |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 170 | u8 dirtyCache; /* True if cached pages have changed */ |
drh | 80e35f4 | 2007-03-30 14:06:34 +0000 | [diff] [blame] | 171 | u8 alwaysRollback; /* Disable DontRollback() for all pages */ |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 172 | u8 memDb; /* True to inhibit all file I/O */ |
drh | 6d156e4 | 2005-05-20 20:11:20 +0000 | [diff] [blame] | 173 | u8 setMaster; /* True if a m-j name has been written to jrnl */ |
drh | 80e35f4 | 2007-03-30 14:06:34 +0000 | [diff] [blame] | 174 | u8 doNotSync; /* Boolean. While true, do not spill the cache */ |
| 175 | u8 exclusiveMode; /* Boolean. True if locking_mode==EXCLUSIVE */ |
drh | fdc40e9 | 2008-04-17 20:59:37 +0000 | [diff] [blame] | 176 | u8 journalMode; /* On of the PAGER_JOURNALMODE_* values */ |
drh | d138c01 | 2008-05-13 00:58:18 +0000 | [diff] [blame] | 177 | u8 dbModified; /* True if there are any changes to the Db */ |
drh | 80e35f4 | 2007-03-30 14:06:34 +0000 | [diff] [blame] | 178 | u8 changeCountDone; /* Set after incrementing the change-counter */ |
danielk1977 | d92db53 | 2008-11-17 04:56:24 +0000 | [diff] [blame] | 179 | u8 dbSizeValid; /* Set when dbSize is correct */ |
drh | 33f4e02 | 2007-09-03 15:19:34 +0000 | [diff] [blame] | 180 | u32 vfsFlags; /* Flags for sqlite3_vfs.xOpen() */ |
drh | e49f982 | 2006-09-15 12:29:16 +0000 | [diff] [blame] | 181 | int errCode; /* One of several kinds of errors */ |
danielk1977 | d92db53 | 2008-11-17 04:56:24 +0000 | [diff] [blame] | 182 | Pgno dbSize; /* Number of pages in the file */ |
| 183 | Pgno origDbSize; /* dbSize before the current change */ |
| 184 | Pgno stmtSize; /* Size of database (in pages) at stmt_begin() */ |
drh | fcd35c7 | 2005-05-21 02:48:08 +0000 | [diff] [blame] | 185 | int nRec; /* Number of pages written to the journal */ |
| 186 | u32 cksumInit; /* Quasi-random value added to every checksum */ |
| 187 | int stmtNRec; /* Number of records in stmt subjournal */ |
| 188 | int nExtra; /* Add this many bytes to each in-memory page */ |
| 189 | int pageSize; /* Number of bytes in a page */ |
| 190 | int nPage; /* Total number of in-memory pages */ |
drh | fcd35c7 | 2005-05-21 02:48:08 +0000 | [diff] [blame] | 191 | int mxPage; /* Maximum number of pages to hold in cache */ |
drh | f8e632b | 2007-05-08 14:51:36 +0000 | [diff] [blame] | 192 | Pgno mxPgno; /* Maximum allowed size of the database */ |
drh | f5e7bb5 | 2008-02-18 14:47:33 +0000 | [diff] [blame] | 193 | Bitvec *pInJournal; /* One bit for each page in the database file */ |
| 194 | Bitvec *pInStmt; /* One bit for each page in the database */ |
danielk1977 | a1fa00d | 2008-08-27 15:16:33 +0000 | [diff] [blame] | 195 | Bitvec *pAlwaysRollback; /* One bit for each page marked always-rollback */ |
drh | fcd35c7 | 2005-05-21 02:48:08 +0000 | [diff] [blame] | 196 | char *zFilename; /* Name of the database file */ |
| 197 | char *zJournal; /* Name of the journal file */ |
| 198 | char *zDirectory; /* Directory hold database and journal files */ |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 199 | sqlite3_file *fd, *jfd; /* File descriptors for database and journal */ |
| 200 | sqlite3_file *stfd; /* File descriptor for the statement subjournal*/ |
danielk1977 | 1ceedd3 | 2008-11-19 10:22:33 +0000 | [diff] [blame] | 201 | int (*xBusyHandler)(void*); /* Function to call when busy */ |
| 202 | void *pBusyHandlerArg; /* Context argument for xBusyHandler */ |
drh | eb20625 | 2004-10-01 02:00:31 +0000 | [diff] [blame] | 203 | i64 journalOff; /* Current byte offset in the journal file */ |
| 204 | i64 journalHdr; /* Byte offset to previous journal header */ |
| 205 | i64 stmtHdrOff; /* First journal header written this statement */ |
| 206 | i64 stmtCksum; /* cksumInit when statement was started */ |
drh | 6d156e4 | 2005-05-20 20:11:20 +0000 | [diff] [blame] | 207 | i64 stmtJSize; /* Size of journal at stmt_begin() */ |
drh | 98c5835 | 2008-11-07 00:24:53 +0000 | [diff] [blame] | 208 | u32 sectorSize; /* Assumed sector size during rollback */ |
drh | fcd35c7 | 2005-05-21 02:48:08 +0000 | [diff] [blame] | 209 | #ifdef SQLITE_TEST |
drh | 7c4ac0c | 2007-04-05 11:25:58 +0000 | [diff] [blame] | 210 | int nHit, nMiss; /* Cache hits and missing */ |
| 211 | int nRead, nWrite; /* Database pages read/written */ |
drh | fcd35c7 | 2005-05-21 02:48:08 +0000 | [diff] [blame] | 212 | #endif |
danielk1977 | eaa06f6 | 2008-09-18 17:34:44 +0000 | [diff] [blame] | 213 | void (*xReiniter)(DbPage*); /* Call this routine when reloading pages */ |
drh | 7c4ac0c | 2007-04-05 11:25:58 +0000 | [diff] [blame] | 214 | #ifdef SQLITE_HAS_CODEC |
drh | c001c58 | 2006-03-06 18:23:16 +0000 | [diff] [blame] | 215 | void *(*xCodec)(void*,void*,Pgno,int); /* Routine for en/decoding data */ |
drh | 6d156e4 | 2005-05-20 20:11:20 +0000 | [diff] [blame] | 216 | void *pCodecArg; /* First argument to xCodec() */ |
drh | 7c4ac0c | 2007-04-05 11:25:58 +0000 | [diff] [blame] | 217 | #endif |
danielk1977 | 8186df8 | 2007-03-06 13:45:59 +0000 | [diff] [blame] | 218 | char *pTmpSpace; /* Pager.pageSize bytes of space for tmp use */ |
drh | 86a8811 | 2007-04-16 15:02:19 +0000 | [diff] [blame] | 219 | char dbFileVers[16]; /* Changes whenever database file changes */ |
danielk1977 | b53e496 | 2008-06-04 06:45:59 +0000 | [diff] [blame] | 220 | i64 journalSizeLimit; /* Size limit for persistent journal files */ |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 221 | PCache *pPCache; /* Pointer to page cache object */ |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 222 | }; |
| 223 | |
| 224 | /* |
drh | 538f570 | 2007-04-13 02:14:30 +0000 | [diff] [blame] | 225 | ** The following global variables hold counters used for |
| 226 | ** testing purposes only. These variables do not exist in |
| 227 | ** a non-testing build. These variables are not thread-safe. |
drh | fcd35c7 | 2005-05-21 02:48:08 +0000 | [diff] [blame] | 228 | */ |
| 229 | #ifdef SQLITE_TEST |
drh | 538f570 | 2007-04-13 02:14:30 +0000 | [diff] [blame] | 230 | int sqlite3_pager_readdb_count = 0; /* Number of full pages read from DB */ |
| 231 | int sqlite3_pager_writedb_count = 0; /* Number of full pages written to DB */ |
| 232 | int sqlite3_pager_writej_count = 0; /* Number of pages written to journal */ |
drh | 538f570 | 2007-04-13 02:14:30 +0000 | [diff] [blame] | 233 | # define PAGER_INCR(v) v++ |
drh | fcd35c7 | 2005-05-21 02:48:08 +0000 | [diff] [blame] | 234 | #else |
drh | 538f570 | 2007-04-13 02:14:30 +0000 | [diff] [blame] | 235 | # define PAGER_INCR(v) |
drh | fcd35c7 | 2005-05-21 02:48:08 +0000 | [diff] [blame] | 236 | #endif |
| 237 | |
drh | 538f570 | 2007-04-13 02:14:30 +0000 | [diff] [blame] | 238 | |
| 239 | |
drh | fcd35c7 | 2005-05-21 02:48:08 +0000 | [diff] [blame] | 240 | /* |
drh | 5e00f6c | 2001-09-13 13:46:56 +0000 | [diff] [blame] | 241 | ** Journal files begin with the following magic string. The data |
| 242 | ** was obtained from /dev/random. It is used only as a sanity check. |
drh | 94f3331 | 2002-08-12 12:29:56 +0000 | [diff] [blame] | 243 | ** |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 244 | ** Since version 2.8.0, the journal format contains additional sanity |
| 245 | ** checking information. If the power fails while the journal is begin |
| 246 | ** written, semi-random garbage data might appear in the journal |
| 247 | ** file after power is restored. If an attempt is then made |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 248 | ** to roll the journal back, the database could be corrupted. The additional |
| 249 | ** sanity checking data is an attempt to discover the garbage in the |
| 250 | ** journal and ignore it. |
| 251 | ** |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 252 | ** The sanity checking information for the new journal format consists |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 253 | ** of a 32-bit checksum on each page of data. The checksum covers both |
drh | 90f5ecb | 2004-07-22 01:19:35 +0000 | [diff] [blame] | 254 | ** the page number and the pPager->pageSize bytes of data for the page. |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 255 | ** This cksum is initialized to a 32-bit random value that appears in the |
| 256 | ** journal file right after the header. The random initializer is important, |
| 257 | ** because garbage data that appears at the end of a journal is likely |
| 258 | ** data that was once in other files that have now been deleted. If the |
| 259 | ** garbage data came from an obsolete journal file, the checksums might |
| 260 | ** be correct. But by initializing the checksum to random value which |
| 261 | ** is different for every journal, we minimize that risk. |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 262 | */ |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 263 | static const unsigned char aJournalMagic[] = { |
| 264 | 0xd9, 0xd5, 0x05, 0xf9, 0x20, 0xa1, 0x63, 0xd7, |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 265 | }; |
| 266 | |
| 267 | /* |
drh | 726de59 | 2004-06-10 23:35:50 +0000 | [diff] [blame] | 268 | ** The size of the header and of each page in the journal is determined |
| 269 | ** by the following macros. |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 270 | */ |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 271 | #define JOURNAL_PG_SZ(pPager) ((pPager->pageSize) + 8) |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 272 | |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 273 | /* |
| 274 | ** The journal header size for this pager. In the future, this could be |
| 275 | ** set to some value read from the disk controller. The important |
| 276 | ** characteristic is that it is the same size as a disk sector. |
| 277 | */ |
| 278 | #define JOURNAL_HDR_SZ(pPager) (pPager->sectorSize) |
| 279 | |
drh | b7f9164 | 2004-10-31 02:22:47 +0000 | [diff] [blame] | 280 | /* |
| 281 | ** The macro MEMDB is true if we are dealing with an in-memory database. |
| 282 | ** We do this as a macro so that if the SQLITE_OMIT_MEMORYDB macro is set, |
| 283 | ** the value of MEMDB will be a constant and the compiler will optimize |
| 284 | ** out code that would never execute. |
| 285 | */ |
| 286 | #ifdef SQLITE_OMIT_MEMORYDB |
| 287 | # define MEMDB 0 |
| 288 | #else |
| 289 | # define MEMDB pPager->memDb |
| 290 | #endif |
| 291 | |
| 292 | /* |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 293 | ** Page number PAGER_MJ_PGNO is never used in an SQLite database (it is |
| 294 | ** reserved for working around a windows/posix incompatibility). It is |
| 295 | ** used in the journal to signify that the remainder of the journal file |
| 296 | ** is devoted to storing a master journal name - there are no more pages to |
| 297 | ** roll back. See comments for function writeMasterJournal() for details. |
| 298 | */ |
danielk1977 | 599fcba | 2004-11-08 07:13:13 +0000 | [diff] [blame] | 299 | /* #define PAGER_MJ_PGNO(x) (PENDING_BYTE/((x)->pageSize)) */ |
danielk1977 | d92db53 | 2008-11-17 04:56:24 +0000 | [diff] [blame] | 300 | #define PAGER_MJ_PGNO(x) ((Pgno)((PENDING_BYTE/((x)->pageSize))+1)) |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 301 | |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 302 | /* |
danielk1977 | 2683665 | 2005-01-17 01:33:13 +0000 | [diff] [blame] | 303 | ** The maximum legal page number is (2^31 - 1). |
| 304 | */ |
| 305 | #define PAGER_MAX_PGNO 2147483647 |
| 306 | |
| 307 | /* |
danielk1977 | f35843b | 2007-04-07 15:03:17 +0000 | [diff] [blame] | 308 | ** Return true if page *pPg has already been written to the statement |
| 309 | ** journal (or statement snapshot has been created, if *pPg is part |
| 310 | ** of an in-memory database). |
| 311 | */ |
| 312 | static int pageInStatement(PgHdr *pPg){ |
| 313 | Pager *pPager = pPg->pPager; |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 314 | return sqlite3BitvecTest(pPager->pInStmt, pPg->pgno); |
danielk1977 | f35843b | 2007-04-07 15:03:17 +0000 | [diff] [blame] | 315 | } |
drh | 8ca0c72 | 2006-05-07 17:49:38 +0000 | [diff] [blame] | 316 | |
danielk1977 | bc2ca9e | 2008-11-13 14:28:28 +0000 | [diff] [blame] | 317 | static int pageInJournal(PgHdr *pPg){ |
| 318 | return sqlite3BitvecTest(pPg->pPager->pInJournal, pPg->pgno); |
| 319 | } |
| 320 | |
drh | 8ca0c72 | 2006-05-07 17:49:38 +0000 | [diff] [blame] | 321 | /* |
drh | 34e79ce | 2004-02-08 06:05:46 +0000 | [diff] [blame] | 322 | ** Read a 32-bit integer from the given file descriptor. Store the integer |
| 323 | ** that is read in *pRes. Return SQLITE_OK if everything worked, or an |
| 324 | ** error code is something goes wrong. |
drh | 726de59 | 2004-06-10 23:35:50 +0000 | [diff] [blame] | 325 | ** |
| 326 | ** All values are stored on disk as big-endian. |
drh | 94f3331 | 2002-08-12 12:29:56 +0000 | [diff] [blame] | 327 | */ |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 328 | static int read32bits(sqlite3_file *fd, i64 offset, u32 *pRes){ |
drh | 3b59a5c | 2006-01-15 20:28:28 +0000 | [diff] [blame] | 329 | unsigned char ac[4]; |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 330 | int rc = sqlite3OsRead(fd, ac, sizeof(ac), offset); |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 331 | if( rc==SQLITE_OK ){ |
drh | a315289 | 2007-05-05 11:48:52 +0000 | [diff] [blame] | 332 | *pRes = sqlite3Get4byte(ac); |
drh | 94f3331 | 2002-08-12 12:29:56 +0000 | [diff] [blame] | 333 | } |
drh | 94f3331 | 2002-08-12 12:29:56 +0000 | [diff] [blame] | 334 | return rc; |
| 335 | } |
| 336 | |
| 337 | /* |
drh | 97b5748 | 2006-01-10 20:32:32 +0000 | [diff] [blame] | 338 | ** Write a 32-bit integer into a string buffer in big-endian byte order. |
| 339 | */ |
drh | a315289 | 2007-05-05 11:48:52 +0000 | [diff] [blame] | 340 | #define put32bits(A,B) sqlite3Put4byte((u8*)A,B) |
drh | 97b5748 | 2006-01-10 20:32:32 +0000 | [diff] [blame] | 341 | |
| 342 | /* |
drh | 34e79ce | 2004-02-08 06:05:46 +0000 | [diff] [blame] | 343 | ** Write a 32-bit integer into the given file descriptor. Return SQLITE_OK |
| 344 | ** on success or an error code is something goes wrong. |
drh | 94f3331 | 2002-08-12 12:29:56 +0000 | [diff] [blame] | 345 | */ |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 346 | static int write32bits(sqlite3_file *fd, i64 offset, u32 val){ |
danielk1977 | bab45c6 | 2006-01-16 15:14:27 +0000 | [diff] [blame] | 347 | char ac[4]; |
drh | 97b5748 | 2006-01-10 20:32:32 +0000 | [diff] [blame] | 348 | put32bits(ac, val); |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 349 | return sqlite3OsWrite(fd, ac, 4, offset); |
drh | 94f3331 | 2002-08-12 12:29:56 +0000 | [diff] [blame] | 350 | } |
| 351 | |
drh | 2554f8b | 2003-01-22 01:26:44 +0000 | [diff] [blame] | 352 | /* |
danielk1977 | 7a2b1ee | 2007-08-21 14:27:01 +0000 | [diff] [blame] | 353 | ** If file pFd is open, call sqlite3OsUnlock() on it. |
| 354 | */ |
| 355 | static int osUnlock(sqlite3_file *pFd, int eLock){ |
| 356 | if( !pFd->pMethods ){ |
| 357 | return SQLITE_OK; |
| 358 | } |
| 359 | return sqlite3OsUnlock(pFd, eLock); |
| 360 | } |
| 361 | |
| 362 | /* |
danielk1977 | c7b6017 | 2007-08-22 11:22:03 +0000 | [diff] [blame] | 363 | ** This function determines whether or not the atomic-write optimization |
| 364 | ** can be used with this pager. The optimization can be used if: |
| 365 | ** |
| 366 | ** (a) the value returned by OsDeviceCharacteristics() indicates that |
| 367 | ** a database page may be written atomically, and |
| 368 | ** (b) the value returned by OsSectorSize() is less than or equal |
| 369 | ** to the page size. |
| 370 | ** |
| 371 | ** If the optimization cannot be used, 0 is returned. If it can be used, |
| 372 | ** then the value returned is the size of the journal file when it |
| 373 | ** contains rollback data for exactly one page. |
| 374 | */ |
| 375 | #ifdef SQLITE_ENABLE_ATOMIC_WRITE |
| 376 | static int jrnlBufferSize(Pager *pPager){ |
| 377 | int dc; /* Device characteristics */ |
| 378 | int nSector; /* Sector size */ |
drh | facf030 | 2008-06-17 15:12:00 +0000 | [diff] [blame] | 379 | int szPage; /* Page size */ |
danielk1977 | c7b6017 | 2007-08-22 11:22:03 +0000 | [diff] [blame] | 380 | sqlite3_file *fd = pPager->fd; |
| 381 | |
| 382 | if( fd->pMethods ){ |
| 383 | dc = sqlite3OsDeviceCharacteristics(fd); |
| 384 | nSector = sqlite3OsSectorSize(fd); |
drh | facf030 | 2008-06-17 15:12:00 +0000 | [diff] [blame] | 385 | szPage = pPager->pageSize; |
danielk1977 | c7b6017 | 2007-08-22 11:22:03 +0000 | [diff] [blame] | 386 | } |
| 387 | |
| 388 | assert(SQLITE_IOCAP_ATOMIC512==(512>>8)); |
| 389 | assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8)); |
| 390 | |
drh | facf030 | 2008-06-17 15:12:00 +0000 | [diff] [blame] | 391 | if( !fd->pMethods || |
| 392 | (dc & (SQLITE_IOCAP_ATOMIC|(szPage>>8)) && nSector<=szPage) ){ |
danielk1977 | c7b6017 | 2007-08-22 11:22:03 +0000 | [diff] [blame] | 393 | return JOURNAL_HDR_SZ(pPager) + JOURNAL_PG_SZ(pPager); |
| 394 | } |
| 395 | return 0; |
| 396 | } |
| 397 | #endif |
| 398 | |
| 399 | /* |
danielk1977 | aef0bf6 | 2005-12-30 16:28:01 +0000 | [diff] [blame] | 400 | ** This function should be called when an error occurs within the pager |
danielk1977 | a96a710 | 2006-01-16 12:46:41 +0000 | [diff] [blame] | 401 | ** code. The first argument is a pointer to the pager structure, the |
| 402 | ** second the error-code about to be returned by a pager API function. |
| 403 | ** The value returned is a copy of the second argument to this function. |
| 404 | ** |
drh | 4f0ee68 | 2007-03-30 20:43:40 +0000 | [diff] [blame] | 405 | ** If the second argument is SQLITE_IOERR, SQLITE_CORRUPT, or SQLITE_FULL |
danielk1977 | ae72d98 | 2007-10-03 08:46:44 +0000 | [diff] [blame] | 406 | ** the error becomes persistent. Until the persisten error is cleared, |
| 407 | ** subsequent API calls on this Pager will immediately return the same |
| 408 | ** error code. |
| 409 | ** |
| 410 | ** A persistent error indicates that the contents of the pager-cache |
| 411 | ** cannot be trusted. This state can be cleared by completely discarding |
| 412 | ** the contents of the pager-cache. If a transaction was active when |
| 413 | ** the persistent error occured, then the rollback journal may need |
| 414 | ** to be replayed. |
danielk1977 | aef0bf6 | 2005-12-30 16:28:01 +0000 | [diff] [blame] | 415 | */ |
danielk1977 | ae72d98 | 2007-10-03 08:46:44 +0000 | [diff] [blame] | 416 | static void pager_unlock(Pager *pPager); |
danielk1977 | aef0bf6 | 2005-12-30 16:28:01 +0000 | [diff] [blame] | 417 | static int pager_error(Pager *pPager, int rc){ |
drh | 4ac285a | 2006-09-15 07:28:50 +0000 | [diff] [blame] | 418 | int rc2 = rc & 0xff; |
drh | 34f5621 | 2007-08-10 23:56:35 +0000 | [diff] [blame] | 419 | assert( |
| 420 | pPager->errCode==SQLITE_FULL || |
| 421 | pPager->errCode==SQLITE_OK || |
| 422 | (pPager->errCode & 0xff)==SQLITE_IOERR |
| 423 | ); |
danielk1977 | 979f38e | 2007-03-27 16:19:51 +0000 | [diff] [blame] | 424 | if( |
drh | 4ac285a | 2006-09-15 07:28:50 +0000 | [diff] [blame] | 425 | rc2==SQLITE_FULL || |
| 426 | rc2==SQLITE_IOERR || |
drh | 4f0ee68 | 2007-03-30 20:43:40 +0000 | [diff] [blame] | 427 | rc2==SQLITE_CORRUPT |
danielk1977 | efaaf57 | 2006-01-16 11:29:19 +0000 | [diff] [blame] | 428 | ){ |
| 429 | pPager->errCode = rc; |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 430 | if( pPager->state==PAGER_UNLOCK |
| 431 | && sqlite3PcacheRefCount(pPager->pPCache)==0 |
| 432 | ){ |
danielk1977 | ae72d98 | 2007-10-03 08:46:44 +0000 | [diff] [blame] | 433 | /* If the pager is already unlocked, call pager_unlock() now to |
| 434 | ** clear the error state and ensure that the pager-cache is |
| 435 | ** completely empty. |
| 436 | */ |
| 437 | pager_unlock(pPager); |
| 438 | } |
danielk1977 | aef0bf6 | 2005-12-30 16:28:01 +0000 | [diff] [blame] | 439 | } |
| 440 | return rc; |
| 441 | } |
| 442 | |
drh | 477731b | 2007-06-16 03:06:27 +0000 | [diff] [blame] | 443 | /* |
| 444 | ** If SQLITE_CHECK_PAGES is defined then we do some sanity checking |
| 445 | ** on the cache using a hash function. This is used for testing |
| 446 | ** and debugging only. |
| 447 | */ |
danielk1977 | 3c40737 | 2005-02-15 02:54:14 +0000 | [diff] [blame] | 448 | #ifdef SQLITE_CHECK_PAGES |
| 449 | /* |
| 450 | ** Return a 32-bit hash of the page data for pPage. |
| 451 | */ |
drh | 477731b | 2007-06-16 03:06:27 +0000 | [diff] [blame] | 452 | static u32 pager_datahash(int nByte, unsigned char *pData){ |
danielk1977 | 3c40737 | 2005-02-15 02:54:14 +0000 | [diff] [blame] | 453 | u32 hash = 0; |
| 454 | int i; |
drh | 477731b | 2007-06-16 03:06:27 +0000 | [diff] [blame] | 455 | for(i=0; i<nByte; i++){ |
| 456 | hash = (hash*1039) + pData[i]; |
danielk1977 | 3c40737 | 2005-02-15 02:54:14 +0000 | [diff] [blame] | 457 | } |
| 458 | return hash; |
| 459 | } |
drh | 477731b | 2007-06-16 03:06:27 +0000 | [diff] [blame] | 460 | static u32 pager_pagehash(PgHdr *pPage){ |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 461 | return pager_datahash(pPage->pPager->pageSize, (unsigned char *)pPage->pData); |
| 462 | } |
danielk1977 | bc2ca9e | 2008-11-13 14:28:28 +0000 | [diff] [blame] | 463 | static void pager_set_pagehash(PgHdr *pPage){ |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 464 | pPage->pageHash = pager_pagehash(pPage); |
drh | 477731b | 2007-06-16 03:06:27 +0000 | [diff] [blame] | 465 | } |
danielk1977 | 3c40737 | 2005-02-15 02:54:14 +0000 | [diff] [blame] | 466 | |
| 467 | /* |
| 468 | ** The CHECK_PAGE macro takes a PgHdr* as an argument. If SQLITE_CHECK_PAGES |
| 469 | ** is defined, and NDEBUG is not defined, an assert() statement checks |
| 470 | ** that the page is either dirty or still matches the calculated page-hash. |
| 471 | */ |
| 472 | #define CHECK_PAGE(x) checkPage(x) |
| 473 | static void checkPage(PgHdr *pPg){ |
| 474 | Pager *pPager = pPg->pPager; |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 475 | assert( !pPg->pageHash || pPager->errCode |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 476 | || (pPg->flags&PGHDR_DIRTY) || pPg->pageHash==pager_pagehash(pPg) ); |
danielk1977 | 3c40737 | 2005-02-15 02:54:14 +0000 | [diff] [blame] | 477 | } |
| 478 | |
| 479 | #else |
drh | 8ffa817 | 2007-06-18 17:25:17 +0000 | [diff] [blame] | 480 | #define pager_datahash(X,Y) 0 |
drh | 477731b | 2007-06-16 03:06:27 +0000 | [diff] [blame] | 481 | #define pager_pagehash(X) 0 |
danielk1977 | 3c40737 | 2005-02-15 02:54:14 +0000 | [diff] [blame] | 482 | #define CHECK_PAGE(x) |
drh | 41d3027 | 2008-08-20 21:47:45 +0000 | [diff] [blame] | 483 | #endif /* SQLITE_CHECK_PAGES */ |
danielk1977 | 3c40737 | 2005-02-15 02:54:14 +0000 | [diff] [blame] | 484 | |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 485 | /* |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 486 | ** When this is called the journal file for pager pPager must be open. |
| 487 | ** The master journal file name is read from the end of the file and |
danielk1977 | 65839c6 | 2007-08-30 08:08:17 +0000 | [diff] [blame] | 488 | ** written into memory supplied by the caller. |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 489 | ** |
danielk1977 | 65839c6 | 2007-08-30 08:08:17 +0000 | [diff] [blame] | 490 | ** zMaster must point to a buffer of at least nMaster bytes allocated by |
| 491 | ** the caller. This should be sqlite3_vfs.mxPathname+1 (to ensure there is |
| 492 | ** enough space to write the master journal name). If the master journal |
| 493 | ** name in the journal is longer than nMaster bytes (including a |
| 494 | ** nul-terminator), then this is handled as if no master journal name |
| 495 | ** were present in the journal. |
| 496 | ** |
| 497 | ** If no master journal file name is present zMaster[0] is set to 0 and |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 498 | ** SQLITE_OK returned. |
| 499 | */ |
danielk1977 | d92db53 | 2008-11-17 04:56:24 +0000 | [diff] [blame] | 500 | static int readMasterJournal(sqlite3_file *pJrnl, char *zMaster, u32 nMaster){ |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 501 | int rc; |
| 502 | u32 len; |
drh | eb20625 | 2004-10-01 02:00:31 +0000 | [diff] [blame] | 503 | i64 szJ; |
danielk1977 | c3e8f5e | 2004-06-28 01:16:46 +0000 | [diff] [blame] | 504 | u32 cksum; |
shane | 0b8d276 | 2008-07-22 05:18:00 +0000 | [diff] [blame] | 505 | u32 u; /* Unsigned loop counter */ |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 506 | unsigned char aMagic[8]; /* A buffer to hold the magic header */ |
| 507 | |
danielk1977 | 65839c6 | 2007-08-30 08:08:17 +0000 | [diff] [blame] | 508 | zMaster[0] = '\0'; |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 509 | |
drh | 054889e | 2005-11-30 03:20:31 +0000 | [diff] [blame] | 510 | rc = sqlite3OsFileSize(pJrnl, &szJ); |
danielk1977 | cafadba | 2004-06-25 11:11:54 +0000 | [diff] [blame] | 511 | if( rc!=SQLITE_OK || szJ<16 ) return rc; |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 512 | |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 513 | rc = read32bits(pJrnl, szJ-16, &len); |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 514 | if( rc!=SQLITE_OK ) return rc; |
| 515 | |
danielk1977 | 65839c6 | 2007-08-30 08:08:17 +0000 | [diff] [blame] | 516 | if( len>=nMaster ){ |
| 517 | return SQLITE_OK; |
| 518 | } |
| 519 | |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 520 | rc = read32bits(pJrnl, szJ-12, &cksum); |
danielk1977 | cafadba | 2004-06-25 11:11:54 +0000 | [diff] [blame] | 521 | if( rc!=SQLITE_OK ) return rc; |
| 522 | |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 523 | rc = sqlite3OsRead(pJrnl, aMagic, 8, szJ-8); |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 524 | if( rc!=SQLITE_OK || memcmp(aMagic, aJournalMagic, 8) ) return rc; |
| 525 | |
danielk1977 | 65839c6 | 2007-08-30 08:08:17 +0000 | [diff] [blame] | 526 | rc = sqlite3OsRead(pJrnl, zMaster, len, szJ-16-len); |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 527 | if( rc!=SQLITE_OK ){ |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 528 | return rc; |
| 529 | } |
danielk1977 | 65839c6 | 2007-08-30 08:08:17 +0000 | [diff] [blame] | 530 | zMaster[len] = '\0'; |
danielk1977 | cafadba | 2004-06-25 11:11:54 +0000 | [diff] [blame] | 531 | |
| 532 | /* See if the checksum matches the master journal name */ |
shane | 0b8d276 | 2008-07-22 05:18:00 +0000 | [diff] [blame] | 533 | for(u=0; u<len; u++){ |
| 534 | cksum -= zMaster[u]; |
danielk1977 | 65839c6 | 2007-08-30 08:08:17 +0000 | [diff] [blame] | 535 | } |
danielk1977 | 8191bff | 2004-06-28 04:52:30 +0000 | [diff] [blame] | 536 | if( cksum ){ |
| 537 | /* If the checksum doesn't add up, then one or more of the disk sectors |
| 538 | ** containing the master journal filename is corrupted. This means |
| 539 | ** definitely roll back, so just return SQLITE_OK and report a (nul) |
| 540 | ** master-journal filename. |
| 541 | */ |
danielk1977 | 65839c6 | 2007-08-30 08:08:17 +0000 | [diff] [blame] | 542 | zMaster[0] = '\0'; |
danielk1977 | cafadba | 2004-06-25 11:11:54 +0000 | [diff] [blame] | 543 | } |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 544 | |
| 545 | return SQLITE_OK; |
| 546 | } |
| 547 | |
| 548 | /* |
| 549 | ** Seek the journal file descriptor to the next sector boundary where a |
| 550 | ** journal header may be read or written. Pager.journalOff is updated with |
| 551 | ** the new seek offset. |
| 552 | ** |
| 553 | ** i.e for a sector size of 512: |
| 554 | ** |
| 555 | ** Input Offset Output Offset |
| 556 | ** --------------------------------------- |
| 557 | ** 0 0 |
| 558 | ** 512 512 |
| 559 | ** 100 512 |
| 560 | ** 2000 2048 |
| 561 | ** |
| 562 | */ |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 563 | static void seekJournalHdr(Pager *pPager){ |
drh | eb20625 | 2004-10-01 02:00:31 +0000 | [diff] [blame] | 564 | i64 offset = 0; |
| 565 | i64 c = pPager->journalOff; |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 566 | if( c ){ |
| 567 | offset = ((c-1)/JOURNAL_HDR_SZ(pPager) + 1) * JOURNAL_HDR_SZ(pPager); |
| 568 | } |
| 569 | assert( offset%JOURNAL_HDR_SZ(pPager)==0 ); |
| 570 | assert( offset>=c ); |
| 571 | assert( (offset-c)<JOURNAL_HDR_SZ(pPager) ); |
| 572 | pPager->journalOff = offset; |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 573 | } |
| 574 | |
| 575 | /* |
drh | f3a8762 | 2008-04-17 14:16:42 +0000 | [diff] [blame] | 576 | ** Write zeros over the header of the journal file. This has the |
| 577 | ** effect of invalidating the journal file and committing the |
| 578 | ** transaction. |
| 579 | */ |
danielk1977 | df2566a | 2008-05-07 19:11:03 +0000 | [diff] [blame] | 580 | static int zeroJournalHdr(Pager *pPager, int doTruncate){ |
| 581 | int rc = SQLITE_OK; |
danielk1977 | 55a25a1 | 2008-09-11 10:29:15 +0000 | [diff] [blame] | 582 | static const char zeroHdr[28] = {0}; |
drh | f3a8762 | 2008-04-17 14:16:42 +0000 | [diff] [blame] | 583 | |
danielk1977 | df2566a | 2008-05-07 19:11:03 +0000 | [diff] [blame] | 584 | if( pPager->journalOff ){ |
danielk1977 | b53e496 | 2008-06-04 06:45:59 +0000 | [diff] [blame] | 585 | i64 iLimit = pPager->journalSizeLimit; |
| 586 | |
danielk1977 | df2566a | 2008-05-07 19:11:03 +0000 | [diff] [blame] | 587 | IOTRACE(("JZEROHDR %p\n", pPager)) |
danielk1977 | b53e496 | 2008-06-04 06:45:59 +0000 | [diff] [blame] | 588 | if( doTruncate || iLimit==0 ){ |
danielk1977 | df2566a | 2008-05-07 19:11:03 +0000 | [diff] [blame] | 589 | rc = sqlite3OsTruncate(pPager->jfd, 0); |
| 590 | }else{ |
| 591 | rc = sqlite3OsWrite(pPager->jfd, zeroHdr, sizeof(zeroHdr), 0); |
| 592 | } |
danielk1977 | 8162054 | 2008-06-07 05:19:37 +0000 | [diff] [blame] | 593 | if( rc==SQLITE_OK && !pPager->noSync ){ |
danielk1977 | df2566a | 2008-05-07 19:11:03 +0000 | [diff] [blame] | 594 | rc = sqlite3OsSync(pPager->jfd, SQLITE_SYNC_DATAONLY|pPager->sync_flags); |
| 595 | } |
danielk1977 | b53e496 | 2008-06-04 06:45:59 +0000 | [diff] [blame] | 596 | |
| 597 | /* At this point the transaction is committed but the write lock |
| 598 | ** is still held on the file. If there is a size limit configured for |
| 599 | ** the persistent journal and the journal file currently consumes more |
| 600 | ** space than that limit allows for, truncate it now. There is no need |
| 601 | ** to sync the file following this operation. |
| 602 | */ |
| 603 | if( rc==SQLITE_OK && iLimit>0 ){ |
| 604 | i64 sz; |
| 605 | rc = sqlite3OsFileSize(pPager->jfd, &sz); |
| 606 | if( rc==SQLITE_OK && sz>iLimit ){ |
| 607 | rc = sqlite3OsTruncate(pPager->jfd, iLimit); |
| 608 | } |
| 609 | } |
drh | a06ecba | 2008-04-22 17:15:17 +0000 | [diff] [blame] | 610 | } |
drh | f3a8762 | 2008-04-17 14:16:42 +0000 | [diff] [blame] | 611 | return rc; |
| 612 | } |
| 613 | |
| 614 | /* |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 615 | ** The journal file must be open when this routine is called. A journal |
| 616 | ** header (JOURNAL_HDR_SZ bytes) is written into the journal file at the |
| 617 | ** current location. |
| 618 | ** |
| 619 | ** The format for the journal header is as follows: |
| 620 | ** - 8 bytes: Magic identifying journal format. |
| 621 | ** - 4 bytes: Number of records in journal, or -1 no-sync mode is on. |
| 622 | ** - 4 bytes: Random number used for page hash. |
| 623 | ** - 4 bytes: Initial database page count. |
| 624 | ** - 4 bytes: Sector size used by the process that wrote this journal. |
danielk1977 | 67c007b | 2008-03-20 04:45:49 +0000 | [diff] [blame] | 625 | ** - 4 bytes: Database page size. |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 626 | ** |
danielk1977 | 67c007b | 2008-03-20 04:45:49 +0000 | [diff] [blame] | 627 | ** Followed by (JOURNAL_HDR_SZ - 28) bytes of unused space. |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 628 | */ |
| 629 | static int writeJournalHdr(Pager *pPager){ |
danielk1977 | a664f8e | 2008-04-22 14:31:48 +0000 | [diff] [blame] | 630 | int rc = SQLITE_OK; |
| 631 | char *zHeader = pPager->pTmpSpace; |
danielk1977 | d92db53 | 2008-11-17 04:56:24 +0000 | [diff] [blame] | 632 | u32 nHeader = pPager->pageSize; |
| 633 | u32 nWrite; |
danielk1977 | a664f8e | 2008-04-22 14:31:48 +0000 | [diff] [blame] | 634 | |
| 635 | if( nHeader>JOURNAL_HDR_SZ(pPager) ){ |
| 636 | nHeader = JOURNAL_HDR_SZ(pPager); |
| 637 | } |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 638 | |
danielk1977 | 4099f6e | 2007-03-19 11:25:20 +0000 | [diff] [blame] | 639 | if( pPager->stmtHdrOff==0 ){ |
| 640 | pPager->stmtHdrOff = pPager->journalOff; |
| 641 | } |
| 642 | |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 643 | seekJournalHdr(pPager); |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 644 | pPager->journalHdr = pPager->journalOff; |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 645 | |
drh | 97b5748 | 2006-01-10 20:32:32 +0000 | [diff] [blame] | 646 | memcpy(zHeader, aJournalMagic, sizeof(aJournalMagic)); |
danielk1977 | 4cd2cd5 | 2007-08-23 14:48:23 +0000 | [diff] [blame] | 647 | |
| 648 | /* |
| 649 | ** Write the nRec Field - the number of page records that follow this |
| 650 | ** journal header. Normally, zero is written to this value at this time. |
| 651 | ** After the records are added to the journal (and the journal synced, |
| 652 | ** if in full-sync mode), the zero is overwritten with the true number |
| 653 | ** of records (see syncJournal()). |
| 654 | ** |
| 655 | ** A faster alternative is to write 0xFFFFFFFF to the nRec field. When |
| 656 | ** reading the journal this value tells SQLite to assume that the |
| 657 | ** rest of the journal file contains valid page records. This assumption |
| 658 | ** is dangerous, as if a failure occured whilst writing to the journal |
| 659 | ** file it may contain some garbage data. There are two scenarios |
| 660 | ** where this risk can be ignored: |
| 661 | ** |
| 662 | ** * When the pager is in no-sync mode. Corruption can follow a |
| 663 | ** power failure in this case anyway. |
| 664 | ** |
| 665 | ** * When the SQLITE_IOCAP_SAFE_APPEND flag is set. This guarantees |
| 666 | ** that garbage data is never appended to the journal file. |
| 667 | */ |
| 668 | assert(pPager->fd->pMethods||pPager->noSync); |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 669 | if( (pPager->noSync) || (pPager->journalMode==PAGER_JOURNALMODE_MEMORY) |
danielk1977 | 4cd2cd5 | 2007-08-23 14:48:23 +0000 | [diff] [blame] | 670 | || (sqlite3OsDeviceCharacteristics(pPager->fd)&SQLITE_IOCAP_SAFE_APPEND) |
| 671 | ){ |
| 672 | put32bits(&zHeader[sizeof(aJournalMagic)], 0xffffffff); |
| 673 | }else{ |
| 674 | put32bits(&zHeader[sizeof(aJournalMagic)], 0); |
| 675 | } |
| 676 | |
drh | 97b5748 | 2006-01-10 20:32:32 +0000 | [diff] [blame] | 677 | /* The random check-hash initialiser */ |
drh | 2fa1868 | 2008-03-19 14:15:34 +0000 | [diff] [blame] | 678 | sqlite3_randomness(sizeof(pPager->cksumInit), &pPager->cksumInit); |
drh | 97b5748 | 2006-01-10 20:32:32 +0000 | [diff] [blame] | 679 | put32bits(&zHeader[sizeof(aJournalMagic)+4], pPager->cksumInit); |
| 680 | /* The initial database size */ |
| 681 | put32bits(&zHeader[sizeof(aJournalMagic)+8], pPager->dbSize); |
| 682 | /* The assumed sector size for this process */ |
| 683 | put32bits(&zHeader[sizeof(aJournalMagic)+12], pPager->sectorSize); |
danielk1977 | 67c007b | 2008-03-20 04:45:49 +0000 | [diff] [blame] | 684 | if( pPager->journalHdr==0 ){ |
| 685 | /* The page size */ |
| 686 | put32bits(&zHeader[sizeof(aJournalMagic)+16], pPager->pageSize); |
| 687 | } |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 688 | |
danielk1977 | a664f8e | 2008-04-22 14:31:48 +0000 | [diff] [blame] | 689 | for(nWrite=0; rc==SQLITE_OK&&nWrite<JOURNAL_HDR_SZ(pPager); nWrite+=nHeader){ |
| 690 | IOTRACE(("JHDR %p %lld %d\n", pPager, pPager->journalHdr, nHeader)) |
| 691 | rc = sqlite3OsWrite(pPager->jfd, zHeader, nHeader, pPager->journalOff); |
| 692 | pPager->journalOff += nHeader; |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 693 | } |
danielk1977 | a664f8e | 2008-04-22 14:31:48 +0000 | [diff] [blame] | 694 | |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 695 | return rc; |
| 696 | } |
| 697 | |
| 698 | /* |
| 699 | ** The journal file must be open when this is called. A journal header file |
| 700 | ** (JOURNAL_HDR_SZ bytes) is read from the current location in the journal |
| 701 | ** file. See comments above function writeJournalHdr() for a description of |
| 702 | ** the journal header format. |
| 703 | ** |
| 704 | ** If the header is read successfully, *nRec is set to the number of |
| 705 | ** page records following this header and *dbSize is set to the size of the |
| 706 | ** database before the transaction began, in pages. Also, pPager->cksumInit |
| 707 | ** is set to the value read from the journal header. SQLITE_OK is returned |
| 708 | ** in this case. |
| 709 | ** |
| 710 | ** If the journal header file appears to be corrupted, SQLITE_DONE is |
| 711 | ** returned and *nRec and *dbSize are not set. If JOURNAL_HDR_SZ bytes |
| 712 | ** cannot be read from the journal file an error code is returned. |
| 713 | */ |
| 714 | static int readJournalHdr( |
| 715 | Pager *pPager, |
drh | eb20625 | 2004-10-01 02:00:31 +0000 | [diff] [blame] | 716 | i64 journalSize, |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 717 | u32 *pNRec, |
| 718 | u32 *pDbSize |
| 719 | ){ |
| 720 | int rc; |
| 721 | unsigned char aMagic[8]; /* A buffer to hold the magic header */ |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 722 | i64 jrnlOff; |
danielk1977 | 67c007b | 2008-03-20 04:45:49 +0000 | [diff] [blame] | 723 | int iPageSize; |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 724 | |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 725 | seekJournalHdr(pPager); |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 726 | if( pPager->journalOff+JOURNAL_HDR_SZ(pPager) > journalSize ){ |
| 727 | return SQLITE_DONE; |
| 728 | } |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 729 | jrnlOff = pPager->journalOff; |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 730 | |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 731 | rc = sqlite3OsRead(pPager->jfd, aMagic, sizeof(aMagic), jrnlOff); |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 732 | if( rc ) return rc; |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 733 | jrnlOff += sizeof(aMagic); |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 734 | |
| 735 | if( memcmp(aMagic, aJournalMagic, sizeof(aMagic))!=0 ){ |
| 736 | return SQLITE_DONE; |
| 737 | } |
| 738 | |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 739 | rc = read32bits(pPager->jfd, jrnlOff, pNRec); |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 740 | if( rc ) return rc; |
| 741 | |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 742 | rc = read32bits(pPager->jfd, jrnlOff+4, &pPager->cksumInit); |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 743 | if( rc ) return rc; |
| 744 | |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 745 | rc = read32bits(pPager->jfd, jrnlOff+8, pDbSize); |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 746 | if( rc ) return rc; |
| 747 | |
danielk1977 | 67c007b | 2008-03-20 04:45:49 +0000 | [diff] [blame] | 748 | rc = read32bits(pPager->jfd, jrnlOff+16, (u32 *)&iPageSize); |
| 749 | if( rc==SQLITE_OK |
| 750 | && iPageSize>=512 |
| 751 | && iPageSize<=SQLITE_MAX_PAGE_SIZE |
| 752 | && ((iPageSize-1)&iPageSize)==0 |
| 753 | ){ |
| 754 | u16 pagesize = iPageSize; |
| 755 | rc = sqlite3PagerSetPagesize(pPager, &pagesize); |
| 756 | } |
| 757 | if( rc ) return rc; |
| 758 | |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 759 | /* Update the assumed sector-size to match the value used by |
| 760 | ** the process that created this journal. If this journal was |
| 761 | ** created by a process other than this one, then this routine |
| 762 | ** is being called from within pager_playback(). The local value |
| 763 | ** of Pager.sectorSize is restored at the end of that routine. |
| 764 | */ |
drh | 98c5835 | 2008-11-07 00:24:53 +0000 | [diff] [blame] | 765 | rc = read32bits(pPager->jfd, jrnlOff+12, &pPager->sectorSize); |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 766 | if( rc ) return rc; |
drh | 98c5835 | 2008-11-07 00:24:53 +0000 | [diff] [blame] | 767 | if( (pPager->sectorSize & (pPager->sectorSize-1))!=0 |
| 768 | || pPager->sectorSize>0x1000000 ){ |
| 769 | return SQLITE_DONE; |
| 770 | } |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 771 | |
| 772 | pPager->journalOff += JOURNAL_HDR_SZ(pPager); |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 773 | return SQLITE_OK; |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 774 | } |
| 775 | |
| 776 | |
| 777 | /* |
| 778 | ** Write the supplied master journal name into the journal file for pager |
danielk1977 | cafadba | 2004-06-25 11:11:54 +0000 | [diff] [blame] | 779 | ** pPager at the current location. The master journal name must be the last |
| 780 | ** thing written to a journal file. If the pager is in full-sync mode, the |
| 781 | ** journal file descriptor is advanced to the next sector boundary before |
| 782 | ** anything is written. The format is: |
| 783 | ** |
| 784 | ** + 4 bytes: PAGER_MJ_PGNO. |
| 785 | ** + N bytes: length of master journal name. |
| 786 | ** + 4 bytes: N |
| 787 | ** + 4 bytes: Master journal name checksum. |
| 788 | ** + 8 bytes: aJournalMagic[]. |
| 789 | ** |
| 790 | ** The master journal page checksum is the sum of the bytes in the master |
| 791 | ** journal name. |
danielk1977 | aef0bf6 | 2005-12-30 16:28:01 +0000 | [diff] [blame] | 792 | ** |
| 793 | ** If zMaster is a NULL pointer (occurs for a single database transaction), |
| 794 | ** this call is a no-op. |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 795 | */ |
| 796 | static int writeMasterJournal(Pager *pPager, const char *zMaster){ |
| 797 | int rc; |
| 798 | int len; |
danielk1977 | cafadba | 2004-06-25 11:11:54 +0000 | [diff] [blame] | 799 | int i; |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 800 | i64 jrnlOff; |
danielk1977 | df2566a | 2008-05-07 19:11:03 +0000 | [diff] [blame] | 801 | i64 jrnlSize; |
drh | 97b5748 | 2006-01-10 20:32:32 +0000 | [diff] [blame] | 802 | u32 cksum = 0; |
| 803 | char zBuf[sizeof(aJournalMagic)+2*4]; |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 804 | |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 805 | if( !zMaster || pPager->setMaster ) return SQLITE_OK; |
| 806 | if( pPager->journalMode==PAGER_JOURNALMODE_MEMORY ) return SQLITE_OK; |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 807 | pPager->setMaster = 1; |
| 808 | |
| 809 | len = strlen(zMaster); |
danielk1977 | cafadba | 2004-06-25 11:11:54 +0000 | [diff] [blame] | 810 | for(i=0; i<len; i++){ |
| 811 | cksum += zMaster[i]; |
| 812 | } |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 813 | |
| 814 | /* If in full-sync mode, advance to the next disk sector before writing |
| 815 | ** the master journal name. This is in case the previous page written to |
| 816 | ** the journal has already been synced. |
| 817 | */ |
| 818 | if( pPager->fullSync ){ |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 819 | seekJournalHdr(pPager); |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 820 | } |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 821 | jrnlOff = pPager->journalOff; |
danielk1977 | cafadba | 2004-06-25 11:11:54 +0000 | [diff] [blame] | 822 | pPager->journalOff += (len+20); |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 823 | |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 824 | rc = write32bits(pPager->jfd, jrnlOff, PAGER_MJ_PGNO(pPager)); |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 825 | if( rc!=SQLITE_OK ) return rc; |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 826 | jrnlOff += 4; |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 827 | |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 828 | rc = sqlite3OsWrite(pPager->jfd, zMaster, len, jrnlOff); |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 829 | if( rc!=SQLITE_OK ) return rc; |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 830 | jrnlOff += len; |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 831 | |
drh | 97b5748 | 2006-01-10 20:32:32 +0000 | [diff] [blame] | 832 | put32bits(zBuf, len); |
| 833 | put32bits(&zBuf[4], cksum); |
| 834 | memcpy(&zBuf[8], aJournalMagic, sizeof(aJournalMagic)); |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 835 | rc = sqlite3OsWrite(pPager->jfd, zBuf, 8+sizeof(aJournalMagic), jrnlOff); |
danielk1977 | df2566a | 2008-05-07 19:11:03 +0000 | [diff] [blame] | 836 | jrnlOff += 8+sizeof(aJournalMagic); |
drh | 2c8997b | 2005-08-27 16:36:48 +0000 | [diff] [blame] | 837 | pPager->needSync = !pPager->noSync; |
danielk1977 | df2566a | 2008-05-07 19:11:03 +0000 | [diff] [blame] | 838 | |
| 839 | /* If the pager is in peristent-journal mode, then the physical |
| 840 | ** journal-file may extend past the end of the master-journal name |
| 841 | ** and 8 bytes of magic data just written to the file. This is |
| 842 | ** dangerous because the code to rollback a hot-journal file |
| 843 | ** will not be able to find the master-journal name to determine |
| 844 | ** whether or not the journal is hot. |
| 845 | ** |
| 846 | ** Easiest thing to do in this scenario is to truncate the journal |
| 847 | ** file to the required size. |
| 848 | */ |
| 849 | if( (rc==SQLITE_OK) |
| 850 | && (rc = sqlite3OsFileSize(pPager->jfd, &jrnlSize))==SQLITE_OK |
| 851 | && jrnlSize>jrnlOff |
| 852 | ){ |
| 853 | rc = sqlite3OsTruncate(pPager->jfd, jrnlOff); |
| 854 | } |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 855 | return rc; |
| 856 | } |
| 857 | |
| 858 | /* |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 859 | ** Find a page in the hash table given its page number. Return |
| 860 | ** a pointer to the page or NULL if not found. |
| 861 | */ |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 862 | static PgHdr *pager_lookup(Pager *pPager, Pgno pgno){ |
drh | 8ca0c72 | 2006-05-07 17:49:38 +0000 | [diff] [blame] | 863 | PgHdr *p; |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 864 | sqlite3PcacheFetch(pPager->pPCache, pgno, 0, &p); |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 865 | return p; |
| 866 | } |
| 867 | |
| 868 | /* |
danielk1977 | e180dd9 | 2007-04-05 17:15:52 +0000 | [diff] [blame] | 869 | ** Clear the in-memory cache. This routine |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 870 | ** sets the state of the pager back to what it was when it was first |
| 871 | ** opened. Any outstanding pages are invalidated and subsequent attempts |
| 872 | ** to access those pages will likely result in a coredump. |
| 873 | */ |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 874 | static void pager_reset(Pager *pPager){ |
danielk1977 | efaaf57 | 2006-01-16 11:29:19 +0000 | [diff] [blame] | 875 | if( pPager->errCode ) return; |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 876 | sqlite3PcacheClear(pPager->pPCache); |
danielk1977 | e277be0 | 2007-03-23 18:12:06 +0000 | [diff] [blame] | 877 | } |
| 878 | |
| 879 | /* |
danielk1977 | ae72d98 | 2007-10-03 08:46:44 +0000 | [diff] [blame] | 880 | ** Unlock the database file. |
| 881 | ** |
| 882 | ** If the pager is currently in error state, discard the contents of |
| 883 | ** the cache and reset the Pager structure internal state. If there is |
| 884 | ** an open journal-file, then the next time a shared-lock is obtained |
| 885 | ** on the pager file (by this or any other process), it will be |
| 886 | ** treated as a hot-journal and rolled back. |
| 887 | */ |
| 888 | static void pager_unlock(Pager *pPager){ |
| 889 | if( !pPager->exclusiveMode ){ |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 890 | int rc = osUnlock(pPager->fd, NO_LOCK); |
| 891 | if( rc ) pPager->errCode = rc; |
danielk1977 | d92db53 | 2008-11-17 04:56:24 +0000 | [diff] [blame] | 892 | pPager->dbSizeValid = 0; |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 893 | IOTRACE(("UNLOCK %p\n", pPager)) |
danielk1977 | ae72d98 | 2007-10-03 08:46:44 +0000 | [diff] [blame] | 894 | |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 895 | /* Always close the journal file when dropping the database lock. |
| 896 | ** Otherwise, another connection with journal_mode=delete might |
| 897 | ** delete the file out from under us. |
| 898 | */ |
| 899 | if( pPager->journalOpen ){ |
| 900 | sqlite3OsClose(pPager->jfd); |
| 901 | pPager->journalOpen = 0; |
| 902 | sqlite3BitvecDestroy(pPager->pInJournal); |
| 903 | pPager->pInJournal = 0; |
| 904 | sqlite3BitvecDestroy(pPager->pAlwaysRollback); |
| 905 | pPager->pAlwaysRollback = 0; |
danielk1977 | ae72d98 | 2007-10-03 08:46:44 +0000 | [diff] [blame] | 906 | } |
| 907 | |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 908 | /* If Pager.errCode is set, the contents of the pager cache cannot be |
| 909 | ** trusted. Now that the pager file is unlocked, the contents of the |
| 910 | ** cache can be discarded and the error code safely cleared. |
| 911 | */ |
| 912 | if( pPager->errCode ){ |
| 913 | if( rc==SQLITE_OK ) pPager->errCode = SQLITE_OK; |
| 914 | pager_reset(pPager); |
| 915 | if( pPager->stmtOpen ){ |
| 916 | sqlite3OsClose(pPager->stfd); |
| 917 | sqlite3BitvecDestroy(pPager->pInStmt); |
| 918 | pPager->pInStmt = 0; |
| 919 | } |
| 920 | pPager->stmtOpen = 0; |
| 921 | pPager->stmtInUse = 0; |
| 922 | pPager->journalOff = 0; |
| 923 | pPager->journalStarted = 0; |
| 924 | pPager->stmtAutoopen = 0; |
| 925 | pPager->origDbSize = 0; |
danielk1977 | ae72d98 | 2007-10-03 08:46:44 +0000 | [diff] [blame] | 926 | } |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 927 | |
| 928 | pPager->state = PAGER_UNLOCK; |
| 929 | pPager->changeCountDone = 0; |
danielk1977 | ae72d98 | 2007-10-03 08:46:44 +0000 | [diff] [blame] | 930 | } |
| 931 | } |
| 932 | |
| 933 | /* |
| 934 | ** Execute a rollback if a transaction is active and unlock the |
| 935 | ** database file. If the pager has already entered the error state, |
| 936 | ** do not attempt the rollback. |
| 937 | */ |
| 938 | static void pagerUnlockAndRollback(Pager *p){ |
danielk1977 | ae72d98 | 2007-10-03 08:46:44 +0000 | [diff] [blame] | 939 | if( p->errCode==SQLITE_OK && p->state>=PAGER_RESERVED ){ |
danielk1977 | 2d1d86f | 2008-06-20 14:59:51 +0000 | [diff] [blame] | 940 | sqlite3BeginBenignMalloc(); |
danielk1977 | ae72d98 | 2007-10-03 08:46:44 +0000 | [diff] [blame] | 941 | sqlite3PagerRollback(p); |
danielk1977 | 2d1d86f | 2008-06-20 14:59:51 +0000 | [diff] [blame] | 942 | sqlite3EndBenignMalloc(); |
danielk1977 | ae72d98 | 2007-10-03 08:46:44 +0000 | [diff] [blame] | 943 | } |
| 944 | pager_unlock(p); |
danielk1977 | ae72d98 | 2007-10-03 08:46:44 +0000 | [diff] [blame] | 945 | } |
| 946 | |
| 947 | /* |
drh | 80e35f4 | 2007-03-30 14:06:34 +0000 | [diff] [blame] | 948 | ** This routine ends a transaction. A transaction is ended by either |
| 949 | ** a COMMIT or a ROLLBACK. |
| 950 | ** |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 951 | ** When this routine is called, the pager has the journal file open and |
drh | 80e35f4 | 2007-03-30 14:06:34 +0000 | [diff] [blame] | 952 | ** a RESERVED or EXCLUSIVE lock on the database. This routine will release |
| 953 | ** the database lock and acquires a SHARED lock in its place if that is |
| 954 | ** the appropriate thing to do. Release locks usually is appropriate, |
| 955 | ** unless we are in exclusive access mode or unless this is a |
| 956 | ** COMMIT AND BEGIN or ROLLBACK AND BEGIN operation. |
| 957 | ** |
| 958 | ** The journal file is either deleted or truncated. |
drh | 5045789 | 2003-09-06 01:10:47 +0000 | [diff] [blame] | 959 | ** |
| 960 | ** TODO: Consider keeping the journal file open for temporary databases. |
| 961 | ** This might give a performance improvement on windows where opening |
| 962 | ** a file is an expensive operation. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 963 | */ |
danielk1977 | df2566a | 2008-05-07 19:11:03 +0000 | [diff] [blame] | 964 | static int pager_end_transaction(Pager *pPager, int hasMaster){ |
danielk1977 | 4148346 | 2007-03-24 16:45:04 +0000 | [diff] [blame] | 965 | int rc = SQLITE_OK; |
danielk1977 | 979f38e | 2007-03-27 16:19:51 +0000 | [diff] [blame] | 966 | int rc2 = SQLITE_OK; |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 967 | if( pPager->state<PAGER_RESERVED ){ |
| 968 | return SQLITE_OK; |
| 969 | } |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 970 | sqlite3PagerStmtCommit(pPager); |
danielk1977 | 334cdb6 | 2007-03-26 08:05:12 +0000 | [diff] [blame] | 971 | if( pPager->stmtOpen && !pPager->exclusiveMode ){ |
danielk1977 | b4b4741 | 2007-08-17 15:53:36 +0000 | [diff] [blame] | 972 | sqlite3OsClose(pPager->stfd); |
danielk1977 | 979f38e | 2007-03-27 16:19:51 +0000 | [diff] [blame] | 973 | pPager->stmtOpen = 0; |
drh | 0f89253 | 2002-05-30 12:27:03 +0000 | [diff] [blame] | 974 | } |
drh | da47d77 | 2002-12-02 04:25:19 +0000 | [diff] [blame] | 975 | if( pPager->journalOpen ){ |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 976 | if( pPager->journalMode==PAGER_JOURNALMODE_MEMORY ){ |
| 977 | int isMemoryJournal = sqlite3IsMemJournal(pPager->jfd); |
| 978 | sqlite3OsClose(pPager->jfd); |
| 979 | pPager->journalOpen = 0; |
| 980 | if( !isMemoryJournal ){ |
| 981 | rc = sqlite3OsDelete(pPager->pVfs, pPager->zJournal, 0); |
| 982 | } |
| 983 | }else if( pPager->journalMode==PAGER_JOURNALMODE_TRUNCATE |
drh | 0433588 | 2008-09-26 21:08:08 +0000 | [diff] [blame] | 984 | && (rc = sqlite3OsTruncate(pPager->jfd, 0))==SQLITE_OK ){ |
| 985 | pPager->journalOff = 0; |
| 986 | pPager->journalStarted = 0; |
| 987 | }else if( pPager->exclusiveMode |
danielk1977 | 93f7af9 | 2008-05-09 16:57:50 +0000 | [diff] [blame] | 988 | || pPager->journalMode==PAGER_JOURNALMODE_PERSIST |
| 989 | ){ |
| 990 | rc = zeroJournalHdr(pPager, hasMaster); |
| 991 | pager_error(pPager, rc); |
danielk1977 | 4148346 | 2007-03-24 16:45:04 +0000 | [diff] [blame] | 992 | pPager->journalOff = 0; |
danielk1977 | 334cdb6 | 2007-03-26 08:05:12 +0000 | [diff] [blame] | 993 | pPager->journalStarted = 0; |
danielk1977 | 4148346 | 2007-03-24 16:45:04 +0000 | [diff] [blame] | 994 | }else{ |
drh | 0433588 | 2008-09-26 21:08:08 +0000 | [diff] [blame] | 995 | assert( pPager->journalMode==PAGER_JOURNALMODE_DELETE || rc ); |
danielk1977 | b4b4741 | 2007-08-17 15:53:36 +0000 | [diff] [blame] | 996 | sqlite3OsClose(pPager->jfd); |
danielk1977 | 4148346 | 2007-03-24 16:45:04 +0000 | [diff] [blame] | 997 | pPager->journalOpen = 0; |
danielk1977 | 0f01fda | 2008-06-06 16:14:02 +0000 | [diff] [blame] | 998 | if( rc==SQLITE_OK && !pPager->tempFile ){ |
danielk1977 | fee2d25 | 2007-08-18 10:59:19 +0000 | [diff] [blame] | 999 | rc = sqlite3OsDelete(pPager->pVfs, pPager->zJournal, 0); |
danielk1977 | 7152de8 | 2007-03-29 17:28:14 +0000 | [diff] [blame] | 1000 | } |
danielk1977 | 4148346 | 2007-03-24 16:45:04 +0000 | [diff] [blame] | 1001 | } |
drh | f5e7bb5 | 2008-02-18 14:47:33 +0000 | [diff] [blame] | 1002 | sqlite3BitvecDestroy(pPager->pInJournal); |
| 1003 | pPager->pInJournal = 0; |
danielk1977 | a1fa00d | 2008-08-27 15:16:33 +0000 | [diff] [blame] | 1004 | sqlite3BitvecDestroy(pPager->pAlwaysRollback); |
| 1005 | pPager->pAlwaysRollback = 0; |
danielk1977 | 3c40737 | 2005-02-15 02:54:14 +0000 | [diff] [blame] | 1006 | #ifdef SQLITE_CHECK_PAGES |
danielk1977 | bc2ca9e | 2008-11-13 14:28:28 +0000 | [diff] [blame] | 1007 | sqlite3PcacheIterateDirty(pPager->pPCache, pager_set_pagehash); |
danielk1977 | 3c40737 | 2005-02-15 02:54:14 +0000 | [diff] [blame] | 1008 | #endif |
danielk1977 | bc2ca9e | 2008-11-13 14:28:28 +0000 | [diff] [blame] | 1009 | sqlite3PcacheCleanAll(pPager->pPCache); |
danielk1977 | ef317ab | 2004-06-23 10:43:10 +0000 | [diff] [blame] | 1010 | pPager->dirtyCache = 0; |
danielk1977 | ef317ab | 2004-06-23 10:43:10 +0000 | [diff] [blame] | 1011 | pPager->nRec = 0; |
drh | da47d77 | 2002-12-02 04:25:19 +0000 | [diff] [blame] | 1012 | }else{ |
drh | f5e7bb5 | 2008-02-18 14:47:33 +0000 | [diff] [blame] | 1013 | assert( pPager->pInJournal==0 ); |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 1014 | } |
danielk1977 | 979f38e | 2007-03-27 16:19:51 +0000 | [diff] [blame] | 1015 | |
danielk1977 | 4148346 | 2007-03-24 16:45:04 +0000 | [diff] [blame] | 1016 | if( !pPager->exclusiveMode ){ |
danielk1977 | 7a2b1ee | 2007-08-21 14:27:01 +0000 | [diff] [blame] | 1017 | rc2 = osUnlock(pPager->fd, SHARED_LOCK); |
danielk1977 | 4148346 | 2007-03-24 16:45:04 +0000 | [diff] [blame] | 1018 | pPager->state = PAGER_SHARED; |
danielk1977 | 334cdb6 | 2007-03-26 08:05:12 +0000 | [diff] [blame] | 1019 | }else if( pPager->state==PAGER_SYNCED ){ |
| 1020 | pPager->state = PAGER_EXCLUSIVE; |
danielk1977 | 4148346 | 2007-03-24 16:45:04 +0000 | [diff] [blame] | 1021 | } |
danielk1977 | 334cdb6 | 2007-03-26 08:05:12 +0000 | [diff] [blame] | 1022 | pPager->origDbSize = 0; |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1023 | pPager->setMaster = 0; |
danielk1977 | c4da5b9 | 2006-01-21 12:08:54 +0000 | [diff] [blame] | 1024 | pPager->needSync = 0; |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 1025 | /* lruListSetFirstSynced(pPager); */ |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 1026 | if( !MEMDB ){ |
danielk1977 | d92db53 | 2008-11-17 04:56:24 +0000 | [diff] [blame] | 1027 | pPager->dbSizeValid = 0; |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 1028 | } |
drh | d138c01 | 2008-05-13 00:58:18 +0000 | [diff] [blame] | 1029 | pPager->dbModified = 0; |
danielk1977 | 979f38e | 2007-03-27 16:19:51 +0000 | [diff] [blame] | 1030 | |
| 1031 | return (rc==SQLITE_OK?rc2:rc); |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1032 | } |
| 1033 | |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1034 | /* |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 1035 | ** Compute and return a checksum for the page of data. |
drh | 34e79ce | 2004-02-08 06:05:46 +0000 | [diff] [blame] | 1036 | ** |
| 1037 | ** This is not a real checksum. It is really just the sum of the |
drh | 726de59 | 2004-06-10 23:35:50 +0000 | [diff] [blame] | 1038 | ** random initial value and the page number. We experimented with |
| 1039 | ** a checksum of the entire data, but that was found to be too slow. |
| 1040 | ** |
| 1041 | ** Note that the page number is stored at the beginning of data and |
| 1042 | ** the checksum is stored at the end. This is important. If journal |
| 1043 | ** corruption occurs due to a power failure, the most likely scenario |
| 1044 | ** is that one end or the other of the record will be changed. It is |
| 1045 | ** much less likely that the two ends of the journal record will be |
| 1046 | ** correct and the middle be corrupt. Thus, this "checksum" scheme, |
| 1047 | ** though fast and simple, catches the mostly likely kind of corruption. |
| 1048 | ** |
| 1049 | ** FIX ME: Consider adding every 200th (or so) byte of the data to the |
| 1050 | ** checksum. That way if a single page spans 3 or more disk sectors and |
| 1051 | ** only the middle sector is corrupt, we will still have a reasonable |
| 1052 | ** chance of failing the checksum and thus detecting the problem. |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 1053 | */ |
drh | 7416170 | 2006-02-24 02:53:49 +0000 | [diff] [blame] | 1054 | static u32 pager_cksum(Pager *pPager, const u8 *aData){ |
danielk1977 | ef317ab | 2004-06-23 10:43:10 +0000 | [diff] [blame] | 1055 | u32 cksum = pPager->cksumInit; |
| 1056 | int i = pPager->pageSize-200; |
| 1057 | while( i>0 ){ |
| 1058 | cksum += aData[i]; |
| 1059 | i -= 200; |
| 1060 | } |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 1061 | return cksum; |
| 1062 | } |
| 1063 | |
| 1064 | /* |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1065 | ** Read a single page from the journal file opened on file descriptor |
| 1066 | ** jfd. Playback this one page. |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 1067 | ** |
drh | c13148f | 2008-08-27 18:03:20 +0000 | [diff] [blame] | 1068 | ** The isMainJrnl flag is true if this is the main rollback journal and |
| 1069 | ** false for the statement journal. The main rollback journal uses |
| 1070 | ** checksums - the statement journal does not. |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1071 | */ |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 1072 | static int pager_playback_one_page( |
drh | c13148f | 2008-08-27 18:03:20 +0000 | [diff] [blame] | 1073 | Pager *pPager, /* The pager being played back */ |
| 1074 | sqlite3_file *jfd, /* The file that is the journal being rolled back */ |
| 1075 | i64 offset, /* Offset of the page within the journal */ |
| 1076 | int isMainJrnl /* True for main rollback journal. False for Stmt jrnl */ |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 1077 | ){ |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1078 | int rc; |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 1079 | PgHdr *pPg; /* An existing page in the cache */ |
| 1080 | Pgno pgno; /* The page number of a page in journal */ |
| 1081 | u32 cksum; /* Checksum used for sanity checking */ |
danielk1977 | 8186df8 | 2007-03-06 13:45:59 +0000 | [diff] [blame] | 1082 | u8 *aData = (u8 *)pPager->pTmpSpace; /* Temp storage for a page */ |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1083 | |
drh | c13148f | 2008-08-27 18:03:20 +0000 | [diff] [blame] | 1084 | /* isMainJrnl should be true for the main journal and false for |
drh | 9636284 | 2005-03-20 22:47:56 +0000 | [diff] [blame] | 1085 | ** statement journals. Verify that this is always the case |
| 1086 | */ |
drh | c13148f | 2008-08-27 18:03:20 +0000 | [diff] [blame] | 1087 | assert( jfd == (isMainJrnl ? pPager->jfd : pPager->stfd) ); |
danielk1977 | 8186df8 | 2007-03-06 13:45:59 +0000 | [diff] [blame] | 1088 | assert( aData ); |
drh | 9636284 | 2005-03-20 22:47:56 +0000 | [diff] [blame] | 1089 | |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 1090 | rc = read32bits(jfd, offset, &pgno); |
drh | 99ee360 | 2003-02-16 19:13:36 +0000 | [diff] [blame] | 1091 | if( rc!=SQLITE_OK ) return rc; |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 1092 | rc = sqlite3OsRead(jfd, aData, pPager->pageSize, offset+4); |
drh | 99ee360 | 2003-02-16 19:13:36 +0000 | [diff] [blame] | 1093 | if( rc!=SQLITE_OK ) return rc; |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1094 | pPager->journalOff += pPager->pageSize + 4; |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1095 | |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 1096 | /* Sanity checking on the page. This is more important that I originally |
| 1097 | ** thought. If a power failure occurs while the journal is being written, |
| 1098 | ** it could cause invalid data to be written into the journal. We need to |
| 1099 | ** detect this invalid data (with high probability) and ignore it. |
| 1100 | */ |
danielk1977 | 75edc16 | 2004-06-26 01:48:18 +0000 | [diff] [blame] | 1101 | if( pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){ |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 1102 | return SQLITE_DONE; |
| 1103 | } |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 1104 | if( pgno>(unsigned)pPager->dbSize ){ |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 1105 | return SQLITE_OK; |
| 1106 | } |
drh | c13148f | 2008-08-27 18:03:20 +0000 | [diff] [blame] | 1107 | if( isMainJrnl ){ |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 1108 | rc = read32bits(jfd, offset+pPager->pageSize+4, &cksum); |
drh | 99ee360 | 2003-02-16 19:13:36 +0000 | [diff] [blame] | 1109 | if( rc ) return rc; |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1110 | pPager->journalOff += 4; |
drh | 7416170 | 2006-02-24 02:53:49 +0000 | [diff] [blame] | 1111 | if( pager_cksum(pPager, aData)!=cksum ){ |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 1112 | return SQLITE_DONE; |
| 1113 | } |
| 1114 | } |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1115 | |
danielk1977 | aa5ccdf | 2004-06-14 05:10:42 +0000 | [diff] [blame] | 1116 | assert( pPager->state==PAGER_RESERVED || pPager->state>=PAGER_EXCLUSIVE ); |
danielk1977 | a3f3a5f | 2004-06-10 04:32:16 +0000 | [diff] [blame] | 1117 | |
| 1118 | /* If the pager is in RESERVED state, then there must be a copy of this |
| 1119 | ** page in the pager cache. In this case just update the pager cache, |
danielk1977 | 0de0bb3 | 2004-06-10 05:59:24 +0000 | [diff] [blame] | 1120 | ** not the database file. The page is left marked dirty in this case. |
| 1121 | ** |
danielk1977 | 2df71c7 | 2007-05-24 07:22:42 +0000 | [diff] [blame] | 1122 | ** An exception to the above rule: If the database is in no-sync mode |
| 1123 | ** and a page is moved during an incremental vacuum then the page may |
danielk1977 | 369f3a0 | 2007-05-24 09:41:20 +0000 | [diff] [blame] | 1124 | ** not be in the pager cache. Later: if a malloc() or IO error occurs |
| 1125 | ** during a Movepage() call, then the page may not be in the cache |
| 1126 | ** either. So the condition described in the above paragraph is not |
| 1127 | ** assert()able. |
danielk1977 | 2df71c7 | 2007-05-24 07:22:42 +0000 | [diff] [blame] | 1128 | ** |
danielk1977 | a3f3a5f | 2004-06-10 04:32:16 +0000 | [diff] [blame] | 1129 | ** If in EXCLUSIVE state, then we update the pager cache if it exists |
| 1130 | ** and the main file. The page is then marked not dirty. |
drh | 9636284 | 2005-03-20 22:47:56 +0000 | [diff] [blame] | 1131 | ** |
| 1132 | ** Ticket #1171: The statement journal might contain page content that is |
| 1133 | ** different from the page content at the start of the transaction. |
| 1134 | ** This occurs when a page is changed prior to the start of a statement |
| 1135 | ** then changed again within the statement. When rolling back such a |
| 1136 | ** statement we must not write to the original database unless we know |
drh | 5e38531 | 2007-06-16 04:42:12 +0000 | [diff] [blame] | 1137 | ** for certain that original page contents are synced into the main rollback |
| 1138 | ** journal. Otherwise, a power loss might leave modified data in the |
| 1139 | ** database file without an entry in the rollback journal that can |
| 1140 | ** restore the database to its original form. Two conditions must be |
| 1141 | ** met before writing to the database files. (1) the database must be |
| 1142 | ** locked. (2) we know that the original page content is fully synced |
| 1143 | ** in the main journal either because the page is not in cache or else |
| 1144 | ** the page is marked as needSync==0. |
drh | 4c02a23 | 2008-04-14 23:13:45 +0000 | [diff] [blame] | 1145 | ** |
| 1146 | ** 2008-04-14: When attempting to vacuum a corrupt database file, it |
| 1147 | ** is possible to fail a statement on a database that does not yet exist. |
| 1148 | ** Do not attempt to write if database file has never been opened. |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1149 | */ |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 1150 | pPg = pager_lookup(pPager, pgno); |
drh | 477731b | 2007-06-16 03:06:27 +0000 | [diff] [blame] | 1151 | PAGERTRACE4("PLAYBACK %d page %d hash(%08x)\n", |
| 1152 | PAGERID(pPager), pgno, pager_datahash(pPager->pageSize, aData)); |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 1153 | if( (pPager->state>=PAGER_EXCLUSIVE) |
| 1154 | && (pPg==0 || 0==(pPg->flags&PGHDR_NEED_SYNC)) |
| 1155 | && (pPager->fd->pMethods) |
| 1156 | ){ |
drh | 281b21d | 2008-08-22 12:57:08 +0000 | [diff] [blame] | 1157 | i64 ofst = (pgno-1)*(i64)pPager->pageSize; |
| 1158 | rc = sqlite3OsWrite(pPager->fd, aData, pPager->pageSize, ofst); |
danielk1977 | a3f3a5f | 2004-06-10 04:32:16 +0000 | [diff] [blame] | 1159 | } |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1160 | if( pPg ){ |
danielk1977 | 2812956 | 2005-01-11 10:25:06 +0000 | [diff] [blame] | 1161 | /* No page should ever be explicitly rolled back that is in use, except |
| 1162 | ** for page 1 which is held in use in order to keep the lock on the |
| 1163 | ** database active. However such a page may be rolled back as a result |
| 1164 | ** of an internal error resulting in an automatic call to |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 1165 | ** sqlite3PagerRollback(). |
drh | acf4ac9 | 2003-12-17 23:57:34 +0000 | [diff] [blame] | 1166 | */ |
drh | b6f4148 | 2004-05-14 01:58:11 +0000 | [diff] [blame] | 1167 | void *pData; |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 1168 | pData = pPg->pData; |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 1169 | memcpy(pData, aData, pPager->pageSize); |
danielk1977 | 9038bb6 | 2007-04-09 11:20:54 +0000 | [diff] [blame] | 1170 | if( pPager->xReiniter ){ |
danielk1977 | eaa06f6 | 2008-09-18 17:34:44 +0000 | [diff] [blame] | 1171 | pPager->xReiniter(pPg); |
drh | de64713 | 2004-05-07 17:57:49 +0000 | [diff] [blame] | 1172 | } |
drh | c047b9f | 2008-11-21 03:23:43 +0000 | [diff] [blame^] | 1173 | if( isMainJrnl ){ |
| 1174 | sqlite3PcacheMakeClean(pPg); |
| 1175 | } |
danielk1977 | 3c40737 | 2005-02-15 02:54:14 +0000 | [diff] [blame] | 1176 | #ifdef SQLITE_CHECK_PAGES |
drh | 9636284 | 2005-03-20 22:47:56 +0000 | [diff] [blame] | 1177 | pPg->pageHash = pager_pagehash(pPg); |
danielk1977 | 3c40737 | 2005-02-15 02:54:14 +0000 | [diff] [blame] | 1178 | #endif |
drh | 86a8811 | 2007-04-16 15:02:19 +0000 | [diff] [blame] | 1179 | /* If this was page 1, then restore the value of Pager.dbFileVers. |
| 1180 | ** Do this before any decoding. */ |
danielk1977 | 4148346 | 2007-03-24 16:45:04 +0000 | [diff] [blame] | 1181 | if( pgno==1 ){ |
drh | 86a8811 | 2007-04-16 15:02:19 +0000 | [diff] [blame] | 1182 | memcpy(&pPager->dbFileVers, &((u8*)pData)[24],sizeof(pPager->dbFileVers)); |
danielk1977 | 4148346 | 2007-03-24 16:45:04 +0000 | [diff] [blame] | 1183 | } |
drh | 86a8811 | 2007-04-16 15:02:19 +0000 | [diff] [blame] | 1184 | |
| 1185 | /* Decode the page just read from disk */ |
| 1186 | CODEC1(pPager, pData, pPg->pgno, 3); |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 1187 | sqlite3PcacheRelease(pPg); |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1188 | } |
| 1189 | return rc; |
| 1190 | } |
| 1191 | |
| 1192 | /* |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 1193 | ** Parameter zMaster is the name of a master journal file. A single journal |
| 1194 | ** file that referred to the master journal file has just been rolled back. |
| 1195 | ** This routine checks if it is possible to delete the master journal file, |
| 1196 | ** and does so if it is. |
drh | 726de59 | 2004-06-10 23:35:50 +0000 | [diff] [blame] | 1197 | ** |
danielk1977 | 65839c6 | 2007-08-30 08:08:17 +0000 | [diff] [blame] | 1198 | ** Argument zMaster may point to Pager.pTmpSpace. So that buffer is not |
| 1199 | ** available for use within this function. |
| 1200 | ** |
| 1201 | ** |
drh | 726de59 | 2004-06-10 23:35:50 +0000 | [diff] [blame] | 1202 | ** The master journal file contains the names of all child journals. |
| 1203 | ** To tell if a master journal can be deleted, check to each of the |
| 1204 | ** children. If all children are either missing or do not refer to |
| 1205 | ** a different master journal, then this master journal can be deleted. |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 1206 | */ |
danielk1977 | b4b4741 | 2007-08-17 15:53:36 +0000 | [diff] [blame] | 1207 | static int pager_delmaster(Pager *pPager, const char *zMaster){ |
| 1208 | sqlite3_vfs *pVfs = pPager->pVfs; |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 1209 | int rc; |
| 1210 | int master_open = 0; |
danielk1977 | b4b4741 | 2007-08-17 15:53:36 +0000 | [diff] [blame] | 1211 | sqlite3_file *pMaster; |
| 1212 | sqlite3_file *pJournal; |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 1213 | char *zMasterJournal = 0; /* Contents of master journal file */ |
drh | eb20625 | 2004-10-01 02:00:31 +0000 | [diff] [blame] | 1214 | i64 nMasterJournal; /* Size of master journal file */ |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 1215 | |
| 1216 | /* Open the master journal file exclusively in case some other process |
| 1217 | ** is running this routine also. Not that it makes too much difference. |
| 1218 | */ |
drh | e5ae573 | 2008-06-15 02:51:47 +0000 | [diff] [blame] | 1219 | pMaster = (sqlite3_file *)sqlite3Malloc(pVfs->szOsFile * 2); |
danielk1977 | fee2d25 | 2007-08-18 10:59:19 +0000 | [diff] [blame] | 1220 | pJournal = (sqlite3_file *)(((u8 *)pMaster) + pVfs->szOsFile); |
danielk1977 | b4b4741 | 2007-08-17 15:53:36 +0000 | [diff] [blame] | 1221 | if( !pMaster ){ |
| 1222 | rc = SQLITE_NOMEM; |
| 1223 | }else{ |
danielk1977 | fee2d25 | 2007-08-18 10:59:19 +0000 | [diff] [blame] | 1224 | int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MASTER_JOURNAL); |
| 1225 | rc = sqlite3OsOpen(pVfs, zMaster, pMaster, flags, 0); |
danielk1977 | b4b4741 | 2007-08-17 15:53:36 +0000 | [diff] [blame] | 1226 | } |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 1227 | if( rc!=SQLITE_OK ) goto delmaster_out; |
| 1228 | master_open = 1; |
danielk1977 | b4b4741 | 2007-08-17 15:53:36 +0000 | [diff] [blame] | 1229 | |
| 1230 | rc = sqlite3OsFileSize(pMaster, &nMasterJournal); |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 1231 | if( rc!=SQLITE_OK ) goto delmaster_out; |
| 1232 | |
| 1233 | if( nMasterJournal>0 ){ |
danielk1977 | 5865e3d | 2004-06-14 06:03:57 +0000 | [diff] [blame] | 1234 | char *zJournal; |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1235 | char *zMasterPtr = 0; |
danielk1977 | 65839c6 | 2007-08-30 08:08:17 +0000 | [diff] [blame] | 1236 | int nMasterPtr = pPager->pVfs->mxPathname+1; |
danielk1977 | 5865e3d | 2004-06-14 06:03:57 +0000 | [diff] [blame] | 1237 | |
| 1238 | /* Load the entire master journal file into space obtained from |
drh | 1743575 | 2007-08-16 04:30:38 +0000 | [diff] [blame] | 1239 | ** sqlite3_malloc() and pointed to by zMasterJournal. |
danielk1977 | 5865e3d | 2004-06-14 06:03:57 +0000 | [diff] [blame] | 1240 | */ |
drh | e5ae573 | 2008-06-15 02:51:47 +0000 | [diff] [blame] | 1241 | zMasterJournal = (char *)sqlite3Malloc(nMasterJournal + nMasterPtr); |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 1242 | if( !zMasterJournal ){ |
| 1243 | rc = SQLITE_NOMEM; |
| 1244 | goto delmaster_out; |
| 1245 | } |
danielk1977 | 65839c6 | 2007-08-30 08:08:17 +0000 | [diff] [blame] | 1246 | zMasterPtr = &zMasterJournal[nMasterJournal]; |
danielk1977 | b4b4741 | 2007-08-17 15:53:36 +0000 | [diff] [blame] | 1247 | rc = sqlite3OsRead(pMaster, zMasterJournal, nMasterJournal, 0); |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 1248 | if( rc!=SQLITE_OK ) goto delmaster_out; |
| 1249 | |
danielk1977 | 5865e3d | 2004-06-14 06:03:57 +0000 | [diff] [blame] | 1250 | zJournal = zMasterJournal; |
| 1251 | while( (zJournal-zMasterJournal)<nMasterJournal ){ |
danielk1977 | 861f745 | 2008-06-05 11:39:11 +0000 | [diff] [blame] | 1252 | int exists; |
| 1253 | rc = sqlite3OsAccess(pVfs, zJournal, SQLITE_ACCESS_EXISTS, &exists); |
| 1254 | if( rc!=SQLITE_OK ){ |
drh | 19db935 | 2008-03-27 22:42:51 +0000 | [diff] [blame] | 1255 | goto delmaster_out; |
| 1256 | } |
danielk1977 | 861f745 | 2008-06-05 11:39:11 +0000 | [diff] [blame] | 1257 | if( exists ){ |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 1258 | /* One of the journals pointed to by the master journal exists. |
| 1259 | ** Open it and check if it points at the master journal. If |
| 1260 | ** so, return without deleting the master journal file. |
| 1261 | */ |
drh | 3b7b78b | 2004-11-24 01:16:43 +0000 | [diff] [blame] | 1262 | int c; |
danielk1977 | fee2d25 | 2007-08-18 10:59:19 +0000 | [diff] [blame] | 1263 | int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MAIN_JOURNAL); |
| 1264 | rc = sqlite3OsOpen(pVfs, zJournal, pJournal, flags, 0); |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 1265 | if( rc!=SQLITE_OK ){ |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 1266 | goto delmaster_out; |
| 1267 | } |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 1268 | |
danielk1977 | 65839c6 | 2007-08-30 08:08:17 +0000 | [diff] [blame] | 1269 | rc = readMasterJournal(pJournal, zMasterPtr, nMasterPtr); |
danielk1977 | b4b4741 | 2007-08-17 15:53:36 +0000 | [diff] [blame] | 1270 | sqlite3OsClose(pJournal); |
danielk1977 | 9eed505 | 2004-06-04 10:38:30 +0000 | [diff] [blame] | 1271 | if( rc!=SQLITE_OK ){ |
danielk1977 | 9eed505 | 2004-06-04 10:38:30 +0000 | [diff] [blame] | 1272 | goto delmaster_out; |
| 1273 | } |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1274 | |
danielk1977 | 65839c6 | 2007-08-30 08:08:17 +0000 | [diff] [blame] | 1275 | c = zMasterPtr[0]!=0 && strcmp(zMasterPtr, zMaster)==0; |
drh | 3b7b78b | 2004-11-24 01:16:43 +0000 | [diff] [blame] | 1276 | if( c ){ |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1277 | /* We have a match. Do not delete the master journal file. */ |
| 1278 | goto delmaster_out; |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 1279 | } |
| 1280 | } |
danielk1977 | 5865e3d | 2004-06-14 06:03:57 +0000 | [diff] [blame] | 1281 | zJournal += (strlen(zJournal)+1); |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 1282 | } |
| 1283 | } |
| 1284 | |
danielk1977 | fee2d25 | 2007-08-18 10:59:19 +0000 | [diff] [blame] | 1285 | rc = sqlite3OsDelete(pVfs, zMaster, 0); |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 1286 | |
| 1287 | delmaster_out: |
| 1288 | if( zMasterJournal ){ |
drh | 1743575 | 2007-08-16 04:30:38 +0000 | [diff] [blame] | 1289 | sqlite3_free(zMasterJournal); |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 1290 | } |
| 1291 | if( master_open ){ |
danielk1977 | b4b4741 | 2007-08-17 15:53:36 +0000 | [diff] [blame] | 1292 | sqlite3OsClose(pMaster); |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 1293 | } |
danielk1977 | b4b4741 | 2007-08-17 15:53:36 +0000 | [diff] [blame] | 1294 | sqlite3_free(pMaster); |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 1295 | return rc; |
| 1296 | } |
| 1297 | |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 1298 | |
danielk1977 | e180dd9 | 2007-04-05 17:15:52 +0000 | [diff] [blame] | 1299 | static void pager_truncate_cache(Pager *pPager); |
| 1300 | |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 1301 | /* |
drh | cb4c40b | 2004-08-18 19:09:43 +0000 | [diff] [blame] | 1302 | ** Truncate the main file of the given pager to the number of pages |
danielk1977 | e180dd9 | 2007-04-05 17:15:52 +0000 | [diff] [blame] | 1303 | ** indicated. Also truncate the cached representation of the file. |
drh | 7fe3f7e | 2007-11-29 18:44:27 +0000 | [diff] [blame] | 1304 | ** |
| 1305 | ** Might might be the case that the file on disk is smaller than nPage. |
| 1306 | ** This can happen, for example, if we are in the middle of a transaction |
| 1307 | ** which has extended the file size and the new pages are still all held |
| 1308 | ** in cache, then an INSERT or UPDATE does a statement rollback. Some |
| 1309 | ** operating system implementations can get confused if you try to |
| 1310 | ** truncate a file to some size that is larger than it currently is, |
danielk1977 | 06e11af | 2008-05-06 18:13:26 +0000 | [diff] [blame] | 1311 | ** so detect this case and write a single zero byte to the end of the new |
| 1312 | ** file instead. |
drh | cb4c40b | 2004-08-18 19:09:43 +0000 | [diff] [blame] | 1313 | */ |
danielk1977 | d92db53 | 2008-11-17 04:56:24 +0000 | [diff] [blame] | 1314 | static int pager_truncate(Pager *pPager, Pgno nPage){ |
danielk1977 | e180dd9 | 2007-04-05 17:15:52 +0000 | [diff] [blame] | 1315 | int rc = SQLITE_OK; |
danielk1977 | 7a2b1ee | 2007-08-21 14:27:01 +0000 | [diff] [blame] | 1316 | if( pPager->state>=PAGER_EXCLUSIVE && pPager->fd->pMethods ){ |
drh | 7fe3f7e | 2007-11-29 18:44:27 +0000 | [diff] [blame] | 1317 | i64 currentSize, newSize; |
| 1318 | rc = sqlite3OsFileSize(pPager->fd, ¤tSize); |
| 1319 | newSize = pPager->pageSize*(i64)nPage; |
danielk1977 | 06e11af | 2008-05-06 18:13:26 +0000 | [diff] [blame] | 1320 | if( rc==SQLITE_OK && currentSize!=newSize ){ |
| 1321 | if( currentSize>newSize ){ |
| 1322 | rc = sqlite3OsTruncate(pPager->fd, newSize); |
| 1323 | }else{ |
| 1324 | rc = sqlite3OsWrite(pPager->fd, "", 1, newSize-1); |
| 1325 | } |
drh | 7fe3f7e | 2007-11-29 18:44:27 +0000 | [diff] [blame] | 1326 | } |
danielk1977 | e180dd9 | 2007-04-05 17:15:52 +0000 | [diff] [blame] | 1327 | } |
| 1328 | if( rc==SQLITE_OK ){ |
| 1329 | pPager->dbSize = nPage; |
| 1330 | pager_truncate_cache(pPager); |
| 1331 | } |
| 1332 | return rc; |
drh | cb4c40b | 2004-08-18 19:09:43 +0000 | [diff] [blame] | 1333 | } |
| 1334 | |
| 1335 | /* |
drh | c80f058 | 2007-05-01 16:59:48 +0000 | [diff] [blame] | 1336 | ** Set the sectorSize for the given pager. |
| 1337 | ** |
drh | 334c80d | 2008-03-28 17:41:13 +0000 | [diff] [blame] | 1338 | ** The sector size is at least as big as the sector size reported |
| 1339 | ** by sqlite3OsSectorSize(). The minimum sector size is 512. |
drh | c80f058 | 2007-05-01 16:59:48 +0000 | [diff] [blame] | 1340 | */ |
| 1341 | static void setSectorSize(Pager *pPager){ |
danielk1977 | 7a2b1ee | 2007-08-21 14:27:01 +0000 | [diff] [blame] | 1342 | assert(pPager->fd->pMethods||pPager->tempFile); |
| 1343 | if( !pPager->tempFile ){ |
| 1344 | /* Sector size doesn't matter for temporary files. Also, the file |
| 1345 | ** may not have been opened yet, in whcih case the OsSectorSize() |
| 1346 | ** call will segfault. |
| 1347 | */ |
| 1348 | pPager->sectorSize = sqlite3OsSectorSize(pPager->fd); |
| 1349 | } |
drh | 334c80d | 2008-03-28 17:41:13 +0000 | [diff] [blame] | 1350 | if( pPager->sectorSize<512 ){ |
| 1351 | pPager->sectorSize = 512; |
drh | c80f058 | 2007-05-01 16:59:48 +0000 | [diff] [blame] | 1352 | } |
| 1353 | } |
| 1354 | |
| 1355 | /* |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1356 | ** Playback the journal and thus restore the database file to |
| 1357 | ** the state it was in before we started making changes. |
| 1358 | ** |
drh | 34e79ce | 2004-02-08 06:05:46 +0000 | [diff] [blame] | 1359 | ** The journal file format is as follows: |
| 1360 | ** |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 1361 | ** (1) 8 byte prefix. A copy of aJournalMagic[]. |
| 1362 | ** (2) 4 byte big-endian integer which is the number of valid page records |
drh | 34e79ce | 2004-02-08 06:05:46 +0000 | [diff] [blame] | 1363 | ** in the journal. If this value is 0xffffffff, then compute the |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 1364 | ** number of page records from the journal size. |
| 1365 | ** (3) 4 byte big-endian integer which is the initial value for the |
| 1366 | ** sanity checksum. |
| 1367 | ** (4) 4 byte integer which is the number of pages to truncate the |
drh | 34e79ce | 2004-02-08 06:05:46 +0000 | [diff] [blame] | 1368 | ** database to during a rollback. |
drh | 334c80d | 2008-03-28 17:41:13 +0000 | [diff] [blame] | 1369 | ** (5) 4 byte big-endian integer which is the sector size. The header |
| 1370 | ** is this many bytes in size. |
| 1371 | ** (6) 4 byte big-endian integer which is the page case. |
| 1372 | ** (7) 4 byte integer which is the number of bytes in the master journal |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 1373 | ** name. The value may be zero (indicate that there is no master |
| 1374 | ** journal.) |
drh | 334c80d | 2008-03-28 17:41:13 +0000 | [diff] [blame] | 1375 | ** (8) N bytes of the master journal name. The name will be nul-terminated |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 1376 | ** and might be shorter than the value read from (5). If the first byte |
| 1377 | ** of the name is \000 then there is no master journal. The master |
| 1378 | ** journal name is stored in UTF-8. |
drh | 334c80d | 2008-03-28 17:41:13 +0000 | [diff] [blame] | 1379 | ** (9) Zero or more pages instances, each as follows: |
drh | 34e79ce | 2004-02-08 06:05:46 +0000 | [diff] [blame] | 1380 | ** + 4 byte page number. |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 1381 | ** + pPager->pageSize bytes of data. |
| 1382 | ** + 4 byte checksum |
drh | 34e79ce | 2004-02-08 06:05:46 +0000 | [diff] [blame] | 1383 | ** |
drh | 334c80d | 2008-03-28 17:41:13 +0000 | [diff] [blame] | 1384 | ** When we speak of the journal header, we mean the first 8 items above. |
| 1385 | ** Each entry in the journal is an instance of the 9th item. |
drh | 34e79ce | 2004-02-08 06:05:46 +0000 | [diff] [blame] | 1386 | ** |
| 1387 | ** Call the value from the second bullet "nRec". nRec is the number of |
| 1388 | ** valid page entries in the journal. In most cases, you can compute the |
| 1389 | ** value of nRec from the size of the journal file. But if a power |
| 1390 | ** failure occurred while the journal was being written, it could be the |
| 1391 | ** case that the size of the journal file had already been increased but |
| 1392 | ** the extra entries had not yet made it safely to disk. In such a case, |
| 1393 | ** the value of nRec computed from the file size would be too large. For |
| 1394 | ** that reason, we always use the nRec value in the header. |
| 1395 | ** |
| 1396 | ** If the nRec value is 0xffffffff it means that nRec should be computed |
| 1397 | ** from the file size. This value is used when the user selects the |
| 1398 | ** no-sync option for the journal. A power failure could lead to corruption |
| 1399 | ** in this case. But for things like temporary table (which will be |
| 1400 | ** deleted when the power is restored) we don't care. |
| 1401 | ** |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 1402 | ** If the file opened as the journal file is not a well-formed |
danielk1977 | ece80f1 | 2004-06-23 01:05:26 +0000 | [diff] [blame] | 1403 | ** journal file then all pages up to the first corrupted page are rolled |
| 1404 | ** back (or no pages if the journal header is corrupted). The journal file |
| 1405 | ** is then deleted and SQLITE_OK returned, just as if no corruption had |
| 1406 | ** been encountered. |
| 1407 | ** |
| 1408 | ** If an I/O or malloc() error occurs, the journal-file is not deleted |
| 1409 | ** and an error code is returned. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1410 | */ |
danielk1977 | e277be0 | 2007-03-23 18:12:06 +0000 | [diff] [blame] | 1411 | static int pager_playback(Pager *pPager, int isHot){ |
danielk1977 | b4b4741 | 2007-08-17 15:53:36 +0000 | [diff] [blame] | 1412 | sqlite3_vfs *pVfs = pPager->pVfs; |
drh | eb20625 | 2004-10-01 02:00:31 +0000 | [diff] [blame] | 1413 | i64 szJ; /* Size of the journal file in bytes */ |
danielk1977 | c3e8f5e | 2004-06-28 01:16:46 +0000 | [diff] [blame] | 1414 | u32 nRec; /* Number of Records in the journal */ |
shane | 0b8d276 | 2008-07-22 05:18:00 +0000 | [diff] [blame] | 1415 | u32 u; /* Unsigned loop counter */ |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 1416 | Pgno mxPg = 0; /* Size of the original file in pages */ |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 1417 | int rc; /* Result code of a subroutine */ |
danielk1977 | 861f745 | 2008-06-05 11:39:11 +0000 | [diff] [blame] | 1418 | int res = 1; /* Value returned by sqlite3OsAccess() */ |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 1419 | char *zMaster = 0; /* Name of master journal file if any */ |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1420 | |
drh | c3a64ba | 2001-11-22 00:01:27 +0000 | [diff] [blame] | 1421 | /* Figure out how many records are in the journal. Abort early if |
| 1422 | ** the journal is empty. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1423 | */ |
drh | 8cfbf08 | 2001-09-19 13:22:39 +0000 | [diff] [blame] | 1424 | assert( pPager->journalOpen ); |
drh | 054889e | 2005-11-30 03:20:31 +0000 | [diff] [blame] | 1425 | rc = sqlite3OsFileSize(pPager->jfd, &szJ); |
danielk1977 | 334cdb6 | 2007-03-26 08:05:12 +0000 | [diff] [blame] | 1426 | if( rc!=SQLITE_OK || szJ==0 ){ |
drh | c3a64ba | 2001-11-22 00:01:27 +0000 | [diff] [blame] | 1427 | goto end_playback; |
| 1428 | } |
drh | 240c579 | 2004-02-08 00:40:52 +0000 | [diff] [blame] | 1429 | |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1430 | /* Read the master journal name from the journal, if it is present. |
| 1431 | ** If a master journal file name is specified, but the file is not |
| 1432 | ** present on disk, then the journal is not hot and does not need to be |
| 1433 | ** played back. |
drh | 240c579 | 2004-02-08 00:40:52 +0000 | [diff] [blame] | 1434 | */ |
danielk1977 | 65839c6 | 2007-08-30 08:08:17 +0000 | [diff] [blame] | 1435 | zMaster = pPager->pTmpSpace; |
| 1436 | rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1); |
danielk1977 | 861f745 | 2008-06-05 11:39:11 +0000 | [diff] [blame] | 1437 | if( rc==SQLITE_OK && zMaster[0] ){ |
| 1438 | rc = sqlite3OsAccess(pVfs, zMaster, SQLITE_ACCESS_EXISTS, &res); |
drh | c3a64ba | 2001-11-22 00:01:27 +0000 | [diff] [blame] | 1439 | } |
danielk1977 | 65839c6 | 2007-08-30 08:08:17 +0000 | [diff] [blame] | 1440 | zMaster = 0; |
danielk1977 | 861f745 | 2008-06-05 11:39:11 +0000 | [diff] [blame] | 1441 | if( rc!=SQLITE_OK || !res ){ |
danielk1977 | ce98bba | 2008-04-03 10:13:01 +0000 | [diff] [blame] | 1442 | goto end_playback; |
| 1443 | } |
| 1444 | pPager->journalOff = 0; |
drh | c3a64ba | 2001-11-22 00:01:27 +0000 | [diff] [blame] | 1445 | |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1446 | /* This loop terminates either when the readJournalHdr() call returns |
| 1447 | ** SQLITE_DONE or an IO error occurs. */ |
| 1448 | while( 1 ){ |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 1449 | |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1450 | /* Read the next journal header from the journal file. If there are |
| 1451 | ** not enough bytes left in the journal file for a complete header, or |
| 1452 | ** it is corrupted, then a process must of failed while writing it. |
| 1453 | ** This indicates nothing more needs to be rolled back. |
| 1454 | */ |
| 1455 | rc = readJournalHdr(pPager, szJ, &nRec, &mxPg); |
| 1456 | if( rc!=SQLITE_OK ){ |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 1457 | if( rc==SQLITE_DONE ){ |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 1458 | rc = SQLITE_OK; |
| 1459 | } |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1460 | goto end_playback; |
| 1461 | } |
| 1462 | |
| 1463 | /* If nRec is 0xffffffff, then this journal was created by a process |
| 1464 | ** working in no-sync mode. This means that the rest of the journal |
| 1465 | ** file consists of pages, there are no more journal headers. Compute |
| 1466 | ** the value of nRec based on this assumption. |
| 1467 | */ |
| 1468 | if( nRec==0xffffffff ){ |
| 1469 | assert( pPager->journalOff==JOURNAL_HDR_SZ(pPager) ); |
| 1470 | nRec = (szJ - JOURNAL_HDR_SZ(pPager))/JOURNAL_PG_SZ(pPager); |
| 1471 | } |
| 1472 | |
danielk1977 | e277be0 | 2007-03-23 18:12:06 +0000 | [diff] [blame] | 1473 | /* If nRec is 0 and this rollback is of a transaction created by this |
drh | 8940f4e | 2007-08-11 00:26:20 +0000 | [diff] [blame] | 1474 | ** process and if this is the final header in the journal, then it means |
| 1475 | ** that this part of the journal was being filled but has not yet been |
| 1476 | ** synced to disk. Compute the number of pages based on the remaining |
| 1477 | ** size of the file. |
| 1478 | ** |
| 1479 | ** The third term of the test was added to fix ticket #2565. |
danielk1977 | e277be0 | 2007-03-23 18:12:06 +0000 | [diff] [blame] | 1480 | */ |
drh | 8940f4e | 2007-08-11 00:26:20 +0000 | [diff] [blame] | 1481 | if( nRec==0 && !isHot && |
| 1482 | pPager->journalHdr+JOURNAL_HDR_SZ(pPager)==pPager->journalOff ){ |
danielk1977 | e277be0 | 2007-03-23 18:12:06 +0000 | [diff] [blame] | 1483 | nRec = (szJ - pPager->journalOff) / JOURNAL_PG_SZ(pPager); |
| 1484 | } |
| 1485 | |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1486 | /* If this is the first header read from the journal, truncate the |
drh | 85b623f | 2007-12-13 21:54:09 +0000 | [diff] [blame] | 1487 | ** database file back to its original size. |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1488 | */ |
danielk1977 | e180dd9 | 2007-04-05 17:15:52 +0000 | [diff] [blame] | 1489 | if( pPager->journalOff==JOURNAL_HDR_SZ(pPager) ){ |
drh | cb4c40b | 2004-08-18 19:09:43 +0000 | [diff] [blame] | 1490 | rc = pager_truncate(pPager, mxPg); |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1491 | if( rc!=SQLITE_OK ){ |
| 1492 | goto end_playback; |
| 1493 | } |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1494 | } |
| 1495 | |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1496 | /* Copy original pages out of the journal and back into the database file. |
| 1497 | */ |
shane | 0b8d276 | 2008-07-22 05:18:00 +0000 | [diff] [blame] | 1498 | for(u=0; u<nRec; u++){ |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 1499 | rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1); |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1500 | if( rc!=SQLITE_OK ){ |
| 1501 | if( rc==SQLITE_DONE ){ |
| 1502 | rc = SQLITE_OK; |
| 1503 | pPager->journalOff = szJ; |
| 1504 | break; |
| 1505 | }else{ |
drh | a9625ea | 2008-09-03 00:08:29 +0000 | [diff] [blame] | 1506 | /* If we are unable to rollback, then the database is probably |
| 1507 | ** going to end up being corrupt. It is corrupt to us, anyhow. |
| 1508 | ** Perhaps the next process to come along can fix it.... |
| 1509 | */ |
danielk1977 | 98c2190 | 2008-09-23 16:41:29 +0000 | [diff] [blame] | 1510 | rc = SQLITE_CORRUPT_BKPT; |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1511 | goto end_playback; |
| 1512 | } |
| 1513 | } |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 1514 | } |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1515 | } |
drh | 580eeaf | 2006-02-24 03:09:37 +0000 | [diff] [blame] | 1516 | /*NOTREACHED*/ |
| 1517 | assert( 0 ); |
drh | 4a0681e | 2003-02-13 01:58:20 +0000 | [diff] [blame] | 1518 | |
| 1519 | end_playback: |
drh | c047b9f | 2008-11-21 03:23:43 +0000 | [diff] [blame^] | 1520 | /* There may be pages in cache that are dirty but which were not in |
| 1521 | ** the rollback journal. Such pages would have been taken out of the |
| 1522 | ** freelist (and hence marked as DontRollback). All such pages must |
| 1523 | ** be reinitialized. |
| 1524 | */ |
| 1525 | if( rc==SQLITE_OK && pPager->xReiniter ){ |
| 1526 | PgHdr *pDirty; /* List of page that are still dirty */ |
| 1527 | pDirty = sqlite3PcacheDirtyList(pPager->pPCache); |
| 1528 | while( pDirty ){ |
| 1529 | pPager->xReiniter(pDirty); |
| 1530 | sqlite3PcacheMakeClean(pDirty); |
| 1531 | pDirty = pDirty->pDirty; |
| 1532 | } |
| 1533 | } |
danielk1977 | 8191bff | 2004-06-28 04:52:30 +0000 | [diff] [blame] | 1534 | if( rc==SQLITE_OK ){ |
danielk1977 | 65839c6 | 2007-08-30 08:08:17 +0000 | [diff] [blame] | 1535 | zMaster = pPager->pTmpSpace; |
| 1536 | rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1); |
| 1537 | } |
| 1538 | if( rc==SQLITE_OK ){ |
danielk1977 | df2566a | 2008-05-07 19:11:03 +0000 | [diff] [blame] | 1539 | rc = pager_end_transaction(pPager, zMaster[0]!='\0'); |
danielk1977 | 8191bff | 2004-06-28 04:52:30 +0000 | [diff] [blame] | 1540 | } |
danielk1977 | c56774e | 2008-10-07 11:51:20 +0000 | [diff] [blame] | 1541 | if( rc==SQLITE_OK && zMaster[0] && res ){ |
danielk1977 | 979f38e | 2007-03-27 16:19:51 +0000 | [diff] [blame] | 1542 | /* If there was a master journal and this routine will return success, |
danielk1977 | 32554c1 | 2005-01-22 03:39:39 +0000 | [diff] [blame] | 1543 | ** see if it is possible to delete the master journal. |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 1544 | */ |
danielk1977 | 65839c6 | 2007-08-30 08:08:17 +0000 | [diff] [blame] | 1545 | rc = pager_delmaster(pPager, zMaster); |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 1546 | } |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1547 | |
| 1548 | /* The Pager.sectorSize variable may have been updated while rolling |
drh | 3ceeb75 | 2007-03-29 18:19:52 +0000 | [diff] [blame] | 1549 | ** back a journal created by a process with a different sector size |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1550 | ** value. Reset it to the correct value for this process. |
| 1551 | */ |
drh | c80f058 | 2007-05-01 16:59:48 +0000 | [diff] [blame] | 1552 | setSectorSize(pPager); |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 1553 | return rc; |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1554 | } |
| 1555 | |
| 1556 | /* |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 1557 | ** Playback the statement journal. |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1558 | ** |
| 1559 | ** This is similar to playing back the transaction journal but with |
| 1560 | ** a few extra twists. |
| 1561 | ** |
drh | 663fc63 | 2002-02-02 18:49:19 +0000 | [diff] [blame] | 1562 | ** (1) The number of pages in the database file at the start of |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 1563 | ** the statement is stored in pPager->stmtSize, not in the |
drh | 663fc63 | 2002-02-02 18:49:19 +0000 | [diff] [blame] | 1564 | ** journal file itself. |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1565 | ** |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 1566 | ** (2) In addition to playing back the statement journal, also |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1567 | ** playback all pages of the transaction journal beginning |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 1568 | ** at offset pPager->stmtJSize. |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1569 | */ |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 1570 | static int pager_stmt_playback(Pager *pPager){ |
drh | eb20625 | 2004-10-01 02:00:31 +0000 | [diff] [blame] | 1571 | i64 szJ; /* Size of the full journal */ |
| 1572 | i64 hdrOff; |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 1573 | int nRec; /* Number of Records */ |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1574 | int i; /* Loop counter */ |
| 1575 | int rc; |
| 1576 | |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1577 | szJ = pPager->journalOff; |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1578 | |
danielk1977 | 4099f6e | 2007-03-19 11:25:20 +0000 | [diff] [blame] | 1579 | /* Set hdrOff to be the offset just after the end of the last journal |
| 1580 | ** page written before the first journal-header for this statement |
| 1581 | ** transaction was written, or the end of the file if no journal |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1582 | ** header was written. |
| 1583 | */ |
| 1584 | hdrOff = pPager->stmtHdrOff; |
| 1585 | assert( pPager->fullSync || !hdrOff ); |
| 1586 | if( !hdrOff ){ |
| 1587 | hdrOff = szJ; |
| 1588 | } |
| 1589 | |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1590 | /* Truncate the database back to its original size. |
| 1591 | */ |
danielk1977 | e180dd9 | 2007-04-05 17:15:52 +0000 | [diff] [blame] | 1592 | rc = pager_truncate(pPager, pPager->stmtSize); |
drh | 1aa2d8b | 2007-01-03 15:34:29 +0000 | [diff] [blame] | 1593 | assert( pPager->state>=PAGER_SHARED ); |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1594 | |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 1595 | /* Figure out how many records are in the statement journal. |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1596 | */ |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 1597 | assert( pPager->stmtInUse && pPager->journalOpen ); |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 1598 | nRec = pPager->stmtNRec; |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1599 | |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 1600 | /* Copy original pages out of the statement journal and back into the |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 1601 | ** database file. Note that the statement journal omits checksums from |
| 1602 | ** each record since power-failure recovery is not important to statement |
| 1603 | ** journals. |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1604 | */ |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 1605 | for(i=0; i<nRec; i++){ |
| 1606 | i64 offset = i*(4+pPager->pageSize); |
| 1607 | rc = pager_playback_one_page(pPager, pPager->stfd, offset, 0); |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 1608 | assert( rc!=SQLITE_DONE ); |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 1609 | if( rc!=SQLITE_OK ) goto end_stmt_playback; |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1610 | } |
| 1611 | |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1612 | /* Now roll some pages back from the transaction journal. Pager.stmtJSize |
| 1613 | ** was the size of the journal file when this statement was started, so |
| 1614 | ** everything after that needs to be rolled back, either into the |
| 1615 | ** database, the memory cache, or both. |
| 1616 | ** |
| 1617 | ** If it is not zero, then Pager.stmtHdrOff is the offset to the start |
| 1618 | ** of the first journal header written during this statement transaction. |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1619 | */ |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1620 | pPager->journalOff = pPager->stmtJSize; |
danielk1977 | 75edc16 | 2004-06-26 01:48:18 +0000 | [diff] [blame] | 1621 | pPager->cksumInit = pPager->stmtCksum; |
danielk1977 | 4099f6e | 2007-03-19 11:25:20 +0000 | [diff] [blame] | 1622 | while( pPager->journalOff < hdrOff ){ |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 1623 | rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1); |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1624 | assert( rc!=SQLITE_DONE ); |
| 1625 | if( rc!=SQLITE_OK ) goto end_stmt_playback; |
| 1626 | } |
| 1627 | |
| 1628 | while( pPager->journalOff < szJ ){ |
danielk1977 | f011300 | 2006-01-24 12:09:17 +0000 | [diff] [blame] | 1629 | u32 nJRec; /* Number of Journal Records */ |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1630 | u32 dummy; |
danielk1977 | f011300 | 2006-01-24 12:09:17 +0000 | [diff] [blame] | 1631 | rc = readJournalHdr(pPager, szJ, &nJRec, &dummy); |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 1632 | if( rc!=SQLITE_OK ){ |
| 1633 | assert( rc!=SQLITE_DONE ); |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 1634 | goto end_stmt_playback; |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 1635 | } |
danielk1977 | f011300 | 2006-01-24 12:09:17 +0000 | [diff] [blame] | 1636 | if( nJRec==0 ){ |
| 1637 | nJRec = (szJ - pPager->journalOff) / (pPager->pageSize+8); |
danielk1977 | 75edc16 | 2004-06-26 01:48:18 +0000 | [diff] [blame] | 1638 | } |
danielk1977 | f011300 | 2006-01-24 12:09:17 +0000 | [diff] [blame] | 1639 | for(i=nJRec-1; i>=0 && pPager->journalOff < szJ; i--){ |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 1640 | rc = pager_playback_one_page(pPager, pPager->jfd, pPager->journalOff, 1); |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1641 | assert( rc!=SQLITE_DONE ); |
| 1642 | if( rc!=SQLITE_OK ) goto end_stmt_playback; |
| 1643 | } |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1644 | } |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1645 | |
| 1646 | pPager->journalOff = szJ; |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1647 | |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 1648 | end_stmt_playback: |
danielk1977 | 8a7aea3 | 2006-01-23 15:25:48 +0000 | [diff] [blame] | 1649 | if( rc==SQLITE_OK) { |
danielk1977 | 75edc16 | 2004-06-26 01:48:18 +0000 | [diff] [blame] | 1650 | pPager->journalOff = szJ; |
| 1651 | /* pager_reload_cache(pPager); */ |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1652 | } |
| 1653 | return rc; |
| 1654 | } |
| 1655 | |
| 1656 | /* |
drh | f57b14a | 2001-09-14 18:54:08 +0000 | [diff] [blame] | 1657 | ** Change the maximum number of in-memory pages that are allowed. |
| 1658 | */ |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 1659 | void sqlite3PagerSetCachesize(Pager *pPager, int mxPage){ |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 1660 | sqlite3PcacheSetCachesize(pPager->pPCache, mxPage); |
drh | f57b14a | 2001-09-14 18:54:08 +0000 | [diff] [blame] | 1661 | } |
| 1662 | |
| 1663 | /* |
drh | 973b6e3 | 2003-02-12 14:09:42 +0000 | [diff] [blame] | 1664 | ** Adjust the robustness of the database to damage due to OS crashes |
| 1665 | ** or power failures by changing the number of syncs()s when writing |
| 1666 | ** the rollback journal. There are three levels: |
| 1667 | ** |
drh | 054889e | 2005-11-30 03:20:31 +0000 | [diff] [blame] | 1668 | ** OFF sqlite3OsSync() is never called. This is the default |
drh | 973b6e3 | 2003-02-12 14:09:42 +0000 | [diff] [blame] | 1669 | ** for temporary and transient files. |
| 1670 | ** |
| 1671 | ** NORMAL The journal is synced once before writes begin on the |
| 1672 | ** database. This is normally adequate protection, but |
| 1673 | ** it is theoretically possible, though very unlikely, |
| 1674 | ** that an inopertune power failure could leave the journal |
| 1675 | ** in a state which would cause damage to the database |
| 1676 | ** when it is rolled back. |
| 1677 | ** |
| 1678 | ** FULL The journal is synced twice before writes begin on the |
drh | 34e79ce | 2004-02-08 06:05:46 +0000 | [diff] [blame] | 1679 | ** database (with some additional information - the nRec field |
| 1680 | ** of the journal header - being written in between the two |
| 1681 | ** syncs). If we assume that writing a |
drh | 973b6e3 | 2003-02-12 14:09:42 +0000 | [diff] [blame] | 1682 | ** single disk sector is atomic, then this mode provides |
| 1683 | ** assurance that the journal will not be corrupted to the |
| 1684 | ** point of causing damage to the database during rollback. |
| 1685 | ** |
| 1686 | ** Numeric values associated with these states are OFF==1, NORMAL=2, |
| 1687 | ** and FULL=3. |
| 1688 | */ |
danielk1977 | 93758c8 | 2005-01-21 08:13:14 +0000 | [diff] [blame] | 1689 | #ifndef SQLITE_OMIT_PAGER_PRAGMAS |
drh | 281b21d | 2008-08-22 12:57:08 +0000 | [diff] [blame] | 1690 | void sqlite3PagerSetSafetyLevel(Pager *pPager, int level, int bFullFsync){ |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 1691 | pPager->noSync = level==1 || pPager->tempFile; |
drh | 973b6e3 | 2003-02-12 14:09:42 +0000 | [diff] [blame] | 1692 | pPager->fullSync = level==3 && !pPager->tempFile; |
drh | 281b21d | 2008-08-22 12:57:08 +0000 | [diff] [blame] | 1693 | pPager->sync_flags = (bFullFsync?SQLITE_SYNC_FULL:SQLITE_SYNC_NORMAL); |
danielk1977 | 1d850a7 | 2004-05-31 08:26:49 +0000 | [diff] [blame] | 1694 | if( pPager->noSync ) pPager->needSync = 0; |
drh | 973b6e3 | 2003-02-12 14:09:42 +0000 | [diff] [blame] | 1695 | } |
danielk1977 | 93758c8 | 2005-01-21 08:13:14 +0000 | [diff] [blame] | 1696 | #endif |
drh | 973b6e3 | 2003-02-12 14:09:42 +0000 | [diff] [blame] | 1697 | |
| 1698 | /* |
drh | af6df11 | 2005-06-07 02:12:30 +0000 | [diff] [blame] | 1699 | ** The following global variable is incremented whenever the library |
| 1700 | ** attempts to open a temporary file. This information is used for |
| 1701 | ** testing and analysis only. |
| 1702 | */ |
drh | 0f7eb61 | 2006-08-08 13:51:43 +0000 | [diff] [blame] | 1703 | #ifdef SQLITE_TEST |
drh | af6df11 | 2005-06-07 02:12:30 +0000 | [diff] [blame] | 1704 | int sqlite3_opentemp_count = 0; |
drh | 0f7eb61 | 2006-08-08 13:51:43 +0000 | [diff] [blame] | 1705 | #endif |
drh | af6df11 | 2005-06-07 02:12:30 +0000 | [diff] [blame] | 1706 | |
| 1707 | /* |
drh | 3f56e6e | 2007-03-15 01:16:47 +0000 | [diff] [blame] | 1708 | ** Open a temporary file. |
| 1709 | ** |
| 1710 | ** Write the file descriptor into *fd. Return SQLITE_OK on success or some |
danielk1977 | fee2d25 | 2007-08-18 10:59:19 +0000 | [diff] [blame] | 1711 | ** other error code if we fail. The OS will automatically delete the temporary |
| 1712 | ** file when it is closed. |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1713 | */ |
danielk1977 | b4b4741 | 2007-08-17 15:53:36 +0000 | [diff] [blame] | 1714 | static int sqlite3PagerOpentemp( |
danielk1977 | 17b90b5 | 2008-06-06 11:11:25 +0000 | [diff] [blame] | 1715 | Pager *pPager, /* The pager object */ |
drh | 33f4e02 | 2007-09-03 15:19:34 +0000 | [diff] [blame] | 1716 | sqlite3_file *pFile, /* Write the file descriptor here */ |
drh | 33f4e02 | 2007-09-03 15:19:34 +0000 | [diff] [blame] | 1717 | int vfsFlags /* Flags passed through to the VFS */ |
danielk1977 | b4b4741 | 2007-08-17 15:53:36 +0000 | [diff] [blame] | 1718 | ){ |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1719 | int rc; |
drh | 3f56e6e | 2007-03-15 01:16:47 +0000 | [diff] [blame] | 1720 | |
drh | 0f7eb61 | 2006-08-08 13:51:43 +0000 | [diff] [blame] | 1721 | #ifdef SQLITE_TEST |
drh | af6df11 | 2005-06-07 02:12:30 +0000 | [diff] [blame] | 1722 | sqlite3_opentemp_count++; /* Used for testing and analysis only */ |
drh | 0f7eb61 | 2006-08-08 13:51:43 +0000 | [diff] [blame] | 1723 | #endif |
danielk1977 | b4b4741 | 2007-08-17 15:53:36 +0000 | [diff] [blame] | 1724 | |
drh | 33f4e02 | 2007-09-03 15:19:34 +0000 | [diff] [blame] | 1725 | vfsFlags |= SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE | |
| 1726 | SQLITE_OPEN_EXCLUSIVE | SQLITE_OPEN_DELETEONCLOSE; |
danielk1977 | 17b90b5 | 2008-06-06 11:11:25 +0000 | [diff] [blame] | 1727 | rc = sqlite3OsOpen(pPager->pVfs, 0, pFile, vfsFlags, 0); |
drh | ae28c01 | 2007-08-24 16:29:23 +0000 | [diff] [blame] | 1728 | assert( rc!=SQLITE_OK || pFile->pMethods ); |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1729 | return rc; |
| 1730 | } |
| 1731 | |
danielk1977 | a858aa2 | 2008-08-22 16:22:17 +0000 | [diff] [blame] | 1732 | static int pagerStress(void *,PgHdr *); |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 1733 | |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1734 | /* |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1735 | ** Create a new page cache and put a pointer to the page cache in *ppPager. |
drh | 5e00f6c | 2001-09-13 13:46:56 +0000 | [diff] [blame] | 1736 | ** The file to be cached need not exist. The file is not locked until |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 1737 | ** the first call to sqlite3PagerGet() and is only held open until the |
| 1738 | ** last page is released using sqlite3PagerUnref(). |
drh | 382c024 | 2001-10-06 16:33:02 +0000 | [diff] [blame] | 1739 | ** |
drh | 6446c4d | 2001-12-15 14:22:18 +0000 | [diff] [blame] | 1740 | ** If zFilename is NULL then a randomly-named temporary file is created |
drh | 1cc8c44 | 2007-08-24 16:08:29 +0000 | [diff] [blame] | 1741 | ** and used as the file to be cached. The file will be deleted |
drh | 6446c4d | 2001-12-15 14:22:18 +0000 | [diff] [blame] | 1742 | ** automatically when it is closed. |
drh | 90f5ecb | 2004-07-22 01:19:35 +0000 | [diff] [blame] | 1743 | ** |
| 1744 | ** If zFilename is ":memory:" then all information is held in cache. |
| 1745 | ** It is never written to disk. This can be used to implement an |
| 1746 | ** in-memory database. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1747 | */ |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 1748 | int sqlite3PagerOpen( |
drh | 86f8c19 | 2007-08-22 00:39:19 +0000 | [diff] [blame] | 1749 | sqlite3_vfs *pVfs, /* The virtual file system to use */ |
drh | 7e3b0a0 | 2001-04-28 16:52:40 +0000 | [diff] [blame] | 1750 | Pager **ppPager, /* Return the Pager structure here */ |
| 1751 | const char *zFilename, /* Name of the database file to open */ |
drh | da47d77 | 2002-12-02 04:25:19 +0000 | [diff] [blame] | 1752 | int nExtra, /* Extra bytes append to each in-memory page */ |
drh | 33f4e02 | 2007-09-03 15:19:34 +0000 | [diff] [blame] | 1753 | int flags, /* flags controlling this file */ |
| 1754 | int vfsFlags /* flags passed through to sqlite3_vfs.xOpen() */ |
drh | 7e3b0a0 | 2001-04-28 16:52:40 +0000 | [diff] [blame] | 1755 | ){ |
danielk1977 | b4b4741 | 2007-08-17 15:53:36 +0000 | [diff] [blame] | 1756 | u8 *pPtr; |
danielk1977 | aef0bf6 | 2005-12-30 16:28:01 +0000 | [diff] [blame] | 1757 | Pager *pPager = 0; |
danielk1977 | cfe9a69 | 2004-06-16 12:00:29 +0000 | [diff] [blame] | 1758 | int rc = SQLITE_OK; |
| 1759 | int i; |
danielk1977 | 8def5ea | 2004-06-16 10:39:52 +0000 | [diff] [blame] | 1760 | int tempFile = 0; |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 1761 | int memDb = 0; |
drh | 5e00f6c | 2001-09-13 13:46:56 +0000 | [diff] [blame] | 1762 | int readOnly = 0; |
drh | 7bec505 | 2005-02-06 02:45:41 +0000 | [diff] [blame] | 1763 | int useJournal = (flags & PAGER_OMIT_JOURNAL)==0; |
| 1764 | int noReadlock = (flags & PAGER_NO_READLOCK)!=0; |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 1765 | int journalFileSize; |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 1766 | int pcacheSize = sqlite3PcacheSize(); |
drh | facf030 | 2008-06-17 15:12:00 +0000 | [diff] [blame] | 1767 | int szPageDflt = SQLITE_DEFAULT_PAGE_SIZE; |
danielk1977 | 17b90b5 | 2008-06-06 11:11:25 +0000 | [diff] [blame] | 1768 | char *zPathname = 0; |
| 1769 | int nPathname = 0; |
danielk1977 | b4b4741 | 2007-08-17 15:53:36 +0000 | [diff] [blame] | 1770 | |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 1771 | if( sqlite3JournalSize(pVfs)>sqlite3MemJournalSize() ){ |
| 1772 | journalFileSize = sqlite3JournalSize(pVfs); |
| 1773 | }else{ |
| 1774 | journalFileSize = sqlite3MemJournalSize(); |
| 1775 | } |
| 1776 | |
drh | 86f8c19 | 2007-08-22 00:39:19 +0000 | [diff] [blame] | 1777 | /* The default return is a NULL pointer */ |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 1778 | *ppPager = 0; |
danielk1977 | aef0bf6 | 2005-12-30 16:28:01 +0000 | [diff] [blame] | 1779 | |
danielk1977 | 17b90b5 | 2008-06-06 11:11:25 +0000 | [diff] [blame] | 1780 | /* Compute and store the full pathname in an allocated buffer pointed |
| 1781 | ** to by zPathname, length nPathname. Or, if this is a temporary file, |
| 1782 | ** leave both nPathname and zPathname set to 0. |
| 1783 | */ |
drh | 1cc8c44 | 2007-08-24 16:08:29 +0000 | [diff] [blame] | 1784 | if( zFilename && zFilename[0] ){ |
danielk1977 | 17b90b5 | 2008-06-06 11:11:25 +0000 | [diff] [blame] | 1785 | nPathname = pVfs->mxPathname+1; |
drh | e5ae573 | 2008-06-15 02:51:47 +0000 | [diff] [blame] | 1786 | zPathname = sqlite3Malloc(nPathname*2); |
danielk1977 | 17b90b5 | 2008-06-06 11:11:25 +0000 | [diff] [blame] | 1787 | if( zPathname==0 ){ |
| 1788 | return SQLITE_NOMEM; |
| 1789 | } |
drh | 1cc8c44 | 2007-08-24 16:08:29 +0000 | [diff] [blame] | 1790 | #ifndef SQLITE_OMIT_MEMORYDB |
| 1791 | if( strcmp(zFilename,":memory:")==0 ){ |
| 1792 | memDb = 1; |
| 1793 | zPathname[0] = 0; |
| 1794 | }else |
| 1795 | #endif |
| 1796 | { |
danielk1977 | adfb9b0 | 2007-09-17 07:02:56 +0000 | [diff] [blame] | 1797 | rc = sqlite3OsFullPathname(pVfs, zFilename, nPathname, zPathname); |
drh | 1cc8c44 | 2007-08-24 16:08:29 +0000 | [diff] [blame] | 1798 | } |
danielk1977 | 17b90b5 | 2008-06-06 11:11:25 +0000 | [diff] [blame] | 1799 | if( rc!=SQLITE_OK ){ |
| 1800 | sqlite3_free(zPathname); |
| 1801 | return rc; |
| 1802 | } |
| 1803 | nPathname = strlen(zPathname); |
drh | ae28c01 | 2007-08-24 16:29:23 +0000 | [diff] [blame] | 1804 | } |
drh | 99b90c3 | 2008-03-17 13:50:58 +0000 | [diff] [blame] | 1805 | |
danielk1977 | b4b4741 | 2007-08-17 15:53:36 +0000 | [diff] [blame] | 1806 | /* Allocate memory for the pager structure */ |
| 1807 | pPager = sqlite3MallocZero( |
| 1808 | sizeof(*pPager) + /* Pager structure */ |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 1809 | pcacheSize + /* PCache object */ |
danielk1977 | c7b6017 | 2007-08-22 11:22:03 +0000 | [diff] [blame] | 1810 | journalFileSize + /* The journal file structure */ |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 1811 | pVfs->szOsFile + /* The main db file */ |
| 1812 | journalFileSize * 2 + /* The two journal files */ |
danielk1977 | 17b90b5 | 2008-06-06 11:11:25 +0000 | [diff] [blame] | 1813 | 3*nPathname + 40 /* zFilename, zDirectory, zJournal */ |
danielk1977 | b4b4741 | 2007-08-17 15:53:36 +0000 | [diff] [blame] | 1814 | ); |
| 1815 | if( !pPager ){ |
drh | 1cc8c44 | 2007-08-24 16:08:29 +0000 | [diff] [blame] | 1816 | sqlite3_free(zPathname); |
danielk1977 | b4b4741 | 2007-08-17 15:53:36 +0000 | [diff] [blame] | 1817 | return SQLITE_NOMEM; |
| 1818 | } |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 1819 | pPager->pPCache = (PCache *)&pPager[1]; |
| 1820 | pPtr = ((u8 *)&pPager[1]) + pcacheSize; |
drh | 33f4e02 | 2007-09-03 15:19:34 +0000 | [diff] [blame] | 1821 | pPager->vfsFlags = vfsFlags; |
danielk1977 | b4b4741 | 2007-08-17 15:53:36 +0000 | [diff] [blame] | 1822 | pPager->fd = (sqlite3_file*)&pPtr[pVfs->szOsFile*0]; |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 1823 | pPager->stfd = (sqlite3_file*)&pPtr[pVfs->szOsFile]; |
| 1824 | pPager->jfd = (sqlite3_file*)&pPtr[pVfs->szOsFile+journalFileSize]; |
| 1825 | pPager->zFilename = (char*)&pPtr[pVfs->szOsFile+2*journalFileSize]; |
drh | 1cc8c44 | 2007-08-24 16:08:29 +0000 | [diff] [blame] | 1826 | pPager->zDirectory = &pPager->zFilename[nPathname+1]; |
| 1827 | pPager->zJournal = &pPager->zDirectory[nPathname+1]; |
danielk1977 | b4b4741 | 2007-08-17 15:53:36 +0000 | [diff] [blame] | 1828 | pPager->pVfs = pVfs; |
danielk1977 | 17b90b5 | 2008-06-06 11:11:25 +0000 | [diff] [blame] | 1829 | if( zPathname ){ |
| 1830 | memcpy(pPager->zFilename, zPathname, nPathname+1); |
| 1831 | sqlite3_free(zPathname); |
| 1832 | } |
danielk1977 | b4b4741 | 2007-08-17 15:53:36 +0000 | [diff] [blame] | 1833 | |
drh | 153c62c | 2007-08-24 03:51:33 +0000 | [diff] [blame] | 1834 | /* Open the pager file. |
danielk1977 | aef0bf6 | 2005-12-30 16:28:01 +0000 | [diff] [blame] | 1835 | */ |
drh | ae28c01 | 2007-08-24 16:29:23 +0000 | [diff] [blame] | 1836 | if( zFilename && zFilename[0] && !memDb ){ |
danielk1977 | d92db53 | 2008-11-17 04:56:24 +0000 | [diff] [blame] | 1837 | if( nPathname>(pVfs->mxPathname - (int)sizeof("-journal")) ){ |
drh | 1cc8c44 | 2007-08-24 16:08:29 +0000 | [diff] [blame] | 1838 | rc = SQLITE_CANTOPEN; |
| 1839 | }else{ |
drh | 1cc8c44 | 2007-08-24 16:08:29 +0000 | [diff] [blame] | 1840 | int fout = 0; |
drh | 33f4e02 | 2007-09-03 15:19:34 +0000 | [diff] [blame] | 1841 | rc = sqlite3OsOpen(pVfs, pPager->zFilename, pPager->fd, |
| 1842 | pPager->vfsFlags, &fout); |
drh | 1cc8c44 | 2007-08-24 16:08:29 +0000 | [diff] [blame] | 1843 | readOnly = (fout&SQLITE_OPEN_READONLY); |
| 1844 | |
| 1845 | /* If the file was successfully opened for read/write access, |
| 1846 | ** choose a default page size in case we have to create the |
| 1847 | ** database file. The default page size is the maximum of: |
| 1848 | ** |
| 1849 | ** + SQLITE_DEFAULT_PAGE_SIZE, |
| 1850 | ** + The value returned by sqlite3OsSectorSize() |
| 1851 | ** + The largest page size that can be written atomically. |
| 1852 | */ |
| 1853 | if( rc==SQLITE_OK && !readOnly ){ |
| 1854 | int iSectorSize = sqlite3OsSectorSize(pPager->fd); |
drh | facf030 | 2008-06-17 15:12:00 +0000 | [diff] [blame] | 1855 | if( szPageDflt<iSectorSize ){ |
| 1856 | szPageDflt = iSectorSize; |
drh | 1cc8c44 | 2007-08-24 16:08:29 +0000 | [diff] [blame] | 1857 | } |
danielk1977 | 9663b8f | 2007-08-24 11:52:28 +0000 | [diff] [blame] | 1858 | #ifdef SQLITE_ENABLE_ATOMIC_WRITE |
drh | 1cc8c44 | 2007-08-24 16:08:29 +0000 | [diff] [blame] | 1859 | { |
| 1860 | int iDc = sqlite3OsDeviceCharacteristics(pPager->fd); |
| 1861 | int ii; |
| 1862 | assert(SQLITE_IOCAP_ATOMIC512==(512>>8)); |
| 1863 | assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8)); |
| 1864 | assert(SQLITE_MAX_DEFAULT_PAGE_SIZE<=65536); |
drh | facf030 | 2008-06-17 15:12:00 +0000 | [diff] [blame] | 1865 | for(ii=szPageDflt; ii<=SQLITE_MAX_DEFAULT_PAGE_SIZE; ii=ii*2){ |
| 1866 | if( iDc&(SQLITE_IOCAP_ATOMIC|(ii>>8)) ) szPageDflt = ii; |
danielk1977 | 9663b8f | 2007-08-24 11:52:28 +0000 | [diff] [blame] | 1867 | } |
danielk1977 | b4b4741 | 2007-08-17 15:53:36 +0000 | [diff] [blame] | 1868 | } |
drh | 1cc8c44 | 2007-08-24 16:08:29 +0000 | [diff] [blame] | 1869 | #endif |
drh | facf030 | 2008-06-17 15:12:00 +0000 | [diff] [blame] | 1870 | if( szPageDflt>SQLITE_MAX_DEFAULT_PAGE_SIZE ){ |
| 1871 | szPageDflt = SQLITE_MAX_DEFAULT_PAGE_SIZE; |
drh | 1cc8c44 | 2007-08-24 16:08:29 +0000 | [diff] [blame] | 1872 | } |
danielk1977 | 8def5ea | 2004-06-16 10:39:52 +0000 | [diff] [blame] | 1873 | } |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 1874 | } |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 1875 | }else{ |
danielk1977 | 7a2b1ee | 2007-08-21 14:27:01 +0000 | [diff] [blame] | 1876 | /* If a temporary file is requested, it is not opened immediately. |
| 1877 | ** In this case we accept the default page size and delay actually |
| 1878 | ** opening the file until the first call to OsWrite(). |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 1879 | ** |
| 1880 | ** This branch is also run for an in-memory database. An in-memory |
| 1881 | ** database is the same as a temp-file that is never written out to |
| 1882 | ** disk and uses an in-memory rollback journal. |
danielk1977 | 7a2b1ee | 2007-08-21 14:27:01 +0000 | [diff] [blame] | 1883 | */ |
danielk1977 | 7a2b1ee | 2007-08-21 14:27:01 +0000 | [diff] [blame] | 1884 | tempFile = 1; |
| 1885 | pPager->state = PAGER_EXCLUSIVE; |
drh | 5e00f6c | 2001-09-13 13:46:56 +0000 | [diff] [blame] | 1886 | } |
danielk1977 | aef0bf6 | 2005-12-30 16:28:01 +0000 | [diff] [blame] | 1887 | |
danielk1977 | b4b4741 | 2007-08-17 15:53:36 +0000 | [diff] [blame] | 1888 | if( pPager && rc==SQLITE_OK ){ |
drh | facf030 | 2008-06-17 15:12:00 +0000 | [diff] [blame] | 1889 | pPager->pTmpSpace = sqlite3PageMalloc(szPageDflt); |
drh | 3e7a609 | 2002-12-07 21:45:14 +0000 | [diff] [blame] | 1890 | } |
danielk1977 | aef0bf6 | 2005-12-30 16:28:01 +0000 | [diff] [blame] | 1891 | |
drh | 153c62c | 2007-08-24 03:51:33 +0000 | [diff] [blame] | 1892 | /* If an error occured in either of the blocks above. |
| 1893 | ** Free the Pager structure and close the file. |
| 1894 | ** Since the pager is not allocated there is no need to set |
danielk1977 | aef0bf6 | 2005-12-30 16:28:01 +0000 | [diff] [blame] | 1895 | ** any Pager.errMask variables. |
| 1896 | */ |
danielk1977 | b4b4741 | 2007-08-17 15:53:36 +0000 | [diff] [blame] | 1897 | if( !pPager || !pPager->pTmpSpace ){ |
| 1898 | sqlite3OsClose(pPager->fd); |
drh | 1743575 | 2007-08-16 04:30:38 +0000 | [diff] [blame] | 1899 | sqlite3_free(pPager); |
danielk1977 | aef0bf6 | 2005-12-30 16:28:01 +0000 | [diff] [blame] | 1900 | return ((rc==SQLITE_OK)?SQLITE_NOMEM:rc); |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1901 | } |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 1902 | nExtra = FORCE_ALIGNMENT(nExtra); |
danielk1977 | 71d5d2c | 2008-09-29 11:49:47 +0000 | [diff] [blame] | 1903 | sqlite3PcacheOpen(szPageDflt, nExtra, !memDb, |
drh | 41d3027 | 2008-08-20 21:47:45 +0000 | [diff] [blame] | 1904 | !memDb?pagerStress:0, (void *)pPager, pPager->pPCache); |
danielk1977 | aef0bf6 | 2005-12-30 16:28:01 +0000 | [diff] [blame] | 1905 | |
drh | 153c62c | 2007-08-24 03:51:33 +0000 | [diff] [blame] | 1906 | PAGERTRACE3("OPEN %d %s\n", FILEHANDLEID(pPager->fd), pPager->zFilename); |
| 1907 | IOTRACE(("OPEN %p %s\n", pPager, pPager->zFilename)) |
danielk1977 | aef0bf6 | 2005-12-30 16:28:01 +0000 | [diff] [blame] | 1908 | |
danielk1977 | b4b4741 | 2007-08-17 15:53:36 +0000 | [diff] [blame] | 1909 | /* Fill in Pager.zDirectory[] */ |
drh | 1cc8c44 | 2007-08-24 16:08:29 +0000 | [diff] [blame] | 1910 | memcpy(pPager->zDirectory, pPager->zFilename, nPathname+1); |
danielk1977 | b4b4741 | 2007-08-17 15:53:36 +0000 | [diff] [blame] | 1911 | for(i=strlen(pPager->zDirectory); i>0 && pPager->zDirectory[i-1]!='/'; i--){} |
drh | a76c82e | 2003-07-27 18:59:42 +0000 | [diff] [blame] | 1912 | if( i>0 ) pPager->zDirectory[i-1] = 0; |
danielk1977 | b4b4741 | 2007-08-17 15:53:36 +0000 | [diff] [blame] | 1913 | |
drh | 99b90c3 | 2008-03-17 13:50:58 +0000 | [diff] [blame] | 1914 | /* Fill in Pager.zJournal[] */ |
danielk1977 | 17b90b5 | 2008-06-06 11:11:25 +0000 | [diff] [blame] | 1915 | if( zPathname ){ |
| 1916 | memcpy(pPager->zJournal, pPager->zFilename, nPathname); |
| 1917 | memcpy(&pPager->zJournal[nPathname], "-journal", 9); |
| 1918 | }else{ |
| 1919 | pPager->zJournal = 0; |
| 1920 | } |
danielk1977 | b4b4741 | 2007-08-17 15:53:36 +0000 | [diff] [blame] | 1921 | |
drh | 3b59a5c | 2006-01-15 20:28:28 +0000 | [diff] [blame] | 1922 | /* pPager->journalOpen = 0; */ |
drh | b3df2e1 | 2008-09-17 20:06:26 +0000 | [diff] [blame] | 1923 | pPager->useJournal = useJournal; |
drh | 7bec505 | 2005-02-06 02:45:41 +0000 | [diff] [blame] | 1924 | pPager->noReadlock = noReadlock && readOnly; |
drh | 3b59a5c | 2006-01-15 20:28:28 +0000 | [diff] [blame] | 1925 | /* pPager->stmtOpen = 0; */ |
| 1926 | /* pPager->stmtInUse = 0; */ |
| 1927 | /* pPager->nRef = 0; */ |
danielk1977 | d92db53 | 2008-11-17 04:56:24 +0000 | [diff] [blame] | 1928 | pPager->dbSizeValid = memDb; |
drh | facf030 | 2008-06-17 15:12:00 +0000 | [diff] [blame] | 1929 | pPager->pageSize = szPageDflt; |
drh | 3b59a5c | 2006-01-15 20:28:28 +0000 | [diff] [blame] | 1930 | /* pPager->stmtSize = 0; */ |
| 1931 | /* pPager->stmtJSize = 0; */ |
| 1932 | /* pPager->nPage = 0; */ |
drh | 90f5ecb | 2004-07-22 01:19:35 +0000 | [diff] [blame] | 1933 | pPager->mxPage = 100; |
drh | f8e632b | 2007-05-08 14:51:36 +0000 | [diff] [blame] | 1934 | pPager->mxPgno = SQLITE_MAX_PAGE_COUNT; |
drh | 3b59a5c | 2006-01-15 20:28:28 +0000 | [diff] [blame] | 1935 | /* pPager->state = PAGER_UNLOCK; */ |
drh | 1cc8c44 | 2007-08-24 16:08:29 +0000 | [diff] [blame] | 1936 | assert( pPager->state == (tempFile ? PAGER_EXCLUSIVE : PAGER_UNLOCK) ); |
drh | 3b59a5c | 2006-01-15 20:28:28 +0000 | [diff] [blame] | 1937 | /* pPager->errMask = 0; */ |
drh | 5e00f6c | 2001-09-13 13:46:56 +0000 | [diff] [blame] | 1938 | pPager->tempFile = tempFile; |
drh | 369339d | 2007-03-30 16:01:55 +0000 | [diff] [blame] | 1939 | assert( tempFile==PAGER_LOCKINGMODE_NORMAL |
| 1940 | || tempFile==PAGER_LOCKINGMODE_EXCLUSIVE ); |
| 1941 | assert( PAGER_LOCKINGMODE_EXCLUSIVE==1 ); |
| 1942 | pPager->exclusiveMode = tempFile; |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 1943 | pPager->memDb = memDb; |
drh | 5e00f6c | 2001-09-13 13:46:56 +0000 | [diff] [blame] | 1944 | pPager->readOnly = readOnly; |
drh | 3b59a5c | 2006-01-15 20:28:28 +0000 | [diff] [blame] | 1945 | /* pPager->needSync = 0; */ |
drh | da47d77 | 2002-12-02 04:25:19 +0000 | [diff] [blame] | 1946 | pPager->noSync = pPager->tempFile || !useJournal; |
danielk1977 | 75edc16 | 2004-06-26 01:48:18 +0000 | [diff] [blame] | 1947 | pPager->fullSync = (pPager->noSync?0:1); |
danielk1977 | f036aef | 2007-08-20 05:36:51 +0000 | [diff] [blame] | 1948 | pPager->sync_flags = SQLITE_SYNC_NORMAL; |
drh | 3b59a5c | 2006-01-15 20:28:28 +0000 | [diff] [blame] | 1949 | /* pPager->pFirst = 0; */ |
| 1950 | /* pPager->pFirstSynced = 0; */ |
| 1951 | /* pPager->pLast = 0; */ |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 1952 | pPager->nExtra = nExtra; |
danielk1977 | b53e496 | 2008-06-04 06:45:59 +0000 | [diff] [blame] | 1953 | pPager->journalSizeLimit = SQLITE_DEFAULT_JOURNAL_SIZE_LIMIT; |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 1954 | assert(pPager->fd->pMethods||tempFile); |
| 1955 | setSectorSize(pPager); |
| 1956 | if( memDb ){ |
| 1957 | pPager->journalMode = PAGER_JOURNALMODE_MEMORY; |
danielk1977 | b472117 | 2007-03-19 05:54:48 +0000 | [diff] [blame] | 1958 | } |
danielk1977 | 1ceedd3 | 2008-11-19 10:22:33 +0000 | [diff] [blame] | 1959 | /* pPager->xBusyHandler = 0; */ |
| 1960 | /* pPager->pBusyHandlerArg = 0; */ |
drh | 3b59a5c | 2006-01-15 20:28:28 +0000 | [diff] [blame] | 1961 | /* memset(pPager->aHash, 0, sizeof(pPager->aHash)); */ |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1962 | *ppPager = pPager; |
| 1963 | return SQLITE_OK; |
| 1964 | } |
| 1965 | |
| 1966 | /* |
drh | 90f5ecb | 2004-07-22 01:19:35 +0000 | [diff] [blame] | 1967 | ** Set the busy handler function. |
| 1968 | */ |
danielk1977 | 1ceedd3 | 2008-11-19 10:22:33 +0000 | [diff] [blame] | 1969 | void sqlite3PagerSetBusyhandler( |
| 1970 | Pager *pPager, |
| 1971 | int (*xBusyHandler)(void *), |
| 1972 | void *pBusyHandlerArg |
| 1973 | ){ |
| 1974 | pPager->xBusyHandler = xBusyHandler; |
| 1975 | pPager->pBusyHandlerArg = pBusyHandlerArg; |
drh | 90f5ecb | 2004-07-22 01:19:35 +0000 | [diff] [blame] | 1976 | } |
| 1977 | |
| 1978 | /* |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 1979 | ** Set the reinitializer for this pager. If not NULL, the reinitializer |
| 1980 | ** is called when the content of a page in cache is restored to its original |
| 1981 | ** value as a result of a rollback. The callback gives higher-level code |
| 1982 | ** an opportunity to restore the EXTRA section to agree with the restored |
| 1983 | ** page data. |
| 1984 | */ |
danielk1977 | eaa06f6 | 2008-09-18 17:34:44 +0000 | [diff] [blame] | 1985 | void sqlite3PagerSetReiniter(Pager *pPager, void (*xReinit)(DbPage*)){ |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 1986 | pPager->xReiniter = xReinit; |
| 1987 | } |
| 1988 | |
| 1989 | /* |
danielk1977 | a1644fd | 2007-08-29 12:31:25 +0000 | [diff] [blame] | 1990 | ** Set the page size to *pPageSize. If the suggest new page size is |
| 1991 | ** inappropriate, then an alternative page size is set to that |
| 1992 | ** value before returning. |
drh | 90f5ecb | 2004-07-22 01:19:35 +0000 | [diff] [blame] | 1993 | */ |
danielk1977 | a1644fd | 2007-08-29 12:31:25 +0000 | [diff] [blame] | 1994 | int sqlite3PagerSetPagesize(Pager *pPager, u16 *pPageSize){ |
danielk1977 | 1357d9f | 2008-09-16 05:12:24 +0000 | [diff] [blame] | 1995 | int rc = pPager->errCode; |
| 1996 | if( rc==SQLITE_OK ){ |
| 1997 | u16 pageSize = *pPageSize; |
| 1998 | assert( pageSize==0 || (pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE) ); |
| 1999 | if( pageSize && pageSize!=pPager->pageSize |
| 2000 | && (pPager->memDb==0 || pPager->dbSize==0) |
| 2001 | && sqlite3PcacheRefCount(pPager->pPCache)==0 |
| 2002 | ){ |
| 2003 | char *pNew = (char *)sqlite3PageMalloc(pageSize); |
| 2004 | if( !pNew ){ |
| 2005 | rc = SQLITE_NOMEM; |
| 2006 | }else{ |
| 2007 | pager_reset(pPager); |
| 2008 | pPager->pageSize = pageSize; |
| 2009 | if( !pPager->memDb ) setSectorSize(pPager); |
| 2010 | sqlite3PageFree(pPager->pTmpSpace); |
| 2011 | pPager->pTmpSpace = pNew; |
| 2012 | sqlite3PcacheSetPageSize(pPager->pPCache, pageSize); |
| 2013 | } |
danielk1977 | a1644fd | 2007-08-29 12:31:25 +0000 | [diff] [blame] | 2014 | } |
danielk1977 | 1357d9f | 2008-09-16 05:12:24 +0000 | [diff] [blame] | 2015 | *pPageSize = pPager->pageSize; |
drh | 1c7880e | 2005-05-20 20:01:55 +0000 | [diff] [blame] | 2016 | } |
danielk1977 | a1644fd | 2007-08-29 12:31:25 +0000 | [diff] [blame] | 2017 | return rc; |
drh | 90f5ecb | 2004-07-22 01:19:35 +0000 | [diff] [blame] | 2018 | } |
| 2019 | |
| 2020 | /* |
drh | 26b7994 | 2007-11-28 16:19:56 +0000 | [diff] [blame] | 2021 | ** Return a pointer to the "temporary page" buffer held internally |
| 2022 | ** by the pager. This is a buffer that is big enough to hold the |
| 2023 | ** entire content of a database page. This buffer is used internally |
| 2024 | ** during rollback and will be overwritten whenever a rollback |
| 2025 | ** occurs. But other modules are free to use it too, as long as |
| 2026 | ** no rollbacks are happening. |
| 2027 | */ |
| 2028 | void *sqlite3PagerTempSpace(Pager *pPager){ |
| 2029 | return pPager->pTmpSpace; |
| 2030 | } |
| 2031 | |
| 2032 | /* |
drh | f8e632b | 2007-05-08 14:51:36 +0000 | [diff] [blame] | 2033 | ** Attempt to set the maximum database page count if mxPage is positive. |
| 2034 | ** Make no changes if mxPage is zero or negative. And never reduce the |
| 2035 | ** maximum page count below the current size of the database. |
| 2036 | ** |
| 2037 | ** Regardless of mxPage, return the current maximum page count. |
| 2038 | */ |
| 2039 | int sqlite3PagerMaxPageCount(Pager *pPager, int mxPage){ |
| 2040 | if( mxPage>0 ){ |
| 2041 | pPager->mxPgno = mxPage; |
| 2042 | } |
danielk1977 | ad0132d | 2008-06-07 08:58:22 +0000 | [diff] [blame] | 2043 | sqlite3PagerPagecount(pPager, 0); |
drh | f8e632b | 2007-05-08 14:51:36 +0000 | [diff] [blame] | 2044 | return pPager->mxPgno; |
| 2045 | } |
| 2046 | |
| 2047 | /* |
drh | c9ac5ca | 2005-11-04 22:03:30 +0000 | [diff] [blame] | 2048 | ** The following set of routines are used to disable the simulated |
| 2049 | ** I/O error mechanism. These routines are used to avoid simulated |
| 2050 | ** errors in places where we do not care about errors. |
| 2051 | ** |
| 2052 | ** Unless -DSQLITE_TEST=1 is used, these routines are all no-ops |
| 2053 | ** and generate no code. |
| 2054 | */ |
| 2055 | #ifdef SQLITE_TEST |
| 2056 | extern int sqlite3_io_error_pending; |
| 2057 | extern int sqlite3_io_error_hit; |
| 2058 | static int saved_cnt; |
drh | c9ac5ca | 2005-11-04 22:03:30 +0000 | [diff] [blame] | 2059 | void disable_simulated_io_errors(void){ |
| 2060 | saved_cnt = sqlite3_io_error_pending; |
| 2061 | sqlite3_io_error_pending = -1; |
| 2062 | } |
| 2063 | void enable_simulated_io_errors(void){ |
| 2064 | sqlite3_io_error_pending = saved_cnt; |
| 2065 | } |
| 2066 | #else |
drh | 152410f | 2005-11-05 15:11:22 +0000 | [diff] [blame] | 2067 | # define disable_simulated_io_errors() |
| 2068 | # define enable_simulated_io_errors() |
drh | c9ac5ca | 2005-11-04 22:03:30 +0000 | [diff] [blame] | 2069 | #endif |
| 2070 | |
| 2071 | /* |
drh | 90f5ecb | 2004-07-22 01:19:35 +0000 | [diff] [blame] | 2072 | ** Read the first N bytes from the beginning of the file into memory |
danielk1977 | aef0bf6 | 2005-12-30 16:28:01 +0000 | [diff] [blame] | 2073 | ** that pDest points to. |
| 2074 | ** |
| 2075 | ** No error checking is done. The rational for this is that this function |
| 2076 | ** may be called even if the file does not exist or contain a header. In |
| 2077 | ** these cases sqlite3OsRead() will return an error, to which the correct |
| 2078 | ** response is to zero the memory at pDest and continue. A real IO error |
| 2079 | ** will presumably recur and be picked up later (Todo: Think about this). |
drh | 90f5ecb | 2004-07-22 01:19:35 +0000 | [diff] [blame] | 2080 | */ |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 2081 | int sqlite3PagerReadFileheader(Pager *pPager, int N, unsigned char *pDest){ |
drh | 551b773 | 2006-11-06 21:20:25 +0000 | [diff] [blame] | 2082 | int rc = SQLITE_OK; |
drh | 90f5ecb | 2004-07-22 01:19:35 +0000 | [diff] [blame] | 2083 | memset(pDest, 0, N); |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 2084 | assert(pPager->fd->pMethods||pPager->tempFile); |
danielk1977 | 7a2b1ee | 2007-08-21 14:27:01 +0000 | [diff] [blame] | 2085 | if( pPager->fd->pMethods ){ |
drh | b060341 | 2007-02-28 04:47:26 +0000 | [diff] [blame] | 2086 | IOTRACE(("DBHDR %p 0 %d\n", pPager, N)) |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 2087 | rc = sqlite3OsRead(pPager->fd, pDest, N, 0); |
drh | 551b773 | 2006-11-06 21:20:25 +0000 | [diff] [blame] | 2088 | if( rc==SQLITE_IOERR_SHORT_READ ){ |
| 2089 | rc = SQLITE_OK; |
| 2090 | } |
drh | 90f5ecb | 2004-07-22 01:19:35 +0000 | [diff] [blame] | 2091 | } |
drh | 551b773 | 2006-11-06 21:20:25 +0000 | [diff] [blame] | 2092 | return rc; |
drh | 90f5ecb | 2004-07-22 01:19:35 +0000 | [diff] [blame] | 2093 | } |
| 2094 | |
| 2095 | /* |
drh | 5e00f6c | 2001-09-13 13:46:56 +0000 | [diff] [blame] | 2096 | ** Return the total number of pages in the disk file associated with |
danielk1977 | 15f411d | 2005-09-16 10:18:45 +0000 | [diff] [blame] | 2097 | ** pPager. |
| 2098 | ** |
| 2099 | ** If the PENDING_BYTE lies on the page directly after the end of the |
| 2100 | ** file, then consider this page part of the file too. For example, if |
| 2101 | ** PENDING_BYTE is byte 4096 (the first byte of page 5) and the size of the |
| 2102 | ** file is 4096 bytes, 5 is returned instead of 4. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2103 | */ |
danielk1977 | ad0132d | 2008-06-07 08:58:22 +0000 | [diff] [blame] | 2104 | int sqlite3PagerPagecount(Pager *pPager, int *pnPage){ |
danielk1977 | 7a2b1ee | 2007-08-21 14:27:01 +0000 | [diff] [blame] | 2105 | i64 n = 0; |
drh | e49f982 | 2006-09-15 12:29:16 +0000 | [diff] [blame] | 2106 | int rc; |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2107 | assert( pPager!=0 ); |
drh | a7aea3d | 2007-03-15 12:51:16 +0000 | [diff] [blame] | 2108 | if( pPager->errCode ){ |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 2109 | rc = pPager->errCode; |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 2110 | return rc; |
drh | a7aea3d | 2007-03-15 12:51:16 +0000 | [diff] [blame] | 2111 | } |
danielk1977 | d92db53 | 2008-11-17 04:56:24 +0000 | [diff] [blame] | 2112 | if( pPager->dbSizeValid ){ |
danielk1977 | 15f411d | 2005-09-16 10:18:45 +0000 | [diff] [blame] | 2113 | n = pPager->dbSize; |
| 2114 | } else { |
danielk1977 | 7a2b1ee | 2007-08-21 14:27:01 +0000 | [diff] [blame] | 2115 | assert(pPager->fd->pMethods||pPager->tempFile); |
| 2116 | if( (pPager->fd->pMethods) |
| 2117 | && (rc = sqlite3OsFileSize(pPager->fd, &n))!=SQLITE_OK ){ |
drh | e49f982 | 2006-09-15 12:29:16 +0000 | [diff] [blame] | 2118 | pager_error(pPager, rc); |
danielk1977 | ad0132d | 2008-06-07 08:58:22 +0000 | [diff] [blame] | 2119 | return rc; |
danielk1977 | 15f411d | 2005-09-16 10:18:45 +0000 | [diff] [blame] | 2120 | } |
| 2121 | if( n>0 && n<pPager->pageSize ){ |
| 2122 | n = 1; |
| 2123 | }else{ |
| 2124 | n /= pPager->pageSize; |
| 2125 | } |
| 2126 | if( pPager->state!=PAGER_UNLOCK ){ |
| 2127 | pPager->dbSize = n; |
danielk1977 | d92db53 | 2008-11-17 04:56:24 +0000 | [diff] [blame] | 2128 | pPager->dbSizeValid = 1; |
danielk1977 | 15f411d | 2005-09-16 10:18:45 +0000 | [diff] [blame] | 2129 | } |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2130 | } |
danielk1977 | 15f411d | 2005-09-16 10:18:45 +0000 | [diff] [blame] | 2131 | if( n==(PENDING_BYTE/pPager->pageSize) ){ |
drh | 1f59571 | 2004-06-15 01:40:29 +0000 | [diff] [blame] | 2132 | n++; |
| 2133 | } |
drh | f8e632b | 2007-05-08 14:51:36 +0000 | [diff] [blame] | 2134 | if( n>pPager->mxPgno ){ |
| 2135 | pPager->mxPgno = n; |
| 2136 | } |
danielk1977 | ad0132d | 2008-06-07 08:58:22 +0000 | [diff] [blame] | 2137 | if( pnPage ){ |
| 2138 | *pnPage = n; |
| 2139 | } |
| 2140 | return SQLITE_OK; |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2141 | } |
| 2142 | |
| 2143 | /* |
drh | f7c5753 | 2003-04-25 13:22:51 +0000 | [diff] [blame] | 2144 | ** Forward declaration |
| 2145 | */ |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 2146 | static int syncJournal(Pager*); |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 2147 | |
| 2148 | /* |
danielk1977 | e180dd9 | 2007-04-05 17:15:52 +0000 | [diff] [blame] | 2149 | ** This routine is used to truncate the cache when a database |
| 2150 | ** is truncated. Drop from the cache all pages whose pgno is |
| 2151 | ** larger than pPager->dbSize and is unreferenced. |
| 2152 | ** |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 2153 | ** Referenced pages larger than pPager->dbSize are zeroed. |
danielk1977 | e180dd9 | 2007-04-05 17:15:52 +0000 | [diff] [blame] | 2154 | ** |
| 2155 | ** Actually, at the point this routine is called, it would be |
| 2156 | ** an error to have a referenced page. But rather than delete |
| 2157 | ** that page and guarantee a subsequent segfault, it seems better |
| 2158 | ** to zero it and hope that we error out sanely. |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 2159 | */ |
danielk1977 | e180dd9 | 2007-04-05 17:15:52 +0000 | [diff] [blame] | 2160 | static void pager_truncate_cache(Pager *pPager){ |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 2161 | sqlite3PcacheTruncate(pPager->pPCache, pPager->dbSize); |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 2162 | } |
| 2163 | |
drh | f7c5753 | 2003-04-25 13:22:51 +0000 | [diff] [blame] | 2164 | /* |
danielk1977 | 1722181 | 2005-02-15 03:38:05 +0000 | [diff] [blame] | 2165 | ** Try to obtain a lock on a file. Invoke the busy callback if the lock |
drh | a4afb65 | 2005-07-09 02:16:02 +0000 | [diff] [blame] | 2166 | ** is currently not available. Repeat until the busy callback returns |
danielk1977 | 1722181 | 2005-02-15 03:38:05 +0000 | [diff] [blame] | 2167 | ** false or until the lock succeeds. |
| 2168 | ** |
| 2169 | ** Return SQLITE_OK on success and an error code if we cannot obtain |
| 2170 | ** the lock. |
| 2171 | */ |
| 2172 | static int pager_wait_on_lock(Pager *pPager, int locktype){ |
| 2173 | int rc; |
drh | 1aa2d8b | 2007-01-03 15:34:29 +0000 | [diff] [blame] | 2174 | |
| 2175 | /* The OS lock values must be the same as the Pager lock values */ |
danielk1977 | 1722181 | 2005-02-15 03:38:05 +0000 | [diff] [blame] | 2176 | assert( PAGER_SHARED==SHARED_LOCK ); |
| 2177 | assert( PAGER_RESERVED==RESERVED_LOCK ); |
| 2178 | assert( PAGER_EXCLUSIVE==EXCLUSIVE_LOCK ); |
drh | 1aa2d8b | 2007-01-03 15:34:29 +0000 | [diff] [blame] | 2179 | |
| 2180 | /* If the file is currently unlocked then the size must be unknown */ |
danielk1977 | d92db53 | 2008-11-17 04:56:24 +0000 | [diff] [blame] | 2181 | assert( pPager->state>=PAGER_SHARED || pPager->dbSizeValid==0 ); |
drh | 1aa2d8b | 2007-01-03 15:34:29 +0000 | [diff] [blame] | 2182 | |
danielk1977 | 1722181 | 2005-02-15 03:38:05 +0000 | [diff] [blame] | 2183 | if( pPager->state>=locktype ){ |
| 2184 | rc = SQLITE_OK; |
| 2185 | }else{ |
danielk1977 | 1722181 | 2005-02-15 03:38:05 +0000 | [diff] [blame] | 2186 | do { |
drh | 054889e | 2005-11-30 03:20:31 +0000 | [diff] [blame] | 2187 | rc = sqlite3OsLock(pPager->fd, locktype); |
danielk1977 | 1ceedd3 | 2008-11-19 10:22:33 +0000 | [diff] [blame] | 2188 | }while( rc==SQLITE_BUSY && pPager->xBusyHandler(pPager->pBusyHandlerArg) ); |
danielk1977 | 1722181 | 2005-02-15 03:38:05 +0000 | [diff] [blame] | 2189 | if( rc==SQLITE_OK ){ |
| 2190 | pPager->state = locktype; |
drh | b060341 | 2007-02-28 04:47:26 +0000 | [diff] [blame] | 2191 | IOTRACE(("LOCK %p %d\n", pPager, locktype)) |
danielk1977 | 1722181 | 2005-02-15 03:38:05 +0000 | [diff] [blame] | 2192 | } |
| 2193 | } |
| 2194 | return rc; |
| 2195 | } |
| 2196 | |
| 2197 | /* |
drh | f7c5753 | 2003-04-25 13:22:51 +0000 | [diff] [blame] | 2198 | ** Truncate the file to the number of pages specified. |
| 2199 | */ |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 2200 | int sqlite3PagerTruncate(Pager *pPager, Pgno nPage){ |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 2201 | int rc = SQLITE_OK; |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 2202 | assert( pPager->state>=PAGER_SHARED ); |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 2203 | |
danielk1977 | ad0132d | 2008-06-07 08:58:22 +0000 | [diff] [blame] | 2204 | sqlite3PagerPagecount(pPager, 0); |
danielk1977 | efaaf57 | 2006-01-16 11:29:19 +0000 | [diff] [blame] | 2205 | if( pPager->errCode ){ |
| 2206 | rc = pPager->errCode; |
danielk1977 | d92db53 | 2008-11-17 04:56:24 +0000 | [diff] [blame] | 2207 | }else if( nPage<pPager->dbSize ){ |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 2208 | rc = syncJournal(pPager); |
| 2209 | if( rc==SQLITE_OK ){ |
| 2210 | /* Get an exclusive lock on the database before truncating. */ |
| 2211 | rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK); |
| 2212 | } |
| 2213 | if( rc==SQLITE_OK ){ |
| 2214 | rc = pager_truncate(pPager, nPage); |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 2215 | } |
danielk1977 | 369f27e | 2004-06-15 11:40:04 +0000 | [diff] [blame] | 2216 | } |
danielk1977 | 1722181 | 2005-02-15 03:38:05 +0000 | [diff] [blame] | 2217 | |
drh | f7c5753 | 2003-04-25 13:22:51 +0000 | [diff] [blame] | 2218 | return rc; |
| 2219 | } |
| 2220 | |
| 2221 | /* |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2222 | ** Shutdown the page cache. Free all memory and close all files. |
| 2223 | ** |
| 2224 | ** If a transaction was in progress when this routine is called, that |
| 2225 | ** transaction is rolled back. All outstanding pages are invalidated |
| 2226 | ** and their memory is freed. Any attempt to use a page associated |
| 2227 | ** with this page cache after this function returns will likely |
| 2228 | ** result in a coredump. |
danielk1977 | aef0bf6 | 2005-12-30 16:28:01 +0000 | [diff] [blame] | 2229 | ** |
| 2230 | ** This function always succeeds. If a transaction is active an attempt |
| 2231 | ** is made to roll it back. If an error occurs during the rollback |
| 2232 | ** a hot journal may be left in the filesystem but no error is returned |
| 2233 | ** to the caller. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2234 | */ |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 2235 | int sqlite3PagerClose(Pager *pPager){ |
danielk1977 | 13f7299 | 2005-12-18 08:51:22 +0000 | [diff] [blame] | 2236 | |
drh | bafda09 | 2007-01-03 23:36:22 +0000 | [diff] [blame] | 2237 | disable_simulated_io_errors(); |
danielk1977 | 2d1d86f | 2008-06-20 14:59:51 +0000 | [diff] [blame] | 2238 | sqlite3BeginBenignMalloc(); |
drh | c2ee76c | 2007-01-04 14:58:14 +0000 | [diff] [blame] | 2239 | pPager->errCode = 0; |
danielk1977 | 4148346 | 2007-03-24 16:45:04 +0000 | [diff] [blame] | 2240 | pPager->exclusiveMode = 0; |
drh | bafda09 | 2007-01-03 23:36:22 +0000 | [diff] [blame] | 2241 | pager_reset(pPager); |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 2242 | if( !MEMDB ){ |
| 2243 | pagerUnlockAndRollback(pPager); |
| 2244 | } |
drh | bafda09 | 2007-01-03 23:36:22 +0000 | [diff] [blame] | 2245 | enable_simulated_io_errors(); |
danielk1977 | 2d1d86f | 2008-06-20 14:59:51 +0000 | [diff] [blame] | 2246 | sqlite3EndBenignMalloc(); |
drh | 4f0c587 | 2007-03-26 22:05:01 +0000 | [diff] [blame] | 2247 | PAGERTRACE2("CLOSE %d\n", PAGERID(pPager)); |
drh | b060341 | 2007-02-28 04:47:26 +0000 | [diff] [blame] | 2248 | IOTRACE(("CLOSE %p\n", pPager)) |
danielk1977 | e94ddc9 | 2005-03-21 03:53:38 +0000 | [diff] [blame] | 2249 | if( pPager->journalOpen ){ |
danielk1977 | b4b4741 | 2007-08-17 15:53:36 +0000 | [diff] [blame] | 2250 | sqlite3OsClose(pPager->jfd); |
danielk1977 | e94ddc9 | 2005-03-21 03:53:38 +0000 | [diff] [blame] | 2251 | } |
drh | f5e7bb5 | 2008-02-18 14:47:33 +0000 | [diff] [blame] | 2252 | sqlite3BitvecDestroy(pPager->pInJournal); |
danielk1977 | a1fa00d | 2008-08-27 15:16:33 +0000 | [diff] [blame] | 2253 | sqlite3BitvecDestroy(pPager->pAlwaysRollback); |
danielk1977 | e94ddc9 | 2005-03-21 03:53:38 +0000 | [diff] [blame] | 2254 | if( pPager->stmtOpen ){ |
danielk1977 | b4b4741 | 2007-08-17 15:53:36 +0000 | [diff] [blame] | 2255 | sqlite3OsClose(pPager->stfd); |
danielk1977 | e94ddc9 | 2005-03-21 03:53:38 +0000 | [diff] [blame] | 2256 | } |
danielk1977 | b4b4741 | 2007-08-17 15:53:36 +0000 | [diff] [blame] | 2257 | sqlite3OsClose(pPager->fd); |
drh | 0f89253 | 2002-05-30 12:27:03 +0000 | [diff] [blame] | 2258 | /* Temp files are automatically deleted by the OS |
| 2259 | ** if( pPager->tempFile ){ |
drh | 66560ad | 2006-01-06 14:32:19 +0000 | [diff] [blame] | 2260 | ** sqlite3OsDelete(pPager->zFilename); |
drh | 0f89253 | 2002-05-30 12:27:03 +0000 | [diff] [blame] | 2261 | ** } |
| 2262 | */ |
danielk1977 | aca790a | 2005-01-13 11:07:52 +0000 | [diff] [blame] | 2263 | |
drh | facf030 | 2008-06-17 15:12:00 +0000 | [diff] [blame] | 2264 | sqlite3PageFree(pPager->pTmpSpace); |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 2265 | sqlite3PcacheClose(pPager->pPCache); |
drh | 1743575 | 2007-08-16 04:30:38 +0000 | [diff] [blame] | 2266 | sqlite3_free(pPager); |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2267 | return SQLITE_OK; |
| 2268 | } |
| 2269 | |
drh | 87cc3b3 | 2007-05-08 21:45:27 +0000 | [diff] [blame] | 2270 | #if !defined(NDEBUG) || defined(SQLITE_TEST) |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2271 | /* |
drh | 5e00f6c | 2001-09-13 13:46:56 +0000 | [diff] [blame] | 2272 | ** Return the page number for the given page data. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2273 | */ |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 2274 | Pgno sqlite3PagerPagenumber(DbPage *p){ |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2275 | return p->pgno; |
| 2276 | } |
drh | 87cc3b3 | 2007-05-08 21:45:27 +0000 | [diff] [blame] | 2277 | #endif |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2278 | |
| 2279 | /* |
drh | df0b3b0 | 2001-06-23 11:36:20 +0000 | [diff] [blame] | 2280 | ** Increment the reference count for a page. The input pointer is |
| 2281 | ** a reference to the page data. |
| 2282 | */ |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 2283 | int sqlite3PagerRef(DbPage *pPg){ |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 2284 | sqlite3PcacheRef(pPg); |
drh | 8c42ca9 | 2001-06-22 19:15:00 +0000 | [diff] [blame] | 2285 | return SQLITE_OK; |
drh | 7e3b0a0 | 2001-04-28 16:52:40 +0000 | [diff] [blame] | 2286 | } |
| 2287 | |
| 2288 | /* |
drh | 34e79ce | 2004-02-08 06:05:46 +0000 | [diff] [blame] | 2289 | ** Sync the journal. In other words, make sure all the pages that have |
| 2290 | ** been written to the journal have actually reached the surface of the |
| 2291 | ** disk. It is not safe to modify the original database file until after |
| 2292 | ** the journal has been synced. If the original database is modified before |
| 2293 | ** the journal is synced and a power failure occurs, the unsynced journal |
| 2294 | ** data would be lost and we would be unable to completely rollback the |
| 2295 | ** database changes. Database corruption would occur. |
| 2296 | ** |
| 2297 | ** This routine also updates the nRec field in the header of the journal. |
| 2298 | ** (See comments on the pager_playback() routine for additional information.) |
| 2299 | ** If the sync mode is FULL, two syncs will occur. First the whole journal |
| 2300 | ** is synced, then the nRec field is updated, then a second sync occurs. |
drh | b19a2bc | 2001-09-16 00:13:26 +0000 | [diff] [blame] | 2301 | ** |
drh | 34e79ce | 2004-02-08 06:05:46 +0000 | [diff] [blame] | 2302 | ** For temporary databases, we do not care if we are able to rollback |
danielk1977 | 4cd2cd5 | 2007-08-23 14:48:23 +0000 | [diff] [blame] | 2303 | ** after a power failure, so no sync occurs. |
| 2304 | ** |
| 2305 | ** If the IOCAP_SEQUENTIAL flag is set for the persistent media on which |
| 2306 | ** the database is stored, then OsSync() is never called on the journal |
| 2307 | ** file. In this case all that is required is to update the nRec field in |
| 2308 | ** the journal header. |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 2309 | ** |
drh | 34e79ce | 2004-02-08 06:05:46 +0000 | [diff] [blame] | 2310 | ** This routine clears the needSync field of every page current held in |
| 2311 | ** memory. |
drh | 50e5dad | 2001-09-15 00:57:28 +0000 | [diff] [blame] | 2312 | */ |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 2313 | static int syncJournal(Pager *pPager){ |
drh | 50e5dad | 2001-09-15 00:57:28 +0000 | [diff] [blame] | 2314 | int rc = SQLITE_OK; |
drh | 03eb96a | 2002-11-10 23:32:56 +0000 | [diff] [blame] | 2315 | |
| 2316 | /* Sync the journal before modifying the main database |
| 2317 | ** (assuming there is a journal and it needs to be synced.) |
| 2318 | */ |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 2319 | if( pPager->needSync ){ |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 2320 | assert( !pPager->tempFile ); |
| 2321 | if( pPager->journalMode!=PAGER_JOURNALMODE_MEMORY ){ |
danielk1977 | 4cd2cd5 | 2007-08-23 14:48:23 +0000 | [diff] [blame] | 2322 | int iDc = sqlite3OsDeviceCharacteristics(pPager->fd); |
drh | db48ee0 | 2003-01-16 13:42:43 +0000 | [diff] [blame] | 2323 | assert( pPager->journalOpen ); |
danielk1977 | 4cd2cd5 | 2007-08-23 14:48:23 +0000 | [diff] [blame] | 2324 | |
danielk1977 | 4cd2cd5 | 2007-08-23 14:48:23 +0000 | [diff] [blame] | 2325 | if( 0==(iDc&SQLITE_IOCAP_SAFE_APPEND) ){ |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 2326 | /* Write the nRec value into the journal file header. If in |
| 2327 | ** full-synchronous mode, sync the journal first. This ensures that |
| 2328 | ** all data has really hit the disk before nRec is updated to mark |
danielk1977 | 4cd2cd5 | 2007-08-23 14:48:23 +0000 | [diff] [blame] | 2329 | ** it as a candidate for rollback. |
| 2330 | ** |
| 2331 | ** This is not required if the persistent media supports the |
| 2332 | ** SAFE_APPEND property. Because in this case it is not possible |
| 2333 | ** for garbage data to be appended to the file, the nRec field |
| 2334 | ** is populated with 0xFFFFFFFF when the journal header is written |
| 2335 | ** and never needs to be updated. |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 2336 | */ |
danielk1977 | 4cd2cd5 | 2007-08-23 14:48:23 +0000 | [diff] [blame] | 2337 | i64 jrnlOff; |
| 2338 | if( pPager->fullSync && 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){ |
drh | 4f0c587 | 2007-03-26 22:05:01 +0000 | [diff] [blame] | 2339 | PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager)); |
drh | b060341 | 2007-02-28 04:47:26 +0000 | [diff] [blame] | 2340 | IOTRACE(("JSYNC %p\n", pPager)) |
danielk1977 | f036aef | 2007-08-20 05:36:51 +0000 | [diff] [blame] | 2341 | rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags); |
drh | d8d66e8 | 2003-02-12 02:10:15 +0000 | [diff] [blame] | 2342 | if( rc!=0 ) return rc; |
| 2343 | } |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 2344 | |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 2345 | jrnlOff = pPager->journalHdr + sizeof(aJournalMagic); |
| 2346 | IOTRACE(("JHDR %p %lld %d\n", pPager, jrnlOff, 4)); |
| 2347 | rc = write32bits(pPager->jfd, jrnlOff, pPager->nRec); |
drh | b4746b9 | 2005-09-09 01:32:06 +0000 | [diff] [blame] | 2348 | if( rc ) return rc; |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 2349 | } |
danielk1977 | 4cd2cd5 | 2007-08-23 14:48:23 +0000 | [diff] [blame] | 2350 | if( 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){ |
| 2351 | PAGERTRACE2("SYNC journal of %d\n", PAGERID(pPager)); |
| 2352 | IOTRACE(("JSYNC %p\n", pPager)) |
| 2353 | rc = sqlite3OsSync(pPager->jfd, pPager->sync_flags| |
| 2354 | (pPager->sync_flags==SQLITE_SYNC_FULL?SQLITE_SYNC_DATAONLY:0) |
| 2355 | ); |
| 2356 | if( rc!=0 ) return rc; |
| 2357 | } |
drh | db48ee0 | 2003-01-16 13:42:43 +0000 | [diff] [blame] | 2358 | pPager->journalStarted = 1; |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 2359 | } |
drh | 50e5dad | 2001-09-15 00:57:28 +0000 | [diff] [blame] | 2360 | pPager->needSync = 0; |
drh | 341eae8 | 2003-01-21 02:39:36 +0000 | [diff] [blame] | 2361 | |
| 2362 | /* Erase the needSync flag from every page. |
| 2363 | */ |
danielk1977 | bc2ca9e | 2008-11-13 14:28:28 +0000 | [diff] [blame] | 2364 | sqlite3PcacheClearSyncFlags(pPager->pPCache); |
drh | 50e5dad | 2001-09-15 00:57:28 +0000 | [diff] [blame] | 2365 | } |
drh | 03eb96a | 2002-11-10 23:32:56 +0000 | [diff] [blame] | 2366 | |
drh | 81a20f2 | 2001-10-12 17:30:04 +0000 | [diff] [blame] | 2367 | return rc; |
drh | 50e5dad | 2001-09-15 00:57:28 +0000 | [diff] [blame] | 2368 | } |
| 2369 | |
| 2370 | /* |
drh | 2554f8b | 2003-01-22 01:26:44 +0000 | [diff] [blame] | 2371 | ** Given a list of pages (connected by the PgHdr.pDirty pointer) write |
danielk1977 | a858aa2 | 2008-08-22 16:22:17 +0000 | [diff] [blame] | 2372 | ** every one of those pages out to the database file. No calls are made |
| 2373 | ** to the page-cache to mark the pages as clean. It is the responsibility |
| 2374 | ** of the caller to use PcacheCleanAll() or PcacheMakeClean() to mark |
| 2375 | ** the pages as clean. |
drh | 2554f8b | 2003-01-22 01:26:44 +0000 | [diff] [blame] | 2376 | */ |
| 2377 | static int pager_write_pagelist(PgHdr *pList){ |
| 2378 | Pager *pPager; |
| 2379 | int rc; |
| 2380 | |
| 2381 | if( pList==0 ) return SQLITE_OK; |
| 2382 | pPager = pList->pPager; |
danielk1977 | 9eed505 | 2004-06-04 10:38:30 +0000 | [diff] [blame] | 2383 | |
| 2384 | /* At this point there may be either a RESERVED or EXCLUSIVE lock on the |
| 2385 | ** database file. If there is already an EXCLUSIVE lock, the following |
drh | 054889e | 2005-11-30 03:20:31 +0000 | [diff] [blame] | 2386 | ** calls to sqlite3OsLock() are no-ops. |
danielk1977 | 9eed505 | 2004-06-04 10:38:30 +0000 | [diff] [blame] | 2387 | ** |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 2388 | ** Moving the lock from RESERVED to EXCLUSIVE actually involves going |
| 2389 | ** through an intermediate state PENDING. A PENDING lock prevents new |
| 2390 | ** readers from attaching to the database but is unsufficient for us to |
| 2391 | ** write. The idea of a PENDING lock is to prevent new readers from |
| 2392 | ** coming in while we wait for existing readers to clear. |
danielk1977 | 9eed505 | 2004-06-04 10:38:30 +0000 | [diff] [blame] | 2393 | ** |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 2394 | ** While the pager is in the RESERVED state, the original database file |
| 2395 | ** is unchanged and we can rollback without having to playback the |
| 2396 | ** journal into the original database file. Once we transition to |
| 2397 | ** EXCLUSIVE, it means the database file has been changed and any rollback |
| 2398 | ** will require a journal playback. |
danielk1977 | 9eed505 | 2004-06-04 10:38:30 +0000 | [diff] [blame] | 2399 | */ |
drh | 684917c | 2004-10-05 02:41:42 +0000 | [diff] [blame] | 2400 | rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK); |
danielk1977 | 9eed505 | 2004-06-04 10:38:30 +0000 | [diff] [blame] | 2401 | if( rc!=SQLITE_OK ){ |
| 2402 | return rc; |
| 2403 | } |
| 2404 | |
drh | 2554f8b | 2003-01-22 01:26:44 +0000 | [diff] [blame] | 2405 | while( pList ){ |
danielk1977 | 7a2b1ee | 2007-08-21 14:27:01 +0000 | [diff] [blame] | 2406 | |
| 2407 | /* If the file has not yet been opened, open it now. */ |
| 2408 | if( !pPager->fd->pMethods ){ |
| 2409 | assert(pPager->tempFile); |
danielk1977 | 17b90b5 | 2008-06-06 11:11:25 +0000 | [diff] [blame] | 2410 | rc = sqlite3PagerOpentemp(pPager, pPager->fd, pPager->vfsFlags); |
danielk1977 | 7a2b1ee | 2007-08-21 14:27:01 +0000 | [diff] [blame] | 2411 | if( rc ) return rc; |
| 2412 | } |
| 2413 | |
danielk1977 | 687566d | 2004-11-02 12:56:41 +0000 | [diff] [blame] | 2414 | /* If there are dirty pages in the page cache with page numbers greater |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 2415 | ** than Pager.dbSize, this means sqlite3PagerTruncate() was called to |
danielk1977 | 687566d | 2004-11-02 12:56:41 +0000 | [diff] [blame] | 2416 | ** make the file smaller (presumably by auto-vacuum code). Do not write |
| 2417 | ** any such pages to the file. |
| 2418 | */ |
danielk1977 | 33e3216 | 2008-08-23 18:53:08 +0000 | [diff] [blame] | 2419 | if( pList->pgno<=pPager->dbSize && 0==(pList->flags&PGHDR_DONT_WRITE) ){ |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 2420 | i64 offset = (pList->pgno-1)*(i64)pPager->pageSize; |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 2421 | char *pData = CODEC2(pPager, pList->pData, pList->pgno, 6); |
drh | 477731b | 2007-06-16 03:06:27 +0000 | [diff] [blame] | 2422 | PAGERTRACE4("STORE %d page %d hash(%08x)\n", |
| 2423 | PAGERID(pPager), pList->pgno, pager_pagehash(pList)); |
drh | 538f570 | 2007-04-13 02:14:30 +0000 | [diff] [blame] | 2424 | IOTRACE(("PGOUT %p %d\n", pPager, pList->pgno)); |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 2425 | rc = sqlite3OsWrite(pPager->fd, pData, pPager->pageSize, offset); |
drh | 538f570 | 2007-04-13 02:14:30 +0000 | [diff] [blame] | 2426 | PAGER_INCR(sqlite3_pager_writedb_count); |
| 2427 | PAGER_INCR(pPager->nWrite); |
drh | 86a8811 | 2007-04-16 15:02:19 +0000 | [diff] [blame] | 2428 | if( pList->pgno==1 ){ |
| 2429 | memcpy(&pPager->dbFileVers, &pData[24], sizeof(pPager->dbFileVers)); |
| 2430 | } |
danielk1977 | 687566d | 2004-11-02 12:56:41 +0000 | [diff] [blame] | 2431 | } |
| 2432 | #ifndef NDEBUG |
| 2433 | else{ |
drh | 4f0c587 | 2007-03-26 22:05:01 +0000 | [diff] [blame] | 2434 | PAGERTRACE3("NOSTORE %d page %d\n", PAGERID(pPager), pList->pgno); |
danielk1977 | 687566d | 2004-11-02 12:56:41 +0000 | [diff] [blame] | 2435 | } |
| 2436 | #endif |
drh | 2554f8b | 2003-01-22 01:26:44 +0000 | [diff] [blame] | 2437 | if( rc ) return rc; |
danielk1977 | 3c40737 | 2005-02-15 02:54:14 +0000 | [diff] [blame] | 2438 | #ifdef SQLITE_CHECK_PAGES |
| 2439 | pList->pageHash = pager_pagehash(pList); |
| 2440 | #endif |
drh | 2554f8b | 2003-01-22 01:26:44 +0000 | [diff] [blame] | 2441 | pList = pList->pDirty; |
| 2442 | } |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 2443 | |
drh | 2554f8b | 2003-01-22 01:26:44 +0000 | [diff] [blame] | 2444 | return SQLITE_OK; |
| 2445 | } |
| 2446 | |
| 2447 | /* |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 2448 | ** This function is called by the pcache layer when it has reached some |
| 2449 | ** soft memory limit. The argument is a pointer to a purgeable Pager |
| 2450 | ** object. This function attempts to make a single dirty page that has no |
| 2451 | ** outstanding references (if one exists) clean so that it can be recycled |
| 2452 | ** by the pcache layer. |
drh | 2554f8b | 2003-01-22 01:26:44 +0000 | [diff] [blame] | 2453 | */ |
danielk1977 | a858aa2 | 2008-08-22 16:22:17 +0000 | [diff] [blame] | 2454 | static int pagerStress(void *p, PgHdr *pPg){ |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 2455 | Pager *pPager = (Pager *)p; |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 2456 | int rc = SQLITE_OK; |
drh | 8f2e9a1 | 2008-02-26 14:46:04 +0000 | [diff] [blame] | 2457 | |
danielk1977 | 8c20014 | 2008-08-25 07:12:28 +0000 | [diff] [blame] | 2458 | if( pPager->doNotSync ){ |
| 2459 | return SQLITE_OK; |
| 2460 | } |
| 2461 | |
danielk1977 | a858aa2 | 2008-08-22 16:22:17 +0000 | [diff] [blame] | 2462 | assert( pPg->flags&PGHDR_DIRTY ); |
| 2463 | if( pPager->errCode==SQLITE_OK ){ |
| 2464 | if( pPg->flags&PGHDR_NEED_SYNC ){ |
| 2465 | rc = syncJournal(pPager); |
| 2466 | if( rc==SQLITE_OK && pPager->fullSync && |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 2467 | !(pPager->journalMode==PAGER_JOURNALMODE_MEMORY) && |
danielk1977 | a858aa2 | 2008-08-22 16:22:17 +0000 | [diff] [blame] | 2468 | !(sqlite3OsDeviceCharacteristics(pPager->fd)&SQLITE_IOCAP_SAFE_APPEND) |
| 2469 | ){ |
| 2470 | pPager->nRec = 0; |
| 2471 | rc = writeJournalHdr(pPager); |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 2472 | } |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 2473 | } |
danielk1977 | a858aa2 | 2008-08-22 16:22:17 +0000 | [diff] [blame] | 2474 | if( rc==SQLITE_OK ){ |
| 2475 | pPg->pDirty = 0; |
| 2476 | rc = pager_write_pagelist(pPg); |
| 2477 | } |
| 2478 | if( rc!=SQLITE_OK ){ |
| 2479 | pager_error(pPager, rc); |
| 2480 | } |
| 2481 | } |
| 2482 | |
| 2483 | if( rc==SQLITE_OK ){ |
| 2484 | sqlite3PcacheMakeClean(pPg); |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 2485 | } |
| 2486 | return rc; |
drh | 2554f8b | 2003-01-22 01:26:44 +0000 | [diff] [blame] | 2487 | } |
| 2488 | |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 2489 | |
drh | 2554f8b | 2003-01-22 01:26:44 +0000 | [diff] [blame] | 2490 | /* |
drh | 19db935 | 2008-03-27 22:42:51 +0000 | [diff] [blame] | 2491 | ** Return 1 if there is a hot journal on the given pager. |
drh | 165ffe9 | 2005-03-15 17:09:30 +0000 | [diff] [blame] | 2492 | ** A hot journal is one that needs to be played back. |
| 2493 | ** |
| 2494 | ** If the current size of the database file is 0 but a journal file |
| 2495 | ** exists, that is probably an old journal left over from a prior |
| 2496 | ** database with the same name. Just delete the journal. |
drh | 19db935 | 2008-03-27 22:42:51 +0000 | [diff] [blame] | 2497 | ** |
| 2498 | ** Return negative if unable to determine the status of the journal. |
drh | 82ed1e5 | 2008-04-25 12:25:42 +0000 | [diff] [blame] | 2499 | ** |
| 2500 | ** This routine does not open the journal file to examine its |
| 2501 | ** content. Hence, the journal might contain the name of a master |
| 2502 | ** journal file that has been deleted, and hence not be hot. Or |
| 2503 | ** the header of the journal might be zeroed out. This routine |
| 2504 | ** does not discover these cases of a non-hot journal - if the |
| 2505 | ** journal file exists and is not empty this routine assumes it |
| 2506 | ** is hot. The pager_playback() routine will discover that the |
| 2507 | ** journal file is not really hot and will no-op. |
drh | 165ffe9 | 2005-03-15 17:09:30 +0000 | [diff] [blame] | 2508 | */ |
danielk1977 | d300b8a | 2008-08-01 10:50:23 +0000 | [diff] [blame] | 2509 | static int hasHotJournal(Pager *pPager, int *pExists){ |
danielk1977 | b4b4741 | 2007-08-17 15:53:36 +0000 | [diff] [blame] | 2510 | sqlite3_vfs *pVfs = pPager->pVfs; |
danielk1977 | d300b8a | 2008-08-01 10:50:23 +0000 | [diff] [blame] | 2511 | int rc = SQLITE_OK; |
drh | 0a846f9 | 2008-08-25 17:23:29 +0000 | [diff] [blame] | 2512 | int exists; |
| 2513 | int locked; |
| 2514 | assert( pPager!=0 ); |
| 2515 | assert( pPager->useJournal ); |
| 2516 | assert( pPager->fd->pMethods ); |
danielk1977 | d300b8a | 2008-08-01 10:50:23 +0000 | [diff] [blame] | 2517 | *pExists = 0; |
drh | 0a846f9 | 2008-08-25 17:23:29 +0000 | [diff] [blame] | 2518 | rc = sqlite3OsAccess(pVfs, pPager->zJournal, SQLITE_ACCESS_EXISTS, &exists); |
| 2519 | if( rc==SQLITE_OK && exists ){ |
| 2520 | rc = sqlite3OsCheckReservedLock(pPager->fd, &locked); |
| 2521 | } |
| 2522 | if( rc==SQLITE_OK && exists && !locked ){ |
| 2523 | int nPage; |
| 2524 | rc = sqlite3PagerPagecount(pPager, &nPage); |
| 2525 | if( rc==SQLITE_OK ){ |
| 2526 | if( nPage==0 ){ |
| 2527 | sqlite3OsDelete(pVfs, pPager->zJournal, 0); |
| 2528 | }else{ |
| 2529 | *pExists = 1; |
danielk1977 | 861f745 | 2008-06-05 11:39:11 +0000 | [diff] [blame] | 2530 | } |
| 2531 | } |
drh | bb5f18d | 2007-04-06 18:23:17 +0000 | [diff] [blame] | 2532 | } |
danielk1977 | d300b8a | 2008-08-01 10:50:23 +0000 | [diff] [blame] | 2533 | return rc; |
drh | 165ffe9 | 2005-03-15 17:09:30 +0000 | [diff] [blame] | 2534 | } |
| 2535 | |
| 2536 | /* |
danielk1977 | e180dd9 | 2007-04-05 17:15:52 +0000 | [diff] [blame] | 2537 | ** Read the content of page pPg out of the database file. |
| 2538 | */ |
| 2539 | static int readDbPage(Pager *pPager, PgHdr *pPg, Pgno pgno){ |
| 2540 | int rc; |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 2541 | i64 offset; |
danielk1977 | e180dd9 | 2007-04-05 17:15:52 +0000 | [diff] [blame] | 2542 | assert( MEMDB==0 ); |
danielk1977 | 7a2b1ee | 2007-08-21 14:27:01 +0000 | [diff] [blame] | 2543 | assert(pPager->fd->pMethods||pPager->tempFile); |
| 2544 | if( !pPager->fd->pMethods ){ |
| 2545 | return SQLITE_IOERR_SHORT_READ; |
| 2546 | } |
danielk1977 | 6207906 | 2007-08-15 17:08:46 +0000 | [diff] [blame] | 2547 | offset = (pgno-1)*(i64)pPager->pageSize; |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 2548 | rc = sqlite3OsRead(pPager->fd, pPg->pData, pPager->pageSize, offset); |
drh | 538f570 | 2007-04-13 02:14:30 +0000 | [diff] [blame] | 2549 | PAGER_INCR(sqlite3_pager_readdb_count); |
| 2550 | PAGER_INCR(pPager->nRead); |
| 2551 | IOTRACE(("PGIN %p %d\n", pPager, pgno)); |
drh | 86a8811 | 2007-04-16 15:02:19 +0000 | [diff] [blame] | 2552 | if( pgno==1 ){ |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 2553 | memcpy(&pPager->dbFileVers, &((u8*)pPg->pData)[24], |
drh | 86a8811 | 2007-04-16 15:02:19 +0000 | [diff] [blame] | 2554 | sizeof(pPager->dbFileVers)); |
| 2555 | } |
danielk1977 | 3084952 | 2008-08-21 04:35:18 +0000 | [diff] [blame] | 2556 | CODEC1(pPager, pPg->pData, pPg->pgno, 3); |
drh | 477731b | 2007-06-16 03:06:27 +0000 | [diff] [blame] | 2557 | PAGERTRACE4("FETCH %d page %d hash(%08x)\n", |
| 2558 | PAGERID(pPager), pPg->pgno, pager_pagehash(pPg)); |
danielk1977 | e180dd9 | 2007-04-05 17:15:52 +0000 | [diff] [blame] | 2559 | return rc; |
| 2560 | } |
| 2561 | |
| 2562 | |
| 2563 | /* |
danielk1977 | e277be0 | 2007-03-23 18:12:06 +0000 | [diff] [blame] | 2564 | ** This function is called to obtain the shared lock required before |
| 2565 | ** data may be read from the pager cache. If the shared lock has already |
| 2566 | ** been obtained, this function is a no-op. |
danielk1977 | 393f068 | 2007-03-31 10:00:48 +0000 | [diff] [blame] | 2567 | ** |
| 2568 | ** Immediately after obtaining the shared lock (if required), this function |
| 2569 | ** checks for a hot-journal file. If one is found, an emergency rollback |
| 2570 | ** is performed immediately. |
danielk1977 | e277be0 | 2007-03-23 18:12:06 +0000 | [diff] [blame] | 2571 | */ |
| 2572 | static int pagerSharedLock(Pager *pPager){ |
| 2573 | int rc = SQLITE_OK; |
danielk1977 | d300b8a | 2008-08-01 10:50:23 +0000 | [diff] [blame] | 2574 | int isErrorReset = 0; |
danielk1977 | e277be0 | 2007-03-23 18:12:06 +0000 | [diff] [blame] | 2575 | |
danielk1977 | ae72d98 | 2007-10-03 08:46:44 +0000 | [diff] [blame] | 2576 | /* If this database is opened for exclusive access, has no outstanding |
| 2577 | ** page references and is in an error-state, now is the chance to clear |
| 2578 | ** the error. Discard the contents of the pager-cache and treat any |
| 2579 | ** open journal file as a hot-journal. |
| 2580 | */ |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 2581 | if( !MEMDB && pPager->exclusiveMode |
| 2582 | && sqlite3PcacheRefCount(pPager->pPCache)==0 && pPager->errCode |
| 2583 | ){ |
danielk1977 | ae72d98 | 2007-10-03 08:46:44 +0000 | [diff] [blame] | 2584 | if( pPager->journalOpen ){ |
danielk1977 | d300b8a | 2008-08-01 10:50:23 +0000 | [diff] [blame] | 2585 | isErrorReset = 1; |
danielk1977 | ae72d98 | 2007-10-03 08:46:44 +0000 | [diff] [blame] | 2586 | } |
danielk1977 | ae72d98 | 2007-10-03 08:46:44 +0000 | [diff] [blame] | 2587 | pPager->errCode = SQLITE_OK; |
danielk1977 | 93f7af9 | 2008-05-09 16:57:50 +0000 | [diff] [blame] | 2588 | pager_reset(pPager); |
danielk1977 | ae72d98 | 2007-10-03 08:46:44 +0000 | [diff] [blame] | 2589 | } |
| 2590 | |
| 2591 | /* If the pager is still in an error state, do not proceed. The error |
| 2592 | ** state will be cleared at some point in the future when all page |
| 2593 | ** references are dropped and the cache can be discarded. |
| 2594 | */ |
| 2595 | if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){ |
| 2596 | return pPager->errCode; |
| 2597 | } |
| 2598 | |
danielk1977 | d300b8a | 2008-08-01 10:50:23 +0000 | [diff] [blame] | 2599 | if( pPager->state==PAGER_UNLOCK || isErrorReset ){ |
danielk1977 | b4b4741 | 2007-08-17 15:53:36 +0000 | [diff] [blame] | 2600 | sqlite3_vfs *pVfs = pPager->pVfs; |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 2601 | int isHotJournal; |
shane | 049fc21 | 2008-10-22 16:26:47 +0000 | [diff] [blame] | 2602 | assert( !MEMDB ); |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 2603 | assert( sqlite3PcacheRefCount(pPager->pPCache)==0 ); |
| 2604 | if( !pPager->noReadlock ){ |
| 2605 | rc = pager_wait_on_lock(pPager, SHARED_LOCK); |
| 2606 | if( rc!=SQLITE_OK ){ |
| 2607 | assert( pPager->state==PAGER_UNLOCK ); |
| 2608 | return pager_error(pPager, rc); |
danielk1977 | e277be0 | 2007-03-23 18:12:06 +0000 | [diff] [blame] | 2609 | } |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 2610 | assert( pPager->state>=SHARED_LOCK ); |
| 2611 | } |
| 2612 | |
| 2613 | /* If a journal file exists, and there is no RESERVED lock on the |
| 2614 | ** database file, then it either needs to be played back or deleted. |
| 2615 | */ |
| 2616 | if( !isErrorReset ){ |
| 2617 | rc = hasHotJournal(pPager, &isHotJournal); |
| 2618 | if( rc!=SQLITE_OK ){ |
| 2619 | goto failed; |
| 2620 | } |
| 2621 | } |
| 2622 | if( isErrorReset || isHotJournal ){ |
| 2623 | /* Get an EXCLUSIVE lock on the database file. At this point it is |
| 2624 | ** important that a RESERVED lock is not obtained on the way to the |
| 2625 | ** EXCLUSIVE lock. If it were, another process might open the |
| 2626 | ** database file, detect the RESERVED lock, and conclude that the |
| 2627 | ** database is safe to read while this process is still rolling it |
| 2628 | ** back. |
| 2629 | ** |
| 2630 | ** Because the intermediate RESERVED lock is not requested, the |
| 2631 | ** second process will get to this point in the code and fail to |
| 2632 | ** obtain its own EXCLUSIVE lock on the database file. |
danielk1977 | e277be0 | 2007-03-23 18:12:06 +0000 | [diff] [blame] | 2633 | */ |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 2634 | if( pPager->state<EXCLUSIVE_LOCK ){ |
| 2635 | rc = sqlite3OsLock(pPager->fd, EXCLUSIVE_LOCK); |
danielk1977 | e277be0 | 2007-03-23 18:12:06 +0000 | [diff] [blame] | 2636 | if( rc!=SQLITE_OK ){ |
danielk1977 | 52b472a | 2008-05-05 16:23:55 +0000 | [diff] [blame] | 2637 | rc = pager_error(pPager, rc); |
| 2638 | goto failed; |
danielk1977 | e277be0 | 2007-03-23 18:12:06 +0000 | [diff] [blame] | 2639 | } |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 2640 | pPager->state = PAGER_EXCLUSIVE; |
| 2641 | } |
| 2642 | |
| 2643 | /* Open the journal for read/write access. This is because in |
| 2644 | ** exclusive-access mode the file descriptor will be kept open and |
| 2645 | ** possibly used for a transaction later on. On some systems, the |
| 2646 | ** OsTruncate() call used in exclusive-access mode also requires |
| 2647 | ** a read/write file handle. |
| 2648 | */ |
| 2649 | if( !isErrorReset && pPager->journalOpen==0 ){ |
| 2650 | int res; |
| 2651 | rc = sqlite3OsAccess(pVfs,pPager->zJournal,SQLITE_ACCESS_EXISTS,&res); |
| 2652 | if( rc==SQLITE_OK ){ |
| 2653 | if( res ){ |
| 2654 | int fout = 0; |
| 2655 | int f = SQLITE_OPEN_READWRITE|SQLITE_OPEN_MAIN_JOURNAL; |
| 2656 | assert( !pPager->tempFile ); |
| 2657 | rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, f, &fout); |
| 2658 | assert( rc!=SQLITE_OK || pPager->jfd->pMethods ); |
danielk1977 | 281d8bd | 2008-10-29 07:01:56 +0000 | [diff] [blame] | 2659 | if( rc==SQLITE_OK && fout&SQLITE_OPEN_READONLY ){ |
| 2660 | rc = SQLITE_CANTOPEN; |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 2661 | sqlite3OsClose(pPager->jfd); |
| 2662 | } |
| 2663 | }else{ |
| 2664 | /* If the journal does not exist, that means some other process |
| 2665 | ** has already rolled it back */ |
| 2666 | rc = SQLITE_BUSY; |
| 2667 | } |
| 2668 | } |
| 2669 | } |
| 2670 | if( rc!=SQLITE_OK ){ |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 2671 | goto failed; |
| 2672 | } |
| 2673 | pPager->journalOpen = 1; |
| 2674 | pPager->journalStarted = 0; |
| 2675 | pPager->journalOff = 0; |
| 2676 | pPager->setMaster = 0; |
| 2677 | pPager->journalHdr = 0; |
| 2678 | |
| 2679 | /* Playback and delete the journal. Drop the database write |
| 2680 | ** lock and reacquire the read lock. |
| 2681 | */ |
| 2682 | rc = pager_playback(pPager, 1); |
| 2683 | if( rc!=SQLITE_OK ){ |
| 2684 | rc = pager_error(pPager, rc); |
| 2685 | goto failed; |
| 2686 | } |
| 2687 | assert(pPager->state==PAGER_SHARED || |
| 2688 | (pPager->exclusiveMode && pPager->state>PAGER_SHARED) |
| 2689 | ); |
| 2690 | } |
| 2691 | |
| 2692 | if( sqlite3PcachePagecount(pPager->pPCache)>0 ){ |
| 2693 | /* The shared-lock has just been acquired on the database file |
| 2694 | ** and there are already pages in the cache (from a previous |
| 2695 | ** read or write transaction). Check to see if the database |
| 2696 | ** has been modified. If the database has changed, flush the |
| 2697 | ** cache. |
| 2698 | ** |
| 2699 | ** Database changes is detected by looking at 15 bytes beginning |
| 2700 | ** at offset 24 into the file. The first 4 of these 16 bytes are |
| 2701 | ** a 32-bit counter that is incremented with each change. The |
| 2702 | ** other bytes change randomly with each file change when |
| 2703 | ** a codec is in use. |
| 2704 | ** |
| 2705 | ** There is a vanishingly small chance that a change will not be |
| 2706 | ** detected. The chance of an undetected change is so small that |
| 2707 | ** it can be neglected. |
| 2708 | */ |
| 2709 | char dbFileVers[sizeof(pPager->dbFileVers)]; |
| 2710 | sqlite3PagerPagecount(pPager, 0); |
| 2711 | |
| 2712 | if( pPager->errCode ){ |
| 2713 | rc = pPager->errCode; |
| 2714 | goto failed; |
danielk1977 | e277be0 | 2007-03-23 18:12:06 +0000 | [diff] [blame] | 2715 | } |
| 2716 | |
danielk1977 | d92db53 | 2008-11-17 04:56:24 +0000 | [diff] [blame] | 2717 | assert( pPager->dbSizeValid ); |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 2718 | if( pPager->dbSize>0 ){ |
| 2719 | IOTRACE(("CKVERS %p %d\n", pPager, sizeof(dbFileVers))); |
| 2720 | rc = sqlite3OsRead(pPager->fd, &dbFileVers, sizeof(dbFileVers), 24); |
| 2721 | if( rc!=SQLITE_OK ){ |
danielk1977 | 52b472a | 2008-05-05 16:23:55 +0000 | [diff] [blame] | 2722 | goto failed; |
danielk1977 | e277be0 | 2007-03-23 18:12:06 +0000 | [diff] [blame] | 2723 | } |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 2724 | }else{ |
| 2725 | memset(dbFileVers, 0, sizeof(dbFileVers)); |
| 2726 | } |
danielk1977 | e277be0 | 2007-03-23 18:12:06 +0000 | [diff] [blame] | 2727 | |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 2728 | if( memcmp(pPager->dbFileVers, dbFileVers, sizeof(dbFileVers))!=0 ){ |
| 2729 | pager_reset(pPager); |
danielk1977 | e277be0 | 2007-03-23 18:12:06 +0000 | [diff] [blame] | 2730 | } |
| 2731 | } |
danielk1977 | c585971 | 2007-03-26 12:26:27 +0000 | [diff] [blame] | 2732 | assert( pPager->exclusiveMode || pPager->state<=PAGER_SHARED ); |
| 2733 | if( pPager->state==PAGER_UNLOCK ){ |
| 2734 | pPager->state = PAGER_SHARED; |
| 2735 | } |
danielk1977 | e277be0 | 2007-03-23 18:12:06 +0000 | [diff] [blame] | 2736 | } |
| 2737 | |
danielk1977 | 52b472a | 2008-05-05 16:23:55 +0000 | [diff] [blame] | 2738 | failed: |
| 2739 | if( rc!=SQLITE_OK ){ |
| 2740 | /* pager_unlock() is a no-op for exclusive mode and in-memory databases. */ |
| 2741 | pager_unlock(pPager); |
| 2742 | } |
danielk1977 | e277be0 | 2007-03-23 18:12:06 +0000 | [diff] [blame] | 2743 | return rc; |
| 2744 | } |
| 2745 | |
| 2746 | /* |
drh | d33d5a8 | 2007-04-26 12:11:28 +0000 | [diff] [blame] | 2747 | ** Make sure we have the content for a page. If the page was |
| 2748 | ** previously acquired with noContent==1, then the content was |
| 2749 | ** just initialized to zeros instead of being read from disk. |
| 2750 | ** But now we need the real data off of disk. So make sure we |
| 2751 | ** have it. Read it in if we do not have it already. |
| 2752 | */ |
| 2753 | static int pager_get_content(PgHdr *pPg){ |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 2754 | if( pPg->flags&PGHDR_NEED_READ ){ |
drh | d33d5a8 | 2007-04-26 12:11:28 +0000 | [diff] [blame] | 2755 | int rc = readDbPage(pPg->pPager, pPg, pPg->pgno); |
| 2756 | if( rc==SQLITE_OK ){ |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 2757 | pPg->flags &= ~PGHDR_NEED_READ; |
drh | d33d5a8 | 2007-04-26 12:11:28 +0000 | [diff] [blame] | 2758 | }else{ |
| 2759 | return rc; |
| 2760 | } |
| 2761 | } |
| 2762 | return SQLITE_OK; |
| 2763 | } |
| 2764 | |
| 2765 | /* |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 2766 | ** If the reference count has reached zero, and the pager is not in the |
| 2767 | ** middle of a write transaction or opened in exclusive mode, unlock it. |
| 2768 | */ |
| 2769 | static void pagerUnlockIfUnused(Pager *pPager){ |
| 2770 | if( (sqlite3PcacheRefCount(pPager->pPCache)==0) |
| 2771 | && (!pPager->exclusiveMode || pPager->journalOff>0) |
| 2772 | ){ |
| 2773 | pagerUnlockAndRollback(pPager); |
| 2774 | } |
| 2775 | } |
| 2776 | |
| 2777 | /* |
| 2778 | ** Drop a page from the cache using sqlite3PcacheDrop(). |
| 2779 | ** |
| 2780 | ** If this means there are now no pages with references to them, a rollback |
| 2781 | ** occurs and the lock on the database is removed. |
| 2782 | */ |
| 2783 | static void pagerDropPage(DbPage *pPg){ |
| 2784 | Pager *pPager = pPg->pPager; |
| 2785 | sqlite3PcacheDrop(pPg); |
| 2786 | pagerUnlockIfUnused(pPager); |
| 2787 | } |
| 2788 | |
| 2789 | /* |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2790 | ** Acquire a page. |
| 2791 | ** |
drh | 58a1168 | 2001-11-10 13:51:08 +0000 | [diff] [blame] | 2792 | ** A read lock on the disk file is obtained when the first page is acquired. |
drh | 5e00f6c | 2001-09-13 13:46:56 +0000 | [diff] [blame] | 2793 | ** This read lock is dropped when the last page is released. |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2794 | ** |
drh | d33d5a8 | 2007-04-26 12:11:28 +0000 | [diff] [blame] | 2795 | ** This routine works for any page number greater than 0. If the database |
drh | 306dc21 | 2001-05-21 13:45:10 +0000 | [diff] [blame] | 2796 | ** file is smaller than the requested page, then no actual disk |
| 2797 | ** read occurs and the memory image of the page is initialized to |
| 2798 | ** all zeros. The extra data appended to a page is always initialized |
| 2799 | ** to zeros the first time a page is loaded into memory. |
| 2800 | ** |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2801 | ** The acquisition might fail for several reasons. In all cases, |
| 2802 | ** an appropriate error code is returned and *ppPage is set to NULL. |
drh | 7e3b0a0 | 2001-04-28 16:52:40 +0000 | [diff] [blame] | 2803 | ** |
drh | d33d5a8 | 2007-04-26 12:11:28 +0000 | [diff] [blame] | 2804 | ** See also sqlite3PagerLookup(). Both this routine and Lookup() attempt |
drh | 7e3b0a0 | 2001-04-28 16:52:40 +0000 | [diff] [blame] | 2805 | ** to find a page in the in-memory cache first. If the page is not already |
drh | d33d5a8 | 2007-04-26 12:11:28 +0000 | [diff] [blame] | 2806 | ** in memory, this routine goes to disk to read it in whereas Lookup() |
drh | 7e3b0a0 | 2001-04-28 16:52:40 +0000 | [diff] [blame] | 2807 | ** just returns 0. This routine acquires a read-lock the first time it |
| 2808 | ** has to go to disk, and could also playback an old journal if necessary. |
drh | d33d5a8 | 2007-04-26 12:11:28 +0000 | [diff] [blame] | 2809 | ** Since Lookup() never goes to disk, it never has to deal with locks |
drh | 7e3b0a0 | 2001-04-28 16:52:40 +0000 | [diff] [blame] | 2810 | ** or journal files. |
drh | 0787db6 | 2007-03-04 13:15:27 +0000 | [diff] [blame] | 2811 | ** |
drh | 538f570 | 2007-04-13 02:14:30 +0000 | [diff] [blame] | 2812 | ** If noContent is false, the page contents are actually read from disk. |
| 2813 | ** If noContent is true, it means that we do not care about the contents |
| 2814 | ** of the page at this time, so do not do a disk read. Just fill in the |
| 2815 | ** page content with zeros. But mark the fact that we have not read the |
| 2816 | ** content by setting the PgHdr.needRead flag. Later on, if |
drh | d33d5a8 | 2007-04-26 12:11:28 +0000 | [diff] [blame] | 2817 | ** sqlite3PagerWrite() is called on this page or if this routine is |
| 2818 | ** called again with noContent==0, that means that the content is needed |
| 2819 | ** and the disk read should occur at that point. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2820 | */ |
danielk1977 | 65e0ff3 | 2008-09-19 09:14:43 +0000 | [diff] [blame] | 2821 | int sqlite3PagerAcquire( |
drh | 538f570 | 2007-04-13 02:14:30 +0000 | [diff] [blame] | 2822 | Pager *pPager, /* The pager open on the database file */ |
| 2823 | Pgno pgno, /* Page number to fetch */ |
| 2824 | DbPage **ppPage, /* Write a pointer to the page here */ |
| 2825 | int noContent /* Do not bother reading content from disk if true */ |
| 2826 | ){ |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 2827 | PgHdr *pPg = 0; |
drh | 165ffe9 | 2005-03-15 17:09:30 +0000 | [diff] [blame] | 2828 | int rc; |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2829 | |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 2830 | assert( pPager->state==PAGER_UNLOCK |
| 2831 | || sqlite3PcacheRefCount(pPager->pPCache)>0 |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 2832 | || pgno==1 |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 2833 | ); |
danielk1977 | e277be0 | 2007-03-23 18:12:06 +0000 | [diff] [blame] | 2834 | |
danielk1977 | 2683665 | 2005-01-17 01:33:13 +0000 | [diff] [blame] | 2835 | /* The maximum page number is 2^31. Return SQLITE_CORRUPT if a page |
| 2836 | ** number greater than this, or zero, is requested. |
| 2837 | */ |
drh | 267cb32 | 2005-09-16 17:16:52 +0000 | [diff] [blame] | 2838 | if( pgno>PAGER_MAX_PGNO || pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){ |
drh | 4928570 | 2005-09-17 15:20:26 +0000 | [diff] [blame] | 2839 | return SQLITE_CORRUPT_BKPT; |
danielk1977 | 2683665 | 2005-01-17 01:33:13 +0000 | [diff] [blame] | 2840 | } |
| 2841 | |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2842 | /* Make sure we have not hit any critical errors. |
| 2843 | */ |
drh | 836faa4 | 2003-01-11 13:30:57 +0000 | [diff] [blame] | 2844 | assert( pPager!=0 ); |
drh | 2e6d11b | 2003-04-25 15:37:57 +0000 | [diff] [blame] | 2845 | *ppPage = 0; |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2846 | |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 2847 | /* If this is the first page accessed, then get a SHARED lock |
danielk1977 | 334cdb6 | 2007-03-26 08:05:12 +0000 | [diff] [blame] | 2848 | ** on the database file. pagerSharedLock() is a no-op if |
| 2849 | ** a database lock is already held. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2850 | */ |
danielk1977 | e277be0 | 2007-03-23 18:12:06 +0000 | [diff] [blame] | 2851 | rc = pagerSharedLock(pPager); |
| 2852 | if( rc!=SQLITE_OK ){ |
| 2853 | return rc; |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2854 | } |
danielk1977 | e277be0 | 2007-03-23 18:12:06 +0000 | [diff] [blame] | 2855 | assert( pPager->state!=PAGER_UNLOCK ); |
| 2856 | |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 2857 | rc = sqlite3PcacheFetch(pPager->pPCache, pgno, 1, &pPg); |
| 2858 | if( rc!=SQLITE_OK ){ |
| 2859 | return rc; |
| 2860 | } |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 2861 | if( pPg->pPager==0 ){ |
| 2862 | /* The pager cache has created a new page. Its content needs to |
| 2863 | ** be initialized. |
| 2864 | */ |
danielk1977 | 979f38e | 2007-03-27 16:19:51 +0000 | [diff] [blame] | 2865 | int nMax; |
drh | 538f570 | 2007-04-13 02:14:30 +0000 | [diff] [blame] | 2866 | PAGER_INCR(pPager->nMiss); |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 2867 | pPg->pPager = pPager; |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 2868 | memset(pPg->pExtra, 0, pPager->nExtra); |
danielk1977 | 2416872 | 2007-04-02 05:07:47 +0000 | [diff] [blame] | 2869 | |
danielk1977 | ad0132d | 2008-06-07 08:58:22 +0000 | [diff] [blame] | 2870 | rc = sqlite3PagerPagecount(pPager, &nMax); |
| 2871 | if( rc!=SQLITE_OK ){ |
danielk1977 | ae72d98 | 2007-10-03 08:46:44 +0000 | [diff] [blame] | 2872 | sqlite3PagerUnref(pPg); |
drh | 2e6d11b | 2003-04-25 15:37:57 +0000 | [diff] [blame] | 2873 | return rc; |
| 2874 | } |
danielk1977 | 75bab7d | 2006-01-23 13:09:45 +0000 | [diff] [blame] | 2875 | |
danielk1977 | a1fa00d | 2008-08-27 15:16:33 +0000 | [diff] [blame] | 2876 | if( nMax<(int)pgno || MEMDB || noContent ){ |
drh | f8e632b | 2007-05-08 14:51:36 +0000 | [diff] [blame] | 2877 | if( pgno>pPager->mxPgno ){ |
danielk1977 | de3bea7 | 2007-05-09 15:56:39 +0000 | [diff] [blame] | 2878 | sqlite3PagerUnref(pPg); |
drh | f8e632b | 2007-05-08 14:51:36 +0000 | [diff] [blame] | 2879 | return SQLITE_FULL; |
| 2880 | } |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 2881 | memset(pPg->pData, 0, pPager->pageSize); |
danielk1977 | a1fa00d | 2008-08-27 15:16:33 +0000 | [diff] [blame] | 2882 | if( noContent ){ |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 2883 | pPg->flags |= PGHDR_NEED_READ; |
| 2884 | } |
drh | 538f570 | 2007-04-13 02:14:30 +0000 | [diff] [blame] | 2885 | IOTRACE(("ZERO %p %d\n", pPager, pgno)); |
drh | 306dc21 | 2001-05-21 13:45:10 +0000 | [diff] [blame] | 2886 | }else{ |
danielk1977 | e180dd9 | 2007-04-05 17:15:52 +0000 | [diff] [blame] | 2887 | rc = readDbPage(pPager, pPg, pgno); |
drh | 551b773 | 2006-11-06 21:20:25 +0000 | [diff] [blame] | 2888 | if( rc!=SQLITE_OK && rc!=SQLITE_IOERR_SHORT_READ ){ |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 2889 | /* sqlite3PagerUnref(pPg); */ |
| 2890 | pagerDropPage(pPg); |
drh | 551b773 | 2006-11-06 21:20:25 +0000 | [diff] [blame] | 2891 | return rc; |
drh | 81a20f2 | 2001-10-12 17:30:04 +0000 | [diff] [blame] | 2892 | } |
drh | 306dc21 | 2001-05-21 13:45:10 +0000 | [diff] [blame] | 2893 | } |
danielk1977 | 3c40737 | 2005-02-15 02:54:14 +0000 | [diff] [blame] | 2894 | #ifdef SQLITE_CHECK_PAGES |
| 2895 | pPg->pageHash = pager_pagehash(pPg); |
| 2896 | #endif |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2897 | }else{ |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2898 | /* The requested page is in the page cache. */ |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 2899 | assert(sqlite3PcacheRefCount(pPager->pPCache)>0 || pgno==1); |
drh | 538f570 | 2007-04-13 02:14:30 +0000 | [diff] [blame] | 2900 | PAGER_INCR(pPager->nHit); |
drh | d33d5a8 | 2007-04-26 12:11:28 +0000 | [diff] [blame] | 2901 | if( !noContent ){ |
| 2902 | rc = pager_get_content(pPg); |
| 2903 | if( rc ){ |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 2904 | sqlite3PagerUnref(pPg); |
drh | d33d5a8 | 2007-04-26 12:11:28 +0000 | [diff] [blame] | 2905 | return rc; |
| 2906 | } |
| 2907 | } |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2908 | } |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 2909 | |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 2910 | *ppPage = pPg; |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2911 | return SQLITE_OK; |
| 2912 | } |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 2913 | |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2914 | /* |
drh | 7e3b0a0 | 2001-04-28 16:52:40 +0000 | [diff] [blame] | 2915 | ** Acquire a page if it is already in the in-memory cache. Do |
| 2916 | ** not read the page from disk. Return a pointer to the page, |
| 2917 | ** or 0 if the page is not in cache. |
| 2918 | ** |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 2919 | ** See also sqlite3PagerGet(). The difference between this routine |
| 2920 | ** and sqlite3PagerGet() is that _get() will go to the disk and read |
drh | 7e3b0a0 | 2001-04-28 16:52:40 +0000 | [diff] [blame] | 2921 | ** in the page if the page is not already in cache. This routine |
drh | 5e00f6c | 2001-09-13 13:46:56 +0000 | [diff] [blame] | 2922 | ** returns NULL if the page is not in cache or if a disk I/O error |
| 2923 | ** has ever happened. |
drh | 7e3b0a0 | 2001-04-28 16:52:40 +0000 | [diff] [blame] | 2924 | */ |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 2925 | DbPage *sqlite3PagerLookup(Pager *pPager, Pgno pgno){ |
drh | 86f8c19 | 2007-08-22 00:39:19 +0000 | [diff] [blame] | 2926 | PgHdr *pPg = 0; |
drh | 836faa4 | 2003-01-11 13:30:57 +0000 | [diff] [blame] | 2927 | assert( pPager!=0 ); |
| 2928 | assert( pgno!=0 ); |
danielk1977 | e277be0 | 2007-03-23 18:12:06 +0000 | [diff] [blame] | 2929 | |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 2930 | if( (pPager->state!=PAGER_UNLOCK) |
| 2931 | && (pPager->errCode==SQLITE_OK || pPager->errCode==SQLITE_FULL) |
| 2932 | ){ |
| 2933 | sqlite3PcacheFetch(pPager->pPCache, pgno, 0, &pPg); |
danielk1977 | e277be0 | 2007-03-23 18:12:06 +0000 | [diff] [blame] | 2934 | } |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 2935 | |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 2936 | return pPg; |
drh | 7e3b0a0 | 2001-04-28 16:52:40 +0000 | [diff] [blame] | 2937 | } |
| 2938 | |
| 2939 | /* |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2940 | ** Release a page. |
| 2941 | ** |
| 2942 | ** If the number of references to the page drop to zero, then the |
| 2943 | ** page is added to the LRU list. When all references to all pages |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2944 | ** are released, a rollback occurs and the lock on the database is |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2945 | ** removed. |
| 2946 | */ |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 2947 | int sqlite3PagerUnref(DbPage *pPg){ |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 2948 | if( pPg ){ |
| 2949 | Pager *pPager = pPg->pPager; |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 2950 | sqlite3PcacheRelease(pPg); |
| 2951 | pagerUnlockIfUnused(pPager); |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2952 | } |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2953 | return SQLITE_OK; |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2954 | } |
| 2955 | |
| 2956 | /* |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 2957 | ** Create a journal file for pPager. There should already be a RESERVED |
| 2958 | ** or EXCLUSIVE lock on the database file when this routine is called. |
drh | da47d77 | 2002-12-02 04:25:19 +0000 | [diff] [blame] | 2959 | ** |
| 2960 | ** Return SQLITE_OK if everything. Return an error code and release the |
| 2961 | ** write lock if anything goes wrong. |
| 2962 | */ |
| 2963 | static int pager_open_journal(Pager *pPager){ |
danielk1977 | b4b4741 | 2007-08-17 15:53:36 +0000 | [diff] [blame] | 2964 | sqlite3_vfs *pVfs = pPager->pVfs; |
| 2965 | int flags = (SQLITE_OPEN_READWRITE|SQLITE_OPEN_EXCLUSIVE|SQLITE_OPEN_CREATE); |
| 2966 | |
drh | da47d77 | 2002-12-02 04:25:19 +0000 | [diff] [blame] | 2967 | int rc; |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 2968 | assert( pPager->state>=PAGER_RESERVED ); |
drh | da47d77 | 2002-12-02 04:25:19 +0000 | [diff] [blame] | 2969 | assert( pPager->useJournal ); |
drh | f5e7bb5 | 2008-02-18 14:47:33 +0000 | [diff] [blame] | 2970 | assert( pPager->pInJournal==0 ); |
danielk1977 | ad0132d | 2008-06-07 08:58:22 +0000 | [diff] [blame] | 2971 | sqlite3PagerPagecount(pPager, 0); |
drh | f5e7bb5 | 2008-02-18 14:47:33 +0000 | [diff] [blame] | 2972 | pPager->pInJournal = sqlite3BitvecCreate(pPager->dbSize); |
drh | f5e7bb5 | 2008-02-18 14:47:33 +0000 | [diff] [blame] | 2973 | if( pPager->pInJournal==0 ){ |
drh | 9c105bb | 2004-10-02 20:38:28 +0000 | [diff] [blame] | 2974 | rc = SQLITE_NOMEM; |
| 2975 | goto failed_to_open_journal; |
drh | da47d77 | 2002-12-02 04:25:19 +0000 | [diff] [blame] | 2976 | } |
danielk1977 | b4b4741 | 2007-08-17 15:53:36 +0000 | [diff] [blame] | 2977 | |
drh | fdc40e9 | 2008-04-17 20:59:37 +0000 | [diff] [blame] | 2978 | if( pPager->journalOpen==0 ){ |
| 2979 | if( pPager->tempFile ){ |
| 2980 | flags |= (SQLITE_OPEN_DELETEONCLOSE|SQLITE_OPEN_TEMP_JOURNAL); |
| 2981 | }else{ |
| 2982 | flags |= (SQLITE_OPEN_MAIN_JOURNAL); |
drh | 600e46a | 2007-03-28 01:59:33 +0000 | [diff] [blame] | 2983 | } |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 2984 | if( pPager->journalMode==PAGER_JOURNALMODE_MEMORY ){ |
| 2985 | sqlite3MemJournalOpen(pPager->jfd); |
| 2986 | rc = SQLITE_OK; |
| 2987 | }else{ |
drh | fdc40e9 | 2008-04-17 20:59:37 +0000 | [diff] [blame] | 2988 | #ifdef SQLITE_ENABLE_ATOMIC_WRITE |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 2989 | rc = sqlite3JournalOpen( |
| 2990 | pVfs, pPager->zJournal, pPager->jfd, flags, jrnlBufferSize(pPager) |
| 2991 | ); |
drh | fdc40e9 | 2008-04-17 20:59:37 +0000 | [diff] [blame] | 2992 | #else |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 2993 | rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, flags, 0); |
drh | fdc40e9 | 2008-04-17 20:59:37 +0000 | [diff] [blame] | 2994 | #endif |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 2995 | } |
drh | fdc40e9 | 2008-04-17 20:59:37 +0000 | [diff] [blame] | 2996 | assert( rc!=SQLITE_OK || pPager->jfd->pMethods ); |
| 2997 | pPager->journalOff = 0; |
| 2998 | pPager->setMaster = 0; |
| 2999 | pPager->journalHdr = 0; |
| 3000 | if( rc!=SQLITE_OK ){ |
| 3001 | if( rc==SQLITE_NOMEM ){ |
| 3002 | sqlite3OsDelete(pVfs, pPager->zJournal, 0); |
| 3003 | } |
| 3004 | goto failed_to_open_journal; |
| 3005 | } |
drh | da47d77 | 2002-12-02 04:25:19 +0000 | [diff] [blame] | 3006 | } |
| 3007 | pPager->journalOpen = 1; |
drh | db48ee0 | 2003-01-16 13:42:43 +0000 | [diff] [blame] | 3008 | pPager->journalStarted = 0; |
drh | da47d77 | 2002-12-02 04:25:19 +0000 | [diff] [blame] | 3009 | pPager->needSync = 0; |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 3010 | pPager->nRec = 0; |
danielk1977 | efaaf57 | 2006-01-16 11:29:19 +0000 | [diff] [blame] | 3011 | if( pPager->errCode ){ |
| 3012 | rc = pPager->errCode; |
drh | dd5b2fa | 2005-03-28 03:39:55 +0000 | [diff] [blame] | 3013 | goto failed_to_open_journal; |
drh | 2e6d11b | 2003-04-25 15:37:57 +0000 | [diff] [blame] | 3014 | } |
drh | da47d77 | 2002-12-02 04:25:19 +0000 | [diff] [blame] | 3015 | pPager->origDbSize = pPager->dbSize; |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 3016 | |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 3017 | rc = writeJournalHdr(pPager); |
| 3018 | |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 3019 | if( pPager->stmtAutoopen && rc==SQLITE_OK ){ |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 3020 | rc = sqlite3PagerStmtBegin(pPager); |
drh | da47d77 | 2002-12-02 04:25:19 +0000 | [diff] [blame] | 3021 | } |
danielk1977 | ae72d98 | 2007-10-03 08:46:44 +0000 | [diff] [blame] | 3022 | if( rc!=SQLITE_OK && rc!=SQLITE_NOMEM && rc!=SQLITE_IOERR_NOMEM ){ |
danielk1977 | df2566a | 2008-05-07 19:11:03 +0000 | [diff] [blame] | 3023 | rc = pager_end_transaction(pPager, 0); |
drh | da47d77 | 2002-12-02 04:25:19 +0000 | [diff] [blame] | 3024 | if( rc==SQLITE_OK ){ |
| 3025 | rc = SQLITE_FULL; |
| 3026 | } |
| 3027 | } |
drh | 9c105bb | 2004-10-02 20:38:28 +0000 | [diff] [blame] | 3028 | return rc; |
| 3029 | |
| 3030 | failed_to_open_journal: |
drh | f5e7bb5 | 2008-02-18 14:47:33 +0000 | [diff] [blame] | 3031 | sqlite3BitvecDestroy(pPager->pInJournal); |
| 3032 | pPager->pInJournal = 0; |
drh | 9c105bb | 2004-10-02 20:38:28 +0000 | [diff] [blame] | 3033 | return rc; |
drh | da47d77 | 2002-12-02 04:25:19 +0000 | [diff] [blame] | 3034 | } |
| 3035 | |
| 3036 | /* |
drh | 4b845d7 | 2002-03-05 12:41:19 +0000 | [diff] [blame] | 3037 | ** Acquire a write-lock on the database. The lock is removed when |
| 3038 | ** the any of the following happen: |
| 3039 | ** |
drh | 80e35f4 | 2007-03-30 14:06:34 +0000 | [diff] [blame] | 3040 | ** * sqlite3PagerCommitPhaseTwo() is called. |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 3041 | ** * sqlite3PagerRollback() is called. |
| 3042 | ** * sqlite3PagerClose() is called. |
| 3043 | ** * sqlite3PagerUnref() is called to on every outstanding page. |
drh | 4b845d7 | 2002-03-05 12:41:19 +0000 | [diff] [blame] | 3044 | ** |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 3045 | ** The first parameter to this routine is a pointer to any open page of the |
| 3046 | ** database file. Nothing changes about the page - it is used merely to |
| 3047 | ** acquire a pointer to the Pager structure and as proof that there is |
| 3048 | ** already a read-lock on the database. |
drh | 4b845d7 | 2002-03-05 12:41:19 +0000 | [diff] [blame] | 3049 | ** |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 3050 | ** The second parameter indicates how much space in bytes to reserve for a |
| 3051 | ** master journal file-name at the start of the journal when it is created. |
| 3052 | ** |
| 3053 | ** A journal file is opened if this is not a temporary file. For temporary |
| 3054 | ** files, the opening of the journal file is deferred until there is an |
| 3055 | ** actual need to write to the journal. |
drh | da47d77 | 2002-12-02 04:25:19 +0000 | [diff] [blame] | 3056 | ** |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 3057 | ** If the database is already reserved for writing, this routine is a no-op. |
drh | 684917c | 2004-10-05 02:41:42 +0000 | [diff] [blame] | 3058 | ** |
| 3059 | ** If exFlag is true, go ahead and get an EXCLUSIVE lock on the file |
| 3060 | ** immediately instead of waiting until we try to flush the cache. The |
| 3061 | ** exFlag is ignored if a transaction is already active. |
drh | 4b845d7 | 2002-03-05 12:41:19 +0000 | [diff] [blame] | 3062 | */ |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 3063 | int sqlite3PagerBegin(DbPage *pPg, int exFlag){ |
drh | 4b845d7 | 2002-03-05 12:41:19 +0000 | [diff] [blame] | 3064 | Pager *pPager = pPg->pPager; |
| 3065 | int rc = SQLITE_OK; |
| 3066 | assert( pPg->nRef>0 ); |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 3067 | assert( pPager->state!=PAGER_UNLOCK ); |
| 3068 | if( pPager->state==PAGER_SHARED ){ |
drh | f5e7bb5 | 2008-02-18 14:47:33 +0000 | [diff] [blame] | 3069 | assert( pPager->pInJournal==0 ); |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 3070 | assert( !MEMDB ); |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 3071 | rc = sqlite3OsLock(pPager->fd, RESERVED_LOCK); |
| 3072 | if( rc==SQLITE_OK ){ |
| 3073 | pPager->state = PAGER_RESERVED; |
| 3074 | if( exFlag ){ |
| 3075 | rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK); |
drh | 684917c | 2004-10-05 02:41:42 +0000 | [diff] [blame] | 3076 | } |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 3077 | } |
| 3078 | if( rc!=SQLITE_OK ){ |
| 3079 | return rc; |
| 3080 | } |
| 3081 | pPager->dirtyCache = 0; |
| 3082 | PAGERTRACE2("TRANSACTION %d\n", PAGERID(pPager)); |
| 3083 | if( pPager->useJournal && !pPager->tempFile |
| 3084 | && pPager->journalMode!=PAGER_JOURNALMODE_OFF ){ |
| 3085 | rc = pager_open_journal(pPager); |
drh | 4b845d7 | 2002-03-05 12:41:19 +0000 | [diff] [blame] | 3086 | } |
danielk1977 | 334cdb6 | 2007-03-26 08:05:12 +0000 | [diff] [blame] | 3087 | }else if( pPager->journalOpen && pPager->journalOff==0 ){ |
drh | d138c01 | 2008-05-13 00:58:18 +0000 | [diff] [blame] | 3088 | /* This happens when the pager was in exclusive-access mode the last |
danielk1977 | 334cdb6 | 2007-03-26 08:05:12 +0000 | [diff] [blame] | 3089 | ** time a (read or write) transaction was successfully concluded |
| 3090 | ** by this connection. Instead of deleting the journal file it was |
drh | d138c01 | 2008-05-13 00:58:18 +0000 | [diff] [blame] | 3091 | ** kept open and either was truncated to 0 bytes or its header was |
| 3092 | ** overwritten with zeros. |
danielk1977 | 334cdb6 | 2007-03-26 08:05:12 +0000 | [diff] [blame] | 3093 | */ |
| 3094 | assert( pPager->nRec==0 ); |
| 3095 | assert( pPager->origDbSize==0 ); |
drh | f5e7bb5 | 2008-02-18 14:47:33 +0000 | [diff] [blame] | 3096 | assert( pPager->pInJournal==0 ); |
danielk1977 | ad0132d | 2008-06-07 08:58:22 +0000 | [diff] [blame] | 3097 | sqlite3PagerPagecount(pPager, 0); |
drh | f5e7bb5 | 2008-02-18 14:47:33 +0000 | [diff] [blame] | 3098 | pPager->pInJournal = sqlite3BitvecCreate( pPager->dbSize ); |
drh | f5e7bb5 | 2008-02-18 14:47:33 +0000 | [diff] [blame] | 3099 | if( !pPager->pInJournal ){ |
danielk1977 | 334cdb6 | 2007-03-26 08:05:12 +0000 | [diff] [blame] | 3100 | rc = SQLITE_NOMEM; |
| 3101 | }else{ |
drh | 369339d | 2007-03-30 16:01:55 +0000 | [diff] [blame] | 3102 | pPager->origDbSize = pPager->dbSize; |
danielk1977 | 334cdb6 | 2007-03-26 08:05:12 +0000 | [diff] [blame] | 3103 | rc = writeJournalHdr(pPager); |
| 3104 | } |
drh | 4b845d7 | 2002-03-05 12:41:19 +0000 | [diff] [blame] | 3105 | } |
danielk1977 | 334cdb6 | 2007-03-26 08:05:12 +0000 | [diff] [blame] | 3106 | assert( !pPager->journalOpen || pPager->journalOff>0 || rc!=SQLITE_OK ); |
drh | 4b845d7 | 2002-03-05 12:41:19 +0000 | [diff] [blame] | 3107 | return rc; |
| 3108 | } |
| 3109 | |
| 3110 | /* |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 3111 | ** Mark a data page as writeable. The page is written into the journal |
| 3112 | ** if it is not there already. This routine must be called before making |
| 3113 | ** changes to a page. |
| 3114 | ** |
| 3115 | ** The first time this routine is called, the pager creates a new |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 3116 | ** journal and acquires a RESERVED lock on the database. If the RESERVED |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 3117 | ** lock could not be acquired, this routine returns SQLITE_BUSY. The |
drh | 306dc21 | 2001-05-21 13:45:10 +0000 | [diff] [blame] | 3118 | ** calling routine must check for that return value and be careful not to |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 3119 | ** change any page data until this routine returns SQLITE_OK. |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 3120 | ** |
| 3121 | ** If the journal file could not be written because the disk is full, |
| 3122 | ** then this routine returns SQLITE_FULL and does an immediate rollback. |
| 3123 | ** All subsequent write attempts also return SQLITE_FULL until there |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 3124 | ** is a call to sqlite3PagerCommit() or sqlite3PagerRollback() to |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 3125 | ** reset. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 3126 | */ |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 3127 | static int pager_write(PgHdr *pPg){ |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 3128 | void *pData = pPg->pData; |
drh | 69688d5 | 2001-04-14 16:38:23 +0000 | [diff] [blame] | 3129 | Pager *pPager = pPg->pPager; |
drh | d79caeb | 2001-04-15 02:27:24 +0000 | [diff] [blame] | 3130 | int rc = SQLITE_OK; |
drh | 69688d5 | 2001-04-14 16:38:23 +0000 | [diff] [blame] | 3131 | |
drh | 6446c4d | 2001-12-15 14:22:18 +0000 | [diff] [blame] | 3132 | /* Check for errors |
| 3133 | */ |
danielk1977 | efaaf57 | 2006-01-16 11:29:19 +0000 | [diff] [blame] | 3134 | if( pPager->errCode ){ |
| 3135 | return pPager->errCode; |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 3136 | } |
drh | 5e00f6c | 2001-09-13 13:46:56 +0000 | [diff] [blame] | 3137 | if( pPager->readOnly ){ |
| 3138 | return SQLITE_PERM; |
| 3139 | } |
drh | 6446c4d | 2001-12-15 14:22:18 +0000 | [diff] [blame] | 3140 | |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 3141 | assert( !pPager->setMaster ); |
| 3142 | |
danielk1977 | 3c40737 | 2005-02-15 02:54:14 +0000 | [diff] [blame] | 3143 | CHECK_PAGE(pPg); |
| 3144 | |
drh | 538f570 | 2007-04-13 02:14:30 +0000 | [diff] [blame] | 3145 | /* If this page was previously acquired with noContent==1, that means |
| 3146 | ** we didn't really read in the content of the page. This can happen |
| 3147 | ** (for example) when the page is being moved to the freelist. But |
| 3148 | ** now we are (perhaps) moving the page off of the freelist for |
| 3149 | ** reuse and we need to know its original content so that content |
| 3150 | ** can be stored in the rollback journal. So do the read at this |
| 3151 | ** time. |
| 3152 | */ |
drh | d33d5a8 | 2007-04-26 12:11:28 +0000 | [diff] [blame] | 3153 | rc = pager_get_content(pPg); |
| 3154 | if( rc ){ |
| 3155 | return rc; |
drh | 538f570 | 2007-04-13 02:14:30 +0000 | [diff] [blame] | 3156 | } |
| 3157 | |
drh | 6446c4d | 2001-12-15 14:22:18 +0000 | [diff] [blame] | 3158 | /* Mark the page as dirty. If the page has already been written |
| 3159 | ** to the journal then we can return right away. |
| 3160 | */ |
drh | c047b9f | 2008-11-21 03:23:43 +0000 | [diff] [blame^] | 3161 | sqlite3PcacheMakeDirty(pPg); |
danielk1977 | bc2ca9e | 2008-11-13 14:28:28 +0000 | [diff] [blame] | 3162 | if( pageInJournal(pPg) && (pageInStatement(pPg) || pPager->stmtInUse==0) ){ |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 3163 | pPager->dirtyCache = 1; |
drh | d138c01 | 2008-05-13 00:58:18 +0000 | [diff] [blame] | 3164 | pPager->dbModified = 1; |
danielk1977 | a0bf265 | 2004-11-04 14:30:04 +0000 | [diff] [blame] | 3165 | }else{ |
drh | 6446c4d | 2001-12-15 14:22:18 +0000 | [diff] [blame] | 3166 | |
danielk1977 | a0bf265 | 2004-11-04 14:30:04 +0000 | [diff] [blame] | 3167 | /* If we get this far, it means that the page needs to be |
| 3168 | ** written to the transaction journal or the ckeckpoint journal |
| 3169 | ** or both. |
| 3170 | ** |
| 3171 | ** First check to see that the transaction journal exists and |
| 3172 | ** create it if it does not. |
| 3173 | */ |
| 3174 | assert( pPager->state!=PAGER_UNLOCK ); |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 3175 | rc = sqlite3PagerBegin(pPg, 0); |
danielk1977 | a0bf265 | 2004-11-04 14:30:04 +0000 | [diff] [blame] | 3176 | if( rc!=SQLITE_OK ){ |
| 3177 | return rc; |
| 3178 | } |
| 3179 | assert( pPager->state>=PAGER_RESERVED ); |
drh | fdc40e9 | 2008-04-17 20:59:37 +0000 | [diff] [blame] | 3180 | if( !pPager->journalOpen && pPager->useJournal |
| 3181 | && pPager->journalMode!=PAGER_JOURNALMODE_OFF ){ |
danielk1977 | a0bf265 | 2004-11-04 14:30:04 +0000 | [diff] [blame] | 3182 | rc = pager_open_journal(pPager); |
| 3183 | if( rc!=SQLITE_OK ) return rc; |
| 3184 | } |
danielk1977 | a0bf265 | 2004-11-04 14:30:04 +0000 | [diff] [blame] | 3185 | pPager->dirtyCache = 1; |
drh | d138c01 | 2008-05-13 00:58:18 +0000 | [diff] [blame] | 3186 | pPager->dbModified = 1; |
danielk1977 | a0bf265 | 2004-11-04 14:30:04 +0000 | [diff] [blame] | 3187 | |
| 3188 | /* The transaction journal now exists and we have a RESERVED or an |
| 3189 | ** EXCLUSIVE lock on the main database file. Write the current page to |
| 3190 | ** the transaction journal if it is not there already. |
| 3191 | */ |
danielk1977 | bc2ca9e | 2008-11-13 14:28:28 +0000 | [diff] [blame] | 3192 | if( !pageInJournal(pPg) && pPager->journalOpen ){ |
danielk1977 | d92db53 | 2008-11-17 04:56:24 +0000 | [diff] [blame] | 3193 | if( pPg->pgno<=pPager->origDbSize ){ |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 3194 | u32 cksum; |
| 3195 | char *pData2; |
danielk1977 | dd97a49 | 2007-08-22 18:54:32 +0000 | [diff] [blame] | 3196 | |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 3197 | /* We should never write to the journal file the page that |
| 3198 | ** contains the database locks. The following assert verifies |
| 3199 | ** that we do not. */ |
| 3200 | assert( pPg->pgno!=PAGER_MJ_PGNO(pPager) ); |
| 3201 | pData2 = CODEC2(pPager, pData, pPg->pgno, 7); |
| 3202 | cksum = pager_cksum(pPager, (u8*)pData2); |
| 3203 | rc = write32bits(pPager->jfd, pPager->journalOff, pPg->pgno); |
| 3204 | if( rc==SQLITE_OK ){ |
| 3205 | rc = sqlite3OsWrite(pPager->jfd, pData2, pPager->pageSize, |
| 3206 | pPager->journalOff + 4); |
| 3207 | pPager->journalOff += pPager->pageSize+4; |
| 3208 | } |
| 3209 | if( rc==SQLITE_OK ){ |
| 3210 | rc = write32bits(pPager->jfd, pPager->journalOff, cksum); |
| 3211 | pPager->journalOff += 4; |
| 3212 | } |
| 3213 | IOTRACE(("JOUT %p %d %lld %d\n", pPager, pPg->pgno, |
| 3214 | pPager->journalOff, pPager->pageSize)); |
| 3215 | PAGER_INCR(sqlite3_pager_writej_count); |
| 3216 | PAGERTRACE5("JOURNAL %d page %d needSync=%d hash(%08x)\n", |
| 3217 | PAGERID(pPager), pPg->pgno, |
| 3218 | ((pPg->flags&PGHDR_NEED_SYNC)?1:0), pager_pagehash(pPg)); |
danielk1977 | 07cb560 | 2006-01-20 10:55:05 +0000 | [diff] [blame] | 3219 | |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 3220 | /* An error has occured writing to the journal file. The |
| 3221 | ** transaction will be rolled back by the layer above. |
| 3222 | */ |
| 3223 | if( rc!=SQLITE_OK ){ |
| 3224 | return rc; |
| 3225 | } |
danielk1977 | 07cb560 | 2006-01-20 10:55:05 +0000 | [diff] [blame] | 3226 | |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 3227 | pPager->nRec++; |
| 3228 | assert( pPager->pInJournal!=0 ); |
| 3229 | sqlite3BitvecSet(pPager->pInJournal, pPg->pgno); |
| 3230 | if( !pPager->noSync ){ |
| 3231 | pPg->flags |= PGHDR_NEED_SYNC; |
| 3232 | } |
| 3233 | if( pPager->stmtInUse ){ |
| 3234 | sqlite3BitvecSet(pPager->pInStmt, pPg->pgno); |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 3235 | } |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 3236 | }else{ |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 3237 | if( !pPager->journalStarted && !pPager->noSync ){ |
| 3238 | pPg->flags |= PGHDR_NEED_SYNC; |
| 3239 | } |
drh | 4f0c587 | 2007-03-26 22:05:01 +0000 | [diff] [blame] | 3240 | PAGERTRACE4("APPEND %d page %d needSync=%d\n", |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 3241 | PAGERID(pPager), pPg->pgno, |
| 3242 | ((pPg->flags&PGHDR_NEED_SYNC)?1:0)); |
danielk1977 | a0bf265 | 2004-11-04 14:30:04 +0000 | [diff] [blame] | 3243 | } |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 3244 | if( pPg->flags&PGHDR_NEED_SYNC ){ |
danielk1977 | a0bf265 | 2004-11-04 14:30:04 +0000 | [diff] [blame] | 3245 | pPager->needSync = 1; |
| 3246 | } |
danielk1977 | a0bf265 | 2004-11-04 14:30:04 +0000 | [diff] [blame] | 3247 | } |
| 3248 | |
| 3249 | /* If the statement journal is open and the page is not in it, |
| 3250 | ** then write the current page to the statement journal. Note that |
| 3251 | ** the statement journal format differs from the standard journal format |
| 3252 | ** in that it omits the checksums and the header. |
| 3253 | */ |
danielk1977 | f35843b | 2007-04-07 15:03:17 +0000 | [diff] [blame] | 3254 | if( pPager->stmtInUse |
| 3255 | && !pageInStatement(pPg) |
danielk1977 | d92db53 | 2008-11-17 04:56:24 +0000 | [diff] [blame] | 3256 | && pPg->pgno<=pPager->stmtSize |
danielk1977 | f35843b | 2007-04-07 15:03:17 +0000 | [diff] [blame] | 3257 | ){ |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 3258 | i64 offset = pPager->stmtNRec*(4+pPager->pageSize); |
| 3259 | char *pData2 = CODEC2(pPager, pData, pPg->pgno, 7); |
danielk1977 | d92db53 | 2008-11-17 04:56:24 +0000 | [diff] [blame] | 3260 | assert( pageInJournal(pPg) || pPg->pgno>pPager->origDbSize ); |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 3261 | rc = write32bits(pPager->stfd, offset, pPg->pgno); |
| 3262 | if( rc==SQLITE_OK ){ |
| 3263 | rc = sqlite3OsWrite(pPager->stfd, pData2, pPager->pageSize, offset+4); |
drh | db48ee0 | 2003-01-16 13:42:43 +0000 | [diff] [blame] | 3264 | } |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 3265 | PAGERTRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno); |
| 3266 | if( rc!=SQLITE_OK ){ |
| 3267 | return rc; |
| 3268 | } |
| 3269 | pPager->stmtNRec++; |
| 3270 | assert( pPager->pInStmt!=0 ); |
| 3271 | sqlite3BitvecSet(pPager->pInStmt, pPg->pgno); |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 3272 | } |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 3273 | } |
| 3274 | |
| 3275 | /* Update the database size and return. |
| 3276 | */ |
drh | 1aa2d8b | 2007-01-03 15:34:29 +0000 | [diff] [blame] | 3277 | assert( pPager->state>=PAGER_SHARED ); |
danielk1977 | d92db53 | 2008-11-17 04:56:24 +0000 | [diff] [blame] | 3278 | if( pPager->dbSize<pPg->pgno ){ |
drh | 306dc21 | 2001-05-21 13:45:10 +0000 | [diff] [blame] | 3279 | pPager->dbSize = pPg->pgno; |
danielk1977 | d92db53 | 2008-11-17 04:56:24 +0000 | [diff] [blame] | 3280 | if( pPager->dbSize==(PAGER_MJ_PGNO(pPager)-1) ){ |
drh | 1f59571 | 2004-06-15 01:40:29 +0000 | [diff] [blame] | 3281 | pPager->dbSize++; |
| 3282 | } |
drh | 306dc21 | 2001-05-21 13:45:10 +0000 | [diff] [blame] | 3283 | } |
drh | 69688d5 | 2001-04-14 16:38:23 +0000 | [diff] [blame] | 3284 | return rc; |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 3285 | } |
| 3286 | |
| 3287 | /* |
danielk1977 | 4099f6e | 2007-03-19 11:25:20 +0000 | [diff] [blame] | 3288 | ** This function is used to mark a data-page as writable. It uses |
| 3289 | ** pager_write() to open a journal file (if it is not already open) |
| 3290 | ** and write the page *pData to the journal. |
| 3291 | ** |
| 3292 | ** The difference between this function and pager_write() is that this |
| 3293 | ** function also deals with the special case where 2 or more pages |
| 3294 | ** fit on a single disk sector. In this case all co-resident pages |
| 3295 | ** must have been written to the journal file before returning. |
| 3296 | */ |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 3297 | int sqlite3PagerWrite(DbPage *pDbPage){ |
danielk1977 | 4099f6e | 2007-03-19 11:25:20 +0000 | [diff] [blame] | 3298 | int rc = SQLITE_OK; |
| 3299 | |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 3300 | PgHdr *pPg = pDbPage; |
danielk1977 | 4099f6e | 2007-03-19 11:25:20 +0000 | [diff] [blame] | 3301 | Pager *pPager = pPg->pPager; |
| 3302 | Pgno nPagePerSector = (pPager->sectorSize/pPager->pageSize); |
| 3303 | |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 3304 | if( nPagePerSector>1 ){ |
danielk1977 | 4099f6e | 2007-03-19 11:25:20 +0000 | [diff] [blame] | 3305 | Pgno nPageCount; /* Total number of pages in database file */ |
| 3306 | Pgno pg1; /* First page of the sector pPg is located on. */ |
| 3307 | int nPage; /* Number of pages starting at pg1 to journal */ |
| 3308 | int ii; |
danielk1977 | dd97a49 | 2007-08-22 18:54:32 +0000 | [diff] [blame] | 3309 | int needSync = 0; |
danielk1977 | 4099f6e | 2007-03-19 11:25:20 +0000 | [diff] [blame] | 3310 | |
| 3311 | /* Set the doNotSync flag to 1. This is because we cannot allow a journal |
| 3312 | ** header to be written between the pages journaled by this function. |
| 3313 | */ |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 3314 | assert( !MEMDB ); |
danielk1977 | 4099f6e | 2007-03-19 11:25:20 +0000 | [diff] [blame] | 3315 | assert( pPager->doNotSync==0 ); |
| 3316 | pPager->doNotSync = 1; |
| 3317 | |
| 3318 | /* This trick assumes that both the page-size and sector-size are |
| 3319 | ** an integer power of 2. It sets variable pg1 to the identifier |
| 3320 | ** of the first page of the sector pPg is located on. |
| 3321 | */ |
| 3322 | pg1 = ((pPg->pgno-1) & ~(nPagePerSector-1)) + 1; |
| 3323 | |
danielk1977 | ad0132d | 2008-06-07 08:58:22 +0000 | [diff] [blame] | 3324 | sqlite3PagerPagecount(pPager, (int *)&nPageCount); |
danielk1977 | 4099f6e | 2007-03-19 11:25:20 +0000 | [diff] [blame] | 3325 | if( pPg->pgno>nPageCount ){ |
| 3326 | nPage = (pPg->pgno - pg1)+1; |
| 3327 | }else if( (pg1+nPagePerSector-1)>nPageCount ){ |
| 3328 | nPage = nPageCount+1-pg1; |
| 3329 | }else{ |
| 3330 | nPage = nPagePerSector; |
| 3331 | } |
| 3332 | assert(nPage>0); |
| 3333 | assert(pg1<=pPg->pgno); |
| 3334 | assert((pg1+nPage)>pPg->pgno); |
| 3335 | |
| 3336 | for(ii=0; ii<nPage && rc==SQLITE_OK; ii++){ |
| 3337 | Pgno pg = pg1+ii; |
danielk1977 | dd97a49 | 2007-08-22 18:54:32 +0000 | [diff] [blame] | 3338 | PgHdr *pPage; |
drh | f5e7bb5 | 2008-02-18 14:47:33 +0000 | [diff] [blame] | 3339 | if( pg==pPg->pgno || !sqlite3BitvecTest(pPager->pInJournal, pg) ){ |
danielk1977 | 4099f6e | 2007-03-19 11:25:20 +0000 | [diff] [blame] | 3340 | if( pg!=PAGER_MJ_PGNO(pPager) ){ |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 3341 | rc = sqlite3PagerGet(pPager, pg, &pPage); |
danielk1977 | 4099f6e | 2007-03-19 11:25:20 +0000 | [diff] [blame] | 3342 | if( rc==SQLITE_OK ){ |
| 3343 | rc = pager_write(pPage); |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 3344 | if( pPage->flags&PGHDR_NEED_SYNC ){ |
danielk1977 | dd97a49 | 2007-08-22 18:54:32 +0000 | [diff] [blame] | 3345 | needSync = 1; |
| 3346 | } |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 3347 | sqlite3PagerUnref(pPage); |
danielk1977 | 4099f6e | 2007-03-19 11:25:20 +0000 | [diff] [blame] | 3348 | } |
| 3349 | } |
drh | c81945e | 2008-03-10 14:12:53 +0000 | [diff] [blame] | 3350 | }else if( (pPage = pager_lookup(pPager, pg))!=0 ){ |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 3351 | if( pPage->flags&PGHDR_NEED_SYNC ){ |
danielk1977 | dd97a49 | 2007-08-22 18:54:32 +0000 | [diff] [blame] | 3352 | needSync = 1; |
| 3353 | } |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 3354 | sqlite3PagerUnref(pPage); |
danielk1977 | 4099f6e | 2007-03-19 11:25:20 +0000 | [diff] [blame] | 3355 | } |
| 3356 | } |
| 3357 | |
danielk1977 | dd97a49 | 2007-08-22 18:54:32 +0000 | [diff] [blame] | 3358 | /* If the PgHdr.needSync flag is set for any of the nPage pages |
| 3359 | ** starting at pg1, then it needs to be set for all of them. Because |
| 3360 | ** writing to any of these nPage pages may damage the others, the |
| 3361 | ** journal file must contain sync()ed copies of all of them |
| 3362 | ** before any of them can be written out to the database file. |
| 3363 | */ |
| 3364 | if( needSync ){ |
drh | b3df2e1 | 2008-09-17 20:06:26 +0000 | [diff] [blame] | 3365 | assert( !MEMDB && pPager->noSync==0 ); |
danielk1977 | dd97a49 | 2007-08-22 18:54:32 +0000 | [diff] [blame] | 3366 | for(ii=0; ii<nPage && needSync; ii++){ |
| 3367 | PgHdr *pPage = pager_lookup(pPager, pg1+ii); |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 3368 | if( pPage ) pPage->flags |= PGHDR_NEED_SYNC; |
| 3369 | sqlite3PagerUnref(pPage); |
danielk1977 | dd97a49 | 2007-08-22 18:54:32 +0000 | [diff] [blame] | 3370 | } |
| 3371 | assert(pPager->needSync); |
| 3372 | } |
| 3373 | |
danielk1977 | 4099f6e | 2007-03-19 11:25:20 +0000 | [diff] [blame] | 3374 | assert( pPager->doNotSync==1 ); |
| 3375 | pPager->doNotSync = 0; |
| 3376 | }else{ |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 3377 | rc = pager_write(pDbPage); |
danielk1977 | 4099f6e | 2007-03-19 11:25:20 +0000 | [diff] [blame] | 3378 | } |
| 3379 | return rc; |
| 3380 | } |
| 3381 | |
| 3382 | /* |
drh | aacc543 | 2002-01-06 17:07:40 +0000 | [diff] [blame] | 3383 | ** Return TRUE if the page given in the argument was previously passed |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 3384 | ** to sqlite3PagerWrite(). In other words, return TRUE if it is ok |
drh | 6019e16 | 2001-07-02 17:51:45 +0000 | [diff] [blame] | 3385 | ** to change the content of the page. |
| 3386 | */ |
danielk1977 | 7d3a666 | 2006-01-23 16:21:05 +0000 | [diff] [blame] | 3387 | #ifndef NDEBUG |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 3388 | int sqlite3PagerIswriteable(DbPage *pPg){ |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 3389 | return pPg->flags&PGHDR_DIRTY; |
drh | 6019e16 | 2001-07-02 17:51:45 +0000 | [diff] [blame] | 3390 | } |
danielk1977 | 7d3a666 | 2006-01-23 16:21:05 +0000 | [diff] [blame] | 3391 | #endif |
drh | 6019e16 | 2001-07-02 17:51:45 +0000 | [diff] [blame] | 3392 | |
drh | 001bbcb | 2003-03-19 03:14:00 +0000 | [diff] [blame] | 3393 | /* |
drh | 30e5875 | 2002-03-02 20:41:57 +0000 | [diff] [blame] | 3394 | ** A call to this routine tells the pager that it is not necessary to |
drh | 538f570 | 2007-04-13 02:14:30 +0000 | [diff] [blame] | 3395 | ** write the information on page pPg back to the disk, even though |
drh | dfe88ec | 2008-11-03 20:55:06 +0000 | [diff] [blame] | 3396 | ** that page might be marked as dirty. This happens, for example, when |
| 3397 | ** the page has been added as a leaf of the freelist and so its |
| 3398 | ** content no longer matters. |
drh | 30e5875 | 2002-03-02 20:41:57 +0000 | [diff] [blame] | 3399 | ** |
| 3400 | ** The overlying software layer calls this routine when all of the data |
| 3401 | ** on the given page is unused. The pager marks the page as clean so |
| 3402 | ** that it does not get written to disk. |
| 3403 | ** |
| 3404 | ** Tests show that this optimization, together with the |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 3405 | ** sqlite3PagerDontRollback() below, more than double the speed |
drh | 30e5875 | 2002-03-02 20:41:57 +0000 | [diff] [blame] | 3406 | ** of large INSERT operations and quadruple the speed of large DELETEs. |
drh | 8e298f9 | 2002-07-06 16:28:47 +0000 | [diff] [blame] | 3407 | ** |
| 3408 | ** When this routine is called, set the alwaysRollback flag to true. |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 3409 | ** Subsequent calls to sqlite3PagerDontRollback() for the same page |
drh | 8e298f9 | 2002-07-06 16:28:47 +0000 | [diff] [blame] | 3410 | ** will thereafter be ignored. This is necessary to avoid a problem |
| 3411 | ** where a page with data is added to the freelist during one part of |
| 3412 | ** a transaction then removed from the freelist during a later part |
| 3413 | ** of the same transaction and reused for some other purpose. When it |
| 3414 | ** is first added to the freelist, this routine is called. When reused, |
drh | 80e35f4 | 2007-03-30 14:06:34 +0000 | [diff] [blame] | 3415 | ** the sqlite3PagerDontRollback() routine is called. But because the |
| 3416 | ** page contains critical data, we still need to be sure it gets |
| 3417 | ** rolled back in spite of the sqlite3PagerDontRollback() call. |
drh | 30e5875 | 2002-03-02 20:41:57 +0000 | [diff] [blame] | 3418 | */ |
danielk1977 | a1fa00d | 2008-08-27 15:16:33 +0000 | [diff] [blame] | 3419 | int sqlite3PagerDontWrite(DbPage *pDbPage){ |
drh | 538f570 | 2007-04-13 02:14:30 +0000 | [diff] [blame] | 3420 | PgHdr *pPg = pDbPage; |
| 3421 | Pager *pPager = pPg->pPager; |
danielk1977 | a1fa00d | 2008-08-27 15:16:33 +0000 | [diff] [blame] | 3422 | int rc; |
drh | 8e298f9 | 2002-07-06 16:28:47 +0000 | [diff] [blame] | 3423 | |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 3424 | if( pPg->pgno>pPager->origDbSize ){ |
danielk1977 | a1fa00d | 2008-08-27 15:16:33 +0000 | [diff] [blame] | 3425 | return SQLITE_OK; |
| 3426 | } |
| 3427 | if( pPager->pAlwaysRollback==0 ){ |
| 3428 | assert( pPager->pInJournal ); |
| 3429 | pPager->pAlwaysRollback = sqlite3BitvecCreate(pPager->origDbSize); |
| 3430 | if( !pPager->pAlwaysRollback ){ |
| 3431 | return SQLITE_NOMEM; |
| 3432 | } |
| 3433 | } |
| 3434 | rc = sqlite3BitvecSet(pPager->pAlwaysRollback, pPg->pgno); |
| 3435 | |
| 3436 | if( rc==SQLITE_OK && (pPg->flags&PGHDR_DIRTY) && !pPager->stmtInUse ){ |
drh | 1aa2d8b | 2007-01-03 15:34:29 +0000 | [diff] [blame] | 3437 | assert( pPager->state>=PAGER_SHARED ); |
danielk1977 | d92db53 | 2008-11-17 04:56:24 +0000 | [diff] [blame] | 3438 | if( pPager->dbSize==pPg->pgno && pPager->origDbSize<pPager->dbSize ){ |
drh | 8124a30 | 2002-06-25 14:43:57 +0000 | [diff] [blame] | 3439 | /* If this pages is the last page in the file and the file has grown |
| 3440 | ** during the current transaction, then do NOT mark the page as clean. |
| 3441 | ** When the database file grows, we must make sure that the last page |
| 3442 | ** gets written at least once so that the disk file will be the correct |
| 3443 | ** size. If you do not write this page and the size of the file |
| 3444 | ** on the disk ends up being too small, that can lead to database |
| 3445 | ** corruption during the next transaction. |
| 3446 | */ |
| 3447 | }else{ |
drh | 538f570 | 2007-04-13 02:14:30 +0000 | [diff] [blame] | 3448 | PAGERTRACE3("DONT_WRITE page %d of %d\n", pPg->pgno, PAGERID(pPager)); |
| 3449 | IOTRACE(("CLEAN %p %d\n", pPager, pPg->pgno)) |
danielk1977 | 33e3216 | 2008-08-23 18:53:08 +0000 | [diff] [blame] | 3450 | pPg->flags |= PGHDR_DONT_WRITE; |
danielk1977 | 3c40737 | 2005-02-15 02:54:14 +0000 | [diff] [blame] | 3451 | #ifdef SQLITE_CHECK_PAGES |
| 3452 | pPg->pageHash = pager_pagehash(pPg); |
| 3453 | #endif |
drh | 8124a30 | 2002-06-25 14:43:57 +0000 | [diff] [blame] | 3454 | } |
drh | 30e5875 | 2002-03-02 20:41:57 +0000 | [diff] [blame] | 3455 | } |
danielk1977 | a1fa00d | 2008-08-27 15:16:33 +0000 | [diff] [blame] | 3456 | return rc; |
drh | 30e5875 | 2002-03-02 20:41:57 +0000 | [diff] [blame] | 3457 | } |
| 3458 | |
| 3459 | /* |
| 3460 | ** A call to this routine tells the pager that if a rollback occurs, |
| 3461 | ** it is not necessary to restore the data on the given page. This |
| 3462 | ** means that the pager does not have to record the given page in the |
| 3463 | ** rollback journal. |
drh | 538f570 | 2007-04-13 02:14:30 +0000 | [diff] [blame] | 3464 | ** |
| 3465 | ** If we have not yet actually read the content of this page (if |
| 3466 | ** the PgHdr.needRead flag is set) then this routine acts as a promise |
| 3467 | ** that we will never need to read the page content in the future. |
| 3468 | ** so the needRead flag can be cleared at this point. |
drh | 30e5875 | 2002-03-02 20:41:57 +0000 | [diff] [blame] | 3469 | */ |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 3470 | void sqlite3PagerDontRollback(DbPage *pPg){ |
drh | 30e5875 | 2002-03-02 20:41:57 +0000 | [diff] [blame] | 3471 | Pager *pPager = pPg->pPager; |
| 3472 | |
drh | d3627af | 2006-12-18 18:34:51 +0000 | [diff] [blame] | 3473 | assert( pPager->state>=PAGER_RESERVED ); |
danielk1977 | a55e935 | 2008-01-21 13:04:34 +0000 | [diff] [blame] | 3474 | |
| 3475 | /* If the journal file is not open, or DontWrite() has been called on |
| 3476 | ** this page (DontWrite() sets the alwaysRollback flag), then this |
| 3477 | ** function is a no-op. |
| 3478 | */ |
danielk1977 | a1fa00d | 2008-08-27 15:16:33 +0000 | [diff] [blame] | 3479 | if( pPager->journalOpen==0 |
| 3480 | || sqlite3BitvecTest(pPager->pAlwaysRollback, pPg->pgno) |
| 3481 | || pPg->pgno>pPager->origDbSize |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 3482 | ){ |
danielk1977 | 87c29a9 | 2008-01-18 11:33:16 +0000 | [diff] [blame] | 3483 | return; |
| 3484 | } |
danielk1977 | a55e935 | 2008-01-21 13:04:34 +0000 | [diff] [blame] | 3485 | |
drh | c5d0bd9 | 2008-04-14 01:00:57 +0000 | [diff] [blame] | 3486 | #ifdef SQLITE_SECURE_DELETE |
drh | 1feb7dd | 2008-11-19 18:30:29 +0000 | [diff] [blame] | 3487 | if( sqlite3BitvecTest(pPager->pInJournal, pPg->pgno)!=0 |
| 3488 | || pPg->pgno>pPager->origDbSize ){ |
drh | c5d0bd9 | 2008-04-14 01:00:57 +0000 | [diff] [blame] | 3489 | return; |
| 3490 | } |
| 3491 | #endif |
| 3492 | |
| 3493 | /* If SECURE_DELETE is disabled, then there is no way that this |
| 3494 | ** routine can be called on a page for which sqlite3PagerDontWrite() |
| 3495 | ** has not been previously called during the same transaction. |
| 3496 | ** And if DontWrite() has previously been called, the following |
| 3497 | ** conditions must be met. |
drh | 1013148 | 2008-07-11 03:34:09 +0000 | [diff] [blame] | 3498 | ** |
| 3499 | ** (Later:) Not true. If the database is corrupted by having duplicate |
| 3500 | ** pages on the freelist (ex: corrupt9.test) then the following is not |
| 3501 | ** necessarily true: |
danielk1977 | a55e935 | 2008-01-21 13:04:34 +0000 | [diff] [blame] | 3502 | */ |
drh | 1013148 | 2008-07-11 03:34:09 +0000 | [diff] [blame] | 3503 | /* assert( !pPg->inJournal && (int)pPg->pgno <= pPager->origDbSize ); */ |
danielk1977 | a55e935 | 2008-01-21 13:04:34 +0000 | [diff] [blame] | 3504 | |
drh | f5e7bb5 | 2008-02-18 14:47:33 +0000 | [diff] [blame] | 3505 | assert( pPager->pInJournal!=0 ); |
| 3506 | sqlite3BitvecSet(pPager->pInJournal, pPg->pgno); |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 3507 | pPg->flags &= ~PGHDR_NEED_READ; |
danielk1977 | a55e935 | 2008-01-21 13:04:34 +0000 | [diff] [blame] | 3508 | if( pPager->stmtInUse ){ |
drh | c5d0bd9 | 2008-04-14 01:00:57 +0000 | [diff] [blame] | 3509 | assert( pPager->stmtSize >= pPager->origDbSize ); |
drh | f5e7bb5 | 2008-02-18 14:47:33 +0000 | [diff] [blame] | 3510 | sqlite3BitvecSet(pPager->pInStmt, pPg->pgno); |
drh | 30e5875 | 2002-03-02 20:41:57 +0000 | [diff] [blame] | 3511 | } |
danielk1977 | a55e935 | 2008-01-21 13:04:34 +0000 | [diff] [blame] | 3512 | PAGERTRACE3("DONT_ROLLBACK page %d of %d\n", pPg->pgno, PAGERID(pPager)); |
| 3513 | IOTRACE(("GARBAGE %p %d\n", pPager, pPg->pgno)) |
drh | 30e5875 | 2002-03-02 20:41:57 +0000 | [diff] [blame] | 3514 | } |
| 3515 | |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 3516 | |
drh | 30e5875 | 2002-03-02 20:41:57 +0000 | [diff] [blame] | 3517 | /* |
drh | 80e35f4 | 2007-03-30 14:06:34 +0000 | [diff] [blame] | 3518 | ** This routine is called to increment the database file change-counter, |
| 3519 | ** stored at byte 24 of the pager file. |
| 3520 | */ |
danielk1977 | c7b6017 | 2007-08-22 11:22:03 +0000 | [diff] [blame] | 3521 | static int pager_incr_changecounter(Pager *pPager, int isDirect){ |
drh | 80e35f4 | 2007-03-30 14:06:34 +0000 | [diff] [blame] | 3522 | PgHdr *pPgHdr; |
| 3523 | u32 change_counter; |
danielk1977 | c7b6017 | 2007-08-22 11:22:03 +0000 | [diff] [blame] | 3524 | int rc = SQLITE_OK; |
drh | 80e35f4 | 2007-03-30 14:06:34 +0000 | [diff] [blame] | 3525 | |
drh | 701bb3b | 2008-08-02 03:50:39 +0000 | [diff] [blame] | 3526 | #ifndef SQLITE_ENABLE_ATOMIC_WRITE |
| 3527 | assert( isDirect==0 ); /* isDirect is only true for atomic writes */ |
| 3528 | #endif |
drh | 80e35f4 | 2007-03-30 14:06:34 +0000 | [diff] [blame] | 3529 | if( !pPager->changeCountDone ){ |
| 3530 | /* Open page 1 of the file for writing. */ |
| 3531 | rc = sqlite3PagerGet(pPager, 1, &pPgHdr); |
| 3532 | if( rc!=SQLITE_OK ) return rc; |
danielk1977 | c7b6017 | 2007-08-22 11:22:03 +0000 | [diff] [blame] | 3533 | |
| 3534 | if( !isDirect ){ |
| 3535 | rc = sqlite3PagerWrite(pPgHdr); |
danielk1977 | ae72d98 | 2007-10-03 08:46:44 +0000 | [diff] [blame] | 3536 | if( rc!=SQLITE_OK ){ |
| 3537 | sqlite3PagerUnref(pPgHdr); |
| 3538 | return rc; |
| 3539 | } |
danielk1977 | c7b6017 | 2007-08-22 11:22:03 +0000 | [diff] [blame] | 3540 | } |
| 3541 | |
drh | 80e35f4 | 2007-03-30 14:06:34 +0000 | [diff] [blame] | 3542 | /* Increment the value just read and write it back to byte 24. */ |
drh | b100391 | 2007-07-20 00:33:36 +0000 | [diff] [blame] | 3543 | change_counter = sqlite3Get4byte((u8*)pPager->dbFileVers); |
drh | 80e35f4 | 2007-03-30 14:06:34 +0000 | [diff] [blame] | 3544 | change_counter++; |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 3545 | put32bits(((char*)pPgHdr->pData)+24, change_counter); |
danielk1977 | c7b6017 | 2007-08-22 11:22:03 +0000 | [diff] [blame] | 3546 | |
drh | 701bb3b | 2008-08-02 03:50:39 +0000 | [diff] [blame] | 3547 | #ifdef SQLITE_ENABLE_ATOMIC_WRITE |
danielk1977 | c7b6017 | 2007-08-22 11:22:03 +0000 | [diff] [blame] | 3548 | if( isDirect && pPager->fd->pMethods ){ |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 3549 | const void *zBuf = pPgHdr->pData; |
danielk1977 | c7b6017 | 2007-08-22 11:22:03 +0000 | [diff] [blame] | 3550 | rc = sqlite3OsWrite(pPager->fd, zBuf, pPager->pageSize, 0); |
| 3551 | } |
drh | 701bb3b | 2008-08-02 03:50:39 +0000 | [diff] [blame] | 3552 | #endif |
danielk1977 | c7b6017 | 2007-08-22 11:22:03 +0000 | [diff] [blame] | 3553 | |
drh | 80e35f4 | 2007-03-30 14:06:34 +0000 | [diff] [blame] | 3554 | /* Release the page reference. */ |
| 3555 | sqlite3PagerUnref(pPgHdr); |
| 3556 | pPager->changeCountDone = 1; |
| 3557 | } |
danielk1977 | c7b6017 | 2007-08-22 11:22:03 +0000 | [diff] [blame] | 3558 | return rc; |
drh | 80e35f4 | 2007-03-30 14:06:34 +0000 | [diff] [blame] | 3559 | } |
| 3560 | |
| 3561 | /* |
danielk1977 | f653d78 | 2008-03-20 11:04:21 +0000 | [diff] [blame] | 3562 | ** Sync the pager file to disk. |
| 3563 | */ |
| 3564 | int sqlite3PagerSync(Pager *pPager){ |
| 3565 | int rc; |
drh | 7426f86 | 2008-08-26 21:07:26 +0000 | [diff] [blame] | 3566 | if( MEMDB ){ |
| 3567 | rc = SQLITE_OK; |
| 3568 | }else{ |
| 3569 | rc = sqlite3OsSync(pPager->fd, pPager->sync_flags); |
| 3570 | } |
danielk1977 | f653d78 | 2008-03-20 11:04:21 +0000 | [diff] [blame] | 3571 | return rc; |
| 3572 | } |
| 3573 | |
| 3574 | /* |
drh | 80e35f4 | 2007-03-30 14:06:34 +0000 | [diff] [blame] | 3575 | ** Sync the database file for the pager pPager. zMaster points to the name |
| 3576 | ** of a master journal file that should be written into the individual |
| 3577 | ** journal file. zMaster may be NULL, which is interpreted as no master |
| 3578 | ** journal (a single database transaction). |
| 3579 | ** |
| 3580 | ** This routine ensures that the journal is synced, all dirty pages written |
| 3581 | ** to the database file and the database file synced. The only thing that |
| 3582 | ** remains to commit the transaction is to delete the journal file (or |
| 3583 | ** master journal file if specified). |
| 3584 | ** |
| 3585 | ** Note that if zMaster==NULL, this does not overwrite a previous value |
| 3586 | ** passed to an sqlite3PagerCommitPhaseOne() call. |
| 3587 | ** |
| 3588 | ** If parameter nTrunc is non-zero, then the pager file is truncated to |
| 3589 | ** nTrunc pages (this is used by auto-vacuum databases). |
danielk1977 | f653d78 | 2008-03-20 11:04:21 +0000 | [diff] [blame] | 3590 | ** |
| 3591 | ** If the final parameter - noSync - is true, then the database file itself |
| 3592 | ** is not synced. The caller must call sqlite3PagerSync() directly to |
| 3593 | ** sync the database file before calling CommitPhaseTwo() to delete the |
| 3594 | ** journal file in this case. |
drh | 80e35f4 | 2007-03-30 14:06:34 +0000 | [diff] [blame] | 3595 | */ |
danielk1977 | f653d78 | 2008-03-20 11:04:21 +0000 | [diff] [blame] | 3596 | int sqlite3PagerCommitPhaseOne( |
| 3597 | Pager *pPager, |
| 3598 | const char *zMaster, |
| 3599 | Pgno nTrunc, |
| 3600 | int noSync |
| 3601 | ){ |
drh | 80e35f4 | 2007-03-30 14:06:34 +0000 | [diff] [blame] | 3602 | int rc = SQLITE_OK; |
| 3603 | |
danielk1977 | dad31b5 | 2008-05-15 11:08:07 +0000 | [diff] [blame] | 3604 | if( pPager->errCode ){ |
| 3605 | return pPager->errCode; |
| 3606 | } |
| 3607 | |
drh | d138c01 | 2008-05-13 00:58:18 +0000 | [diff] [blame] | 3608 | /* If no changes have been made, we can leave the transaction early. |
| 3609 | */ |
| 3610 | if( pPager->dbModified==0 && |
| 3611 | (pPager->journalMode!=PAGER_JOURNALMODE_DELETE || |
| 3612 | pPager->exclusiveMode!=0) ){ |
| 3613 | assert( pPager->dirtyCache==0 || pPager->journalOpen==0 ); |
| 3614 | return SQLITE_OK; |
| 3615 | } |
| 3616 | |
drh | 80e35f4 | 2007-03-30 14:06:34 +0000 | [diff] [blame] | 3617 | PAGERTRACE4("DATABASE SYNC: File=%s zMaster=%s nTrunc=%d\n", |
| 3618 | pPager->zFilename, zMaster, nTrunc); |
| 3619 | |
| 3620 | /* If this is an in-memory db, or no pages have been written to, or this |
| 3621 | ** function has already been called, it is a no-op. |
| 3622 | */ |
| 3623 | if( pPager->state!=PAGER_SYNCED && !MEMDB && pPager->dirtyCache ){ |
| 3624 | PgHdr *pPg; |
drh | 80e35f4 | 2007-03-30 14:06:34 +0000 | [diff] [blame] | 3625 | |
danielk1977 | c7b6017 | 2007-08-22 11:22:03 +0000 | [diff] [blame] | 3626 | #ifdef SQLITE_ENABLE_ATOMIC_WRITE |
| 3627 | /* The atomic-write optimization can be used if all of the |
| 3628 | ** following are true: |
| 3629 | ** |
| 3630 | ** + The file-system supports the atomic-write property for |
| 3631 | ** blocks of size page-size, and |
| 3632 | ** + This commit is not part of a multi-file transaction, and |
| 3633 | ** + Exactly one page has been modified and store in the journal file. |
| 3634 | ** |
| 3635 | ** If the optimization can be used, then the journal file will never |
| 3636 | ** be created for this transaction. |
| 3637 | */ |
danielk1977 | 4d60af9 | 2008-09-08 15:35:06 +0000 | [diff] [blame] | 3638 | int useAtomicWrite; |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 3639 | pPg = sqlite3PcacheDirtyList(pPager->pPCache); |
danielk1977 | 4d60af9 | 2008-09-08 15:35:06 +0000 | [diff] [blame] | 3640 | useAtomicWrite = ( |
danielk1977 | f55b899 | 2007-08-24 08:15:53 +0000 | [diff] [blame] | 3641 | !zMaster && |
danielk1977 | 700b9c5 | 2008-04-24 12:37:40 +0000 | [diff] [blame] | 3642 | pPager->journalOpen && |
danielk1977 | f55b899 | 2007-08-24 08:15:53 +0000 | [diff] [blame] | 3643 | pPager->journalOff==jrnlBufferSize(pPager) && |
| 3644 | nTrunc==0 && |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 3645 | (pPg==0 || pPg->pDirty==0) |
danielk1977 | f55b899 | 2007-08-24 08:15:53 +0000 | [diff] [blame] | 3646 | ); |
danielk1977 | 700b9c5 | 2008-04-24 12:37:40 +0000 | [diff] [blame] | 3647 | assert( pPager->journalOpen || pPager->journalMode==PAGER_JOURNALMODE_OFF ); |
danielk1977 | f55b899 | 2007-08-24 08:15:53 +0000 | [diff] [blame] | 3648 | if( useAtomicWrite ){ |
danielk1977 | c7b6017 | 2007-08-22 11:22:03 +0000 | [diff] [blame] | 3649 | /* Update the nRec field in the journal file. */ |
| 3650 | int offset = pPager->journalHdr + sizeof(aJournalMagic); |
| 3651 | assert(pPager->nRec==1); |
| 3652 | rc = write32bits(pPager->jfd, offset, pPager->nRec); |
| 3653 | |
| 3654 | /* Update the db file change counter. The following call will modify |
| 3655 | ** the in-memory representation of page 1 to include the updated |
| 3656 | ** change counter and then write page 1 directly to the database |
| 3657 | ** file. Because of the atomic-write property of the host file-system, |
| 3658 | ** this is safe. |
| 3659 | */ |
danielk1977 | ae72d98 | 2007-10-03 08:46:44 +0000 | [diff] [blame] | 3660 | if( rc==SQLITE_OK ){ |
| 3661 | rc = pager_incr_changecounter(pPager, 1); |
| 3662 | } |
danielk1977 | f55b899 | 2007-08-24 08:15:53 +0000 | [diff] [blame] | 3663 | }else{ |
| 3664 | rc = sqlite3JournalCreate(pPager->jfd); |
danielk1977 | f55b899 | 2007-08-24 08:15:53 +0000 | [diff] [blame] | 3665 | } |
| 3666 | |
danielk1977 | ae72d98 | 2007-10-03 08:46:44 +0000 | [diff] [blame] | 3667 | if( !useAtomicWrite && rc==SQLITE_OK ) |
danielk1977 | c7b6017 | 2007-08-22 11:22:03 +0000 | [diff] [blame] | 3668 | #endif |
| 3669 | |
drh | 80e35f4 | 2007-03-30 14:06:34 +0000 | [diff] [blame] | 3670 | /* If a master journal file name has already been written to the |
| 3671 | ** journal file, then no sync is required. This happens when it is |
| 3672 | ** written, then the process fails to upgrade from a RESERVED to an |
| 3673 | ** EXCLUSIVE lock. The next time the process tries to commit the |
| 3674 | ** transaction the m-j name will have already been written. |
| 3675 | */ |
| 3676 | if( !pPager->setMaster ){ |
danielk1977 | c7b6017 | 2007-08-22 11:22:03 +0000 | [diff] [blame] | 3677 | rc = pager_incr_changecounter(pPager, 0); |
drh | 80e35f4 | 2007-03-30 14:06:34 +0000 | [diff] [blame] | 3678 | if( rc!=SQLITE_OK ) goto sync_exit; |
danielk1977 | 71aa7ff | 2008-05-20 07:05:09 +0000 | [diff] [blame] | 3679 | if( pPager->journalMode!=PAGER_JOURNALMODE_OFF ){ |
drh | 80e35f4 | 2007-03-30 14:06:34 +0000 | [diff] [blame] | 3680 | #ifndef SQLITE_OMIT_AUTOVACUUM |
danielk1977 | 71aa7ff | 2008-05-20 07:05:09 +0000 | [diff] [blame] | 3681 | if( nTrunc!=0 ){ |
| 3682 | /* If this transaction has made the database smaller, then all pages |
| 3683 | ** being discarded by the truncation must be written to the journal |
| 3684 | ** file. |
| 3685 | */ |
| 3686 | Pgno i; |
danielk1977 | d92db53 | 2008-11-17 04:56:24 +0000 | [diff] [blame] | 3687 | Pgno iSkip = PAGER_MJ_PGNO(pPager); |
danielk1977 | 71aa7ff | 2008-05-20 07:05:09 +0000 | [diff] [blame] | 3688 | for( i=nTrunc+1; i<=pPager->origDbSize; i++ ){ |
| 3689 | if( !sqlite3BitvecTest(pPager->pInJournal, i) && i!=iSkip ){ |
| 3690 | rc = sqlite3PagerGet(pPager, i, &pPg); |
| 3691 | if( rc!=SQLITE_OK ) goto sync_exit; |
| 3692 | rc = sqlite3PagerWrite(pPg); |
| 3693 | sqlite3PagerUnref(pPg); |
| 3694 | if( rc!=SQLITE_OK ) goto sync_exit; |
| 3695 | } |
| 3696 | } |
| 3697 | } |
drh | 80e35f4 | 2007-03-30 14:06:34 +0000 | [diff] [blame] | 3698 | #endif |
danielk1977 | 71aa7ff | 2008-05-20 07:05:09 +0000 | [diff] [blame] | 3699 | rc = writeMasterJournal(pPager, zMaster); |
| 3700 | if( rc!=SQLITE_OK ) goto sync_exit; |
| 3701 | rc = syncJournal(pPager); |
| 3702 | } |
drh | 80e35f4 | 2007-03-30 14:06:34 +0000 | [diff] [blame] | 3703 | } |
danielk1977 | c7b6017 | 2007-08-22 11:22:03 +0000 | [diff] [blame] | 3704 | if( rc!=SQLITE_OK ) goto sync_exit; |
drh | 80e35f4 | 2007-03-30 14:06:34 +0000 | [diff] [blame] | 3705 | |
| 3706 | #ifndef SQLITE_OMIT_AUTOVACUUM |
| 3707 | if( nTrunc!=0 ){ |
| 3708 | rc = sqlite3PagerTruncate(pPager, nTrunc); |
| 3709 | if( rc!=SQLITE_OK ) goto sync_exit; |
| 3710 | } |
| 3711 | #endif |
| 3712 | |
| 3713 | /* Write all dirty pages to the database file */ |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 3714 | pPg = sqlite3PcacheDirtyList(pPager->pPCache); |
drh | 80e35f4 | 2007-03-30 14:06:34 +0000 | [diff] [blame] | 3715 | rc = pager_write_pagelist(pPg); |
drh | 153c62c | 2007-08-24 03:51:33 +0000 | [diff] [blame] | 3716 | if( rc!=SQLITE_OK ){ |
drh | 04c3a46 | 2008-02-26 16:16:45 +0000 | [diff] [blame] | 3717 | assert( rc!=SQLITE_IOERR_BLOCKED ); |
| 3718 | /* The error might have left the dirty list all fouled up here, |
| 3719 | ** but that does not matter because if the if the dirty list did |
| 3720 | ** get corrupted, then the transaction will roll back and |
| 3721 | ** discard the dirty list. There is an assert in |
| 3722 | ** pager_get_all_dirty_pages() that verifies that no attempt |
| 3723 | ** is made to use an invalid dirty list. |
| 3724 | */ |
drh | 153c62c | 2007-08-24 03:51:33 +0000 | [diff] [blame] | 3725 | goto sync_exit; |
| 3726 | } |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 3727 | sqlite3PcacheCleanAll(pPager->pPCache); |
drh | 80e35f4 | 2007-03-30 14:06:34 +0000 | [diff] [blame] | 3728 | |
| 3729 | /* Sync the database file. */ |
danielk1977 | f653d78 | 2008-03-20 11:04:21 +0000 | [diff] [blame] | 3730 | if( !pPager->noSync && !noSync ){ |
danielk1977 | f036aef | 2007-08-20 05:36:51 +0000 | [diff] [blame] | 3731 | rc = sqlite3OsSync(pPager->fd, pPager->sync_flags); |
drh | 80e35f4 | 2007-03-30 14:06:34 +0000 | [diff] [blame] | 3732 | } |
| 3733 | IOTRACE(("DBSYNC %p\n", pPager)) |
| 3734 | |
| 3735 | pPager->state = PAGER_SYNCED; |
| 3736 | }else if( MEMDB && nTrunc!=0 ){ |
| 3737 | rc = sqlite3PagerTruncate(pPager, nTrunc); |
| 3738 | } |
| 3739 | |
| 3740 | sync_exit: |
danielk1977 | e965ac7 | 2007-06-13 15:22:28 +0000 | [diff] [blame] | 3741 | if( rc==SQLITE_IOERR_BLOCKED ){ |
| 3742 | /* pager_incr_changecounter() may attempt to obtain an exclusive |
| 3743 | * lock to spill the cache and return IOERR_BLOCKED. But since |
drh | 85b623f | 2007-12-13 21:54:09 +0000 | [diff] [blame] | 3744 | * there is no chance the cache is inconsistent, it is |
danielk1977 | e965ac7 | 2007-06-13 15:22:28 +0000 | [diff] [blame] | 3745 | * better to return SQLITE_BUSY. |
| 3746 | */ |
| 3747 | rc = SQLITE_BUSY; |
| 3748 | } |
drh | 80e35f4 | 2007-03-30 14:06:34 +0000 | [diff] [blame] | 3749 | return rc; |
| 3750 | } |
| 3751 | |
| 3752 | |
| 3753 | /* |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 3754 | ** Commit all changes to the database and release the write lock. |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 3755 | ** |
| 3756 | ** If the commit fails for any reason, a rollback attempt is made |
| 3757 | ** and an error code is returned. If the commit worked, SQLITE_OK |
| 3758 | ** is returned. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 3759 | */ |
drh | 80e35f4 | 2007-03-30 14:06:34 +0000 | [diff] [blame] | 3760 | int sqlite3PagerCommitPhaseTwo(Pager *pPager){ |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 3761 | int rc = SQLITE_OK; |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 3762 | |
danielk1977 | efaaf57 | 2006-01-16 11:29:19 +0000 | [diff] [blame] | 3763 | if( pPager->errCode ){ |
danielk1977 | 7f7bc66 | 2006-01-23 13:47:47 +0000 | [diff] [blame] | 3764 | return pPager->errCode; |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 3765 | } |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 3766 | if( pPager->state<PAGER_RESERVED ){ |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 3767 | return SQLITE_ERROR; |
| 3768 | } |
drh | d138c01 | 2008-05-13 00:58:18 +0000 | [diff] [blame] | 3769 | if( pPager->dbModified==0 && |
| 3770 | (pPager->journalMode!=PAGER_JOURNALMODE_DELETE || |
| 3771 | pPager->exclusiveMode!=0) ){ |
| 3772 | assert( pPager->dirtyCache==0 || pPager->journalOpen==0 ); |
| 3773 | return SQLITE_OK; |
| 3774 | } |
drh | 4f0c587 | 2007-03-26 22:05:01 +0000 | [diff] [blame] | 3775 | PAGERTRACE2("COMMIT %d\n", PAGERID(pPager)); |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 3776 | assert( pPager->state==PAGER_SYNCED || MEMDB || !pPager->dirtyCache ); |
| 3777 | rc = pager_end_transaction(pPager, pPager->setMaster); |
| 3778 | rc = pager_error(pPager, rc); |
drh | 86f8c19 | 2007-08-22 00:39:19 +0000 | [diff] [blame] | 3779 | return rc; |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 3780 | } |
| 3781 | |
| 3782 | /* |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 3783 | ** Rollback all changes. The database falls back to PAGER_SHARED mode. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 3784 | ** All in-memory cache pages revert to their original data contents. |
| 3785 | ** The journal is deleted. |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 3786 | ** |
| 3787 | ** This routine cannot fail unless some other process is not following |
drh | 4f0ee68 | 2007-03-30 20:43:40 +0000 | [diff] [blame] | 3788 | ** the correct locking protocol or unless some other |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 3789 | ** process is writing trash into the journal file (SQLITE_CORRUPT) or |
| 3790 | ** unless a prior malloc() failed (SQLITE_NOMEM). Appropriate error |
| 3791 | ** codes are returned for all these occasions. Otherwise, |
| 3792 | ** SQLITE_OK is returned. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 3793 | */ |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 3794 | int sqlite3PagerRollback(Pager *pPager){ |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 3795 | int rc = SQLITE_OK; |
drh | 4f0c587 | 2007-03-26 22:05:01 +0000 | [diff] [blame] | 3796 | PAGERTRACE2("ROLLBACK %d\n", PAGERID(pPager)); |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 3797 | if( !pPager->dirtyCache || !pPager->journalOpen ){ |
danielk1977 | df2566a | 2008-05-07 19:11:03 +0000 | [diff] [blame] | 3798 | rc = pager_end_transaction(pPager, pPager->setMaster); |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 3799 | }else if( pPager->errCode && pPager->errCode!=SQLITE_FULL ){ |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 3800 | if( pPager->state>=PAGER_EXCLUSIVE ){ |
danielk1977 | e277be0 | 2007-03-23 18:12:06 +0000 | [diff] [blame] | 3801 | pager_playback(pPager, 0); |
drh | 4b845d7 | 2002-03-05 12:41:19 +0000 | [diff] [blame] | 3802 | } |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 3803 | rc = pPager->errCode; |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 3804 | }else{ |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 3805 | if( pPager->state==PAGER_RESERVED ){ |
| 3806 | int rc2; |
| 3807 | rc = pager_playback(pPager, 0); |
| 3808 | rc2 = pager_end_transaction(pPager, pPager->setMaster); |
| 3809 | if( rc==SQLITE_OK ){ |
| 3810 | rc = rc2; |
| 3811 | } |
| 3812 | }else{ |
| 3813 | rc = pager_playback(pPager, 0); |
| 3814 | } |
danielk1977 | 07cb560 | 2006-01-20 10:55:05 +0000 | [diff] [blame] | 3815 | |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 3816 | if( !MEMDB ){ |
danielk1977 | d92db53 | 2008-11-17 04:56:24 +0000 | [diff] [blame] | 3817 | pPager->dbSizeValid = 0; |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 3818 | } |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 3819 | |
| 3820 | /* If an error occurs during a ROLLBACK, we can no longer trust the pager |
| 3821 | ** cache. So call pager_error() on the way out to make any error |
| 3822 | ** persistent. |
| 3823 | */ |
| 3824 | rc = pager_error(pPager, rc); |
| 3825 | } |
drh | 86f8c19 | 2007-08-22 00:39:19 +0000 | [diff] [blame] | 3826 | return rc; |
drh | 98808ba | 2001-10-18 12:34:46 +0000 | [diff] [blame] | 3827 | } |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 3828 | |
| 3829 | /* |
drh | 5e00f6c | 2001-09-13 13:46:56 +0000 | [diff] [blame] | 3830 | ** Return TRUE if the database file is opened read-only. Return FALSE |
| 3831 | ** if the database is (in theory) writable. |
| 3832 | */ |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 3833 | int sqlite3PagerIsreadonly(Pager *pPager){ |
drh | be0072d | 2001-09-13 14:46:09 +0000 | [diff] [blame] | 3834 | return pPager->readOnly; |
drh | 5e00f6c | 2001-09-13 13:46:56 +0000 | [diff] [blame] | 3835 | } |
| 3836 | |
| 3837 | /* |
drh | 0f7eb61 | 2006-08-08 13:51:43 +0000 | [diff] [blame] | 3838 | ** Return the number of references to the pager. |
| 3839 | */ |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 3840 | int sqlite3PagerRefcount(Pager *pPager){ |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 3841 | return sqlite3PcacheRefCount(pPager->pPCache); |
drh | 0f7eb61 | 2006-08-08 13:51:43 +0000 | [diff] [blame] | 3842 | } |
| 3843 | |
danielk1977 | 71d5d2c | 2008-09-29 11:49:47 +0000 | [diff] [blame] | 3844 | /* |
| 3845 | ** Return the number of references to the specified page. |
| 3846 | */ |
| 3847 | int sqlite3PagerPageRefcount(DbPage *pPage){ |
| 3848 | return sqlite3PcachePageRefcount(pPage); |
| 3849 | } |
| 3850 | |
drh | 0f7eb61 | 2006-08-08 13:51:43 +0000 | [diff] [blame] | 3851 | #ifdef SQLITE_TEST |
| 3852 | /* |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 3853 | ** This routine is used for testing and analysis only. |
| 3854 | */ |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 3855 | int *sqlite3PagerStats(Pager *pPager){ |
danielk1977 | 42741be | 2005-01-08 12:42:39 +0000 | [diff] [blame] | 3856 | static int a[11]; |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 3857 | a[0] = sqlite3PcacheRefCount(pPager->pPCache); |
| 3858 | a[1] = sqlite3PcachePagecount(pPager->pPCache); |
| 3859 | a[2] = sqlite3PcacheGetCachesize(pPager->pPCache); |
danielk1977 | d92db53 | 2008-11-17 04:56:24 +0000 | [diff] [blame] | 3860 | a[3] = pPager->dbSizeValid ? (int) pPager->dbSize : -1; |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 3861 | a[4] = pPager->state; |
danielk1977 | efaaf57 | 2006-01-16 11:29:19 +0000 | [diff] [blame] | 3862 | a[5] = pPager->errCode; |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 3863 | a[6] = pPager->nHit; |
| 3864 | a[7] = pPager->nMiss; |
drh | 7c4ac0c | 2007-04-05 11:25:58 +0000 | [diff] [blame] | 3865 | a[8] = 0; /* Used to be pPager->nOvfl */ |
danielk1977 | 42741be | 2005-01-08 12:42:39 +0000 | [diff] [blame] | 3866 | a[9] = pPager->nRead; |
| 3867 | a[10] = pPager->nWrite; |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 3868 | return a; |
| 3869 | } |
danielk1977 | 17b90b5 | 2008-06-06 11:11:25 +0000 | [diff] [blame] | 3870 | int sqlite3PagerIsMemdb(Pager *pPager){ |
| 3871 | return MEMDB; |
| 3872 | } |
drh | 0f7eb61 | 2006-08-08 13:51:43 +0000 | [diff] [blame] | 3873 | #endif |
drh | dd79342 | 2001-06-28 01:54:48 +0000 | [diff] [blame] | 3874 | |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 3875 | /* |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 3876 | ** Set the statement rollback point. |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 3877 | ** |
| 3878 | ** This routine should be called with the transaction journal already |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 3879 | ** open. A new statement journal is created that can be used to rollback |
drh | aaab572 | 2002-02-19 13:39:21 +0000 | [diff] [blame] | 3880 | ** changes of a single SQL command within a larger transaction. |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 3881 | */ |
drh | 86f8c19 | 2007-08-22 00:39:19 +0000 | [diff] [blame] | 3882 | static int pagerStmtBegin(Pager *pPager){ |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 3883 | int rc; |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 3884 | assert( !pPager->stmtInUse ); |
drh | 1aa2d8b | 2007-01-03 15:34:29 +0000 | [diff] [blame] | 3885 | assert( pPager->state>=PAGER_SHARED ); |
danielk1977 | d92db53 | 2008-11-17 04:56:24 +0000 | [diff] [blame] | 3886 | assert( pPager->dbSizeValid ); |
drh | 4f0c587 | 2007-03-26 22:05:01 +0000 | [diff] [blame] | 3887 | PAGERTRACE2("STMT-BEGIN %d\n", PAGERID(pPager)); |
drh | da47d77 | 2002-12-02 04:25:19 +0000 | [diff] [blame] | 3888 | if( !pPager->journalOpen ){ |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 3889 | pPager->stmtAutoopen = 1; |
drh | da47d77 | 2002-12-02 04:25:19 +0000 | [diff] [blame] | 3890 | return SQLITE_OK; |
| 3891 | } |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 3892 | assert( pPager->journalOpen ); |
drh | f5e7bb5 | 2008-02-18 14:47:33 +0000 | [diff] [blame] | 3893 | assert( pPager->pInStmt==0 ); |
| 3894 | pPager->pInStmt = sqlite3BitvecCreate(pPager->dbSize); |
drh | f5e7bb5 | 2008-02-18 14:47:33 +0000 | [diff] [blame] | 3895 | if( pPager->pInStmt==0 ){ |
danielk1977 | 261919c | 2005-12-06 12:52:59 +0000 | [diff] [blame] | 3896 | /* sqlite3OsLock(pPager->fd, SHARED_LOCK); */ |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 3897 | return SQLITE_NOMEM; |
| 3898 | } |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 3899 | pPager->stmtJSize = pPager->journalOff; |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 3900 | pPager->stmtSize = pPager->dbSize; |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 3901 | pPager->stmtHdrOff = 0; |
danielk1977 | 75edc16 | 2004-06-26 01:48:18 +0000 | [diff] [blame] | 3902 | pPager->stmtCksum = pPager->cksumInit; |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 3903 | if( !pPager->stmtOpen ){ |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 3904 | if( pPager->journalMode==PAGER_JOURNALMODE_MEMORY ){ |
| 3905 | sqlite3MemJournalOpen(pPager->stfd); |
| 3906 | }else{ |
| 3907 | rc = sqlite3PagerOpentemp(pPager, pPager->stfd, SQLITE_OPEN_SUBJOURNAL); |
| 3908 | if( rc ){ |
| 3909 | goto stmt_begin_failed; |
| 3910 | } |
drh | 334b299 | 2007-09-06 23:28:23 +0000 | [diff] [blame] | 3911 | } |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 3912 | pPager->stmtOpen = 1; |
| 3913 | pPager->stmtNRec = 0; |
drh | 0f89253 | 2002-05-30 12:27:03 +0000 | [diff] [blame] | 3914 | } |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 3915 | pPager->stmtInUse = 1; |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 3916 | return SQLITE_OK; |
| 3917 | |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 3918 | stmt_begin_failed: |
drh | f5e7bb5 | 2008-02-18 14:47:33 +0000 | [diff] [blame] | 3919 | if( pPager->pInStmt ){ |
| 3920 | sqlite3BitvecDestroy(pPager->pInStmt); |
| 3921 | pPager->pInStmt = 0; |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 3922 | } |
| 3923 | return rc; |
| 3924 | } |
drh | 86f8c19 | 2007-08-22 00:39:19 +0000 | [diff] [blame] | 3925 | int sqlite3PagerStmtBegin(Pager *pPager){ |
| 3926 | int rc; |
drh | 86f8c19 | 2007-08-22 00:39:19 +0000 | [diff] [blame] | 3927 | rc = pagerStmtBegin(pPager); |
drh | 86f8c19 | 2007-08-22 00:39:19 +0000 | [diff] [blame] | 3928 | return rc; |
| 3929 | } |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 3930 | |
| 3931 | /* |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 3932 | ** Commit a statement. |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 3933 | */ |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 3934 | int sqlite3PagerStmtCommit(Pager *pPager){ |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 3935 | if( pPager->stmtInUse ){ |
drh | 4f0c587 | 2007-03-26 22:05:01 +0000 | [diff] [blame] | 3936 | PAGERTRACE2("STMT-COMMIT %d\n", PAGERID(pPager)); |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 3937 | sqlite3BitvecDestroy(pPager->pInStmt); |
| 3938 | pPager->pInStmt = 0; |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 3939 | pPager->stmtNRec = 0; |
| 3940 | pPager->stmtInUse = 0; |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 3941 | if( sqlite3IsMemJournal(pPager->stfd) ){ |
| 3942 | sqlite3OsTruncate(pPager->stfd, 0); |
| 3943 | } |
drh | 663fc63 | 2002-02-02 18:49:19 +0000 | [diff] [blame] | 3944 | } |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 3945 | pPager->stmtAutoopen = 0; |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 3946 | return SQLITE_OK; |
| 3947 | } |
| 3948 | |
| 3949 | /* |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 3950 | ** Rollback a statement. |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 3951 | */ |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 3952 | int sqlite3PagerStmtRollback(Pager *pPager){ |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 3953 | int rc; |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 3954 | if( pPager->stmtInUse ){ |
drh | 4f0c587 | 2007-03-26 22:05:01 +0000 | [diff] [blame] | 3955 | PAGERTRACE2("STMT-ROLLBACK %d\n", PAGERID(pPager)); |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 3956 | rc = pager_stmt_playback(pPager); |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 3957 | sqlite3PagerStmtCommit(pPager); |
drh | 663fc63 | 2002-02-02 18:49:19 +0000 | [diff] [blame] | 3958 | }else{ |
| 3959 | rc = SQLITE_OK; |
| 3960 | } |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 3961 | pPager->stmtAutoopen = 0; |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 3962 | return rc; |
| 3963 | } |
| 3964 | |
drh | 73509ee | 2003-04-06 20:44:45 +0000 | [diff] [blame] | 3965 | /* |
| 3966 | ** Return the full pathname of the database file. |
| 3967 | */ |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 3968 | const char *sqlite3PagerFilename(Pager *pPager){ |
drh | 73509ee | 2003-04-06 20:44:45 +0000 | [diff] [blame] | 3969 | return pPager->zFilename; |
| 3970 | } |
| 3971 | |
drh | b20ea9d | 2004-02-09 01:20:36 +0000 | [diff] [blame] | 3972 | /* |
drh | d0679ed | 2007-08-28 22:24:34 +0000 | [diff] [blame] | 3973 | ** Return the VFS structure for the pager. |
| 3974 | */ |
| 3975 | const sqlite3_vfs *sqlite3PagerVfs(Pager *pPager){ |
| 3976 | return pPager->pVfs; |
| 3977 | } |
| 3978 | |
| 3979 | /* |
drh | cc6bb3e | 2007-08-31 16:11:35 +0000 | [diff] [blame] | 3980 | ** Return the file handle for the database file associated |
| 3981 | ** with the pager. This might return NULL if the file has |
| 3982 | ** not yet been opened. |
| 3983 | */ |
| 3984 | sqlite3_file *sqlite3PagerFile(Pager *pPager){ |
| 3985 | return pPager->fd; |
| 3986 | } |
| 3987 | |
| 3988 | /* |
danielk1977 | 5865e3d | 2004-06-14 06:03:57 +0000 | [diff] [blame] | 3989 | ** Return the directory of the database file. |
| 3990 | */ |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 3991 | const char *sqlite3PagerDirname(Pager *pPager){ |
danielk1977 | 5865e3d | 2004-06-14 06:03:57 +0000 | [diff] [blame] | 3992 | return pPager->zDirectory; |
| 3993 | } |
| 3994 | |
| 3995 | /* |
| 3996 | ** Return the full pathname of the journal file. |
| 3997 | */ |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 3998 | const char *sqlite3PagerJournalname(Pager *pPager){ |
danielk1977 | 5865e3d | 2004-06-14 06:03:57 +0000 | [diff] [blame] | 3999 | return pPager->zJournal; |
| 4000 | } |
| 4001 | |
| 4002 | /* |
drh | 2c8997b | 2005-08-27 16:36:48 +0000 | [diff] [blame] | 4003 | ** Return true if fsync() calls are disabled for this pager. Return FALSE |
| 4004 | ** if fsync()s are executed normally. |
| 4005 | */ |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 4006 | int sqlite3PagerNosync(Pager *pPager){ |
drh | 2c8997b | 2005-08-27 16:36:48 +0000 | [diff] [blame] | 4007 | return pPager->noSync; |
| 4008 | } |
| 4009 | |
drh | 7c4ac0c | 2007-04-05 11:25:58 +0000 | [diff] [blame] | 4010 | #ifdef SQLITE_HAS_CODEC |
drh | 2c8997b | 2005-08-27 16:36:48 +0000 | [diff] [blame] | 4011 | /* |
drh | b20ea9d | 2004-02-09 01:20:36 +0000 | [diff] [blame] | 4012 | ** Set the codec for this pager |
| 4013 | */ |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 4014 | void sqlite3PagerSetCodec( |
drh | b20ea9d | 2004-02-09 01:20:36 +0000 | [diff] [blame] | 4015 | Pager *pPager, |
drh | c001c58 | 2006-03-06 18:23:16 +0000 | [diff] [blame] | 4016 | void *(*xCodec)(void*,void*,Pgno,int), |
drh | b20ea9d | 2004-02-09 01:20:36 +0000 | [diff] [blame] | 4017 | void *pCodecArg |
| 4018 | ){ |
| 4019 | pPager->xCodec = xCodec; |
| 4020 | pPager->pCodecArg = pCodecArg; |
| 4021 | } |
drh | 7c4ac0c | 2007-04-05 11:25:58 +0000 | [diff] [blame] | 4022 | #endif |
drh | b20ea9d | 2004-02-09 01:20:36 +0000 | [diff] [blame] | 4023 | |
danielk1977 | 687566d | 2004-11-02 12:56:41 +0000 | [diff] [blame] | 4024 | #ifndef SQLITE_OMIT_AUTOVACUUM |
| 4025 | /* |
danielk1977 | 87c29a9 | 2008-01-18 11:33:16 +0000 | [diff] [blame] | 4026 | ** Move the page pPg to location pgno in the file. |
danielk1977 | 687566d | 2004-11-02 12:56:41 +0000 | [diff] [blame] | 4027 | ** |
drh | 5e38531 | 2007-06-16 04:42:12 +0000 | [diff] [blame] | 4028 | ** There must be no references to the page previously located at |
| 4029 | ** pgno (which we call pPgOld) though that page is allowed to be |
drh | b3df2e1 | 2008-09-17 20:06:26 +0000 | [diff] [blame] | 4030 | ** in cache. If the page previously located at pgno is not already |
drh | 5e38531 | 2007-06-16 04:42:12 +0000 | [diff] [blame] | 4031 | ** in the rollback journal, it is not put there by by this routine. |
danielk1977 | 687566d | 2004-11-02 12:56:41 +0000 | [diff] [blame] | 4032 | ** |
drh | 5e38531 | 2007-06-16 04:42:12 +0000 | [diff] [blame] | 4033 | ** References to the page pPg remain valid. Updating any |
| 4034 | ** meta-data associated with pPg (i.e. data stored in the nExtra bytes |
danielk1977 | 687566d | 2004-11-02 12:56:41 +0000 | [diff] [blame] | 4035 | ** allocated along with the page) is the responsibility of the caller. |
| 4036 | ** |
danielk1977 | 5fd057a | 2005-03-09 13:09:43 +0000 | [diff] [blame] | 4037 | ** A transaction must be active when this routine is called. It used to be |
| 4038 | ** required that a statement transaction was not active, but this restriction |
| 4039 | ** has been removed (CREATE INDEX needs to move a page when a statement |
| 4040 | ** transaction is active). |
danielk1977 | 4c99999 | 2008-07-16 18:17:55 +0000 | [diff] [blame] | 4041 | ** |
| 4042 | ** If the fourth argument, isCommit, is non-zero, then this page is being |
| 4043 | ** moved as part of a database reorganization just before the transaction |
| 4044 | ** is being committed. In this case, it is guaranteed that the database page |
| 4045 | ** pPg refers to will not be written to again within this transaction. |
danielk1977 | 687566d | 2004-11-02 12:56:41 +0000 | [diff] [blame] | 4046 | */ |
danielk1977 | 4c99999 | 2008-07-16 18:17:55 +0000 | [diff] [blame] | 4047 | int sqlite3PagerMovepage(Pager *pPager, DbPage *pPg, Pgno pgno, int isCommit){ |
drh | 5e38531 | 2007-06-16 04:42:12 +0000 | [diff] [blame] | 4048 | PgHdr *pPgOld; /* The page being overwritten. */ |
danielk1977 | 94daf7f | 2004-11-08 09:26:09 +0000 | [diff] [blame] | 4049 | Pgno needSyncPgno = 0; |
danielk1977 | 687566d | 2004-11-02 12:56:41 +0000 | [diff] [blame] | 4050 | |
danielk1977 | 687566d | 2004-11-02 12:56:41 +0000 | [diff] [blame] | 4051 | assert( pPg->nRef>0 ); |
| 4052 | |
drh | 4f0c587 | 2007-03-26 22:05:01 +0000 | [diff] [blame] | 4053 | PAGERTRACE5("MOVE %d page %d (needSync=%d) moves to %d\n", |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 4054 | PAGERID(pPager), pPg->pgno, (pPg->flags&PGHDR_NEED_SYNC)?1:0, pgno); |
drh | b060341 | 2007-02-28 04:47:26 +0000 | [diff] [blame] | 4055 | IOTRACE(("MOVE %p %d %d\n", pPager, pPg->pgno, pgno)) |
danielk1977 | ef73ee9 | 2004-11-06 12:26:07 +0000 | [diff] [blame] | 4056 | |
danielk1977 | b4626a3 | 2007-04-28 15:47:43 +0000 | [diff] [blame] | 4057 | pager_get_content(pPg); |
danielk1977 | 4c99999 | 2008-07-16 18:17:55 +0000 | [diff] [blame] | 4058 | |
| 4059 | /* If the journal needs to be sync()ed before page pPg->pgno can |
| 4060 | ** be written to, store pPg->pgno in local variable needSyncPgno. |
| 4061 | ** |
| 4062 | ** If the isCommit flag is set, there is no need to remember that |
| 4063 | ** the journal needs to be sync()ed before database page pPg->pgno |
| 4064 | ** can be written to. The caller has already promised not to write to it. |
| 4065 | */ |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 4066 | if( (pPg->flags&PGHDR_NEED_SYNC) && !isCommit ){ |
danielk1977 | 94daf7f | 2004-11-08 09:26:09 +0000 | [diff] [blame] | 4067 | needSyncPgno = pPg->pgno; |
danielk1977 | d92db53 | 2008-11-17 04:56:24 +0000 | [diff] [blame] | 4068 | assert( pageInJournal(pPg) || pgno>pPager->origDbSize ); |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 4069 | assert( pPg->flags&PGHDR_DIRTY ); |
danielk1977 | ae82558 | 2004-11-23 09:06:55 +0000 | [diff] [blame] | 4070 | assert( pPager->needSync ); |
danielk1977 | 94daf7f | 2004-11-08 09:26:09 +0000 | [diff] [blame] | 4071 | } |
| 4072 | |
danielk1977 | ef73ee9 | 2004-11-06 12:26:07 +0000 | [diff] [blame] | 4073 | /* If the cache contains a page with page-number pgno, remove it |
drh | 85b623f | 2007-12-13 21:54:09 +0000 | [diff] [blame] | 4074 | ** from its hash chain. Also, if the PgHdr.needSync was set for |
danielk1977 | 599fcba | 2004-11-08 07:13:13 +0000 | [diff] [blame] | 4075 | ** page pgno before the 'move' operation, it needs to be retained |
| 4076 | ** for the page moved there. |
danielk1977 | f5fdda8 | 2004-11-03 08:44:05 +0000 | [diff] [blame] | 4077 | */ |
danielk1977 | bc2ca9e | 2008-11-13 14:28:28 +0000 | [diff] [blame] | 4078 | pPg->flags &= ~PGHDR_NEED_SYNC; |
danielk1977 | 687566d | 2004-11-02 12:56:41 +0000 | [diff] [blame] | 4079 | pPgOld = pager_lookup(pPager, pgno); |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 4080 | assert( !pPgOld || pPgOld->nRef==1 ); |
danielk1977 | 687566d | 2004-11-02 12:56:41 +0000 | [diff] [blame] | 4081 | if( pPgOld ){ |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 4082 | pPg->flags |= (pPgOld->flags&PGHDR_NEED_SYNC); |
drh | 5e38531 | 2007-06-16 04:42:12 +0000 | [diff] [blame] | 4083 | } |
danielk1977 | 687566d | 2004-11-02 12:56:41 +0000 | [diff] [blame] | 4084 | |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 4085 | sqlite3PcacheMove(pPg, pgno); |
| 4086 | if( pPgOld ){ |
danielk1977 | bc2ca9e | 2008-11-13 14:28:28 +0000 | [diff] [blame] | 4087 | sqlite3PcacheDrop(pPgOld); |
danielk1977 | f5fdda8 | 2004-11-03 08:44:05 +0000 | [diff] [blame] | 4088 | } |
danielk1977 | f5fdda8 | 2004-11-03 08:44:05 +0000 | [diff] [blame] | 4089 | |
drh | c047b9f | 2008-11-21 03:23:43 +0000 | [diff] [blame^] | 4090 | sqlite3PcacheMakeDirty(pPg); |
danielk1977 | 687566d | 2004-11-02 12:56:41 +0000 | [diff] [blame] | 4091 | pPager->dirtyCache = 1; |
drh | d138c01 | 2008-05-13 00:58:18 +0000 | [diff] [blame] | 4092 | pPager->dbModified = 1; |
danielk1977 | 687566d | 2004-11-02 12:56:41 +0000 | [diff] [blame] | 4093 | |
danielk1977 | 94daf7f | 2004-11-08 09:26:09 +0000 | [diff] [blame] | 4094 | if( needSyncPgno ){ |
| 4095 | /* If needSyncPgno is non-zero, then the journal file needs to be |
| 4096 | ** sync()ed before any data is written to database file page needSyncPgno. |
| 4097 | ** Currently, no such page exists in the page-cache and the |
danielk1977 | 4c99999 | 2008-07-16 18:17:55 +0000 | [diff] [blame] | 4098 | ** "is journaled" bitvec flag has been set. This needs to be remedied by |
| 4099 | ** loading the page into the pager-cache and setting the PgHdr.needSync |
| 4100 | ** flag. |
danielk1977 | ae82558 | 2004-11-23 09:06:55 +0000 | [diff] [blame] | 4101 | ** |
danielk1977 | a98d7b4 | 2008-01-18 13:42:54 +0000 | [diff] [blame] | 4102 | ** If the attempt to load the page into the page-cache fails, (due |
drh | f5e7bb5 | 2008-02-18 14:47:33 +0000 | [diff] [blame] | 4103 | ** to a malloc() or IO failure), clear the bit in the pInJournal[] |
danielk1977 | a98d7b4 | 2008-01-18 13:42:54 +0000 | [diff] [blame] | 4104 | ** array. Otherwise, if the page is loaded and written again in |
| 4105 | ** this transaction, it may be written to the database file before |
| 4106 | ** it is synced into the journal file. This way, it may end up in |
| 4107 | ** the journal file twice, but that is not a problem. |
| 4108 | ** |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 4109 | ** The sqlite3PagerGet() call may cause the journal to sync. So make |
danielk1977 | ae82558 | 2004-11-23 09:06:55 +0000 | [diff] [blame] | 4110 | ** sure the Pager.needSync flag is set too. |
danielk1977 | 94daf7f | 2004-11-08 09:26:09 +0000 | [diff] [blame] | 4111 | */ |
| 4112 | int rc; |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 4113 | PgHdr *pPgHdr; |
danielk1977 | ae82558 | 2004-11-23 09:06:55 +0000 | [diff] [blame] | 4114 | assert( pPager->needSync ); |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 4115 | rc = sqlite3PagerGet(pPager, needSyncPgno, &pPgHdr); |
danielk1977 | 87c29a9 | 2008-01-18 11:33:16 +0000 | [diff] [blame] | 4116 | if( rc!=SQLITE_OK ){ |
danielk1977 | d92db53 | 2008-11-17 04:56:24 +0000 | [diff] [blame] | 4117 | if( pPager->pInJournal && needSyncPgno<=pPager->origDbSize ){ |
drh | f5e7bb5 | 2008-02-18 14:47:33 +0000 | [diff] [blame] | 4118 | sqlite3BitvecClear(pPager->pInJournal, needSyncPgno); |
danielk1977 | a98d7b4 | 2008-01-18 13:42:54 +0000 | [diff] [blame] | 4119 | } |
danielk1977 | 87c29a9 | 2008-01-18 11:33:16 +0000 | [diff] [blame] | 4120 | return rc; |
| 4121 | } |
danielk1977 | ae82558 | 2004-11-23 09:06:55 +0000 | [diff] [blame] | 4122 | pPager->needSync = 1; |
drh | b3df2e1 | 2008-09-17 20:06:26 +0000 | [diff] [blame] | 4123 | assert( pPager->noSync==0 && !MEMDB ); |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 4124 | pPgHdr->flags |= PGHDR_NEED_SYNC; |
drh | c047b9f | 2008-11-21 03:23:43 +0000 | [diff] [blame^] | 4125 | sqlite3PcacheMakeDirty(pPgHdr); |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 4126 | sqlite3PagerUnref(pPgHdr); |
danielk1977 | 94daf7f | 2004-11-08 09:26:09 +0000 | [diff] [blame] | 4127 | } |
| 4128 | |
danielk1977 | 687566d | 2004-11-02 12:56:41 +0000 | [diff] [blame] | 4129 | return SQLITE_OK; |
| 4130 | } |
| 4131 | #endif |
| 4132 | |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 4133 | /* |
| 4134 | ** Return a pointer to the data for the specified page. |
| 4135 | */ |
| 4136 | void *sqlite3PagerGetData(DbPage *pPg){ |
danielk1977 | 71d5d2c | 2008-09-29 11:49:47 +0000 | [diff] [blame] | 4137 | assert( pPg->nRef>0 || pPg->pPager->memDb ); |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 4138 | return pPg->pData; |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 4139 | } |
| 4140 | |
| 4141 | /* |
| 4142 | ** Return a pointer to the Pager.nExtra bytes of "extra" space |
| 4143 | ** allocated along with the specified page. |
| 4144 | */ |
| 4145 | void *sqlite3PagerGetExtra(DbPage *pPg){ |
| 4146 | Pager *pPager = pPg->pPager; |
danielk1977 | 8c0a791 | 2008-08-20 14:49:23 +0000 | [diff] [blame] | 4147 | return (pPager?pPg->pExtra:0); |
danielk1977 | 3b8a05f | 2007-03-19 17:44:26 +0000 | [diff] [blame] | 4148 | } |
| 4149 | |
danielk1977 | 4148346 | 2007-03-24 16:45:04 +0000 | [diff] [blame] | 4150 | /* |
| 4151 | ** Get/set the locking-mode for this pager. Parameter eMode must be one |
| 4152 | ** of PAGER_LOCKINGMODE_QUERY, PAGER_LOCKINGMODE_NORMAL or |
| 4153 | ** PAGER_LOCKINGMODE_EXCLUSIVE. If the parameter is not _QUERY, then |
| 4154 | ** the locking-mode is set to the value specified. |
| 4155 | ** |
| 4156 | ** The returned value is either PAGER_LOCKINGMODE_NORMAL or |
| 4157 | ** PAGER_LOCKINGMODE_EXCLUSIVE, indicating the current (possibly updated) |
| 4158 | ** locking-mode. |
| 4159 | */ |
| 4160 | int sqlite3PagerLockingMode(Pager *pPager, int eMode){ |
drh | 369339d | 2007-03-30 16:01:55 +0000 | [diff] [blame] | 4161 | assert( eMode==PAGER_LOCKINGMODE_QUERY |
| 4162 | || eMode==PAGER_LOCKINGMODE_NORMAL |
| 4163 | || eMode==PAGER_LOCKINGMODE_EXCLUSIVE ); |
| 4164 | assert( PAGER_LOCKINGMODE_QUERY<0 ); |
| 4165 | assert( PAGER_LOCKINGMODE_NORMAL>=0 && PAGER_LOCKINGMODE_EXCLUSIVE>=0 ); |
| 4166 | if( eMode>=0 && !pPager->tempFile ){ |
danielk1977 | 4148346 | 2007-03-24 16:45:04 +0000 | [diff] [blame] | 4167 | pPager->exclusiveMode = eMode; |
| 4168 | } |
| 4169 | return (int)pPager->exclusiveMode; |
| 4170 | } |
| 4171 | |
drh | 3b02013 | 2008-04-17 17:02:01 +0000 | [diff] [blame] | 4172 | /* |
drh | 0433588 | 2008-09-26 21:08:08 +0000 | [diff] [blame] | 4173 | ** Get/set the journal-mode for this pager. Parameter eMode must be one of: |
drh | 3b02013 | 2008-04-17 17:02:01 +0000 | [diff] [blame] | 4174 | ** |
drh | 0433588 | 2008-09-26 21:08:08 +0000 | [diff] [blame] | 4175 | ** PAGER_JOURNALMODE_QUERY |
| 4176 | ** PAGER_JOURNALMODE_DELETE |
| 4177 | ** PAGER_JOURNALMODE_TRUNCATE |
| 4178 | ** PAGER_JOURNALMODE_PERSIST |
| 4179 | ** PAGER_JOURNALMODE_OFF |
| 4180 | ** |
| 4181 | ** If the parameter is not _QUERY, then the journal-mode is set to the |
| 4182 | ** value specified. |
| 4183 | ** |
| 4184 | ** The returned indicate the current (possibly updated) |
drh | 3b02013 | 2008-04-17 17:02:01 +0000 | [diff] [blame] | 4185 | ** journal-mode. |
| 4186 | */ |
| 4187 | int sqlite3PagerJournalMode(Pager *pPager, int eMode){ |
danielk1977 | b317538 | 2008-10-17 18:51:52 +0000 | [diff] [blame] | 4188 | if( !MEMDB ){ |
| 4189 | assert( eMode==PAGER_JOURNALMODE_QUERY |
| 4190 | || eMode==PAGER_JOURNALMODE_DELETE |
| 4191 | || eMode==PAGER_JOURNALMODE_TRUNCATE |
| 4192 | || eMode==PAGER_JOURNALMODE_PERSIST |
| 4193 | || eMode==PAGER_JOURNALMODE_OFF |
| 4194 | || eMode==PAGER_JOURNALMODE_MEMORY ); |
| 4195 | assert( PAGER_JOURNALMODE_QUERY<0 ); |
| 4196 | if( eMode>=0 ){ |
| 4197 | pPager->journalMode = eMode; |
| 4198 | }else{ |
| 4199 | assert( eMode==PAGER_JOURNALMODE_QUERY ); |
| 4200 | } |
drh | 3b02013 | 2008-04-17 17:02:01 +0000 | [diff] [blame] | 4201 | } |
drh | fdc40e9 | 2008-04-17 20:59:37 +0000 | [diff] [blame] | 4202 | return (int)pPager->journalMode; |
drh | 3b02013 | 2008-04-17 17:02:01 +0000 | [diff] [blame] | 4203 | } |
| 4204 | |
danielk1977 | b53e496 | 2008-06-04 06:45:59 +0000 | [diff] [blame] | 4205 | /* |
| 4206 | ** Get/set the size-limit used for persistent journal files. |
| 4207 | */ |
| 4208 | i64 sqlite3PagerJournalSizeLimit(Pager *pPager, i64 iLimit){ |
| 4209 | if( iLimit>=-1 ){ |
| 4210 | pPager->journalSizeLimit = iLimit; |
| 4211 | } |
| 4212 | return pPager->journalSizeLimit; |
| 4213 | } |
| 4214 | |
drh | 2e66f0b | 2005-04-28 17:18:48 +0000 | [diff] [blame] | 4215 | #endif /* SQLITE_OMIT_DISKIO */ |