1 /* back-ldbm.h - ldap ldbm back-end header file */
3 * Copyright 1998-1999 The OpenLDAP Foundation, All Rights Reserved.
4 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
14 #define DEFAULT_CACHE_SIZE 1000
16 #ifdef HAVE_BERKELEY_DB2
17 # define DEFAULT_DBCACHE_SIZE (100 * DEFAULT_DB_PAGE_SIZE)
19 # define DEFAULT_DBCACHE_SIZE 100000
22 #define DEFAULT_DB_DIRECTORY "/usr/tmp"
23 #define DEFAULT_MODE 0600
27 /* #undef DN_INDICES *//* generate dn eq, subtree, and parent indices */
28 #define DN_ENTRY_PREFIX '='
29 #define DN_SUBTREE_PREFIX '?'
30 #define DN_PARENT_PREFIX '@'
33 * there is a single index for each attribute. these prefixes ensure
34 * that there is no collision among keys.
36 #define EQ_PREFIX '=' /* prefix for equality keys */
37 #define APPROX_PREFIX '~' /* prefix for approx keys */
38 #define SUB_PREFIX '*' /* prefix for substring keys */
39 #define CONT_PREFIX '\\' /* prefix for continuation keys */
41 /* allow 3 characters per byte + PREFIX + EOS */
42 #define CONT_SIZE ( sizeof(long)*3 + 1 + 1 )
44 /* #undef CONT_POSTFIX *//* postfix original key */
46 #define UNKNOWN_PREFIX '?' /* prefix for unknown keys */
48 #define DEFAULT_BLOCKSIZE 8192
51 * This structure represents an id block on disk and an id list
54 * The fields have the following meanings:
56 * b_nmax maximum number of ids in this block. if this is == ALLIDSBLOCK,
57 * then this block represents all ids.
58 * b_nids current number of ids in use in this block. if this
59 * is == INDBLOCK, then this block is an indirect block
60 * containing a list of other blocks containing actual ids.
61 * the list is terminated by an id of NOID.
62 * b_ids a list of the actual ids themselves
67 #define ID_BLOCK_NMAX_OFFSET 0
68 #define ID_BLOCK_NIDS_OFFSET 1
69 #define ID_BLOCK_IDS_OFFSET 2
71 /* all ID_BLOCK macros operate on a pointer to a ID_BLOCK */
73 #define ID_BLOCK_NMAX(b) ((b)[ID_BLOCK_NMAX_OFFSET])
74 #define ID_BLOCK_NIDS(b) ((b)[ID_BLOCK_NIDS_OFFSET])
75 #define ID_BLOCK_ID(b, n) ((b)[ID_BLOCK_IDS_OFFSET+(n)])
77 #define ID_BLOCK_NOID(b, n) (ID_BLOCK_ID((b),(n)) == NOID)
79 #define ID_BLOCK_ALLIDS_VALUE 0
80 #define ID_BLOCK_ALLIDS(b) (ID_BLOCK_NMAX(b) == ID_BLOCK_ALLIDS_VALUE)
82 #define ID_BLOCK_INDIRECT_VALUE 0
83 #define ID_BLOCK_INDIRECT(b) (ID_BLOCK_NIDS(b) == ID_BLOCK_INDIRECT_VALUE)
85 /* for the in-core cache of entries */
86 typedef struct ldbm_cache {
91 Entry *c_lruhead; /* lru - add accessed entries here */
92 Entry *c_lrutail; /* lru - rem lru entries from here */
93 ldap_pvt_thread_mutex_t c_mutex;
96 #define CACHE_READ_LOCK 0
97 #define CACHE_WRITE_LOCK 1
99 /* for the cache of open index files */
100 typedef struct ldbm_dbcache {
110 /* for the cache of attribute information (which are indexed, etc.) */
111 typedef struct ldbm_attrinfo {
112 char *ai_type; /* type name (cn, sn, ...) */
113 int ai_indexmask; /* how the attr is indexed */
114 #define INDEX_PRESENCE 0x01
115 #define INDEX_EQUALITY 0x02
116 #define INDEX_APPROX 0x04
117 #define INDEX_SUB 0x08
118 #define INDEX_UNKNOWN 0x10
119 #define INDEX_FROMINIT 0x20
120 int ai_syntaxmask; /* what kind of syntax */
122 #define SYNTAX_CIS 0x01
123 #define SYNTAX_CES 0x02
124 #define SYNTAX_BIN 0x04
129 #define MAXDBCACHE 16
131 /* this could be made an option */
132 #ifndef SLAPD_NEXTID_CHUNK
133 #define SLAPD_NEXTID_CHUNK 32
138 #if SLAPD_NEXTID_CHUNK > 1
141 char *li_nextid_file;
142 ldap_pvt_thread_mutex_t li_root_mutex;
143 ldap_pvt_thread_mutex_t li_add_mutex;
144 ldap_pvt_thread_mutex_t li_nextid_mutex;
151 DBCache li_dbcache[MAXDBCACHE];
152 ldap_pvt_thread_mutex_t li_dbcache_mutex;
153 ldap_pvt_thread_cond_t li_dbcache_cv;
154 #ifdef HAVE_BERKELEY_DB2
159 extern int ldbm_ignore_nextid_file;
163 #include "proto-back-ldbm.h"
165 #endif /* _back_ldbm_h_ */