git.sur5r.net Git - openldap/blob - servers/slapd/back-bdb/proto-bdb.h

   1 /* $OpenLDAP$ */
   2 /*
   3  * Copyright 2000-2003 The OpenLDAP Foundation, All Rights Reserved.
   4  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
   5  */
   6
   7 #ifndef _PROTO_BDB_H
   8 #define _PROTO_BDB_H
   9
  10 LDAP_BEGIN_DECL
  11
  12 #ifdef BDB_HIER
  13 #define BDB_SYMBOL(x)   LDAP_CONCAT(hdb_,x)
  14 #else
  15 #define BDB_SYMBOL(x)   LDAP_CONCAT(bdb_,x)
  16 #endif
  17
  18 /*
  19  * attr.c
  20  */
  21
  22 #define bdb_attr_mask                           BDB_SYMBOL(attr_mask)
  23 #define bdb_attr_index_config           BDB_SYMBOL(attr_index_config)
  24 #define bdb_attr_index_destroy          BDB_SYMBOL(attr_index_destroy)
  25
  26 void bdb_attr_mask( struct bdb_info *bdb,
  27         AttributeDescription *desc,
  28         slap_mask_t *indexmask );
  29
  30 int bdb_attr_index_config LDAP_P(( struct bdb_info *bdb,
  31         const char *fname, int lineno,
  32         int argc, char **argv ));
  33
  34 void bdb_attr_index_destroy LDAP_P(( Avlnode *tree ));
  35
  36 /*
  37  * ctxcsn.c
  38  */
  39 #define bdb_csn_commit                          BDB_SYMBOL(csn_commit)
  40 #define bdb_get_commit_csn                      BDB_SYMBOL(get_commit_csn)
  41
  42 int bdb_csn_commit LDAP_P(( Operation *op, SlapReply *rs, DB_TXN *tid,
  43                                                 EntryInfo *ei, EntryInfo **suffix_ei, Entry **ctxcsn_e,
  44                                                 int *ctxcsn_added, u_int32_t locker ));
  45
  46 int bdb_get_commit_csn LDAP_P(( Operation *op, SlapReply *rs,
  47                                                 struct berval **search_context_csn,
  48                                                 u_int32_t locker, DB_LOCK *ctxcsn_lock ));
  49
  50 /*
  51  * dbcache.c
  52  */
  53 #define bdb_db_cache                            BDB_SYMBOL(db_cache)
  54
  55 int
  56 bdb_db_cache(
  57     Backend     *be,
  58     DB_TXN *tid,
  59     const char *name,
  60         DB **db );
  61
  62 /*
  63  * dn2entry.c
  64  */
  65 #define bdb_dn2entry                            BDB_SYMBOL(dn2entry)
  66
  67 int bdb_dn2entry LDAP_P(( Operation *op, DB_TXN *tid,
  68         struct berval *dn, EntryInfo **e, int matched,
  69         u_int32_t locker, DB_LOCK *lock ));
  70
  71 /*
  72  * dn2id.c
  73  */
  74 #define bdb_dn2id                                       BDB_SYMBOL(dn2id)
  75 #define bdb_dn2id_add                           BDB_SYMBOL(dn2id_add)
  76 #define bdb_dn2id_delete                        BDB_SYMBOL(dn2id_delete)
  77 #define bdb_dn2id_children                      BDB_SYMBOL(dn2id_children)
  78 #define bdb_dn2idl                                      BDB_SYMBOL(dn2idl)
  79
  80 int bdb_dn2id(
  81         Operation *op,
  82         DB_TXN *tid,
  83         struct berval *dn,
  84         EntryInfo *ei );
  85
  86 int bdb_dn2id_add(
  87         Operation *op,
  88         DB_TXN *tid,
  89         EntryInfo *eip,
  90         Entry *e );
  91
  92 int bdb_dn2id_delete(
  93         Operation *op,
  94         DB_TXN *tid,
  95         EntryInfo *eip,
  96         Entry *e );
  97
  98 int bdb_dn2id_children(
  99         Operation *op,
 100         DB_TXN *tid,
 101         Entry *e );
 102
 103 int bdb_dn2idl(
 104         Operation *op,
 105         Entry *e,
 106         ID *ids,
 107         ID *stack );
 108
 109 #ifdef BDB_HIER
 110 #define bdb_dn2id_parent                        BDB_SYMBOL(dn2id_parent)
 111 #define bdb_dup_compare                         BDB_SYMBOL(dup_compare)
 112 #define bdb_fix_dn                                      BDB_SYMBOL(fix_dn)
 113
 114 int bdb_dn2id_parent(
 115         Operation *op,
 116         DB_TXN *txn,
 117         EntryInfo *ei,
 118         ID *idp );
 119
 120 int bdb_dup_compare(
 121         DB *db,
 122         const DBT *usrkey,
 123         const DBT *curkey );
 124
 125 int bdb_fix_dn( Entry *e, int checkit );
 126 #endif
 127
 128
 129 /*
 130  * error.c
 131  */
 132 #define bdb_errcall                                     BDB_SYMBOL(errcall)
 133
 134 void bdb_errcall( const char *pfx, char * msg );
 135
 136 #ifdef HAVE_EBCDIC
 137 #define ebcdic_dberror                          BDB_SYMBOL(ebcdic_dberror)
 138
 139 char *ebcdic_dberror( int rc );
 140 #define db_strerror(x)  ebcdic_dberror(x)
 141 #endif
 142
 143 /*
 144  * filterentry.c
 145  */
 146 #define bdb_filter_candidates           BDB_SYMBOL(filter_candidates)
 147
 148 int bdb_filter_candidates(
 149         Operation *op,
 150         Filter  *f,
 151         ID *ids,
 152         ID *tmp,
 153         ID *stack );
 154
 155 /*
 156  * id2entry.c
 157  */
 158 #define bdb_id2entry                            BDB_SYMBOL(id2entry)
 159 #define bdb_id2entry_add                        BDB_SYMBOL(id2entry_add)
 160 #define bdb_id2entry_update                     BDB_SYMBOL(id2entry_update)
 161 #define bdb_id2entry_delete                     BDB_SYMBOL(id2entry_delete)
 162
 163 int bdb_id2entry_add(
 164         BackendDB *be,
 165         DB_TXN *tid,
 166         Entry *e );
 167
 168 int bdb_id2entry_update(
 169         BackendDB *be,
 170         DB_TXN *tid,
 171         Entry *e );
 172
 173 int bdb_id2entry_delete(
 174         BackendDB *be,
 175         DB_TXN *tid,
 176         Entry *e);
 177
 178 int bdb_id2entry(
 179         BackendDB *be,
 180         DB_TXN *tid,
 181         ID id,
 182         Entry **e);
 183
 184 #define bdb_entry_free                          BDB_SYMBOL(entry_free)
 185 #define bdb_entry_return                        BDB_SYMBOL(entry_return)
 186 #define bdb_entry_release                       BDB_SYMBOL(entry_release)
 187 #define bdb_entry_get                           BDB_SYMBOL(entry_get)
 188
 189 void bdb_entry_free ( Entry *e );
 190 int bdb_entry_return( Entry *e );
 191 BI_entry_release_rw bdb_entry_release;
 192 BI_entry_get_rw bdb_entry_get;
 193
 194
 195 /*
 196  * idl.c
 197  */
 198 #ifdef SLAP_IDL_CACHE
 199
 200 #define bdb_idl_cache_get                       BDB_SYMBOL(idl_cache_get)
 201 #define bdb_idl_cache_put                       BDB_SYMBOL(idl_cache_put)
 202 #define bdb_idl_cache_del                       BDB_SYMBOL(idl_cache_del)
 203
 204 int bdb_idl_cache_get(
 205         struct bdb_info *bdb,
 206         DB *db,
 207         DBT *key,
 208         ID *ids );
 209
 210 void
 211 bdb_idl_cache_put(
 212         struct bdb_info *bdb,
 213         DB              *db,
 214         DBT             *key,
 215         ID              *ids,
 216         int             rc );
 217
 218 void
 219 bdb_idl_cache_del(
 220         struct bdb_info *bdb,
 221         DB              *db,
 222         DBT             *key );
 223 #endif
 224
 225 #define bdb_idl_first                           BDB_SYMBOL(idl_first)
 226 #define bdb_idl_next                            BDB_SYMBOL(idl_next)
 227 #define bdb_idl_search                          BDB_SYMBOL(idl_search)
 228 #define bdb_idl_insert                          BDB_SYMBOL(idl_insert)
 229 #define bdb_idl_intersection            BDB_SYMBOL(idl_intersection)
 230 #define bdb_idl_union                           BDB_SYMBOL(idl_union)
 231
 232 #define bdb_idl_fetch_key                       BDB_SYMBOL(idl_fetch_key)
 233 #define bdb_idl_insert_key                      BDB_SYMBOL(idl_insert_key)
 234 #define bdb_idl_delete_key                      BDB_SYMBOL(idl_delete_key)
 235
 236 unsigned bdb_idl_search( ID *ids, ID id );
 237
 238 int bdb_idl_fetch_key(
 239         BackendDB *be,
 240         DB *db,
 241         DB_TXN *txn,
 242         DBT *key,
 243         ID *ids );
 244
 245 int bdb_idl_insert( ID *ids, ID id );
 246
 247 int bdb_idl_insert_key(
 248         BackendDB *be,
 249         DB *db,
 250         DB_TXN *txn,
 251         DBT *key,
 252         ID id );
 253
 254 int bdb_idl_delete_key(
 255         BackendDB *be,
 256         DB *db,
 257         DB_TXN *txn,
 258         DBT *key,
 259         ID id );
 260
 261 int
 262 bdb_idl_intersection(
 263         ID *a,
 264         ID *b );
 265
 266 int
 267 bdb_idl_union(
 268         ID *a,
 269         ID *b );
 270
 271 ID bdb_idl_first( ID *ids, ID *cursor );
 272 ID bdb_idl_next( ID *ids, ID *cursor );
 273
 274
 275 #define bdb_bt_compare                          BDB_SYMBOL(bt_compare)
 276
 277 int bdb_bt_compare(
 278         DB *db,
 279         const DBT *a,
 280         const DBT *b );
 281
 282
 283 /*
 284  * index.c
 285  */
 286 #define bdb_index_is_indexed            BDB_SYMBOL(index_is_indexed)
 287 #define bdb_index_param                         BDB_SYMBOL(index_param)
 288 #define bdb_index_values                        BDB_SYMBOL(index_values)
 289 #define bdb_index_entry                         BDB_SYMBOL(index_entry)
 290
 291 extern int
 292 bdb_index_is_indexed LDAP_P((
 293         Backend *be,
 294         AttributeDescription *desc ));
 295
 296 extern int
 297 bdb_index_param LDAP_P((
 298         Backend *be,
 299         AttributeDescription *desc,
 300         int ftype,
 301         DB **db,
 302         slap_mask_t *mask,
 303         struct berval *prefix ));
 304
 305 extern int
 306 bdb_index_values LDAP_P((
 307         Operation *op,
 308         DB_TXN *txn,
 309         AttributeDescription *desc,
 310         BerVarray vals,
 311         BerVarray xvals,
 312         ID id,
 313         int opid ));
 314
 315 int bdb_index_entry LDAP_P(( Operation *op, DB_TXN *t, int r, Entry *e ));
 316
 317 #define bdb_index_entry_add(op,t,e) \
 318         bdb_index_entry((op),(t),SLAP_INDEX_ADD_OP,(e))
 319 #define bdb_index_entry_del(op,t,e) \
 320         bdb_index_entry((op),(t),SLAP_INDEX_DELETE_OP,(e))
 321
 322 /*
 323  * init.c
 324  */
 325 #define bdb_uuid                                        BDB_SYMBOL(uuid)
 326
 327 extern struct berval bdb_uuid;
 328
 329 /*
 330  * key.c
 331  */
 332 #define bdb_key_read                            BDB_SYMBOL(key_read)
 333 #define bdb_key_change                          BDB_SYMBOL(key_change)
 334
 335 extern int
 336 bdb_key_read(
 337     Backend     *be,
 338         DB *db,
 339         DB_TXN *txn,
 340     struct berval *k,
 341         ID *ids );
 342
 343 extern int
 344 bdb_key_change(
 345     Backend      *be,
 346     DB *db,
 347         DB_TXN *txn,
 348     struct berval *k,
 349     ID id,
 350     int op );
 351
 352 /*
 353  * nextid.c
 354  */
 355 #define bdb_next_id                                     BDB_SYMBOL(next_id)
 356 #define bdb_last_id                                     BDB_SYMBOL(last_id)
 357
 358 int bdb_next_id( BackendDB *be, DB_TXN *tid, ID *id );
 359 int bdb_last_id( BackendDB *be, DB_TXN *tid );
 360
 361 /*
 362  * modify.c
 363  */
 364 #define bdb_modify_internal                     BDB_SYMBOL(modify_internal)
 365
 366 int bdb_modify_internal(
 367         Operation *op,
 368         DB_TXN *tid,
 369         Modifications *modlist,
 370         Entry *e,
 371         const char **text,
 372         char *textbuf,
 373         size_t textlen );
 374
 375 /*
 376  * passwd.c
 377  */
 378 #define bdb_exop_passwd                         BDB_SYMBOL(exop_passwd)
 379
 380 BI_op_extended bdb_exop_passwd;
 381
 382
 383 /*
 384  * cache.c
 385  */
 386 #define bdb_cache_entry_db_unlock       BDB_SYMBOL(cache_entry_db_unlock)
 387
 388 #define bdb_cache_entryinfo_lock(e) \
 389         ldap_pvt_thread_mutex_lock( &(e)->bei_kids_mutex )
 390 #define bdb_cache_entryinfo_unlock(e) \
 391         ldap_pvt_thread_mutex_unlock( &(e)->bei_kids_mutex )
 392
 393 /* What a mess. Hopefully the current cache scheme will stabilize
 394  * and we can trim out all of this stuff.
 395  */
 396 #if 0
 397 void bdb_cache_return_entry_rw( DB_ENV *env, Cache *cache, Entry *e,
 398         int rw, DB_LOCK *lock );
 399 #else
 400 #define bdb_cache_return_entry_rw( env, cache, e, rw, lock ) \
 401         bdb_cache_entry_db_unlock( env, lock )
 402 #define bdb_cache_return_entry( env, lock ) \
 403         bdb_cache_entry_db_unlock( env, lock )
 404 #endif
 405 #define bdb_cache_return_entry_r(env, c, e, l) \
 406         bdb_cache_return_entry_rw((env), (c), (e), 0, (l))
 407 #define bdb_cache_return_entry_w(env, c, e, l) \
 408         bdb_cache_return_entry_rw((env), (c), (e), 1, (l))
 409 #if 0
 410 void bdb_unlocked_cache_return_entry_rw( Cache *cache, Entry *e, int rw );
 411 #else
 412 #define bdb_unlocked_cache_return_entry_rw( a, b, c )
 413 #endif
 414 #define bdb_unlocked_cache_return_entry_r( c, e ) \
 415         bdb_unlocked_cache_return_entry_rw((c), (e), 0)
 416 #define bdb_unlocked_cache_return_entry_w( c, e ) \
 417         bdb_unlocked_cache_return_entry_rw((c), (e), 1)
 418
 419 #define bdb_cache_add                           BDB_SYMBOL(cache_add)
 420 #define bdb_cache_children                      BDB_SYMBOL(cache_children)
 421 #define bdb_cache_delete                        BDB_SYMBOL(cache_delete)
 422 #define bdb_cache_delete_cleanup                BDB_SYMBOL(cache_delete_cleanup)
 423 #define bdb_cache_find_id                       BDB_SYMBOL(cache_find_id)
 424 #define bdb_cache_find_ndn                      BDB_SYMBOL(cache_find_ndn)
 425 #define bdb_cache_modify                        BDB_SYMBOL(cache_modify)
 426 #define bdb_cache_modrdn                        BDB_SYMBOL(cache_modrdn)
 427 #define bdb_cache_release_all           BDB_SYMBOL(cache_release_all)
 428
 429 int bdb_cache_children(
 430         Operation *op,
 431         DB_TXN *txn,
 432         Entry *e
 433 );
 434 int bdb_cache_add(
 435         struct bdb_info *bdb,
 436         EntryInfo *pei,
 437         Entry   *e,
 438         struct berval *nrdn,
 439         u_int32_t locker
 440 );
 441 int bdb_cache_modrdn(
 442         Entry   *e,
 443         struct berval *nrdn,
 444         Entry   *new,
 445         EntryInfo *ein,
 446         DB_ENV *env,
 447         u_int32_t locker,
 448         DB_LOCK *lock
 449 );
 450 int bdb_cache_modify(
 451         Entry *e,
 452         Attribute *newAttrs,
 453         DB_ENV *env,
 454         u_int32_t locker,
 455         DB_LOCK *lock
 456 );
 457 int bdb_cache_find_ndn(
 458         Operation *op,
 459         DB_TXN  *txn,
 460         struct berval   *ndn,
 461         EntryInfo       **res,
 462         u_int32_t       locker
 463 );
 464 int bdb_cache_find_id(
 465         Operation *op,
 466         DB_TXN  *tid,
 467         ID              id,
 468         EntryInfo **eip,
 469         int     islocked,
 470         u_int32_t       locker,
 471         DB_LOCK         *lock
 472 );
 473 int bdb_cache_delete(
 474         Cache   *cache,
 475         Entry   *e,
 476         DB_ENV  *env,
 477         u_int32_t locker,
 478         DB_LOCK *lock
 479 );
 480 void bdb_cache_delete_cleanup(
 481         Entry   *e
 482 );
 483 void bdb_cache_release_all( Cache *cache );
 484
 485 #define bdb_cache_entry_db_relock               BDB_SYMBOL(cache_entry_db_relock)
 486 int bdb_cache_entry_db_relock(
 487         DB_ENV *env,
 488         u_int32_t locker,
 489         EntryInfo *ei,
 490         int rw,
 491         int tryOnly,
 492         DB_LOCK *lock );
 493
 494 #ifdef BDB_REUSE_LOCKERS
 495
 496 #define bdb_locker_id                           BDB_SYMBOL(locker_id)
 497 int bdb_locker_id( Operation *op, DB_ENV *env, int *locker );
 498
 499 #define LOCK_ID_FREE(env, locker)
 500 #define LOCK_ID(env, locker)    bdb_locker_id(op, env, locker)
 501
 502 #else
 503
 504 #define LOCK_ID_FREE(env, locker)       XLOCK_ID_FREE(env, locker)
 505 #define LOCK_ID(env, locker)            XLOCK_ID(env, locker)
 506
 507 #endif
 508
 509 /*
 510  * search.c
 511  */
 512
 513 #define bdb_abandon                                     BDB_SYMBOL(abandon)
 514 #define bdb_cancel                                      BDB_SYMBOL(cancel)
 515 #define bdb_do_search                           BDB_SYMBOL(do_search)
 516
 517 BI_op_abandon bdb_abandon;
 518 BI_op_cancel bdb_cancel;
 519
 520 int bdb_do_search(
 521         Operation       *op,
 522         SlapReply       *rs,
 523         Operation       *ps_op,
 524         Entry           *entry,
 525         int             psearch_type
 526 );
 527 #define bdb_psearch(op, rs, sop, e, ps_type)    bdb_do_search(op, rs, sop, e, ps_type)
 528
 529 #define bdb_build_sync_state_ctrl       BDB_SYMBOL(build_sync_state_ctrl)
 530 #define bdb_build_sync_done_ctrl        BDB_SYMBOL(build_sync_done_ctrl)
 531 #define bdb_send_ldap_intermediate      BDB_SYMBOL(send_ldap_intermediate)
 532
 533 int
 534 bdb_build_sync_state_ctrl(
 535         Operation       *op,
 536         SlapReply               *rs,
 537         Entry           *e,
 538         int             entry_sync_state,
 539         LDAPControl     **ctrls,
 540         int             num_ctrls,
 541         int             send_cookie,
 542         struct berval   *csn     );
 543
 544 int
 545 bdb_build_sync_done_ctrl(
 546         Operation       *op,
 547         SlapReply       *rs,
 548         LDAPControl     **ctrls,
 549         int             num_ctrls,
 550         int             send_cookie,
 551         struct berval   *latest_entrycsn_bv     );
 552
 553 int
 554 bdb_send_ldap_intermediate(
 555         Operation   *op,
 556         SlapReply       *rs,
 557         int         state,
 558         struct berval *cookie );
 559
 560 /*
 561  * trans.c
 562  */
 563 #define bdb_trans_backoff                       BDB_SYMBOL(trans_backoff)
 564
 565 void
 566 bdb_trans_backoff( int num_retries );
 567
 568 LDAP_END_DECL
 569
 570 #endif /* _PROTO_BDB_H */