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-2004 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 #else
  24 #define BDB_SYMBOL(x)   LDAP_CONCAT(bdb_,x)
  25 #endif
  26
  27 /*
  28  * attr.c
  29  */
  30
  31 #define bdb_attr_mask                           BDB_SYMBOL(attr_mask)
  32 #define bdb_attr_index_config           BDB_SYMBOL(attr_index_config)
  33 #define bdb_attr_index_destroy          BDB_SYMBOL(attr_index_destroy)
  34
  35 void bdb_attr_mask( struct bdb_info *bdb,
  36         AttributeDescription *desc,
  37         slap_mask_t *indexmask );
  38
  39 int bdb_attr_index_config LDAP_P(( struct bdb_info *bdb,
  40         const char *fname, int lineno,
  41         int argc, char **argv ));
  42
  43 void bdb_attr_index_destroy LDAP_P(( Avlnode *tree ));
  44
  45 /*
  46  * ctxcsn.c
  47  */
  48 #define bdb_csn_commit                          BDB_SYMBOL(csn_commit)
  49 #define bdb_get_commit_csn                      BDB_SYMBOL(get_commit_csn)
  50
  51 int bdb_csn_commit LDAP_P(( Operation *op, SlapReply *rs, DB_TXN *tid,
  52                                                 EntryInfo *ei, EntryInfo **suffix_ei, Entry **ctxcsn_e,
  53                                                 int *ctxcsn_added, u_int32_t locker ));
  54
  55 int bdb_get_commit_csn LDAP_P(( Operation *op, SlapReply *rs,
  56                                                 struct berval **search_context_csn,
  57                                                 u_int32_t locker, DB_LOCK *ctxcsn_lock ));
  58
  59 /*
  60  * dbcache.c
  61  */
  62 #define bdb_db_cache                            BDB_SYMBOL(db_cache)
  63
  64 int
  65 bdb_db_cache(
  66     Backend     *be,
  67     const char *name,
  68         DB **db );
  69
  70 /*
  71  * dn2entry.c
  72  */
  73 #define bdb_dn2entry                            BDB_SYMBOL(dn2entry)
  74
  75 int bdb_dn2entry LDAP_P(( Operation *op, DB_TXN *tid,
  76         struct berval *dn, EntryInfo **e, int matched,
  77         u_int32_t locker, DB_LOCK *lock ));
  78
  79 /*
  80  * dn2id.c
  81  */
  82 #define bdb_dn2id                                       BDB_SYMBOL(dn2id)
  83 #define bdb_dn2id_add                           BDB_SYMBOL(dn2id_add)
  84 #define bdb_dn2id_delete                        BDB_SYMBOL(dn2id_delete)
  85 #define bdb_dn2id_children                      BDB_SYMBOL(dn2id_children)
  86 #define bdb_dn2idl                                      BDB_SYMBOL(dn2idl)
  87
  88 int bdb_dn2id(
  89         Operation *op,
  90         DB_TXN *tid,
  91         struct berval *dn,
  92         EntryInfo *ei );
  93
  94 int bdb_dn2id_add(
  95         Operation *op,
  96         DB_TXN *tid,
  97         EntryInfo *eip,
  98         Entry *e );
  99
 100 int bdb_dn2id_delete(
 101         Operation *op,
 102         DB_TXN *tid,
 103         EntryInfo *eip,
 104         Entry *e );
 105
 106 int bdb_dn2id_children(
 107         Operation *op,
 108         DB_TXN *tid,
 109         Entry *e );
 110
 111 int bdb_dn2idl(
 112         Operation *op,
 113         Entry *e,
 114         ID *ids,
 115         ID *stack );
 116
 117 #ifdef BDB_HIER
 118 #define bdb_dn2id_parent                        BDB_SYMBOL(dn2id_parent)
 119 #define bdb_dup_compare                         BDB_SYMBOL(dup_compare)
 120 #define bdb_fix_dn                                      BDB_SYMBOL(fix_dn)
 121
 122 int bdb_dn2id_parent(
 123         Operation *op,
 124         DB_TXN *txn,
 125         EntryInfo *ei,
 126         ID *idp );
 127
 128 int bdb_dup_compare(
 129         DB *db,
 130         const DBT *usrkey,
 131         const DBT *curkey );
 132
 133 int bdb_fix_dn( Entry *e, int checkit );
 134 #endif
 135
 136
 137 /*
 138  * error.c
 139  */
 140 #define bdb_errcall                                     BDB_SYMBOL(errcall)
 141
 142 void bdb_errcall( const char *pfx, char * msg );
 143
 144 #ifdef HAVE_EBCDIC
 145 #define ebcdic_dberror                          BDB_SYMBOL(ebcdic_dberror)
 146
 147 char *ebcdic_dberror( int rc );
 148 #define db_strerror(x)  ebcdic_dberror(x)
 149 #endif
 150
 151 /*
 152  * filterentry.c
 153  */
 154 #define bdb_filter_candidates           BDB_SYMBOL(filter_candidates)
 155
 156 int bdb_filter_candidates(
 157         Operation *op,
 158         Filter  *f,
 159         ID *ids,
 160         ID *tmp,
 161         ID *stack );
 162
 163 /*
 164  * id2entry.c
 165  */
 166 #define bdb_id2entry                            BDB_SYMBOL(id2entry)
 167 #define bdb_id2entry_add                        BDB_SYMBOL(id2entry_add)
 168 #define bdb_id2entry_update                     BDB_SYMBOL(id2entry_update)
 169 #define bdb_id2entry_delete                     BDB_SYMBOL(id2entry_delete)
 170
 171 int bdb_id2entry_add(
 172         BackendDB *be,
 173         DB_TXN *tid,
 174         Entry *e );
 175
 176 int bdb_id2entry_update(
 177         BackendDB *be,
 178         DB_TXN *tid,
 179         Entry *e );
 180
 181 int bdb_id2entry_delete(
 182         BackendDB *be,
 183         DB_TXN *tid,
 184         Entry *e);
 185
 186 int bdb_id2entry(
 187         BackendDB *be,
 188         DB_TXN *tid,
 189         ID id,
 190         Entry **e);
 191
 192 #define bdb_entry_free                          BDB_SYMBOL(entry_free)
 193 #define bdb_entry_return                        BDB_SYMBOL(entry_return)
 194 #define bdb_entry_release                       BDB_SYMBOL(entry_release)
 195 #define bdb_entry_get                           BDB_SYMBOL(entry_get)
 196
 197 void bdb_entry_free ( Entry *e );
 198 int bdb_entry_return( Entry *e );
 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 #define bdb_bt_compare                          BDB_SYMBOL(bt_compare)
 284
 285 int bdb_bt_compare(
 286         DB *db,
 287         const DBT *a,
 288         const DBT *b );
 289
 290
 291 /*
 292  * index.c
 293  */
 294 #define bdb_index_is_indexed            BDB_SYMBOL(index_is_indexed)
 295 #define bdb_index_param                         BDB_SYMBOL(index_param)
 296 #define bdb_index_values                        BDB_SYMBOL(index_values)
 297 #define bdb_index_entry                         BDB_SYMBOL(index_entry)
 298
 299 extern int
 300 bdb_index_is_indexed LDAP_P((
 301         Backend *be,
 302         AttributeDescription *desc ));
 303
 304 extern int
 305 bdb_index_param LDAP_P((
 306         Backend *be,
 307         AttributeDescription *desc,
 308         int ftype,
 309         DB **db,
 310         slap_mask_t *mask,
 311         struct berval *prefix ));
 312
 313 extern int
 314 bdb_index_values LDAP_P((
 315         Operation *op,
 316         DB_TXN *txn,
 317         AttributeDescription *desc,
 318         BerVarray vals,
 319         ID id,
 320         int opid ));
 321
 322 int bdb_index_entry LDAP_P(( Operation *op, DB_TXN *t, int r, Entry *e ));
 323
 324 #define bdb_index_entry_add(op,t,e) \
 325         bdb_index_entry((op),(t),SLAP_INDEX_ADD_OP,(e))
 326 #define bdb_index_entry_del(op,t,e) \
 327         bdb_index_entry((op),(t),SLAP_INDEX_DELETE_OP,(e))
 328
 329 /*
 330  * init.c
 331  */
 332 #define bdb_uuid                                        BDB_SYMBOL(uuid)
 333
 334 extern struct berval bdb_uuid;
 335
 336 /*
 337  * key.c
 338  */
 339 #define bdb_key_read                            BDB_SYMBOL(key_read)
 340 #define bdb_key_change                          BDB_SYMBOL(key_change)
 341
 342 extern int
 343 bdb_key_read(
 344     Backend     *be,
 345         DB *db,
 346         DB_TXN *txn,
 347     struct berval *k,
 348         ID *ids,
 349     DBC **saved_cursor,
 350         int get_flags );
 351
 352 extern int
 353 bdb_key_change(
 354     Backend      *be,
 355     DB *db,
 356         DB_TXN *txn,
 357     struct berval *k,
 358     ID id,
 359     int op );
 360
 361 /*
 362  * nextid.c
 363  */
 364 #define bdb_next_id                                     BDB_SYMBOL(next_id)
 365 #define bdb_last_id                                     BDB_SYMBOL(last_id)
 366
 367 int bdb_next_id( BackendDB *be, DB_TXN *tid, ID *id );
 368 int bdb_last_id( BackendDB *be, DB_TXN *tid );
 369
 370 /*
 371  * modify.c
 372  */
 373 #define bdb_modify_internal                     BDB_SYMBOL(modify_internal)
 374
 375 int bdb_modify_internal(
 376         Operation *op,
 377         DB_TXN *tid,
 378         Modifications *modlist,
 379         Entry *e,
 380         const char **text,
 381         char *textbuf,
 382         size_t textlen );
 383
 384
 385 /*
 386  * cache.c
 387  */
 388 #define bdb_cache_entry_db_unlock       BDB_SYMBOL(cache_entry_db_unlock)
 389
 390 #define bdb_cache_entryinfo_lock(e) \
 391         ldap_pvt_thread_mutex_lock( &(e)->bei_kids_mutex )
 392 #define bdb_cache_entryinfo_unlock(e) \
 393         ldap_pvt_thread_mutex_unlock( &(e)->bei_kids_mutex )
 394
 395 /* What a mess. Hopefully the current cache scheme will stabilize
 396  * and we can trim out all of this stuff.
 397  */
 398 #if 0
 399 void bdb_cache_return_entry_rw( DB_ENV *env, Cache *cache, Entry *e,
 400         int rw, DB_LOCK *lock );
 401 #else
 402 #define bdb_cache_return_entry_rw( env, cache, e, rw, lock ) \
 403         bdb_cache_entry_db_unlock( env, lock )
 404 #define bdb_cache_return_entry( env, lock ) \
 405         bdb_cache_entry_db_unlock( env, lock )
 406 #endif
 407 #define bdb_cache_return_entry_r(env, c, e, l) \
 408         bdb_cache_return_entry_rw((env), (c), (e), 0, (l))
 409 #define bdb_cache_return_entry_w(env, c, e, l) \
 410         bdb_cache_return_entry_rw((env), (c), (e), 1, (l))
 411 #if 0
 412 void bdb_unlocked_cache_return_entry_rw( Cache *cache, Entry *e, int rw );
 413 #else
 414 #define bdb_unlocked_cache_return_entry_rw( a, b, c )
 415 #endif
 416 #define bdb_unlocked_cache_return_entry_r( c, e ) \
 417         bdb_unlocked_cache_return_entry_rw((c), (e), 0)
 418 #define bdb_unlocked_cache_return_entry_w( c, e ) \
 419         bdb_unlocked_cache_return_entry_rw((c), (e), 1)
 420
 421 #define bdb_cache_add                           BDB_SYMBOL(cache_add)
 422 #define bdb_cache_children                      BDB_SYMBOL(cache_children)
 423 #define bdb_cache_delete                        BDB_SYMBOL(cache_delete)
 424 #define bdb_cache_delete_cleanup                BDB_SYMBOL(cache_delete_cleanup)
 425 #define bdb_cache_find_id                       BDB_SYMBOL(cache_find_id)
 426 #define bdb_cache_find_info                     BDB_SYMBOL(cache_find_info)
 427 #define bdb_cache_find_ndn                      BDB_SYMBOL(cache_find_ndn)
 428 #define bdb_cache_modify                        BDB_SYMBOL(cache_modify)
 429 #define bdb_cache_modrdn                        BDB_SYMBOL(cache_modrdn)
 430 #define bdb_cache_release_all           BDB_SYMBOL(cache_release_all)
 431 #define bdb_cache_delete_entry          BDB_SYMBOL(cache_delete_entry)
 432
 433 int bdb_cache_children(
 434         Operation *op,
 435         DB_TXN *txn,
 436         Entry *e
 437 );
 438 int bdb_cache_add(
 439         struct bdb_info *bdb,
 440         EntryInfo *pei,
 441         Entry   *e,
 442         struct berval *nrdn,
 443         u_int32_t locker
 444 );
 445 int bdb_cache_modrdn(
 446         Entry   *e,
 447         struct berval *nrdn,
 448         Entry   *new,
 449         EntryInfo *ein,
 450         DB_ENV *env,
 451         u_int32_t locker,
 452         DB_LOCK *lock
 453 );
 454 int bdb_cache_modify(
 455         Entry *e,
 456         Attribute *newAttrs,
 457         DB_ENV *env,
 458         u_int32_t locker,
 459         DB_LOCK *lock
 460 );
 461 int bdb_cache_find_ndn(
 462         Operation *op,
 463         DB_TXN  *txn,
 464         struct berval   *ndn,
 465         EntryInfo       **res
 466 );
 467 EntryInfo * bdb_cache_find_info(
 468         struct bdb_info *bdb,
 469         ID id
 470 );
 471 int bdb_cache_find_id(
 472         Operation *op,
 473         DB_TXN  *tid,
 474         ID              id,
 475         EntryInfo **eip,
 476         int     islocked,
 477         u_int32_t       locker,
 478         DB_LOCK         *lock
 479 );
 480 int bdb_cache_delete(
 481         Cache   *cache,
 482         Entry   *e,
 483         DB_ENV  *env,
 484         u_int32_t locker,
 485         DB_LOCK *lock
 486 );
 487 void bdb_cache_delete_cleanup(
 488         Cache   *cache,
 489         Entry   *e
 490 );
 491 void bdb_cache_release_all( Cache *cache );
 492 void bdb_cache_delete_entry(
 493         struct bdb_info *bdb,
 494         EntryInfo *ei,
 495         u_int32_t locker,
 496         DB_LOCK *lock
 497 );
 498
 499 #ifdef BDB_HIER
 500 int hdb_cache_load(
 501         struct bdb_info *bdb,
 502         EntryInfo *ei,
 503         EntryInfo **res
 504 );
 505 #endif
 506
 507 #define bdb_cache_entry_db_relock               BDB_SYMBOL(cache_entry_db_relock)
 508 int bdb_cache_entry_db_relock(
 509         DB_ENV *env,
 510         u_int32_t locker,
 511         EntryInfo *ei,
 512         int rw,
 513         int tryOnly,
 514         DB_LOCK *lock );
 515
 516 int bdb_cache_entry_db_unlock(
 517         DB_ENV *env,
 518         DB_LOCK *lock );
 519
 520 #ifdef BDB_REUSE_LOCKERS
 521
 522 #define bdb_locker_id                           BDB_SYMBOL(locker_id)
 523 int bdb_locker_id( Operation *op, DB_ENV *env, int *locker );
 524
 525 #define LOCK_ID_FREE(env, locker)
 526 #define LOCK_ID(env, locker)    bdb_locker_id(op, env, locker)
 527
 528 #else
 529
 530 #define LOCK_ID_FREE(env, locker)       XLOCK_ID_FREE(env, locker)
 531 #define LOCK_ID(env, locker)            XLOCK_ID(env, locker)
 532
 533 #endif
 534
 535 /*
 536  * search.c
 537  */
 538
 539 #define bdb_abandon                                     BDB_SYMBOL(abandon)
 540 #define bdb_cancel                                      BDB_SYMBOL(cancel)
 541 #define bdb_do_search                           BDB_SYMBOL(do_search)
 542 #define bdb_psearch                             BDB_SYMBOL(psearch)
 543
 544 BI_op_abandon bdb_abandon;
 545 BI_op_cancel bdb_cancel;
 546
 547 int bdb_psearch(
 548         Operation       *op,
 549         SlapReply       *rs,
 550         Operation       *ps_op,
 551         Entry           *entry,
 552         int             psearch_type
 553 );
 554
 555 int bdb_do_search(
 556         Operation       *op,
 557         SlapReply       *rs,
 558         Operation       *ps_op,
 559         Entry           *entry,
 560         int             psearch_type
 561 );
 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 LDAP_END_DECL
 572
 573 #endif /* _PROTO_BDB_H */