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 *txn,
 248         DBT *key,
 249         ID *ids );
 250
 251 int bdb_idl_insert( ID *ids, ID id );
 252
 253 int bdb_idl_insert_key(
 254         BackendDB *be,
 255         DB *db,
 256         DB_TXN *txn,
 257         DBT *key,
 258         ID id );
 259
 260 int bdb_idl_delete_key(
 261         BackendDB *be,
 262         DB *db,
 263         DB_TXN *txn,
 264         DBT *key,
 265         ID id );
 266
 267 int
 268 bdb_idl_intersection(
 269         ID *a,
 270         ID *b );
 271
 272 int
 273 bdb_idl_union(
 274         ID *a,
 275         ID *b );
 276
 277 ID bdb_idl_first( ID *ids, ID *cursor );
 278 ID bdb_idl_next( ID *ids, ID *cursor );
 279
 280
 281 #define bdb_bt_compare                          BDB_SYMBOL(bt_compare)
 282
 283 int bdb_bt_compare(
 284         DB *db,
 285         const DBT *a,
 286         const DBT *b );
 287
 288
 289 /*
 290  * index.c
 291  */
 292 #define bdb_index_is_indexed            BDB_SYMBOL(index_is_indexed)
 293 #define bdb_index_param                         BDB_SYMBOL(index_param)
 294 #define bdb_index_values                        BDB_SYMBOL(index_values)
 295 #define bdb_index_entry                         BDB_SYMBOL(index_entry)
 296
 297 extern int
 298 bdb_index_is_indexed LDAP_P((
 299         Backend *be,
 300         AttributeDescription *desc ));
 301
 302 extern int
 303 bdb_index_param LDAP_P((
 304         Backend *be,
 305         AttributeDescription *desc,
 306         int ftype,
 307         DB **db,
 308         slap_mask_t *mask,
 309         struct berval *prefix ));
 310
 311 extern int
 312 bdb_index_values LDAP_P((
 313         Operation *op,
 314         DB_TXN *txn,
 315         AttributeDescription *desc,
 316         BerVarray vals,
 317         ID id,
 318         int opid ));
 319
 320 int bdb_index_entry LDAP_P(( Operation *op, DB_TXN *t, int r, Entry *e ));
 321
 322 #define bdb_index_entry_add(op,t,e) \
 323         bdb_index_entry((op),(t),SLAP_INDEX_ADD_OP,(e))
 324 #define bdb_index_entry_del(op,t,e) \
 325         bdb_index_entry((op),(t),SLAP_INDEX_DELETE_OP,(e))
 326
 327 /*
 328  * init.c
 329  */
 330 #define bdb_uuid                                        BDB_SYMBOL(uuid)
 331
 332 extern struct berval bdb_uuid;
 333
 334 /*
 335  * key.c
 336  */
 337 #define bdb_key_read                            BDB_SYMBOL(key_read)
 338 #define bdb_key_change                          BDB_SYMBOL(key_change)
 339
 340 extern int
 341 bdb_key_read(
 342     Backend     *be,
 343         DB *db,
 344         DB_TXN *txn,
 345     struct berval *k,
 346         ID *ids );
 347
 348 extern int
 349 bdb_key_change(
 350     Backend      *be,
 351     DB *db,
 352         DB_TXN *txn,
 353     struct berval *k,
 354     ID id,
 355     int op );
 356
 357 /*
 358  * nextid.c
 359  */
 360 #define bdb_next_id                                     BDB_SYMBOL(next_id)
 361 #define bdb_last_id                                     BDB_SYMBOL(last_id)
 362
 363 int bdb_next_id( BackendDB *be, DB_TXN *tid, ID *id );
 364 int bdb_last_id( BackendDB *be, DB_TXN *tid );
 365
 366 /*
 367  * modify.c
 368  */
 369 #define bdb_modify_internal                     BDB_SYMBOL(modify_internal)
 370
 371 int bdb_modify_internal(
 372         Operation *op,
 373         DB_TXN *tid,
 374         Modifications *modlist,
 375         Entry *e,
 376         const char **text,
 377         char *textbuf,
 378         size_t textlen );
 379
 380
 381 /*
 382  * cache.c
 383  */
 384 #define bdb_cache_entry_db_unlock       BDB_SYMBOL(cache_entry_db_unlock)
 385
 386 #define bdb_cache_entryinfo_lock(e) \
 387         ldap_pvt_thread_mutex_lock( &(e)->bei_kids_mutex )
 388 #define bdb_cache_entryinfo_unlock(e) \
 389         ldap_pvt_thread_mutex_unlock( &(e)->bei_kids_mutex )
 390
 391 /* What a mess. Hopefully the current cache scheme will stabilize
 392  * and we can trim out all of this stuff.
 393  */
 394 #if 0
 395 void bdb_cache_return_entry_rw( DB_ENV *env, Cache *cache, Entry *e,
 396         int rw, DB_LOCK *lock );
 397 #else
 398 #define bdb_cache_return_entry_rw( env, cache, e, rw, lock ) \
 399         bdb_cache_entry_db_unlock( env, lock )
 400 #define bdb_cache_return_entry( env, lock ) \
 401         bdb_cache_entry_db_unlock( env, lock )
 402 #endif
 403 #define bdb_cache_return_entry_r(env, c, e, l) \
 404         bdb_cache_return_entry_rw((env), (c), (e), 0, (l))
 405 #define bdb_cache_return_entry_w(env, c, e, l) \
 406         bdb_cache_return_entry_rw((env), (c), (e), 1, (l))
 407 #if 0
 408 void bdb_unlocked_cache_return_entry_rw( Cache *cache, Entry *e, int rw );
 409 #else
 410 #define bdb_unlocked_cache_return_entry_rw( a, b, c )
 411 #endif
 412 #define bdb_unlocked_cache_return_entry_r( c, e ) \
 413         bdb_unlocked_cache_return_entry_rw((c), (e), 0)
 414 #define bdb_unlocked_cache_return_entry_w( c, e ) \
 415         bdb_unlocked_cache_return_entry_rw((c), (e), 1)
 416
 417 #define bdb_cache_add                           BDB_SYMBOL(cache_add)
 418 #define bdb_cache_children                      BDB_SYMBOL(cache_children)
 419 #define bdb_cache_delete                        BDB_SYMBOL(cache_delete)
 420 #define bdb_cache_delete_cleanup                BDB_SYMBOL(cache_delete_cleanup)
 421 #define bdb_cache_find_id                       BDB_SYMBOL(cache_find_id)
 422 #define bdb_cache_find_info                     BDB_SYMBOL(cache_find_info)
 423 #define bdb_cache_find_ndn                      BDB_SYMBOL(cache_find_ndn)
 424 #define bdb_cache_modify                        BDB_SYMBOL(cache_modify)
 425 #define bdb_cache_modrdn                        BDB_SYMBOL(cache_modrdn)
 426 #define bdb_cache_release_all           BDB_SYMBOL(cache_release_all)
 427 #define bdb_cache_delete_entry          BDB_SYMBOL(cache_delete_entry)
 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 );
 463 EntryInfo * bdb_cache_find_info(
 464         struct bdb_info *bdb,
 465         ID id
 466 );
 467 int bdb_cache_find_id(
 468         Operation *op,
 469         DB_TXN  *tid,
 470         ID              id,
 471         EntryInfo **eip,
 472         int     islocked,
 473         u_int32_t       locker,
 474         DB_LOCK         *lock
 475 );
 476 int bdb_cache_delete(
 477         Cache   *cache,
 478         Entry   *e,
 479         DB_ENV  *env,
 480         u_int32_t locker,
 481         DB_LOCK *lock
 482 );
 483 void bdb_cache_delete_cleanup(
 484         Cache   *cache,
 485         Entry   *e
 486 );
 487 void bdb_cache_release_all( Cache *cache );
 488 void bdb_cache_delete_entry(
 489         struct bdb_info *bdb,
 490         EntryInfo *ei,
 491         u_int32_t locker,
 492         DB_LOCK *lock
 493 );
 494
 495 #ifdef BDB_HIER
 496 int hdb_cache_load(
 497         struct bdb_info *bdb,
 498         EntryInfo *ei,
 499         EntryInfo **res
 500 );
 501 #endif
 502
 503 #define bdb_cache_entry_db_relock               BDB_SYMBOL(cache_entry_db_relock)
 504 int bdb_cache_entry_db_relock(
 505         DB_ENV *env,
 506         u_int32_t locker,
 507         EntryInfo *ei,
 508         int rw,
 509         int tryOnly,
 510         DB_LOCK *lock );
 511
 512 int bdb_cache_entry_db_unlock(
 513         DB_ENV *env,
 514         DB_LOCK *lock );
 515
 516 #ifdef BDB_REUSE_LOCKERS
 517
 518 #define bdb_locker_id                           BDB_SYMBOL(locker_id)
 519 int bdb_locker_id( Operation *op, DB_ENV *env, int *locker );
 520
 521 #define LOCK_ID_FREE(env, locker)
 522 #define LOCK_ID(env, locker)    bdb_locker_id(op, env, locker)
 523
 524 #else
 525
 526 #define LOCK_ID_FREE(env, locker)       XLOCK_ID_FREE(env, locker)
 527 #define LOCK_ID(env, locker)            XLOCK_ID(env, locker)
 528
 529 #endif
 530
 531 /*
 532  * search.c
 533  */
 534
 535 #define bdb_abandon                                     BDB_SYMBOL(abandon)
 536 #define bdb_cancel                                      BDB_SYMBOL(cancel)
 537 #define bdb_do_search                           BDB_SYMBOL(do_search)
 538 #define bdb_psearch                             BDB_SYMBOL(psearch)
 539
 540 BI_op_abandon bdb_abandon;
 541 BI_op_cancel bdb_cancel;
 542
 543 int bdb_psearch(
 544         Operation       *op,
 545         SlapReply       *rs,
 546         Operation       *ps_op,
 547         Entry           *entry,
 548         int             psearch_type
 549 );
 550
 551 int bdb_do_search(
 552         Operation       *op,
 553         SlapReply       *rs,
 554         Operation       *ps_op,
 555         Entry           *entry,
 556         int             psearch_type
 557 );
 558
 559 /*
 560  * trans.c
 561  */
 562 #define bdb_trans_backoff                       BDB_SYMBOL(trans_backoff)
 563
 564 void
 565 bdb_trans_backoff( int num_retries );
 566
 567 LDAP_END_DECL
 568
 569 #endif /* _PROTO_BDB_H */