1 /* config.c - mdb backend configuration file routine */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 2000-2015 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 { "maxentrysize", "size", 2, 2, 0, ARG_ULONG|ARG_OFFSET,
70 (void *)offsetof(struct mdb_info, mi_maxentrysize),
71 "( OLcfgDbAt:12.4 NAME 'olcDbMaxEntrySize' "
72 "DESC 'Maximum size of an entry in bytes' "
73 "SYNTAX OMsInteger SINGLE-VALUE )", NULL, NULL },
74 { "maxreaders", "num", 2, 2, 0, ARG_UINT|ARG_MAGIC|MDB_MAXREADERS,
75 mdb_cf_gen, "( OLcfgDbAt:12.1 NAME 'olcDbMaxReaders' "
76 "DESC 'Maximum number of threads that may access the DB concurrently' "
77 "SYNTAX OMsInteger SINGLE-VALUE )", NULL, NULL },
78 { "maxsize", "size", 2, 2, 0, ARG_ULONG|ARG_MAGIC|MDB_MAXSIZE,
79 mdb_cf_gen, "( OLcfgDbAt:12.2 NAME 'olcDbMaxSize' "
80 "DESC 'Maximum size of DB in bytes' "
81 "SYNTAX OMsInteger SINGLE-VALUE )", NULL, NULL },
82 { "mode", "mode", 2, 2, 0, ARG_MAGIC|MDB_MODE,
83 mdb_cf_gen, "( OLcfgDbAt:0.3 NAME 'olcDbMode' "
84 "DESC 'Unix permissions of database files' "
85 "SYNTAX OMsDirectoryString SINGLE-VALUE )", NULL, NULL },
86 { "rtxnsize", "entries", 2, 2, 0, ARG_UINT|ARG_OFFSET,
87 (void *)offsetof(struct mdb_info, mi_rtxn_size),
88 "( OLcfgDbAt:12.5 NAME 'olcDbRtxnSize' "
89 "DESC 'Number of entries to process in one read transaction' "
90 "SYNTAX OMsInteger SINGLE-VALUE )", NULL, NULL },
91 { "searchstack", "depth", 2, 2, 0, ARG_INT|ARG_MAGIC|MDB_SSTACK,
92 mdb_cf_gen, "( OLcfgDbAt:1.9 NAME 'olcDbSearchStack' "
93 "DESC 'Depth of search stack in IDLs' "
94 "SYNTAX OMsInteger SINGLE-VALUE )", NULL, NULL },
95 { NULL, NULL, 0, 0, 0, ARG_IGNORED,
96 NULL, NULL, NULL, NULL }
99 static ConfigOCs mdbocs[] = {
102 "NAME 'olcMdbConfig' "
103 "DESC 'MDB backend configuration' "
104 "SUP olcDatabaseConfig "
105 "MUST olcDbDirectory "
106 "MAY ( olcDbCheckpoint $ olcDbEnvFlags $ "
107 "olcDbNoSync $ olcDbIndex $ olcDbMaxReaders $ olcDbMaxSize $ "
108 "olcDbMode $ olcDbSearchStack $ olcDbMaxEntrySize $ olcDbRtxnSize ) )",
109 Cft_Database, mdbcfg },
113 static slap_verbmasks mdb_envflags[] = {
114 { BER_BVC("nosync"), MDB_NOSYNC },
115 { BER_BVC("nometasync"), MDB_NOMETASYNC },
116 { BER_BVC("writemap"), MDB_WRITEMAP },
117 { BER_BVC("mapasync"), MDB_MAPASYNC },
118 { BER_BVC("nordahead"), MDB_NORDAHEAD },
122 /* perform periodic syncs */
124 mdb_checkpoint( void *ctx, void *arg )
126 struct re_s *rtask = arg;
127 struct mdb_info *mdb = rtask->arg;
129 mdb_env_sync( mdb->mi_dbenv, 1 );
130 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
131 ldap_pvt_runqueue_stoptask( &slapd_rq, rtask );
132 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
136 /* reindex entries on the fly */
138 mdb_online_index( void *ctx, void *arg )
140 struct re_s *rtask = arg;
141 BackendDB *be = rtask->arg;
142 struct mdb_info *mdb = be->be_private;
144 Connection conn = {0};
145 OperationBuffer opbuf;
156 connection_fake_init( &conn, &opbuf, ctx );
162 key.mv_size = sizeof(ID);
165 if ( slapd_shutdown )
168 rc = mdb_txn_begin( mdb->mi_dbenv, NULL, 0, &txn );
171 rc = mdb_cursor_open( txn, mdb->mi_id2entry, &curs );
173 mdb_txn_abort( txn );
179 rc = mdb_cursor_get( curs, &key, &data, MDB_SET_RANGE );
181 mdb_txn_abort( txn );
182 if ( rc == MDB_NOTFOUND )
186 memcpy( &id, key.mv_data, sizeof( id ));
189 rc = mdb_id2entry( op, curs, id, &e );
190 mdb_cursor_close( curs );
192 mdb_txn_abort( txn );
193 if ( rc == MDB_NOTFOUND ) {
200 rc = mdb_index_entry( op, txn, MDB_INDEX_UPDATE_OP, e );
201 mdb_entry_return( op, e );
203 rc = mdb_txn_commit( txn );
206 mdb_txn_abort( txn );
210 Debug( LDAP_DEBUG_ANY,
211 LDAP_XSTRING(mdb_online_index) ": database %s: "
212 "txn_commit failed: %s (%d)\n",
213 be->be_suffix[0].bv_val, mdb_strerror(rc), rc );
220 for ( i = 0; i < mdb->mi_nattrs; i++ ) {
221 if ( mdb->mi_attrs[ i ]->ai_indexmask & MDB_INDEX_DELETING
222 || mdb->mi_attrs[ i ]->ai_newmask == 0 )
226 mdb->mi_attrs[ i ]->ai_indexmask = mdb->mi_attrs[ i ]->ai_newmask;
227 mdb->mi_attrs[ i ]->ai_newmask = 0;
230 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
231 ldap_pvt_runqueue_stoptask( &slapd_rq, rtask );
232 mdb->mi_index_task = NULL;
233 ldap_pvt_runqueue_remove( &slapd_rq, rtask );
234 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
239 /* Cleanup loose ends after Modify completes */
241 mdb_cf_cleanup( ConfigArgs *c )
243 struct mdb_info *mdb = c->be->be_private;
246 if ( mdb->mi_flags & MDB_DEL_INDEX ) {
247 mdb_attr_flush( mdb );
248 mdb->mi_flags ^= MDB_DEL_INDEX;
251 if ( mdb->mi_flags & MDB_RE_OPEN ) {
252 mdb->mi_flags ^= MDB_RE_OPEN;
253 rc = c->be->bd_info->bi_db_close( c->be, &c->reply );
255 rc = c->be->bd_info->bi_db_open( c->be, &c->reply );
256 /* If this fails, we need to restart */
259 snprintf( c->cr_msg, sizeof( c->cr_msg ),
260 "failed to reopen database, rc=%d", rc );
261 Debug( LDAP_DEBUG_ANY, LDAP_XSTRING(mdb_cf_cleanup)
262 ": %s\n", c->cr_msg, 0, 0 );
267 if ( mdb->mi_flags & MDB_OPEN_INDEX ) {
268 rc = mdb_attr_dbs_open( c->be, NULL, &c->reply );
276 mdb_cf_gen( ConfigArgs *c )
278 struct mdb_info *mdb = c->be->be_private;
281 if ( c->op == SLAP_CONFIG_EMIT ) {
287 bv.bv_len = snprintf( buf, sizeof(buf), "0%o", mdb->mi_dbenv_mode );
288 if ( bv.bv_len > 0 && bv.bv_len < sizeof(buf) ) {
290 value_add_one( &c->rvalue_vals, &bv );
297 if ( mdb->mi_txn_cp ) {
300 bv.bv_len = snprintf( buf, sizeof(buf), "%ld %ld",
301 (long) mdb->mi_txn_cp_kbyte, (long) mdb->mi_txn_cp_min );
302 if ( bv.bv_len > 0 && bv.bv_len < sizeof(buf) ) {
304 value_add_one( &c->rvalue_vals, &bv );
314 if ( mdb->mi_dbenv_home ) {
315 c->value_string = ch_strdup( mdb->mi_dbenv_home );
322 if ( mdb->mi_dbenv_flags & MDB_NOSYNC )
327 if ( mdb->mi_dbenv_flags ) {
328 mask_to_verbs( mdb_envflags, mdb->mi_dbenv_flags, &c->rvalue_vals );
330 if ( !c->rvalue_vals ) rc = 1;
334 mdb_attr_index_unparse( mdb, &c->rvalue_vals );
335 if ( !c->rvalue_vals ) rc = 1;
339 c->value_int = mdb->mi_search_stack_depth;
343 c->value_int = mdb->mi_readers;
347 c->value_ulong = mdb->mi_mapsize;
351 } else if ( c->op == LDAP_MOD_DELETE ) {
356 /* FIXME: does it make any sense to change the mode,
357 * if we don't exec a chmod()? */
358 mdb->bi_dbenv_mode = SLAPD_DEFAULT_DB_MODE;
362 /* single-valued no-ops */
369 if ( mdb->mi_txn_cp_task ) {
370 struct re_s *re = mdb->mi_txn_cp_task;
371 mdb->mi_txn_cp_task = NULL;
372 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
373 if ( ldap_pvt_runqueue_isrunning( &slapd_rq, re ) )
374 ldap_pvt_runqueue_stoptask( &slapd_rq, re );
375 ldap_pvt_runqueue_remove( &slapd_rq, re );
376 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
381 mdb->mi_flags |= MDB_RE_OPEN;
382 ch_free( mdb->mi_dbenv_home );
383 mdb->mi_dbenv_home = NULL;
384 c->cleanup = mdb_cf_cleanup;
385 ldap_pvt_thread_pool_purgekey( mdb->mi_dbenv );
388 mdb_env_set_flags( mdb->mi_dbenv, MDB_NOSYNC, 0 );
389 mdb->mi_dbenv_flags &= ~MDB_NOSYNC;
393 if ( c->valx == -1 ) {
395 for ( i=0; mdb_envflags[i].mask; i++) {
396 if ( mdb->mi_dbenv_flags & mdb_envflags[i].mask ) {
397 /* not all flags are runtime resettable */
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;
408 int i = verb_to_mask( c->line, mdb_envflags );
409 if ( mdb_envflags[i].mask & mdb->mi_dbenv_flags ) {
410 rc = mdb_env_set_flags( mdb->mi_dbenv, mdb_envflags[i].mask, 0 );
412 mdb->mi_flags |= MDB_RE_OPEN;
413 c->cleanup = mdb_cf_cleanup;
416 mdb->mi_dbenv_flags ^= mdb_envflags[i].mask;
418 /* unknown keyword */
419 snprintf( c->cr_msg, sizeof( c->cr_msg ), "%s: unknown keyword \"%s\"",
420 c->argv[0], c->argv[i] );
421 Debug( LDAP_DEBUG_CONFIG, "%s %s\n", c->log, c->cr_msg, 0 );
428 if ( c->valx == -1 ) {
431 /* delete all (FIXME) */
432 for ( i = 0; i < mdb->mi_nattrs; i++ ) {
433 mdb->mi_attrs[i]->ai_indexmask |= MDB_INDEX_DELETING;
435 mdb->mi_flags |= MDB_DEL_INDEX;
436 c->cleanup = mdb_cf_cleanup;
439 struct berval bv, def = BER_BVC("default");
442 for (ptr = c->line; !isspace( (unsigned char) *ptr ); ptr++);
445 bv.bv_len = ptr - bv.bv_val;
446 if ( bvmatch( &bv, &def )) {
447 mdb->mi_defaultmask = 0;
454 sep = bv.bv_val[ bv.bv_len ];
455 bv.bv_val[ bv.bv_len ] = '\0';
456 attrs = ldap_str2charray( bv.bv_val, "," );
458 for ( i = 0; attrs[ i ]; i++ ) {
459 AttributeDescription *ad = NULL;
463 slap_str2ad( attrs[ i ], &ad, &text );
464 /* if we got here... */
465 assert( ad != NULL );
467 ai = mdb_attr_mask( mdb, ad );
468 /* if we got here... */
469 assert( ai != NULL );
471 ai->ai_indexmask |= MDB_INDEX_DELETING;
472 mdb->mi_flags |= MDB_DEL_INDEX;
473 c->cleanup = mdb_cf_cleanup;
476 bv.bv_val[ bv.bv_len ] = sep;
477 ldap_charray_free( attrs );
487 if ( ASCII_DIGIT( c->argv[1][0] ) ) {
491 mode = strtol( c->argv[1], &next, 0 );
492 if ( errno != 0 || next == c->argv[1] || next[0] != '\0' ) {
493 fprintf( stderr, "%s: "
494 "unable to parse mode=\"%s\".\n",
495 c->log, c->argv[1] );
498 mdb->mi_dbenv_mode = mode;
501 char *m = c->argv[1];
502 int who, what, mode = 0;
504 if ( strlen( m ) != STRLENOF("-rwxrwxrwx") ) {
513 for ( who = 0; who < 3; who++ ) {
514 for ( what = 0; what < 3; what++, m++ ) {
517 } else if ( m[0] != "rwx"[what] ) {
520 mode += ((1 << (2 - what)) << 3*(2 - who));
523 mdb->mi_dbenv_mode = mode;
529 if ( lutil_atolx( &l, c->argv[1], 0 ) != 0 ) {
530 fprintf( stderr, "%s: "
531 "invalid kbyte \"%s\" in \"checkpoint\".\n",
532 c->log, c->argv[1] );
535 mdb->mi_txn_cp_kbyte = l;
536 if ( lutil_atolx( &l, c->argv[2], 0 ) != 0 ) {
537 fprintf( stderr, "%s: "
538 "invalid minutes \"%s\" in \"checkpoint\".\n",
539 c->log, c->argv[2] );
542 mdb->mi_txn_cp_min = l;
543 /* If we're in server mode and time-based checkpointing is enabled,
544 * submit a task to perform periodic checkpoints.
546 if ((slapMode & SLAP_SERVER_MODE) && mdb->mi_txn_cp_min ) {
547 struct re_s *re = mdb->mi_txn_cp_task;
549 re->interval.tv_sec = mdb->mi_txn_cp_min * 60;
551 if ( c->be->be_suffix == NULL || BER_BVISNULL( &c->be->be_suffix[0] ) ) {
552 fprintf( stderr, "%s: "
553 "\"checkpoint\" must occur after \"suffix\".\n",
557 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
558 mdb->mi_txn_cp_task = ldap_pvt_runqueue_insert( &slapd_rq,
559 mdb->mi_txn_cp_min * 60, mdb_checkpoint, mdb,
560 LDAP_XSTRING(mdb_checkpoint), c->be->be_suffix[0].bv_val );
561 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
566 case MDB_DIRECTORY: {
568 char *ptr, *testpath;
571 len = strlen( c->value_string );
572 testpath = ch_malloc( len + STRLENOF(LDAP_DIRSEP) + STRLENOF("DUMMY") + 1 );
573 ptr = lutil_strcopy( testpath, c->value_string );
574 *ptr++ = LDAP_DIRSEP[0];
575 strcpy( ptr, "DUMMY" );
576 f = fopen( testpath, "w" );
583 snprintf( c->cr_msg, sizeof( c->cr_msg ), "%s: invalid path: %s",
584 c->log, strerror( errno ));
585 Debug( LDAP_DEBUG_ANY, "%s\n", c->cr_msg, 0, 0 );
589 if ( mdb->mi_dbenv_home )
590 ch_free( mdb->mi_dbenv_home );
591 mdb->mi_dbenv_home = c->value_string;
598 mdb->mi_dbenv_flags |= MDB_NOSYNC;
600 mdb->mi_dbenv_flags ^= MDB_NOSYNC;
601 if ( mdb->mi_flags & MDB_IS_OPEN ) {
602 mdb_env_set_flags( mdb->mi_dbenv, MDB_NOSYNC,
609 for ( i=1; i<c->argc; i++ ) {
610 j = verb_to_mask( c->argv[i], mdb_envflags );
611 if ( mdb_envflags[j].mask ) {
612 if ( mdb->mi_flags & MDB_IS_OPEN )
613 rc = mdb_env_set_flags( mdb->mi_dbenv, mdb_envflags[j].mask, 1 );
617 mdb->mi_flags |= MDB_RE_OPEN;
618 c->cleanup = mdb_cf_cleanup;
621 mdb->mi_dbenv_flags |= mdb_envflags[j].mask;
623 /* unknown keyword */
624 snprintf( c->cr_msg, sizeof( c->cr_msg ), "%s: unknown keyword \"%s\"",
625 c->argv[0], c->argv[i] );
626 Debug( LDAP_DEBUG_ANY, "%s %s\n", c->log, c->cr_msg, 0 );
634 rc = mdb_attr_index_config( mdb, c->fname, c->lineno,
635 c->argc - 1, &c->argv[1], &c->reply);
637 if( rc != LDAP_SUCCESS ) return 1;
638 mdb->mi_flags |= MDB_OPEN_INDEX;
639 if ( mdb->mi_flags & MDB_IS_OPEN ) {
640 c->cleanup = mdb_cf_cleanup;
641 if ( !mdb->mi_index_task ) {
642 /* Start the task as soon as we finish here. Set a long
643 * interval (10 hours) so that it only gets scheduled once.
645 if ( c->be->be_suffix == NULL || BER_BVISNULL( &c->be->be_suffix[0] ) ) {
646 fprintf( stderr, "%s: "
647 "\"index\" must occur after \"suffix\".\n",
651 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
652 mdb->mi_index_task = ldap_pvt_runqueue_insert( &slapd_rq, 36000,
653 mdb_online_index, c->be,
654 LDAP_XSTRING(mdb_online_index), c->be->be_suffix[0].bv_val );
655 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
661 if ( c->value_int < MINIMUM_SEARCH_STACK_DEPTH ) {
663 "%s: depth %d too small, using %d\n",
664 c->log, c->value_int, MINIMUM_SEARCH_STACK_DEPTH );
665 c->value_int = MINIMUM_SEARCH_STACK_DEPTH;
667 mdb->mi_search_stack_depth = c->value_int;
671 mdb->mi_readers = c->value_int;
672 if ( mdb->mi_flags & MDB_IS_OPEN ) {
673 mdb->mi_flags |= MDB_RE_OPEN;
674 c->cleanup = mdb_cf_cleanup;
679 mdb->mi_mapsize = c->value_ulong;
680 if ( mdb->mi_flags & MDB_IS_OPEN ) {
681 mdb->mi_flags |= MDB_RE_OPEN;
682 c->cleanup = mdb_cf_cleanup;
690 int mdb_back_init_cf( BackendInfo *bi )
693 bi->bi_cf_ocs = mdbocs;
695 rc = config_register_schema( mdbcfg, mdbocs );