1 /* config.c - bdb backend configuration file routine */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 2000-2006 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>.
21 #include <ac/string.h>
31 # define SLAP_BDB_ALLOW_DIRTY_READ
34 #define bdb_cf_gen BDB_SYMBOL(cf_gen)
35 #define bdb_cf_cleanup BDB_SYMBOL(cf_cleanup)
36 #define bdb_checkpoint BDB_SYMBOL(checkpoint)
37 #define bdb_online_index BDB_SYMBOL(online_index)
39 static ConfigDriver bdb_cf_gen;
52 static ConfigTable bdbcfg[] = {
53 { "directory", "dir", 2, 2, 0, ARG_STRING|ARG_MAGIC|BDB_DIRECTORY,
54 bdb_cf_gen, "( OLcfgDbAt:0.1 NAME 'olcDbDirectory' "
55 "DESC 'Directory for database content' "
56 "EQUALITY caseIgnoreMatch "
57 "SYNTAX OMsDirectoryString SINGLE-VALUE )", NULL, NULL },
58 { "cachefree", "size", 2, 2, 0, ARG_INT|ARG_OFFSET,
59 (void *)offsetof(struct bdb_info, bi_cache.c_minfree),
60 "( OLcfgDbAt:1.11 NAME 'olcDbCacheFree' "
61 "DESC 'Number of extra entries to free when max is reached' "
62 "SYNTAX OMsInteger SINGLE-VALUE )", NULL, NULL },
63 { "cachesize", "size", 2, 2, 0, ARG_INT|ARG_OFFSET,
64 (void *)offsetof(struct bdb_info, bi_cache.c_maxsize),
65 "( OLcfgDbAt:1.1 NAME 'olcDbCacheSize' "
66 "DESC 'Entry cache size in entries' "
67 "SYNTAX OMsInteger SINGLE-VALUE )", NULL, NULL },
68 { "checkpoint", "kbyte> <min", 3, 3, 0, ARG_MAGIC|BDB_CHKPT,
69 bdb_cf_gen, "( OLcfgDbAt:1.2 NAME 'olcDbCheckpoint' "
70 "DESC 'Database checkpoint interval in kbytes and minutes' "
71 "SYNTAX OMsDirectoryString SINGLE-VALUE )",NULL, NULL },
72 { "dbconfig", "DB_CONFIG setting", 1, 0, 0, ARG_MAGIC|BDB_CONFIG,
73 bdb_cf_gen, "( OLcfgDbAt:1.3 NAME 'olcDbConfig' "
74 "DESC 'BerkeleyDB DB_CONFIG configuration directives' "
75 "SYNTAX OMsDirectoryString X-ORDERED 'VALUES' )", NULL, NULL },
76 { "dbnosync", NULL, 1, 2, 0, ARG_ON_OFF|ARG_MAGIC|BDB_NOSYNC,
77 bdb_cf_gen, "( OLcfgDbAt:1.4 NAME 'olcDbNoSync' "
78 "DESC 'Disable synchronous database writes' "
79 "SYNTAX OMsBoolean SINGLE-VALUE )", NULL, NULL },
80 { "dirtyread", NULL, 1, 2, 0,
81 #ifdef SLAP_BDB_ALLOW_DIRTY_READ
82 ARG_ON_OFF|ARG_MAGIC|BDB_DIRTYR, bdb_cf_gen,
86 "( OLcfgDbAt:1.5 NAME 'olcDbDirtyRead' "
87 "DESC 'Allow reads of uncommitted data' "
88 "SYNTAX OMsBoolean SINGLE-VALUE )", NULL, NULL },
89 { "idlcachesize", "size", 2, 2, 0, ARG_INT|ARG_OFFSET,
90 (void *)offsetof(struct bdb_info,bi_idl_cache_max_size),
91 "( OLcfgDbAt:1.6 NAME 'olcDbIDLcacheSize' "
92 "DESC 'IDL cache size in IDLs' "
93 "SYNTAX OMsInteger SINGLE-VALUE )", NULL, NULL },
94 { "index", "attr> <[pres,eq,approx,sub]", 2, 3, 0, ARG_MAGIC|BDB_INDEX,
95 bdb_cf_gen, "( OLcfgDbAt:0.2 NAME 'olcDbIndex' "
96 "DESC 'Attribute index parameters' "
97 "EQUALITY caseIgnoreMatch "
98 "SYNTAX OMsDirectoryString )", NULL, NULL },
99 { "linearindex", NULL, 1, 2, 0, ARG_ON_OFF|ARG_OFFSET,
100 (void *)offsetof(struct bdb_info, bi_linear_index),
101 "( OLcfgDbAt:1.7 NAME 'olcDbLinearIndex' "
102 "DESC 'Index attributes one at a time' "
103 "SYNTAX OMsBoolean SINGLE-VALUE )", NULL, NULL },
104 { "lockdetect", "policy", 2, 2, 0, ARG_MAGIC|BDB_LOCKD,
105 bdb_cf_gen, "( OLcfgDbAt:1.8 NAME 'olcDbLockDetect' "
106 "DESC 'Deadlock detection algorithm' "
107 "SYNTAX OMsDirectoryString SINGLE-VALUE )", NULL, NULL },
108 { "mode", "mode", 2, 2, 0, ARG_INT|ARG_OFFSET,
109 (void *)offsetof(struct bdb_info, bi_dbenv_mode),
110 "( OLcfgDbAt:0.3 NAME 'olcDbMode' "
111 "DESC 'Unix permissions of database files' "
112 "SYNTAX OMsInteger SINGLE-VALUE )", NULL, NULL },
113 { "searchstack", "depth", 2, 2, 0, ARG_INT|ARG_MAGIC|BDB_SSTACK,
114 bdb_cf_gen, "( OLcfgDbAt:1.9 NAME 'olcDbSearchStack' "
115 "DESC 'Depth of search stack in IDLs' "
116 "SYNTAX OMsInteger SINGLE-VALUE )", NULL, NULL },
117 { "shm_key", "key", 2, 2, 0, ARG_INT|ARG_OFFSET,
118 (void *)offsetof(struct bdb_info, bi_shm_key),
119 "( OLcfgDbAt:1.10 NAME 'olcDbShmKey' "
120 "DESC 'Key for shared memory region' "
121 "SYNTAX OMsInteger SINGLE-VALUE )", NULL, NULL },
122 { NULL, NULL, 0, 0, 0, ARG_IGNORED,
123 NULL, NULL, NULL, NULL }
126 static ConfigOCs bdbocs[] = {
130 "NAME 'olcHdbConfig' "
131 "DESC 'HDB backend configuration' "
134 "NAME 'olcBdbConfig' "
135 "DESC 'BDB backend configuration' "
137 "SUP olcDatabaseConfig "
138 "MUST olcDbDirectory "
139 "MAY ( olcDbCacheSize $ olcDbCheckpoint $ olcDbConfig $ "
140 "olcDbNoSync $ olcDbDirtyRead $ olcDbIDLcacheSize $ "
141 "olcDbIndex $ olcDbLinearIndex $ olcDbLockDetect $ "
142 "olcDbMode $ olcDbSearchStack $ olcDbShmKey $ "
143 "olcDbCacheFree ) )",
144 Cft_Database, bdbcfg },
148 static slap_verbmasks bdb_lockd[] = {
149 { BER_BVC("default"), DB_LOCK_DEFAULT },
150 { BER_BVC("oldest"), DB_LOCK_OLDEST },
151 { BER_BVC("random"), DB_LOCK_RANDOM },
152 { BER_BVC("youngest"), DB_LOCK_YOUNGEST },
153 { BER_BVC("fewest"), DB_LOCK_MINLOCKS },
157 /* perform periodic checkpoints */
159 bdb_checkpoint( void *ctx, void *arg )
161 struct re_s *rtask = arg;
162 struct bdb_info *bdb = rtask->arg;
164 TXN_CHECKPOINT( bdb->bi_dbenv, bdb->bi_txn_cp_kbyte,
165 bdb->bi_txn_cp_min, 0 );
166 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
167 ldap_pvt_runqueue_stoptask( &slapd_rq, rtask );
168 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
172 /* reindex entries on the fly */
174 bdb_online_index( void *ctx, void *arg )
176 struct re_s *rtask = arg;
177 BackendDB *be = rtask->arg;
178 struct bdb_info *bdb = be->be_private;
180 Connection conn = {0};
181 OperationBuffer opbuf;
182 Operation *op = (Operation *) &opbuf;
194 connection_fake_init( &conn, op, ctx );
203 key.size = key.ulen = sizeof(ID);
204 key.flags = DB_DBT_USERMEM;
206 data.flags = DB_DBT_USERMEM | DB_DBT_PARTIAL;
207 data.dlen = data.ulen = 0;
210 if ( slapd_shutdown )
213 rc = TXN_BEGIN( bdb->bi_dbenv, NULL, &txn, bdb->bi_db_opflags );
216 locker = TXN_ID( txn );
219 BDB_ID2DISK( id, &nid );
220 rc = bdb->bi_id2entry->bdi_db->cursor(
221 bdb->bi_id2entry->bdi_db, txn, &curs, bdb->bi_db_opflags );
226 rc = curs->c_get( curs, &key, &data, DB_SET_RANGE );
227 curs->c_close( curs );
230 if ( rc == DB_NOTFOUND )
232 if ( rc == DB_LOCK_DEADLOCK ) {
233 ldap_pvt_thread_yield();
238 BDB_DISK2ID( &nid, &id );
242 rc = bdb_cache_find_id( op, txn, id, &ei, 0, locker, &lock );
245 if ( rc == DB_LOCK_DEADLOCK ) {
246 ldap_pvt_thread_yield();
249 if ( rc == DB_NOTFOUND ) {
257 rc = bdb_index_entry( op, txn, BDB_INDEX_UPDATE_OP, ei->bei_e );
258 if ( rc == DB_LOCK_DEADLOCK ) {
260 ldap_pvt_thread_yield();
264 rc = TXN_COMMIT( txn, 0 );
274 for ( i = 0; i < bdb->bi_nattrs; i++ ) {
275 if ( bdb->bi_attrs[ i ]->ai_indexmask & BDB_INDEX_DELETING
276 || bdb->bi_attrs[ i ]->ai_newmask == 0 )
280 bdb->bi_attrs[ i ]->ai_indexmask = bdb->bi_attrs[ i ]->ai_newmask;
281 bdb->bi_attrs[ i ]->ai_newmask = 0;
284 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
285 ldap_pvt_runqueue_stoptask( &slapd_rq, rtask );
286 bdb->bi_index_task = NULL;
287 ldap_pvt_runqueue_remove( &slapd_rq, rtask );
288 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
293 /* Cleanup loose ends after Modify completes */
295 bdb_cf_cleanup( ConfigArgs *c )
297 struct bdb_info *bdb = c->be->be_private;
300 if ( bdb->bi_flags & BDB_UPD_CONFIG ) {
301 if ( bdb->bi_db_config ) {
303 FILE *f = fopen( bdb->bi_db_config_path, "w" );
305 for (i=0; bdb->bi_db_config[i].bv_val; i++)
306 fprintf( f, "%s\n", bdb->bi_db_config[i].bv_val );
310 unlink( bdb->bi_db_config_path );
312 bdb->bi_flags ^= BDB_UPD_CONFIG;
315 if ( bdb->bi_flags & BDB_DEL_INDEX ) {
316 bdb_attr_flush( bdb );
317 bdb->bi_flags ^= BDB_DEL_INDEX;
320 if ( bdb->bi_flags & BDB_RE_OPEN ) {
321 bdb->bi_flags ^= BDB_RE_OPEN;
322 rc = c->be->bd_info->bi_db_close( c->be );
324 rc = c->be->bd_info->bi_db_open( c->be );
325 /* If this fails, we need to restart */
328 Debug( LDAP_DEBUG_ANY, LDAP_XSTRING(bdb_cf_cleanup)
329 ": failed to reopen database, rc=%d", rc, 0, 0 );
336 bdb_cf_gen( ConfigArgs *c )
338 struct bdb_info *bdb = c->be->be_private;
341 if ( c->op == SLAP_CONFIG_EMIT ) {
345 if ( bdb->bi_txn_cp ) {
348 bv.bv_len = sprintf( buf, "%d %d", bdb->bi_txn_cp_kbyte,
349 bdb->bi_txn_cp_min );
351 value_add_one( &c->rvalue_vals, &bv );
358 if ( bdb->bi_dbenv_home ) {
359 c->value_string = ch_strdup( bdb->bi_dbenv_home );
366 if ( ( slapMode & SLAP_SERVER_MODE )
367 && !( bdb->bi_flags & BDB_IS_OPEN )
368 && !bdb->bi_db_config )
370 char buf[SLAP_TEXT_BUFLEN];
371 FILE *f = fopen( bdb->bi_db_config_path, "r" );
375 bdb->bi_flags |= BDB_HAS_CONFIG;
376 while ( fgets( buf, sizeof(buf), f )) {
377 ber_str2bv( buf, 0, 1, &bv );
378 if ( bv.bv_len > 0 && bv.bv_val[bv.bv_len-1] == '\n' ) {
380 bv.bv_val[bv.bv_len] = '\0';
382 /* shouldn't need this, but ... */
383 if ( bv.bv_len > 0 && bv.bv_val[bv.bv_len-1] == '\r' ) {
385 bv.bv_val[bv.bv_len] = '\0';
387 ber_bvarray_add( &bdb->bi_db_config, &bv );
392 if ( bdb->bi_db_config ) {
397 for (i=0; !BER_BVISNULL(&bdb->bi_db_config[i]); i++) {
398 bv.bv_len = sprintf( bv.bv_val, "{%d}%s", i,
399 bdb->bi_db_config[i].bv_val );
400 value_add_one( &c->rvalue_vals, &bv );
403 if ( !c->rvalue_vals ) rc = 1;
407 if ( bdb->bi_dbenv_xflags & DB_TXN_NOSYNC )
412 bdb_attr_index_unparse( bdb, &c->rvalue_vals );
413 if ( !c->rvalue_vals ) rc = 1;
418 if ( bdb->bi_lock_detect != DB_LOCK_DEFAULT ) {
420 for (i=0; !BER_BVISNULL(&bdb_lockd[i].word); i++) {
421 if ( bdb->bi_lock_detect == bdb_lockd[i].mask ) {
422 value_add_one( &c->rvalue_vals, &bdb_lockd[i].word );
431 c->value_int = bdb->bi_search_stack_depth;
435 } else if ( c->op == LDAP_MOD_DELETE ) {
438 /* single-valued no-ops */
444 if ( bdb->bi_txn_cp_task ) {
445 struct re_s *re = bdb->bi_txn_cp_task;
446 bdb->bi_txn_cp_task = NULL;
447 if ( ldap_pvt_runqueue_isrunning( &slapd_rq, re ) )
448 ldap_pvt_runqueue_stoptask( &slapd_rq, re );
449 ldap_pvt_runqueue_remove( &slapd_rq, re );
455 ber_bvarray_free( bdb->bi_db_config );
456 bdb->bi_db_config = NULL;
459 ch_free( bdb->bi_db_config[i].bv_val );
460 for (; bdb->bi_db_config[i].bv_val; i++)
461 bdb->bi_db_config[i] = bdb->bi_db_config[i+1];
463 bdb->bi_flags |= BDB_UPD_CONFIG;
464 c->cleanup = bdb_cf_cleanup;
467 bdb->bi_flags |= BDB_RE_OPEN;
468 bdb->bi_flags ^= BDB_HAS_CONFIG;
469 ch_free( bdb->bi_dbenv_home );
470 bdb->bi_dbenv_home = NULL;
471 ch_free( bdb->bi_db_config_path );
472 bdb->bi_db_config_path = NULL;
473 c->cleanup = bdb_cf_cleanup;
474 ldap_pvt_thread_pool_purgekey( bdb->bi_dbenv );
475 ldap_pvt_thread_pool_purgekey( ((char *)bdb->bi_dbenv) + 1 );
478 bdb->bi_dbenv->set_flags( bdb->bi_dbenv, DB_TXN_NOSYNC, 0 );
481 if ( c->valx == -1 ) {
484 /* delete all (FIXME) */
485 for ( i = 0; i < bdb->bi_nattrs; i++ ) {
486 bdb->bi_attrs[i]->ai_indexmask |= BDB_INDEX_DELETING;
488 bdb->bi_flags |= BDB_DEL_INDEX;
489 c->cleanup = bdb_cf_cleanup;
492 struct berval bv, def = BER_BVC("default");
495 for (ptr = c->line; !isspace( (unsigned char) *ptr ); ptr++);
498 bv.bv_len = ptr - bv.bv_val;
499 if ( bvmatch( &bv, &def )) {
500 bdb->bi_defaultmask = 0;
507 sep = bv.bv_val[ bv.bv_len ];
508 bv.bv_val[ bv.bv_len ] = '\0';
509 attrs = ldap_str2charray( bv.bv_val, "," );
511 for ( i = 0; attrs[ i ]; i++ ) {
512 AttributeDescription *ad = NULL;
516 slap_str2ad( attrs[ i ], &ad, &text );
517 /* if we got here... */
518 assert( ad != NULL );
520 ai = bdb_attr_mask( bdb, ad );
521 /* if we got here... */
522 assert( ai != NULL );
524 ai->ai_indexmask |= BDB_INDEX_DELETING;
525 bdb->bi_flags |= BDB_DEL_INDEX;
526 c->cleanup = bdb_cf_cleanup;
529 bv.bv_val[ bv.bv_len ] = sep;
530 ldap_charray_free( attrs );
542 if ( lutil_atolx( &l, c->argv[1], 0 ) != 0 ) {
543 fprintf( stderr, "%s: "
544 "invalid kbyte \"%s\" in \"checkpoint\".\n",
545 c->log, c->argv[1] );
548 bdb->bi_txn_cp_kbyte = l;
549 if ( lutil_atolx( &l, c->argv[2], 0 ) != 0 ) {
550 fprintf( stderr, "%s: "
551 "invalid minutes \"%s\" in \"checkpoint\".\n",
552 c->log, c->argv[2] );
555 bdb->bi_txn_cp_min = l;
556 /* If we're in server mode and time-based checkpointing is enabled,
557 * submit a task to perform periodic checkpoints.
559 if ((slapMode & SLAP_SERVER_MODE) && bdb->bi_txn_cp_min ) {
560 struct re_s *re = bdb->bi_txn_cp_task;
562 re->interval.tv_sec = bdb->bi_txn_cp_min * 60;
564 if ( c->be->be_suffix == NULL || BER_BVISNULL( &c->be->be_suffix[0] ) ) {
565 fprintf( stderr, "%s: "
566 "\"checkpoint\" must occur after \"suffix\".\n",
570 bdb->bi_txn_cp_task = ldap_pvt_runqueue_insert( &slapd_rq,
571 bdb->bi_txn_cp_min * 60, bdb_checkpoint, bdb,
572 LDAP_XSTRING(bdb_checkpoint), c->be->be_suffix[0].bv_val );
581 if ( c->op == SLAP_CONFIG_ADD ) {
582 ptr += STRLENOF("dbconfig");
583 while (!isspace((unsigned char)*ptr)) ptr++;
584 while (isspace((unsigned char)*ptr)) ptr++;
587 if ( bdb->bi_flags & BDB_IS_OPEN ) {
588 bdb->bi_flags |= BDB_UPD_CONFIG;
589 c->cleanup = bdb_cf_cleanup;
591 /* If we're just starting up...
594 /* If a DB_CONFIG file exists, or we don't know the path
595 * to the DB_CONFIG file, ignore these directives
597 if (( bdb->bi_flags & BDB_HAS_CONFIG ) || !bdb->bi_db_config_path )
599 f = fopen( bdb->bi_db_config_path, "a" );
601 /* FIXME: EBCDIC probably needs special handling */
602 fprintf( f, "%s\n", ptr );
606 ber_str2bv( ptr, 0, 1, &bv );
607 ber_bvarray_add( &bdb->bi_db_config, &bv );
611 case BDB_DIRECTORY: {
615 if ( bdb->bi_dbenv_home )
616 ch_free( bdb->bi_dbenv_home );
617 bdb->bi_dbenv_home = c->value_string;
619 /* See if a DB_CONFIG file already exists here */
620 if ( bdb->bi_db_config_path )
621 ch_free( bdb->bi_db_config_path );
622 bdb->bi_db_config_path = ch_malloc( strlen( bdb->bi_dbenv_home ) +
623 STRLENOF(LDAP_DIRSEP) + STRLENOF("DB_CONFIG") + 1 );
624 ptr = lutil_strcopy( bdb->bi_db_config_path, bdb->bi_dbenv_home );
625 *ptr++ = LDAP_DIRSEP[0];
626 strcpy( ptr, "DB_CONFIG" );
628 f = fopen( bdb->bi_db_config_path, "r" );
630 bdb->bi_flags |= BDB_HAS_CONFIG;
638 bdb->bi_dbenv_xflags |= DB_TXN_NOSYNC;
640 bdb->bi_dbenv_xflags &= ~DB_TXN_NOSYNC;
641 if ( bdb->bi_flags & BDB_IS_OPEN ) {
642 bdb->bi_dbenv->set_flags( bdb->bi_dbenv, DB_TXN_NOSYNC,
648 rc = bdb_attr_index_config( bdb, c->fname, c->lineno,
649 c->argc - 1, &c->argv[1] );
651 if( rc != LDAP_SUCCESS ) return 1;
652 if (( bdb->bi_flags & BDB_IS_OPEN ) && !bdb->bi_index_task ) {
653 /* Start the task as soon as we finish here. Set a long
654 * interval (10 hours) so that it only gets scheduled once.
656 if ( c->be->be_suffix == NULL || BER_BVISNULL( &c->be->be_suffix[0] ) ) {
657 fprintf( stderr, "%s: "
658 "\"index\" must occur after \"suffix\".\n",
662 bdb->bi_index_task = ldap_pvt_runqueue_insert( &slapd_rq, 36000,
663 bdb_online_index, c->be,
664 LDAP_XSTRING(bdb_online_index), c->be->be_suffix[0].bv_val );
669 rc = verb_to_mask( c->argv[1], bdb_lockd );
670 if ( BER_BVISNULL(&bdb_lockd[rc].word) ) {
671 fprintf( stderr, "%s: "
672 "bad policy (%s) in \"lockDetect <policy>\" line\n",
673 c->log, c->argv[1] );
676 bdb->bi_lock_detect = rc;
680 if ( c->value_int < MINIMUM_SEARCH_STACK_DEPTH ) {
682 "%s: depth %d too small, using %d\n",
683 c->log, c->value_int, MINIMUM_SEARCH_STACK_DEPTH );
684 c->value_int = MINIMUM_SEARCH_STACK_DEPTH;
686 bdb->bi_search_stack_depth = c->value_int;
692 int bdb_back_init_cf( BackendInfo *bi )
695 bi->bi_cf_ocs = bdbocs;
697 rc = config_register_schema( bdbcfg, bdbocs );