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