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