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 | 93758c8 | 2005-01-21 08:13:14 +0000 | [diff] [blame^] | 21 | ** @(#) $Id: pager.c,v 1.185 2005/01/21 08:13:15 danielk1977 Exp $ |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 22 | */ |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 23 | #include "sqliteInt.h" |
drh | eb20625 | 2004-10-01 02:00:31 +0000 | [diff] [blame] | 24 | #include "os.h" |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 25 | #include "pager.h" |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 26 | #include <assert.h> |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 27 | #include <string.h> |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 28 | |
| 29 | /* |
drh | db48ee0 | 2003-01-16 13:42:43 +0000 | [diff] [blame] | 30 | ** Macros for troubleshooting. Normally turned off |
| 31 | */ |
danielk1977 | 466be56 | 2004-06-10 02:16:01 +0000 | [diff] [blame] | 32 | #if 0 |
drh | 34f4732 | 2004-08-18 15:58:22 +0000 | [diff] [blame] | 33 | #define TRACE1(X) sqlite3DebugPrintf(X) |
| 34 | #define TRACE2(X,Y) sqlite3DebugPrintf(X,Y) |
| 35 | #define TRACE3(X,Y,Z) sqlite3DebugPrintf(X,Y,Z) |
| 36 | #define TRACE4(X,Y,Z,W) sqlite3DebugPrintf(X,Y,Z,W) |
danielk1977 | 94daf7f | 2004-11-08 09:26:09 +0000 | [diff] [blame] | 37 | #define TRACE5(X,Y,Z,W,V) sqlite3DebugPrintf(X,Y,Z,W,V) |
drh | db48ee0 | 2003-01-16 13:42:43 +0000 | [diff] [blame] | 38 | #else |
drh | db48ee0 | 2003-01-16 13:42:43 +0000 | [diff] [blame] | 39 | #define TRACE1(X) |
| 40 | #define TRACE2(X,Y) |
| 41 | #define TRACE3(X,Y,Z) |
drh | 34f4732 | 2004-08-18 15:58:22 +0000 | [diff] [blame] | 42 | #define TRACE4(X,Y,Z,W) |
danielk1977 | 599fcba | 2004-11-08 07:13:13 +0000 | [diff] [blame] | 43 | #define TRACE5(X,Y,Z,W,V) |
drh | db48ee0 | 2003-01-16 13:42:43 +0000 | [diff] [blame] | 44 | #endif |
| 45 | |
danielk1977 | 599fcba | 2004-11-08 07:13:13 +0000 | [diff] [blame] | 46 | /* |
| 47 | ** The following two macros are used within the TRACEX() macros above |
| 48 | ** to print out file-descriptors. They are required so that tracing |
| 49 | ** can be turned on when using both the regular os_unix.c and os_test.c |
| 50 | ** backends. |
| 51 | ** |
| 52 | ** PAGERID() takes a pointer to a Pager struct as it's argument. The |
| 53 | ** associated file-descriptor is returned. FILEHANDLEID() takes an OsFile |
| 54 | ** struct as it's argument. |
| 55 | */ |
danielk1977 | ef73ee9 | 2004-11-06 12:26:07 +0000 | [diff] [blame] | 56 | #ifdef OS_TEST |
| 57 | #define PAGERID(p) (p->fd->fd.h) |
| 58 | #define FILEHANDLEID(fd) (fd->fd.h) |
| 59 | #else |
| 60 | #define PAGERID(p) (p->fd.h) |
| 61 | #define FILEHANDLEID(fd) (fd.h) |
| 62 | #endif |
drh | db48ee0 | 2003-01-16 13:42:43 +0000 | [diff] [blame] | 63 | |
| 64 | /* |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 65 | ** The page cache as a whole is always in one of the following |
| 66 | ** states: |
| 67 | ** |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 68 | ** PAGER_UNLOCK The page cache is not currently reading or |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 69 | ** writing the database file. There is no |
| 70 | ** data held in memory. This is the initial |
| 71 | ** state. |
| 72 | ** |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 73 | ** PAGER_SHARED The page cache is reading the database. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 74 | ** Writing is not permitted. There can be |
| 75 | ** multiple readers accessing the same database |
drh | 69688d5 | 2001-04-14 16:38:23 +0000 | [diff] [blame] | 76 | ** file at the same time. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 77 | ** |
drh | 726de59 | 2004-06-10 23:35:50 +0000 | [diff] [blame] | 78 | ** PAGER_RESERVED This process has reserved the database for writing |
| 79 | ** but has not yet made any changes. Only one process |
| 80 | ** at a time can reserve the database. The original |
| 81 | ** database file has not been modified so other |
| 82 | ** processes may still be reading the on-disk |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 83 | ** database file. |
| 84 | ** |
| 85 | ** PAGER_EXCLUSIVE The page cache is writing the database. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 86 | ** Access is exclusive. No other processes or |
| 87 | ** threads can be reading or writing while one |
| 88 | ** process is writing. |
| 89 | ** |
danielk1977 | aa5ccdf | 2004-06-14 05:10:42 +0000 | [diff] [blame] | 90 | ** PAGER_SYNCED The pager moves to this state from PAGER_EXCLUSIVE |
| 91 | ** after all dirty pages have been written to the |
| 92 | ** database file and the file has been synced to |
| 93 | ** disk. All that remains to do is to remove the |
| 94 | ** journal file and the transaction will be |
| 95 | ** committed. |
| 96 | ** |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 97 | ** The page cache comes up in PAGER_UNLOCK. The first time a |
drh | 726de59 | 2004-06-10 23:35:50 +0000 | [diff] [blame] | 98 | ** sqlite3pager_get() occurs, the state transitions to PAGER_SHARED. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 99 | ** After all pages have been released using sqlite_page_unref(), |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 100 | ** the state transitions back to PAGER_UNLOCK. The first time |
drh | 726de59 | 2004-06-10 23:35:50 +0000 | [diff] [blame] | 101 | ** that sqlite3pager_write() is called, the state transitions to |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 102 | ** PAGER_RESERVED. (Note that sqlite_page_write() can only be |
drh | 306dc21 | 2001-05-21 13:45:10 +0000 | [diff] [blame] | 103 | ** called on an outstanding page which means that the pager must |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 104 | ** be in PAGER_SHARED before it transitions to PAGER_RESERVED.) |
drh | 726de59 | 2004-06-10 23:35:50 +0000 | [diff] [blame] | 105 | ** The transition to PAGER_EXCLUSIVE occurs when before any changes |
| 106 | ** are made to the database file. After an sqlite3pager_rollback() |
| 107 | ** or sqlite_pager_commit(), the state goes back to PAGER_SHARED. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 108 | */ |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 109 | #define PAGER_UNLOCK 0 |
drh | 684917c | 2004-10-05 02:41:42 +0000 | [diff] [blame] | 110 | #define PAGER_SHARED 1 /* same as SHARED_LOCK */ |
| 111 | #define PAGER_RESERVED 2 /* same as RESERVED_LOCK */ |
| 112 | #define PAGER_EXCLUSIVE 4 /* same as EXCLUSIVE_LOCK */ |
| 113 | #define PAGER_SYNCED 5 |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 114 | |
drh | 684917c | 2004-10-05 02:41:42 +0000 | [diff] [blame] | 115 | /* |
| 116 | ** If the SQLITE_BUSY_RESERVED_LOCK macro is set to true at compile-time, |
| 117 | ** then failed attempts to get a reserved lock will invoke the busy callback. |
| 118 | ** This is off by default. To see why, consider the following scenario: |
| 119 | ** |
| 120 | ** Suppose thread A already has a shared lock and wants a reserved lock. |
| 121 | ** Thread B already has a reserved lock and wants an exclusive lock. If |
| 122 | ** both threads are using their busy callbacks, it might be a long time |
| 123 | ** be for one of the threads give up and allows the other to proceed. |
| 124 | ** But if the thread trying to get the reserved lock gives up quickly |
| 125 | ** (if it never invokes its busy callback) then the contention will be |
| 126 | ** resolved quickly. |
| 127 | */ |
| 128 | #ifndef SQLITE_BUSY_RESERVED_LOCK |
| 129 | # define SQLITE_BUSY_RESERVED_LOCK 0 |
| 130 | #endif |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 131 | |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 132 | /* |
drh | 887dc4c | 2004-10-22 16:22:57 +0000 | [diff] [blame] | 133 | ** This macro rounds values up so that if the value is an address it |
| 134 | ** is guaranteed to be an address that is aligned to an 8-byte boundary. |
| 135 | */ |
| 136 | #define FORCE_ALIGNMENT(X) (((X)+7)&~7) |
| 137 | |
| 138 | /* |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 139 | ** Each in-memory image of a page begins with the following header. |
drh | bd03cae | 2001-06-02 02:40:57 +0000 | [diff] [blame] | 140 | ** This header is only visible to this pager module. The client |
| 141 | ** code that calls pager sees only the data that follows the header. |
drh | f603871 | 2004-02-08 18:07:34 +0000 | [diff] [blame] | 142 | ** |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 143 | ** Client code should call sqlite3pager_write() on a page prior to making |
| 144 | ** any modifications to that page. The first time sqlite3pager_write() |
drh | f603871 | 2004-02-08 18:07:34 +0000 | [diff] [blame] | 145 | ** is called, the original page contents are written into the rollback |
| 146 | ** journal and PgHdr.inJournal and PgHdr.needSync are set. Later, once |
| 147 | ** the journal page has made it onto the disk surface, PgHdr.needSync |
| 148 | ** is cleared. The modified page cannot be written back into the original |
| 149 | ** database file until the journal pages has been synced to disk and the |
| 150 | ** PgHdr.needSync has been cleared. |
| 151 | ** |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 152 | ** The PgHdr.dirty flag is set when sqlite3pager_write() is called and |
drh | f603871 | 2004-02-08 18:07:34 +0000 | [diff] [blame] | 153 | ** is cleared again when the page content is written back to the original |
| 154 | ** database file. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 155 | */ |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 156 | typedef struct PgHdr PgHdr; |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 157 | struct PgHdr { |
| 158 | Pager *pPager; /* The pager to which this page belongs */ |
| 159 | Pgno pgno; /* The page number for this page */ |
drh | 69688d5 | 2001-04-14 16:38:23 +0000 | [diff] [blame] | 160 | PgHdr *pNextHash, *pPrevHash; /* Hash collision chain for PgHdr.pgno */ |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 161 | PgHdr *pNextFree, *pPrevFree; /* Freelist of pages where nRef==0 */ |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 162 | PgHdr *pNextAll; /* A list of all pages */ |
| 163 | PgHdr *pNextStmt, *pPrevStmt; /* List of pages in the statement journal */ |
drh | 193a6b4 | 2002-07-07 16:52:46 +0000 | [diff] [blame] | 164 | u8 inJournal; /* TRUE if has been written to journal */ |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 165 | u8 inStmt; /* TRUE if in the statement subjournal */ |
drh | 193a6b4 | 2002-07-07 16:52:46 +0000 | [diff] [blame] | 166 | u8 dirty; /* TRUE if we need to write back changes */ |
drh | db48ee0 | 2003-01-16 13:42:43 +0000 | [diff] [blame] | 167 | u8 needSync; /* Sync journal before writing this page */ |
drh | 193a6b4 | 2002-07-07 16:52:46 +0000 | [diff] [blame] | 168 | u8 alwaysRollback; /* Disable dont_rollback() for this page */ |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 169 | short int nRef; /* Number of users of this page */ |
drh | 2554f8b | 2003-01-22 01:26:44 +0000 | [diff] [blame] | 170 | PgHdr *pDirty; /* Dirty pages sorted by PgHdr.pgno */ |
drh | 887dc4c | 2004-10-22 16:22:57 +0000 | [diff] [blame] | 171 | /* pPager->psAligned bytes of page data follow this header */ |
drh | 973b6e3 | 2003-02-12 14:09:42 +0000 | [diff] [blame] | 172 | /* Pager.nExtra bytes of local data follow the page data */ |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 173 | }; |
| 174 | |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 175 | /* |
| 176 | ** For an in-memory only database, some extra information is recorded about |
| 177 | ** each page so that changes can be rolled back. (Journal files are not |
| 178 | ** used for in-memory databases.) The following information is added to |
| 179 | ** the end of every EXTRA block for in-memory databases. |
| 180 | ** |
| 181 | ** This information could have been added directly to the PgHdr structure. |
| 182 | ** But then it would take up an extra 8 bytes of storage on every PgHdr |
| 183 | ** even for disk-based databases. Splitting it out saves 8 bytes. This |
| 184 | ** is only a savings of 0.8% but those percentages add up. |
| 185 | */ |
| 186 | typedef struct PgHistory PgHistory; |
| 187 | struct PgHistory { |
| 188 | u8 *pOrig; /* Original page text. Restore to this on a full rollback */ |
| 189 | u8 *pStmt; /* Text as it was at the beginning of the current statement */ |
| 190 | }; |
drh | 9eb9e26 | 2004-02-11 02:18:05 +0000 | [diff] [blame] | 191 | |
| 192 | /* |
| 193 | ** A macro used for invoking the codec if there is one |
| 194 | */ |
| 195 | #ifdef SQLITE_HAS_CODEC |
| 196 | # define CODEC(P,D,N,X) if( P->xCodec ){ P->xCodec(P->pCodecArg,D,N,X); } |
| 197 | #else |
| 198 | # define CODEC(P,D,N,X) |
| 199 | #endif |
| 200 | |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 201 | /* |
drh | 69688d5 | 2001-04-14 16:38:23 +0000 | [diff] [blame] | 202 | ** Convert a pointer to a PgHdr into a pointer to its data |
| 203 | ** and back again. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 204 | */ |
| 205 | #define PGHDR_TO_DATA(P) ((void*)(&(P)[1])) |
| 206 | #define DATA_TO_PGHDR(D) (&((PgHdr*)(D))[-1]) |
drh | 887dc4c | 2004-10-22 16:22:57 +0000 | [diff] [blame] | 207 | #define PGHDR_TO_EXTRA(G,P) ((void*)&((char*)(&(G)[1]))[(P)->psAligned]) |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 208 | #define PGHDR_TO_HIST(P,PGR) \ |
drh | 887dc4c | 2004-10-22 16:22:57 +0000 | [diff] [blame] | 209 | ((PgHistory*)&((char*)(&(P)[1]))[(PGR)->psAligned+(PGR)->nExtra]) |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 210 | |
| 211 | /* |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 212 | ** How big to make the hash table used for locating in-memory pages |
drh | 836faa4 | 2003-01-11 13:30:57 +0000 | [diff] [blame] | 213 | ** by page number. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 214 | */ |
drh | 836faa4 | 2003-01-11 13:30:57 +0000 | [diff] [blame] | 215 | #define N_PG_HASH 2048 |
| 216 | |
| 217 | /* |
| 218 | ** Hash a page number |
| 219 | */ |
| 220 | #define pager_hash(PN) ((PN)&(N_PG_HASH-1)) |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 221 | |
| 222 | /* |
| 223 | ** A open page cache is an instance of the following structure. |
| 224 | */ |
| 225 | struct Pager { |
| 226 | char *zFilename; /* Name of the database file */ |
| 227 | char *zJournal; /* Name of the journal file */ |
drh | a76c82e | 2003-07-27 18:59:42 +0000 | [diff] [blame] | 228 | char *zDirectory; /* Directory hold database and journal files */ |
drh | 8cfbf08 | 2001-09-19 13:22:39 +0000 | [diff] [blame] | 229 | OsFile fd, jfd; /* File descriptors for database and journal */ |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 230 | OsFile stfd; /* File descriptor for the statement subjournal*/ |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 231 | int dbSize; /* Number of pages in the file */ |
drh | 69688d5 | 2001-04-14 16:38:23 +0000 | [diff] [blame] | 232 | int origDbSize; /* dbSize before the current change */ |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 233 | int stmtSize; /* Size of database (in pages) at stmt_begin() */ |
drh | eb20625 | 2004-10-01 02:00:31 +0000 | [diff] [blame] | 234 | i64 stmtJSize; /* Size of journal at stmt_begin() */ |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 235 | int nRec; /* Number of pages written to the journal */ |
| 236 | u32 cksumInit; /* Quasi-random value added to every checksum */ |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 237 | int stmtNRec; /* Number of records in stmt subjournal */ |
drh | 7e3b0a0 | 2001-04-28 16:52:40 +0000 | [diff] [blame] | 238 | int nExtra; /* Add this many bytes to each in-memory page */ |
drh | b6f4148 | 2004-05-14 01:58:11 +0000 | [diff] [blame] | 239 | void (*xDestructor)(void*,int); /* Call this routine when freeing pages */ |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 240 | void (*xReiniter)(void*,int); /* Call this routine when reloading pages */ |
drh | b6f4148 | 2004-05-14 01:58:11 +0000 | [diff] [blame] | 241 | int pageSize; /* Number of bytes in a page */ |
drh | 887dc4c | 2004-10-22 16:22:57 +0000 | [diff] [blame] | 242 | int psAligned; /* pageSize rounded up to a multiple of 8 */ |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 243 | int nPage; /* Total number of in-memory pages */ |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 244 | int nRef; /* Number of in-memory pages with PgHdr.nRef>0 */ |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 245 | int mxPage; /* Maximum number of pages to hold in cache */ |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 246 | int nHit, nMiss, nOvfl; /* Cache hits, missing, and LRU overflows */ |
danielk1977 | 42741be | 2005-01-08 12:42:39 +0000 | [diff] [blame] | 247 | int nRead,nWrite; /* Database pages read/written */ |
drh | 9eb9e26 | 2004-02-11 02:18:05 +0000 | [diff] [blame] | 248 | void (*xCodec)(void*,void*,Pgno,int); /* Routine for en/decoding data */ |
drh | b20ea9d | 2004-02-09 01:20:36 +0000 | [diff] [blame] | 249 | void *pCodecArg; /* First argument to xCodec() */ |
drh | 603240c | 2002-03-05 01:11:12 +0000 | [diff] [blame] | 250 | u8 journalOpen; /* True if journal file descriptors is valid */ |
drh | 34e79ce | 2004-02-08 06:05:46 +0000 | [diff] [blame] | 251 | u8 journalStarted; /* True if header of journal is synced */ |
| 252 | u8 useJournal; /* Use a rollback journal on this file */ |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 253 | u8 stmtOpen; /* True if the statement subjournal is open */ |
| 254 | u8 stmtInUse; /* True we are in a statement subtransaction */ |
| 255 | u8 stmtAutoopen; /* Open stmt journal when main journal is opened*/ |
drh | 603240c | 2002-03-05 01:11:12 +0000 | [diff] [blame] | 256 | u8 noSync; /* Do not sync the journal if true */ |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 257 | u8 fullSync; /* Do extra syncs of the journal for robustness */ |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 258 | u8 state; /* PAGER_UNLOCK, _SHARED, _RESERVED, etc. */ |
drh | 603240c | 2002-03-05 01:11:12 +0000 | [diff] [blame] | 259 | u8 errMask; /* One of several kinds of errors */ |
| 260 | u8 tempFile; /* zFilename is a temporary file */ |
| 261 | u8 readOnly; /* True for a read-only database */ |
| 262 | u8 needSync; /* True if an fsync() is needed on the journal */ |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 263 | u8 dirtyCache; /* True if cached pages have changed */ |
drh | 193a6b4 | 2002-07-07 16:52:46 +0000 | [diff] [blame] | 264 | u8 alwaysRollback; /* Disable dont_rollback() for all pages */ |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 265 | u8 memDb; /* True to inhibit all file I/O */ |
drh | 603240c | 2002-03-05 01:11:12 +0000 | [diff] [blame] | 266 | u8 *aInJournal; /* One bit for each page in the database file */ |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 267 | u8 *aInStmt; /* One bit for each page in the database */ |
drh | fdb3806 | 2004-08-21 19:20:42 +0000 | [diff] [blame] | 268 | u8 setMaster; /* True if a m-j name has been written to jrnl */ |
drh | 726de59 | 2004-06-10 23:35:50 +0000 | [diff] [blame] | 269 | BusyHandler *pBusyHandler; /* Pointer to sqlite.busyHandler */ |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 270 | PgHdr *pFirst, *pLast; /* List of free pages */ |
drh | 341eae8 | 2003-01-21 02:39:36 +0000 | [diff] [blame] | 271 | PgHdr *pFirstSynced; /* First free page with PgHdr.needSync==0 */ |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 272 | PgHdr *pAll; /* List of all pages */ |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 273 | PgHdr *pStmt; /* List of pages in the statement subjournal */ |
drh | eb20625 | 2004-10-01 02:00:31 +0000 | [diff] [blame] | 274 | i64 journalOff; /* Current byte offset in the journal file */ |
| 275 | i64 journalHdr; /* Byte offset to previous journal header */ |
| 276 | i64 stmtHdrOff; /* First journal header written this statement */ |
| 277 | i64 stmtCksum; /* cksumInit when statement was started */ |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 278 | int sectorSize; /* Assumed sector size during rollback */ |
drh | 76ff3a0 | 2004-09-24 22:32:30 +0000 | [diff] [blame] | 279 | PgHdr *aHash[N_PG_HASH]; /* Hash table to map page number to PgHdr */ |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 280 | }; |
| 281 | |
| 282 | /* |
| 283 | ** These are bits that can be set in Pager.errMask. |
| 284 | */ |
| 285 | #define PAGER_ERR_FULL 0x01 /* a write() failed */ |
| 286 | #define PAGER_ERR_MEM 0x02 /* malloc() failed */ |
| 287 | #define PAGER_ERR_LOCK 0x04 /* error in the locking protocol */ |
| 288 | #define PAGER_ERR_CORRUPT 0x08 /* database or journal corruption */ |
drh | 81a20f2 | 2001-10-12 17:30:04 +0000 | [diff] [blame] | 289 | #define PAGER_ERR_DISK 0x10 /* general disk I/O error - bad hard drive? */ |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 290 | |
| 291 | /* |
drh | 5e00f6c | 2001-09-13 13:46:56 +0000 | [diff] [blame] | 292 | ** Journal files begin with the following magic string. The data |
| 293 | ** was obtained from /dev/random. It is used only as a sanity check. |
drh | 94f3331 | 2002-08-12 12:29:56 +0000 | [diff] [blame] | 294 | ** |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 295 | ** Since version 2.8.0, the journal format contains additional sanity |
| 296 | ** checking information. If the power fails while the journal is begin |
| 297 | ** written, semi-random garbage data might appear in the journal |
| 298 | ** file after power is restored. If an attempt is then made |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 299 | ** to roll the journal back, the database could be corrupted. The additional |
| 300 | ** sanity checking data is an attempt to discover the garbage in the |
| 301 | ** journal and ignore it. |
| 302 | ** |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 303 | ** The sanity checking information for the new journal format consists |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 304 | ** 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] | 305 | ** the page number and the pPager->pageSize bytes of data for the page. |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 306 | ** This cksum is initialized to a 32-bit random value that appears in the |
| 307 | ** journal file right after the header. The random initializer is important, |
| 308 | ** because garbage data that appears at the end of a journal is likely |
| 309 | ** data that was once in other files that have now been deleted. If the |
| 310 | ** garbage data came from an obsolete journal file, the checksums might |
| 311 | ** be correct. But by initializing the checksum to random value which |
| 312 | ** is different for every journal, we minimize that risk. |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 313 | */ |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 314 | static const unsigned char aJournalMagic[] = { |
| 315 | 0xd9, 0xd5, 0x05, 0xf9, 0x20, 0xa1, 0x63, 0xd7, |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 316 | }; |
| 317 | |
| 318 | /* |
drh | 726de59 | 2004-06-10 23:35:50 +0000 | [diff] [blame] | 319 | ** The size of the header and of each page in the journal is determined |
| 320 | ** by the following macros. |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 321 | */ |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 322 | #define JOURNAL_PG_SZ(pPager) ((pPager->pageSize) + 8) |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 323 | |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 324 | /* |
| 325 | ** The journal header size for this pager. In the future, this could be |
| 326 | ** set to some value read from the disk controller. The important |
| 327 | ** characteristic is that it is the same size as a disk sector. |
| 328 | */ |
| 329 | #define JOURNAL_HDR_SZ(pPager) (pPager->sectorSize) |
| 330 | |
drh | b7f9164 | 2004-10-31 02:22:47 +0000 | [diff] [blame] | 331 | /* |
| 332 | ** The macro MEMDB is true if we are dealing with an in-memory database. |
| 333 | ** We do this as a macro so that if the SQLITE_OMIT_MEMORYDB macro is set, |
| 334 | ** the value of MEMDB will be a constant and the compiler will optimize |
| 335 | ** out code that would never execute. |
| 336 | */ |
| 337 | #ifdef SQLITE_OMIT_MEMORYDB |
| 338 | # define MEMDB 0 |
| 339 | #else |
| 340 | # define MEMDB pPager->memDb |
| 341 | #endif |
| 342 | |
| 343 | /* |
| 344 | ** The default size of a disk sector |
| 345 | */ |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 346 | #define PAGER_SECTOR_SIZE 512 |
| 347 | |
| 348 | /* |
| 349 | ** Page number PAGER_MJ_PGNO is never used in an SQLite database (it is |
| 350 | ** reserved for working around a windows/posix incompatibility). It is |
| 351 | ** used in the journal to signify that the remainder of the journal file |
| 352 | ** is devoted to storing a master journal name - there are no more pages to |
| 353 | ** roll back. See comments for function writeMasterJournal() for details. |
| 354 | */ |
danielk1977 | 599fcba | 2004-11-08 07:13:13 +0000 | [diff] [blame] | 355 | /* #define PAGER_MJ_PGNO(x) (PENDING_BYTE/((x)->pageSize)) */ |
| 356 | #define PAGER_MJ_PGNO(x) ((PENDING_BYTE/((x)->pageSize))+1) |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 357 | |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 358 | /* |
danielk1977 | 2683665 | 2005-01-17 01:33:13 +0000 | [diff] [blame] | 359 | ** The maximum legal page number is (2^31 - 1). |
| 360 | */ |
| 361 | #define PAGER_MAX_PGNO 2147483647 |
| 362 | |
| 363 | /* |
drh | 726de59 | 2004-06-10 23:35:50 +0000 | [diff] [blame] | 364 | ** Enable reference count tracking (for debugging) here: |
drh | dd79342 | 2001-06-28 01:54:48 +0000 | [diff] [blame] | 365 | */ |
danielk1977 | aca790a | 2005-01-13 11:07:52 +0000 | [diff] [blame] | 366 | #ifdef SQLITE_DEBUG |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 367 | int pager3_refinfo_enable = 0; |
drh | dd79342 | 2001-06-28 01:54:48 +0000 | [diff] [blame] | 368 | static void pager_refinfo(PgHdr *p){ |
| 369 | static int cnt = 0; |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 370 | if( !pager3_refinfo_enable ) return; |
drh | fe63d1c | 2004-09-08 20:13:04 +0000 | [diff] [blame] | 371 | sqlite3DebugPrintf( |
| 372 | "REFCNT: %4d addr=%p nRef=%d\n", |
| 373 | p->pgno, PGHDR_TO_DATA(p), p->nRef |
drh | dd79342 | 2001-06-28 01:54:48 +0000 | [diff] [blame] | 374 | ); |
| 375 | cnt++; /* Something to set a breakpoint on */ |
| 376 | } |
| 377 | # define REFINFO(X) pager_refinfo(X) |
| 378 | #else |
| 379 | # define REFINFO(X) |
| 380 | #endif |
| 381 | |
| 382 | /* |
drh | 34e79ce | 2004-02-08 06:05:46 +0000 | [diff] [blame] | 383 | ** Read a 32-bit integer from the given file descriptor. Store the integer |
| 384 | ** that is read in *pRes. Return SQLITE_OK if everything worked, or an |
| 385 | ** error code is something goes wrong. |
drh | 726de59 | 2004-06-10 23:35:50 +0000 | [diff] [blame] | 386 | ** |
| 387 | ** All values are stored on disk as big-endian. |
drh | 94f3331 | 2002-08-12 12:29:56 +0000 | [diff] [blame] | 388 | */ |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 389 | static int read32bits(OsFile *fd, u32 *pRes){ |
drh | 94f3331 | 2002-08-12 12:29:56 +0000 | [diff] [blame] | 390 | u32 res; |
| 391 | int rc; |
danielk1977 | 4adee20 | 2004-05-08 08:23:19 +0000 | [diff] [blame] | 392 | rc = sqlite3OsRead(fd, &res, sizeof(res)); |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 393 | if( rc==SQLITE_OK ){ |
drh | 94f3331 | 2002-08-12 12:29:56 +0000 | [diff] [blame] | 394 | unsigned char ac[4]; |
| 395 | memcpy(ac, &res, 4); |
| 396 | res = (ac[0]<<24) | (ac[1]<<16) | (ac[2]<<8) | ac[3]; |
| 397 | } |
| 398 | *pRes = res; |
| 399 | return rc; |
| 400 | } |
| 401 | |
| 402 | /* |
drh | 34e79ce | 2004-02-08 06:05:46 +0000 | [diff] [blame] | 403 | ** Write a 32-bit integer into the given file descriptor. Return SQLITE_OK |
| 404 | ** on success or an error code is something goes wrong. |
drh | 94f3331 | 2002-08-12 12:29:56 +0000 | [diff] [blame] | 405 | */ |
| 406 | static int write32bits(OsFile *fd, u32 val){ |
| 407 | unsigned char ac[4]; |
drh | 94f3331 | 2002-08-12 12:29:56 +0000 | [diff] [blame] | 408 | ac[0] = (val>>24) & 0xff; |
| 409 | ac[1] = (val>>16) & 0xff; |
| 410 | ac[2] = (val>>8) & 0xff; |
| 411 | ac[3] = val & 0xff; |
danielk1977 | 4adee20 | 2004-05-08 08:23:19 +0000 | [diff] [blame] | 412 | return sqlite3OsWrite(fd, ac, 4); |
drh | 94f3331 | 2002-08-12 12:29:56 +0000 | [diff] [blame] | 413 | } |
| 414 | |
drh | 2554f8b | 2003-01-22 01:26:44 +0000 | [diff] [blame] | 415 | /* |
danielk1977 | aa5ccdf | 2004-06-14 05:10:42 +0000 | [diff] [blame] | 416 | ** Write the 32-bit integer 'val' into the page identified by page header |
| 417 | ** 'p' at offset 'offset'. |
drh | 2554f8b | 2003-01-22 01:26:44 +0000 | [diff] [blame] | 418 | */ |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 419 | static void store32bits(u32 val, PgHdr *p, int offset){ |
drh | 2554f8b | 2003-01-22 01:26:44 +0000 | [diff] [blame] | 420 | unsigned char *ac; |
drh | ec1bd0b | 2003-08-26 11:41:27 +0000 | [diff] [blame] | 421 | ac = &((unsigned char*)PGHDR_TO_DATA(p))[offset]; |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 422 | ac[0] = (val>>24) & 0xff; |
| 423 | ac[1] = (val>>16) & 0xff; |
| 424 | ac[2] = (val>>8) & 0xff; |
| 425 | ac[3] = val & 0xff; |
drh | 2554f8b | 2003-01-22 01:26:44 +0000 | [diff] [blame] | 426 | } |
| 427 | |
danielk1977 | aa5ccdf | 2004-06-14 05:10:42 +0000 | [diff] [blame] | 428 | /* |
| 429 | ** Read a 32-bit integer at offset 'offset' from the page identified by |
| 430 | ** page header 'p'. |
| 431 | */ |
| 432 | static u32 retrieve32bits(PgHdr *p, int offset){ |
| 433 | unsigned char *ac; |
| 434 | ac = &((unsigned char*)PGHDR_TO_DATA(p))[offset]; |
| 435 | return (ac[0]<<24) | (ac[1]<<16) | (ac[2]<<8) | ac[3]; |
| 436 | } |
| 437 | |
drh | 94f3331 | 2002-08-12 12:29:56 +0000 | [diff] [blame] | 438 | |
| 439 | /* |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 440 | ** Convert the bits in the pPager->errMask into an approprate |
| 441 | ** return code. |
| 442 | */ |
| 443 | static int pager_errcode(Pager *pPager){ |
| 444 | int rc = SQLITE_OK; |
| 445 | if( pPager->errMask & PAGER_ERR_LOCK ) rc = SQLITE_PROTOCOL; |
drh | 81a20f2 | 2001-10-12 17:30:04 +0000 | [diff] [blame] | 446 | if( pPager->errMask & PAGER_ERR_DISK ) rc = SQLITE_IOERR; |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 447 | if( pPager->errMask & PAGER_ERR_FULL ) rc = SQLITE_FULL; |
| 448 | if( pPager->errMask & PAGER_ERR_MEM ) rc = SQLITE_NOMEM; |
| 449 | if( pPager->errMask & PAGER_ERR_CORRUPT ) rc = SQLITE_CORRUPT; |
| 450 | return rc; |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 451 | } |
| 452 | |
| 453 | /* |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 454 | ** When this is called the journal file for pager pPager must be open. |
| 455 | ** The master journal file name is read from the end of the file and |
| 456 | ** written into memory obtained from sqliteMalloc(). *pzMaster is |
| 457 | ** set to point at the memory and SQLITE_OK returned. The caller must |
| 458 | ** sqliteFree() *pzMaster. |
| 459 | ** |
| 460 | ** If no master journal file name is present *pzMaster is set to 0 and |
| 461 | ** SQLITE_OK returned. |
| 462 | */ |
| 463 | static int readMasterJournal(OsFile *pJrnl, char **pzMaster){ |
| 464 | int rc; |
| 465 | u32 len; |
drh | eb20625 | 2004-10-01 02:00:31 +0000 | [diff] [blame] | 466 | i64 szJ; |
danielk1977 | c3e8f5e | 2004-06-28 01:16:46 +0000 | [diff] [blame] | 467 | u32 cksum; |
danielk1977 | cafadba | 2004-06-25 11:11:54 +0000 | [diff] [blame] | 468 | int i; |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 469 | unsigned char aMagic[8]; /* A buffer to hold the magic header */ |
| 470 | |
| 471 | *pzMaster = 0; |
| 472 | |
| 473 | rc = sqlite3OsFileSize(pJrnl, &szJ); |
danielk1977 | cafadba | 2004-06-25 11:11:54 +0000 | [diff] [blame] | 474 | if( rc!=SQLITE_OK || szJ<16 ) return rc; |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 475 | |
danielk1977 | cafadba | 2004-06-25 11:11:54 +0000 | [diff] [blame] | 476 | rc = sqlite3OsSeek(pJrnl, szJ-16); |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 477 | if( rc!=SQLITE_OK ) return rc; |
| 478 | |
| 479 | rc = read32bits(pJrnl, &len); |
| 480 | if( rc!=SQLITE_OK ) return rc; |
| 481 | |
danielk1977 | cafadba | 2004-06-25 11:11:54 +0000 | [diff] [blame] | 482 | rc = read32bits(pJrnl, &cksum); |
| 483 | if( rc!=SQLITE_OK ) return rc; |
| 484 | |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 485 | rc = sqlite3OsRead(pJrnl, aMagic, 8); |
| 486 | if( rc!=SQLITE_OK || memcmp(aMagic, aJournalMagic, 8) ) return rc; |
| 487 | |
danielk1977 | 8191bff | 2004-06-28 04:52:30 +0000 | [diff] [blame] | 488 | rc = sqlite3OsSeek(pJrnl, szJ-16-len); |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 489 | if( rc!=SQLITE_OK ) return rc; |
| 490 | |
danielk1977 | 8191bff | 2004-06-28 04:52:30 +0000 | [diff] [blame] | 491 | *pzMaster = (char *)sqliteMalloc(len+1); |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 492 | if( !*pzMaster ){ |
| 493 | return SQLITE_NOMEM; |
| 494 | } |
| 495 | rc = sqlite3OsRead(pJrnl, *pzMaster, len); |
| 496 | if( rc!=SQLITE_OK ){ |
| 497 | sqliteFree(*pzMaster); |
| 498 | *pzMaster = 0; |
| 499 | return rc; |
| 500 | } |
danielk1977 | cafadba | 2004-06-25 11:11:54 +0000 | [diff] [blame] | 501 | |
| 502 | /* See if the checksum matches the master journal name */ |
| 503 | for(i=0; i<len; i++){ |
danielk1977 | 8191bff | 2004-06-28 04:52:30 +0000 | [diff] [blame] | 504 | cksum -= (*pzMaster)[i]; |
danielk1977 | cafadba | 2004-06-25 11:11:54 +0000 | [diff] [blame] | 505 | } |
danielk1977 | 8191bff | 2004-06-28 04:52:30 +0000 | [diff] [blame] | 506 | if( cksum ){ |
| 507 | /* If the checksum doesn't add up, then one or more of the disk sectors |
| 508 | ** containing the master journal filename is corrupted. This means |
| 509 | ** definitely roll back, so just return SQLITE_OK and report a (nul) |
| 510 | ** master-journal filename. |
| 511 | */ |
danielk1977 | cafadba | 2004-06-25 11:11:54 +0000 | [diff] [blame] | 512 | sqliteFree(*pzMaster); |
| 513 | *pzMaster = 0; |
danielk1977 | aca790a | 2005-01-13 11:07:52 +0000 | [diff] [blame] | 514 | }else{ |
| 515 | (*pzMaster)[len] = '\0'; |
danielk1977 | cafadba | 2004-06-25 11:11:54 +0000 | [diff] [blame] | 516 | } |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 517 | |
| 518 | return SQLITE_OK; |
| 519 | } |
| 520 | |
| 521 | /* |
| 522 | ** Seek the journal file descriptor to the next sector boundary where a |
| 523 | ** journal header may be read or written. Pager.journalOff is updated with |
| 524 | ** the new seek offset. |
| 525 | ** |
| 526 | ** i.e for a sector size of 512: |
| 527 | ** |
| 528 | ** Input Offset Output Offset |
| 529 | ** --------------------------------------- |
| 530 | ** 0 0 |
| 531 | ** 512 512 |
| 532 | ** 100 512 |
| 533 | ** 2000 2048 |
| 534 | ** |
| 535 | */ |
| 536 | static int seekJournalHdr(Pager *pPager){ |
drh | eb20625 | 2004-10-01 02:00:31 +0000 | [diff] [blame] | 537 | i64 offset = 0; |
| 538 | i64 c = pPager->journalOff; |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 539 | if( c ){ |
| 540 | offset = ((c-1)/JOURNAL_HDR_SZ(pPager) + 1) * JOURNAL_HDR_SZ(pPager); |
| 541 | } |
| 542 | assert( offset%JOURNAL_HDR_SZ(pPager)==0 ); |
| 543 | assert( offset>=c ); |
| 544 | assert( (offset-c)<JOURNAL_HDR_SZ(pPager) ); |
| 545 | pPager->journalOff = offset; |
| 546 | return sqlite3OsSeek(&pPager->jfd, pPager->journalOff); |
| 547 | } |
| 548 | |
| 549 | /* |
| 550 | ** The journal file must be open when this routine is called. A journal |
| 551 | ** header (JOURNAL_HDR_SZ bytes) is written into the journal file at the |
| 552 | ** current location. |
| 553 | ** |
| 554 | ** The format for the journal header is as follows: |
| 555 | ** - 8 bytes: Magic identifying journal format. |
| 556 | ** - 4 bytes: Number of records in journal, or -1 no-sync mode is on. |
| 557 | ** - 4 bytes: Random number used for page hash. |
| 558 | ** - 4 bytes: Initial database page count. |
| 559 | ** - 4 bytes: Sector size used by the process that wrote this journal. |
| 560 | ** |
danielk1977 | f42f25c | 2004-06-25 07:21:28 +0000 | [diff] [blame] | 561 | ** Followed by (JOURNAL_HDR_SZ - 24) bytes of unused space. |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 562 | */ |
| 563 | static int writeJournalHdr(Pager *pPager){ |
| 564 | |
| 565 | int rc = seekJournalHdr(pPager); |
| 566 | if( rc ) return rc; |
| 567 | |
| 568 | pPager->journalHdr = pPager->journalOff; |
| 569 | if( pPager->stmtHdrOff==0 ){ |
| 570 | pPager->stmtHdrOff = pPager->journalHdr; |
| 571 | } |
| 572 | pPager->journalOff += JOURNAL_HDR_SZ(pPager); |
| 573 | |
| 574 | /* FIX ME: |
| 575 | ** |
| 576 | ** Possibly for a pager not in no-sync mode, the journal magic should not |
| 577 | ** be written until nRec is filled in as part of next syncJournal(). |
| 578 | ** |
| 579 | ** Actually maybe the whole journal header should be delayed until that |
| 580 | ** point. Think about this. |
| 581 | */ |
| 582 | rc = sqlite3OsWrite(&pPager->jfd, aJournalMagic, sizeof(aJournalMagic)); |
| 583 | |
| 584 | if( rc==SQLITE_OK ){ |
| 585 | /* The nRec Field. 0xFFFFFFFF for no-sync journals. */ |
| 586 | rc = write32bits(&pPager->jfd, pPager->noSync ? 0xffffffff : 0); |
| 587 | } |
| 588 | if( rc==SQLITE_OK ){ |
| 589 | /* The random check-hash initialiser */ |
| 590 | sqlite3Randomness(sizeof(pPager->cksumInit), &pPager->cksumInit); |
| 591 | rc = write32bits(&pPager->jfd, pPager->cksumInit); |
| 592 | } |
| 593 | if( rc==SQLITE_OK ){ |
| 594 | /* The initial database size */ |
| 595 | rc = write32bits(&pPager->jfd, pPager->dbSize); |
| 596 | } |
| 597 | if( rc==SQLITE_OK ){ |
| 598 | /* The assumed sector size for this process */ |
| 599 | rc = write32bits(&pPager->jfd, pPager->sectorSize); |
| 600 | } |
| 601 | |
| 602 | /* The journal header has been written successfully. Seek the journal |
| 603 | ** file descriptor to the end of the journal header sector. |
| 604 | */ |
| 605 | if( rc==SQLITE_OK ){ |
| 606 | sqlite3OsSeek(&pPager->jfd, pPager->journalOff-1); |
| 607 | rc = sqlite3OsWrite(&pPager->jfd, "\000", 1); |
| 608 | } |
| 609 | return rc; |
| 610 | } |
| 611 | |
| 612 | /* |
| 613 | ** The journal file must be open when this is called. A journal header file |
| 614 | ** (JOURNAL_HDR_SZ bytes) is read from the current location in the journal |
| 615 | ** file. See comments above function writeJournalHdr() for a description of |
| 616 | ** the journal header format. |
| 617 | ** |
| 618 | ** If the header is read successfully, *nRec is set to the number of |
| 619 | ** page records following this header and *dbSize is set to the size of the |
| 620 | ** database before the transaction began, in pages. Also, pPager->cksumInit |
| 621 | ** is set to the value read from the journal header. SQLITE_OK is returned |
| 622 | ** in this case. |
| 623 | ** |
| 624 | ** If the journal header file appears to be corrupted, SQLITE_DONE is |
| 625 | ** returned and *nRec and *dbSize are not set. If JOURNAL_HDR_SZ bytes |
| 626 | ** cannot be read from the journal file an error code is returned. |
| 627 | */ |
| 628 | static int readJournalHdr( |
| 629 | Pager *pPager, |
drh | eb20625 | 2004-10-01 02:00:31 +0000 | [diff] [blame] | 630 | i64 journalSize, |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 631 | u32 *pNRec, |
| 632 | u32 *pDbSize |
| 633 | ){ |
| 634 | int rc; |
| 635 | unsigned char aMagic[8]; /* A buffer to hold the magic header */ |
| 636 | |
| 637 | rc = seekJournalHdr(pPager); |
| 638 | if( rc ) return rc; |
| 639 | |
| 640 | if( pPager->journalOff+JOURNAL_HDR_SZ(pPager) > journalSize ){ |
| 641 | return SQLITE_DONE; |
| 642 | } |
| 643 | |
| 644 | rc = sqlite3OsRead(&pPager->jfd, aMagic, sizeof(aMagic)); |
| 645 | if( rc ) return rc; |
| 646 | |
| 647 | if( memcmp(aMagic, aJournalMagic, sizeof(aMagic))!=0 ){ |
| 648 | return SQLITE_DONE; |
| 649 | } |
| 650 | |
| 651 | rc = read32bits(&pPager->jfd, pNRec); |
| 652 | if( rc ) return rc; |
| 653 | |
| 654 | rc = read32bits(&pPager->jfd, &pPager->cksumInit); |
| 655 | if( rc ) return rc; |
| 656 | |
| 657 | rc = read32bits(&pPager->jfd, pDbSize); |
| 658 | if( rc ) return rc; |
| 659 | |
| 660 | /* Update the assumed sector-size to match the value used by |
| 661 | ** the process that created this journal. If this journal was |
| 662 | ** created by a process other than this one, then this routine |
| 663 | ** is being called from within pager_playback(). The local value |
| 664 | ** of Pager.sectorSize is restored at the end of that routine. |
| 665 | */ |
danielk1977 | c3e8f5e | 2004-06-28 01:16:46 +0000 | [diff] [blame] | 666 | rc = read32bits(&pPager->jfd, (u32 *)&pPager->sectorSize); |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 667 | if( rc ) return rc; |
| 668 | |
| 669 | pPager->journalOff += JOURNAL_HDR_SZ(pPager); |
| 670 | rc = sqlite3OsSeek(&pPager->jfd, pPager->journalOff); |
| 671 | return rc; |
| 672 | } |
| 673 | |
| 674 | |
| 675 | /* |
| 676 | ** Write the supplied master journal name into the journal file for pager |
danielk1977 | cafadba | 2004-06-25 11:11:54 +0000 | [diff] [blame] | 677 | ** pPager at the current location. The master journal name must be the last |
| 678 | ** thing written to a journal file. If the pager is in full-sync mode, the |
| 679 | ** journal file descriptor is advanced to the next sector boundary before |
| 680 | ** anything is written. The format is: |
| 681 | ** |
| 682 | ** + 4 bytes: PAGER_MJ_PGNO. |
| 683 | ** + N bytes: length of master journal name. |
| 684 | ** + 4 bytes: N |
| 685 | ** + 4 bytes: Master journal name checksum. |
| 686 | ** + 8 bytes: aJournalMagic[]. |
| 687 | ** |
| 688 | ** The master journal page checksum is the sum of the bytes in the master |
| 689 | ** journal name. |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 690 | */ |
| 691 | static int writeMasterJournal(Pager *pPager, const char *zMaster){ |
| 692 | int rc; |
| 693 | int len; |
danielk1977 | cafadba | 2004-06-25 11:11:54 +0000 | [diff] [blame] | 694 | int i; |
danielk1977 | c3e8f5e | 2004-06-28 01:16:46 +0000 | [diff] [blame] | 695 | u32 cksum = 0; |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 696 | |
| 697 | if( !zMaster || pPager->setMaster) return SQLITE_OK; |
| 698 | pPager->setMaster = 1; |
| 699 | |
| 700 | len = strlen(zMaster); |
danielk1977 | cafadba | 2004-06-25 11:11:54 +0000 | [diff] [blame] | 701 | for(i=0; i<len; i++){ |
| 702 | cksum += zMaster[i]; |
| 703 | } |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 704 | |
| 705 | /* If in full-sync mode, advance to the next disk sector before writing |
| 706 | ** the master journal name. This is in case the previous page written to |
| 707 | ** the journal has already been synced. |
| 708 | */ |
| 709 | if( pPager->fullSync ){ |
| 710 | rc = seekJournalHdr(pPager); |
| 711 | if( rc!=SQLITE_OK ) return rc; |
| 712 | } |
danielk1977 | cafadba | 2004-06-25 11:11:54 +0000 | [diff] [blame] | 713 | pPager->journalOff += (len+20); |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 714 | |
| 715 | rc = write32bits(&pPager->jfd, PAGER_MJ_PGNO(pPager)); |
| 716 | if( rc!=SQLITE_OK ) return rc; |
| 717 | |
| 718 | rc = sqlite3OsWrite(&pPager->jfd, zMaster, len); |
| 719 | if( rc!=SQLITE_OK ) return rc; |
| 720 | |
| 721 | rc = write32bits(&pPager->jfd, len); |
| 722 | if( rc!=SQLITE_OK ) return rc; |
| 723 | |
danielk1977 | cafadba | 2004-06-25 11:11:54 +0000 | [diff] [blame] | 724 | rc = write32bits(&pPager->jfd, cksum); |
| 725 | if( rc!=SQLITE_OK ) return rc; |
| 726 | |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 727 | rc = sqlite3OsWrite(&pPager->jfd, aJournalMagic, sizeof(aJournalMagic)); |
drh | fdb3806 | 2004-08-21 19:20:42 +0000 | [diff] [blame] | 728 | pPager->needSync = 1; |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 729 | return rc; |
| 730 | } |
| 731 | |
| 732 | /* |
drh | 03eb96a | 2002-11-10 23:32:56 +0000 | [diff] [blame] | 733 | ** 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] | 734 | ** statement journal. |
drh | 03eb96a | 2002-11-10 23:32:56 +0000 | [diff] [blame] | 735 | ** |
| 736 | ** The Pager keeps a separate list of pages that are currently in |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 737 | ** the statement journal. This helps the sqlite3pager_stmt_commit() |
drh | 03eb96a | 2002-11-10 23:32:56 +0000 | [diff] [blame] | 738 | ** routine run MUCH faster for the common case where there are many |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 739 | ** pages in memory but only a few are in the statement journal. |
drh | 03eb96a | 2002-11-10 23:32:56 +0000 | [diff] [blame] | 740 | */ |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 741 | static void page_add_to_stmt_list(PgHdr *pPg){ |
drh | 03eb96a | 2002-11-10 23:32:56 +0000 | [diff] [blame] | 742 | Pager *pPager = pPg->pPager; |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 743 | if( pPg->inStmt ) return; |
| 744 | assert( pPg->pPrevStmt==0 && pPg->pNextStmt==0 ); |
| 745 | pPg->pPrevStmt = 0; |
| 746 | if( pPager->pStmt ){ |
| 747 | pPager->pStmt->pPrevStmt = pPg; |
drh | 03eb96a | 2002-11-10 23:32:56 +0000 | [diff] [blame] | 748 | } |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 749 | pPg->pNextStmt = pPager->pStmt; |
| 750 | pPager->pStmt = pPg; |
| 751 | pPg->inStmt = 1; |
drh | 03eb96a | 2002-11-10 23:32:56 +0000 | [diff] [blame] | 752 | } |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 753 | static void page_remove_from_stmt_list(PgHdr *pPg){ |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 754 | if( !pPg->inStmt ) return; |
| 755 | if( pPg->pPrevStmt ){ |
| 756 | assert( pPg->pPrevStmt->pNextStmt==pPg ); |
| 757 | pPg->pPrevStmt->pNextStmt = pPg->pNextStmt; |
drh | 03eb96a | 2002-11-10 23:32:56 +0000 | [diff] [blame] | 758 | }else{ |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 759 | assert( pPg->pPager->pStmt==pPg ); |
| 760 | pPg->pPager->pStmt = pPg->pNextStmt; |
drh | 03eb96a | 2002-11-10 23:32:56 +0000 | [diff] [blame] | 761 | } |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 762 | if( pPg->pNextStmt ){ |
| 763 | assert( pPg->pNextStmt->pPrevStmt==pPg ); |
| 764 | pPg->pNextStmt->pPrevStmt = pPg->pPrevStmt; |
drh | 03eb96a | 2002-11-10 23:32:56 +0000 | [diff] [blame] | 765 | } |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 766 | pPg->pNextStmt = 0; |
| 767 | pPg->pPrevStmt = 0; |
| 768 | pPg->inStmt = 0; |
drh | 03eb96a | 2002-11-10 23:32:56 +0000 | [diff] [blame] | 769 | } |
| 770 | |
| 771 | /* |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 772 | ** Find a page in the hash table given its page number. Return |
| 773 | ** a pointer to the page or NULL if not found. |
| 774 | */ |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 775 | static PgHdr *pager_lookup(Pager *pPager, Pgno pgno){ |
drh | 836faa4 | 2003-01-11 13:30:57 +0000 | [diff] [blame] | 776 | PgHdr *p = pPager->aHash[pager_hash(pgno)]; |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 777 | while( p && p->pgno!=pgno ){ |
| 778 | p = p->pNextHash; |
| 779 | } |
| 780 | return p; |
| 781 | } |
| 782 | |
| 783 | /* |
| 784 | ** Unlock the database and clear the in-memory cache. This routine |
| 785 | ** sets the state of the pager back to what it was when it was first |
| 786 | ** opened. Any outstanding pages are invalidated and subsequent attempts |
| 787 | ** to access those pages will likely result in a coredump. |
| 788 | */ |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 789 | static void pager_reset(Pager *pPager){ |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 790 | PgHdr *pPg, *pNext; |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 791 | for(pPg=pPager->pAll; pPg; pPg=pNext){ |
| 792 | pNext = pPg->pNextAll; |
| 793 | sqliteFree(pPg); |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 794 | } |
| 795 | pPager->pFirst = 0; |
drh | 341eae8 | 2003-01-21 02:39:36 +0000 | [diff] [blame] | 796 | pPager->pFirstSynced = 0; |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 797 | pPager->pLast = 0; |
| 798 | pPager->pAll = 0; |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 799 | memset(pPager->aHash, 0, sizeof(pPager->aHash)); |
| 800 | pPager->nPage = 0; |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 801 | if( pPager->state>=PAGER_RESERVED ){ |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 802 | sqlite3pager_rollback(pPager); |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 803 | } |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 804 | sqlite3OsUnlock(&pPager->fd, NO_LOCK); |
| 805 | pPager->state = PAGER_UNLOCK; |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 806 | pPager->dbSize = -1; |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 807 | pPager->nRef = 0; |
drh | 8cfbf08 | 2001-09-19 13:22:39 +0000 | [diff] [blame] | 808 | assert( pPager->journalOpen==0 ); |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 809 | } |
| 810 | |
| 811 | /* |
| 812 | ** When this routine is called, the pager has the journal file open and |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 813 | ** a RESERVED or EXCLUSIVE lock on the database. This routine releases |
| 814 | ** the database lock and acquires a SHARED lock in its place. The journal |
| 815 | ** file is deleted and closed. |
drh | 5045789 | 2003-09-06 01:10:47 +0000 | [diff] [blame] | 816 | ** |
| 817 | ** TODO: Consider keeping the journal file open for temporary databases. |
| 818 | ** This might give a performance improvement on windows where opening |
| 819 | ** a file is an expensive operation. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 820 | */ |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 821 | static int pager_unwritelock(Pager *pPager){ |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 822 | PgHdr *pPg; |
drh | 9c105bb | 2004-10-02 20:38:28 +0000 | [diff] [blame] | 823 | int rc; |
drh | b7f9164 | 2004-10-31 02:22:47 +0000 | [diff] [blame] | 824 | assert( !MEMDB ); |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 825 | if( pPager->state<PAGER_RESERVED ){ |
| 826 | return SQLITE_OK; |
| 827 | } |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 828 | sqlite3pager_stmt_commit(pPager); |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 829 | if( pPager->stmtOpen ){ |
| 830 | sqlite3OsClose(&pPager->stfd); |
| 831 | pPager->stmtOpen = 0; |
drh | 0f89253 | 2002-05-30 12:27:03 +0000 | [diff] [blame] | 832 | } |
drh | da47d77 | 2002-12-02 04:25:19 +0000 | [diff] [blame] | 833 | if( pPager->journalOpen ){ |
danielk1977 | 4adee20 | 2004-05-08 08:23:19 +0000 | [diff] [blame] | 834 | sqlite3OsClose(&pPager->jfd); |
drh | da47d77 | 2002-12-02 04:25:19 +0000 | [diff] [blame] | 835 | pPager->journalOpen = 0; |
danielk1977 | 4adee20 | 2004-05-08 08:23:19 +0000 | [diff] [blame] | 836 | sqlite3OsDelete(pPager->zJournal); |
drh | da47d77 | 2002-12-02 04:25:19 +0000 | [diff] [blame] | 837 | sqliteFree( pPager->aInJournal ); |
| 838 | pPager->aInJournal = 0; |
| 839 | for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){ |
| 840 | pPg->inJournal = 0; |
| 841 | pPg->dirty = 0; |
drh | db48ee0 | 2003-01-16 13:42:43 +0000 | [diff] [blame] | 842 | pPg->needSync = 0; |
drh | da47d77 | 2002-12-02 04:25:19 +0000 | [diff] [blame] | 843 | } |
danielk1977 | ef317ab | 2004-06-23 10:43:10 +0000 | [diff] [blame] | 844 | pPager->dirtyCache = 0; |
danielk1977 | ef317ab | 2004-06-23 10:43:10 +0000 | [diff] [blame] | 845 | pPager->nRec = 0; |
drh | da47d77 | 2002-12-02 04:25:19 +0000 | [diff] [blame] | 846 | }else{ |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 847 | assert( pPager->dirtyCache==0 || pPager->useJournal==0 ); |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 848 | } |
drh | 9c105bb | 2004-10-02 20:38:28 +0000 | [diff] [blame] | 849 | rc = sqlite3OsUnlock(&pPager->fd, SHARED_LOCK); |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 850 | pPager->state = PAGER_SHARED; |
danielk1977 | ef317ab | 2004-06-23 10:43:10 +0000 | [diff] [blame] | 851 | pPager->origDbSize = 0; |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 852 | pPager->setMaster = 0; |
drh | 9c105bb | 2004-10-02 20:38:28 +0000 | [diff] [blame] | 853 | return rc; |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 854 | } |
| 855 | |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 856 | /* |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 857 | ** Compute and return a checksum for the page of data. |
drh | 34e79ce | 2004-02-08 06:05:46 +0000 | [diff] [blame] | 858 | ** |
| 859 | ** 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] | 860 | ** random initial value and the page number. We experimented with |
| 861 | ** a checksum of the entire data, but that was found to be too slow. |
| 862 | ** |
| 863 | ** Note that the page number is stored at the beginning of data and |
| 864 | ** the checksum is stored at the end. This is important. If journal |
| 865 | ** corruption occurs due to a power failure, the most likely scenario |
| 866 | ** is that one end or the other of the record will be changed. It is |
| 867 | ** much less likely that the two ends of the journal record will be |
| 868 | ** correct and the middle be corrupt. Thus, this "checksum" scheme, |
| 869 | ** though fast and simple, catches the mostly likely kind of corruption. |
| 870 | ** |
| 871 | ** FIX ME: Consider adding every 200th (or so) byte of the data to the |
| 872 | ** checksum. That way if a single page spans 3 or more disk sectors and |
| 873 | ** only the middle sector is corrupt, we will still have a reasonable |
| 874 | ** chance of failing the checksum and thus detecting the problem. |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 875 | */ |
| 876 | static u32 pager_cksum(Pager *pPager, Pgno pgno, const char *aData){ |
danielk1977 | ef317ab | 2004-06-23 10:43:10 +0000 | [diff] [blame] | 877 | u32 cksum = pPager->cksumInit; |
| 878 | int i = pPager->pageSize-200; |
| 879 | while( i>0 ){ |
| 880 | cksum += aData[i]; |
| 881 | i -= 200; |
| 882 | } |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 883 | return cksum; |
| 884 | } |
| 885 | |
| 886 | /* |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 887 | ** Read a single page from the journal file opened on file descriptor |
| 888 | ** jfd. Playback this one page. |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 889 | ** |
drh | 726de59 | 2004-06-10 23:35:50 +0000 | [diff] [blame] | 890 | ** If useCksum==0 it means this journal does not use checksums. Checksums |
| 891 | ** are not used in statement journals because statement journals do not |
| 892 | ** need to survive power failures. |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 893 | */ |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 894 | static int pager_playback_one_page(Pager *pPager, OsFile *jfd, int useCksum){ |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 895 | int rc; |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 896 | PgHdr *pPg; /* An existing page in the cache */ |
| 897 | Pgno pgno; /* The page number of a page in journal */ |
| 898 | u32 cksum; /* Checksum used for sanity checking */ |
drh | 90f5ecb | 2004-07-22 01:19:35 +0000 | [diff] [blame] | 899 | u8 aData[SQLITE_MAX_PAGE_SIZE]; /* Temp storage for a page */ |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 900 | |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 901 | rc = read32bits(jfd, &pgno); |
drh | 99ee360 | 2003-02-16 19:13:36 +0000 | [diff] [blame] | 902 | if( rc!=SQLITE_OK ) return rc; |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 903 | rc = sqlite3OsRead(jfd, &aData, pPager->pageSize); |
drh | 99ee360 | 2003-02-16 19:13:36 +0000 | [diff] [blame] | 904 | if( rc!=SQLITE_OK ) return rc; |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 905 | pPager->journalOff += pPager->pageSize + 4; |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 906 | |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 907 | /* Sanity checking on the page. This is more important that I originally |
| 908 | ** thought. If a power failure occurs while the journal is being written, |
| 909 | ** it could cause invalid data to be written into the journal. We need to |
| 910 | ** detect this invalid data (with high probability) and ignore it. |
| 911 | */ |
danielk1977 | 75edc16 | 2004-06-26 01:48:18 +0000 | [diff] [blame] | 912 | if( pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){ |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 913 | return SQLITE_DONE; |
| 914 | } |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 915 | if( pgno>(unsigned)pPager->dbSize ){ |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 916 | return SQLITE_OK; |
| 917 | } |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 918 | if( useCksum ){ |
| 919 | rc = read32bits(jfd, &cksum); |
drh | 99ee360 | 2003-02-16 19:13:36 +0000 | [diff] [blame] | 920 | if( rc ) return rc; |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 921 | pPager->journalOff += 4; |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 922 | if( pager_cksum(pPager, pgno, aData)!=cksum ){ |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 923 | return SQLITE_DONE; |
| 924 | } |
| 925 | } |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 926 | |
danielk1977 | aa5ccdf | 2004-06-14 05:10:42 +0000 | [diff] [blame] | 927 | assert( pPager->state==PAGER_RESERVED || pPager->state>=PAGER_EXCLUSIVE ); |
danielk1977 | a3f3a5f | 2004-06-10 04:32:16 +0000 | [diff] [blame] | 928 | |
| 929 | /* If the pager is in RESERVED state, then there must be a copy of this |
| 930 | ** page in the pager cache. In this case just update the pager cache, |
danielk1977 | 0de0bb3 | 2004-06-10 05:59:24 +0000 | [diff] [blame] | 931 | ** not the database file. The page is left marked dirty in this case. |
| 932 | ** |
danielk1977 | a3f3a5f | 2004-06-10 04:32:16 +0000 | [diff] [blame] | 933 | ** If in EXCLUSIVE state, then we update the pager cache if it exists |
| 934 | ** and the main file. The page is then marked not dirty. |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 935 | */ |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 936 | pPg = pager_lookup(pPager, pgno); |
danielk1977 | aa5ccdf | 2004-06-14 05:10:42 +0000 | [diff] [blame] | 937 | assert( pPager->state>=PAGER_EXCLUSIVE || pPg ); |
danielk1977 | ef73ee9 | 2004-11-06 12:26:07 +0000 | [diff] [blame] | 938 | TRACE3("PLAYBACK %d page %d\n", PAGERID(pPager), pgno); |
danielk1977 | aa5ccdf | 2004-06-14 05:10:42 +0000 | [diff] [blame] | 939 | if( pPager->state>=PAGER_EXCLUSIVE ){ |
drh | eb20625 | 2004-10-01 02:00:31 +0000 | [diff] [blame] | 940 | sqlite3OsSeek(&pPager->fd, (pgno-1)*(i64)pPager->pageSize); |
drh | 90f5ecb | 2004-07-22 01:19:35 +0000 | [diff] [blame] | 941 | rc = sqlite3OsWrite(&pPager->fd, aData, pPager->pageSize); |
danielk1977 | a3f3a5f | 2004-06-10 04:32:16 +0000 | [diff] [blame] | 942 | } |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 943 | if( pPg ){ |
danielk1977 | 2812956 | 2005-01-11 10:25:06 +0000 | [diff] [blame] | 944 | /* No page should ever be explicitly rolled back that is in use, except |
| 945 | ** for page 1 which is held in use in order to keep the lock on the |
| 946 | ** database active. However such a page may be rolled back as a result |
| 947 | ** of an internal error resulting in an automatic call to |
| 948 | ** sqlite3pager_rollback(). |
drh | acf4ac9 | 2003-12-17 23:57:34 +0000 | [diff] [blame] | 949 | */ |
drh | b6f4148 | 2004-05-14 01:58:11 +0000 | [diff] [blame] | 950 | void *pData; |
danielk1977 | 2812956 | 2005-01-11 10:25:06 +0000 | [diff] [blame] | 951 | /* assert( pPg->nRef==0 || pPg->pgno==1 ); */ |
drh | b6f4148 | 2004-05-14 01:58:11 +0000 | [diff] [blame] | 952 | pData = PGHDR_TO_DATA(pPg); |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 953 | memcpy(pData, aData, pPager->pageSize); |
drh | 726de59 | 2004-06-10 23:35:50 +0000 | [diff] [blame] | 954 | if( pPager->xDestructor ){ /*** FIX ME: Should this be xReinit? ***/ |
drh | b6f4148 | 2004-05-14 01:58:11 +0000 | [diff] [blame] | 955 | pPager->xDestructor(pData, pPager->pageSize); |
drh | de64713 | 2004-05-07 17:57:49 +0000 | [diff] [blame] | 956 | } |
danielk1977 | aa5ccdf | 2004-06-14 05:10:42 +0000 | [diff] [blame] | 957 | if( pPager->state>=PAGER_EXCLUSIVE ){ |
danielk1977 | 0de0bb3 | 2004-06-10 05:59:24 +0000 | [diff] [blame] | 958 | pPg->dirty = 0; |
| 959 | pPg->needSync = 0; |
| 960 | } |
drh | b6f4148 | 2004-05-14 01:58:11 +0000 | [diff] [blame] | 961 | CODEC(pPager, pData, pPg->pgno, 3); |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 962 | } |
| 963 | return rc; |
| 964 | } |
| 965 | |
| 966 | /* |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 967 | ** Parameter zMaster is the name of a master journal file. A single journal |
| 968 | ** file that referred to the master journal file has just been rolled back. |
| 969 | ** This routine checks if it is possible to delete the master journal file, |
| 970 | ** and does so if it is. |
drh | 726de59 | 2004-06-10 23:35:50 +0000 | [diff] [blame] | 971 | ** |
| 972 | ** The master journal file contains the names of all child journals. |
| 973 | ** To tell if a master journal can be deleted, check to each of the |
| 974 | ** children. If all children are either missing or do not refer to |
| 975 | ** a different master journal, then this master journal can be deleted. |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 976 | */ |
| 977 | static int pager_delmaster(const char *zMaster){ |
| 978 | int rc; |
| 979 | int master_open = 0; |
| 980 | OsFile master; |
| 981 | char *zMasterJournal = 0; /* Contents of master journal file */ |
drh | eb20625 | 2004-10-01 02:00:31 +0000 | [diff] [blame] | 982 | i64 nMasterJournal; /* Size of master journal file */ |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 983 | |
| 984 | /* Open the master journal file exclusively in case some other process |
| 985 | ** is running this routine also. Not that it makes too much difference. |
| 986 | */ |
drh | da71ce1 | 2004-06-21 18:14:45 +0000 | [diff] [blame] | 987 | memset(&master, 0, sizeof(master)); |
danielk1977 | 8191bff | 2004-06-28 04:52:30 +0000 | [diff] [blame] | 988 | rc = sqlite3OsOpenReadOnly(zMaster, &master); |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 989 | if( rc!=SQLITE_OK ) goto delmaster_out; |
| 990 | master_open = 1; |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 991 | rc = sqlite3OsFileSize(&master, &nMasterJournal); |
| 992 | if( rc!=SQLITE_OK ) goto delmaster_out; |
| 993 | |
| 994 | if( nMasterJournal>0 ){ |
danielk1977 | 5865e3d | 2004-06-14 06:03:57 +0000 | [diff] [blame] | 995 | char *zJournal; |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 996 | char *zMasterPtr = 0; |
danielk1977 | 5865e3d | 2004-06-14 06:03:57 +0000 | [diff] [blame] | 997 | |
| 998 | /* Load the entire master journal file into space obtained from |
| 999 | ** sqliteMalloc() and pointed to by zMasterJournal. |
danielk1977 | 5865e3d | 2004-06-14 06:03:57 +0000 | [diff] [blame] | 1000 | */ |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1001 | zMasterJournal = (char *)sqliteMalloc(nMasterJournal); |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 1002 | if( !zMasterJournal ){ |
| 1003 | rc = SQLITE_NOMEM; |
| 1004 | goto delmaster_out; |
| 1005 | } |
| 1006 | rc = sqlite3OsRead(&master, zMasterJournal, nMasterJournal); |
| 1007 | if( rc!=SQLITE_OK ) goto delmaster_out; |
| 1008 | |
danielk1977 | 5865e3d | 2004-06-14 06:03:57 +0000 | [diff] [blame] | 1009 | zJournal = zMasterJournal; |
| 1010 | while( (zJournal-zMasterJournal)<nMasterJournal ){ |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 1011 | if( sqlite3OsFileExists(zJournal) ){ |
| 1012 | /* One of the journals pointed to by the master journal exists. |
| 1013 | ** Open it and check if it points at the master journal. If |
| 1014 | ** so, return without deleting the master journal file. |
| 1015 | */ |
| 1016 | OsFile journal; |
drh | 3b7b78b | 2004-11-24 01:16:43 +0000 | [diff] [blame] | 1017 | int c; |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 1018 | |
drh | da71ce1 | 2004-06-21 18:14:45 +0000 | [diff] [blame] | 1019 | memset(&journal, 0, sizeof(journal)); |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 1020 | rc = sqlite3OsOpenReadOnly(zJournal, &journal); |
| 1021 | if( rc!=SQLITE_OK ){ |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 1022 | goto delmaster_out; |
| 1023 | } |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 1024 | |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1025 | rc = readMasterJournal(&journal, &zMasterPtr); |
| 1026 | sqlite3OsClose(&journal); |
danielk1977 | 9eed505 | 2004-06-04 10:38:30 +0000 | [diff] [blame] | 1027 | if( rc!=SQLITE_OK ){ |
danielk1977 | 9eed505 | 2004-06-04 10:38:30 +0000 | [diff] [blame] | 1028 | goto delmaster_out; |
| 1029 | } |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1030 | |
drh | 3b7b78b | 2004-11-24 01:16:43 +0000 | [diff] [blame] | 1031 | c = zMasterPtr!=0 && strcmp(zMasterPtr, zMaster)==0; |
| 1032 | sqliteFree(zMasterPtr); |
| 1033 | if( c ){ |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1034 | /* We have a match. Do not delete the master journal file. */ |
| 1035 | goto delmaster_out; |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 1036 | } |
| 1037 | } |
danielk1977 | 5865e3d | 2004-06-14 06:03:57 +0000 | [diff] [blame] | 1038 | zJournal += (strlen(zJournal)+1); |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 1039 | } |
| 1040 | } |
| 1041 | |
| 1042 | sqlite3OsDelete(zMaster); |
| 1043 | |
| 1044 | delmaster_out: |
| 1045 | if( zMasterJournal ){ |
| 1046 | sqliteFree(zMasterJournal); |
| 1047 | } |
| 1048 | if( master_open ){ |
| 1049 | sqlite3OsClose(&master); |
| 1050 | } |
| 1051 | return rc; |
| 1052 | } |
| 1053 | |
| 1054 | /* |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 1055 | ** Make every page in the cache agree with what is on disk. In other words, |
| 1056 | ** reread the disk to reset the state of the cache. |
| 1057 | ** |
| 1058 | ** This routine is called after a rollback in which some of the dirty cache |
| 1059 | ** pages had never been written out to disk. We need to roll back the |
| 1060 | ** cache content and the easiest way to do that is to reread the old content |
| 1061 | ** back from the disk. |
| 1062 | */ |
| 1063 | static int pager_reload_cache(Pager *pPager){ |
| 1064 | PgHdr *pPg; |
| 1065 | int rc = SQLITE_OK; |
| 1066 | for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){ |
drh | 90f5ecb | 2004-07-22 01:19:35 +0000 | [diff] [blame] | 1067 | char zBuf[SQLITE_MAX_PAGE_SIZE]; |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 1068 | if( !pPg->dirty ) continue; |
| 1069 | if( (int)pPg->pgno <= pPager->origDbSize ){ |
drh | eb20625 | 2004-10-01 02:00:31 +0000 | [diff] [blame] | 1070 | sqlite3OsSeek(&pPager->fd, pPager->pageSize*(i64)(pPg->pgno-1)); |
drh | 90f5ecb | 2004-07-22 01:19:35 +0000 | [diff] [blame] | 1071 | rc = sqlite3OsRead(&pPager->fd, zBuf, pPager->pageSize); |
danielk1977 | ef73ee9 | 2004-11-06 12:26:07 +0000 | [diff] [blame] | 1072 | TRACE3("REFETCH %d page %d\n", PAGERID(pPager), pPg->pgno); |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 1073 | if( rc ) break; |
drh | 25d6543 | 2004-07-22 15:02:25 +0000 | [diff] [blame] | 1074 | CODEC(pPager, zBuf, pPg->pgno, 2); |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 1075 | }else{ |
drh | 90f5ecb | 2004-07-22 01:19:35 +0000 | [diff] [blame] | 1076 | memset(zBuf, 0, pPager->pageSize); |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 1077 | } |
drh | 90f5ecb | 2004-07-22 01:19:35 +0000 | [diff] [blame] | 1078 | if( pPg->nRef==0 || memcmp(zBuf, PGHDR_TO_DATA(pPg), pPager->pageSize) ){ |
| 1079 | memcpy(PGHDR_TO_DATA(pPg), zBuf, pPager->pageSize); |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 1080 | if( pPager->xReiniter ){ |
| 1081 | pPager->xReiniter(PGHDR_TO_DATA(pPg), pPager->pageSize); |
| 1082 | }else{ |
drh | 90f5ecb | 2004-07-22 01:19:35 +0000 | [diff] [blame] | 1083 | memset(PGHDR_TO_EXTRA(pPg, pPager), 0, pPager->nExtra); |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 1084 | } |
| 1085 | } |
| 1086 | pPg->needSync = 0; |
| 1087 | pPg->dirty = 0; |
| 1088 | } |
| 1089 | return rc; |
| 1090 | } |
| 1091 | |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 1092 | /* |
drh | cb4c40b | 2004-08-18 19:09:43 +0000 | [diff] [blame] | 1093 | ** Truncate the main file of the given pager to the number of pages |
| 1094 | ** indicated. |
| 1095 | */ |
| 1096 | static int pager_truncate(Pager *pPager, int nPage){ |
drh | eb20625 | 2004-10-01 02:00:31 +0000 | [diff] [blame] | 1097 | return sqlite3OsTruncate(&pPager->fd, pPager->pageSize*(i64)nPage); |
drh | cb4c40b | 2004-08-18 19:09:43 +0000 | [diff] [blame] | 1098 | } |
| 1099 | |
| 1100 | /* |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1101 | ** Playback the journal and thus restore the database file to |
| 1102 | ** the state it was in before we started making changes. |
| 1103 | ** |
drh | 34e79ce | 2004-02-08 06:05:46 +0000 | [diff] [blame] | 1104 | ** The journal file format is as follows: |
| 1105 | ** |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 1106 | ** (1) 8 byte prefix. A copy of aJournalMagic[]. |
| 1107 | ** (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] | 1108 | ** in the journal. If this value is 0xffffffff, then compute the |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 1109 | ** number of page records from the journal size. |
| 1110 | ** (3) 4 byte big-endian integer which is the initial value for the |
| 1111 | ** sanity checksum. |
| 1112 | ** (4) 4 byte integer which is the number of pages to truncate the |
drh | 34e79ce | 2004-02-08 06:05:46 +0000 | [diff] [blame] | 1113 | ** database to during a rollback. |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 1114 | ** (5) 4 byte integer which is the number of bytes in the master journal |
| 1115 | ** name. The value may be zero (indicate that there is no master |
| 1116 | ** journal.) |
| 1117 | ** (6) N bytes of the master journal name. The name will be nul-terminated |
| 1118 | ** and might be shorter than the value read from (5). If the first byte |
| 1119 | ** of the name is \000 then there is no master journal. The master |
| 1120 | ** journal name is stored in UTF-8. |
| 1121 | ** (7) Zero or more pages instances, each as follows: |
drh | 34e79ce | 2004-02-08 06:05:46 +0000 | [diff] [blame] | 1122 | ** + 4 byte page number. |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 1123 | ** + pPager->pageSize bytes of data. |
| 1124 | ** + 4 byte checksum |
drh | 34e79ce | 2004-02-08 06:05:46 +0000 | [diff] [blame] | 1125 | ** |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 1126 | ** When we speak of the journal header, we mean the first 6 items above. |
| 1127 | ** Each entry in the journal is an instance of the 7th item. |
drh | 34e79ce | 2004-02-08 06:05:46 +0000 | [diff] [blame] | 1128 | ** |
| 1129 | ** Call the value from the second bullet "nRec". nRec is the number of |
| 1130 | ** valid page entries in the journal. In most cases, you can compute the |
| 1131 | ** value of nRec from the size of the journal file. But if a power |
| 1132 | ** failure occurred while the journal was being written, it could be the |
| 1133 | ** case that the size of the journal file had already been increased but |
| 1134 | ** the extra entries had not yet made it safely to disk. In such a case, |
| 1135 | ** the value of nRec computed from the file size would be too large. For |
| 1136 | ** that reason, we always use the nRec value in the header. |
| 1137 | ** |
| 1138 | ** If the nRec value is 0xffffffff it means that nRec should be computed |
| 1139 | ** from the file size. This value is used when the user selects the |
| 1140 | ** no-sync option for the journal. A power failure could lead to corruption |
| 1141 | ** in this case. But for things like temporary table (which will be |
| 1142 | ** deleted when the power is restored) we don't care. |
| 1143 | ** |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 1144 | ** If the file opened as the journal file is not a well-formed |
danielk1977 | ece80f1 | 2004-06-23 01:05:26 +0000 | [diff] [blame] | 1145 | ** journal file then all pages up to the first corrupted page are rolled |
| 1146 | ** back (or no pages if the journal header is corrupted). The journal file |
| 1147 | ** is then deleted and SQLITE_OK returned, just as if no corruption had |
| 1148 | ** been encountered. |
| 1149 | ** |
| 1150 | ** If an I/O or malloc() error occurs, the journal-file is not deleted |
| 1151 | ** and an error code is returned. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1152 | */ |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1153 | static int pager_playback(Pager *pPager){ |
drh | eb20625 | 2004-10-01 02:00:31 +0000 | [diff] [blame] | 1154 | i64 szJ; /* Size of the journal file in bytes */ |
danielk1977 | c3e8f5e | 2004-06-28 01:16:46 +0000 | [diff] [blame] | 1155 | u32 nRec; /* Number of Records in the journal */ |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 1156 | int i; /* Loop counter */ |
| 1157 | Pgno mxPg = 0; /* Size of the original file in pages */ |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 1158 | int rc; /* Result code of a subroutine */ |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 1159 | char *zMaster = 0; /* Name of master journal file if any */ |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1160 | |
drh | c3a64ba | 2001-11-22 00:01:27 +0000 | [diff] [blame] | 1161 | /* Figure out how many records are in the journal. Abort early if |
| 1162 | ** the journal is empty. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1163 | */ |
drh | 8cfbf08 | 2001-09-19 13:22:39 +0000 | [diff] [blame] | 1164 | assert( pPager->journalOpen ); |
danielk1977 | 4adee20 | 2004-05-08 08:23:19 +0000 | [diff] [blame] | 1165 | rc = sqlite3OsFileSize(&pPager->jfd, &szJ); |
drh | c3a64ba | 2001-11-22 00:01:27 +0000 | [diff] [blame] | 1166 | if( rc!=SQLITE_OK ){ |
| 1167 | goto end_playback; |
| 1168 | } |
drh | 240c579 | 2004-02-08 00:40:52 +0000 | [diff] [blame] | 1169 | |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1170 | /* Read the master journal name from the journal, if it is present. |
| 1171 | ** If a master journal file name is specified, but the file is not |
| 1172 | ** present on disk, then the journal is not hot and does not need to be |
| 1173 | ** played back. |
drh | 240c579 | 2004-02-08 00:40:52 +0000 | [diff] [blame] | 1174 | */ |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1175 | rc = readMasterJournal(&pPager->jfd, &zMaster); |
| 1176 | assert( rc!=SQLITE_DONE ); |
| 1177 | if( rc!=SQLITE_OK || (zMaster && !sqlite3OsFileExists(zMaster)) ){ |
| 1178 | sqliteFree(zMaster); |
| 1179 | zMaster = 0; |
| 1180 | if( rc==SQLITE_DONE ) rc = SQLITE_OK; |
drh | c3a64ba | 2001-11-22 00:01:27 +0000 | [diff] [blame] | 1181 | goto end_playback; |
| 1182 | } |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1183 | sqlite3OsSeek(&pPager->jfd, 0); |
| 1184 | pPager->journalOff = 0; |
drh | c3a64ba | 2001-11-22 00:01:27 +0000 | [diff] [blame] | 1185 | |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1186 | /* This loop terminates either when the readJournalHdr() call returns |
| 1187 | ** SQLITE_DONE or an IO error occurs. */ |
| 1188 | while( 1 ){ |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 1189 | |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1190 | /* Read the next journal header from the journal file. If there are |
| 1191 | ** not enough bytes left in the journal file for a complete header, or |
| 1192 | ** it is corrupted, then a process must of failed while writing it. |
| 1193 | ** This indicates nothing more needs to be rolled back. |
| 1194 | */ |
| 1195 | rc = readJournalHdr(pPager, szJ, &nRec, &mxPg); |
| 1196 | if( rc!=SQLITE_OK ){ |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 1197 | if( rc==SQLITE_DONE ){ |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 1198 | rc = SQLITE_OK; |
| 1199 | } |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1200 | goto end_playback; |
| 1201 | } |
| 1202 | |
| 1203 | /* If nRec is 0xffffffff, then this journal was created by a process |
| 1204 | ** working in no-sync mode. This means that the rest of the journal |
| 1205 | ** file consists of pages, there are no more journal headers. Compute |
| 1206 | ** the value of nRec based on this assumption. |
| 1207 | */ |
| 1208 | if( nRec==0xffffffff ){ |
| 1209 | assert( pPager->journalOff==JOURNAL_HDR_SZ(pPager) ); |
| 1210 | nRec = (szJ - JOURNAL_HDR_SZ(pPager))/JOURNAL_PG_SZ(pPager); |
| 1211 | } |
| 1212 | |
| 1213 | /* If this is the first header read from the journal, truncate the |
| 1214 | ** database file back to it's original size. |
| 1215 | */ |
| 1216 | if( pPager->journalOff==JOURNAL_HDR_SZ(pPager) ){ |
| 1217 | assert( pPager->origDbSize==0 || pPager->origDbSize==mxPg ); |
drh | cb4c40b | 2004-08-18 19:09:43 +0000 | [diff] [blame] | 1218 | rc = pager_truncate(pPager, mxPg); |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1219 | if( rc!=SQLITE_OK ){ |
| 1220 | goto end_playback; |
| 1221 | } |
| 1222 | pPager->dbSize = mxPg; |
| 1223 | } |
| 1224 | |
| 1225 | /* rc = sqlite3OsSeek(&pPager->jfd, JOURNAL_HDR_SZ(pPager)); */ |
| 1226 | if( rc!=SQLITE_OK ) goto end_playback; |
| 1227 | |
| 1228 | /* Copy original pages out of the journal and back into the database file. |
| 1229 | */ |
| 1230 | for(i=0; i<nRec; i++){ |
| 1231 | rc = pager_playback_one_page(pPager, &pPager->jfd, 1); |
| 1232 | if( rc!=SQLITE_OK ){ |
| 1233 | if( rc==SQLITE_DONE ){ |
| 1234 | rc = SQLITE_OK; |
| 1235 | pPager->journalOff = szJ; |
| 1236 | break; |
| 1237 | }else{ |
| 1238 | goto end_playback; |
| 1239 | } |
| 1240 | } |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 1241 | } |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1242 | } |
drh | 81a20f2 | 2001-10-12 17:30:04 +0000 | [diff] [blame] | 1243 | |
drh | 4a0681e | 2003-02-13 01:58:20 +0000 | [diff] [blame] | 1244 | /* Pages that have been written to the journal but never synced |
| 1245 | ** where not restored by the loop above. We have to restore those |
drh | 240c579 | 2004-02-08 00:40:52 +0000 | [diff] [blame] | 1246 | ** pages by reading them back from the original database. |
drh | db48ee0 | 2003-01-16 13:42:43 +0000 | [diff] [blame] | 1247 | */ |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1248 | assert( rc==SQLITE_OK ); |
| 1249 | pager_reload_cache(pPager); |
drh | 4a0681e | 2003-02-13 01:58:20 +0000 | [diff] [blame] | 1250 | |
| 1251 | end_playback: |
danielk1977 | 8191bff | 2004-06-28 04:52:30 +0000 | [diff] [blame] | 1252 | if( rc==SQLITE_OK ){ |
| 1253 | rc = pager_unwritelock(pPager); |
| 1254 | } |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 1255 | if( zMaster ){ |
| 1256 | /* If there was a master journal and this routine will return true, |
| 1257 | ** see if it is possible to delete the master journal. If errors |
| 1258 | ** occur during this process, ignore them. |
| 1259 | */ |
| 1260 | if( rc==SQLITE_OK ){ |
| 1261 | pager_delmaster(zMaster); |
| 1262 | } |
| 1263 | sqliteFree(zMaster); |
| 1264 | } |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1265 | |
| 1266 | /* The Pager.sectorSize variable may have been updated while rolling |
| 1267 | ** back a journal created by a process with a different PAGER_SECTOR_SIZE |
| 1268 | ** value. Reset it to the correct value for this process. |
| 1269 | */ |
| 1270 | pPager->sectorSize = PAGER_SECTOR_SIZE; |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 1271 | return rc; |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1272 | } |
| 1273 | |
| 1274 | /* |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 1275 | ** Playback the statement journal. |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1276 | ** |
| 1277 | ** This is similar to playing back the transaction journal but with |
| 1278 | ** a few extra twists. |
| 1279 | ** |
drh | 663fc63 | 2002-02-02 18:49:19 +0000 | [diff] [blame] | 1280 | ** (1) The number of pages in the database file at the start of |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 1281 | ** the statement is stored in pPager->stmtSize, not in the |
drh | 663fc63 | 2002-02-02 18:49:19 +0000 | [diff] [blame] | 1282 | ** journal file itself. |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1283 | ** |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 1284 | ** (2) In addition to playing back the statement journal, also |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1285 | ** playback all pages of the transaction journal beginning |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 1286 | ** at offset pPager->stmtJSize. |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1287 | */ |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 1288 | static int pager_stmt_playback(Pager *pPager){ |
drh | eb20625 | 2004-10-01 02:00:31 +0000 | [diff] [blame] | 1289 | i64 szJ; /* Size of the full journal */ |
| 1290 | i64 hdrOff; |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 1291 | int nRec; /* Number of Records */ |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1292 | int i; /* Loop counter */ |
| 1293 | int rc; |
| 1294 | |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1295 | szJ = pPager->journalOff; |
| 1296 | #ifndef NDEBUG |
| 1297 | { |
drh | eb20625 | 2004-10-01 02:00:31 +0000 | [diff] [blame] | 1298 | i64 os_szJ; |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1299 | rc = sqlite3OsFileSize(&pPager->jfd, &os_szJ); |
| 1300 | if( rc!=SQLITE_OK ) return rc; |
| 1301 | assert( szJ==os_szJ ); |
| 1302 | } |
| 1303 | #endif |
| 1304 | |
| 1305 | /* Set hdrOff to be the offset to the first journal header written |
| 1306 | ** this statement transaction, or the end of the file if no journal |
| 1307 | ** header was written. |
| 1308 | */ |
| 1309 | hdrOff = pPager->stmtHdrOff; |
| 1310 | assert( pPager->fullSync || !hdrOff ); |
| 1311 | if( !hdrOff ){ |
| 1312 | hdrOff = szJ; |
| 1313 | } |
| 1314 | |
| 1315 | |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1316 | /* Truncate the database back to its original size. |
| 1317 | */ |
drh | cb4c40b | 2004-08-18 19:09:43 +0000 | [diff] [blame] | 1318 | rc = pager_truncate(pPager, pPager->stmtSize); |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 1319 | pPager->dbSize = pPager->stmtSize; |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1320 | |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 1321 | /* Figure out how many records are in the statement journal. |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1322 | */ |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 1323 | assert( pPager->stmtInUse && pPager->journalOpen ); |
| 1324 | sqlite3OsSeek(&pPager->stfd, 0); |
| 1325 | nRec = pPager->stmtNRec; |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1326 | |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 1327 | /* Copy original pages out of the statement journal and back into the |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 1328 | ** database file. Note that the statement journal omits checksums from |
| 1329 | ** each record since power-failure recovery is not important to statement |
| 1330 | ** journals. |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1331 | */ |
| 1332 | for(i=nRec-1; i>=0; i--){ |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 1333 | rc = pager_playback_one_page(pPager, &pPager->stfd, 0); |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 1334 | assert( rc!=SQLITE_DONE ); |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 1335 | if( rc!=SQLITE_OK ) goto end_stmt_playback; |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1336 | } |
| 1337 | |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1338 | /* Now roll some pages back from the transaction journal. Pager.stmtJSize |
| 1339 | ** was the size of the journal file when this statement was started, so |
| 1340 | ** everything after that needs to be rolled back, either into the |
| 1341 | ** database, the memory cache, or both. |
| 1342 | ** |
| 1343 | ** If it is not zero, then Pager.stmtHdrOff is the offset to the start |
| 1344 | ** of the first journal header written during this statement transaction. |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1345 | */ |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 1346 | rc = sqlite3OsSeek(&pPager->jfd, pPager->stmtJSize); |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1347 | if( rc!=SQLITE_OK ){ |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 1348 | goto end_stmt_playback; |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1349 | } |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1350 | pPager->journalOff = pPager->stmtJSize; |
danielk1977 | 75edc16 | 2004-06-26 01:48:18 +0000 | [diff] [blame] | 1351 | pPager->cksumInit = pPager->stmtCksum; |
| 1352 | assert( JOURNAL_HDR_SZ(pPager)<(pPager->pageSize+8) ); |
| 1353 | while( pPager->journalOff <= (hdrOff-(pPager->pageSize+8)) ){ |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 1354 | rc = pager_playback_one_page(pPager, &pPager->jfd, 1); |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1355 | assert( rc!=SQLITE_DONE ); |
| 1356 | if( rc!=SQLITE_OK ) goto end_stmt_playback; |
| 1357 | } |
| 1358 | |
| 1359 | while( pPager->journalOff < szJ ){ |
| 1360 | u32 nRec; |
| 1361 | u32 dummy; |
| 1362 | rc = readJournalHdr(pPager, szJ, &nRec, &dummy); |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 1363 | if( rc!=SQLITE_OK ){ |
| 1364 | assert( rc!=SQLITE_DONE ); |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 1365 | goto end_stmt_playback; |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 1366 | } |
danielk1977 | 75edc16 | 2004-06-26 01:48:18 +0000 | [diff] [blame] | 1367 | if( nRec==0 ){ |
| 1368 | nRec = (szJ - pPager->journalOff) / (pPager->pageSize+8); |
| 1369 | } |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1370 | for(i=nRec-1; i>=0 && pPager->journalOff < szJ; i--){ |
| 1371 | rc = pager_playback_one_page(pPager, &pPager->jfd, 1); |
| 1372 | assert( rc!=SQLITE_DONE ); |
| 1373 | if( rc!=SQLITE_OK ) goto end_stmt_playback; |
| 1374 | } |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1375 | } |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1376 | |
| 1377 | pPager->journalOff = szJ; |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1378 | |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 1379 | end_stmt_playback: |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1380 | if( rc!=SQLITE_OK ){ |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1381 | pPager->errMask |= PAGER_ERR_CORRUPT; |
drh | ee696e2 | 2004-08-30 16:52:17 +0000 | [diff] [blame] | 1382 | rc = SQLITE_CORRUPT; /* bkpt-CORRUPT */ |
danielk1977 | 75edc16 | 2004-06-26 01:48:18 +0000 | [diff] [blame] | 1383 | }else{ |
| 1384 | pPager->journalOff = szJ; |
| 1385 | /* pager_reload_cache(pPager); */ |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1386 | } |
| 1387 | return rc; |
| 1388 | } |
| 1389 | |
| 1390 | /* |
drh | f57b14a | 2001-09-14 18:54:08 +0000 | [diff] [blame] | 1391 | ** Change the maximum number of in-memory pages that are allowed. |
drh | cd61c28 | 2002-03-06 22:01:34 +0000 | [diff] [blame] | 1392 | ** |
| 1393 | ** The maximum number is the absolute value of the mxPage parameter. |
| 1394 | ** If mxPage is negative, the noSync flag is also set. noSync bypasses |
danielk1977 | 4adee20 | 2004-05-08 08:23:19 +0000 | [diff] [blame] | 1395 | ** calls to sqlite3OsSync(). The pager runs much faster with noSync on, |
drh | cd61c28 | 2002-03-06 22:01:34 +0000 | [diff] [blame] | 1396 | ** but if the operating system crashes or there is an abrupt power |
| 1397 | ** failure, the database file might be left in an inconsistent and |
| 1398 | ** unrepairable state. |
drh | f57b14a | 2001-09-14 18:54:08 +0000 | [diff] [blame] | 1399 | */ |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 1400 | void sqlite3pager_set_cachesize(Pager *pPager, int mxPage){ |
drh | 603240c | 2002-03-05 01:11:12 +0000 | [diff] [blame] | 1401 | if( mxPage>=0 ){ |
drh | a168045 | 2002-04-18 01:56:57 +0000 | [diff] [blame] | 1402 | pPager->noSync = pPager->tempFile; |
danielk1977 | 1d850a7 | 2004-05-31 08:26:49 +0000 | [diff] [blame] | 1403 | if( pPager->noSync ) pPager->needSync = 0; |
drh | 603240c | 2002-03-05 01:11:12 +0000 | [diff] [blame] | 1404 | }else{ |
| 1405 | pPager->noSync = 1; |
| 1406 | mxPage = -mxPage; |
| 1407 | } |
drh | f57b14a | 2001-09-14 18:54:08 +0000 | [diff] [blame] | 1408 | if( mxPage>10 ){ |
| 1409 | pPager->mxPage = mxPage; |
danielk1977 | ef317ab | 2004-06-23 10:43:10 +0000 | [diff] [blame] | 1410 | }else{ |
| 1411 | pPager->mxPage = 10; |
drh | f57b14a | 2001-09-14 18:54:08 +0000 | [diff] [blame] | 1412 | } |
| 1413 | } |
| 1414 | |
| 1415 | /* |
drh | 973b6e3 | 2003-02-12 14:09:42 +0000 | [diff] [blame] | 1416 | ** Adjust the robustness of the database to damage due to OS crashes |
| 1417 | ** or power failures by changing the number of syncs()s when writing |
| 1418 | ** the rollback journal. There are three levels: |
| 1419 | ** |
danielk1977 | 4adee20 | 2004-05-08 08:23:19 +0000 | [diff] [blame] | 1420 | ** OFF sqlite3OsSync() is never called. This is the default |
drh | 973b6e3 | 2003-02-12 14:09:42 +0000 | [diff] [blame] | 1421 | ** for temporary and transient files. |
| 1422 | ** |
| 1423 | ** NORMAL The journal is synced once before writes begin on the |
| 1424 | ** database. This is normally adequate protection, but |
| 1425 | ** it is theoretically possible, though very unlikely, |
| 1426 | ** that an inopertune power failure could leave the journal |
| 1427 | ** in a state which would cause damage to the database |
| 1428 | ** when it is rolled back. |
| 1429 | ** |
| 1430 | ** FULL The journal is synced twice before writes begin on the |
drh | 34e79ce | 2004-02-08 06:05:46 +0000 | [diff] [blame] | 1431 | ** database (with some additional information - the nRec field |
| 1432 | ** of the journal header - being written in between the two |
| 1433 | ** syncs). If we assume that writing a |
drh | 973b6e3 | 2003-02-12 14:09:42 +0000 | [diff] [blame] | 1434 | ** single disk sector is atomic, then this mode provides |
| 1435 | ** assurance that the journal will not be corrupted to the |
| 1436 | ** point of causing damage to the database during rollback. |
| 1437 | ** |
| 1438 | ** Numeric values associated with these states are OFF==1, NORMAL=2, |
| 1439 | ** and FULL=3. |
| 1440 | */ |
danielk1977 | 93758c8 | 2005-01-21 08:13:14 +0000 | [diff] [blame^] | 1441 | #ifndef SQLITE_OMIT_PAGER_PRAGMAS |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 1442 | void sqlite3pager_set_safety_level(Pager *pPager, int level){ |
drh | 973b6e3 | 2003-02-12 14:09:42 +0000 | [diff] [blame] | 1443 | pPager->noSync = level==1 || pPager->tempFile; |
| 1444 | pPager->fullSync = level==3 && !pPager->tempFile; |
danielk1977 | 1d850a7 | 2004-05-31 08:26:49 +0000 | [diff] [blame] | 1445 | if( pPager->noSync ) pPager->needSync = 0; |
drh | 973b6e3 | 2003-02-12 14:09:42 +0000 | [diff] [blame] | 1446 | } |
danielk1977 | 93758c8 | 2005-01-21 08:13:14 +0000 | [diff] [blame^] | 1447 | #endif |
drh | 973b6e3 | 2003-02-12 14:09:42 +0000 | [diff] [blame] | 1448 | |
| 1449 | /* |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1450 | ** Open a temporary file. Write the name of the file into zName |
| 1451 | ** (zName must be at least SQLITE_TEMPNAME_SIZE bytes long.) Write |
| 1452 | ** the file descriptor into *fd. Return SQLITE_OK on success or some |
| 1453 | ** other error code if we fail. |
| 1454 | ** |
| 1455 | ** The OS will automatically delete the temporary file when it is |
| 1456 | ** closed. |
| 1457 | */ |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 1458 | static int sqlite3pager_opentemp(char *zFile, OsFile *fd){ |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1459 | int cnt = 8; |
| 1460 | int rc; |
| 1461 | do{ |
| 1462 | cnt--; |
danielk1977 | 4adee20 | 2004-05-08 08:23:19 +0000 | [diff] [blame] | 1463 | sqlite3OsTempFileName(zFile); |
| 1464 | rc = sqlite3OsOpenExclusive(zFile, fd, 1); |
danielk1977 | 1307393 | 2004-06-30 11:54:06 +0000 | [diff] [blame] | 1465 | }while( cnt>0 && rc!=SQLITE_OK && rc!=SQLITE_NOMEM ); |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1466 | return rc; |
| 1467 | } |
| 1468 | |
| 1469 | /* |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1470 | ** 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] | 1471 | ** The file to be cached need not exist. The file is not locked until |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 1472 | ** the first call to sqlite3pager_get() and is only held open until the |
| 1473 | ** last page is released using sqlite3pager_unref(). |
drh | 382c024 | 2001-10-06 16:33:02 +0000 | [diff] [blame] | 1474 | ** |
drh | 6446c4d | 2001-12-15 14:22:18 +0000 | [diff] [blame] | 1475 | ** If zFilename is NULL then a randomly-named temporary file is created |
| 1476 | ** and used as the file to be cached. The file will be deleted |
| 1477 | ** automatically when it is closed. |
drh | 90f5ecb | 2004-07-22 01:19:35 +0000 | [diff] [blame] | 1478 | ** |
| 1479 | ** If zFilename is ":memory:" then all information is held in cache. |
| 1480 | ** It is never written to disk. This can be used to implement an |
| 1481 | ** in-memory database. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1482 | */ |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 1483 | int sqlite3pager_open( |
drh | 7e3b0a0 | 2001-04-28 16:52:40 +0000 | [diff] [blame] | 1484 | Pager **ppPager, /* Return the Pager structure here */ |
| 1485 | const char *zFilename, /* Name of the database file to open */ |
drh | da47d77 | 2002-12-02 04:25:19 +0000 | [diff] [blame] | 1486 | int nExtra, /* Extra bytes append to each in-memory page */ |
drh | 90f5ecb | 2004-07-22 01:19:35 +0000 | [diff] [blame] | 1487 | int useJournal /* TRUE to use a rollback journal on this file */ |
drh | 7e3b0a0 | 2001-04-28 16:52:40 +0000 | [diff] [blame] | 1488 | ){ |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1489 | Pager *pPager; |
danielk1977 | 8def5ea | 2004-06-16 10:39:52 +0000 | [diff] [blame] | 1490 | char *zFullPathname = 0; |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1491 | int nameLen; |
drh | 8cfbf08 | 2001-09-19 13:22:39 +0000 | [diff] [blame] | 1492 | OsFile fd; |
danielk1977 | cfe9a69 | 2004-06-16 12:00:29 +0000 | [diff] [blame] | 1493 | int rc = SQLITE_OK; |
| 1494 | int i; |
danielk1977 | 8def5ea | 2004-06-16 10:39:52 +0000 | [diff] [blame] | 1495 | int tempFile = 0; |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 1496 | int memDb = 0; |
drh | 5e00f6c | 2001-09-13 13:46:56 +0000 | [diff] [blame] | 1497 | int readOnly = 0; |
drh | 8cfbf08 | 2001-09-19 13:22:39 +0000 | [diff] [blame] | 1498 | char zTemp[SQLITE_TEMPNAME_SIZE]; |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1499 | |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 1500 | *ppPager = 0; |
drh | da71ce1 | 2004-06-21 18:14:45 +0000 | [diff] [blame] | 1501 | memset(&fd, 0, sizeof(fd)); |
danielk1977 | 6f8a503 | 2004-05-10 10:34:51 +0000 | [diff] [blame] | 1502 | if( sqlite3_malloc_failed ){ |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 1503 | return SQLITE_NOMEM; |
| 1504 | } |
drh | 901afd4 | 2003-08-26 11:25:58 +0000 | [diff] [blame] | 1505 | if( zFilename && zFilename[0] ){ |
drh | b7f9164 | 2004-10-31 02:22:47 +0000 | [diff] [blame] | 1506 | #ifndef SQLITE_OMIT_MEMORYDB |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 1507 | if( strcmp(zFilename,":memory:")==0 ){ |
| 1508 | memDb = 1; |
drh | da71ce1 | 2004-06-21 18:14:45 +0000 | [diff] [blame] | 1509 | zFullPathname = sqliteStrDup(""); |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 1510 | rc = SQLITE_OK; |
drh | b7f9164 | 2004-10-31 02:22:47 +0000 | [diff] [blame] | 1511 | }else |
| 1512 | #endif |
| 1513 | { |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 1514 | zFullPathname = sqlite3OsFullPathname(zFilename); |
danielk1977 | 8def5ea | 2004-06-16 10:39:52 +0000 | [diff] [blame] | 1515 | if( zFullPathname ){ |
| 1516 | rc = sqlite3OsOpenReadWrite(zFullPathname, &fd, &readOnly); |
| 1517 | } |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 1518 | } |
drh | 5e00f6c | 2001-09-13 13:46:56 +0000 | [diff] [blame] | 1519 | }else{ |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 1520 | rc = sqlite3pager_opentemp(zTemp, &fd); |
drh | 5e00f6c | 2001-09-13 13:46:56 +0000 | [diff] [blame] | 1521 | zFilename = zTemp; |
danielk1977 | 4adee20 | 2004-05-08 08:23:19 +0000 | [diff] [blame] | 1522 | zFullPathname = sqlite3OsFullPathname(zFilename); |
danielk1977 | 8def5ea | 2004-06-16 10:39:52 +0000 | [diff] [blame] | 1523 | if( rc==SQLITE_OK ){ |
| 1524 | tempFile = 1; |
| 1525 | } |
drh | 5e00f6c | 2001-09-13 13:46:56 +0000 | [diff] [blame] | 1526 | } |
danielk1977 | 8def5ea | 2004-06-16 10:39:52 +0000 | [diff] [blame] | 1527 | if( !zFullPathname ){ |
danielk1977 | b5548a8 | 2004-06-26 13:51:33 +0000 | [diff] [blame] | 1528 | sqlite3OsClose(&fd); |
drh | 3e7a609 | 2002-12-07 21:45:14 +0000 | [diff] [blame] | 1529 | return SQLITE_NOMEM; |
| 1530 | } |
drh | 8cfbf08 | 2001-09-19 13:22:39 +0000 | [diff] [blame] | 1531 | if( rc!=SQLITE_OK ){ |
drh | da71ce1 | 2004-06-21 18:14:45 +0000 | [diff] [blame] | 1532 | sqlite3OsClose(&fd); |
| 1533 | sqliteFree(zFullPathname); |
danielk1977 | 8def5ea | 2004-06-16 10:39:52 +0000 | [diff] [blame] | 1534 | return rc; |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1535 | } |
drh | 3e7a609 | 2002-12-07 21:45:14 +0000 | [diff] [blame] | 1536 | nameLen = strlen(zFullPathname); |
drh | a76c82e | 2003-07-27 18:59:42 +0000 | [diff] [blame] | 1537 | pPager = sqliteMalloc( sizeof(*pPager) + nameLen*3 + 30 ); |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 1538 | if( pPager==0 ){ |
drh | da71ce1 | 2004-06-21 18:14:45 +0000 | [diff] [blame] | 1539 | sqlite3OsClose(&fd); |
| 1540 | sqliteFree(zFullPathname); |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 1541 | return SQLITE_NOMEM; |
| 1542 | } |
danielk1977 | ef73ee9 | 2004-11-06 12:26:07 +0000 | [diff] [blame] | 1543 | TRACE3("OPEN %d %s\n", FILEHANDLEID(fd), zFullPathname); |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1544 | pPager->zFilename = (char*)&pPager[1]; |
drh | a76c82e | 2003-07-27 18:59:42 +0000 | [diff] [blame] | 1545 | pPager->zDirectory = &pPager->zFilename[nameLen+1]; |
| 1546 | pPager->zJournal = &pPager->zDirectory[nameLen+1]; |
drh | 3e7a609 | 2002-12-07 21:45:14 +0000 | [diff] [blame] | 1547 | strcpy(pPager->zFilename, zFullPathname); |
drh | a76c82e | 2003-07-27 18:59:42 +0000 | [diff] [blame] | 1548 | strcpy(pPager->zDirectory, zFullPathname); |
| 1549 | for(i=nameLen; i>0 && pPager->zDirectory[i-1]!='/'; i--){} |
| 1550 | if( i>0 ) pPager->zDirectory[i-1] = 0; |
drh | 3e7a609 | 2002-12-07 21:45:14 +0000 | [diff] [blame] | 1551 | strcpy(pPager->zJournal, zFullPathname); |
| 1552 | sqliteFree(zFullPathname); |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1553 | strcpy(&pPager->zJournal[nameLen], "-journal"); |
| 1554 | pPager->fd = fd; |
drh | 6d08b4d | 2004-07-20 12:45:22 +0000 | [diff] [blame] | 1555 | #if OS_UNIX |
drh | d5b447d | 2004-07-19 22:08:09 +0000 | [diff] [blame] | 1556 | pPager->fd.pPager = pPager; |
drh | 6d08b4d | 2004-07-20 12:45:22 +0000 | [diff] [blame] | 1557 | #endif |
drh | 8cfbf08 | 2001-09-19 13:22:39 +0000 | [diff] [blame] | 1558 | pPager->journalOpen = 0; |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 1559 | pPager->useJournal = useJournal && !memDb; |
| 1560 | pPager->stmtOpen = 0; |
| 1561 | pPager->stmtInUse = 0; |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1562 | pPager->nRef = 0; |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 1563 | pPager->dbSize = memDb-1; |
drh | 90f5ecb | 2004-07-22 01:19:35 +0000 | [diff] [blame] | 1564 | pPager->pageSize = SQLITE_DEFAULT_PAGE_SIZE; |
drh | 887dc4c | 2004-10-22 16:22:57 +0000 | [diff] [blame] | 1565 | pPager->psAligned = FORCE_ALIGNMENT(pPager->pageSize); |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 1566 | pPager->stmtSize = 0; |
| 1567 | pPager->stmtJSize = 0; |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1568 | pPager->nPage = 0; |
drh | 90f5ecb | 2004-07-22 01:19:35 +0000 | [diff] [blame] | 1569 | pPager->mxPage = 100; |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 1570 | pPager->state = PAGER_UNLOCK; |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 1571 | pPager->errMask = 0; |
drh | 5e00f6c | 2001-09-13 13:46:56 +0000 | [diff] [blame] | 1572 | pPager->tempFile = tempFile; |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 1573 | pPager->memDb = memDb; |
drh | 5e00f6c | 2001-09-13 13:46:56 +0000 | [diff] [blame] | 1574 | pPager->readOnly = readOnly; |
drh | f57b14a | 2001-09-14 18:54:08 +0000 | [diff] [blame] | 1575 | pPager->needSync = 0; |
drh | da47d77 | 2002-12-02 04:25:19 +0000 | [diff] [blame] | 1576 | pPager->noSync = pPager->tempFile || !useJournal; |
danielk1977 | 75edc16 | 2004-06-26 01:48:18 +0000 | [diff] [blame] | 1577 | pPager->fullSync = (pPager->noSync?0:1); |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1578 | pPager->pFirst = 0; |
drh | 341eae8 | 2003-01-21 02:39:36 +0000 | [diff] [blame] | 1579 | pPager->pFirstSynced = 0; |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1580 | pPager->pLast = 0; |
drh | 887dc4c | 2004-10-22 16:22:57 +0000 | [diff] [blame] | 1581 | pPager->nExtra = FORCE_ALIGNMENT(nExtra); |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1582 | pPager->sectorSize = PAGER_SECTOR_SIZE; |
drh | 90f5ecb | 2004-07-22 01:19:35 +0000 | [diff] [blame] | 1583 | pPager->pBusyHandler = 0; |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1584 | memset(pPager->aHash, 0, sizeof(pPager->aHash)); |
| 1585 | *ppPager = pPager; |
| 1586 | return SQLITE_OK; |
| 1587 | } |
| 1588 | |
| 1589 | /* |
drh | 90f5ecb | 2004-07-22 01:19:35 +0000 | [diff] [blame] | 1590 | ** Set the busy handler function. |
| 1591 | */ |
| 1592 | void sqlite3pager_set_busyhandler(Pager *pPager, BusyHandler *pBusyHandler){ |
| 1593 | pPager->pBusyHandler = pBusyHandler; |
| 1594 | } |
| 1595 | |
| 1596 | /* |
drh | 72f8286 | 2001-05-24 21:06:34 +0000 | [diff] [blame] | 1597 | ** Set the destructor for this pager. If not NULL, the destructor is called |
drh | 5e00f6c | 2001-09-13 13:46:56 +0000 | [diff] [blame] | 1598 | ** when the reference count on each page reaches zero. The destructor can |
| 1599 | ** 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] | 1600 | ** |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 1601 | ** The destructor is not called as a result sqlite3pager_close(). |
| 1602 | ** Destructors are only called by sqlite3pager_unref(). |
drh | 72f8286 | 2001-05-24 21:06:34 +0000 | [diff] [blame] | 1603 | */ |
drh | b6f4148 | 2004-05-14 01:58:11 +0000 | [diff] [blame] | 1604 | void sqlite3pager_set_destructor(Pager *pPager, void (*xDesc)(void*,int)){ |
drh | 72f8286 | 2001-05-24 21:06:34 +0000 | [diff] [blame] | 1605 | pPager->xDestructor = xDesc; |
| 1606 | } |
| 1607 | |
| 1608 | /* |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 1609 | ** Set the reinitializer for this pager. If not NULL, the reinitializer |
| 1610 | ** is called when the content of a page in cache is restored to its original |
| 1611 | ** value as a result of a rollback. The callback gives higher-level code |
| 1612 | ** an opportunity to restore the EXTRA section to agree with the restored |
| 1613 | ** page data. |
| 1614 | */ |
| 1615 | void sqlite3pager_set_reiniter(Pager *pPager, void (*xReinit)(void*,int)){ |
| 1616 | pPager->xReiniter = xReinit; |
| 1617 | } |
| 1618 | |
| 1619 | /* |
drh | 90f5ecb | 2004-07-22 01:19:35 +0000 | [diff] [blame] | 1620 | ** Set the page size. |
| 1621 | ** |
| 1622 | ** The page size must only be changed when the cache is empty. |
| 1623 | */ |
| 1624 | void sqlite3pager_set_pagesize(Pager *pPager, int pageSize){ |
| 1625 | assert( pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE ); |
| 1626 | pPager->pageSize = pageSize; |
drh | 887dc4c | 2004-10-22 16:22:57 +0000 | [diff] [blame] | 1627 | pPager->psAligned = FORCE_ALIGNMENT(pageSize); |
drh | 90f5ecb | 2004-07-22 01:19:35 +0000 | [diff] [blame] | 1628 | } |
| 1629 | |
| 1630 | /* |
| 1631 | ** Read the first N bytes from the beginning of the file into memory |
| 1632 | ** that pDest points to. No error checking is done. |
| 1633 | */ |
| 1634 | void sqlite3pager_read_fileheader(Pager *pPager, int N, unsigned char *pDest){ |
| 1635 | memset(pDest, 0, N); |
drh | b7f9164 | 2004-10-31 02:22:47 +0000 | [diff] [blame] | 1636 | if( MEMDB==0 ){ |
drh | 90f5ecb | 2004-07-22 01:19:35 +0000 | [diff] [blame] | 1637 | sqlite3OsSeek(&pPager->fd, 0); |
| 1638 | sqlite3OsRead(&pPager->fd, pDest, N); |
| 1639 | } |
| 1640 | } |
| 1641 | |
| 1642 | /* |
drh | 5e00f6c | 2001-09-13 13:46:56 +0000 | [diff] [blame] | 1643 | ** Return the total number of pages in the disk file associated with |
| 1644 | ** pPager. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1645 | */ |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 1646 | int sqlite3pager_pagecount(Pager *pPager){ |
drh | eb20625 | 2004-10-01 02:00:31 +0000 | [diff] [blame] | 1647 | i64 n; |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 1648 | assert( pPager!=0 ); |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1649 | if( pPager->dbSize>=0 ){ |
| 1650 | return pPager->dbSize; |
| 1651 | } |
danielk1977 | 4adee20 | 2004-05-08 08:23:19 +0000 | [diff] [blame] | 1652 | if( sqlite3OsFileSize(&pPager->fd, &n)!=SQLITE_OK ){ |
drh | 81a20f2 | 2001-10-12 17:30:04 +0000 | [diff] [blame] | 1653 | pPager->errMask |= PAGER_ERR_DISK; |
drh | 8cfbf08 | 2001-09-19 13:22:39 +0000 | [diff] [blame] | 1654 | return 0; |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1655 | } |
drh | 90f5ecb | 2004-07-22 01:19:35 +0000 | [diff] [blame] | 1656 | n /= pPager->pageSize; |
drh | b7f9164 | 2004-10-31 02:22:47 +0000 | [diff] [blame] | 1657 | if( !MEMDB && n==PENDING_BYTE/pPager->pageSize ){ |
drh | 1f59571 | 2004-06-15 01:40:29 +0000 | [diff] [blame] | 1658 | n++; |
| 1659 | } |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 1660 | if( pPager->state!=PAGER_UNLOCK ){ |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1661 | pPager->dbSize = n; |
| 1662 | } |
| 1663 | return n; |
| 1664 | } |
| 1665 | |
| 1666 | /* |
drh | f7c5753 | 2003-04-25 13:22:51 +0000 | [diff] [blame] | 1667 | ** Forward declaration |
| 1668 | */ |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1669 | static int syncJournal(Pager*); |
drh | f7c5753 | 2003-04-25 13:22:51 +0000 | [diff] [blame] | 1670 | |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 1671 | |
| 1672 | /* |
danielk1977 | f5fdda8 | 2004-11-03 08:44:05 +0000 | [diff] [blame] | 1673 | ** Unlink pPg from it's hash chain. Also set the page number to 0 to indicate |
| 1674 | ** that the page is not part of any hash chain. This is required because the |
| 1675 | ** sqlite3pager_movepage() routine can leave a page in the |
| 1676 | ** pNextFree/pPrevFree list that is not a part of any hash-chain. |
| 1677 | */ |
| 1678 | static void unlinkHashChain(Pager *pPager, PgHdr *pPg){ |
| 1679 | if( pPg->pgno==0 ){ |
| 1680 | /* If the page number is zero, then this page is not in any hash chain. */ |
| 1681 | return; |
| 1682 | } |
| 1683 | if( pPg->pNextHash ){ |
| 1684 | pPg->pNextHash->pPrevHash = pPg->pPrevHash; |
| 1685 | } |
| 1686 | if( pPg->pPrevHash ){ |
| 1687 | assert( pPager->aHash[pager_hash(pPg->pgno)]!=pPg ); |
| 1688 | pPg->pPrevHash->pNextHash = pPg->pNextHash; |
| 1689 | }else{ |
| 1690 | int h = pager_hash(pPg->pgno); |
| 1691 | assert( pPager->aHash[h]==pPg ); |
| 1692 | pPager->aHash[h] = pPg->pNextHash; |
| 1693 | } |
| 1694 | |
| 1695 | pPg->pgno = 0; |
| 1696 | pPg->pNextHash = pPg->pPrevHash = 0; |
| 1697 | } |
| 1698 | |
| 1699 | /* |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 1700 | ** Unlink a page from the free list (the list of all pages where nRef==0) |
| 1701 | ** and from its hash collision chain. |
| 1702 | */ |
| 1703 | static void unlinkPage(PgHdr *pPg){ |
| 1704 | Pager *pPager = pPg->pPager; |
| 1705 | |
| 1706 | /* Keep the pFirstSynced pointer pointing at the first synchronized page */ |
| 1707 | if( pPg==pPager->pFirstSynced ){ |
| 1708 | PgHdr *p = pPg->pNextFree; |
| 1709 | while( p && p->needSync ){ p = p->pNextFree; } |
| 1710 | pPager->pFirstSynced = p; |
| 1711 | } |
| 1712 | |
| 1713 | /* Unlink from the freelist */ |
| 1714 | if( pPg->pPrevFree ){ |
| 1715 | pPg->pPrevFree->pNextFree = pPg->pNextFree; |
| 1716 | }else{ |
| 1717 | assert( pPager->pFirst==pPg ); |
| 1718 | pPager->pFirst = pPg->pNextFree; |
| 1719 | } |
| 1720 | if( pPg->pNextFree ){ |
| 1721 | pPg->pNextFree->pPrevFree = pPg->pPrevFree; |
| 1722 | }else{ |
| 1723 | assert( pPager->pLast==pPg ); |
| 1724 | pPager->pLast = pPg->pPrevFree; |
| 1725 | } |
| 1726 | pPg->pNextFree = pPg->pPrevFree = 0; |
| 1727 | |
| 1728 | /* Unlink from the pgno hash table */ |
danielk1977 | f5fdda8 | 2004-11-03 08:44:05 +0000 | [diff] [blame] | 1729 | unlinkHashChain(pPager, pPg); |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 1730 | } |
| 1731 | |
danielk1977 | b84f96f | 2005-01-20 11:32:23 +0000 | [diff] [blame] | 1732 | #ifndef SQLITE_OMIT_MEMORYDB |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 1733 | /* |
| 1734 | ** This routine is used to truncate an in-memory database. Delete |
danielk1977 | 369f27e | 2004-06-15 11:40:04 +0000 | [diff] [blame] | 1735 | ** all pages whose pgno is larger than pPager->dbSize and is unreferenced. |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 1736 | ** Referenced pages larger than pPager->dbSize are zeroed. |
| 1737 | */ |
| 1738 | static void memoryTruncate(Pager *pPager){ |
| 1739 | PgHdr *pPg; |
| 1740 | PgHdr **ppPg; |
| 1741 | int dbSize = pPager->dbSize; |
| 1742 | |
| 1743 | ppPg = &pPager->pAll; |
| 1744 | while( (pPg = *ppPg)!=0 ){ |
| 1745 | if( pPg->pgno<=dbSize ){ |
| 1746 | ppPg = &pPg->pNextAll; |
| 1747 | }else if( pPg->nRef>0 ){ |
| 1748 | memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize); |
| 1749 | ppPg = &pPg->pNextAll; |
| 1750 | }else{ |
| 1751 | *ppPg = pPg->pNextAll; |
| 1752 | unlinkPage(pPg); |
| 1753 | sqliteFree(pPg); |
| 1754 | pPager->nPage--; |
| 1755 | } |
| 1756 | } |
| 1757 | } |
danielk1977 | b84f96f | 2005-01-20 11:32:23 +0000 | [diff] [blame] | 1758 | #else |
| 1759 | #define memoryTruncate(p) |
| 1760 | #endif |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 1761 | |
drh | f7c5753 | 2003-04-25 13:22:51 +0000 | [diff] [blame] | 1762 | /* |
| 1763 | ** Truncate the file to the number of pages specified. |
| 1764 | */ |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 1765 | int sqlite3pager_truncate(Pager *pPager, Pgno nPage){ |
drh | f7c5753 | 2003-04-25 13:22:51 +0000 | [diff] [blame] | 1766 | int rc; |
drh | dc3ff9c | 2004-08-18 02:10:15 +0000 | [diff] [blame] | 1767 | sqlite3pager_pagecount(pPager); |
drh | 2e6d11b | 2003-04-25 15:37:57 +0000 | [diff] [blame] | 1768 | if( pPager->errMask!=0 ){ |
| 1769 | rc = pager_errcode(pPager); |
| 1770 | return rc; |
| 1771 | } |
drh | 7d02cb7 | 2003-06-04 16:24:39 +0000 | [diff] [blame] | 1772 | if( nPage>=(unsigned)pPager->dbSize ){ |
drh | f7c5753 | 2003-04-25 13:22:51 +0000 | [diff] [blame] | 1773 | return SQLITE_OK; |
| 1774 | } |
drh | b7f9164 | 2004-10-31 02:22:47 +0000 | [diff] [blame] | 1775 | if( MEMDB ){ |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 1776 | pPager->dbSize = nPage; |
| 1777 | memoryTruncate(pPager); |
| 1778 | return SQLITE_OK; |
| 1779 | } |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1780 | rc = syncJournal(pPager); |
danielk1977 | 369f27e | 2004-06-15 11:40:04 +0000 | [diff] [blame] | 1781 | if( rc!=SQLITE_OK ){ |
| 1782 | return rc; |
| 1783 | } |
drh | cb4c40b | 2004-08-18 19:09:43 +0000 | [diff] [blame] | 1784 | rc = pager_truncate(pPager, nPage); |
drh | f7c5753 | 2003-04-25 13:22:51 +0000 | [diff] [blame] | 1785 | if( rc==SQLITE_OK ){ |
| 1786 | pPager->dbSize = nPage; |
| 1787 | } |
| 1788 | return rc; |
| 1789 | } |
| 1790 | |
| 1791 | /* |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1792 | ** Shutdown the page cache. Free all memory and close all files. |
| 1793 | ** |
| 1794 | ** If a transaction was in progress when this routine is called, that |
| 1795 | ** transaction is rolled back. All outstanding pages are invalidated |
| 1796 | ** and their memory is freed. Any attempt to use a page associated |
| 1797 | ** with this page cache after this function returns will likely |
| 1798 | ** result in a coredump. |
| 1799 | */ |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 1800 | int sqlite3pager_close(Pager *pPager){ |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 1801 | PgHdr *pPg, *pNext; |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1802 | switch( pPager->state ){ |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 1803 | case PAGER_RESERVED: |
danielk1977 | aa5ccdf | 2004-06-14 05:10:42 +0000 | [diff] [blame] | 1804 | case PAGER_SYNCED: |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 1805 | case PAGER_EXCLUSIVE: { |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 1806 | sqlite3pager_rollback(pPager); |
drh | b7f9164 | 2004-10-31 02:22:47 +0000 | [diff] [blame] | 1807 | if( !MEMDB ){ |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 1808 | sqlite3OsUnlock(&pPager->fd, NO_LOCK); |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 1809 | } |
drh | 8cfbf08 | 2001-09-19 13:22:39 +0000 | [diff] [blame] | 1810 | assert( pPager->journalOpen==0 ); |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1811 | break; |
| 1812 | } |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 1813 | case PAGER_SHARED: { |
drh | b7f9164 | 2004-10-31 02:22:47 +0000 | [diff] [blame] | 1814 | if( !MEMDB ){ |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 1815 | sqlite3OsUnlock(&pPager->fd, NO_LOCK); |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 1816 | } |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1817 | break; |
| 1818 | } |
| 1819 | default: { |
| 1820 | /* Do nothing */ |
| 1821 | break; |
| 1822 | } |
| 1823 | } |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 1824 | for(pPg=pPager->pAll; pPg; pPg=pNext){ |
danielk1977 | eac7a36 | 2004-06-16 07:45:24 +0000 | [diff] [blame] | 1825 | #ifndef NDEBUG |
drh | b7f9164 | 2004-10-31 02:22:47 +0000 | [diff] [blame] | 1826 | if( MEMDB ){ |
danielk1977 | eac7a36 | 2004-06-16 07:45:24 +0000 | [diff] [blame] | 1827 | PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager); |
| 1828 | assert( !pPg->alwaysRollback ); |
| 1829 | assert( !pHist->pOrig ); |
| 1830 | assert( !pHist->pStmt ); |
| 1831 | } |
| 1832 | #endif |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 1833 | pNext = pPg->pNextAll; |
| 1834 | sqliteFree(pPg); |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1835 | } |
danielk1977 | ef73ee9 | 2004-11-06 12:26:07 +0000 | [diff] [blame] | 1836 | TRACE2("CLOSE %d\n", PAGERID(pPager)); |
drh | da71ce1 | 2004-06-21 18:14:45 +0000 | [diff] [blame] | 1837 | sqlite3OsClose(&pPager->fd); |
drh | 8cfbf08 | 2001-09-19 13:22:39 +0000 | [diff] [blame] | 1838 | assert( pPager->journalOpen==0 ); |
drh | 0f89253 | 2002-05-30 12:27:03 +0000 | [diff] [blame] | 1839 | /* Temp files are automatically deleted by the OS |
| 1840 | ** if( pPager->tempFile ){ |
danielk1977 | 4adee20 | 2004-05-08 08:23:19 +0000 | [diff] [blame] | 1841 | ** sqlite3OsDelete(pPager->zFilename); |
drh | 0f89253 | 2002-05-30 12:27:03 +0000 | [diff] [blame] | 1842 | ** } |
| 1843 | */ |
danielk1977 | aca790a | 2005-01-13 11:07:52 +0000 | [diff] [blame] | 1844 | |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1845 | sqliteFree(pPager); |
| 1846 | return SQLITE_OK; |
| 1847 | } |
| 1848 | |
| 1849 | /* |
drh | 5e00f6c | 2001-09-13 13:46:56 +0000 | [diff] [blame] | 1850 | ** Return the page number for the given page data. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1851 | */ |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 1852 | Pgno sqlite3pager_pagenumber(void *pData){ |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 1853 | PgHdr *p = DATA_TO_PGHDR(pData); |
| 1854 | return p->pgno; |
| 1855 | } |
| 1856 | |
| 1857 | /* |
drh | c8629a1 | 2004-05-08 20:07:40 +0000 | [diff] [blame] | 1858 | ** The page_ref() function increments the reference count for a page. |
| 1859 | ** 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] | 1860 | ** remove it from the freelist. |
drh | c8629a1 | 2004-05-08 20:07:40 +0000 | [diff] [blame] | 1861 | ** |
| 1862 | ** For non-test systems, page_ref() is a macro that calls _page_ref() |
| 1863 | ** online of the reference count is zero. For test systems, page_ref() |
| 1864 | ** is a real function so that we can set breakpoints and trace it. |
drh | 7e3b0a0 | 2001-04-28 16:52:40 +0000 | [diff] [blame] | 1865 | */ |
drh | 836faa4 | 2003-01-11 13:30:57 +0000 | [diff] [blame] | 1866 | static void _page_ref(PgHdr *pPg){ |
drh | 7e3b0a0 | 2001-04-28 16:52:40 +0000 | [diff] [blame] | 1867 | if( pPg->nRef==0 ){ |
| 1868 | /* The page is currently on the freelist. Remove it. */ |
drh | 341eae8 | 2003-01-21 02:39:36 +0000 | [diff] [blame] | 1869 | if( pPg==pPg->pPager->pFirstSynced ){ |
| 1870 | PgHdr *p = pPg->pNextFree; |
| 1871 | while( p && p->needSync ){ p = p->pNextFree; } |
| 1872 | pPg->pPager->pFirstSynced = p; |
| 1873 | } |
drh | 7e3b0a0 | 2001-04-28 16:52:40 +0000 | [diff] [blame] | 1874 | if( pPg->pPrevFree ){ |
| 1875 | pPg->pPrevFree->pNextFree = pPg->pNextFree; |
| 1876 | }else{ |
| 1877 | pPg->pPager->pFirst = pPg->pNextFree; |
| 1878 | } |
| 1879 | if( pPg->pNextFree ){ |
| 1880 | pPg->pNextFree->pPrevFree = pPg->pPrevFree; |
| 1881 | }else{ |
| 1882 | pPg->pPager->pLast = pPg->pPrevFree; |
| 1883 | } |
| 1884 | pPg->pPager->nRef++; |
| 1885 | } |
| 1886 | pPg->nRef++; |
drh | dd79342 | 2001-06-28 01:54:48 +0000 | [diff] [blame] | 1887 | REFINFO(pPg); |
drh | df0b3b0 | 2001-06-23 11:36:20 +0000 | [diff] [blame] | 1888 | } |
danielk1977 | aca790a | 2005-01-13 11:07:52 +0000 | [diff] [blame] | 1889 | #ifdef SQLITE_DEBUG |
drh | c8629a1 | 2004-05-08 20:07:40 +0000 | [diff] [blame] | 1890 | static void page_ref(PgHdr *pPg){ |
| 1891 | if( pPg->nRef==0 ){ |
| 1892 | _page_ref(pPg); |
| 1893 | }else{ |
| 1894 | pPg->nRef++; |
| 1895 | REFINFO(pPg); |
| 1896 | } |
| 1897 | } |
| 1898 | #else |
| 1899 | # define page_ref(P) ((P)->nRef==0?_page_ref(P):(void)(P)->nRef++) |
| 1900 | #endif |
drh | df0b3b0 | 2001-06-23 11:36:20 +0000 | [diff] [blame] | 1901 | |
| 1902 | /* |
| 1903 | ** Increment the reference count for a page. The input pointer is |
| 1904 | ** a reference to the page data. |
| 1905 | */ |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 1906 | int sqlite3pager_ref(void *pData){ |
drh | df0b3b0 | 2001-06-23 11:36:20 +0000 | [diff] [blame] | 1907 | PgHdr *pPg = DATA_TO_PGHDR(pData); |
| 1908 | page_ref(pPg); |
drh | 8c42ca9 | 2001-06-22 19:15:00 +0000 | [diff] [blame] | 1909 | return SQLITE_OK; |
drh | 7e3b0a0 | 2001-04-28 16:52:40 +0000 | [diff] [blame] | 1910 | } |
| 1911 | |
| 1912 | /* |
drh | 34e79ce | 2004-02-08 06:05:46 +0000 | [diff] [blame] | 1913 | ** Sync the journal. In other words, make sure all the pages that have |
| 1914 | ** been written to the journal have actually reached the surface of the |
| 1915 | ** disk. It is not safe to modify the original database file until after |
| 1916 | ** the journal has been synced. If the original database is modified before |
| 1917 | ** the journal is synced and a power failure occurs, the unsynced journal |
| 1918 | ** data would be lost and we would be unable to completely rollback the |
| 1919 | ** database changes. Database corruption would occur. |
| 1920 | ** |
| 1921 | ** This routine also updates the nRec field in the header of the journal. |
| 1922 | ** (See comments on the pager_playback() routine for additional information.) |
| 1923 | ** If the sync mode is FULL, two syncs will occur. First the whole journal |
| 1924 | ** is synced, then the nRec field is updated, then a second sync occurs. |
drh | b19a2bc | 2001-09-16 00:13:26 +0000 | [diff] [blame] | 1925 | ** |
drh | 34e79ce | 2004-02-08 06:05:46 +0000 | [diff] [blame] | 1926 | ** For temporary databases, we do not care if we are able to rollback |
| 1927 | ** after a power failure, so sync occurs. |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1928 | ** |
drh | 34e79ce | 2004-02-08 06:05:46 +0000 | [diff] [blame] | 1929 | ** This routine clears the needSync field of every page current held in |
| 1930 | ** memory. |
drh | 50e5dad | 2001-09-15 00:57:28 +0000 | [diff] [blame] | 1931 | */ |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1932 | static int syncJournal(Pager *pPager){ |
drh | 50e5dad | 2001-09-15 00:57:28 +0000 | [diff] [blame] | 1933 | PgHdr *pPg; |
| 1934 | int rc = SQLITE_OK; |
drh | 03eb96a | 2002-11-10 23:32:56 +0000 | [diff] [blame] | 1935 | |
| 1936 | /* Sync the journal before modifying the main database |
| 1937 | ** (assuming there is a journal and it needs to be synced.) |
| 1938 | */ |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1939 | if( pPager->needSync ){ |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1940 | if( !pPager->tempFile ){ |
drh | db48ee0 | 2003-01-16 13:42:43 +0000 | [diff] [blame] | 1941 | assert( pPager->journalOpen ); |
drh | 946966f | 2004-02-25 02:20:41 +0000 | [diff] [blame] | 1942 | /* assert( !pPager->noSync ); // noSync might be set if synchronous |
| 1943 | ** was turned off after the transaction was started. Ticket #615 */ |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 1944 | #ifndef NDEBUG |
| 1945 | { |
drh | 34e79ce | 2004-02-08 06:05:46 +0000 | [diff] [blame] | 1946 | /* Make sure the pPager->nRec counter we are keeping agrees |
| 1947 | ** with the nRec computed from the size of the journal file. |
| 1948 | */ |
drh | eb20625 | 2004-10-01 02:00:31 +0000 | [diff] [blame] | 1949 | i64 jSz; |
danielk1977 | 4adee20 | 2004-05-08 08:23:19 +0000 | [diff] [blame] | 1950 | rc = sqlite3OsFileSize(&pPager->jfd, &jSz); |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 1951 | if( rc!=0 ) return rc; |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1952 | assert( pPager->journalOff==jSz ); |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 1953 | } |
| 1954 | #endif |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 1955 | { |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1956 | /* Write the nRec value into the journal file header. If in |
| 1957 | ** full-synchronous mode, sync the journal first. This ensures that |
| 1958 | ** all data has really hit the disk before nRec is updated to mark |
| 1959 | ** it as a candidate for rollback. |
| 1960 | */ |
drh | d8d66e8 | 2003-02-12 02:10:15 +0000 | [diff] [blame] | 1961 | if( pPager->fullSync ){ |
danielk1977 | ef73ee9 | 2004-11-06 12:26:07 +0000 | [diff] [blame] | 1962 | TRACE2("SYNC journal of %d\n", PAGERID(pPager)); |
danielk1977 | 4adee20 | 2004-05-08 08:23:19 +0000 | [diff] [blame] | 1963 | rc = sqlite3OsSync(&pPager->jfd); |
drh | d8d66e8 | 2003-02-12 02:10:15 +0000 | [diff] [blame] | 1964 | if( rc!=0 ) return rc; |
| 1965 | } |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1966 | sqlite3OsSeek(&pPager->jfd, pPager->journalHdr + sizeof(aJournalMagic)); |
drh | 99ee360 | 2003-02-16 19:13:36 +0000 | [diff] [blame] | 1967 | rc = write32bits(&pPager->jfd, pPager->nRec); |
| 1968 | if( rc ) return rc; |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 1969 | |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 1970 | sqlite3OsSeek(&pPager->jfd, pPager->journalOff); |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 1971 | } |
danielk1977 | ef73ee9 | 2004-11-06 12:26:07 +0000 | [diff] [blame] | 1972 | TRACE2("SYNC journal of %d\n", PAGERID(pPager)); |
danielk1977 | 4adee20 | 2004-05-08 08:23:19 +0000 | [diff] [blame] | 1973 | rc = sqlite3OsSync(&pPager->jfd); |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1974 | if( rc!=0 ) return rc; |
drh | db48ee0 | 2003-01-16 13:42:43 +0000 | [diff] [blame] | 1975 | pPager->journalStarted = 1; |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 1976 | } |
drh | 50e5dad | 2001-09-15 00:57:28 +0000 | [diff] [blame] | 1977 | pPager->needSync = 0; |
drh | 341eae8 | 2003-01-21 02:39:36 +0000 | [diff] [blame] | 1978 | |
| 1979 | /* Erase the needSync flag from every page. |
| 1980 | */ |
| 1981 | for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){ |
| 1982 | pPg->needSync = 0; |
| 1983 | } |
| 1984 | pPager->pFirstSynced = pPager->pFirst; |
drh | 50e5dad | 2001-09-15 00:57:28 +0000 | [diff] [blame] | 1985 | } |
drh | 03eb96a | 2002-11-10 23:32:56 +0000 | [diff] [blame] | 1986 | |
drh | 341eae8 | 2003-01-21 02:39:36 +0000 | [diff] [blame] | 1987 | #ifndef NDEBUG |
| 1988 | /* If the Pager.needSync flag is clear then the PgHdr.needSync |
| 1989 | ** flag must also be clear for all pages. Verify that this |
| 1990 | ** invariant is true. |
drh | 03eb96a | 2002-11-10 23:32:56 +0000 | [diff] [blame] | 1991 | */ |
drh | 341eae8 | 2003-01-21 02:39:36 +0000 | [diff] [blame] | 1992 | else{ |
| 1993 | for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){ |
| 1994 | assert( pPg->needSync==0 ); |
| 1995 | } |
| 1996 | assert( pPager->pFirstSynced==pPager->pFirst ); |
drh | 03eb96a | 2002-11-10 23:32:56 +0000 | [diff] [blame] | 1997 | } |
drh | 341eae8 | 2003-01-21 02:39:36 +0000 | [diff] [blame] | 1998 | #endif |
drh | db48ee0 | 2003-01-16 13:42:43 +0000 | [diff] [blame] | 1999 | |
drh | 81a20f2 | 2001-10-12 17:30:04 +0000 | [diff] [blame] | 2000 | return rc; |
drh | 50e5dad | 2001-09-15 00:57:28 +0000 | [diff] [blame] | 2001 | } |
| 2002 | |
| 2003 | /* |
drh | 684917c | 2004-10-05 02:41:42 +0000 | [diff] [blame] | 2004 | ** Try to obtain a lock on a file. Invoke the busy callback if the lock |
| 2005 | ** is currently not available. Repeate until the busy callback returns |
| 2006 | ** false or until the lock succeeds. |
| 2007 | ** |
| 2008 | ** Return SQLITE_OK on success and an error code if we cannot obtain |
| 2009 | ** the lock. |
| 2010 | */ |
| 2011 | static int pager_wait_on_lock(Pager *pPager, int locktype){ |
| 2012 | int rc; |
| 2013 | assert( PAGER_SHARED==SHARED_LOCK ); |
| 2014 | assert( PAGER_RESERVED==RESERVED_LOCK ); |
| 2015 | assert( PAGER_EXCLUSIVE==EXCLUSIVE_LOCK ); |
| 2016 | if( pPager->state>=locktype ){ |
| 2017 | rc = SQLITE_OK; |
| 2018 | }else{ |
| 2019 | int busy = 1; |
| 2020 | do { |
| 2021 | rc = sqlite3OsLock(&pPager->fd, locktype); |
| 2022 | }while( rc==SQLITE_BUSY && |
| 2023 | pPager->pBusyHandler && |
| 2024 | pPager->pBusyHandler->xFunc && |
| 2025 | pPager->pBusyHandler->xFunc(pPager->pBusyHandler->pArg, busy++) |
| 2026 | ); |
| 2027 | if( rc==SQLITE_OK ){ |
| 2028 | pPager->state = locktype; |
| 2029 | } |
| 2030 | } |
| 2031 | return rc; |
| 2032 | } |
| 2033 | |
| 2034 | /* |
drh | 2554f8b | 2003-01-22 01:26:44 +0000 | [diff] [blame] | 2035 | ** Given a list of pages (connected by the PgHdr.pDirty pointer) write |
| 2036 | ** every one of those pages out to the database file and mark them all |
| 2037 | ** as clean. |
| 2038 | */ |
| 2039 | static int pager_write_pagelist(PgHdr *pList){ |
| 2040 | Pager *pPager; |
| 2041 | int rc; |
| 2042 | |
| 2043 | if( pList==0 ) return SQLITE_OK; |
| 2044 | pPager = pList->pPager; |
danielk1977 | 9eed505 | 2004-06-04 10:38:30 +0000 | [diff] [blame] | 2045 | |
| 2046 | /* At this point there may be either a RESERVED or EXCLUSIVE lock on the |
| 2047 | ** database file. If there is already an EXCLUSIVE lock, the following |
| 2048 | ** calls to sqlite3OsLock() are no-ops. |
| 2049 | ** |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 2050 | ** Moving the lock from RESERVED to EXCLUSIVE actually involves going |
| 2051 | ** through an intermediate state PENDING. A PENDING lock prevents new |
| 2052 | ** readers from attaching to the database but is unsufficient for us to |
| 2053 | ** write. The idea of a PENDING lock is to prevent new readers from |
| 2054 | ** coming in while we wait for existing readers to clear. |
danielk1977 | 9eed505 | 2004-06-04 10:38:30 +0000 | [diff] [blame] | 2055 | ** |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 2056 | ** While the pager is in the RESERVED state, the original database file |
| 2057 | ** is unchanged and we can rollback without having to playback the |
| 2058 | ** journal into the original database file. Once we transition to |
| 2059 | ** EXCLUSIVE, it means the database file has been changed and any rollback |
| 2060 | ** will require a journal playback. |
danielk1977 | 9eed505 | 2004-06-04 10:38:30 +0000 | [diff] [blame] | 2061 | */ |
drh | 684917c | 2004-10-05 02:41:42 +0000 | [diff] [blame] | 2062 | rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK); |
danielk1977 | 9eed505 | 2004-06-04 10:38:30 +0000 | [diff] [blame] | 2063 | if( rc!=SQLITE_OK ){ |
| 2064 | return rc; |
| 2065 | } |
| 2066 | |
drh | 2554f8b | 2003-01-22 01:26:44 +0000 | [diff] [blame] | 2067 | while( pList ){ |
| 2068 | assert( pList->dirty ); |
drh | eb20625 | 2004-10-01 02:00:31 +0000 | [diff] [blame] | 2069 | sqlite3OsSeek(&pPager->fd, (pList->pgno-1)*(i64)pPager->pageSize); |
danielk1977 | 687566d | 2004-11-02 12:56:41 +0000 | [diff] [blame] | 2070 | /* If there are dirty pages in the page cache with page numbers greater |
| 2071 | ** than Pager.dbSize, this means sqlite3pager_truncate() was called to |
| 2072 | ** make the file smaller (presumably by auto-vacuum code). Do not write |
| 2073 | ** any such pages to the file. |
| 2074 | */ |
| 2075 | if( pList->pgno<=pPager->dbSize ){ |
| 2076 | CODEC(pPager, PGHDR_TO_DATA(pList), pList->pgno, 6); |
danielk1977 | ef73ee9 | 2004-11-06 12:26:07 +0000 | [diff] [blame] | 2077 | TRACE3("STORE %d page %d\n", PAGERID(pPager), pList->pgno); |
danielk1977 | 687566d | 2004-11-02 12:56:41 +0000 | [diff] [blame] | 2078 | rc = sqlite3OsWrite(&pPager->fd, PGHDR_TO_DATA(pList), pPager->pageSize); |
| 2079 | CODEC(pPager, PGHDR_TO_DATA(pList), pList->pgno, 0); |
danielk1977 | 42741be | 2005-01-08 12:42:39 +0000 | [diff] [blame] | 2080 | pPager->nWrite++; |
danielk1977 | 687566d | 2004-11-02 12:56:41 +0000 | [diff] [blame] | 2081 | } |
| 2082 | #ifndef NDEBUG |
| 2083 | else{ |
danielk1977 | ef73ee9 | 2004-11-06 12:26:07 +0000 | [diff] [blame] | 2084 | TRACE3("NOSTORE %d page %d\n", PAGERID(pPager), pList->pgno); |
danielk1977 | 687566d | 2004-11-02 12:56:41 +0000 | [diff] [blame] | 2085 | } |
| 2086 | #endif |
drh | 2554f8b | 2003-01-22 01:26:44 +0000 | [diff] [blame] | 2087 | if( rc ) return rc; |
| 2088 | pList->dirty = 0; |
| 2089 | pList = pList->pDirty; |
| 2090 | } |
| 2091 | return SQLITE_OK; |
| 2092 | } |
| 2093 | |
| 2094 | /* |
| 2095 | ** Collect every dirty page into a dirty list and |
| 2096 | ** return a pointer to the head of that list. All pages are |
| 2097 | ** collected even if they are still in use. |
| 2098 | */ |
| 2099 | static PgHdr *pager_get_all_dirty_pages(Pager *pPager){ |
| 2100 | PgHdr *p, *pList; |
| 2101 | pList = 0; |
| 2102 | for(p=pPager->pAll; p; p=p->pNextAll){ |
| 2103 | if( p->dirty ){ |
| 2104 | p->pDirty = pList; |
| 2105 | pList = p; |
| 2106 | } |
| 2107 | } |
| 2108 | return pList; |
| 2109 | } |
| 2110 | |
| 2111 | /* |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2112 | ** Acquire a page. |
| 2113 | ** |
drh | 58a1168 | 2001-11-10 13:51:08 +0000 | [diff] [blame] | 2114 | ** 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] | 2115 | ** This read lock is dropped when the last page is released. |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2116 | ** |
drh | 306dc21 | 2001-05-21 13:45:10 +0000 | [diff] [blame] | 2117 | ** A _get works for any page number greater than 0. If the database |
| 2118 | ** file is smaller than the requested page, then no actual disk |
| 2119 | ** read occurs and the memory image of the page is initialized to |
| 2120 | ** all zeros. The extra data appended to a page is always initialized |
| 2121 | ** to zeros the first time a page is loaded into memory. |
| 2122 | ** |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2123 | ** The acquisition might fail for several reasons. In all cases, |
| 2124 | ** an appropriate error code is returned and *ppPage is set to NULL. |
drh | 7e3b0a0 | 2001-04-28 16:52:40 +0000 | [diff] [blame] | 2125 | ** |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 2126 | ** See also sqlite3pager_lookup(). Both this routine and _lookup() attempt |
drh | 7e3b0a0 | 2001-04-28 16:52:40 +0000 | [diff] [blame] | 2127 | ** to find a page in the in-memory cache first. If the page is not already |
drh | 5e00f6c | 2001-09-13 13:46:56 +0000 | [diff] [blame] | 2128 | ** in memory, this routine goes to disk to read it in whereas _lookup() |
drh | 7e3b0a0 | 2001-04-28 16:52:40 +0000 | [diff] [blame] | 2129 | ** just returns 0. This routine acquires a read-lock the first time it |
| 2130 | ** has to go to disk, and could also playback an old journal if necessary. |
| 2131 | ** Since _lookup() never goes to disk, it never has to deal with locks |
| 2132 | ** or journal files. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2133 | */ |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 2134 | int sqlite3pager_get(Pager *pPager, Pgno pgno, void **ppPage){ |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2135 | PgHdr *pPg; |
drh | 8766c34 | 2002-11-09 00:33:15 +0000 | [diff] [blame] | 2136 | int rc; |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2137 | |
danielk1977 | 2683665 | 2005-01-17 01:33:13 +0000 | [diff] [blame] | 2138 | /* The maximum page number is 2^31. Return SQLITE_CORRUPT if a page |
| 2139 | ** number greater than this, or zero, is requested. |
| 2140 | */ |
| 2141 | if( pgno>PAGER_MAX_PGNO || pgno==0 ){ |
| 2142 | return SQLITE_CORRUPT; |
| 2143 | } |
| 2144 | |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2145 | /* Make sure we have not hit any critical errors. |
| 2146 | */ |
drh | 836faa4 | 2003-01-11 13:30:57 +0000 | [diff] [blame] | 2147 | assert( pPager!=0 ); |
drh | 2e6d11b | 2003-04-25 15:37:57 +0000 | [diff] [blame] | 2148 | *ppPage = 0; |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2149 | if( pPager->errMask & ~(PAGER_ERR_FULL) ){ |
| 2150 | return pager_errcode(pPager); |
| 2151 | } |
| 2152 | |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 2153 | /* If this is the first page accessed, then get a SHARED lock |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2154 | ** on the database file. |
| 2155 | */ |
drh | b7f9164 | 2004-10-31 02:22:47 +0000 | [diff] [blame] | 2156 | if( pPager->nRef==0 && !MEMDB ){ |
drh | 684917c | 2004-10-05 02:41:42 +0000 | [diff] [blame] | 2157 | rc = pager_wait_on_lock(pPager, SHARED_LOCK); |
danielk1977 | 9eed505 | 2004-06-04 10:38:30 +0000 | [diff] [blame] | 2158 | if( rc!=SQLITE_OK ){ |
| 2159 | return rc; |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2160 | } |
| 2161 | |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 2162 | /* If a journal file exists, and there is no RESERVED lock on the |
| 2163 | ** database file, then it either needs to be played back or deleted. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2164 | */ |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 2165 | if( pPager->useJournal && |
| 2166 | sqlite3OsFileExists(pPager->zJournal) && |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 2167 | !sqlite3OsCheckReservedLock(&pPager->fd) |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 2168 | ){ |
drh | e2227f0 | 2003-06-14 11:42:57 +0000 | [diff] [blame] | 2169 | int rc; |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2170 | |
danielk1977 | 90ba3bd | 2004-06-25 08:32:25 +0000 | [diff] [blame] | 2171 | /* Get an EXCLUSIVE lock on the database file. At this point it is |
| 2172 | ** important that a RESERVED lock is not obtained on the way to the |
| 2173 | ** EXCLUSIVE lock. If it were, another process might open the |
| 2174 | ** database file, detect the RESERVED lock, and conclude that the |
| 2175 | ** database is safe to read while this process is still rolling it |
| 2176 | ** back. |
| 2177 | ** |
| 2178 | ** Because the intermediate RESERVED lock is not requested, the |
| 2179 | ** second process will get to this point in the code and fail to |
| 2180 | ** obtain it's own EXCLUSIVE lock on the database file. |
| 2181 | */ |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 2182 | rc = sqlite3OsLock(&pPager->fd, EXCLUSIVE_LOCK); |
drh | a7fcb05 | 2001-12-14 15:09:55 +0000 | [diff] [blame] | 2183 | if( rc!=SQLITE_OK ){ |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 2184 | sqlite3OsUnlock(&pPager->fd, NO_LOCK); |
| 2185 | pPager->state = PAGER_UNLOCK; |
drh | 8766c34 | 2002-11-09 00:33:15 +0000 | [diff] [blame] | 2186 | return rc; |
drh | a7fcb05 | 2001-12-14 15:09:55 +0000 | [diff] [blame] | 2187 | } |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 2188 | pPager->state = PAGER_EXCLUSIVE; |
drh | a7fcb05 | 2001-12-14 15:09:55 +0000 | [diff] [blame] | 2189 | |
drh | e2227f0 | 2003-06-14 11:42:57 +0000 | [diff] [blame] | 2190 | /* Open the journal for reading only. Return SQLITE_BUSY if |
| 2191 | ** we are unable to open the journal file. |
drh | f57b339 | 2001-10-08 13:22:32 +0000 | [diff] [blame] | 2192 | ** |
drh | e2227f0 | 2003-06-14 11:42:57 +0000 | [diff] [blame] | 2193 | ** The journal file does not need to be locked itself. The |
| 2194 | ** journal file is never open unless the main database file holds |
| 2195 | ** a write lock, so there is never any chance of two or more |
| 2196 | ** processes opening the journal at the same time. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2197 | */ |
danielk1977 | 4adee20 | 2004-05-08 08:23:19 +0000 | [diff] [blame] | 2198 | rc = sqlite3OsOpenReadOnly(pPager->zJournal, &pPager->jfd); |
drh | a7fcb05 | 2001-12-14 15:09:55 +0000 | [diff] [blame] | 2199 | if( rc!=SQLITE_OK ){ |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 2200 | sqlite3OsUnlock(&pPager->fd, NO_LOCK); |
| 2201 | pPager->state = PAGER_UNLOCK; |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2202 | return SQLITE_BUSY; |
| 2203 | } |
drh | a7fcb05 | 2001-12-14 15:09:55 +0000 | [diff] [blame] | 2204 | pPager->journalOpen = 1; |
drh | db48ee0 | 2003-01-16 13:42:43 +0000 | [diff] [blame] | 2205 | pPager->journalStarted = 0; |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 2206 | pPager->journalOff = 0; |
| 2207 | pPager->setMaster = 0; |
| 2208 | pPager->journalHdr = 0; |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2209 | |
| 2210 | /* Playback and delete the journal. Drop the database write |
| 2211 | ** lock and reacquire the read lock. |
| 2212 | */ |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 2213 | rc = pager_playback(pPager); |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2214 | if( rc!=SQLITE_OK ){ |
| 2215 | return rc; |
| 2216 | } |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2217 | } |
| 2218 | pPg = 0; |
| 2219 | }else{ |
| 2220 | /* Search for page in cache */ |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2221 | pPg = pager_lookup(pPager, pgno); |
drh | b7f9164 | 2004-10-31 02:22:47 +0000 | [diff] [blame] | 2222 | if( MEMDB && pPager->state==PAGER_UNLOCK ){ |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 2223 | pPager->state = PAGER_SHARED; |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 2224 | } |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2225 | } |
| 2226 | if( pPg==0 ){ |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2227 | /* The requested page is not in the page cache. */ |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2228 | int h; |
drh | 7e3b0a0 | 2001-04-28 16:52:40 +0000 | [diff] [blame] | 2229 | pPager->nMiss++; |
drh | b7f9164 | 2004-10-31 02:22:47 +0000 | [diff] [blame] | 2230 | if( pPager->nPage<pPager->mxPage || pPager->pFirst==0 || MEMDB ){ |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2231 | /* Create a new page */ |
drh | 887dc4c | 2004-10-22 16:22:57 +0000 | [diff] [blame] | 2232 | pPg = sqliteMallocRaw( sizeof(*pPg) + pPager->psAligned |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 2233 | + sizeof(u32) + pPager->nExtra |
drh | b7f9164 | 2004-10-31 02:22:47 +0000 | [diff] [blame] | 2234 | + MEMDB*sizeof(PgHistory) ); |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2235 | if( pPg==0 ){ |
drh | b7f9164 | 2004-10-31 02:22:47 +0000 | [diff] [blame] | 2236 | if( !MEMDB ){ |
danielk1977 | 8def5ea | 2004-06-16 10:39:52 +0000 | [diff] [blame] | 2237 | pager_unwritelock(pPager); |
| 2238 | } |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2239 | pPager->errMask |= PAGER_ERR_MEM; |
| 2240 | return SQLITE_NOMEM; |
| 2241 | } |
drh | 8c1238a | 2003-01-02 14:43:55 +0000 | [diff] [blame] | 2242 | memset(pPg, 0, sizeof(*pPg)); |
drh | b7f9164 | 2004-10-31 02:22:47 +0000 | [diff] [blame] | 2243 | if( MEMDB ){ |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 2244 | memset(PGHDR_TO_HIST(pPg, pPager), 0, sizeof(PgHistory)); |
| 2245 | } |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2246 | pPg->pPager = pPager; |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2247 | pPg->pNextAll = pPager->pAll; |
drh | d79caeb | 2001-04-15 02:27:24 +0000 | [diff] [blame] | 2248 | pPager->pAll = pPg; |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2249 | pPager->nPage++; |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2250 | }else{ |
drh | db48ee0 | 2003-01-16 13:42:43 +0000 | [diff] [blame] | 2251 | /* Find a page to recycle. Try to locate a page that does not |
| 2252 | ** require us to do an fsync() on the journal. |
| 2253 | */ |
drh | 341eae8 | 2003-01-21 02:39:36 +0000 | [diff] [blame] | 2254 | pPg = pPager->pFirstSynced; |
drh | b19a2bc | 2001-09-16 00:13:26 +0000 | [diff] [blame] | 2255 | |
drh | db48ee0 | 2003-01-16 13:42:43 +0000 | [diff] [blame] | 2256 | /* If we could not find a page that does not require an fsync() |
| 2257 | ** on the journal file then fsync the journal file. This is a |
| 2258 | ** very slow operation, so we work hard to avoid it. But sometimes |
| 2259 | ** it can't be helped. |
drh | b19a2bc | 2001-09-16 00:13:26 +0000 | [diff] [blame] | 2260 | */ |
drh | 603240c | 2002-03-05 01:11:12 +0000 | [diff] [blame] | 2261 | if( pPg==0 ){ |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 2262 | int rc = syncJournal(pPager); |
drh | 50e5dad | 2001-09-15 00:57:28 +0000 | [diff] [blame] | 2263 | if( rc!=0 ){ |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 2264 | sqlite3pager_rollback(pPager); |
drh | 50e5dad | 2001-09-15 00:57:28 +0000 | [diff] [blame] | 2265 | return SQLITE_IOERR; |
| 2266 | } |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 2267 | if( pPager->fullSync ){ |
| 2268 | /* If in full-sync mode, write a new journal header into the |
| 2269 | ** journal file. This is done to avoid ever modifying a journal |
| 2270 | ** header that is involved in the rollback of pages that have |
| 2271 | ** already been written to the database (in case the header is |
| 2272 | ** trashed when the nRec field is updated). |
| 2273 | */ |
| 2274 | pPager->nRec = 0; |
danielk1977 | f187bd9 | 2004-06-25 06:23:22 +0000 | [diff] [blame] | 2275 | assert( pPager->journalOff > 0 ); |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 2276 | rc = writeJournalHdr(pPager); |
| 2277 | if( rc!=0 ){ |
| 2278 | sqlite3pager_rollback(pPager); |
| 2279 | return SQLITE_IOERR; |
| 2280 | } |
| 2281 | } |
drh | 50e5dad | 2001-09-15 00:57:28 +0000 | [diff] [blame] | 2282 | pPg = pPager->pFirst; |
| 2283 | } |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2284 | assert( pPg->nRef==0 ); |
drh | db48ee0 | 2003-01-16 13:42:43 +0000 | [diff] [blame] | 2285 | |
| 2286 | /* Write the page to the database file if it is dirty. |
| 2287 | */ |
| 2288 | if( pPg->dirty ){ |
| 2289 | assert( pPg->needSync==0 ); |
drh | 2554f8b | 2003-01-22 01:26:44 +0000 | [diff] [blame] | 2290 | pPg->pDirty = 0; |
| 2291 | rc = pager_write_pagelist( pPg ); |
drh | db48ee0 | 2003-01-16 13:42:43 +0000 | [diff] [blame] | 2292 | if( rc!=SQLITE_OK ){ |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 2293 | sqlite3pager_rollback(pPager); |
drh | db48ee0 | 2003-01-16 13:42:43 +0000 | [diff] [blame] | 2294 | return SQLITE_IOERR; |
| 2295 | } |
drh | db48ee0 | 2003-01-16 13:42:43 +0000 | [diff] [blame] | 2296 | } |
drh | 50e5dad | 2001-09-15 00:57:28 +0000 | [diff] [blame] | 2297 | assert( pPg->dirty==0 ); |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2298 | |
drh | db48ee0 | 2003-01-16 13:42:43 +0000 | [diff] [blame] | 2299 | /* If the page we are recycling is marked as alwaysRollback, then |
drh | 193a6b4 | 2002-07-07 16:52:46 +0000 | [diff] [blame] | 2300 | ** set the global alwaysRollback flag, thus disabling the |
| 2301 | ** sqlite_dont_rollback() optimization for the rest of this transaction. |
| 2302 | ** It is necessary to do this because the page marked alwaysRollback |
| 2303 | ** might be reloaded at a later time but at that point we won't remember |
| 2304 | ** that is was marked alwaysRollback. This means that all pages must |
| 2305 | ** be marked as alwaysRollback from here on out. |
| 2306 | */ |
| 2307 | if( pPg->alwaysRollback ){ |
| 2308 | pPager->alwaysRollback = 1; |
| 2309 | } |
| 2310 | |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2311 | /* Unlink the old page from the free list and the hash table |
| 2312 | */ |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 2313 | unlinkPage(pPg); |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2314 | pPager->nOvfl++; |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2315 | } |
| 2316 | pPg->pgno = pgno; |
drh | 1ab4300 | 2002-01-14 09:28:19 +0000 | [diff] [blame] | 2317 | if( pPager->aInJournal && (int)pgno<=pPager->origDbSize ){ |
danielk1977 | 4adee20 | 2004-05-08 08:23:19 +0000 | [diff] [blame] | 2318 | sqlite3CheckMemory(pPager->aInJournal, pgno/8); |
drh | db48ee0 | 2003-01-16 13:42:43 +0000 | [diff] [blame] | 2319 | assert( pPager->journalOpen ); |
drh | 6019e16 | 2001-07-02 17:51:45 +0000 | [diff] [blame] | 2320 | pPg->inJournal = (pPager->aInJournal[pgno/8] & (1<<(pgno&7)))!=0; |
drh | db48ee0 | 2003-01-16 13:42:43 +0000 | [diff] [blame] | 2321 | pPg->needSync = 0; |
drh | 6019e16 | 2001-07-02 17:51:45 +0000 | [diff] [blame] | 2322 | }else{ |
| 2323 | pPg->inJournal = 0; |
drh | db48ee0 | 2003-01-16 13:42:43 +0000 | [diff] [blame] | 2324 | pPg->needSync = 0; |
drh | 6019e16 | 2001-07-02 17:51:45 +0000 | [diff] [blame] | 2325 | } |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 2326 | if( pPager->aInStmt && (int)pgno<=pPager->stmtSize |
| 2327 | && (pPager->aInStmt[pgno/8] & (1<<(pgno&7)))!=0 ){ |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 2328 | page_add_to_stmt_list(pPg); |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 2329 | }else{ |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 2330 | page_remove_from_stmt_list(pPg); |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 2331 | } |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2332 | pPg->dirty = 0; |
| 2333 | pPg->nRef = 1; |
drh | dd79342 | 2001-06-28 01:54:48 +0000 | [diff] [blame] | 2334 | REFINFO(pPg); |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2335 | pPager->nRef++; |
| 2336 | h = pager_hash(pgno); |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2337 | pPg->pNextHash = pPager->aHash[h]; |
| 2338 | pPager->aHash[h] = pPg; |
| 2339 | if( pPg->pNextHash ){ |
| 2340 | assert( pPg->pNextHash->pPrevHash==0 ); |
| 2341 | pPg->pNextHash->pPrevHash = pPg; |
| 2342 | } |
drh | 2e6d11b | 2003-04-25 15:37:57 +0000 | [diff] [blame] | 2343 | if( pPager->nExtra>0 ){ |
drh | 90f5ecb | 2004-07-22 01:19:35 +0000 | [diff] [blame] | 2344 | memset(PGHDR_TO_EXTRA(pPg, pPager), 0, pPager->nExtra); |
drh | 2e6d11b | 2003-04-25 15:37:57 +0000 | [diff] [blame] | 2345 | } |
drh | dc3ff9c | 2004-08-18 02:10:15 +0000 | [diff] [blame] | 2346 | sqlite3pager_pagecount(pPager); |
drh | 2e6d11b | 2003-04-25 15:37:57 +0000 | [diff] [blame] | 2347 | if( pPager->errMask!=0 ){ |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 2348 | sqlite3pager_unref(PGHDR_TO_DATA(pPg)); |
drh | 2e6d11b | 2003-04-25 15:37:57 +0000 | [diff] [blame] | 2349 | rc = pager_errcode(pPager); |
| 2350 | return rc; |
| 2351 | } |
drh | 1ab4300 | 2002-01-14 09:28:19 +0000 | [diff] [blame] | 2352 | if( pPager->dbSize<(int)pgno ){ |
drh | 90f5ecb | 2004-07-22 01:19:35 +0000 | [diff] [blame] | 2353 | memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize); |
drh | 306dc21 | 2001-05-21 13:45:10 +0000 | [diff] [blame] | 2354 | }else{ |
drh | 81a20f2 | 2001-10-12 17:30:04 +0000 | [diff] [blame] | 2355 | int rc; |
drh | b7f9164 | 2004-10-31 02:22:47 +0000 | [diff] [blame] | 2356 | assert( MEMDB==0 ); |
drh | eb20625 | 2004-10-01 02:00:31 +0000 | [diff] [blame] | 2357 | sqlite3OsSeek(&pPager->fd, (pgno-1)*(i64)pPager->pageSize); |
drh | 90f5ecb | 2004-07-22 01:19:35 +0000 | [diff] [blame] | 2358 | rc = sqlite3OsRead(&pPager->fd, PGHDR_TO_DATA(pPg), pPager->pageSize); |
danielk1977 | ef73ee9 | 2004-11-06 12:26:07 +0000 | [diff] [blame] | 2359 | TRACE3("FETCH %d page %d\n", PAGERID(pPager), pPg->pgno); |
drh | 9eb9e26 | 2004-02-11 02:18:05 +0000 | [diff] [blame] | 2360 | CODEC(pPager, PGHDR_TO_DATA(pPg), pPg->pgno, 3); |
drh | 81a20f2 | 2001-10-12 17:30:04 +0000 | [diff] [blame] | 2361 | if( rc!=SQLITE_OK ){ |
drh | eb20625 | 2004-10-01 02:00:31 +0000 | [diff] [blame] | 2362 | i64 fileSize; |
danielk1977 | 4adee20 | 2004-05-08 08:23:19 +0000 | [diff] [blame] | 2363 | if( sqlite3OsFileSize(&pPager->fd,&fileSize)!=SQLITE_OK |
drh | 90f5ecb | 2004-07-22 01:19:35 +0000 | [diff] [blame] | 2364 | || fileSize>=pgno*pPager->pageSize ){ |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 2365 | sqlite3pager_unref(PGHDR_TO_DATA(pPg)); |
drh | 4e371ee | 2002-09-05 16:08:27 +0000 | [diff] [blame] | 2366 | return rc; |
| 2367 | }else{ |
drh | 90f5ecb | 2004-07-22 01:19:35 +0000 | [diff] [blame] | 2368 | memset(PGHDR_TO_DATA(pPg), 0, pPager->pageSize); |
drh | 4e371ee | 2002-09-05 16:08:27 +0000 | [diff] [blame] | 2369 | } |
danielk1977 | 42741be | 2005-01-08 12:42:39 +0000 | [diff] [blame] | 2370 | }else{ |
| 2371 | pPager->nRead++; |
drh | 81a20f2 | 2001-10-12 17:30:04 +0000 | [diff] [blame] | 2372 | } |
drh | 306dc21 | 2001-05-21 13:45:10 +0000 | [diff] [blame] | 2373 | } |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2374 | }else{ |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2375 | /* The requested page is in the page cache. */ |
drh | 7e3b0a0 | 2001-04-28 16:52:40 +0000 | [diff] [blame] | 2376 | pPager->nHit++; |
drh | df0b3b0 | 2001-06-23 11:36:20 +0000 | [diff] [blame] | 2377 | page_ref(pPg); |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2378 | } |
| 2379 | *ppPage = PGHDR_TO_DATA(pPg); |
| 2380 | return SQLITE_OK; |
| 2381 | } |
| 2382 | |
| 2383 | /* |
drh | 7e3b0a0 | 2001-04-28 16:52:40 +0000 | [diff] [blame] | 2384 | ** Acquire a page if it is already in the in-memory cache. Do |
| 2385 | ** not read the page from disk. Return a pointer to the page, |
| 2386 | ** or 0 if the page is not in cache. |
| 2387 | ** |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 2388 | ** See also sqlite3pager_get(). The difference between this routine |
| 2389 | ** and sqlite3pager_get() is that _get() will go to the disk and read |
drh | 7e3b0a0 | 2001-04-28 16:52:40 +0000 | [diff] [blame] | 2390 | ** in the page if the page is not already in cache. This routine |
drh | 5e00f6c | 2001-09-13 13:46:56 +0000 | [diff] [blame] | 2391 | ** returns NULL if the page is not in cache or if a disk I/O error |
| 2392 | ** has ever happened. |
drh | 7e3b0a0 | 2001-04-28 16:52:40 +0000 | [diff] [blame] | 2393 | */ |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 2394 | void *sqlite3pager_lookup(Pager *pPager, Pgno pgno){ |
drh | 7e3b0a0 | 2001-04-28 16:52:40 +0000 | [diff] [blame] | 2395 | PgHdr *pPg; |
| 2396 | |
drh | 836faa4 | 2003-01-11 13:30:57 +0000 | [diff] [blame] | 2397 | assert( pPager!=0 ); |
| 2398 | assert( pgno!=0 ); |
drh | 7e3b0a0 | 2001-04-28 16:52:40 +0000 | [diff] [blame] | 2399 | if( pPager->errMask & ~(PAGER_ERR_FULL) ){ |
| 2400 | return 0; |
| 2401 | } |
drh | 7e3b0a0 | 2001-04-28 16:52:40 +0000 | [diff] [blame] | 2402 | pPg = pager_lookup(pPager, pgno); |
| 2403 | if( pPg==0 ) return 0; |
drh | df0b3b0 | 2001-06-23 11:36:20 +0000 | [diff] [blame] | 2404 | page_ref(pPg); |
drh | 7e3b0a0 | 2001-04-28 16:52:40 +0000 | [diff] [blame] | 2405 | return PGHDR_TO_DATA(pPg); |
| 2406 | } |
| 2407 | |
| 2408 | /* |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2409 | ** Release a page. |
| 2410 | ** |
| 2411 | ** If the number of references to the page drop to zero, then the |
| 2412 | ** page is added to the LRU list. When all references to all pages |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2413 | ** are released, a rollback occurs and the lock on the database is |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2414 | ** removed. |
| 2415 | */ |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 2416 | int sqlite3pager_unref(void *pData){ |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2417 | PgHdr *pPg; |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2418 | |
| 2419 | /* Decrement the reference count for this page |
| 2420 | */ |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2421 | pPg = DATA_TO_PGHDR(pData); |
| 2422 | assert( pPg->nRef>0 ); |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2423 | pPg->nRef--; |
drh | dd79342 | 2001-06-28 01:54:48 +0000 | [diff] [blame] | 2424 | REFINFO(pPg); |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2425 | |
drh | 72f8286 | 2001-05-24 21:06:34 +0000 | [diff] [blame] | 2426 | /* When the number of references to a page reach 0, call the |
| 2427 | ** destructor and add the page to the freelist. |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2428 | */ |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2429 | if( pPg->nRef==0 ){ |
drh | 1eaa269 | 2001-09-18 02:02:23 +0000 | [diff] [blame] | 2430 | Pager *pPager; |
| 2431 | pPager = pPg->pPager; |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2432 | pPg->pNextFree = 0; |
| 2433 | pPg->pPrevFree = pPager->pLast; |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2434 | pPager->pLast = pPg; |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2435 | if( pPg->pPrevFree ){ |
| 2436 | pPg->pPrevFree->pNextFree = pPg; |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2437 | }else{ |
| 2438 | pPager->pFirst = pPg; |
| 2439 | } |
drh | 341eae8 | 2003-01-21 02:39:36 +0000 | [diff] [blame] | 2440 | if( pPg->needSync==0 && pPager->pFirstSynced==0 ){ |
| 2441 | pPager->pFirstSynced = pPg; |
| 2442 | } |
drh | 72f8286 | 2001-05-24 21:06:34 +0000 | [diff] [blame] | 2443 | if( pPager->xDestructor ){ |
drh | b6f4148 | 2004-05-14 01:58:11 +0000 | [diff] [blame] | 2444 | pPager->xDestructor(pData, pPager->pageSize); |
drh | 72f8286 | 2001-05-24 21:06:34 +0000 | [diff] [blame] | 2445 | } |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2446 | |
| 2447 | /* When all pages reach the freelist, drop the read lock from |
| 2448 | ** the database file. |
| 2449 | */ |
| 2450 | pPager->nRef--; |
| 2451 | assert( pPager->nRef>=0 ); |
drh | b7f9164 | 2004-10-31 02:22:47 +0000 | [diff] [blame] | 2452 | if( pPager->nRef==0 && !MEMDB ){ |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2453 | pager_reset(pPager); |
| 2454 | } |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2455 | } |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2456 | return SQLITE_OK; |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2457 | } |
| 2458 | |
| 2459 | /* |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 2460 | ** Create a journal file for pPager. There should already be a RESERVED |
| 2461 | ** or EXCLUSIVE lock on the database file when this routine is called. |
drh | da47d77 | 2002-12-02 04:25:19 +0000 | [diff] [blame] | 2462 | ** |
| 2463 | ** Return SQLITE_OK if everything. Return an error code and release the |
| 2464 | ** write lock if anything goes wrong. |
| 2465 | */ |
| 2466 | static int pager_open_journal(Pager *pPager){ |
| 2467 | int rc; |
drh | b7f9164 | 2004-10-31 02:22:47 +0000 | [diff] [blame] | 2468 | assert( !MEMDB ); |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 2469 | assert( pPager->state>=PAGER_RESERVED ); |
drh | da47d77 | 2002-12-02 04:25:19 +0000 | [diff] [blame] | 2470 | assert( pPager->journalOpen==0 ); |
| 2471 | assert( pPager->useJournal ); |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 2472 | sqlite3pager_pagecount(pPager); |
drh | da47d77 | 2002-12-02 04:25:19 +0000 | [diff] [blame] | 2473 | pPager->aInJournal = sqliteMalloc( pPager->dbSize/8 + 1 ); |
| 2474 | if( pPager->aInJournal==0 ){ |
drh | 9c105bb | 2004-10-02 20:38:28 +0000 | [diff] [blame] | 2475 | rc = SQLITE_NOMEM; |
| 2476 | goto failed_to_open_journal; |
drh | da47d77 | 2002-12-02 04:25:19 +0000 | [diff] [blame] | 2477 | } |
danielk1977 | 4adee20 | 2004-05-08 08:23:19 +0000 | [diff] [blame] | 2478 | rc = sqlite3OsOpenExclusive(pPager->zJournal, &pPager->jfd,pPager->tempFile); |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 2479 | pPager->journalOff = 0; |
| 2480 | pPager->setMaster = 0; |
| 2481 | pPager->journalHdr = 0; |
drh | da47d77 | 2002-12-02 04:25:19 +0000 | [diff] [blame] | 2482 | if( rc!=SQLITE_OK ){ |
drh | 9c105bb | 2004-10-02 20:38:28 +0000 | [diff] [blame] | 2483 | goto failed_to_open_journal; |
drh | da47d77 | 2002-12-02 04:25:19 +0000 | [diff] [blame] | 2484 | } |
danielk1977 | 4adee20 | 2004-05-08 08:23:19 +0000 | [diff] [blame] | 2485 | sqlite3OsOpenDirectory(pPager->zDirectory, &pPager->jfd); |
drh | da47d77 | 2002-12-02 04:25:19 +0000 | [diff] [blame] | 2486 | pPager->journalOpen = 1; |
drh | db48ee0 | 2003-01-16 13:42:43 +0000 | [diff] [blame] | 2487 | pPager->journalStarted = 0; |
drh | da47d77 | 2002-12-02 04:25:19 +0000 | [diff] [blame] | 2488 | pPager->needSync = 0; |
| 2489 | pPager->alwaysRollback = 0; |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 2490 | pPager->nRec = 0; |
drh | 2e6d11b | 2003-04-25 15:37:57 +0000 | [diff] [blame] | 2491 | if( pPager->errMask!=0 ){ |
| 2492 | rc = pager_errcode(pPager); |
| 2493 | return rc; |
| 2494 | } |
drh | da47d77 | 2002-12-02 04:25:19 +0000 | [diff] [blame] | 2495 | pPager->origDbSize = pPager->dbSize; |
drh | ae2b40c | 2004-06-09 19:03:54 +0000 | [diff] [blame] | 2496 | |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 2497 | rc = writeJournalHdr(pPager); |
| 2498 | |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 2499 | if( pPager->stmtAutoopen && rc==SQLITE_OK ){ |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 2500 | rc = sqlite3pager_stmt_begin(pPager); |
drh | da47d77 | 2002-12-02 04:25:19 +0000 | [diff] [blame] | 2501 | } |
| 2502 | if( rc!=SQLITE_OK ){ |
| 2503 | rc = pager_unwritelock(pPager); |
| 2504 | if( rc==SQLITE_OK ){ |
| 2505 | rc = SQLITE_FULL; |
| 2506 | } |
| 2507 | } |
drh | 9c105bb | 2004-10-02 20:38:28 +0000 | [diff] [blame] | 2508 | return rc; |
| 2509 | |
| 2510 | failed_to_open_journal: |
| 2511 | sqliteFree(pPager->aInJournal); |
| 2512 | pPager->aInJournal = 0; |
| 2513 | sqlite3OsUnlock(&pPager->fd, NO_LOCK); |
| 2514 | pPager->state = PAGER_UNLOCK; |
| 2515 | return rc; |
drh | da47d77 | 2002-12-02 04:25:19 +0000 | [diff] [blame] | 2516 | } |
| 2517 | |
| 2518 | /* |
drh | 4b845d7 | 2002-03-05 12:41:19 +0000 | [diff] [blame] | 2519 | ** Acquire a write-lock on the database. The lock is removed when |
| 2520 | ** the any of the following happen: |
| 2521 | ** |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 2522 | ** * sqlite3pager_commit() is called. |
| 2523 | ** * sqlite3pager_rollback() is called. |
| 2524 | ** * sqlite3pager_close() is called. |
| 2525 | ** * sqlite3pager_unref() is called to on every outstanding page. |
drh | 4b845d7 | 2002-03-05 12:41:19 +0000 | [diff] [blame] | 2526 | ** |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 2527 | ** The first parameter to this routine is a pointer to any open page of the |
| 2528 | ** database file. Nothing changes about the page - it is used merely to |
| 2529 | ** acquire a pointer to the Pager structure and as proof that there is |
| 2530 | ** already a read-lock on the database. |
drh | 4b845d7 | 2002-03-05 12:41:19 +0000 | [diff] [blame] | 2531 | ** |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 2532 | ** The second parameter indicates how much space in bytes to reserve for a |
| 2533 | ** master journal file-name at the start of the journal when it is created. |
| 2534 | ** |
| 2535 | ** A journal file is opened if this is not a temporary file. For temporary |
| 2536 | ** files, the opening of the journal file is deferred until there is an |
| 2537 | ** actual need to write to the journal. |
drh | da47d77 | 2002-12-02 04:25:19 +0000 | [diff] [blame] | 2538 | ** |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 2539 | ** 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] | 2540 | ** |
| 2541 | ** If exFlag is true, go ahead and get an EXCLUSIVE lock on the file |
| 2542 | ** immediately instead of waiting until we try to flush the cache. The |
| 2543 | ** exFlag is ignored if a transaction is already active. |
drh | 4b845d7 | 2002-03-05 12:41:19 +0000 | [diff] [blame] | 2544 | */ |
drh | 684917c | 2004-10-05 02:41:42 +0000 | [diff] [blame] | 2545 | int sqlite3pager_begin(void *pData, int exFlag){ |
drh | 4b845d7 | 2002-03-05 12:41:19 +0000 | [diff] [blame] | 2546 | PgHdr *pPg = DATA_TO_PGHDR(pData); |
| 2547 | Pager *pPager = pPg->pPager; |
| 2548 | int rc = SQLITE_OK; |
| 2549 | assert( pPg->nRef>0 ); |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 2550 | assert( pPager->state!=PAGER_UNLOCK ); |
| 2551 | if( pPager->state==PAGER_SHARED ){ |
drh | 4b845d7 | 2002-03-05 12:41:19 +0000 | [diff] [blame] | 2552 | assert( pPager->aInJournal==0 ); |
drh | b7f9164 | 2004-10-31 02:22:47 +0000 | [diff] [blame] | 2553 | if( MEMDB ){ |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 2554 | pPager->state = PAGER_EXCLUSIVE; |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 2555 | pPager->origDbSize = pPager->dbSize; |
| 2556 | }else{ |
drh | 684917c | 2004-10-05 02:41:42 +0000 | [diff] [blame] | 2557 | if( SQLITE_BUSY_RESERVED_LOCK || exFlag ){ |
| 2558 | rc = pager_wait_on_lock(pPager, RESERVED_LOCK); |
| 2559 | }else{ |
danielk1977 | 9eed505 | 2004-06-04 10:38:30 +0000 | [diff] [blame] | 2560 | rc = sqlite3OsLock(&pPager->fd, RESERVED_LOCK); |
drh | 684917c | 2004-10-05 02:41:42 +0000 | [diff] [blame] | 2561 | } |
| 2562 | if( rc==SQLITE_OK ){ |
| 2563 | pPager->state = PAGER_RESERVED; |
| 2564 | if( exFlag ){ |
| 2565 | rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK); |
| 2566 | } |
| 2567 | } |
danielk1977 | 9eed505 | 2004-06-04 10:38:30 +0000 | [diff] [blame] | 2568 | if( rc!=SQLITE_OK ){ |
| 2569 | return rc; |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 2570 | } |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 2571 | pPager->dirtyCache = 0; |
danielk1977 | ef73ee9 | 2004-11-06 12:26:07 +0000 | [diff] [blame] | 2572 | TRACE2("TRANSACTION %d\n", PAGERID(pPager)); |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 2573 | if( pPager->useJournal && !pPager->tempFile ){ |
| 2574 | rc = pager_open_journal(pPager); |
| 2575 | } |
drh | 4b845d7 | 2002-03-05 12:41:19 +0000 | [diff] [blame] | 2576 | } |
| 2577 | } |
| 2578 | return rc; |
| 2579 | } |
| 2580 | |
| 2581 | /* |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2582 | ** Mark a data page as writeable. The page is written into the journal |
| 2583 | ** if it is not there already. This routine must be called before making |
| 2584 | ** changes to a page. |
| 2585 | ** |
| 2586 | ** The first time this routine is called, the pager creates a new |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 2587 | ** journal and acquires a RESERVED lock on the database. If the RESERVED |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2588 | ** lock could not be acquired, this routine returns SQLITE_BUSY. The |
drh | 306dc21 | 2001-05-21 13:45:10 +0000 | [diff] [blame] | 2589 | ** calling routine must check for that return value and be careful not to |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2590 | ** change any page data until this routine returns SQLITE_OK. |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2591 | ** |
| 2592 | ** If the journal file could not be written because the disk is full, |
| 2593 | ** then this routine returns SQLITE_FULL and does an immediate rollback. |
| 2594 | ** All subsequent write attempts also return SQLITE_FULL until there |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 2595 | ** is a call to sqlite3pager_commit() or sqlite3pager_rollback() to |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2596 | ** reset. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2597 | */ |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 2598 | int sqlite3pager_write(void *pData){ |
drh | 69688d5 | 2001-04-14 16:38:23 +0000 | [diff] [blame] | 2599 | PgHdr *pPg = DATA_TO_PGHDR(pData); |
| 2600 | Pager *pPager = pPg->pPager; |
drh | d79caeb | 2001-04-15 02:27:24 +0000 | [diff] [blame] | 2601 | int rc = SQLITE_OK; |
drh | 69688d5 | 2001-04-14 16:38:23 +0000 | [diff] [blame] | 2602 | |
drh | 6446c4d | 2001-12-15 14:22:18 +0000 | [diff] [blame] | 2603 | /* Check for errors |
| 2604 | */ |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2605 | if( pPager->errMask ){ |
| 2606 | return pager_errcode(pPager); |
| 2607 | } |
drh | 5e00f6c | 2001-09-13 13:46:56 +0000 | [diff] [blame] | 2608 | if( pPager->readOnly ){ |
| 2609 | return SQLITE_PERM; |
| 2610 | } |
drh | 6446c4d | 2001-12-15 14:22:18 +0000 | [diff] [blame] | 2611 | |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 2612 | assert( !pPager->setMaster ); |
| 2613 | |
drh | 6446c4d | 2001-12-15 14:22:18 +0000 | [diff] [blame] | 2614 | /* Mark the page as dirty. If the page has already been written |
| 2615 | ** to the journal then we can return right away. |
| 2616 | */ |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2617 | pPg->dirty = 1; |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 2618 | if( pPg->inJournal && (pPg->inStmt || pPager->stmtInUse==0) ){ |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 2619 | pPager->dirtyCache = 1; |
danielk1977 | a0bf265 | 2004-11-04 14:30:04 +0000 | [diff] [blame] | 2620 | }else{ |
drh | 6446c4d | 2001-12-15 14:22:18 +0000 | [diff] [blame] | 2621 | |
danielk1977 | a0bf265 | 2004-11-04 14:30:04 +0000 | [diff] [blame] | 2622 | /* If we get this far, it means that the page needs to be |
| 2623 | ** written to the transaction journal or the ckeckpoint journal |
| 2624 | ** or both. |
| 2625 | ** |
| 2626 | ** First check to see that the transaction journal exists and |
| 2627 | ** create it if it does not. |
| 2628 | */ |
| 2629 | assert( pPager->state!=PAGER_UNLOCK ); |
| 2630 | rc = sqlite3pager_begin(pData, 0); |
| 2631 | if( rc!=SQLITE_OK ){ |
| 2632 | return rc; |
| 2633 | } |
| 2634 | assert( pPager->state>=PAGER_RESERVED ); |
| 2635 | if( !pPager->journalOpen && pPager->useJournal ){ |
| 2636 | rc = pager_open_journal(pPager); |
| 2637 | if( rc!=SQLITE_OK ) return rc; |
| 2638 | } |
| 2639 | assert( pPager->journalOpen || !pPager->useJournal ); |
| 2640 | pPager->dirtyCache = 1; |
| 2641 | |
| 2642 | /* The transaction journal now exists and we have a RESERVED or an |
| 2643 | ** EXCLUSIVE lock on the main database file. Write the current page to |
| 2644 | ** the transaction journal if it is not there already. |
| 2645 | */ |
| 2646 | if( !pPg->inJournal && (pPager->useJournal || MEMDB) ){ |
| 2647 | if( (int)pPg->pgno <= pPager->origDbSize ){ |
| 2648 | int szPg; |
| 2649 | u32 saved; |
| 2650 | if( MEMDB ){ |
| 2651 | PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager); |
danielk1977 | ef73ee9 | 2004-11-06 12:26:07 +0000 | [diff] [blame] | 2652 | TRACE3("JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno); |
danielk1977 | a0bf265 | 2004-11-04 14:30:04 +0000 | [diff] [blame] | 2653 | assert( pHist->pOrig==0 ); |
| 2654 | pHist->pOrig = sqliteMallocRaw( pPager->pageSize ); |
| 2655 | if( pHist->pOrig ){ |
| 2656 | memcpy(pHist->pOrig, PGHDR_TO_DATA(pPg), pPager->pageSize); |
| 2657 | } |
| 2658 | }else{ |
| 2659 | u32 cksum; |
| 2660 | CODEC(pPager, pData, pPg->pgno, 7); |
| 2661 | cksum = pager_cksum(pPager, pPg->pgno, pData); |
| 2662 | saved = *(u32*)PGHDR_TO_EXTRA(pPg, pPager); |
| 2663 | store32bits(cksum, pPg, pPager->pageSize); |
| 2664 | szPg = pPager->pageSize+8; |
| 2665 | store32bits(pPg->pgno, pPg, -4); |
| 2666 | rc = sqlite3OsWrite(&pPager->jfd, &((char*)pData)[-4], szPg); |
| 2667 | pPager->journalOff += szPg; |
| 2668 | TRACE4("JOURNAL %d page %d needSync=%d\n", |
danielk1977 | ef73ee9 | 2004-11-06 12:26:07 +0000 | [diff] [blame] | 2669 | PAGERID(pPager), pPg->pgno, pPg->needSync); |
danielk1977 | a0bf265 | 2004-11-04 14:30:04 +0000 | [diff] [blame] | 2670 | CODEC(pPager, pData, pPg->pgno, 0); |
| 2671 | *(u32*)PGHDR_TO_EXTRA(pPg, pPager) = saved; |
| 2672 | if( rc!=SQLITE_OK ){ |
| 2673 | sqlite3pager_rollback(pPager); |
| 2674 | pPager->errMask |= PAGER_ERR_FULL; |
| 2675 | return rc; |
| 2676 | } |
| 2677 | pPager->nRec++; |
| 2678 | assert( pPager->aInJournal!=0 ); |
| 2679 | pPager->aInJournal[pPg->pgno/8] |= 1<<(pPg->pgno&7); |
| 2680 | pPg->needSync = !pPager->noSync; |
| 2681 | if( pPager->stmtInUse ){ |
| 2682 | pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7); |
| 2683 | page_add_to_stmt_list(pPg); |
| 2684 | } |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 2685 | } |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 2686 | }else{ |
danielk1977 | a0bf265 | 2004-11-04 14:30:04 +0000 | [diff] [blame] | 2687 | pPg->needSync = !pPager->journalStarted && !pPager->noSync; |
| 2688 | TRACE4("APPEND %d page %d needSync=%d\n", |
danielk1977 | ef73ee9 | 2004-11-06 12:26:07 +0000 | [diff] [blame] | 2689 | PAGERID(pPager), pPg->pgno, pPg->needSync); |
danielk1977 | a0bf265 | 2004-11-04 14:30:04 +0000 | [diff] [blame] | 2690 | } |
| 2691 | if( pPg->needSync ){ |
| 2692 | pPager->needSync = 1; |
| 2693 | } |
| 2694 | pPg->inJournal = 1; |
| 2695 | } |
| 2696 | |
| 2697 | /* If the statement journal is open and the page is not in it, |
| 2698 | ** then write the current page to the statement journal. Note that |
| 2699 | ** the statement journal format differs from the standard journal format |
| 2700 | ** in that it omits the checksums and the header. |
| 2701 | */ |
| 2702 | if( pPager->stmtInUse && !pPg->inStmt && (int)pPg->pgno<=pPager->stmtSize ){ |
| 2703 | assert( pPg->inJournal || (int)pPg->pgno>pPager->origDbSize ); |
| 2704 | if( MEMDB ){ |
| 2705 | PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager); |
| 2706 | assert( pHist->pStmt==0 ); |
| 2707 | pHist->pStmt = sqliteMallocRaw( pPager->pageSize ); |
| 2708 | if( pHist->pStmt ){ |
| 2709 | memcpy(pHist->pStmt, PGHDR_TO_DATA(pPg), pPager->pageSize); |
| 2710 | } |
danielk1977 | ef73ee9 | 2004-11-06 12:26:07 +0000 | [diff] [blame] | 2711 | TRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno); |
danielk1977 | a0bf265 | 2004-11-04 14:30:04 +0000 | [diff] [blame] | 2712 | }else{ |
| 2713 | store32bits(pPg->pgno, pPg, -4); |
| 2714 | CODEC(pPager, pData, pPg->pgno, 7); |
| 2715 | rc = sqlite3OsWrite(&pPager->stfd,((char*)pData)-4, pPager->pageSize+4); |
danielk1977 | ef73ee9 | 2004-11-06 12:26:07 +0000 | [diff] [blame] | 2716 | TRACE3("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno); |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 2717 | CODEC(pPager, pData, pPg->pgno, 0); |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 2718 | if( rc!=SQLITE_OK ){ |
| 2719 | sqlite3pager_rollback(pPager); |
| 2720 | pPager->errMask |= PAGER_ERR_FULL; |
| 2721 | return rc; |
| 2722 | } |
danielk1977 | a0bf265 | 2004-11-04 14:30:04 +0000 | [diff] [blame] | 2723 | pPager->stmtNRec++; |
| 2724 | assert( pPager->aInStmt!=0 ); |
| 2725 | pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7); |
drh | db48ee0 | 2003-01-16 13:42:43 +0000 | [diff] [blame] | 2726 | } |
danielk1977 | a0bf265 | 2004-11-04 14:30:04 +0000 | [diff] [blame] | 2727 | page_add_to_stmt_list(pPg); |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2728 | } |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 2729 | } |
| 2730 | |
| 2731 | /* Update the database size and return. |
| 2732 | */ |
drh | 1ab4300 | 2002-01-14 09:28:19 +0000 | [diff] [blame] | 2733 | if( pPager->dbSize<(int)pPg->pgno ){ |
drh | 306dc21 | 2001-05-21 13:45:10 +0000 | [diff] [blame] | 2734 | pPager->dbSize = pPg->pgno; |
drh | b7f9164 | 2004-10-31 02:22:47 +0000 | [diff] [blame] | 2735 | if( !MEMDB && pPager->dbSize==PENDING_BYTE/pPager->pageSize ){ |
drh | 1f59571 | 2004-06-15 01:40:29 +0000 | [diff] [blame] | 2736 | pPager->dbSize++; |
| 2737 | } |
drh | 306dc21 | 2001-05-21 13:45:10 +0000 | [diff] [blame] | 2738 | } |
drh | 69688d5 | 2001-04-14 16:38:23 +0000 | [diff] [blame] | 2739 | return rc; |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2740 | } |
| 2741 | |
| 2742 | /* |
drh | aacc543 | 2002-01-06 17:07:40 +0000 | [diff] [blame] | 2743 | ** Return TRUE if the page given in the argument was previously passed |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 2744 | ** to sqlite3pager_write(). In other words, return TRUE if it is ok |
drh | 6019e16 | 2001-07-02 17:51:45 +0000 | [diff] [blame] | 2745 | ** to change the content of the page. |
| 2746 | */ |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 2747 | int sqlite3pager_iswriteable(void *pData){ |
drh | 6019e16 | 2001-07-02 17:51:45 +0000 | [diff] [blame] | 2748 | PgHdr *pPg = DATA_TO_PGHDR(pData); |
| 2749 | return pPg->dirty; |
| 2750 | } |
| 2751 | |
danielk1977 | b84f96f | 2005-01-20 11:32:23 +0000 | [diff] [blame] | 2752 | #ifndef SQLITE_OMIT_VACUUM |
drh | 6019e16 | 2001-07-02 17:51:45 +0000 | [diff] [blame] | 2753 | /* |
drh | 001bbcb | 2003-03-19 03:14:00 +0000 | [diff] [blame] | 2754 | ** Replace the content of a single page with the information in the third |
| 2755 | ** argument. |
| 2756 | */ |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 2757 | int sqlite3pager_overwrite(Pager *pPager, Pgno pgno, void *pData){ |
drh | 001bbcb | 2003-03-19 03:14:00 +0000 | [diff] [blame] | 2758 | void *pPage; |
| 2759 | int rc; |
| 2760 | |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 2761 | rc = sqlite3pager_get(pPager, pgno, &pPage); |
drh | 001bbcb | 2003-03-19 03:14:00 +0000 | [diff] [blame] | 2762 | if( rc==SQLITE_OK ){ |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 2763 | rc = sqlite3pager_write(pPage); |
drh | 001bbcb | 2003-03-19 03:14:00 +0000 | [diff] [blame] | 2764 | if( rc==SQLITE_OK ){ |
drh | 90f5ecb | 2004-07-22 01:19:35 +0000 | [diff] [blame] | 2765 | memcpy(pPage, pData, pPager->pageSize); |
drh | 001bbcb | 2003-03-19 03:14:00 +0000 | [diff] [blame] | 2766 | } |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 2767 | sqlite3pager_unref(pPage); |
drh | 001bbcb | 2003-03-19 03:14:00 +0000 | [diff] [blame] | 2768 | } |
| 2769 | return rc; |
| 2770 | } |
danielk1977 | b84f96f | 2005-01-20 11:32:23 +0000 | [diff] [blame] | 2771 | #endif |
drh | 001bbcb | 2003-03-19 03:14:00 +0000 | [diff] [blame] | 2772 | |
| 2773 | /* |
drh | 30e5875 | 2002-03-02 20:41:57 +0000 | [diff] [blame] | 2774 | ** A call to this routine tells the pager that it is not necessary to |
| 2775 | ** write the information on page "pgno" back to the disk, even though |
| 2776 | ** that page might be marked as dirty. |
| 2777 | ** |
| 2778 | ** The overlying software layer calls this routine when all of the data |
| 2779 | ** on the given page is unused. The pager marks the page as clean so |
| 2780 | ** that it does not get written to disk. |
| 2781 | ** |
| 2782 | ** Tests show that this optimization, together with the |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 2783 | ** sqlite3pager_dont_rollback() below, more than double the speed |
drh | 30e5875 | 2002-03-02 20:41:57 +0000 | [diff] [blame] | 2784 | ** of large INSERT operations and quadruple the speed of large DELETEs. |
drh | 8e298f9 | 2002-07-06 16:28:47 +0000 | [diff] [blame] | 2785 | ** |
| 2786 | ** When this routine is called, set the alwaysRollback flag to true. |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 2787 | ** Subsequent calls to sqlite3pager_dont_rollback() for the same page |
drh | 8e298f9 | 2002-07-06 16:28:47 +0000 | [diff] [blame] | 2788 | ** will thereafter be ignored. This is necessary to avoid a problem |
| 2789 | ** where a page with data is added to the freelist during one part of |
| 2790 | ** a transaction then removed from the freelist during a later part |
| 2791 | ** of the same transaction and reused for some other purpose. When it |
| 2792 | ** is first added to the freelist, this routine is called. When reused, |
| 2793 | ** the dont_rollback() routine is called. But because the page contains |
| 2794 | ** critical data, we still need to be sure it gets rolled back in spite |
| 2795 | ** of the dont_rollback() call. |
drh | 30e5875 | 2002-03-02 20:41:57 +0000 | [diff] [blame] | 2796 | */ |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 2797 | void sqlite3pager_dont_write(Pager *pPager, Pgno pgno){ |
drh | 30e5875 | 2002-03-02 20:41:57 +0000 | [diff] [blame] | 2798 | PgHdr *pPg; |
drh | 8e298f9 | 2002-07-06 16:28:47 +0000 | [diff] [blame] | 2799 | |
drh | b7f9164 | 2004-10-31 02:22:47 +0000 | [diff] [blame] | 2800 | if( MEMDB ) return; |
danielk1977 | eac7a36 | 2004-06-16 07:45:24 +0000 | [diff] [blame] | 2801 | |
drh | 30e5875 | 2002-03-02 20:41:57 +0000 | [diff] [blame] | 2802 | pPg = pager_lookup(pPager, pgno); |
drh | 8e298f9 | 2002-07-06 16:28:47 +0000 | [diff] [blame] | 2803 | pPg->alwaysRollback = 1; |
drh | 30e5875 | 2002-03-02 20:41:57 +0000 | [diff] [blame] | 2804 | if( pPg && pPg->dirty ){ |
drh | 8124a30 | 2002-06-25 14:43:57 +0000 | [diff] [blame] | 2805 | if( pPager->dbSize==(int)pPg->pgno && pPager->origDbSize<pPager->dbSize ){ |
| 2806 | /* If this pages is the last page in the file and the file has grown |
| 2807 | ** during the current transaction, then do NOT mark the page as clean. |
| 2808 | ** When the database file grows, we must make sure that the last page |
| 2809 | ** gets written at least once so that the disk file will be the correct |
| 2810 | ** size. If you do not write this page and the size of the file |
| 2811 | ** on the disk ends up being too small, that can lead to database |
| 2812 | ** corruption during the next transaction. |
| 2813 | */ |
| 2814 | }else{ |
danielk1977 | ef73ee9 | 2004-11-06 12:26:07 +0000 | [diff] [blame] | 2815 | TRACE3("DONT_WRITE page %d of %d\n", pgno, PAGERID(pPager)); |
drh | 8124a30 | 2002-06-25 14:43:57 +0000 | [diff] [blame] | 2816 | pPg->dirty = 0; |
| 2817 | } |
drh | 30e5875 | 2002-03-02 20:41:57 +0000 | [diff] [blame] | 2818 | } |
| 2819 | } |
| 2820 | |
| 2821 | /* |
| 2822 | ** A call to this routine tells the pager that if a rollback occurs, |
| 2823 | ** it is not necessary to restore the data on the given page. This |
| 2824 | ** means that the pager does not have to record the given page in the |
| 2825 | ** rollback journal. |
| 2826 | */ |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 2827 | void sqlite3pager_dont_rollback(void *pData){ |
drh | 30e5875 | 2002-03-02 20:41:57 +0000 | [diff] [blame] | 2828 | PgHdr *pPg = DATA_TO_PGHDR(pData); |
| 2829 | Pager *pPager = pPg->pPager; |
| 2830 | |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 2831 | if( pPager->state!=PAGER_EXCLUSIVE || pPager->journalOpen==0 ) return; |
drh | b7f9164 | 2004-10-31 02:22:47 +0000 | [diff] [blame] | 2832 | if( pPg->alwaysRollback || pPager->alwaysRollback || MEMDB ) return; |
drh | 30e5875 | 2002-03-02 20:41:57 +0000 | [diff] [blame] | 2833 | if( !pPg->inJournal && (int)pPg->pgno <= pPager->origDbSize ){ |
| 2834 | assert( pPager->aInJournal!=0 ); |
| 2835 | pPager->aInJournal[pPg->pgno/8] |= 1<<(pPg->pgno&7); |
| 2836 | pPg->inJournal = 1; |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 2837 | if( pPager->stmtInUse ){ |
| 2838 | pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7); |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 2839 | page_add_to_stmt_list(pPg); |
drh | 30e5875 | 2002-03-02 20:41:57 +0000 | [diff] [blame] | 2840 | } |
danielk1977 | ef73ee9 | 2004-11-06 12:26:07 +0000 | [diff] [blame] | 2841 | TRACE3("DONT_ROLLBACK page %d of %d\n", pPg->pgno, PAGERID(pPager)); |
drh | 30e5875 | 2002-03-02 20:41:57 +0000 | [diff] [blame] | 2842 | } |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 2843 | if( pPager->stmtInUse && !pPg->inStmt && (int)pPg->pgno<=pPager->stmtSize ){ |
drh | 30e5875 | 2002-03-02 20:41:57 +0000 | [diff] [blame] | 2844 | assert( pPg->inJournal || (int)pPg->pgno>pPager->origDbSize ); |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 2845 | assert( pPager->aInStmt!=0 ); |
| 2846 | pPager->aInStmt[pPg->pgno/8] |= 1<<(pPg->pgno&7); |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 2847 | page_add_to_stmt_list(pPg); |
drh | 30e5875 | 2002-03-02 20:41:57 +0000 | [diff] [blame] | 2848 | } |
| 2849 | } |
| 2850 | |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 2851 | |
danielk1977 | 93758c8 | 2005-01-21 08:13:14 +0000 | [diff] [blame^] | 2852 | #ifndef SQLITE_OMIT_MEMORYDB |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 2853 | /* |
| 2854 | ** Clear a PgHistory block |
| 2855 | */ |
| 2856 | static void clearHistory(PgHistory *pHist){ |
| 2857 | sqliteFree(pHist->pOrig); |
| 2858 | sqliteFree(pHist->pStmt); |
| 2859 | pHist->pOrig = 0; |
| 2860 | pHist->pStmt = 0; |
| 2861 | } |
danielk1977 | 93758c8 | 2005-01-21 08:13:14 +0000 | [diff] [blame^] | 2862 | #else |
| 2863 | #define clearHistory(x) |
| 2864 | #endif |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 2865 | |
drh | 30e5875 | 2002-03-02 20:41:57 +0000 | [diff] [blame] | 2866 | /* |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2867 | ** Commit all changes to the database and release the write lock. |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2868 | ** |
| 2869 | ** If the commit fails for any reason, a rollback attempt is made |
| 2870 | ** and an error code is returned. If the commit worked, SQLITE_OK |
| 2871 | ** is returned. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2872 | */ |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 2873 | int sqlite3pager_commit(Pager *pPager){ |
drh | a1b351a | 2001-09-14 16:42:12 +0000 | [diff] [blame] | 2874 | int rc; |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2875 | PgHdr *pPg; |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2876 | |
| 2877 | if( pPager->errMask==PAGER_ERR_FULL ){ |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 2878 | rc = sqlite3pager_rollback(pPager); |
drh | 4e371ee | 2002-09-05 16:08:27 +0000 | [diff] [blame] | 2879 | if( rc==SQLITE_OK ){ |
| 2880 | rc = SQLITE_FULL; |
| 2881 | } |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2882 | return rc; |
| 2883 | } |
| 2884 | if( pPager->errMask!=0 ){ |
| 2885 | rc = pager_errcode(pPager); |
| 2886 | return rc; |
| 2887 | } |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 2888 | if( pPager->state<PAGER_RESERVED ){ |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2889 | return SQLITE_ERROR; |
| 2890 | } |
danielk1977 | ef73ee9 | 2004-11-06 12:26:07 +0000 | [diff] [blame] | 2891 | TRACE2("COMMIT %d\n", PAGERID(pPager)); |
drh | b7f9164 | 2004-10-31 02:22:47 +0000 | [diff] [blame] | 2892 | if( MEMDB ){ |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 2893 | pPg = pager_get_all_dirty_pages(pPager); |
| 2894 | while( pPg ){ |
| 2895 | clearHistory(PGHDR_TO_HIST(pPg, pPager)); |
| 2896 | pPg->dirty = 0; |
| 2897 | pPg->inJournal = 0; |
| 2898 | pPg->inStmt = 0; |
| 2899 | pPg->pPrevStmt = pPg->pNextStmt = 0; |
| 2900 | pPg = pPg->pDirty; |
| 2901 | } |
danielk1977 | eac7a36 | 2004-06-16 07:45:24 +0000 | [diff] [blame] | 2902 | #ifndef NDEBUG |
| 2903 | for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){ |
| 2904 | PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager); |
| 2905 | assert( !pPg->alwaysRollback ); |
| 2906 | assert( !pHist->pOrig ); |
| 2907 | assert( !pHist->pStmt ); |
| 2908 | } |
| 2909 | #endif |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 2910 | pPager->pStmt = 0; |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 2911 | pPager->state = PAGER_SHARED; |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 2912 | return SQLITE_OK; |
| 2913 | } |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 2914 | if( pPager->dirtyCache==0 ){ |
danielk1977 | 4adee20 | 2004-05-08 08:23:19 +0000 | [diff] [blame] | 2915 | /* Exit early (without doing the time-consuming sqlite3OsSync() calls) |
drh | a168045 | 2002-04-18 01:56:57 +0000 | [diff] [blame] | 2916 | ** if there have been no changes to the database file. */ |
drh | 341eae8 | 2003-01-21 02:39:36 +0000 | [diff] [blame] | 2917 | assert( pPager->needSync==0 ); |
drh | a168045 | 2002-04-18 01:56:57 +0000 | [diff] [blame] | 2918 | rc = pager_unwritelock(pPager); |
| 2919 | pPager->dbSize = -1; |
| 2920 | return rc; |
| 2921 | } |
drh | da47d77 | 2002-12-02 04:25:19 +0000 | [diff] [blame] | 2922 | assert( pPager->journalOpen ); |
danielk1977 | d761c0c | 2004-11-05 16:37:02 +0000 | [diff] [blame] | 2923 | rc = sqlite3pager_sync(pPager, 0, 0); |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 2924 | if( rc!=SQLITE_OK ){ |
| 2925 | goto commit_abort; |
| 2926 | } |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2927 | rc = pager_unwritelock(pPager); |
| 2928 | pPager->dbSize = -1; |
| 2929 | return rc; |
| 2930 | |
| 2931 | /* Jump here if anything goes wrong during the commit process. |
| 2932 | */ |
| 2933 | commit_abort: |
drh | 92f02c3 | 2004-09-02 14:57:08 +0000 | [diff] [blame] | 2934 | sqlite3pager_rollback(pPager); |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2935 | return rc; |
| 2936 | } |
| 2937 | |
| 2938 | /* |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 2939 | ** Rollback all changes. The database falls back to PAGER_SHARED mode. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2940 | ** All in-memory cache pages revert to their original data contents. |
| 2941 | ** The journal is deleted. |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2942 | ** |
| 2943 | ** This routine cannot fail unless some other process is not following |
| 2944 | ** the correct locking protocol (SQLITE_PROTOCOL) or unless some other |
| 2945 | ** process is writing trash into the journal file (SQLITE_CORRUPT) or |
| 2946 | ** unless a prior malloc() failed (SQLITE_NOMEM). Appropriate error |
| 2947 | ** codes are returned for all these occasions. Otherwise, |
| 2948 | ** SQLITE_OK is returned. |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2949 | */ |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 2950 | int sqlite3pager_rollback(Pager *pPager){ |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 2951 | int rc; |
danielk1977 | ef73ee9 | 2004-11-06 12:26:07 +0000 | [diff] [blame] | 2952 | TRACE2("ROLLBACK %d\n", PAGERID(pPager)); |
drh | b7f9164 | 2004-10-31 02:22:47 +0000 | [diff] [blame] | 2953 | if( MEMDB ){ |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 2954 | PgHdr *p; |
| 2955 | for(p=pPager->pAll; p; p=p->pNextAll){ |
| 2956 | PgHistory *pHist; |
danielk1977 | eac7a36 | 2004-06-16 07:45:24 +0000 | [diff] [blame] | 2957 | assert( !p->alwaysRollback ); |
| 2958 | if( !p->dirty ){ |
| 2959 | assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pOrig ); |
| 2960 | assert( !((PgHistory *)PGHDR_TO_HIST(p, pPager))->pStmt ); |
| 2961 | continue; |
| 2962 | } |
| 2963 | |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 2964 | pHist = PGHDR_TO_HIST(p, pPager); |
| 2965 | if( pHist->pOrig ){ |
| 2966 | memcpy(PGHDR_TO_DATA(p), pHist->pOrig, pPager->pageSize); |
danielk1977 | ef73ee9 | 2004-11-06 12:26:07 +0000 | [diff] [blame] | 2967 | TRACE3("ROLLBACK-PAGE %d of %d\n", p->pgno, PAGERID(pPager)); |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 2968 | }else{ |
danielk1977 | ef73ee9 | 2004-11-06 12:26:07 +0000 | [diff] [blame] | 2969 | TRACE3("PAGE %d is clean on %d\n", p->pgno, PAGERID(pPager)); |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 2970 | } |
| 2971 | clearHistory(pHist); |
| 2972 | p->dirty = 0; |
| 2973 | p->inJournal = 0; |
| 2974 | p->inStmt = 0; |
| 2975 | p->pPrevStmt = p->pNextStmt = 0; |
danielk1977 | 369f27e | 2004-06-15 11:40:04 +0000 | [diff] [blame] | 2976 | |
| 2977 | if( pPager->xReiniter ){ |
| 2978 | pPager->xReiniter(PGHDR_TO_DATA(p), pPager->pageSize); |
| 2979 | } |
| 2980 | |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 2981 | } |
| 2982 | pPager->pStmt = 0; |
| 2983 | pPager->dbSize = pPager->origDbSize; |
| 2984 | memoryTruncate(pPager); |
| 2985 | pPager->stmtInUse = 0; |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 2986 | pPager->state = PAGER_SHARED; |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 2987 | return SQLITE_OK; |
| 2988 | } |
| 2989 | |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 2990 | if( !pPager->dirtyCache || !pPager->journalOpen ){ |
drh | da47d77 | 2002-12-02 04:25:19 +0000 | [diff] [blame] | 2991 | rc = pager_unwritelock(pPager); |
| 2992 | pPager->dbSize = -1; |
| 2993 | return rc; |
| 2994 | } |
drh | db48ee0 | 2003-01-16 13:42:43 +0000 | [diff] [blame] | 2995 | |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 2996 | if( pPager->errMask!=0 && pPager->errMask!=PAGER_ERR_FULL ){ |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 2997 | if( pPager->state>=PAGER_EXCLUSIVE ){ |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 2998 | pager_playback(pPager); |
drh | 4b845d7 | 2002-03-05 12:41:19 +0000 | [diff] [blame] | 2999 | } |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 3000 | return pager_errcode(pPager); |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 3001 | } |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 3002 | if( pPager->state==PAGER_RESERVED ){ |
drh | cb4c40b | 2004-08-18 19:09:43 +0000 | [diff] [blame] | 3003 | int rc2, rc3; |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 3004 | rc = pager_reload_cache(pPager); |
drh | cb4c40b | 2004-08-18 19:09:43 +0000 | [diff] [blame] | 3005 | rc2 = pager_truncate(pPager, pPager->origDbSize); |
| 3006 | rc3 = pager_unwritelock(pPager); |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 3007 | if( rc==SQLITE_OK ){ |
| 3008 | rc = rc2; |
drh | cb4c40b | 2004-08-18 19:09:43 +0000 | [diff] [blame] | 3009 | if( rc3 ) rc = rc3; |
drh | a6abd04 | 2004-06-09 17:37:22 +0000 | [diff] [blame] | 3010 | } |
| 3011 | }else{ |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 3012 | rc = pager_playback(pPager); |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 3013 | } |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 3014 | if( rc!=SQLITE_OK ){ |
drh | ee696e2 | 2004-08-30 16:52:17 +0000 | [diff] [blame] | 3015 | rc = SQLITE_CORRUPT; /* bkpt-CORRUPT */ |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 3016 | pPager->errMask |= PAGER_ERR_CORRUPT; |
| 3017 | } |
| 3018 | pPager->dbSize = -1; |
drh | ed7c855 | 2001-04-11 14:29:21 +0000 | [diff] [blame] | 3019 | return rc; |
drh | 98808ba | 2001-10-18 12:34:46 +0000 | [diff] [blame] | 3020 | } |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 3021 | |
| 3022 | /* |
drh | 5e00f6c | 2001-09-13 13:46:56 +0000 | [diff] [blame] | 3023 | ** Return TRUE if the database file is opened read-only. Return FALSE |
| 3024 | ** if the database is (in theory) writable. |
| 3025 | */ |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 3026 | int sqlite3pager_isreadonly(Pager *pPager){ |
drh | be0072d | 2001-09-13 14:46:09 +0000 | [diff] [blame] | 3027 | return pPager->readOnly; |
drh | 5e00f6c | 2001-09-13 13:46:56 +0000 | [diff] [blame] | 3028 | } |
| 3029 | |
| 3030 | /* |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 3031 | ** This routine is used for testing and analysis only. |
| 3032 | */ |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 3033 | int *sqlite3pager_stats(Pager *pPager){ |
danielk1977 | 42741be | 2005-01-08 12:42:39 +0000 | [diff] [blame] | 3034 | static int a[11]; |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 3035 | a[0] = pPager->nRef; |
| 3036 | a[1] = pPager->nPage; |
| 3037 | a[2] = pPager->mxPage; |
| 3038 | a[3] = pPager->dbSize; |
| 3039 | a[4] = pPager->state; |
| 3040 | a[5] = pPager->errMask; |
| 3041 | a[6] = pPager->nHit; |
| 3042 | a[7] = pPager->nMiss; |
| 3043 | a[8] = pPager->nOvfl; |
danielk1977 | 42741be | 2005-01-08 12:42:39 +0000 | [diff] [blame] | 3044 | a[9] = pPager->nRead; |
| 3045 | a[10] = pPager->nWrite; |
drh | d9b0257 | 2001-04-15 00:37:09 +0000 | [diff] [blame] | 3046 | return a; |
| 3047 | } |
drh | dd79342 | 2001-06-28 01:54:48 +0000 | [diff] [blame] | 3048 | |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 3049 | /* |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 3050 | ** Set the statement rollback point. |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 3051 | ** |
| 3052 | ** This routine should be called with the transaction journal already |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 3053 | ** open. A new statement journal is created that can be used to rollback |
drh | aaab572 | 2002-02-19 13:39:21 +0000 | [diff] [blame] | 3054 | ** changes of a single SQL command within a larger transaction. |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 3055 | */ |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 3056 | int sqlite3pager_stmt_begin(Pager *pPager){ |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 3057 | int rc; |
| 3058 | char zTemp[SQLITE_TEMPNAME_SIZE]; |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 3059 | assert( !pPager->stmtInUse ); |
drh | dc3ff9c | 2004-08-18 02:10:15 +0000 | [diff] [blame] | 3060 | assert( pPager->dbSize>=0 ); |
danielk1977 | ef73ee9 | 2004-11-06 12:26:07 +0000 | [diff] [blame] | 3061 | TRACE2("STMT-BEGIN %d\n", PAGERID(pPager)); |
drh | b7f9164 | 2004-10-31 02:22:47 +0000 | [diff] [blame] | 3062 | if( MEMDB ){ |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 3063 | pPager->stmtInUse = 1; |
| 3064 | pPager->stmtSize = pPager->dbSize; |
| 3065 | return SQLITE_OK; |
| 3066 | } |
drh | da47d77 | 2002-12-02 04:25:19 +0000 | [diff] [blame] | 3067 | if( !pPager->journalOpen ){ |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 3068 | pPager->stmtAutoopen = 1; |
drh | da47d77 | 2002-12-02 04:25:19 +0000 | [diff] [blame] | 3069 | return SQLITE_OK; |
| 3070 | } |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 3071 | assert( pPager->journalOpen ); |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 3072 | pPager->aInStmt = sqliteMalloc( pPager->dbSize/8 + 1 ); |
| 3073 | if( pPager->aInStmt==0 ){ |
danielk1977 | 9eed505 | 2004-06-04 10:38:30 +0000 | [diff] [blame] | 3074 | sqlite3OsLock(&pPager->fd, SHARED_LOCK); |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 3075 | return SQLITE_NOMEM; |
| 3076 | } |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 3077 | #ifndef NDEBUG |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 3078 | rc = sqlite3OsFileSize(&pPager->jfd, &pPager->stmtJSize); |
| 3079 | if( rc ) goto stmt_begin_failed; |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 3080 | assert( pPager->stmtJSize == pPager->journalOff ); |
drh | 968af52 | 2003-02-11 14:55:40 +0000 | [diff] [blame] | 3081 | #endif |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 3082 | pPager->stmtJSize = pPager->journalOff; |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 3083 | pPager->stmtSize = pPager->dbSize; |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 3084 | pPager->stmtHdrOff = 0; |
danielk1977 | 75edc16 | 2004-06-26 01:48:18 +0000 | [diff] [blame] | 3085 | pPager->stmtCksum = pPager->cksumInit; |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 3086 | if( !pPager->stmtOpen ){ |
| 3087 | rc = sqlite3pager_opentemp(zTemp, &pPager->stfd); |
| 3088 | if( rc ) goto stmt_begin_failed; |
| 3089 | pPager->stmtOpen = 1; |
| 3090 | pPager->stmtNRec = 0; |
drh | 0f89253 | 2002-05-30 12:27:03 +0000 | [diff] [blame] | 3091 | } |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 3092 | pPager->stmtInUse = 1; |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 3093 | return SQLITE_OK; |
| 3094 | |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 3095 | stmt_begin_failed: |
| 3096 | if( pPager->aInStmt ){ |
| 3097 | sqliteFree(pPager->aInStmt); |
| 3098 | pPager->aInStmt = 0; |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 3099 | } |
| 3100 | return rc; |
| 3101 | } |
| 3102 | |
| 3103 | /* |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 3104 | ** Commit a statement. |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 3105 | */ |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 3106 | int sqlite3pager_stmt_commit(Pager *pPager){ |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 3107 | if( pPager->stmtInUse ){ |
drh | 03eb96a | 2002-11-10 23:32:56 +0000 | [diff] [blame] | 3108 | PgHdr *pPg, *pNext; |
danielk1977 | ef73ee9 | 2004-11-06 12:26:07 +0000 | [diff] [blame] | 3109 | TRACE2("STMT-COMMIT %d\n", PAGERID(pPager)); |
drh | b7f9164 | 2004-10-31 02:22:47 +0000 | [diff] [blame] | 3110 | if( !MEMDB ){ |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 3111 | sqlite3OsSeek(&pPager->stfd, 0); |
| 3112 | /* sqlite3OsTruncate(&pPager->stfd, 0); */ |
| 3113 | sqliteFree( pPager->aInStmt ); |
| 3114 | pPager->aInStmt = 0; |
drh | 663fc63 | 2002-02-02 18:49:19 +0000 | [diff] [blame] | 3115 | } |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 3116 | for(pPg=pPager->pStmt; pPg; pPg=pNext){ |
| 3117 | pNext = pPg->pNextStmt; |
| 3118 | assert( pPg->inStmt ); |
| 3119 | pPg->inStmt = 0; |
| 3120 | pPg->pPrevStmt = pPg->pNextStmt = 0; |
drh | b7f9164 | 2004-10-31 02:22:47 +0000 | [diff] [blame] | 3121 | if( MEMDB ){ |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 3122 | PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager); |
| 3123 | sqliteFree(pHist->pStmt); |
| 3124 | pHist->pStmt = 0; |
| 3125 | } |
| 3126 | } |
| 3127 | pPager->stmtNRec = 0; |
| 3128 | pPager->stmtInUse = 0; |
| 3129 | pPager->pStmt = 0; |
drh | 663fc63 | 2002-02-02 18:49:19 +0000 | [diff] [blame] | 3130 | } |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 3131 | pPager->stmtAutoopen = 0; |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 3132 | return SQLITE_OK; |
| 3133 | } |
| 3134 | |
| 3135 | /* |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 3136 | ** Rollback a statement. |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 3137 | */ |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 3138 | int sqlite3pager_stmt_rollback(Pager *pPager){ |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 3139 | int rc; |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 3140 | if( pPager->stmtInUse ){ |
danielk1977 | ef73ee9 | 2004-11-06 12:26:07 +0000 | [diff] [blame] | 3141 | TRACE2("STMT-ROLLBACK %d\n", PAGERID(pPager)); |
drh | b7f9164 | 2004-10-31 02:22:47 +0000 | [diff] [blame] | 3142 | if( MEMDB ){ |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 3143 | PgHdr *pPg; |
| 3144 | for(pPg=pPager->pStmt; pPg; pPg=pPg->pNextStmt){ |
| 3145 | PgHistory *pHist = PGHDR_TO_HIST(pPg, pPager); |
| 3146 | if( pHist->pStmt ){ |
| 3147 | memcpy(PGHDR_TO_DATA(pPg), pHist->pStmt, pPager->pageSize); |
| 3148 | sqliteFree(pHist->pStmt); |
| 3149 | pHist->pStmt = 0; |
| 3150 | } |
| 3151 | } |
| 3152 | pPager->dbSize = pPager->stmtSize; |
| 3153 | memoryTruncate(pPager); |
| 3154 | rc = SQLITE_OK; |
| 3155 | }else{ |
| 3156 | rc = pager_stmt_playback(pPager); |
| 3157 | } |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 3158 | sqlite3pager_stmt_commit(pPager); |
drh | 663fc63 | 2002-02-02 18:49:19 +0000 | [diff] [blame] | 3159 | }else{ |
| 3160 | rc = SQLITE_OK; |
| 3161 | } |
drh | ac69b05 | 2004-05-12 13:30:07 +0000 | [diff] [blame] | 3162 | pPager->stmtAutoopen = 0; |
drh | fa86c41 | 2002-02-02 15:01:15 +0000 | [diff] [blame] | 3163 | return rc; |
| 3164 | } |
| 3165 | |
drh | 73509ee | 2003-04-06 20:44:45 +0000 | [diff] [blame] | 3166 | /* |
| 3167 | ** Return the full pathname of the database file. |
| 3168 | */ |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 3169 | const char *sqlite3pager_filename(Pager *pPager){ |
drh | 73509ee | 2003-04-06 20:44:45 +0000 | [diff] [blame] | 3170 | return pPager->zFilename; |
| 3171 | } |
| 3172 | |
drh | b20ea9d | 2004-02-09 01:20:36 +0000 | [diff] [blame] | 3173 | /* |
danielk1977 | 5865e3d | 2004-06-14 06:03:57 +0000 | [diff] [blame] | 3174 | ** Return the directory of the database file. |
| 3175 | */ |
| 3176 | const char *sqlite3pager_dirname(Pager *pPager){ |
| 3177 | return pPager->zDirectory; |
| 3178 | } |
| 3179 | |
| 3180 | /* |
| 3181 | ** Return the full pathname of the journal file. |
| 3182 | */ |
| 3183 | const char *sqlite3pager_journalname(Pager *pPager){ |
| 3184 | return pPager->zJournal; |
| 3185 | } |
| 3186 | |
| 3187 | /* |
drh | b20ea9d | 2004-02-09 01:20:36 +0000 | [diff] [blame] | 3188 | ** Set the codec for this pager |
| 3189 | */ |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 3190 | void sqlite3pager_set_codec( |
drh | b20ea9d | 2004-02-09 01:20:36 +0000 | [diff] [blame] | 3191 | Pager *pPager, |
drh | 9eb9e26 | 2004-02-11 02:18:05 +0000 | [diff] [blame] | 3192 | void (*xCodec)(void*,void*,Pgno,int), |
drh | b20ea9d | 2004-02-09 01:20:36 +0000 | [diff] [blame] | 3193 | void *pCodecArg |
| 3194 | ){ |
| 3195 | pPager->xCodec = xCodec; |
| 3196 | pPager->pCodecArg = pCodecArg; |
| 3197 | } |
| 3198 | |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 3199 | /* |
danielk1977 | aa5ccdf | 2004-06-14 05:10:42 +0000 | [diff] [blame] | 3200 | ** This routine is called to increment the database file change-counter, |
| 3201 | ** stored at byte 24 of the pager file. |
| 3202 | */ |
| 3203 | static int pager_incr_changecounter(Pager *pPager){ |
| 3204 | void *pPage; |
| 3205 | PgHdr *pPgHdr; |
| 3206 | u32 change_counter; |
| 3207 | int rc; |
| 3208 | |
| 3209 | /* Open page 1 of the file for writing. */ |
| 3210 | rc = sqlite3pager_get(pPager, 1, &pPage); |
| 3211 | if( rc!=SQLITE_OK ) return rc; |
| 3212 | rc = sqlite3pager_write(pPage); |
| 3213 | if( rc!=SQLITE_OK ) return rc; |
| 3214 | |
| 3215 | /* Read the current value at byte 24. */ |
| 3216 | pPgHdr = DATA_TO_PGHDR(pPage); |
| 3217 | change_counter = retrieve32bits(pPgHdr, 24); |
| 3218 | |
| 3219 | /* Increment the value just read and write it back to byte 24. */ |
| 3220 | change_counter++; |
| 3221 | store32bits(change_counter, pPgHdr, 24); |
| 3222 | |
| 3223 | /* Release the page reference. */ |
| 3224 | sqlite3pager_unref(pPage); |
| 3225 | return SQLITE_OK; |
| 3226 | } |
| 3227 | |
| 3228 | /* |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 3229 | ** Sync the database file for the pager pPager. zMaster points to the name |
| 3230 | ** of a master journal file that should be written into the individual |
| 3231 | ** journal file. zMaster may be NULL, which is interpreted as no master |
| 3232 | ** journal (a single database transaction). |
| 3233 | ** |
| 3234 | ** This routine ensures that the journal is synced, all dirty pages written |
| 3235 | ** to the database file and the database file synced. The only thing that |
| 3236 | ** remains to commit the transaction is to delete the journal file (or |
| 3237 | ** master journal file if specified). |
| 3238 | ** |
| 3239 | ** Note that if zMaster==NULL, this does not overwrite a previous value |
| 3240 | ** passed to an sqlite3pager_sync() call. |
danielk1977 | d761c0c | 2004-11-05 16:37:02 +0000 | [diff] [blame] | 3241 | ** |
| 3242 | ** If parameter nTrunc is non-zero, then the pager file is truncated to |
| 3243 | ** nTrunc pages (this is used by auto-vacuum databases). |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 3244 | */ |
danielk1977 | d761c0c | 2004-11-05 16:37:02 +0000 | [diff] [blame] | 3245 | int sqlite3pager_sync(Pager *pPager, const char *zMaster, Pgno nTrunc){ |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 3246 | int rc = SQLITE_OK; |
| 3247 | |
danielk1977 | ef73ee9 | 2004-11-06 12:26:07 +0000 | [diff] [blame] | 3248 | TRACE4("DATABASE SYNC: File=%s zMaster=%s nTrunc=%d\n", |
| 3249 | pPager->zFilename, zMaster, nTrunc); |
| 3250 | |
danielk1977 | aa5ccdf | 2004-06-14 05:10:42 +0000 | [diff] [blame] | 3251 | /* If this is an in-memory db, or no pages have been written to, or this |
| 3252 | ** function has already been called, it is a no-op. |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 3253 | */ |
drh | b7f9164 | 2004-10-31 02:22:47 +0000 | [diff] [blame] | 3254 | if( pPager->state!=PAGER_SYNCED && !MEMDB && pPager->dirtyCache ){ |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 3255 | PgHdr *pPg; |
| 3256 | assert( pPager->journalOpen ); |
| 3257 | |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 3258 | /* If a master journal file name has already been written to the |
| 3259 | ** journal file, then no sync is required. This happens when it is |
| 3260 | ** written, then the process fails to upgrade from a RESERVED to an |
| 3261 | ** EXCLUSIVE lock. The next time the process tries to commit the |
| 3262 | ** transaction the m-j name will have already been written. |
| 3263 | */ |
| 3264 | if( !pPager->setMaster ){ |
| 3265 | rc = pager_incr_changecounter(pPager); |
| 3266 | if( rc!=SQLITE_OK ) goto sync_exit; |
danielk1977 | ef73ee9 | 2004-11-06 12:26:07 +0000 | [diff] [blame] | 3267 | #ifndef SQLITE_OMIT_AUTOVACUUM |
| 3268 | if( nTrunc!=0 ){ |
| 3269 | /* If this transaction has made the database smaller, then all pages |
| 3270 | ** being discarded by the truncation must be written to the journal |
| 3271 | ** file. |
| 3272 | */ |
| 3273 | Pgno i; |
| 3274 | void *pPage; |
| 3275 | for( i=nTrunc+1; i<=pPager->origDbSize; i++ ){ |
| 3276 | if( !(pPager->aInJournal[i/8] & (1<<(i&7))) ){ |
| 3277 | rc = sqlite3pager_get(pPager, i, &pPage); |
| 3278 | if( rc!=SQLITE_OK ) goto sync_exit; |
| 3279 | rc = sqlite3pager_write(pPage); |
| 3280 | sqlite3pager_unref(pPage); |
| 3281 | if( rc!=SQLITE_OK ) goto sync_exit; |
| 3282 | } |
| 3283 | } |
| 3284 | } |
| 3285 | #endif |
danielk1977 | 7657240 | 2004-06-25 02:38:54 +0000 | [diff] [blame] | 3286 | rc = writeMasterJournal(pPager, zMaster); |
| 3287 | if( rc!=SQLITE_OK ) goto sync_exit; |
| 3288 | rc = syncJournal(pPager); |
| 3289 | if( rc!=SQLITE_OK ) goto sync_exit; |
| 3290 | } |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 3291 | |
danielk1977 | d761c0c | 2004-11-05 16:37:02 +0000 | [diff] [blame] | 3292 | #ifndef SQLITE_OMIT_AUTOVACUUM |
| 3293 | if( nTrunc!=0 ){ |
| 3294 | rc = sqlite3pager_truncate(pPager, nTrunc); |
| 3295 | if( rc!=SQLITE_OK ) goto sync_exit; |
| 3296 | } |
| 3297 | #endif |
| 3298 | |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 3299 | /* Write all dirty pages to the database file */ |
| 3300 | pPg = pager_get_all_dirty_pages(pPager); |
| 3301 | rc = pager_write_pagelist(pPg); |
| 3302 | if( rc!=SQLITE_OK ) goto sync_exit; |
| 3303 | |
danielk1977 | aa5ccdf | 2004-06-14 05:10:42 +0000 | [diff] [blame] | 3304 | /* Sync the database file. */ |
| 3305 | if( !pPager->noSync ){ |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 3306 | rc = sqlite3OsSync(&pPager->fd); |
| 3307 | } |
danielk1977 | aa5ccdf | 2004-06-14 05:10:42 +0000 | [diff] [blame] | 3308 | |
| 3309 | pPager->state = PAGER_SYNCED; |
danielk1977 | 13adf8a | 2004-06-03 16:08:41 +0000 | [diff] [blame] | 3310 | } |
| 3311 | |
| 3312 | sync_exit: |
| 3313 | return rc; |
| 3314 | } |
| 3315 | |
danielk1977 | 687566d | 2004-11-02 12:56:41 +0000 | [diff] [blame] | 3316 | #ifndef SQLITE_OMIT_AUTOVACUUM |
| 3317 | /* |
| 3318 | ** Move the page identified by pData to location pgno in the file. |
| 3319 | ** |
| 3320 | ** There must be no references to the current page pgno. If current page |
| 3321 | ** pgno is not already in the rollback journal, it is not written there by |
| 3322 | ** by this routine. The same applies to the page pData refers to on entry to |
| 3323 | ** this routine. |
| 3324 | ** |
| 3325 | ** References to the page refered to by pData remain valid. Updating any |
| 3326 | ** meta-data associated with page pData (i.e. data stored in the nExtra bytes |
| 3327 | ** allocated along with the page) is the responsibility of the caller. |
| 3328 | ** |
| 3329 | ** A transaction must be active when this routine is called, however it is |
| 3330 | ** illegal to call this routine if a statment transaction is active. |
| 3331 | */ |
| 3332 | int sqlite3pager_movepage(Pager *pPager, void *pData, Pgno pgno){ |
| 3333 | PgHdr *pPg = DATA_TO_PGHDR(pData); |
| 3334 | PgHdr *pPgOld; |
danielk1977 | f5fdda8 | 2004-11-03 08:44:05 +0000 | [diff] [blame] | 3335 | int h; |
danielk1977 | 94daf7f | 2004-11-08 09:26:09 +0000 | [diff] [blame] | 3336 | Pgno needSyncPgno = 0; |
danielk1977 | 687566d | 2004-11-02 12:56:41 +0000 | [diff] [blame] | 3337 | |
| 3338 | assert( !pPager->stmtInUse ); |
danielk1977 | 687566d | 2004-11-02 12:56:41 +0000 | [diff] [blame] | 3339 | assert( pPg->nRef>0 ); |
| 3340 | |
danielk1977 | 599fcba | 2004-11-08 07:13:13 +0000 | [diff] [blame] | 3341 | TRACE5("MOVE %d page %d (needSync=%d) moves to %d\n", |
| 3342 | PAGERID(pPager), pPg->pgno, pPg->needSync, pgno); |
danielk1977 | ef73ee9 | 2004-11-06 12:26:07 +0000 | [diff] [blame] | 3343 | |
danielk1977 | 94daf7f | 2004-11-08 09:26:09 +0000 | [diff] [blame] | 3344 | if( pPg->needSync ){ |
| 3345 | needSyncPgno = pPg->pgno; |
| 3346 | assert( pPg->inJournal ); |
| 3347 | assert( pPg->dirty ); |
danielk1977 | ae82558 | 2004-11-23 09:06:55 +0000 | [diff] [blame] | 3348 | assert( pPager->needSync ); |
danielk1977 | 94daf7f | 2004-11-08 09:26:09 +0000 | [diff] [blame] | 3349 | } |
| 3350 | |
danielk1977 | 687566d | 2004-11-02 12:56:41 +0000 | [diff] [blame] | 3351 | /* Unlink pPg from it's hash-chain */ |
danielk1977 | f5fdda8 | 2004-11-03 08:44:05 +0000 | [diff] [blame] | 3352 | unlinkHashChain(pPager, pPg); |
danielk1977 | 687566d | 2004-11-02 12:56:41 +0000 | [diff] [blame] | 3353 | |
danielk1977 | ef73ee9 | 2004-11-06 12:26:07 +0000 | [diff] [blame] | 3354 | /* If the cache contains a page with page-number pgno, remove it |
danielk1977 | 599fcba | 2004-11-08 07:13:13 +0000 | [diff] [blame] | 3355 | ** from it's hash chain. Also, if the PgHdr.needSync was set for |
| 3356 | ** page pgno before the 'move' operation, it needs to be retained |
| 3357 | ** for the page moved there. |
danielk1977 | f5fdda8 | 2004-11-03 08:44:05 +0000 | [diff] [blame] | 3358 | */ |
danielk1977 | 687566d | 2004-11-02 12:56:41 +0000 | [diff] [blame] | 3359 | pPgOld = pager_lookup(pPager, pgno); |
| 3360 | if( pPgOld ){ |
danielk1977 | f5fdda8 | 2004-11-03 08:44:05 +0000 | [diff] [blame] | 3361 | assert( pPgOld->nRef==0 ); |
| 3362 | unlinkHashChain(pPager, pPgOld); |
| 3363 | pPgOld->dirty = 0; |
danielk1977 | ef73ee9 | 2004-11-06 12:26:07 +0000 | [diff] [blame] | 3364 | if( pPgOld->needSync ){ |
danielk1977 | 45901d6 | 2004-11-10 15:27:38 +0000 | [diff] [blame] | 3365 | assert( pPgOld->inJournal ); |
| 3366 | pPg->inJournal = 1; |
danielk1977 | ef73ee9 | 2004-11-06 12:26:07 +0000 | [diff] [blame] | 3367 | pPg->needSync = 1; |
danielk1977 | ae82558 | 2004-11-23 09:06:55 +0000 | [diff] [blame] | 3368 | assert( pPager->needSync ); |
danielk1977 | ef73ee9 | 2004-11-06 12:26:07 +0000 | [diff] [blame] | 3369 | } |
danielk1977 | 687566d | 2004-11-02 12:56:41 +0000 | [diff] [blame] | 3370 | } |
| 3371 | |
danielk1977 | f5fdda8 | 2004-11-03 08:44:05 +0000 | [diff] [blame] | 3372 | /* Change the page number for pPg and insert it into the new hash-chain. */ |
| 3373 | pPg->pgno = pgno; |
| 3374 | h = pager_hash(pgno); |
| 3375 | if( pPager->aHash[h] ){ |
| 3376 | assert( pPager->aHash[h]->pPrevHash==0 ); |
| 3377 | pPager->aHash[h]->pPrevHash = pPg; |
| 3378 | } |
| 3379 | pPg->pNextHash = pPager->aHash[h]; |
| 3380 | pPager->aHash[h] = pPg; |
| 3381 | pPg->pPrevHash = 0; |
| 3382 | |
danielk1977 | 687566d | 2004-11-02 12:56:41 +0000 | [diff] [blame] | 3383 | pPg->dirty = 1; |
| 3384 | pPager->dirtyCache = 1; |
| 3385 | |
danielk1977 | 94daf7f | 2004-11-08 09:26:09 +0000 | [diff] [blame] | 3386 | if( needSyncPgno ){ |
| 3387 | /* If needSyncPgno is non-zero, then the journal file needs to be |
| 3388 | ** sync()ed before any data is written to database file page needSyncPgno. |
| 3389 | ** Currently, no such page exists in the page-cache and the |
| 3390 | ** Pager.aInJournal bit has been set. This needs to be remedied by loading |
| 3391 | ** the page into the pager-cache and setting the PgHdr.needSync flag. |
danielk1977 | ae82558 | 2004-11-23 09:06:55 +0000 | [diff] [blame] | 3392 | ** |
| 3393 | ** The sqlite3pager_get() call may cause the journal to sync. So make |
| 3394 | ** sure the Pager.needSync flag is set too. |
danielk1977 | 94daf7f | 2004-11-08 09:26:09 +0000 | [diff] [blame] | 3395 | */ |
| 3396 | int rc; |
| 3397 | void *pNeedSync; |
danielk1977 | ae82558 | 2004-11-23 09:06:55 +0000 | [diff] [blame] | 3398 | assert( pPager->needSync ); |
danielk1977 | 94daf7f | 2004-11-08 09:26:09 +0000 | [diff] [blame] | 3399 | rc = sqlite3pager_get(pPager, needSyncPgno, &pNeedSync); |
| 3400 | if( rc!=SQLITE_OK ) return rc; |
danielk1977 | ae82558 | 2004-11-23 09:06:55 +0000 | [diff] [blame] | 3401 | pPager->needSync = 1; |
danielk1977 | 94daf7f | 2004-11-08 09:26:09 +0000 | [diff] [blame] | 3402 | DATA_TO_PGHDR(pNeedSync)->needSync = 1; |
| 3403 | DATA_TO_PGHDR(pNeedSync)->inJournal = 1; |
| 3404 | DATA_TO_PGHDR(pNeedSync)->dirty = 1; |
| 3405 | sqlite3pager_unref(pNeedSync); |
| 3406 | } |
| 3407 | |
danielk1977 | 687566d | 2004-11-02 12:56:41 +0000 | [diff] [blame] | 3408 | return SQLITE_OK; |
| 3409 | } |
| 3410 | #endif |
| 3411 | |
dougcurrie | 81c95ef | 2004-06-18 23:21:47 +0000 | [diff] [blame] | 3412 | #if defined(SQLITE_DEBUG) || defined(SQLITE_TEST) |
drh | 89ac8c1 | 2004-06-09 14:17:20 +0000 | [diff] [blame] | 3413 | /* |
| 3414 | ** Return the current state of the file lock for the given pager. |
| 3415 | ** The return value is one of NO_LOCK, SHARED_LOCK, RESERVED_LOCK, |
| 3416 | ** PENDING_LOCK, or EXCLUSIVE_LOCK. |
| 3417 | */ |
| 3418 | int sqlite3pager_lockstate(Pager *pPager){ |
danielk1977 | e302663 | 2004-06-22 11:29:02 +0000 | [diff] [blame] | 3419 | #ifdef OS_TEST |
danielk1977 | 8a6c550 | 2004-06-22 12:18:32 +0000 | [diff] [blame] | 3420 | return pPager->fd->fd.locktype; |
danielk1977 | e302663 | 2004-06-22 11:29:02 +0000 | [diff] [blame] | 3421 | #else |
drh | 89ac8c1 | 2004-06-09 14:17:20 +0000 | [diff] [blame] | 3422 | return pPager->fd.locktype; |
danielk1977 | e302663 | 2004-06-22 11:29:02 +0000 | [diff] [blame] | 3423 | #endif |
drh | 89ac8c1 | 2004-06-09 14:17:20 +0000 | [diff] [blame] | 3424 | } |
| 3425 | #endif |
| 3426 | |
danielk1977 | 93758c8 | 2005-01-21 08:13:14 +0000 | [diff] [blame^] | 3427 | #ifdef SQLITE_DEBUG |
drh | dd79342 | 2001-06-28 01:54:48 +0000 | [diff] [blame] | 3428 | /* |
| 3429 | ** Print a listing of all referenced pages and their ref count. |
| 3430 | */ |
drh | 3aac2dd | 2004-04-26 14:10:20 +0000 | [diff] [blame] | 3431 | void sqlite3pager_refdump(Pager *pPager){ |
drh | dd79342 | 2001-06-28 01:54:48 +0000 | [diff] [blame] | 3432 | PgHdr *pPg; |
| 3433 | for(pPg=pPager->pAll; pPg; pPg=pPg->pNextAll){ |
| 3434 | if( pPg->nRef<=0 ) continue; |
drh | fe63d1c | 2004-09-08 20:13:04 +0000 | [diff] [blame] | 3435 | sqlite3DebugPrintf("PAGE %3d addr=%p nRef=%d\n", |
| 3436 | pPg->pgno, PGHDR_TO_DATA(pPg), pPg->nRef); |
drh | dd79342 | 2001-06-28 01:54:48 +0000 | [diff] [blame] | 3437 | } |
| 3438 | } |
| 3439 | #endif |