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         u_int32_t locker,
 128         EntryInfo *ei,
 129         ID *idp );
 130
 131 int bdb_fix_dn( Entry *e, int checkit );
 132 #endif
 133
 134
 135 /*
 136  * error.c
 137  */
 138 #define bdb_errcall                                     BDB_SYMBOL(errcall)
 139
 140 #if DB_VERSION_FULL < 0x04030000
 141 void bdb_errcall( const char *pfx, char * msg );
 142 #else
 143 #define bdb_msgcall                                     BDB_SYMBOL(msgcall)
 144 void bdb_errcall( const DB_ENV *env, const char *pfx, const char * msg );
 145 void bdb_msgcall( const DB_ENV *env, 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 #ifdef SLAP_ZONE_ALLOC
 191 #else
 192 int bdb_id2entry(
 193         BackendDB *be,
 194         DB_TXN *tid,
 195         u_int32_t locker,
 196         ID id,
 197         Entry **e);
 198 #endif
 199
 200 #define bdb_entry_free                          BDB_SYMBOL(entry_free)
 201 #define bdb_entry_return                        BDB_SYMBOL(entry_return)
 202 #define bdb_entry_release                       BDB_SYMBOL(entry_release)
 203 #define bdb_entry_get                           BDB_SYMBOL(entry_get)
 204
 205 void bdb_entry_free ( Entry *e );
 206 #ifdef SLAP_ZONE_ALLOC
 207 int bdb_entry_return( struct bdb_info *bdb, Entry *e, int seqno );
 208 #else
 209 int bdb_entry_return( Entry *e );
 210 #endif
 211 BI_entry_release_rw bdb_entry_release;
 212 BI_entry_get_rw bdb_entry_get;
 213
 214
 215 /*
 216  * idl.c
 217  */
 218
 219 #define bdb_idl_cache_get                       BDB_SYMBOL(idl_cache_get)
 220 #define bdb_idl_cache_put                       BDB_SYMBOL(idl_cache_put)
 221 #define bdb_idl_cache_del                       BDB_SYMBOL(idl_cache_del)
 222 #define bdb_idl_cache_add_id            BDB_SYMBOL(idl_cache_add_id)
 223 #define bdb_idl_cache_del_id            BDB_SYMBOL(idl_cache_del_id)
 224
 225 int bdb_idl_cache_get(
 226         struct bdb_info *bdb,
 227         DB *db,
 228         DBT *key,
 229         ID *ids );
 230
 231 void
 232 bdb_idl_cache_put(
 233         struct bdb_info *bdb,
 234         DB              *db,
 235         DBT             *key,
 236         ID              *ids,
 237         int             rc );
 238
 239 void
 240 bdb_idl_cache_del(
 241         struct bdb_info *bdb,
 242         DB              *db,
 243         DBT             *key );
 244
 245 void
 246 bdb_idl_cache_add_id(
 247         struct bdb_info *bdb,
 248         DB              *db,
 249         DBT             *key,
 250         ID              id );
 251
 252 void
 253 bdb_idl_cache_del_id(
 254         struct bdb_info *bdb,
 255         DB              *db,
 256         DBT             *key,
 257         ID              id );
 258
 259 #define bdb_idl_first                           BDB_SYMBOL(idl_first)
 260 #define bdb_idl_next                            BDB_SYMBOL(idl_next)
 261 #define bdb_idl_search                          BDB_SYMBOL(idl_search)
 262 #define bdb_idl_insert                          BDB_SYMBOL(idl_insert)
 263 #define bdb_idl_intersection            BDB_SYMBOL(idl_intersection)
 264 #define bdb_idl_union                           BDB_SYMBOL(idl_union)
 265 #define bdb_idl_sort                            BDB_SYMBOL(idl_sort)
 266 #define bdb_idl_append                          BDB_SYMBOL(idl_append)
 267 #define bdb_idl_append_one                      BDB_SYMBOL(idl_append_one)
 268
 269 #define bdb_idl_fetch_key                       BDB_SYMBOL(idl_fetch_key)
 270 #define bdb_idl_insert_key                      BDB_SYMBOL(idl_insert_key)
 271 #define bdb_idl_delete_key                      BDB_SYMBOL(idl_delete_key)
 272
 273 unsigned bdb_idl_search( ID *ids, ID id );
 274
 275 int bdb_idl_fetch_key(
 276         BackendDB       *be,
 277         DB                      *db,
 278         DB_TXN          *tid,
 279         DBT                     *key,
 280         ID                      *ids,
 281         DBC                     **saved_cursor,
 282         int                     get_flag );
 283
 284 int bdb_idl_insert( ID *ids, ID id );
 285
 286 int bdb_idl_insert_key(
 287         BackendDB *be,
 288         DB *db,
 289         DB_TXN *txn,
 290         DBT *key,
 291         ID id );
 292
 293 int bdb_idl_delete_key(
 294         BackendDB *be,
 295         DB *db,
 296         DB_TXN *txn,
 297         DBT *key,
 298         ID id );
 299
 300 int
 301 bdb_idl_intersection(
 302         ID *a,
 303         ID *b );
 304
 305 int
 306 bdb_idl_union(
 307         ID *a,
 308         ID *b );
 309
 310 ID bdb_idl_first( ID *ids, ID *cursor );
 311 ID bdb_idl_next( ID *ids, ID *cursor );
 312
 313 void bdb_idl_sort( ID *ids, ID *tmp );
 314 int bdb_idl_append( ID *a, ID *b );
 315 int bdb_idl_append_one( ID *ids, ID id );
 316
 317
 318 /*
 319  * index.c
 320  */
 321 #define bdb_index_is_indexed            BDB_SYMBOL(index_is_indexed)
 322 #define bdb_index_param                         BDB_SYMBOL(index_param)
 323 #define bdb_index_values                        BDB_SYMBOL(index_values)
 324 #define bdb_index_entry                         BDB_SYMBOL(index_entry)
 325
 326 extern int
 327 bdb_index_is_indexed LDAP_P((
 328         Backend *be,
 329         AttributeDescription *desc ));
 330
 331 extern int
 332 bdb_index_param LDAP_P((
 333         Backend *be,
 334         AttributeDescription *desc,
 335         int ftype,
 336         DB **db,
 337         slap_mask_t *mask,
 338         struct berval *prefix ));
 339
 340 extern int
 341 bdb_index_values LDAP_P((
 342         Operation *op,
 343         DB_TXN *txn,
 344         AttributeDescription *desc,
 345         BerVarray vals,
 346         ID id,
 347         int opid ));
 348
 349 int bdb_index_entry LDAP_P(( Operation *op, DB_TXN *t, int r, Entry *e ));
 350
 351 #define bdb_index_entry_add(op,t,e) \
 352         bdb_index_entry((op),(t),SLAP_INDEX_ADD_OP,(e))
 353 #define bdb_index_entry_del(op,t,e) \
 354         bdb_index_entry((op),(t),SLAP_INDEX_DELETE_OP,(e))
 355
 356 /*
 357  * key.c
 358  */
 359 #define bdb_key_read                            BDB_SYMBOL(key_read)
 360 #define bdb_key_change                          BDB_SYMBOL(key_change)
 361
 362 extern int
 363 bdb_key_read(
 364     Backend     *be,
 365         DB *db,
 366         DB_TXN *txn,
 367     struct berval *k,
 368         ID *ids,
 369     DBC **saved_cursor,
 370         int get_flags );
 371
 372 extern int
 373 bdb_key_change(
 374     Backend      *be,
 375     DB *db,
 376         DB_TXN *txn,
 377     struct berval *k,
 378     ID id,
 379     int op );
 380
 381 /*
 382  * nextid.c
 383  */
 384 #define bdb_next_id                                     BDB_SYMBOL(next_id)
 385 #define bdb_last_id                                     BDB_SYMBOL(last_id)
 386
 387 int bdb_next_id( BackendDB *be, DB_TXN *tid, ID *id );
 388 int bdb_last_id( BackendDB *be, DB_TXN *tid );
 389
 390 /*
 391  * modify.c
 392  */
 393 #define bdb_modify_internal                     BDB_SYMBOL(modify_internal)
 394
 395 int bdb_modify_internal(
 396         Operation *op,
 397         DB_TXN *tid,
 398         Modifications *modlist,
 399         Entry *e,
 400         const char **text,
 401         char *textbuf,
 402         size_t textlen );
 403
 404
 405 /*
 406  * cache.c
 407  */
 408 #define bdb_cache_entry_db_unlock       BDB_SYMBOL(cache_entry_db_unlock)
 409
 410 #define bdb_cache_entryinfo_lock(e) \
 411         ldap_pvt_thread_mutex_lock( &(e)->bei_kids_mutex )
 412 #define bdb_cache_entryinfo_unlock(e) \
 413         ldap_pvt_thread_mutex_unlock( &(e)->bei_kids_mutex )
 414
 415 /* What a mess. Hopefully the current cache scheme will stabilize
 416  * and we can trim out all of this stuff.
 417  */
 418 #if 0
 419 void bdb_cache_return_entry_rw( DB_ENV *env, Cache *cache, Entry *e,
 420         int rw, DB_LOCK *lock );
 421 #else
 422 #define bdb_cache_return_entry_rw( env, cache, e, rw, lock ) \
 423         bdb_cache_entry_db_unlock( env, lock )
 424 #define bdb_cache_return_entry( env, lock ) \
 425         bdb_cache_entry_db_unlock( env, lock )
 426 #endif
 427 #define bdb_cache_return_entry_r(env, c, e, l) \
 428         bdb_cache_return_entry_rw((env), (c), (e), 0, (l))
 429 #define bdb_cache_return_entry_w(env, c, e, l) \
 430         bdb_cache_return_entry_rw((env), (c), (e), 1, (l))
 431 #if 0
 432 void bdb_unlocked_cache_return_entry_rw( Cache *cache, Entry *e, int rw );
 433 #else
 434 #define bdb_unlocked_cache_return_entry_rw( a, b, c )   ((void)0)
 435 #endif
 436 #define bdb_unlocked_cache_return_entry_r( c, e ) \
 437         bdb_unlocked_cache_return_entry_rw((c), (e), 0)
 438 #define bdb_unlocked_cache_return_entry_w( c, e ) \
 439         bdb_unlocked_cache_return_entry_rw((c), (e), 1)
 440
 441 #define bdb_cache_add                           BDB_SYMBOL(cache_add)
 442 #define bdb_cache_children                      BDB_SYMBOL(cache_children)
 443 #define bdb_cache_delete                        BDB_SYMBOL(cache_delete)
 444 #define bdb_cache_delete_cleanup        BDB_SYMBOL(cache_delete_cleanup)
 445 #define bdb_cache_find_id                       BDB_SYMBOL(cache_find_id)
 446 #define bdb_cache_find_info                     BDB_SYMBOL(cache_find_info)
 447 #define bdb_cache_find_ndn                      BDB_SYMBOL(cache_find_ndn)
 448 #define bdb_cache_find_parent           BDB_SYMBOL(cache_find_parent)
 449 #define bdb_cache_modify                        BDB_SYMBOL(cache_modify)
 450 #define bdb_cache_modrdn                        BDB_SYMBOL(cache_modrdn)
 451 #define bdb_cache_release_all           BDB_SYMBOL(cache_release_all)
 452 #define bdb_cache_delete_entry          BDB_SYMBOL(cache_delete_entry)
 453
 454 int bdb_cache_children(
 455         Operation *op,
 456         DB_TXN *txn,
 457         Entry *e
 458 );
 459 int bdb_cache_add(
 460         struct bdb_info *bdb,
 461         EntryInfo *pei,
 462         Entry   *e,
 463         struct berval *nrdn,
 464         u_int32_t locker
 465 );
 466 int bdb_cache_modrdn(
 467         struct bdb_info *bdb,
 468         Entry   *e,
 469         struct berval *nrdn,
 470         Entry   *new,
 471         EntryInfo *ein,
 472         u_int32_t locker,
 473         DB_LOCK *lock
 474 );
 475 int bdb_cache_modify(
 476         Entry *e,
 477         Attribute *newAttrs,
 478         DB_ENV *env,
 479         u_int32_t locker,
 480         DB_LOCK *lock
 481 );
 482 int bdb_cache_find_ndn(
 483         Operation *op,
 484         DB_TXN  *txn,
 485         struct berval   *ndn,
 486         EntryInfo       **res
 487 );
 488 EntryInfo * bdb_cache_find_info(
 489         struct bdb_info *bdb,
 490         ID id
 491 );
 492 int bdb_cache_find_id(
 493         Operation *op,
 494         DB_TXN  *tid,
 495         ID              id,
 496         EntryInfo **eip,
 497         int     islocked,
 498         u_int32_t       locker,
 499         DB_LOCK         *lock
 500 );
 501 int
 502 bdb_cache_find_parent(
 503         Operation *op,
 504         DB_TXN *txn,
 505         u_int32_t       locker,
 506         ID id,
 507         EntryInfo **res
 508 );
 509 int bdb_cache_delete(
 510         Cache   *cache,
 511         Entry   *e,
 512         DB_ENV  *env,
 513         u_int32_t locker,
 514         DB_LOCK *lock
 515 );
 516 void bdb_cache_delete_cleanup(
 517         Cache   *cache,
 518         EntryInfo *ei
 519 );
 520 void bdb_cache_release_all( Cache *cache );
 521 void bdb_cache_delete_entry(
 522         struct bdb_info *bdb,
 523         EntryInfo *ei,
 524         u_int32_t locker,
 525         DB_LOCK *lock
 526 );
 527
 528 #ifdef BDB_HIER
 529 int hdb_cache_load(
 530         struct bdb_info *bdb,
 531         EntryInfo *ei,
 532         EntryInfo **res
 533 );
 534 #endif
 535
 536 #define bdb_cache_entry_db_relock               BDB_SYMBOL(cache_entry_db_relock)
 537 int bdb_cache_entry_db_relock(
 538         DB_ENV *env,
 539         u_int32_t locker,
 540         EntryInfo *ei,
 541         int rw,
 542         int tryOnly,
 543         DB_LOCK *lock );
 544
 545 int bdb_cache_entry_db_unlock(
 546         DB_ENV *env,
 547         DB_LOCK *lock );
 548
 549 #ifdef BDB_REUSE_LOCKERS
 550
 551 #define bdb_locker_id                           BDB_SYMBOL(locker_id)
 552 int bdb_locker_id( Operation *op, DB_ENV *env, u_int32_t *locker );
 553
 554 #define LOCK_ID_FREE(env, locker)       ((void)0)
 555 #define LOCK_ID(env, locker)    bdb_locker_id(op, env, locker)
 556
 557 #else
 558
 559 #define LOCK_ID_FREE(env, locker)       XLOCK_ID_FREE(env, locker)
 560 #define LOCK_ID(env, locker)            XLOCK_ID(env, locker)
 561
 562 #endif
 563
 564 /*
 565  * trans.c
 566  */
 567 #define bdb_trans_backoff                       BDB_SYMBOL(trans_backoff)
 568
 569 void
 570 bdb_trans_backoff( int num_retries );
 571
 572 /*
 573  * former external.h
 574  */
 575
 576 #define bdb_back_initialize             BDB_SYMBOL(back_initialize)
 577 #define bdb_db_config                   BDB_SYMBOL(db_config)
 578 #define bdb_add                         BDB_SYMBOL(add)
 579 #define bdb_bind                        BDB_SYMBOL(bind)
 580 #define bdb_compare                     BDB_SYMBOL(compare)
 581 #define bdb_delete                      BDB_SYMBOL(delete)
 582 #define bdb_modify                      BDB_SYMBOL(modify)
 583 #define bdb_modrdn                      BDB_SYMBOL(modrdn)
 584 #define bdb_search                      BDB_SYMBOL(search)
 585 #define bdb_extended                    BDB_SYMBOL(extended)
 586 #define bdb_referrals                   BDB_SYMBOL(referrals)
 587 #define bdb_operational                 BDB_SYMBOL(operational)
 588 #define bdb_hasSubordinates             BDB_SYMBOL(hasSubordinates)
 589 #define bdb_tool_entry_open             BDB_SYMBOL(tool_entry_open)
 590 #define bdb_tool_entry_close            BDB_SYMBOL(tool_entry_close)
 591 #define bdb_tool_entry_next             BDB_SYMBOL(tool_entry_next)
 592 #define bdb_tool_entry_get              BDB_SYMBOL(tool_entry_get)
 593 #define bdb_tool_entry_put              BDB_SYMBOL(tool_entry_put)
 594 #define bdb_tool_entry_reindex          BDB_SYMBOL(tool_entry_reindex)
 595 #define bdb_tool_dn2id_get              BDB_SYMBOL(tool_dn2id_get)
 596 #define bdb_tool_id2entry_get           BDB_SYMBOL(tool_id2entry_get)
 597 #define bdb_tool_entry_modify           BDB_SYMBOL(tool_entry_modify)
 598
 599 extern BI_init                          bdb_back_initialize;
 600
 601 extern BI_db_config                     bdb_db_config;
 602
 603 extern BI_op_add                        bdb_add;
 604 extern BI_op_bind                       bdb_bind;
 605 extern BI_op_compare                    bdb_compare;
 606 extern BI_op_delete                     bdb_delete;
 607 extern BI_op_modify                     bdb_modify;
 608 extern BI_op_modrdn                     bdb_modrdn;
 609 extern BI_op_search                     bdb_search;
 610 extern BI_op_extended                   bdb_extended;
 611
 612 extern BI_chk_referrals                 bdb_referrals;
 613
 614 extern BI_operational                   bdb_operational;
 615
 616 extern BI_has_subordinates              bdb_hasSubordinates;
 617
 618 /* tools.c */
 619 extern BI_tool_entry_open               bdb_tool_entry_open;
 620 extern BI_tool_entry_close              bdb_tool_entry_close;
 621 extern BI_tool_entry_next               bdb_tool_entry_next;
 622 extern BI_tool_entry_get                bdb_tool_entry_get;
 623 extern BI_tool_entry_put                bdb_tool_entry_put;
 624 extern BI_tool_entry_reindex            bdb_tool_entry_reindex;
 625 extern BI_tool_dn2id_get                bdb_tool_dn2id_get;
 626 extern BI_tool_id2entry_get             bdb_tool_id2entry_get;
 627 extern BI_tool_entry_modify             bdb_tool_entry_modify;
 628
 629 LDAP_END_DECL
 630
 631 #endif /* _PROTO_BDB_H */