1 /* back-bdb.h - bdb back-end header file */
4 * Copyright 2000-2003 The OpenLDAP Foundation, All Rights Reserved.
5 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
17 /* #define BDB_HIER 1 */
19 #define DN_BASE_PREFIX SLAP_INDEX_EQUALITY_PREFIX
20 #define DN_ONE_PREFIX '%'
21 #define DN_SUBTREE_PREFIX '@'
23 #define DBTzero(t) (memset((t), 0, sizeof(DBT)))
24 #define DBT2bv(t,bv) ((bv)->bv_val = (t)->data, \
25 (bv)->bv_len = (t)->size)
26 #define bv2DBT(bv,t) ((t)->data = (bv)->bv_val, \
27 (t)->size = (bv)->bv_len )
29 #define BDB_TXN_RETRIES 16
31 #define BDB_MAX_ADD_LOOP 30
36 #define BDB_TMP_SUBDIR "tmp"
37 #define BDB_LG_SUBDIR "log"
38 #define BDB_DATA_SUBDIR "data"
41 #define BDB_SUFFIX ".bdb"
42 #define BDB_ID2ENTRY 0
44 #define BDB_ID2PARENT 1
50 /* The bdb on-disk entry format is pretty space-inefficient. Average
51 * sized user entries are 3-4K each. You need at least two entries to
52 * fit into a single database page, more is better. 64K is BDB's
53 * upper bound. Smaller pages are better for concurrency.
55 #ifndef BDB_ID2ENTRY_PAGESIZE
56 #define BDB_ID2ENTRY_PAGESIZE 16384
60 #define BDB_PAGESIZE 4096 /* BDB's original default */
63 #define DEFAULT_CACHE_SIZE 1000
65 /* The default search IDL stack cache depth */
66 #define DEFAULT_SEARCH_STACK_DEPTH 16
68 /* The minimum we can function with */
69 #define MINIMUM_SEARCH_STACK_DEPTH 8
71 /* for the IDL cache */
72 #define SLAP_IDL_CACHE 1
75 typedef struct bdb_idl_cache_entry_s {
77 ldap_pvt_thread_rdwr_t idl_entry_rwlock;
80 struct bdb_idl_cache_entry_s* idl_lru_prev;
81 struct bdb_idl_cache_entry_s* idl_lru_next;
82 } bdb_idl_cache_entry_t;
85 /* for the in-core cache of entries */
86 typedef struct bdb_cache {
91 Entry *c_lruhead; /* lru - add accessed entries here */
92 Entry *c_lrutail; /* lru - rem lru entries from here */
93 ldap_pvt_thread_rdwr_t c_rwlock;
94 ldap_pvt_thread_mutex_t lru_mutex;
97 #define CACHE_READ_LOCK 0
98 #define CACHE_WRITE_LOCK 1
100 #define BDB_INDICES 128
110 /* DB_ENV parameters */
111 /* The DB_ENV can be tuned via DB_CONFIG */
113 u_int32_t bi_dbenv_xflags; /* extra flags */
117 struct bdb_db_info **bi_databases;
118 int bi_db_opflags; /* db-specific flags */
120 slap_mask_t bi_defaultmask;
123 void *bi_search_stack;
124 int bi_search_stack_depth;
127 ldap_pvt_thread_rdwr_t bi_tree_rdwr;
132 u_int32_t bi_txn_cp_min;
133 u_int32_t bi_txn_cp_kbyte;
138 ldap_pvt_thread_mutex_t bi_lastid_mutex;
139 #if defined(LDAP_CLIENT_UPDATE) || defined(LDAP_SYNC)
140 LDAP_LIST_HEAD(pl, slap_op) bi_psearch_list;
142 #ifdef SLAP_IDL_CACHE
143 int bi_idl_cache_max_size;
144 int bi_idl_cache_size;
145 Avlnode *bi_idl_tree;
146 bdb_idl_cache_entry_t *bi_idl_lru_head;
147 bdb_idl_cache_entry_t *bi_idl_lru_tail;
148 ldap_pvt_thread_mutex_t bi_idl_tree_mutex;
152 #define bi_id2entry bi_databases[BDB_ID2ENTRY]
154 #define bi_id2parent bi_databases[BDB_ID2PARENT]
156 #define bi_dn2id bi_databases[BDB_DN2ID]
162 DB_LOCK boi_lock; /* used when no txn */
164 u_int32_t boi_locker;
168 #define DB_OPEN(db, txn, file, name, type, flags, mode) \
169 (db)->open(db, file, name, type, flags, mode)
171 #if DB_VERSION_MAJOR < 4
172 #define LOCK_DETECT(env,f,t,a) lock_detect(env, f, t, a)
173 #define LOCK_GET(env,i,f,o,m,l) lock_get(env, i, f, o, m, l)
174 #define LOCK_PUT(env,l) lock_put(env, l)
175 #define TXN_CHECKPOINT(env,k,m,f) txn_checkpoint(env, k, m, f)
176 #define TXN_BEGIN(env,p,t,f) txn_begin((env), p, t, f)
177 #define TXN_PREPARE(txn,gid) txn_prepare((txn), (gid))
178 #define TXN_COMMIT(txn,f) txn_commit((txn), (f))
179 #define TXN_ABORT(txn) txn_abort((txn))
180 #define TXN_ID(txn) txn_id(txn)
181 #define XLOCK_ID(env, locker) lock_id(env, locker)
182 #define XLOCK_ID_FREE(env, locker) lock_id_free(env, locker)
184 #define LOCK_DETECT(env,f,t,a) (env)->lock_detect(env, f, t, a)
185 #define LOCK_GET(env,i,f,o,m,l) (env)->lock_get(env, i, f, o, m, l)
186 #define LOCK_PUT(env,l) (env)->lock_put(env, l)
187 #define TXN_CHECKPOINT(env,k,m,f) (env)->txn_checkpoint(env, k, m, f)
188 #define TXN_BEGIN(env,p,t,f) (env)->txn_begin((env), p, t, f)
189 #define TXN_PREPARE(txn,g) (txn)->prepare((txn), (g))
190 #define TXN_COMMIT(txn,f) (txn)->commit((txn), (f))
191 #define TXN_ABORT(txn) (txn)->abort((txn))
192 #define TXN_ID(txn) (txn)->id(txn)
193 #define XLOCK_ID(env, locker) (env)->lock_id(env, locker)
194 #define XLOCK_ID_FREE(env, locker) (env)->lock_id_free(env, locker)
196 /* BDB 4.1.17 adds txn arg to db->open */
197 #if DB_VERSION_MINOR > 1 || DB_VERSION_PATCH >= 17
199 #define DB_OPEN(db, txn, file, name, type, flags, mode) \
200 (db)->open(db, txn, file, name, type, flags, mode)
203 #define BDB_REUSE_LOCKERS
205 #ifdef BDB_REUSE_LOCKERS
206 #define LOCK_ID_FREE(env, locker)
207 #define LOCK_ID(env, locker) bdb_locker_id(op, env, locker)
209 #define LOCK_ID_FREE(env, locker) XLOCK_ID_FREE(env, locker)
210 #define LOCK_ID(env, locker) XLOCK_ID(env, locker)
217 #include "proto-bdb.h"
219 #endif /* _BACK_BDB_H_ */