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