1 /* back-bdb.h - bdb back-end header file */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 2000-2005 The OpenLDAP Foundation.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted only as authorized by the OpenLDAP
12 * A copy of this license is available in the file LICENSE in the
13 * top-level directory of the distribution or, alternatively, at
14 * <http://www.OpenLDAP.org/license.html>.
26 #define DB_VERSION_FULL ((DB_VERSION_MAJOR << 24) | (DB_VERSION_MINOR << 16) | DB_VERSION_PATCH)
28 #define BDB_SUBENTRIES 1
30 #define DN_BASE_PREFIX SLAP_INDEX_EQUALITY_PREFIX
31 #define DN_ONE_PREFIX '%'
32 #define DN_SUBTREE_PREFIX '@'
34 #define DBTzero(t) (memset((t), 0, sizeof(DBT)))
35 #define DBT2bv(t,bv) ((bv)->bv_val = (t)->data, \
36 (bv)->bv_len = (t)->size)
37 #define bv2DBT(bv,t) ((t)->data = (bv)->bv_val, \
38 (t)->size = (bv)->bv_len )
40 #define BDB_TXN_RETRIES 16
42 #define BDB_MAX_ADD_LOOP 30
45 #define BDB_TMP_SUBDIR "tmp"
46 #define BDB_LG_SUBDIR "log"
47 #define BDB_DATA_SUBDIR "data"
50 #define BDB_SUFFIX ".bdb"
51 #define BDB_ID2ENTRY 0
55 /* The bdb on-disk entry format is pretty space-inefficient. Average
56 * sized user entries are 3-4K each. You need at least two entries to
57 * fit into a single database page, more is better. 64K is BDB's
58 * upper bound. Smaller pages are better for concurrency.
60 #ifndef BDB_ID2ENTRY_PAGESIZE
61 #define BDB_ID2ENTRY_PAGESIZE 16384
65 #define BDB_PAGESIZE 4096 /* BDB's original default */
68 #define DEFAULT_CACHE_SIZE 1000
70 /* The default search IDL stack cache depth */
71 #define DEFAULT_SEARCH_STACK_DEPTH 16
73 /* The minimum we can function with */
74 #define MINIMUM_SEARCH_STACK_DEPTH 8
76 typedef struct bdb_idl_cache_entry_s {
78 ldap_pvt_thread_rdwr_t idl_entry_rwlock;
81 struct bdb_idl_cache_entry_s* idl_lru_prev;
82 struct bdb_idl_cache_entry_s* idl_lru_next;
83 } bdb_idl_cache_entry_t;
85 /* BDB backend specific entry info */
86 typedef struct bdb_entry_info {
87 struct bdb_entry_info *bei_parent;
90 /* we use the bei_id as a lockobj, but we need to make the size != 4
91 * to avoid conflicting with BDB's internal locks. So add a byte here
92 * that is always zero.
97 #define CACHE_ENTRY_DELETED 1
98 #define CACHE_ENTRY_NO_KIDS 2
99 #define CACHE_ENTRY_NOT_LINKED 4
100 #define CACHE_ENTRY_NO_GRANDKIDS 8
101 #define CACHE_ENTRY_LOADING 0x10
104 * remaining fields require backend cache lock to access
106 struct berval bei_nrdn;
108 struct berval bei_rdn;
109 int bei_modrdns; /* track renames */
110 int bei_ckids; /* number of kids cached */
111 int bei_dkids; /* number of kids on-disk, plus 1 */
115 #ifdef SLAP_ZONE_ALLOC
116 struct bdb_info *bei_bdb;
119 ldap_pvt_thread_mutex_t bei_kids_mutex;
121 struct bdb_entry_info *bei_lrunext; /* for cache lru list */
122 struct bdb_entry_info *bei_lruprev;
125 #define BEI(e) ((EntryInfo *) ((e)->e_private))
127 /* for the in-core cache of entries */
128 typedef struct bdb_cache {
131 int c_eiused; /* EntryInfo's in use */
133 EntryInfo *c_eifree; /* free list */
135 EntryInfo *c_lruhead; /* lru - add accessed entries here */
136 EntryInfo *c_lrutail; /* lru - rem lru entries from here */
137 ldap_pvt_thread_rdwr_t c_rwlock;
138 ldap_pvt_thread_mutex_t lru_mutex;
139 u_int32_t c_locker; /* used by lru cleaner */
140 #ifdef SLAP_ZONE_ALLOC
145 #define CACHE_READ_LOCK 0
146 #define CACHE_WRITE_LOCK 1
148 #define BDB_INDICES 128
158 /* DB_ENV parameters */
159 /* The DB_ENV can be tuned via DB_CONFIG */
161 u_int32_t bi_dbenv_xflags; /* extra flags */
165 struct bdb_db_info **bi_databases;
166 ldap_pvt_thread_mutex_t bi_database_mutex;
167 int bi_db_opflags; /* db-specific flags */
169 slap_mask_t bi_defaultmask;
172 void *bi_search_stack;
173 int bi_search_stack_depth;
177 u_int32_t bi_txn_cp_min;
178 u_int32_t bi_txn_cp_kbyte;
184 ldap_pvt_thread_mutex_t bi_lastid_mutex;
185 int bi_idl_cache_max_size;
186 int bi_idl_cache_size;
187 Avlnode *bi_idl_tree;
188 bdb_idl_cache_entry_t *bi_idl_lru_head;
189 bdb_idl_cache_entry_t *bi_idl_lru_tail;
190 ldap_pvt_thread_rdwr_t bi_idl_tree_rwlock;
191 ldap_pvt_thread_mutex_t bi_idl_tree_lrulock;
194 #define bi_id2entry bi_databases[BDB_ID2ENTRY]
195 #define bi_dn2id bi_databases[BDB_DN2ID]
197 struct bdb_lock_info {
198 struct bdb_lock_info *bli_next;
207 u_int32_t boi_locker;
209 struct bdb_lock_info *boi_locks; /* used when no txn */
212 #define DB_OPEN(db, file, name, type, flags, mode) \
213 (db)->open(db, file, name, type, flags, mode)
215 #if DB_VERSION_MAJOR < 4
216 #define LOCK_DETECT(env,f,t,a) lock_detect(env, f, t, a)
217 #define LOCK_GET(env,i,f,o,m,l) lock_get(env, i, f, o, m, l)
218 #define LOCK_PUT(env,l) lock_put(env, l)
219 #define TXN_CHECKPOINT(env,k,m,f) txn_checkpoint(env, k, m, f)
220 #define TXN_BEGIN(env,p,t,f) txn_begin((env), p, t, f)
221 #define TXN_PREPARE(txn,gid) txn_prepare((txn), (gid))
222 #define TXN_COMMIT(txn,f) txn_commit((txn), (f))
223 #define TXN_ABORT(txn) txn_abort((txn))
224 #define TXN_ID(txn) txn_id(txn)
225 #define XLOCK_ID(env, locker) lock_id(env, locker)
226 #define XLOCK_ID_FREE(env, locker) lock_id_free(env, locker)
228 #define LOCK_DETECT(env,f,t,a) (env)->lock_detect(env, f, t, a)
229 #define LOCK_GET(env,i,f,o,m,l) (env)->lock_get(env, i, f, o, m, l)
230 #define LOCK_PUT(env,l) (env)->lock_put(env, l)
231 #define TXN_CHECKPOINT(env,k,m,f) (env)->txn_checkpoint(env, k, m, f)
232 #define TXN_BEGIN(env,p,t,f) (env)->txn_begin((env), p, t, f)
233 #define TXN_PREPARE(txn,g) (txn)->prepare((txn), (g))
234 #define TXN_COMMIT(txn,f) (txn)->commit((txn), (f))
235 #define TXN_ABORT(txn) (txn)->abort((txn))
236 #define TXN_ID(txn) (txn)->id(txn)
237 #define XLOCK_ID(env, locker) (env)->lock_id(env, locker)
238 #define XLOCK_ID_FREE(env, locker) (env)->lock_id_free(env, locker)
240 /* BDB 4.1.17 adds txn arg to db->open */
241 #if DB_VERSION_FULL >= 0x04010011
243 #define DB_OPEN(db, file, name, type, flags, mode) \
244 (db)->open(db, NULL, file, name, type, flags, mode)
249 #define BDB_REUSE_LOCKERS
251 #define BDB_CSN_COMMIT 0
252 #define BDB_CSN_ABORT 1
253 #define BDB_CSN_RETRY 2
255 /* Copy an ID "src" to pointer "dst" in big-endian byte order */
256 #define BDB_ID2DISK( src, dst ) \
257 do { int i0; ID tmp; unsigned char *_p; \
258 tmp = (src); _p = (char *)(dst); \
259 for ( i0=sizeof(ID)-1; i0>=0; i0-- ) { \
260 _p[i0] = tmp & 0xff; tmp >>= 8; \
264 /* Copy a pointer "src" to a pointer "dst" from big-endian to native order */
265 #define BDB_DISK2ID( src, dst ) \
266 do { int i0; ID tmp = 0; unsigned char *_p; \
267 _p = (unsigned char *)(src); \
268 for ( i0=0; i0<sizeof(ID); i0++ ) { \
269 tmp <<= 8; tmp |= *_p++; \
275 #include "proto-bdb.h"
277 #endif /* _BACK_BDB_H_ */