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