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-2011 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 "mdb.h"
  23
  24 LDAP_BEGIN_DECL
  25
  26 #define DN_BASE_PREFIX          SLAP_INDEX_EQUALITY_PREFIX
  27 #define DN_ONE_PREFIX           '%'
  28 #define DN_SUBTREE_PREFIX       '@'
  29
  30 #define MDB_AD2ID               0
  31 #define MDB_DN2ID               1
  32 #define MDB_ID2ENTRY    2
  33 #define MDB_NDB                 3
  34
  35 /* The default search IDL stack cache depth */
  36 #define DEFAULT_SEARCH_STACK_DEPTH      16
  37
  38 /* The minimum we can function with */
  39 #define MINIMUM_SEARCH_STACK_DEPTH      8
  40
  41 #define MDB_INDICES             128
  42
  43 /* Default to 10MB max */
  44 #define DEFAULT_MAPSIZE (10*1048576)
  45
  46 struct mdb_db_info {
  47         struct berval   mdi_name;
  48         MDB_dbi mdi_dbi;
  49 };
  50
  51 #ifdef LDAP_DEVEL
  52 #define MDB_MONITOR_IDX
  53 #endif /* LDAP_DEVEL */
  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         /* The DB_ENV can be tuned via DB_CONFIG */
  68         char            *mi_dbenv_home;
  69         u_int32_t       mi_dbenv_flags;
  70         int                     mi_dbenv_mode;
  71
  72         size_t          mi_mapsize;
  73
  74         int                     mi_ndatabases;
  75         int                     mi_db_opflags;  /* db-specific flags */
  76         struct mdb_db_info **mi_databases;
  77         ldap_pvt_thread_mutex_t mi_database_mutex;
  78
  79         slap_mask_t     mi_defaultmask;
  80         struct mdb_attrinfo             **mi_attrs;
  81         int                     mi_nattrs;
  82         void            *mi_search_stack;
  83         int                     mi_search_stack_depth;
  84
  85         int                     mi_txn_cp;
  86         u_int32_t       mi_txn_cp_min;
  87         u_int32_t       mi_txn_cp_kbyte;
  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_DEL_INDEX   0x08
 101 #define MDB_RE_OPEN             0x10
 102 };
 103
 104 #define mi_id2entry     mi_databases[MDB_ID2ENTRY]
 105 #define mi_dn2id        mi_databases[MDB_DN2ID]
 106 #define mi_ad2id        mi_databases[MDB_AD2ID]
 107
 108 struct mdb_op_info {
 109         OpExtra         moi_oe;
 110         MDB_txn*        moi_txn;
 111         u_int32_t       moi_err;
 112         char            moi_acl_cache;
 113         char            moi_flag;
 114 };
 115 #define MOI_DONTFREE    1
 116
 117 /* Copy an ID "src" to pointer "dst" in big-endian byte order */
 118 #define MDB_ID2DISK( src, dst ) \
 119         do { int i0; ID tmp; unsigned char *_p; \
 120                 tmp = (src); _p = (unsigned char *)(dst);       \
 121                 for ( i0=sizeof(ID)-1; i0>=0; i0-- ) {  \
 122                         _p[i0] = tmp & 0xff; tmp >>= 8; \
 123                 } \
 124         } while(0)
 125
 126 /* Copy a pointer "src" to a pointer "dst" from big-endian to native order */
 127 #define MDB_DISK2ID( src, dst ) \
 128         do { unsigned i0; ID tmp = 0; unsigned char *_p;        \
 129                 _p = (unsigned char *)(src);    \
 130                 for ( i0=0; i0<sizeof(ID); i0++ ) {     \
 131                         tmp <<= 8; tmp |= *_p++;        \
 132                 } *(dst) = tmp; \
 133         } while (0)
 134
 135 LDAP_END_DECL
 136
 137 /* for the cache of attribute information (which are indexed, etc.) */
 138 typedef struct mdb_attrinfo {
 139         AttributeDescription *ai_desc; /* attribute description cn;lang-en */
 140         slap_mask_t ai_indexmask;       /* how the attr is indexed      */
 141         slap_mask_t ai_newmask; /* new settings to replace old mask */
 142 #ifdef LDAP_COMP_MATCH
 143         ComponentReference* ai_cr; /*component indexing*/
 144 #endif
 145         int ai_idx;     /* position in AI array */
 146 } AttrInfo;
 147
 148 /* These flags must not clash with SLAP_INDEX flags or ops in slap.h! */
 149 #define MDB_INDEX_DELETING      0x8000U /* index is being modified */
 150 #define MDB_INDEX_UPDATE_OP     0x03    /* performing an index update */
 151
 152 /* For slapindex to record which attrs in an entry belong to which
 153  * index database
 154  */
 155 typedef struct AttrList {
 156         struct AttrList *next;
 157         Attribute *attr;
 158 } AttrList;
 159
 160 typedef struct IndexRec {
 161         AttrInfo *ai;
 162         AttrList *attrs;
 163 } IndexRec;
 164
 165 #include "proto-mdb.h"
 166
 167 #endif /* _BACK_MDB_H_ */