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