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