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-2008 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         ID      *idl;
  72         DB      *db;
  73         int             idl_flags;
  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         short 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 #define CACHE_ENTRY_REFERENCED  0x80
  98 #define CACHE_ENTRY_NOT_CACHED  0x100
  99         int bei_finders;
 100
 101         /*
 102          * remaining fields require backend cache lock to access
 103          */
 104         struct berval bei_nrdn;
 105 #ifdef BDB_HIER
 106         struct berval bei_rdn;
 107         int     bei_modrdns;    /* track renames */
 108         int     bei_ckids;      /* number of kids cached */
 109         int     bei_dkids;      /* number of kids on-disk, plus 1 */
 110 #endif
 111         Entry   *bei_e;
 112         Avlnode *bei_kids;
 113 #ifdef SLAP_ZONE_ALLOC
 114         struct bdb_info *bei_bdb;
 115         int bei_zseq;
 116 #endif
 117         ldap_pvt_thread_mutex_t bei_kids_mutex;
 118
 119         struct bdb_entry_info   *bei_lrunext;   /* for cache lru list */
 120         struct bdb_entry_info   *bei_lruprev;
 121 } EntryInfo;
 122 #undef BEI
 123 #define BEI(e)  ((EntryInfo *) ((e)->e_private))
 124
 125 /* for the in-core cache of entries */
 126 typedef struct bdb_cache {
 127         EntryInfo       *c_eifree;      /* free list */
 128         Avlnode         *c_idtree;
 129         EntryInfo       *c_lruhead;     /* lru - add accessed entries here */
 130         EntryInfo       *c_lrutail;     /* lru - rem lru entries from here */
 131         EntryInfo       c_dntree;
 132         unsigned        c_maxsize;
 133         int             c_cursize;
 134         unsigned        c_minfree;
 135         unsigned        c_eimax;
 136         int             c_eiused;       /* EntryInfo's in use */
 137         int             c_leaves;       /* EntryInfo leaf nodes */
 138         int             c_purging;
 139         DB_TXN  *c_txn; /* used by lru cleaner */
 140         ldap_pvt_thread_rdwr_t c_rwlock;
 141         ldap_pvt_thread_mutex_t c_lru_mutex;
 142         ldap_pvt_thread_mutex_t c_count_mutex;
 143         ldap_pvt_thread_mutex_t c_eifree_mutex;
 144 #ifdef SLAP_ZONE_ALLOC
 145         void *c_zctx;
 146 #endif
 147 } Cache;
 148
 149 #define CACHE_READ_LOCK                0
 150 #define CACHE_WRITE_LOCK       1
 151
 152 #define BDB_INDICES             128
 153
 154 struct bdb_db_info {
 155         struct berval   bdi_name;
 156         DB                      *bdi_db;
 157 };
 158
 159 struct bdb_db_pgsize {
 160         struct bdb_db_pgsize *bdp_next;
 161         struct berval   bdp_name;
 162         int     bdp_size;
 163 };
 164
 165 #ifdef LDAP_DEVEL
 166 #define BDB_MONITOR_IDX
 167 #endif /* LDAP_DEVEL */
 168
 169 typedef struct bdb_monitor_t {
 170         void            *bdm_cb;
 171         struct berval   bdm_ndn;
 172 } bdb_monitor_t;
 173
 174 /* From ldap_rq.h */
 175 struct re_s;
 176
 177 struct bdb_info {
 178         DB_ENV          *bi_dbenv;
 179
 180         /* DB_ENV parameters */
 181         /* The DB_ENV can be tuned via DB_CONFIG */
 182         char            *bi_dbenv_home;
 183         u_int32_t       bi_dbenv_xflags; /* extra flags */
 184         int                     bi_dbenv_mode;
 185
 186         int                     bi_ndatabases;
 187         int             bi_db_opflags;  /* db-specific flags */
 188         struct bdb_db_info **bi_databases;
 189         ldap_pvt_thread_mutex_t bi_database_mutex;
 190         struct bdb_db_pgsize *bi_pagesizes;
 191
 192         slap_mask_t     bi_defaultmask;
 193         Cache           bi_cache;
 194         struct bdb_attrinfo             **bi_attrs;
 195         int                     bi_nattrs;
 196         void            *bi_search_stack;
 197         int             bi_search_stack_depth;
 198         int             bi_linear_index;
 199
 200         int                     bi_txn_cp;
 201         u_int32_t       bi_txn_cp_min;
 202         u_int32_t       bi_txn_cp_kbyte;
 203         struct re_s             *bi_txn_cp_task;
 204         struct re_s             *bi_index_task;
 205
 206         int                     bi_lock_detect;
 207         long            bi_shm_key;
 208
 209         ID                      bi_lastid;
 210         ldap_pvt_thread_mutex_t bi_lastid_mutex;
 211         unsigned        bi_idl_cache_max_size;
 212         int             bi_idl_cache_size;
 213         Avlnode         *bi_idl_tree;
 214         bdb_idl_cache_entry_t   *bi_idl_lru_head;
 215         bdb_idl_cache_entry_t   *bi_idl_lru_tail;
 216         ldap_pvt_thread_rdwr_t bi_idl_tree_rwlock;
 217         ldap_pvt_thread_mutex_t bi_idl_tree_lrulock;
 218         alock_info_t    bi_alock_info;
 219         char            *bi_db_config_path;
 220         BerVarray       bi_db_config;
 221         char            *bi_db_crypt_file;
 222         struct berval   bi_db_crypt_key;
 223         bdb_monitor_t   bi_monitor;
 224
 225 #ifdef BDB_MONITOR_IDX
 226         ldap_pvt_thread_mutex_t bi_idx_mutex;
 227         Avlnode         *bi_idx;
 228 #endif /* BDB_MONITOR_IDX */
 229
 230         int             bi_flags;
 231 #define BDB_IS_OPEN             0x01
 232 #define BDB_HAS_CONFIG  0x02
 233 #define BDB_UPD_CONFIG  0x04
 234 #define BDB_DEL_INDEX   0x08
 235 #define BDB_RE_OPEN             0x10
 236 #ifdef BDB_HIER
 237         int             bi_modrdns;             /* number of modrdns completed */
 238         ldap_pvt_thread_mutex_t bi_modrdns_mutex;
 239 #endif
 240 };
 241
 242 #define bi_id2entry     bi_databases[BDB_ID2ENTRY]
 243 #define bi_dn2id        bi_databases[BDB_DN2ID]
 244
 245
 246 struct bdb_lock_info {
 247         struct bdb_lock_info *bli_next;
 248         DB_LOCK bli_lock;
 249         ID              bli_id;
 250         int             bli_flag;
 251 };
 252 #define BLI_DONTFREE    1
 253
 254 struct bdb_op_info {
 255         OpExtra boi_oe;
 256         DB_TXN*         boi_txn;
 257         struct bdb_lock_info *boi_locks;        /* used when no txn */
 258         u_int32_t       boi_err;
 259         char            boi_acl_cache;
 260         char            boi_flag;
 261 };
 262 #define BOI_DONTFREE    1
 263
 264 #define DB_OPEN(db, file, name, type, flags, mode) \
 265         ((db)->open)(db, file, name, type, flags, mode)
 266
 267 #if DB_VERSION_MAJOR < 4
 268 #define LOCK_DETECT(env,f,t,a)          lock_detect(env, f, t, a)
 269 #define LOCK_GET(env,i,f,o,m,l)         lock_get(env, i, f, o, m, l)
 270 #define LOCK_PUT(env,l)                 lock_put(env, l)
 271 #define TXN_CHECKPOINT(env,k,m,f)       txn_checkpoint(env, k, m, f)
 272 #define TXN_BEGIN(env,p,t,f)            txn_begin((env), p, t, f)
 273 #define TXN_PREPARE(txn,gid)            txn_prepare((txn), (gid))
 274 #define TXN_COMMIT(txn,f)                       txn_commit((txn), (f))
 275 #define TXN_ABORT(txn)                          txn_abort((txn))
 276 #define TXN_ID(txn)                                     txn_id(txn)
 277 #define XLOCK_ID(env, locker)           lock_id(env, locker)
 278 #define XLOCK_ID_FREE(env, locker)      lock_id_free(env, locker)
 279 #else
 280 #define LOCK_DETECT(env,f,t,a)          (env)->lock_detect(env, f, t, a)
 281 #define LOCK_GET(env,i,f,o,m,l)         (env)->lock_get(env, i, f, o, m, l)
 282 #define LOCK_PUT(env,l)                 (env)->lock_put(env, l)
 283 #define TXN_CHECKPOINT(env,k,m,f)       (env)->txn_checkpoint(env, k, m, f)
 284 #define TXN_BEGIN(env,p,t,f)            (env)->txn_begin((env), p, t, f)
 285 #define TXN_PREPARE(txn,g)                      (txn)->prepare((txn), (g))
 286 #define TXN_COMMIT(txn,f)                       (txn)->commit((txn), (f))
 287 #define TXN_ABORT(txn)                          (txn)->abort((txn))
 288 #define TXN_ID(txn)                                     (txn)->id(txn)
 289 #define XLOCK_ID(env, locker)           (env)->lock_id(env, locker)
 290 #define XLOCK_ID_FREE(env, locker)      (env)->lock_id_free(env, locker)
 291
 292 /* BDB 4.1.17 adds txn arg to db->open */
 293 #if DB_VERSION_FULL >= 0x04010011
 294 #undef DB_OPEN
 295 #define DB_OPEN(db, file, name, type, flags, mode) \
 296         ((db)->open)(db, NULL, file, name, type, flags, mode)
 297 #endif
 298
 299 /* #undef BDB_LOG_DEBUG */
 300
 301 #ifdef BDB_LOG_DEBUG
 302
 303 /* env->log_printf appeared in 4.4 */
 304 #if DB_VERSION_FULL >= 0x04040000
 305 #define BDB_LOG_PRINTF(env,txn,fmt,...) (env)->log_printf((env),(txn),(fmt),__VA_ARGS__)
 306 #else
 307 extern int __db_logmsg(const DB_ENV *env, DB_TXN *txn, const char *op, u_int32_t flags,
 308         const char *fmt,...);
 309 #define BDB_LOG_PRINTF(env,txn,fmt,...) __db_logmsg((env),(txn),"DIAGNOSTIC",0,(fmt),__VA_ARGS__)
 310 #endif
 311
 312 /* !BDB_LOG_DEBUG */
 313 #elif (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L) || \
 314         (defined(__GNUC__) && __GNUC__ >= 3 && !defined(__STRICT_ANSI__))
 315 #define BDB_LOG_PRINTF(a,b,c,...)
 316 #else
 317 #define BDB_LOG_PRINTF (void)   /* will evaluate and discard the arguments */
 318
 319 #endif /* BDB_LOG_DEBUG */
 320
 321 #endif
 322
 323 #ifndef DB_BUFFER_SMALL
 324 #define DB_BUFFER_SMALL                 ENOMEM
 325 #endif
 326
 327 #define BDB_CSN_COMMIT  0
 328 #define BDB_CSN_ABORT   1
 329 #define BDB_CSN_RETRY   2
 330
 331 /* Copy an ID "src" to pointer "dst" in big-endian byte order */
 332 #define BDB_ID2DISK( src, dst ) \
 333         do { int i0; ID tmp; unsigned char *_p; \
 334                 tmp = (src); _p = (unsigned char *)(dst);       \
 335                 for ( i0=sizeof(ID)-1; i0>=0; i0-- ) {  \
 336                         _p[i0] = tmp & 0xff; tmp >>= 8; \
 337                 } \
 338         } while(0)
 339
 340 /* Copy a pointer "src" to a pointer "dst" from big-endian to native order */
 341 #define BDB_DISK2ID( src, dst ) \
 342         do { unsigned i0; ID tmp = 0; unsigned char *_p;        \
 343                 _p = (unsigned char *)(src);    \
 344                 for ( i0=0; i0<sizeof(ID); i0++ ) {     \
 345                         tmp <<= 8; tmp |= *_p++;        \
 346                 } *(dst) = tmp; \
 347         } while (0)
 348
 349 LDAP_END_DECL
 350
 351 /* for the cache of attribute information (which are indexed, etc.) */
 352 typedef struct bdb_attrinfo {
 353         AttributeDescription *ai_desc; /* attribute description cn;lang-en */
 354         slap_mask_t ai_indexmask;       /* how the attr is indexed      */
 355         slap_mask_t ai_newmask; /* new settings to replace old mask */
 356 #ifdef LDAP_COMP_MATCH
 357         ComponentReference* ai_cr; /*component indexing*/
 358 #endif
 359 } AttrInfo;
 360
 361 /* These flags must not clash with SLAP_INDEX flags or ops in slap.h! */
 362 #define BDB_INDEX_DELETING      0x8000U /* index is being modified */
 363 #define BDB_INDEX_UPDATE_OP     0x03    /* performing an index update */
 364
 365 /* For slapindex to record which attrs in an entry belong to which
 366  * index database
 367  */
 368 typedef struct AttrList {
 369         struct AttrList *next;
 370         Attribute *attr;
 371 } AttrList;
 372
 373 typedef struct IndexRec {
 374         AttrInfo *ai;
 375         AttrList *attrs;
 376 } IndexRec;
 377
 378 #include "proto-bdb.h"
 379
 380 #endif /* _BACK_BDB_H_ */