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-2003 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 #ifdef SLAP_IDL_CACHE
 207
 208 #define bdb_idl_cache_get                       BDB_SYMBOL(idl_cache_get)
 209 #define bdb_idl_cache_put                       BDB_SYMBOL(idl_cache_put)
 210 #define bdb_idl_cache_del                       BDB_SYMBOL(idl_cache_del)
 211
 212 int bdb_idl_cache_get(
 213         struct bdb_info *bdb,
 214         DB *db,
 215         DBT *key,
 216         ID *ids );
 217
 218 void
 219 bdb_idl_cache_put(
 220         struct bdb_info *bdb,
 221         DB              *db,
 222         DBT             *key,
 223         ID              *ids,
 224         int             rc );
 225
 226 void
 227 bdb_idl_cache_del(
 228         struct bdb_info *bdb,
 229         DB              *db,
 230         DBT             *key );
 231 #endif
 232
 233 #define bdb_idl_first                           BDB_SYMBOL(idl_first)
 234 #define bdb_idl_next                            BDB_SYMBOL(idl_next)
 235 #define bdb_idl_search                          BDB_SYMBOL(idl_search)
 236 #define bdb_idl_insert                          BDB_SYMBOL(idl_insert)
 237 #define bdb_idl_intersection            BDB_SYMBOL(idl_intersection)
 238 #define bdb_idl_union                           BDB_SYMBOL(idl_union)
 239
 240 #define bdb_idl_fetch_key                       BDB_SYMBOL(idl_fetch_key)
 241 #define bdb_idl_insert_key                      BDB_SYMBOL(idl_insert_key)
 242 #define bdb_idl_delete_key                      BDB_SYMBOL(idl_delete_key)
 243
 244 unsigned bdb_idl_search( ID *ids, ID id );
 245
 246 int bdb_idl_fetch_key(
 247         BackendDB *be,
 248         DB *db,
 249         DB_TXN *txn,
 250         DBT *key,
 251         ID *ids );
 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
 350 extern int
 351 bdb_key_change(
 352     Backend      *be,
 353     DB *db,
 354         DB_TXN *txn,
 355     struct berval *k,
 356     ID id,
 357     int op );
 358
 359 /*
 360  * nextid.c
 361  */
 362 #define bdb_next_id                                     BDB_SYMBOL(next_id)
 363 #define bdb_last_id                                     BDB_SYMBOL(last_id)
 364
 365 int bdb_next_id( BackendDB *be, DB_TXN *tid, ID *id );
 366 int bdb_last_id( BackendDB *be, DB_TXN *tid );
 367
 368 /*
 369  * modify.c
 370  */
 371 #define bdb_modify_internal                     BDB_SYMBOL(modify_internal)
 372
 373 int bdb_modify_internal(
 374         Operation *op,
 375         DB_TXN *tid,
 376         Modifications *modlist,
 377         Entry *e,
 378         const char **text,
 379         char *textbuf,
 380         size_t textlen );
 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_info                     BDB_SYMBOL(cache_find_info)
 425 #define bdb_cache_find_ndn                      BDB_SYMBOL(cache_find_ndn)
 426 #define bdb_cache_modify                        BDB_SYMBOL(cache_modify)
 427 #define bdb_cache_modrdn                        BDB_SYMBOL(cache_modrdn)
 428 #define bdb_cache_release_all           BDB_SYMBOL(cache_release_all)
 429 #define bdb_cache_delete_entry          BDB_SYMBOL(cache_delete_entry)
 430
 431 int bdb_cache_children(
 432         Operation *op,
 433         DB_TXN *txn,
 434         Entry *e
 435 );
 436 int bdb_cache_add(
 437         struct bdb_info *bdb,
 438         EntryInfo *pei,
 439         Entry   *e,
 440         struct berval *nrdn,
 441         u_int32_t locker
 442 );
 443 int bdb_cache_modrdn(
 444         Entry   *e,
 445         struct berval *nrdn,
 446         Entry   *new,
 447         EntryInfo *ein,
 448         DB_ENV *env,
 449         u_int32_t locker,
 450         DB_LOCK *lock
 451 );
 452 int bdb_cache_modify(
 453         Entry *e,
 454         Attribute *newAttrs,
 455         DB_ENV *env,
 456         u_int32_t locker,
 457         DB_LOCK *lock
 458 );
 459 int bdb_cache_find_ndn(
 460         Operation *op,
 461         DB_TXN  *txn,
 462         struct berval   *ndn,
 463         EntryInfo       **res
 464 );
 465 EntryInfo * bdb_cache_find_info(
 466         struct bdb_info *bdb,
 467         ID id
 468 );
 469 int bdb_cache_find_id(
 470         Operation *op,
 471         DB_TXN  *tid,
 472         ID              id,
 473         EntryInfo **eip,
 474         int     islocked,
 475         u_int32_t       locker,
 476         DB_LOCK         *lock
 477 );
 478 int bdb_cache_delete(
 479         Cache   *cache,
 480         Entry   *e,
 481         DB_ENV  *env,
 482         u_int32_t locker,
 483         DB_LOCK *lock
 484 );
 485 void bdb_cache_delete_cleanup(
 486         Cache   *cache,
 487         Entry   *e
 488 );
 489 void bdb_cache_release_all( Cache *cache );
 490 void bdb_cache_delete_entry(
 491         struct bdb_info *bdb,
 492         EntryInfo *ei,
 493         u_int32_t locker,
 494         DB_LOCK *lock
 495 );
 496
 497 #ifdef BDB_HIER
 498 int hdb_cache_load(
 499         struct bdb_info *bdb,
 500         EntryInfo *ei,
 501         EntryInfo **res
 502 );
 503 #endif
 504
 505 #define bdb_cache_entry_db_relock               BDB_SYMBOL(cache_entry_db_relock)
 506 int bdb_cache_entry_db_relock(
 507         DB_ENV *env,
 508         u_int32_t locker,
 509         EntryInfo *ei,
 510         int rw,
 511         int tryOnly,
 512         DB_LOCK *lock );
 513
 514 int bdb_cache_entry_db_unlock(
 515         DB_ENV *env,
 516         DB_LOCK *lock );
 517
 518 #ifdef BDB_REUSE_LOCKERS
 519
 520 #define bdb_locker_id                           BDB_SYMBOL(locker_id)
 521 int bdb_locker_id( Operation *op, DB_ENV *env, int *locker );
 522
 523 #define LOCK_ID_FREE(env, locker)
 524 #define LOCK_ID(env, locker)    bdb_locker_id(op, env, locker)
 525
 526 #else
 527
 528 #define LOCK_ID_FREE(env, locker)       XLOCK_ID_FREE(env, locker)
 529 #define LOCK_ID(env, locker)            XLOCK_ID(env, locker)
 530
 531 #endif
 532
 533 /*
 534  * search.c
 535  */
 536
 537 #define bdb_abandon                                     BDB_SYMBOL(abandon)
 538 #define bdb_cancel                                      BDB_SYMBOL(cancel)
 539 #define bdb_do_search                           BDB_SYMBOL(do_search)
 540
 541 BI_op_abandon bdb_abandon;
 542 BI_op_cancel bdb_cancel;
 543
 544 int bdb_do_search(
 545         Operation       *op,
 546         SlapReply       *rs,
 547         Operation       *ps_op,
 548         Entry           *entry,
 549         int             psearch_type
 550 );
 551 #define bdb_psearch(op, rs, sop, e, ps_type)    bdb_do_search(op, rs, sop, e, ps_type)
 552
 553 /*
 554  * trans.c
 555  */
 556 #define bdb_trans_backoff                       BDB_SYMBOL(trans_backoff)
 557
 558 void
 559 bdb_trans_backoff( int num_retries );
 560
 561 LDAP_END_DECL
 562
 563 #endif /* _PROTO_BDB_H */