openldap/servers/slapd/back-ldbm/back-ldbm.h

167 lines
4.3 KiB
C
Raw Normal View History

1999-08-07 07:07:46 +08:00
/* back-ldbm.h - ldap ldbm back-end header file */
/*
* Copyright 1998-1999 The OpenLDAP Foundation, All Rights Reserved.
* COPYING RESTRICTIONS APPLY, see COPYRIGHT file
*/
1998-08-09 08:43:13 +08:00
#ifndef _BACK_LDBM_H_
#define _BACK_LDBM_H_
#include "ldbm.h"
1998-10-25 09:41:42 +08:00
LDAP_BEGIN_DECL
1998-08-09 08:43:13 +08:00
#define DEFAULT_CACHE_SIZE 1000
1998-10-25 09:41:42 +08:00
#ifdef HAVE_BERKELEY_DB2
# define DEFAULT_DBCACHE_SIZE (100 * DEFAULT_DB_PAGE_SIZE)
#else
# define DEFAULT_DBCACHE_SIZE 100000
#endif
1998-08-09 08:43:13 +08:00
#define DEFAULT_DB_DIRECTORY "/usr/tmp"
#define DEFAULT_MODE 0600
#define SUBLEN 3
/* #undef DN_INDICES *//* generate dn eq, subtree, and parent indices */
#define DN_BASE_PREFIX '='
#define DN_ONE_PREFIX '@'
#define DN_SUBTREE_PREFIX '?'
#define SLAPD_FILTER_DN_ONE ((ber_tag_t) -2)
#define SLAPD_FILTER_DN_SUBTREE ((ber_tag_t) -3)
1998-08-09 08:43:13 +08:00
/*
* there is a single index for each attribute. these prefixes ensure
1998-08-09 08:43:13 +08:00
* that there is no collision among keys.
*/
#define EQ_PREFIX '=' /* prefix for equality keys */
#define APPROX_PREFIX '~' /* prefix for approx keys */
#define SUB_PREFIX '*' /* prefix for substring keys */
#define CONT_PREFIX '\\' /* prefix for continuation keys */
/* allow 3 characters per byte + PREFIX + EOS */
#define CONT_SIZE ( sizeof(long)*3 + 1 + 1 )
/* #undef CONT_POSTFIX *//* postfix original key */
#define UNKNOWN_PREFIX '?' /* prefix for unknown keys */
1998-08-09 08:43:13 +08:00
#define DEFAULT_BLOCKSIZE 8192
/*
* This structure represents an id block on disk and an id list
* in core.
*
* The fields have the following meanings:
*
* b_nmax maximum number of ids in this block. if this is == ALLIDSBLOCK,
* then this block represents all ids.
* b_nids current number of ids in use in this block. if this
* is == INDBLOCK, then this block is an indirect block
* containing a list of other blocks containing actual ids.
* the list is terminated by an id of NOID.
* b_ids a list of the actual ids themselves
*/
typedef ID ID_BLOCK;
#define ID_BLOCK_NMAX_OFFSET 0
#define ID_BLOCK_NIDS_OFFSET 1
#define ID_BLOCK_IDS_OFFSET 2
/* all ID_BLOCK macros operate on a pointer to a ID_BLOCK */
#define ID_BLOCK_NMAX(b) ((b)[ID_BLOCK_NMAX_OFFSET])
#define ID_BLOCK_NIDS(b) ((b)[ID_BLOCK_NIDS_OFFSET])
#define ID_BLOCK_ID(b, n) ((b)[ID_BLOCK_IDS_OFFSET+(n)])
#define ID_BLOCK_NOID(b, n) (ID_BLOCK_ID((b),(n)) == NOID)
#define ID_BLOCK_ALLIDS_VALUE 0
#define ID_BLOCK_ALLIDS(b) (ID_BLOCK_NMAX(b) == ID_BLOCK_ALLIDS_VALUE)
#define ID_BLOCK_INDIRECT_VALUE 0
#define ID_BLOCK_INDIRECT(b) (ID_BLOCK_NIDS(b) == ID_BLOCK_INDIRECT_VALUE)
1998-08-09 08:43:13 +08:00
/* for the in-core cache of entries */
typedef struct ldbm_cache {
1998-08-09 08:43:13 +08:00
int c_maxsize;
int c_cursize;
Avlnode *c_dntree;
Avlnode *c_idtree;
Entry *c_lruhead; /* lru - add accessed entries here */
Entry *c_lrutail; /* lru - rem lru entries from here */
ldap_pvt_thread_mutex_t c_mutex;
} Cache;
1998-08-09 08:43:13 +08:00
#define CACHE_READ_LOCK 0
#define CACHE_WRITE_LOCK 1
1998-08-09 08:43:13 +08:00
/* for the cache of open index files */
typedef struct ldbm_dbcache {
1998-08-09 08:43:13 +08:00
int dbc_refcnt;
int dbc_maxids;
int dbc_maxindirect;
time_t dbc_lastref;
long dbc_blksize;
char *dbc_name;
LDBM dbc_db;
} DBCache;
1998-08-09 08:43:13 +08:00
/* for the cache of attribute information (which are indexed, etc.) */
typedef struct ldbm_attrinfo {
1998-08-09 08:43:13 +08:00
char *ai_type; /* type name (cn, sn, ...) */
int ai_indexmask; /* how the attr is indexed */
#define INDEX_PRESENCE 0x0001
#define INDEX_EQUALITY 0x0002
#define INDEX_APPROX 0x0004
#define INDEX_SUB 0x0008
#define INDEX_UNKNOWN 0x0010
#define INDEX_FROMINIT 0x1000
1998-08-09 08:43:13 +08:00
int ai_syntaxmask; /* what kind of syntax */
/* ...from slap.h...
#define SYNTAX_CIS 0x01
#define SYNTAX_CES 0x02
#define SYNTAX_BIN 0x04
... etc. ...
*/
} AttrInfo;
1998-08-09 08:43:13 +08:00
#define MAXDBCACHE 16
1998-08-09 08:43:13 +08:00
/* this could be made an option */
#ifndef SLAPD_NEXTID_CHUNK
#define SLAPD_NEXTID_CHUNK 32
#endif
1998-08-09 08:43:13 +08:00
struct ldbminfo {
ID li_nextid;
#if SLAPD_NEXTID_CHUNK > 1
ID li_nextid_wrote;
#endif
char *li_nextid_file;
ldap_pvt_thread_mutex_t li_root_mutex;
ldap_pvt_thread_mutex_t li_add_mutex;
ldap_pvt_thread_mutex_t li_nextid_mutex;
1998-08-09 08:43:13 +08:00
int li_mode;
char *li_directory;
Cache li_cache;
1998-08-09 08:43:13 +08:00
Avlnode *li_attrs;
int li_dbcachesize;
int li_dbcachewsync;
DBCache li_dbcache[MAXDBCACHE];
ldap_pvt_thread_mutex_t li_dbcache_mutex;
ldap_pvt_thread_cond_t li_dbcache_cv;
#ifdef HAVE_BERKELEY_DB2
1999-04-01 22:50:34 +08:00
DB_ENV li_db_env;
#endif
1998-08-09 08:43:13 +08:00
};
1998-10-25 09:41:42 +08:00
LDAP_END_DECL
1998-08-09 08:43:13 +08:00
#include "proto-back-ldbm.h"
1998-08-09 08:43:13 +08:00
#endif /* _back_ldbm_h_ */