1/* id2entry.c - routines to deal with the id2entry database */
2/* $OpenLDAP$ */
3/* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 *
5 * Copyright 2000-2011 The OpenLDAP Foundation.
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted only as authorized by the OpenLDAP
10 * Public License.
11 *
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>.
15 */
16
17#include "portable.h"
18
19#include <stdio.h>
20#include <ac/string.h>
21#include <ac/errno.h>
22
23#include "back-bdb.h"
24
25static int bdb_id2entry_put(
26	BackendDB *be,
27	DB_TXN *tid,
28	Entry *e,
29	int flag )
30{
31	struct bdb_info *bdb = (struct bdb_info *) be->be_private;
32	DB *db = bdb->bi_id2entry->bdi_db;
33	DBT key, data;
34	struct berval bv;
35	int rc;
36	ID nid;
37#ifdef BDB_HIER
38	struct berval odn, ondn;
39
40	/* We only store rdns, and they go in the dn2id database. */
41
42	odn = e->e_name; ondn = e->e_nname;
43
44	e->e_name = slap_empty_bv;
45	e->e_nname = slap_empty_bv;
46#endif
47	DBTzero( &key );
48
49	/* Store ID in BigEndian format */
50	key.data = &nid;
51	key.size = sizeof(ID);
52	BDB_ID2DISK( e->e_id, &nid );
53
54	rc = entry_encode( e, &bv );
55#ifdef BDB_HIER
56	e->e_name = odn; e->e_nname = ondn;
57#endif
58	if( rc != LDAP_SUCCESS ) {
59		return -1;
60	}
61
62	DBTzero( &data );
63	bv2DBT( &bv, &data );
64
65	rc = db->put( db, tid, &key, &data, flag );
66
67	free( bv.bv_val );
68	return rc;
69}
70
71/*
72 * This routine adds (or updates) an entry on disk.
73 * The cache should be already be updated.
74 */
75
76
77int bdb_id2entry_add(
78	BackendDB *be,
79	DB_TXN *tid,
80	Entry *e )
81{
82	return bdb_id2entry_put(be, tid, e, DB_NOOVERWRITE);
83}
84
85int bdb_id2entry_update(
86	BackendDB *be,
87	DB_TXN *tid,
88	Entry *e )
89{
90	return bdb_id2entry_put(be, tid, e, 0);
91}
92
93int bdb_id2entry(
94	BackendDB *be,
95	DB_TXN *tid,
96	ID id,
97	Entry **e )
98{
99	struct bdb_info *bdb = (struct bdb_info *) be->be_private;
100	DB *db = bdb->bi_id2entry->bdi_db;
101	DBT key, data;
102	DBC *cursor;
103	EntryHeader eh;
104	char buf[16];
105	int rc = 0, off;
106	ID nid;
107
108	*e = NULL;
109
110	DBTzero( &key );
111	key.data = &nid;
112	key.size = sizeof(ID);
113	BDB_ID2DISK( id, &nid );
114
115	DBTzero( &data );
116	data.flags = DB_DBT_USERMEM | DB_DBT_PARTIAL;
117
118	/* fetch it */
119	rc = db->cursor( db, tid, &cursor, bdb->bi_db_opflags );
120	if ( rc ) return rc;
121
122	/* Get the nattrs / nvals counts first */
123	data.ulen = data.dlen = sizeof(buf);
124	data.data = buf;
125	rc = cursor->c_get( cursor, &key, &data, DB_SET );
126	if ( rc ) goto finish;
127
128
129	eh.bv.bv_val = buf;
130	eh.bv.bv_len = data.size;
131	rc = entry_header( &eh );
132	if ( rc ) goto finish;
133
134	if ( eh.nvals ) {
135		/* Get the size */
136		data.flags ^= DB_DBT_PARTIAL;
137		data.ulen = 0;
138		rc = cursor->c_get( cursor, &key, &data, DB_CURRENT );
139		if ( rc != DB_BUFFER_SMALL ) goto finish;
140
141		/* Allocate a block and retrieve the data */
142		off = eh.data - eh.bv.bv_val;
143		eh.bv.bv_len = eh.nvals * sizeof( struct berval ) + data.size;
144		eh.bv.bv_val = ch_malloc( eh.bv.bv_len );
145		eh.data = eh.bv.bv_val + eh.nvals * sizeof( struct berval );
146		data.data = eh.data;
147		data.ulen = data.size;
148
149		/* skip past already parsed nattr/nvals */
150		eh.data += off;
151
152		rc = cursor->c_get( cursor, &key, &data, DB_CURRENT );
153	}
154
155finish:
156	cursor->c_close( cursor );
157
158	if( rc != 0 ) {
159		return rc;
160	}
161
162	if ( eh.nvals ) {
163#ifdef SLAP_ZONE_ALLOC
164		rc = entry_decode(&eh, e, bdb->bi_cache.c_zctx);
165#else
166		rc = entry_decode(&eh, e);
167#endif
168	} else {
169		*e = entry_alloc();
170	}
171
172	if( rc == 0 ) {
173		(*e)->e_id = id;
174	} else {
175		/* only free on error. On success, the entry was
176		 * decoded in place.
177		 */
178#ifndef SLAP_ZONE_ALLOC
179		ch_free(eh.bv.bv_val);
180#endif
181	}
182#ifdef SLAP_ZONE_ALLOC
183	ch_free(eh.bv.bv_val);
184#endif
185
186	return rc;
187}
188
189int bdb_id2entry_delete(
190	BackendDB *be,
191	DB_TXN *tid,
192	Entry *e )
193{
194	struct bdb_info *bdb = (struct bdb_info *) be->be_private;
195	DB *db = bdb->bi_id2entry->bdi_db;
196	DBT key;
197	int rc;
198	ID nid;
199
200	DBTzero( &key );
201	key.data = &nid;
202	key.size = sizeof(ID);
203	BDB_ID2DISK( e->e_id, &nid );
204
205	/* delete from database */
206	rc = db->del( db, tid, &key, 0 );
207
208	return rc;
209}
210
211int bdb_entry_return(
212	Entry *e
213)
214{
215	/* Our entries are allocated in two blocks; the data comes from
216	 * the db itself and the Entry structure and associated pointers
217	 * are allocated in entry_decode. The db data pointer is saved
218	 * in e_bv.
219	 */
220	if ( e->e_bv.bv_val ) {
221		/* See if the DNs were changed by modrdn */
222		if( e->e_nname.bv_val < e->e_bv.bv_val || e->e_nname.bv_val >
223			e->e_bv.bv_val + e->e_bv.bv_len ) {
224			ch_free(e->e_name.bv_val);
225			ch_free(e->e_nname.bv_val);
226		}
227		e->e_name.bv_val = NULL;
228		e->e_nname.bv_val = NULL;
229		/* In tool mode the e_bv buffer is realloc'd, leave it alone */
230		if( !(slapMode & SLAP_TOOL_MODE) ) {
231			free( e->e_bv.bv_val );
232		}
233		BER_BVZERO( &e->e_bv );
234	}
235	entry_free( e );
236	return 0;
237}
238
239int bdb_entry_release(
240	Operation *op,
241	Entry *e,
242	int rw )
243{
244	struct bdb_info *bdb = (struct bdb_info *) op->o_bd->be_private;
245	struct bdb_op_info *boi;
246	OpExtra *oex;
247
248	/* slapMode : SLAP_SERVER_MODE, SLAP_TOOL_MODE,
249			SLAP_TRUNCATE_MODE, SLAP_UNDEFINED_MODE */
250
251	if ( slapMode == SLAP_SERVER_MODE ) {
252		/* If not in our cache, just free it */
253		if ( !e->e_private ) {
254#ifdef SLAP_ZONE_ALLOC
255			return bdb_entry_return( bdb, e, -1 );
256#else
257			return bdb_entry_return( e );
258#endif
259		}
260		/* free entry and reader or writer lock */
261		LDAP_SLIST_FOREACH( oex, &op->o_extra, oe_next ) {
262			if ( oex->oe_key == bdb ) break;
263		}
264		boi = (struct bdb_op_info *)oex;
265
266		/* lock is freed with txn */
267		if ( !boi || boi->boi_txn ) {
268			bdb_unlocked_cache_return_entry_rw( bdb, e, rw );
269		} else {
270			struct bdb_lock_info *bli, *prev;
271			for ( prev=(struct bdb_lock_info *)&boi->boi_locks,
272				bli = boi->boi_locks; bli; prev=bli, bli=bli->bli_next ) {
273				if ( bli->bli_id == e->e_id ) {
274					bdb_cache_return_entry_rw( bdb, e, rw, &bli->bli_lock );
275					prev->bli_next = bli->bli_next;
276					/* Cleanup, or let caller know we unlocked */
277					if ( bli->bli_flag & BLI_DONTFREE )
278						bli->bli_flag = 0;
279					else
280						op->o_tmpfree( bli, op->o_tmpmemctx );
281					break;
282				}
283			}
284			if ( !boi->boi_locks ) {
285				LDAP_SLIST_REMOVE( &op->o_extra, &boi->boi_oe, OpExtra, oe_next );
286				if ( !(boi->boi_flag & BOI_DONTFREE))
287					op->o_tmpfree( boi, op->o_tmpmemctx );
288			}
289		}
290	} else {
291#ifdef SLAP_ZONE_ALLOC
292		int zseq = -1;
293		if (e->e_private != NULL) {
294			BEI(e)->bei_e = NULL;
295			zseq = BEI(e)->bei_zseq;
296		}
297#else
298		if (e->e_private != NULL)
299			BEI(e)->bei_e = NULL;
300#endif
301		e->e_private = NULL;
302#ifdef SLAP_ZONE_ALLOC
303		bdb_entry_return ( bdb, e, zseq );
304#else
305		bdb_entry_return ( e );
306#endif
307	}
308
309	return 0;
310}
311
312/* return LDAP_SUCCESS IFF we can retrieve the specified entry.
313 */
314int bdb_entry_get(
315	Operation *op,
316	struct berval *ndn,
317	ObjectClass *oc,
318	AttributeDescription *at,
319	int rw,
320	Entry **ent )
321{
322	struct bdb_info *bdb = (struct bdb_info *) op->o_bd->be_private;
323	struct bdb_op_info *boi = NULL;
324	DB_TXN *txn = NULL;
325	Entry *e = NULL;
326	EntryInfo *ei;
327	int	rc;
328	const char *at_name = at ? at->ad_cname.bv_val : "(null)";
329
330	DB_LOCK		lock;
331
332	Debug( LDAP_DEBUG_ARGS,
333		"=> bdb_entry_get: ndn: \"%s\"\n", ndn->bv_val, 0, 0 );
334	Debug( LDAP_DEBUG_ARGS,
335		"=> bdb_entry_get: oc: \"%s\", at: \"%s\"\n",
336		oc ? oc->soc_cname.bv_val : "(null)", at_name, 0);
337
338	if( op ) {
339		OpExtra *oex;
340		LDAP_SLIST_FOREACH( oex, &op->o_extra, oe_next ) {
341			if ( oex->oe_key == bdb ) break;
342		}
343		boi = (struct bdb_op_info *)oex;
344		if ( boi )
345			txn = boi->boi_txn;
346	}
347
348	if ( !txn ) {
349		rc = bdb_reader_get( op, bdb->bi_dbenv, &txn );
350		switch(rc) {
351		case 0:
352			break;
353		default:
354			return LDAP_OTHER;
355		}
356	}
357
358dn2entry_retry:
359	/* can we find entry */
360	rc = bdb_dn2entry( op, txn, ndn, &ei, 0, &lock );
361	switch( rc ) {
362	case DB_NOTFOUND:
363	case 0:
364		break;
365	case DB_LOCK_DEADLOCK:
366	case DB_LOCK_NOTGRANTED:
367		/* the txn must abort and retry */
368		if ( txn ) {
369			if ( boi ) boi->boi_err = rc;
370			return LDAP_BUSY;
371		}
372		ldap_pvt_thread_yield();
373		goto dn2entry_retry;
374	default:
375		if ( boi ) boi->boi_err = rc;
376		return (rc != LDAP_BUSY) ? LDAP_OTHER : LDAP_BUSY;
377	}
378	if (ei) e = ei->bei_e;
379	if (e == NULL) {
380		Debug( LDAP_DEBUG_ACL,
381			"=> bdb_entry_get: cannot find entry: \"%s\"\n",
382				ndn->bv_val, 0, 0 );
383		return LDAP_NO_SUCH_OBJECT;
384	}
385
386	Debug( LDAP_DEBUG_ACL,
387		"=> bdb_entry_get: found entry: \"%s\"\n",
388		ndn->bv_val, 0, 0 );
389
390	if ( oc && !is_entry_objectclass( e, oc, 0 )) {
391		Debug( LDAP_DEBUG_ACL,
392			"<= bdb_entry_get: failed to find objectClass %s\n",
393			oc->soc_cname.bv_val, 0, 0 );
394		rc = LDAP_NO_SUCH_ATTRIBUTE;
395		goto return_results;
396	}
397
398	/* NOTE: attr_find() or attrs_find()? */
399	if ( at && attr_find( e->e_attrs, at ) == NULL ) {
400		Debug( LDAP_DEBUG_ACL,
401			"<= bdb_entry_get: failed to find attribute %s\n",
402			at->ad_cname.bv_val, 0, 0 );
403		rc = LDAP_NO_SUCH_ATTRIBUTE;
404		goto return_results;
405	}
406
407return_results:
408	if( rc != LDAP_SUCCESS ) {
409		/* free entry */
410		bdb_cache_return_entry_rw(bdb, e, rw, &lock);
411
412	} else {
413		if ( slapMode == SLAP_SERVER_MODE ) {
414			*ent = e;
415			/* big drag. we need a place to store a read lock so we can
416			 * release it later?? If we're in a txn, nothing is needed
417			 * here because the locks will go away with the txn.
418			 */
419			if ( op ) {
420				if ( !boi ) {
421					boi = op->o_tmpcalloc(1,sizeof(struct bdb_op_info),op->o_tmpmemctx);
422					boi->boi_oe.oe_key = bdb;
423					LDAP_SLIST_INSERT_HEAD( &op->o_extra, &boi->boi_oe, oe_next );
424				}
425				if ( !boi->boi_txn ) {
426					struct bdb_lock_info *bli;
427					bli = op->o_tmpalloc( sizeof(struct bdb_lock_info),
428						op->o_tmpmemctx );
429					bli->bli_next = boi->boi_locks;
430					bli->bli_id = e->e_id;
431					bli->bli_flag = 0;
432					bli->bli_lock = lock;
433					boi->boi_locks = bli;
434				}
435			}
436		} else {
437			*ent = entry_dup( e );
438			bdb_cache_return_entry_rw(bdb, e, rw, &lock);
439		}
440	}
441
442	Debug( LDAP_DEBUG_TRACE,
443		"bdb_entry_get: rc=%d\n",
444		rc, 0, 0 );
445	return(rc);
446}
447