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-2015 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 )
143 struct mdb_info *mdb = (struct mdb_info *) op->o_bd->be_private;
150 key.mv_size = sizeof(ID);
153 rc = mdb_cursor_get( mc, &key, &data, MDB_SET );
154 if ( rc == MDB_NOTFOUND ) {
155 /* Looking for root entry on an empty-dn suffix? */
156 if ( !id && BER_BVISEMPTY( &op->o_bd->be_nsuffix[0] )) {
157 struct berval gluebv = BER_BVC("glue");
158 Entry *r = mdb_entry_alloc(op, 2, 4);
159 Attribute *a = r->e_attrs;
163 r->e_ocflags = SLAP_OC_GLUE|SLAP_OC__END;
165 a->a_flags = SLAP_ATTR_DONT_FREE_DATA | SLAP_ATTR_DONT_FREE_VALS;
166 a->a_desc = slap_schema.si_ad_objectClass;
167 a->a_nvals = a->a_vals;
174 a->a_flags = SLAP_ATTR_DONT_FREE_DATA | SLAP_ATTR_DONT_FREE_VALS;
175 a->a_desc = slap_schema.si_ad_structuralObjectClass;
177 a->a_nvals = a->a_vals;
186 /* stubs from missing parents - DB is actually invalid */
187 if ( rc == MDB_SUCCESS && !data.mv_size )
191 rc = mdb_entry_decode( op, mdb_cursor_txn( mc ), &data, e );
195 (*e)->e_name.bv_val = NULL;
196 (*e)->e_nname.bv_val = NULL;
201 int mdb_id2entry_delete(
206 struct mdb_info *mdb = (struct mdb_info *) be->be_private;
207 MDB_dbi dbi = mdb->mi_id2entry;
211 key.mv_data = &e->e_id;
212 key.mv_size = sizeof(ID);
214 /* delete from database */
215 rc = mdb_del( tid, dbi, &key, NULL );
220 static Entry * mdb_entry_alloc(
225 Entry *e = op->o_tmpalloc( sizeof(Entry) +
226 nattrs * sizeof(Attribute) +
227 nvals * sizeof(struct berval), op->o_tmpmemctx );
228 BER_BVZERO(&e->e_bv);
231 e->e_attrs = (Attribute *)(e+1);
232 e->e_attrs->a_vals = (struct berval *)(e->e_attrs+nattrs);
240 int mdb_entry_return(
247 if ( e->e_private ) {
249 op->o_tmpfree( e->e_nname.bv_val, op->o_tmpmemctx );
250 op->o_tmpfree( e->e_name.bv_val, op->o_tmpmemctx );
251 op->o_tmpfree( e, op->o_tmpmemctx );
253 ch_free( e->e_nname.bv_val );
254 ch_free( e->e_name.bv_val );
263 int mdb_entry_release(
268 struct mdb_info *mdb = (struct mdb_info *) op->o_bd->be_private;
269 struct mdb_op_info *moi = NULL;
272 /* slapMode : SLAP_SERVER_MODE, SLAP_TOOL_MODE,
273 SLAP_TRUNCATE_MODE, SLAP_UNDEFINED_MODE */
276 if ( slapMode & SLAP_SERVER_MODE ) {
278 LDAP_SLIST_FOREACH( oex, &op->o_extra, oe_next ) {
280 if ( oex->oe_key == mdb ) {
281 mdb_entry_return( op, e );
282 moi = (mdb_op_info *)oex;
283 /* If it was setup by entry_get we should probably free it */
284 if ( moi->moi_flag & MOI_FREEIT ) {
286 if ( moi->moi_ref < 1 ) {
287 mdb_txn_reset( moi->moi_txn );
289 LDAP_SLIST_REMOVE( &op->o_extra, &moi->moi_oe, OpExtra, oe_next );
290 op->o_tmpfree( moi, op->o_tmpmemctx );
299 mdb_entry_return( op, e );
304 /* return LDAP_SUCCESS IFF we can retrieve the specified entry.
310 AttributeDescription *at,
314 struct mdb_info *mdb = (struct mdb_info *) op->o_bd->be_private;
315 struct mdb_op_info *moi = NULL;
319 const char *at_name = at ? at->ad_cname.bv_val : "(null)";
321 Debug( LDAP_DEBUG_ARGS,
322 "=> mdb_entry_get: ndn: \"%s\"\n", ndn->bv_val, 0, 0 );
323 Debug( LDAP_DEBUG_ARGS,
324 "=> mdb_entry_get: oc: \"%s\", at: \"%s\"\n",
325 oc ? oc->soc_cname.bv_val : "(null)", at_name, 0);
327 rc = mdb_opinfo_get( op, mdb, rw == 0, &moi );
332 /* can we find entry */
333 rc = mdb_dn2entry( op, txn, NULL, ndn, &e, NULL, 0 );
339 return (rc != LDAP_BUSY) ? LDAP_OTHER : LDAP_BUSY;
342 Debug( LDAP_DEBUG_ACL,
343 "=> mdb_entry_get: cannot find entry: \"%s\"\n",
345 rc = LDAP_NO_SUCH_OBJECT;
349 Debug( LDAP_DEBUG_ACL,
350 "=> mdb_entry_get: found entry: \"%s\"\n",
353 if ( oc && !is_entry_objectclass( e, oc, 0 )) {
354 Debug( LDAP_DEBUG_ACL,
355 "<= mdb_entry_get: failed to find objectClass %s\n",
356 oc->soc_cname.bv_val, 0, 0 );
357 rc = LDAP_NO_SUCH_ATTRIBUTE;
361 /* NOTE: attr_find() or attrs_find()? */
362 if ( at && attr_find( e->e_attrs, at ) == NULL ) {
363 Debug( LDAP_DEBUG_ACL,
364 "<= mdb_entry_get: failed to find attribute %s\n",
365 at->ad_cname.bv_val, 0, 0 );
366 rc = LDAP_NO_SUCH_ATTRIBUTE;
371 if( rc != LDAP_SUCCESS ) {
373 mdb_entry_release( op, e, rw );
378 Debug( LDAP_DEBUG_TRACE,
379 "mdb_entry_get: rc=%d\n",
385 mdb_reader_free( void *key, void *data )
389 if ( txn ) mdb_txn_abort( txn );
392 /* free up any keys used by the main thread */
394 mdb_reader_flush( MDB_env *env )
397 void *ctx = ldap_pvt_thread_pool_context();
399 if ( !ldap_pvt_thread_pool_getkey( ctx, env, &data, NULL ) ) {
400 ldap_pvt_thread_pool_setkey( ctx, env, NULL, 0, NULL, NULL );
401 mdb_reader_free( env, data );
405 extern MDB_txn *mdb_tool_txn;
408 mdb_opinfo_get( Operation *op, struct mdb_info *mdb, int rdonly, mdb_op_info **moip )
413 mdb_op_info *moi = NULL;
416 assert( op != NULL );
418 if ( !mdb || !moip ) return -1;
420 /* If no op was provided, try to find the ctx anyway... */
422 ctx = op->o_threadctx;
424 ctx = ldap_pvt_thread_pool_context();
428 LDAP_SLIST_FOREACH( oex, &op->o_extra, oe_next ) {
429 if ( oex->oe_key == mdb ) break;
431 moi = (mdb_op_info *)oex;
439 moi = op->o_tmpalloc(sizeof(struct mdb_op_info),op->o_tmpmemctx);
441 moi = ch_malloc(sizeof(mdb_op_info));
443 moi->moi_flag = MOI_FREEIT;
446 LDAP_SLIST_INSERT_HEAD( &op->o_extra, &moi->moi_oe, oe_next );
447 moi->moi_oe.oe_key = mdb;
453 /* This op started as a reader, but now wants to write. */
454 if ( moi->moi_flag & MOI_READER ) {
456 LDAP_SLIST_INSERT_HEAD( &op->o_extra, &moi->moi_oe, oe_next );
458 /* This op is continuing an existing write txn */
462 if ( !moi->moi_txn ) {
463 if (( slapMode & SLAP_TOOL_MODE ) && mdb_tool_txn ) {
464 moi->moi_txn = mdb_tool_txn;
466 rc = mdb_txn_begin( mdb->mi_dbenv, NULL, 0, &moi->moi_txn );
468 Debug( LDAP_DEBUG_ANY, "mdb_opinfo_get: err %s(%d)\n",
469 mdb_strerror(rc), rc, 0 );
477 /* OK, this is a reader */
478 if ( !moi->moi_txn ) {
479 if (( slapMode & SLAP_TOOL_MODE ) && mdb_tool_txn ) {
480 moi->moi_txn = mdb_tool_txn;
484 /* Shouldn't happen unless we're single-threaded */
485 rc = mdb_txn_begin( mdb->mi_dbenv, NULL, MDB_RDONLY, &moi->moi_txn );
487 Debug( LDAP_DEBUG_ANY, "mdb_opinfo_get: err %s(%d)\n",
488 mdb_strerror(rc), rc, 0 );
492 if ( ldap_pvt_thread_pool_getkey( ctx, mdb->mi_dbenv, &data, NULL ) ) {
493 rc = mdb_txn_begin( mdb->mi_dbenv, NULL, MDB_RDONLY, &moi->moi_txn );
495 Debug( LDAP_DEBUG_ANY, "mdb_opinfo_get: err %s(%d)\n",
496 mdb_strerror(rc), rc, 0 );
500 if ( ( rc = ldap_pvt_thread_pool_setkey( ctx, mdb->mi_dbenv,
501 data, mdb_reader_free, NULL, NULL ) ) ) {
502 mdb_txn_abort( moi->moi_txn );
504 Debug( LDAP_DEBUG_ANY, "mdb_opinfo_get: thread_pool_setkey failed err (%d)\n",
512 moi->moi_flag |= MOI_READER;
515 if ( moi->moi_ref < 1 ) {
519 rc = mdb_txn_renew( moi->moi_txn );
529 /* Count up the sizes of the components of an entry */
530 static int mdb_entry_partsize(struct mdb_info *mdb, MDB_txn *txn, Entry *e,
534 int i, nat = 0, nval = 0, nnval = 0;
537 len = 4*sizeof(int); /* nattrs, nvals, ocflags, offset */
538 for (a=e->e_attrs; a; a=a->a_next) {
539 /* For AttributeDesc, we only store the attr index */
541 if (a->a_desc->ad_index >= MDB_MAXADS) {
542 Debug( LDAP_DEBUG_ANY, "mdb_entry_partsize: too many AttributeDescriptions used\n",
546 if (!mdb->mi_adxs[a->a_desc->ad_index]) {
547 int rc = mdb_ad_get(mdb, txn, a->a_desc);
551 len += 2*sizeof(int); /* AD index, numvals */
552 nval += a->a_numvals + 1; /* empty berval at end */
553 for (i=0; i<a->a_numvals; i++) {
554 len += a->a_vals[i].bv_len + 1 + sizeof(int); /* len */
556 if (a->a_nvals != a->a_vals) {
557 nval += a->a_numvals + 1;
559 for (i=0; i<a->a_numvals; i++) {
560 len += a->a_nvals[i].bv_len + 1 + sizeof(int);;
565 len = (len + sizeof(ID)-1) & ~(sizeof(ID)-1);
569 eh->offset = nat + nval - nnval;
573 #define HIGH_BIT (1<<(sizeof(unsigned int)*CHAR_BIT-1))
575 /* Flatten an Entry into a buffer. The buffer starts with the count of the
576 * number of attributes in the entry, the total number of values in the
577 * entry, and the e_ocflags. It then contains a list of integers for each
578 * attribute. For each attribute the first integer gives the index of the
579 * matching AttributeDescription, followed by the number of values in the
580 * attribute. If the high bit of the attr index is set, the attribute's
581 * values are already sorted.
582 * If the high bit of numvals is set, the attribute also has normalized
583 * values present. (Note - a_numvals is an unsigned int, so this means
584 * it's possible to receive an attribute that we can't encode due to size
585 * overflow. In practice, this should not be an issue.) Then the length
586 * of each value is listed. If there are normalized values, their lengths
587 * come next. This continues for each attribute. After all of the lengths
588 * for the last attribute, the actual values are copied, with a NUL
589 * terminator after each value. The buffer is padded to the sizeof(ID).
590 * The entire buffer size is precomputed so that a single malloc can be
593 static int mdb_entry_encode(Operation *op, Entry *e, MDB_val *data, Ecount *eh)
595 struct mdb_info *mdb = (struct mdb_info *) op->o_bd->be_private;
602 Debug( LDAP_DEBUG_TRACE, "=> mdb_entry_encode(0x%08lx): %s\n",
603 (long) e->e_id, e->e_dn, 0 );
605 /* make sure e->e_ocflags is set */
606 if (is_entry_referral(e))
609 lp = (unsigned int *)data->mv_data;
612 *lp++ = (unsigned int)e->e_ocflags;
614 ptr = (unsigned char *)(lp + eh->offset);
616 for (a=e->e_attrs; a; a=a->a_next) {
617 if (!a->a_desc->ad_index)
618 return LDAP_UNDEFINED_TYPE;
619 l = mdb->mi_adxs[a->a_desc->ad_index];
620 if (a->a_flags & SLAP_ATTR_SORTED_VALS)
624 if (a->a_nvals != a->a_vals)
628 for (i=0; a->a_vals[i].bv_val; i++);
629 assert( i == a->a_numvals );
630 for (i=0; i<a->a_numvals; i++) {
631 *lp++ = a->a_vals[i].bv_len;
632 memcpy(ptr, a->a_vals[i].bv_val,
633 a->a_vals[i].bv_len);
634 ptr += a->a_vals[i].bv_len;
637 if (a->a_nvals != a->a_vals) {
638 for (i=0; i<a->a_numvals; i++) {
639 *lp++ = a->a_nvals[i].bv_len;
640 memcpy(ptr, a->a_nvals[i].bv_val,
641 a->a_nvals[i].bv_len);
642 ptr += a->a_nvals[i].bv_len;
649 Debug( LDAP_DEBUG_TRACE, "<= mdb_entry_encode(0x%08lx): %s\n",
650 (long) e->e_id, e->e_dn, 0 );
655 /* Retrieve an Entry that was stored using entry_encode above.
657 * Note: everything is stored in a single contiguous block, so
658 * you can not free individual attributes or names from this
659 * structure. Attempting to do so will likely corrupt memory.
662 int mdb_entry_decode(Operation *op, MDB_txn *txn, MDB_val *data, Entry **e)
664 struct mdb_info *mdb = (struct mdb_info *) op->o_bd->be_private;
665 int i, j, nattrs, nvals;
670 AttributeDescription *ad;
671 unsigned int *lp = (unsigned int *)data->mv_data;
675 Debug( LDAP_DEBUG_TRACE,
676 "=> mdb_entry_decode:\n",
681 x = mdb_entry_alloc(op, nattrs, nvals);
682 x->e_ocflags = *lp++;
689 ptr = (unsigned char *)(lp + i);
691 for (;nattrs>0; nattrs--) {
693 a->a_flags = SLAP_ATTR_DONT_FREE_DATA | SLAP_ATTR_DONT_FREE_VALS;
697 a->a_flags |= SLAP_ATTR_SORTED_VALS;
699 if (i > mdb->mi_numads) {
700 rc = mdb_ad_read(mdb, txn);
703 if (i > mdb->mi_numads) {
704 Debug( LDAP_DEBUG_ANY,
705 "mdb_entry_decode: attribute index %d not recognized\n",
710 a->a_desc = mdb->mi_ads[i];
711 a->a_numvals = *lp++;
712 if (a->a_numvals & HIGH_BIT) {
713 a->a_numvals ^= HIGH_BIT;
717 for (i=0; i<a->a_numvals; i++) {
718 bptr->bv_len = *lp++;;
719 bptr->bv_val = (char *)ptr;
720 ptr += bptr->bv_len+1;
729 for (i=0; i<a->a_numvals; i++) {
730 bptr->bv_len = *lp++;
731 bptr->bv_val = (char *)ptr;
732 ptr += bptr->bv_len+1;
739 a->a_nvals = a->a_vals;
741 /* FIXME: This is redundant once a sorted entry is saved into the DB */
742 if (( a->a_desc->ad_type->sat_flags & SLAP_AT_SORTED_VAL )
743 && !(a->a_flags & SLAP_ATTR_SORTED_VALS)) {
744 rc = slap_sort_vals( (Modifications *)a, &text, &j, NULL );
745 if ( rc == LDAP_SUCCESS ) {
746 a->a_flags |= SLAP_ATTR_SORTED_VALS;
747 } else if ( rc == LDAP_TYPE_OR_VALUE_EXISTS ) {
748 /* should never happen */
749 Debug( LDAP_DEBUG_ANY,
750 "mdb_entry_decode: attributeType %s value #%d provided more than once\n",
751 a->a_desc->ad_cname.bv_val, j, 0 );
761 Debug(LDAP_DEBUG_TRACE, "<= mdb_entry_decode\n",