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