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