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-2003 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 "slap.h"
  13 #include <db.h>
  14
  15 LDAP_BEGIN_DECL
  16
  17 /* #define BDB_HIER             1 */
  18
  19 #define DN_BASE_PREFIX          SLAP_INDEX_EQUALITY_PREFIX
  20 #define DN_ONE_PREFIX           '%'
  21 #define DN_SUBTREE_PREFIX       '@'
  22
  23 #define DBTzero(t)                      (memset((t), 0, sizeof(DBT)))
  24 #define DBT2bv(t,bv)            ((bv)->bv_val = (t)->data, \
  25                                                                 (bv)->bv_len = (t)->size)
  26 #define bv2DBT(bv,t)            ((t)->data = (bv)->bv_val, \
  27                                                                 (t)->size = (bv)->bv_len )
  28
  29 #define BDB_TXN_RETRIES         16
  30
  31 #define BDB_MAX_ADD_LOOP        30
  32
  33 #define BDB_ALIASES     1
  34
  35 #ifdef BDB_SUBDIRS
  36 #define BDB_TMP_SUBDIR  "tmp"
  37 #define BDB_LG_SUBDIR   "log"
  38 #define BDB_DATA_SUBDIR "data"
  39 #endif
  40
  41 #define BDB_SUFFIX              ".bdb"
  42 #define BDB_ID2ENTRY    0
  43 #ifdef BDB_HIER
  44 #define BDB_ID2PARENT           1
  45 #else
  46 #define BDB_DN2ID               1
  47 #endif
  48 #define BDB_NDB                 2
  49
  50 /* The bdb on-disk entry format is pretty space-inefficient. Average
  51  * sized user entries are 3-4K each. You need at least two entries to
  52  * fit into a single database page, more is better. 64K is BDB's
  53  * upper bound. Smaller pages are better for concurrency.
  54  */
  55 #ifndef BDB_ID2ENTRY_PAGESIZE
  56 #define BDB_ID2ENTRY_PAGESIZE   16384
  57 #endif
  58
  59 #ifndef BDB_PAGESIZE
  60 #define BDB_PAGESIZE    4096    /* BDB's original default */
  61 #endif
  62
  63 #define DEFAULT_CACHE_SIZE     1000
  64
  65 /* The default search IDL stack cache depth */
  66 #define DEFAULT_SEARCH_STACK_DEPTH      16
  67
  68 /* The minimum we can function with */
  69 #define MINIMUM_SEARCH_STACK_DEPTH      8
  70
  71 /* for the IDL cache */
  72 #define SLAP_IDL_CACHE  1
  73
  74 #ifdef SLAP_IDL_CACHE
  75 typedef struct bdb_idl_cache_entry_s {
  76         struct berval kstr;
  77         ldap_pvt_thread_rdwr_t idl_entry_rwlock;
  78         ID      *idl;
  79         DB      *db;
  80         struct bdb_idl_cache_entry_s* idl_lru_prev;
  81         struct bdb_idl_cache_entry_s* idl_lru_next;
  82 } bdb_idl_cache_entry_t;
  83 #endif
  84
  85 /* BDB backend specific entry info */
  86 typedef struct bdb_entry_info {
  87         struct bdb_entry_info *bei_parent;
  88         ID bei_id;
  89
  90         int bei_state;
  91 #define CACHE_ENTRY_DELETED     1
  92 #define CACHE_ENTRY_NO_KIDS     2
  93
  94         /*
  95          * remaining fields require backend cache lock to access
  96          */
  97         struct berval bei_nrdn;
  98         struct berval bei_rdn;
  99         Entry   *bei_e;
 100         Avlnode *bei_kids;
 101         ldap_pvt_thread_mutex_t bei_kids_mutex;
 102
 103         struct bdb_entry_info   *bei_lrunext;   /* for cache lru list */
 104         struct bdb_entry_info   *bei_lruprev;
 105 } EntryInfo;
 106 #undef BEI
 107 #define BEI(e)  ((EntryInfo *) ((e)->e_private))
 108
 109 /* for the in-core cache of entries */
 110 typedef struct bdb_cache {
 111         int             c_maxsize;
 112         int             c_cursize;
 113         EntryInfo       c_dntree;
 114         Avlnode         *c_idtree;
 115         EntryInfo       *c_lruhead;     /* lru - add accessed entries here */
 116         EntryInfo       *c_lrutail;     /* lru - rem lru entries from here */
 117         ldap_pvt_thread_rdwr_t c_rwlock;
 118         ldap_pvt_thread_mutex_t lru_mutex;
 119 } Cache;
 120
 121 #define CACHE_READ_LOCK                0
 122 #define CACHE_WRITE_LOCK       1
 123
 124 #define BDB_INDICES             128
 125
 126 struct bdb_db_info {
 127         char            *bdi_name;
 128         DB                      *bdi_db;
 129 };
 130
 131 struct bdb_info {
 132         DB_ENV          *bi_dbenv;
 133
 134         /* DB_ENV parameters */
 135         /* The DB_ENV can be tuned via DB_CONFIG */
 136         char            *bi_dbenv_home;
 137         u_int32_t       bi_dbenv_xflags; /* extra flags */
 138         int                     bi_dbenv_mode;
 139
 140         int                     bi_ndatabases;
 141         struct bdb_db_info **bi_databases;
 142         int             bi_db_opflags;  /* db-specific flags */
 143
 144         slap_mask_t     bi_defaultmask;
 145         Cache           bi_cache;
 146         Avlnode         *bi_attrs;
 147         void            *bi_search_stack;
 148         int             bi_search_stack_depth;
 149 #ifdef BDB_HIER
 150         Avlnode         *bi_tree;
 151         ldap_pvt_thread_rdwr_t  bi_tree_rdwr;
 152         void            *bi_troot;
 153 #endif
 154
 155         int                     bi_txn_cp;
 156         u_int32_t       bi_txn_cp_min;
 157         u_int32_t       bi_txn_cp_kbyte;
 158
 159         int                     bi_lock_detect;
 160
 161         ID                      bi_lastid;
 162         ldap_pvt_thread_mutex_t bi_lastid_mutex;
 163 #if defined(LDAP_CLIENT_UPDATE) || defined(LDAP_SYNC)
 164         LDAP_LIST_HEAD(pl, slap_op) bi_psearch_list;
 165 #endif
 166 #ifdef SLAP_IDL_CACHE
 167         int             bi_idl_cache_max_size;
 168         int             bi_idl_cache_size;
 169         Avlnode         *bi_idl_tree;
 170         bdb_idl_cache_entry_t   *bi_idl_lru_head;
 171         bdb_idl_cache_entry_t   *bi_idl_lru_tail;
 172         ldap_pvt_thread_rdwr_t bi_idl_tree_rwlock;
 173         ldap_pvt_thread_mutex_t bi_idl_tree_lrulock;
 174 #endif
 175 };
 176
 177 #define bi_id2entry     bi_databases[BDB_ID2ENTRY]
 178 #ifdef BDB_HIER
 179 #define bi_id2parent    bi_databases[BDB_ID2PARENT]
 180 #else
 181 #define bi_dn2id        bi_databases[BDB_DN2ID]
 182 #endif
 183
 184 struct bdb_op_info {
 185         BackendDB*      boi_bdb;
 186         DB_TXN*         boi_txn;
 187         DB_LOCK         boi_lock;       /* used when no txn */
 188         u_int32_t       boi_err;
 189         u_int32_t       boi_locker;
 190         int             boi_acl_cache;
 191 };
 192
 193 #define DB_OPEN(db, txn, file, name, type, flags, mode) \
 194         (db)->open(db, file, name, type, flags, mode)
 195
 196 #if DB_VERSION_MAJOR < 4
 197 #define LOCK_DETECT(env,f,t,a)          lock_detect(env, f, t, a)
 198 #define LOCK_GET(env,i,f,o,m,l)         lock_get(env, i, f, o, m, l)
 199 #define LOCK_PUT(env,l)                 lock_put(env, l)
 200 #define TXN_CHECKPOINT(env,k,m,f)       txn_checkpoint(env, k, m, f)
 201 #define TXN_BEGIN(env,p,t,f)            txn_begin((env), p, t, f)
 202 #define TXN_PREPARE(txn,gid)            txn_prepare((txn), (gid))
 203 #define TXN_COMMIT(txn,f)                       txn_commit((txn), (f))
 204 #define TXN_ABORT(txn)                          txn_abort((txn))
 205 #define TXN_ID(txn)                                     txn_id(txn)
 206 #define XLOCK_ID(env, locker)           lock_id(env, locker)
 207 #define XLOCK_ID_FREE(env, locker)      lock_id_free(env, locker)
 208 #else
 209 #define LOCK_DETECT(env,f,t,a)          (env)->lock_detect(env, f, t, a)
 210 #define LOCK_GET(env,i,f,o,m,l)         (env)->lock_get(env, i, f, o, m, l)
 211 #define LOCK_PUT(env,l)                 (env)->lock_put(env, l)
 212 #define TXN_CHECKPOINT(env,k,m,f)       (env)->txn_checkpoint(env, k, m, f)
 213 #define TXN_BEGIN(env,p,t,f)            (env)->txn_begin((env), p, t, f)
 214 #define TXN_PREPARE(txn,g)                      (txn)->prepare((txn), (g))
 215 #define TXN_COMMIT(txn,f)                       (txn)->commit((txn), (f))
 216 #define TXN_ABORT(txn)                          (txn)->abort((txn))
 217 #define TXN_ID(txn)                                     (txn)->id(txn)
 218 #define XLOCK_ID(env, locker)           (env)->lock_id(env, locker)
 219 #define XLOCK_ID_FREE(env, locker)      (env)->lock_id_free(env, locker)
 220
 221 /* BDB 4.1.17 adds txn arg to db->open */
 222 #if DB_VERSION_MINOR > 1 || DB_VERSION_PATCH >= 17
 223 #undef DB_OPEN
 224 #define DB_OPEN(db, txn, file, name, type, flags, mode) \
 225         (db)->open(db, txn, file, name, type, flags, mode)
 226 #endif
 227
 228 #define BDB_REUSE_LOCKERS
 229
 230 #ifdef BDB_REUSE_LOCKERS
 231 #define LOCK_ID_FREE(env, locker)
 232 #define LOCK_ID(env, locker)    bdb_locker_id(op, env, locker)
 233 #else
 234 #define LOCK_ID_FREE(env, locker)       XLOCK_ID_FREE(env, locker)
 235 #define LOCK_ID(env, locker)            XLOCK_ID(env, locker)
 236 #endif
 237
 238 #endif
 239
 240 LDAP_END_DECL
 241
 242 #include "proto-bdb.h"
 243
 244 #endif /* _BACK_BDB_H_ */