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

   1 /* $OpenLDAP$ */
   2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   3  *
   4  * Copyright 2000-2005 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_BDB_H
  17 #define _PROTO_BDB_H
  18
  19 LDAP_BEGIN_DECL
  20
  21 #ifdef BDB_HIER
  22 #define BDB_SYMBOL(x)   LDAP_CONCAT(hdb_,x)
  23 #define BDB_UCTYPE      "HDB"
  24 #else
  25 #define BDB_SYMBOL(x)   LDAP_CONCAT(bdb_,x)
  26 #define BDB_UCTYPE      "BDB"
  27 #endif
  28
  29 /*
  30  * attr.c
  31  */
  32
  33 #define bdb_attr_mask                           BDB_SYMBOL(attr_mask)
  34 #define bdb_attr_index_config           BDB_SYMBOL(attr_index_config)
  35 #define bdb_attr_index_destroy          BDB_SYMBOL(attr_index_destroy)
  36 #define bdb_attr_index_unparse          BDB_SYMBOL(attr_index_unparse)
  37
  38 #ifdef LDAP_COMP_MATCH
  39 #define bdb_attr_comp_ref                       BDB_SYMBOL(attr_comp_ref)
  40 #define bdb_attr_mask_cr                        BDB_SYMBOL(attr_mask_cr)
  41 void bdb_attr_comp_ref( struct bdb_info *bdb,
  42         AttributeDescription *desc,
  43         ComponentReference **cr );
  44 void bdb_attr_mask_cr( struct bdb_info *bdb,
  45         AttributeDescription *desc,
  46         slap_mask_t *indexmask,
  47         ComponentReference **cr );
  48 #endif
  49
  50 void bdb_attr_mask( struct bdb_info *bdb,
  51         AttributeDescription *desc,
  52         slap_mask_t *indexmask );
  53
  54 int bdb_attr_index_config LDAP_P(( struct bdb_info *bdb,
  55         const char *fname, int lineno,
  56         int argc, char **argv ));
  57
  58 void bdb_attr_index_unparse LDAP_P(( struct bdb_info *bdb, BerVarray *bva ));
  59 void bdb_attr_index_destroy LDAP_P(( Avlnode *tree ));
  60
  61 /*
  62  * config.c
  63  */
  64
  65 #define bdb_back_init_cf                                BDB_SYMBOL(back_init_cf)
  66
  67 int bdb_back_init_cf( BackendInfo *bi );
  68
  69 /*
  70  * dbcache.c
  71  */
  72 #define bdb_db_cache                            BDB_SYMBOL(db_cache)
  73
  74 int
  75 bdb_db_cache(
  76     Backend     *be,
  77     const char *name,
  78         DB **db );
  79
  80 /*
  81  * dn2entry.c
  82  */
  83 #define bdb_dn2entry                            BDB_SYMBOL(dn2entry)
  84
  85 int bdb_dn2entry LDAP_P(( Operation *op, DB_TXN *tid,
  86         struct berval *dn, EntryInfo **e, int matched,
  87         u_int32_t locker, DB_LOCK *lock ));
  88
  89 /*
  90  * dn2id.c
  91  */
  92 #define bdb_dn2id                                       BDB_SYMBOL(dn2id)
  93 #define bdb_dn2id_add                           BDB_SYMBOL(dn2id_add)
  94 #define bdb_dn2id_delete                        BDB_SYMBOL(dn2id_delete)
  95 #define bdb_dn2id_children                      BDB_SYMBOL(dn2id_children)
  96 #define bdb_dn2idl                                      BDB_SYMBOL(dn2idl)
  97
  98 int bdb_dn2id(
  99         Operation *op,
 100         DB_TXN *tid,
 101         struct berval *dn,
 102         EntryInfo *ei );
 103
 104 int bdb_dn2id_add(
 105         Operation *op,
 106         DB_TXN *tid,
 107         EntryInfo *eip,
 108         Entry *e );
 109
 110 int bdb_dn2id_delete(
 111         Operation *op,
 112         DB_TXN *tid,
 113         EntryInfo *eip,
 114         Entry *e );
 115
 116 int bdb_dn2id_children(
 117         Operation *op,
 118         DB_TXN *tid,
 119         Entry *e );
 120
 121 int bdb_dn2idl(
 122         Operation *op,
 123         Entry *e,
 124         ID *ids,
 125         ID *stack );
 126
 127 #ifdef BDB_HIER
 128 #define bdb_dn2id_parent                        BDB_SYMBOL(dn2id_parent)
 129 #define bdb_fix_dn                                      BDB_SYMBOL(fix_dn)
 130
 131 int bdb_dn2id_parent(
 132         Operation *op,
 133         DB_TXN *txn,
 134         EntryInfo *ei,
 135         ID *idp );
 136
 137 int bdb_fix_dn( Entry *e, int checkit );
 138 #endif
 139
 140
 141 /*
 142  * error.c
 143  */
 144 #define bdb_errcall                                     BDB_SYMBOL(errcall)
 145
 146 #if DB_VERSION_FULL < 0x04030000
 147 void bdb_errcall( const char *pfx, char * msg );
 148 #else
 149 void bdb_errcall( const DB_ENV *env, const char *pfx, const char * msg );
 150 #endif
 151
 152 #ifdef HAVE_EBCDIC
 153 #define ebcdic_dberror                          BDB_SYMBOL(ebcdic_dberror)
 154
 155 char *ebcdic_dberror( int rc );
 156 #define db_strerror(x)  ebcdic_dberror(x)
 157 #endif
 158
 159 /*
 160  * filterentry.c
 161  */
 162 #define bdb_filter_candidates           BDB_SYMBOL(filter_candidates)
 163
 164 int bdb_filter_candidates(
 165         Operation *op,
 166         Filter  *f,
 167         ID *ids,
 168         ID *tmp,
 169         ID *stack );
 170
 171 /*
 172  * id2entry.c
 173  */
 174 #define bdb_id2entry                            BDB_SYMBOL(id2entry)
 175 #define bdb_id2entry_add                        BDB_SYMBOL(id2entry_add)
 176 #define bdb_id2entry_update                     BDB_SYMBOL(id2entry_update)
 177 #define bdb_id2entry_delete                     BDB_SYMBOL(id2entry_delete)
 178
 179 int bdb_id2entry_add(
 180         BackendDB *be,
 181         DB_TXN *tid,
 182         Entry *e );
 183
 184 int bdb_id2entry_update(
 185         BackendDB *be,
 186         DB_TXN *tid,
 187         Entry *e );
 188
 189 int bdb_id2entry_delete(
 190         BackendDB *be,
 191         DB_TXN *tid,
 192         Entry *e);
 193
 194 #ifdef SLAP_ZONE_ALLOC
 195 #else
 196 int bdb_id2entry(
 197         BackendDB *be,
 198         DB_TXN *tid,
 199         ID id,
 200         Entry **e);
 201 #endif
 202
 203 #define bdb_entry_free                          BDB_SYMBOL(entry_free)
 204 #define bdb_entry_return                        BDB_SYMBOL(entry_return)
 205 #define bdb_entry_release                       BDB_SYMBOL(entry_release)
 206 #define bdb_entry_get                           BDB_SYMBOL(entry_get)
 207
 208 void bdb_entry_free ( Entry *e );
 209 #ifdef SLAP_ZONE_ALLOC
 210 int bdb_entry_return( struct bdb_info *bdb, Entry *e, int seqno );
 211 #else
 212 int bdb_entry_return( Entry *e );
 213 #endif
 214 BI_entry_release_rw bdb_entry_release;
 215 BI_entry_get_rw bdb_entry_get;
 216
 217
 218 /*
 219  * idl.c
 220  */
 221
 222 #define bdb_idl_cache_get                       BDB_SYMBOL(idl_cache_get)
 223 #define bdb_idl_cache_put                       BDB_SYMBOL(idl_cache_put)
 224 #define bdb_idl_cache_del                       BDB_SYMBOL(idl_cache_del)
 225
 226 int bdb_idl_cache_get(
 227         struct bdb_info *bdb,
 228         DB *db,
 229         DBT *key,
 230         ID *ids );
 231
 232 void
 233 bdb_idl_cache_put(
 234         struct bdb_info *bdb,
 235         DB              *db,
 236         DBT             *key,
 237         ID              *ids,
 238         int             rc );
 239
 240 void
 241 bdb_idl_cache_del(
 242         struct bdb_info *bdb,
 243         DB              *db,
 244         DBT             *key );
 245
 246 #define bdb_idl_first                           BDB_SYMBOL(idl_first)
 247 #define bdb_idl_next                            BDB_SYMBOL(idl_next)
 248 #define bdb_idl_search                          BDB_SYMBOL(idl_search)
 249 #define bdb_idl_insert                          BDB_SYMBOL(idl_insert)
 250 #define bdb_idl_intersection            BDB_SYMBOL(idl_intersection)
 251 #define bdb_idl_union                           BDB_SYMBOL(idl_union)
 252
 253 #define bdb_idl_fetch_key                       BDB_SYMBOL(idl_fetch_key)
 254 #define bdb_idl_insert_key                      BDB_SYMBOL(idl_insert_key)
 255 #define bdb_idl_delete_key                      BDB_SYMBOL(idl_delete_key)
 256
 257 unsigned bdb_idl_search( ID *ids, ID id );
 258
 259 int bdb_idl_fetch_key(
 260         BackendDB       *be,
 261         DB                      *db,
 262         DB_TXN          *tid,
 263         DBT                     *key,
 264         ID                      *ids,
 265         DBC                     **saved_cursor,
 266         int                     get_flag );
 267
 268 int bdb_idl_insert( ID *ids, ID id );
 269
 270 int bdb_idl_insert_key(
 271         BackendDB *be,
 272         DB *db,
 273         DB_TXN *txn,
 274         DBT *key,
 275         ID id );
 276
 277 int bdb_idl_delete_key(
 278         BackendDB *be,
 279         DB *db,
 280         DB_TXN *txn,
 281         DBT *key,
 282         ID id );
 283
 284 int
 285 bdb_idl_intersection(
 286         ID *a,
 287         ID *b );
 288
 289 int
 290 bdb_idl_union(
 291         ID *a,
 292         ID *b );
 293
 294 ID bdb_idl_first( ID *ids, ID *cursor );
 295 ID bdb_idl_next( ID *ids, ID *cursor );
 296
 297
 298
 299 /*
 300  * index.c
 301  */
 302 #define bdb_index_is_indexed            BDB_SYMBOL(index_is_indexed)
 303 #define bdb_index_param                         BDB_SYMBOL(index_param)
 304 #define bdb_index_values                        BDB_SYMBOL(index_values)
 305 #define bdb_index_entry                         BDB_SYMBOL(index_entry)
 306
 307 extern int
 308 bdb_index_is_indexed LDAP_P((
 309         Backend *be,
 310         AttributeDescription *desc ));
 311
 312 extern int
 313 bdb_index_param LDAP_P((
 314         Backend *be,
 315         AttributeDescription *desc,
 316         int ftype,
 317         DB **db,
 318         slap_mask_t *mask,
 319         struct berval *prefix ));
 320
 321 extern int
 322 bdb_index_values LDAP_P((
 323         Operation *op,
 324         DB_TXN *txn,
 325         AttributeDescription *desc,
 326         BerVarray vals,
 327         ID id,
 328         int opid ));
 329
 330 int bdb_index_entry LDAP_P(( Operation *op, DB_TXN *t, int r, Entry *e ));
 331
 332 #define bdb_index_entry_add(op,t,e) \
 333         bdb_index_entry((op),(t),SLAP_INDEX_ADD_OP,(e))
 334 #define bdb_index_entry_del(op,t,e) \
 335         bdb_index_entry((op),(t),SLAP_INDEX_DELETE_OP,(e))
 336
 337 /*
 338  * key.c
 339  */
 340 #define bdb_key_read                            BDB_SYMBOL(key_read)
 341 #define bdb_key_change                          BDB_SYMBOL(key_change)
 342
 343 extern int
 344 bdb_key_read(
 345     Backend     *be,
 346         DB *db,
 347         DB_TXN *txn,
 348     struct berval *k,
 349         ID *ids,
 350     DBC **saved_cursor,
 351         int get_flags );
 352
 353 extern int
 354 bdb_key_change(
 355     Backend      *be,
 356     DB *db,
 357         DB_TXN *txn,
 358     struct berval *k,
 359     ID id,
 360     int op );
 361
 362 /*
 363  * nextid.c
 364  */
 365 #define bdb_next_id                                     BDB_SYMBOL(next_id)
 366 #define bdb_last_id                                     BDB_SYMBOL(last_id)
 367
 368 int bdb_next_id( BackendDB *be, DB_TXN *tid, ID *id );
 369 int bdb_last_id( BackendDB *be, DB_TXN *tid );
 370
 371 /*
 372  * modify.c
 373  */
 374 #define bdb_modify_internal                     BDB_SYMBOL(modify_internal)
 375
 376 int bdb_modify_internal(
 377         Operation *op,
 378         DB_TXN *tid,
 379         Modifications *modlist,
 380         Entry *e,
 381         const char **text,
 382         char *textbuf,
 383         size_t textlen );
 384
 385
 386 /*
 387  * cache.c
 388  */
 389 #define bdb_cache_entry_db_unlock       BDB_SYMBOL(cache_entry_db_unlock)
 390
 391 #define bdb_cache_entryinfo_lock(e) \
 392         ldap_pvt_thread_mutex_lock( &(e)->bei_kids_mutex )
 393 #define bdb_cache_entryinfo_unlock(e) \
 394         ldap_pvt_thread_mutex_unlock( &(e)->bei_kids_mutex )
 395
 396 /* What a mess. Hopefully the current cache scheme will stabilize
 397  * and we can trim out all of this stuff.
 398  */
 399 #if 0
 400 void bdb_cache_return_entry_rw( DB_ENV *env, Cache *cache, Entry *e,
 401         int rw, DB_LOCK *lock );
 402 #else
 403 #define bdb_cache_return_entry_rw( env, cache, e, rw, lock ) \
 404         bdb_cache_entry_db_unlock( env, lock )
 405 #define bdb_cache_return_entry( env, lock ) \
 406         bdb_cache_entry_db_unlock( env, lock )
 407 #endif
 408 #define bdb_cache_return_entry_r(env, c, e, l) \
 409         bdb_cache_return_entry_rw((env), (c), (e), 0, (l))
 410 #define bdb_cache_return_entry_w(env, c, e, l) \
 411         bdb_cache_return_entry_rw((env), (c), (e), 1, (l))
 412 #if 0
 413 void bdb_unlocked_cache_return_entry_rw( Cache *cache, Entry *e, int rw );
 414 #else
 415 #define bdb_unlocked_cache_return_entry_rw( a, b, c )
 416 #endif
 417 #define bdb_unlocked_cache_return_entry_r( c, e ) \
 418         bdb_unlocked_cache_return_entry_rw((c), (e), 0)
 419 #define bdb_unlocked_cache_return_entry_w( c, e ) \
 420         bdb_unlocked_cache_return_entry_rw((c), (e), 1)
 421
 422 #define bdb_cache_add                           BDB_SYMBOL(cache_add)
 423 #define bdb_cache_children                      BDB_SYMBOL(cache_children)
 424 #define bdb_cache_delete                        BDB_SYMBOL(cache_delete)
 425 #define bdb_cache_delete_cleanup        BDB_SYMBOL(cache_delete_cleanup)
 426 #define bdb_cache_find_id                       BDB_SYMBOL(cache_find_id)
 427 #define bdb_cache_find_info                     BDB_SYMBOL(cache_find_info)
 428 #define bdb_cache_find_ndn                      BDB_SYMBOL(cache_find_ndn)
 429 #define bdb_cache_modify                        BDB_SYMBOL(cache_modify)
 430 #define bdb_cache_modrdn                        BDB_SYMBOL(cache_modrdn)
 431 #define bdb_cache_release_all           BDB_SYMBOL(cache_release_all)
 432 #define bdb_cache_delete_entry          BDB_SYMBOL(cache_delete_entry)
 433
 434 int bdb_cache_children(
 435         Operation *op,
 436         DB_TXN *txn,
 437         Entry *e
 438 );
 439 int bdb_cache_add(
 440         struct bdb_info *bdb,
 441         EntryInfo *pei,
 442         Entry   *e,
 443         struct berval *nrdn,
 444         u_int32_t locker
 445 );
 446 int bdb_cache_modrdn(
 447         Entry   *e,
 448         struct berval *nrdn,
 449         Entry   *new,
 450         EntryInfo *ein,
 451         DB_ENV *env,
 452         u_int32_t locker,
 453         DB_LOCK *lock
 454 );
 455 int bdb_cache_modify(
 456         Entry *e,
 457         Attribute *newAttrs,
 458         DB_ENV *env,
 459         u_int32_t locker,
 460         DB_LOCK *lock
 461 );
 462 int bdb_cache_find_ndn(
 463         Operation *op,
 464         DB_TXN  *txn,
 465         struct berval   *ndn,
 466         EntryInfo       **res
 467 );
 468 EntryInfo * bdb_cache_find_info(
 469         struct bdb_info *bdb,
 470         ID id
 471 );
 472 int bdb_cache_find_id(
 473         Operation *op,
 474         DB_TXN  *tid,
 475         ID              id,
 476         EntryInfo **eip,
 477         int     islocked,
 478         u_int32_t       locker,
 479         DB_LOCK         *lock
 480 );
 481 int bdb_cache_delete(
 482         Cache   *cache,
 483         Entry   *e,
 484         DB_ENV  *env,
 485         u_int32_t locker,
 486         DB_LOCK *lock
 487 );
 488 void bdb_cache_delete_cleanup(
 489         Cache   *cache,
 490         EntryInfo *ei
 491 );
 492 void bdb_cache_release_all( Cache *cache );
 493 void bdb_cache_delete_entry(
 494         struct bdb_info *bdb,
 495         EntryInfo *ei,
 496         u_int32_t locker,
 497         DB_LOCK *lock
 498 );
 499
 500 #ifdef BDB_HIER
 501 int hdb_cache_load(
 502         struct bdb_info *bdb,
 503         EntryInfo *ei,
 504         EntryInfo **res
 505 );
 506 #endif
 507
 508 #define bdb_cache_entry_db_relock               BDB_SYMBOL(cache_entry_db_relock)
 509 int bdb_cache_entry_db_relock(
 510         DB_ENV *env,
 511         u_int32_t locker,
 512         EntryInfo *ei,
 513         int rw,
 514         int tryOnly,
 515         DB_LOCK *lock );
 516
 517 int bdb_cache_entry_db_unlock(
 518         DB_ENV *env,
 519         DB_LOCK *lock );
 520
 521 #ifdef BDB_REUSE_LOCKERS
 522
 523 #define bdb_locker_id                           BDB_SYMBOL(locker_id)
 524 int bdb_locker_id( Operation *op, DB_ENV *env, int *locker );
 525
 526 #define LOCK_ID_FREE(env, locker)
 527 #define LOCK_ID(env, locker)    bdb_locker_id(op, env, locker)
 528
 529 #else
 530
 531 #define LOCK_ID_FREE(env, locker)       XLOCK_ID_FREE(env, locker)
 532 #define LOCK_ID(env, locker)            XLOCK_ID(env, locker)
 533
 534 #endif
 535
 536 /*
 537  * trans.c
 538  */
 539 #define bdb_trans_backoff                       BDB_SYMBOL(trans_backoff)
 540
 541 void
 542 bdb_trans_backoff( int num_retries );
 543
 544 /*
 545  * former external.h
 546  */
 547
 548 #define bdb_back_initialize             BDB_SYMBOL(back_initialize)
 549 #define bdb_db_config                   BDB_SYMBOL(db_config)
 550 #define bdb_add                         BDB_SYMBOL(add)
 551 #define bdb_bind                        BDB_SYMBOL(bind)
 552 #define bdb_compare                     BDB_SYMBOL(compare)
 553 #define bdb_delete                      BDB_SYMBOL(delete)
 554 #define bdb_modify                      BDB_SYMBOL(modify)
 555 #define bdb_modrdn                      BDB_SYMBOL(modrdn)
 556 #define bdb_search                      BDB_SYMBOL(search)
 557 #define bdb_extended                    BDB_SYMBOL(extended)
 558 #define bdb_referrals                   BDB_SYMBOL(referrals)
 559 #define bdb_operational                 BDB_SYMBOL(operational)
 560 #define bdb_hasSubordinates             BDB_SYMBOL(hasSubordinates)
 561 #define bdb_tool_entry_open             BDB_SYMBOL(tool_entry_open)
 562 #define bdb_tool_entry_close            BDB_SYMBOL(tool_entry_close)
 563 #define bdb_tool_entry_next             BDB_SYMBOL(tool_entry_next)
 564 #define bdb_tool_entry_get              BDB_SYMBOL(tool_entry_get)
 565 #define bdb_tool_entry_put              BDB_SYMBOL(tool_entry_put)
 566 #define bdb_tool_entry_reindex          BDB_SYMBOL(tool_entry_reindex)
 567 #define bdb_tool_dn2id_get              BDB_SYMBOL(tool_dn2id_get)
 568 #define bdb_tool_id2entry_get           BDB_SYMBOL(tool_id2entry_get)
 569 #define bdb_tool_entry_modify           BDB_SYMBOL(tool_entry_modify)
 570
 571 extern BI_init                          bdb_back_initialize;
 572
 573 extern BI_db_config                     bdb_db_config;
 574
 575 extern BI_op_add                        bdb_add;
 576 extern BI_op_bind                       bdb_bind;
 577 extern BI_op_compare                    bdb_compare;
 578 extern BI_op_delete                     bdb_delete;
 579 extern BI_op_modify                     bdb_modify;
 580 extern BI_op_modrdn                     bdb_modrdn;
 581 extern BI_op_search                     bdb_search;
 582 extern BI_op_extended                   bdb_extended;
 583
 584 extern BI_chk_referrals                 bdb_referrals;
 585
 586 extern BI_operational                   bdb_operational;
 587
 588 extern BI_has_subordinates              bdb_hasSubordinates;
 589
 590 /* tools.c */
 591 extern BI_tool_entry_open               bdb_tool_entry_open;
 592 extern BI_tool_entry_close              bdb_tool_entry_close;
 593 extern BI_tool_entry_next               bdb_tool_entry_next;
 594 extern BI_tool_entry_get                bdb_tool_entry_get;
 595 extern BI_tool_entry_put                bdb_tool_entry_put;
 596 extern BI_tool_entry_reindex            bdb_tool_entry_reindex;
 597 extern BI_tool_dn2id_get                bdb_tool_dn2id_get;
 598 extern BI_tool_id2entry_get             bdb_tool_id2entry_get;
 599 extern BI_tool_entry_modify             bdb_tool_entry_modify;
 600
 601 LDAP_END_DECL
 602
 603 #endif /* _PROTO_BDB_H */