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