1 /* id2entry.c - routines to deal with the id2entry database */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 2000-2018 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>
25 typedef struct Ecount {
32 static int mdb_entry_partsize(struct mdb_info *mdb, MDB_txn *txn, Entry *e,
34 static int mdb_entry_encode(Operation *op, Entry *e, MDB_val *data,
36 static Entry *mdb_entry_alloc( Operation *op, int nattrs, int nvals );
38 #define ADD_FLAGS (MDB_NOOVERWRITE|MDB_APPEND)
40 static int mdb_id2entry_put(
47 struct mdb_info *mdb = (struct mdb_info *) op->o_bd->be_private;
52 /* We only store rdns, and they go in the dn2id database. */
54 key.mv_data = &e->e_id;
55 key.mv_size = sizeof(ID);
57 rc = mdb_entry_partsize( mdb, txn, e, &ec );
63 if (e->e_id < mdb->mi_nextid)
67 data.mv_size = ec.len;
69 rc = mdb_cursor_put( mc, &key, &data, flag );
71 rc = mdb_put( txn, mdb->mi_id2entry, &key, &data, flag );
72 if (rc == MDB_SUCCESS) {
73 rc = mdb_entry_encode( op, e, &data, &ec );
74 if( rc != LDAP_SUCCESS )
78 /* Was there a hole from slapadd? */
79 if ( (flag & MDB_NOOVERWRITE) && data.mv_size == 0 ) {
83 Debug( LDAP_DEBUG_ANY,
84 "mdb_id2entry_put: mdb_put failed: %s(%d) \"%s\"\n",
87 if ( rc != MDB_KEYEXIST )
94 * This routine adds (or updates) an entry on disk.
95 * The cache should be already be updated.
105 return mdb_id2entry_put(op, txn, mc, e, ADD_FLAGS);
108 int mdb_id2entry_update(
114 return mdb_id2entry_put(op, txn, mc, e, 0);
127 key.mv_size = sizeof(ID);
130 rc = mdb_cursor_get( mc, &key, data, MDB_SET );
131 /* stubs from missing parents - DB is actually invalid */
132 if ( rc == MDB_SUCCESS && !data->mv_size )
149 key.mv_size = sizeof(ID);
152 rc = mdb_cursor_get( mc, &key, &data, MDB_SET );
153 if ( rc == MDB_NOTFOUND ) {
154 /* Looking for root entry on an empty-dn suffix? */
155 if ( !id && BER_BVISEMPTY( &op->o_bd->be_nsuffix[0] )) {
156 struct berval gluebv = BER_BVC("glue");
157 Entry *r = mdb_entry_alloc(op, 2, 4);
158 Attribute *a = r->e_attrs;
162 r->e_ocflags = SLAP_OC_GLUE|SLAP_OC__END;
164 a->a_flags = SLAP_ATTR_DONT_FREE_DATA | SLAP_ATTR_DONT_FREE_VALS;
165 a->a_desc = slap_schema.si_ad_objectClass;
166 a->a_nvals = a->a_vals;
173 a->a_flags = SLAP_ATTR_DONT_FREE_DATA | SLAP_ATTR_DONT_FREE_VALS;
174 a->a_desc = slap_schema.si_ad_structuralObjectClass;
176 a->a_nvals = a->a_vals;
185 /* stubs from missing parents - DB is actually invalid */
186 if ( rc == MDB_SUCCESS && !data.mv_size )
190 rc = mdb_entry_decode( op, mdb_cursor_txn( mc ), &data, e );
194 (*e)->e_name.bv_val = NULL;
195 (*e)->e_nname.bv_val = NULL;
200 int mdb_id2entry_delete(
205 struct mdb_info *mdb = (struct mdb_info *) be->be_private;
206 MDB_dbi dbi = mdb->mi_id2entry;
210 key.mv_data = &e->e_id;
211 key.mv_size = sizeof(ID);
213 /* delete from database */
214 rc = mdb_del( tid, dbi, &key, NULL );
219 static Entry * mdb_entry_alloc(
224 Entry *e = op->o_tmpalloc( sizeof(Entry) +
225 nattrs * sizeof(Attribute) +
226 nvals * sizeof(struct berval), op->o_tmpmemctx );
227 BER_BVZERO(&e->e_bv);
230 e->e_attrs = (Attribute *)(e+1);
231 e->e_attrs->a_vals = (struct berval *)(e->e_attrs+nattrs);
239 int mdb_entry_return(
246 if ( e->e_private ) {
248 op->o_tmpfree( e->e_nname.bv_val, op->o_tmpmemctx );
249 op->o_tmpfree( e->e_name.bv_val, op->o_tmpmemctx );
250 op->o_tmpfree( e, op->o_tmpmemctx );
252 ch_free( e->e_nname.bv_val );
253 ch_free( e->e_name.bv_val );
262 int mdb_entry_release(
267 struct mdb_info *mdb = (struct mdb_info *) op->o_bd->be_private;
268 struct mdb_op_info *moi = NULL;
270 /* slapMode : SLAP_SERVER_MODE, SLAP_TOOL_MODE,
271 SLAP_TRUNCATE_MODE, SLAP_UNDEFINED_MODE */
274 if ( slapMode & SLAP_SERVER_MODE ) {
276 LDAP_SLIST_FOREACH( oex, &op->o_extra, oe_next ) {
278 if ( oex->oe_key == mdb ) {
279 mdb_entry_return( op, e );
280 moi = (mdb_op_info *)oex;
281 /* If it was setup by entry_get we should probably free it */
282 if ( moi->moi_flag & MOI_FREEIT ) {
284 if ( moi->moi_ref < 1 ) {
285 mdb_txn_reset( moi->moi_txn );
287 LDAP_SLIST_REMOVE( &op->o_extra, &moi->moi_oe, OpExtra, oe_next );
288 op->o_tmpfree( moi, op->o_tmpmemctx );
297 mdb_entry_return( op, e );
302 /* return LDAP_SUCCESS IFF we can retrieve the specified entry.
308 AttributeDescription *at,
312 struct mdb_info *mdb = (struct mdb_info *) op->o_bd->be_private;
313 struct mdb_op_info *moi = NULL;
317 const char *at_name = at ? at->ad_cname.bv_val : "(null)";
319 Debug( LDAP_DEBUG_ARGS,
320 "=> mdb_entry_get: ndn: \"%s\"\n", ndn->bv_val, 0, 0 );
321 Debug( LDAP_DEBUG_ARGS,
322 "=> mdb_entry_get: oc: \"%s\", at: \"%s\"\n",
323 oc ? oc->soc_cname.bv_val : "(null)", at_name, 0);
325 rc = mdb_opinfo_get( op, mdb, rw == 0, &moi );
330 /* can we find entry */
331 rc = mdb_dn2entry( op, txn, NULL, ndn, &e, NULL, 0 );
337 return (rc != LDAP_BUSY) ? LDAP_OTHER : LDAP_BUSY;
340 Debug( LDAP_DEBUG_ACL,
341 "=> mdb_entry_get: cannot find entry: \"%s\"\n",
343 rc = LDAP_NO_SUCH_OBJECT;
347 Debug( LDAP_DEBUG_ACL,
348 "=> mdb_entry_get: found entry: \"%s\"\n",
351 if ( oc && !is_entry_objectclass( e, oc, 0 )) {
352 Debug( LDAP_DEBUG_ACL,
353 "<= mdb_entry_get: failed to find objectClass %s\n",
354 oc->soc_cname.bv_val, 0, 0 );
355 rc = LDAP_NO_SUCH_ATTRIBUTE;
359 /* NOTE: attr_find() or attrs_find()? */
360 if ( at && attr_find( e->e_attrs, at ) == NULL ) {
361 Debug( LDAP_DEBUG_ACL,
362 "<= mdb_entry_get: failed to find attribute %s\n",
363 at->ad_cname.bv_val, 0, 0 );
364 rc = LDAP_NO_SUCH_ATTRIBUTE;
369 if( rc != LDAP_SUCCESS ) {
371 mdb_entry_release( op, e, rw );
376 Debug( LDAP_DEBUG_TRACE,
377 "mdb_entry_get: rc=%d\n",
383 mdb_reader_free( void *key, void *data )
387 if ( txn ) mdb_txn_abort( txn );
390 /* free up any keys used by the main thread */
392 mdb_reader_flush( MDB_env *env )
395 void *ctx = ldap_pvt_thread_pool_context();
397 if ( !ldap_pvt_thread_pool_getkey( ctx, env, &data, NULL ) ) {
398 ldap_pvt_thread_pool_setkey( ctx, env, NULL, 0, NULL, NULL );
399 mdb_reader_free( env, data );
403 extern MDB_txn *mdb_tool_txn;
406 mdb_opinfo_get( Operation *op, struct mdb_info *mdb, int rdonly, mdb_op_info **moip )
411 mdb_op_info *moi = NULL;
414 assert( op != NULL );
416 if ( !mdb || !moip ) return -1;
418 /* If no op was provided, try to find the ctx anyway... */
420 ctx = op->o_threadctx;
422 ctx = ldap_pvt_thread_pool_context();
426 LDAP_SLIST_FOREACH( oex, &op->o_extra, oe_next ) {
427 if ( oex->oe_key == mdb ) break;
429 moi = (mdb_op_info *)oex;
437 moi = op->o_tmpalloc(sizeof(struct mdb_op_info),op->o_tmpmemctx);
439 moi = ch_malloc(sizeof(mdb_op_info));
441 moi->moi_flag = MOI_FREEIT;
444 LDAP_SLIST_INSERT_HEAD( &op->o_extra, &moi->moi_oe, oe_next );
445 moi->moi_oe.oe_key = mdb;
451 /* This op started as a reader, but now wants to write. */
452 if ( moi->moi_flag & MOI_READER ) {
454 LDAP_SLIST_INSERT_HEAD( &op->o_extra, &moi->moi_oe, oe_next );
456 /* This op is continuing an existing write txn */
460 if ( !moi->moi_txn ) {
461 if (( slapMode & SLAP_TOOL_MODE ) && mdb_tool_txn ) {
462 moi->moi_txn = mdb_tool_txn;
464 rc = mdb_txn_begin( mdb->mi_dbenv, NULL, 0, &moi->moi_txn );
466 Debug( LDAP_DEBUG_ANY, "mdb_opinfo_get: err %s(%d)\n",
467 mdb_strerror(rc), rc, 0 );
475 /* OK, this is a reader */
476 if ( !moi->moi_txn ) {
477 if (( slapMode & SLAP_TOOL_MODE ) && mdb_tool_txn ) {
478 moi->moi_txn = mdb_tool_txn;
482 /* Shouldn't happen unless we're single-threaded */
483 rc = mdb_txn_begin( mdb->mi_dbenv, NULL, MDB_RDONLY, &moi->moi_txn );
485 Debug( LDAP_DEBUG_ANY, "mdb_opinfo_get: err %s(%d)\n",
486 mdb_strerror(rc), rc, 0 );
490 if ( ldap_pvt_thread_pool_getkey( ctx, mdb->mi_dbenv, &data, NULL ) ) {
491 rc = mdb_txn_begin( mdb->mi_dbenv, NULL, MDB_RDONLY, &moi->moi_txn );
493 Debug( LDAP_DEBUG_ANY, "mdb_opinfo_get: err %s(%d)\n",
494 mdb_strerror(rc), rc, 0 );
498 if ( ( rc = ldap_pvt_thread_pool_setkey( ctx, mdb->mi_dbenv,
499 data, mdb_reader_free, NULL, NULL ) ) ) {
500 mdb_txn_abort( moi->moi_txn );
502 Debug( LDAP_DEBUG_ANY, "mdb_opinfo_get: thread_pool_setkey failed err (%d)\n",
510 moi->moi_flag |= MOI_READER;
513 if ( moi->moi_ref < 1 ) {
517 rc = mdb_txn_renew( moi->moi_txn );
527 /* Count up the sizes of the components of an entry */
528 static int mdb_entry_partsize(struct mdb_info *mdb, MDB_txn *txn, Entry *e,
532 int i, nat = 0, nval = 0, nnval = 0;
535 len = 4*sizeof(int); /* nattrs, nvals, ocflags, offset */
536 for (a=e->e_attrs; a; a=a->a_next) {
537 /* For AttributeDesc, we only store the attr index */
539 if (a->a_desc->ad_index >= MDB_MAXADS) {
540 Debug( LDAP_DEBUG_ANY, "mdb_entry_partsize: too many AttributeDescriptions used\n",
544 if (!mdb->mi_adxs[a->a_desc->ad_index]) {
545 int rc = mdb_ad_get(mdb, txn, a->a_desc);
549 len += 2*sizeof(int); /* AD index, numvals */
550 nval += a->a_numvals + 1; /* empty berval at end */
551 for (i=0; i<a->a_numvals; i++) {
552 len += a->a_vals[i].bv_len + 1 + sizeof(int); /* len */
554 if (a->a_nvals != a->a_vals) {
555 nval += a->a_numvals + 1;
557 for (i=0; i<a->a_numvals; i++) {
558 len += a->a_nvals[i].bv_len + 1 + sizeof(int);;
563 len = (len + sizeof(ID)-1) & ~(sizeof(ID)-1);
567 eh->offset = nat + nval - nnval;
571 #define HIGH_BIT (1<<(sizeof(unsigned int)*CHAR_BIT-1))
573 /* Flatten an Entry into a buffer. The buffer starts with the count of the
574 * number of attributes in the entry, the total number of values in the
575 * entry, and the e_ocflags. It then contains a list of integers for each
576 * attribute. For each attribute the first integer gives the index of the
577 * matching AttributeDescription, followed by the number of values in the
578 * attribute. If the high bit of the attr index is set, the attribute's
579 * values are already sorted.
580 * If the high bit of numvals is set, the attribute also has normalized
581 * values present. (Note - a_numvals is an unsigned int, so this means
582 * it's possible to receive an attribute that we can't encode due to size
583 * overflow. In practice, this should not be an issue.) Then the length
584 * of each value is listed. If there are normalized values, their lengths
585 * come next. This continues for each attribute. After all of the lengths
586 * for the last attribute, the actual values are copied, with a NUL
587 * terminator after each value. The buffer is padded to the sizeof(ID).
588 * The entire buffer size is precomputed so that a single malloc can be
591 static int mdb_entry_encode(Operation *op, Entry *e, MDB_val *data, Ecount *eh)
593 struct mdb_info *mdb = (struct mdb_info *) op->o_bd->be_private;
599 Debug( LDAP_DEBUG_TRACE, "=> mdb_entry_encode(0x%08lx): %s\n",
600 (long) e->e_id, e->e_dn, 0 );
602 /* make sure e->e_ocflags is set */
603 if (is_entry_referral(e))
606 lp = (unsigned int *)data->mv_data;
609 *lp++ = (unsigned int)e->e_ocflags;
611 ptr = (unsigned char *)(lp + eh->offset);
613 for (a=e->e_attrs; a; a=a->a_next) {
614 if (!a->a_desc->ad_index)
615 return LDAP_UNDEFINED_TYPE;
616 l = mdb->mi_adxs[a->a_desc->ad_index];
617 if (a->a_flags & SLAP_ATTR_SORTED_VALS)
621 if (a->a_nvals != a->a_vals)
625 for (i=0; a->a_vals[i].bv_val; i++);
626 assert( i == a->a_numvals );
627 for (i=0; i<a->a_numvals; i++) {
628 *lp++ = a->a_vals[i].bv_len;
629 memcpy(ptr, a->a_vals[i].bv_val,
630 a->a_vals[i].bv_len);
631 ptr += a->a_vals[i].bv_len;
634 if (a->a_nvals != a->a_vals) {
635 for (i=0; i<a->a_numvals; i++) {
636 *lp++ = a->a_nvals[i].bv_len;
637 memcpy(ptr, a->a_nvals[i].bv_val,
638 a->a_nvals[i].bv_len);
639 ptr += a->a_nvals[i].bv_len;
646 Debug( LDAP_DEBUG_TRACE, "<= mdb_entry_encode(0x%08lx): %s\n",
647 (long) e->e_id, e->e_dn, 0 );
652 /* Retrieve an Entry that was stored using entry_encode above.
654 * Note: everything is stored in a single contiguous block, so
655 * you can not free individual attributes or names from this
656 * structure. Attempting to do so will likely corrupt memory.
659 int mdb_entry_decode(Operation *op, MDB_txn *txn, MDB_val *data, Entry **e)
661 struct mdb_info *mdb = (struct mdb_info *) op->o_bd->be_private;
662 int i, j, nattrs, nvals;
667 unsigned int *lp = (unsigned int *)data->mv_data;
671 Debug( LDAP_DEBUG_TRACE,
672 "=> mdb_entry_decode:\n",
677 x = mdb_entry_alloc(op, nattrs, nvals);
678 x->e_ocflags = *lp++;
685 ptr = (unsigned char *)(lp + i);
687 for (;nattrs>0; nattrs--) {
689 a->a_flags = SLAP_ATTR_DONT_FREE_DATA | SLAP_ATTR_DONT_FREE_VALS;
693 a->a_flags |= SLAP_ATTR_SORTED_VALS;
695 if (i > mdb->mi_numads) {
696 rc = mdb_ad_read(mdb, txn);
699 if (i > mdb->mi_numads) {
700 Debug( LDAP_DEBUG_ANY,
701 "mdb_entry_decode: attribute index %d not recognized\n",
706 a->a_desc = mdb->mi_ads[i];
707 a->a_numvals = *lp++;
708 if (a->a_numvals & HIGH_BIT) {
709 a->a_numvals ^= HIGH_BIT;
713 for (i=0; i<a->a_numvals; i++) {
714 bptr->bv_len = *lp++;;
715 bptr->bv_val = (char *)ptr;
716 ptr += bptr->bv_len+1;
725 for (i=0; i<a->a_numvals; i++) {
726 bptr->bv_len = *lp++;
727 bptr->bv_val = (char *)ptr;
728 ptr += bptr->bv_len+1;
735 a->a_nvals = a->a_vals;
737 /* FIXME: This is redundant once a sorted entry is saved into the DB */
738 if (( a->a_desc->ad_type->sat_flags & SLAP_AT_SORTED_VAL )
739 && !(a->a_flags & SLAP_ATTR_SORTED_VALS)) {
740 rc = slap_sort_vals( (Modifications *)a, &text, &j, NULL );
741 if ( rc == LDAP_SUCCESS ) {
742 a->a_flags |= SLAP_ATTR_SORTED_VALS;
743 } else if ( rc == LDAP_TYPE_OR_VALUE_EXISTS ) {
744 /* should never happen */
745 Debug( LDAP_DEBUG_ANY,
746 "mdb_entry_decode: attributeType %s value #%d provided more than once\n",
747 a->a_desc->ad_cname.bv_val, j, 0 );
757 Debug(LDAP_DEBUG_TRACE, "<= mdb_entry_decode\n",