git.sur5r.net Git - openldap/blob - servers/slapd/back-bdb/config.c

   1 /* config.c - bdb backend configuration file routine */
   2 /* $OpenLDAP$ */
   3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   4  *
   5  * Copyright 2000-2005 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 #include "portable.h"
  18
  19 #include <stdio.h>
  20 #include <ac/string.h>
  21
  22 #include "back-bdb.h"
  23
  24 #include "config.h"
  25
  26 #ifdef DB_DIRTY_READ
  27 #       define  SLAP_BDB_ALLOW_DIRTY_READ
  28 #endif
  29
  30 static ObjectClass *bdb_oc;
  31
  32 static ConfigDriver bdb_cf_oc, bdb_cf_gen;
  33
  34 enum {
  35         BDB_CHKPT = 1,
  36         BDB_NOSYNC,
  37         BDB_DIRTYR,
  38         BDB_INDEX,
  39         BDB_LOCKD,
  40         BDB_SSTACK
  41 };
  42
  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_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,
  68 #else
  69                 ARG_IGNORED, NULL,
  70 #endif
  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_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_INT|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_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 }
 108 };
 109
 110 static ConfigOCs bdbocs[] = {
 111         { "( OLcfgOc:1.1 "
 112                 "NAME 'bdbConfig' "
 113                 "DESC 'BDB backend configuration' "
 114                 "SUP olcDatabaseConfig "
 115                 "MUST dbDirectory "
 116                 "MAY ( dbCacheSize $ dbCheckpoint $ dbNoSync $ "
 117                  "dbDirtyRead $ dbIDLcacheSize $ dbIndex $ dbLinearIndex $ "
 118                  "dbLockDetect $ dbMode $ dbSearchStack $ dbShmKey ) )",
 119                         Cft_Database, &bdb_oc },
 120         { NULL, 0, NULL }
 121 };
 122
 123 static int
 124 bdb_cf_oc(ConfigArgs *c)
 125 {
 126         if ( c->op == SLAP_CONFIG_EMIT ) {
 127                 value_add_one( &c->rvalue_vals, &bdb_oc->soc_cname );
 128                 return 0;
 129         }
 130         return 1;
 131 }
 132
 133 static slap_verbmasks bdb_lockd[] = {
 134         { BER_BVC("default"), DB_LOCK_DEFAULT },
 135         { BER_BVC("oldest"), DB_LOCK_OLDEST },
 136         { BER_BVC("random"), DB_LOCK_RANDOM },
 137         { BER_BVC("youngest"), DB_LOCK_YOUNGEST },
 138         { BER_BVC("fewest"), DB_LOCK_MINLOCKS },
 139         { BER_BVNULL, 0 }
 140 };
 141
 142 static int
 143 bdb_cf_gen(ConfigArgs *c)
 144 {
 145         struct bdb_info *bdb = c->be->be_private;
 146         int rc;
 147
 148         if ( c->op == SLAP_CONFIG_EMIT ) {
 149                 rc = 0;
 150                 switch( c->type ) {
 151                 case BDB_CHKPT:
 152                         if (bdb->bi_txn_cp ) {
 153                                 char buf[64];
 154                                 struct berval bv;
 155                                 bv.bv_len = sprintf( buf, "%d %d", bdb->bi_txn_cp_kbyte,
 156                                         bdb->bi_txn_cp_min );
 157                                 bv.bv_val = buf;
 158                                 value_add_one( &c->rvalue_vals, &bv );
 159                         } else{
 160                                 rc = 1;
 161                         }
 162                         break;
 163
 164                 case BDB_NOSYNC:
 165                         if ( bdb->bi_dbenv_xflags & DB_TXN_NOSYNC )
 166                                 c->value_int = 1;
 167                         break;
 168
 169                 case BDB_INDEX:
 170                         bdb_attr_index_unparse( bdb, &c->rvalue_vals );
 171                         if ( !c->rvalue_vals ) rc = 1;
 172                         break;
 173
 174                 case BDB_LOCKD:
 175                         rc = 1;
 176                         if ( bdb->bi_lock_detect != DB_LOCK_DEFAULT ) {
 177                                 int i;
 178                                 for (i=0; !BER_BVISNULL(&bdb_lockd[i].word); i++) {
 179                                         if ( bdb->bi_lock_detect == bdb_lockd[i].mask ) {
 180                                                 value_add_one( &c->rvalue_vals, &bdb_lockd[i].word );
 181                                                 rc = 0;
 182                                                 break;
 183                                         }
 184                                 }
 185                         }
 186                         break;
 187
 188                 case BDB_SSTACK:
 189                         c->value_int = bdb->bi_search_stack_depth;
 190                         break;
 191                 }
 192                 return rc;
 193         }
 194         switch( c->type ) {
 195         case BDB_CHKPT:
 196                 bdb->bi_txn_cp = 1;
 197                 bdb->bi_txn_cp_kbyte = strtol( c->argv[1], NULL, 0 );
 198                 bdb->bi_txn_cp_min = strtol( c->argv[2], NULL, 0 );
 199                 break;
 200
 201         case BDB_NOSYNC:
 202                 if ( c->value_int )
 203                         bdb->bi_dbenv_xflags |= DB_TXN_NOSYNC;
 204                 else
 205                         bdb->bi_dbenv_xflags &= ~DB_TXN_NOSYNC;
 206                 break;
 207
 208         case BDB_INDEX:
 209                 rc = bdb_attr_index_config( bdb, c->fname, c->lineno,
 210                         c->argc - 1, &c->argv[1] );
 211
 212                 if( rc != LDAP_SUCCESS ) return 1;
 213                 break;
 214
 215         case BDB_LOCKD:
 216                 rc = verb_to_mask( c->argv[1], bdb_lockd );
 217                 if ( BER_BVISNULL(&bdb_lockd[rc].word) ) {
 218                         fprintf( stderr, "%s: "
 219                                 "bad policy (%s) in \"lockDetect <policy>\" line\n",
 220                                 c->log, c->argv[1] );
 221                         return 1;
 222                 }
 223                 bdb->bi_lock_detect = rc;
 224                 break;
 225
 226         case BDB_SSTACK:
 227                 if ( c->value_int < MINIMUM_SEARCH_STACK_DEPTH ) {
 228                         fprintf( stderr,
 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;
 232                 }
 233                 bdb->bi_search_stack_depth = c->value_int;
 234                 break;
 235         }
 236         return 0;
 237 }
 238
 239 int bdb_back_init_cf( BackendInfo *bi )
 240 {
 241         int rc;
 242         bi->bi_cf_table = bdbcfg;
 243
 244         rc = config_register_schema( bdbcfg, bdbocs );
 245         if ( rc ) return rc;
 246         bdbcfg[0].ad = slap_schema.si_ad_objectClass;
 247         return 0;
 248 }