1 /* config.c - mdb backend configuration file routine */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 2000-2013 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 static ConfigDriver mdb_cf_gen;
45 static ConfigTable mdbcfg[] = {
46 { "directory", "dir", 2, 2, 0, ARG_STRING|ARG_MAGIC|MDB_DIRECTORY,
47 mdb_cf_gen, "( OLcfgDbAt:0.1 NAME 'olcDbDirectory' "
48 "DESC 'Directory for database content' "
49 "EQUALITY caseIgnoreMatch "
50 "SYNTAX OMsDirectoryString SINGLE-VALUE )", NULL, NULL },
51 { "checkpoint", "kbyte> <min", 3, 3, 0, ARG_MAGIC|MDB_CHKPT,
52 mdb_cf_gen, "( OLcfgDbAt:1.2 NAME 'olcDbCheckpoint' "
53 "DESC 'Database checkpoint interval in kbytes and minutes' "
54 "SYNTAX OMsDirectoryString SINGLE-VALUE )",NULL, NULL },
55 { "dbnosync", NULL, 1, 2, 0, ARG_ON_OFF|ARG_MAGIC|MDB_DBNOSYNC,
56 mdb_cf_gen, "( OLcfgDbAt:1.4 NAME 'olcDbNoSync' "
57 "DESC 'Disable synchronous database writes' "
58 "SYNTAX OMsBoolean SINGLE-VALUE )", NULL, NULL },
59 { "envflags", "flags", 2, 0, 0, ARG_MAGIC|MDB_ENVFLAGS,
60 mdb_cf_gen, "( OLcfgDbAt:12.3 NAME 'olcDbEnvFlags' "
61 "DESC 'Database environment flags' "
62 "SYNTAX OMsDirectoryString )", NULL, NULL },
63 { "index", "attr> <[pres,eq,approx,sub]", 2, 3, 0, ARG_MAGIC|MDB_INDEX,
64 mdb_cf_gen, "( OLcfgDbAt:0.2 NAME 'olcDbIndex' "
65 "DESC 'Attribute index parameters' "
66 "EQUALITY caseIgnoreMatch "
67 "SYNTAX OMsDirectoryString )", NULL, NULL },
68 { "maxreaders", "num", 2, 2, 0, ARG_UINT|ARG_MAGIC|MDB_MAXREADERS,
69 mdb_cf_gen, "( OLcfgDbAt:12.1 NAME 'olcDbMaxReaders' "
70 "DESC 'Maximum number of threads that may access the DB concurrently' "
71 "SYNTAX OMsInteger SINGLE-VALUE )", NULL, NULL },
72 { "maxsize", "size", 2, 2, 0, ARG_ULONG|ARG_MAGIC|MDB_MAXSIZE,
73 mdb_cf_gen, "( OLcfgDbAt:12.2 NAME 'olcDbMaxSize' "
74 "DESC 'Maximum size of DB in bytes' "
75 "SYNTAX OMsInteger SINGLE-VALUE )", NULL, NULL },
76 { "mode", "mode", 2, 2, 0, ARG_MAGIC|MDB_MODE,
77 mdb_cf_gen, "( OLcfgDbAt:0.3 NAME 'olcDbMode' "
78 "DESC 'Unix permissions of database files' "
79 "SYNTAX OMsDirectoryString SINGLE-VALUE )", NULL, NULL },
80 { "searchstack", "depth", 2, 2, 0, ARG_INT|ARG_MAGIC|MDB_SSTACK,
81 mdb_cf_gen, "( OLcfgDbAt:1.9 NAME 'olcDbSearchStack' "
82 "DESC 'Depth of search stack in IDLs' "
83 "SYNTAX OMsInteger SINGLE-VALUE )", NULL, NULL },
84 { NULL, NULL, 0, 0, 0, ARG_IGNORED,
85 NULL, NULL, NULL, NULL }
88 static ConfigOCs mdbocs[] = {
91 "NAME 'olcMdbConfig' "
92 "DESC 'MDB backend configuration' "
93 "SUP olcDatabaseConfig "
94 "MUST olcDbDirectory "
95 "MAY ( olcDbCheckpoint $ olcDbEnvFlags $ "
96 "olcDbNoSync $ olcDbIndex $ olcDbMaxReaders $ olcDbMaxsize $ "
97 "olcDbMode $ olcDbSearchStack ) )",
98 Cft_Database, mdbcfg },
102 static slap_verbmasks mdb_envflags[] = {
103 { BER_BVC("nosync"), MDB_NOSYNC },
104 { BER_BVC("nometasync"), MDB_NOMETASYNC },
105 { BER_BVC("writemap"), MDB_WRITEMAP },
106 { BER_BVC("mapasync"), MDB_MAPASYNC },
107 { BER_BVC("nordahead"), MDB_NORDAHEAD },
111 /* perform periodic syncs */
113 mdb_checkpoint( void *ctx, void *arg )
115 struct re_s *rtask = arg;
116 struct mdb_info *mdb = rtask->arg;
118 mdb_env_sync( mdb->mi_dbenv, 1 );
119 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
120 ldap_pvt_runqueue_stoptask( &slapd_rq, rtask );
121 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
125 /* reindex entries on the fly */
127 mdb_online_index( void *ctx, void *arg )
129 struct re_s *rtask = arg;
130 BackendDB *be = rtask->arg;
131 struct mdb_info *mdb = be->be_private;
133 Connection conn = {0};
134 OperationBuffer opbuf;
145 connection_fake_init( &conn, &opbuf, ctx );
151 key.mv_size = sizeof(ID);
154 if ( slapd_shutdown )
157 rc = mdb_txn_begin( mdb->mi_dbenv, NULL, 0, &txn );
160 rc = mdb_cursor_open( txn, mdb->mi_id2entry, &curs );
162 mdb_txn_abort( txn );
168 rc = mdb_cursor_get( curs, &key, &data, MDB_SET_RANGE );
170 mdb_txn_abort( txn );
171 if ( rc == MDB_NOTFOUND )
175 memcpy( &id, key.mv_data, sizeof( id ));
178 rc = mdb_id2entry( op, curs, id, &e );
179 mdb_cursor_close( curs );
181 mdb_txn_abort( txn );
182 if ( rc == MDB_NOTFOUND ) {
189 rc = mdb_index_entry( op, txn, MDB_INDEX_UPDATE_OP, e );
190 mdb_entry_return( op, e );
192 rc = mdb_txn_commit( txn );
195 mdb_txn_abort( txn );
199 Debug( LDAP_DEBUG_ANY,
200 LDAP_XSTRING(mdb_online_index) ": database %s: "
201 "txn_commit failed: %s (%d)\n",
202 be->be_suffix[0].bv_val, mdb_strerror(rc), rc );
209 for ( i = 0; i < mdb->mi_nattrs; i++ ) {
210 if ( mdb->mi_attrs[ i ]->ai_indexmask & MDB_INDEX_DELETING
211 || mdb->mi_attrs[ i ]->ai_newmask == 0 )
215 mdb->mi_attrs[ i ]->ai_indexmask = mdb->mi_attrs[ i ]->ai_newmask;
216 mdb->mi_attrs[ i ]->ai_newmask = 0;
219 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
220 ldap_pvt_runqueue_stoptask( &slapd_rq, rtask );
221 mdb->mi_index_task = NULL;
222 ldap_pvt_runqueue_remove( &slapd_rq, rtask );
223 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
228 /* Cleanup loose ends after Modify completes */
230 mdb_cf_cleanup( ConfigArgs *c )
232 struct mdb_info *mdb = c->be->be_private;
235 if ( mdb->mi_flags & MDB_DEL_INDEX ) {
236 mdb_attr_flush( mdb );
237 mdb->mi_flags ^= MDB_DEL_INDEX;
240 if ( mdb->mi_flags & MDB_RE_OPEN ) {
241 mdb->mi_flags ^= MDB_RE_OPEN;
242 rc = c->be->bd_info->bi_db_close( c->be, &c->reply );
244 rc = c->be->bd_info->bi_db_open( c->be, &c->reply );
245 /* If this fails, we need to restart */
248 snprintf( c->cr_msg, sizeof( c->cr_msg ),
249 "failed to reopen database, rc=%d", rc );
250 Debug( LDAP_DEBUG_ANY, LDAP_XSTRING(mdb_cf_cleanup)
251 ": %s\n", c->cr_msg, 0, 0 );
256 if ( mdb->mi_flags & MDB_OPEN_INDEX ) {
257 rc = mdb_attr_dbs_open( c->be, NULL, &c->reply );
265 mdb_cf_gen( ConfigArgs *c )
267 struct mdb_info *mdb = c->be->be_private;
270 if ( c->op == SLAP_CONFIG_EMIT ) {
276 bv.bv_len = snprintf( buf, sizeof(buf), "0%o", mdb->mi_dbenv_mode );
277 if ( bv.bv_len > 0 && bv.bv_len < sizeof(buf) ) {
279 value_add_one( &c->rvalue_vals, &bv );
286 if ( mdb->mi_txn_cp ) {
289 bv.bv_len = snprintf( buf, sizeof(buf), "%ld %ld",
290 (long) mdb->mi_txn_cp_kbyte, (long) mdb->mi_txn_cp_min );
291 if ( bv.bv_len > 0 && bv.bv_len < sizeof(buf) ) {
293 value_add_one( &c->rvalue_vals, &bv );
303 if ( mdb->mi_dbenv_home ) {
304 c->value_string = ch_strdup( mdb->mi_dbenv_home );
311 if ( mdb->mi_dbenv_flags & MDB_NOSYNC )
316 if ( mdb->mi_dbenv_flags ) {
317 mask_to_verbs( mdb_envflags, mdb->mi_dbenv_flags, &c->rvalue_vals );
319 if ( !c->rvalue_vals ) rc = 1;
323 mdb_attr_index_unparse( mdb, &c->rvalue_vals );
324 if ( !c->rvalue_vals ) rc = 1;
328 c->value_int = mdb->mi_search_stack_depth;
332 c->value_int = mdb->mi_readers;
336 c->value_ulong = mdb->mi_mapsize;
340 } else if ( c->op == LDAP_MOD_DELETE ) {
345 /* FIXME: does it make any sense to change the mode,
346 * if we don't exec a chmod()? */
347 mdb->bi_dbenv_mode = SLAPD_DEFAULT_DB_MODE;
351 /* single-valued no-ops */
358 if ( mdb->mi_txn_cp_task ) {
359 struct re_s *re = mdb->mi_txn_cp_task;
360 mdb->mi_txn_cp_task = NULL;
361 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
362 if ( ldap_pvt_runqueue_isrunning( &slapd_rq, re ) )
363 ldap_pvt_runqueue_stoptask( &slapd_rq, re );
364 ldap_pvt_runqueue_remove( &slapd_rq, re );
365 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
370 mdb->mi_flags |= MDB_RE_OPEN;
371 ch_free( mdb->mi_dbenv_home );
372 mdb->mi_dbenv_home = NULL;
373 c->cleanup = mdb_cf_cleanup;
374 ldap_pvt_thread_pool_purgekey( mdb->mi_dbenv );
377 mdb_env_set_flags( mdb->mi_dbenv, MDB_NOSYNC, 0 );
378 mdb->mi_dbenv_flags &= ~MDB_NOSYNC;
382 if ( c->valx == -1 ) {
384 for ( i=0; mdb_envflags[i].mask; i++) {
385 if ( mdb->mi_dbenv_flags & mdb_envflags[i].mask ) {
386 /* not all flags are runtime resettable */
387 rc = mdb_env_set_flags( mdb->mi_dbenv, mdb_envflags[i].mask, 0 );
389 mdb->mi_flags |= MDB_RE_OPEN;
390 c->cleanup = mdb_cf_cleanup;
393 mdb->mi_dbenv_flags ^= mdb_envflags[i].mask;
397 int i = verb_to_mask( c->line, mdb_envflags );
398 if ( mdb_envflags[i].mask & mdb->mi_dbenv_flags ) {
399 rc = mdb_env_set_flags( mdb->mi_dbenv, mdb_envflags[i].mask, 0 );
401 mdb->mi_flags |= MDB_RE_OPEN;
402 c->cleanup = mdb_cf_cleanup;
405 mdb->mi_dbenv_flags ^= mdb_envflags[i].mask;
407 /* unknown keyword */
414 if ( c->valx == -1 ) {
417 /* delete all (FIXME) */
418 for ( i = 0; i < mdb->mi_nattrs; i++ ) {
419 mdb->mi_attrs[i]->ai_indexmask |= MDB_INDEX_DELETING;
421 mdb->mi_flags |= MDB_DEL_INDEX;
422 c->cleanup = mdb_cf_cleanup;
425 struct berval bv, def = BER_BVC("default");
428 for (ptr = c->line; !isspace( (unsigned char) *ptr ); ptr++);
431 bv.bv_len = ptr - bv.bv_val;
432 if ( bvmatch( &bv, &def )) {
433 mdb->mi_defaultmask = 0;
440 sep = bv.bv_val[ bv.bv_len ];
441 bv.bv_val[ bv.bv_len ] = '\0';
442 attrs = ldap_str2charray( bv.bv_val, "," );
444 for ( i = 0; attrs[ i ]; i++ ) {
445 AttributeDescription *ad = NULL;
449 slap_str2ad( attrs[ i ], &ad, &text );
450 /* if we got here... */
451 assert( ad != NULL );
453 ai = mdb_attr_mask( mdb, ad );
454 /* if we got here... */
455 assert( ai != NULL );
457 ai->ai_indexmask |= MDB_INDEX_DELETING;
458 mdb->mi_flags |= MDB_DEL_INDEX;
459 c->cleanup = mdb_cf_cleanup;
462 bv.bv_val[ bv.bv_len ] = sep;
463 ldap_charray_free( attrs );
473 if ( ASCII_DIGIT( c->argv[1][0] ) ) {
477 mode = strtol( c->argv[1], &next, 0 );
478 if ( errno != 0 || next == c->argv[1] || next[0] != '\0' ) {
479 fprintf( stderr, "%s: "
480 "unable to parse mode=\"%s\".\n",
481 c->log, c->argv[1] );
484 mdb->mi_dbenv_mode = mode;
487 char *m = c->argv[1];
488 int who, what, mode = 0;
490 if ( strlen( m ) != STRLENOF("-rwxrwxrwx") ) {
499 for ( who = 0; who < 3; who++ ) {
500 for ( what = 0; what < 3; what++, m++ ) {
503 } else if ( m[0] != "rwx"[what] ) {
506 mode += ((1 << (2 - what)) << 3*(2 - who));
509 mdb->mi_dbenv_mode = mode;
515 if ( lutil_atolx( &l, c->argv[1], 0 ) != 0 ) {
516 fprintf( stderr, "%s: "
517 "invalid kbyte \"%s\" in \"checkpoint\".\n",
518 c->log, c->argv[1] );
521 mdb->mi_txn_cp_kbyte = l;
522 if ( lutil_atolx( &l, c->argv[2], 0 ) != 0 ) {
523 fprintf( stderr, "%s: "
524 "invalid minutes \"%s\" in \"checkpoint\".\n",
525 c->log, c->argv[2] );
528 mdb->mi_txn_cp_min = l;
529 /* If we're in server mode and time-based checkpointing is enabled,
530 * submit a task to perform periodic checkpoints.
532 if ((slapMode & SLAP_SERVER_MODE) && mdb->mi_txn_cp_min ) {
533 struct re_s *re = mdb->mi_txn_cp_task;
535 re->interval.tv_sec = mdb->mi_txn_cp_min * 60;
537 if ( c->be->be_suffix == NULL || BER_BVISNULL( &c->be->be_suffix[0] ) ) {
538 fprintf( stderr, "%s: "
539 "\"checkpoint\" must occur after \"suffix\".\n",
543 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
544 mdb->mi_txn_cp_task = ldap_pvt_runqueue_insert( &slapd_rq,
545 mdb->mi_txn_cp_min * 60, mdb_checkpoint, mdb,
546 LDAP_XSTRING(mdb_checkpoint), c->be->be_suffix[0].bv_val );
547 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
552 case MDB_DIRECTORY: {
554 char *ptr, *testpath;
557 len = strlen( c->value_string );
558 testpath = ch_malloc( len + STRLENOF(LDAP_DIRSEP) + STRLENOF("DUMMY") + 1 );
559 ptr = lutil_strcopy( testpath, c->value_string );
560 *ptr++ = LDAP_DIRSEP[0];
561 strcpy( ptr, "DUMMY" );
562 f = fopen( testpath, "w" );
569 snprintf( c->cr_msg, sizeof( c->cr_msg ), "%s: invalid path: %s",
570 c->log, strerror( errno ));
571 Debug( LDAP_DEBUG_ANY, "%s\n", c->cr_msg, 0, 0 );
575 if ( mdb->mi_dbenv_home )
576 ch_free( mdb->mi_dbenv_home );
577 mdb->mi_dbenv_home = c->value_string;
584 mdb->mi_dbenv_flags |= MDB_NOSYNC;
586 mdb->mi_dbenv_flags ^= MDB_NOSYNC;
587 if ( mdb->mi_flags & MDB_IS_OPEN ) {
588 mdb_env_set_flags( mdb->mi_dbenv, MDB_NOSYNC,
595 for ( i=1; i<c->argc; i++ ) {
596 j = verb_to_mask( c->argv[i], mdb_envflags );
597 if ( mdb_envflags[j].mask ) {
598 if ( mdb->mi_flags & MDB_IS_OPEN )
599 rc = mdb_env_set_flags( mdb->mi_dbenv, mdb_envflags[j].mask, 1 );
603 mdb->mi_flags |= MDB_RE_OPEN;
604 c->cleanup = mdb_cf_cleanup;
607 mdb->mi_dbenv_flags |= mdb_envflags[j].mask;
609 /* unknown keyword */
617 rc = mdb_attr_index_config( mdb, c->fname, c->lineno,
618 c->argc - 1, &c->argv[1], &c->reply);
620 if( rc != LDAP_SUCCESS ) return 1;
621 c->cleanup = mdb_cf_cleanup;
622 mdb->mi_flags |= MDB_OPEN_INDEX;
623 if (( mdb->mi_flags & MDB_IS_OPEN ) && !mdb->mi_index_task ) {
624 /* Start the task as soon as we finish here. Set a long
625 * interval (10 hours) so that it only gets scheduled once.
627 if ( c->be->be_suffix == NULL || BER_BVISNULL( &c->be->be_suffix[0] ) ) {
628 fprintf( stderr, "%s: "
629 "\"index\" must occur after \"suffix\".\n",
633 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
634 mdb->mi_index_task = ldap_pvt_runqueue_insert( &slapd_rq, 36000,
635 mdb_online_index, c->be,
636 LDAP_XSTRING(mdb_online_index), c->be->be_suffix[0].bv_val );
637 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
642 if ( c->value_int < MINIMUM_SEARCH_STACK_DEPTH ) {
644 "%s: depth %d too small, using %d\n",
645 c->log, c->value_int, MINIMUM_SEARCH_STACK_DEPTH );
646 c->value_int = MINIMUM_SEARCH_STACK_DEPTH;
648 mdb->mi_search_stack_depth = c->value_int;
652 mdb->mi_readers = c->value_int;
653 if ( mdb->mi_flags & MDB_IS_OPEN ) {
654 mdb->mi_flags |= MDB_RE_OPEN;
655 c->cleanup = mdb_cf_cleanup;
660 mdb->mi_mapsize = c->value_ulong;
661 if ( mdb->mi_flags & MDB_IS_OPEN ) {
662 mdb->mi_flags |= MDB_RE_OPEN;
663 c->cleanup = mdb_cf_cleanup;
671 int mdb_back_init_cf( BackendInfo *bi )
674 bi->bi_cf_ocs = mdbocs;
676 rc = config_register_schema( mdbcfg, mdbocs );