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