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>.
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 ) {
278 bdb->bi_attrs[ i ]->ai_indexmask = bdb->bi_attrs[ i ]->ai_newmask;
279 bdb->bi_attrs[ i ]->ai_newmask = 0;
282 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
283 ldap_pvt_runqueue_stoptask( &slapd_rq, rtask );
284 bdb->bi_index_task = NULL;
285 ldap_pvt_runqueue_remove( &slapd_rq, rtask );
286 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
291 /* Cleanup loose ends after Modify completes */
293 bdb_cf_cleanup( ConfigArgs *c )
295 struct bdb_info *bdb = c->be->be_private;
298 if ( bdb->bi_flags & BDB_UPD_CONFIG ) {
299 if ( bdb->bi_db_config ) {
301 FILE *f = fopen( bdb->bi_db_config_path, "w" );
303 for (i=0; bdb->bi_db_config[i].bv_val; i++)
304 fprintf( f, "%s\n", bdb->bi_db_config[i].bv_val );
308 unlink( bdb->bi_db_config_path );
310 bdb->bi_flags ^= BDB_UPD_CONFIG;
313 if ( bdb->bi_flags & BDB_DEL_INDEX ) {
314 bdb_attr_flush( bdb );
315 bdb->bi_flags ^= BDB_DEL_INDEX;
318 if ( bdb->bi_flags & BDB_RE_OPEN ) {
319 bdb->bi_flags ^= BDB_RE_OPEN;
320 rc = c->be->bd_info->bi_db_close( c->be );
322 rc = c->be->bd_info->bi_db_open( c->be );
323 /* If this fails, we need to restart */
326 Debug( LDAP_DEBUG_ANY, LDAP_XSTRING(bdb_cf_cleanup)
327 ": failed to reopen database, rc=%d", rc, 0, 0 );
334 bdb_cf_gen(ConfigArgs *c)
336 struct bdb_info *bdb = c->be->be_private;
339 if ( c->op == SLAP_CONFIG_EMIT ) {
343 if (bdb->bi_txn_cp ) {
346 bv.bv_len = sprintf( buf, "%d %d", bdb->bi_txn_cp_kbyte,
347 bdb->bi_txn_cp_min );
349 value_add_one( &c->rvalue_vals, &bv );
356 if ( bdb->bi_dbenv_home ) {
357 c->value_string = ch_strdup( bdb->bi_dbenv_home );
364 if (( slapMode&SLAP_SERVER_MODE ) && !( bdb->bi_flags&BDB_IS_OPEN )
365 && !bdb->bi_db_config ) {
366 char buf[SLAP_TEXT_BUFLEN];
367 FILE *f = fopen( bdb->bi_db_config_path, "r" );
371 bdb->bi_flags |= BDB_HAS_CONFIG;
372 while ( fgets( buf, sizeof(buf), f )) {
373 ber_str2bv( buf, 0, 1, &bv );
374 if ( bv.bv_len > 0 && bv.bv_val[bv.bv_len-1] == '\n' ) {
376 bv.bv_val[bv.bv_len] = '\0';
378 /* shouldn't need this, but ... */
379 if ( bv.bv_len > 0 && bv.bv_val[bv.bv_len-1] == '\r' ) {
381 bv.bv_val[bv.bv_len] = '\0';
383 ber_bvarray_add( &bdb->bi_db_config, &bv );
388 if ( bdb->bi_db_config ) {
393 for (i=0; !BER_BVISNULL(&bdb->bi_db_config[i]); i++) {
394 bv.bv_len = sprintf( bv.bv_val, "{%d}%s", i,
395 bdb->bi_db_config[i].bv_val );
396 value_add_one( &c->rvalue_vals, &bv );
399 if ( !c->rvalue_vals ) rc = 1;
403 if ( bdb->bi_dbenv_xflags & DB_TXN_NOSYNC )
408 bdb_attr_index_unparse( bdb, &c->rvalue_vals );
409 if ( !c->rvalue_vals ) rc = 1;
414 if ( bdb->bi_lock_detect != DB_LOCK_DEFAULT ) {
416 for (i=0; !BER_BVISNULL(&bdb_lockd[i].word); i++) {
417 if ( bdb->bi_lock_detect == bdb_lockd[i].mask ) {
418 value_add_one( &c->rvalue_vals, &bdb_lockd[i].word );
427 c->value_int = bdb->bi_search_stack_depth;
431 } else if ( c->op == LDAP_MOD_DELETE ) {
434 /* single-valued no-ops */
440 if ( bdb->bi_txn_cp_task ) {
441 struct re_s *re = bdb->bi_txn_cp_task;
442 bdb->bi_txn_cp_task = NULL;
443 if ( ldap_pvt_runqueue_isrunning( &slapd_rq, re ))
444 ldap_pvt_runqueue_stoptask( &slapd_rq, re );
445 ldap_pvt_runqueue_remove( &slapd_rq, re );
451 ber_bvarray_free( bdb->bi_db_config );
452 bdb->bi_db_config = NULL;
455 ch_free( bdb->bi_db_config[i].bv_val );
456 for (; bdb->bi_db_config[i].bv_val; i++)
457 bdb->bi_db_config[i] = bdb->bi_db_config[i+1];
459 bdb->bi_flags |= BDB_UPD_CONFIG;
460 c->cleanup = bdb_cf_cleanup;
463 bdb->bi_flags |= BDB_RE_OPEN;
464 bdb->bi_flags ^= BDB_HAS_CONFIG;
465 ch_free( bdb->bi_dbenv_home );
466 bdb->bi_dbenv_home = NULL;
467 ch_free( bdb->bi_db_config_path );
468 bdb->bi_db_config_path = NULL;
469 c->cleanup = bdb_cf_cleanup;
470 ldap_pvt_thread_pool_purgekey( bdb->bi_dbenv );
471 ldap_pvt_thread_pool_purgekey( ((char *)bdb->bi_dbenv) + 1 );
474 bdb->bi_dbenv->set_flags( bdb->bi_dbenv, DB_TXN_NOSYNC, 0 );
477 if ( c->valx == -1 ) {
480 /* delete all (FIXME) */
481 for ( i = 0; i < bdb->bi_nattrs; i++ ) {
482 bdb->bi_attrs[i]->ai_indexmask |= BDB_INDEX_DELETING;
484 bdb->bi_flags |= BDB_DEL_INDEX;
485 c->cleanup = bdb_cf_cleanup;
488 struct berval bv, def = BER_BVC("default");
491 for (ptr = c->line; !isspace( *ptr ); ptr++);
494 bv.bv_len = ptr - bv.bv_val;
495 if ( bvmatch( &bv, &def )) {
496 bdb->bi_defaultmask = 0;
503 sep = bv.bv_val[ bv.bv_len ];
504 bv.bv_val[ bv.bv_len ] = '\0';
505 attrs = ldap_str2charray( bv.bv_val, "," );
507 for ( i = 0; attrs[ i ]; i++ ) {
508 AttributeDescription *ad = NULL;
512 slap_str2ad( attrs[ i ], &ad, &text );
513 /* if we got here... */
514 assert( ad != NULL );
516 ai = bdb_attr_mask( bdb, ad );
517 /* if we got here... */
518 assert( ai != NULL );
520 ai->ai_indexmask |= BDB_INDEX_DELETING;
521 bdb->bi_flags |= BDB_DEL_INDEX;
522 c->cleanup = bdb_cf_cleanup;
525 bv.bv_val[ bv.bv_len ] = sep;
526 ldap_charray_free( attrs );
538 if ( lutil_atolx( &l, c->argv[1], 0 ) != 0 ) {
539 fprintf( stderr, "%s: "
540 "invalid kbyte \"%s\" in \"checkpoint\".\n",
541 c->log, c->argv[1] );
544 bdb->bi_txn_cp_kbyte = l;
545 if ( lutil_atolx( &l, c->argv[2], 0 ) != 0 ) {
546 fprintf( stderr, "%s: "
547 "invalid minutes \"%s\" in \"checkpoint\".\n",
548 c->log, c->argv[2] );
551 bdb->bi_txn_cp_min = l;
552 /* If we're in server mode and time-based checkpointing is enabled,
553 * submit a task to perform periodic checkpoints.
555 if ((slapMode & SLAP_SERVER_MODE) && bdb->bi_txn_cp_min ) {
556 struct re_s *re = bdb->bi_txn_cp_task;
558 re->interval.tv_sec = bdb->bi_txn_cp_min * 60;
560 if ( c->be->be_suffix == NULL || BER_BVISNULL( &c->be->be_suffix[0] ) ) {
561 fprintf( stderr, "%s: "
562 "\"checkpoint\" must occur after \"suffix\".\n",
566 bdb->bi_txn_cp_task = ldap_pvt_runqueue_insert( &slapd_rq,
567 bdb->bi_txn_cp_min * 60, bdb_checkpoint, bdb,
568 LDAP_XSTRING(bdb_checkpoint), c->be->be_suffix[0].bv_val );
577 if ( c->op == SLAP_CONFIG_ADD ) {
578 ptr += STRLENOF("dbconfig");
579 while (!isspace(*ptr)) ptr++;
580 while (isspace(*ptr)) ptr++;
583 if ( bdb->bi_flags & BDB_IS_OPEN ) {
584 bdb->bi_flags |= BDB_UPD_CONFIG;
585 c->cleanup = bdb_cf_cleanup;
587 /* If we're just starting up...
590 /* If a DB_CONFIG file exists, or we don't know the path
591 * to the DB_CONFIG file, ignore these directives
593 if (( bdb->bi_flags & BDB_HAS_CONFIG ) || !bdb->bi_db_config_path )
595 f = fopen( bdb->bi_db_config_path, "a" );
597 /* FIXME: EBCDIC probably needs special handling */
598 fprintf( f, "%s\n", ptr );
602 ber_str2bv( ptr, 0, 1, &bv );
603 ber_bvarray_add( &bdb->bi_db_config, &bv );
607 case BDB_DIRECTORY: {
611 if ( bdb->bi_dbenv_home )
612 ch_free( bdb->bi_dbenv_home );
613 bdb->bi_dbenv_home = c->value_string;
615 /* See if a DB_CONFIG file already exists here */
616 if ( bdb->bi_db_config_path )
617 ch_free( bdb->bi_db_config_path );
618 bdb->bi_db_config_path = ch_malloc( strlen( bdb->bi_dbenv_home ) +
619 STRLENOF(LDAP_DIRSEP) + STRLENOF("DB_CONFIG") + 1 );
620 ptr = lutil_strcopy( bdb->bi_db_config_path, bdb->bi_dbenv_home );
621 *ptr++ = LDAP_DIRSEP[0];
622 strcpy( ptr, "DB_CONFIG" );
624 f = fopen( bdb->bi_db_config_path, "r" );
626 bdb->bi_flags |= BDB_HAS_CONFIG;
634 bdb->bi_dbenv_xflags |= DB_TXN_NOSYNC;
636 bdb->bi_dbenv_xflags &= ~DB_TXN_NOSYNC;
637 if ( bdb->bi_flags & BDB_IS_OPEN ) {
638 bdb->bi_dbenv->set_flags( bdb->bi_dbenv, DB_TXN_NOSYNC,
644 rc = bdb_attr_index_config( bdb, c->fname, c->lineno,
645 c->argc - 1, &c->argv[1] );
647 if( rc != LDAP_SUCCESS ) return 1;
648 if (( bdb->bi_flags & BDB_IS_OPEN ) && !bdb->bi_index_task ) {
649 /* Start the task as soon as we finish here. Set a long
650 * interval (10 hours) so that it only gets scheduled once.
652 if ( c->be->be_suffix == NULL || BER_BVISNULL( &c->be->be_suffix[0] ) ) {
653 fprintf( stderr, "%s: "
654 "\"index\" must occur after \"suffix\".\n",
658 bdb->bi_index_task = ldap_pvt_runqueue_insert( &slapd_rq, 36000,
659 bdb_online_index, c->be,
660 LDAP_XSTRING(bdb_online_index), c->be->be_suffix[0].bv_val );
665 rc = verb_to_mask( c->argv[1], bdb_lockd );
666 if ( BER_BVISNULL(&bdb_lockd[rc].word) ) {
667 fprintf( stderr, "%s: "
668 "bad policy (%s) in \"lockDetect <policy>\" line\n",
669 c->log, c->argv[1] );
672 bdb->bi_lock_detect = rc;
676 if ( c->value_int < MINIMUM_SEARCH_STACK_DEPTH ) {
678 "%s: depth %d too small, using %d\n",
679 c->log, c->value_int, MINIMUM_SEARCH_STACK_DEPTH );
680 c->value_int = MINIMUM_SEARCH_STACK_DEPTH;
682 bdb->bi_search_stack_depth = c->value_int;
688 int bdb_back_init_cf( BackendInfo *bi )
691 bi->bi_cf_ocs = bdbocs;
693 rc = config_register_schema( bdbcfg, bdbocs );