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>.
27 #define DB_VERSION_FULL ((DB_VERSION_MAJOR << 24) | (DB_VERSION_MINOR << 16) | DB_VERSION_PATCH)
29 #define DN_BASE_PREFIX SLAP_INDEX_EQUALITY_PREFIX
30 #define DN_ONE_PREFIX '%'
31 #define DN_SUBTREE_PREFIX '@'
33 #define DBTzero(t) (memset((t), 0, sizeof(DBT)))
34 #define DBT2bv(t,bv) ((bv)->bv_val = (t)->data, \
35 (bv)->bv_len = (t)->size)
36 #define bv2DBT(bv,t) ((t)->data = (bv)->bv_val, \
37 (t)->size = (bv)->bv_len )
39 #define BDB_TXN_RETRIES 16
41 #define BDB_MAX_ADD_LOOP 30
43 #define BDB_SUFFIX ".bdb"
44 #define BDB_ID2ENTRY 0
48 /* The bdb on-disk entry format is pretty space-inefficient. Average
49 * sized user entries are 3-4K each. You need at least two entries to
50 * fit into a single database page, more is better. 64K is BDB's
51 * upper bound. Smaller pages are better for concurrency.
53 #ifndef BDB_ID2ENTRY_PAGESIZE
54 #define BDB_ID2ENTRY_PAGESIZE 16384
58 #define BDB_PAGESIZE 4096 /* BDB's original default */
61 #define DEFAULT_CACHE_SIZE 1000
63 /* The default search IDL stack cache depth */
64 #define DEFAULT_SEARCH_STACK_DEPTH 16
66 /* The minimum we can function with */
67 #define MINIMUM_SEARCH_STACK_DEPTH 8
69 typedef struct bdb_idl_cache_entry_s {
71 ldap_pvt_thread_rdwr_t idl_entry_rwlock;
74 struct bdb_idl_cache_entry_s* idl_lru_prev;
75 struct bdb_idl_cache_entry_s* idl_lru_next;
76 } bdb_idl_cache_entry_t;
78 /* BDB backend specific entry info */
79 typedef struct bdb_entry_info {
80 struct bdb_entry_info *bei_parent;
83 /* we use the bei_id as a lockobj, but we need to make the size != 4
84 * to avoid conflicting with BDB's internal locks. So add a byte here
85 * that is always zero.
90 #define CACHE_ENTRY_DELETED 1
91 #define CACHE_ENTRY_NO_KIDS 2
92 #define CACHE_ENTRY_NOT_LINKED 4
93 #define CACHE_ENTRY_NO_GRANDKIDS 8
94 #define CACHE_ENTRY_LOADING 0x10
95 #define CACHE_ENTRY_WALKING 0x20
96 #define CACHE_ENTRY_ONELEVEL 0x40
99 * remaining fields require backend cache lock to access
101 struct berval bei_nrdn;
103 struct berval bei_rdn;
104 int bei_modrdns; /* track renames */
105 int bei_ckids; /* number of kids cached */
106 int bei_dkids; /* number of kids on-disk, plus 1 */
110 #ifdef SLAP_ZONE_ALLOC
111 struct bdb_info *bei_bdb;
114 ldap_pvt_thread_mutex_t bei_kids_mutex;
116 struct bdb_entry_info *bei_lrunext; /* for cache lru list */
117 struct bdb_entry_info *bei_lruprev;
120 #define BEI(e) ((EntryInfo *) ((e)->e_private))
122 /* for the in-core cache of entries */
123 typedef struct bdb_cache {
126 int c_eiused; /* EntryInfo's in use */
127 int c_leaves; /* EntryInfo leaf nodes */
129 EntryInfo *c_eifree; /* free list */
131 EntryInfo *c_lruhead; /* lru - add accessed entries here */
132 EntryInfo *c_lrutail; /* lru - rem lru entries from here */
133 ldap_pvt_thread_rdwr_t c_rwlock;
134 ldap_pvt_thread_mutex_t lru_mutex;
135 u_int32_t c_locker; /* used by lru cleaner */
136 #ifdef SLAP_ZONE_ALLOC
141 #define CACHE_READ_LOCK 0
142 #define CACHE_WRITE_LOCK 1
144 #define BDB_INDICES 128
154 /* DB_ENV parameters */
155 /* The DB_ENV can be tuned via DB_CONFIG */
157 u_int32_t bi_dbenv_xflags; /* extra flags */
161 struct bdb_db_info **bi_databases;
162 ldap_pvt_thread_mutex_t bi_database_mutex;
163 int bi_db_opflags; /* db-specific flags */
165 slap_mask_t bi_defaultmask;
167 struct bdb_attrinfo **bi_attrs;
169 void *bi_search_stack;
170 int bi_search_stack_depth;
174 u_int32_t bi_txn_cp_min;
175 u_int32_t bi_txn_cp_kbyte;
176 void *bi_txn_cp_task;
183 ldap_pvt_thread_mutex_t bi_lastid_mutex;
184 int bi_idl_cache_max_size;
185 int bi_idl_cache_size;
186 Avlnode *bi_idl_tree;
187 bdb_idl_cache_entry_t *bi_idl_lru_head;
188 bdb_idl_cache_entry_t *bi_idl_lru_tail;
189 ldap_pvt_thread_rdwr_t bi_idl_tree_rwlock;
190 ldap_pvt_thread_mutex_t bi_idl_tree_lrulock;
191 alock_info_t bi_alock_info;
192 char *bi_db_config_path;
193 BerVarray bi_db_config;
195 #define BDB_IS_OPEN 0x01
196 #define BDB_HAS_CONFIG 0x02
197 #define BDB_UPD_CONFIG 0x04
198 #define BDB_DEL_INDEX 0x08
199 #define BDB_RE_OPEN 0x10
201 int bi_modrdns; /* number of modrdns completed */
202 ldap_pvt_thread_mutex_t bi_modrdns_mutex;
206 #define bi_id2entry bi_databases[BDB_ID2ENTRY]
207 #define bi_dn2id bi_databases[BDB_DN2ID]
209 struct bdb_lock_info {
210 struct bdb_lock_info *bli_next;
219 u_int32_t boi_locker;
221 struct bdb_lock_info *boi_locks; /* used when no txn */
224 #define DB_OPEN(db, file, name, type, flags, mode) \
225 (db)->open(db, file, name, type, flags, mode)
227 #if DB_VERSION_MAJOR < 4
228 #define LOCK_DETECT(env,f,t,a) lock_detect(env, f, t, a)
229 #define LOCK_GET(env,i,f,o,m,l) lock_get(env, i, f, o, m, l)
230 #define LOCK_PUT(env,l) lock_put(env, l)
231 #define TXN_CHECKPOINT(env,k,m,f) txn_checkpoint(env, k, m, f)
232 #define TXN_BEGIN(env,p,t,f) txn_begin((env), p, t, f)
233 #define TXN_PREPARE(txn,gid) txn_prepare((txn), (gid))
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) lock_id(env, locker)
238 #define XLOCK_ID_FREE(env, locker) lock_id_free(env, locker)
240 #define LOCK_DETECT(env,f,t,a) (env)->lock_detect(env, f, t, a)
241 #define LOCK_GET(env,i,f,o,m,l) (env)->lock_get(env, i, f, o, m, l)
242 #define LOCK_PUT(env,l) (env)->lock_put(env, l)
243 #define TXN_CHECKPOINT(env,k,m,f) (env)->txn_checkpoint(env, k, m, f)
244 #define TXN_BEGIN(env,p,t,f) (env)->txn_begin((env), p, t, f)
245 #define TXN_PREPARE(txn,g) (txn)->prepare((txn), (g))
246 #define TXN_COMMIT(txn,f) (txn)->commit((txn), (f))
247 #define TXN_ABORT(txn) (txn)->abort((txn))
248 #define TXN_ID(txn) (txn)->id(txn)
249 #define XLOCK_ID(env, locker) (env)->lock_id(env, locker)
250 #define XLOCK_ID_FREE(env, locker) (env)->lock_id_free(env, locker)
252 /* BDB 4.1.17 adds txn arg to db->open */
253 #if DB_VERSION_FULL >= 0x04010011
255 #define DB_OPEN(db, file, name, type, flags, mode) \
256 (db)->open(db, NULL, file, name, type, flags, mode)
261 #define BDB_REUSE_LOCKERS
263 #define BDB_CSN_COMMIT 0
264 #define BDB_CSN_ABORT 1
265 #define BDB_CSN_RETRY 2
267 /* Copy an ID "src" to pointer "dst" in big-endian byte order */
268 #define BDB_ID2DISK( src, dst ) \
269 do { int i0; ID tmp; unsigned char *_p; \
270 tmp = (src); _p = (unsigned char *)(dst); \
271 for ( i0=sizeof(ID)-1; i0>=0; i0-- ) { \
272 _p[i0] = tmp & 0xff; tmp >>= 8; \
276 /* Copy a pointer "src" to a pointer "dst" from big-endian to native order */
277 #define BDB_DISK2ID( src, dst ) \
278 do { int i0; ID tmp = 0; unsigned char *_p; \
279 _p = (unsigned char *)(src); \
280 for ( i0=0; i0<sizeof(ID); i0++ ) { \
281 tmp <<= 8; tmp |= *_p++; \
287 /* for the cache of attribute information (which are indexed, etc.) */
288 typedef struct bdb_attrinfo {
289 AttributeDescription *ai_desc; /* attribute description cn;lang-en */
290 slap_mask_t ai_indexmask; /* how the attr is indexed */
291 slap_mask_t ai_newmask; /* new settings to replace old mask */
292 #ifdef LDAP_COMP_MATCH
293 ComponentReference* ai_cr; /*component indexing*/
297 /* These flags must not clash with SLAP_INDEX flags or ops in slap.h! */
298 #define BDB_INDEX_DELETING 0x8000U /* index is being modified */
299 #define BDB_INDEX_UPDATE_OP 0x03 /* performing an index update */
301 /* For slapindex to record which attrs in an entry belong to which
304 typedef struct AttrList {
305 struct AttrList *next;
309 typedef struct IndexRec {
314 #include "proto-bdb.h"
316 #endif /* _BACK_BDB_H_ */