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-2012 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);
126 key.mv_size = sizeof(ID);
129 return mdb_cursor_get( mc, &key, data, MDB_SET );
138 struct mdb_info *mdb = (struct mdb_info *) op->o_bd->be_private;
145 key.mv_size = sizeof(ID);
148 rc = mdb_cursor_get( mc, &key, &data, MDB_SET );
149 if ( rc == MDB_NOTFOUND ) {
150 /* Looking for root entry on an empty-dn suffix? */
151 if ( !id && BER_BVISEMPTY( &op->o_bd->be_nsuffix[0] )) {
152 struct berval gluebv = BER_BVC("glue");
153 Entry *r = mdb_entry_alloc(op, 2, 4);
154 Attribute *a = r->e_attrs;
158 r->e_ocflags = SLAP_OC_GLUE|SLAP_OC__END;
160 a->a_flags = SLAP_ATTR_DONT_FREE_DATA | SLAP_ATTR_DONT_FREE_VALS;
161 a->a_desc = slap_schema.si_ad_objectClass;
162 a->a_nvals = a->a_vals;
169 a->a_flags = SLAP_ATTR_DONT_FREE_DATA | SLAP_ATTR_DONT_FREE_VALS;
170 a->a_desc = slap_schema.si_ad_structuralObjectClass;
172 a->a_nvals = a->a_vals;
183 rc = mdb_entry_decode( op, &data, e );
187 (*e)->e_name.bv_val = NULL;
188 (*e)->e_nname.bv_val = NULL;
193 int mdb_id2entry_delete(
198 struct mdb_info *mdb = (struct mdb_info *) be->be_private;
199 MDB_dbi dbi = mdb->mi_id2entry;
203 key.mv_data = &e->e_id;
204 key.mv_size = sizeof(ID);
206 /* delete from database */
207 rc = mdb_del( tid, dbi, &key, NULL );
212 static Entry * mdb_entry_alloc(
217 Entry *e = op->o_tmpalloc( sizeof(Entry) +
218 nattrs * sizeof(Attribute) +
219 nvals * sizeof(struct berval), op->o_tmpmemctx );
220 BER_BVZERO(&e->e_bv);
223 e->e_attrs = (Attribute *)(e+1);
224 e->e_attrs->a_vals = (struct berval *)(e->e_attrs+nattrs);
232 int mdb_entry_return(
237 if ( e->e_private ) {
239 op->o_tmpfree( e->e_nname.bv_val, op->o_tmpmemctx );
240 op->o_tmpfree( e->e_name.bv_val, op->o_tmpmemctx );
241 op->o_tmpfree( e, op->o_tmpmemctx );
243 ch_free( e->e_nname.bv_val );
244 ch_free( e->e_name.bv_val );
253 int mdb_entry_release(
258 struct mdb_info *mdb = (struct mdb_info *) op->o_bd->be_private;
259 struct mdb_op_info *moi = NULL;
262 /* slapMode : SLAP_SERVER_MODE, SLAP_TOOL_MODE,
263 SLAP_TRUNCATE_MODE, SLAP_UNDEFINED_MODE */
265 mdb_entry_return( op, e );
266 if ( slapMode == SLAP_SERVER_MODE ) {
268 LDAP_SLIST_FOREACH( oex, &op->o_extra, oe_next ) {
269 if ( oex->oe_key == mdb ) {
270 moi = (mdb_op_info *)oex;
271 /* If it was setup by entry_get we should probably free it */
272 if ( moi->moi_flag & MOI_FREEIT ) {
274 if ( moi->moi_ref < 1 ) {
275 mdb_txn_reset( moi->moi_txn );
277 LDAP_SLIST_REMOVE( &op->o_extra, &moi->moi_oe, OpExtra, oe_next );
278 op->o_tmpfree( moi, op->o_tmpmemctx );
289 /* return LDAP_SUCCESS IFF we can retrieve the specified entry.
295 AttributeDescription *at,
299 struct mdb_info *mdb = (struct mdb_info *) op->o_bd->be_private;
300 struct mdb_op_info *moi = NULL;
304 const char *at_name = at ? at->ad_cname.bv_val : "(null)";
306 Debug( LDAP_DEBUG_ARGS,
307 "=> mdb_entry_get: ndn: \"%s\"\n", ndn->bv_val, 0, 0 );
308 Debug( LDAP_DEBUG_ARGS,
309 "=> mdb_entry_get: oc: \"%s\", at: \"%s\"\n",
310 oc ? oc->soc_cname.bv_val : "(null)", at_name, 0);
312 rc = mdb_opinfo_get( op, mdb, rw == 0, &moi );
317 /* can we find entry */
318 rc = mdb_dn2entry( op, txn, NULL, ndn, &e, 0 );
324 return (rc != LDAP_BUSY) ? LDAP_OTHER : LDAP_BUSY;
327 Debug( LDAP_DEBUG_ACL,
328 "=> mdb_entry_get: cannot find entry: \"%s\"\n",
330 rc = LDAP_NO_SUCH_OBJECT;
334 Debug( LDAP_DEBUG_ACL,
335 "=> mdb_entry_get: found entry: \"%s\"\n",
338 if ( oc && !is_entry_objectclass( e, oc, 0 )) {
339 Debug( LDAP_DEBUG_ACL,
340 "<= mdb_entry_get: failed to find objectClass %s\n",
341 oc->soc_cname.bv_val, 0, 0 );
342 rc = LDAP_NO_SUCH_ATTRIBUTE;
346 /* NOTE: attr_find() or attrs_find()? */
347 if ( at && attr_find( e->e_attrs, at ) == NULL ) {
348 Debug( LDAP_DEBUG_ACL,
349 "<= mdb_entry_get: failed to find attribute %s\n",
350 at->ad_cname.bv_val, 0, 0 );
351 rc = LDAP_NO_SUCH_ATTRIBUTE;
356 if( rc != LDAP_SUCCESS ) {
359 mdb_entry_return( op, e );
361 if (moi->moi_ref == 1) {
362 LDAP_SLIST_REMOVE( &op->o_extra, &moi->moi_oe, OpExtra, oe_next );
363 mdb_txn_reset( txn );
364 op->o_tmpfree( moi, op->o_tmpmemctx );
370 Debug( LDAP_DEBUG_TRACE,
371 "mdb_entry_get: rc=%d\n",
377 mdb_reader_free( void *key, void *data )
381 if ( txn ) mdb_txn_abort( txn );
384 /* free up any keys used by the main thread */
386 mdb_reader_flush( MDB_env *env )
389 void *ctx = ldap_pvt_thread_pool_context();
391 if ( !ldap_pvt_thread_pool_getkey( ctx, env, &data, NULL ) ) {
392 ldap_pvt_thread_pool_setkey( ctx, env, NULL, 0, NULL, NULL );
393 mdb_reader_free( env, data );
398 mdb_opinfo_get( Operation *op, struct mdb_info *mdb, int rdonly, mdb_op_info **moip )
403 mdb_op_info *moi = NULL;
406 assert( op != NULL );
408 if ( !mdb || !moip ) return -1;
410 /* If no op was provided, try to find the ctx anyway... */
412 ctx = op->o_threadctx;
414 ctx = ldap_pvt_thread_pool_context();
418 LDAP_SLIST_FOREACH( oex, &op->o_extra, oe_next ) {
419 if ( oex->oe_key == mdb ) break;
421 moi = (mdb_op_info *)oex;
429 moi = op->o_tmpalloc(sizeof(struct mdb_op_info),op->o_tmpmemctx);
431 moi = ch_malloc(sizeof(mdb_op_info));
433 moi->moi_flag = MOI_FREEIT;
436 LDAP_SLIST_INSERT_HEAD( &op->o_extra, &moi->moi_oe, oe_next );
437 moi->moi_oe.oe_key = mdb;
443 /* This op started as a reader, but now wants to write. */
444 if ( moi->moi_flag & MOI_READER ) {
446 LDAP_SLIST_INSERT_HEAD( &op->o_extra, &moi->moi_oe, oe_next );
448 /* This op is continuing an existing write txn */
452 if ( !moi->moi_txn ) {
453 rc = mdb_txn_begin( mdb->mi_dbenv, NULL, 0, &moi->moi_txn );
455 Debug( LDAP_DEBUG_ANY, "mdb_opinfo_get: err %s(%d)\n",
456 mdb_strerror(rc), rc, 0 );
463 /* OK, this is a reader */
464 if ( !moi->moi_txn ) {
466 /* Shouldn't happen unless we're single-threaded */
467 rc = mdb_txn_begin( mdb->mi_dbenv, NULL, MDB_RDONLY, &moi->moi_txn );
469 Debug( LDAP_DEBUG_ANY, "mdb_opinfo_get: err %s(%d)\n",
470 mdb_strerror(rc), rc, 0 );
474 if ( ldap_pvt_thread_pool_getkey( ctx, mdb->mi_dbenv, &data, NULL ) ) {
475 rc = mdb_txn_begin( mdb->mi_dbenv, NULL, MDB_RDONLY, &moi->moi_txn );
477 Debug( LDAP_DEBUG_ANY, "mdb_opinfo_get: err %s(%d)\n",
478 mdb_strerror(rc), rc, 0 );
482 if ( ( rc = ldap_pvt_thread_pool_setkey( ctx, mdb->mi_dbenv,
483 data, mdb_reader_free, NULL, NULL ) ) ) {
484 mdb_txn_abort( moi->moi_txn );
486 Debug( LDAP_DEBUG_ANY, "mdb_opinfo_get: thread_pool_setkey failed err (%d)\n",
494 moi->moi_flag |= MOI_READER;
496 if ( moi->moi_ref < 1 ) {
500 mdb_txn_renew( moi->moi_txn );
509 /* Count up the sizes of the components of an entry */
510 static int mdb_entry_partsize(struct mdb_info *mdb, MDB_txn *txn, Entry *e,
514 int i, nat = 0, nval = 0, nnval = 0;
517 len = 4*sizeof(int); /* nattrs, nvals, ocflags, offset */
518 for (a=e->e_attrs; a; a=a->a_next) {
519 /* For AttributeDesc, we only store the attr index */
521 if (a->a_desc->ad_index >= MDB_MAXADS) {
522 Debug( LDAP_DEBUG_ANY, "mdb_entry_partsize: too many AttributeDescriptions used\n",
526 if (!mdb->mi_adxs[a->a_desc->ad_index]) {
527 int rc = mdb_ad_get(mdb, txn, a->a_desc);
531 len += 2*sizeof(int); /* AD index, numvals */
532 nval += a->a_numvals + 1; /* empty berval at end */
533 for (i=0; i<a->a_numvals; i++) {
534 len += a->a_vals[i].bv_len + 1 + sizeof(int); /* len */
536 if (a->a_nvals != a->a_vals) {
537 nval += a->a_numvals + 1;
539 for (i=0; i<a->a_numvals; i++) {
540 len += a->a_nvals[i].bv_len + 1 + sizeof(int);;
545 len = (len + sizeof(ID)-1) & ~(sizeof(ID)-1);
549 eh->offset = nat + nval - nnval;
553 #define HIGH_BIT (1<<(sizeof(unsigned int)*CHAR_BIT-1))
555 /* Flatten an Entry into a buffer. The buffer starts with the count of the
556 * number of attributes in the entry, the total number of values in the
557 * entry, and the e_ocflags. It then contains a list of integers for each
558 * attribute. For each attribute the first integer gives the index of the
559 * matching AttributeDescription, followed by the number of values in the
560 * attribute. If the high bit is set, the attribute also has normalized
561 * values present. (Note - a_numvals is an unsigned int, so this means
562 * it's possible to receive an attribute that we can't encode due to size
563 * overflow. In practice, this should not be an issue.) Then the length
564 * of each value is listed. If there are normalized values, their lengths
565 * come next. This continues for each attribute. After all of the lengths
566 * for the last attribute, the actual values are copied, with a NUL
567 * terminator after each value. The buffer is padded to the sizeof(ID).
568 * The entire buffer size is precomputed so that a single malloc can be
571 static int mdb_entry_encode(Operation *op, Entry *e, MDB_val *data, Ecount *eh)
573 struct mdb_info *mdb = (struct mdb_info *) op->o_bd->be_private;
580 Debug( LDAP_DEBUG_TRACE, "=> mdb_entry_encode(0x%08lx): %s\n",
581 (long) e->e_id, e->e_dn, 0 );
583 /* make sure e->e_ocflags is set */
584 if (is_entry_referral(e))
587 lp = (unsigned int *)data->mv_data;
590 *lp++ = (unsigned int)e->e_ocflags;
592 ptr = (unsigned char *)(lp + eh->offset);
594 for (a=e->e_attrs; a; a=a->a_next) {
595 *lp++ = mdb->mi_adxs[a->a_desc->ad_index];
597 if (a->a_nvals != a->a_vals)
601 for (i=0; a->a_vals[i].bv_val; i++);
602 assert( i == a->a_numvals );
603 for (i=0; i<a->a_numvals; i++) {
604 *lp++ = a->a_vals[i].bv_len;
605 memcpy(ptr, a->a_vals[i].bv_val,
606 a->a_vals[i].bv_len);
607 ptr += a->a_vals[i].bv_len;
610 if (a->a_nvals != a->a_vals) {
611 for (i=0; i<a->a_numvals; i++) {
612 *lp++ = a->a_nvals[i].bv_len;
613 memcpy(ptr, a->a_nvals[i].bv_val,
614 a->a_nvals[i].bv_len);
615 ptr += a->a_nvals[i].bv_len;
622 Debug( LDAP_DEBUG_TRACE, "<= mdb_entry_encode(0x%08lx): %s\n",
623 (long) e->e_id, e->e_dn, 0 );
628 /* Retrieve an Entry that was stored using entry_encode above.
630 * Note: everything is stored in a single contiguous block, so
631 * you can not free individual attributes or names from this
632 * structure. Attempting to do so will likely corrupt memory.
635 int mdb_entry_decode(Operation *op, MDB_val *data, Entry **e)
637 struct mdb_info *mdb = (struct mdb_info *) op->o_bd->be_private;
638 int i, j, nattrs, nvals;
643 AttributeDescription *ad;
644 unsigned int *lp = (unsigned int *)data->mv_data;
648 Debug( LDAP_DEBUG_TRACE,
649 "=> mdb_entry_decode:\n",
654 x = mdb_entry_alloc(op, nattrs, nvals);
655 x->e_ocflags = *lp++;
662 ptr = (unsigned char *)(lp + i);
664 for (;nattrs>0; nattrs--) {
666 a->a_desc = mdb->mi_ads[*lp++];
667 a->a_flags = SLAP_ATTR_DONT_FREE_DATA | SLAP_ATTR_DONT_FREE_VALS;
668 a->a_numvals = *lp++;
669 if (a->a_numvals & HIGH_BIT) {
670 a->a_numvals ^= HIGH_BIT;
674 for (i=0; i<a->a_numvals; i++) {
675 bptr->bv_len = *lp++;;
676 bptr->bv_val = (char *)ptr;
677 ptr += bptr->bv_len+1;
686 for (i=0; i<a->a_numvals; i++) {
687 bptr->bv_len = *lp++;
688 bptr->bv_val = (char *)ptr;
689 ptr += bptr->bv_len+1;
696 a->a_nvals = a->a_vals;
698 /* FIXME: This is redundant once a sorted entry is saved into the DB */
699 if ( a->a_desc->ad_type->sat_flags & SLAP_AT_SORTED_VAL ) {
700 rc = slap_sort_vals( (Modifications *)a, &text, &j, NULL );
701 if ( rc == LDAP_SUCCESS ) {
702 a->a_flags |= SLAP_ATTR_SORTED_VALS;
703 } else if ( rc == LDAP_TYPE_OR_VALUE_EXISTS ) {
704 /* should never happen */
705 Debug( LDAP_DEBUG_ANY,
706 "mdb_entry_decode: attributeType %s value #%d provided more than once\n",
707 a->a_desc->ad_cname.bv_val, j, 0 );
717 Debug(LDAP_DEBUG_TRACE, "<= mdb_entry_decode\n",