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 MDB_cmp_func mdb_id2v_compare;
 172 MDB_cmp_func mdb_id2v_dupsort;
 173
 174 int mdb_id2entry_add(
 175         Operation *op,
 176         MDB_txn *tid,
 177         MDB_cursor *mc,
 178         Entry *e );
 179
 180 int mdb_id2entry_update(
 181         Operation *op,
 182         MDB_txn *tid,
 183         MDB_cursor *mc,
 184         Entry *e );
 185
 186 int mdb_id2entry_delete(
 187         BackendDB *be,
 188         MDB_txn *tid,
 189         Entry *e);
 190
 191 int mdb_id2entry(
 192         Operation *op,
 193         MDB_cursor *mc,
 194         ID id,
 195         Entry **e);
 196
 197 int mdb_id2edata(
 198         Operation *op,
 199         MDB_cursor *mc,
 200         ID id,
 201         MDB_val *data);
 202
 203 int mdb_entry_return( Operation *op, Entry *e );
 204 BI_entry_release_rw mdb_entry_release;
 205 BI_entry_get_rw mdb_entry_get;
 206 BI_op_txn mdb_txn;
 207
 208 int mdb_entry_decode( Operation *op, MDB_txn *txn, MDB_val *data, ID id, Entry **e );
 209
 210 void mdb_reader_flush( MDB_env *env );
 211 int mdb_opinfo_get( Operation *op, struct mdb_info *mdb, int rdonly, mdb_op_info **moi );
 212
 213 int mdb_mval_put(Operation *op, MDB_cursor *mc, ID id, Attribute *a);
 214 int mdb_mval_del(Operation *op, MDB_cursor *mc, ID id, Attribute *a);
 215
 216 /*
 217  * idl.c
 218  */
 219
 220 unsigned mdb_idl_search( ID *ids, ID id );
 221
 222 int mdb_idl_fetch_key(
 223         BackendDB       *be,
 224         MDB_txn         *txn,
 225         MDB_dbi         dbi,
 226         MDB_val         *key,
 227         ID                      *ids,
 228         MDB_cursor      **saved_cursor,
 229         int                     get_flag );
 230
 231 int mdb_idl_insert( ID *ids, ID id );
 232
 233 typedef int (mdb_idl_keyfunc)(
 234         BackendDB *be,
 235         MDB_cursor *mc,
 236         struct berval *key,
 237         ID id );
 238
 239 mdb_idl_keyfunc mdb_idl_insert_keys;
 240 mdb_idl_keyfunc mdb_idl_delete_keys;
 241
 242 int
 243 mdb_idl_intersection(
 244         ID *a,
 245         ID *b );
 246
 247 int
 248 mdb_idl_union(
 249         ID *a,
 250         ID *b );
 251
 252 ID mdb_idl_first( ID *ids, ID *cursor );
 253 ID mdb_idl_next( ID *ids, ID *cursor );
 254
 255 void mdb_idl_sort( ID *ids, ID *tmp );
 256 int mdb_idl_append( ID *a, ID *b );
 257 int mdb_idl_append_one( ID *ids, ID id );
 258
 259
 260 /*
 261  * index.c
 262  */
 263
 264 extern AttrInfo *
 265 mdb_index_mask LDAP_P((
 266         Backend *be,
 267         AttributeDescription *desc,
 268         struct berval *name ));
 269
 270 extern int
 271 mdb_index_param LDAP_P((
 272         Backend *be,
 273         AttributeDescription *desc,
 274         int ftype,
 275         MDB_dbi *dbi,
 276         slap_mask_t *mask,
 277         struct berval *prefix ));
 278
 279 extern int
 280 mdb_index_values LDAP_P((
 281         Operation *op,
 282         MDB_txn *txn,
 283         AttributeDescription *desc,
 284         BerVarray vals,
 285         ID id,
 286         int opid ));
 287
 288 extern int
 289 mdb_index_recset LDAP_P((
 290         struct mdb_info *mdb,
 291         Attribute *a,
 292         AttributeType *type,
 293         struct berval *tags,
 294         IndexRec *ir ));
 295
 296 extern int
 297 mdb_index_recrun LDAP_P((
 298         Operation *op,
 299         MDB_txn *txn,
 300         struct mdb_info *mdb,
 301         IndexRec *ir,
 302         ID id,
 303         int base ));
 304
 305 int mdb_index_entry LDAP_P(( Operation *op, MDB_txn *t, int r, Entry *e ));
 306
 307 #define mdb_index_entry_add(op,t,e) \
 308         mdb_index_entry((op),(t),SLAP_INDEX_ADD_OP,(e))
 309 #define mdb_index_entry_del(op,t,e) \
 310         mdb_index_entry((op),(t),SLAP_INDEX_DELETE_OP,(e))
 311
 312 /*
 313  * key.c
 314  */
 315
 316 extern int
 317 mdb_key_read(
 318     Backend     *be,
 319         MDB_txn *txn,
 320         MDB_dbi dbi,
 321     struct berval *k,
 322         ID *ids,
 323     MDB_cursor **saved_cursor,
 324         int get_flags );
 325
 326 /*
 327  * nextid.c
 328  */
 329
 330 int mdb_next_id( BackendDB *be, MDB_cursor *mc, ID *id );
 331
 332 /*
 333  * modify.c
 334  */
 335
 336 int mdb_modify_internal(
 337         Operation *op,
 338         MDB_txn *tid,
 339         Modifications *modlist,
 340         Entry *e,
 341         const char **text,
 342         char *textbuf,
 343         size_t textlen );
 344
 345 /*
 346  * monitor.c
 347  */
 348
 349 int mdb_monitor_db_init( BackendDB *be );
 350 int mdb_monitor_db_open( BackendDB *be );
 351 int mdb_monitor_db_close( BackendDB *be );
 352 int mdb_monitor_db_destroy( BackendDB *be );
 353
 354 #ifdef MDB_MONITOR_IDX
 355 int
 356 mdb_monitor_idx_add(
 357         struct mdb_info         *mdb,
 358         AttributeDescription    *desc,
 359         slap_mask_t             type );
 360 #endif /* MDB_MONITOR_IDX */
 361
 362 /*
 363  * former external.h
 364  */
 365
 366 extern BI_init                          mdb_back_initialize;
 367
 368 extern BI_db_config                     mdb_db_config;
 369
 370 extern BI_op_add                        mdb_add;
 371 extern BI_op_bind                       mdb_bind;
 372 extern BI_op_compare                    mdb_compare;
 373 extern BI_op_delete                     mdb_delete;
 374 extern BI_op_modify                     mdb_modify;
 375 extern BI_op_modrdn                     mdb_modrdn;
 376 extern BI_op_search                     mdb_search;
 377 extern BI_op_extended                   mdb_extended;
 378
 379 extern BI_chk_referrals                 mdb_referrals;
 380
 381 extern BI_operational                   mdb_operational;
 382
 383 extern BI_has_subordinates              mdb_hasSubordinates;
 384
 385 /* tools.c */
 386 extern BI_tool_entry_open               mdb_tool_entry_open;
 387 extern BI_tool_entry_close              mdb_tool_entry_close;
 388 extern BI_tool_entry_first_x            mdb_tool_entry_first_x;
 389 extern BI_tool_entry_next               mdb_tool_entry_next;
 390 extern BI_tool_entry_get                mdb_tool_entry_get;
 391 extern BI_tool_entry_put                mdb_tool_entry_put;
 392 extern BI_tool_entry_reindex            mdb_tool_entry_reindex;
 393 extern BI_tool_dn2id_get                mdb_tool_dn2id_get;
 394 extern BI_tool_entry_modify             mdb_tool_entry_modify;
 395 extern BI_tool_entry_delete             mdb_tool_entry_delete;
 396
 397 extern mdb_idl_keyfunc mdb_tool_idl_add;
 398
 399 LDAP_END_DECL
 400
 401 #endif /* _PROTO_MDB_H */