]> git.sur5r.net Git - openldap/blob - servers/slapd/back-mdb/back-mdb.h
Merge remote-tracking branch 'origin/mdb.master'
[openldap] / 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-2013 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 broken */
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 #ifdef LDAP_DEVEL
51 #define MDB_MONITOR_IDX
52 #endif /* LDAP_DEVEL */
53
54 typedef struct mdb_monitor_t {
55         void            *mdm_cb;
56         struct berval   mdm_ndn;
57 } mdb_monitor_t;
58
59 /* From ldap_rq.h */
60 struct re_s;
61
62 struct mdb_info {
63         MDB_env         *mi_dbenv;
64
65         /* DB_ENV parameters */
66         /* The DB_ENV can be tuned via DB_CONFIG */
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
74         slap_mask_t     mi_defaultmask;
75         int                     mi_nattrs;
76         struct mdb_attrinfo             **mi_attrs;
77         void            *mi_search_stack;
78         int                     mi_search_stack_depth;
79         int                     mi_readers;
80
81         int                     mi_txn_cp;
82         uint32_t        mi_txn_cp_min;
83         uint32_t        mi_txn_cp_kbyte;
84         struct re_s             *mi_txn_cp_task;
85         struct re_s             *mi_index_task;
86
87         mdb_monitor_t   mi_monitor;
88
89 #ifdef MDB_MONITOR_IDX
90         ldap_pvt_thread_mutex_t mi_idx_mutex;
91         Avlnode         *mi_idx;
92 #endif /* MDB_MONITOR_IDX */
93
94         int             mi_flags;
95 #define MDB_IS_OPEN             0x01
96 #define MDB_OPEN_INDEX  0x02
97 #define MDB_DEL_INDEX   0x08
98 #define MDB_RE_OPEN             0x10
99 #define MDB_NEED_UPGRADE        0x20
100
101         int mi_numads;
102
103         MDB_dbi mi_dbis[MDB_NDB];
104         AttributeDescription *mi_ads[MDB_MAXADS];
105         int mi_adxs[MDB_MAXADS];
106 };
107
108 #define mi_id2entry     mi_dbis[MDB_ID2ENTRY]
109 #define mi_dn2id        mi_dbis[MDB_DN2ID]
110 #define mi_ad2id        mi_dbis[MDB_AD2ID]
111
112 typedef struct mdb_op_info {
113         OpExtra         moi_oe;
114         MDB_txn*        moi_txn;
115         int                     moi_ref;
116         char            moi_flag;
117 } mdb_op_info;
118 #define MOI_READER      0x01
119 #define MOI_FREEIT      0x02
120
121 /* Copy an ID "src" to pointer "dst" in big-endian byte order */
122 #define MDB_ID2DISK( src, dst ) \
123         do { int i0; ID tmp; unsigned char *_p; \
124                 tmp = (src); _p = (unsigned char *)(dst);       \
125                 for ( i0=sizeof(ID)-1; i0>=0; i0-- ) {  \
126                         _p[i0] = tmp & 0xff; tmp >>= 8; \
127                 } \
128         } while(0)
129
130 /* Copy a pointer "src" to a pointer "dst" from big-endian to native order */
131 #define MDB_DISK2ID( src, dst ) \
132         do { unsigned i0; ID tmp = 0; unsigned char *_p;        \
133                 _p = (unsigned char *)(src);    \
134                 for ( i0=0; i0<sizeof(ID); i0++ ) {     \
135                         tmp <<= 8; tmp |= *_p++;        \
136                 } *(dst) = tmp; \
137         } while (0)
138
139 LDAP_END_DECL
140
141 /* for the cache of attribute information (which are indexed, etc.) */
142 typedef struct mdb_attrinfo {
143         AttributeDescription *ai_desc; /* attribute description cn;lang-en */
144         slap_mask_t ai_indexmask;       /* how the attr is indexed      */
145         slap_mask_t ai_newmask; /* new settings to replace old mask */
146 #ifdef LDAP_COMP_MATCH
147         ComponentReference* ai_cr; /*component indexing*/
148 #endif
149         Avlnode *ai_root;               /* for tools */
150         void *ai_flist;         /* for tools */
151         void *ai_clist;         /* for tools */
152         MDB_cursor *ai_cursor;  /* for tools */
153         int ai_idx;     /* position in AI array */
154         MDB_dbi ai_dbi;
155 } AttrInfo;
156
157 /* These flags must not clash with SLAP_INDEX flags or ops in slap.h! */
158 #define MDB_INDEX_DELETING      0x8000U /* index is being modified */
159 #define MDB_INDEX_UPDATE_OP     0x03    /* performing an index update */
160
161 /* For slapindex to record which attrs in an entry belong to which
162  * index database 
163  */
164 typedef struct AttrList {
165         struct AttrList *next;
166         Attribute *attr;
167 } AttrList;
168
169 #ifndef CACHELINE
170 #define CACHELINE       64
171 #endif
172
173 #if defined(__i386) || defined(__x86_64)
174 #define MISALIGNED_OK   1
175 #else
176 #define ALIGNER (sizeof(size_t)-1)
177 #endif
178
179 typedef struct IndexRbody {
180         AttrInfo *ai;
181         AttrList *attrs;
182         void *tptr;
183         int i;
184 } IndexRbody;
185
186 typedef struct IndexRec {
187         union {
188                 IndexRbody irb;
189 #define ir_ai   iru.irb.ai
190 #define ir_attrs        iru.irb.attrs
191 #define ir_tptr iru.irb.tptr
192 #define ir_i    iru.irb.i
193                 /* cache line alignment */
194                 char pad[(sizeof(IndexRbody)+CACHELINE-1) & (!CACHELINE-1)];
195         } iru;
196 } IndexRec;
197
198 #define MAXRDNS SLAP_LDAPDN_MAXLEN/4
199
200 #include "proto-mdb.h"
201
202 #endif /* _BACK_MDB_H_ */