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