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