]> git.sur5r.net Git - openldap/blob - servers/slapd/back-bdb/back-bdb.h
Merge in latest changes from HEAD
[openldap] / servers / slapd / back-bdb / back-bdb.h
1 /* back-bdb.h - bdb back-end header file */
2 /* $OpenLDAP$ */
3 /*
4  * Copyright 2000-2003 The OpenLDAP Foundation, All Rights Reserved.
5  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
6  */
7
8 #ifndef _BACK_BDB_H_
9 #define _BACK_BDB_H_
10
11 #include <portable.h>
12 #include "slap.h"
13 #include <db.h>
14
15 LDAP_BEGIN_DECL
16
17 #define BDB_SUBENTRIES 1
18
19 #define DN_BASE_PREFIX          SLAP_INDEX_EQUALITY_PREFIX
20 #define DN_ONE_PREFIX           '%'
21 #define DN_SUBTREE_PREFIX       '@'
22
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 )
28
29 #define BDB_TXN_RETRIES         16
30
31 #define BDB_MAX_ADD_LOOP        30
32
33 #define BDB_ALIASES     1
34
35 #ifdef BDB_SUBDIRS
36 #define BDB_TMP_SUBDIR  "tmp"
37 #define BDB_LG_SUBDIR   "log"
38 #define BDB_DATA_SUBDIR "data"
39 #endif
40
41 #define BDB_SUFFIX              ".bdb"
42 #define BDB_ID2ENTRY    0
43 #define BDB_DN2ID               1
44 #define BDB_NDB                 2
45
46 /* The bdb on-disk entry format is pretty space-inefficient. Average
47  * sized user entries are 3-4K each. You need at least two entries to
48  * fit into a single database page, more is better. 64K is BDB's
49  * upper bound. Smaller pages are better for concurrency.
50  */
51 #ifndef BDB_ID2ENTRY_PAGESIZE
52 #define BDB_ID2ENTRY_PAGESIZE   16384
53 #endif
54
55 #ifndef BDB_PAGESIZE
56 #define BDB_PAGESIZE    4096    /* BDB's original default */
57 #endif
58
59 #define DEFAULT_CACHE_SIZE     1000
60
61 /* The default search IDL stack cache depth */
62 #define DEFAULT_SEARCH_STACK_DEPTH      16
63
64 /* The minimum we can function with */
65 #define MINIMUM_SEARCH_STACK_DEPTH      8
66
67 /* for the IDL cache */
68 #define SLAP_IDL_CACHE  1
69
70 #ifdef SLAP_IDL_CACHE
71 typedef struct bdb_idl_cache_entry_s {
72         struct berval kstr;
73         ldap_pvt_thread_rdwr_t idl_entry_rwlock;
74         ID      *idl;
75         DB      *db;
76         struct bdb_idl_cache_entry_s* idl_lru_prev;
77         struct bdb_idl_cache_entry_s* idl_lru_next;
78 } bdb_idl_cache_entry_t;
79 #endif
80
81 /* BDB backend specific entry info */
82 typedef struct bdb_entry_info {
83         struct bdb_entry_info *bei_parent;
84         ID bei_id;
85
86         int bei_state;
87 #define CACHE_ENTRY_DELETED     1
88 #define CACHE_ENTRY_NO_KIDS     2
89 #define CACHE_ENTRY_NOT_LINKED  4
90 #define CACHE_ENTRY_NO_GRANDKIDS        8
91
92         /*
93          * remaining fields require backend cache lock to access
94          */
95         struct berval bei_nrdn;
96 #ifdef BDB_HIER
97         struct berval bei_rdn;
98         int     bei_modrdns;    /* track renames */
99         int     bei_ckids;      /* number of kids cached */
100         int     bei_dkids;      /* number of kids on-disk, plus 1 */
101 #endif
102         Entry   *bei_e;
103         Avlnode *bei_kids;
104         ldap_pvt_thread_mutex_t bei_kids_mutex;
105         
106         struct bdb_entry_info   *bei_lrunext;   /* for cache lru list */
107         struct bdb_entry_info   *bei_lruprev;
108 } EntryInfo;
109 #undef BEI
110 #define BEI(e)  ((EntryInfo *) ((e)->e_private))
111
112 /* for the in-core cache of entries */
113 typedef struct bdb_cache {
114         int             c_maxsize;
115         int             c_cursize;
116         EntryInfo       c_dntree;
117         EntryInfo       *c_eifree;      /* free list */
118         Avlnode         *c_idtree;
119         EntryInfo       *c_lruhead;     /* lru - add accessed entries here */
120         EntryInfo       *c_lrutail;     /* lru - rem lru entries from here */
121         ldap_pvt_thread_rdwr_t c_rwlock;
122         ldap_pvt_thread_mutex_t lru_mutex;
123 } Cache;
124  
125 #define CACHE_READ_LOCK                0
126 #define CACHE_WRITE_LOCK       1
127  
128 #define BDB_INDICES             128
129
130 struct bdb_db_info {
131         char            *bdi_name;
132         DB                      *bdi_db;
133 };
134
135 struct bdb_info {
136         DB_ENV          *bi_dbenv;
137
138         /* DB_ENV parameters */
139         /* The DB_ENV can be tuned via DB_CONFIG */
140         char            *bi_dbenv_home;
141         u_int32_t       bi_dbenv_xflags; /* extra flags */
142         int                     bi_dbenv_mode;
143
144         int                     bi_ndatabases;
145         struct bdb_db_info **bi_databases;
146         ldap_pvt_thread_mutex_t bi_database_mutex;
147         int             bi_db_opflags;  /* db-specific flags */
148
149         slap_mask_t     bi_defaultmask;
150         Cache           bi_cache;
151         Avlnode         *bi_attrs;
152         void            *bi_search_stack;
153         int             bi_search_stack_depth;
154
155         int                     bi_txn_cp;
156         u_int32_t       bi_txn_cp_min;
157         u_int32_t       bi_txn_cp_kbyte;
158
159         int                     bi_lock_detect;
160         long            bi_shm_key;
161
162         ID                      bi_lastid;
163         ldap_pvt_thread_mutex_t bi_lastid_mutex;
164         LDAP_LIST_HEAD(pl, slap_op) bi_psearch_list;
165 #ifdef SLAP_IDL_CACHE
166         int             bi_idl_cache_max_size;
167         int             bi_idl_cache_size;
168         Avlnode         *bi_idl_tree;
169         bdb_idl_cache_entry_t   *bi_idl_lru_head;
170         bdb_idl_cache_entry_t   *bi_idl_lru_tail;
171         ldap_pvt_thread_rdwr_t bi_idl_tree_rwlock;
172         ldap_pvt_thread_mutex_t bi_idl_tree_lrulock;
173 #endif
174 };
175
176 #define bi_id2entry     bi_databases[BDB_ID2ENTRY]
177 #define bi_dn2id        bi_databases[BDB_DN2ID]
178
179 struct bdb_op_info {
180         BackendDB*      boi_bdb;
181         DB_TXN*         boi_txn;
182         DB_LOCK         boi_lock;       /* used when no txn */
183         u_int32_t       boi_err;
184         u_int32_t       boi_locker;
185         int             boi_acl_cache;
186 };
187
188 #define DB_OPEN(db, file, name, type, flags, mode) \
189         (db)->open(db, file, name, type, flags, mode)
190
191 #if DB_VERSION_MAJOR < 4
192 #define LOCK_DETECT(env,f,t,a)          lock_detect(env, f, t, a)
193 #define LOCK_GET(env,i,f,o,m,l)         lock_get(env, i, f, o, m, l)
194 #define LOCK_PUT(env,l)                 lock_put(env, l)
195 #define TXN_CHECKPOINT(env,k,m,f)       txn_checkpoint(env, k, m, f)
196 #define TXN_BEGIN(env,p,t,f)            txn_begin((env), p, t, f)
197 #define TXN_PREPARE(txn,gid)            txn_prepare((txn), (gid))
198 #define TXN_COMMIT(txn,f)                       txn_commit((txn), (f))
199 #define TXN_ABORT(txn)                          txn_abort((txn))
200 #define TXN_ID(txn)                                     txn_id(txn)
201 #define XLOCK_ID(env, locker)           lock_id(env, locker)
202 #define XLOCK_ID_FREE(env, locker)      lock_id_free(env, locker)
203 #else
204 #define LOCK_DETECT(env,f,t,a)          (env)->lock_detect(env, f, t, a)
205 #define LOCK_GET(env,i,f,o,m,l)         (env)->lock_get(env, i, f, o, m, l)
206 #define LOCK_PUT(env,l)                 (env)->lock_put(env, l)
207 #define TXN_CHECKPOINT(env,k,m,f)       (env)->txn_checkpoint(env, k, m, f)
208 #define TXN_BEGIN(env,p,t,f)            (env)->txn_begin((env), p, t, f)
209 #define TXN_PREPARE(txn,g)                      (txn)->prepare((txn), (g))
210 #define TXN_COMMIT(txn,f)                       (txn)->commit((txn), (f))
211 #define TXN_ABORT(txn)                          (txn)->abort((txn))
212 #define TXN_ID(txn)                                     (txn)->id(txn)
213 #define XLOCK_ID(env, locker)           (env)->lock_id(env, locker)
214 #define XLOCK_ID_FREE(env, locker)      (env)->lock_id_free(env, locker)
215
216 /* BDB 4.1.17 adds txn arg to db->open */
217 #if DB_VERSION_MINOR > 1 || DB_VERSION_PATCH >= 17
218 #undef DB_OPEN
219 #define DB_OPEN(db, file, name, type, flags, mode) \
220         (db)->open(db, NULL, file, name, type, (flags)|DB_AUTO_COMMIT, mode)
221 #endif
222
223 #endif
224
225 #define BDB_REUSE_LOCKERS
226
227 #define BDB_CSN_COMMIT  0
228 #define BDB_CSN_ABORT   1
229 #define BDB_CSN_RETRY   2
230
231 LDAP_END_DECL
232
233 #include "proto-bdb.h"
234
235 #endif /* _BACK_BDB_H_ */