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-2006 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 DN_BASE_PREFIX          SLAP_INDEX_EQUALITY_PREFIX
  30 #define DN_ONE_PREFIX           '%'
  31 #define DN_SUBTREE_PREFIX       '@'
  32
  33 #define DBTzero(t)                      (memset((t), 0, sizeof(DBT)))
  34 #define DBT2bv(t,bv)            ((bv)->bv_val = (t)->data, \
  35                                                                 (bv)->bv_len = (t)->size)
  36 #define bv2DBT(bv,t)            ((t)->data = (bv)->bv_val, \
  37                                                                 (t)->size = (bv)->bv_len )
  38
  39 #define BDB_TXN_RETRIES         16
  40
  41 #define BDB_MAX_ADD_LOOP        30
  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 typedef struct bdb_idl_cache_entry_s {
  70         struct berval kstr;
  71         ldap_pvt_thread_rdwr_t idl_entry_rwlock;
  72         ID      *idl;
  73         DB      *db;
  74         struct bdb_idl_cache_entry_s* idl_lru_prev;
  75         struct bdb_idl_cache_entry_s* idl_lru_next;
  76 } bdb_idl_cache_entry_t;
  77
  78 /* BDB backend specific entry info */
  79 typedef struct bdb_entry_info {
  80         struct bdb_entry_info *bei_parent;
  81         ID bei_id;
  82
  83         /* we use the bei_id as a lockobj, but we need to make the size != 4
  84          * to avoid conflicting with BDB's internal locks. So add a byte here
  85          * that is always zero.
  86          */
  87         char bei_lockpad;
  88
  89         short bei_state;
  90 #define CACHE_ENTRY_DELETED     1
  91 #define CACHE_ENTRY_NO_KIDS     2
  92 #define CACHE_ENTRY_NOT_LINKED  4
  93 #define CACHE_ENTRY_NO_GRANDKIDS        8
  94 #define CACHE_ENTRY_LOADING     0x10
  95 #define CACHE_ENTRY_WALKING     0x20
  96 #define CACHE_ENTRY_ONELEVEL    0x40
  97
  98         /*
  99          * remaining fields require backend cache lock to access
 100          */
 101         struct berval bei_nrdn;
 102 #ifdef BDB_HIER
 103         struct berval bei_rdn;
 104         int     bei_modrdns;    /* track renames */
 105         int     bei_ckids;      /* number of kids cached */
 106         int     bei_dkids;      /* number of kids on-disk, plus 1 */
 107 #endif
 108         Entry   *bei_e;
 109         Avlnode *bei_kids;
 110 #ifdef SLAP_ZONE_ALLOC
 111         struct bdb_info *bei_bdb;
 112         int bei_zseq;
 113 #endif
 114         ldap_pvt_thread_mutex_t bei_kids_mutex;
 115
 116         struct bdb_entry_info   *bei_lrunext;   /* for cache lru list */
 117         struct bdb_entry_info   *bei_lruprev;
 118 } EntryInfo;
 119 #undef BEI
 120 #define BEI(e)  ((EntryInfo *) ((e)->e_private))
 121
 122 /* for the in-core cache of entries */
 123 typedef struct bdb_cache {
 124         int             c_maxsize;
 125         int             c_cursize;
 126         int             c_minfree;
 127         int             c_eiused;       /* EntryInfo's in use */
 128         int             c_leaves;       /* EntryInfo leaf nodes */
 129         EntryInfo       c_dntree;
 130         EntryInfo       *c_eifree;      /* free list */
 131         Avlnode         *c_idtree;
 132         EntryInfo       *c_lruhead;     /* lru - add accessed entries here */
 133         EntryInfo       *c_lrutail;     /* lru - rem lru entries from here */
 134         ldap_pvt_thread_rdwr_t c_rwlock;
 135         ldap_pvt_thread_mutex_t lru_head_mutex;
 136         ldap_pvt_thread_mutex_t lru_tail_mutex;
 137         u_int32_t       c_locker;       /* used by lru cleaner */
 138 #ifdef SLAP_ZONE_ALLOC
 139         void *c_zctx;
 140 #endif
 141 } Cache;
 142
 143 #define CACHE_READ_LOCK                0
 144 #define CACHE_WRITE_LOCK       1
 145
 146 #define BDB_INDICES             128
 147
 148 struct bdb_db_info {
 149         char            *bdi_name;
 150         DB                      *bdi_db;
 151 };
 152
 153 /* From ldap_rq.h */
 154 struct re_s;
 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         struct bdb_attrinfo             **bi_attrs;
 173         int                     bi_nattrs;
 174         void            *bi_search_stack;
 175         int             bi_search_stack_depth;
 176         int             bi_linear_index;
 177
 178         int                     bi_txn_cp;
 179         u_int32_t       bi_txn_cp_min;
 180         u_int32_t       bi_txn_cp_kbyte;
 181         struct re_s             *bi_txn_cp_task;
 182         struct re_s             *bi_index_task;
 183
 184         int                     bi_lock_detect;
 185         long            bi_shm_key;
 186
 187         ID                      bi_lastid;
 188         ldap_pvt_thread_mutex_t bi_lastid_mutex;
 189         int             bi_idl_cache_max_size;
 190         int             bi_idl_cache_size;
 191         Avlnode         *bi_idl_tree;
 192         bdb_idl_cache_entry_t   *bi_idl_lru_head;
 193         bdb_idl_cache_entry_t   *bi_idl_lru_tail;
 194         ldap_pvt_thread_rdwr_t bi_idl_tree_rwlock;
 195         ldap_pvt_thread_mutex_t bi_idl_tree_lrulock;
 196         alock_info_t    bi_alock_info;
 197         char            *bi_db_config_path;
 198         BerVarray       bi_db_config;
 199         int             bi_flags;
 200 #define BDB_IS_OPEN             0x01
 201 #define BDB_HAS_CONFIG  0x02
 202 #define BDB_UPD_CONFIG  0x04
 203 #define BDB_DEL_INDEX   0x08
 204 #define BDB_RE_OPEN             0x10
 205 #ifdef BDB_HIER
 206         int             bi_modrdns;             /* number of modrdns completed */
 207         ldap_pvt_thread_mutex_t bi_modrdns_mutex;
 208 #endif
 209 };
 210
 211 #define bi_id2entry     bi_databases[BDB_ID2ENTRY]
 212 #define bi_dn2id        bi_databases[BDB_DN2ID]
 213
 214 struct bdb_lock_info {
 215         struct bdb_lock_info *bli_next;
 216         ID              bli_id;
 217         DB_LOCK bli_lock;
 218 };
 219
 220 struct bdb_op_info {
 221         BackendDB*      boi_bdb;
 222         DB_TXN*         boi_txn;
 223         u_int32_t       boi_err;
 224         u_int32_t       boi_locker;
 225         int             boi_acl_cache;
 226         struct bdb_lock_info *boi_locks;        /* used when no txn */
 227 };
 228
 229 #define DB_OPEN(db, file, name, type, flags, mode) \
 230         (db)->open(db, file, name, type, flags, mode)
 231
 232 #if DB_VERSION_MAJOR < 4
 233 #define LOCK_DETECT(env,f,t,a)          lock_detect(env, f, t, a)
 234 #define LOCK_GET(env,i,f,o,m,l)         lock_get(env, i, f, o, m, l)
 235 #define LOCK_PUT(env,l)                 lock_put(env, l)
 236 #define TXN_CHECKPOINT(env,k,m,f)       txn_checkpoint(env, k, m, f)
 237 #define TXN_BEGIN(env,p,t,f)            txn_begin((env), p, t, f)
 238 #define TXN_PREPARE(txn,gid)            txn_prepare((txn), (gid))
 239 #define TXN_COMMIT(txn,f)                       txn_commit((txn), (f))
 240 #define TXN_ABORT(txn)                          txn_abort((txn))
 241 #define TXN_ID(txn)                                     txn_id(txn)
 242 #define XLOCK_ID(env, locker)           lock_id(env, locker)
 243 #define XLOCK_ID_FREE(env, locker)      lock_id_free(env, locker)
 244 #else
 245 #define LOCK_DETECT(env,f,t,a)          (env)->lock_detect(env, f, t, a)
 246 #define LOCK_GET(env,i,f,o,m,l)         (env)->lock_get(env, i, f, o, m, l)
 247 #define LOCK_PUT(env,l)                 (env)->lock_put(env, l)
 248 #define TXN_CHECKPOINT(env,k,m,f)       (env)->txn_checkpoint(env, k, m, f)
 249 #define TXN_BEGIN(env,p,t,f)            (env)->txn_begin((env), p, t, f)
 250 #define TXN_PREPARE(txn,g)                      (txn)->prepare((txn), (g))
 251 #define TXN_COMMIT(txn,f)                       (txn)->commit((txn), (f))
 252 #define TXN_ABORT(txn)                          (txn)->abort((txn))
 253 #define TXN_ID(txn)                                     (txn)->id(txn)
 254 #define XLOCK_ID(env, locker)           (env)->lock_id(env, locker)
 255 #define XLOCK_ID_FREE(env, locker)      (env)->lock_id_free(env, locker)
 256
 257 /* BDB 4.1.17 adds txn arg to db->open */
 258 #if DB_VERSION_FULL >= 0x04010011
 259 #undef DB_OPEN
 260 #define DB_OPEN(db, file, name, type, flags, mode) \
 261         (db)->open(db, NULL, file, name, type, flags, mode)
 262 #endif
 263
 264 #endif
 265
 266 #define BDB_REUSE_LOCKERS
 267
 268 #define BDB_CSN_COMMIT  0
 269 #define BDB_CSN_ABORT   1
 270 #define BDB_CSN_RETRY   2
 271
 272 /* Copy an ID "src" to pointer "dst" in big-endian byte order */
 273 #define BDB_ID2DISK( src, dst ) \
 274         do { int i0; ID tmp; unsigned char *_p; \
 275                 tmp = (src); _p = (unsigned char *)(dst);       \
 276                 for ( i0=sizeof(ID)-1; i0>=0; i0-- ) {  \
 277                         _p[i0] = tmp & 0xff; tmp >>= 8; \
 278                 } \
 279         } while(0)
 280
 281 /* Copy a pointer "src" to a pointer "dst" from big-endian to native order */
 282 #define BDB_DISK2ID( src, dst ) \
 283         do { int i0; ID tmp = 0; unsigned char *_p;     \
 284                 _p = (unsigned char *)(src);    \
 285                 for ( i0=0; i0<sizeof(ID); i0++ ) {     \
 286                         tmp <<= 8; tmp |= *_p++;        \
 287                 } *(dst) = tmp; \
 288         } while (0)
 289
 290 LDAP_END_DECL
 291
 292 /* for the cache of attribute information (which are indexed, etc.) */
 293 typedef struct bdb_attrinfo {
 294         AttributeDescription *ai_desc; /* attribute description cn;lang-en */
 295         slap_mask_t ai_indexmask;       /* how the attr is indexed      */
 296         slap_mask_t ai_newmask; /* new settings to replace old mask */
 297 #ifdef LDAP_COMP_MATCH
 298         ComponentReference* ai_cr; /*component indexing*/
 299 #endif
 300 } AttrInfo;
 301
 302 /* These flags must not clash with SLAP_INDEX flags or ops in slap.h! */
 303 #define BDB_INDEX_DELETING      0x8000U /* index is being modified */
 304 #define BDB_INDEX_UPDATE_OP     0x03    /* performing an index update */
 305
 306 /* For slapindex to record which attrs in an entry belong to which
 307  * index database
 308  */
 309 typedef struct AttrList {
 310         struct AttrList *next;
 311         Attribute *attr;
 312 } AttrList;
 313
 314 typedef struct IndexRec {
 315         AttrInfo *ai;
 316         AttrList *attrs;
 317 } IndexRec;
 318
 319 #include "proto-bdb.h"
 320
 321 #endif /* _BACK_BDB_H_ */