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 #if DB_VERSION_FULL < 0x04030000
 143 void bdb_errcall( const char *pfx, char * msg );
 144 #else
 145 void bdb_errcall( DB_ENV *env, const char *pfx, const char * msg );
 146 #endif
 147
 148 #ifdef HAVE_EBCDIC
 149 #define ebcdic_dberror                          BDB_SYMBOL(ebcdic_dberror)
 150
 151 char *ebcdic_dberror( int rc );
 152 #define db_strerror(x)  ebcdic_dberror(x)
 153 #endif
 154
 155 /*
 156  * filterentry.c
 157  */
 158 #define bdb_filter_candidates           BDB_SYMBOL(filter_candidates)
 159
 160 int bdb_filter_candidates(
 161         Operation *op,
 162         Filter  *f,
 163         ID *ids,
 164         ID *tmp,
 165         ID *stack );
 166
 167 /*
 168  * id2entry.c
 169  */
 170 #define bdb_id2entry                            BDB_SYMBOL(id2entry)
 171 #define bdb_id2entry_add                        BDB_SYMBOL(id2entry_add)
 172 #define bdb_id2entry_update                     BDB_SYMBOL(id2entry_update)
 173 #define bdb_id2entry_delete                     BDB_SYMBOL(id2entry_delete)
 174
 175 int bdb_id2entry_add(
 176         BackendDB *be,
 177         DB_TXN *tid,
 178         Entry *e );
 179
 180 int bdb_id2entry_update(
 181         BackendDB *be,
 182         DB_TXN *tid,
 183         Entry *e );
 184
 185 int bdb_id2entry_delete(
 186         BackendDB *be,
 187         DB_TXN *tid,
 188         Entry *e);
 189
 190 int bdb_id2entry(
 191         BackendDB *be,
 192         DB_TXN *tid,
 193         ID id,
 194         Entry **e);
 195
 196 #define bdb_entry_free                          BDB_SYMBOL(entry_free)
 197 #define bdb_entry_return                        BDB_SYMBOL(entry_return)
 198 #define bdb_entry_release                       BDB_SYMBOL(entry_release)
 199 #define bdb_entry_get                           BDB_SYMBOL(entry_get)
 200
 201 void bdb_entry_free ( Entry *e );
 202 int bdb_entry_return( Entry *e );
 203 BI_entry_release_rw bdb_entry_release;
 204 BI_entry_get_rw bdb_entry_get;
 205
 206
 207 /*
 208  * idl.c
 209  */
 210
 211 #define bdb_idl_cache_get                       BDB_SYMBOL(idl_cache_get)
 212 #define bdb_idl_cache_put                       BDB_SYMBOL(idl_cache_put)
 213 #define bdb_idl_cache_del                       BDB_SYMBOL(idl_cache_del)
 214
 215 int bdb_idl_cache_get(
 216         struct bdb_info *bdb,
 217         DB *db,
 218         DBT *key,
 219         ID *ids );
 220
 221 void
 222 bdb_idl_cache_put(
 223         struct bdb_info *bdb,
 224         DB              *db,
 225         DBT             *key,
 226         ID              *ids,
 227         int             rc );
 228
 229 void
 230 bdb_idl_cache_del(
 231         struct bdb_info *bdb,
 232         DB              *db,
 233         DBT             *key );
 234
 235 #define bdb_idl_first                           BDB_SYMBOL(idl_first)
 236 #define bdb_idl_next                            BDB_SYMBOL(idl_next)
 237 #define bdb_idl_search                          BDB_SYMBOL(idl_search)
 238 #define bdb_idl_insert                          BDB_SYMBOL(idl_insert)
 239 #define bdb_idl_intersection            BDB_SYMBOL(idl_intersection)
 240 #define bdb_idl_union                           BDB_SYMBOL(idl_union)
 241
 242 #define bdb_idl_fetch_key                       BDB_SYMBOL(idl_fetch_key)
 243 #define bdb_idl_insert_key                      BDB_SYMBOL(idl_insert_key)
 244 #define bdb_idl_delete_key                      BDB_SYMBOL(idl_delete_key)
 245
 246 unsigned bdb_idl_search( ID *ids, ID id );
 247
 248 int bdb_idl_fetch_key(
 249         BackendDB       *be,
 250         DB                      *db,
 251         DB_TXN          *tid,
 252         DBT                     *key,
 253         ID                      *ids,
 254         DBC                     **saved_cursor,
 255         int                     get_flag );
 256
 257 int bdb_idl_insert( ID *ids, ID id );
 258
 259 int bdb_idl_insert_key(
 260         BackendDB *be,
 261         DB *db,
 262         DB_TXN *txn,
 263         DBT *key,
 264         ID id );
 265
 266 int bdb_idl_delete_key(
 267         BackendDB *be,
 268         DB *db,
 269         DB_TXN *txn,
 270         DBT *key,
 271         ID id );
 272
 273 int
 274 bdb_idl_intersection(
 275         ID *a,
 276         ID *b );
 277
 278 int
 279 bdb_idl_union(
 280         ID *a,
 281         ID *b );
 282
 283 ID bdb_idl_first( ID *ids, ID *cursor );
 284 ID bdb_idl_next( ID *ids, ID *cursor );
 285
 286
 287 #define bdb_bt_compare                          BDB_SYMBOL(bt_compare)
 288
 289 int bdb_bt_compare(
 290         DB *db,
 291         const DBT *a,
 292         const DBT *b );
 293
 294
 295 /*
 296  * index.c
 297  */
 298 #define bdb_index_is_indexed            BDB_SYMBOL(index_is_indexed)
 299 #define bdb_index_param                         BDB_SYMBOL(index_param)
 300 #define bdb_index_values                        BDB_SYMBOL(index_values)
 301 #define bdb_index_entry                         BDB_SYMBOL(index_entry)
 302
 303 extern int
 304 bdb_index_is_indexed LDAP_P((
 305         Backend *be,
 306         AttributeDescription *desc ));
 307
 308 extern int
 309 bdb_index_param LDAP_P((
 310         Backend *be,
 311         AttributeDescription *desc,
 312         int ftype,
 313         DB **db,
 314         slap_mask_t *mask,
 315         struct berval *prefix ));
 316
 317 extern int
 318 bdb_index_values LDAP_P((
 319         Operation *op,
 320         DB_TXN *txn,
 321         AttributeDescription *desc,
 322         BerVarray vals,
 323         ID id,
 324         int opid ));
 325
 326 int bdb_index_entry LDAP_P(( Operation *op, DB_TXN *t, int r, Entry *e ));
 327
 328 #define bdb_index_entry_add(op,t,e) \
 329         bdb_index_entry((op),(t),SLAP_INDEX_ADD_OP,(e))
 330 #define bdb_index_entry_del(op,t,e) \
 331         bdb_index_entry((op),(t),SLAP_INDEX_DELETE_OP,(e))
 332
 333 /*
 334  * init.c
 335  */
 336 #define bdb_uuid                                        BDB_SYMBOL(uuid)
 337
 338 extern struct berval bdb_uuid;
 339
 340 /*
 341  * key.c
 342  */
 343 #define bdb_key_read                            BDB_SYMBOL(key_read)
 344 #define bdb_key_change                          BDB_SYMBOL(key_change)
 345
 346 extern int
 347 bdb_key_read(
 348     Backend     *be,
 349         DB *db,
 350         DB_TXN *txn,
 351     struct berval *k,
 352         ID *ids,
 353     DBC **saved_cursor,
 354         int get_flags );
 355
 356 extern int
 357 bdb_key_change(
 358     Backend      *be,
 359     DB *db,
 360         DB_TXN *txn,
 361     struct berval *k,
 362     ID id,
 363     int op );
 364
 365 /*
 366  * nextid.c
 367  */
 368 #define bdb_next_id                                     BDB_SYMBOL(next_id)
 369 #define bdb_last_id                                     BDB_SYMBOL(last_id)
 370
 371 int bdb_next_id( BackendDB *be, DB_TXN *tid, ID *id );
 372 int bdb_last_id( BackendDB *be, DB_TXN *tid );
 373
 374 /*
 375  * modify.c
 376  */
 377 #define bdb_modify_internal                     BDB_SYMBOL(modify_internal)
 378
 379 int bdb_modify_internal(
 380         Operation *op,
 381         DB_TXN *tid,
 382         Modifications *modlist,
 383         Entry *e,
 384         const char **text,
 385         char *textbuf,
 386         size_t textlen );
 387
 388
 389 /*
 390  * cache.c
 391  */
 392 #define bdb_cache_entry_db_unlock       BDB_SYMBOL(cache_entry_db_unlock)
 393
 394 #define bdb_cache_entryinfo_lock(e) \
 395         ldap_pvt_thread_mutex_lock( &(e)->bei_kids_mutex )
 396 #define bdb_cache_entryinfo_unlock(e) \
 397         ldap_pvt_thread_mutex_unlock( &(e)->bei_kids_mutex )
 398
 399 /* What a mess. Hopefully the current cache scheme will stabilize
 400  * and we can trim out all of this stuff.
 401  */
 402 #if 0
 403 void bdb_cache_return_entry_rw( DB_ENV *env, Cache *cache, Entry *e,
 404         int rw, DB_LOCK *lock );
 405 #else
 406 #define bdb_cache_return_entry_rw( env, cache, e, rw, lock ) \
 407         bdb_cache_entry_db_unlock( env, lock )
 408 #define bdb_cache_return_entry( env, lock ) \
 409         bdb_cache_entry_db_unlock( env, lock )
 410 #endif
 411 #define bdb_cache_return_entry_r(env, c, e, l) \
 412         bdb_cache_return_entry_rw((env), (c), (e), 0, (l))
 413 #define bdb_cache_return_entry_w(env, c, e, l) \
 414         bdb_cache_return_entry_rw((env), (c), (e), 1, (l))
 415 #if 0
 416 void bdb_unlocked_cache_return_entry_rw( Cache *cache, Entry *e, int rw );
 417 #else
 418 #define bdb_unlocked_cache_return_entry_rw( a, b, c )
 419 #endif
 420 #define bdb_unlocked_cache_return_entry_r( c, e ) \
 421         bdb_unlocked_cache_return_entry_rw((c), (e), 0)
 422 #define bdb_unlocked_cache_return_entry_w( c, e ) \
 423         bdb_unlocked_cache_return_entry_rw((c), (e), 1)
 424
 425 #define bdb_cache_add                           BDB_SYMBOL(cache_add)
 426 #define bdb_cache_children                      BDB_SYMBOL(cache_children)
 427 #define bdb_cache_delete                        BDB_SYMBOL(cache_delete)
 428 #define bdb_cache_delete_cleanup                BDB_SYMBOL(cache_delete_cleanup)
 429 #define bdb_cache_find_id                       BDB_SYMBOL(cache_find_id)
 430 #define bdb_cache_find_info                     BDB_SYMBOL(cache_find_info)
 431 #define bdb_cache_find_ndn                      BDB_SYMBOL(cache_find_ndn)
 432 #define bdb_cache_modify                        BDB_SYMBOL(cache_modify)
 433 #define bdb_cache_modrdn                        BDB_SYMBOL(cache_modrdn)
 434 #define bdb_cache_release_all           BDB_SYMBOL(cache_release_all)
 435 #define bdb_cache_delete_entry          BDB_SYMBOL(cache_delete_entry)
 436
 437 int bdb_cache_children(
 438         Operation *op,
 439         DB_TXN *txn,
 440         Entry *e
 441 );
 442 int bdb_cache_add(
 443         struct bdb_info *bdb,
 444         EntryInfo *pei,
 445         Entry   *e,
 446         struct berval *nrdn,
 447         u_int32_t locker
 448 );
 449 int bdb_cache_modrdn(
 450         Entry   *e,
 451         struct berval *nrdn,
 452         Entry   *new,
 453         EntryInfo *ein,
 454         DB_ENV *env,
 455         u_int32_t locker,
 456         DB_LOCK *lock
 457 );
 458 int bdb_cache_modify(
 459         Entry *e,
 460         Attribute *newAttrs,
 461         DB_ENV *env,
 462         u_int32_t locker,
 463         DB_LOCK *lock
 464 );
 465 int bdb_cache_find_ndn(
 466         Operation *op,
 467         DB_TXN  *txn,
 468         struct berval   *ndn,
 469         EntryInfo       **res
 470 );
 471 EntryInfo * bdb_cache_find_info(
 472         struct bdb_info *bdb,
 473         ID id
 474 );
 475 int bdb_cache_find_id(
 476         Operation *op,
 477         DB_TXN  *tid,
 478         ID              id,
 479         EntryInfo **eip,
 480         int     islocked,
 481         u_int32_t       locker,
 482         DB_LOCK         *lock
 483 );
 484 int bdb_cache_delete(
 485         Cache   *cache,
 486         Entry   *e,
 487         DB_ENV  *env,
 488         u_int32_t locker,
 489         DB_LOCK *lock
 490 );
 491 void bdb_cache_delete_cleanup(
 492         Cache   *cache,
 493         EntryInfo *ei
 494 );
 495 void bdb_cache_release_all( Cache *cache );
 496 void bdb_cache_delete_entry(
 497         struct bdb_info *bdb,
 498         EntryInfo *ei,
 499         u_int32_t locker,
 500         DB_LOCK *lock
 501 );
 502
 503 #ifdef BDB_HIER
 504 int hdb_cache_load(
 505         struct bdb_info *bdb,
 506         EntryInfo *ei,
 507         EntryInfo **res
 508 );
 509 #endif
 510
 511 #define bdb_cache_entry_db_relock               BDB_SYMBOL(cache_entry_db_relock)
 512 int bdb_cache_entry_db_relock(
 513         DB_ENV *env,
 514         u_int32_t locker,
 515         EntryInfo *ei,
 516         int rw,
 517         int tryOnly,
 518         DB_LOCK *lock );
 519
 520 int bdb_cache_entry_db_unlock(
 521         DB_ENV *env,
 522         DB_LOCK *lock );
 523
 524 #ifdef BDB_REUSE_LOCKERS
 525
 526 #define bdb_locker_id                           BDB_SYMBOL(locker_id)
 527 int bdb_locker_id( Operation *op, DB_ENV *env, int *locker );
 528
 529 #define LOCK_ID_FREE(env, locker)
 530 #define LOCK_ID(env, locker)    bdb_locker_id(op, env, locker)
 531
 532 #else
 533
 534 #define LOCK_ID_FREE(env, locker)       XLOCK_ID_FREE(env, locker)
 535 #define LOCK_ID(env, locker)            XLOCK_ID(env, locker)
 536
 537 #endif
 538
 539 /*
 540  * search.c
 541  */
 542
 543 #define bdb_abandon                                     BDB_SYMBOL(abandon)
 544 #define bdb_cancel                                      BDB_SYMBOL(cancel)
 545 #define bdb_do_search                           BDB_SYMBOL(do_search)
 546 #define bdb_psearch                             BDB_SYMBOL(psearch)
 547
 548 BI_op_abandon bdb_abandon;
 549 BI_op_cancel bdb_cancel;
 550
 551 int bdb_psearch(
 552         Operation       *op,
 553         SlapReply       *rs,
 554         Operation       *ps_op,
 555         Entry           *entry,
 556         int             psearch_type
 557 );
 558
 559 int bdb_do_search(
 560         Operation       *op,
 561         SlapReply       *rs,
 562         Operation       *ps_op,
 563         Entry           *entry,
 564         int             psearch_type
 565 );
 566
 567 /*
 568  * trans.c
 569  */
 570 #define bdb_trans_backoff                       BDB_SYMBOL(trans_backoff)
 571
 572 void
 573 bdb_trans_backoff( int num_retries );
 574
 575 LDAP_END_DECL
 576
 577 #endif /* _PROTO_BDB_H */