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 #ifdef SLAP_IDL_CACHE
200 if ( bdb->bi_idl_cache_max_size ) {
201 bdb->bi_idl_tree = NULL;
202 ldap_pvt_thread_rdwr_init( &bdb->bi_idl_tree_rwlock );
203 ldap_pvt_thread_mutex_init( &bdb->bi_idl_tree_lrulock );
204 bdb->bi_idl_cache_size = 0;
210 char dir[MAXPATHLEN], *ptr;
212 if (bdb->bi_dbenv_home[0] == '.') {
213 /* If home is a relative path, relative subdirs
214 * are just concat'd by BDB. We don't want the
215 * path to be concat'd twice, e.g.
216 * ./test-db/./test-db/tmp
220 ptr = lutil_strcopy( dir, bdb->bi_dbenv_home );
221 *ptr++ = LDAP_DIRSEP[0];
227 strcpy( ptr, BDB_TMP_SUBDIR );
231 rc = bdb->bi_dbenv->set_tmp_dir( bdb->bi_dbenv, dir );
234 LDAP_LOG( BACK_BDB, ERR,
235 "bdb_db_open: set_tmp_dir(%s) failed: %s (%d)\n",
236 dir, db_strerror(rc), rc );
238 Debug( LDAP_DEBUG_ANY,
239 "bdb_db_open: set_tmp_dir(%s) failed: %s (%d)\n",
240 dir, db_strerror(rc), rc );
245 strcpy( ptr, BDB_LG_SUBDIR );
249 rc = bdb->bi_dbenv->set_lg_dir( bdb->bi_dbenv, dir );
252 LDAP_LOG( BACK_BDB, ERR,
253 "bdb_db_open: set_lg_dir(%s) failed: %s (%d)\n",
254 dir, db_strerror(rc), rc );
256 Debug( LDAP_DEBUG_ANY,
257 "bdb_db_open: set_lg_dir(%s) failed: %s (%d)\n",
258 dir, db_strerror(rc), rc );
263 strcpy( ptr, BDB_DATA_SUBDIR );
267 rc = bdb->bi_dbenv->set_data_dir( bdb->bi_dbenv, dir );
270 LDAP_LOG( BACK_BDB, ERR,
271 "bdb_db_open: set_data_dir(%s) failed: %s (%d)\n",
272 dir, db_strerror(rc), rc );
274 Debug( LDAP_DEBUG_ANY,
275 "bdb_db_open: set_data_dir(%s) failed: %s (%d)\n",
276 dir, db_strerror(rc), rc );
284 LDAP_LOG( BACK_BDB, DETAIL1,
285 "bdb_db_open: dbenv_open %s\n", bdb->bi_dbenv_home, 0, 0 );
287 Debug( LDAP_DEBUG_TRACE,
288 "bdb_db_open: dbenv_open(%s)\n",
289 bdb->bi_dbenv_home, 0, 0);
293 strcpy( path, bdb->bi_dbenv_home );
295 rc = bdb->bi_dbenv->open( bdb->bi_dbenv,
298 bdb->bi_dbenv_mode );
300 rc = bdb->bi_dbenv->open( bdb->bi_dbenv,
303 bdb->bi_dbenv_mode );
307 LDAP_LOG( BACK_BDB, ERR,
308 "bdb_db_open: dbenv_open failed: %s (%d)\n",
309 db_strerror(rc), rc, 0 );
311 Debug( LDAP_DEBUG_ANY,
312 "bdb_db_open: dbenv_open failed: %s (%d)\n",
313 db_strerror(rc), rc, 0 );
318 if( bdb->bi_dbenv_xflags != 0 ) {
319 rc = bdb->bi_dbenv->set_flags( bdb->bi_dbenv,
320 bdb->bi_dbenv_xflags, 1);
323 LDAP_LOG( BACK_BDB, ERR,
324 "bdb_db_open: dbenv_set_flags failed: %s (%d)\n",
325 db_strerror(rc), rc, 0 );
327 Debug( LDAP_DEBUG_ANY,
328 "bdb_db_open: dbenv_set_flags failed: %s (%d)\n",
329 db_strerror(rc), rc, 0 );
335 flags = DB_THREAD | bdb->bi_db_opflags;
337 bdb->bi_databases = (struct bdb_db_info **) ch_malloc(
338 BDB_INDICES * sizeof(struct bdb_db_info *) );
340 /* open (and create) main database */
341 for( i = 0; bdbi_databases[i].name; i++ ) {
342 struct bdb_db_info *db;
344 db = (struct bdb_db_info *) ch_calloc(1, sizeof(struct bdb_db_info));
346 rc = db_create( &db->bdi_db, bdb->bi_dbenv, 0 );
349 LDAP_LOG( BACK_BDB, ERR,
350 "bdb_db_open: db_create(%s) failed: %s (%d)\n",
351 bdb->bi_dbenv_home, db_strerror(rc), rc );
353 Debug( LDAP_DEBUG_ANY,
354 "bdb_db_open: db_create(%s) failed: %s (%d)\n",
355 bdb->bi_dbenv_home, db_strerror(rc), rc );
360 if( i == BDB_ID2ENTRY ) {
361 rc = db->bdi_db->set_bt_compare( db->bdi_db,
363 rc = db->bdi_db->set_pagesize( db->bdi_db,
364 BDB_ID2ENTRY_PAGESIZE );
365 if ( slapMode & SLAP_TOOL_READMAIN ) {
371 rc = db->bdi_db->set_flags( db->bdi_db,
372 DB_DUP | DB_DUPSORT );
374 rc = db->bdi_db->set_dup_compare( db->bdi_db,
376 if ( slapMode & SLAP_TOOL_READONLY ) {
382 rc = db->bdi_db->set_dup_compare( db->bdi_db,
384 rc = db->bdi_db->set_bt_compare( db->bdi_db,
386 if ( slapMode & (SLAP_TOOL_READONLY|SLAP_TOOL_READMAIN) ) {
392 rc = db->bdi_db->set_pagesize( db->bdi_db,
397 strcpy( path, bdbi_databases[i].file );
399 rc = DB_OPEN( db->bdi_db,
401 /* bdbi_databases[i].name, */ NULL,
402 bdbi_databases[i].type,
403 bdbi_databases[i].flags | flags,
404 bdb->bi_dbenv_mode );
406 rc = DB_OPEN( db->bdi_db,
407 bdbi_databases[i].file,
408 /* bdbi_databases[i].name, */ NULL,
409 bdbi_databases[i].type,
410 bdbi_databases[i].flags | flags,
411 bdb->bi_dbenv_mode );
416 LDAP_LOG( BACK_BDB, ERR,
417 "bdb_db_open: db_create(%s) failed: %s (%d)\n",
418 bdb->bi_dbenv_home, db_strerror(rc), rc );
420 Debug( LDAP_DEBUG_ANY,
421 "bdb_db_open: db_open(%s) failed: %s (%d)\n",
422 bdb->bi_dbenv_home, db_strerror(rc), rc );
427 flags &= ~(DB_CREATE | DB_RDONLY);
428 db->bdi_name = bdbi_databases[i].name;
429 bdb->bi_databases[i] = db;
432 bdb->bi_databases[i] = NULL;
433 bdb->bi_ndatabases = i;
436 rc = bdb_last_id( be, NULL );
439 LDAP_LOG( BACK_BDB, ERR,
440 "bdb_db_open: last_id(%s) failed: %s (%d)\n",
441 bdb->bi_dbenv_home, db_strerror(rc), rc );
443 Debug( LDAP_DEBUG_ANY,
444 "bdb_db_open: last_id(%s) failed: %s (%d)\n",
445 bdb->bi_dbenv_home, db_strerror(rc), rc );
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 #ifdef SLAP_IDL_CACHE
461 bdb_idl_cache_entry_t *entry, *next_entry;
464 while( bdb->bi_ndatabases-- ) {
465 db = bdb->bi_databases[bdb->bi_ndatabases];
466 rc = db->bdi_db->close( db->bdi_db, 0 );
467 /* Lower numbered names are not strdup'd */
468 if( bdb->bi_ndatabases >= BDB_NDB )
469 free( db->bdi_name );
472 free( bdb->bi_databases );
473 bdb_attr_index_destroy( bdb->bi_attrs );
475 bdb_cache_release_all (&bdb->bi_cache);
477 #ifdef SLAP_IDL_CACHE
478 if ( bdb->bi_idl_cache_max_size ) {
479 ldap_pvt_thread_rdwr_wlock ( &bdb->bi_idl_tree_rwlock );
480 avl_free( bdb->bi_idl_tree, NULL );
481 entry = bdb->bi_idl_lru_head;
482 while ( entry != NULL ) {
483 next_entry = entry->idl_lru_next;
486 free( entry->kstr.bv_val );
490 ldap_pvt_thread_rdwr_wunlock ( &bdb->bi_idl_tree_rwlock );
498 bdb_db_destroy( BackendDB *be )
501 struct bdb_info *bdb = (struct bdb_info *) be->be_private;
503 /* close db environment */
504 if( bdb->bi_dbenv ) {
505 /* force a checkpoint */
506 rc = TXN_CHECKPOINT( bdb->bi_dbenv, 0, 0, DB_FORCE );
509 LDAP_LOG( BACK_BDB, ERR,
510 "bdb_db_destroy: txn_checkpoint failed: %s (%d)\n",
511 db_strerror(rc), rc, 0 );
513 Debug( LDAP_DEBUG_ANY,
514 "bdb_db_destroy: txn_checkpoint failed: %s (%d)\n",
515 db_strerror(rc), rc, 0 );
519 rc = bdb->bi_dbenv->close( bdb->bi_dbenv, 0 );
520 bdb->bi_dbenv = NULL;
523 LDAP_LOG( BACK_BDB, ERR,
524 "bdb_db_destroy: close failed: %s (%d)\n",
525 db_strerror(rc), rc, 0 );
527 Debug( LDAP_DEBUG_ANY,
528 "bdb_db_destroy: close failed: %s (%d)\n",
529 db_strerror(rc), rc, 0 );
535 if( bdb->bi_dbenv_home ) ch_free( bdb->bi_dbenv_home );
537 ldap_pvt_thread_rdwr_destroy ( &bdb->bi_cache.c_rwlock );
538 ldap_pvt_thread_mutex_destroy( &bdb->bi_cache.lru_mutex );
539 ldap_pvt_thread_mutex_destroy( &bdb->bi_cache.c_dntree.bei_kids_mutex );
540 ldap_pvt_thread_rdwr_destroy ( &bdb->bi_pslist_rwlock );
541 ldap_pvt_thread_mutex_destroy( &bdb->bi_lastid_mutex );
542 ldap_pvt_thread_mutex_destroy( &bdb->bi_database_mutex );
543 #ifdef SLAP_IDL_CACHE
544 if ( bdb->bi_idl_cache_max_size ) {
545 ldap_pvt_thread_rdwr_destroy( &bdb->bi_idl_tree_rwlock );
546 ldap_pvt_thread_mutex_destroy( &bdb->bi_idl_tree_lrulock );
551 be->be_private = NULL;
556 #if (defined(SLAPD_BDB_DYNAMIC) && !defined(BDB_HIER)) || \
557 (defined(SLAPD_HDB_DYNAMIC) && defined(BDB_HIER))
558 int init_module( int argc, char *argv[] ) {
561 memset( &bi, '\0', sizeof(bi) );
567 bi.bi_init = bdb_initialize;
572 #endif /* SLAPD_BDB_DYNAMIC */
578 static char *controls[] = {
580 LDAP_CONTROL_MANAGEDSAIT,
582 LDAP_CONTROL_PAGEDRESULTS,
583 #ifdef LDAP_CONTROL_SUBENTRIES
584 LDAP_CONTROL_SUBENTRIES,
586 LDAP_CONTROL_VALUESRETURNFILTER,
590 /* initialize the underlying database system */
592 LDAP_LOG( BACK_BDB, ENTRY, "bdb_db_initialize\n", 0, 0, 0 );
594 Debug( LDAP_DEBUG_TRACE, "bdb_initialize: initialize BDB backend\n",
599 SLAP_BFLAG_INCREMENT |
600 #ifdef BDB_SUBENTRIES
601 SLAP_BFLAG_SUBENTRIES |
606 SLAP_BFLAG_REFERRALS;
608 bi->bi_controls = controls;
610 { /* version check */
611 int major, minor, patch;
612 char *version = db_version( &major, &minor, &patch );
616 /* All our stdio does an ASCII to EBCDIC conversion on
617 * the output. Strings from the BDB library are already
618 * in EBCDIC; we have to go back and forth...
620 strcpy( v2, version );
625 if( major != DB_VERSION_MAJOR ||
626 minor != DB_VERSION_MINOR ||
627 patch < DB_VERSION_PATCH )
630 LDAP_LOG( BACK_BDB, ERR,
631 "bdb_initialize: BDB library version mismatch:"
632 " expected " DB_VERSION_STRING ","
633 " got %s\n", version, 0, 0 );
635 Debug( LDAP_DEBUG_ANY,
636 "bdb_initialize: BDB library version mismatch:"
637 " expected " DB_VERSION_STRING ","
638 " got %s\n", version, 0, 0 );
643 LDAP_LOG( BACK_BDB, DETAIL1,
644 "bdb_db_initialize: %s\n", version, 0, 0 );
646 Debug( LDAP_DEBUG_ANY, "bdb_initialize: %s\n",
651 db_env_set_func_free( ber_memfree );
652 db_env_set_func_malloc( (db_malloc *)ber_memalloc );
653 db_env_set_func_realloc( (db_realloc *)ber_memrealloc );
655 /* This is a no-op on a NO_THREAD build. Leave the default
656 * alone so that BDB will sleep on interprocess conflicts.
658 db_env_set_func_yield( ldap_pvt_thread_yield );
662 static char uuidbuf[ LDAP_LUTIL_UUIDSTR_BUFSIZE ];
664 bdb_uuid.bv_len = lutil_uuidstr( uuidbuf, sizeof( uuidbuf ));
665 bdb_uuid.bv_val = uuidbuf;
673 bi->bi_db_init = bdb_db_init;
674 bi->bi_db_config = bdb_db_config;
675 bi->bi_db_open = bdb_db_open;
676 bi->bi_db_close = bdb_db_close;
677 bi->bi_db_destroy = bdb_db_destroy;
679 bi->bi_op_add = bdb_add;
680 bi->bi_op_bind = bdb_bind;
681 bi->bi_op_compare = bdb_compare;
682 bi->bi_op_delete = bdb_delete;
683 bi->bi_op_modify = bdb_modify;
684 bi->bi_op_modrdn = bdb_modrdn;
685 bi->bi_op_search = bdb_search;
687 bi->bi_op_unbind = 0;
689 bi->bi_op_abandon = bdb_abandon;
690 bi->bi_op_cancel = bdb_cancel;
692 bi->bi_extended = bdb_extended;
694 bi->bi_chk_referrals = bdb_referrals;
695 bi->bi_operational = bdb_operational;
696 bi->bi_has_subordinates = bdb_hasSubordinates;
697 bi->bi_entry_release_rw = bdb_entry_release;
698 bi->bi_entry_get_rw = bdb_entry_get;
701 * hooks for slap tools
703 bi->bi_tool_entry_open = bdb_tool_entry_open;
704 bi->bi_tool_entry_close = bdb_tool_entry_close;
705 bi->bi_tool_entry_first = bdb_tool_entry_next;
706 bi->bi_tool_entry_next = bdb_tool_entry_next;
707 bi->bi_tool_entry_get = bdb_tool_entry_get;
708 bi->bi_tool_entry_put = bdb_tool_entry_put;
709 bi->bi_tool_entry_reindex = bdb_tool_entry_reindex;
710 bi->bi_tool_sync = 0;
711 bi->bi_tool_dn2id_get = bdb_tool_dn2id_get;
712 bi->bi_tool_id2entry_get = bdb_tool_id2entry_get;
713 bi->bi_tool_entry_modify = bdb_tool_entry_modify;
715 bi->bi_connection_init = 0;
716 bi->bi_connection_destroy = 0;