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 "EQUALITY caseIgnoreMatch "
63 "SYNTAX OMsDirectoryString )", NULL, NULL },
64 { "index", "attr> <[pres,eq,approx,sub]", 2, 3, 0, ARG_MAGIC|MDB_INDEX,
65 mdb_cf_gen, "( OLcfgDbAt:0.2 NAME 'olcDbIndex' "
66 "DESC 'Attribute index parameters' "
67 "EQUALITY caseIgnoreMatch "
68 "SYNTAX OMsDirectoryString )", NULL, NULL },
69 { "maxreaders", "num", 2, 2, 0, ARG_UINT|ARG_MAGIC|MDB_MAXREADERS,
70 mdb_cf_gen, "( OLcfgDbAt:12.1 NAME 'olcDbMaxReaders' "
71 "DESC 'Maximum number of threads that may access the DB concurrently' "
72 "SYNTAX OMsInteger SINGLE-VALUE )", NULL, NULL },
73 { "maxsize", "size", 2, 2, 0, ARG_ULONG|ARG_MAGIC|MDB_MAXSIZE,
74 mdb_cf_gen, "( OLcfgDbAt:12.2 NAME 'olcDbMaxSize' "
75 "DESC 'Maximum size of DB in bytes' "
76 "SYNTAX OMsInteger SINGLE-VALUE )", NULL, NULL },
77 { "mode", "mode", 2, 2, 0, ARG_MAGIC|MDB_MODE,
78 mdb_cf_gen, "( OLcfgDbAt:0.3 NAME 'olcDbMode' "
79 "DESC 'Unix permissions of database files' "
80 "SYNTAX OMsDirectoryString SINGLE-VALUE )", NULL, NULL },
81 { "searchstack", "depth", 2, 2, 0, ARG_INT|ARG_MAGIC|MDB_SSTACK,
82 mdb_cf_gen, "( OLcfgDbAt:1.9 NAME 'olcDbSearchStack' "
83 "DESC 'Depth of search stack in IDLs' "
84 "SYNTAX OMsInteger SINGLE-VALUE )", NULL, NULL },
85 { NULL, NULL, 0, 0, 0, ARG_IGNORED,
86 NULL, NULL, NULL, NULL }
89 static ConfigOCs mdbocs[] = {
92 "NAME 'olcMdbConfig' "
93 "DESC 'MDB backend configuration' "
94 "SUP olcDatabaseConfig "
95 "MUST olcDbDirectory "
96 "MAY ( olcDbCheckpoint $ olcDbEnvFlags $ "
97 "olcDbNoSync $ olcDbIndex $ olcDbMaxReaders $ olcDbMaxsize $ "
98 "olcDbMode $ olcDbSearchStack ) )",
99 Cft_Database, mdbcfg },
103 static slap_verbmasks mdb_envflags[] = {
104 { BER_BVC("nosync"), MDB_NOSYNC },
105 { BER_BVC("nometasync"), MDB_NOMETASYNC },
106 { BER_BVC("writemap"), MDB_WRITEMAP },
107 { BER_BVC("mapasync"), MDB_MAPASYNC },
108 { BER_BVC("nordahead"), MDB_NORDAHEAD },
112 /* perform periodic syncs */
114 mdb_checkpoint( void *ctx, void *arg )
116 struct re_s *rtask = arg;
117 struct mdb_info *mdb = rtask->arg;
119 mdb_env_sync( mdb->mi_dbenv, 1 );
120 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
121 ldap_pvt_runqueue_stoptask( &slapd_rq, rtask );
122 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
126 /* reindex entries on the fly */
128 mdb_online_index( void *ctx, void *arg )
130 struct re_s *rtask = arg;
131 BackendDB *be = rtask->arg;
132 struct mdb_info *mdb = be->be_private;
134 Connection conn = {0};
135 OperationBuffer opbuf;
146 connection_fake_init( &conn, &opbuf, ctx );
152 key.mv_size = sizeof(ID);
155 if ( slapd_shutdown )
158 rc = mdb_txn_begin( mdb->mi_dbenv, NULL, 0, &txn );
161 rc = mdb_cursor_open( txn, mdb->mi_id2entry, &curs );
163 mdb_txn_abort( txn );
169 rc = mdb_cursor_get( curs, &key, &data, MDB_SET_RANGE );
171 mdb_txn_abort( txn );
172 if ( rc == MDB_NOTFOUND )
176 memcpy( &id, key.mv_data, sizeof( id ));
179 rc = mdb_id2entry( op, curs, id, &e );
180 mdb_cursor_close( curs );
182 mdb_txn_abort( txn );
183 if ( rc == MDB_NOTFOUND ) {
190 rc = mdb_index_entry( op, txn, MDB_INDEX_UPDATE_OP, e );
191 mdb_entry_return( op, e );
193 rc = mdb_txn_commit( txn );
196 mdb_txn_abort( txn );
200 Debug( LDAP_DEBUG_ANY,
201 LDAP_XSTRING(mdb_online_index) ": database %s: "
202 "txn_commit failed: %s (%d)\n",
203 be->be_suffix[0].bv_val, mdb_strerror(rc), rc );
210 for ( i = 0; i < mdb->mi_nattrs; i++ ) {
211 if ( mdb->mi_attrs[ i ]->ai_indexmask & MDB_INDEX_DELETING
212 || mdb->mi_attrs[ i ]->ai_newmask == 0 )
216 mdb->mi_attrs[ i ]->ai_indexmask = mdb->mi_attrs[ i ]->ai_newmask;
217 mdb->mi_attrs[ i ]->ai_newmask = 0;
220 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
221 ldap_pvt_runqueue_stoptask( &slapd_rq, rtask );
222 mdb->mi_index_task = NULL;
223 ldap_pvt_runqueue_remove( &slapd_rq, rtask );
224 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
229 /* Cleanup loose ends after Modify completes */
231 mdb_cf_cleanup( ConfigArgs *c )
233 struct mdb_info *mdb = c->be->be_private;
236 if ( mdb->mi_flags & MDB_DEL_INDEX ) {
237 mdb_attr_flush( mdb );
238 mdb->mi_flags ^= MDB_DEL_INDEX;
241 if ( mdb->mi_flags & MDB_RE_OPEN ) {
242 mdb->mi_flags ^= MDB_RE_OPEN;
243 rc = c->be->bd_info->bi_db_close( c->be, &c->reply );
245 rc = c->be->bd_info->bi_db_open( c->be, &c->reply );
246 /* If this fails, we need to restart */
249 snprintf( c->cr_msg, sizeof( c->cr_msg ),
250 "failed to reopen database, rc=%d", rc );
251 Debug( LDAP_DEBUG_ANY, LDAP_XSTRING(mdb_cf_cleanup)
252 ": %s\n", c->cr_msg, 0, 0 );
257 if ( mdb->mi_flags & MDB_OPEN_INDEX ) {
258 rc = mdb_attr_dbs_open( c->be, NULL, &c->reply );
266 mdb_cf_gen( ConfigArgs *c )
268 struct mdb_info *mdb = c->be->be_private;
271 if ( c->op == SLAP_CONFIG_EMIT ) {
277 bv.bv_len = snprintf( buf, sizeof(buf), "0%o", mdb->mi_dbenv_mode );
278 if ( bv.bv_len > 0 && bv.bv_len < sizeof(buf) ) {
280 value_add_one( &c->rvalue_vals, &bv );
287 if ( mdb->mi_txn_cp ) {
290 bv.bv_len = snprintf( buf, sizeof(buf), "%ld %ld",
291 (long) mdb->mi_txn_cp_kbyte, (long) mdb->mi_txn_cp_min );
292 if ( bv.bv_len > 0 && bv.bv_len < sizeof(buf) ) {
294 value_add_one( &c->rvalue_vals, &bv );
304 if ( mdb->mi_dbenv_home ) {
305 c->value_string = ch_strdup( mdb->mi_dbenv_home );
312 if ( mdb->mi_dbenv_flags & MDB_NOSYNC )
317 if ( mdb->mi_dbenv_flags ) {
318 mask_to_verbs( mdb_envflags, mdb->mi_dbenv_flags, &c->rvalue_vals );
320 if ( !c->rvalue_vals ) rc = 1;
324 mdb_attr_index_unparse( mdb, &c->rvalue_vals );
325 if ( !c->rvalue_vals ) rc = 1;
329 c->value_int = mdb->mi_search_stack_depth;
333 c->value_int = mdb->mi_readers;
337 c->value_ulong = mdb->mi_mapsize;
341 } else if ( c->op == LDAP_MOD_DELETE ) {
346 /* FIXME: does it make any sense to change the mode,
347 * if we don't exec a chmod()? */
348 mdb->bi_dbenv_mode = SLAPD_DEFAULT_DB_MODE;
352 /* single-valued no-ops */
359 if ( mdb->mi_txn_cp_task ) {
360 struct re_s *re = mdb->mi_txn_cp_task;
361 mdb->mi_txn_cp_task = NULL;
362 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
363 if ( ldap_pvt_runqueue_isrunning( &slapd_rq, re ) )
364 ldap_pvt_runqueue_stoptask( &slapd_rq, re );
365 ldap_pvt_runqueue_remove( &slapd_rq, re );
366 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
371 mdb->mi_flags |= MDB_RE_OPEN;
372 ch_free( mdb->mi_dbenv_home );
373 mdb->mi_dbenv_home = NULL;
374 c->cleanup = mdb_cf_cleanup;
375 ldap_pvt_thread_pool_purgekey( mdb->mi_dbenv );
378 mdb_env_set_flags( mdb->mi_dbenv, MDB_NOSYNC, 0 );
379 mdb->mi_dbenv_flags &= ~MDB_NOSYNC;
383 if ( c->valx == -1 ) {
385 for ( i=0; mdb_envflags[i].mask; i++) {
386 if ( mdb->mi_dbenv_flags & mdb_envflags[i].mask ) {
387 /* not all flags are runtime resettable */
388 rc = mdb_env_set_flags( mdb->mi_dbenv, mdb_envflags[i].mask, 0 );
390 mdb->mi_flags |= MDB_RE_OPEN;
391 c->cleanup = mdb_cf_cleanup;
394 mdb->mi_dbenv_flags ^= mdb_envflags[i].mask;
398 int i = verb_to_mask( c->line, mdb_envflags );
399 if ( mdb_envflags[i].mask & mdb->mi_dbenv_flags ) {
400 rc = mdb_env_set_flags( mdb->mi_dbenv, mdb_envflags[i].mask, 0 );
402 mdb->mi_flags |= MDB_RE_OPEN;
403 c->cleanup = mdb_cf_cleanup;
406 mdb->mi_dbenv_flags ^= mdb_envflags[i].mask;
408 /* unknown keyword */
415 if ( c->valx == -1 ) {
418 /* delete all (FIXME) */
419 for ( i = 0; i < mdb->mi_nattrs; i++ ) {
420 mdb->mi_attrs[i]->ai_indexmask |= MDB_INDEX_DELETING;
422 mdb->mi_flags |= MDB_DEL_INDEX;
423 c->cleanup = mdb_cf_cleanup;
426 struct berval bv, def = BER_BVC("default");
429 for (ptr = c->line; !isspace( (unsigned char) *ptr ); ptr++);
432 bv.bv_len = ptr - bv.bv_val;
433 if ( bvmatch( &bv, &def )) {
434 mdb->mi_defaultmask = 0;
441 sep = bv.bv_val[ bv.bv_len ];
442 bv.bv_val[ bv.bv_len ] = '\0';
443 attrs = ldap_str2charray( bv.bv_val, "," );
445 for ( i = 0; attrs[ i ]; i++ ) {
446 AttributeDescription *ad = NULL;
450 slap_str2ad( attrs[ i ], &ad, &text );
451 /* if we got here... */
452 assert( ad != NULL );
454 ai = mdb_attr_mask( mdb, ad );
455 /* if we got here... */
456 assert( ai != NULL );
458 ai->ai_indexmask |= MDB_INDEX_DELETING;
459 mdb->mi_flags |= MDB_DEL_INDEX;
460 c->cleanup = mdb_cf_cleanup;
463 bv.bv_val[ bv.bv_len ] = sep;
464 ldap_charray_free( attrs );
474 if ( ASCII_DIGIT( c->argv[1][0] ) ) {
478 mode = strtol( c->argv[1], &next, 0 );
479 if ( errno != 0 || next == c->argv[1] || next[0] != '\0' ) {
480 fprintf( stderr, "%s: "
481 "unable to parse mode=\"%s\".\n",
482 c->log, c->argv[1] );
485 mdb->mi_dbenv_mode = mode;
488 char *m = c->argv[1];
489 int who, what, mode = 0;
491 if ( strlen( m ) != STRLENOF("-rwxrwxrwx") ) {
500 for ( who = 0; who < 3; who++ ) {
501 for ( what = 0; what < 3; what++, m++ ) {
504 } else if ( m[0] != "rwx"[what] ) {
507 mode += ((1 << (2 - what)) << 3*(2 - who));
510 mdb->mi_dbenv_mode = mode;
516 if ( lutil_atolx( &l, c->argv[1], 0 ) != 0 ) {
517 fprintf( stderr, "%s: "
518 "invalid kbyte \"%s\" in \"checkpoint\".\n",
519 c->log, c->argv[1] );
522 mdb->mi_txn_cp_kbyte = l;
523 if ( lutil_atolx( &l, c->argv[2], 0 ) != 0 ) {
524 fprintf( stderr, "%s: "
525 "invalid minutes \"%s\" in \"checkpoint\".\n",
526 c->log, c->argv[2] );
529 mdb->mi_txn_cp_min = l;
530 /* If we're in server mode and time-based checkpointing is enabled,
531 * submit a task to perform periodic checkpoints.
533 if ((slapMode & SLAP_SERVER_MODE) && mdb->mi_txn_cp_min ) {
534 struct re_s *re = mdb->mi_txn_cp_task;
536 re->interval.tv_sec = mdb->mi_txn_cp_min * 60;
538 if ( c->be->be_suffix == NULL || BER_BVISNULL( &c->be->be_suffix[0] ) ) {
539 fprintf( stderr, "%s: "
540 "\"checkpoint\" must occur after \"suffix\".\n",
544 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
545 mdb->mi_txn_cp_task = ldap_pvt_runqueue_insert( &slapd_rq,
546 mdb->mi_txn_cp_min * 60, mdb_checkpoint, mdb,
547 LDAP_XSTRING(mdb_checkpoint), c->be->be_suffix[0].bv_val );
548 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
553 case MDB_DIRECTORY: {
555 char *ptr, *testpath;
558 len = strlen( c->value_string );
559 testpath = ch_malloc( len + STRLENOF(LDAP_DIRSEP) + STRLENOF("DUMMY") + 1 );
560 ptr = lutil_strcopy( testpath, c->value_string );
561 *ptr++ = LDAP_DIRSEP[0];
562 strcpy( ptr, "DUMMY" );
563 f = fopen( testpath, "w" );
570 snprintf( c->cr_msg, sizeof( c->cr_msg ), "%s: invalid path: %s",
571 c->log, strerror( errno ));
572 Debug( LDAP_DEBUG_ANY, "%s\n", c->cr_msg, 0, 0 );
576 if ( mdb->mi_dbenv_home )
577 ch_free( mdb->mi_dbenv_home );
578 mdb->mi_dbenv_home = c->value_string;
585 mdb->mi_dbenv_flags |= MDB_NOSYNC;
587 mdb->mi_dbenv_flags ^= MDB_NOSYNC;
588 if ( mdb->mi_flags & MDB_IS_OPEN ) {
589 mdb_env_set_flags( mdb->mi_dbenv, MDB_NOSYNC,
596 for ( i=1; i<c->argc; i++ ) {
597 j = verb_to_mask( c->argv[i], mdb_envflags );
598 if ( mdb_envflags[j].mask ) {
599 if ( mdb->mi_flags & MDB_IS_OPEN )
600 rc = mdb_env_set_flags( mdb->mi_dbenv, mdb_envflags[j].mask, 1 );
604 mdb->mi_flags |= MDB_RE_OPEN;
605 c->cleanup = mdb_cf_cleanup;
608 mdb->mi_dbenv_flags |= mdb_envflags[j].mask;
610 /* unknown keyword */
618 rc = mdb_attr_index_config( mdb, c->fname, c->lineno,
619 c->argc - 1, &c->argv[1], &c->reply);
621 if( rc != LDAP_SUCCESS ) return 1;
622 c->cleanup = mdb_cf_cleanup;
623 mdb->mi_flags |= MDB_OPEN_INDEX;
624 if (( mdb->mi_flags & MDB_IS_OPEN ) && !mdb->mi_index_task ) {
625 /* Start the task as soon as we finish here. Set a long
626 * interval (10 hours) so that it only gets scheduled once.
628 if ( c->be->be_suffix == NULL || BER_BVISNULL( &c->be->be_suffix[0] ) ) {
629 fprintf( stderr, "%s: "
630 "\"index\" must occur after \"suffix\".\n",
634 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
635 mdb->mi_index_task = ldap_pvt_runqueue_insert( &slapd_rq, 36000,
636 mdb_online_index, c->be,
637 LDAP_XSTRING(mdb_online_index), c->be->be_suffix[0].bv_val );
638 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
643 if ( c->value_int < MINIMUM_SEARCH_STACK_DEPTH ) {
645 "%s: depth %d too small, using %d\n",
646 c->log, c->value_int, MINIMUM_SEARCH_STACK_DEPTH );
647 c->value_int = MINIMUM_SEARCH_STACK_DEPTH;
649 mdb->mi_search_stack_depth = c->value_int;
653 mdb->mi_readers = c->value_int;
654 if ( mdb->mi_flags & MDB_IS_OPEN ) {
655 mdb->mi_flags |= MDB_RE_OPEN;
656 c->cleanup = mdb_cf_cleanup;
661 mdb->mi_mapsize = c->value_ulong;
662 if ( mdb->mi_flags & MDB_IS_OPEN ) {
663 mdb->mi_flags |= MDB_RE_OPEN;
664 c->cleanup = mdb_cf_cleanup;
672 int mdb_back_init_cf( BackendInfo *bi )
675 bi->bi_cf_ocs = mdbocs;
677 rc = config_register_schema( mdbcfg, mdbocs );