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-2005 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 #define BDB_UCTYPE      "HDB"
  24 #else
  25 #define BDB_SYMBOL(x)   LDAP_CONCAT(bdb_,x)
  26 #define BDB_UCTYPE      "BDB"
  27 #endif
  28
  29 /*
  30  * attr.c
  31  */
  32
  33 #define bdb_attr_mask                           BDB_SYMBOL(attr_mask)
  34 #define bdb_attr_flush                          BDB_SYMBOL(attr_flush)
  35 #define bdb_attr_index_config           BDB_SYMBOL(attr_index_config)
  36 #define bdb_attr_index_destroy          BDB_SYMBOL(attr_index_destroy)
  37 #define bdb_attr_index_free                     BDB_SYMBOL(attr_index_free)
  38 #define bdb_attr_index_unparse          BDB_SYMBOL(attr_index_unparse)
  39
  40 AttrInfo *bdb_attr_mask( struct bdb_info *bdb,
  41         AttributeDescription *desc );
  42
  43 void bdb_attr_flush( struct bdb_info *bdb );
  44
  45 int bdb_attr_index_config LDAP_P(( struct bdb_info *bdb,
  46         const char *fname, int lineno,
  47         int argc, char **argv ));
  48
  49 void bdb_attr_index_unparse LDAP_P(( struct bdb_info *bdb, BerVarray *bva ));
  50 void bdb_attr_index_destroy LDAP_P(( Avlnode *tree ));
  51 void bdb_attr_index_free LDAP_P(( struct bdb_info *bdb,
  52         AttributeDescription *ad ));
  53
  54 /*
  55  * config.c
  56  */
  57
  58 #define bdb_back_init_cf                                BDB_SYMBOL(back_init_cf)
  59
  60 int bdb_back_init_cf( BackendInfo *bi );
  61
  62 /*
  63  * dbcache.c
  64  */
  65 #define bdb_db_cache                            BDB_SYMBOL(db_cache)
  66
  67 int
  68 bdb_db_cache(
  69     Backend     *be,
  70     const char *name,
  71         DB **db );
  72
  73 /*
  74  * dn2entry.c
  75  */
  76 #define bdb_dn2entry                            BDB_SYMBOL(dn2entry)
  77
  78 int bdb_dn2entry LDAP_P(( Operation *op, DB_TXN *tid,
  79         struct berval *dn, EntryInfo **e, int matched,
  80         u_int32_t locker, DB_LOCK *lock ));
  81
  82 /*
  83  * dn2id.c
  84  */
  85 #define bdb_dn2id                                       BDB_SYMBOL(dn2id)
  86 #define bdb_dn2id_add                           BDB_SYMBOL(dn2id_add)
  87 #define bdb_dn2id_delete                        BDB_SYMBOL(dn2id_delete)
  88 #define bdb_dn2id_children                      BDB_SYMBOL(dn2id_children)
  89 #define bdb_dn2idl                                      BDB_SYMBOL(dn2idl)
  90
  91 int bdb_dn2id(
  92         Operation *op,
  93         DB_TXN *tid,
  94         struct berval *dn,
  95         EntryInfo *ei );
  96
  97 int bdb_dn2id_add(
  98         Operation *op,
  99         DB_TXN *tid,
 100         EntryInfo *eip,
 101         Entry *e );
 102
 103 int bdb_dn2id_delete(
 104         Operation *op,
 105         DB_TXN *tid,
 106         EntryInfo *eip,
 107         Entry *e );
 108
 109 int bdb_dn2id_children(
 110         Operation *op,
 111         DB_TXN *tid,
 112         Entry *e );
 113
 114 int bdb_dn2idl(
 115         Operation *op,
 116         Entry *e,
 117         ID *ids,
 118         ID *stack );
 119
 120 #ifdef BDB_HIER
 121 #define bdb_dn2id_parent                        BDB_SYMBOL(dn2id_parent)
 122 #define bdb_fix_dn                                      BDB_SYMBOL(fix_dn)
 123
 124 int bdb_dn2id_parent(
 125         Operation *op,
 126         DB_TXN *txn,
 127         EntryInfo *ei,
 128         ID *idp );
 129
 130 int bdb_fix_dn( Entry *e, int checkit );
 131 #endif
 132
 133
 134 /*
 135  * error.c
 136  */
 137 #define bdb_errcall                                     BDB_SYMBOL(errcall)
 138
 139 #if DB_VERSION_FULL < 0x04030000
 140 void bdb_errcall( const char *pfx, char * msg );
 141 #else
 142 #define bdb_msgcall                                     BDB_SYMBOL(msgcall)
 143 void bdb_errcall( const DB_ENV *env, const char *pfx, const char * msg );
 144 void bdb_msgcall( const DB_ENV *env, const char * msg );
 145 #endif
 146
 147 #ifdef HAVE_EBCDIC
 148 #define ebcdic_dberror                          BDB_SYMBOL(ebcdic_dberror)
 149
 150 char *ebcdic_dberror( int rc );
 151 #define db_strerror(x)  ebcdic_dberror(x)
 152 #endif
 153
 154 /*
 155  * filterentry.c
 156  */
 157 #define bdb_filter_candidates           BDB_SYMBOL(filter_candidates)
 158
 159 int bdb_filter_candidates(
 160         Operation *op,
 161         Filter  *f,
 162         ID *ids,
 163         ID *tmp,
 164         ID *stack );
 165
 166 /*
 167  * id2entry.c
 168  */
 169 #define bdb_id2entry                            BDB_SYMBOL(id2entry)
 170 #define bdb_id2entry_add                        BDB_SYMBOL(id2entry_add)
 171 #define bdb_id2entry_update                     BDB_SYMBOL(id2entry_update)
 172 #define bdb_id2entry_delete                     BDB_SYMBOL(id2entry_delete)
 173
 174 int bdb_id2entry_add(
 175         BackendDB *be,
 176         DB_TXN *tid,
 177         Entry *e );
 178
 179 int bdb_id2entry_update(
 180         BackendDB *be,
 181         DB_TXN *tid,
 182         Entry *e );
 183
 184 int bdb_id2entry_delete(
 185         BackendDB *be,
 186         DB_TXN *tid,
 187         Entry *e);
 188
 189 #ifdef SLAP_ZONE_ALLOC
 190 #else
 191 int bdb_id2entry(
 192         BackendDB *be,
 193         DB_TXN *tid,
 194         ID id,
 195         Entry **e);
 196 #endif
 197
 198 #define bdb_entry_free                          BDB_SYMBOL(entry_free)
 199 #define bdb_entry_return                        BDB_SYMBOL(entry_return)
 200 #define bdb_entry_release                       BDB_SYMBOL(entry_release)
 201 #define bdb_entry_get                           BDB_SYMBOL(entry_get)
 202
 203 void bdb_entry_free ( Entry *e );
 204 #ifdef SLAP_ZONE_ALLOC
 205 int bdb_entry_return( struct bdb_info *bdb, Entry *e, int seqno );
 206 #else
 207 int bdb_entry_return( Entry *e );
 208 #endif
 209 BI_entry_release_rw bdb_entry_release;
 210 BI_entry_get_rw bdb_entry_get;
 211
 212
 213 /*
 214  * idl.c
 215  */
 216
 217 #define bdb_idl_cache_get                       BDB_SYMBOL(idl_cache_get)
 218 #define bdb_idl_cache_put                       BDB_SYMBOL(idl_cache_put)
 219 #define bdb_idl_cache_del                       BDB_SYMBOL(idl_cache_del)
 220 #define bdb_idl_cache_add_id            BDB_SYMBOL(idl_cache_add_id)
 221 #define bdb_idl_cache_del_id            BDB_SYMBOL(idl_cache_del_id)
 222
 223 int bdb_idl_cache_get(
 224         struct bdb_info *bdb,
 225         DB *db,
 226         DBT *key,
 227         ID *ids );
 228
 229 void
 230 bdb_idl_cache_put(
 231         struct bdb_info *bdb,
 232         DB              *db,
 233         DBT             *key,
 234         ID              *ids,
 235         int             rc );
 236
 237 void
 238 bdb_idl_cache_del(
 239         struct bdb_info *bdb,
 240         DB              *db,
 241         DBT             *key );
 242
 243 void
 244 bdb_idl_cache_add_id(
 245         struct bdb_info *bdb,
 246         DB              *db,
 247         DBT             *key,
 248         ID              id );
 249
 250 void
 251 bdb_idl_cache_del_id(
 252         struct bdb_info *bdb,
 253         DB              *db,
 254         DBT             *key,
 255         ID              id );
 256
 257 #define bdb_idl_first                           BDB_SYMBOL(idl_first)
 258 #define bdb_idl_next                            BDB_SYMBOL(idl_next)
 259 #define bdb_idl_search                          BDB_SYMBOL(idl_search)
 260 #define bdb_idl_insert                          BDB_SYMBOL(idl_insert)
 261 #define bdb_idl_intersection            BDB_SYMBOL(idl_intersection)
 262 #define bdb_idl_union                           BDB_SYMBOL(idl_union)
 263 #define bdb_idl_sort                            BDB_SYMBOL(idl_sort)
 264 #define bdb_idl_append                          BDB_SYMBOL(idl_append)
 265 #define bdb_idl_append_one                      BDB_SYMBOL(idl_append_one)
 266
 267 #define bdb_idl_fetch_key                       BDB_SYMBOL(idl_fetch_key)
 268 #define bdb_idl_insert_key                      BDB_SYMBOL(idl_insert_key)
 269 #define bdb_idl_delete_key                      BDB_SYMBOL(idl_delete_key)
 270
 271 unsigned bdb_idl_search( ID *ids, ID id );
 272
 273 int bdb_idl_fetch_key(
 274         BackendDB       *be,
 275         DB                      *db,
 276         DB_TXN          *tid,
 277         DBT                     *key,
 278         ID                      *ids,
 279         DBC                     **saved_cursor,
 280         int                     get_flag );
 281
 282 int bdb_idl_insert( ID *ids, ID id );
 283
 284 int bdb_idl_insert_key(
 285         BackendDB *be,
 286         DB *db,
 287         DB_TXN *txn,
 288         DBT *key,
 289         ID id );
 290
 291 int bdb_idl_delete_key(
 292         BackendDB *be,
 293         DB *db,
 294         DB_TXN *txn,
 295         DBT *key,
 296         ID id );
 297
 298 int
 299 bdb_idl_intersection(
 300         ID *a,
 301         ID *b );
 302
 303 int
 304 bdb_idl_union(
 305         ID *a,
 306         ID *b );
 307
 308 ID bdb_idl_first( ID *ids, ID *cursor );
 309 ID bdb_idl_next( ID *ids, ID *cursor );
 310
 311 void bdb_idl_sort( ID *ids, ID *tmp );
 312 int bdb_idl_append( ID *a, ID *b );
 313 int bdb_idl_append_one( ID *ids, ID id );
 314
 315
 316 /*
 317  * index.c
 318  */
 319 #define bdb_index_is_indexed            BDB_SYMBOL(index_is_indexed)
 320 #define bdb_index_param                         BDB_SYMBOL(index_param)
 321 #define bdb_index_values                        BDB_SYMBOL(index_values)
 322 #define bdb_index_entry                         BDB_SYMBOL(index_entry)
 323
 324 extern int
 325 bdb_index_is_indexed LDAP_P((
 326         Backend *be,
 327         AttributeDescription *desc ));
 328
 329 extern int
 330 bdb_index_param LDAP_P((
 331         Backend *be,
 332         AttributeDescription *desc,
 333         int ftype,
 334         DB **db,
 335         slap_mask_t *mask,
 336         struct berval *prefix ));
 337
 338 extern int
 339 bdb_index_values LDAP_P((
 340         Operation *op,
 341         DB_TXN *txn,
 342         AttributeDescription *desc,
 343         BerVarray vals,
 344         ID id,
 345         int opid ));
 346
 347 int bdb_index_entry LDAP_P(( Operation *op, DB_TXN *t, int r, Entry *e ));
 348
 349 #define bdb_index_entry_add(op,t,e) \
 350         bdb_index_entry((op),(t),SLAP_INDEX_ADD_OP,(e))
 351 #define bdb_index_entry_del(op,t,e) \
 352         bdb_index_entry((op),(t),SLAP_INDEX_DELETE_OP,(e))
 353
 354 /*
 355  * key.c
 356  */
 357 #define bdb_key_read                            BDB_SYMBOL(key_read)
 358 #define bdb_key_change                          BDB_SYMBOL(key_change)
 359
 360 extern int
 361 bdb_key_read(
 362     Backend     *be,
 363         DB *db,
 364         DB_TXN *txn,
 365     struct berval *k,
 366         ID *ids,
 367     DBC **saved_cursor,
 368         int get_flags );
 369
 370 extern int
 371 bdb_key_change(
 372     Backend      *be,
 373     DB *db,
 374         DB_TXN *txn,
 375     struct berval *k,
 376     ID id,
 377     int op );
 378
 379 /*
 380  * nextid.c
 381  */
 382 #define bdb_next_id                                     BDB_SYMBOL(next_id)
 383 #define bdb_last_id                                     BDB_SYMBOL(last_id)
 384
 385 int bdb_next_id( BackendDB *be, DB_TXN *tid, ID *id );
 386 int bdb_last_id( BackendDB *be, DB_TXN *tid );
 387
 388 /*
 389  * modify.c
 390  */
 391 #define bdb_modify_internal                     BDB_SYMBOL(modify_internal)
 392
 393 int bdb_modify_internal(
 394         Operation *op,
 395         DB_TXN *tid,
 396         Modifications *modlist,
 397         Entry *e,
 398         const char **text,
 399         char *textbuf,
 400         size_t textlen );
 401
 402
 403 /*
 404  * cache.c
 405  */
 406 #define bdb_cache_entry_db_unlock       BDB_SYMBOL(cache_entry_db_unlock)
 407
 408 #define bdb_cache_entryinfo_lock(e) \
 409         ldap_pvt_thread_mutex_lock( &(e)->bei_kids_mutex )
 410 #define bdb_cache_entryinfo_unlock(e) \
 411         ldap_pvt_thread_mutex_unlock( &(e)->bei_kids_mutex )
 412
 413 /* What a mess. Hopefully the current cache scheme will stabilize
 414  * and we can trim out all of this stuff.
 415  */
 416 #if 0
 417 void bdb_cache_return_entry_rw( DB_ENV *env, Cache *cache, Entry *e,
 418         int rw, DB_LOCK *lock );
 419 #else
 420 #define bdb_cache_return_entry_rw( env, cache, e, rw, lock ) \
 421         bdb_cache_entry_db_unlock( env, lock )
 422 #define bdb_cache_return_entry( env, lock ) \
 423         bdb_cache_entry_db_unlock( env, lock )
 424 #endif
 425 #define bdb_cache_return_entry_r(env, c, e, l) \
 426         bdb_cache_return_entry_rw((env), (c), (e), 0, (l))
 427 #define bdb_cache_return_entry_w(env, c, e, l) \
 428         bdb_cache_return_entry_rw((env), (c), (e), 1, (l))
 429 #if 0
 430 void bdb_unlocked_cache_return_entry_rw( Cache *cache, Entry *e, int rw );
 431 #else
 432 #define bdb_unlocked_cache_return_entry_rw( a, b, c )   ((void)0)
 433 #endif
 434 #define bdb_unlocked_cache_return_entry_r( c, e ) \
 435         bdb_unlocked_cache_return_entry_rw((c), (e), 0)
 436 #define bdb_unlocked_cache_return_entry_w( c, e ) \
 437         bdb_unlocked_cache_return_entry_rw((c), (e), 1)
 438
 439 #define bdb_cache_add                           BDB_SYMBOL(cache_add)
 440 #define bdb_cache_children                      BDB_SYMBOL(cache_children)
 441 #define bdb_cache_delete                        BDB_SYMBOL(cache_delete)
 442 #define bdb_cache_delete_cleanup        BDB_SYMBOL(cache_delete_cleanup)
 443 #define bdb_cache_find_id                       BDB_SYMBOL(cache_find_id)
 444 #define bdb_cache_find_info                     BDB_SYMBOL(cache_find_info)
 445 #define bdb_cache_find_ndn                      BDB_SYMBOL(cache_find_ndn)
 446 #define bdb_cache_find_parent           BDB_SYMBOL(cache_find_parent)
 447 #define bdb_cache_modify                        BDB_SYMBOL(cache_modify)
 448 #define bdb_cache_modrdn                        BDB_SYMBOL(cache_modrdn)
 449 #define bdb_cache_release_all           BDB_SYMBOL(cache_release_all)
 450 #define bdb_cache_delete_entry          BDB_SYMBOL(cache_delete_entry)
 451
 452 int bdb_cache_children(
 453         Operation *op,
 454         DB_TXN *txn,
 455         Entry *e
 456 );
 457 int bdb_cache_add(
 458         struct bdb_info *bdb,
 459         EntryInfo *pei,
 460         Entry   *e,
 461         struct berval *nrdn,
 462         u_int32_t locker
 463 );
 464 int bdb_cache_modrdn(
 465         struct bdb_info *bdb,
 466         Entry   *e,
 467         struct berval *nrdn,
 468         Entry   *new,
 469         EntryInfo *ein,
 470         u_int32_t locker,
 471         DB_LOCK *lock
 472 );
 473 int bdb_cache_modify(
 474         Entry *e,
 475         Attribute *newAttrs,
 476         DB_ENV *env,
 477         u_int32_t locker,
 478         DB_LOCK *lock
 479 );
 480 int bdb_cache_find_ndn(
 481         Operation *op,
 482         DB_TXN  *txn,
 483         struct berval   *ndn,
 484         EntryInfo       **res
 485 );
 486 EntryInfo * bdb_cache_find_info(
 487         struct bdb_info *bdb,
 488         ID id
 489 );
 490 int bdb_cache_find_id(
 491         Operation *op,
 492         DB_TXN  *tid,
 493         ID              id,
 494         EntryInfo **eip,
 495         int     islocked,
 496         u_int32_t       locker,
 497         DB_LOCK         *lock
 498 );
 499 int
 500 bdb_cache_find_parent(
 501         Operation *op,
 502         DB_TXN *txn,
 503         ID id,
 504         EntryInfo **res
 505 );
 506 int bdb_cache_delete(
 507         Cache   *cache,
 508         Entry   *e,
 509         DB_ENV  *env,
 510         u_int32_t locker,
 511         DB_LOCK *lock
 512 );
 513 void bdb_cache_delete_cleanup(
 514         Cache   *cache,
 515         EntryInfo *ei
 516 );
 517 void bdb_cache_release_all( Cache *cache );
 518 void bdb_cache_delete_entry(
 519         struct bdb_info *bdb,
 520         EntryInfo *ei,
 521         u_int32_t locker,
 522         DB_LOCK *lock
 523 );
 524
 525 #ifdef BDB_HIER
 526 int hdb_cache_load(
 527         struct bdb_info *bdb,
 528         EntryInfo *ei,
 529         EntryInfo **res
 530 );
 531 #endif
 532
 533 #define bdb_cache_entry_db_relock               BDB_SYMBOL(cache_entry_db_relock)
 534 int bdb_cache_entry_db_relock(
 535         DB_ENV *env,
 536         u_int32_t locker,
 537         EntryInfo *ei,
 538         int rw,
 539         int tryOnly,
 540         DB_LOCK *lock );
 541
 542 int bdb_cache_entry_db_unlock(
 543         DB_ENV *env,
 544         DB_LOCK *lock );
 545
 546 #ifdef BDB_REUSE_LOCKERS
 547
 548 #define bdb_locker_id                           BDB_SYMBOL(locker_id)
 549 int bdb_locker_id( Operation *op, DB_ENV *env, u_int32_t *locker );
 550
 551 #define LOCK_ID_FREE(env, locker)       ((void)0)
 552 #define LOCK_ID(env, locker)    bdb_locker_id(op, env, locker)
 553
 554 #else
 555
 556 #define LOCK_ID_FREE(env, locker)       XLOCK_ID_FREE(env, locker)
 557 #define LOCK_ID(env, locker)            XLOCK_ID(env, locker)
 558
 559 #endif
 560
 561 /*
 562  * trans.c
 563  */
 564 #define bdb_trans_backoff                       BDB_SYMBOL(trans_backoff)
 565
 566 void
 567 bdb_trans_backoff( int num_retries );
 568
 569 /*
 570  * former external.h
 571  */
 572
 573 #define bdb_back_initialize             BDB_SYMBOL(back_initialize)
 574 #define bdb_db_config                   BDB_SYMBOL(db_config)
 575 #define bdb_add                         BDB_SYMBOL(add)
 576 #define bdb_bind                        BDB_SYMBOL(bind)
 577 #define bdb_compare                     BDB_SYMBOL(compare)
 578 #define bdb_delete                      BDB_SYMBOL(delete)
 579 #define bdb_modify                      BDB_SYMBOL(modify)
 580 #define bdb_modrdn                      BDB_SYMBOL(modrdn)
 581 #define bdb_search                      BDB_SYMBOL(search)
 582 #define bdb_extended                    BDB_SYMBOL(extended)
 583 #define bdb_referrals                   BDB_SYMBOL(referrals)
 584 #define bdb_operational                 BDB_SYMBOL(operational)
 585 #define bdb_hasSubordinates             BDB_SYMBOL(hasSubordinates)
 586 #define bdb_tool_entry_open             BDB_SYMBOL(tool_entry_open)
 587 #define bdb_tool_entry_close            BDB_SYMBOL(tool_entry_close)
 588 #define bdb_tool_entry_next             BDB_SYMBOL(tool_entry_next)
 589 #define bdb_tool_entry_get              BDB_SYMBOL(tool_entry_get)
 590 #define bdb_tool_entry_put              BDB_SYMBOL(tool_entry_put)
 591 #define bdb_tool_entry_reindex          BDB_SYMBOL(tool_entry_reindex)
 592 #define bdb_tool_dn2id_get              BDB_SYMBOL(tool_dn2id_get)
 593 #define bdb_tool_id2entry_get           BDB_SYMBOL(tool_id2entry_get)
 594 #define bdb_tool_entry_modify           BDB_SYMBOL(tool_entry_modify)
 595
 596 extern BI_init                          bdb_back_initialize;
 597
 598 extern BI_db_config                     bdb_db_config;
 599
 600 extern BI_op_add                        bdb_add;
 601 extern BI_op_bind                       bdb_bind;
 602 extern BI_op_compare                    bdb_compare;
 603 extern BI_op_delete                     bdb_delete;
 604 extern BI_op_modify                     bdb_modify;
 605 extern BI_op_modrdn                     bdb_modrdn;
 606 extern BI_op_search                     bdb_search;
 607 extern BI_op_extended                   bdb_extended;
 608
 609 extern BI_chk_referrals                 bdb_referrals;
 610
 611 extern BI_operational                   bdb_operational;
 612
 613 extern BI_has_subordinates              bdb_hasSubordinates;
 614
 615 /* tools.c */
 616 extern BI_tool_entry_open               bdb_tool_entry_open;
 617 extern BI_tool_entry_close              bdb_tool_entry_close;
 618 extern BI_tool_entry_next               bdb_tool_entry_next;
 619 extern BI_tool_entry_get                bdb_tool_entry_get;
 620 extern BI_tool_entry_put                bdb_tool_entry_put;
 621 extern BI_tool_entry_reindex            bdb_tool_entry_reindex;
 622 extern BI_tool_dn2id_get                bdb_tool_dn2id_get;
 623 extern BI_tool_id2entry_get             bdb_tool_id2entry_get;
 624 extern BI_tool_entry_modify             bdb_tool_entry_modify;
 625
 626 LDAP_END_DECL
 627
 628 #endif /* _PROTO_BDB_H */