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