1 /* config.c - mdb backend configuration file routine */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 2000-2014 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;
46 static ConfigTable mdbcfg[] = {
47 { "directory", "dir", 2, 2, 0, ARG_STRING|ARG_MAGIC|MDB_DIRECTORY,
48 mdb_cf_gen, "( OLcfgDbAt:0.1 NAME 'olcDbDirectory' "
49 "DESC 'Directory for database content' "
50 "EQUALITY caseIgnoreMatch "
51 "SYNTAX OMsDirectoryString SINGLE-VALUE )", NULL, NULL },
52 { "checkpoint", "kbyte> <min", 3, 3, 0, ARG_MAGIC|MDB_CHKPT,
53 mdb_cf_gen, "( OLcfgDbAt:1.2 NAME 'olcDbCheckpoint' "
54 "DESC 'Database checkpoint interval in kbytes and minutes' "
55 "SYNTAX OMsDirectoryString SINGLE-VALUE )",NULL, NULL },
56 { "dbnosync", NULL, 1, 2, 0, ARG_ON_OFF|ARG_MAGIC|MDB_DBNOSYNC,
57 mdb_cf_gen, "( OLcfgDbAt:1.4 NAME 'olcDbNoSync' "
58 "DESC 'Disable synchronous database writes' "
59 "SYNTAX OMsBoolean SINGLE-VALUE )", NULL, NULL },
60 { "envflags", "flags", 2, 0, 0, ARG_MAGIC|MDB_ENVFLAGS,
61 mdb_cf_gen, "( OLcfgDbAt:12.3 NAME 'olcDbEnvFlags' "
62 "DESC 'Database environment flags' "
63 "EQUALITY caseIgnoreMatch "
64 "SYNTAX OMsDirectoryString )", NULL, NULL },
65 { "index", "attr> <[pres,eq,approx,sub]", 2, 3, 0, ARG_MAGIC|MDB_INDEX,
66 mdb_cf_gen, "( OLcfgDbAt:0.2 NAME 'olcDbIndex' "
67 "DESC 'Attribute index parameters' "
68 "EQUALITY caseIgnoreMatch "
69 "SYNTAX OMsDirectoryString )", NULL, NULL },
70 { "maxentrysize", "size", 2, 2, 0, ARG_ULONG|ARG_MAGIC|MDB_MAXENTSZ,
71 mdb_cf_gen, "( 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 { "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 $ olcDbMaxEntrySize ) )",
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_ulong = mdb->mi_maxentrysize;
342 c->value_int = mdb->mi_readers;
346 c->value_ulong = mdb->mi_mapsize;
350 } else if ( c->op == LDAP_MOD_DELETE ) {
355 /* FIXME: does it make any sense to change the mode,
356 * if we don't exec a chmod()? */
357 mdb->bi_dbenv_mode = SLAPD_DEFAULT_DB_MODE;
361 /* single-valued no-ops */
368 mdb->mi_maxentrysize = 0;
372 if ( mdb->mi_txn_cp_task ) {
373 struct re_s *re = mdb->mi_txn_cp_task;
374 mdb->mi_txn_cp_task = NULL;
375 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
376 if ( ldap_pvt_runqueue_isrunning( &slapd_rq, re ) )
377 ldap_pvt_runqueue_stoptask( &slapd_rq, re );
378 ldap_pvt_runqueue_remove( &slapd_rq, re );
379 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
384 mdb->mi_flags |= MDB_RE_OPEN;
385 ch_free( mdb->mi_dbenv_home );
386 mdb->mi_dbenv_home = NULL;
387 c->cleanup = mdb_cf_cleanup;
388 ldap_pvt_thread_pool_purgekey( mdb->mi_dbenv );
391 mdb_env_set_flags( mdb->mi_dbenv, MDB_NOSYNC, 0 );
392 mdb->mi_dbenv_flags &= ~MDB_NOSYNC;
396 if ( c->valx == -1 ) {
398 for ( i=0; mdb_envflags[i].mask; i++) {
399 if ( mdb->mi_dbenv_flags & mdb_envflags[i].mask ) {
400 /* not all flags are runtime resettable */
401 rc = mdb_env_set_flags( mdb->mi_dbenv, mdb_envflags[i].mask, 0 );
403 mdb->mi_flags |= MDB_RE_OPEN;
404 c->cleanup = mdb_cf_cleanup;
407 mdb->mi_dbenv_flags ^= mdb_envflags[i].mask;
411 int i = verb_to_mask( c->line, mdb_envflags );
412 if ( mdb_envflags[i].mask & mdb->mi_dbenv_flags ) {
413 rc = mdb_env_set_flags( mdb->mi_dbenv, mdb_envflags[i].mask, 0 );
415 mdb->mi_flags |= MDB_RE_OPEN;
416 c->cleanup = mdb_cf_cleanup;
419 mdb->mi_dbenv_flags ^= mdb_envflags[i].mask;
421 /* unknown keyword */
422 snprintf( c->cr_msg, sizeof( c->cr_msg ), "%s: unknown keyword \"%s\"",
423 c->argv[0], c->argv[i] );
424 Debug( LDAP_DEBUG_CONFIG, "%s %s\n", c->log, c->cr_msg, 0 );
431 if ( c->valx == -1 ) {
434 /* delete all (FIXME) */
435 for ( i = 0; i < mdb->mi_nattrs; i++ ) {
436 mdb->mi_attrs[i]->ai_indexmask |= MDB_INDEX_DELETING;
438 mdb->mi_flags |= MDB_DEL_INDEX;
439 c->cleanup = mdb_cf_cleanup;
442 struct berval bv, def = BER_BVC("default");
445 for (ptr = c->line; !isspace( (unsigned char) *ptr ); ptr++);
448 bv.bv_len = ptr - bv.bv_val;
449 if ( bvmatch( &bv, &def )) {
450 mdb->mi_defaultmask = 0;
457 sep = bv.bv_val[ bv.bv_len ];
458 bv.bv_val[ bv.bv_len ] = '\0';
459 attrs = ldap_str2charray( bv.bv_val, "," );
461 for ( i = 0; attrs[ i ]; i++ ) {
462 AttributeDescription *ad = NULL;
466 slap_str2ad( attrs[ i ], &ad, &text );
467 /* if we got here... */
468 assert( ad != NULL );
470 ai = mdb_attr_mask( mdb, ad );
471 /* if we got here... */
472 assert( ai != NULL );
474 ai->ai_indexmask |= MDB_INDEX_DELETING;
475 mdb->mi_flags |= MDB_DEL_INDEX;
476 c->cleanup = mdb_cf_cleanup;
479 bv.bv_val[ bv.bv_len ] = sep;
480 ldap_charray_free( attrs );
490 if ( ASCII_DIGIT( c->argv[1][0] ) ) {
494 mode = strtol( c->argv[1], &next, 0 );
495 if ( errno != 0 || next == c->argv[1] || next[0] != '\0' ) {
496 fprintf( stderr, "%s: "
497 "unable to parse mode=\"%s\".\n",
498 c->log, c->argv[1] );
501 mdb->mi_dbenv_mode = mode;
504 char *m = c->argv[1];
505 int who, what, mode = 0;
507 if ( strlen( m ) != STRLENOF("-rwxrwxrwx") ) {
516 for ( who = 0; who < 3; who++ ) {
517 for ( what = 0; what < 3; what++, m++ ) {
520 } else if ( m[0] != "rwx"[what] ) {
523 mode += ((1 << (2 - what)) << 3*(2 - who));
526 mdb->mi_dbenv_mode = mode;
532 if ( lutil_atolx( &l, c->argv[1], 0 ) != 0 ) {
533 fprintf( stderr, "%s: "
534 "invalid kbyte \"%s\" in \"checkpoint\".\n",
535 c->log, c->argv[1] );
538 mdb->mi_txn_cp_kbyte = l;
539 if ( lutil_atolx( &l, c->argv[2], 0 ) != 0 ) {
540 fprintf( stderr, "%s: "
541 "invalid minutes \"%s\" in \"checkpoint\".\n",
542 c->log, c->argv[2] );
545 mdb->mi_txn_cp_min = l;
546 /* If we're in server mode and time-based checkpointing is enabled,
547 * submit a task to perform periodic checkpoints.
549 if ((slapMode & SLAP_SERVER_MODE) && mdb->mi_txn_cp_min ) {
550 struct re_s *re = mdb->mi_txn_cp_task;
552 re->interval.tv_sec = mdb->mi_txn_cp_min * 60;
554 if ( c->be->be_suffix == NULL || BER_BVISNULL( &c->be->be_suffix[0] ) ) {
555 fprintf( stderr, "%s: "
556 "\"checkpoint\" must occur after \"suffix\".\n",
560 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
561 mdb->mi_txn_cp_task = ldap_pvt_runqueue_insert( &slapd_rq,
562 mdb->mi_txn_cp_min * 60, mdb_checkpoint, mdb,
563 LDAP_XSTRING(mdb_checkpoint), c->be->be_suffix[0].bv_val );
564 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
569 case MDB_DIRECTORY: {
571 char *ptr, *testpath;
574 len = strlen( c->value_string );
575 testpath = ch_malloc( len + STRLENOF(LDAP_DIRSEP) + STRLENOF("DUMMY") + 1 );
576 ptr = lutil_strcopy( testpath, c->value_string );
577 *ptr++ = LDAP_DIRSEP[0];
578 strcpy( ptr, "DUMMY" );
579 f = fopen( testpath, "w" );
586 snprintf( c->cr_msg, sizeof( c->cr_msg ), "%s: invalid path: %s",
587 c->log, strerror( errno ));
588 Debug( LDAP_DEBUG_ANY, "%s\n", c->cr_msg, 0, 0 );
592 if ( mdb->mi_dbenv_home )
593 ch_free( mdb->mi_dbenv_home );
594 mdb->mi_dbenv_home = c->value_string;
601 mdb->mi_dbenv_flags |= MDB_NOSYNC;
603 mdb->mi_dbenv_flags ^= MDB_NOSYNC;
604 if ( mdb->mi_flags & MDB_IS_OPEN ) {
605 mdb_env_set_flags( mdb->mi_dbenv, MDB_NOSYNC,
612 for ( i=1; i<c->argc; i++ ) {
613 j = verb_to_mask( c->argv[i], mdb_envflags );
614 if ( mdb_envflags[j].mask ) {
615 if ( mdb->mi_flags & MDB_IS_OPEN )
616 rc = mdb_env_set_flags( mdb->mi_dbenv, mdb_envflags[j].mask, 1 );
620 mdb->mi_flags |= MDB_RE_OPEN;
621 c->cleanup = mdb_cf_cleanup;
624 mdb->mi_dbenv_flags |= mdb_envflags[j].mask;
626 /* unknown keyword */
627 snprintf( c->cr_msg, sizeof( c->cr_msg ), "%s: unknown keyword \"%s\"",
628 c->argv[0], c->argv[i] );
629 Debug( LDAP_DEBUG_ANY, "%s %s\n", c->log, c->cr_msg, 0 );
637 rc = mdb_attr_index_config( mdb, c->fname, c->lineno,
638 c->argc - 1, &c->argv[1], &c->reply);
640 if( rc != LDAP_SUCCESS ) return 1;
641 mdb->mi_flags |= MDB_OPEN_INDEX;
642 if ( mdb->mi_flags & MDB_IS_OPEN ) {
643 c->cleanup = mdb_cf_cleanup;
644 if ( !mdb->mi_index_task ) {
645 /* Start the task as soon as we finish here. Set a long
646 * interval (10 hours) so that it only gets scheduled once.
648 if ( c->be->be_suffix == NULL || BER_BVISNULL( &c->be->be_suffix[0] ) ) {
649 fprintf( stderr, "%s: "
650 "\"index\" must occur after \"suffix\".\n",
654 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
655 mdb->mi_index_task = ldap_pvt_runqueue_insert( &slapd_rq, 36000,
656 mdb_online_index, c->be,
657 LDAP_XSTRING(mdb_online_index), c->be->be_suffix[0].bv_val );
658 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
664 if ( c->value_int < MINIMUM_SEARCH_STACK_DEPTH ) {
666 "%s: depth %d too small, using %d\n",
667 c->log, c->value_int, MINIMUM_SEARCH_STACK_DEPTH );
668 c->value_int = MINIMUM_SEARCH_STACK_DEPTH;
670 mdb->mi_search_stack_depth = c->value_int;
674 mdb->mi_maxentrysize = c->value_ulong;
678 mdb->mi_readers = c->value_int;
679 if ( mdb->mi_flags & MDB_IS_OPEN ) {
680 mdb->mi_flags |= MDB_RE_OPEN;
681 c->cleanup = mdb_cf_cleanup;
686 mdb->mi_mapsize = c->value_ulong;
687 if ( mdb->mi_flags & MDB_IS_OPEN ) {
688 mdb->mi_flags |= MDB_RE_OPEN;
689 c->cleanup = mdb_cf_cleanup;
697 int mdb_back_init_cf( BackendInfo *bi )
700 bi->bi_cf_ocs = mdbocs;
702 rc = config_register_schema( mdbcfg, mdbocs );