1 /* config.c - bdb backend configuration file routine */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 2000-2005 The OpenLDAP Foundation.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted only as authorized by the OpenLDAP
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>.
20 #include <ac/string.h>
27 # define SLAP_BDB_ALLOW_DIRTY_READ
30 static ObjectClass *bdb_oc;
32 static ConfigDriver bdb_cf_oc, bdb_cf_gen;
43 static ConfigTable bdbcfg[] = {
44 { "", "", 0, 0, 0, ARG_MAGIC,
45 bdb_cf_oc, NULL, NULL, NULL },
46 { "directory", "dir", 2, 2, 0, ARG_STRING|ARG_OFFSET,
47 (void *)offsetof(struct bdb_info, bi_dbenv_home),
48 "( OLcfgAt:1.1 NAME 'dbDirectory' "
49 "DESC 'Directory for database content' "
50 "EQUALITY caseIgnoreMatch "
51 "SYNTAX OMsDirectoryString )", NULL, NULL },
52 { "cachesize", "size", 2, 2, 0, ARG_INT|ARG_NONZERO|ARG_OFFSET,
53 (void *)offsetof(struct bdb_info, bi_cache.c_maxsize),
54 "( OLcfgAt:1.2 NAME 'dbCacheSize' "
55 "DESC 'Entry cache size in entries' "
56 "SYNTAX OMsInteger )", NULL, NULL },
57 { "checkpoint", "kbyte> <min", 3, 3, 0, ARG_MAGIC|BDB_CHKPT,
58 bdb_cf_gen, "( OLcfgAt:1.3 NAME 'dbCheckpoint' "
59 "DESC 'Database checkpoint interval in kbytes and minutes' "
60 "SYNTAX OMsDirectoryString )",NULL, NULL },
61 { "dbnosync", NULL, 1, 2, 0, ARG_ON_OFF|ARG_MAGIC|BDB_NOSYNC,
62 bdb_cf_gen, "( OLcfgAt:1.4 NAME 'dbNoSync' "
63 "DESC 'Disable synchronous database writes' "
64 "SYNTAX OMsBoolean )", NULL, NULL },
65 { "dirtyread", NULL, 1, 2, 0,
66 #ifdef SLAP_BDB_ALLOW_DIRTY_READ
67 ARG_ON_OFF|ARG_MAGIC|BDB_DIRTYR, bdb_cf_gen,
71 "( OLcfgAt:1.5 NAME 'dbDirtyRead' "
72 "DESC 'Allow reads of uncommitted data' "
73 "SYNTAX OMsBoolean )", NULL, NULL },
74 { "idlcachesize", "size", 2, 2, 0, ARG_INT|ARG_NONZERO|ARG_OFFSET,
75 (void *)offsetof(struct bdb_info,bi_idl_cache_max_size),
76 "( OLcfgAt:1.6 NAME 'dbIDLcacheSize' "
77 "DESC 'IDL cache size in IDLs' "
78 "SYNTAX OMsInteger )", NULL, NULL },
79 { "index", "attr> <[pres,eq,approx,sub]", 3, 3, 0, ARG_MAGIC|BDB_INDEX,
80 bdb_cf_gen, "( OLcfgAt:1.7 NAME 'dbIndex' "
81 "DESC 'Attribute index parameters' "
82 "SYNTAX OMsDirectoryString )", NULL, NULL },
83 { "linearindex", NULL, 1, 2, 0, ARG_ON_OFF|ARG_OFFSET,
84 (void *)offsetof(struct bdb_info, bi_linear_index),
85 "( OLcfgAt:1.8 NAME 'dbLinearIndex' "
86 "DESC 'Index attributes one at a time' "
87 "SYNTAX OMsBoolean )", NULL, NULL },
88 { "lockdetect", "policy", 2, 2, 0, ARG_MAGIC|BDB_LOCKD,
89 bdb_cf_gen, "( OLcfgAt:1.9 NAME 'dbLockDetect' "
90 "DESC 'Deadlock detection algorithm' "
91 "SYNTAX OMsDirectoryString )", NULL, NULL },
92 { "mode", "mode", 2, 2, 0, ARG_LONG|ARG_OFFSET,
93 (void *)offsetof(struct bdb_info, bi_dbenv_mode),
94 "( OLcfgAt:1.10 NAME 'dbMode' "
95 "DESC 'Unix permissions of database files' "
96 "SYNTAX OMsInteger )", NULL, NULL },
97 { "searchstack", "depth", 2, 2, 0, ARG_INT|ARG_MAGIC|BDB_SSTACK,
98 bdb_cf_gen, "( OLcfgAt:1.11 NAME 'dbSearchStack' "
99 "DESC 'Depth of search stack in IDLs' "
100 "SYNTAX OMsInteger )", NULL, NULL },
101 { "shm_key", "key", 2, 2, 0, ARG_INT|ARG_NONZERO|ARG_OFFSET,
102 (void *)offsetof(struct bdb_info, bi_shm_key),
103 "( OLcfgAt:1.12 NAME 'dbShmKey' "
104 "DESC 'Key for shared memory region' "
105 "SYNTAX OMsInteger )", NULL, NULL },
106 { NULL, NULL, 0, 0, 0, ARG_IGNORED,
107 NULL, NULL, NULL, NULL }
110 static ConfigOCs bdbocs[] = {
113 "DESC 'BDB backend configuration' "
115 "MAY ( dbDirectory $ dbCacheSize $ dbCheckpoint $ dbNoSync $ "
116 "dbDirtyRead $ dbIDLcacheSize $ dbIndex $ dbLinearIndex $ "
117 "dbLockDetect $ dbMode $ dbSearchStack $ dbShmKey ) )",
123 bdb_cf_oc(ConfigArgs *c)
126 value_add_one( &c->rvalue_vals, &bdb_oc->soc_cname );
132 static slap_verbmasks bdb_lockd[] = {
133 { "default", DB_LOCK_DEFAULT },
134 { "oldest", DB_LOCK_OLDEST },
135 { "random", DB_LOCK_RANDOM },
136 { "youngest", DB_LOCK_YOUNGEST },
137 { "fewest", DB_LOCK_MINLOCKS },
142 bdb_cf_gen(ConfigArgs *c)
144 struct bdb_info *bdb = c->be->be_private;
151 if (bdb->bi_txn_cp ) {
154 bv.bv_len = sprintf( buf, "%d %d", bdb->bi_txn_cp_kbyte,
155 bdb->bi_txn_cp_min );
157 value_add_one( &c->rvalue_vals, &bv );
164 if ( bdb->bi_dbenv_xflags & DB_TXN_NOSYNC )
174 if ( bdb->bi_lock_detect != DB_LOCK_DEFAULT ) {
176 for (i=0; bdb_lockd[i].word; i++) {
177 if ( bdb->bi_lock_detect == bdb_lockd[i].mask ) {
179 ber_str2bv( bdb_lockd[i].word, 0, 1, &bv );
180 ber_bvarray_add( &c->rvalue_vals, &bv );
189 c->value_int = bdb->bi_search_stack_depth;
197 bdb->bi_txn_cp_kbyte = strtol( c->argv[1], NULL, 0 );
198 bdb->bi_txn_cp_min = strtol( c->argv[2], NULL, 0 );
203 bdb->bi_dbenv_xflags |= DB_TXN_NOSYNC;
205 bdb->bi_dbenv_xflags &= ~DB_TXN_NOSYNC;
209 rc = bdb_attr_index_config( bdb, c->fname, c->lineno,
210 c->argc - 1, &c->argv[1] );
212 if( rc != LDAP_SUCCESS ) return 1;
216 rc = verb_to_mask( c->argv[1], bdb_lockd );
217 if ( !bdb_lockd[rc].word ) {
218 fprintf( stderr, "%s: "
219 "bad policy (%s) in \"lockDetect <policy>\" line\n",
220 c->log, c->argv[1] );
223 bdb->bi_lock_detect = rc;
227 if ( c->value_int < MINIMUM_SEARCH_STACK_DEPTH ) {
229 "%s: depth %d too small, using %d\n",
230 c->log, c->value_int, MINIMUM_SEARCH_STACK_DEPTH );
231 c->value_int = MINIMUM_SEARCH_STACK_DEPTH;
233 bdb->bi_search_stack_depth = c->value_int;
239 int bdb_back_init_cf( BackendInfo *bi )
242 bi->bi_cf_table = bdbcfg;
244 rc = init_config_attrs( bdbcfg );
246 bdbcfg[0].ad = slap_schema.si_ad_objectClass;
247 rc = init_config_ocs( bdbocs );