git.sur5r.net Git - openldap/blob - servers/slapd/back-mdb/back-mdb.h

   1 /* back-mdb.h - mdb back-end header file */
   2 /* $OpenLDAP$ */
   3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   4  *
   5  * Copyright 2000-2015 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_MDB_H_
  18 #define _BACK_MDB_H_
  19
  20 #include <portable.h>
  21 #include "slap.h"
  22 #include "lmdb.h"
  23
  24 LDAP_BEGIN_DECL
  25
  26 #undef  MDB_TOOL_IDL_CACHING    /* currently no perf gain */
  27
  28 #define DN_BASE_PREFIX          SLAP_INDEX_EQUALITY_PREFIX
  29 #define DN_ONE_PREFIX           '%'
  30 #define DN_SUBTREE_PREFIX       '@'
  31
  32 #define MDB_AD2ID               0
  33 #define MDB_DN2ID               1
  34 #define MDB_ID2ENTRY    2
  35 #define MDB_NDB                 3
  36
  37 /* The default search IDL stack cache depth */
  38 #define DEFAULT_SEARCH_STACK_DEPTH      16
  39
  40 /* The minimum we can function with */
  41 #define MINIMUM_SEARCH_STACK_DEPTH      8
  42
  43 #define MDB_INDICES             128
  44
  45 #define MDB_MAXADS      65536
  46
  47 /* Default to 10MB max */
  48 #define DEFAULT_MAPSIZE (10*1048576)
  49
  50 /* Most users will never see this */
  51 #define DEFAULT_RTXN_SIZE       10000
  52
  53 #define MDB_MONITOR_IDX
  54
  55 typedef struct mdb_monitor_t {
  56         void            *mdm_cb;
  57         struct berval   mdm_ndn;
  58 } mdb_monitor_t;
  59
  60 /* From ldap_rq.h */
  61 struct re_s;
  62
  63 struct mdb_info {
  64         MDB_env         *mi_dbenv;
  65
  66         /* DB_ENV parameters */
  67         char            *mi_dbenv_home;
  68         uint32_t        mi_dbenv_flags;
  69         int                     mi_dbenv_mode;
  70
  71         size_t          mi_mapsize;
  72         ID                      mi_nextid;
  73         size_t          mi_maxentrysize;
  74
  75         slap_mask_t     mi_defaultmask;
  76         int                     mi_nattrs;
  77         struct mdb_attrinfo             **mi_attrs;
  78         void            *mi_search_stack;
  79         int                     mi_search_stack_depth;
  80         int                     mi_readers;
  81
  82         uint32_t        mi_rtxn_size;
  83         int                     mi_txn_cp;
  84         uint32_t        mi_txn_cp_min;
  85         uint32_t        mi_txn_cp_kbyte;
  86         struct re_s             *mi_txn_cp_task;
  87         struct re_s             *mi_index_task;
  88
  89         mdb_monitor_t   mi_monitor;
  90
  91 #ifdef MDB_MONITOR_IDX
  92         ldap_pvt_thread_mutex_t mi_idx_mutex;
  93         Avlnode         *mi_idx;
  94 #endif /* MDB_MONITOR_IDX */
  95
  96         int             mi_flags;
  97 #define MDB_IS_OPEN             0x01
  98 #define MDB_OPEN_INDEX  0x02
  99 #define MDB_DEL_INDEX   0x08
 100 #define MDB_RE_OPEN             0x10
 101 #define MDB_NEED_UPGRADE        0x20
 102
 103         int mi_numads;
 104
 105         MDB_dbi mi_dbis[MDB_NDB];
 106         AttributeDescription *mi_ads[MDB_MAXADS];
 107         int mi_adxs[MDB_MAXADS];
 108 };
 109
 110 #define mi_id2entry     mi_dbis[MDB_ID2ENTRY]
 111 #define mi_dn2id        mi_dbis[MDB_DN2ID]
 112 #define mi_ad2id        mi_dbis[MDB_AD2ID]
 113
 114 typedef struct mdb_op_info {
 115         OpExtra         moi_oe;
 116         MDB_txn*        moi_txn;
 117         int                     moi_ref;
 118         char            moi_flag;
 119 } mdb_op_info;
 120 #define MOI_READER      0x01
 121 #define MOI_FREEIT      0x02
 122 #define MOI_KEEPER      0x04
 123
 124 /* Copy an ID "src" to pointer "dst" in big-endian byte order */
 125 #define MDB_ID2DISK( src, dst ) \
 126         do { int i0; ID tmp; unsigned char *_p; \
 127                 tmp = (src); _p = (unsigned char *)(dst);       \
 128                 for ( i0=sizeof(ID)-1; i0>=0; i0-- ) {  \
 129                         _p[i0] = tmp & 0xff; tmp >>= 8; \
 130                 } \
 131         } while(0)
 132
 133 /* Copy a pointer "src" to a pointer "dst" from big-endian to native order */
 134 #define MDB_DISK2ID( src, dst ) \
 135         do { unsigned i0; ID tmp = 0; unsigned char *_p;        \
 136                 _p = (unsigned char *)(src);    \
 137                 for ( i0=0; i0<sizeof(ID); i0++ ) {     \
 138                         tmp <<= 8; tmp |= *_p++;        \
 139                 } *(dst) = tmp; \
 140         } while (0)
 141
 142 LDAP_END_DECL
 143
 144 /* for the cache of attribute information (which are indexed, etc.) */
 145 typedef struct mdb_attrinfo {
 146         AttributeDescription *ai_desc; /* attribute description cn;lang-en */
 147         slap_mask_t ai_indexmask;       /* how the attr is indexed      */
 148         slap_mask_t ai_newmask; /* new settings to replace old mask */
 149 #ifdef LDAP_COMP_MATCH
 150         ComponentReference* ai_cr; /*component indexing*/
 151 #endif
 152         Avlnode *ai_root;               /* for tools */
 153         MDB_cursor *ai_cursor;  /* for tools */
 154         int ai_idx;     /* position in AI array */
 155         MDB_dbi ai_dbi;
 156 } AttrInfo;
 157
 158 /* tool threaded indexer state */
 159 typedef struct mdb_attrixinfo {
 160         OpExtra ai_oe;
 161         void *ai_flist;
 162         void *ai_clist;
 163         AttrInfo *ai_ai;
 164 } AttrIxInfo;
 165
 166 /* These flags must not clash with SLAP_INDEX flags or ops in slap.h! */
 167 #define MDB_INDEX_DELETING      0x8000U /* index is being modified */
 168 #define MDB_INDEX_UPDATE_OP     0x03    /* performing an index update */
 169
 170 /* For slapindex to record which attrs in an entry belong to which
 171  * index database
 172  */
 173 typedef struct AttrList {
 174         struct AttrList *next;
 175         Attribute *attr;
 176 } AttrList;
 177
 178 #ifndef CACHELINE
 179 #define CACHELINE       64
 180 #endif
 181
 182 #if defined(__i386) || defined(__x86_64)
 183 #define MISALIGNED_OK   1
 184 #else
 185 #define ALIGNER (sizeof(size_t)-1)
 186 #endif
 187
 188 typedef struct IndexRbody {
 189         AttrInfo *ai;
 190         AttrList *attrs;
 191         void *tptr;
 192         int i;
 193 } IndexRbody;
 194
 195 typedef struct IndexRec {
 196         union {
 197                 IndexRbody irb;
 198 #define ir_ai   iru.irb.ai
 199 #define ir_attrs        iru.irb.attrs
 200 #define ir_tptr iru.irb.tptr
 201 #define ir_i    iru.irb.i
 202                 /* cache line alignment */
 203                 char pad[(sizeof(IndexRbody)+CACHELINE-1) & (!CACHELINE-1)];
 204         } iru;
 205 } IndexRec;
 206
 207 #define MAXRDNS SLAP_LDAPDN_MAXLEN/4
 208
 209 #include "proto-mdb.h"
 210
 211 #endif /* _BACK_MDB_H_ */