git.sur5r.net Git - openldap/blob - servers/slapd/back-bdb/back-bdb.h

   1 /* back-bdb.h - bdb back-end header file */
   2 /* $OpenLDAP$ */
   3 /*
   4  * Copyright 2000-2002 The OpenLDAP Foundation, All Rights Reserved.
   5  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
   6  */
   7
   8 #ifndef _BACK_BDB_H_
   9 #define _BACK_BDB_H_
  10
  11 #include <portable.h>
  12 #include <db.h>
  13
  14 #include "slap.h"
  15
  16 LDAP_BEGIN_DECL
  17
  18 /* #define BDB_HIER             1 */
  19
  20 #define DN_BASE_PREFIX          SLAP_INDEX_EQUALITY_PREFIX
  21 #define DN_ONE_PREFIX           '%'
  22 #define DN_SUBTREE_PREFIX       '@'
  23
  24 #define DBTzero(t)                      (memset((t), 0, sizeof(DBT)))
  25 #define DBT2bv(t,bv)            ((bv)->bv_val = (t)->data, \
  26                                                                 (bv)->bv_len = (t)->size)
  27 #define bv2DBT(bv,t)            ((t)->data = (bv)->bv_val, \
  28                                                                 (t)->size = (bv)->bv_len )
  29
  30 #define BDB_TXN_RETRIES         16
  31
  32 #define BDB_MAX_ADD_LOOP        30
  33
  34 #ifdef BDB_SUBDIRS
  35 #define BDB_TMP_SUBDIR  LDAP_DIRSEP "tmp"
  36 #define BDB_LG_SUBDIR   LDAP_DIRSEP "log"
  37 #define BDB_DATA_SUBDIR LDAP_DIRSEP "data"
  38 #endif
  39
  40 #define BDB_SUFFIX              ".bdb"
  41 #define BDB_ID2ENTRY    0
  42 #ifdef BDB_HIER
  43 #define BDB_ID2PARENT           1
  44 #else
  45 #define BDB_DN2ID               1
  46 #endif
  47 #define BDB_NDB                 2
  48
  49 /* The bdb on-disk entry format is pretty space-inefficient. Average
  50  * sized user entries are 3-4K each. You need at least two entries to
  51  * fit into a single database page, more is better. 64K is BDB's
  52  * upper bound. Smaller pages are better for concurrency.
  53  */
  54 #ifndef BDB_ID2ENTRY_PAGESIZE
  55 #define BDB_ID2ENTRY_PAGESIZE   16384
  56 #endif
  57
  58 #ifndef BDB_PAGESIZE
  59 #define BDB_PAGESIZE    4096    /* BDB's original default */
  60 #endif
  61
  62 #define DEFAULT_CACHE_SIZE     1000
  63
  64 /* for the in-core cache of entries */
  65 typedef struct bdb_cache {
  66         int             c_maxsize;
  67         int             c_cursize;
  68         Avlnode         *c_dntree;
  69         Avlnode         *c_idtree;
  70         Entry           *c_lruhead;     /* lru - add accessed entries here */
  71         Entry           *c_lrutail;     /* lru - rem lru entries from here */
  72         ldap_pvt_thread_rdwr_t c_rwlock;
  73         ldap_pvt_thread_mutex_t lru_mutex;
  74 } Cache;
  75
  76 #define CACHE_READ_LOCK                0
  77 #define CACHE_WRITE_LOCK       1
  78
  79 #define BDB_INDICES             128
  80
  81 struct bdb_db_info {
  82         char            *bdi_name;
  83         DB                      *bdi_db;
  84 };
  85
  86 struct bdb_info {
  87         DB_ENV          *bi_dbenv;
  88
  89         /* DB_ENV parameters */
  90         /* The DB_ENV can be tuned via DB_CONFIG */
  91         char            *bi_dbenv_home;
  92         u_int32_t       bi_dbenv_xflags; /* extra flags */
  93         int                     bi_dbenv_mode;
  94
  95         int                     bi_ndatabases;
  96         struct bdb_db_info **bi_databases;
  97         ldap_pvt_thread_mutex_t bi_database_mutex;
  98         int             bi_db_opflags;  /* db-specific flags */
  99
 100         slap_mask_t     bi_defaultmask;
 101         Cache           bi_cache;
 102         Avlnode         *bi_attrs;
 103 #ifdef BDB_HIER
 104         Avlnode         *bi_tree;
 105         ldap_pvt_thread_rdwr_t  bi_tree_rdwr;
 106         void            *bi_troot;
 107         int             bi_nrdns;
 108 #endif
 109
 110         int                     bi_txn_cp;
 111         u_int32_t       bi_txn_cp_min;
 112         u_int32_t       bi_txn_cp_kbyte;
 113
 114         int                     bi_lock_detect;
 115 #ifdef NO_THREADS
 116         int             bi_locker_id;
 117 #endif
 118
 119         ID                      bi_lastid;
 120         ldap_pvt_thread_mutex_t bi_lastid_mutex;
 121 };
 122
 123 #define bi_id2entry     bi_databases[BDB_ID2ENTRY]
 124 #ifdef BDB_HIER
 125 #define bi_id2parent    bi_databases[BDB_ID2PARENT]
 126 #else
 127 #define bi_dn2id        bi_databases[BDB_DN2ID]
 128 #endif
 129
 130 struct bdb_op_info {
 131         BackendDB*      boi_bdb;
 132         DB_TXN*         boi_txn;
 133         int                     boi_err;
 134 };
 135
 136 #define DB_OPEN(db, file, name, type, flags, mode) \
 137         (db)->open(db, file, name, type, flags, mode)
 138
 139 #if DB_VERSION_MAJOR < 4
 140 #define LOCK_DETECT(env,f,t,a)          lock_detect(env, f, t, a)
 141 #define LOCK_GET(env,i,f,o,m,l)         lock_get(env, i, f, o, m, l)
 142 #define LOCK_PUT(env,l)                 lock_put(env, l)
 143 #define TXN_CHECKPOINT(env,k,m,f)       txn_checkpoint(env, k, m, f)
 144 #define TXN_BEGIN(env,p,t,f)            txn_begin((env), p, t, f)
 145 #define TXN_PREPARE(txn,gid)            txn_prepare((txn), (gid))
 146 #define TXN_COMMIT(txn,f)                       txn_commit((txn), (f))
 147 #define TXN_ABORT(txn)                          txn_abort((txn))
 148 #define TXN_ID(txn)                                     txn_id(txn)
 149 #define XLOCK_ID(env, locker)           lock_id(env, locker)
 150 #define XLOCK_ID_FREE(env, locker)      lock_id_free(env, locker)
 151 #else
 152 #define LOCK_DETECT(env,f,t,a)          (env)->lock_detect(env, f, t, a)
 153 #define LOCK_GET(env,i,f,o,m,l)         (env)->lock_get(env, i, f, o, m, l)
 154 #define LOCK_PUT(env,l)                 (env)->lock_put(env, l)
 155 #define TXN_CHECKPOINT(env,k,m,f)       (env)->txn_checkpoint(env, k, m, f)
 156 #define TXN_BEGIN(env,p,t,f)            (env)->txn_begin((env), p, t, f)
 157 #define TXN_PREPARE(txn,g)                      (txn)->prepare((txn), (g))
 158 #define TXN_COMMIT(txn,f)                       (txn)->commit((txn), (f))
 159 #define TXN_ABORT(txn)                          (txn)->abort((txn))
 160 #define TXN_ID(txn)                                     (txn)->id(txn)
 161 #define XLOCK_ID(env, locker)           (env)->lock_id(env, locker)
 162 #define XLOCK_ID_FREE(env, locker)      (env)->lock_id_free(env, locker)
 163
 164 /* BDB 4.1.17 adds txn arg to db->open */
 165 #if DB_VERSION_MINOR > 1 || DB_VERSION_PATCH >= 17
 166 #undef DB_OPEN
 167 #define DB_OPEN(db, file, name, type, flags, mode) \
 168         (db)->open(db, NULL, file, name, type, (flags)|DB_AUTO_COMMIT, mode)
 169 #endif
 170
 171 #define BDB_REUSE_LOCKERS
 172
 173 #ifdef BDB_REUSE_LOCKERS
 174 /* Hack - we depend on "op" and "bdb" being the right variable names
 175  * in each invoker.
 176  */
 177 #define LOCK_ID_FREE(env, locker)
 178 #define LOCK_ID(env, locker)    bdb_locker_id(op, bdb, locker)
 179 #else
 180 #define LOCK_ID_FREE(env, locker)       XLOCK_ID_FREE(env, locker)
 181 #define LOCK_ID(env, locker)            XLOCK_ID(env, locker)
 182 #endif
 183
 184 #endif
 185
 186 LDAP_END_DECL
 187
 188 #include "proto-bdb.h"
 189
 190 #endif /* _BACK_BDB_H_ */