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