1 /* init.c - initialize bdb backend */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 2000-2006 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>.
20 #include <ac/string.h>
21 #include <ac/unistd.h>
22 #include <ac/stdlib.h>
30 static const struct bdbi_database {
35 } bdbi_databases[] = {
36 { "id2entry" BDB_SUFFIX, "id2entry", DB_BTREE, 0 },
37 { "dn2id" BDB_SUFFIX, "dn2id", DB_BTREE, 0 },
41 typedef void * db_malloc(size_t);
42 typedef void * db_realloc(void *, size_t);
45 bdb_db_init( BackendDB *be )
49 Debug( LDAP_DEBUG_TRACE,
50 LDAP_XSTRING(bdb_db_init) ": Initializing " BDB_UCTYPE " database\n",
53 /* allocate backend-database-specific stuff */
54 bdb = (struct bdb_info *) ch_calloc( 1, sizeof(struct bdb_info) );
56 /* DBEnv parameters */
57 bdb->bi_dbenv_home = ch_strdup( SLAPD_DEFAULT_DB_DIR );
58 bdb->bi_dbenv_xflags = 0;
59 bdb->bi_dbenv_mode = SLAPD_DEFAULT_DB_MODE;
61 bdb->bi_cache.c_maxsize = DEFAULT_CACHE_SIZE;
62 bdb->bi_cache.c_minfree = 1;
64 bdb->bi_lock_detect = DB_LOCK_DEFAULT;
65 bdb->bi_search_stack_depth = DEFAULT_SEARCH_STACK_DEPTH;
66 bdb->bi_search_stack = NULL;
68 ldap_pvt_thread_mutex_init( &bdb->bi_database_mutex );
69 ldap_pvt_thread_mutex_init( &bdb->bi_lastid_mutex );
71 ldap_pvt_thread_mutex_init( &bdb->bi_modrdns_mutex );
73 ldap_pvt_thread_mutex_init( &bdb->bi_cache.lru_head_mutex );
74 ldap_pvt_thread_mutex_init( &bdb->bi_cache.lru_tail_mutex );
75 ldap_pvt_thread_mutex_init( &bdb->bi_cache.c_dntree.bei_kids_mutex );
76 ldap_pvt_thread_rdwr_init ( &bdb->bi_cache.c_rwlock );
77 ldap_pvt_thread_rdwr_init( &bdb->bi_idl_tree_rwlock );
78 ldap_pvt_thread_mutex_init( &bdb->bi_idl_tree_lrulock );
81 be->be_cf_ocs = be->bd_info->bi_cf_ocs;
87 bdb_db_close( BackendDB *be );
90 bdb_db_open( BackendDB *be )
93 struct bdb_info *bdb = (struct bdb_info *) be->be_private;
94 struct stat stat1, stat2;
96 char path[MAXPATHLEN];
98 int do_recover = 0, do_alock_recover = 0;
99 int alockt, quick = 0;
101 if ( be->be_suffix == NULL ) {
102 Debug( LDAP_DEBUG_ANY,
103 "bdb_db_open: need suffix\n",
108 Debug( LDAP_DEBUG_ARGS,
110 be->be_suffix[0].bv_val, 0, 0 );
112 #ifndef BDB_MULTIPLE_SUFFIXES
113 if ( be->be_suffix[1].bv_val ) {
114 Debug( LDAP_DEBUG_ANY,
115 "bdb_db_open: only one suffix allowed\n", 0, 0, 0 );
120 /* Check existence of dbenv_home. Any error means trouble */
121 rc = stat( bdb->bi_dbenv_home, &stat1 );
123 Debug( LDAP_DEBUG_ANY,
124 "bdb_db_open: Cannot access database directory %s (%d)\n",
125 bdb->bi_dbenv_home, errno, 0 );
129 /* Perform database use arbitration/recovery logic */
130 alockt = (slapMode & SLAP_TOOL_READONLY) ? ALOCK_LOCKED : ALOCK_UNIQUE;
131 if ( slapMode & SLAP_TOOL_QUICK ) {
132 alockt |= ALOCK_NOSAVE;
136 rc = alock_open( &bdb->bi_alock_info,
138 bdb->bi_dbenv_home, alockt );
140 /* alockt is TRUE if the existing environment was created in Quick mode */
141 alockt = (rc & ALOCK_NOSAVE) ? 1 : 0;
144 if( rc == ALOCK_RECOVER ) {
145 Debug( LDAP_DEBUG_ANY,
146 "bdb_db_open: unclean shutdown detected;"
147 " attempting recovery.\n",
149 do_alock_recover = 1;
150 do_recover = DB_RECOVER;
151 } else if( rc == ALOCK_BUSY ) {
152 Debug( LDAP_DEBUG_ANY,
153 "bdb_db_open: database already in use\n",
156 } else if( rc != ALOCK_CLEAN ) {
157 Debug( LDAP_DEBUG_ANY,
158 "bdb_db_open: alock package is unstable\n",
164 * The DB_CONFIG file may have changed. If so, recover the
165 * database so that new settings are put into effect. Also
166 * note the possible absence of DB_CONFIG in the log.
168 if( stat( bdb->bi_db_config_path, &stat1 ) == 0 ) {
170 char *ptr = lutil_strcopy(path, bdb->bi_dbenv_home);
171 *ptr++ = LDAP_DIRSEP[0];
172 strcpy( ptr, "__db.001" );
173 if( stat( path, &stat2 ) == 0 ) {
174 if( stat2.st_mtime < stat1.st_mtime ) {
175 Debug( LDAP_DEBUG_ANY,
176 "bdb_db_open: DB_CONFIG for suffix %s has changed.\n"
177 "Performing database recovery to activate new settings.\n",
178 be->be_suffix[0].bv_val, 0, 0 );
179 do_recover = DB_RECOVER;
185 Debug( LDAP_DEBUG_ANY,
186 "bdb_db_open: Warning - No DB_CONFIG file found "
187 "in directory %s: (%d)\n"
188 "Expect poor performance for suffix %s.\n",
189 bdb->bi_dbenv_home, errno, be->be_suffix[0].bv_val );
192 /* Always let slapcat run, regardless of environment state.
193 * This can be used to cause a cache flush after an unclean
196 if ( do_recover && ( slapMode & SLAP_TOOL_READONLY )) {
197 Debug( LDAP_DEBUG_ANY,
198 "bdb_db_open: Recovery skipped in read-only mode. "
199 "Run manual recovery if errors are encountered.\n",
205 /* An existing environment in Quick mode has nothing to recover. */
206 if ( alockt && do_recover ) {
207 Debug( LDAP_DEBUG_ANY,
208 "bdb_db_open: cannot recover, database must be reinitialized.\n",
214 rc = db_env_create( &bdb->bi_dbenv, 0 );
216 Debug( LDAP_DEBUG_ANY,
217 "bdb_db_open: db_env_create failed: %s (%d)\n",
218 db_strerror(rc), rc, 0 );
223 strcpy( path, bdb->bi_dbenv_home );
227 dbhome = bdb->bi_dbenv_home;
230 /* If existing environment is clean but doesn't support
231 * currently requested modes, remove it.
233 if ( !do_recover && ( alockt ^ quick )) {
234 rc = bdb->bi_dbenv->remove( bdb->bi_dbenv, dbhome, DB_FORCE );
236 Debug( LDAP_DEBUG_ANY,
237 "bdb_db_open: dbenv remove failed: %s (%d)\n",
238 db_strerror(rc), rc, 0 );
239 bdb->bi_dbenv = NULL;
242 rc = db_env_create( &bdb->bi_dbenv, 0 );
244 Debug( LDAP_DEBUG_ANY,
245 "bdb_db_open: db_env_create failed: %s (%d)\n",
246 db_strerror(rc), rc, 0 );
251 bdb->bi_dbenv->set_errpfx( bdb->bi_dbenv, be->be_suffix[0].bv_val );
252 bdb->bi_dbenv->set_errcall( bdb->bi_dbenv, bdb_errcall );
254 bdb->bi_dbenv->set_lk_detect( bdb->bi_dbenv, bdb->bi_lock_detect );
256 /* One long-lived TXN per thread, two TXNs per write op */
257 bdb->bi_dbenv->set_tx_max( bdb->bi_dbenv, connection_pool_max * 3 );
259 if( bdb->bi_dbenv_xflags != 0 ) {
260 rc = bdb->bi_dbenv->set_flags( bdb->bi_dbenv,
261 bdb->bi_dbenv_xflags, 1);
263 Debug( LDAP_DEBUG_ANY,
264 "bdb_db_open: dbenv_set_flags failed: %s (%d)\n",
265 db_strerror(rc), rc, 0 );
270 #define BDB_TXN_FLAGS (DB_INIT_LOCK | DB_INIT_LOG | DB_INIT_TXN)
272 Debug( LDAP_DEBUG_TRACE,
273 "bdb_db_open: dbenv_open(%s)\n",
274 bdb->bi_dbenv_home, 0, 0);
276 flags = DB_INIT_MPOOL | DB_CREATE | DB_THREAD;
279 flags |= BDB_TXN_FLAGS;
281 /* If a key was set, use shared memory for the BDB environment */
282 if ( bdb->bi_shm_key ) {
283 bdb->bi_dbenv->set_shm_key( bdb->bi_dbenv, bdb->bi_shm_key );
284 flags |= DB_SYSTEM_MEM;
286 rc = bdb->bi_dbenv->open( bdb->bi_dbenv, dbhome,
287 flags | do_recover, bdb->bi_dbenv_mode );
290 Debug( LDAP_DEBUG_ANY,
291 "bdb_db_open: Database cannot be %s, err %d. "
292 "Restore from backup!\n",
293 do_recover ? "recovered" : "opened", rc, 0);
297 if ( do_alock_recover && alock_recover (&bdb->bi_alock_info) != 0 ) {
298 Debug( LDAP_DEBUG_ANY,
299 "bdb_db_open: alock_recover failed\n",
305 #ifdef SLAP_ZONE_ALLOC
306 if ( bdb->bi_cache.c_maxsize ) {
307 bdb->bi_cache.c_zctx = slap_zn_mem_create(
308 SLAP_ZONE_INITSIZE, SLAP_ZONE_MAXSIZE,
309 SLAP_ZONE_DELTA, SLAP_ZONE_SIZE);
313 if ( bdb->bi_idl_cache_max_size ) {
314 bdb->bi_idl_tree = NULL;
315 bdb->bi_idl_cache_size = 0;
318 flags = DB_THREAD | bdb->bi_db_opflags;
320 #ifdef DB_AUTO_COMMIT
322 flags |= DB_AUTO_COMMIT;
325 bdb->bi_databases = (struct bdb_db_info **) ch_malloc(
326 BDB_INDICES * sizeof(struct bdb_db_info *) );
328 /* open (and create) main database */
329 for( i = 0; bdbi_databases[i].name; i++ ) {
330 struct bdb_db_info *db;
332 db = (struct bdb_db_info *) ch_calloc(1, sizeof(struct bdb_db_info));
334 rc = db_create( &db->bdi_db, bdb->bi_dbenv, 0 );
336 Debug( LDAP_DEBUG_ANY,
337 "bdb_db_open: db_create(%s) failed: %s (%d)\n",
338 bdb->bi_dbenv_home, db_strerror(rc), rc );
342 if( i == BDB_ID2ENTRY ) {
343 if ( slapMode & SLAP_TOOL_MODE )
344 db->bdi_db->mpf->set_priority( db->bdi_db->mpf,
345 DB_PRIORITY_VERY_LOW );
347 rc = db->bdi_db->set_pagesize( db->bdi_db,
348 BDB_ID2ENTRY_PAGESIZE );
349 if ( slapMode & SLAP_TOOL_READMAIN ) {
355 rc = db->bdi_db->set_flags( db->bdi_db,
356 DB_DUP | DB_DUPSORT );
358 if ( slapMode & SLAP_TOOL_READONLY ) {
364 if ( slapMode & (SLAP_TOOL_READONLY|SLAP_TOOL_READMAIN) ) {
370 rc = db->bdi_db->set_pagesize( db->bdi_db,
375 strcpy( path, bdbi_databases[i].file );
377 rc = DB_OPEN( db->bdi_db,
379 /* bdbi_databases[i].name, */ NULL,
380 bdbi_databases[i].type,
381 bdbi_databases[i].flags | flags,
382 bdb->bi_dbenv_mode );
384 rc = DB_OPEN( db->bdi_db,
385 bdbi_databases[i].file,
386 /* bdbi_databases[i].name, */ NULL,
387 bdbi_databases[i].type,
388 bdbi_databases[i].flags | flags,
389 bdb->bi_dbenv_mode );
393 char buf[SLAP_TEXT_BUFLEN];
395 snprintf( buf, sizeof(buf), "%s/%s",
396 bdb->bi_dbenv_home, bdbi_databases[i].file );
397 Debug( LDAP_DEBUG_ANY,
398 "bdb_db_open: db_open(%s) failed: %s (%d)\n",
399 buf, db_strerror(rc), rc );
400 db->bdi_db->close( db->bdi_db, 0 );
404 flags &= ~(DB_CREATE | DB_RDONLY);
405 db->bdi_name = bdbi_databases[i].name;
406 bdb->bi_databases[i] = db;
409 bdb->bi_databases[i] = NULL;
410 bdb->bi_ndatabases = i;
413 rc = bdb_last_id( be, NULL );
415 Debug( LDAP_DEBUG_ANY,
416 "bdb_db_open: last_id(%s) failed: %s (%d)\n",
417 bdb->bi_dbenv_home, db_strerror(rc), rc );
422 XLOCK_ID(bdb->bi_dbenv, &bdb->bi_cache.c_locker);
425 bdb->bi_flags |= BDB_IS_OPEN;
435 bdb_db_close( BackendDB *be )
438 struct bdb_info *bdb = (struct bdb_info *) be->be_private;
439 struct bdb_db_info *db;
440 bdb_idl_cache_entry_t *entry, *next_entry;
442 bdb->bi_flags &= ~BDB_IS_OPEN;
444 ber_bvarray_free( bdb->bi_db_config );
445 bdb->bi_db_config = NULL;
447 while( bdb->bi_databases && bdb->bi_ndatabases-- ) {
448 db = bdb->bi_databases[bdb->bi_ndatabases];
449 rc = db->bdi_db->close( db->bdi_db, 0 );
450 /* Lower numbered names are not strdup'd */
451 if( bdb->bi_ndatabases >= BDB_NDB )
452 free( db->bdi_name );
455 free( bdb->bi_databases );
456 bdb->bi_databases = NULL;
458 bdb_cache_release_all (&bdb->bi_cache);
460 if ( bdb->bi_idl_cache_max_size ) {
461 avl_free( bdb->bi_idl_tree, NULL );
462 bdb->bi_idl_tree = NULL;
463 entry = bdb->bi_idl_lru_head;
464 while ( entry != NULL ) {
465 next_entry = entry->idl_lru_next;
468 free( entry->kstr.bv_val );
472 bdb->bi_idl_lru_head = bdb->bi_idl_lru_tail = NULL;
475 /* close db environment */
476 if( bdb->bi_dbenv ) {
477 /* Free cache locker if we enabled locking */
478 if ( !( slapMode & SLAP_TOOL_QUICK )) {
479 XLOCK_ID_FREE(bdb->bi_dbenv, bdb->bi_cache.c_locker);
480 bdb->bi_cache.c_locker = 0;
483 /* force a checkpoint, but not if we were ReadOnly,
484 * and not in Quick mode since there are no transactions there.
486 if ( !( slapMode & ( SLAP_TOOL_QUICK|SLAP_TOOL_READONLY ))) {
487 rc = TXN_CHECKPOINT( bdb->bi_dbenv, 0, 0, DB_FORCE );
489 Debug( LDAP_DEBUG_ANY,
490 "bdb_db_close: txn_checkpoint failed: %s (%d)\n",
491 db_strerror(rc), rc, 0 );
495 rc = bdb->bi_dbenv->close( bdb->bi_dbenv, 0 );
496 bdb->bi_dbenv = NULL;
498 Debug( LDAP_DEBUG_ANY,
499 "bdb_db_close: close failed: %s (%d)\n",
500 db_strerror(rc), rc, 0 );
505 rc = alock_close( &bdb->bi_alock_info );
507 Debug( LDAP_DEBUG_ANY,
508 "bdb_db_close: alock_close failed\n", 0, 0, 0 );
516 bdb_db_destroy( BackendDB *be )
518 struct bdb_info *bdb = (struct bdb_info *) be->be_private;
520 if( bdb->bi_dbenv_home ) ch_free( bdb->bi_dbenv_home );
521 if( bdb->bi_db_config_path ) ch_free( bdb->bi_db_config_path );
523 bdb_attr_index_destroy( bdb );
525 ldap_pvt_thread_rdwr_destroy ( &bdb->bi_cache.c_rwlock );
526 ldap_pvt_thread_mutex_destroy( &bdb->bi_cache.lru_head_mutex );
527 ldap_pvt_thread_mutex_destroy( &bdb->bi_cache.lru_tail_mutex );
528 ldap_pvt_thread_mutex_destroy( &bdb->bi_cache.c_dntree.bei_kids_mutex );
530 ldap_pvt_thread_mutex_destroy( &bdb->bi_modrdns_mutex );
532 ldap_pvt_thread_mutex_destroy( &bdb->bi_lastid_mutex );
533 ldap_pvt_thread_mutex_destroy( &bdb->bi_database_mutex );
534 ldap_pvt_thread_rdwr_destroy( &bdb->bi_idl_tree_rwlock );
535 ldap_pvt_thread_mutex_destroy( &bdb->bi_idl_tree_lrulock );
538 be->be_private = NULL;
549 static char *controls[] = {
551 LDAP_CONTROL_MANAGEDSAIT,
553 LDAP_CONTROL_PAGEDRESULTS,
554 LDAP_CONTROL_PRE_READ,
555 LDAP_CONTROL_POST_READ,
556 LDAP_CONTROL_SUBENTRIES,
557 LDAP_CONTROL_X_PERMISSIVE_MODIFY,
559 LDAP_CONTROL_X_TXN_SPEC,
564 /* initialize the underlying database system */
565 Debug( LDAP_DEBUG_TRACE,
566 LDAP_XSTRING(bdb_back_initialize) ": initialize "
567 BDB_UCTYPE " backend\n", 0, 0, 0 );
570 SLAP_BFLAG_INCREMENT |
571 SLAP_BFLAG_SUBENTRIES |
573 SLAP_BFLAG_REFERRALS;
575 bi->bi_controls = controls;
577 { /* version check */
578 int major, minor, patch, ver;
579 char *version = db_version( &major, &minor, &patch );
583 /* All our stdio does an ASCII to EBCDIC conversion on
584 * the output. Strings from the BDB library are already
585 * in EBCDIC; we have to go back and forth...
587 strcpy( v2, version );
592 ver = (major << 24) | (minor << 16) | patch;
593 if( ver != DB_VERSION_FULL ) {
594 /* fail if a versions don't match */
595 Debug( LDAP_DEBUG_ANY,
596 LDAP_XSTRING(bdb_back_initialize) ": "
597 "BDB library version mismatch:"
598 " expected " DB_VERSION_STRING ","
599 " got %s\n", version, 0, 0 );
603 Debug( LDAP_DEBUG_TRACE, LDAP_XSTRING(bdb_back_initialize)
604 ": %s\n", version, 0, 0 );
607 db_env_set_func_free( ber_memfree );
608 db_env_set_func_malloc( (db_malloc *)ber_memalloc );
609 db_env_set_func_realloc( (db_realloc *)ber_memrealloc );
611 /* This is a no-op on a NO_THREAD build. Leave the default
612 * alone so that BDB will sleep on interprocess conflicts.
614 db_env_set_func_yield( ldap_pvt_thread_yield );
622 bi->bi_db_init = bdb_db_init;
623 bi->bi_db_config = config_generic_wrapper;
624 bi->bi_db_open = bdb_db_open;
625 bi->bi_db_close = bdb_db_close;
626 bi->bi_db_destroy = bdb_db_destroy;
628 bi->bi_op_add = bdb_add;
629 bi->bi_op_bind = bdb_bind;
630 bi->bi_op_compare = bdb_compare;
631 bi->bi_op_delete = bdb_delete;
632 bi->bi_op_modify = bdb_modify;
633 bi->bi_op_modrdn = bdb_modrdn;
634 bi->bi_op_search = bdb_search;
636 bi->bi_op_unbind = 0;
638 bi->bi_extended = bdb_extended;
640 bi->bi_chk_referrals = bdb_referrals;
641 bi->bi_operational = bdb_operational;
642 bi->bi_has_subordinates = bdb_hasSubordinates;
643 bi->bi_entry_release_rw = bdb_entry_release;
644 bi->bi_entry_get_rw = bdb_entry_get;
647 * hooks for slap tools
649 bi->bi_tool_entry_open = bdb_tool_entry_open;
650 bi->bi_tool_entry_close = bdb_tool_entry_close;
651 bi->bi_tool_entry_first = bdb_tool_entry_next;
652 bi->bi_tool_entry_next = bdb_tool_entry_next;
653 bi->bi_tool_entry_get = bdb_tool_entry_get;
654 bi->bi_tool_entry_put = bdb_tool_entry_put;
655 bi->bi_tool_entry_reindex = bdb_tool_entry_reindex;
656 bi->bi_tool_sync = 0;
657 bi->bi_tool_dn2id_get = bdb_tool_dn2id_get;
658 bi->bi_tool_id2entry_get = bdb_tool_id2entry_get;
659 bi->bi_tool_entry_modify = bdb_tool_entry_modify;
661 bi->bi_connection_init = 0;
662 bi->bi_connection_destroy = 0;
664 rc = bdb_back_init_cf( bi );
669 #if (SLAPD_BDB == SLAPD_MOD_DYNAMIC && !defined(BDB_HIER)) || \
670 (SLAPD_HDB == SLAPD_MOD_DYNAMIC && defined(BDB_HIER))
672 /* conditionally define the init_module() function */
674 SLAP_BACKEND_INIT_MODULE( hdb )
675 #else /* !BDB_HIER */
676 SLAP_BACKEND_INIT_MODULE( bdb )
677 #endif /* !BDB_HIER */
679 #endif /* SLAPD_[BH]DB == SLAPD_MOD_DYNAMIC */