]> git.sur5r.net Git - openldap/blob - servers/slapd/back-bdb/init.c
Sync with HEAD
[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                         bdb->bi_dbenv->close( bdb->bi_dbenv, 0 );
316                         bdb->bi_dbenv = NULL;
317                         rc = db_env_create( &bdb->bi_dbenv, 0 );
318                         if( rc != 0 ) {
319                                 Debug( LDAP_DEBUG_ANY,
320                                         "bdb_db_open: db_env_create failed: %s (%d)\n",
321                                         db_strerror(rc), rc, 0 );
322                                 return rc;
323                         }
324
325                         bdb->bi_dbenv->set_errpfx( bdb->bi_dbenv, be->be_suffix[0].bv_val );
326                         bdb->bi_dbenv->set_errcall( bdb->bi_dbenv, bdb_errcall );
327                         bdb->bi_dbenv->set_lk_detect( bdb->bi_dbenv, bdb->bi_lock_detect );
328
329                         /* One long-lived TXN per thread, two TXNs per write op */
330                         bdb->bi_dbenv->set_tx_max( bdb->bi_dbenv, connection_pool_max * 3 );
331
332                         if( bdb->bi_dbenv_xflags != 0 ) {
333                                 rc = bdb->bi_dbenv->set_flags( bdb->bi_dbenv,
334                                         bdb->bi_dbenv_xflags, 1);
335                                 if( rc != 0 ) {
336                                         Debug( LDAP_DEBUG_ANY,
337                                                 "bdb_db_open: dbenv_set_flags failed: %s (%d)\n",
338                                                 db_strerror(rc), rc, 0 );
339                                         return rc;
340                                 }
341                         }
342                 }
343         }
344
345         /* If we need to recover but there was no existing environment,
346          * then we assume that someone has already manually recovered using
347          * db_recover. Just ignore it.
348          */
349         if ( do_recover && !got_env ) {
350                 do_recover = 0;
351                 Debug( LDAP_DEBUG_TRACE,
352                         "bdb_db_open: Recovery needed but environment is missing - "
353                         "assuming recovery was done manually...\n", 0, 0, 0 );
354         }
355
356         if ( open_env ) {
357                 flags = DB_INIT_MPOOL | DB_THREAD | DB_CREATE;
358                 if ( !( slapMode & SLAP_TOOL_QUICK ))
359                         flags |= BDB_TXN_FLAGS;
360
361                 if ( do_recover )
362                         flags |= DB_RECOVER;
363
364                 /* If a key was set, use shared memory for the BDB environment */
365                 if ( bdb->bi_shm_key ) {
366                         bdb->bi_dbenv->set_shm_key( bdb->bi_dbenv, bdb->bi_shm_key );
367                         flags |= DB_SYSTEM_MEM;
368                 }
369
370                 rc = bdb->bi_dbenv->open( bdb->bi_dbenv, dbhome,
371                         flags, bdb->bi_dbenv_mode );
372                 if( rc != 0 ) {
373                         Debug( LDAP_DEBUG_ANY,
374                                 "bdb_db_open: dbenv_open failed: %s (%d)\n",
375                                 db_strerror(rc), rc, 0 );
376                         return rc;
377                 }
378         }
379
380         if ( do_alock_recover && alock_recover (&bdb->bi_alock_info) != 0 ) {
381                 Debug( LDAP_DEBUG_ANY,
382                         "bdb_db_open: alock_recover failed\n",
383                         0, 0, 0 );
384                 return -1;
385         }
386
387 #ifdef SLAP_ZONE_ALLOC
388         if ( bdb->bi_cache.c_maxsize ) {
389                 bdb->bi_cache.c_zctx = slap_zn_mem_create(
390                                                                 SLAP_ZONE_INITSIZE,
391                                                                 SLAP_ZONE_MAXSIZE,
392                                                                 SLAP_ZONE_DELTA,
393                                                                 SLAP_ZONE_SIZE);
394         }
395 #endif
396
397         if ( bdb->bi_idl_cache_max_size ) {
398                 bdb->bi_idl_tree = NULL;
399                 bdb->bi_idl_cache_size = 0;
400         }
401
402         flags = DB_THREAD | bdb->bi_db_opflags;
403
404 #ifdef DB_AUTO_COMMIT
405         if ( !( slapMode & SLAP_TOOL_QUICK ))
406                 flags |= DB_AUTO_COMMIT;
407 #endif
408
409         bdb->bi_databases = (struct bdb_db_info **) ch_malloc(
410                 BDB_INDICES * sizeof(struct bdb_db_info *) );
411
412         /* open (and create) main database */
413         for( i = 0; bdbi_databases[i].name; i++ ) {
414                 struct bdb_db_info *db;
415
416                 db = (struct bdb_db_info *) ch_calloc(1, sizeof(struct bdb_db_info));
417
418                 rc = db_create( &db->bdi_db, bdb->bi_dbenv, 0 );
419                 if( rc != 0 ) {
420                         Debug( LDAP_DEBUG_ANY,
421                                 "bdb_db_open: db_create(%s) failed: %s (%d)\n",
422                                 bdb->bi_dbenv_home, db_strerror(rc), rc );
423                         return rc;
424                 }
425
426                 if( i == BDB_ID2ENTRY ) {
427                         rc = db->bdi_db->set_pagesize( db->bdi_db,
428                                 BDB_ID2ENTRY_PAGESIZE );
429                         if ( slapMode & SLAP_TOOL_READMAIN ) {
430                                 flags |= DB_RDONLY;
431                         } else {
432                                 flags |= DB_CREATE;
433                         }
434                 } else {
435                         rc = db->bdi_db->set_flags( db->bdi_db, 
436                                 DB_DUP | DB_DUPSORT );
437 #ifndef BDB_HIER
438                         if ( slapMode & SLAP_TOOL_READONLY ) {
439                                 flags |= DB_RDONLY;
440                         } else {
441                                 flags |= DB_CREATE;
442                         }
443 #else
444                         if ( slapMode & (SLAP_TOOL_READONLY|SLAP_TOOL_READMAIN) ) {
445                                 flags |= DB_RDONLY;
446                         } else {
447                                 flags |= DB_CREATE;
448                         }
449 #endif
450                         rc = db->bdi_db->set_pagesize( db->bdi_db,
451                                 BDB_PAGESIZE );
452                 }
453
454 #ifdef HAVE_EBCDIC
455                 strcpy( path, bdbi_databases[i].file );
456                 __atoe( path );
457                 rc = DB_OPEN( db->bdi_db,
458                         path,
459                 /*      bdbi_databases[i].name, */ NULL,
460                         bdbi_databases[i].type,
461                         bdbi_databases[i].flags | flags,
462                         bdb->bi_dbenv_mode );
463 #else
464                 rc = DB_OPEN( db->bdi_db,
465                         bdbi_databases[i].file,
466                 /*      bdbi_databases[i].name, */ NULL,
467                         bdbi_databases[i].type,
468                         bdbi_databases[i].flags | flags,
469                         bdb->bi_dbenv_mode );
470 #endif
471
472                 if ( rc != 0 ) {
473                         char    buf[SLAP_TEXT_BUFLEN];
474
475                         snprintf( buf, sizeof(buf), "%s/%s", 
476                                 bdb->bi_dbenv_home, bdbi_databases[i].file );
477                         Debug( LDAP_DEBUG_ANY,
478                                 "bdb_db_open: db_open(%s) failed: %s (%d)\n",
479                                 buf, db_strerror(rc), rc );
480                         return rc;
481                 }
482
483 #if 0
484                 if( i == BDB_ID2ENTRY && ( slapMode & SLAP_TOOL_MODE )) {
485                         db->bdi_db->mpf->set_priority( db->bdi_db->mpf,
486                                 DB_PRIORITY_VERY_LOW );
487                 }
488 #endif
489
490                 flags &= ~(DB_CREATE | DB_RDONLY);
491                 db->bdi_name = bdbi_databases[i].name;
492                 bdb->bi_databases[i] = db;
493         }
494
495         bdb->bi_databases[i] = NULL;
496         bdb->bi_ndatabases = i;
497
498         /* get nextid */
499         rc = bdb_last_id( be, NULL );
500         if( rc != 0 ) {
501                 Debug( LDAP_DEBUG_ANY,
502                         "bdb_db_open: last_id(%s) failed: %s (%d)\n",
503                         bdb->bi_dbenv_home, db_strerror(rc), rc );
504                 return rc;
505         }
506
507         if ( !( slapMode & SLAP_TOOL_QUICK )) {
508                 XLOCK_ID(bdb->bi_dbenv, &bdb->bi_cache.c_locker);
509         }
510
511         bdb->bi_flags |= BDB_IS_OPEN;
512
513         return 0;
514 }
515
516 static int
517 bdb_db_close( BackendDB *be )
518 {
519         int rc;
520         struct bdb_info *bdb = (struct bdb_info *) be->be_private;
521         struct bdb_db_info *db;
522         bdb_idl_cache_entry_t *entry, *next_entry;
523
524         /* backend_shutdown closes everything, even if not all were opened */
525         if ( !( bdb->bi_flags & BDB_IS_OPEN ))
526                 return 0;
527
528         bdb->bi_flags &= ~BDB_IS_OPEN;
529
530         ber_bvarray_free( bdb->bi_db_config );
531         bdb->bi_db_config = NULL;
532
533         while( bdb->bi_databases && bdb->bi_ndatabases-- ) {
534                 db = bdb->bi_databases[bdb->bi_ndatabases];
535                 rc = db->bdi_db->close( db->bdi_db, 0 );
536                 /* Lower numbered names are not strdup'd */
537                 if( bdb->bi_ndatabases >= BDB_NDB )
538                         free( db->bdi_name );
539                 free( db );
540         }
541         free( bdb->bi_databases );
542         bdb->bi_databases = NULL;
543
544         bdb_cache_release_all (&bdb->bi_cache);
545
546         if ( bdb->bi_idl_cache_max_size ) {
547                 ldap_pvt_thread_rdwr_wlock ( &bdb->bi_idl_tree_rwlock );
548                 avl_free( bdb->bi_idl_tree, NULL );
549                 bdb->bi_idl_tree = NULL;
550                 entry = bdb->bi_idl_lru_head;
551                 while ( entry != NULL ) {
552                         next_entry = entry->idl_lru_next;
553                         if ( entry->idl )
554                                 free( entry->idl );
555                         free( entry->kstr.bv_val );
556                         free( entry );
557                         entry = next_entry;
558                 }
559                 bdb->bi_idl_lru_head = bdb->bi_idl_lru_tail = NULL;
560                 ldap_pvt_thread_rdwr_wunlock ( &bdb->bi_idl_tree_rwlock );
561         }
562
563         if ( !( slapMode & SLAP_TOOL_QUICK ) && bdb->bi_dbenv ) {
564                 XLOCK_ID_FREE(bdb->bi_dbenv, bdb->bi_cache.c_locker);
565                 bdb->bi_cache.c_locker = 0;
566         }
567
568         /* close db environment */
569         if( bdb->bi_dbenv ) {
570                 /* force a checkpoint, but not if we were ReadOnly,
571                  * and not in Quick mode since there are no transactions there.
572                  */
573                 if ( !( slapMode & ( SLAP_TOOL_QUICK|SLAP_TOOL_READONLY ))) {
574                         rc = TXN_CHECKPOINT( bdb->bi_dbenv, 0, 0, DB_FORCE );
575                         if( rc != 0 ) {
576                                 Debug( LDAP_DEBUG_ANY,
577                                         "bdb_db_close: txn_checkpoint failed: %s (%d)\n",
578                                         db_strerror(rc), rc, 0 );
579                         }
580                 }
581
582                 rc = bdb->bi_dbenv->close( bdb->bi_dbenv, 0 );
583                 bdb->bi_dbenv = NULL;
584                 if( rc != 0 ) {
585                         Debug( LDAP_DEBUG_ANY,
586                                 "bdb_db_close: close failed: %s (%d)\n",
587                                 db_strerror(rc), rc, 0 );
588                         return rc;
589                 }
590         }
591
592         rc = alock_close( &bdb->bi_alock_info );
593         if( rc != 0 ) {
594                 Debug( LDAP_DEBUG_ANY,
595                         "bdb_db_close: alock_close failed\n", 0, 0, 0 );
596                 return -1;
597         }
598
599         return 0;
600 }
601
602 static int
603 bdb_db_destroy( BackendDB *be )
604 {
605         struct bdb_info *bdb = (struct bdb_info *) be->be_private;
606
607         if( bdb->bi_dbenv_home ) ch_free( bdb->bi_dbenv_home );
608         if( bdb->bi_db_config_path ) ch_free( bdb->bi_db_config_path );
609
610         bdb_attr_index_destroy( bdb->bi_attrs );
611
612         ldap_pvt_thread_rdwr_destroy ( &bdb->bi_cache.c_rwlock );
613         ldap_pvt_thread_mutex_destroy( &bdb->bi_cache.lru_mutex );
614         ldap_pvt_thread_mutex_destroy( &bdb->bi_cache.c_dntree.bei_kids_mutex );
615 #ifdef BDB_HIER
616         ldap_pvt_thread_mutex_destroy( &bdb->bi_modrdns_mutex );
617 #endif
618         ldap_pvt_thread_mutex_destroy( &bdb->bi_lastid_mutex );
619         ldap_pvt_thread_mutex_destroy( &bdb->bi_database_mutex );
620         ldap_pvt_thread_rdwr_destroy( &bdb->bi_idl_tree_rwlock );
621         ldap_pvt_thread_mutex_destroy( &bdb->bi_idl_tree_lrulock );
622
623         ch_free( bdb );
624         be->be_private = NULL;
625
626         return 0;
627 }
628
629 int
630 bdb_back_initialize(
631         BackendInfo     *bi )
632 {
633         int rc;
634
635         static char *controls[] = {
636                 LDAP_CONTROL_ASSERT,
637                 LDAP_CONTROL_MANAGEDSAIT,
638                 LDAP_CONTROL_NOOP,
639                 LDAP_CONTROL_PAGEDRESULTS,
640 #ifdef LDAP_CONTROL_SUBENTRIES
641                 LDAP_CONTROL_SUBENTRIES,
642 #endif
643 #ifdef LDAP_CONTROL_X_PERMISSIVE_MODIFY
644                 LDAP_CONTROL_X_PERMISSIVE_MODIFY,
645 #endif
646                 NULL
647         };
648
649         /* initialize the underlying database system */
650         Debug( LDAP_DEBUG_TRACE,
651                 LDAP_XSTRING(bdb_back_initialize) ": initialize " 
652                 BDB_UCTYPE " backend\n", 0, 0, 0 );
653
654         bi->bi_flags |=
655                 SLAP_BFLAG_INCREMENT |
656 #ifdef BDB_SUBENTRIES
657                 SLAP_BFLAG_SUBENTRIES |
658 #endif
659                 SLAP_BFLAG_ALIASES |
660                 SLAP_BFLAG_REFERRALS;
661
662         bi->bi_controls = controls;
663
664         {       /* version check */
665                 int major, minor, patch, ver;
666                 char *version = db_version( &major, &minor, &patch );
667 #ifdef HAVE_EBCDIC
668                 char v2[1024];
669
670                 /* All our stdio does an ASCII to EBCDIC conversion on
671                  * the output. Strings from the BDB library are already
672                  * in EBCDIC; we have to go back and forth...
673                  */
674                 strcpy( v2, version );
675                 __etoa( v2 );
676                 version = v2;
677 #endif
678
679                 ver = (major << 24) | (minor << 16) | patch;
680                 if( ver != DB_VERSION_FULL ) {
681                         /* fail if a versions don't match */
682                         Debug( LDAP_DEBUG_ANY,
683                                 LDAP_XSTRING(bdb_back_initialize) ": "
684                                 "BDB library version mismatch:"
685                                 " expected " DB_VERSION_STRING ","
686                                 " got %s\n", version, 0, 0 );
687                         return -1;
688                 }
689
690                 Debug( LDAP_DEBUG_TRACE, LDAP_XSTRING(bdb_back_initialize)
691                         ": %s\n", version, 0, 0 );
692         }
693
694         db_env_set_func_free( ber_memfree );
695         db_env_set_func_malloc( (db_malloc *)ber_memalloc );
696         db_env_set_func_realloc( (db_realloc *)ber_memrealloc );
697 #ifndef NO_THREAD
698         /* This is a no-op on a NO_THREAD build. Leave the default
699          * alone so that BDB will sleep on interprocess conflicts.
700          */
701         db_env_set_func_yield( ldap_pvt_thread_yield );
702 #endif
703
704         bi->bi_open = 0;
705         bi->bi_close = 0;
706         bi->bi_config = 0;
707         bi->bi_destroy = 0;
708
709         bi->bi_db_init = bdb_db_init;
710         bi->bi_db_config = config_generic_wrapper;
711         bi->bi_db_open = bdb_db_open;
712         bi->bi_db_close = bdb_db_close;
713         bi->bi_db_destroy = bdb_db_destroy;
714
715         bi->bi_op_add = bdb_add;
716         bi->bi_op_bind = bdb_bind;
717         bi->bi_op_compare = bdb_compare;
718         bi->bi_op_delete = bdb_delete;
719         bi->bi_op_modify = bdb_modify;
720         bi->bi_op_modrdn = bdb_modrdn;
721         bi->bi_op_search = bdb_search;
722
723         bi->bi_op_unbind = 0;
724
725         bi->bi_extended = bdb_extended;
726
727         bi->bi_chk_referrals = bdb_referrals;
728         bi->bi_operational = bdb_operational;
729         bi->bi_has_subordinates = bdb_hasSubordinates;
730         bi->bi_entry_release_rw = bdb_entry_release;
731         bi->bi_entry_get_rw = bdb_entry_get;
732
733         /*
734          * hooks for slap tools
735          */
736         bi->bi_tool_entry_open = bdb_tool_entry_open;
737         bi->bi_tool_entry_close = bdb_tool_entry_close;
738         bi->bi_tool_entry_first = bdb_tool_entry_next;
739         bi->bi_tool_entry_next = bdb_tool_entry_next;
740         bi->bi_tool_entry_get = bdb_tool_entry_get;
741         bi->bi_tool_entry_put = bdb_tool_entry_put;
742         bi->bi_tool_entry_reindex = bdb_tool_entry_reindex;
743         bi->bi_tool_sync = 0;
744         bi->bi_tool_dn2id_get = bdb_tool_dn2id_get;
745         bi->bi_tool_id2entry_get = bdb_tool_id2entry_get;
746         bi->bi_tool_entry_modify = bdb_tool_entry_modify;
747
748         bi->bi_connection_init = 0;
749         bi->bi_connection_destroy = 0;
750
751         rc = bdb_back_init_cf( bi );
752
753         return rc;
754 }
755
756 #if     (SLAPD_BDB == SLAPD_MOD_DYNAMIC && !defined(BDB_HIER)) || \
757         (SLAPD_HDB == SLAPD_MOD_DYNAMIC && defined(BDB_HIER))
758
759 /* conditionally define the init_module() function */
760 #ifdef BDB_HIER
761 SLAP_BACKEND_INIT_MODULE( hdb )
762 #else /* !BDB_HIER */
763 SLAP_BACKEND_INIT_MODULE( bdb )
764 #endif /* !BDB_HIER */
765
766 #endif /* SLAPD_[BH]DB == SLAPD_MOD_DYNAMIC */
767