1 /* config.c - mdb backend configuration file routine */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 2000-2012 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;
44 static ConfigTable mdbcfg[] = {
45 { "directory", "dir", 2, 2, 0, ARG_STRING|ARG_MAGIC|MDB_DIRECTORY,
46 mdb_cf_gen, "( OLcfgDbAt:0.1 NAME 'olcDbDirectory' "
47 "DESC 'Directory for database content' "
48 "EQUALITY caseIgnoreMatch "
49 "SYNTAX OMsDirectoryString SINGLE-VALUE )", NULL, NULL },
50 { "checkpoint", "kbyte> <min", 3, 3, 0, ARG_MAGIC|MDB_CHKPT,
51 mdb_cf_gen, "( OLcfgDbAt:1.2 NAME 'olcDbCheckpoint' "
52 "DESC 'Database checkpoint interval in kbytes and minutes' "
53 "SYNTAX OMsDirectoryString SINGLE-VALUE )",NULL, NULL },
54 { "dbnosync", NULL, 1, 2, 0, ARG_ON_OFF|ARG_MAGIC|MDB_DBNOSYNC,
55 mdb_cf_gen, "( OLcfgDbAt:1.4 NAME 'olcDbNoSync' "
56 "DESC 'Disable synchronous database writes' "
57 "SYNTAX OMsBoolean SINGLE-VALUE )", NULL, NULL },
58 { "index", "attr> <[pres,eq,approx,sub]", 2, 3, 0, ARG_MAGIC|MDB_INDEX,
59 mdb_cf_gen, "( OLcfgDbAt:0.2 NAME 'olcDbIndex' "
60 "DESC 'Attribute index parameters' "
61 "EQUALITY caseIgnoreMatch "
62 "SYNTAX OMsDirectoryString )", NULL, NULL },
63 { "maxreaders", "num", 2, 2, 0, ARG_UINT|ARG_MAGIC|MDB_MAXREADERS,
64 mdb_cf_gen, "( OLcfgDbAt:12.1 NAME 'olcDbMaxReaders' "
65 "DESC 'Maximum number of threads that may access the DB concurrently' "
66 "SYNTAX OMsInteger SINGLE-VALUE )", NULL, NULL },
67 { "maxsize", "size", 2, 2, 0, ARG_ULONG|ARG_MAGIC|MDB_MAXSIZE,
68 mdb_cf_gen, "( OLcfgDbAt:12.2 NAME 'olcDbMaxSize' "
69 "DESC 'Maximum size of DB in bytes' "
70 "SYNTAX OMsInteger SINGLE-VALUE )", NULL, NULL },
71 { "mode", "mode", 2, 2, 0, ARG_MAGIC|MDB_MODE,
72 mdb_cf_gen, "( OLcfgDbAt:0.3 NAME 'olcDbMode' "
73 "DESC 'Unix permissions of database files' "
74 "SYNTAX OMsDirectoryString SINGLE-VALUE )", NULL, NULL },
75 { "searchstack", "depth", 2, 2, 0, ARG_INT|ARG_MAGIC|MDB_SSTACK,
76 mdb_cf_gen, "( OLcfgDbAt:1.9 NAME 'olcDbSearchStack' "
77 "DESC 'Depth of search stack in IDLs' "
78 "SYNTAX OMsInteger SINGLE-VALUE )", NULL, NULL },
79 { NULL, NULL, 0, 0, 0, ARG_IGNORED,
80 NULL, NULL, NULL, NULL }
83 static ConfigOCs mdbocs[] = {
86 "NAME 'olcMdbConfig' "
87 "DESC 'MDB backend configuration' "
88 "SUP olcDatabaseConfig "
89 "MUST olcDbDirectory "
90 "MAY ( olcDbCheckpoint $ "
91 "olcDbNoSync $ olcDbIndex $ olcDbMaxReaders $ olcDbMaxsize $ "
92 "olcDbMode $ olcDbSearchStack ) )",
93 Cft_Database, mdbcfg },
97 /* perform periodic syncs */
99 mdb_checkpoint( void *ctx, void *arg )
101 struct re_s *rtask = arg;
102 struct mdb_info *mdb = rtask->arg;
104 mdb_env_sync( mdb->mi_dbenv, 0 );
105 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
106 ldap_pvt_runqueue_stoptask( &slapd_rq, rtask );
107 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
111 /* reindex entries on the fly */
113 mdb_online_index( void *ctx, void *arg )
115 struct re_s *rtask = arg;
116 BackendDB *be = rtask->arg;
117 struct mdb_info *mdb = be->be_private;
119 Connection conn = {0};
120 OperationBuffer opbuf;
131 connection_fake_init( &conn, &opbuf, ctx );
137 key.mv_size = sizeof(ID);
140 if ( slapd_shutdown )
143 rc = mdb_txn_begin( mdb->mi_dbenv, NULL, 0, &txn );
146 rc = mdb_cursor_open( txn, mdb->mi_id2entry, &curs );
148 mdb_txn_abort( txn );
154 rc = mdb_cursor_get( curs, &key, &data, MDB_SET_RANGE );
156 mdb_txn_abort( txn );
157 if ( rc == MDB_NOTFOUND )
161 memcpy( &id, key.mv_data, sizeof( id ));
164 rc = mdb_id2entry( op, curs, id, &e );
165 mdb_cursor_close( curs );
167 mdb_txn_abort( txn );
168 if ( rc == MDB_NOTFOUND ) {
175 rc = mdb_index_entry( op, txn, MDB_INDEX_UPDATE_OP, e );
176 mdb_entry_return( op, e );
178 rc = mdb_txn_commit( txn );
181 mdb_txn_abort( txn );
190 for ( i = 0; i < mdb->mi_nattrs; i++ ) {
191 if ( mdb->mi_attrs[ i ]->ai_indexmask & MDB_INDEX_DELETING
192 || mdb->mi_attrs[ i ]->ai_newmask == 0 )
196 mdb->mi_attrs[ i ]->ai_indexmask = mdb->mi_attrs[ i ]->ai_newmask;
197 mdb->mi_attrs[ i ]->ai_newmask = 0;
200 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
201 ldap_pvt_runqueue_stoptask( &slapd_rq, rtask );
202 mdb->mi_index_task = NULL;
203 ldap_pvt_runqueue_remove( &slapd_rq, rtask );
204 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
209 /* Cleanup loose ends after Modify completes */
211 mdb_cf_cleanup( ConfigArgs *c )
213 struct mdb_info *mdb = c->be->be_private;
216 if ( mdb->mi_flags & MDB_DEL_INDEX ) {
217 mdb_attr_flush( mdb );
218 mdb->mi_flags ^= MDB_DEL_INDEX;
221 if ( mdb->mi_flags & MDB_RE_OPEN ) {
222 mdb->mi_flags ^= MDB_RE_OPEN;
223 rc = c->be->bd_info->bi_db_close( c->be, &c->reply );
225 rc = c->be->bd_info->bi_db_open( c->be, &c->reply );
226 /* If this fails, we need to restart */
229 snprintf( c->cr_msg, sizeof( c->cr_msg ),
230 "failed to reopen database, rc=%d", rc );
231 Debug( LDAP_DEBUG_ANY, LDAP_XSTRING(mdb_cf_cleanup)
232 ": %s\n", c->cr_msg, 0, 0 );
237 if ( mdb->mi_flags & MDB_OPEN_INDEX ) {
238 rc = mdb_attr_dbs_open( c->be, NULL, &c->reply );
246 mdb_cf_gen( ConfigArgs *c )
248 struct mdb_info *mdb = c->be->be_private;
251 if ( c->op == SLAP_CONFIG_EMIT ) {
257 bv.bv_len = snprintf( buf, sizeof(buf), "0%o", mdb->mi_dbenv_mode );
258 if ( bv.bv_len > 0 && bv.bv_len < sizeof(buf) ) {
260 value_add_one( &c->rvalue_vals, &bv );
267 if ( mdb->mi_txn_cp ) {
270 bv.bv_len = snprintf( buf, sizeof(buf), "%ld %ld",
271 (long) mdb->mi_txn_cp_kbyte, (long) mdb->mi_txn_cp_min );
272 if ( bv.bv_len > 0 && bv.bv_len < sizeof(buf) ) {
274 value_add_one( &c->rvalue_vals, &bv );
284 if ( mdb->mi_dbenv_home ) {
285 c->value_string = ch_strdup( mdb->mi_dbenv_home );
292 if ( mdb->mi_dbenv_flags & MDB_NOSYNC )
297 mdb_attr_index_unparse( mdb, &c->rvalue_vals );
298 if ( !c->rvalue_vals ) rc = 1;
302 c->value_int = mdb->mi_search_stack_depth;
306 c->value_int = mdb->mi_readers;
310 c->value_ulong = mdb->mi_mapsize;
314 } else if ( c->op == LDAP_MOD_DELETE ) {
319 /* FIXME: does it make any sense to change the mode,
320 * if we don't exec a chmod()? */
321 mdb->bi_dbenv_mode = SLAPD_DEFAULT_DB_MODE;
325 /* single-valued no-ops */
332 if ( mdb->mi_txn_cp_task ) {
333 struct re_s *re = mdb->mi_txn_cp_task;
334 mdb->mi_txn_cp_task = NULL;
335 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
336 if ( ldap_pvt_runqueue_isrunning( &slapd_rq, re ) )
337 ldap_pvt_runqueue_stoptask( &slapd_rq, re );
338 ldap_pvt_runqueue_remove( &slapd_rq, re );
339 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
344 mdb->mi_flags |= MDB_RE_OPEN;
345 ch_free( mdb->mi_dbenv_home );
346 mdb->mi_dbenv_home = NULL;
347 c->cleanup = mdb_cf_cleanup;
348 ldap_pvt_thread_pool_purgekey( mdb->mi_dbenv );
351 mdb_env_set_flags( mdb->mi_dbenv, MDB_NOSYNC, 0 );
354 if ( c->valx == -1 ) {
357 /* delete all (FIXME) */
358 for ( i = 0; i < mdb->mi_nattrs; i++ ) {
359 mdb->mi_attrs[i]->ai_indexmask |= MDB_INDEX_DELETING;
361 mdb->mi_flags |= MDB_DEL_INDEX;
362 c->cleanup = mdb_cf_cleanup;
365 struct berval bv, def = BER_BVC("default");
368 for (ptr = c->line; !isspace( (unsigned char) *ptr ); ptr++);
371 bv.bv_len = ptr - bv.bv_val;
372 if ( bvmatch( &bv, &def )) {
373 mdb->mi_defaultmask = 0;
380 sep = bv.bv_val[ bv.bv_len ];
381 bv.bv_val[ bv.bv_len ] = '\0';
382 attrs = ldap_str2charray( bv.bv_val, "," );
384 for ( i = 0; attrs[ i ]; i++ ) {
385 AttributeDescription *ad = NULL;
389 slap_str2ad( attrs[ i ], &ad, &text );
390 /* if we got here... */
391 assert( ad != NULL );
393 ai = mdb_attr_mask( mdb, ad );
394 /* if we got here... */
395 assert( ai != NULL );
397 ai->ai_indexmask |= MDB_INDEX_DELETING;
398 mdb->mi_flags |= MDB_DEL_INDEX;
399 c->cleanup = mdb_cf_cleanup;
402 bv.bv_val[ bv.bv_len ] = sep;
403 ldap_charray_free( attrs );
413 if ( ASCII_DIGIT( c->argv[1][0] ) ) {
417 mode = strtol( c->argv[1], &next, 0 );
418 if ( errno != 0 || next == c->argv[1] || next[0] != '\0' ) {
419 fprintf( stderr, "%s: "
420 "unable to parse mode=\"%s\".\n",
421 c->log, c->argv[1] );
424 mdb->mi_dbenv_mode = mode;
427 char *m = c->argv[1];
428 int who, what, mode = 0;
430 if ( strlen( m ) != STRLENOF("-rwxrwxrwx") ) {
439 for ( who = 0; who < 3; who++ ) {
440 for ( what = 0; what < 3; what++, m++ ) {
443 } else if ( m[0] != "rwx"[what] ) {
446 mode += ((1 << (2 - what)) << 3*(2 - who));
449 mdb->mi_dbenv_mode = mode;
455 if ( lutil_atolx( &l, c->argv[1], 0 ) != 0 ) {
456 fprintf( stderr, "%s: "
457 "invalid kbyte \"%s\" in \"checkpoint\".\n",
458 c->log, c->argv[1] );
461 mdb->mi_txn_cp_kbyte = l;
462 if ( lutil_atolx( &l, c->argv[2], 0 ) != 0 ) {
463 fprintf( stderr, "%s: "
464 "invalid minutes \"%s\" in \"checkpoint\".\n",
465 c->log, c->argv[2] );
468 mdb->mi_txn_cp_min = l;
469 /* If we're in server mode and time-based checkpointing is enabled,
470 * submit a task to perform periodic checkpoints.
472 if ((slapMode & SLAP_SERVER_MODE) && mdb->mi_txn_cp_min ) {
473 struct re_s *re = mdb->mi_txn_cp_task;
475 re->interval.tv_sec = mdb->mi_txn_cp_min * 60;
477 if ( c->be->be_suffix == NULL || BER_BVISNULL( &c->be->be_suffix[0] ) ) {
478 fprintf( stderr, "%s: "
479 "\"checkpoint\" must occur after \"suffix\".\n",
483 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
484 mdb->mi_txn_cp_task = ldap_pvt_runqueue_insert( &slapd_rq,
485 mdb->mi_txn_cp_min * 60, mdb_checkpoint, mdb,
486 LDAP_XSTRING(mdb_checkpoint), c->be->be_suffix[0].bv_val );
487 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
492 case MDB_DIRECTORY: {
494 char *ptr, *testpath;
497 len = strlen( c->value_string );
498 testpath = ch_malloc( len + STRLENOF(LDAP_DIRSEP) + STRLENOF("DUMMY") + 1 );
499 ptr = lutil_strcopy( testpath, c->value_string );
500 *ptr++ = LDAP_DIRSEP[0];
501 strcpy( ptr, "DUMMY" );
502 f = fopen( testpath, "w" );
509 snprintf( c->cr_msg, sizeof( c->cr_msg ), "%s: invalid path: %s",
510 c->log, strerror( errno ));
511 Debug( LDAP_DEBUG_ANY, "%s\n", c->cr_msg, 0, 0 );
515 if ( mdb->mi_dbenv_home )
516 ch_free( mdb->mi_dbenv_home );
517 mdb->mi_dbenv_home = c->value_string;
524 mdb->mi_dbenv_flags |= MDB_NOSYNC;
526 mdb->mi_dbenv_flags ^= MDB_NOSYNC;
527 if ( mdb->mi_flags & MDB_IS_OPEN ) {
528 mdb_env_set_flags( mdb->mi_dbenv, MDB_NOSYNC,
534 rc = mdb_attr_index_config( mdb, c->fname, c->lineno,
535 c->argc - 1, &c->argv[1], &c->reply);
537 if( rc != LDAP_SUCCESS ) return 1;
538 c->cleanup = mdb_cf_cleanup;
539 mdb->mi_flags |= MDB_OPEN_INDEX;
540 if (( mdb->mi_flags & MDB_IS_OPEN ) && !mdb->mi_index_task ) {
541 /* Start the task as soon as we finish here. Set a long
542 * interval (10 hours) so that it only gets scheduled once.
544 if ( c->be->be_suffix == NULL || BER_BVISNULL( &c->be->be_suffix[0] ) ) {
545 fprintf( stderr, "%s: "
546 "\"index\" must occur after \"suffix\".\n",
550 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
551 mdb->mi_index_task = ldap_pvt_runqueue_insert( &slapd_rq, 36000,
552 mdb_online_index, c->be,
553 LDAP_XSTRING(mdb_online_index), c->be->be_suffix[0].bv_val );
554 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
559 if ( c->value_int < MINIMUM_SEARCH_STACK_DEPTH ) {
561 "%s: depth %d too small, using %d\n",
562 c->log, c->value_int, MINIMUM_SEARCH_STACK_DEPTH );
563 c->value_int = MINIMUM_SEARCH_STACK_DEPTH;
565 mdb->mi_search_stack_depth = c->value_int;
569 mdb->mi_readers = c->value_int;
570 if ( mdb->mi_flags & MDB_IS_OPEN ) {
571 mdb->mi_flags |= MDB_RE_OPEN;
572 c->cleanup = mdb_cf_cleanup;
577 mdb->mi_mapsize = c->value_ulong;
578 if ( mdb->mi_flags & MDB_IS_OPEN ) {
579 mdb->mi_flags |= MDB_RE_OPEN;
580 c->cleanup = mdb_cf_cleanup;
588 int mdb_back_init_cf( BackendInfo *bi )
591 bi->bi_cf_ocs = mdbocs;
593 rc = config_register_schema( mdbcfg, mdbocs );