1 /* config.c - mdb backend configuration file routine */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 2000-2017 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 { "rtxnsize", "entries", 2, 2, 0, ARG_UINT|ARG_OFFSET,
82 (void *)offsetof(struct mdb_info, mi_rtxn_size),
83 "( OLcfgDbAt:12.5 NAME 'olcDbRtxnSize' "
84 "DESC 'Number of entries to process in one read transaction' "
85 "SYNTAX OMsInteger SINGLE-VALUE )", NULL, NULL },
86 { "searchstack", "depth", 2, 2, 0, ARG_INT|ARG_MAGIC|MDB_SSTACK,
87 mdb_cf_gen, "( OLcfgDbAt:1.9 NAME 'olcDbSearchStack' "
88 "DESC 'Depth of search stack in IDLs' "
89 "SYNTAX OMsInteger SINGLE-VALUE )", NULL, NULL },
90 { NULL, NULL, 0, 0, 0, ARG_IGNORED,
91 NULL, NULL, NULL, NULL }
94 static ConfigOCs mdbocs[] = {
97 "NAME 'olcMdbConfig' "
98 "DESC 'MDB backend configuration' "
99 "SUP olcDatabaseConfig "
100 "MUST olcDbDirectory "
101 "MAY ( olcDbCheckpoint $ olcDbEnvFlags $ "
102 "olcDbNoSync $ olcDbIndex $ olcDbMaxReaders $ olcDbMaxSize $ "
103 "olcDbMode $ olcDbSearchStack $ olcDbRtxnSize ) )",
104 Cft_Database, mdbcfg },
108 static slap_verbmasks mdb_envflags[] = {
109 { BER_BVC("nosync"), MDB_NOSYNC },
110 { BER_BVC("nometasync"), MDB_NOMETASYNC },
111 { BER_BVC("writemap"), MDB_WRITEMAP },
112 { BER_BVC("mapasync"), MDB_MAPASYNC },
113 { BER_BVC("nordahead"), MDB_NORDAHEAD },
117 /* perform periodic syncs */
119 mdb_checkpoint( void *ctx, void *arg )
121 struct re_s *rtask = arg;
122 struct mdb_info *mdb = rtask->arg;
124 mdb_env_sync( mdb->mi_dbenv, 1 );
125 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
126 ldap_pvt_runqueue_stoptask( &slapd_rq, rtask );
127 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
131 /* reindex entries on the fly */
133 mdb_online_index( void *ctx, void *arg )
135 struct re_s *rtask = arg;
136 BackendDB *be = rtask->arg;
137 struct mdb_info *mdb = be->be_private;
139 Connection conn = {0};
140 OperationBuffer opbuf;
151 connection_fake_init( &conn, &opbuf, ctx );
157 key.mv_size = sizeof(ID);
160 if ( slapd_shutdown )
163 rc = mdb_txn_begin( mdb->mi_dbenv, NULL, 0, &txn );
166 rc = mdb_cursor_open( txn, mdb->mi_id2entry, &curs );
168 mdb_txn_abort( txn );
174 rc = mdb_cursor_get( curs, &key, &data, MDB_SET_RANGE );
176 mdb_txn_abort( txn );
177 if ( rc == MDB_NOTFOUND )
181 memcpy( &id, key.mv_data, sizeof( id ));
184 rc = mdb_id2entry( op, curs, id, &e );
185 mdb_cursor_close( curs );
187 mdb_txn_abort( txn );
188 if ( rc == MDB_NOTFOUND ) {
195 rc = mdb_index_entry( op, txn, MDB_INDEX_UPDATE_OP, e );
196 mdb_entry_return( op, e );
198 rc = mdb_txn_commit( txn );
201 mdb_txn_abort( txn );
205 Debug( LDAP_DEBUG_ANY,
206 LDAP_XSTRING(mdb_online_index) ": database %s: "
207 "txn_commit failed: %s (%d)\n",
208 be->be_suffix[0].bv_val, mdb_strerror(rc), rc );
215 for ( i = 0; i < mdb->mi_nattrs; i++ ) {
216 if ( mdb->mi_attrs[ i ]->ai_indexmask & MDB_INDEX_DELETING
217 || mdb->mi_attrs[ i ]->ai_newmask == 0 )
221 mdb->mi_attrs[ i ]->ai_indexmask = mdb->mi_attrs[ i ]->ai_newmask;
222 mdb->mi_attrs[ i ]->ai_newmask = 0;
225 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
226 ldap_pvt_runqueue_stoptask( &slapd_rq, rtask );
227 mdb->mi_index_task = NULL;
228 ldap_pvt_runqueue_remove( &slapd_rq, rtask );
229 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
234 /* Cleanup loose ends after Modify completes */
236 mdb_cf_cleanup( ConfigArgs *c )
238 struct mdb_info *mdb = c->be->be_private;
241 if ( mdb->mi_flags & MDB_DEL_INDEX ) {
242 mdb_attr_flush( mdb );
243 mdb->mi_flags ^= MDB_DEL_INDEX;
246 if ( mdb->mi_flags & MDB_RE_OPEN ) {
247 mdb->mi_flags ^= MDB_RE_OPEN;
248 rc = c->be->bd_info->bi_db_close( c->be, &c->reply );
250 rc = c->be->bd_info->bi_db_open( c->be, &c->reply );
251 /* If this fails, we need to restart */
254 snprintf( c->cr_msg, sizeof( c->cr_msg ),
255 "failed to reopen database, rc=%d", rc );
256 Debug( LDAP_DEBUG_ANY, LDAP_XSTRING(mdb_cf_cleanup)
257 ": %s\n", c->cr_msg, 0, 0 );
262 if ( mdb->mi_flags & MDB_OPEN_INDEX ) {
263 rc = mdb_attr_dbs_open( c->be, NULL, &c->reply );
271 mdb_cf_gen( ConfigArgs *c )
273 struct mdb_info *mdb = c->be->be_private;
276 if ( c->op == SLAP_CONFIG_EMIT ) {
282 bv.bv_len = snprintf( buf, sizeof(buf), "0%o", mdb->mi_dbenv_mode );
283 if ( bv.bv_len > 0 && bv.bv_len < sizeof(buf) ) {
285 value_add_one( &c->rvalue_vals, &bv );
292 if ( mdb->mi_txn_cp ) {
295 bv.bv_len = snprintf( buf, sizeof(buf), "%ld %ld",
296 (long) mdb->mi_txn_cp_kbyte, (long) mdb->mi_txn_cp_min );
297 if ( bv.bv_len > 0 && bv.bv_len < sizeof(buf) ) {
299 value_add_one( &c->rvalue_vals, &bv );
309 if ( mdb->mi_dbenv_home ) {
310 c->value_string = ch_strdup( mdb->mi_dbenv_home );
317 if ( mdb->mi_dbenv_flags & MDB_NOSYNC )
322 if ( mdb->mi_dbenv_flags ) {
323 mask_to_verbs( mdb_envflags, mdb->mi_dbenv_flags, &c->rvalue_vals );
325 if ( !c->rvalue_vals ) rc = 1;
329 mdb_attr_index_unparse( mdb, &c->rvalue_vals );
330 if ( !c->rvalue_vals ) rc = 1;
334 c->value_int = mdb->mi_search_stack_depth;
338 c->value_int = mdb->mi_readers;
342 c->value_ulong = mdb->mi_mapsize;
346 } else if ( c->op == LDAP_MOD_DELETE ) {
351 /* FIXME: does it make any sense to change the mode,
352 * if we don't exec a chmod()? */
353 mdb->bi_dbenv_mode = SLAPD_DEFAULT_DB_MODE;
357 /* single-valued no-ops */
364 if ( mdb->mi_txn_cp_task ) {
365 struct re_s *re = mdb->mi_txn_cp_task;
366 mdb->mi_txn_cp_task = NULL;
367 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
368 if ( ldap_pvt_runqueue_isrunning( &slapd_rq, re ) )
369 ldap_pvt_runqueue_stoptask( &slapd_rq, re );
370 ldap_pvt_runqueue_remove( &slapd_rq, re );
371 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
376 mdb->mi_flags |= MDB_RE_OPEN;
377 ch_free( mdb->mi_dbenv_home );
378 mdb->mi_dbenv_home = NULL;
379 c->cleanup = mdb_cf_cleanup;
380 ldap_pvt_thread_pool_purgekey( mdb->mi_dbenv );
383 mdb_env_set_flags( mdb->mi_dbenv, MDB_NOSYNC, 0 );
384 mdb->mi_dbenv_flags &= ~MDB_NOSYNC;
388 if ( c->valx == -1 ) {
390 for ( i=0; mdb_envflags[i].mask; i++) {
391 if ( mdb->mi_dbenv_flags & mdb_envflags[i].mask ) {
392 /* not all flags are runtime resettable */
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;
403 int i = verb_to_mask( c->line, mdb_envflags );
404 if ( mdb_envflags[i].mask & mdb->mi_dbenv_flags ) {
405 rc = mdb_env_set_flags( mdb->mi_dbenv, mdb_envflags[i].mask, 0 );
407 mdb->mi_flags |= MDB_RE_OPEN;
408 c->cleanup = mdb_cf_cleanup;
411 mdb->mi_dbenv_flags ^= mdb_envflags[i].mask;
413 /* unknown keyword */
414 snprintf( c->cr_msg, sizeof( c->cr_msg ), "%s: unknown keyword \"%s\"",
415 c->argv[0], c->argv[i] );
416 Debug( LDAP_DEBUG_CONFIG, "%s %s\n", c->log, c->cr_msg, 0 );
423 if ( c->valx == -1 ) {
426 /* delete all (FIXME) */
427 for ( i = 0; i < mdb->mi_nattrs; i++ ) {
428 mdb->mi_attrs[i]->ai_indexmask |= MDB_INDEX_DELETING;
430 mdb->mi_flags |= MDB_DEL_INDEX;
431 c->cleanup = mdb_cf_cleanup;
434 struct berval bv, def = BER_BVC("default");
437 for (ptr = c->line; !isspace( (unsigned char) *ptr ); ptr++);
440 bv.bv_len = ptr - bv.bv_val;
441 if ( bvmatch( &bv, &def )) {
442 mdb->mi_defaultmask = 0;
449 sep = bv.bv_val[ bv.bv_len ];
450 bv.bv_val[ bv.bv_len ] = '\0';
451 attrs = ldap_str2charray( bv.bv_val, "," );
453 for ( i = 0; attrs[ i ]; i++ ) {
454 AttributeDescription *ad = NULL;
458 slap_str2ad( attrs[ i ], &ad, &text );
459 /* if we got here... */
460 assert( ad != NULL );
462 ai = mdb_attr_mask( mdb, ad );
463 /* if we got here... */
464 assert( ai != NULL );
466 ai->ai_indexmask |= MDB_INDEX_DELETING;
467 mdb->mi_flags |= MDB_DEL_INDEX;
468 c->cleanup = mdb_cf_cleanup;
471 bv.bv_val[ bv.bv_len ] = sep;
472 ldap_charray_free( attrs );
482 if ( ASCII_DIGIT( c->argv[1][0] ) ) {
486 mode = strtol( c->argv[1], &next, 0 );
487 if ( errno != 0 || next == c->argv[1] || next[0] != '\0' ) {
488 fprintf( stderr, "%s: "
489 "unable to parse mode=\"%s\".\n",
490 c->log, c->argv[1] );
493 mdb->mi_dbenv_mode = mode;
496 char *m = c->argv[1];
497 int who, what, mode = 0;
499 if ( strlen( m ) != STRLENOF("-rwxrwxrwx") ) {
508 for ( who = 0; who < 3; who++ ) {
509 for ( what = 0; what < 3; what++, m++ ) {
512 } else if ( m[0] != "rwx"[what] ) {
515 mode += ((1 << (2 - what)) << 3*(2 - who));
518 mdb->mi_dbenv_mode = mode;
524 if ( lutil_atolx( &l, c->argv[1], 0 ) != 0 ) {
525 fprintf( stderr, "%s: "
526 "invalid kbyte \"%s\" in \"checkpoint\".\n",
527 c->log, c->argv[1] );
530 mdb->mi_txn_cp_kbyte = l;
531 if ( lutil_atolx( &l, c->argv[2], 0 ) != 0 ) {
532 fprintf( stderr, "%s: "
533 "invalid minutes \"%s\" in \"checkpoint\".\n",
534 c->log, c->argv[2] );
537 mdb->mi_txn_cp_min = l;
538 /* If we're in server mode and time-based checkpointing is enabled,
539 * submit a task to perform periodic checkpoints.
541 if ((slapMode & SLAP_SERVER_MODE) && mdb->mi_txn_cp_min ) {
542 struct re_s *re = mdb->mi_txn_cp_task;
544 re->interval.tv_sec = mdb->mi_txn_cp_min * 60;
546 if ( c->be->be_suffix == NULL || BER_BVISNULL( &c->be->be_suffix[0] ) ) {
547 fprintf( stderr, "%s: "
548 "\"checkpoint\" must occur after \"suffix\".\n",
552 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
553 mdb->mi_txn_cp_task = ldap_pvt_runqueue_insert( &slapd_rq,
554 mdb->mi_txn_cp_min * 60, mdb_checkpoint, mdb,
555 LDAP_XSTRING(mdb_checkpoint), c->be->be_suffix[0].bv_val );
556 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
561 case MDB_DIRECTORY: {
563 char *ptr, *testpath;
566 len = strlen( c->value_string );
567 testpath = ch_malloc( len + STRLENOF(LDAP_DIRSEP) + STRLENOF("DUMMY") + 1 );
568 ptr = lutil_strcopy( testpath, c->value_string );
569 *ptr++ = LDAP_DIRSEP[0];
570 strcpy( ptr, "DUMMY" );
571 f = fopen( testpath, "w" );
578 snprintf( c->cr_msg, sizeof( c->cr_msg ), "%s: invalid path: %s",
579 c->log, strerror( errno ));
580 Debug( LDAP_DEBUG_ANY, "%s\n", c->cr_msg, 0, 0 );
584 if ( mdb->mi_dbenv_home )
585 ch_free( mdb->mi_dbenv_home );
586 mdb->mi_dbenv_home = c->value_string;
593 mdb->mi_dbenv_flags |= MDB_NOSYNC;
595 mdb->mi_dbenv_flags ^= MDB_NOSYNC;
596 if ( mdb->mi_flags & MDB_IS_OPEN ) {
597 mdb_env_set_flags( mdb->mi_dbenv, MDB_NOSYNC,
604 for ( i=1; i<c->argc; i++ ) {
605 j = verb_to_mask( c->argv[i], mdb_envflags );
606 if ( mdb_envflags[j].mask ) {
607 if ( mdb->mi_flags & MDB_IS_OPEN )
608 rc = mdb_env_set_flags( mdb->mi_dbenv, mdb_envflags[j].mask, 1 );
612 mdb->mi_flags |= MDB_RE_OPEN;
613 c->cleanup = mdb_cf_cleanup;
616 mdb->mi_dbenv_flags |= mdb_envflags[j].mask;
618 /* unknown keyword */
619 snprintf( c->cr_msg, sizeof( c->cr_msg ), "%s: unknown keyword \"%s\"",
620 c->argv[0], c->argv[i] );
621 Debug( LDAP_DEBUG_ANY, "%s %s\n", c->log, c->cr_msg, 0 );
629 rc = mdb_attr_index_config( mdb, c->fname, c->lineno,
630 c->argc - 1, &c->argv[1], &c->reply);
632 if( rc != LDAP_SUCCESS ) return 1;
633 mdb->mi_flags |= MDB_OPEN_INDEX;
634 if ( mdb->mi_flags & MDB_IS_OPEN ) {
635 c->cleanup = mdb_cf_cleanup;
636 if ( !mdb->mi_index_task ) {
637 /* Start the task as soon as we finish here. Set a long
638 * interval (10 hours) so that it only gets scheduled once.
640 if ( c->be->be_suffix == NULL || BER_BVISNULL( &c->be->be_suffix[0] ) ) {
641 fprintf( stderr, "%s: "
642 "\"index\" must occur after \"suffix\".\n",
646 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
647 mdb->mi_index_task = ldap_pvt_runqueue_insert( &slapd_rq, 36000,
648 mdb_online_index, c->be,
649 LDAP_XSTRING(mdb_online_index), c->be->be_suffix[0].bv_val );
650 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
656 if ( c->value_int < MINIMUM_SEARCH_STACK_DEPTH ) {
658 "%s: depth %d too small, using %d\n",
659 c->log, c->value_int, MINIMUM_SEARCH_STACK_DEPTH );
660 c->value_int = MINIMUM_SEARCH_STACK_DEPTH;
662 mdb->mi_search_stack_depth = c->value_int;
666 mdb->mi_readers = c->value_int;
667 if ( mdb->mi_flags & MDB_IS_OPEN ) {
668 mdb->mi_flags |= MDB_RE_OPEN;
669 c->cleanup = mdb_cf_cleanup;
674 mdb->mi_mapsize = c->value_ulong;
675 if ( mdb->mi_flags & MDB_IS_OPEN ) {
676 mdb->mi_flags |= MDB_RE_OPEN;
677 c->cleanup = mdb_cf_cleanup;
685 int mdb_back_init_cf( BackendInfo *bi )
688 bi->bi_cf_ocs = mdbocs;
690 rc = config_register_schema( mdbcfg, mdbocs );