1 /* cache.c - routines to maintain an in-core cache of entries */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 2001-2006 The OpenLDAP Foundation.
6 * Portions Copyright 2001-2003 Pierangelo Masarati.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted only as authorized by the OpenLDAP
13 * A copy of this license is available in file LICENSE in the
14 * top-level directory of the distribution or, alternatively, at
15 * <http://www.OpenLDAP.org/license.html>.
18 * This work was initially developed by Pierangelo Masarati for inclusion
19 * in OpenLDAP Software.
25 #include "ac/string.h"
29 #include "back-monitor.h"
32 * The cache maps DNs to Entries.
33 * Each entry, on turn, holds the list of its children in the e_private field.
34 * This is used by search operation to perform onelevel and subtree candidate
37 typedef struct monitor_cache_t {
43 * compares entries based on the dn
50 monitor_cache_t *cc1 = ( monitor_cache_t * )c1;
51 monitor_cache_t *cc2 = ( monitor_cache_t * )c2;
54 * case sensitive, because the dn MUST be normalized
56 return ber_bvcmp( &cc1->mc_ndn, &cc2->mc_ndn );
60 * checks for duplicate entries
67 monitor_cache_t *cc1 = ( monitor_cache_t * )c1;
68 monitor_cache_t *cc2 = ( monitor_cache_t * )c2;
71 * case sensitive, because the dn MUST be normalized
73 return ber_bvcmp( &cc1->mc_ndn, &cc2->mc_ndn ) == 0 ? -1 : 0;
77 * adds an entry to the cache and inits the mutex
91 mp = ( monitor_entry_t *)e->e_private;
92 ldap_pvt_thread_mutex_init( &mp->mp_mutex );
94 mc = ( monitor_cache_t * )ch_malloc( sizeof( monitor_cache_t ) );
95 mc->mc_ndn = e->e_nname;
97 ldap_pvt_thread_mutex_lock( &mi->mi_cache_mutex );
98 rc = avl_insert( &mi->mi_cache, ( caddr_t )mc,
99 monitor_cache_cmp, monitor_cache_dup );
100 ldap_pvt_thread_mutex_unlock( &mi->mi_cache_mutex );
106 * locks the entry (no r/w)
115 assert( e->e_private != NULL );
117 mp = ( monitor_entry_t * )e->e_private;
118 ldap_pvt_thread_mutex_lock( &mp->mp_mutex );
124 * gets an entry from the cache based on the normalized dn
133 monitor_cache_t tmp_mc, *mc;
135 assert( mi != NULL );
136 assert( ndn != NULL );
137 assert( ep != NULL );
141 tmp_mc.mc_ndn = *ndn;
142 ldap_pvt_thread_mutex_lock( &mi->mi_cache_mutex );
143 mc = ( monitor_cache_t * )avl_find( mi->mi_cache,
144 ( caddr_t )&tmp_mc, monitor_cache_cmp );
147 /* entry is returned with mutex locked */
148 monitor_cache_lock( mc->mc_e );
152 ldap_pvt_thread_mutex_unlock( &mi->mi_cache_mutex );
154 return ( *ep == NULL ? -1 : 0 );
158 * If the entry exists in cache, it is returned in locked status;
159 * otherwise, if the parent exists, if it may generate volatile
160 * descendants an attempt to generate the required entry is
161 * performed and, if successful, the entry is returned
164 monitor_cache_dn2entry(
171 monitor_info_t *mi = (monitor_info_t *)op->o_bd->be_private;
173 struct berval p_ndn = BER_BVNULL;
177 assert( mi != NULL );
178 assert( ndn != NULL );
179 assert( ep != NULL );
180 assert( matched != NULL );
184 if ( !dnIsSuffix( ndn, &op->o_bd->be_nsuffix[ 0 ] ) ) {
188 rc = monitor_cache_get( mi, ndn, ep );
189 if ( !rc && *ep != NULL ) {
193 /* try with parent/ancestors */
194 if ( BER_BVISNULL( ndn ) ) {
195 BER_BVSTR( &p_ndn, "" );
198 dnParent( ndn, &p_ndn );
201 rc = monitor_cache_dn2entry( op, rs, &p_ndn, &e_parent, matched );
202 if ( rc || e_parent == NULL ) {
206 mp = ( monitor_entry_t * )e_parent->e_private;
208 if ( mp->mp_flags & MONITOR_F_VOLATILE_CH ) {
209 /* parent entry generates volatile children */
210 rc = monitor_entry_create( op, rs, ndn, e_parent, ep );
214 monitor_cache_lock( *ep );
215 monitor_cache_release( mi, e_parent );
225 * releases the lock of the entry; if it is marked as volatile, it is
229 monitor_cache_release(
235 assert( mi != NULL );
237 assert( e->e_private != NULL );
239 mp = ( monitor_entry_t * )e->e_private;
241 if ( mp->mp_flags & MONITOR_F_VOLATILE ) {
242 monitor_cache_t *mc, tmp_mc;
244 /* volatile entries do not return to cache */
245 ldap_pvt_thread_mutex_lock( &mi->mi_cache_mutex );
246 tmp_mc.mc_ndn = e->e_nname;
247 mc = avl_delete( &mi->mi_cache,
248 ( caddr_t )&tmp_mc, monitor_cache_cmp );
249 ldap_pvt_thread_mutex_unlock( &mi->mi_cache_mutex );
254 ldap_pvt_thread_mutex_unlock( &mp->mp_mutex );
255 ldap_pvt_thread_mutex_destroy( &mp->mp_mutex );
263 ldap_pvt_thread_mutex_unlock( &mp->mp_mutex );
269 monitor_entry_destroy( void *v_mc )
271 monitor_cache_t *mc = (monitor_cache_t *)v_mc;
273 if ( mc->mc_e != NULL ) {
276 assert( mc->mc_e->e_private != NULL );
278 mp = ( monitor_entry_t * )mc->mc_e->e_private;
281 if ( mp->mp_cb->mc_free ) {
282 mp->mp_cb->mc_free( mc->mc_e,
283 mp->mp_cb->mc_private );
285 ch_free( mp->mp_cb );
288 ldap_pvt_thread_mutex_destroy( &mp->mp_mutex );
291 mc->mc_e->e_private = NULL;
292 entry_free( mc->mc_e );
299 monitor_cache_destroy(
302 if ( mi->mi_cache ) {
303 avl_free( mi->mi_cache, monitor_entry_destroy );