1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/persistentdata/persistentstorage/sql/SQLite/pager.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,144 @@
1.4 +/*
1.5 +** 2001 September 15
1.6 +**
1.7 +** The author disclaims copyright to this source code. In place of
1.8 +** a legal notice, here is a blessing:
1.9 +**
1.10 +** May you do good and not evil.
1.11 +** May you find forgiveness for yourself and forgive others.
1.12 +** May you share freely, never taking more than you give.
1.13 +**
1.14 +*************************************************************************
1.15 +** This header file defines the interface that the sqlite page cache
1.16 +** subsystem. The page cache subsystem reads and writes a file a page
1.17 +** at a time and provides a journal for rollback.
1.18 +**
1.19 +** @(#) $Id: pager.h,v 1.77 2008/07/16 18:17:56 danielk1977 Exp $
1.20 +*/
1.21 +
1.22 +#ifndef _PAGER_H_
1.23 +#define _PAGER_H_
1.24 +
1.25 +/*
1.26 +** If defined as non-zero, auto-vacuum is enabled by default. Otherwise
1.27 +** it must be turned on for each database using "PRAGMA auto_vacuum = 1".
1.28 +*/
1.29 +#ifndef SQLITE_DEFAULT_JOURNAL_SIZE_LIMIT
1.30 + #define SQLITE_DEFAULT_JOURNAL_SIZE_LIMIT -1
1.31 +#endif
1.32 +
1.33 +/*
1.34 +** The type used to represent a page number. The first page in a file
1.35 +** is called page 1. 0 is used to represent "not a page".
1.36 +*/
1.37 +typedef u32 Pgno;
1.38 +
1.39 +/*
1.40 +** Each open file is managed by a separate instance of the "Pager" structure.
1.41 +*/
1.42 +typedef struct Pager Pager;
1.43 +
1.44 +/*
1.45 +** Handle type for pages.
1.46 +*/
1.47 +typedef struct PgHdr DbPage;
1.48 +
1.49 +/*
1.50 +** Allowed values for the flags parameter to sqlite3PagerOpen().
1.51 +**
1.52 +** NOTE: This values must match the corresponding BTREE_ values in btree.h.
1.53 +*/
1.54 +#define PAGER_OMIT_JOURNAL 0x0001 /* Do not use a rollback journal */
1.55 +#define PAGER_NO_READLOCK 0x0002 /* Omit readlocks on readonly files */
1.56 +
1.57 +/*
1.58 +** Valid values for the second argument to sqlite3PagerLockingMode().
1.59 +*/
1.60 +#define PAGER_LOCKINGMODE_QUERY -1
1.61 +#define PAGER_LOCKINGMODE_NORMAL 0
1.62 +#define PAGER_LOCKINGMODE_EXCLUSIVE 1
1.63 +
1.64 +/*
1.65 +** Valid values for the second argument to sqlite3PagerJournalMode().
1.66 +*/
1.67 +#define PAGER_JOURNALMODE_QUERY -1
1.68 +#define PAGER_JOURNALMODE_DELETE 0 /* Commit by deleting journal file */
1.69 +#define PAGER_JOURNALMODE_PERSIST 1 /* Commit by zeroing journal header */
1.70 +#define PAGER_JOURNALMODE_OFF 2 /* Journal omitted. */
1.71 +
1.72 +/*
1.73 +** See source code comments for a detailed description of the following
1.74 +** routines:
1.75 +*/
1.76 +int sqlite3PagerOpen(sqlite3_vfs *, Pager **ppPager, const char*, int,int,int);
1.77 +void sqlite3PagerSetBusyhandler(Pager*, BusyHandler *pBusyHandler);
1.78 +void sqlite3PagerSetDestructor(Pager*, void(*)(DbPage*,int));
1.79 +void sqlite3PagerSetReiniter(Pager*, void(*)(DbPage*,int));
1.80 +int sqlite3PagerSetPagesize(Pager*, u16*);
1.81 +int sqlite3PagerMaxPageCount(Pager*, int);
1.82 +int sqlite3PagerReadFileheader(Pager*, int, unsigned char*);
1.83 +void sqlite3PagerSetCachesize(Pager*, int);
1.84 +int sqlite3PagerClose(Pager *pPager);
1.85 +int sqlite3PagerAcquire(Pager *pPager, Pgno pgno, DbPage **ppPage, int clrFlag);
1.86 +#define sqlite3PagerGet(A,B,C) sqlite3PagerAcquire(A,B,C,0)
1.87 +DbPage *sqlite3PagerLookup(Pager *pPager, Pgno pgno);
1.88 +int sqlite3PagerRef(DbPage*);
1.89 +int sqlite3PagerUnref(DbPage*);
1.90 +int sqlite3PagerWrite(DbPage*);
1.91 +int sqlite3PagerPagecount(Pager*, int*);
1.92 +int sqlite3PagerTruncate(Pager*,Pgno);
1.93 +int sqlite3PagerBegin(DbPage*, int exFlag);
1.94 +int sqlite3PagerCommitPhaseOne(Pager*,const char *zMaster, Pgno, int);
1.95 +int sqlite3PagerCommitPhaseTwo(Pager*);
1.96 +int sqlite3PagerRollback(Pager*);
1.97 +int sqlite3PagerIsreadonly(Pager*);
1.98 +int sqlite3PagerStmtBegin(Pager*);
1.99 +int sqlite3PagerStmtCommit(Pager*);
1.100 +int sqlite3PagerStmtRollback(Pager*);
1.101 +void sqlite3PagerDontRollback(DbPage*);
1.102 +void sqlite3PagerDontWrite(DbPage*);
1.103 +int sqlite3PagerRefcount(Pager*);
1.104 +void sqlite3PagerSetSafetyLevel(Pager*,int,int);
1.105 +const char *sqlite3PagerFilename(Pager*);
1.106 +const sqlite3_vfs *sqlite3PagerVfs(Pager*);
1.107 +sqlite3_file *sqlite3PagerFile(Pager*);
1.108 +const char *sqlite3PagerDirname(Pager*);
1.109 +const char *sqlite3PagerJournalname(Pager*);
1.110 +int sqlite3PagerNosync(Pager*);
1.111 +int sqlite3PagerMovepage(Pager*,DbPage*,Pgno,int);
1.112 +void *sqlite3PagerGetData(DbPage *);
1.113 +void *sqlite3PagerGetExtra(DbPage *);
1.114 +int sqlite3PagerLockingMode(Pager *, int);
1.115 +int sqlite3PagerJournalMode(Pager *, int);
1.116 +i64 sqlite3PagerJournalSizeLimit(Pager *, i64);
1.117 +void *sqlite3PagerTempSpace(Pager*);
1.118 +int sqlite3PagerSync(Pager *pPager);
1.119 +
1.120 +#if defined(SQLITE_ENABLE_MEMORY_MANAGEMENT) && !defined(SQLITE_OMIT_DISKIO)
1.121 + int sqlite3PagerReleaseMemory(int);
1.122 +#endif
1.123 +
1.124 +#ifdef SQLITE_HAS_CODEC
1.125 + void sqlite3PagerSetCodec(Pager*,void*(*)(void*,void*,Pgno,int),void*);
1.126 +#endif
1.127 +
1.128 +#if !defined(NDEBUG) || defined(SQLITE_TEST)
1.129 + Pgno sqlite3PagerPagenumber(DbPage*);
1.130 + int sqlite3PagerIswriteable(DbPage*);
1.131 +#endif
1.132 +
1.133 +#ifdef SQLITE_TEST
1.134 + int *sqlite3PagerStats(Pager*);
1.135 + void sqlite3PagerRefdump(Pager*);
1.136 + int sqlite3PagerIsMemdb(Pager*);
1.137 +#endif
1.138 +
1.139 +#ifdef SQLITE_TEST
1.140 +void disable_simulated_io_errors(void);
1.141 +void enable_simulated_io_errors(void);
1.142 +#else
1.143 +# define disable_simulated_io_errors()
1.144 +# define enable_simulated_io_errors()
1.145 +#endif
1.146 +
1.147 +#endif /* _PAGER_H_ */