1 /* init.c - initialize mdb backend */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 2000-2011 The OpenLDAP Foundation.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted only as authorized by the OpenLDAP
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>.
20 #include <ac/string.h>
21 #include <ac/unistd.h>
22 #include <ac/stdlib.h>
30 static const struct berval mdmi_databases[] = {
38 mdb_db_init( BackendDB *be, ConfigReply *cr )
43 Debug( LDAP_DEBUG_TRACE,
44 LDAP_XSTRING(mdb_db_init) ": Initializing mdb database\n",
47 /* allocate backend-database-specific stuff */
48 mdb = (struct mdb_info *) ch_calloc( 1, sizeof(struct mdb_info) );
50 /* DBEnv parameters */
51 mdb->mi_dbenv_home = ch_strdup( SLAPD_DEFAULT_DB_DIR );
52 mdb->mi_dbenv_flags = 0;
53 mdb->mi_dbenv_mode = SLAPD_DEFAULT_DB_MODE;
55 mdb->mi_search_stack_depth = DEFAULT_SEARCH_STACK_DEPTH;
56 mdb->mi_search_stack = NULL;
58 mdb->mi_mapsize = DEFAULT_MAPSIZE;
61 be->be_cf_ocs = be->bd_info->bi_cf_ocs;
63 #ifndef MDB_MULTIPLE_SUFFIXES
64 SLAP_DBFLAGS( be ) |= SLAP_DBFLAG_ONE_SUFFIX;
67 rc = mdb_monitor_db_init( be );
73 mdb_db_close( BackendDB *be, ConfigReply *cr );
76 mdb_db_open( BackendDB *be, ConfigReply *cr )
79 struct mdb_info *mdb = (struct mdb_info *) be->be_private;
85 if ( be->be_suffix == NULL ) {
86 Debug( LDAP_DEBUG_ANY,
87 LDAP_XSTRING(mdb_db_open) ": need suffix.\n",
92 Debug( LDAP_DEBUG_ARGS,
93 LDAP_XSTRING(mdb_db_open) ": \"%s\"\n",
94 be->be_suffix[0].bv_val, 0, 0 );
96 /* Check existence of dbenv_home. Any error means trouble */
97 rc = stat( mdb->mi_dbenv_home, &stat1 );
99 Debug( LDAP_DEBUG_ANY,
100 LDAP_XSTRING(mdb_db_open) ": database \"%s\": "
101 "cannot access database directory \"%s\" (%d).\n",
102 be->be_suffix[0].bv_val, mdb->mi_dbenv_home, errno );
106 /* mdb is always clean */
107 be->be_flags |= SLAP_DBFLAG_CLEAN;
109 rc = mdb_env_create( &mdb->mi_dbenv );
111 Debug( LDAP_DEBUG_ANY,
112 LDAP_XSTRING(mdb_db_open) ": database \"%s\": "
113 "mdb_env_create failed: %s (%d).\n",
114 be->be_suffix[0].bv_val, mdb_strerror(rc), rc );
118 if ( mdb->mi_readers ) {
119 rc = mdb_env_set_maxreaders( mdb->mi_dbenv, mdb->mi_readers );
121 Debug( LDAP_DEBUG_ANY,
122 LDAP_XSTRING(mdb_db_open) ": database \"%s\": "
123 "mdb_env_set_maxreaders failed: %s (%d).\n",
124 be->be_suffix[0].bv_val, mdb_strerror(rc), rc );
129 rc = mdb_env_set_mapsize( mdb->mi_dbenv, mdb->mi_mapsize );
131 Debug( LDAP_DEBUG_ANY,
132 LDAP_XSTRING(mdb_db_open) ": database \"%s\": "
133 "mdb_env_set_mapsize failed: %s (%d).\n",
134 be->be_suffix[0].bv_val, mdb_strerror(rc), rc );
138 rc = mdb_env_set_maxdbs( mdb->mi_dbenv, MDB_INDICES );
140 Debug( LDAP_DEBUG_ANY,
141 LDAP_XSTRING(mdb_db_open) ": database \"%s\": "
142 "mdb_env_set_maxdbs failed: %s (%d).\n",
143 be->be_suffix[0].bv_val, mdb_strerror(rc), rc );
148 strcpy( path, mdb->mi_dbenv_home );
152 dbhome = mdb->mi_dbenv_home;
155 Debug( LDAP_DEBUG_TRACE,
156 LDAP_XSTRING(mdb_db_open) ": database \"%s\": "
158 be->be_suffix[0].bv_val, mdb->mi_dbenv_home, 0);
160 flags = mdb->mi_dbenv_flags;
162 if ( slapMode & SLAP_TOOL_QUICK )
165 if ( slapMode & SLAP_TOOL_READONLY)
168 rc = mdb_env_open( mdb->mi_dbenv, dbhome,
169 flags, mdb->mi_dbenv_mode );
172 Debug( LDAP_DEBUG_ANY,
173 LDAP_XSTRING(mdb_db_open) ": database \"%s\" cannot be opened, err %d. "
174 "Restore from backup!\n",
175 be->be_suffix[0].bv_val, rc, 0 );
179 rc = mdb_txn_begin( mdb->mi_dbenv, 0, &txn );
181 Debug( LDAP_DEBUG_ANY,
182 LDAP_XSTRING(mdb_db_open) ": database \"%s\" cannot be opened, err %d. "
183 "Restore from backup!\n",
184 be->be_suffix[0].bv_val, rc, 0 );
188 /* open (and create) main databases */
189 for( i = 0; mdmi_databases[i].bv_val; i++ ) {
190 flags = MDB_INTEGERKEY;
191 if( i == MDB_ID2ENTRY ) {
192 if ( !(slapMode & (SLAP_TOOL_READMAIN|SLAP_TOOL_READONLY) ))
195 if ( i == MDB_DN2ID )
196 flags |= MDB_DUPSORT;
197 if ( !(slapMode & SLAP_TOOL_READONLY) )
202 mdmi_databases[i].bv_val,
207 snprintf( cr->msg, sizeof(cr->msg), "database \"%s\": "
208 "mdb_open(%s/%s) failed: %s (%d).",
209 be->be_suffix[0].bv_val,
210 mdb->mi_dbenv_home, mdmi_databases[i].bv_val,
211 mdb_strerror(rc), rc );
212 Debug( LDAP_DEBUG_ANY,
213 LDAP_XSTRING(mdb_db_open) ": %s\n",
218 if ( i == MDB_DN2ID )
219 mdb_set_dupsort( txn, mdb->mi_dbis[i], mdb_dup_compare );
223 rc = mdb_ad_read( mdb, txn );
225 mdb_txn_abort( txn );
229 rc = mdb_attr_dbs_open( be, txn, cr );
231 mdb_txn_abort( txn );
235 rc = mdb_txn_commit(txn);
241 rc = mdb_monitor_db_open( be );
246 mdb->mi_flags |= MDB_IS_OPEN;
251 mdb_db_close( be, NULL );
256 mdb_db_close( BackendDB *be, ConfigReply *cr )
259 struct mdb_info *mdb = (struct mdb_info *) be->be_private;
262 /* monitor handling */
263 (void)mdb_monitor_db_close( be );
265 mdb->mi_flags &= ~MDB_IS_OPEN;
267 if( mdb->mi_dbenv ) {
268 mdb_reader_flush( mdb->mi_dbenv );
271 if ( mdb->mi_dbenv ) {
272 if ( mdb->mi_dbis[0] ) {
274 rc = mdb_txn_begin( mdb->mi_dbenv, MDB_RDONLY, &txn );
276 mdb_attr_dbs_close( mdb, txn );
277 for ( i=0; i<MDB_NDB; i++ )
278 mdb_close( txn, mdb->mi_dbis[i] );
280 mdb_txn_abort( txn );
283 rc = mdb_env_sync( mdb->mi_dbenv, 1 );
285 Debug( LDAP_DEBUG_ANY,
286 "mdb_db_close: database \"%s\": "
287 "mdb_env_sync failed: %s (%d).\n",
288 be->be_suffix[0].bv_val, mdb_strerror(rc), rc );
292 mdb_env_close( mdb->mi_dbenv );
293 mdb->mi_dbenv = NULL;
300 mdb_db_destroy( BackendDB *be, ConfigReply *cr )
302 struct mdb_info *mdb = (struct mdb_info *) be->be_private;
304 /* stop and remove checkpoint task */
305 if ( mdb->mi_txn_cp_task ) {
306 struct re_s *re = mdb->mi_txn_cp_task;
307 mdb->mi_txn_cp_task = NULL;
308 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
309 if ( ldap_pvt_runqueue_isrunning( &slapd_rq, re ) )
310 ldap_pvt_runqueue_stoptask( &slapd_rq, re );
311 ldap_pvt_runqueue_remove( &slapd_rq, re );
312 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
315 /* monitor handling */
316 (void)mdb_monitor_db_destroy( be );
318 if( mdb->mi_dbenv_home ) ch_free( mdb->mi_dbenv_home );
320 mdb_attr_index_destroy( mdb );
323 be->be_private = NULL;
334 static char *controls[] = {
336 LDAP_CONTROL_MANAGEDSAIT,
338 LDAP_CONTROL_PAGEDRESULTS,
339 LDAP_CONTROL_PRE_READ,
340 LDAP_CONTROL_POST_READ,
341 LDAP_CONTROL_SUBENTRIES,
342 LDAP_CONTROL_X_PERMISSIVE_MODIFY,
344 LDAP_CONTROL_X_TXN_SPEC,
349 /* initialize the underlying database system */
350 Debug( LDAP_DEBUG_TRACE,
351 LDAP_XSTRING(mdb_back_initialize) ": initialize "
352 MDB_UCTYPE " backend\n", 0, 0, 0 );
355 SLAP_BFLAG_INCREMENT |
356 SLAP_BFLAG_SUBENTRIES |
358 SLAP_BFLAG_REFERRALS;
360 bi->bi_controls = controls;
362 { /* version check */
363 int major, minor, patch, ver;
364 char *version = mdb_version( &major, &minor, &patch );
368 /* All our stdio does an ASCII to EBCDIC conversion on
369 * the output. Strings from the MDB library are already
370 * in EBCDIC; we have to go back and forth...
372 strcpy( v2, version );
376 ver = (major << 24) | (minor << 16) | patch;
377 if( ver != MDB_VERSION_FULL ) {
378 /* fail if a versions don't match */
379 Debug( LDAP_DEBUG_ANY,
380 LDAP_XSTRING(mdb_back_initialize) ": "
381 "MDB library version mismatch:"
382 " expected " MDB_VERSION_STRING ","
383 " got %s\n", version, 0, 0 );
387 Debug( LDAP_DEBUG_TRACE, LDAP_XSTRING(mdb_back_initialize)
388 ": %s\n", version, 0, 0 );
396 bi->bi_db_init = mdb_db_init;
397 bi->bi_db_config = config_generic_wrapper;
398 bi->bi_db_open = mdb_db_open;
399 bi->bi_db_close = mdb_db_close;
400 bi->bi_db_destroy = mdb_db_destroy;
402 bi->bi_op_add = mdb_add;
403 bi->bi_op_bind = mdb_bind;
404 bi->bi_op_compare = mdb_compare;
405 bi->bi_op_delete = mdb_delete;
406 bi->bi_op_modify = mdb_modify;
407 bi->bi_op_modrdn = mdb_modrdn;
408 bi->bi_op_search = mdb_search;
410 bi->bi_op_unbind = 0;
412 bi->bi_extended = mdb_extended;
414 bi->bi_chk_referrals = 0;
415 bi->bi_operational = mdb_operational;
417 bi->bi_has_subordinates = mdb_hasSubordinates;
418 bi->bi_entry_release_rw = mdb_entry_release;
419 bi->bi_entry_get_rw = mdb_entry_get;
422 * hooks for slap tools
424 bi->bi_tool_entry_open = mdb_tool_entry_open;
425 bi->bi_tool_entry_close = mdb_tool_entry_close;
426 bi->bi_tool_entry_first = backend_tool_entry_first;
427 bi->bi_tool_entry_first_x = mdb_tool_entry_first_x;
428 bi->bi_tool_entry_next = mdb_tool_entry_next;
429 bi->bi_tool_entry_get = mdb_tool_entry_get;
430 bi->bi_tool_entry_put = mdb_tool_entry_put;
431 bi->bi_tool_entry_reindex = mdb_tool_entry_reindex;
432 bi->bi_tool_sync = 0;
433 bi->bi_tool_dn2id_get = mdb_tool_dn2id_get;
434 bi->bi_tool_entry_modify = mdb_tool_entry_modify;
436 bi->bi_connection_init = 0;
437 bi->bi_connection_destroy = 0;
439 rc = mdb_back_init_cf( bi );
444 #if (SLAPD_MDB == SLAPD_MOD_DYNAMIC)
446 SLAP_BACKEND_INIT_MODULE( mdb )
448 #endif /* SLAPD_MDB == SLAPD_MOD_DYNAMIC */