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
  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: %s (%d). "
 180                         "Restore from backup!\n",
 181                         be->be_suffix[0].bv_val, mdb_strerror(rc), rc );
 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: %s (%d). "
 189                         "Restore from backup!\n",
 190                         be->be_suffix[0].bv_val, mdb_strerror(rc), rc );
 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_cursor *mc;
 228                         MDB_val key, data;
 229                         ID id;
 230                         mdb_set_dupsort( txn, mdb->mi_dbis[i], mdb_dup_compare );
 231                         /* check for old dn2id format */
 232                         rc = mdb_cursor_open( txn, mdb->mi_dbis[i], &mc );
 233                         /* first record is always ID 0 */
 234                         rc = mdb_cursor_get( mc, &key, &data, MDB_FIRST );
 235                         if ( rc == 0 ) {
 236                                 rc = mdb_cursor_get( mc, &key, &data, MDB_NEXT );
 237                                 if ( rc == 0 ) {
 238                                         int len;
 239                                         unsigned char *ptr;
 240                                         ptr = data.mv_data;
 241                                         len = (ptr[0] & 0x7f) << 8 | ptr[1];
 242                                         if (data.mv_size < 2*len + 4 + 2*sizeof(ID)) {
 243                                                 snprintf( cr->msg, sizeof(cr->msg),
 244                                                 "database \"%s\": DN index needs upgrade, "
 245                                                 "run \"slapindex entryDN\".",
 246                                                 be->be_suffix[0].bv_val );
 247                                                 Debug( LDAP_DEBUG_ANY,
 248                                                         LDAP_XSTRING(mdb_db_open) ": %s\n",
 249                                                         cr->msg, 0, 0 );
 250                                                 if ( !(slapMode & SLAP_TOOL_READMAIN ))
 251                                                         rc = LDAP_OTHER;
 252                                                 mdb->mi_flags |= MDB_NEED_UPGRADE;
 253                                         }
 254                                 }
 255                         }
 256                         mdb_cursor_close( mc );
 257                         if ( rc == LDAP_OTHER )
 258                                 goto fail;
 259                 }
 260         }
 261
 262         rc = mdb_ad_read( mdb, txn );
 263         if ( rc ) {
 264                 mdb_txn_abort( txn );
 265                 goto fail;
 266         }
 267
 268         /* slapcat doesn't need indexes. avoid a failure if
 269          * a configured index wasn't created yet.
 270          */
 271         if ( !(slapMode & SLAP_TOOL_READONLY) ) {
 272                 rc = mdb_attr_dbs_open( be, txn, cr );
 273                 if ( rc ) {
 274                         mdb_txn_abort( txn );
 275                         goto fail;
 276                 }
 277         }
 278
 279         rc = mdb_txn_commit(txn);
 280         if ( rc != 0 ) {
 281                 Debug( LDAP_DEBUG_ANY,
 282                         LDAP_XSTRING(mdb_db_open) ": database %s: "
 283                         "txn_commit failed: %s (%d)\n",
 284                         be->be_suffix[0].bv_val, mdb_strerror(rc), rc );
 285                 goto fail;
 286         }
 287
 288         /* monitor setup */
 289         rc = mdb_monitor_db_open( be );
 290         if ( rc != 0 ) {
 291                 goto fail;
 292         }
 293
 294         mdb->mi_flags |= MDB_IS_OPEN;
 295
 296         return 0;
 297
 298 fail:
 299         mdb_db_close( be, NULL );
 300         return rc;
 301 }
 302
 303 static int
 304 mdb_db_close( BackendDB *be, ConfigReply *cr )
 305 {
 306         int rc;
 307         struct mdb_info *mdb = (struct mdb_info *) be->be_private;
 308
 309         /* monitor handling */
 310         (void)mdb_monitor_db_close( be );
 311
 312         mdb->mi_flags &= ~MDB_IS_OPEN;
 313
 314         if( mdb->mi_dbenv ) {
 315                 mdb_reader_flush( mdb->mi_dbenv );
 316         }
 317
 318         if ( mdb->mi_dbenv ) {
 319                 if ( mdb->mi_dbis[0] ) {
 320                         int i;
 321
 322                         mdb_attr_dbs_close( mdb );
 323                         for ( i=0; i<MDB_NDB; i++ )
 324                                 mdb_dbi_close( mdb->mi_dbenv, mdb->mi_dbis[i] );
 325
 326                         /* force a sync, but not if we were ReadOnly,
 327                          * and not in Quick mode.
 328                          */
 329                         if (!(slapMode & (SLAP_TOOL_QUICK|SLAP_TOOL_READONLY))) {
 330                                 rc = mdb_env_sync( mdb->mi_dbenv, 1 );
 331                                 if( rc != 0 ) {
 332                                         Debug( LDAP_DEBUG_ANY,
 333                                                 "mdb_db_close: database \"%s\": "
 334                                                 "mdb_env_sync failed: %s (%d).\n",
 335                                                 be->be_suffix[0].bv_val, mdb_strerror(rc), rc );
 336                                 }
 337                         }
 338                 }
 339
 340                 mdb_env_close( mdb->mi_dbenv );
 341                 mdb->mi_dbenv = NULL;
 342         }
 343
 344         return 0;
 345 }
 346
 347 static int
 348 mdb_db_destroy( BackendDB *be, ConfigReply *cr )
 349 {
 350         struct mdb_info *mdb = (struct mdb_info *) be->be_private;
 351
 352         /* stop and remove checkpoint task */
 353         if ( mdb->mi_txn_cp_task ) {
 354                 struct re_s *re = mdb->mi_txn_cp_task;
 355                 mdb->mi_txn_cp_task = NULL;
 356                 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
 357                 if ( ldap_pvt_runqueue_isrunning( &slapd_rq, re ) )
 358                         ldap_pvt_runqueue_stoptask( &slapd_rq, re );
 359                 ldap_pvt_runqueue_remove( &slapd_rq, re );
 360                 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
 361         }
 362
 363         /* monitor handling */
 364         (void)mdb_monitor_db_destroy( be );
 365
 366         if( mdb->mi_dbenv_home ) ch_free( mdb->mi_dbenv_home );
 367
 368         mdb_attr_index_destroy( mdb );
 369
 370         ch_free( mdb );
 371         be->be_private = NULL;
 372
 373         return 0;
 374 }
 375
 376 int
 377 mdb_back_initialize(
 378         BackendInfo     *bi )
 379 {
 380         int rc;
 381
 382         static char *controls[] = {
 383                 LDAP_CONTROL_ASSERT,
 384                 LDAP_CONTROL_MANAGEDSAIT,
 385                 LDAP_CONTROL_NOOP,
 386                 LDAP_CONTROL_PAGEDRESULTS,
 387                 LDAP_CONTROL_PRE_READ,
 388                 LDAP_CONTROL_POST_READ,
 389                 LDAP_CONTROL_SUBENTRIES,
 390                 LDAP_CONTROL_X_PERMISSIVE_MODIFY,
 391 #ifdef LDAP_X_TXN
 392                 LDAP_CONTROL_X_TXN_SPEC,
 393 #endif
 394                 NULL
 395         };
 396
 397         /* initialize the underlying database system */
 398         Debug( LDAP_DEBUG_TRACE,
 399                 LDAP_XSTRING(mdb_back_initialize) ": initialize "
 400                 MDB_UCTYPE " backend\n", 0, 0, 0 );
 401
 402         bi->bi_flags |=
 403                 SLAP_BFLAG_INCREMENT |
 404                 SLAP_BFLAG_SUBENTRIES |
 405                 SLAP_BFLAG_ALIASES |
 406                 SLAP_BFLAG_REFERRALS;
 407
 408         bi->bi_controls = controls;
 409
 410         {       /* version check */
 411                 int major, minor, patch, ver;
 412                 char *version = mdb_version( &major, &minor, &patch );
 413 #ifdef HAVE_EBCDIC
 414                 char v2[1024];
 415
 416                 /* All our stdio does an ASCII to EBCDIC conversion on
 417                  * the output. Strings from the MDB library are already
 418                  * in EBCDIC; we have to go back and forth...
 419                  */
 420                 strcpy( v2, version );
 421                 __etoa( v2 );
 422                 version = v2;
 423 #endif
 424                 ver = (major << 24) | (minor << 16) | patch;
 425                 if( ver != MDB_VERSION_FULL ) {
 426                         /* fail if a versions don't match */
 427                         Debug( LDAP_DEBUG_ANY,
 428                                 LDAP_XSTRING(mdb_back_initialize) ": "
 429                                 "MDB library version mismatch:"
 430                                 " expected " MDB_VERSION_STRING ","
 431                                 " got %s\n", version, 0, 0 );
 432                         return -1;
 433                 }
 434
 435                 Debug( LDAP_DEBUG_TRACE, LDAP_XSTRING(mdb_back_initialize)
 436                         ": %s\n", version, 0, 0 );
 437         }
 438
 439         bi->bi_open = 0;
 440         bi->bi_close = 0;
 441         bi->bi_config = 0;
 442         bi->bi_destroy = 0;
 443
 444         bi->bi_db_init = mdb_db_init;
 445         bi->bi_db_config = config_generic_wrapper;
 446         bi->bi_db_open = mdb_db_open;
 447         bi->bi_db_close = mdb_db_close;
 448         bi->bi_db_destroy = mdb_db_destroy;
 449
 450         bi->bi_op_add = mdb_add;
 451         bi->bi_op_bind = mdb_bind;
 452         bi->bi_op_compare = mdb_compare;
 453         bi->bi_op_delete = mdb_delete;
 454         bi->bi_op_modify = mdb_modify;
 455         bi->bi_op_modrdn = mdb_modrdn;
 456         bi->bi_op_search = mdb_search;
 457
 458         bi->bi_op_unbind = 0;
 459         bi->bi_op_txn = mdb_txn;
 460
 461         bi->bi_extended = mdb_extended;
 462
 463         bi->bi_chk_referrals = 0;
 464         bi->bi_operational = mdb_operational;
 465
 466         bi->bi_has_subordinates = mdb_hasSubordinates;
 467         bi->bi_entry_release_rw = mdb_entry_release;
 468         bi->bi_entry_get_rw = mdb_entry_get;
 469
 470         /*
 471          * hooks for slap tools
 472          */
 473         bi->bi_tool_entry_open = mdb_tool_entry_open;
 474         bi->bi_tool_entry_close = mdb_tool_entry_close;
 475         bi->bi_tool_entry_first = backend_tool_entry_first;
 476         bi->bi_tool_entry_first_x = mdb_tool_entry_first_x;
 477         bi->bi_tool_entry_next = mdb_tool_entry_next;
 478         bi->bi_tool_entry_get = mdb_tool_entry_get;
 479         bi->bi_tool_entry_put = mdb_tool_entry_put;
 480         bi->bi_tool_entry_reindex = mdb_tool_entry_reindex;
 481         bi->bi_tool_sync = 0;
 482         bi->bi_tool_dn2id_get = mdb_tool_dn2id_get;
 483         bi->bi_tool_entry_modify = mdb_tool_entry_modify;
 484
 485         bi->bi_connection_init = 0;
 486         bi->bi_connection_destroy = 0;
 487
 488         rc = mdb_back_init_cf( bi );
 489
 490         return rc;
 491 }
 492
 493 #if     (SLAPD_MDB == SLAPD_MOD_DYNAMIC)
 494
 495 SLAP_BACKEND_INIT_MODULE( mdb )
 496
 497 #endif /* SLAPD_MDB == SLAPD_MOD_DYNAMIC */
 498