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