sl@0: /*
sl@0: ** 2001 September 15
sl@0: **
sl@0: ** The author disclaims copyright to this source code.  In place of
sl@0: ** a legal notice, here is a blessing:
sl@0: **
sl@0: **    May you do good and not evil.
sl@0: **    May you find forgiveness for yourself and forgive others.
sl@0: **    May you share freely, never taking more than you give.
sl@0: **
sl@0: *************************************************************************
sl@0: ** This header file defines the interface that the sqlite B-Tree file
sl@0: ** subsystem.  See comments in the source code for a detailed description
sl@0: ** of what each interface routine does.
sl@0: **
sl@0: ** @(#) $Id: btree.h,v 1.104 2008/10/08 17:58:49 danielk1977 Exp $
sl@0: */
sl@0: #ifndef _BTREE_H_
sl@0: #define _BTREE_H_
sl@0: 
sl@0: /* TODO: This definition is just included so other modules compile. It
sl@0: ** needs to be revisited.
sl@0: */
sl@0: #define SQLITE_N_BTREE_META 10
sl@0: 
sl@0: /*
sl@0: ** If defined as non-zero, auto-vacuum is enabled by default. Otherwise
sl@0: ** it must be turned on for each database using "PRAGMA auto_vacuum = 1".
sl@0: */
sl@0: #ifndef SQLITE_DEFAULT_AUTOVACUUM
sl@0:   #define SQLITE_DEFAULT_AUTOVACUUM 0
sl@0: #endif
sl@0: 
sl@0: #define BTREE_AUTOVACUUM_NONE 0        /* Do not do auto-vacuum */
sl@0: #define BTREE_AUTOVACUUM_FULL 1        /* Do full auto-vacuum */
sl@0: #define BTREE_AUTOVACUUM_INCR 2        /* Incremental vacuum */
sl@0: 
sl@0: /*
sl@0: ** Forward declarations of structure
sl@0: */
sl@0: typedef struct Btree Btree;
sl@0: typedef struct BtCursor BtCursor;
sl@0: typedef struct BtShared BtShared;
sl@0: typedef struct BtreeMutexArray BtreeMutexArray;
sl@0: 
sl@0: /*
sl@0: ** This structure records all of the Btrees that need to hold
sl@0: ** a mutex before we enter sqlite3VdbeExec().  The Btrees are
sl@0: ** are placed in aBtree[] in order of aBtree[]->pBt.  That way,
sl@0: ** we can always lock and unlock them all quickly.
sl@0: */
sl@0: struct BtreeMutexArray {
sl@0:   int nMutex;
sl@0:   Btree *aBtree[SQLITE_MAX_ATTACHED+1];
sl@0: };
sl@0: 
sl@0: 
sl@0: int sqlite3BtreeOpen(
sl@0:   const char *zFilename,   /* Name of database file to open */
sl@0:   sqlite3 *db,             /* Associated database connection */
sl@0:   Btree **,                /* Return open Btree* here */
sl@0:   int flags,               /* Flags */
sl@0:   int vfsFlags             /* Flags passed through to VFS open */
sl@0: );
sl@0: 
sl@0: /* The flags parameter to sqlite3BtreeOpen can be the bitwise or of the
sl@0: ** following values.
sl@0: **
sl@0: ** NOTE:  These values must match the corresponding PAGER_ values in
sl@0: ** pager.h.
sl@0: */
sl@0: #define BTREE_OMIT_JOURNAL  1  /* Do not use journal.  No argument */
sl@0: #define BTREE_NO_READLOCK   2  /* Omit readlocks on readonly files */
sl@0: #define BTREE_MEMORY        4  /* In-memory DB.  No argument */
sl@0: #define BTREE_READONLY      8  /* Open the database in read-only mode */
sl@0: #define BTREE_READWRITE    16  /* Open for both reading and writing */
sl@0: #define BTREE_CREATE       32  /* Create the database if it does not exist */
sl@0: 
sl@0: int sqlite3BtreeClose(Btree*);
sl@0: int sqlite3BtreeSetCacheSize(Btree*,int);
sl@0: int sqlite3BtreeSetSafetyLevel(Btree*,int,int);
sl@0: int sqlite3BtreeSyncDisabled(Btree*);
sl@0: int sqlite3BtreeSetPageSize(Btree*,int,int);
sl@0: int sqlite3BtreeGetPageSize(Btree*);
sl@0: int sqlite3BtreeMaxPageCount(Btree*,int);
sl@0: int sqlite3BtreeGetReserve(Btree*);
sl@0: int sqlite3BtreeSetAutoVacuum(Btree *, int);
sl@0: int sqlite3BtreeGetAutoVacuum(Btree *);
sl@0: int sqlite3BtreeBeginTrans(Btree*,int);
sl@0: int sqlite3BtreeCommitPhaseOne(Btree*, const char *zMaster);
sl@0: int sqlite3BtreeCommitPhaseTwo(Btree*);
sl@0: int sqlite3BtreeCommit(Btree*);
sl@0: int sqlite3BtreeRollback(Btree*);
sl@0: int sqlite3BtreeBeginStmt(Btree*);
sl@0: int sqlite3BtreeCommitStmt(Btree*);
sl@0: int sqlite3BtreeRollbackStmt(Btree*);
sl@0: int sqlite3BtreeCreateTable(Btree*, int*, int flags);
sl@0: int sqlite3BtreeIsInTrans(Btree*);
sl@0: int sqlite3BtreeIsInStmt(Btree*);
sl@0: int sqlite3BtreeIsInReadTrans(Btree*);
sl@0: void *sqlite3BtreeSchema(Btree *, int, void(*)(void *));
sl@0: int sqlite3BtreeSchemaLocked(Btree *);
sl@0: int sqlite3BtreeLockTable(Btree *, int, u8);
sl@0: 
sl@0: const char *sqlite3BtreeGetFilename(Btree *);
sl@0: const char *sqlite3BtreeGetDirname(Btree *);
sl@0: const char *sqlite3BtreeGetJournalname(Btree *);
sl@0: int sqlite3BtreeCopyFile(Btree *, Btree *);
sl@0: 
sl@0: int sqlite3BtreeIncrVacuum(Btree *);
sl@0: 
sl@0: /* The flags parameter to sqlite3BtreeCreateTable can be the bitwise OR
sl@0: ** of the following flags:
sl@0: */
sl@0: #define BTREE_INTKEY     1    /* Table has only 64-bit signed integer keys */
sl@0: #define BTREE_ZERODATA   2    /* Table has keys only - no data */
sl@0: #define BTREE_LEAFDATA   4    /* Data stored in leaves only.  Implies INTKEY */
sl@0: 
sl@0: int sqlite3BtreeDropTable(Btree*, int, int*);
sl@0: int sqlite3BtreeClearTable(Btree*, int);
sl@0: int sqlite3BtreeGetMeta(Btree*, int idx, u32 *pValue);
sl@0: int sqlite3BtreeUpdateMeta(Btree*, int idx, u32 value);
sl@0: void sqlite3BtreeTripAllCursors(Btree*, int);
sl@0: 
sl@0: int sqlite3BtreeCursor(
sl@0:   Btree*,                              /* BTree containing table to open */
sl@0:   int iTable,                          /* Index of root page */
sl@0:   int wrFlag,                          /* 1 for writing.  0 for read-only */
sl@0:   struct KeyInfo*,                     /* First argument to compare function */
sl@0:   BtCursor *pCursor                    /* Space to write cursor structure */
sl@0: );
sl@0: int sqlite3BtreeCursorSize(void);
sl@0: 
sl@0: int sqlite3BtreeCloseCursor(BtCursor*);
sl@0: int sqlite3BtreeMoveto(
sl@0:   BtCursor*,
sl@0:   const void *pKey,
sl@0:   i64 nKey,
sl@0:   int bias,
sl@0:   int *pRes
sl@0: );
sl@0: int sqlite3BtreeMovetoUnpacked(
sl@0:   BtCursor*,
sl@0:   UnpackedRecord *pUnKey,
sl@0:   i64 intKey,
sl@0:   int bias,
sl@0:   int *pRes
sl@0: );
sl@0: int sqlite3BtreeCursorHasMoved(BtCursor*, int*);
sl@0: int sqlite3BtreeDelete(BtCursor*);
sl@0: int sqlite3BtreeInsert(BtCursor*, const void *pKey, i64 nKey,
sl@0:                                   const void *pData, int nData,
sl@0:                                   int nZero, int bias);
sl@0: int sqlite3BtreeFirst(BtCursor*, int *pRes);
sl@0: int sqlite3BtreeLast(BtCursor*, int *pRes);
sl@0: int sqlite3BtreeNext(BtCursor*, int *pRes);
sl@0: int sqlite3BtreeEof(BtCursor*);
sl@0: int sqlite3BtreeFlags(BtCursor*);
sl@0: int sqlite3BtreePrevious(BtCursor*, int *pRes);
sl@0: int sqlite3BtreeKeySize(BtCursor*, i64 *pSize);
sl@0: int sqlite3BtreeKey(BtCursor*, u32 offset, u32 amt, void*);
sl@0: sqlite3 *sqlite3BtreeCursorDb(const BtCursor*);
sl@0: const void *sqlite3BtreeKeyFetch(BtCursor*, int *pAmt);
sl@0: const void *sqlite3BtreeDataFetch(BtCursor*, int *pAmt);
sl@0: int sqlite3BtreeDataSize(BtCursor*, u32 *pSize);
sl@0: int sqlite3BtreeData(BtCursor*, u32 offset, u32 amt, void*);
sl@0: 
sl@0: char *sqlite3BtreeIntegrityCheck(Btree*, int *aRoot, int nRoot, int, int*);
sl@0: struct Pager *sqlite3BtreePager(Btree*);
sl@0: 
sl@0: int sqlite3BtreePutData(BtCursor*, u32 offset, u32 amt, void*);
sl@0: void sqlite3BtreeCacheOverflow(BtCursor *);
sl@0: void sqlite3BtreeClearCursor(BtCursor *);
sl@0: 
sl@0: #ifdef SQLITE_TEST
sl@0: int sqlite3BtreeCursorInfo(BtCursor*, int*, int);
sl@0: void sqlite3BtreeCursorList(Btree*);
sl@0: #endif
sl@0: 
sl@0: /*
sl@0: ** If we are not using shared cache, then there is no need to
sl@0: ** use mutexes to access the BtShared structures.  So make the
sl@0: ** Enter and Leave procedures no-ops.
sl@0: */
sl@0: #if !defined(SQLITE_OMIT_SHARED_CACHE) && SQLITE_THREADSAFE
sl@0:   void sqlite3BtreeEnter(Btree*);
sl@0:   void sqlite3BtreeLeave(Btree*);
sl@0: #ifndef NDEBUG
sl@0:   /* This routine is used inside assert() statements only. */
sl@0:   int sqlite3BtreeHoldsMutex(Btree*);
sl@0: #endif
sl@0:   void sqlite3BtreeEnterCursor(BtCursor*);
sl@0:   void sqlite3BtreeLeaveCursor(BtCursor*);
sl@0:   void sqlite3BtreeEnterAll(sqlite3*);
sl@0:   void sqlite3BtreeLeaveAll(sqlite3*);
sl@0: #ifndef NDEBUG
sl@0:   /* This routine is used inside assert() statements only. */
sl@0:   int sqlite3BtreeHoldsAllMutexes(sqlite3*);
sl@0: #endif
sl@0:   void sqlite3BtreeMutexArrayEnter(BtreeMutexArray*);
sl@0:   void sqlite3BtreeMutexArrayLeave(BtreeMutexArray*);
sl@0:   void sqlite3BtreeMutexArrayInsert(BtreeMutexArray*, Btree*);
sl@0: #else
sl@0: # define sqlite3BtreeEnter(X)
sl@0: # define sqlite3BtreeLeave(X)
sl@0: #ifndef NDEBUG
sl@0:   /* This routine is used inside assert() statements only. */
sl@0: # define sqlite3BtreeHoldsMutex(X) 1
sl@0: #endif
sl@0: # define sqlite3BtreeEnterCursor(X)
sl@0: # define sqlite3BtreeLeaveCursor(X)
sl@0: # define sqlite3BtreeEnterAll(X)
sl@0: # define sqlite3BtreeLeaveAll(X)
sl@0: #ifndef NDEBUG
sl@0:   /* This routine is used inside assert() statements only. */
sl@0: # define sqlite3BtreeHoldsAllMutexes(X) 1
sl@0: #endif
sl@0: # define sqlite3BtreeMutexArrayEnter(X)
sl@0: # define sqlite3BtreeMutexArrayLeave(X)
sl@0: # define sqlite3BtreeMutexArrayInsert(X,Y)
sl@0: #endif
sl@0: 
sl@0: 
sl@0: #endif /* _BTREE_H_ */