1 /* back-ldbm.h - ldap ldbm back-end header file */
4 * Copyright 1998-2000 The OpenLDAP Foundation, All Rights Reserved.
5 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
15 #define DEFAULT_CACHE_SIZE 1000
17 #ifdef HAVE_BERKELEY_DB2
18 # define DEFAULT_DBCACHE_SIZE (100 * DEFAULT_DB_PAGE_SIZE)
20 # define DEFAULT_DBCACHE_SIZE 100000
23 #define DEFAULT_DB_DIRECTORY LDAP_RUNDIR LDAP_DIRSEP "openldap-ldbm"
24 #define DEFAULT_MODE 0600
28 #define DN_BASE_PREFIX '='
29 #define DN_ONE_PREFIX '@'
30 #define DN_SUBTREE_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 #define UNKNOWN_PREFIX '?' /* prefix for unknown keys */
46 #define DEFAULT_BLOCKSIZE 8192
49 * This structure represents an id block on disk and an id list
52 * The fields have the following meanings:
54 * b_nmax maximum number of ids in this block. if this is == ALLIDSBLOCK,
55 * then this block represents all ids.
56 * b_nids current number of ids in use in this block. if this
57 * is == INDBLOCK, then this block is an indirect block
58 * containing a list of other blocks containing actual ids.
59 * the list is terminated by an id of NOID.
60 * b_ids a list of the actual ids themselves
65 #define ID_BLOCK_NMAX_OFFSET 0
66 #define ID_BLOCK_NIDS_OFFSET 1
67 #define ID_BLOCK_IDS_OFFSET 2
69 /* all ID_BLOCK macros operate on a pointer to a ID_BLOCK */
71 #define ID_BLOCK_NMAX(b) ((b)[ID_BLOCK_NMAX_OFFSET])
72 #define ID_BLOCK_NIDS(b) ((b)[ID_BLOCK_NIDS_OFFSET])
73 #define ID_BLOCK_ID(b, n) ((b)[ID_BLOCK_IDS_OFFSET+(n)])
75 #define ID_BLOCK_NOID(b, n) (ID_BLOCK_ID((b),(n)) == NOID)
77 #define ID_BLOCK_ALLIDS_VALUE 0
78 #define ID_BLOCK_ALLIDS(b) (ID_BLOCK_NMAX(b) == ID_BLOCK_ALLIDS_VALUE)
80 #define ID_BLOCK_INDIRECT_VALUE 0
81 #define ID_BLOCK_INDIRECT(b) (ID_BLOCK_NIDS(b) == ID_BLOCK_INDIRECT_VALUE)
83 /* for the in-core cache of entries */
84 typedef struct ldbm_cache {
89 Entry *c_lruhead; /* lru - add accessed entries here */
90 Entry *c_lrutail; /* lru - rem lru entries from here */
91 ldap_pvt_thread_mutex_t c_mutex;
94 #define CACHE_READ_LOCK 0
95 #define CACHE_WRITE_LOCK 1
97 /* for the cache of open index files */
98 typedef struct ldbm_dbcache {
108 #define MAXDBCACHE 16
112 ldap_pvt_thread_mutex_t li_nextid_mutex;
113 ldap_pvt_thread_mutex_t li_root_mutex;
114 ldap_pvt_thread_mutex_t li_add_mutex;
119 int li_dblocking; /* lock databases */
120 int li_dbwritesync; /* write sync */
122 DBCache li_dbcache[MAXDBCACHE];
123 ldap_pvt_thread_mutex_t li_dbcache_mutex;
124 ldap_pvt_thread_cond_t li_dbcache_cv;
125 #ifdef HAVE_BERKELEY_DB2
132 #include "proto-back-ldbm.h"
134 #endif /* _back_ldbm_h_ */