git.sur5r.net Git - openldap/blob - servers/slapd/back-ldbm/proto-back-ldbm.h

   1 /* $OpenLDAP$ */
   2 /*
   3  * Copyright 1998-1999 The OpenLDAP Foundation, All Rights Reserved.
   4  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
   5  */
   6
   7 #ifndef _PROTO_BACK_LDBM
   8 #define _PROTO_BACK_LDBM
   9
  10 #include <ldap_cdefs.h>
  11
  12 #include "external.h"
  13
  14 LDAP_BEGIN_DECL
  15
  16 /*
  17  * alias.c
  18  */
  19 Entry *deref_internal_r LDAP_P((
  20         Backend *be,
  21         Entry *e,
  22         char *dn,
  23         int *err,
  24         Entry **matched,
  25         char **text ));
  26
  27 #define deref_entry_r( be, e, err, matched, text ) \
  28         deref_internal_r( be, e, NULL, err, matched, text )
  29 #define deref_dn_r( be, dn, err, matched, text ) \
  30         deref_internal_r( be, NULL, dn, err, matched, text)
  31
  32 /*
  33  * attr.c
  34  */
  35
  36 void attr_masks LDAP_P(( struct ldbminfo *li, char *type, int *indexmask,
  37  int *syntaxmask ));
  38 void attr_index_config LDAP_P(( struct ldbminfo *li,
  39         const char *fname, int lineno,
  40         int argc, char **argv, int init ));
  41 void attr_index_destroy LDAP_P(( Avlnode *tree ));
  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, const 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 void cache_release_all LDAP_P(( Cache *cache ));
  57
  58 /*
  59  * dbcache.c
  60  */
  61
  62 DBCache * ldbm_cache_open LDAP_P(( Backend *be,
  63         char *name, char *suffix, int flags ));
  64 void ldbm_cache_close LDAP_P(( Backend *be, DBCache *db ));
  65 void ldbm_cache_really_close LDAP_P(( Backend *be, DBCache *db ));
  66 void ldbm_cache_flush_all LDAP_P(( Backend *be ));
  67 Datum ldbm_cache_fetch LDAP_P(( DBCache *db, Datum key ));
  68 int ldbm_cache_store LDAP_P(( DBCache *db, Datum key, Datum data, int flags ));
  69 int ldbm_cache_delete LDAP_P(( DBCache *db, Datum key ));
  70
  71 /*
  72  * dn2id.c
  73  */
  74
  75 int dn2id_add LDAP_P(( Backend *be, const char *dn, ID id ));
  76 ID dn2id LDAP_P(( Backend *be, const char *dn ));
  77 ID_BLOCK *dn2idl LDAP_P(( Backend *be, const char *dn, int prefix ));
  78 int dn2id_delete LDAP_P(( Backend *be, const char *dn, ID id ));
  79
  80 Entry * dn2entry_rw LDAP_P(( Backend *be, const char *dn, Entry **matched, int rw ));
  81 #define dn2entry_r(be, dn, m) dn2entry_rw((be), (dn), (m), 0)
  82 #define dn2entry_w(be, dn, m) dn2entry_rw((be), (dn), (m), 1)
  83
  84 /*
  85  * entry.c
  86  */
  87 int ldbm_back_entry_release_rw LDAP_P(( Backend *be, Entry *e, int rw ));
  88
  89 /*
  90  * filterindex.c
  91  */
  92
  93 ID_BLOCK * filter_candidates LDAP_P(( Backend *be, Filter *f ));
  94
  95 /*
  96  * id2children.c
  97  */
  98
  99 int id2children_add LDAP_P(( Backend *be, Entry *p, Entry *e ));
 100 int id2children_remove LDAP_P(( Backend *be, Entry *p, Entry *e ));
 101 int has_children LDAP_P(( Backend *be, Entry *p ));
 102
 103 /*
 104  * id2entry.c
 105  */
 106
 107 int id2entry_add LDAP_P(( Backend *be, Entry *e ));
 108 int id2entry_delete LDAP_P(( Backend *be, Entry *e ));
 109
 110 Entry * id2entry_rw LDAP_P(( Backend *be, ID id, int rw ));
 111 #define id2entry_r(be, id)      id2entry_rw((be), (id), 0)
 112 #define id2entry_w(be, id)      id2entry_rw((be), (id), 1)
 113
 114 /*
 115  * idl.c
 116  */
 117
 118 ID_BLOCK * idl_alloc LDAP_P(( unsigned int nids ));
 119 ID_BLOCK * idl_allids LDAP_P(( Backend *be ));
 120 void idl_free LDAP_P(( ID_BLOCK *idl ));
 121 ID_BLOCK * idl_fetch LDAP_P(( Backend *be, DBCache *db, Datum key ));
 122 int idl_insert_key LDAP_P(( Backend *be, DBCache *db, Datum key, ID id ));
 123 int idl_insert LDAP_P(( ID_BLOCK **idl, ID id, unsigned int maxids ));
 124 int idl_delete_key LDAP_P(( Backend *be, DBCache *db, Datum key, ID id ));
 125 ID_BLOCK * idl_intersection LDAP_P(( Backend *be, ID_BLOCK *a, ID_BLOCK *b ));
 126 ID_BLOCK * idl_union LDAP_P(( Backend *be, ID_BLOCK *a, ID_BLOCK *b ));
 127 ID_BLOCK * idl_notin LDAP_P(( Backend *be, ID_BLOCK *a, ID_BLOCK *b ));
 128 ID idl_firstid LDAP_P(( ID_BLOCK *idl, ID *cursor ));
 129 ID idl_nextid LDAP_P(( ID_BLOCK *idl, ID *cursor ));
 130
 131 /*
 132  * index.c
 133  */
 134
 135 int index_add_entry LDAP_P(( Backend *be, Entry *e ));
 136 int index_add_mods LDAP_P(( Backend *be, LDAPModList *ml, ID id ));
 137 ID_BLOCK * index_read LDAP_P(( Backend *be,
 138         char *type, int indextype, char *val ));
 139 /* Possible operations supported (op) by index_change_values() */
 140 int index_change_values LDAP_P(( Backend *be,
 141                                  char *type,
 142                                  struct berval **vals,
 143                                  ID  id,
 144                                  unsigned int op ));
 145
 146 /*
 147  * passwd.c
 148  */
 149 extern int ldbm_back_exop_passwd LDAP_P(( BackendDB *bd,
 150         Connection *conn, Operation *op,
 151         char *reqoid,
 152         struct berval *reqdata,
 153         char **rspoid,
 154         struct berval **rspdata,
 155         LDAPControl ***rspctrls,
 156         char **text,
 157         struct berval *** refs ));
 158
 159
 160 /*
 161  * modify.c
 162  * These prototypes are placed here because they are used by modify and
 163  * modify rdn which are implemented in different files.
 164  *
 165  * We need ldbm_internal_modify here because of LDAP modrdn & modify use
 166  * it. If we do not add this, there would be a bunch of code replication
 167  * here and there and of course the likelihood of bugs increases.
 168  * Juan C. Gomez (gomez@engr.sgi.com) 05/18/99
 169  *
 170  */
 171
 172 int add_values LDAP_P(( Entry *e, LDAPMod *mod, char *dn ));
 173 int delete_values LDAP_P(( Entry *e, LDAPMod *mod, char *dn ));
 174 int replace_values LDAP_P(( Entry *e, LDAPMod *mod, char *dn ));
 175
 176 /* returns LDAP error code indicating error OR SLAPD_ABANDON */
 177 int ldbm_modify_internal LDAP_P((Backend *be,
 178         Connection *conn, Operation *op,
 179         char *dn, LDAPModList *mods, Entry *e ));
 180
 181 #ifdef HAVE_CYRUS_SASL
 182 /*
 183  * sasl.c
 184  */
 185 int ldbm_sasl_authorize LDAP_P((
 186         BackendDB *be,
 187         const char *auth_identity,
 188         const char *requested_user,
 189         const char **user,
 190         const char **errstring ));
 191 int ldbm_sasl_getsecret LDAP_P((
 192         Backend *be,
 193         const char *mechanism,
 194         const char *auth_identity,
 195         const char *realm,
 196         sasl_secret_t **secret ));
 197 int ldbm_sasl_putsecret LDAP_P((
 198         Backend *be,
 199         const char *mechanism,
 200         const char *auth_identity,
 201         const char *realm,
 202         const sasl_secret_t *secret ));
 203 #endif /* HAVE_CYRUS_SASL */
 204
 205 /*
 206  * nextid.c
 207  */
 208
 209 ID next_id LDAP_P(( Backend *be ));
 210 ID next_id_get LDAP_P(( Backend *be ));
 211 ID next_id_write LDAP_P(( Backend *be, ID id ));
 212
 213 LDAP_END_DECL
 214 #endif