]> git.sur5r.net Git - openldap/blob - servers/slapd/back-bdb2/proto-back-bdb2.h
New dn2id format with base/one/subtree indices (ldbm/bdb2)
[openldap] / servers / slapd / back-bdb2 / proto-back-bdb2.h
1 #ifndef _PROTO_BACK_BDB2
2 #define _PROTO_BACK_BDB2
3
4 #include <ldap_cdefs.h>
5
6 #include <ac/time.h>            /* Needed in add.c compare.c struct timeval */
7
8 #include "external.h"
9
10 LDAP_BEGIN_DECL
11
12 /*
13  * add.c
14  */
15 int bdb2i_release_add_lock LDAP_P(());
16
17 /*
18  * alias.c
19  */
20
21 Entry * bdb2i_deref_r LDAP_P((
22         Backend *be,
23         Entry *e,
24         char *dn,
25         int *err,
26         Entry **matched,
27         char **text ));
28
29 #define deref_entry_r( be, e, err, matched, text ) \
30         bdb2i_deref_r( be, e, NULL, err, matched, text )
31 #define deref_dn_r( be, dn, err, matched, text ) \
32         bdb2i_deref_r( be, NULL, dn, err, matched, text )
33
34 /*
35  * attr.c
36  */
37
38 void bdb2i_attr_masks LDAP_P(( struct ldbminfo *li, char *type, int *indexmask,
39  int *syntaxmask ));
40 void bdb2i_attr_index_config LDAP_P(( struct ldbminfo *li, char *fname,
41  int lineno, int argc, char **argv, int init ));
42
43 /*
44  * cache.c
45  */
46
47 int bdb2i_cache_add_entry_rw LDAP_P(( struct cache *cache, Entry *e, int rw ));
48 int bdb2i_cache_update_entry LDAP_P(( struct cache *cache, Entry *e ));
49 void bdb2i_cache_return_entry_rw LDAP_P(( struct cache *cache, Entry *e,
50  int rw ));
51 #define bdb2i_cache_return_entry_r(c, e) bdb2i_cache_return_entry_rw((c), (e), 0)
52 #define bdb2i_cache_return_entry_w(c, e) bdb2i_cache_return_entry_rw((c), (e), 1)
53
54 ID bdb2i_cache_find_entry_dn2id LDAP_P(( BackendDB *be, struct cache *cache,
55  char *dn ));
56 Entry * bdb2i_cache_find_entry_id LDAP_P(( struct cache *cache, ID id, int rw ));
57 int bdb2i_cache_delete_entry LDAP_P(( struct cache *cache, Entry *e ));
58
59 /*
60  * dbcache.c
61  */
62
63 struct dbcache * bdb2i_cache_open LDAP_P(( BackendDB *be, char *name, char *suffix,
64  int flags ));
65 void bdb2i_cache_close LDAP_P(( BackendDB *be, struct dbcache *db ));
66 void bdb2i_cache_really_close LDAP_P(( BackendDB *be, struct dbcache *db ));
67 void bdb2i_cache_flush_all LDAP_P(( BackendDB *be ));
68 Datum bdb2i_cache_fetch LDAP_P(( struct dbcache *db, Datum key ));
69 int bdb2i_cache_store LDAP_P(( struct dbcache *db, Datum key, Datum data, int flags ));
70 int bdb2i_cache_delete LDAP_P(( struct dbcache *db, Datum key ));
71
72 /*
73  * dn2id.c
74  */
75
76 int bdb2i_dn2id_add LDAP_P(( BackendDB *be, char *dn, ID id ));
77 ID bdb2i_dn2id LDAP_P(( BackendDB *be, char *dn ));
78 int bdb2i_dn2id_delete LDAP_P(( BackendDB *be, char *dn ));
79
80 ID_BLOCK *
81 bdb2i_dn2idl LDAP_P((
82     BackendDB   *be,
83     char        *dn,
84         int     prefix ));
85
86 Entry * bdb2i_dn2entry_rw LDAP_P((
87         BackendDB *be,
88         char *dn,
89         Entry **matched,
90         int rw ));
91
92 #define bdb2i_dn2entry_r(be, dn, m) bdb2i_dn2entry_rw((be), (dn), (m), 0)
93 #define bdb2i_dn2entry_w(be, dn, m) bdb2i_dn2entry_rw((be), (dn), (m), 1)
94
95 /*
96  * entry.c
97  */
98 int bdb2_back_entry_release_rw LDAP_P(( BackendDB *be, Entry *e, int rw ));
99
100 /*
101  * filterindex.c
102  */
103
104 ID_BLOCK * bdb2i_filter_candidates LDAP_P(( BackendDB *be, Filter *f ));
105
106 /*
107  * id2children.c
108  */
109
110 int bdb2i_has_children LDAP_P(( BackendDB *be, Entry *p ));
111
112 /*
113  * id2entry.c
114  */
115
116 int bdb2i_id2entry_add LDAP_P(( BackendDB *be, Entry *e ));
117 int bdb2i_id2entry_delete LDAP_P(( BackendDB *be, Entry *e ));
118
119 Entry * bdb2i_id2entry_rw LDAP_P(( BackendDB *be, ID id, int rw )); 
120 #define bdb2i_id2entry_r(be, id)  bdb2i_id2entry_rw((be), (id), 0)
121 #define bdb2i_id2entry_w(be, id)  bdb2i_id2entry_rw((be), (id), 1)
122
123 /*
124  * idl.c
125  */
126
127 ID_BLOCK * bdb2i_idl_alloc LDAP_P(( unsigned int nids ));
128 ID_BLOCK * bdb2i_idl_allids LDAP_P(( BackendDB *be ));
129 void bdb2i_idl_free LDAP_P(( ID_BLOCK *idl ));
130 ID_BLOCK * bdb2i_idl_fetch LDAP_P(( BackendDB *be, struct dbcache *db, Datum key ));
131 int bdb2i_idl_insert_key LDAP_P(( BackendDB *be, struct dbcache *db, Datum key, ID id ));
132 int bdb2i_idl_insert LDAP_P(( ID_BLOCK **idl, ID id, unsigned int maxids ));
133 int bdb2i_idl_delete_key LDAP_P(( BackendDB *be, struct dbcache *db, Datum key, ID id ));
134 ID_BLOCK * bdb2i_idl_intersection LDAP_P(( BackendDB *be, ID_BLOCK *a, ID_BLOCK *b ));
135 ID_BLOCK * bdb2i_idl_union LDAP_P(( BackendDB *be, ID_BLOCK *a, ID_BLOCK *b ));
136 ID_BLOCK * bdb2i_idl_notin LDAP_P(( BackendDB *be, ID_BLOCK *a, ID_BLOCK *b ));
137 ID bdb2i_idl_firstid LDAP_P(( ID_BLOCK *idl, ID *cursor ));
138 ID bdb2i_idl_nextid LDAP_P(( ID_BLOCK *idl, ID *cursor ));
139
140 /*
141  * index.c
142  */
143
144 int bdb2i_index_add_entry LDAP_P(( BackendDB *be, Entry *e ));
145 int bdb2i_index_add_mods LDAP_P(( BackendDB *be, LDAPModList *ml, ID id ));
146 ID_BLOCK * bdb2i_index_read LDAP_P(( BackendDB *be, char *type, int indextype, char *val ));
147 int bdb2i_index_add_values LDAP_P(( BackendDB *be, char *type, struct berval **vals, ID  id ));
148
149 /*
150  * kerberos.c
151  */
152
153 #ifdef HAVE_KERBEROS
154 /* bdb2i_krbv4_ldap_auth LDAP_P(( BackendDB *be, struct berval *cred, AUTH_DAT *ad )); */
155 #endif
156
157 /*
158  * modify.c
159  * These prototypes are placed here because they are used by modify and
160  * modify rdn which are implemented in different files. 
161  *
162  * We need bdb2i_back_modify_internal here because of LDAP modrdn & modify use 
163  * it. If we do not add this, there would be a bunch of code replication 
164  * here and there and of course the likelihood of bugs increases.
165  * Juan C. Gomez (gomez@engr.sgi.com) 05/18/99
166  *
167  */
168
169 int bdb2i_add_values LDAP_P(( Entry *e, LDAPMod *mod, char *dn ));
170 int bdb2i_delete_values LDAP_P(( Entry *e, LDAPMod *mod, char *dn ));
171 int bdb2i_replace_values LDAP_P(( Entry *e, LDAPMod *mod, char *dn ));
172 int bdb2i_back_modify_internal LDAP_P((Backend *be, Connection *conn, Operation *op,
173                                  char *dn, LDAPModList *mods, Entry *e));
174 /*
175  * nextid.c
176  */
177
178 ID bdb2i_next_id LDAP_P(( BackendDB *be ));
179 void bdb2i_next_id_return LDAP_P(( BackendDB *be, ID id ));
180 ID bdb2i_next_id_get LDAP_P(( BackendDB *be ));
181 int bdb2i_next_id_save LDAP_P(( BackendDB *be ));
182
183 /*
184  *  startup.c
185  */
186
187 int bdb2i_back_startup     LDAP_P(( BackendInfo *bi ));
188 int bdb2i_back_shutdown    LDAP_P(( BackendInfo *bi ));
189 int bdb2i_back_db_startup  LDAP_P(( BackendDB *be ));
190 int bdb2i_back_db_shutdown LDAP_P(( BackendDB *be ));
191
192 /*
193  *  timing.c
194  */
195
196 void bdb2i_uncond_start_timing LDAP_P(( struct timeval *time1 ));
197 #define bdb2i_start_timing(bi,time1)  if ( with_timing( bi )) bdb2i_uncond_start_timing( (time1) )
198 void bdb2i_uncond_stop_timing LDAP_P(( struct timeval time1,
199   char *func, Connection *conn, Operation *op, int level ));
200 #define bdb2i_stop_timing(bi,time1,func,conn,op)  if ( with_timing( bi )) bdb2i_uncond_stop_timing( (time1), (func), (conn), (op), LDAP_DEBUG_ANY )
201
202 /*
203  * porter.c
204  */
205
206 int bdb2i_enter_backend_rw  LDAP_P(( DB_LOCK *lock, int writer ));
207 #define bdb2i_enter_backend_r(lock)  bdb2i_enter_backend_rw((lock), 0 )
208 #define bdb2i_enter_backend_w(lock)  bdb2i_enter_backend_rw((lock), 1 )
209 int bdb2i_leave_backend_rw LDAP_P(( DB_LOCK lock, int writer ));
210 #define bdb2i_leave_backend_r(lock)  bdb2i_leave_backend_rw((lock), 0 )
211 #define bdb2i_leave_backend_w(lock)  bdb2i_leave_backend_rw((lock), 1 )
212
213 /*
214  *  txn.c
215  */
216
217 int bdb2i_txn_head_init  LDAP_P(( BDB2_TXN_HEAD *head ));
218 void bdb2i_txn_attr_config LDAP_P((
219  struct ldbminfo  *li,
220  char *attr,
221  int open ));
222 int bdb2i_txn_open_files LDAP_P(( BackendDB *be ));
223 void bdb2i_txn_close_files LDAP_P(( BackendDB *be ));
224 BDB2_TXN_FILES *bdb2i_get_db_file_cache LDAP_P((
225  struct ldbminfo *li,
226  char *name ));
227 int bdb2i_check_additional_attr_index LDAP_P(( struct ldbminfo *li ));
228 void bdb2i_check_default_attr_index_add LDAP_P((
229  struct ldbminfo *li,
230  Entry *e ));
231 void bdb2i_check_default_attr_index_mod LDAP_P((
232  struct ldbminfo *li,
233  LDAPModList *modlist ));
234 ID bdb2i_get_nextid  LDAP_P(( BackendDB *be ));
235 int bdb2i_put_nextid LDAP_P(( BackendDB *be, ID id ));
236 LDBM bdb2i_db_open LDAP_P(( char *name, int type, int rw, int mode,
237  int dbcachesize ));
238 int bdb2i_db_store   LDAP_P(( LDBM ldbm, Datum key, Datum data, int flags ));
239 int bdb2i_db_delete  LDAP_P(( LDBM ldbm, Datum key ));
240 Datum bdb2i_db_fetch LDAP_P(( LDBM ldbm, Datum key ));
241 Datum bdb2i_db_firstkey LDAP_P(( LDBM ldbm, DBC **dbch ));
242 Datum bdb2i_db_nextkey  LDAP_P(( LDBM ldbm, Datum key, DBC *dbcp ));
243 int bdb2i_start_transction   LDAP_P(( DB_TXNMGR *txmgr ));
244 int bdb2i_finish_transaction LDAP_P(( ));
245 int bdb2i_set_txn_checkpoint LDAP_P(( DB_TXNMGR *txmgr, int forced ));
246
247
248 LDAP_END_DECL
249 #endif