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