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