]> git.sur5r.net Git - openldap/blob - servers/slapd/back-ldbm/proto-back-ldbm.h
New dn2id format with base/one/subtree indices (ldbm/bdb2)
[openldap] / servers / slapd / back-ldbm / proto-back-ldbm.h
1 /*
2  * Copyright 1998-1999 The OpenLDAP Foundation, All Rights Reserved.
3  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
4  */
5
6 #ifndef _PROTO_BACK_LDBM
7 #define _PROTO_BACK_LDBM
8
9 #include <ldap_cdefs.h>
10
11 #include "external.h"
12
13 LDAP_BEGIN_DECL
14
15 /*
16  * alias.c
17  */
18 Entry *deref_internal_r LDAP_P((
19         Backend *be,
20         Entry *e,
21         char *dn,
22         int *err,
23         Entry **matched,
24         char **text ));
25
26 #define deref_entry_r( be, e, err, matched, text ) \
27         deref_internal_r( be, e, NULL, err, matched, text )
28 #define deref_dn_r( be, dn, err, matched, text ) \
29         deref_internal_r( be, NULL, dn, err, matched, text)
30
31 /*
32  * attr.c
33  */
34
35 void attr_masks LDAP_P(( struct ldbminfo *li, char *type, int *indexmask,
36  int *syntaxmask ));
37 void attr_index_config LDAP_P(( struct ldbminfo *li, char *fname, int lineno,
38  int argc, char **argv, int init ));
39 #ifdef SLAP_CLEANUP
40 void attr_index_destroy LDAP_P(( Avlnode *tree ));
41 #endif
42
43 /*
44  * cache.c
45  */
46
47 int cache_add_entry_rw LDAP_P(( Cache *cache, Entry *e, int rw ));
48 int cache_update_entry LDAP_P(( Cache *cache, Entry *e ));
49 void cache_return_entry_rw LDAP_P(( Cache *cache, Entry *e, int rw ));
50 #define cache_return_entry_r(c, e) cache_return_entry_rw((c), (e), 0)
51 #define cache_return_entry_w(c, e) cache_return_entry_rw((c), (e), 1)
52
53 ID cache_find_entry_dn2id LDAP_P(( Backend *be, Cache *cache, char *dn ));
54 Entry * cache_find_entry_id LDAP_P(( Cache *cache, ID id, int rw ));
55 int cache_delete_entry LDAP_P(( Cache *cache, Entry *e ));
56 #ifdef SLAP_CLEANUP
57 void cache_release_all LDAP_P(( Cache *cache ));
58 #endif
59
60 /*
61  * dbcache.c
62  */
63
64 DBCache * ldbm_cache_open LDAP_P(( Backend *be,
65         char *name, char *suffix, int flags ));
66 void ldbm_cache_close LDAP_P(( Backend *be, DBCache *db ));
67 void ldbm_cache_really_close LDAP_P(( Backend *be, DBCache *db ));
68 void ldbm_cache_flush_all LDAP_P(( Backend *be ));
69 Datum ldbm_cache_fetch LDAP_P(( DBCache *db, Datum key ));
70 int ldbm_cache_store LDAP_P(( DBCache *db, Datum key, Datum data, int flags ));
71 int ldbm_cache_delete LDAP_P(( DBCache *db, Datum key ));
72
73 /*
74  * dn2id.c
75  */
76
77 int dn2id_add LDAP_P(( Backend *be, char *dn, ID id ));
78 ID dn2id LDAP_P(( Backend *be, char *dn ));
79 ID_BLOCK *dn2idl LDAP_P(( Backend *be, char *dn, int prefix ));
80 int dn2id_delete LDAP_P(( Backend *be, char *dn ));
81
82 Entry * dn2entry_rw LDAP_P(( Backend *be, char *dn, Entry **matched, int rw ));
83 #define dn2entry_r(be, dn, m) dn2entry_rw((be), (dn), (m), 0)
84 #define dn2entry_w(be, dn, m) dn2entry_rw((be), (dn), (m), 1)
85
86 /*
87  * entry.c
88  */
89 int ldbm_back_entry_release_rw LDAP_P(( Backend *be, Entry *e, int rw ));
90
91 /*
92  * filterindex.c
93  */
94
95 ID_BLOCK * filter_candidates LDAP_P(( Backend *be, Filter *f ));
96
97 /*
98  * id2children.c
99  */
100
101 int id2children_add LDAP_P(( Backend *be, Entry *p, Entry *e ));
102 int id2children_remove LDAP_P(( Backend *be, Entry *p, Entry *e ));
103 int has_children LDAP_P(( Backend *be, Entry *p ));
104
105 /*
106  * id2entry.c
107  */
108
109 int id2entry_add LDAP_P(( Backend *be, Entry *e ));
110 int id2entry_delete LDAP_P(( Backend *be, Entry *e ));
111
112 Entry * id2entry_rw LDAP_P(( Backend *be, ID id, int rw )); 
113 #define id2entry_r(be, id)      id2entry_rw((be), (id), 0)
114 #define id2entry_w(be, id)      id2entry_rw((be), (id), 1)
115
116 /*
117  * idl.c
118  */
119
120 ID_BLOCK * idl_alloc LDAP_P(( unsigned int nids ));
121 ID_BLOCK * idl_allids LDAP_P(( Backend *be ));
122 void idl_free LDAP_P(( ID_BLOCK *idl ));
123 ID_BLOCK * idl_fetch LDAP_P(( Backend *be, DBCache *db, Datum key ));
124 int idl_insert_key LDAP_P(( Backend *be, DBCache *db, Datum key, ID id ));
125 int idl_insert LDAP_P(( ID_BLOCK **idl, ID id, unsigned int maxids ));
126 int idl_delete_key LDAP_P(( Backend *be, DBCache *db, Datum key, ID id ));
127 ID_BLOCK * idl_intersection LDAP_P(( Backend *be, ID_BLOCK *a, ID_BLOCK *b ));
128 ID_BLOCK * idl_union LDAP_P(( Backend *be, ID_BLOCK *a, ID_BLOCK *b ));
129 ID_BLOCK * idl_notin LDAP_P(( Backend *be, ID_BLOCK *a, ID_BLOCK *b ));
130 ID idl_firstid LDAP_P(( ID_BLOCK *idl, ID *cursor ));
131 ID idl_nextid LDAP_P(( ID_BLOCK *idl, ID *cursor ));
132
133 /*
134  * index.c
135  */
136
137 int index_add_entry LDAP_P(( Backend *be, Entry *e ));
138 int index_add_mods LDAP_P(( Backend *be, LDAPModList *ml, ID id ));
139 ID_BLOCK * index_read LDAP_P(( Backend *be,
140         char *type, int indextype, char *val ));
141 /* Possible operations supported (op) by index_change_values() */
142 int index_change_values LDAP_P(( Backend *be,
143                                  char *type,
144                                  struct berval **vals,
145                                  ID  id,
146                                  unsigned int op ));
147
148 /*
149  * kerberos.c
150  */
151
152 #ifdef HAVE_KERBEROS
153 /* krbv4_ldap_auth LDAP_P(( Backend *be, struct berval *cred, AUTH_DAT *ad )); */
154 #endif
155  
156 /*
157  * modify.c
158  * These prototypes are placed here because they are used by modify and
159  * modify rdn which are implemented in different files. 
160  *
161  * We need ldbm_internal_modify here because of LDAP modrdn & modify use 
162  * it. If we do not add this, there would be a bunch of code replication 
163  * here and there and of course the likelihood of bugs increases.
164  * Juan C. Gomez (gomez@engr.sgi.com) 05/18/99
165  * 
166  */
167
168 int add_values LDAP_P(( Entry *e, LDAPMod *mod, char *dn ));
169 int delete_values LDAP_P(( Entry *e, LDAPMod *mod, char *dn ));
170 int replace_values LDAP_P(( Entry *e, LDAPMod *mod, char *dn ));
171 int ldbm_modify_internal LDAP_P((Backend *be,
172         Connection *conn, Operation *op,
173         char *dn, LDAPModList *mods, Entry *e));
174
175 /*
176  * nextid.c
177  */
178
179 ID next_id LDAP_P(( Backend *be ));
180 ID next_id_get LDAP_P(( Backend *be ));
181 ID next_id_write LDAP_P(( Backend *be, ID id ));
182
183 LDAP_END_DECL
184 #endif