git.sur5r.net Git - openldap/blob - servers/slapd/back-mdb/init.c

   1 /* init.c - initialize mdb backend */
   2 /* $OpenLDAP$ */
   3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   4  *
   5  * Copyright 2000-2011 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-mdb.h"
  26 #include <lutil.h>
  27 #include <ldap_rq.h>
  28 #include "config.h"
  29
  30 static const struct berval mdmi_databases[] = {
  31         BER_BVC("ad2i"),
  32         BER_BVC("dn2i"),
  33         BER_BVC("id2e"),
  34         BER_BVNULL
  35 };
  36
  37 static int
  38 mdb_db_init( BackendDB *be, ConfigReply *cr )
  39 {
  40         struct mdb_info *mdb;
  41         int rc;
  42
  43         Debug( LDAP_DEBUG_TRACE,
  44                 LDAP_XSTRING(mdb_db_init) ": Initializing mdb database\n",
  45                 0, 0, 0 );
  46
  47         /* allocate backend-database-specific stuff */
  48         mdb = (struct mdb_info *) ch_calloc( 1, sizeof(struct mdb_info) );
  49
  50         /* DBEnv parameters */
  51         mdb->mi_dbenv_home = ch_strdup( SLAPD_DEFAULT_DB_DIR );
  52         mdb->mi_dbenv_flags = 0;
  53         mdb->mi_dbenv_mode = SLAPD_DEFAULT_DB_MODE;
  54
  55         mdb->mi_search_stack_depth = DEFAULT_SEARCH_STACK_DEPTH;
  56         mdb->mi_search_stack = NULL;
  57
  58         mdb->mi_mapsize = DEFAULT_MAPSIZE;
  59
  60         be->be_private = mdb;
  61         be->be_cf_ocs = be->bd_info->bi_cf_ocs;
  62
  63 #ifndef MDB_MULTIPLE_SUFFIXES
  64         SLAP_DBFLAGS( be ) |= SLAP_DBFLAG_ONE_SUFFIX;
  65 #endif
  66
  67         rc = mdb_monitor_db_init( be );
  68
  69         return rc;
  70 }
  71
  72 static int
  73 mdb_db_close( BackendDB *be, ConfigReply *cr );
  74
  75 static int
  76 mdb_db_open( BackendDB *be, ConfigReply *cr )
  77 {
  78         int rc, i;
  79         struct mdb_info *mdb = (struct mdb_info *) be->be_private;
  80         struct stat stat1;
  81         u_int32_t flags;
  82         char *dbhome;
  83         MDB_txn *txn;
  84
  85         if ( be->be_suffix == NULL ) {
  86                 Debug( LDAP_DEBUG_ANY,
  87                         LDAP_XSTRING(mdb_db_open) ": need suffix.\n",
  88                         1, 0, 0 );
  89                 return -1;
  90         }
  91
  92         Debug( LDAP_DEBUG_ARGS,
  93                 LDAP_XSTRING(mdb_db_open) ": \"%s\"\n",
  94                 be->be_suffix[0].bv_val, 0, 0 );
  95
  96         /* Check existence of dbenv_home. Any error means trouble */
  97         rc = stat( mdb->mi_dbenv_home, &stat1 );
  98         if( rc != 0 ) {
  99                 Debug( LDAP_DEBUG_ANY,
 100                         LDAP_XSTRING(mdb_db_open) ": database \"%s\": "
 101                         "cannot access database directory \"%s\" (%d).\n",
 102                         be->be_suffix[0].bv_val, mdb->mi_dbenv_home, errno );
 103                 return -1;
 104         }
 105
 106         /* mdb is always clean */
 107         be->be_flags |= SLAP_DBFLAG_CLEAN;
 108
 109         rc = mdb_env_create( &mdb->mi_dbenv );
 110         if( rc != 0 ) {
 111                 Debug( LDAP_DEBUG_ANY,
 112                         LDAP_XSTRING(mdb_db_open) ": database \"%s\": "
 113                         "mdb_env_create failed: %s (%d).\n",
 114                         be->be_suffix[0].bv_val, mdb_strerror(rc), rc );
 115                 goto fail;
 116         }
 117
 118         if ( mdb->mi_readers ) {
 119                 rc = mdb_env_set_maxreaders( mdb->mi_dbenv, mdb->mi_readers );
 120                 if( rc != 0 ) {
 121                         Debug( LDAP_DEBUG_ANY,
 122                                 LDAP_XSTRING(mdb_db_open) ": database \"%s\": "
 123                                 "mdb_env_set_maxreaders failed: %s (%d).\n",
 124                                 be->be_suffix[0].bv_val, mdb_strerror(rc), rc );
 125                         goto fail;
 126                 }
 127         }
 128
 129         rc = mdb_env_set_mapsize( mdb->mi_dbenv, mdb->mi_mapsize );
 130         if( rc != 0 ) {
 131                 Debug( LDAP_DEBUG_ANY,
 132                         LDAP_XSTRING(mdb_db_open) ": database \"%s\": "
 133                         "mdb_env_set_mapsize failed: %s (%d).\n",
 134                         be->be_suffix[0].bv_val, mdb_strerror(rc), rc );
 135                 goto fail;
 136         }
 137
 138         rc = mdb_env_set_maxdbs( mdb->mi_dbenv, MDB_INDICES );
 139         if( rc != 0 ) {
 140                 Debug( LDAP_DEBUG_ANY,
 141                         LDAP_XSTRING(mdb_db_open) ": database \"%s\": "
 142                         "mdb_env_set_maxdbs failed: %s (%d).\n",
 143                         be->be_suffix[0].bv_val, mdb_strerror(rc), rc );
 144                 goto fail;
 145         }
 146
 147 #ifdef HAVE_EBCDIC
 148         strcpy( path, mdb->mi_dbenv_home );
 149         __atoe( path );
 150         dbhome = path;
 151 #else
 152         dbhome = mdb->mi_dbenv_home;
 153 #endif
 154
 155         Debug( LDAP_DEBUG_TRACE,
 156                 LDAP_XSTRING(mdb_db_open) ": database \"%s\": "
 157                 "dbenv_open(%s).\n",
 158                 be->be_suffix[0].bv_val, mdb->mi_dbenv_home, 0);
 159
 160         flags = mdb->mi_dbenv_flags;
 161
 162         if ( slapMode & SLAP_TOOL_QUICK )
 163                 flags |= MDB_NOSYNC;
 164
 165         if ( slapMode & SLAP_TOOL_READONLY)
 166                 flags |= MDB_RDONLY;
 167
 168         rc = mdb_env_open( mdb->mi_dbenv, dbhome,
 169                         flags, mdb->mi_dbenv_mode );
 170
 171         if ( rc ) {
 172                 Debug( LDAP_DEBUG_ANY,
 173                         LDAP_XSTRING(mdb_db_open) ": database \"%s\" cannot be opened, err %d. "
 174                         "Restore from backup!\n",
 175                         be->be_suffix[0].bv_val, rc, 0 );
 176                 goto fail;
 177         }
 178
 179         rc = mdb_txn_begin( mdb->mi_dbenv, 0, &txn );
 180         if ( rc ) {
 181                 Debug( LDAP_DEBUG_ANY,
 182                         LDAP_XSTRING(mdb_db_open) ": database \"%s\" cannot be opened, err %d. "
 183                         "Restore from backup!\n",
 184                         be->be_suffix[0].bv_val, rc, 0 );
 185                 goto fail;
 186         }
 187
 188         /* open (and create) main databases */
 189         for( i = 0; mdmi_databases[i].bv_val; i++ ) {
 190                 flags = MDB_INTEGERKEY;
 191                 if( i == MDB_ID2ENTRY ) {
 192                         if ( !(slapMode & (SLAP_TOOL_READMAIN|SLAP_TOOL_READONLY) ))
 193                                 flags |= MDB_CREATE;
 194                 } else {
 195                         if ( i == MDB_DN2ID )
 196                                 flags |= MDB_DUPSORT;
 197                         if ( !(slapMode & SLAP_TOOL_READONLY) )
 198                                 flags |= MDB_CREATE;
 199                 }
 200
 201                 rc = mdb_open( txn,
 202                         mdmi_databases[i].bv_val,
 203                         flags,
 204                         &mdb->mi_dbis[i] );
 205
 206                 if ( rc != 0 ) {
 207                         snprintf( cr->msg, sizeof(cr->msg), "database \"%s\": "
 208                                 "mdb_open(%s/%s) failed: %s (%d).",
 209                                 be->be_suffix[0].bv_val,
 210                                 mdb->mi_dbenv_home, mdmi_databases[i].bv_val,
 211                                 mdb_strerror(rc), rc );
 212                         Debug( LDAP_DEBUG_ANY,
 213                                 LDAP_XSTRING(mdb_db_open) ": %s\n",
 214                                 cr->msg, 0, 0 );
 215                         goto fail;
 216                 }
 217
 218                 if ( i == MDB_DN2ID )
 219                         mdb_set_dupsort( txn, mdb->mi_dbis[i], mdb_dup_compare );
 220
 221         }
 222
 223         rc = mdb_ad_read( mdb, txn );
 224         if ( rc ) {
 225                 mdb_txn_abort( txn );
 226                 goto fail;
 227         }
 228
 229         rc = mdb_attr_dbs_open( be, txn, cr );
 230         if ( rc ) {
 231                 mdb_txn_abort( txn );
 232                 goto fail;
 233         }
 234
 235         rc = mdb_txn_commit(txn);
 236         if ( rc != 0 ) {
 237                 goto fail;
 238         }
 239
 240         /* monitor setup */
 241         rc = mdb_monitor_db_open( be );
 242         if ( rc != 0 ) {
 243                 goto fail;
 244         }
 245
 246         mdb->mi_flags |= MDB_IS_OPEN;
 247
 248         return 0;
 249
 250 fail:
 251         mdb_db_close( be, NULL );
 252         return rc;
 253 }
 254
 255 static int
 256 mdb_db_close( BackendDB *be, ConfigReply *cr )
 257 {
 258         int rc;
 259         struct mdb_info *mdb = (struct mdb_info *) be->be_private;
 260         MDB_txn *txn;
 261
 262         /* monitor handling */
 263         (void)mdb_monitor_db_close( be );
 264
 265         mdb->mi_flags &= ~MDB_IS_OPEN;
 266
 267         if( mdb->mi_dbenv ) {
 268                 mdb_reader_flush( mdb->mi_dbenv );
 269         }
 270
 271         if ( mdb->mi_dbenv ) {
 272                 if ( mdb->mi_dbis[0] ) {
 273                         int i;
 274                         rc = mdb_txn_begin( mdb->mi_dbenv, MDB_RDONLY, &txn );
 275
 276                         mdb_attr_dbs_close( mdb, txn );
 277                         for ( i=0; i<MDB_NDB; i++ )
 278                                 mdb_close( txn, mdb->mi_dbis[i] );
 279
 280                         mdb_txn_abort( txn );
 281
 282                         /* force a sync */
 283                         rc = mdb_env_sync( mdb->mi_dbenv, 1 );
 284                         if( rc != 0 ) {
 285                                 Debug( LDAP_DEBUG_ANY,
 286                                         "mdb_db_close: database \"%s\": "
 287                                         "mdb_env_sync failed: %s (%d).\n",
 288                                         be->be_suffix[0].bv_val, mdb_strerror(rc), rc );
 289                         }
 290                 }
 291
 292                 mdb_env_close( mdb->mi_dbenv );
 293                 mdb->mi_dbenv = NULL;
 294         }
 295
 296         return 0;
 297 }
 298
 299 static int
 300 mdb_db_destroy( BackendDB *be, ConfigReply *cr )
 301 {
 302         struct mdb_info *mdb = (struct mdb_info *) be->be_private;
 303
 304         /* stop and remove checkpoint task */
 305         if ( mdb->mi_txn_cp_task ) {
 306                 struct re_s *re = mdb->mi_txn_cp_task;
 307                 mdb->mi_txn_cp_task = NULL;
 308                 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
 309                 if ( ldap_pvt_runqueue_isrunning( &slapd_rq, re ) )
 310                         ldap_pvt_runqueue_stoptask( &slapd_rq, re );
 311                 ldap_pvt_runqueue_remove( &slapd_rq, re );
 312                 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
 313         }
 314
 315         /* monitor handling */
 316         (void)mdb_monitor_db_destroy( be );
 317
 318         if( mdb->mi_dbenv_home ) ch_free( mdb->mi_dbenv_home );
 319
 320         mdb_attr_index_destroy( mdb );
 321
 322         ch_free( mdb );
 323         be->be_private = NULL;
 324
 325         return 0;
 326 }
 327
 328 int
 329 mdb_back_initialize(
 330         BackendInfo     *bi )
 331 {
 332         int rc;
 333
 334         static char *controls[] = {
 335                 LDAP_CONTROL_ASSERT,
 336                 LDAP_CONTROL_MANAGEDSAIT,
 337                 LDAP_CONTROL_NOOP,
 338                 LDAP_CONTROL_PAGEDRESULTS,
 339                 LDAP_CONTROL_PRE_READ,
 340                 LDAP_CONTROL_POST_READ,
 341                 LDAP_CONTROL_SUBENTRIES,
 342                 LDAP_CONTROL_X_PERMISSIVE_MODIFY,
 343 #ifdef LDAP_X_TXN
 344                 LDAP_CONTROL_X_TXN_SPEC,
 345 #endif
 346                 NULL
 347         };
 348
 349         /* initialize the underlying database system */
 350         Debug( LDAP_DEBUG_TRACE,
 351                 LDAP_XSTRING(mdb_back_initialize) ": initialize "
 352                 MDB_UCTYPE " backend\n", 0, 0, 0 );
 353
 354         bi->bi_flags |=
 355                 SLAP_BFLAG_INCREMENT |
 356                 SLAP_BFLAG_SUBENTRIES |
 357                 SLAP_BFLAG_ALIASES |
 358                 SLAP_BFLAG_REFERRALS;
 359
 360         bi->bi_controls = controls;
 361
 362         {       /* version check */
 363                 int major, minor, patch, ver;
 364                 char *version = mdb_version( &major, &minor, &patch );
 365 #ifdef HAVE_EBCDIC
 366                 char v2[1024];
 367
 368                 /* All our stdio does an ASCII to EBCDIC conversion on
 369                  * the output. Strings from the MDB library are already
 370                  * in EBCDIC; we have to go back and forth...
 371                  */
 372                 strcpy( v2, version );
 373                 __etoa( v2 );
 374                 version = v2;
 375 #endif
 376                 ver = (major << 24) | (minor << 16) | patch;
 377                 if( ver != MDB_VERSION_FULL ) {
 378                         /* fail if a versions don't match */
 379                         Debug( LDAP_DEBUG_ANY,
 380                                 LDAP_XSTRING(mdb_back_initialize) ": "
 381                                 "MDB library version mismatch:"
 382                                 " expected " MDB_VERSION_STRING ","
 383                                 " got %s\n", version, 0, 0 );
 384                         return -1;
 385                 }
 386
 387                 Debug( LDAP_DEBUG_TRACE, LDAP_XSTRING(mdb_back_initialize)
 388                         ": %s\n", version, 0, 0 );
 389         }
 390
 391         bi->bi_open = 0;
 392         bi->bi_close = 0;
 393         bi->bi_config = 0;
 394         bi->bi_destroy = 0;
 395
 396         bi->bi_db_init = mdb_db_init;
 397         bi->bi_db_config = config_generic_wrapper;
 398         bi->bi_db_open = mdb_db_open;
 399         bi->bi_db_close = mdb_db_close;
 400         bi->bi_db_destroy = mdb_db_destroy;
 401
 402         bi->bi_op_add = mdb_add;
 403         bi->bi_op_bind = mdb_bind;
 404         bi->bi_op_compare = mdb_compare;
 405         bi->bi_op_delete = mdb_delete;
 406         bi->bi_op_modify = mdb_modify;
 407         bi->bi_op_modrdn = mdb_modrdn;
 408         bi->bi_op_search = mdb_search;
 409
 410         bi->bi_op_unbind = 0;
 411
 412         bi->bi_extended = mdb_extended;
 413
 414         bi->bi_chk_referrals = 0;
 415         bi->bi_operational = mdb_operational;
 416
 417         bi->bi_has_subordinates = mdb_hasSubordinates;
 418         bi->bi_entry_release_rw = mdb_entry_release;
 419         bi->bi_entry_get_rw = mdb_entry_get;
 420
 421         /*
 422          * hooks for slap tools
 423          */
 424         bi->bi_tool_entry_open = mdb_tool_entry_open;
 425         bi->bi_tool_entry_close = mdb_tool_entry_close;
 426         bi->bi_tool_entry_first = backend_tool_entry_first;
 427         bi->bi_tool_entry_first_x = mdb_tool_entry_first_x;
 428         bi->bi_tool_entry_next = mdb_tool_entry_next;
 429         bi->bi_tool_entry_get = mdb_tool_entry_get;
 430         bi->bi_tool_entry_put = mdb_tool_entry_put;
 431         bi->bi_tool_entry_reindex = mdb_tool_entry_reindex;
 432         bi->bi_tool_sync = 0;
 433         bi->bi_tool_dn2id_get = mdb_tool_dn2id_get;
 434         bi->bi_tool_entry_modify = mdb_tool_entry_modify;
 435
 436         bi->bi_connection_init = 0;
 437         bi->bi_connection_destroy = 0;
 438
 439         rc = mdb_back_init_cf( bi );
 440
 441         return rc;
 442 }
 443
 444 #if     (SLAPD_MDB == SLAPD_MOD_DYNAMIC)
 445
 446 SLAP_BACKEND_INIT_MODULE( mdb )
 447
 448 #endif /* SLAPD_MDB == SLAPD_MOD_DYNAMIC */
 449