1 /* init.c - initialize bdb backend */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 2000-2004 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>
28 static const struct bdbi_database {
33 } bdbi_databases[] = {
34 { "id2entry" BDB_SUFFIX, "id2entry", DB_BTREE, 0 },
35 { "dn2id" BDB_SUFFIX, "dn2id", DB_BTREE, 0 },
39 struct berval bdb_uuid = BER_BVNULL;
41 typedef void * db_malloc(size_t);
42 typedef void * db_realloc(void *, size_t);
46 bdb_open( BackendInfo *bi )
52 bdb_destroy( BackendInfo *bi )
58 bdb_close( BackendInfo *bi )
60 /* terminate the underlying database system */
66 bdb_db_init( BackendDB *be )
71 LDAP_LOG( BACK_BDB, ENTRY, "bdb_db_init", 0, 0, 0 );
73 Debug( LDAP_DEBUG_ANY,
74 "bdb_db_init: Initializing BDB database\n",
78 /* allocate backend-database-specific stuff */
79 bdb = (struct bdb_info *) ch_calloc( 1, sizeof(struct bdb_info) );
81 /* DBEnv parameters */
82 bdb->bi_dbenv_home = ch_strdup( SLAPD_DEFAULT_DB_DIR );
83 bdb->bi_dbenv_xflags = 0;
84 bdb->bi_dbenv_mode = SLAPD_DEFAULT_DB_MODE;
86 bdb->bi_cache.c_maxsize = DEFAULT_CACHE_SIZE;
88 bdb->bi_lock_detect = DB_LOCK_DEFAULT;
89 bdb->bi_search_stack_depth = DEFAULT_SEARCH_STACK_DEPTH;
90 bdb->bi_search_stack = NULL;
92 LDAP_LIST_INIT (&bdb->bi_psearch_list);
94 ldap_pvt_thread_mutex_init( &bdb->bi_database_mutex );
95 ldap_pvt_thread_mutex_init( &bdb->bi_lastid_mutex );
96 ldap_pvt_thread_rdwr_init ( &bdb->bi_pslist_rwlock );
97 ldap_pvt_thread_mutex_init( &bdb->bi_cache.lru_mutex );
98 ldap_pvt_thread_mutex_init( &bdb->bi_cache.c_dntree.bei_kids_mutex );
99 ldap_pvt_thread_rdwr_init ( &bdb->bi_cache.c_rwlock );
101 be->be_private = bdb;
112 unsigned char *u, *c;
118 #ifdef WORDS_BIGENDIAN
119 for( i = 0; i < (int)sizeof(ID); i++)
121 for( i = sizeof(ID)-1; i >= 0; i--)
132 bdb_db_open( BackendDB *be )
135 struct bdb_info *bdb = (struct bdb_info *) be->be_private;
138 char path[MAXPATHLEN];
142 LDAP_LOG( BACK_BDB, ARGS,
143 "bdb_db_open: %s\n", be->be_suffix[0].bv_val, 0, 0 );
145 Debug( LDAP_DEBUG_ARGS,
147 be->be_suffix[0].bv_val, 0, 0 );
150 #ifndef BDB_MULTIPLE_SUFFIXES
151 if ( be->be_suffix[1].bv_val ) {
153 LDAP_LOG( BACK_BDB, ERR,
154 "bdb_db_open: only one suffix allowed\n", 0, 0, 0 );
156 Debug( LDAP_DEBUG_ANY,
157 "bdb_db_open: only one suffix allowed\n", 0, 0, 0 );
162 /* we should check existance of dbenv_home and db_directory */
164 rc = db_env_create( &bdb->bi_dbenv, 0 );
167 LDAP_LOG( BACK_BDB, ERR,
168 "bdb_db_open: db_env_create failed: %s (%d)\n",
169 db_strerror(rc), rc, 0 );
171 Debug( LDAP_DEBUG_ANY,
172 "bdb_db_open: db_env_create failed: %s (%d)\n",
173 db_strerror(rc), rc, 0 );
178 flags = DB_INIT_MPOOL | DB_THREAD | DB_CREATE
179 | DB_INIT_LOCK | DB_INIT_LOG | DB_INIT_TXN;
182 /* Never do automatic recovery, must perform it manually.
183 * Otherwise restarting with gentlehup will corrupt the
186 if( !(slapMode & SLAP_TOOL_MODE) ) flags |= DB_RECOVER;
189 /* If a key was set, use shared memory for the BDB environment */
190 if ( bdb->bi_shm_key ) {
191 bdb->bi_dbenv->set_shm_key( bdb->bi_dbenv, bdb->bi_shm_key );
192 flags |= DB_SYSTEM_MEM;
195 bdb->bi_dbenv->set_errpfx( bdb->bi_dbenv, be->be_suffix[0].bv_val );
196 bdb->bi_dbenv->set_errcall( bdb->bi_dbenv, bdb_errcall );
197 bdb->bi_dbenv->set_lk_detect( bdb->bi_dbenv, bdb->bi_lock_detect );
199 if ( bdb->bi_idl_cache_max_size ) {
200 bdb->bi_idl_tree = NULL;
201 ldap_pvt_thread_rdwr_init( &bdb->bi_idl_tree_rwlock );
202 ldap_pvt_thread_mutex_init( &bdb->bi_idl_tree_lrulock );
203 bdb->bi_idl_cache_size = 0;
208 char dir[MAXPATHLEN], *ptr;
210 if (bdb->bi_dbenv_home[0] == '.') {
211 /* If home is a relative path, relative subdirs
212 * are just concat'd by BDB. We don't want the
213 * path to be concat'd twice, e.g.
214 * ./test-db/./test-db/tmp
218 ptr = lutil_strcopy( dir, bdb->bi_dbenv_home );
219 *ptr++ = LDAP_DIRSEP[0];
225 strcpy( ptr, BDB_TMP_SUBDIR );
229 rc = bdb->bi_dbenv->set_tmp_dir( bdb->bi_dbenv, dir );
232 LDAP_LOG( BACK_BDB, ERR,
233 "bdb_db_open: set_tmp_dir(%s) failed: %s (%d)\n",
234 dir, db_strerror(rc), rc );
236 Debug( LDAP_DEBUG_ANY,
237 "bdb_db_open: set_tmp_dir(%s) failed: %s (%d)\n",
238 dir, db_strerror(rc), rc );
243 strcpy( ptr, BDB_LG_SUBDIR );
247 rc = bdb->bi_dbenv->set_lg_dir( bdb->bi_dbenv, dir );
250 LDAP_LOG( BACK_BDB, ERR,
251 "bdb_db_open: set_lg_dir(%s) failed: %s (%d)\n",
252 dir, db_strerror(rc), rc );
254 Debug( LDAP_DEBUG_ANY,
255 "bdb_db_open: set_lg_dir(%s) failed: %s (%d)\n",
256 dir, db_strerror(rc), rc );
261 strcpy( ptr, BDB_DATA_SUBDIR );
265 rc = bdb->bi_dbenv->set_data_dir( bdb->bi_dbenv, dir );
268 LDAP_LOG( BACK_BDB, ERR,
269 "bdb_db_open: set_data_dir(%s) failed: %s (%d)\n",
270 dir, db_strerror(rc), rc );
272 Debug( LDAP_DEBUG_ANY,
273 "bdb_db_open: set_data_dir(%s) failed: %s (%d)\n",
274 dir, db_strerror(rc), rc );
282 LDAP_LOG( BACK_BDB, DETAIL1,
283 "bdb_db_open: dbenv_open %s\n", bdb->bi_dbenv_home, 0, 0 );
285 Debug( LDAP_DEBUG_TRACE,
286 "bdb_db_open: dbenv_open(%s)\n",
287 bdb->bi_dbenv_home, 0, 0);
291 strcpy( path, bdb->bi_dbenv_home );
293 rc = bdb->bi_dbenv->open( bdb->bi_dbenv,
296 bdb->bi_dbenv_mode );
298 rc = bdb->bi_dbenv->open( bdb->bi_dbenv,
301 bdb->bi_dbenv_mode );
305 LDAP_LOG( BACK_BDB, ERR,
306 "bdb_db_open: dbenv_open failed: %s (%d)\n",
307 db_strerror(rc), rc, 0 );
309 Debug( LDAP_DEBUG_ANY,
310 "bdb_db_open: dbenv_open failed: %s (%d)\n",
311 db_strerror(rc), rc, 0 );
316 if( bdb->bi_dbenv_xflags != 0 ) {
317 rc = bdb->bi_dbenv->set_flags( bdb->bi_dbenv,
318 bdb->bi_dbenv_xflags, 1);
321 LDAP_LOG( BACK_BDB, ERR,
322 "bdb_db_open: dbenv_set_flags failed: %s (%d)\n",
323 db_strerror(rc), rc, 0 );
325 Debug( LDAP_DEBUG_ANY,
326 "bdb_db_open: dbenv_set_flags failed: %s (%d)\n",
327 db_strerror(rc), rc, 0 );
333 flags = DB_THREAD | bdb->bi_db_opflags;
335 bdb->bi_databases = (struct bdb_db_info **) ch_malloc(
336 BDB_INDICES * sizeof(struct bdb_db_info *) );
338 /* open (and create) main database */
339 for( i = 0; bdbi_databases[i].name; i++ ) {
340 struct bdb_db_info *db;
342 db = (struct bdb_db_info *) ch_calloc(1, sizeof(struct bdb_db_info));
344 rc = db_create( &db->bdi_db, bdb->bi_dbenv, 0 );
347 LDAP_LOG( BACK_BDB, ERR,
348 "bdb_db_open: db_create(%s) failed: %s (%d)\n",
349 bdb->bi_dbenv_home, db_strerror(rc), rc );
351 Debug( LDAP_DEBUG_ANY,
352 "bdb_db_open: db_create(%s) failed: %s (%d)\n",
353 bdb->bi_dbenv_home, db_strerror(rc), rc );
358 if( i == BDB_ID2ENTRY ) {
359 rc = db->bdi_db->set_bt_compare( db->bdi_db,
361 rc = db->bdi_db->set_pagesize( db->bdi_db,
362 BDB_ID2ENTRY_PAGESIZE );
363 if ( slapMode & SLAP_TOOL_READMAIN ) {
369 rc = db->bdi_db->set_flags( db->bdi_db,
370 DB_DUP | DB_DUPSORT );
372 rc = db->bdi_db->set_dup_compare( db->bdi_db,
374 if ( slapMode & SLAP_TOOL_READONLY ) {
380 rc = db->bdi_db->set_dup_compare( db->bdi_db,
382 rc = db->bdi_db->set_bt_compare( db->bdi_db,
384 if ( slapMode & (SLAP_TOOL_READONLY|SLAP_TOOL_READMAIN) ) {
390 rc = db->bdi_db->set_pagesize( db->bdi_db,
395 strcpy( path, bdbi_databases[i].file );
397 rc = DB_OPEN( db->bdi_db,
399 /* bdbi_databases[i].name, */ NULL,
400 bdbi_databases[i].type,
401 bdbi_databases[i].flags | flags,
402 bdb->bi_dbenv_mode );
404 rc = DB_OPEN( db->bdi_db,
405 bdbi_databases[i].file,
406 /* bdbi_databases[i].name, */ NULL,
407 bdbi_databases[i].type,
408 bdbi_databases[i].flags | flags,
409 bdb->bi_dbenv_mode );
414 LDAP_LOG( BACK_BDB, ERR,
415 "bdb_db_open: db_create(%s) failed: %s (%d)\n",
416 bdb->bi_dbenv_home, db_strerror(rc), rc );
418 Debug( LDAP_DEBUG_ANY,
419 "bdb_db_open: db_open(%s) failed: %s (%d)\n",
420 bdb->bi_dbenv_home, db_strerror(rc), rc );
425 flags &= ~(DB_CREATE | DB_RDONLY);
426 db->bdi_name = bdbi_databases[i].name;
427 bdb->bi_databases[i] = db;
430 bdb->bi_databases[i] = NULL;
431 bdb->bi_ndatabases = i;
434 rc = bdb_last_id( be, NULL );
437 LDAP_LOG( BACK_BDB, ERR,
438 "bdb_db_open: last_id(%s) failed: %s (%d)\n",
439 bdb->bi_dbenv_home, db_strerror(rc), rc );
441 Debug( LDAP_DEBUG_ANY,
442 "bdb_db_open: last_id(%s) failed: %s (%d)\n",
443 bdb->bi_dbenv_home, db_strerror(rc), rc );
448 bdb->bi_dbenv->lock_id(bdb->bi_dbenv, &bdb->bi_cache.c_locker);
450 /* <insert> open (and create) index databases */
455 bdb_db_close( BackendDB *be )
458 struct bdb_info *bdb = (struct bdb_info *) be->be_private;
459 struct bdb_db_info *db;
460 bdb_idl_cache_entry_t *entry, *next_entry;
462 while( bdb->bi_ndatabases-- ) {
463 db = bdb->bi_databases[bdb->bi_ndatabases];
464 rc = db->bdi_db->close( db->bdi_db, 0 );
465 /* Lower numbered names are not strdup'd */
466 if( bdb->bi_ndatabases >= BDB_NDB )
467 free( db->bdi_name );
470 free( bdb->bi_databases );
471 bdb_attr_index_destroy( bdb->bi_attrs );
473 bdb_cache_release_all (&bdb->bi_cache);
475 if ( bdb->bi_idl_cache_max_size ) {
476 ldap_pvt_thread_rdwr_wlock ( &bdb->bi_idl_tree_rwlock );
477 avl_free( bdb->bi_idl_tree, NULL );
478 entry = bdb->bi_idl_lru_head;
479 while ( entry != NULL ) {
480 next_entry = entry->idl_lru_next;
483 free( entry->kstr.bv_val );
487 ldap_pvt_thread_rdwr_wunlock ( &bdb->bi_idl_tree_rwlock );
494 bdb_db_destroy( BackendDB *be )
497 struct bdb_info *bdb = (struct bdb_info *) be->be_private;
499 /* close db environment */
500 if( bdb->bi_dbenv ) {
501 /* force a checkpoint */
502 rc = TXN_CHECKPOINT( bdb->bi_dbenv, 0, 0, DB_FORCE );
505 LDAP_LOG( BACK_BDB, ERR,
506 "bdb_db_destroy: txn_checkpoint failed: %s (%d)\n",
507 db_strerror(rc), rc, 0 );
509 Debug( LDAP_DEBUG_ANY,
510 "bdb_db_destroy: txn_checkpoint failed: %s (%d)\n",
511 db_strerror(rc), rc, 0 );
515 rc = bdb->bi_dbenv->close( bdb->bi_dbenv, 0 );
516 bdb->bi_dbenv = NULL;
519 LDAP_LOG( BACK_BDB, ERR,
520 "bdb_db_destroy: close failed: %s (%d)\n",
521 db_strerror(rc), rc, 0 );
523 Debug( LDAP_DEBUG_ANY,
524 "bdb_db_destroy: close failed: %s (%d)\n",
525 db_strerror(rc), rc, 0 );
531 if( bdb->bi_dbenv_home ) ch_free( bdb->bi_dbenv_home );
533 ldap_pvt_thread_rdwr_destroy ( &bdb->bi_cache.c_rwlock );
534 ldap_pvt_thread_mutex_destroy( &bdb->bi_cache.lru_mutex );
535 ldap_pvt_thread_mutex_destroy( &bdb->bi_cache.c_dntree.bei_kids_mutex );
536 ldap_pvt_thread_rdwr_destroy ( &bdb->bi_pslist_rwlock );
537 ldap_pvt_thread_mutex_destroy( &bdb->bi_lastid_mutex );
538 ldap_pvt_thread_mutex_destroy( &bdb->bi_database_mutex );
539 if ( bdb->bi_idl_cache_max_size ) {
540 ldap_pvt_thread_rdwr_destroy( &bdb->bi_idl_tree_rwlock );
541 ldap_pvt_thread_mutex_destroy( &bdb->bi_idl_tree_lrulock );
545 be->be_private = NULL;
550 #if (SLAPD_BDB == SLAPD_MOD_DYNAMIC && !defined(BDB_HIER)) || \
551 (SLAPD_HDB == SLAPD_MOD_DYNAMIC && defined(BDB_HIER))
552 int init_module( int argc, char *argv[] ) {
555 memset( &bi, '\0', sizeof(bi) );
561 bi.bi_init = bdb_initialize;
566 #endif /* SLAPD_BDB */
572 static char *controls[] = {
574 LDAP_CONTROL_MANAGEDSAIT,
576 LDAP_CONTROL_PAGEDRESULTS,
577 #ifdef LDAP_CONTROL_SUBENTRIES
578 LDAP_CONTROL_SUBENTRIES,
580 LDAP_CONTROL_VALUESRETURNFILTER,
584 /* initialize the underlying database system */
586 LDAP_LOG( BACK_BDB, ENTRY, "bdb_db_initialize\n", 0, 0, 0 );
588 Debug( LDAP_DEBUG_TRACE, "bdb_initialize: initialize BDB backend\n",
593 SLAP_BFLAG_INCREMENT |
594 #ifdef BDB_SUBENTRIES
595 SLAP_BFLAG_SUBENTRIES |
600 SLAP_BFLAG_REFERRALS;
602 bi->bi_controls = controls;
604 { /* version check */
605 int major, minor, patch;
606 char *version = db_version( &major, &minor, &patch );
610 /* All our stdio does an ASCII to EBCDIC conversion on
611 * the output. Strings from the BDB library are already
612 * in EBCDIC; we have to go back and forth...
614 strcpy( v2, version );
619 if( major != DB_VERSION_MAJOR ||
620 minor != DB_VERSION_MINOR ||
621 patch < DB_VERSION_PATCH )
624 LDAP_LOG( BACK_BDB, ERR,
625 "bdb_initialize: BDB library version mismatch:"
626 " expected " DB_VERSION_STRING ","
627 " got %s\n", version, 0, 0 );
629 Debug( LDAP_DEBUG_ANY,
630 "bdb_initialize: BDB library version mismatch:"
631 " expected " DB_VERSION_STRING ","
632 " got %s\n", version, 0, 0 );
637 LDAP_LOG( BACK_BDB, DETAIL1,
638 "bdb_db_initialize: %s\n", version, 0, 0 );
640 Debug( LDAP_DEBUG_ANY, "bdb_initialize: %s\n",
645 db_env_set_func_free( ber_memfree );
646 db_env_set_func_malloc( (db_malloc *)ber_memalloc );
647 db_env_set_func_realloc( (db_realloc *)ber_memrealloc );
649 /* This is a no-op on a NO_THREAD build. Leave the default
650 * alone so that BDB will sleep on interprocess conflicts.
652 db_env_set_func_yield( ldap_pvt_thread_yield );
656 static char uuidbuf[ LDAP_LUTIL_UUIDSTR_BUFSIZE ];
658 bdb_uuid.bv_len = lutil_uuidstr( uuidbuf, sizeof( uuidbuf ));
659 bdb_uuid.bv_val = uuidbuf;
667 bi->bi_db_init = bdb_db_init;
668 bi->bi_db_config = bdb_db_config;
669 bi->bi_db_open = bdb_db_open;
670 bi->bi_db_close = bdb_db_close;
671 bi->bi_db_destroy = bdb_db_destroy;
673 bi->bi_op_add = bdb_add;
674 bi->bi_op_bind = bdb_bind;
675 bi->bi_op_compare = bdb_compare;
676 bi->bi_op_delete = bdb_delete;
677 bi->bi_op_modify = bdb_modify;
678 bi->bi_op_modrdn = bdb_modrdn;
679 bi->bi_op_search = bdb_search;
681 bi->bi_op_unbind = 0;
683 bi->bi_op_abandon = bdb_abandon;
684 bi->bi_op_cancel = bdb_cancel;
686 bi->bi_extended = bdb_extended;
688 bi->bi_chk_referrals = bdb_referrals;
689 bi->bi_operational = bdb_operational;
690 bi->bi_has_subordinates = bdb_hasSubordinates;
691 bi->bi_entry_release_rw = bdb_entry_release;
692 bi->bi_entry_get_rw = bdb_entry_get;
695 * hooks for slap tools
697 bi->bi_tool_entry_open = bdb_tool_entry_open;
698 bi->bi_tool_entry_close = bdb_tool_entry_close;
699 bi->bi_tool_entry_first = bdb_tool_entry_next;
700 bi->bi_tool_entry_next = bdb_tool_entry_next;
701 bi->bi_tool_entry_get = bdb_tool_entry_get;
702 bi->bi_tool_entry_put = bdb_tool_entry_put;
703 bi->bi_tool_entry_reindex = bdb_tool_entry_reindex;
704 bi->bi_tool_sync = 0;
705 bi->bi_tool_dn2id_get = bdb_tool_dn2id_get;
706 bi->bi_tool_id2entry_get = bdb_tool_id2entry_get;
707 bi->bi_tool_entry_modify = bdb_tool_entry_modify;
709 bi->bi_connection_init = 0;
710 bi->bi_connection_destroy = 0;