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 },
110 /* perform periodic syncs */
112 mdb_checkpoint( void *ctx, void *arg )
114 struct re_s *rtask = arg;
115 struct mdb_info *mdb = rtask->arg;
117 mdb_env_sync( mdb->mi_dbenv, 1 );
118 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
119 ldap_pvt_runqueue_stoptask( &slapd_rq, rtask );
120 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
124 /* reindex entries on the fly */
126 mdb_online_index( void *ctx, void *arg )
128 struct re_s *rtask = arg;
129 BackendDB *be = rtask->arg;
130 struct mdb_info *mdb = be->be_private;
132 Connection conn = {0};
133 OperationBuffer opbuf;
144 connection_fake_init( &conn, &opbuf, ctx );
150 key.mv_size = sizeof(ID);
153 if ( slapd_shutdown )
156 rc = mdb_txn_begin( mdb->mi_dbenv, NULL, 0, &txn );
159 rc = mdb_cursor_open( txn, mdb->mi_id2entry, &curs );
161 mdb_txn_abort( txn );
167 rc = mdb_cursor_get( curs, &key, &data, MDB_SET_RANGE );
169 mdb_txn_abort( txn );
170 if ( rc == MDB_NOTFOUND )
174 memcpy( &id, key.mv_data, sizeof( id ));
177 rc = mdb_id2entry( op, curs, id, &e );
178 mdb_cursor_close( curs );
180 mdb_txn_abort( txn );
181 if ( rc == MDB_NOTFOUND ) {
188 rc = mdb_index_entry( op, txn, MDB_INDEX_UPDATE_OP, e );
189 mdb_entry_return( op, e );
191 rc = mdb_txn_commit( txn );
194 mdb_txn_abort( txn );
198 Debug( LDAP_DEBUG_ANY,
199 LDAP_XSTRING(mdb_online_index) ": database %s: "
200 "txn_commit failed: %s (%d)\n",
201 be->be_suffix[0].bv_val, mdb_strerror(rc), rc );
208 for ( i = 0; i < mdb->mi_nattrs; i++ ) {
209 if ( mdb->mi_attrs[ i ]->ai_indexmask & MDB_INDEX_DELETING
210 || mdb->mi_attrs[ i ]->ai_newmask == 0 )
214 mdb->mi_attrs[ i ]->ai_indexmask = mdb->mi_attrs[ i ]->ai_newmask;
215 mdb->mi_attrs[ i ]->ai_newmask = 0;
218 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
219 ldap_pvt_runqueue_stoptask( &slapd_rq, rtask );
220 mdb->mi_index_task = NULL;
221 ldap_pvt_runqueue_remove( &slapd_rq, rtask );
222 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
227 /* Cleanup loose ends after Modify completes */
229 mdb_cf_cleanup( ConfigArgs *c )
231 struct mdb_info *mdb = c->be->be_private;
234 if ( mdb->mi_flags & MDB_DEL_INDEX ) {
235 mdb_attr_flush( mdb );
236 mdb->mi_flags ^= MDB_DEL_INDEX;
239 if ( mdb->mi_flags & MDB_RE_OPEN ) {
240 mdb->mi_flags ^= MDB_RE_OPEN;
241 rc = c->be->bd_info->bi_db_close( c->be, &c->reply );
243 rc = c->be->bd_info->bi_db_open( c->be, &c->reply );
244 /* If this fails, we need to restart */
247 snprintf( c->cr_msg, sizeof( c->cr_msg ),
248 "failed to reopen database, rc=%d", rc );
249 Debug( LDAP_DEBUG_ANY, LDAP_XSTRING(mdb_cf_cleanup)
250 ": %s\n", c->cr_msg, 0, 0 );
255 if ( mdb->mi_flags & MDB_OPEN_INDEX ) {
256 rc = mdb_attr_dbs_open( c->be, NULL, &c->reply );
264 mdb_cf_gen( ConfigArgs *c )
266 struct mdb_info *mdb = c->be->be_private;
269 if ( c->op == SLAP_CONFIG_EMIT ) {
275 bv.bv_len = snprintf( buf, sizeof(buf), "0%o", mdb->mi_dbenv_mode );
276 if ( bv.bv_len > 0 && bv.bv_len < sizeof(buf) ) {
278 value_add_one( &c->rvalue_vals, &bv );
285 if ( mdb->mi_txn_cp ) {
288 bv.bv_len = snprintf( buf, sizeof(buf), "%ld %ld",
289 (long) mdb->mi_txn_cp_kbyte, (long) mdb->mi_txn_cp_min );
290 if ( bv.bv_len > 0 && bv.bv_len < sizeof(buf) ) {
292 value_add_one( &c->rvalue_vals, &bv );
302 if ( mdb->mi_dbenv_home ) {
303 c->value_string = ch_strdup( mdb->mi_dbenv_home );
310 if ( mdb->mi_dbenv_flags & MDB_NOSYNC )
315 if ( mdb->mi_dbenv_flags ) {
316 mask_to_verbs( mdb_envflags, mdb->mi_dbenv_flags, &c->rvalue_vals );
318 if ( !c->rvalue_vals ) rc = 1;
322 mdb_attr_index_unparse( mdb, &c->rvalue_vals );
323 if ( !c->rvalue_vals ) rc = 1;
327 c->value_int = mdb->mi_search_stack_depth;
331 c->value_int = mdb->mi_readers;
335 c->value_ulong = mdb->mi_mapsize;
339 } else if ( c->op == LDAP_MOD_DELETE ) {
344 /* FIXME: does it make any sense to change the mode,
345 * if we don't exec a chmod()? */
346 mdb->bi_dbenv_mode = SLAPD_DEFAULT_DB_MODE;
350 /* single-valued no-ops */
357 if ( mdb->mi_txn_cp_task ) {
358 struct re_s *re = mdb->mi_txn_cp_task;
359 mdb->mi_txn_cp_task = NULL;
360 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
361 if ( ldap_pvt_runqueue_isrunning( &slapd_rq, re ) )
362 ldap_pvt_runqueue_stoptask( &slapd_rq, re );
363 ldap_pvt_runqueue_remove( &slapd_rq, re );
364 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
369 mdb->mi_flags |= MDB_RE_OPEN;
370 ch_free( mdb->mi_dbenv_home );
371 mdb->mi_dbenv_home = NULL;
372 c->cleanup = mdb_cf_cleanup;
373 ldap_pvt_thread_pool_purgekey( mdb->mi_dbenv );
376 mdb_env_set_flags( mdb->mi_dbenv, MDB_NOSYNC, 0 );
377 mdb->mi_dbenv_flags &= ~MDB_NOSYNC;
381 if ( c->valx == -1 ) {
383 for ( i=0; mdb_envflags[i].mask; i++) {
384 if ( mdb->mi_dbenv_flags & mdb_envflags[i].mask ) {
385 /* not all flags are runtime resettable */
386 rc = mdb_env_set_flags( mdb->mi_dbenv, mdb_envflags[i].mask, 0 );
388 mdb->mi_flags |= MDB_RE_OPEN;
389 c->cleanup = mdb_cf_cleanup;
392 mdb->mi_dbenv_flags ^= mdb_envflags[i].mask;
396 int i = verb_to_mask( c->line, mdb_envflags );
397 if ( mdb_envflags[i].mask & mdb->mi_dbenv_flags ) {
398 rc = mdb_env_set_flags( mdb->mi_dbenv, mdb_envflags[i].mask, 0 );
400 mdb->mi_flags |= MDB_RE_OPEN;
401 c->cleanup = mdb_cf_cleanup;
404 mdb->mi_dbenv_flags ^= mdb_envflags[i].mask;
406 /* unknown keyword */
413 if ( c->valx == -1 ) {
416 /* delete all (FIXME) */
417 for ( i = 0; i < mdb->mi_nattrs; i++ ) {
418 mdb->mi_attrs[i]->ai_indexmask |= MDB_INDEX_DELETING;
420 mdb->mi_flags |= MDB_DEL_INDEX;
421 c->cleanup = mdb_cf_cleanup;
424 struct berval bv, def = BER_BVC("default");
427 for (ptr = c->line; !isspace( (unsigned char) *ptr ); ptr++);
430 bv.bv_len = ptr - bv.bv_val;
431 if ( bvmatch( &bv, &def )) {
432 mdb->mi_defaultmask = 0;
439 sep = bv.bv_val[ bv.bv_len ];
440 bv.bv_val[ bv.bv_len ] = '\0';
441 attrs = ldap_str2charray( bv.bv_val, "," );
443 for ( i = 0; attrs[ i ]; i++ ) {
444 AttributeDescription *ad = NULL;
448 slap_str2ad( attrs[ i ], &ad, &text );
449 /* if we got here... */
450 assert( ad != NULL );
452 ai = mdb_attr_mask( mdb, ad );
453 /* if we got here... */
454 assert( ai != NULL );
456 ai->ai_indexmask |= MDB_INDEX_DELETING;
457 mdb->mi_flags |= MDB_DEL_INDEX;
458 c->cleanup = mdb_cf_cleanup;
461 bv.bv_val[ bv.bv_len ] = sep;
462 ldap_charray_free( attrs );
472 if ( ASCII_DIGIT( c->argv[1][0] ) ) {
476 mode = strtol( c->argv[1], &next, 0 );
477 if ( errno != 0 || next == c->argv[1] || next[0] != '\0' ) {
478 fprintf( stderr, "%s: "
479 "unable to parse mode=\"%s\".\n",
480 c->log, c->argv[1] );
483 mdb->mi_dbenv_mode = mode;
486 char *m = c->argv[1];
487 int who, what, mode = 0;
489 if ( strlen( m ) != STRLENOF("-rwxrwxrwx") ) {
498 for ( who = 0; who < 3; who++ ) {
499 for ( what = 0; what < 3; what++, m++ ) {
502 } else if ( m[0] != "rwx"[what] ) {
505 mode += ((1 << (2 - what)) << 3*(2 - who));
508 mdb->mi_dbenv_mode = mode;
514 if ( lutil_atolx( &l, c->argv[1], 0 ) != 0 ) {
515 fprintf( stderr, "%s: "
516 "invalid kbyte \"%s\" in \"checkpoint\".\n",
517 c->log, c->argv[1] );
520 mdb->mi_txn_cp_kbyte = l;
521 if ( lutil_atolx( &l, c->argv[2], 0 ) != 0 ) {
522 fprintf( stderr, "%s: "
523 "invalid minutes \"%s\" in \"checkpoint\".\n",
524 c->log, c->argv[2] );
527 mdb->mi_txn_cp_min = l;
528 /* If we're in server mode and time-based checkpointing is enabled,
529 * submit a task to perform periodic checkpoints.
531 if ((slapMode & SLAP_SERVER_MODE) && mdb->mi_txn_cp_min ) {
532 struct re_s *re = mdb->mi_txn_cp_task;
534 re->interval.tv_sec = mdb->mi_txn_cp_min * 60;
536 if ( c->be->be_suffix == NULL || BER_BVISNULL( &c->be->be_suffix[0] ) ) {
537 fprintf( stderr, "%s: "
538 "\"checkpoint\" must occur after \"suffix\".\n",
542 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
543 mdb->mi_txn_cp_task = ldap_pvt_runqueue_insert( &slapd_rq,
544 mdb->mi_txn_cp_min * 60, mdb_checkpoint, mdb,
545 LDAP_XSTRING(mdb_checkpoint), c->be->be_suffix[0].bv_val );
546 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
551 case MDB_DIRECTORY: {
553 char *ptr, *testpath;
556 len = strlen( c->value_string );
557 testpath = ch_malloc( len + STRLENOF(LDAP_DIRSEP) + STRLENOF("DUMMY") + 1 );
558 ptr = lutil_strcopy( testpath, c->value_string );
559 *ptr++ = LDAP_DIRSEP[0];
560 strcpy( ptr, "DUMMY" );
561 f = fopen( testpath, "w" );
568 snprintf( c->cr_msg, sizeof( c->cr_msg ), "%s: invalid path: %s",
569 c->log, strerror( errno ));
570 Debug( LDAP_DEBUG_ANY, "%s\n", c->cr_msg, 0, 0 );
574 if ( mdb->mi_dbenv_home )
575 ch_free( mdb->mi_dbenv_home );
576 mdb->mi_dbenv_home = c->value_string;
583 mdb->mi_dbenv_flags |= MDB_NOSYNC;
585 mdb->mi_dbenv_flags ^= MDB_NOSYNC;
586 if ( mdb->mi_flags & MDB_IS_OPEN ) {
587 mdb_env_set_flags( mdb->mi_dbenv, MDB_NOSYNC,
594 for ( i=1; i<c->argc; i++ ) {
595 j = verb_to_mask( c->argv[i], mdb_envflags );
596 if ( mdb_envflags[j].mask ) {
597 if ( mdb->mi_flags & MDB_IS_OPEN )
598 rc = mdb_env_set_flags( mdb->mi_dbenv, mdb_envflags[j].mask, 1 );
602 mdb->mi_flags |= MDB_RE_OPEN;
603 c->cleanup = mdb_cf_cleanup;
606 mdb->mi_dbenv_flags |= mdb_envflags[j].mask;
608 /* unknown keyword */
616 rc = mdb_attr_index_config( mdb, c->fname, c->lineno,
617 c->argc - 1, &c->argv[1], &c->reply);
619 if( rc != LDAP_SUCCESS ) return 1;
620 c->cleanup = mdb_cf_cleanup;
621 mdb->mi_flags |= MDB_OPEN_INDEX;
622 if (( mdb->mi_flags & MDB_IS_OPEN ) && !mdb->mi_index_task ) {
623 /* Start the task as soon as we finish here. Set a long
624 * interval (10 hours) so that it only gets scheduled once.
626 if ( c->be->be_suffix == NULL || BER_BVISNULL( &c->be->be_suffix[0] ) ) {
627 fprintf( stderr, "%s: "
628 "\"index\" must occur after \"suffix\".\n",
632 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
633 mdb->mi_index_task = ldap_pvt_runqueue_insert( &slapd_rq, 36000,
634 mdb_online_index, c->be,
635 LDAP_XSTRING(mdb_online_index), c->be->be_suffix[0].bv_val );
636 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
641 if ( c->value_int < MINIMUM_SEARCH_STACK_DEPTH ) {
643 "%s: depth %d too small, using %d\n",
644 c->log, c->value_int, MINIMUM_SEARCH_STACK_DEPTH );
645 c->value_int = MINIMUM_SEARCH_STACK_DEPTH;
647 mdb->mi_search_stack_depth = c->value_int;
651 mdb->mi_readers = c->value_int;
652 if ( mdb->mi_flags & MDB_IS_OPEN ) {
653 mdb->mi_flags |= MDB_RE_OPEN;
654 c->cleanup = mdb_cf_cleanup;
659 mdb->mi_mapsize = c->value_ulong;
660 if ( mdb->mi_flags & MDB_IS_OPEN ) {
661 mdb->mi_flags |= MDB_RE_OPEN;
662 c->cleanup = mdb_cf_cleanup;
670 int mdb_back_init_cf( BackendInfo *bi )
673 bi->bi_cf_ocs = mdbocs;
675 rc = config_register_schema( mdbcfg, mdbocs );