1 /* config.c - mdb backend configuration file routine */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 2000-2012 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, 0 );
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 );
203 for ( i = 0; i < mdb->mi_nattrs; i++ ) {
204 if ( mdb->mi_attrs[ i ]->ai_indexmask & MDB_INDEX_DELETING
205 || mdb->mi_attrs[ i ]->ai_newmask == 0 )
209 mdb->mi_attrs[ i ]->ai_indexmask = mdb->mi_attrs[ i ]->ai_newmask;
210 mdb->mi_attrs[ i ]->ai_newmask = 0;
213 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
214 ldap_pvt_runqueue_stoptask( &slapd_rq, rtask );
215 mdb->mi_index_task = NULL;
216 ldap_pvt_runqueue_remove( &slapd_rq, rtask );
217 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
222 /* Cleanup loose ends after Modify completes */
224 mdb_cf_cleanup( ConfigArgs *c )
226 struct mdb_info *mdb = c->be->be_private;
229 if ( mdb->mi_flags & MDB_DEL_INDEX ) {
230 mdb_attr_flush( mdb );
231 mdb->mi_flags ^= MDB_DEL_INDEX;
234 if ( mdb->mi_flags & MDB_RE_OPEN ) {
235 mdb->mi_flags ^= MDB_RE_OPEN;
236 rc = c->be->bd_info->bi_db_close( c->be, &c->reply );
238 rc = c->be->bd_info->bi_db_open( c->be, &c->reply );
239 /* If this fails, we need to restart */
242 snprintf( c->cr_msg, sizeof( c->cr_msg ),
243 "failed to reopen database, rc=%d", rc );
244 Debug( LDAP_DEBUG_ANY, LDAP_XSTRING(mdb_cf_cleanup)
245 ": %s\n", c->cr_msg, 0, 0 );
250 if ( mdb->mi_flags & MDB_OPEN_INDEX ) {
251 rc = mdb_attr_dbs_open( c->be, NULL, &c->reply );
259 mdb_cf_gen( ConfigArgs *c )
261 struct mdb_info *mdb = c->be->be_private;
264 if ( c->op == SLAP_CONFIG_EMIT ) {
270 bv.bv_len = snprintf( buf, sizeof(buf), "0%o", mdb->mi_dbenv_mode );
271 if ( bv.bv_len > 0 && bv.bv_len < sizeof(buf) ) {
273 value_add_one( &c->rvalue_vals, &bv );
280 if ( mdb->mi_txn_cp ) {
283 bv.bv_len = snprintf( buf, sizeof(buf), "%ld %ld",
284 (long) mdb->mi_txn_cp_kbyte, (long) mdb->mi_txn_cp_min );
285 if ( bv.bv_len > 0 && bv.bv_len < sizeof(buf) ) {
287 value_add_one( &c->rvalue_vals, &bv );
297 if ( mdb->mi_dbenv_home ) {
298 c->value_string = ch_strdup( mdb->mi_dbenv_home );
305 if ( mdb->mi_dbenv_flags & MDB_NOSYNC )
310 if ( mdb->mi_dbenv_flags ) {
311 mask_to_verbs( mdb_envflags, mdb->mi_dbenv_flags, &c->rvalue_vals );
313 if ( !c->rvalue_vals ) rc = 1;
317 mdb_attr_index_unparse( mdb, &c->rvalue_vals );
318 if ( !c->rvalue_vals ) rc = 1;
322 c->value_int = mdb->mi_search_stack_depth;
326 c->value_int = mdb->mi_readers;
330 c->value_ulong = mdb->mi_mapsize;
334 } else if ( c->op == LDAP_MOD_DELETE ) {
339 /* FIXME: does it make any sense to change the mode,
340 * if we don't exec a chmod()? */
341 mdb->bi_dbenv_mode = SLAPD_DEFAULT_DB_MODE;
345 /* single-valued no-ops */
352 if ( mdb->mi_txn_cp_task ) {
353 struct re_s *re = mdb->mi_txn_cp_task;
354 mdb->mi_txn_cp_task = NULL;
355 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
356 if ( ldap_pvt_runqueue_isrunning( &slapd_rq, re ) )
357 ldap_pvt_runqueue_stoptask( &slapd_rq, re );
358 ldap_pvt_runqueue_remove( &slapd_rq, re );
359 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
364 mdb->mi_flags |= MDB_RE_OPEN;
365 ch_free( mdb->mi_dbenv_home );
366 mdb->mi_dbenv_home = NULL;
367 c->cleanup = mdb_cf_cleanup;
368 ldap_pvt_thread_pool_purgekey( mdb->mi_dbenv );
371 mdb_env_set_flags( mdb->mi_dbenv, MDB_NOSYNC, 0 );
372 mdb->mi_dbenv_flags &= ~MDB_NOSYNC;
376 if ( c->valx == -1 ) {
378 for ( i=0; mdb_envflags[i].mask; i++) {
379 if ( mdb->mi_dbenv_flags & mdb_envflags[i].mask ) {
380 /* not all flags are runtime resettable */
381 rc = mdb_env_set_flags( mdb->mi_dbenv, mdb_envflags[i].mask, 0 );
383 mdb->mi_flags |= MDB_RE_OPEN;
384 c->cleanup = mdb_cf_cleanup;
387 mdb->mi_dbenv_flags ^= mdb_envflags[i].mask;
391 int i = verb_to_mask( c->line, mdb_envflags );
392 if ( mdb_envflags[i].mask & mdb->mi_dbenv_flags ) {
393 rc = mdb_env_set_flags( mdb->mi_dbenv, mdb_envflags[i].mask, 0 );
395 mdb->mi_flags |= MDB_RE_OPEN;
396 c->cleanup = mdb_cf_cleanup;
399 mdb->mi_dbenv_flags ^= mdb_envflags[i].mask;
401 /* unknown keyword */
408 if ( c->valx == -1 ) {
411 /* delete all (FIXME) */
412 for ( i = 0; i < mdb->mi_nattrs; i++ ) {
413 mdb->mi_attrs[i]->ai_indexmask |= MDB_INDEX_DELETING;
415 mdb->mi_flags |= MDB_DEL_INDEX;
416 c->cleanup = mdb_cf_cleanup;
419 struct berval bv, def = BER_BVC("default");
422 for (ptr = c->line; !isspace( (unsigned char) *ptr ); ptr++);
425 bv.bv_len = ptr - bv.bv_val;
426 if ( bvmatch( &bv, &def )) {
427 mdb->mi_defaultmask = 0;
434 sep = bv.bv_val[ bv.bv_len ];
435 bv.bv_val[ bv.bv_len ] = '\0';
436 attrs = ldap_str2charray( bv.bv_val, "," );
438 for ( i = 0; attrs[ i ]; i++ ) {
439 AttributeDescription *ad = NULL;
443 slap_str2ad( attrs[ i ], &ad, &text );
444 /* if we got here... */
445 assert( ad != NULL );
447 ai = mdb_attr_mask( mdb, ad );
448 /* if we got here... */
449 assert( ai != NULL );
451 ai->ai_indexmask |= MDB_INDEX_DELETING;
452 mdb->mi_flags |= MDB_DEL_INDEX;
453 c->cleanup = mdb_cf_cleanup;
456 bv.bv_val[ bv.bv_len ] = sep;
457 ldap_charray_free( attrs );
467 if ( ASCII_DIGIT( c->argv[1][0] ) ) {
471 mode = strtol( c->argv[1], &next, 0 );
472 if ( errno != 0 || next == c->argv[1] || next[0] != '\0' ) {
473 fprintf( stderr, "%s: "
474 "unable to parse mode=\"%s\".\n",
475 c->log, c->argv[1] );
478 mdb->mi_dbenv_mode = mode;
481 char *m = c->argv[1];
482 int who, what, mode = 0;
484 if ( strlen( m ) != STRLENOF("-rwxrwxrwx") ) {
493 for ( who = 0; who < 3; who++ ) {
494 for ( what = 0; what < 3; what++, m++ ) {
497 } else if ( m[0] != "rwx"[what] ) {
500 mode += ((1 << (2 - what)) << 3*(2 - who));
503 mdb->mi_dbenv_mode = mode;
509 if ( lutil_atolx( &l, c->argv[1], 0 ) != 0 ) {
510 fprintf( stderr, "%s: "
511 "invalid kbyte \"%s\" in \"checkpoint\".\n",
512 c->log, c->argv[1] );
515 mdb->mi_txn_cp_kbyte = l;
516 if ( lutil_atolx( &l, c->argv[2], 0 ) != 0 ) {
517 fprintf( stderr, "%s: "
518 "invalid minutes \"%s\" in \"checkpoint\".\n",
519 c->log, c->argv[2] );
522 mdb->mi_txn_cp_min = l;
523 /* If we're in server mode and time-based checkpointing is enabled,
524 * submit a task to perform periodic checkpoints.
526 if ((slapMode & SLAP_SERVER_MODE) && mdb->mi_txn_cp_min ) {
527 struct re_s *re = mdb->mi_txn_cp_task;
529 re->interval.tv_sec = mdb->mi_txn_cp_min * 60;
531 if ( c->be->be_suffix == NULL || BER_BVISNULL( &c->be->be_suffix[0] ) ) {
532 fprintf( stderr, "%s: "
533 "\"checkpoint\" must occur after \"suffix\".\n",
537 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
538 mdb->mi_txn_cp_task = ldap_pvt_runqueue_insert( &slapd_rq,
539 mdb->mi_txn_cp_min * 60, mdb_checkpoint, mdb,
540 LDAP_XSTRING(mdb_checkpoint), c->be->be_suffix[0].bv_val );
541 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
546 case MDB_DIRECTORY: {
548 char *ptr, *testpath;
551 len = strlen( c->value_string );
552 testpath = ch_malloc( len + STRLENOF(LDAP_DIRSEP) + STRLENOF("DUMMY") + 1 );
553 ptr = lutil_strcopy( testpath, c->value_string );
554 *ptr++ = LDAP_DIRSEP[0];
555 strcpy( ptr, "DUMMY" );
556 f = fopen( testpath, "w" );
563 snprintf( c->cr_msg, sizeof( c->cr_msg ), "%s: invalid path: %s",
564 c->log, strerror( errno ));
565 Debug( LDAP_DEBUG_ANY, "%s\n", c->cr_msg, 0, 0 );
569 if ( mdb->mi_dbenv_home )
570 ch_free( mdb->mi_dbenv_home );
571 mdb->mi_dbenv_home = c->value_string;
578 mdb->mi_dbenv_flags |= MDB_NOSYNC;
580 mdb->mi_dbenv_flags ^= MDB_NOSYNC;
581 if ( mdb->mi_flags & MDB_IS_OPEN ) {
582 mdb_env_set_flags( mdb->mi_dbenv, MDB_NOSYNC,
589 for ( i=1; i<c->argc; i++ ) {
590 j = verb_to_mask( c->argv[i], mdb_envflags );
591 if ( mdb_envflags[j].mask ) {
592 if ( mdb->mi_flags & MDB_IS_OPEN )
593 rc = mdb_env_set_flags( mdb->mi_dbenv, mdb_envflags[j].mask, 1 );
597 mdb->mi_flags |= MDB_RE_OPEN;
598 c->cleanup = mdb_cf_cleanup;
601 mdb->mi_dbenv_flags |= mdb_envflags[j].mask;
603 /* unknown keyword */
611 rc = mdb_attr_index_config( mdb, c->fname, c->lineno,
612 c->argc - 1, &c->argv[1], &c->reply);
614 if( rc != LDAP_SUCCESS ) return 1;
615 c->cleanup = mdb_cf_cleanup;
616 mdb->mi_flags |= MDB_OPEN_INDEX;
617 if (( mdb->mi_flags & MDB_IS_OPEN ) && !mdb->mi_index_task ) {
618 /* Start the task as soon as we finish here. Set a long
619 * interval (10 hours) so that it only gets scheduled once.
621 if ( c->be->be_suffix == NULL || BER_BVISNULL( &c->be->be_suffix[0] ) ) {
622 fprintf( stderr, "%s: "
623 "\"index\" must occur after \"suffix\".\n",
627 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
628 mdb->mi_index_task = ldap_pvt_runqueue_insert( &slapd_rq, 36000,
629 mdb_online_index, c->be,
630 LDAP_XSTRING(mdb_online_index), c->be->be_suffix[0].bv_val );
631 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
636 if ( c->value_int < MINIMUM_SEARCH_STACK_DEPTH ) {
638 "%s: depth %d too small, using %d\n",
639 c->log, c->value_int, MINIMUM_SEARCH_STACK_DEPTH );
640 c->value_int = MINIMUM_SEARCH_STACK_DEPTH;
642 mdb->mi_search_stack_depth = c->value_int;
646 mdb->mi_readers = c->value_int;
647 if ( mdb->mi_flags & MDB_IS_OPEN ) {
648 mdb->mi_flags |= MDB_RE_OPEN;
649 c->cleanup = mdb_cf_cleanup;
654 mdb->mi_mapsize = c->value_ulong;
655 if ( mdb->mi_flags & MDB_IS_OPEN ) {
656 mdb->mi_flags |= MDB_RE_OPEN;
657 c->cleanup = mdb_cf_cleanup;
665 int mdb_back_init_cf( BackendInfo *bi )
668 bi->bi_cf_ocs = mdbocs;
670 rc = config_register_schema( mdbcfg, mdbocs );