]> git.sur5r.net Git - openldap/blob - servers/slapd/back-bdb/init.c
Ready for release
[openldap] / servers / slapd / back-bdb / init.c
1 /* init.c - initialize bdb backend */
2 /* $OpenLDAP$ */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4  *
5  * Copyright 2000-2005 The OpenLDAP Foundation.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted only as authorized by the OpenLDAP
10  * Public License.
11  *
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>.
15  */
16
17 #include "portable.h"
18
19 #include <stdio.h>
20 #include <ac/string.h>
21 #include <ac/unistd.h>
22 #include <ac/stdlib.h>
23 #include <ac/errno.h>
24 #include <sys/stat.h>
25 #include "back-bdb.h"
26 #include <lutil.h>
27 #include <ldap_rq.h>
28 #include "alock.h"
29
30 static const struct bdbi_database {
31         char *file;
32         char *name;
33         int type;
34         int flags;
35 } bdbi_databases[] = {
36         { "id2entry" BDB_SUFFIX, "id2entry", DB_BTREE, 0 },
37         { "dn2id" BDB_SUFFIX, "dn2id", DB_BTREE, 0 },
38         { NULL, NULL, 0, 0 }
39 };
40
41 typedef void * db_malloc(size_t);
42 typedef void * db_realloc(void *, size_t);
43
44 static int
45 bdb_db_init( BackendDB *be )
46 {
47         struct bdb_info *bdb;
48
49         Debug( LDAP_DEBUG_TRACE,
50                 LDAP_XSTRING(bdb_db_init) ": Initializing " BDB_UCTYPE " database\n",
51                 0, 0, 0 );
52
53         /* allocate backend-database-specific stuff */
54         bdb = (struct bdb_info *) ch_calloc( 1, sizeof(struct bdb_info) );
55
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;
60
61         bdb->bi_cache.c_maxsize = DEFAULT_CACHE_SIZE;
62
63         bdb->bi_lock_detect = DB_LOCK_DEFAULT;
64         bdb->bi_search_stack_depth = DEFAULT_SEARCH_STACK_DEPTH;
65         bdb->bi_search_stack = NULL;
66
67         ldap_pvt_thread_mutex_init( &bdb->bi_database_mutex );
68         ldap_pvt_thread_mutex_init( &bdb->bi_lastid_mutex );
69 #ifdef BDB_HIER
70         ldap_pvt_thread_mutex_init( &bdb->bi_modrdns_mutex );
71 #endif
72         ldap_pvt_thread_mutex_init( &bdb->bi_cache.lru_mutex );
73         ldap_pvt_thread_mutex_init( &bdb->bi_cache.c_dntree.bei_kids_mutex );
74         ldap_pvt_thread_rdwr_init ( &bdb->bi_cache.c_rwlock );
75         ldap_pvt_thread_rdwr_init( &bdb->bi_idl_tree_rwlock );
76         ldap_pvt_thread_mutex_init( &bdb->bi_idl_tree_lrulock );
77
78         be->be_private = bdb;
79         be->be_cf_ocs = be->bd_info->bi_cf_ocs;
80
81         return 0;
82 }
83
84 static int
85 bdb_db_open( BackendDB *be )
86 {
87         int rc, i;
88         struct bdb_info *bdb = (struct bdb_info *) be->be_private;
89         struct stat stat1, stat2;
90         u_int32_t flags;
91         char path[MAXPATHLEN];
92         char *dbhome;
93         int do_recover = 0, do_alock_recover = 0, open_env = 1, got_env = 0;
94
95         if ( be->be_suffix == NULL ) {
96                 Debug( LDAP_DEBUG_ANY,
97                         "bdb_db_open: need suffix\n",
98                         0, 0, 0 );
99                 return -1;
100         }
101
102         Debug( LDAP_DEBUG_ARGS,
103                 "bdb_db_open: %s\n",
104                 be->be_suffix[0].bv_val, 0, 0 );
105
106 #ifndef BDB_MULTIPLE_SUFFIXES
107         if ( be->be_suffix[1].bv_val ) {
108         Debug( LDAP_DEBUG_ANY,
109                 "bdb_db_open: only one suffix allowed\n", 0, 0, 0 );
110                 return -1;
111         }
112 #endif
113
114         /* Check existence of dbenv_home. Any error means trouble */
115         rc = stat( bdb->bi_dbenv_home, &stat1 );
116         if( rc !=0 ) {
117                 Debug( LDAP_DEBUG_ANY,
118                         "bdb_db_open: Cannot access database directory %s (%d)\n",
119                         bdb->bi_dbenv_home, errno, 0 );
120                         return -1;
121         }
122
123         /* Perform database use arbitration/recovery logic */
124         rc = alock_open( &bdb->bi_alock_info, 
125                                 "slapd", 
126                                 bdb->bi_dbenv_home,
127                                 slapMode & SLAP_TOOL_READONLY ?
128                                 ALOCK_LOCKED : ALOCK_UNIQUE );
129
130         if( rc == ALOCK_RECOVER ) {
131                 Debug( LDAP_DEBUG_ANY,
132                         "bdb_db_open: unclean shutdown detected;"
133                         " attempting recovery.\n", 
134                         0, 0, 0 );
135                 do_alock_recover = 1;
136                 do_recover = 1;
137         } else if( rc == ALOCK_BUSY ) {
138                 Debug( LDAP_DEBUG_ANY,
139                         "bdb_db_open: database already in use\n", 
140                         0, 0, 0 );
141                 return -1;
142         } else if( rc != ALOCK_CLEAN ) {
143                 Debug( LDAP_DEBUG_ANY,
144                         "bdb_db_open: alock package is unstable\n", 
145                         0, 0, 0 );
146                 return -1;
147         }
148
149         /*
150          * The DB_CONFIG file may have changed. If so, recover the
151          * database so that new settings are put into effect. Also
152          * note the possible absence of DB_CONFIG in the log.
153          */
154         if( stat( bdb->bi_db_config_path, &stat1 ) == 0 ) {
155                 if ( !do_recover ) {
156                         char *ptr = lutil_strcopy(path, bdb->bi_dbenv_home);
157                         *ptr++ = LDAP_DIRSEP[0];
158                         strcpy( ptr, "__db.001" );
159                         if( stat( path, &stat2 ) == 0 ) {
160                                 if( stat2.st_mtime <= stat1.st_mtime ) {
161                                         Debug( LDAP_DEBUG_ANY,
162                                                 "bdb_db_open: DB_CONFIG for suffix %s has changed.\n"
163                                                 "Performing database recovery to activate new settings.\n",
164                                                 be->be_suffix[0].bv_val, 0, 0 );
165                                         do_recover = 1;
166                                 }
167                         }
168                 }
169         }
170         else {
171                 Debug( LDAP_DEBUG_ANY,
172                         "bdb_db_open: Warning - No DB_CONFIG file found "
173                         "in directory %s: (%d)\n"
174                         "Expect poor performance for suffix %s.\n",
175                         bdb->bi_dbenv_home, errno, be->be_suffix[0].bv_val );
176         }
177
178         rc = db_env_create( &bdb->bi_dbenv, 0 );
179         if( rc != 0 ) {
180                 Debug( LDAP_DEBUG_ANY,
181                         "bdb_db_open: db_env_create failed: %s (%d)\n",
182                         db_strerror(rc), rc, 0 );
183                 return rc;
184         }
185
186         bdb->bi_dbenv->set_errpfx( bdb->bi_dbenv, be->be_suffix[0].bv_val );
187         bdb->bi_dbenv->set_errcall( bdb->bi_dbenv, bdb_errcall );
188
189         bdb->bi_dbenv->set_lk_detect( bdb->bi_dbenv, bdb->bi_lock_detect );
190
191         /* One long-lived TXN per thread, two TXNs per write op */
192         bdb->bi_dbenv->set_tx_max( bdb->bi_dbenv, connection_pool_max * 3 );
193
194         if( bdb->bi_dbenv_xflags != 0 ) {
195                 rc = bdb->bi_dbenv->set_flags( bdb->bi_dbenv,
196                         bdb->bi_dbenv_xflags, 1);
197                 if( rc != 0 ) {
198                         Debug( LDAP_DEBUG_ANY,
199                                 "bdb_db_open: dbenv_set_flags failed: %s (%d)\n",
200                                 db_strerror(rc), rc, 0 );
201                         return rc;
202                 }
203         }
204
205 #define BDB_TXN_FLAGS   (DB_INIT_LOCK | DB_INIT_LOG | DB_INIT_TXN)
206
207 #ifdef HAVE_EBCDIC
208         strcpy( path, bdb->bi_dbenv_home );
209         __atoe( path );
210         dbhome = path;
211 #else
212         dbhome = bdb->bi_dbenv_home;
213 #endif
214
215         Debug( LDAP_DEBUG_TRACE,
216                 "bdb_db_open: dbenv_open(%s)\n",
217                 bdb->bi_dbenv_home, 0, 0);
218
219         /* Check if there is a usable existing environment */
220         flags = DB_JOINENV | DB_THREAD;
221
222         rc = bdb->bi_dbenv->open( bdb->bi_dbenv, dbhome,
223                 flags, bdb->bi_dbenv_mode );
224         if( rc == 0 ) {
225                 int flags_ok = 0;
226
227                 got_env = 1;
228
229                 rc = bdb->bi_dbenv->get_open_flags( bdb->bi_dbenv, &flags );
230                 if ( rc == 0 ) {
231                         int flag2 = flags & BDB_TXN_FLAGS;
232
233                         /* In quick mode, none of these flags are allowed */
234                         if ( slapMode & SLAP_TOOL_QUICK ) {
235                                 if ( !flag2 )
236                                         flags_ok = 1;
237                         } else {
238                         /* In normal mode, all of these flags are required */
239                                 if ( flag2 == BDB_TXN_FLAGS )
240                                         flags_ok = 1;
241                         }
242                 }
243
244                 /* In Quick mode, we cannot Recover... */
245                 if ( slapMode & SLAP_TOOL_QUICK ) {
246                         /* If we need to recover but we had no TXNs, just fail */
247                         if ( do_recover && flags_ok ) {
248                                 Debug( LDAP_DEBUG_ANY,
249                                         "bdb_db_open: Database cannot be recovered. "
250                                         "Restore from backup!\n", 0, 0, 0);
251                                 return -1;
252                         }
253                         /* We need to recover, and we had TXN support before:
254                          * Close this env, open a new one with recovery flags.
255                          */
256                         if ( do_recover ) {
257                                 bdb->bi_dbenv->close( bdb->bi_dbenv, 0 );
258                                 bdb->bi_dbenv = NULL;
259                                 rc = db_env_create( &bdb->bi_dbenv, 0 );
260                                 if( rc != 0 ) {
261                                         Debug( LDAP_DEBUG_ANY,
262                                                 "bdb_db_open: db_env_create failed: %s (%d)\n",
263                                                 db_strerror(rc), rc, 0 );
264                                         return rc;
265                                 }
266                                 bdb->bi_dbenv->set_errpfx( bdb->bi_dbenv,
267                                         be->be_suffix[0].bv_val );
268                                 bdb->bi_dbenv->set_errcall( bdb->bi_dbenv, bdb_errcall );
269                                 rc = bdb->bi_dbenv->open( bdb->bi_dbenv, dbhome,
270                                         flags | DB_RECOVER, bdb->bi_dbenv_mode );
271                                 if( rc != 0 ) {
272                                         Debug( LDAP_DEBUG_ANY,
273                                                 "bdb_db_open: recovery failed: %s (%d)\n",
274                                                 db_strerror(rc), rc, 0 );
275                                         return rc;
276                                 }
277                                 do_recover = 0;
278                         }
279                         /* Prev environment had TXN support, get rid of it */
280                         if ( !flags_ok ) {
281                                 bdb->bi_dbenv->close( bdb->bi_dbenv, 0 );
282                                 bdb->bi_dbenv = NULL;
283                                 rc = db_env_create( &bdb->bi_dbenv, 0 );
284                                 if( rc != 0 ) {
285                                         Debug( LDAP_DEBUG_ANY,
286                                                 "bdb_db_open: db_env_create failed: %s (%d)\n",
287                                                 db_strerror(rc), rc, 0 );
288                                         return rc;
289                                 }
290                                 bdb->bi_dbenv->remove( bdb->bi_dbenv, dbhome, 0 );
291                                 bdb->bi_dbenv = NULL;
292                         }
293                 /* Normal TXN mode */
294                 } else {
295                         /* If we need to recover but we had no TXNs, just fail */
296                         if ( do_recover && !flags_ok ) {
297                                 Debug( LDAP_DEBUG_ANY,
298                                         "bdb_db_open: Database cannot be recovered. "
299                                         "Restore from backup!\n", 0, 0, 0);
300                                 return -1;
301                         }
302                         /* Prev environment had no TXN support, close it */
303                         if ( !flags_ok ) {
304                                 bdb->bi_dbenv->close( bdb->bi_dbenv, 0 );
305                                 bdb->bi_dbenv = NULL;
306                                 do_recover = 1;
307                         }
308                 }
309
310                 if ( flags_ok && !do_recover ) {
311                         /* This environment is fine, don't reopen it */
312                         open_env = 0;
313                 } else {
314                         /* Create a new env that can take the desired settings */
315                         if ( bdb->bi_dbenv != NULL ) {
316                                 bdb->bi_dbenv->close( bdb->bi_dbenv, 0 );
317                                 bdb->bi_dbenv = NULL;
318                         }
319                         rc = db_env_create( &bdb->bi_dbenv, 0 );
320                         if( rc != 0 ) {
321                                 Debug( LDAP_DEBUG_ANY,
322                                         "bdb_db_open: db_env_create failed: %s (%d)\n",
323                                         db_strerror(rc), rc, 0 );
324                                 return rc;
325                         }
326
327                         bdb->bi_dbenv->set_errpfx( bdb->bi_dbenv, be->be_suffix[0].bv_val );
328                         bdb->bi_dbenv->set_errcall( bdb->bi_dbenv, bdb_errcall );
329                         bdb->bi_dbenv->set_lk_detect( bdb->bi_dbenv, bdb->bi_lock_detect );
330
331                         /* One long-lived TXN per thread, two TXNs per write op */
332                         bdb->bi_dbenv->set_tx_max( bdb->bi_dbenv, connection_pool_max * 3 );
333
334                         if( bdb->bi_dbenv_xflags != 0 ) {
335                                 rc = bdb->bi_dbenv->set_flags( bdb->bi_dbenv,
336                                         bdb->bi_dbenv_xflags, 1);
337                                 if( rc != 0 ) {
338                                         Debug( LDAP_DEBUG_ANY,
339                                                 "bdb_db_open: dbenv_set_flags failed: %s (%d)\n",
340                                                 db_strerror(rc), rc, 0 );
341                                         return rc;
342                                 }
343                         }
344                 }
345         }
346
347         /* If we need to recover but there was no existing environment,
348          * then we assume that someone has already manually recovered using
349          * db_recover. Just ignore it.
350          */
351         if ( do_recover && !got_env ) {
352                 do_recover = 0;
353                 Debug( LDAP_DEBUG_TRACE,
354                         "bdb_db_open: Recovery needed but environment is missing - "
355                         "assuming recovery was done manually...\n", 0, 0, 0 );
356         }
357
358         if ( open_env ) {
359                 flags = DB_INIT_MPOOL | DB_THREAD | DB_CREATE;
360                 if ( !( slapMode & SLAP_TOOL_QUICK ))
361                         flags |= BDB_TXN_FLAGS;
362
363                 if ( do_recover )
364                         flags |= DB_RECOVER;
365
366                 /* If a key was set, use shared memory for the BDB environment */
367                 if ( bdb->bi_shm_key ) {
368                         bdb->bi_dbenv->set_shm_key( bdb->bi_dbenv, bdb->bi_shm_key );
369                         flags |= DB_SYSTEM_MEM;
370                 }
371
372                 rc = bdb->bi_dbenv->open( bdb->bi_dbenv, dbhome,
373                         flags, bdb->bi_dbenv_mode );
374                 if( rc != 0 ) {
375                         Debug( LDAP_DEBUG_ANY,
376                                 "bdb_db_open: dbenv_open failed: %s (%d)\n",
377                                 db_strerror(rc), rc, 0 );
378                         return rc;
379                 }
380         }
381
382         if ( do_alock_recover && alock_recover (&bdb->bi_alock_info) != 0 ) {
383                 Debug( LDAP_DEBUG_ANY,
384                         "bdb_db_open: alock_recover failed\n",
385                         0, 0, 0 );
386                 return -1;
387         }
388
389 #ifdef SLAP_ZONE_ALLOC
390         if ( bdb->bi_cache.c_maxsize ) {
391                 bdb->bi_cache.c_zctx = slap_zn_mem_create(
392                                                                 SLAP_ZONE_INITSIZE,
393                                                                 SLAP_ZONE_MAXSIZE,
394                                                                 SLAP_ZONE_DELTA,
395                                                                 SLAP_ZONE_SIZE);
396         }
397 #endif
398
399         if ( bdb->bi_idl_cache_max_size ) {
400                 bdb->bi_idl_tree = NULL;
401                 bdb->bi_idl_cache_size = 0;
402         }
403
404         flags = DB_THREAD | bdb->bi_db_opflags;
405
406 #ifdef DB_AUTO_COMMIT
407         if ( !( slapMode & SLAP_TOOL_QUICK ))
408                 flags |= DB_AUTO_COMMIT;
409 #endif
410
411         bdb->bi_databases = (struct bdb_db_info **) ch_malloc(
412                 BDB_INDICES * sizeof(struct bdb_db_info *) );
413
414         /* open (and create) main database */
415         for( i = 0; bdbi_databases[i].name; i++ ) {
416                 struct bdb_db_info *db;
417
418                 db = (struct bdb_db_info *) ch_calloc(1, sizeof(struct bdb_db_info));
419
420                 rc = db_create( &db->bdi_db, bdb->bi_dbenv, 0 );
421                 if( rc != 0 ) {
422                         Debug( LDAP_DEBUG_ANY,
423                                 "bdb_db_open: db_create(%s) failed: %s (%d)\n",
424                                 bdb->bi_dbenv_home, db_strerror(rc), rc );
425                         return rc;
426                 }
427
428                 if( i == BDB_ID2ENTRY ) {
429                         rc = db->bdi_db->set_pagesize( db->bdi_db,
430                                 BDB_ID2ENTRY_PAGESIZE );
431                         if ( slapMode & SLAP_TOOL_READMAIN ) {
432                                 flags |= DB_RDONLY;
433                         } else {
434                                 flags |= DB_CREATE;
435                         }
436                 } else {
437                         rc = db->bdi_db->set_flags( db->bdi_db, 
438                                 DB_DUP | DB_DUPSORT );
439 #ifndef BDB_HIER
440                         if ( slapMode & SLAP_TOOL_READONLY ) {
441                                 flags |= DB_RDONLY;
442                         } else {
443                                 flags |= DB_CREATE;
444                         }
445 #else
446                         if ( slapMode & (SLAP_TOOL_READONLY|SLAP_TOOL_READMAIN) ) {
447                                 flags |= DB_RDONLY;
448                         } else {
449                                 flags |= DB_CREATE;
450                         }
451 #endif
452                         rc = db->bdi_db->set_pagesize( db->bdi_db,
453                                 BDB_PAGESIZE );
454                 }
455
456 #ifdef HAVE_EBCDIC
457                 strcpy( path, bdbi_databases[i].file );
458                 __atoe( path );
459                 rc = DB_OPEN( db->bdi_db,
460                         path,
461                 /*      bdbi_databases[i].name, */ NULL,
462                         bdbi_databases[i].type,
463                         bdbi_databases[i].flags | flags,
464                         bdb->bi_dbenv_mode );
465 #else
466                 rc = DB_OPEN( db->bdi_db,
467                         bdbi_databases[i].file,
468                 /*      bdbi_databases[i].name, */ NULL,
469                         bdbi_databases[i].type,
470                         bdbi_databases[i].flags | flags,
471                         bdb->bi_dbenv_mode );
472 #endif
473
474                 if ( rc != 0 ) {
475                         char    buf[SLAP_TEXT_BUFLEN];
476
477                         snprintf( buf, sizeof(buf), "%s/%s", 
478                                 bdb->bi_dbenv_home, bdbi_databases[i].file );
479                         Debug( LDAP_DEBUG_ANY,
480                                 "bdb_db_open: db_open(%s) failed: %s (%d)\n",
481                                 buf, db_strerror(rc), rc );
482                         return rc;
483                 }
484
485 #if 0
486                 if( i == BDB_ID2ENTRY && ( slapMode & SLAP_TOOL_MODE )) {
487                         db->bdi_db->mpf->set_priority( db->bdi_db->mpf,
488                                 DB_PRIORITY_VERY_LOW );
489                 }
490 #endif
491
492                 flags &= ~(DB_CREATE | DB_RDONLY);
493                 db->bdi_name = bdbi_databases[i].name;
494                 bdb->bi_databases[i] = db;
495         }
496
497         bdb->bi_databases[i] = NULL;
498         bdb->bi_ndatabases = i;
499
500         /* get nextid */
501         rc = bdb_last_id( be, NULL );
502         if( rc != 0 ) {
503                 Debug( LDAP_DEBUG_ANY,
504                         "bdb_db_open: last_id(%s) failed: %s (%d)\n",
505                         bdb->bi_dbenv_home, db_strerror(rc), rc );
506                 return rc;
507         }
508
509         if ( !( slapMode & SLAP_TOOL_QUICK )) {
510                 XLOCK_ID(bdb->bi_dbenv, &bdb->bi_cache.c_locker);
511         }
512
513         bdb->bi_flags |= BDB_IS_OPEN;
514
515         return 0;
516 }
517
518 static int
519 bdb_db_close( BackendDB *be )
520 {
521         int rc;
522         struct bdb_info *bdb = (struct bdb_info *) be->be_private;
523         struct bdb_db_info *db;
524         bdb_idl_cache_entry_t *entry, *next_entry;
525
526         /* backend_shutdown closes everything, even if not all were opened */
527         if ( !( bdb->bi_flags & BDB_IS_OPEN ))
528                 return 0;
529
530         bdb->bi_flags &= ~BDB_IS_OPEN;
531
532         ber_bvarray_free( bdb->bi_db_config );
533         bdb->bi_db_config = NULL;
534
535         while( bdb->bi_databases && bdb->bi_ndatabases-- ) {
536                 db = bdb->bi_databases[bdb->bi_ndatabases];
537                 rc = db->bdi_db->close( db->bdi_db, 0 );
538                 /* Lower numbered names are not strdup'd */
539                 if( bdb->bi_ndatabases >= BDB_NDB )
540                         free( db->bdi_name );
541                 free( db );
542         }
543         free( bdb->bi_databases );
544         bdb->bi_databases = NULL;
545
546         bdb_cache_release_all (&bdb->bi_cache);
547
548         if ( bdb->bi_idl_cache_max_size ) {
549                 ldap_pvt_thread_rdwr_wlock ( &bdb->bi_idl_tree_rwlock );
550                 avl_free( bdb->bi_idl_tree, NULL );
551                 bdb->bi_idl_tree = NULL;
552                 entry = bdb->bi_idl_lru_head;
553                 while ( entry != NULL ) {
554                         next_entry = entry->idl_lru_next;
555                         if ( entry->idl )
556                                 free( entry->idl );
557                         free( entry->kstr.bv_val );
558                         free( entry );
559                         entry = next_entry;
560                 }
561                 bdb->bi_idl_lru_head = bdb->bi_idl_lru_tail = NULL;
562                 ldap_pvt_thread_rdwr_wunlock ( &bdb->bi_idl_tree_rwlock );
563         }
564
565         if ( !( slapMode & SLAP_TOOL_QUICK ) && bdb->bi_dbenv ) {
566                 XLOCK_ID_FREE(bdb->bi_dbenv, bdb->bi_cache.c_locker);
567                 bdb->bi_cache.c_locker = 0;
568         }
569
570         /* close db environment */
571         if( bdb->bi_dbenv ) {
572                 /* force a checkpoint, but not if we were ReadOnly,
573                  * and not in Quick mode since there are no transactions there.
574                  */
575                 if ( !( slapMode & ( SLAP_TOOL_QUICK|SLAP_TOOL_READONLY ))) {
576                         rc = TXN_CHECKPOINT( bdb->bi_dbenv, 0, 0, DB_FORCE );
577                         if( rc != 0 ) {
578                                 Debug( LDAP_DEBUG_ANY,
579                                         "bdb_db_close: txn_checkpoint failed: %s (%d)\n",
580                                         db_strerror(rc), rc, 0 );
581                         }
582                 }
583
584                 rc = bdb->bi_dbenv->close( bdb->bi_dbenv, 0 );
585                 bdb->bi_dbenv = NULL;
586                 if( rc != 0 ) {
587                         Debug( LDAP_DEBUG_ANY,
588                                 "bdb_db_close: close failed: %s (%d)\n",
589                                 db_strerror(rc), rc, 0 );
590                         return rc;
591                 }
592         }
593
594         rc = alock_close( &bdb->bi_alock_info );
595         if( rc != 0 ) {
596                 Debug( LDAP_DEBUG_ANY,
597                         "bdb_db_close: alock_close failed\n", 0, 0, 0 );
598                 return -1;
599         }
600
601         return 0;
602 }
603
604 static int
605 bdb_db_destroy( BackendDB *be )
606 {
607         struct bdb_info *bdb = (struct bdb_info *) be->be_private;
608
609         if( bdb->bi_dbenv_home ) ch_free( bdb->bi_dbenv_home );
610         if( bdb->bi_db_config_path ) ch_free( bdb->bi_db_config_path );
611
612         bdb_attr_index_destroy( bdb->bi_attrs );
613
614         ldap_pvt_thread_rdwr_destroy ( &bdb->bi_cache.c_rwlock );
615         ldap_pvt_thread_mutex_destroy( &bdb->bi_cache.lru_mutex );
616         ldap_pvt_thread_mutex_destroy( &bdb->bi_cache.c_dntree.bei_kids_mutex );
617 #ifdef BDB_HIER
618         ldap_pvt_thread_mutex_destroy( &bdb->bi_modrdns_mutex );
619 #endif
620         ldap_pvt_thread_mutex_destroy( &bdb->bi_lastid_mutex );
621         ldap_pvt_thread_mutex_destroy( &bdb->bi_database_mutex );
622         ldap_pvt_thread_rdwr_destroy( &bdb->bi_idl_tree_rwlock );
623         ldap_pvt_thread_mutex_destroy( &bdb->bi_idl_tree_lrulock );
624
625         ch_free( bdb );
626         be->be_private = NULL;
627
628         return 0;
629 }
630
631 int
632 bdb_back_initialize(
633         BackendInfo     *bi )
634 {
635         int rc;
636
637         static char *controls[] = {
638                 LDAP_CONTROL_ASSERT,
639                 LDAP_CONTROL_MANAGEDSAIT,
640                 LDAP_CONTROL_NOOP,
641                 LDAP_CONTROL_PAGEDRESULTS,
642 #ifdef LDAP_CONTROL_SUBENTRIES
643                 LDAP_CONTROL_SUBENTRIES,
644 #endif
645 #ifdef LDAP_CONTROL_X_PERMISSIVE_MODIFY
646                 LDAP_CONTROL_X_PERMISSIVE_MODIFY,
647 #endif
648                 NULL
649         };
650
651         /* initialize the underlying database system */
652         Debug( LDAP_DEBUG_TRACE,
653                 LDAP_XSTRING(bdb_back_initialize) ": initialize " 
654                 BDB_UCTYPE " backend\n", 0, 0, 0 );
655
656         bi->bi_flags |=
657                 SLAP_BFLAG_INCREMENT |
658 #ifdef BDB_SUBENTRIES
659                 SLAP_BFLAG_SUBENTRIES |
660 #endif
661                 SLAP_BFLAG_ALIASES |
662                 SLAP_BFLAG_REFERRALS;
663
664         bi->bi_controls = controls;
665
666         {       /* version check */
667                 int major, minor, patch, ver;
668                 char *version = db_version( &major, &minor, &patch );
669 #ifdef HAVE_EBCDIC
670                 char v2[1024];
671
672                 /* All our stdio does an ASCII to EBCDIC conversion on
673                  * the output. Strings from the BDB library are already
674                  * in EBCDIC; we have to go back and forth...
675                  */
676                 strcpy( v2, version );
677                 __etoa( v2 );
678                 version = v2;
679 #endif
680
681                 ver = (major << 24) | (minor << 16) | patch;
682                 if( ver != DB_VERSION_FULL ) {
683                         /* fail if a versions don't match */
684                         Debug( LDAP_DEBUG_ANY,
685                                 LDAP_XSTRING(bdb_back_initialize) ": "
686                                 "BDB library version mismatch:"
687                                 " expected " DB_VERSION_STRING ","
688                                 " got %s\n", version, 0, 0 );
689                         return -1;
690                 }
691
692                 Debug( LDAP_DEBUG_TRACE, LDAP_XSTRING(bdb_back_initialize)
693                         ": %s\n", version, 0, 0 );
694         }
695
696         db_env_set_func_free( ber_memfree );
697         db_env_set_func_malloc( (db_malloc *)ber_memalloc );
698         db_env_set_func_realloc( (db_realloc *)ber_memrealloc );
699 #ifndef NO_THREAD
700         /* This is a no-op on a NO_THREAD build. Leave the default
701          * alone so that BDB will sleep on interprocess conflicts.
702          */
703         db_env_set_func_yield( ldap_pvt_thread_yield );
704 #endif
705
706         bi->bi_open = 0;
707         bi->bi_close = 0;
708         bi->bi_config = 0;
709         bi->bi_destroy = 0;
710
711         bi->bi_db_init = bdb_db_init;
712         bi->bi_db_config = config_generic_wrapper;
713         bi->bi_db_open = bdb_db_open;
714         bi->bi_db_close = bdb_db_close;
715         bi->bi_db_destroy = bdb_db_destroy;
716
717         bi->bi_op_add = bdb_add;
718         bi->bi_op_bind = bdb_bind;
719         bi->bi_op_compare = bdb_compare;
720         bi->bi_op_delete = bdb_delete;
721         bi->bi_op_modify = bdb_modify;
722         bi->bi_op_modrdn = bdb_modrdn;
723         bi->bi_op_search = bdb_search;
724
725         bi->bi_op_unbind = 0;
726
727         bi->bi_extended = bdb_extended;
728
729         bi->bi_chk_referrals = bdb_referrals;
730         bi->bi_operational = bdb_operational;
731         bi->bi_has_subordinates = bdb_hasSubordinates;
732         bi->bi_entry_release_rw = bdb_entry_release;
733         bi->bi_entry_get_rw = bdb_entry_get;
734
735         /*
736          * hooks for slap tools
737          */
738         bi->bi_tool_entry_open = bdb_tool_entry_open;
739         bi->bi_tool_entry_close = bdb_tool_entry_close;
740         bi->bi_tool_entry_first = bdb_tool_entry_next;
741         bi->bi_tool_entry_next = bdb_tool_entry_next;
742         bi->bi_tool_entry_get = bdb_tool_entry_get;
743         bi->bi_tool_entry_put = bdb_tool_entry_put;
744         bi->bi_tool_entry_reindex = bdb_tool_entry_reindex;
745         bi->bi_tool_sync = 0;
746         bi->bi_tool_dn2id_get = bdb_tool_dn2id_get;
747         bi->bi_tool_id2entry_get = bdb_tool_id2entry_get;
748         bi->bi_tool_entry_modify = bdb_tool_entry_modify;
749
750         bi->bi_connection_init = 0;
751         bi->bi_connection_destroy = 0;
752
753         rc = bdb_back_init_cf( bi );
754
755         return rc;
756 }
757
758 #if     (SLAPD_BDB == SLAPD_MOD_DYNAMIC && !defined(BDB_HIER)) || \
759         (SLAPD_HDB == SLAPD_MOD_DYNAMIC && defined(BDB_HIER))
760
761 /* conditionally define the init_module() function */
762 #ifdef BDB_HIER
763 SLAP_BACKEND_INIT_MODULE( hdb )
764 #else /* !BDB_HIER */
765 SLAP_BACKEND_INIT_MODULE( bdb )
766 #endif /* !BDB_HIER */
767
768 #endif /* SLAPD_[BH]DB == SLAPD_MOD_DYNAMIC */
769