1 /* init.c - initialize bdb backend */
4 * Copyright 1998-2003 The OpenLDAP Foundation, All Rights Reserved.
5 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
11 #include <ac/string.h>
12 #include <ac/unistd.h>
13 #include <ac/stdlib.h>
19 static struct bdbi_database {
24 } bdbi_databases[] = {
25 { "id2entry" BDB_SUFFIX, "id2entry", DB_BTREE, 0 },
27 { "id2parent" BDB_SUFFIX, "id2parent", DB_BTREE, 0 },
29 { "dn2id" BDB_SUFFIX, "dn2id", DB_BTREE, 0 },
34 struct berval bdb_uuid = { 0, NULL };
36 typedef void * db_malloc(size_t);
37 typedef void * db_realloc(void *, size_t);
41 bdb_open( BackendInfo *bi )
47 bdb_destroy( BackendInfo *bi )
53 bdb_close( BackendInfo *bi )
55 /* terminate the underlying database system */
61 bdb_db_init( BackendDB *be )
66 LDAP_LOG( BACK_BDB, ENTRY, "bdb_db_init", 0, 0, 0 );
68 Debug( LDAP_DEBUG_ANY,
69 "bdb_db_init: Initializing BDB database\n",
73 /* indicate system schema supported */
76 SLAP_BFLAG_SUBENTRIES |
83 /* allocate backend-database-specific stuff */
84 bdb = (struct bdb_info *) ch_calloc( 1, sizeof(struct bdb_info) );
86 /* DBEnv parameters */
87 bdb->bi_dbenv_home = ch_strdup( SLAPD_DEFAULT_DB_DIR );
88 bdb->bi_dbenv_xflags = 0;
89 bdb->bi_dbenv_mode = SLAPD_DEFAULT_DB_MODE;
91 bdb->bi_cache.c_maxsize = DEFAULT_CACHE_SIZE;
93 bdb->bi_lock_detect = DB_LOCK_DEFAULT;
94 bdb->bi_search_stack_depth = DEFAULT_SEARCH_STACK_DEPTH;
95 bdb->bi_search_stack = NULL;
97 #if defined(LDAP_CLIENT_UPDATE) || defined(LDAP_SYNC)
98 LDAP_LIST_INIT (&bdb->psearch_list);
101 ldap_pvt_thread_mutex_init( &bdb->bi_database_mutex );
102 ldap_pvt_thread_mutex_init( &bdb->bi_lastid_mutex );
103 ldap_pvt_thread_mutex_init( &bdb->bi_cache.lru_mutex );
104 ldap_pvt_thread_rdwr_init ( &bdb->bi_cache.c_rwlock );
106 ldap_pvt_thread_rdwr_init( &bdb->bi_tree_rdwr );
109 be->be_private = bdb;
121 unsigned char *u, *c;
127 #ifdef WORDS_BIGENDIAN
128 for( i = 0; i < (int)sizeof(ID); i++)
130 for( i = sizeof(ID)-1; i >= 0; i--)
141 bdb_db_open( BackendDB *be )
144 struct bdb_info *bdb = (struct bdb_info *) be->be_private;
147 char path[MAXPATHLEN];
151 LDAP_LOG( BACK_BDB, ARGS,
152 "bdb_db_open: %s\n", be->be_suffix[0].bv_val, 0, 0 );
154 Debug( LDAP_DEBUG_ARGS,
156 be->be_suffix[0].bv_val, 0, 0 );
159 #ifndef BDB_MULTIPLE_SUFFIXES
160 if ( be->be_suffix[1].bv_val ) {
162 LDAP_LOG( BACK_BDB, ERR,
163 "bdb_db_open: only one suffix allowed\n", 0, 0, 0 );
165 Debug( LDAP_DEBUG_ANY,
166 "bdb_db_open: only one suffix allowed\n", 0, 0, 0 );
171 /* we should check existance of dbenv_home and db_directory */
173 rc = db_env_create( &bdb->bi_dbenv, 0 );
176 LDAP_LOG( BACK_BDB, ERR,
177 "bdb_db_open: db_env_create failed: %s (%d)\n",
178 db_strerror(rc), rc, 0 );
180 Debug( LDAP_DEBUG_ANY,
181 "bdb_db_open: db_env_create failed: %s (%d)\n",
182 db_strerror(rc), rc, 0 );
187 flags = DB_INIT_MPOOL | DB_THREAD | DB_CREATE
188 | DB_INIT_LOCK | DB_INIT_LOG | DB_INIT_TXN;
191 /* Never do automatic recovery, must perform it manually.
192 * Otherwise restarting with gentlehup will corrupt the
195 if( !(slapMode & SLAP_TOOL_MODE) ) flags |= DB_RECOVER;
198 bdb->bi_dbenv->set_errpfx( bdb->bi_dbenv, be->be_suffix[0].bv_val );
199 bdb->bi_dbenv->set_errcall( bdb->bi_dbenv, bdb_errcall );
200 bdb->bi_dbenv->set_lk_detect( bdb->bi_dbenv, bdb->bi_lock_detect );
202 #ifdef SLAP_IDL_CACHE
203 if ( bdb->bi_idl_cache_max_size ) {
204 ldap_pvt_thread_mutex_init( &bdb->bi_idl_tree_mutex );
205 bdb->bi_idl_cache_size = 0;
211 char dir[MAXPATHLEN], *ptr;
213 if (bdb->bi_dbenv_home[0] == '.') {
214 /* If home is a relative path, relative subdirs
215 * are just concat'd by BDB. We don't want the
216 * path to be concat'd twice, e.g.
217 * ./test-db/./test-db/tmp
221 ptr = lutil_strcopy( dir, bdb->bi_dbenv_home );
222 *ptr++ = LDAP_DIRSEP[0];
228 strcpy( ptr, BDB_TMP_SUBDIR );
232 rc = bdb->bi_dbenv->set_tmp_dir( bdb->bi_dbenv, dir );
235 LDAP_LOG( BACK_BDB, ERR,
236 "bdb_db_open: set_tmp_dir(%s) failed: %s (%d)\n",
237 dir, db_strerror(rc), rc );
239 Debug( LDAP_DEBUG_ANY,
240 "bdb_db_open: set_tmp_dir(%s) failed: %s (%d)\n",
241 dir, db_strerror(rc), rc );
246 strcpy( ptr, BDB_LG_SUBDIR );
250 rc = bdb->bi_dbenv->set_lg_dir( bdb->bi_dbenv, dir );
253 LDAP_LOG( BACK_BDB, ERR,
254 "bdb_db_open: set_lg_dir(%s) failed: %s (%d)\n",
255 dir, db_strerror(rc), rc );
257 Debug( LDAP_DEBUG_ANY,
258 "bdb_db_open: set_lg_dir(%s) failed: %s (%d)\n",
259 dir, db_strerror(rc), rc );
264 strcpy( ptr, BDB_DATA_SUBDIR );
268 rc = bdb->bi_dbenv->set_data_dir( bdb->bi_dbenv, dir );
271 LDAP_LOG( BACK_BDB, ERR,
272 "bdb_db_open: set_data_dir(%s) failed: %s (%d)\n",
273 dir, db_strerror(rc), rc );
275 Debug( LDAP_DEBUG_ANY,
276 "bdb_db_open: set_data_dir(%s) failed: %s (%d)\n",
277 dir, db_strerror(rc), rc );
285 LDAP_LOG( BACK_BDB, DETAIL1,
286 "bdb_db_open: dbenv_open %s\n", bdb->bi_dbenv_home, 0, 0 );
288 Debug( LDAP_DEBUG_TRACE,
289 "bdb_db_open: dbenv_open(%s)\n",
290 bdb->bi_dbenv_home, 0, 0);
294 strcpy( path, bdb->bi_dbenv_home );
296 rc = bdb->bi_dbenv->open( bdb->bi_dbenv,
299 bdb->bi_dbenv_mode );
301 rc = bdb->bi_dbenv->open( bdb->bi_dbenv,
304 bdb->bi_dbenv_mode );
308 LDAP_LOG( BACK_BDB, ERR,
309 "bdb_db_open: dbenv_open failed: %s (%d)\n",
310 db_strerror(rc), rc, 0 );
312 Debug( LDAP_DEBUG_ANY,
313 "bdb_db_open: dbenv_open failed: %s (%d)\n",
314 db_strerror(rc), rc, 0 );
319 if( bdb->bi_dbenv_xflags != 0 ) {
320 rc = bdb->bi_dbenv->set_flags( bdb->bi_dbenv,
321 bdb->bi_dbenv_xflags, 1);
324 LDAP_LOG( BACK_BDB, ERR,
325 "bdb_db_open: dbenv_set_flags failed: %s (%d)\n",
326 db_strerror(rc), rc, 0 );
328 Debug( LDAP_DEBUG_ANY,
329 "bdb_db_open: dbenv_set_flags failed: %s (%d)\n",
330 db_strerror(rc), rc, 0 );
336 flags = DB_THREAD | DB_CREATE | bdb->bi_db_opflags;
338 bdb->bi_databases = (struct bdb_db_info **) ch_malloc(
339 BDB_INDICES * sizeof(struct bdb_db_info *) );
341 /* open (and create) main database */
342 for( i = 0; bdbi_databases[i].name; i++ ) {
343 struct bdb_db_info *db;
345 db = (struct bdb_db_info *) ch_calloc(1, sizeof(struct bdb_db_info));
347 rc = db_create( &db->bdi_db, bdb->bi_dbenv, 0 );
350 LDAP_LOG( BACK_BDB, ERR,
351 "bdb_db_open: db_create(%s) failed: %s (%d)\n",
352 bdb->bi_dbenv_home, db_strerror(rc), rc );
354 Debug( LDAP_DEBUG_ANY,
355 "bdb_db_open: db_create(%s) failed: %s (%d)\n",
356 bdb->bi_dbenv_home, db_strerror(rc), rc );
361 if( i == BDB_ID2ENTRY ) {
362 rc = db->bdi_db->set_bt_compare( db->bdi_db,
364 rc = db->bdi_db->set_pagesize( db->bdi_db,
365 BDB_ID2ENTRY_PAGESIZE );
368 rc = db->bdi_db->set_bt_compare( db->bdi_db,
371 rc = db->bdi_db->set_flags( db->bdi_db,
372 DB_DUP | DB_DUPSORT );
373 rc = db->bdi_db->set_dup_compare( db->bdi_db,
376 rc = db->bdi_db->set_pagesize( db->bdi_db,
381 strcpy( path, bdbi_databases[i].file );
383 rc = DB_OPEN( db->bdi_db,
385 /* bdbi_databases[i].name, */ NULL,
386 bdbi_databases[i].type,
387 bdbi_databases[i].flags | flags,
388 bdb->bi_dbenv_mode );
390 rc = DB_OPEN( db->bdi_db,
391 bdbi_databases[i].file,
392 /* bdbi_databases[i].name, */ NULL,
393 bdbi_databases[i].type,
394 bdbi_databases[i].flags | flags,
395 bdb->bi_dbenv_mode );
400 LDAP_LOG( BACK_BDB, ERR,
401 "bdb_db_open: db_create(%s) failed: %s (%d)\n",
402 bdb->bi_dbenv_home, db_strerror(rc), rc );
404 Debug( LDAP_DEBUG_ANY,
405 "bdb_db_open: db_open(%s) failed: %s (%d)\n",
406 bdb->bi_dbenv_home, db_strerror(rc), rc );
411 db->bdi_name = bdbi_databases[i].name;
412 bdb->bi_databases[i] = db;
415 bdb->bi_databases[i] = NULL;
416 bdb->bi_ndatabases = i;
419 rc = bdb_last_id( be, NULL );
422 LDAP_LOG( BACK_BDB, ERR,
423 "bdb_db_open: last_id(%s) failed: %s (%d)\n",
424 bdb->bi_dbenv_home, db_strerror(rc), rc );
426 Debug( LDAP_DEBUG_ANY,
427 "bdb_db_open: last_id(%s) failed: %s (%d)\n",
428 bdb->bi_dbenv_home, db_strerror(rc), rc );
433 /* <insert> open (and create) index databases */
435 rc = bdb_build_tree( be );
441 bdb_db_close( BackendDB *be )
444 struct bdb_info *bdb = (struct bdb_info *) be->be_private;
445 struct bdb_db_info *db;
446 #ifdef SLAP_IDL_CACHE
447 bdb_idl_cache_entry_t *entry, *next_entry;
450 while( bdb->bi_ndatabases-- ) {
451 db = bdb->bi_databases[bdb->bi_ndatabases];
452 rc = db->bdi_db->close( db->bdi_db, 0 );
453 /* Lower numbered names are not strdup'd */
454 if( bdb->bi_ndatabases >= BDB_NDB )
455 free( db->bdi_name );
458 free( bdb->bi_databases );
459 bdb_attr_index_destroy( bdb->bi_attrs );
461 bdb_cache_release_all (&bdb->bi_cache);
463 #ifdef SLAP_IDL_CACHE
464 ldap_pvt_thread_mutex_lock ( &bdb->bi_idl_tree_mutex );
465 entry = bdb->bi_idl_lru_head;
466 while ( entry != NULL ) {
467 next_entry = entry->idl_lru_next;
468 avl_delete( &bdb->bi_idl_tree, (caddr_t) entry, bdb_idl_entry_cmp );
470 free( entry->kstr.bv_val );
474 ldap_pvt_thread_mutex_unlock ( &bdb->bi_idl_tree_mutex );
481 bdb_db_destroy( BackendDB *be )
484 struct bdb_info *bdb = (struct bdb_info *) be->be_private;
486 /* close db environment */
487 if( bdb->bi_dbenv ) {
488 /* force a checkpoint */
489 rc = TXN_CHECKPOINT( bdb->bi_dbenv, 0, 0, DB_FORCE );
492 LDAP_LOG( BACK_BDB, ERR,
493 "bdb_db_destroy: txn_checkpoint failed: %s (%d)\n",
494 db_strerror(rc), rc, 0 );
496 Debug( LDAP_DEBUG_ANY,
497 "bdb_db_destroy: txn_checkpoint failed: %s (%d)\n",
498 db_strerror(rc), rc, 0 );
502 bdb_cache_release_all (&bdb->bi_cache);
504 rc = bdb->bi_dbenv->close( bdb->bi_dbenv, 0 );
505 bdb->bi_dbenv = NULL;
508 LDAP_LOG( BACK_BDB, ERR,
509 "bdb_db_destroy: close failed: %s (%d)\n",
510 db_strerror(rc), rc, 0 );
512 Debug( LDAP_DEBUG_ANY,
513 "bdb_db_destroy: close failed: %s (%d)\n",
514 db_strerror(rc), rc, 0 );
520 if( bdb->bi_dbenv_home ) ch_free( bdb->bi_dbenv_home );
523 ldap_pvt_thread_rdwr_destroy( &bdb->bi_tree_rdwr );
525 ldap_pvt_thread_rdwr_destroy ( &bdb->bi_cache.c_rwlock );
526 ldap_pvt_thread_mutex_destroy( &bdb->bi_cache.lru_mutex );
527 ldap_pvt_thread_mutex_destroy( &bdb->bi_lastid_mutex );
528 ldap_pvt_thread_mutex_destroy( &bdb->bi_database_mutex );
531 be->be_private = NULL;
536 #ifdef SLAPD_BDB_DYNAMIC
537 int back_bdb_LTX_init_module( int argc, char *argv[] ) {
540 memset( &bi, '\0', sizeof(bi) );
542 bi.bi_init = bdb_initialize;
547 #endif /* SLAPD_BDB_DYNAMIC */
554 static char *controls[] = {
555 LDAP_CONTROL_MANAGEDSAIT,
557 #ifdef LDAP_CONTROL_PAGEDRESULTS
558 LDAP_CONTROL_PAGEDRESULTS,
560 LDAP_CONTROL_VALUESRETURNFILTER,
561 #ifdef LDAP_CONTROL_SUBENTRIES
562 LDAP_CONTROL_SUBENTRIES,
564 #ifdef LDAP_CLIENT_UPDATE
565 LDAP_CONTROL_CLIENT_UPDATE,
570 bi->bi_controls = controls;
572 /* initialize the underlying database system */
574 LDAP_LOG( BACK_BDB, ENTRY, "bdb_db_initialize\n", 0, 0, 0 );
576 Debug( LDAP_DEBUG_TRACE, "bdb_initialize: initialize BDB backend\n",
580 { /* version check */
581 int major, minor, patch;
582 char *version = db_version( &major, &minor, &patch );
586 /* All our stdio does an ASCII to EBCDIC conversion on
587 * the output. Strings from the BDB library are already
588 * in EBCDIC; we have to go back and forth...
590 strcpy( v2, version );
595 if( major != DB_VERSION_MAJOR ||
596 minor != DB_VERSION_MINOR ||
597 patch < DB_VERSION_PATCH )
600 LDAP_LOG( BACK_BDB, ERR,
601 "bdb_db_initialize: version mismatch: "
602 "\texpected: %s \tgot: %s\n", DB_VERSION_STRING, version, 0 );
604 Debug( LDAP_DEBUG_ANY,
605 "bdb_initialize: version mismatch\n"
606 "\texpected: " DB_VERSION_STRING "\n"
607 "\tgot: %s \n", version, 0, 0 );
612 LDAP_LOG( BACK_BDB, DETAIL1,
613 "bdb_db_initialize: %s\n", version, 0, 0 );
615 Debug( LDAP_DEBUG_ANY, "bdb_initialize: %s\n",
620 db_env_set_func_free( ber_memfree );
621 db_env_set_func_malloc( (db_malloc *)ber_memalloc );
622 db_env_set_func_realloc( (db_realloc *)ber_memrealloc );
624 /* This is a no-op on a NO_THREAD build. Leave the default
625 * alone so that BDB will sleep on interprocess conflicts.
627 db_env_set_func_yield( ldap_pvt_thread_yield );
631 static char uuidbuf[ LDAP_LUTIL_UUIDSTR_BUFSIZE ];
633 bdb_uuid.bv_len = lutil_uuidstr( uuidbuf, sizeof( uuidbuf ));
634 bdb_uuid.bv_val = uuidbuf;
642 bi->bi_db_init = bdb_db_init;
643 bi->bi_db_config = bdb_db_config;
644 bi->bi_db_open = bdb_db_open;
645 bi->bi_db_close = bdb_db_close;
646 bi->bi_db_destroy = bdb_db_destroy;
648 bi->bi_op_add = bdb_add;
649 bi->bi_op_bind = bdb_bind;
650 bi->bi_op_compare = bdb_compare;
651 bi->bi_op_delete = bdb_delete;
652 bi->bi_op_modify = bdb_modify;
653 bi->bi_op_modrdn = bdb_modrdn;
654 bi->bi_op_search = bdb_search;
656 bi->bi_op_unbind = 0;
658 #ifdef LDAP_CLIENT_UPDATE
659 bi->bi_op_abandon = bdb_abandon;
660 bi->bi_op_cancel = bdb_cancel;
662 bi->bi_op_abandon = 0;
663 bi->bi_op_cancel = 0;
666 bi->bi_extended = bdb_extended;
670 * these routines (and their callers) are not yet designed
671 * to work with transaction. Using them may cause deadlock.
673 bi->bi_acl_group = bdb_group;
674 bi->bi_acl_attribute = bdb_attribute;
676 bi->bi_acl_group = 0;
677 bi->bi_acl_attribute = 0;
680 bi->bi_chk_referrals = bdb_referrals;
681 bi->bi_operational = bdb_operational;
682 bi->bi_has_subordinates = bdb_hasSubordinates;
683 bi->bi_entry_release_rw = bdb_entry_release;
686 * hooks for slap tools
688 bi->bi_tool_entry_open = bdb_tool_entry_open;
689 bi->bi_tool_entry_close = bdb_tool_entry_close;
690 bi->bi_tool_entry_first = bdb_tool_entry_next;
691 bi->bi_tool_entry_next = bdb_tool_entry_next;
692 bi->bi_tool_entry_get = bdb_tool_entry_get;
693 bi->bi_tool_entry_put = bdb_tool_entry_put;
694 bi->bi_tool_entry_reindex = bdb_tool_entry_reindex;
695 bi->bi_tool_sync = 0;
697 bi->bi_connection_init = 0;
698 bi->bi_connection_destroy = 0;