1 /* config.c - mdb backend configuration file routine */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 2000-2018 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 { "multival_hi", "num", 2, 2, 0, ARG_UINT|ARG_OFFSET,
87 (void *)offsetof(struct mdb_info, mi_multi_hi),
88 "( OLcfgDbAt:12.6 NAME 'olcDbMultivalHi' "
89 "DESC 'Threshold for splitting multivalued attr out of main blob' "
90 "SYNTAX OMsInteger SINGLE-VALUE )", NULL, NULL },
91 { "multival_lo", "num", 2, 2, 0, ARG_UINT|ARG_OFFSET,
92 (void *)offsetof(struct mdb_info, mi_multi_lo),
93 "( OLcfgDbAt:12.7 NAME 'olcDbMultivalLo' "
94 "DESC 'Threshold for consolidating multivalued attr back into main blob' "
95 "SYNTAX OMsInteger SINGLE-VALUE )", NULL, NULL },
96 { "rtxnsize", "entries", 2, 2, 0, ARG_UINT|ARG_OFFSET,
97 (void *)offsetof(struct mdb_info, mi_rtxn_size),
98 "( OLcfgDbAt:12.5 NAME 'olcDbRtxnSize' "
99 "DESC 'Number of entries to process in one read transaction' "
100 "SYNTAX OMsInteger SINGLE-VALUE )", NULL, NULL },
101 { "searchstack", "depth", 2, 2, 0, ARG_INT|ARG_MAGIC|MDB_SSTACK,
102 mdb_cf_gen, "( OLcfgDbAt:1.9 NAME 'olcDbSearchStack' "
103 "DESC 'Depth of search stack in IDLs' "
104 "SYNTAX OMsInteger SINGLE-VALUE )", NULL, NULL },
105 { NULL, NULL, 0, 0, 0, ARG_IGNORED,
106 NULL, NULL, NULL, NULL }
109 static ConfigOCs mdbocs[] = {
112 "NAME 'olcMdbConfig' "
113 "DESC 'MDB backend configuration' "
114 "SUP olcDatabaseConfig "
115 "MUST olcDbDirectory "
116 "MAY ( olcDbCheckpoint $ olcDbEnvFlags $ "
117 "olcDbNoSync $ olcDbIndex $ olcDbMaxReaders $ olcDbMaxSize $ "
118 "olcDbMode $ olcDbSearchStack $ olcDbMaxEntrySize $ olcDbRtxnSize $ "
119 "olcDbMultivalHi $ olcDbMultivalLo ) )",
120 Cft_Database, mdbcfg },
124 static slap_verbmasks mdb_envflags[] = {
125 { BER_BVC("nosync"), MDB_NOSYNC },
126 { BER_BVC("nometasync"), MDB_NOMETASYNC },
127 { BER_BVC("writemap"), MDB_WRITEMAP },
128 { BER_BVC("mapasync"), MDB_MAPASYNC },
129 { BER_BVC("nordahead"), MDB_NORDAHEAD },
133 /* perform periodic syncs */
135 mdb_checkpoint( void *ctx, void *arg )
137 struct re_s *rtask = arg;
138 struct mdb_info *mdb = rtask->arg;
140 mdb_env_sync( mdb->mi_dbenv, 1 );
141 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
142 ldap_pvt_runqueue_stoptask( &slapd_rq, rtask );
143 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
147 /* reindex entries on the fly */
149 mdb_online_index( void *ctx, void *arg )
151 struct re_s *rtask = arg;
152 BackendDB *be = rtask->arg;
153 struct mdb_info *mdb = be->be_private;
155 Connection conn = {0};
156 OperationBuffer opbuf;
167 connection_fake_init( &conn, &opbuf, ctx );
173 key.mv_size = sizeof(ID);
176 if ( slapd_shutdown )
179 rc = mdb_txn_begin( mdb->mi_dbenv, NULL, 0, &txn );
182 rc = mdb_cursor_open( txn, mdb->mi_id2entry, &curs );
184 mdb_txn_abort( txn );
190 rc = mdb_cursor_get( curs, &key, &data, MDB_SET_RANGE );
192 mdb_txn_abort( txn );
193 if ( rc == MDB_NOTFOUND )
197 memcpy( &id, key.mv_data, sizeof( id ));
200 rc = mdb_id2entry( op, curs, id, &e );
201 mdb_cursor_close( curs );
203 mdb_txn_abort( txn );
204 if ( rc == MDB_NOTFOUND ) {
211 rc = mdb_index_entry( op, txn, MDB_INDEX_UPDATE_OP, e );
212 mdb_entry_return( op, e );
214 rc = mdb_txn_commit( txn );
217 mdb_txn_abort( txn );
221 Debug( LDAP_DEBUG_ANY,
222 LDAP_XSTRING(mdb_online_index) ": database %s: "
223 "txn_commit failed: %s (%d)\n",
224 be->be_suffix[0].bv_val, mdb_strerror(rc), rc );
231 for ( i = 0; i < mdb->mi_nattrs; i++ ) {
232 if ( mdb->mi_attrs[ i ]->ai_indexmask & MDB_INDEX_DELETING
233 || mdb->mi_attrs[ i ]->ai_newmask == 0 )
237 mdb->mi_attrs[ i ]->ai_indexmask = mdb->mi_attrs[ i ]->ai_newmask;
238 mdb->mi_attrs[ i ]->ai_newmask = 0;
241 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
242 ldap_pvt_runqueue_stoptask( &slapd_rq, rtask );
243 mdb->mi_index_task = NULL;
244 ldap_pvt_runqueue_remove( &slapd_rq, rtask );
245 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
250 /* Cleanup loose ends after Modify completes */
252 mdb_cf_cleanup( ConfigArgs *c )
254 struct mdb_info *mdb = c->be->be_private;
257 if ( mdb->mi_flags & MDB_DEL_INDEX ) {
258 mdb_attr_flush( mdb );
259 mdb->mi_flags ^= MDB_DEL_INDEX;
262 if ( mdb->mi_flags & MDB_RE_OPEN ) {
263 mdb->mi_flags ^= MDB_RE_OPEN;
264 rc = c->be->bd_info->bi_db_close( c->be, &c->reply );
266 rc = c->be->bd_info->bi_db_open( c->be, &c->reply );
267 /* If this fails, we need to restart */
270 snprintf( c->cr_msg, sizeof( c->cr_msg ),
271 "failed to reopen database, rc=%d", rc );
272 Debug( LDAP_DEBUG_ANY, LDAP_XSTRING(mdb_cf_cleanup)
273 ": %s\n", c->cr_msg, 0, 0 );
278 if ( mdb->mi_flags & MDB_OPEN_INDEX ) {
279 rc = mdb_attr_dbs_open( c->be, NULL, &c->reply );
287 mdb_cf_gen( ConfigArgs *c )
289 struct mdb_info *mdb = c->be->be_private;
292 if ( c->op == SLAP_CONFIG_EMIT ) {
298 bv.bv_len = snprintf( buf, sizeof(buf), "0%o", mdb->mi_dbenv_mode );
299 if ( bv.bv_len > 0 && bv.bv_len < sizeof(buf) ) {
301 value_add_one( &c->rvalue_vals, &bv );
308 if ( mdb->mi_txn_cp ) {
311 bv.bv_len = snprintf( buf, sizeof(buf), "%ld %ld",
312 (long) mdb->mi_txn_cp_kbyte, (long) mdb->mi_txn_cp_min );
313 if ( bv.bv_len > 0 && bv.bv_len < sizeof(buf) ) {
315 value_add_one( &c->rvalue_vals, &bv );
325 if ( mdb->mi_dbenv_home ) {
326 c->value_string = ch_strdup( mdb->mi_dbenv_home );
333 if ( mdb->mi_dbenv_flags & MDB_NOSYNC )
338 if ( mdb->mi_dbenv_flags ) {
339 mask_to_verbs( mdb_envflags, mdb->mi_dbenv_flags, &c->rvalue_vals );
341 if ( !c->rvalue_vals ) rc = 1;
345 mdb_attr_index_unparse( mdb, &c->rvalue_vals );
346 if ( !c->rvalue_vals ) rc = 1;
350 c->value_int = mdb->mi_search_stack_depth;
354 c->value_int = mdb->mi_readers;
358 c->value_ulong = mdb->mi_mapsize;
362 } else if ( c->op == LDAP_MOD_DELETE ) {
367 /* FIXME: does it make any sense to change the mode,
368 * if we don't exec a chmod()? */
369 mdb->bi_dbenv_mode = SLAPD_DEFAULT_DB_MODE;
373 /* single-valued no-ops */
380 if ( mdb->mi_txn_cp_task ) {
381 struct re_s *re = mdb->mi_txn_cp_task;
382 mdb->mi_txn_cp_task = NULL;
383 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
384 if ( ldap_pvt_runqueue_isrunning( &slapd_rq, re ) )
385 ldap_pvt_runqueue_stoptask( &slapd_rq, re );
386 ldap_pvt_runqueue_remove( &slapd_rq, re );
387 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
392 mdb->mi_flags |= MDB_RE_OPEN;
393 ch_free( mdb->mi_dbenv_home );
394 mdb->mi_dbenv_home = NULL;
395 c->cleanup = mdb_cf_cleanup;
396 ldap_pvt_thread_pool_purgekey( mdb->mi_dbenv );
399 mdb_env_set_flags( mdb->mi_dbenv, MDB_NOSYNC, 0 );
400 mdb->mi_dbenv_flags &= ~MDB_NOSYNC;
404 if ( c->valx == -1 ) {
406 for ( i=0; mdb_envflags[i].mask; i++) {
407 if ( mdb->mi_dbenv_flags & mdb_envflags[i].mask ) {
408 /* not all flags are runtime resettable */
409 rc = mdb_env_set_flags( mdb->mi_dbenv, mdb_envflags[i].mask, 0 );
411 mdb->mi_flags |= MDB_RE_OPEN;
412 c->cleanup = mdb_cf_cleanup;
415 mdb->mi_dbenv_flags ^= mdb_envflags[i].mask;
419 int i = verb_to_mask( c->line, mdb_envflags );
420 if ( mdb_envflags[i].mask & mdb->mi_dbenv_flags ) {
421 rc = mdb_env_set_flags( mdb->mi_dbenv, mdb_envflags[i].mask, 0 );
423 mdb->mi_flags |= MDB_RE_OPEN;
424 c->cleanup = mdb_cf_cleanup;
427 mdb->mi_dbenv_flags ^= mdb_envflags[i].mask;
429 /* unknown keyword */
430 snprintf( c->cr_msg, sizeof( c->cr_msg ), "%s: unknown keyword \"%s\"",
431 c->argv[0], c->argv[i] );
432 Debug( LDAP_DEBUG_CONFIG, "%s %s\n", c->log, c->cr_msg, 0 );
439 if ( c->valx == -1 ) {
442 /* delete all (FIXME) */
443 for ( i = 0; i < mdb->mi_nattrs; i++ ) {
444 mdb->mi_attrs[i]->ai_indexmask |= MDB_INDEX_DELETING;
446 mdb->mi_flags |= MDB_DEL_INDEX;
447 c->cleanup = mdb_cf_cleanup;
450 struct berval bv, def = BER_BVC("default");
453 for (ptr = c->line; !isspace( (unsigned char) *ptr ); ptr++);
456 bv.bv_len = ptr - bv.bv_val;
457 if ( bvmatch( &bv, &def )) {
458 mdb->mi_defaultmask = 0;
465 sep = bv.bv_val[ bv.bv_len ];
466 bv.bv_val[ bv.bv_len ] = '\0';
467 attrs = ldap_str2charray( bv.bv_val, "," );
469 for ( i = 0; attrs[ i ]; i++ ) {
470 AttributeDescription *ad = NULL;
474 slap_str2ad( attrs[ i ], &ad, &text );
475 /* if we got here... */
476 assert( ad != NULL );
478 ai = mdb_attr_mask( mdb, ad );
479 /* if we got here... */
480 assert( ai != NULL );
482 ai->ai_indexmask |= MDB_INDEX_DELETING;
483 mdb->mi_flags |= MDB_DEL_INDEX;
484 c->cleanup = mdb_cf_cleanup;
487 bv.bv_val[ bv.bv_len ] = sep;
488 ldap_charray_free( attrs );
498 if ( ASCII_DIGIT( c->argv[1][0] ) ) {
502 mode = strtol( c->argv[1], &next, 0 );
503 if ( errno != 0 || next == c->argv[1] || next[0] != '\0' ) {
504 fprintf( stderr, "%s: "
505 "unable to parse mode=\"%s\".\n",
506 c->log, c->argv[1] );
509 mdb->mi_dbenv_mode = mode;
512 char *m = c->argv[1];
513 int who, what, mode = 0;
515 if ( strlen( m ) != STRLENOF("-rwxrwxrwx") ) {
524 for ( who = 0; who < 3; who++ ) {
525 for ( what = 0; what < 3; what++, m++ ) {
528 } else if ( m[0] != "rwx"[what] ) {
531 mode += ((1 << (2 - what)) << 3*(2 - who));
534 mdb->mi_dbenv_mode = mode;
540 if ( lutil_atolx( &l, c->argv[1], 0 ) != 0 ) {
541 fprintf( stderr, "%s: "
542 "invalid kbyte \"%s\" in \"checkpoint\".\n",
543 c->log, c->argv[1] );
546 mdb->mi_txn_cp_kbyte = l;
547 if ( lutil_atolx( &l, c->argv[2], 0 ) != 0 ) {
548 fprintf( stderr, "%s: "
549 "invalid minutes \"%s\" in \"checkpoint\".\n",
550 c->log, c->argv[2] );
553 mdb->mi_txn_cp_min = l;
554 /* If we're in server mode and time-based checkpointing is enabled,
555 * submit a task to perform periodic checkpoints.
557 if ((slapMode & SLAP_SERVER_MODE) && mdb->mi_txn_cp_min ) {
558 struct re_s *re = mdb->mi_txn_cp_task;
560 re->interval.tv_sec = mdb->mi_txn_cp_min * 60;
562 if ( c->be->be_suffix == NULL || BER_BVISNULL( &c->be->be_suffix[0] ) ) {
563 fprintf( stderr, "%s: "
564 "\"checkpoint\" must occur after \"suffix\".\n",
568 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
569 mdb->mi_txn_cp_task = ldap_pvt_runqueue_insert( &slapd_rq,
570 mdb->mi_txn_cp_min * 60, mdb_checkpoint, mdb,
571 LDAP_XSTRING(mdb_checkpoint), c->be->be_suffix[0].bv_val );
572 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
577 case MDB_DIRECTORY: {
579 char *ptr, *testpath;
582 len = strlen( c->value_string );
583 testpath = ch_malloc( len + STRLENOF(LDAP_DIRSEP) + STRLENOF("DUMMY") + 1 );
584 ptr = lutil_strcopy( testpath, c->value_string );
585 *ptr++ = LDAP_DIRSEP[0];
586 strcpy( ptr, "DUMMY" );
587 f = fopen( testpath, "w" );
594 snprintf( c->cr_msg, sizeof( c->cr_msg ), "%s: invalid path: %s",
595 c->log, strerror( errno ));
596 Debug( LDAP_DEBUG_ANY, "%s\n", c->cr_msg, 0, 0 );
600 if ( mdb->mi_dbenv_home )
601 ch_free( mdb->mi_dbenv_home );
602 mdb->mi_dbenv_home = c->value_string;
609 mdb->mi_dbenv_flags |= MDB_NOSYNC;
611 mdb->mi_dbenv_flags ^= MDB_NOSYNC;
612 if ( mdb->mi_flags & MDB_IS_OPEN ) {
613 mdb_env_set_flags( mdb->mi_dbenv, MDB_NOSYNC,
620 for ( i=1; i<c->argc; i++ ) {
621 j = verb_to_mask( c->argv[i], mdb_envflags );
622 if ( mdb_envflags[j].mask ) {
623 if ( mdb->mi_flags & MDB_IS_OPEN )
624 rc = mdb_env_set_flags( mdb->mi_dbenv, mdb_envflags[j].mask, 1 );
628 mdb->mi_flags |= MDB_RE_OPEN;
629 c->cleanup = mdb_cf_cleanup;
632 mdb->mi_dbenv_flags |= mdb_envflags[j].mask;
634 /* unknown keyword */
635 snprintf( c->cr_msg, sizeof( c->cr_msg ), "%s: unknown keyword \"%s\"",
636 c->argv[0], c->argv[i] );
637 Debug( LDAP_DEBUG_ANY, "%s %s\n", c->log, c->cr_msg, 0 );
645 rc = mdb_attr_index_config( mdb, c->fname, c->lineno,
646 c->argc - 1, &c->argv[1], &c->reply);
648 if( rc != LDAP_SUCCESS ) return 1;
649 mdb->mi_flags |= MDB_OPEN_INDEX;
650 if ( mdb->mi_flags & MDB_IS_OPEN ) {
651 c->cleanup = mdb_cf_cleanup;
652 if ( !mdb->mi_index_task ) {
653 /* Start the task as soon as we finish here. Set a long
654 * interval (10 hours) so that it only gets scheduled once.
656 if ( c->be->be_suffix == NULL || BER_BVISNULL( &c->be->be_suffix[0] ) ) {
657 fprintf( stderr, "%s: "
658 "\"index\" must occur after \"suffix\".\n",
662 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
663 mdb->mi_index_task = ldap_pvt_runqueue_insert( &slapd_rq, 36000,
664 mdb_online_index, c->be,
665 LDAP_XSTRING(mdb_online_index), c->be->be_suffix[0].bv_val );
666 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
672 if ( c->value_int < MINIMUM_SEARCH_STACK_DEPTH ) {
674 "%s: depth %d too small, using %d\n",
675 c->log, c->value_int, MINIMUM_SEARCH_STACK_DEPTH );
676 c->value_int = MINIMUM_SEARCH_STACK_DEPTH;
678 mdb->mi_search_stack_depth = c->value_int;
682 mdb->mi_readers = c->value_int;
683 if ( mdb->mi_flags & MDB_IS_OPEN ) {
684 mdb->mi_flags |= MDB_RE_OPEN;
685 c->cleanup = mdb_cf_cleanup;
690 mdb->mi_mapsize = c->value_ulong;
691 if ( mdb->mi_flags & MDB_IS_OPEN ) {
692 mdb->mi_flags |= MDB_RE_OPEN;
693 c->cleanup = mdb_cf_cleanup;
701 int mdb_back_init_cf( BackendInfo *bi )
704 bi->bi_cf_ocs = mdbocs;
706 rc = config_register_schema( mdbcfg, mdbocs );