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

   1 /* $OpenLDAP$ */
   2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   3  *
   4  * Copyright 2000-2018 The OpenLDAP Foundation.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted only as authorized by the OpenLDAP
   9  * Public License.
  10  *
  11  * A copy of this license is available in the file LICENSE in the
  12  * top-level directory of the distribution or, alternatively, at
  13  * <http://www.OpenLDAP.org/license.html>.
  14  */
  15
  16 #ifndef _PROTO_MDB_H
  17 #define _PROTO_MDB_H
  18
  19 LDAP_BEGIN_DECL
  20
  21 #define MDB_UCTYPE      "MDB"
  22
  23 /*
  24  * attr.c
  25  */
  26
  27 AttrInfo *mdb_attr_mask( struct mdb_info *mdb,
  28         AttributeDescription *desc );
  29
  30 void mdb_attr_flush( struct mdb_info *mdb );
  31
  32 int mdb_attr_slot( struct mdb_info *mdb,
  33         AttributeDescription *desc, int *insert );
  34
  35 int mdb_attr_dbs_open( BackendDB *be, MDB_txn *txn, struct config_reply_s *cr );
  36 void mdb_attr_dbs_close( struct mdb_info *mdb );
  37
  38 int mdb_attr_index_config LDAP_P(( struct mdb_info *mdb,
  39         const char *fname, int lineno,
  40         int argc, char **argv, struct config_reply_s *cr ));
  41
  42 void mdb_attr_index_unparse LDAP_P(( struct mdb_info *mdb, BerVarray *bva ));
  43 void mdb_attr_index_destroy LDAP_P(( struct mdb_info *mdb ));
  44 void mdb_attr_index_free LDAP_P(( struct mdb_info *mdb,
  45         AttributeDescription *ad ));
  46
  47 void mdb_attr_info_free( AttrInfo *ai );
  48
  49 int mdb_ad_read( struct mdb_info *mdb, MDB_txn *txn );
  50 int mdb_ad_get( struct mdb_info *mdb, MDB_txn *txn, AttributeDescription *ad );
  51
  52 /*
  53  * config.c
  54  */
  55
  56 int mdb_back_init_cf( BackendInfo *bi );
  57
  58 /*
  59  * dn2entry.c
  60  */
  61
  62 int mdb_dn2entry LDAP_P(( Operation *op, MDB_txn *tid, MDB_cursor *mc,
  63         struct berval *dn, Entry **e, ID *nsubs, int matched ));
  64
  65 /*
  66  * dn2id.c
  67  */
  68
  69 int mdb_dn2id(
  70         Operation *op,
  71         MDB_txn *txn,
  72         MDB_cursor *mc,
  73         struct berval *ndn,
  74         ID *id,
  75         ID *nsubs,
  76         struct berval *matched,
  77         struct berval *nmatched );
  78
  79 int mdb_dn2id_add(
  80         Operation *op,
  81         MDB_cursor *mcp,
  82         MDB_cursor *mcd,
  83         ID pid,
  84         ID nsubs,
  85         int upsub,
  86         Entry *e );
  87
  88 int mdb_dn2id_delete(
  89         Operation *op,
  90         MDB_cursor *mc,
  91         ID id,
  92         ID nsubs );
  93
  94 int mdb_dn2id_children(
  95         Operation *op,
  96         MDB_txn *tid,
  97         Entry *e );
  98
  99 int mdb_dn2sups (
 100         Operation *op,
 101         MDB_txn *tid,
 102         struct berval *dn,
 103         ID *sups
 104         );
 105
 106 int mdb_dn2idl(
 107         Operation *op,
 108         MDB_txn *txn,
 109         struct berval *ndn,
 110         ID eid,
 111         ID *ids,
 112         ID *stack );
 113
 114 int mdb_dn2id_parent(
 115         Operation *op,
 116         MDB_txn *txn,
 117         ID eid,
 118         ID *idp );
 119
 120 int mdb_id2name(
 121         Operation *op,
 122         MDB_txn *txn,
 123         MDB_cursor **cursp,
 124         ID eid,
 125         struct berval *name,
 126         struct berval *nname);
 127
 128 int mdb_idscope(
 129         Operation *op,
 130         MDB_txn *txn,
 131         ID base,
 132         ID *ids,
 133         ID *res );
 134
 135 struct IdScopes;
 136
 137 int mdb_idscopes(
 138         Operation *op,
 139         struct IdScopes *isc );
 140
 141 int mdb_idscopechk(
 142         Operation *op,
 143         struct IdScopes *isc );
 144
 145 int mdb_dn2id_walk(
 146         Operation *op,
 147         struct IdScopes *isc );
 148
 149 void mdb_dn2id_wrestore(
 150         Operation *op,
 151         struct IdScopes *isc );
 152
 153 MDB_cmp_func mdb_dup_compare;
 154
 155 /*
 156  * filterentry.c
 157  */
 158
 159 int mdb_filter_candidates(
 160         Operation *op,
 161         MDB_txn *txn,
 162         Filter  *f,
 163         ID *ids,
 164         ID *tmp,
 165         ID *stack );
 166
 167 /*
 168  * id2entry.c
 169  */
 170
 171 int mdb_id2entry_add(
 172         Operation *op,
 173         MDB_txn *tid,
 174         MDB_cursor *mc,
 175         Entry *e );
 176
 177 int mdb_id2entry_update(
 178         Operation *op,
 179         MDB_txn *tid,
 180         MDB_cursor *mc,
 181         Entry *e );
 182
 183 int mdb_id2entry_delete(
 184         BackendDB *be,
 185         MDB_txn *tid,
 186         Entry *e);
 187
 188 int mdb_id2entry(
 189         Operation *op,
 190         MDB_cursor *mc,
 191         ID id,
 192         Entry **e);
 193
 194 int mdb_id2edata(
 195         Operation *op,
 196         MDB_cursor *mc,
 197         ID id,
 198         MDB_val *data);
 199
 200 int mdb_entry_return( Operation *op, Entry *e );
 201 BI_entry_release_rw mdb_entry_release;
 202 BI_entry_get_rw mdb_entry_get;
 203
 204 int mdb_entry_decode( Operation *op, MDB_txn *txn, MDB_val *data, Entry **e );
 205
 206 void mdb_reader_flush( MDB_env *env );
 207 int mdb_opinfo_get( Operation *op, struct mdb_info *mdb, int rdonly, mdb_op_info **moi );
 208
 209 /*
 210  * idl.c
 211  */
 212
 213 unsigned mdb_idl_search( ID *ids, ID id );
 214
 215 int mdb_idl_fetch_key(
 216         BackendDB       *be,
 217         MDB_txn         *txn,
 218         MDB_dbi         dbi,
 219         MDB_val         *key,
 220         ID                      *ids,
 221         MDB_cursor      **saved_cursor,
 222         int                     get_flag );
 223
 224 int mdb_idl_insert( ID *ids, ID id );
 225
 226 typedef int (mdb_idl_keyfunc)(
 227         BackendDB *be,
 228         MDB_cursor *mc,
 229         struct berval *key,
 230         ID id );
 231
 232 mdb_idl_keyfunc mdb_idl_insert_keys;
 233 mdb_idl_keyfunc mdb_idl_delete_keys;
 234
 235 int
 236 mdb_idl_intersection(
 237         ID *a,
 238         ID *b );
 239
 240 int
 241 mdb_idl_union(
 242         ID *a,
 243         ID *b );
 244
 245 ID mdb_idl_first( ID *ids, ID *cursor );
 246 ID mdb_idl_next( ID *ids, ID *cursor );
 247
 248 void mdb_idl_sort( ID *ids, ID *tmp );
 249 int mdb_idl_append( ID *a, ID *b );
 250 int mdb_idl_append_one( ID *ids, ID id );
 251
 252
 253 /*
 254  * index.c
 255  */
 256
 257 extern AttrInfo *
 258 mdb_index_mask LDAP_P((
 259         Backend *be,
 260         AttributeDescription *desc,
 261         struct berval *name ));
 262
 263 extern int
 264 mdb_index_param LDAP_P((
 265         Backend *be,
 266         AttributeDescription *desc,
 267         int ftype,
 268         MDB_dbi *dbi,
 269         slap_mask_t *mask,
 270         struct berval *prefix ));
 271
 272 extern int
 273 mdb_index_values LDAP_P((
 274         Operation *op,
 275         MDB_txn *txn,
 276         AttributeDescription *desc,
 277         BerVarray vals,
 278         ID id,
 279         int opid ));
 280
 281 extern int
 282 mdb_index_recset LDAP_P((
 283         struct mdb_info *mdb,
 284         Attribute *a,
 285         AttributeType *type,
 286         struct berval *tags,
 287         IndexRec *ir ));
 288
 289 extern int
 290 mdb_index_recrun LDAP_P((
 291         Operation *op,
 292         MDB_txn *txn,
 293         struct mdb_info *mdb,
 294         IndexRec *ir,
 295         ID id,
 296         int base ));
 297
 298 int mdb_index_entry LDAP_P(( Operation *op, MDB_txn *t, int r, Entry *e ));
 299
 300 #define mdb_index_entry_add(op,t,e) \
 301         mdb_index_entry((op),(t),SLAP_INDEX_ADD_OP,(e))
 302 #define mdb_index_entry_del(op,t,e) \
 303         mdb_index_entry((op),(t),SLAP_INDEX_DELETE_OP,(e))
 304
 305 /*
 306  * key.c
 307  */
 308
 309 extern int
 310 mdb_key_read(
 311     Backend     *be,
 312         MDB_txn *txn,
 313         MDB_dbi dbi,
 314     struct berval *k,
 315         ID *ids,
 316     MDB_cursor **saved_cursor,
 317         int get_flags );
 318
 319 /*
 320  * nextid.c
 321  */
 322
 323 int mdb_next_id( BackendDB *be, MDB_cursor *mc, ID *id );
 324
 325 /*
 326  * modify.c
 327  */
 328
 329 int mdb_modify_internal(
 330         Operation *op,
 331         MDB_txn *tid,
 332         Modifications *modlist,
 333         Entry *e,
 334         const char **text,
 335         char *textbuf,
 336         size_t textlen );
 337
 338 /*
 339  * monitor.c
 340  */
 341
 342 int mdb_monitor_db_init( BackendDB *be );
 343 int mdb_monitor_db_open( BackendDB *be );
 344 int mdb_monitor_db_close( BackendDB *be );
 345 int mdb_monitor_db_destroy( BackendDB *be );
 346
 347 #ifdef MDB_MONITOR_IDX
 348 int
 349 mdb_monitor_idx_add(
 350         struct mdb_info         *mdb,
 351         AttributeDescription    *desc,
 352         slap_mask_t             type );
 353 #endif /* MDB_MONITOR_IDX */
 354
 355 /*
 356  * former external.h
 357  */
 358
 359 extern BI_init                          mdb_back_initialize;
 360
 361 extern BI_db_config                     mdb_db_config;
 362
 363 extern BI_op_add                        mdb_add;
 364 extern BI_op_bind                       mdb_bind;
 365 extern BI_op_compare                    mdb_compare;
 366 extern BI_op_delete                     mdb_delete;
 367 extern BI_op_modify                     mdb_modify;
 368 extern BI_op_modrdn                     mdb_modrdn;
 369 extern BI_op_search                     mdb_search;
 370 extern BI_op_extended                   mdb_extended;
 371
 372 extern BI_chk_referrals                 mdb_referrals;
 373
 374 extern BI_operational                   mdb_operational;
 375
 376 extern BI_has_subordinates              mdb_hasSubordinates;
 377
 378 /* tools.c */
 379 extern BI_tool_entry_open               mdb_tool_entry_open;
 380 extern BI_tool_entry_close              mdb_tool_entry_close;
 381 extern BI_tool_entry_first_x            mdb_tool_entry_first_x;
 382 extern BI_tool_entry_next               mdb_tool_entry_next;
 383 extern BI_tool_entry_get                mdb_tool_entry_get;
 384 extern BI_tool_entry_put                mdb_tool_entry_put;
 385 extern BI_tool_entry_reindex            mdb_tool_entry_reindex;
 386 extern BI_tool_dn2id_get                mdb_tool_dn2id_get;
 387 extern BI_tool_entry_modify             mdb_tool_entry_modify;
 388
 389 extern mdb_idl_keyfunc mdb_tool_idl_add;
 390
 391 LDAP_END_DECL
 392
 393 #endif /* _PROTO_MDB_H */