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