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