1 /* 2 ** 2001 September 15 3 ** 4 ** The author disclaims copyright to this source code. In place of 5 ** a legal notice, here is a blessing: 6 ** 7 ** May you do good and not evil. 8 ** May you find forgiveness for yourself and forgive others. 9 ** May you share freely, never taking more than you give. 10 ** 11 ************************************************************************* 12 ** This header file defines the interface that the sqlite page cache 13 ** subsystem. The page cache subsystem reads and writes a file a page 14 ** at a time and provides a journal for rollback. 15 */ 16 17 #ifndef _PAGER_H_ 18 #define _PAGER_H_ 19 20 /* 21 ** Default maximum size for persistent journal files. A negative 22 ** value means no limit. This value may be overridden using the 23 ** sqlite3PagerJournalSizeLimit() API. See also "PRAGMA journal_size_limit". 24 */ 25 #ifndef SQLITE_DEFAULT_JOURNAL_SIZE_LIMIT 26 #define SQLITE_DEFAULT_JOURNAL_SIZE_LIMIT -1 27 #endif 28 29 /* 30 ** The type used to represent a page number. The first page in a file 31 ** is called page 1. 0 is used to represent "not a page". 32 */ 33 typedef u32 Pgno; 34 35 /* 36 ** Each open file is managed by a separate instance of the "Pager" structure. 37 */ 38 typedef struct Pager Pager; 39 40 /* 41 ** Handle type for pages. 42 */ 43 typedef struct PgHdr DbPage; 44 45 /* 46 ** Page number PAGER_MJ_PGNO is never used in an SQLite database (it is 47 ** reserved for working around a windows/posix incompatibility). It is 48 ** used in the journal to signify that the remainder of the journal file 49 ** is devoted to storing a master journal name - there are no more pages to 50 ** roll back. See comments for function writeMasterJournal() in pager.c 51 ** for details. 52 */ 53 #define PAGER_MJ_PGNO(x) ((Pgno)((PENDING_BYTE/((x)->pageSize))+1)) 54 55 /* 56 ** Allowed values for the flags parameter to sqlite3PagerOpen(). 57 ** 58 ** NOTE: These values must match the corresponding BTREE_ values in btree.h. 59 */ 60 #define PAGER_OMIT_JOURNAL 0x0001 /* Do not use a rollback journal */ 61 #define PAGER_MEMORY 0x0002 /* In-memory database */ 62 63 /* 64 ** Valid values for the second argument to sqlite3PagerLockingMode(). 65 */ 66 #define PAGER_LOCKINGMODE_QUERY -1 67 #define PAGER_LOCKINGMODE_NORMAL 0 68 #define PAGER_LOCKINGMODE_EXCLUSIVE 1 69 70 /* 71 ** Numeric constants that encode the journalmode. 72 */ 73 #define PAGER_JOURNALMODE_QUERY (-1) /* Query the value of journalmode */ 74 #define PAGER_JOURNALMODE_DELETE 0 /* Commit by deleting journal file */ 75 #define PAGER_JOURNALMODE_PERSIST 1 /* Commit by zeroing journal header */ 76 #define PAGER_JOURNALMODE_OFF 2 /* Journal omitted. */ 77 #define PAGER_JOURNALMODE_TRUNCATE 3 /* Commit by truncating journal */ 78 #define PAGER_JOURNALMODE_MEMORY 4 /* In-memory journal file */ 79 #define PAGER_JOURNALMODE_WAL 5 /* Use write-ahead logging */ 80 81 /* 82 ** Flags that make up the mask passed to sqlite3PagerGet(). 83 */ 84 #define PAGER_GET_NOCONTENT 0x01 /* Do not load data from disk */ 85 #define PAGER_GET_READONLY 0x02 /* Read-only page is acceptable */ 86 87 /* 88 ** Flags for sqlite3PagerSetFlags() 89 */ 90 #define PAGER_SYNCHRONOUS_OFF 0x01 /* PRAGMA synchronous=OFF */ 91 #define PAGER_SYNCHRONOUS_NORMAL 0x02 /* PRAGMA synchronous=NORMAL */ 92 #define PAGER_SYNCHRONOUS_FULL 0x03 /* PRAGMA synchronous=FULL */ 93 #define PAGER_SYNCHRONOUS_EXTRA 0x04 /* PRAGMA synchronous=EXTRA */ 94 #define PAGER_SYNCHRONOUS_MASK 0x07 /* Mask for four values above */ 95 #define PAGER_FULLFSYNC 0x08 /* PRAGMA fullfsync=ON */ 96 #define PAGER_CKPT_FULLFSYNC 0x10 /* PRAGMA checkpoint_fullfsync=ON */ 97 #define PAGER_CACHESPILL 0x20 /* PRAGMA cache_spill=ON */ 98 #define PAGER_FLAGS_MASK 0x38 /* All above except SYNCHRONOUS */ 99 100 /* 101 ** The remainder of this file contains the declarations of the functions 102 ** that make up the Pager sub-system API. See source code comments for 103 ** a detailed description of each routine. 104 */ 105 106 /* Open and close a Pager connection. */ 107 int sqlite3PagerOpen( 108 sqlite3_vfs*, 109 Pager **ppPager, 110 const char*, 111 int, 112 int, 113 int, 114 void(*)(DbPage*) 115 ); 116 int sqlite3PagerClose(Pager *pPager); 117 int sqlite3PagerReadFileheader(Pager*, int, unsigned char*); 118 119 /* Functions used to configure a Pager object. */ 120 void sqlite3PagerSetBusyhandler(Pager*, int(*)(void *), void *); 121 int sqlite3PagerSetPagesize(Pager*, u32*, int); 122 #ifdef SQLITE_HAS_CODEC 123 void sqlite3PagerAlignReserve(Pager*,Pager*); 124 #endif 125 int sqlite3PagerMaxPageCount(Pager*, int); 126 void sqlite3PagerSetCachesize(Pager*, int); 127 int sqlite3PagerSetSpillsize(Pager*, int); 128 void sqlite3PagerSetMmapLimit(Pager *, sqlite3_int64); 129 void sqlite3PagerShrink(Pager*); 130 void sqlite3PagerSetFlags(Pager*,unsigned); 131 int sqlite3PagerLockingMode(Pager *, int); 132 int sqlite3PagerSetJournalMode(Pager *, int); 133 int sqlite3PagerGetJournalMode(Pager*); 134 int sqlite3PagerOkToChangeJournalMode(Pager*); 135 i64 sqlite3PagerJournalSizeLimit(Pager *, i64); 136 sqlite3_backup **sqlite3PagerBackupPtr(Pager*); 137 int sqlite3PagerFlush(Pager*); 138 139 /* Functions used to obtain and release page references. */ 140 int sqlite3PagerGet(Pager *pPager, Pgno pgno, DbPage **ppPage, int clrFlag); 141 DbPage *sqlite3PagerLookup(Pager *pPager, Pgno pgno); 142 void sqlite3PagerRef(DbPage*); 143 void sqlite3PagerUnref(DbPage*); 144 void sqlite3PagerUnrefNotNull(DbPage*); 145 146 /* Operations on page references. */ 147 int sqlite3PagerWrite(DbPage*); 148 void sqlite3PagerDontWrite(DbPage*); 149 int sqlite3PagerMovepage(Pager*,DbPage*,Pgno,int); 150 int sqlite3PagerPageRefcount(DbPage*); 151 void *sqlite3PagerGetData(DbPage *); 152 void *sqlite3PagerGetExtra(DbPage *); 153 154 /* Functions used to manage pager transactions and savepoints. */ 155 void sqlite3PagerPagecount(Pager*, int*); 156 int sqlite3PagerBegin(Pager*, int exFlag, int); 157 int sqlite3PagerCommitPhaseOne(Pager*,const char *zMaster, int); 158 int sqlite3PagerExclusiveLock(Pager*); 159 int sqlite3PagerSync(Pager *pPager, const char *zMaster); 160 int sqlite3PagerCommitPhaseTwo(Pager*); 161 int sqlite3PagerRollback(Pager*); 162 int sqlite3PagerOpenSavepoint(Pager *pPager, int n); 163 int sqlite3PagerSavepoint(Pager *pPager, int op, int iSavepoint); 164 int sqlite3PagerSharedLock(Pager *pPager); 165 166 #ifndef SQLITE_OMIT_WAL 167 int sqlite3PagerCheckpoint(Pager *pPager, int, int*, int*); 168 int sqlite3PagerWalSupported(Pager *pPager); 169 int sqlite3PagerWalCallback(Pager *pPager); 170 int sqlite3PagerOpenWal(Pager *pPager, int *pisOpen); 171 int sqlite3PagerCloseWal(Pager *pPager); 172 # ifdef SQLITE_ENABLE_SNAPSHOT 173 int sqlite3PagerSnapshotGet(Pager *pPager, sqlite3_snapshot **ppSnapshot); 174 int sqlite3PagerSnapshotOpen(Pager *pPager, sqlite3_snapshot *pSnapshot); 175 # endif 176 #endif 177 178 #ifdef SQLITE_ENABLE_ZIPVFS 179 int sqlite3PagerWalFramesize(Pager *pPager); 180 #endif 181 182 /* Functions used to query pager state and configuration. */ 183 u8 sqlite3PagerIsreadonly(Pager*); 184 u32 sqlite3PagerDataVersion(Pager*); 185 #ifdef SQLITE_DEBUG 186 int sqlite3PagerRefcount(Pager*); 187 #endif 188 int sqlite3PagerMemUsed(Pager*); 189 const char *sqlite3PagerFilename(Pager*, int); 190 sqlite3_vfs *sqlite3PagerVfs(Pager*); 191 sqlite3_file *sqlite3PagerFile(Pager*); 192 sqlite3_file *sqlite3PagerJrnlFile(Pager*); 193 const char *sqlite3PagerJournalname(Pager*); 194 void *sqlite3PagerTempSpace(Pager*); 195 int sqlite3PagerIsMemdb(Pager*); 196 void sqlite3PagerCacheStat(Pager *, int, int, int *); 197 void sqlite3PagerClearCache(Pager *); 198 int sqlite3SectorSize(sqlite3_file *); 199 200 /* Functions used to truncate the database file. */ 201 void sqlite3PagerTruncateImage(Pager*,Pgno); 202 203 void sqlite3PagerRekey(DbPage*, Pgno, u16); 204 205 #if defined(SQLITE_HAS_CODEC) && !defined(SQLITE_OMIT_WAL) 206 void *sqlite3PagerCodec(DbPage *); 207 #endif 208 209 /* Functions to support testing and debugging. */ 210 #if !defined(NDEBUG) || defined(SQLITE_TEST) 211 Pgno sqlite3PagerPagenumber(DbPage*); 212 int sqlite3PagerIswriteable(DbPage*); 213 #endif 214 #ifdef SQLITE_TEST 215 int *sqlite3PagerStats(Pager*); 216 void sqlite3PagerRefdump(Pager*); 217 void disable_simulated_io_errors(void); 218 void enable_simulated_io_errors(void); 219 #else 220 # define disable_simulated_io_errors() 221 # define enable_simulated_io_errors() 222 #endif 223 224 #endif /* _PAGER_H_ */ 225