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 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   4  *
   5  * Copyright 2000-2005 The OpenLDAP Foundation.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted only as authorized by the OpenLDAP
  10  * Public License.
  11  *
  12  * A copy of this license is available in the file LICENSE in the
  13  * top-level directory of the distribution or, alternatively, at
  14  * <http://www.OpenLDAP.org/license.html>.
  15  */
  16
  17 #ifndef _BACK_BDB_H_
  18 #define _BACK_BDB_H_
  19
  20 #include <portable.h>
  21 #include "slap.h"
  22 #include <db.h>
  23 #include "alock.h"
  24
  25 LDAP_BEGIN_DECL
  26
  27 #define DB_VERSION_FULL ((DB_VERSION_MAJOR << 24) | (DB_VERSION_MINOR << 16) | DB_VERSION_PATCH)
  28
  29 #define BDB_SUBENTRIES 1
  30
  31 #define DN_BASE_PREFIX          SLAP_INDEX_EQUALITY_PREFIX
  32 #define DN_ONE_PREFIX           '%'
  33 #define DN_SUBTREE_PREFIX       '@'
  34
  35 #define DBTzero(t)                      (memset((t), 0, sizeof(DBT)))
  36 #define DBT2bv(t,bv)            ((bv)->bv_val = (t)->data, \
  37                                                                 (bv)->bv_len = (t)->size)
  38 #define bv2DBT(bv,t)            ((t)->data = (bv)->bv_val, \
  39                                                                 (t)->size = (bv)->bv_len )
  40
  41 #define BDB_TXN_RETRIES         16
  42
  43 #define BDB_MAX_ADD_LOOP        30
  44
  45 #ifdef BDB_SUBDIRS
  46 #define BDB_TMP_SUBDIR  "tmp"
  47 #define BDB_LG_SUBDIR   "log"
  48 #define BDB_DATA_SUBDIR "data"
  49 #endif
  50
  51 #define BDB_SUFFIX              ".bdb"
  52 #define BDB_ID2ENTRY    0
  53 #define BDB_DN2ID               1
  54 #define BDB_NDB                 2
  55
  56 /* The bdb on-disk entry format is pretty space-inefficient. Average
  57  * sized user entries are 3-4K each. You need at least two entries to
  58  * fit into a single database page, more is better. 64K is BDB's
  59  * upper bound. Smaller pages are better for concurrency.
  60  */
  61 #ifndef BDB_ID2ENTRY_PAGESIZE
  62 #define BDB_ID2ENTRY_PAGESIZE   16384
  63 #endif
  64
  65 #ifndef BDB_PAGESIZE
  66 #define BDB_PAGESIZE    4096    /* BDB's original default */
  67 #endif
  68
  69 #define DEFAULT_CACHE_SIZE     1000
  70
  71 /* The default search IDL stack cache depth */
  72 #define DEFAULT_SEARCH_STACK_DEPTH      16
  73
  74 /* The minimum we can function with */
  75 #define MINIMUM_SEARCH_STACK_DEPTH      8
  76
  77 typedef struct bdb_idl_cache_entry_s {
  78         struct berval kstr;
  79         ldap_pvt_thread_rdwr_t idl_entry_rwlock;
  80         ID      *idl;
  81         DB      *db;
  82         struct bdb_idl_cache_entry_s* idl_lru_prev;
  83         struct bdb_idl_cache_entry_s* idl_lru_next;
  84 } bdb_idl_cache_entry_t;
  85
  86 /* BDB backend specific entry info */
  87 typedef struct bdb_entry_info {
  88         struct bdb_entry_info *bei_parent;
  89         ID bei_id;
  90
  91         /* we use the bei_id as a lockobj, but we need to make the size != 4
  92          * to avoid conflicting with BDB's internal locks. So add a byte here
  93          * that is always zero.
  94          */
  95         char bei_lockpad;
  96
  97         short bei_state;
  98 #define CACHE_ENTRY_DELETED     1
  99 #define CACHE_ENTRY_NO_KIDS     2
 100 #define CACHE_ENTRY_NOT_LINKED  4
 101 #define CACHE_ENTRY_NO_GRANDKIDS        8
 102 #define CACHE_ENTRY_LOADING     0x10
 103
 104         /*
 105          * remaining fields require backend cache lock to access
 106          */
 107         struct berval bei_nrdn;
 108 #ifdef BDB_HIER
 109         struct berval bei_rdn;
 110         int     bei_modrdns;    /* track renames */
 111         int     bei_ckids;      /* number of kids cached */
 112         int     bei_dkids;      /* number of kids on-disk, plus 1 */
 113 #endif
 114         Entry   *bei_e;
 115         Avlnode *bei_kids;
 116 #ifdef SLAP_ZONE_ALLOC
 117         struct bdb_info *bei_bdb;
 118         int bei_zseq;
 119 #endif
 120         ldap_pvt_thread_mutex_t bei_kids_mutex;
 121
 122         struct bdb_entry_info   *bei_lrunext;   /* for cache lru list */
 123         struct bdb_entry_info   *bei_lruprev;
 124 } EntryInfo;
 125 #undef BEI
 126 #define BEI(e)  ((EntryInfo *) ((e)->e_private))
 127
 128 /* for the in-core cache of entries */
 129 typedef struct bdb_cache {
 130         int             c_maxsize;
 131         int             c_cursize;
 132         int             c_eiused;       /* EntryInfo's in use */
 133         EntryInfo       c_dntree;
 134         EntryInfo       *c_eifree;      /* free list */
 135         Avlnode         *c_idtree;
 136         EntryInfo       *c_lruhead;     /* lru - add accessed entries here */
 137         EntryInfo       *c_lrutail;     /* lru - rem lru entries from here */
 138         ldap_pvt_thread_rdwr_t c_rwlock;
 139         ldap_pvt_thread_mutex_t lru_mutex;
 140         u_int32_t       c_locker;       /* used by lru cleaner */
 141 #ifdef SLAP_ZONE_ALLOC
 142         void *c_zctx;
 143 #endif
 144 } Cache;
 145
 146 #define CACHE_READ_LOCK                0
 147 #define CACHE_WRITE_LOCK       1
 148
 149 #define BDB_INDICES             128
 150
 151 struct bdb_db_info {
 152         char            *bdi_name;
 153         DB                      *bdi_db;
 154 };
 155
 156 struct bdb_info {
 157         DB_ENV          *bi_dbenv;
 158
 159         /* DB_ENV parameters */
 160         /* The DB_ENV can be tuned via DB_CONFIG */
 161         char            *bi_dbenv_home;
 162         u_int32_t       bi_dbenv_xflags; /* extra flags */
 163         int                     bi_dbenv_mode;
 164
 165         int                     bi_ndatabases;
 166         struct bdb_db_info **bi_databases;
 167         ldap_pvt_thread_mutex_t bi_database_mutex;
 168         int             bi_db_opflags;  /* db-specific flags */
 169
 170         slap_mask_t     bi_defaultmask;
 171         Cache           bi_cache;
 172         Avlnode         *bi_attrs;
 173         void            *bi_search_stack;
 174         int             bi_search_stack_depth;
 175         int             bi_linear_index;
 176
 177         int                     bi_txn_cp;
 178         u_int32_t       bi_txn_cp_min;
 179         u_int32_t       bi_txn_cp_kbyte;
 180
 181         int                     bi_lock_detect;
 182         long            bi_shm_key;
 183
 184         ID                      bi_lastid;
 185         ldap_pvt_thread_mutex_t bi_lastid_mutex;
 186         int             bi_idl_cache_max_size;
 187         int             bi_idl_cache_size;
 188         Avlnode         *bi_idl_tree;
 189         bdb_idl_cache_entry_t   *bi_idl_lru_head;
 190         bdb_idl_cache_entry_t   *bi_idl_lru_tail;
 191         ldap_pvt_thread_rdwr_t bi_idl_tree_rwlock;
 192         ldap_pvt_thread_mutex_t bi_idl_tree_lrulock;
 193         alock_info_t    bi_alock_info;
 194 };
 195
 196 #define bi_id2entry     bi_databases[BDB_ID2ENTRY]
 197 #define bi_dn2id        bi_databases[BDB_DN2ID]
 198
 199 struct bdb_lock_info {
 200         struct bdb_lock_info *bli_next;
 201         ID              bli_id;
 202         DB_LOCK bli_lock;
 203 };
 204
 205 struct bdb_op_info {
 206         BackendDB*      boi_bdb;
 207         DB_TXN*         boi_txn;
 208         u_int32_t       boi_err;
 209         u_int32_t       boi_locker;
 210         int             boi_acl_cache;
 211         struct bdb_lock_info *boi_locks;        /* used when no txn */
 212 };
 213
 214 #define DB_OPEN(db, file, name, type, flags, mode) \
 215         (db)->open(db, file, name, type, flags, mode)
 216
 217 #if DB_VERSION_MAJOR < 4
 218 #define LOCK_DETECT(env,f,t,a)          lock_detect(env, f, t, a)
 219 #define LOCK_GET(env,i,f,o,m,l)         lock_get(env, i, f, o, m, l)
 220 #define LOCK_PUT(env,l)                 lock_put(env, l)
 221 #define TXN_CHECKPOINT(env,k,m,f)       txn_checkpoint(env, k, m, f)
 222 #define TXN_BEGIN(env,p,t,f)            txn_begin((env), p, t, f)
 223 #define TXN_PREPARE(txn,gid)            txn_prepare((txn), (gid))
 224 #define TXN_COMMIT(txn,f)                       txn_commit((txn), (f))
 225 #define TXN_ABORT(txn)                          txn_abort((txn))
 226 #define TXN_ID(txn)                                     txn_id(txn)
 227 #define XLOCK_ID(env, locker)           lock_id(env, locker)
 228 #define XLOCK_ID_FREE(env, locker)      lock_id_free(env, locker)
 229 #else
 230 #define LOCK_DETECT(env,f,t,a)          (env)->lock_detect(env, f, t, a)
 231 #define LOCK_GET(env,i,f,o,m,l)         (env)->lock_get(env, i, f, o, m, l)
 232 #define LOCK_PUT(env,l)                 (env)->lock_put(env, l)
 233 #define TXN_CHECKPOINT(env,k,m,f)       (env)->txn_checkpoint(env, k, m, f)
 234 #define TXN_BEGIN(env,p,t,f)            (env)->txn_begin((env), p, t, f)
 235 #define TXN_PREPARE(txn,g)                      (txn)->prepare((txn), (g))
 236 #define TXN_COMMIT(txn,f)                       (txn)->commit((txn), (f))
 237 #define TXN_ABORT(txn)                          (txn)->abort((txn))
 238 #define TXN_ID(txn)                                     (txn)->id(txn)
 239 #define XLOCK_ID(env, locker)           (env)->lock_id(env, locker)
 240 #define XLOCK_ID_FREE(env, locker)      (env)->lock_id_free(env, locker)
 241
 242 /* BDB 4.1.17 adds txn arg to db->open */
 243 #if DB_VERSION_FULL >= 0x04010011
 244 #undef DB_OPEN
 245 #define DB_OPEN(db, file, name, type, flags, mode) \
 246         (db)->open(db, NULL, file, name, type, flags, mode)
 247 #endif
 248
 249 #endif
 250
 251 #define BDB_REUSE_LOCKERS
 252
 253 #define BDB_CSN_COMMIT  0
 254 #define BDB_CSN_ABORT   1
 255 #define BDB_CSN_RETRY   2
 256
 257 /* Copy an ID "src" to pointer "dst" in big-endian byte order */
 258 #define BDB_ID2DISK( src, dst ) \
 259         do { int i0; ID tmp; unsigned char *_p; \
 260                 tmp = (src); _p = (char *)(dst);        \
 261                 for ( i0=sizeof(ID)-1; i0>=0; i0-- ) {  \
 262                         _p[i0] = tmp & 0xff; tmp >>= 8; \
 263                 } \
 264         } while(0);
 265
 266 /* Copy a pointer "src" to a pointer "dst" from big-endian to native order */
 267 #define BDB_DISK2ID( src, dst ) \
 268         do { int i0; ID tmp = 0; unsigned char *_p;     \
 269                 _p = (unsigned char *)(src);    \
 270                 for ( i0=0; i0<sizeof(ID); i0++ ) {     \
 271                         tmp <<= 8; tmp |= *_p++;        \
 272                 } *(dst) = tmp; \
 273         } while (0);
 274
 275 LDAP_END_DECL
 276
 277 #include "proto-bdb.h"
 278
 279 #endif /* _BACK_BDB_H_ */