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