2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 2003-2011 The OpenLDAP Foundation.
5 * Portions Copyright 2003 IBM Corporation.
6 * Portions Copyright 2003-2009 Symas Corporation.
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 the 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 Apurva Kumar for inclusion
19 * in OpenLDAP Software and subsequently rewritten by Howard Chu.
24 #ifdef SLAPD_OVER_PROXYCACHE
28 #include <ac/string.h>
36 #include "../back-monitor/back-monitor.h"
42 * Control that allows to access the private DB
43 * instead of the public one
45 #define PCACHE_CONTROL_PRIVDB "1.3.6.1.4.1.4203.666.11.9.5.1"
48 * Extended Operation that allows to remove a query from the cache
50 #define PCACHE_EXOP_QUERY_DELETE "1.3.6.1.4.1.4203.666.11.9.6.1"
55 #define PCACHE_MONITOR
58 /* query cache structs */
61 typedef struct Query_s {
62 Filter* filter; /* Search Filter */
63 struct berval base; /* Search Base */
64 int scope; /* Search scope */
67 struct query_template_s;
69 typedef struct Qbase_s {
70 Avlnode *scopes[4]; /* threaded AVL trees of cached queries */
75 /* struct representing a cached query */
76 typedef struct cached_query_s {
81 struct berval q_uuid; /* query identifier */
83 struct query_template_s *qtemp; /* template of the query */
84 time_t expiry_time; /* time till the query is considered invalid */
85 time_t refresh_time; /* time till the query is refreshed */
86 time_t bindref_time; /* time till the bind is refreshed */
87 int bind_refcnt; /* number of bind operation referencing this query */
88 unsigned long answerable_cnt; /* how many times it was answerable */
89 int refcnt; /* references since last refresh */
90 ldap_pvt_thread_mutex_t answerable_cnt_mutex;
91 struct cached_query_s *next; /* next query in the template */
92 struct cached_query_s *prev; /* previous query in the template */
93 struct cached_query_s *lru_up; /* previous query in the LRU list */
94 struct cached_query_s *lru_down; /* next query in the LRU list */
95 ldap_pvt_thread_rdwr_t rwlock;
101 * ldap:///<base>??<scope>?<filter>?x-uuid=<uid>,x-template=<template>,x-attrset=<attrset>,x-expiry=<expiry>,x-refresh=<refresh>
103 * <base> ::= CachedQuery.qbase->base
104 * <scope> ::= CachedQuery.scope
105 * <filter> ::= filter2bv(CachedQuery.filter)
106 * <uuid> ::= CachedQuery.q_uuid
107 * <attrset> ::= CachedQuery.qtemp->attr_set_index
108 * <expiry> ::= CachedQuery.expiry_time
109 * <refresh> ::= CachedQuery.refresh_time
111 * quick hack: parse URI, call add_query() and then fix
112 * CachedQuery.expiry_time and CachedQuery.q_uuid
114 * NOTE: if the <attrset> changes, all stored URLs will be invalidated.
118 * Represents a set of projected attributes.
122 struct query_template_s *templates;
123 AttributeName* attrs; /* specifies the set */
125 #define PC_CONFIGURED (0x1)
126 #define PC_REFERENCED (0x2)
127 #define PC_GOT_OC (0x4)
128 int count; /* number of attributes */
131 /* struct representing a query template
132 * e.g. template string = &(cn=)(mail=)
134 typedef struct query_template_s {
135 struct query_template_s *qtnext;
136 struct query_template_s *qmnext;
139 CachedQuery* query; /* most recent query cached for the template */
140 CachedQuery* query_last; /* oldest query cached for the template */
141 ldap_pvt_thread_rdwr_t t_rwlock; /* Rd/wr lock for accessing queries in the template */
142 struct berval querystr; /* Filter string corresponding to the QT */
143 struct berval bindbase; /* base DN for Bind request */
144 struct berval bindfilterstr; /* Filter string for Bind request */
145 struct berval bindftemp; /* bind filter template */
147 AttributeDescription **bindfattrs; /* attrs to substitute in ftemp */
149 int bindnattrs; /* number of bindfattrs */
151 int attr_set_index; /* determines the projected attributes */
152 int no_of_queries; /* Total number of queries in the template */
153 time_t ttl; /* TTL for the queries of this template */
154 time_t negttl; /* TTL for negative results */
155 time_t limitttl; /* TTL for sizelimit exceeding results */
156 time_t ttr; /* time to refresh */
157 time_t bindttr; /* TTR for cached binds */
158 struct attr_set t_attrs; /* filter attrs + attr_set */
166 } pc_caching_reason_t;
168 static const char *pc_caching_reason_str[] = {
177 struct query_manager_s;
179 /* prototypes for functions for 1) query containment
180 * 2) query addition, 3) cache replacement
182 typedef CachedQuery *(QCfunc)(Operation *op, struct query_manager_s*,
183 Query*, QueryTemplate*);
184 typedef CachedQuery *(AddQueryfunc)(Operation *op, struct query_manager_s*,
185 Query*, QueryTemplate*, pc_caching_reason_t, int wlock);
186 typedef void (CRfunc)(struct query_manager_s*, struct berval*);
188 /* LDAP query cache */
189 typedef struct query_manager_s {
190 struct attr_set* attr_sets; /* possible sets of projected attributes */
191 QueryTemplate* templates; /* cacheable templates */
193 CachedQuery* lru_top; /* top and bottom of LRU list */
194 CachedQuery* lru_bottom;
196 ldap_pvt_thread_mutex_t lru_mutex; /* mutex for accessing LRU list */
198 /* Query cache methods */
199 QCfunc *qcfunc; /* Query containment*/
200 CRfunc *crfunc; /* cache replacement */
201 AddQueryfunc *addfunc; /* add query */
204 /* LDAP query cache manager */
205 typedef struct cache_manager_s {
206 BackendDB db; /* underlying database */
207 unsigned long num_cached_queries; /* total number of cached queries */
208 unsigned long max_queries; /* upper bound on # of cached queries */
209 int save_queries; /* save cached queries across restarts */
210 int check_cacheability; /* check whether a query is cacheable */
211 int numattrsets; /* number of attribute sets */
212 int cur_entries; /* current number of entries cached */
213 int max_entries; /* max number of entries cached */
214 int num_entries_limit; /* max # of entries in a cacheable query */
216 char response_cb; /* install the response callback
217 * at the tail of the callback list */
218 #define PCACHE_RESPONSE_CB_HEAD 0
219 #define PCACHE_RESPONSE_CB_TAIL 1
220 char defer_db_open; /* defer open for online add */
221 char cache_binds; /* cache binds or just passthru */
223 time_t cc_period; /* interval between successive consistency checks (sec) */
224 #define PCACHE_CC_PAUSED 1
225 #define PCACHE_CC_OFFLINE 2
229 ldap_pvt_thread_mutex_t cache_mutex;
231 query_manager* qm; /* query cache managed by the cache manager */
233 #ifdef PCACHE_MONITOR
235 struct berval monitor_ndn;
236 #endif /* PCACHE_MONITOR */
239 #ifdef PCACHE_MONITOR
240 static int pcache_monitor_db_init( BackendDB *be );
241 static int pcache_monitor_db_open( BackendDB *be );
242 static int pcache_monitor_db_close( BackendDB *be );
243 static int pcache_monitor_db_destroy( BackendDB *be );
244 #endif /* PCACHE_MONITOR */
246 static int pcache_debug;
248 #ifdef PCACHE_CONTROL_PRIVDB
249 static int privDB_cid;
250 #endif /* PCACHE_CONTROL_PRIVDB */
252 static AttributeDescription *ad_queryId, *ad_cachedQueryURL;
254 #ifdef PCACHE_MONITOR
255 static AttributeDescription *ad_numQueries, *ad_numEntries;
256 static ObjectClass *oc_olmPCache;
257 #endif /* PCACHE_MONITOR */
263 { "PCacheOID", "1.3.6.1.4.1.4203.666.11.9.1" },
264 { "PCacheAttributes", "PCacheOID:1" },
265 { "PCacheObjectClasses", "PCacheOID:2" },
272 AttributeDescription **adp;
274 { "( PCacheAttributes:1 "
275 "NAME 'pcacheQueryID' "
276 "DESC 'ID of query the entry belongs to, formatted as a UUID' "
277 "EQUALITY octetStringMatch "
278 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.40{64} "
279 "NO-USER-MODIFICATION "
280 "USAGE directoryOperation )",
282 { "( PCacheAttributes:2 "
283 "NAME 'pcacheQueryURL' "
284 "DESC 'URI describing a cached query' "
285 "EQUALITY caseExactMatch "
286 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.15 "
287 "NO-USER-MODIFICATION "
288 "USAGE directoryOperation )",
289 &ad_cachedQueryURL },
290 #ifdef PCACHE_MONITOR
291 { "( PCacheAttributes:3 "
292 "NAME 'pcacheNumQueries' "
293 "DESC 'Number of cached queries' "
294 "EQUALITY integerMatch "
295 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.27 "
296 "NO-USER-MODIFICATION "
297 "USAGE directoryOperation )",
299 { "( PCacheAttributes:4 "
300 "NAME 'pcacheNumEntries' "
301 "DESC 'Number of cached entries' "
302 "EQUALITY integerMatch "
303 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.27 "
304 "NO-USER-MODIFICATION "
305 "USAGE directoryOperation )",
307 #endif /* PCACHE_MONITOR */
316 #ifdef PCACHE_MONITOR
317 /* augments an existing object, so it must be AUXILIARY */
318 { "( PCacheObjectClasses:1 "
319 "NAME ( 'olmPCache' ) "
323 "$ pcacheNumQueries "
324 "$ pcacheNumEntries "
327 #endif /* PCACHE_MONITOR */
336 struct berval *fstr );
343 QueryTemplate *templ,
344 pc_caching_reason_t why,
350 struct berval *query_uuid );
353 * Turn a cached query into its URL representation
356 query2url( Operation *op, CachedQuery *q, struct berval *urlbv, int dolock )
358 struct berval bv_scope,
360 char attrset_buf[ LDAP_PVT_INTTYPE_CHARS( unsigned long ) ],
361 expiry_buf[ LDAP_PVT_INTTYPE_CHARS( unsigned long ) ],
362 refresh_buf[ LDAP_PVT_INTTYPE_CHARS( unsigned long ) ],
363 answerable_buf[ LDAP_PVT_INTTYPE_CHARS( unsigned long ) ],
365 ber_len_t attrset_len,
371 ldap_pvt_thread_rdwr_rlock( &q->rwlock );
374 ldap_pvt_scope2bv( q->scope, &bv_scope );
375 filter2bv_x( op, q->filter, &bv_filter );
376 attrset_len = sprintf( attrset_buf,
377 "%lu", (unsigned long)q->qtemp->attr_set_index );
378 expiry_len = sprintf( expiry_buf,
379 "%lu", (unsigned long)q->expiry_time );
380 answerable_len = snprintf( answerable_buf, sizeof( answerable_buf ),
381 "%lu", q->answerable_cnt );
382 if ( q->refresh_time )
383 refresh_len = sprintf( refresh_buf,
384 "%lu", (unsigned long)q->refresh_time );
388 urlbv->bv_len = STRLENOF( "ldap:///" )
389 + q->qbase->base.bv_len
394 + STRLENOF( "?x-uuid=" )
396 + STRLENOF( ",x-attrset=" )
398 + STRLENOF( ",x-expiry=" )
400 + STRLENOF( ",x-answerable=" )
403 urlbv->bv_len += STRLENOF( ",x-refresh=" )
406 ptr = urlbv->bv_val = ber_memalloc_x( urlbv->bv_len + 1, op->o_tmpmemctx );
407 ptr = lutil_strcopy( ptr, "ldap:///" );
408 ptr = lutil_strcopy( ptr, q->qbase->base.bv_val );
409 ptr = lutil_strcopy( ptr, "??" );
410 ptr = lutil_strcopy( ptr, bv_scope.bv_val );
411 ptr = lutil_strcopy( ptr, "?" );
412 ptr = lutil_strcopy( ptr, bv_filter.bv_val );
413 ptr = lutil_strcopy( ptr, "?x-uuid=" );
414 ptr = lutil_strcopy( ptr, q->q_uuid.bv_val );
415 ptr = lutil_strcopy( ptr, ",x-attrset=" );
416 ptr = lutil_strcopy( ptr, attrset_buf );
417 ptr = lutil_strcopy( ptr, ",x-expiry=" );
418 ptr = lutil_strcopy( ptr, expiry_buf );
419 ptr = lutil_strcopy( ptr, ",x-answerable=" );
420 ptr = lutil_strcopy( ptr, answerable_buf );
422 ptr = lutil_strcopy( ptr, ",x-refresh=" );
423 ptr = lutil_strcopy( ptr, refresh_buf );
426 ber_memfree_x( bv_filter.bv_val, op->o_tmpmemctx );
429 ldap_pvt_thread_rdwr_runlock( &q->rwlock );
435 /* Find and record the empty filter clauses */
438 ftemp_attrs( struct berval *ftemp, struct berval *template,
439 AttributeDescription ***ret, const char **text )
445 AttributeDescription *ad;
446 AttributeDescription **descs = NULL;
449 temp2 = ch_malloc( ftemp->bv_len + 1 );
456 while ( *p1 == '(' || *p1 == '&' || *p1 == '|' || *p1 == ')' )
459 p2 = strchr( p1, '=' );
463 AC_MEMCPY( t1, p1, i );
467 if ( p2[-1] == '<' || p2[-1] == '>' ) p2--;
471 i = slap_bv2ad( &bv, &ad, text );
476 if ( *p2 == '<' || *p2 == '>' ) p2++;
477 if ( p2[1] != ')' ) {
479 while ( *p2 != ')' ) p2++;
484 descs = (AttributeDescription **)ch_realloc(descs,
485 (attr_cnt + 2)*sizeof(AttributeDescription *));
487 descs[attr_cnt++] = ad;
492 descs[attr_cnt] = NULL;
494 template->bv_val = temp2;
495 template->bv_len = t1 - temp2;
500 template_attrs( char *template, struct attr_set *set, AttributeName **ret,
511 AttributeDescription *ad;
512 AttributeName *attrs;
518 attrs = ch_calloc( set->count + 1, sizeof(AttributeName) );
519 for ( i=0; i < set->count; i++ )
520 attrs[i] = set->attrs[i];
522 alluser = an_find( attrs, slap_bv_all_user_attrs );
523 allop = an_find( attrs, slap_bv_all_operational_attrs );
526 while ( *p1 == '(' || *p1 == '&' || *p1 == '|' || *p1 == ')' ) p1++;
527 p2 = strchr( p1, '=' );
530 if ( p2[-1] == '<' || p2[-1] == '>' ) p2--;
534 i = slap_bv2ad( &bv, &ad, text );
541 if ( ad == slap_schema.si_ad_objectClass )
544 if ( is_at_operational(ad->ad_type)) {
548 } else if ( alluser ) {
551 if ( !ad_inlist( ad, attrs )) {
552 attrs = (AttributeName *)ch_realloc(attrs,
553 (attr_cnt + 2)*sizeof(AttributeName));
555 attrs[attr_cnt].an_desc = ad;
556 attrs[attr_cnt].an_name = ad->ad_cname;
557 attrs[attr_cnt].an_oc = NULL;
558 attrs[attr_cnt].an_flags = 0;
559 BER_BVZERO( &attrs[attr_cnt+1].an_name );
567 *text = "couldn't parse template";
570 if ( !got_oc && !( set->flags & PC_GOT_OC )) {
571 attrs = (AttributeName *)ch_realloc(attrs,
572 (attr_cnt + 2)*sizeof(AttributeName));
574 ad = slap_schema.si_ad_objectClass;
575 attrs[attr_cnt].an_desc = ad;
576 attrs[attr_cnt].an_name = ad->ad_cname;
577 attrs[attr_cnt].an_oc = NULL;
578 attrs[attr_cnt].an_flags = 0;
579 BER_BVZERO( &attrs[attr_cnt+1].an_name );
587 * Turn an URL representing a formerly cached query into a cached query,
588 * and try to cache it
599 LDAPURLDesc *lud = NULL;
601 tempstr = BER_BVNULL,
606 unsigned long answerable_cnt;
609 #define GOT_UUID 0x1U
610 #define GOT_ATTRSET 0x2U
611 #define GOT_EXPIRY 0x4U
612 #define GOT_ANSWERABLE 0x8U
613 #define GOT_REFRESH 0x10U
614 #define GOT_ALL (GOT_UUID|GOT_ATTRSET|GOT_EXPIRY|GOT_ANSWERABLE)
617 rc = ldap_url_parse( url, &lud );
618 if ( rc != LDAP_URL_SUCCESS ) {
622 /* non-allowed fields */
623 if ( lud->lud_host != NULL ) {
628 if ( lud->lud_attrs != NULL ) {
634 if ( strcmp( lud->lud_scheme, "ldap" ) != 0 ) {
639 /* required fields */
640 if ( lud->lud_dn == NULL || lud->lud_dn[ 0 ] == '\0' ) {
645 switch ( lud->lud_scope ) {
646 case LDAP_SCOPE_BASE:
647 case LDAP_SCOPE_ONELEVEL:
648 case LDAP_SCOPE_SUBTREE:
649 case LDAP_SCOPE_SUBORDINATE:
657 if ( lud->lud_filter == NULL || lud->lud_filter[ 0 ] == '\0' ) {
662 if ( lud->lud_exts == NULL ) {
667 for ( i = 0; lud->lud_exts[ i ] != NULL; i++ ) {
668 if ( strncmp( lud->lud_exts[ i ], "x-uuid=", STRLENOF( "x-uuid=" ) ) == 0 ) {
669 struct berval tmpUUID;
670 Syntax *syn_UUID = slap_schema.si_ad_entryUUID->ad_type->sat_syntax;
672 if ( got & GOT_UUID ) {
677 ber_str2bv( &lud->lud_exts[ i ][ STRLENOF( "x-uuid=" ) ], 0, 0, &tmpUUID );
678 if ( !BER_BVISEMPTY( &tmpUUID ) ) {
679 rc = syn_UUID->ssyn_pretty( syn_UUID, &tmpUUID, &uuid, NULL );
680 if ( rc != LDAP_SUCCESS ) {
686 } else if ( strncmp( lud->lud_exts[ i ], "x-attrset=", STRLENOF( "x-attrset=" ) ) == 0 ) {
687 if ( got & GOT_ATTRSET ) {
692 rc = lutil_atoi( &attrset, &lud->lud_exts[ i ][ STRLENOF( "x-attrset=" ) ] );
698 } else if ( strncmp( lud->lud_exts[ i ], "x-expiry=", STRLENOF( "x-expiry=" ) ) == 0 ) {
701 if ( got & GOT_EXPIRY ) {
706 rc = lutil_atoul( &l, &lud->lud_exts[ i ][ STRLENOF( "x-expiry=" ) ] );
710 expiry_time = (time_t)l;
713 } else if ( strncmp( lud->lud_exts[ i ], "x-answerable=", STRLENOF( "x-answerable=" ) ) == 0 ) {
714 if ( got & GOT_ANSWERABLE ) {
719 rc = lutil_atoul( &answerable_cnt, &lud->lud_exts[ i ][ STRLENOF( "x-answerable=" ) ] );
723 got |= GOT_ANSWERABLE;
725 } else if ( strncmp( lud->lud_exts[ i ], "x-refresh=", STRLENOF( "x-refresh=" ) ) == 0 ) {
728 if ( got & GOT_REFRESH ) {
733 rc = lutil_atoul( &l, &lud->lud_exts[ i ][ STRLENOF( "x-refresh=" ) ] );
737 refresh_time = (time_t)l;
746 if ( got != GOT_ALL ) {
751 if ( !(got & GOT_REFRESH ))
754 /* ignore expired queries */
755 if ( expiry_time <= slap_get_time()) {
758 memset( &op2.oq_search, 0, sizeof( op2.oq_search ) );
760 (void)remove_query_data( &op2, &uuid );
765 ber_str2bv( lud->lud_dn, 0, 0, &base );
766 rc = dnNormalize( 0, NULL, NULL, &base, &query.base, NULL );
767 if ( rc != LDAP_SUCCESS ) {
770 query.scope = lud->lud_scope;
771 query.filter = str2filter( lud->lud_filter );
772 if ( query.filter == NULL ) {
777 tempstr.bv_val = ch_malloc( strlen( lud->lud_filter ) + 1 );
779 if ( filter2template( op, query.filter, &tempstr ) ) {
780 ch_free( tempstr.bv_val );
785 /* check for query containment */
786 qt = qm->attr_sets[attrset].templates;
787 for ( ; qt; qt = qt->qtnext ) {
788 /* find if template i can potentially answer tempstr */
789 if ( bvmatch( &qt->querystr, &tempstr ) ) {
799 cq = add_query( op, qm, &query, qt, PC_POSITIVE, 0 );
801 cq->expiry_time = expiry_time;
802 cq->refresh_time = refresh_time;
804 cq->answerable_cnt = answerable_cnt;
807 /* it's now into cq->filter */
817 if ( query.filter != NULL ) filter_free( query.filter );
818 if ( !BER_BVISNULL( &tempstr ) ) ch_free( tempstr.bv_val );
819 if ( !BER_BVISNULL( &query.base ) ) ch_free( query.base.bv_val );
820 if ( !BER_BVISNULL( &uuid ) ) ch_free( uuid.bv_val );
821 if ( lud != NULL ) ldap_free_urldesc( lud );
826 /* Return 1 for an added entry, else 0 */
832 struct berval* query_uuid )
835 Modifications* modlist = NULL;
836 const char* text = NULL;
838 char textbuf[SLAP_TEXT_BUFLEN];
839 size_t textlen = sizeof(textbuf);
841 SlapReply sreply = {REP_RESULT};
843 slap_callback cb = { NULL, slap_null_cb, NULL, NULL };
850 /* add queryId attribute */
851 attr_merge_one( e, ad_queryId, query_uuid, NULL );
853 /* append the attribute list from the fetched entry */
854 e->e_attrs->a_next = attr;
856 op->o_tag = LDAP_REQ_ADD;
857 op->o_protocol = LDAP_VERSION3;
858 op->o_callback = &cb;
859 op->o_time = slap_get_time();
860 op->o_do_not_cache = 1;
863 op->o_req_dn = e->e_name;
864 op->o_req_ndn = e->e_nname;
865 rc = op->o_bd->be_add( op, &sreply );
867 if ( rc != LDAP_SUCCESS ) {
868 if ( rc == LDAP_ALREADY_EXISTS ) {
869 rs_reinit( &sreply, REP_RESULT );
870 slap_entry2mods( e, &modlist, &text, textbuf, textlen );
871 modlist->sml_op = LDAP_MOD_ADD;
872 op->o_tag = LDAP_REQ_MODIFY;
873 op->orm_modlist = modlist;
874 op->o_managedsait = SLAP_CONTROL_CRITICAL;
875 op->o_bd->be_modify( op, &sreply );
876 slap_mods_free( modlist, 1 );
877 } else if ( rc == LDAP_REFERRAL ||
878 rc == LDAP_NO_SUCH_OBJECT ) {
879 syncrepl_add_glue( op, e );
888 if ( op->ora_e == e )
896 /* Length-ordered sort on normalized DNs */
897 static int pcache_dn_cmp( const void *v1, const void *v2 )
899 const Qbase *q1 = v1, *q2 = v2;
901 int rc = q1->base.bv_len - q2->base.bv_len;
903 rc = strncmp( q1->base.bv_val, q2->base.bv_val, q1->base.bv_len );
907 static int lex_bvcmp( struct berval *bv1, struct berval *bv2 )
910 dif = bv1->bv_len - bv2->bv_len;
912 if ( dif > 0 ) len -= dif;
913 len = memcmp( bv1->bv_val, bv2->bv_val, len );
919 /* compare the current value in each filter */
920 static int pcache_filter_cmp( Filter *f1, Filter *f2 )
922 int rc, weight1, weight2;
924 switch( f1->f_choice ) {
925 case LDAP_FILTER_AND:
929 case LDAP_FILTER_PRESENT:
932 case LDAP_FILTER_EQUALITY:
940 switch( f2->f_choice ) {
941 case LDAP_FILTER_AND:
945 case LDAP_FILTER_PRESENT:
948 case LDAP_FILTER_EQUALITY:
956 rc = weight1 - weight2;
960 rc = pcache_filter_cmp( f1->f_and, f2->f_and );
965 rc = lex_bvcmp( &f1->f_av_value, &f2->f_av_value );
968 if ( f1->f_choice == LDAP_FILTER_SUBSTRINGS ) {
970 if ( !BER_BVISNULL( &f1->f_sub_initial )) {
971 if ( !BER_BVISNULL( &f2->f_sub_initial )) {
972 rc = lex_bvcmp( &f1->f_sub_initial,
973 &f2->f_sub_initial );
977 } else if ( !BER_BVISNULL( &f2->f_sub_initial )) {
981 if ( f1->f_sub_any ) {
982 if ( f2->f_sub_any ) {
983 rc = lex_bvcmp( f1->f_sub_any,
988 } else if ( f2->f_sub_any ) {
992 if ( !BER_BVISNULL( &f1->f_sub_final )) {
993 if ( !BER_BVISNULL( &f2->f_sub_final )) {
994 rc = lex_bvcmp( &f1->f_sub_final,
999 } else if ( !BER_BVISNULL( &f2->f_sub_final )) {
1003 rc = lex_bvcmp( &f1->f_mr_value,
1017 rc = pcache_filter_cmp( f1, f2 );
1027 /* compare filters in each query */
1028 static int pcache_query_cmp( const void *v1, const void *v2 )
1030 const CachedQuery *q1 = v1, *q2 =v2;
1031 return pcache_filter_cmp( q1->filter, q2->filter );
1034 /* add query on top of LRU list */
1036 add_query_on_top (query_manager* qm, CachedQuery* qc)
1038 CachedQuery* top = qm->lru_top;
1045 qm->lru_bottom = qc;
1049 Debug( pcache_debug, "Base of added query = %s\n",
1050 qc->qbase->base.bv_val, 0, 0 );
1053 /* remove_query from LRU list */
1056 remove_query (query_manager* qm, CachedQuery* qc)
1065 down = qc->lru_down;
1071 qm->lru_bottom = up;
1077 up->lru_down = down;
1079 qc->lru_up = qc->lru_down = NULL;
1082 /* find and remove string2 from string1
1083 * from start if position = 1,
1084 * from end if position = 3,
1085 * from anywhere if position = 2
1086 * string1 is overwritten if position = 2.
1090 find_and_remove(struct berval* ber1, struct berval* ber2, int position)
1094 if ( !ber2->bv_val )
1096 if ( !ber1->bv_val )
1099 switch( position ) {
1101 if ( ber1->bv_len >= ber2->bv_len && !memcmp( ber1->bv_val,
1102 ber2->bv_val, ber2->bv_len )) {
1104 ber1->bv_val += ber2->bv_len;
1105 ber1->bv_len -= ber2->bv_len;
1110 ber1->bv_val[ber1->bv_len] = '\0';
1111 temp = strstr( ber1->bv_val, ber2->bv_val );
1113 strcpy( temp, temp+ber2->bv_len );
1114 ber1->bv_len -= ber2->bv_len;
1120 if ( ber1->bv_len >= ber2->bv_len &&
1121 !memcmp( ber1->bv_val+ber1->bv_len-ber2->bv_len, ber2->bv_val,
1124 ber1->bv_len -= ber2->bv_len;
1132 static struct berval*
1133 merge_init_final(Operation *op, struct berval* init, struct berval* any,
1134 struct berval* final)
1136 struct berval* merged, *temp;
1137 int i, any_count, count;
1139 for (any_count=0; any && any[any_count].bv_val; any_count++)
1149 merged = (struct berval*)op->o_tmpalloc( (count+1)*sizeof(struct berval),
1154 ber_dupbv_x( temp, init, op->o_tmpmemctx );
1158 for (i=0; i<any_count; i++) {
1159 ber_dupbv_x( temp, any, op->o_tmpmemctx );
1164 ber_dupbv_x( temp, final, op->o_tmpmemctx );
1171 /* Each element in stored must be found in incoming. Incoming is overwritten.
1174 strings_containment(struct berval* stored, struct berval* incoming)
1176 struct berval* element;
1180 for ( element=stored; element->bv_val != NULL; element++ ) {
1181 for (j = k; incoming[j].bv_val != NULL; j++) {
1182 if (find_and_remove(&(incoming[j]), element, 2)) {
1199 substr_containment_substr(Operation *op, Filter* stored, Filter* incoming)
1203 struct berval init_incoming;
1204 struct berval final_incoming;
1205 struct berval *remaining_incoming = NULL;
1207 if ((!(incoming->f_sub_initial.bv_val) && (stored->f_sub_initial.bv_val))
1208 || (!(incoming->f_sub_final.bv_val) && (stored->f_sub_final.bv_val)))
1211 init_incoming = incoming->f_sub_initial;
1212 final_incoming = incoming->f_sub_final;
1214 if (find_and_remove(&init_incoming,
1215 &(stored->f_sub_initial), 1) && find_and_remove(&final_incoming,
1216 &(stored->f_sub_final), 3))
1218 if (stored->f_sub_any == NULL) {
1222 remaining_incoming = merge_init_final(op, &init_incoming,
1223 incoming->f_sub_any, &final_incoming);
1224 rc = strings_containment(stored->f_sub_any, remaining_incoming);
1225 ber_bvarray_free_x( remaining_incoming, op->o_tmpmemctx );
1232 substr_containment_equality(Operation *op, Filter* stored, Filter* incoming)
1234 struct berval incoming_val[2];
1237 incoming_val[1] = incoming->f_av_value;
1239 if (find_and_remove(incoming_val+1,
1240 &(stored->f_sub_initial), 1) && find_and_remove(incoming_val+1,
1241 &(stored->f_sub_final), 3)) {
1242 if (stored->f_sub_any == NULL){
1246 ber_dupbv_x( incoming_val, incoming_val+1, op->o_tmpmemctx );
1247 BER_BVZERO( incoming_val+1 );
1248 rc = strings_containment(stored->f_sub_any, incoming_val);
1249 op->o_tmpfree( incoming_val[0].bv_val, op->o_tmpmemctx );
1256 filter_first( Filter *f )
1258 while ( f->f_choice == LDAP_FILTER_OR || f->f_choice == LDAP_FILTER_AND )
1263 typedef struct fstack {
1264 struct fstack *fs_next;
1269 static CachedQuery *
1270 find_filter( Operation *op, Avlnode *root, Filter *inputf, Filter *first )
1274 MatchingRule* mrule = NULL;
1275 int res=0, eqpass= 0;
1278 CachedQuery cq, *qc;
1279 fstack *stack = NULL, *fsp;
1284 /* substring matches sort to the end, and we just have to
1285 * walk the entire list.
1287 if ( first->f_choice == LDAP_FILTER_SUBSTRINGS ) {
1288 ptr = tavl_end( root, 1 );
1289 dir = TAVL_DIR_LEFT;
1291 ptr = tavl_find3( root, &cq, pcache_query_cmp, &ret );
1292 dir = (first->f_choice == LDAP_FILTER_GE) ? TAVL_DIR_LEFT :
1301 /* an incoming substr query can only be satisfied by a cached
1304 if ( first->f_choice == LDAP_FILTER_SUBSTRINGS &&
1305 qc->first->f_choice != LDAP_FILTER_SUBSTRINGS )
1308 /* an incoming eq query can be satisfied by a cached eq or substr
1311 if ( first->f_choice == LDAP_FILTER_EQUALITY ) {
1312 if ( eqpass == 0 ) {
1313 if ( qc->first->f_choice != LDAP_FILTER_EQUALITY ) {
1314 nextpass: eqpass = 1;
1315 ptr = tavl_end( root, 1 );
1316 dir = TAVL_DIR_LEFT;
1320 if ( qc->first->f_choice != LDAP_FILTER_SUBSTRINGS )
1326 switch (fs->f_choice) {
1327 case LDAP_FILTER_EQUALITY:
1328 if (fi->f_choice == LDAP_FILTER_EQUALITY)
1329 mrule = fs->f_ava->aa_desc->ad_type->sat_equality;
1333 case LDAP_FILTER_GE:
1334 case LDAP_FILTER_LE:
1335 mrule = fs->f_ava->aa_desc->ad_type->sat_ordering;
1342 rc = value_match(&ret, fs->f_ava->aa_desc, mrule,
1343 SLAP_MR_VALUE_OF_ASSERTION_SYNTAX,
1344 &(fi->f_ava->aa_value),
1345 &(fs->f_ava->aa_value), &text);
1346 if (rc != LDAP_SUCCESS) {
1349 if ( fi==first && fi->f_choice==LDAP_FILTER_EQUALITY && ret )
1352 switch (fs->f_choice) {
1353 case LDAP_FILTER_OR:
1354 case LDAP_FILTER_AND:
1356 /* save our stack position */
1357 fsp = op->o_tmpalloc(sizeof(fstack), op->o_tmpmemctx);
1358 fsp->fs_next = stack;
1359 fsp->fs_fs = fs->f_next;
1360 fsp->fs_fi = fi->f_next;
1367 case LDAP_FILTER_SUBSTRINGS:
1368 /* check if the equality query can be
1369 * answered with cached substring query */
1370 if ((fi->f_choice == LDAP_FILTER_EQUALITY)
1371 && substr_containment_equality( op,
1374 /* check if the substring query can be
1375 * answered with cached substring query */
1376 if ((fi->f_choice ==LDAP_FILTER_SUBSTRINGS
1377 ) && substr_containment_substr( op,
1383 case LDAP_FILTER_PRESENT:
1388 case LDAP_FILTER_EQUALITY:
1394 case LDAP_FILTER_GE:
1395 if (mrule && ret >= 0)
1400 case LDAP_FILTER_LE:
1401 if (mrule && ret <= 0)
1406 case LDAP_FILTER_NOT:
1412 if (!fs && !fi && stack) {
1415 stack = fsp->fs_next;
1418 op->o_tmpfree(fsp, op->o_tmpmemctx);
1420 } while((res) && (fi != NULL) && (fs != NULL));
1424 ptr = tavl_next( ptr, dir );
1429 /* check whether query is contained in any of
1430 * the cached queries in template
1432 static CachedQuery *
1433 query_containment(Operation *op, query_manager *qm,
1435 QueryTemplate *templa)
1438 int depth = 0, tscope;
1439 Qbase qbase, *qbptr = NULL;
1442 if (query->filter != NULL) {
1445 Debug( pcache_debug, "Lock QC index = %p\n",
1446 (void *) templa, 0, 0 );
1447 qbase.base = query->base;
1449 first = filter_first( query->filter );
1451 ldap_pvt_thread_rdwr_rlock(&templa->t_rwlock);
1454 qbptr = avl_find( templa->qbase, &qbase, pcache_dn_cmp );
1456 tscope = query->scope;
1457 /* Find a matching scope:
1458 * match at depth 0 OK
1461 * subord at depth > 0 OK
1462 * subtree at any depth OK
1464 * subtree or subord at any depth OK
1466 * subtree or subord at any depth OK
1468 * subord at depth > 0 OK
1469 * subtree at any depth OK
1471 for ( tscope = 0 ; tscope <= LDAP_SCOPE_CHILDREN; tscope++ ) {
1472 switch ( query->scope ) {
1473 case LDAP_SCOPE_BASE:
1474 if ( tscope == LDAP_SCOPE_BASE && depth ) continue;
1475 if ( tscope == LDAP_SCOPE_ONE && depth != 1) continue;
1476 if ( tscope == LDAP_SCOPE_CHILDREN && !depth ) continue;
1478 case LDAP_SCOPE_ONE:
1479 if ( tscope == LDAP_SCOPE_BASE )
1480 tscope = LDAP_SCOPE_ONE;
1481 if ( tscope == LDAP_SCOPE_ONE && depth ) continue;
1482 if ( !depth ) break;
1483 if ( tscope < LDAP_SCOPE_SUBTREE )
1484 tscope = LDAP_SCOPE_SUBTREE;
1486 case LDAP_SCOPE_SUBTREE:
1487 if ( tscope < LDAP_SCOPE_SUBTREE )
1488 tscope = LDAP_SCOPE_SUBTREE;
1489 if ( tscope == LDAP_SCOPE_CHILDREN && !depth ) continue;
1491 case LDAP_SCOPE_CHILDREN:
1492 if ( tscope < LDAP_SCOPE_SUBTREE )
1493 tscope = LDAP_SCOPE_SUBTREE;
1496 if ( !qbptr->scopes[tscope] ) continue;
1499 qc = find_filter( op, qbptr->scopes[tscope],
1500 query->filter, first );
1502 if ( qc->q_sizelimit ) {
1503 ldap_pvt_thread_rdwr_runlock(&templa->t_rwlock);
1506 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
1507 if (qm->lru_top != qc) {
1508 remove_query(qm, qc);
1509 add_query_on_top(qm, qc);
1511 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1516 if ( be_issuffix( op->o_bd, &qbase.base ))
1519 dnParent( &qbase.base, &pdn );
1524 Debug( pcache_debug,
1525 "Not answerable: Unlock QC index=%p\n",
1526 (void *) templa, 0, 0 );
1527 ldap_pvt_thread_rdwr_runlock(&templa->t_rwlock);
1533 free_query (CachedQuery* qc)
1535 free(qc->q_uuid.bv_val);
1536 filter_free(qc->filter);
1537 ldap_pvt_thread_mutex_destroy(&qc->answerable_cnt_mutex);
1538 ldap_pvt_thread_rdwr_destroy( &qc->rwlock );
1539 memset(qc, 0, sizeof(*qc));
1544 /* Add query to query cache, the returned Query is locked for writing */
1545 static CachedQuery *
1550 QueryTemplate *templ,
1551 pc_caching_reason_t why,
1554 CachedQuery* new_cached_query = (CachedQuery*) ch_malloc(sizeof(CachedQuery));
1558 time_t ttl = 0, ttr = 0;
1561 new_cached_query->qtemp = templ;
1562 BER_BVZERO( &new_cached_query->q_uuid );
1563 new_cached_query->q_sizelimit = 0;
1565 now = slap_get_time();
1570 ttr = now + templ->ttr;
1574 ttl = templ->negttl;
1578 ttl = templ->limitttl;
1585 new_cached_query->expiry_time = now + ttl;
1586 new_cached_query->refresh_time = ttr;
1587 new_cached_query->bindref_time = 0;
1589 new_cached_query->bind_refcnt = 0;
1590 new_cached_query->answerable_cnt = 0;
1591 new_cached_query->refcnt = 1;
1592 ldap_pvt_thread_mutex_init(&new_cached_query->answerable_cnt_mutex);
1594 new_cached_query->lru_up = NULL;
1595 new_cached_query->lru_down = NULL;
1596 Debug( pcache_debug, "Added query expires at %ld (%s)\n",
1597 (long) new_cached_query->expiry_time,
1598 pc_caching_reason_str[ why ], 0 );
1600 new_cached_query->scope = query->scope;
1601 new_cached_query->filter = query->filter;
1602 new_cached_query->first = first = filter_first( query->filter );
1604 ldap_pvt_thread_rdwr_init(&new_cached_query->rwlock);
1606 ldap_pvt_thread_rdwr_wlock(&new_cached_query->rwlock);
1608 qb.base = query->base;
1610 /* Adding a query */
1611 Debug( pcache_debug, "Lock AQ index = %p\n",
1612 (void *) templ, 0, 0 );
1613 ldap_pvt_thread_rdwr_wlock(&templ->t_rwlock);
1614 qbase = avl_find( templ->qbase, &qb, pcache_dn_cmp );
1616 qbase = ch_calloc( 1, sizeof(Qbase) + qb.base.bv_len + 1 );
1617 qbase->base.bv_len = qb.base.bv_len;
1618 qbase->base.bv_val = (char *)(qbase+1);
1619 memcpy( qbase->base.bv_val, qb.base.bv_val, qb.base.bv_len );
1620 qbase->base.bv_val[qbase->base.bv_len] = '\0';
1621 avl_insert( &templ->qbase, qbase, pcache_dn_cmp, avl_dup_error );
1623 new_cached_query->next = templ->query;
1624 new_cached_query->prev = NULL;
1625 new_cached_query->qbase = qbase;
1626 rc = tavl_insert( &qbase->scopes[query->scope], new_cached_query,
1627 pcache_query_cmp, avl_dup_error );
1630 if (templ->query == NULL)
1631 templ->query_last = new_cached_query;
1633 templ->query->prev = new_cached_query;
1634 templ->query = new_cached_query;
1635 templ->no_of_queries++;
1637 ldap_pvt_thread_mutex_destroy(&new_cached_query->answerable_cnt_mutex);
1639 ldap_pvt_thread_rdwr_wunlock(&new_cached_query->rwlock);
1640 ldap_pvt_thread_rdwr_destroy( &new_cached_query->rwlock );
1641 ch_free( new_cached_query );
1642 new_cached_query = find_filter( op, qbase->scopes[query->scope],
1643 query->filter, first );
1644 filter_free( query->filter );
1645 query->filter = NULL;
1647 Debug( pcache_debug, "TEMPLATE %p QUERIES++ %d\n",
1648 (void *) templ, templ->no_of_queries, 0 );
1650 /* Adding on top of LRU list */
1652 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
1653 add_query_on_top(qm, new_cached_query);
1654 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1656 Debug( pcache_debug, "Unlock AQ index = %p \n",
1657 (void *) templ, 0, 0 );
1658 ldap_pvt_thread_rdwr_wunlock(&templ->t_rwlock);
1660 return rc == 0 ? new_cached_query : NULL;
1664 remove_from_template (CachedQuery* qc, QueryTemplate* template)
1666 if (!qc->prev && !qc->next) {
1667 template->query_last = template->query = NULL;
1668 } else if (qc->prev == NULL) {
1669 qc->next->prev = NULL;
1670 template->query = qc->next;
1671 } else if (qc->next == NULL) {
1672 qc->prev->next = NULL;
1673 template->query_last = qc->prev;
1675 qc->next->prev = qc->prev;
1676 qc->prev->next = qc->next;
1678 tavl_delete( &qc->qbase->scopes[qc->scope], qc, pcache_query_cmp );
1679 qc->qbase->queries--;
1680 if ( qc->qbase->queries == 0 ) {
1681 avl_delete( &template->qbase, qc->qbase, pcache_dn_cmp );
1682 ch_free( qc->qbase );
1686 template->no_of_queries--;
1689 /* remove bottom query of LRU list from the query cache */
1691 * NOTE: slight change in functionality.
1693 * - if result->bv_val is NULL, the query at the bottom of the LRU
1695 * - otherwise, the query whose UUID is *result is removed
1696 * - if not found, result->bv_val is zeroed
1699 cache_replacement(query_manager* qm, struct berval *result)
1701 CachedQuery* bottom;
1702 QueryTemplate *temp;
1704 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
1705 if ( BER_BVISNULL( result ) ) {
1706 bottom = qm->lru_bottom;
1709 Debug ( pcache_debug,
1710 "Cache replacement invoked without "
1711 "any query in LRU list\n", 0, 0, 0 );
1712 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1717 for ( bottom = qm->lru_bottom;
1719 bottom = bottom->lru_up )
1721 if ( bvmatch( result, &bottom->q_uuid ) ) {
1727 Debug ( pcache_debug,
1728 "Could not find query with uuid=\"%s\""
1729 "in LRU list\n", result->bv_val, 0, 0 );
1730 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1731 BER_BVZERO( result );
1736 temp = bottom->qtemp;
1737 remove_query(qm, bottom);
1738 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1740 *result = bottom->q_uuid;
1741 BER_BVZERO( &bottom->q_uuid );
1743 Debug( pcache_debug, "Lock CR index = %p\n", (void *) temp, 0, 0 );
1744 ldap_pvt_thread_rdwr_wlock(&temp->t_rwlock);
1745 remove_from_template(bottom, temp);
1746 Debug( pcache_debug, "TEMPLATE %p QUERIES-- %d\n",
1747 (void *) temp, temp->no_of_queries, 0 );
1748 Debug( pcache_debug, "Unlock CR index = %p\n", (void *) temp, 0, 0 );
1749 ldap_pvt_thread_rdwr_wunlock(&temp->t_rwlock);
1754 struct query_info *next;
1766 struct query_info *qi;
1769 if ( rs->sr_type != REP_SEARCH ) return 0;
1771 attr = attr_find( rs->sr_entry->e_attrs, ad_queryId );
1772 if ( attr == NULL ) return 0;
1774 count = attr->a_numvals;
1775 assert( count > 0 );
1776 qi = op->o_tmpalloc( sizeof( struct query_info ), op->o_tmpmemctx );
1777 qi->next = op->o_callback->sc_private;
1778 op->o_callback->sc_private = qi;
1779 ber_dupbv_x( &qi->xdn, &rs->sr_entry->e_nname, op->o_tmpmemctx );
1780 qi->del = ( count == 1 );
1788 struct berval *query_uuid )
1790 struct query_info *qi, *qnext;
1791 char filter_str[ LDAP_LUTIL_UUIDSTR_BUFSIZE + STRLENOF( "(pcacheQueryID=)" ) ];
1792 AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
1793 Filter filter = {LDAP_FILTER_EQUALITY};
1794 SlapReply sreply = {REP_RESULT};
1795 slap_callback cb = { NULL, remove_func, NULL, NULL };
1798 op->ors_filterstr.bv_len = snprintf(filter_str, sizeof(filter_str),
1799 "(%s=%s)", ad_queryId->ad_cname.bv_val, query_uuid->bv_val);
1800 filter.f_ava = &ava;
1801 filter.f_av_desc = ad_queryId;
1802 filter.f_av_value = *query_uuid;
1804 op->o_tag = LDAP_REQ_SEARCH;
1805 op->o_protocol = LDAP_VERSION3;
1806 op->o_callback = &cb;
1807 op->o_time = slap_get_time();
1808 op->o_do_not_cache = 1;
1810 op->o_req_dn = op->o_bd->be_suffix[0];
1811 op->o_req_ndn = op->o_bd->be_nsuffix[0];
1812 op->ors_scope = LDAP_SCOPE_SUBTREE;
1813 op->ors_deref = LDAP_DEREF_NEVER;
1814 op->ors_slimit = SLAP_NO_LIMIT;
1815 op->ors_tlimit = SLAP_NO_LIMIT;
1816 op->ors_limit = NULL;
1817 op->ors_filter = &filter;
1818 op->ors_filterstr.bv_val = filter_str;
1819 op->ors_filterstr.bv_len = strlen(filter_str);
1820 op->ors_attrs = NULL;
1821 op->ors_attrsonly = 0;
1823 op->o_bd->be_search( op, &sreply );
1825 for ( qi=cb.sc_private; qi; qi=qnext ) {
1828 op->o_req_dn = qi->xdn;
1829 op->o_req_ndn = qi->xdn;
1830 rs_reinit( &sreply, REP_RESULT );
1833 Debug( pcache_debug, "DELETING ENTRY TEMPLATE=%s\n",
1834 query_uuid->bv_val, 0, 0 );
1836 op->o_tag = LDAP_REQ_DELETE;
1838 if (op->o_bd->be_delete(op, &sreply) == LDAP_SUCCESS) {
1844 struct berval vals[2];
1846 vals[0] = *query_uuid;
1847 vals[1].bv_val = NULL;
1849 mod.sml_op = LDAP_MOD_DELETE;
1851 mod.sml_desc = ad_queryId;
1852 mod.sml_type = ad_queryId->ad_cname;
1853 mod.sml_values = vals;
1854 mod.sml_nvalues = NULL;
1855 mod.sml_numvals = 1;
1856 mod.sml_next = NULL;
1857 Debug( pcache_debug,
1858 "REMOVING TEMP ATTR : TEMPLATE=%s\n",
1859 query_uuid->bv_val, 0, 0 );
1861 op->orm_modlist = &mod;
1863 op->o_bd->be_modify( op, &sreply );
1865 op->o_tmpfree( qi->xdn.bv_val, op->o_tmpmemctx );
1866 op->o_tmpfree( qi, op->o_tmpmemctx );
1873 AttributeName* attrs,
1882 struct berval *fstr )
1884 AttributeDescription *ad;
1887 switch ( f->f_choice ) {
1888 case LDAP_FILTER_EQUALITY:
1890 len = STRLENOF( "(=)" ) + ad->ad_cname.bv_len;
1891 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s=)", ad->ad_cname.bv_val );
1892 assert( ret == len );
1893 fstr->bv_len += len;
1896 case LDAP_FILTER_GE:
1898 len = STRLENOF( "(>=)" ) + ad->ad_cname.bv_len;
1899 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s>=)", ad->ad_cname.bv_val);
1900 assert( ret == len );
1901 fstr->bv_len += len;
1904 case LDAP_FILTER_LE:
1906 len = STRLENOF( "(<=)" ) + ad->ad_cname.bv_len;
1907 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s<=)", ad->ad_cname.bv_val);
1908 assert( ret == len );
1909 fstr->bv_len += len;
1912 case LDAP_FILTER_APPROX:
1914 len = STRLENOF( "(~=)" ) + ad->ad_cname.bv_len;
1915 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s~=)", ad->ad_cname.bv_val);
1916 assert( ret == len );
1917 fstr->bv_len += len;
1920 case LDAP_FILTER_SUBSTRINGS:
1922 len = STRLENOF( "(=)" ) + ad->ad_cname.bv_len;
1923 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s=)", ad->ad_cname.bv_val );
1924 assert( ret == len );
1925 fstr->bv_len += len;
1928 case LDAP_FILTER_PRESENT:
1930 len = STRLENOF( "(=*)" ) + ad->ad_cname.bv_len;
1931 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s=*)", ad->ad_cname.bv_val );
1932 assert( ret == len );
1933 fstr->bv_len += len;
1936 case LDAP_FILTER_AND:
1937 case LDAP_FILTER_OR:
1938 case LDAP_FILTER_NOT: {
1940 fstr->bv_val[fstr->bv_len++] = '(';
1941 switch ( f->f_choice ) {
1942 case LDAP_FILTER_AND:
1943 fstr->bv_val[fstr->bv_len] = '&';
1945 case LDAP_FILTER_OR:
1946 fstr->bv_val[fstr->bv_len] = '|';
1948 case LDAP_FILTER_NOT:
1949 fstr->bv_val[fstr->bv_len] = '!';
1954 for ( f = f->f_list; f != NULL; f = f->f_next ) {
1955 rc = filter2template( op, f, fstr );
1958 fstr->bv_val[fstr->bv_len++] = ')';
1959 fstr->bv_val[fstr->bv_len] = '\0';
1965 /* a filter should at least have room for "()",
1966 * an "=" and for a 1-char attr */
1967 strcpy( fstr->bv_val, "(?=)" );
1968 fstr->bv_len += STRLENOF("(?=)");
1975 #define BI_HASHED 0x01
1976 #define BI_DIDCB 0x02
1977 #define BI_LOOKUP 0x04
1981 typedef struct bindinfo {
1982 cache_manager *bi_cm;
1984 QueryTemplate *bi_templ;
1985 struct search_info *bi_si;
1987 slap_callback bi_cb;
1990 struct search_info {
1993 QueryTemplate *qtemp;
1994 AttributeName* save_attrs; /* original attributes, saved for response */
1995 int swap_saved_attrs;
2000 int slimit_exceeded;
2001 pc_caching_reason_t caching_reason;
2007 remove_query_and_data(
2010 struct berval *uuid )
2012 query_manager* qm = cm->qm;
2014 qm->crfunc( qm, uuid );
2015 if ( !BER_BVISNULL( uuid ) ) {
2018 Debug( pcache_debug,
2019 "Removing query UUID %s\n",
2020 uuid->bv_val, 0, 0 );
2021 return_val = remove_query_data( op, uuid );
2022 Debug( pcache_debug,
2023 "QUERY REMOVED, SIZE=%d\n",
2025 ldap_pvt_thread_mutex_lock( &cm->cache_mutex );
2026 cm->cur_entries -= return_val;
2027 cm->num_cached_queries--;
2028 Debug( pcache_debug,
2029 "STORED QUERIES = %lu\n",
2030 cm->num_cached_queries, 0, 0 );
2031 ldap_pvt_thread_mutex_unlock( &cm->cache_mutex );
2032 Debug( pcache_debug,
2033 "QUERY REMOVED, CACHE ="
2035 cm->cur_entries, 0, 0 );
2040 * Callback used to fetch queryId values based on entryUUID;
2041 * used by pcache_remove_entries_from_cache()
2044 fetch_queryId_cb( Operation *op, SlapReply *rs )
2048 /* only care about searchEntry responses */
2049 if ( rs->sr_type != REP_SEARCH ) {
2053 /* allow only one response per entryUUID */
2054 if ( op->o_callback->sc_private != NULL ) {
2060 /* copy all queryId values into callback's private data */
2061 a = attr_find( rs->sr_entry->e_attrs, ad_queryId );
2063 BerVarray vals = NULL;
2065 ber_bvarray_dup_x( &vals, a->a_nvals, op->o_tmpmemctx );
2066 op->o_callback->sc_private = (void *)vals;
2070 /* clear entry if required */
2071 rs_flush_entry( op, rs, (slap_overinst *) op->o_bd->bd_info );
2077 * Call that allows to remove a set of entries from the cache,
2078 * by forcing the removal of all the related queries.
2081 pcache_remove_entries_from_cache(
2084 BerVarray entryUUIDs )
2086 Connection conn = { 0 };
2087 OperationBuffer opbuf;
2089 slap_callback sc = { 0 };
2091 char filtbuf[ LDAP_LUTIL_UUIDSTR_BUFSIZE + STRLENOF( "(entryUUID=)" ) ];
2092 AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
2093 AttributeName attrs[ 2 ] = {{{ 0 }}};
2097 void *thrctx = ldap_pvt_thread_pool_context();
2099 connection_fake_init( &conn, &opbuf, thrctx );
2107 memset( &op->oq_search, 0, sizeof( op->oq_search ) );
2108 op->ors_scope = LDAP_SCOPE_SUBTREE;
2109 op->ors_deref = LDAP_DEREF_NEVER;
2110 f.f_choice = LDAP_FILTER_EQUALITY;
2112 ava.aa_desc = slap_schema.si_ad_entryUUID;
2113 op->ors_filter = &f;
2115 op->ors_tlimit = SLAP_NO_LIMIT;
2116 op->ors_limit = NULL;
2117 attrs[ 0 ].an_desc = ad_queryId;
2118 attrs[ 0 ].an_name = ad_queryId->ad_cname;
2119 op->ors_attrs = attrs;
2120 op->ors_attrsonly = 0;
2122 op->o_req_dn = cm->db.be_suffix[ 0 ];
2123 op->o_req_ndn = cm->db.be_nsuffix[ 0 ];
2125 op->o_tag = LDAP_REQ_SEARCH;
2126 op->o_protocol = LDAP_VERSION3;
2127 op->o_managedsait = SLAP_CONTROL_CRITICAL;
2129 op->o_dn = op->o_bd->be_rootdn;
2130 op->o_ndn = op->o_bd->be_rootndn;
2131 sc.sc_response = fetch_queryId_cb;
2132 op->o_callback = ≻
2134 for ( s = 0; !BER_BVISNULL( &entryUUIDs[ s ] ); s++ ) {
2135 BerVarray vals = NULL;
2136 SlapReply rs = { REP_RESULT };
2138 op->ors_filterstr.bv_len = snprintf( filtbuf, sizeof( filtbuf ),
2139 "(entryUUID=%s)", entryUUIDs[ s ].bv_val );
2140 op->ors_filterstr.bv_val = filtbuf;
2141 ava.aa_value = entryUUIDs[ s ];
2143 rc = op->o_bd->be_search( op, &rs );
2144 if ( rc != LDAP_SUCCESS ) {
2148 vals = (BerVarray)op->o_callback->sc_private;
2149 if ( vals != NULL ) {
2152 for ( i = 0; !BER_BVISNULL( &vals[ i ] ); i++ ) {
2153 struct berval val = vals[ i ];
2155 remove_query_and_data( op, cm, &val );
2157 if ( !BER_BVISNULL( &val ) && val.bv_val != vals[ i ].bv_val ) {
2158 ch_free( val.bv_val );
2162 ber_bvarray_free_x( vals, op->o_tmpmemctx );
2163 op->o_callback->sc_private = NULL;
2171 * Call that allows to remove a query from the cache.
2174 pcache_remove_query_from_cache(
2177 struct berval *queryid )
2179 Operation op2 = *op;
2183 /* remove the selected query */
2184 remove_query_and_data( &op2, cm, queryid );
2186 return LDAP_SUCCESS;
2190 * Call that allows to remove a set of queries related to an entry
2191 * from the cache; if queryid is not null, the entry must belong to
2192 * the query indicated by queryid.
2195 pcache_remove_entry_queries_from_cache(
2199 struct berval *queryid )
2201 Connection conn = { 0 };
2202 OperationBuffer opbuf;
2204 slap_callback sc = { 0 };
2205 SlapReply rs = { REP_RESULT };
2207 char filter_str[ LDAP_LUTIL_UUIDSTR_BUFSIZE + STRLENOF( "(pcacheQueryID=)" ) ];
2208 AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
2209 AttributeName attrs[ 2 ] = {{{ 0 }}};
2212 BerVarray vals = NULL;
2215 void *thrctx = ldap_pvt_thread_pool_context();
2217 connection_fake_init( &conn, &opbuf, thrctx );
2225 memset( &op->oq_search, 0, sizeof( op->oq_search ) );
2226 op->ors_scope = LDAP_SCOPE_BASE;
2227 op->ors_deref = LDAP_DEREF_NEVER;
2228 if ( queryid == NULL || BER_BVISNULL( queryid ) ) {
2229 BER_BVSTR( &op->ors_filterstr, "(objectClass=*)" );
2230 f.f_choice = LDAP_FILTER_PRESENT;
2231 f.f_desc = slap_schema.si_ad_objectClass;
2234 op->ors_filterstr.bv_len = snprintf( filter_str,
2235 sizeof( filter_str ), "(%s=%s)",
2236 ad_queryId->ad_cname.bv_val, queryid->bv_val );
2237 f.f_choice = LDAP_FILTER_EQUALITY;
2239 f.f_av_desc = ad_queryId;
2240 f.f_av_value = *queryid;
2242 op->ors_filter = &f;
2244 op->ors_tlimit = SLAP_NO_LIMIT;
2245 op->ors_limit = NULL;
2246 attrs[ 0 ].an_desc = ad_queryId;
2247 attrs[ 0 ].an_name = ad_queryId->ad_cname;
2248 op->ors_attrs = attrs;
2249 op->ors_attrsonly = 0;
2251 op->o_req_dn = *ndn;
2252 op->o_req_ndn = *ndn;
2254 op->o_tag = LDAP_REQ_SEARCH;
2255 op->o_protocol = LDAP_VERSION3;
2256 op->o_managedsait = SLAP_CONTROL_CRITICAL;
2258 op->o_dn = op->o_bd->be_rootdn;
2259 op->o_ndn = op->o_bd->be_rootndn;
2260 sc.sc_response = fetch_queryId_cb;
2261 op->o_callback = ≻
2263 rc = op->o_bd->be_search( op, &rs );
2264 if ( rc != LDAP_SUCCESS ) {
2268 vals = (BerVarray)op->o_callback->sc_private;
2269 if ( vals != NULL ) {
2272 for ( i = 0; !BER_BVISNULL( &vals[ i ] ); i++ ) {
2273 struct berval val = vals[ i ];
2275 remove_query_and_data( op, cm, &val );
2277 if ( !BER_BVISNULL( &val ) && val.bv_val != vals[ i ].bv_val ) {
2278 ch_free( val.bv_val );
2282 ber_bvarray_free_x( vals, op->o_tmpmemctx );
2285 return LDAP_SUCCESS;
2291 struct berval *query_uuid )
2293 struct search_info *si = op->o_callback->sc_private;
2294 slap_overinst *on = si->on;
2295 cache_manager *cm = on->on_bi.bi_private;
2298 struct berval crp_uuid;
2299 char uuidbuf[ LDAP_LUTIL_UUIDSTR_BUFSIZE ];
2301 Connection conn = {0};
2302 OperationBuffer opbuf;
2303 void *thrctx = ldap_pvt_thread_pool_context();
2305 query_uuid->bv_len = lutil_uuidstr(uuidbuf, sizeof(uuidbuf));
2306 ber_str2bv(uuidbuf, query_uuid->bv_len, 1, query_uuid);
2308 connection_fake_init2( &conn, &opbuf, thrctx, 0 );
2309 op_tmp = &opbuf.ob_op;
2310 op_tmp->o_bd = &cm->db;
2311 op_tmp->o_dn = cm->db.be_rootdn;
2312 op_tmp->o_ndn = cm->db.be_rootndn;
2314 Debug( pcache_debug, "UUID for query being added = %s\n",
2317 for ( e=si->head; e; e=si->head ) {
2318 si->head = e->e_private;
2319 e->e_private = NULL;
2320 while ( cm->cur_entries > (cm->max_entries) ) {
2321 BER_BVZERO( &crp_uuid );
2322 remove_query_and_data( op_tmp, cm, &crp_uuid );
2325 return_val = merge_entry(op_tmp, e, 0, query_uuid);
2326 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
2327 cm->cur_entries += return_val;
2328 Debug( pcache_debug,
2329 "ENTRY ADDED/MERGED, CACHED ENTRIES=%d\n",
2330 cm->cur_entries, 0, 0 );
2332 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
2339 pcache_op_cleanup( Operation *op, SlapReply *rs ) {
2340 slap_callback *cb = op->o_callback;
2341 struct search_info *si = cb->sc_private;
2342 slap_overinst *on = si->on;
2343 cache_manager *cm = on->on_bi.bi_private;
2344 query_manager* qm = cm->qm;
2346 if ( rs->sr_type == REP_SEARCH ) {
2349 /* don't return more entries than requested by the client */
2350 if ( si->slimit > 0 && rs->sr_nentries >= si->slimit ) {
2351 si->slimit_exceeded = 1;
2354 /* If we haven't exceeded the limit for this query,
2355 * build a chain of answers to store. If we hit the
2356 * limit, empty the chain and ignore the rest.
2359 /* check if the entry contains undefined
2360 * attributes/objectClasses (ITS#5680) */
2361 if ( cm->check_cacheability && test_filter( op, rs->sr_entry, si->query.filter ) != LDAP_COMPARE_TRUE ) {
2362 Debug( pcache_debug, "%s: query not cacheable because of schema issues in DN \"%s\"\n",
2363 op->o_log_prefix, rs->sr_entry->e_name.bv_val, 0 );
2367 /* check for malformed entries: attrs with no values */
2369 Attribute *a = rs->sr_entry->e_attrs;
2370 for (; a; a=a->a_next) {
2371 if ( !a->a_numvals ) {
2372 Debug( pcache_debug, "%s: query not cacheable because of attrs without values in DN \"%s\" (%s)\n",
2373 op->o_log_prefix, rs->sr_entry->e_name.bv_val,
2374 a->a_desc->ad_cname.bv_val );
2380 if ( si->count < si->max ) {
2382 e = entry_dup( rs->sr_entry );
2383 if ( !si->head ) si->head = e;
2384 if ( si->tail ) si->tail->e_private = e;
2391 for (;si->head; si->head=e) {
2392 e = si->head->e_private;
2393 si->head->e_private = NULL;
2394 entry_free(si->head);
2402 if ( rs->sr_type == REP_RESULT ||
2403 op->o_abandon || rs->sr_err == SLAPD_ABANDON )
2405 if ( si->swap_saved_attrs ) {
2406 rs->sr_attrs = si->save_attrs;
2407 op->ors_attrs = si->save_attrs;
2409 if ( (op->o_abandon || rs->sr_err == SLAPD_ABANDON) &&
2410 si->caching_reason == PC_IGNORE )
2412 filter_free( si->query.filter );
2414 /* duplicate query, free it */
2416 for (;si->head; si->head=e) {
2417 e = si->head->e_private;
2418 si->head->e_private = NULL;
2419 entry_free(si->head);
2423 } else if ( si->caching_reason != PC_IGNORE ) {
2424 CachedQuery *qc = qm->addfunc(op, qm, &si->query,
2425 si->qtemp, si->caching_reason, 1 );
2428 switch ( si->caching_reason ) {
2430 cache_entries( op, &qc->q_uuid );
2433 si->pbi->bi_cq = qc;
2438 qc->q_sizelimit = rs->sr_nentries;
2448 ldap_pvt_thread_rdwr_wunlock(&qc->rwlock);
2449 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
2450 cm->num_cached_queries++;
2451 Debug( pcache_debug, "STORED QUERIES = %lu\n",
2452 cm->num_cached_queries, 0, 0 );
2453 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
2455 /* If the consistency checker suspended itself,
2458 if ( cm->cc_paused == PCACHE_CC_PAUSED ) {
2459 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
2460 if ( cm->cc_paused == PCACHE_CC_PAUSED ) {
2462 ldap_pvt_runqueue_resched( &slapd_rq, cm->cc_arg, 0 );
2464 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
2467 } else if ( si->count ) {
2468 /* duplicate query, free it */
2470 for (;si->head; si->head=e) {
2471 e = si->head->e_private;
2472 si->head->e_private = NULL;
2473 entry_free(si->head);
2478 filter_free( si->query.filter );
2481 op->o_callback = op->o_callback->sc_next;
2482 op->o_tmpfree( cb, op->o_tmpmemctx );
2485 return SLAP_CB_CONTINUE;
2493 struct search_info *si = op->o_callback->sc_private;
2495 if ( si->swap_saved_attrs ) {
2496 rs->sr_attrs = si->save_attrs;
2497 op->ors_attrs = si->save_attrs;
2500 if ( rs->sr_type == REP_SEARCH ) {
2501 /* don't return more entries than requested by the client */
2502 if ( si->slimit_exceeded ) {
2506 } else if ( rs->sr_type == REP_RESULT ) {
2509 if ( rs->sr_err == LDAP_SUCCESS ) {
2510 si->caching_reason = PC_POSITIVE;
2512 } else if ( rs->sr_err == LDAP_SIZELIMIT_EXCEEDED
2513 && si->qtemp->limitttl )
2517 si->caching_reason = PC_SIZELIMIT;
2518 for (;si->head; si->head=e) {
2519 e = si->head->e_private;
2520 si->head->e_private = NULL;
2521 entry_free(si->head);
2525 } else if ( si->qtemp->negttl && !si->count && !si->over &&
2526 rs->sr_err == LDAP_SUCCESS )
2528 si->caching_reason = PC_NEGATIVE;
2532 if ( si->slimit_exceeded ) {
2533 rs->sr_err = LDAP_SIZELIMIT_EXCEEDED;
2537 return SLAP_CB_CONTINUE;
2540 /* NOTE: this is a quick workaround to let pcache minimally interact
2541 * with pagedResults. A more articulated solutions would be to
2542 * perform the remote query without control and cache all results,
2543 * performing the pagedResults search only within the client
2544 * and the proxy. This requires pcache to understand pagedResults. */
2546 pcache_chk_controls(
2550 const char *non = "";
2551 const char *stripped = "";
2553 switch( op->o_pagedresults ) {
2554 case SLAP_CONTROL_NONCRITICAL:
2556 stripped = "; stripped";
2559 case SLAP_CONTROL_CRITICAL:
2560 Debug( pcache_debug, "%s: "
2561 "%scritical pagedResults control "
2562 "disabled with proxy cache%s.\n",
2563 op->o_log_prefix, non, stripped );
2565 slap_remove_control( op, rs, slap_cids.sc_pagedResults, NULL );
2569 rs->sr_err = SLAP_CB_CONTINUE;
2577 pc_setpw( Operation *op, struct berval *pwd, cache_manager *cm )
2579 struct berval vals[2];
2582 const char *text = NULL;
2583 BER_BVZERO( &vals[0] );
2584 slap_passwd_hash( pwd, &vals[0], &text );
2585 if ( BER_BVISEMPTY( &vals[0] )) {
2586 Debug( pcache_debug, "pc_setpw: hash failed %s\n",
2592 BER_BVZERO( &vals[1] );
2596 SlapReply sr = { REP_RESULT };
2597 slap_callback cb = { 0, slap_null_cb, 0, 0 };
2600 mod.sml_op = LDAP_MOD_REPLACE;
2602 mod.sml_desc = slap_schema.si_ad_userPassword;
2603 mod.sml_type = mod.sml_desc->ad_cname;
2604 mod.sml_values = vals;
2605 mod.sml_nvalues = NULL;
2606 mod.sml_numvals = 1;
2607 mod.sml_next = NULL;
2609 op->o_tag = LDAP_REQ_MODIFY;
2610 op->orm_modlist = &mod;
2612 op->o_dn = op->o_bd->be_rootdn;
2613 op->o_ndn = op->o_bd->be_rootndn;
2614 op->o_callback = &cb;
2615 Debug( pcache_debug, "pc_setpw: CACHING BIND for %s\n",
2616 op->o_req_dn.bv_val, 0, 0 );
2617 rc = op->o_bd->be_modify( op, &sr );
2618 ch_free( vals[0].bv_val );
2623 typedef struct bindcacheinfo {
2629 pc_bind_save( Operation *op, SlapReply *rs )
2631 if ( rs->sr_err == LDAP_SUCCESS ) {
2632 bindcacheinfo *bci = op->o_callback->sc_private;
2633 slap_overinst *on = bci->on;
2634 cache_manager *cm = on->on_bi.bi_private;
2635 CachedQuery *qc = bci->qc;
2638 ldap_pvt_thread_rdwr_wlock( &qc->rwlock );
2639 if ( qc->bind_refcnt-- ) {
2640 Operation op2 = *op;
2641 if ( pc_setpw( &op2, &op->orb_cred, cm ) == LDAP_SUCCESS )
2642 bci->qc->bindref_time = op->o_time + bci->qc->qtemp->bindttr;
2647 ldap_pvt_thread_rdwr_wunlock( &qc->rwlock );
2648 if ( delete ) free_query(qc);
2650 return SLAP_CB_CONTINUE;
2654 pc_bind_attrs( Operation *op, Entry *e, QueryTemplate *temp,
2655 struct berval *fbv )
2658 struct berval *vals, pres = BER_BVC("*");
2662 vals = op->o_tmpalloc( temp->bindnattrs * sizeof( struct berval ),
2665 for ( i=0; i<temp->bindnattrs; i++ ) {
2666 a = attr_find( e->e_attrs, temp->bindfattrs[i] );
2667 if ( a && a->a_vals ) {
2668 vals[i] = a->a_vals[0];
2669 len += a->a_vals[0].bv_len;
2674 fbv->bv_len = len + temp->bindftemp.bv_len;
2675 fbv->bv_val = op->o_tmpalloc( fbv->bv_len + 1, op->o_tmpmemctx );
2677 p1 = temp->bindftemp.bv_val;
2682 if ( p1[0] == '=' && p1[1] == ')' ) {
2683 AC_MEMCPY( p2, vals[i].bv_val, vals[i].bv_len );
2684 p2 += vals[i].bv_len;
2690 op->o_tmpfree( vals, op->o_tmpmemctx );
2692 /* FIXME: are we sure str2filter_x can't fail?
2693 * caller needs to check */
2695 Filter *f = str2filter_x( op, fbv->bv_val );
2696 assert( f != NULL );
2701 /* Check if the requested entry is from the cache and has a valid
2702 * ttr and password hash
2705 pc_bind_search( Operation *op, SlapReply *rs )
2707 if ( rs->sr_type == REP_SEARCH ) {
2708 bindinfo *pbi = op->o_callback->sc_private;
2710 /* We only care if this is an already cached result and we're
2711 * below the refresh time, or we're offline.
2714 if (( pbi->bi_cm->cc_paused & PCACHE_CC_OFFLINE ) ||
2715 op->o_time < pbi->bi_cq->bindref_time ) {
2718 /* See if a recognized password is hashed here */
2719 a = attr_find( rs->sr_entry->e_attrs,
2720 slap_schema.si_ad_userPassword );
2721 if ( a && a->a_vals[0].bv_val[0] == '{' &&
2722 lutil_passwd_scheme( a->a_vals[0].bv_val ))
2723 pbi->bi_flags |= BI_HASHED;
2725 Debug( pcache_debug, "pc_bind_search: cache is stale, "
2726 "reftime: %ld, current time: %ld\n",
2727 pbi->bi_cq->bindref_time, op->o_time, 0 );
2729 } else if ( pbi->bi_si ) {
2730 /* This search result is going into the cache */
2734 filter_free( pbi->bi_si->query.filter );
2735 f = pc_bind_attrs( op, rs->sr_entry, pbi->bi_templ, &fbv );
2736 op->o_tmpfree( fbv.bv_val, op->o_tmpmemctx );
2737 pbi->bi_si->query.filter = filter_dup( f, NULL );
2738 filter_free_x( op, f, 1 );
2744 /* We always want pc_bind_search to run after the search handlers */
2746 pc_bind_resp( Operation *op, SlapReply *rs )
2748 bindinfo *pbi = op->o_callback->sc_private;
2749 if ( !( pbi->bi_flags & BI_DIDCB )) {
2750 slap_callback *sc = op->o_callback;
2751 while ( sc && sc->sc_response != pcache_response )
2754 sc = op->o_callback;
2755 pbi->bi_cb.sc_next = sc->sc_next;
2756 sc->sc_next = &pbi->bi_cb;
2757 pbi->bi_flags |= BI_DIDCB;
2759 return SLAP_CB_CONTINUE;
2762 #ifdef PCACHE_CONTROL_PRIVDB
2768 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
2769 cache_manager *cm = on->on_bi.bi_private;
2770 slap_callback *save_cb;
2773 /* skip if control is unset */
2774 if ( op->o_ctrlflag[ privDB_cid ] != SLAP_CONTROL_CRITICAL ) {
2775 return SLAP_CB_CONTINUE;
2778 /* The cache DB isn't open yet */
2779 if ( cm->defer_db_open ) {
2780 send_ldap_error( op, rs, LDAP_UNAVAILABLE,
2781 "pcachePrivDB: cacheDB not available" );
2785 /* FIXME: might be a little bit exaggerated... */
2786 if ( !be_isroot( op ) ) {
2787 save_cb = op->o_callback;
2788 op->o_callback = NULL;
2789 send_ldap_error( op, rs, LDAP_UNWILLING_TO_PERFORM,
2790 "pcachePrivDB: operation not allowed" );
2791 op->o_callback = save_cb;
2796 /* map tag to operation */
2797 type = slap_req2op( op->o_tag );
2798 if ( type != SLAP_OP_LAST ) {
2802 /* execute, if possible */
2803 func = &cm->db.be_bind;
2804 if ( func[ type ] != NULL ) {
2805 Operation op2 = *op;
2809 rc = func[ type ]( &op2, rs );
2810 if ( type == SLAP_OP_BIND && rc == LDAP_SUCCESS ) {
2811 op->o_conn->c_authz_cookie = cm->db.be_private;
2818 /* otherwise fall back to error */
2819 save_cb = op->o_callback;
2820 op->o_callback = NULL;
2821 send_ldap_error( op, rs, LDAP_UNWILLING_TO_PERFORM,
2822 "operation not supported with pcachePrivDB control" );
2823 op->o_callback = save_cb;
2827 #endif /* PCACHE_CONTROL_PRIVDB */
2834 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
2835 cache_manager *cm = on->on_bi.bi_private;
2836 QueryTemplate *temp;
2838 slap_callback cb = { 0 }, *sc;
2844 #ifdef PCACHE_CONTROL_PRIVDB
2845 if ( op->o_ctrlflag[ privDB_cid ] == SLAP_CONTROL_CRITICAL )
2846 return pcache_op_privdb( op, rs );
2847 #endif /* PCACHE_CONTROL_PRIVDB */
2849 /* Skip if we're not configured for Binds, or cache DB isn't open yet */
2850 if ( !cm->cache_binds || cm->defer_db_open )
2851 return SLAP_CB_CONTINUE;
2853 /* First find a matching template with Bind info */
2854 for ( temp=cm->qm->templates; temp; temp=temp->qmnext ) {
2855 if ( temp->bindttr && dnIsSuffix( &op->o_req_ndn, &temp->bindbase ))
2858 /* Didn't find a suitable template, just passthru */
2860 return SLAP_CB_CONTINUE;
2862 /* See if the entry is already locally cached. If so, we can
2863 * populate the query filter to retrieve the cached query. We
2864 * need to check the bindrefresh time in the query.
2867 op2.o_dn = op->o_bd->be_rootdn;
2868 op2.o_ndn = op->o_bd->be_rootndn;
2873 rc = be_entry_get_rw( &op2, &op->o_req_ndn, NULL, NULL, 0, &e );
2874 if ( rc == LDAP_SUCCESS && e ) {
2875 bi.bi_flags |= BI_LOOKUP;
2876 op2.ors_filter = pc_bind_attrs( op, e, temp, &op2.ors_filterstr );
2877 be_entry_release_r( &op2, e );
2879 op2.ors_filter = temp->bindfilter;
2880 op2.ors_filterstr = temp->bindfilterstr;
2883 op2.o_bd = op->o_bd;
2884 op2.o_tag = LDAP_REQ_SEARCH;
2885 op2.ors_scope = LDAP_SCOPE_BASE;
2886 op2.ors_deref = LDAP_DEREF_NEVER;
2888 op2.ors_tlimit = SLAP_NO_LIMIT;
2889 op2.ors_limit = NULL;
2890 op2.ors_attrs = cm->qm->attr_sets[temp->attr_set_index].attrs;
2891 op2.ors_attrsonly = 0;
2893 /* We want to invoke search at the same level of the stack
2894 * as we're already at...
2901 bi.bi_cb.sc_response = pc_bind_search;
2902 bi.bi_cb.sc_cleanup = NULL;
2903 bi.bi_cb.sc_private = &bi;
2904 cb.sc_private = &bi;
2905 cb.sc_response = pc_bind_resp;
2906 op2.o_callback = &cb;
2907 overlay_op_walk( &op2, rs, op_search, on->on_info, on );
2909 /* OK, just bind locally */
2910 if ( bi.bi_flags & BI_HASHED ) {
2911 BackendDB *be = op->o_bd;
2915 Debug( pcache_debug, "pcache_op_bind: CACHED BIND for %s\n",
2916 op->o_req_dn.bv_val, 0, 0 );
2918 if ( op->o_bd->be_bind( op, rs ) == LDAP_SUCCESS ) {
2919 op->o_conn->c_authz_cookie = cm->db.be_private;
2922 ldap_pvt_thread_rdwr_wlock( &bi.bi_cq->rwlock );
2923 if ( !bi.bi_cq->bind_refcnt-- ) {
2926 ldap_pvt_thread_rdwr_wunlock( &bi.bi_cq->rwlock );
2927 if ( delete ) free_query( bi.bi_cq );
2931 /* We have a cached query to work with */
2933 sc = op->o_tmpalloc( sizeof(slap_callback) + sizeof(bindcacheinfo),
2935 sc->sc_response = pc_bind_save;
2936 sc->sc_cleanup = NULL;
2937 sc->sc_private = sc+1;
2938 bci = sc->sc_private;
2939 sc->sc_next = op->o_callback;
2940 op->o_callback = sc;
2944 return SLAP_CB_CONTINUE;
2947 static slap_response refresh_merge;
2954 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
2955 cache_manager *cm = on->on_bi.bi_private;
2956 query_manager* qm = cm->qm;
2961 QueryTemplate *qtemp = NULL;
2962 bindinfo *pbi = NULL;
2965 CachedQuery *answerable = NULL;
2968 struct berval tempstr;
2970 #ifdef PCACHE_CONTROL_PRIVDB
2971 if ( op->o_ctrlflag[ privDB_cid ] == SLAP_CONTROL_CRITICAL ) {
2972 return pcache_op_privdb( op, rs );
2974 #endif /* PCACHE_CONTROL_PRIVDB */
2976 /* The cache DB isn't open yet */
2977 if ( cm->defer_db_open ) {
2978 send_ldap_error( op, rs, LDAP_UNAVAILABLE,
2979 "pcachePrivDB: cacheDB not available" );
2983 /* pickup runtime ACL changes */
2984 cm->db.be_acl = op->o_bd->be_acl;
2987 /* See if we're processing a Bind request
2988 * or a cache refresh */
2989 slap_callback *cb = op->o_callback;
2991 for ( ; cb; cb=cb->sc_next ) {
2992 if ( cb->sc_response == pc_bind_resp ) {
2993 pbi = cb->sc_private;
2996 if ( cb->sc_response == refresh_merge ) {
2997 /* This is a refresh, do not search the cache */
2998 return SLAP_CB_CONTINUE;
3003 /* FIXME: cannot cache/answer requests with pagedResults control */
3005 query.filter = op->ors_filter;
3008 query.base = pbi->bi_templ->bindbase;
3009 query.scope = pbi->bi_templ->bindscope;
3010 attr_set = pbi->bi_templ->attr_set_index;
3012 qtemp = pbi->bi_templ;
3013 if ( pbi->bi_flags & BI_LOOKUP )
3014 answerable = qm->qcfunc(op, qm, &query, qtemp);
3017 tempstr.bv_val = op->o_tmpalloc( op->ors_filterstr.bv_len+1,
3020 if ( filter2template( op, op->ors_filter, &tempstr ))
3022 op->o_tmpfree( tempstr.bv_val, op->o_tmpmemctx );
3023 return SLAP_CB_CONTINUE;
3026 Debug( pcache_debug, "query template of incoming query = %s\n",
3027 tempstr.bv_val, 0, 0 );
3030 attr_set = get_attr_set(op->ors_attrs, qm, cm->numattrsets);
3032 query.base = op->o_req_ndn;
3033 query.scope = op->ors_scope;
3035 /* check for query containment */
3036 if (attr_set > -1) {
3037 QueryTemplate *qt = qm->attr_sets[attr_set].templates;
3038 for (; qt; qt = qt->qtnext ) {
3039 /* find if template i can potentially answer tempstr */
3040 if ( ber_bvstrcasecmp( &qt->querystr, &tempstr ) != 0 )
3044 Debug( pcache_debug, "Entering QC, querystr = %s\n",
3045 op->ors_filterstr.bv_val, 0, 0 );
3046 answerable = qm->qcfunc(op, qm, &query, qt);
3048 /* if != NULL, rlocks qtemp->t_rwlock */
3053 op->o_tmpfree( tempstr.bv_val, op->o_tmpmemctx );
3057 BackendDB *save_bd = op->o_bd;
3059 ldap_pvt_thread_mutex_lock( &answerable->answerable_cnt_mutex );
3060 answerable->answerable_cnt++;
3061 /* we only care about refcnts if we're refreshing */
3062 if ( answerable->refresh_time )
3063 answerable->refcnt++;
3064 Debug( pcache_debug, "QUERY ANSWERABLE (answered %lu times)\n",
3065 answerable->answerable_cnt, 0, 0 );
3066 ldap_pvt_thread_mutex_unlock( &answerable->answerable_cnt_mutex );
3068 ldap_pvt_thread_rdwr_wlock(&answerable->rwlock);
3069 if ( BER_BVISNULL( &answerable->q_uuid )) {
3070 /* No entries cached, just an empty result set */
3072 send_ldap_result( op, rs );
3074 /* Let Bind know we used a cached query */
3076 answerable->bind_refcnt++;
3077 pbi->bi_cq = answerable;
3081 if ( cm->response_cb == PCACHE_RESPONSE_CB_TAIL ) {
3083 /* The cached entry was already processed by any
3084 * other overlays, so don't let it get processed again.
3086 * This loop removes over_back_response from the stack.
3088 if ( overlay_callback_after_backover( op, &cb, 0) == 0 ) {
3089 slap_callback **scp;
3090 for ( scp = &op->o_callback; *scp != NULL;
3091 scp = &(*scp)->sc_next ) {
3092 if ( (*scp)->sc_next == &cb ) {
3099 i = cm->db.bd_info->bi_op_search( op, rs );
3101 ldap_pvt_thread_rdwr_wunlock(&answerable->rwlock);
3102 /* locked by qtemp->qcfunc (query_containment) */
3103 ldap_pvt_thread_rdwr_runlock(&qtemp->t_rwlock);
3108 Debug( pcache_debug, "QUERY NOT ANSWERABLE\n", 0, 0, 0 );
3110 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
3111 if (cm->num_cached_queries >= cm->max_queries) {
3114 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
3116 if (op->ors_attrsonly)
3121 struct search_info *si;
3123 Debug( pcache_debug, "QUERY CACHEABLE\n", 0, 0, 0 );
3124 query.filter = filter_dup(op->ors_filter, NULL);
3126 cb = op->o_tmpalloc( sizeof(*cb) + sizeof(*si), op->o_tmpmemctx );
3127 cb->sc_response = pcache_response;
3128 cb->sc_cleanup = pcache_op_cleanup;
3129 cb->sc_private = (cb+1);
3130 si = cb->sc_private;
3134 si->max = cm->num_entries_limit ;
3138 si->slimit_exceeded = 0;
3139 si->caching_reason = PC_IGNORE;
3140 if ( op->ors_slimit > 0 && op->ors_slimit < cm->num_entries_limit ) {
3141 si->slimit = op->ors_slimit;
3142 op->ors_slimit = cm->num_entries_limit;
3146 si->swap_saved_attrs = 1;
3147 si->save_attrs = op->ors_attrs;
3152 op->ors_attrs = qtemp->t_attrs.attrs;
3154 if ( cm->response_cb == PCACHE_RESPONSE_CB_HEAD ) {
3155 cb->sc_next = op->o_callback;
3156 op->o_callback = cb;
3159 slap_callback **pcb;
3161 /* need to move the callback at the end, in case other
3162 * overlays are present, so that the final entry is
3163 * actually cached */
3165 for ( pcb = &op->o_callback; *pcb; pcb = &(*pcb)->sc_next );
3170 Debug( pcache_debug, "QUERY NOT CACHEABLE\n",
3174 return SLAP_CB_CONTINUE;
3179 AttributeName* attrs,
3187 for ( ; attrs[i].an_name.bv_val; i++ ) {
3188 /* only count valid attribute names
3189 * (searches ignore others, this overlay does the same) */
3190 if ( attrs[i].an_desc ) {
3196 /* recognize default or explicit single "*" */
3198 ( i == 1 && bvmatch( &attrs[0].an_name, slap_bv_all_user_attrs ) ) )
3201 attrs = slap_anlist_all_user_attributes;
3203 /* recognize implicit (no valid attributes) or explicit single "1.1" */
3204 } else if ( count == 0 ||
3205 ( i == 1 && bvmatch( &attrs[0].an_name, slap_bv_no_attrs ) ) )
3211 for ( i = 0; i < num; i++ ) {
3215 if ( count > qm->attr_sets[i].count ) {
3220 if ( !qm->attr_sets[i].count ) {
3226 for ( a2 = attrs; a2->an_name.bv_val; a2++ ) {
3227 if ( !a2->an_desc && !bvmatch( &a2->an_name, slap_bv_all_user_attrs ) ) continue;
3229 if ( !an_find( qm->attr_sets[i].attrs, &a2->an_name ) ) {
3247 /* Refresh a cached query:
3248 * 1: Replay the query on the remote DB and merge each entry into
3249 * the local DB. Remember the DNs of each remote entry.
3250 * 2: Search the local DB for all entries matching this queryID.
3251 * Delete any entry whose DN is not in the list from (1).
3253 typedef struct dnlist {
3254 struct dnlist *next;
3259 typedef struct refresh_info {
3267 static dnlist *dnl_alloc( Operation *op, struct berval *bvdn )
3269 dnlist *dn = op->o_tmpalloc( sizeof(dnlist) + bvdn->bv_len + 1,
3271 dn->dn.bv_len = bvdn->bv_len;
3272 dn->dn.bv_val = (char *)(dn+1);
3273 AC_MEMCPY( dn->dn.bv_val, bvdn->bv_val, dn->dn.bv_len );
3274 dn->dn.bv_val[dn->dn.bv_len] = '\0';
3279 refresh_merge( Operation *op, SlapReply *rs )
3281 if ( rs->sr_type == REP_SEARCH ) {
3282 refresh_info *ri = op->o_callback->sc_private;
3288 ocb = op->o_callback;
3289 /* Find local entry, merge */
3290 op->o_bd = ri->ri_be;
3291 rc = be_entry_get_rw( op, &rs->sr_entry->e_nname, NULL, NULL, 0, &e );
3292 if ( rc != LDAP_SUCCESS || e == NULL ) {
3293 /* No local entry, just add it. FIXME: we are not checking
3294 * the cache entry limit here
3296 merge_entry( op, rs->sr_entry, 1, &ri->ri_q->q_uuid );
3298 /* Entry exists, update it */
3301 Modifications *modlist, *mods = NULL;
3302 const char* text = NULL;
3303 char textbuf[SLAP_TEXT_BUFLEN];
3304 size_t textlen = sizeof(textbuf);
3305 slap_callback cb = { NULL, slap_null_cb, NULL, NULL };
3309 /* Get a copy of only the attrs we requested */
3310 for ( a=e->e_attrs; a; a=a->a_next ) {
3311 if ( ad_inlist( a->a_desc, rs->sr_attrs )) {
3312 *b = attr_alloc( a->a_desc );
3314 /* The actual values still belong to e */
3315 (*b)->a_flags |= SLAP_ATTR_DONT_FREE_VALS |
3316 SLAP_ATTR_DONT_FREE_DATA;
3317 b = &((*b)->a_next);
3321 slap_entry2mods( rs->sr_entry, &modlist, &text, textbuf, textlen );
3322 syncrepl_diff_entry( op, ne.e_attrs, rs->sr_entry->e_attrs,
3323 &mods, &modlist, 0 );
3324 be_entry_release_r( op, e );
3325 attrs_free( ne.e_attrs );
3326 slap_mods_free( modlist, 1 );
3327 /* mods is NULL if there are no changes */
3329 SlapReply rs2 = { REP_RESULT };
3330 struct berval dn = op->o_req_dn;
3331 struct berval ndn = op->o_req_ndn;
3332 op->o_tag = LDAP_REQ_MODIFY;
3333 op->orm_modlist = mods;
3334 op->o_req_dn = rs->sr_entry->e_name;
3335 op->o_req_ndn = rs->sr_entry->e_nname;
3336 op->o_callback = &cb;
3337 op->o_bd->be_modify( op, &rs2 );
3338 rs->sr_err = rs2.sr_err;
3339 rs_assert_done( &rs2 );
3340 slap_mods_free( mods, 1 );
3342 op->o_req_ndn = ndn;
3346 /* Add DN to list */
3347 dnl = dnl_alloc( op, &rs->sr_entry->e_nname );
3349 if ( ri->ri_tail ) {
3350 ri->ri_tail->next = dnl;
3355 op->o_callback = ocb;
3361 refresh_purge( Operation *op, SlapReply *rs )
3363 if ( rs->sr_type == REP_SEARCH ) {
3364 refresh_info *ri = op->o_callback->sc_private;
3368 /* Did the entry exist on the remote? */
3369 for ( dn=&ri->ri_dns; *dn; dn = &(*dn)->next ) {
3370 if ( dn_match( &(*dn)->dn, &rs->sr_entry->e_nname )) {
3371 dnlist *dnext = (*dn)->next;
3372 op->o_tmpfree( *dn, op->o_tmpmemctx );
3378 /* No, so put it on the list to delete */
3381 dnlist *dnl = dnl_alloc( op, &rs->sr_entry->e_nname );
3382 dnl->next = ri->ri_dels;
3384 a = attr_find( rs->sr_entry->e_attrs, ad_queryId );
3385 /* If ours is the only queryId, delete entry */
3386 dnl->delete = ( a->a_numvals == 1 );
3393 refresh_query( Operation *op, CachedQuery *query, slap_overinst *on )
3395 SlapReply rs = {REP_RESULT};
3396 slap_callback cb = { 0 };
3397 refresh_info ri = { 0 };
3398 char filter_str[ LDAP_LUTIL_UUIDSTR_BUFSIZE + STRLENOF( "(pcacheQueryID=)" ) ];
3399 AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
3400 Filter filter = {LDAP_FILTER_EQUALITY};
3401 AttributeName attrs[ 2 ] = {{{ 0 }}};
3405 ldap_pvt_thread_mutex_lock( &query->answerable_cnt_mutex );
3407 ldap_pvt_thread_mutex_unlock( &query->answerable_cnt_mutex );
3409 cb.sc_response = refresh_merge;
3410 cb.sc_private = &ri;
3413 ri.ri_be = op->o_bd;
3416 op->o_tag = LDAP_REQ_SEARCH;
3417 op->o_protocol = LDAP_VERSION3;
3418 op->o_callback = &cb;
3419 op->o_do_not_cache = 1;
3421 op->o_req_dn = query->qbase->base;
3422 op->o_req_ndn = query->qbase->base;
3423 op->ors_scope = query->scope;
3424 op->ors_slimit = SLAP_NO_LIMIT;
3425 op->ors_tlimit = SLAP_NO_LIMIT;
3426 op->ors_limit = NULL;
3427 op->ors_filter = query->filter;
3428 filter2bv_x( op, query->filter, &op->ors_filterstr );
3429 op->ors_attrs = query->qtemp->t_attrs.attrs;
3430 op->ors_attrsonly = 0;
3432 op->o_bd = on->on_info->oi_origdb;
3433 rc = op->o_bd->be_search( op, &rs );
3435 op->o_bd = ri.ri_be;
3439 /* Get the DNs of all entries matching this query */
3440 cb.sc_response = refresh_purge;
3442 op->o_bd = ri.ri_be;
3443 op->o_req_dn = op->o_bd->be_suffix[0];
3444 op->o_req_ndn = op->o_bd->be_nsuffix[0];
3445 op->ors_scope = LDAP_SCOPE_SUBTREE;
3446 op->ors_deref = LDAP_DEREF_NEVER;
3447 op->ors_filterstr.bv_len = snprintf(filter_str, sizeof(filter_str),
3448 "(%s=%s)", ad_queryId->ad_cname.bv_val, query->q_uuid.bv_val);
3449 filter.f_ava = &ava;
3450 filter.f_av_desc = ad_queryId;
3451 filter.f_av_value = query->q_uuid;
3452 attrs[ 0 ].an_desc = ad_queryId;
3453 attrs[ 0 ].an_name = ad_queryId->ad_cname;
3454 op->ors_attrs = attrs;
3455 op->ors_attrsonly = 0;
3456 rs_reinit( &rs, REP_RESULT );
3457 rc = op->o_bd->be_search( op, &rs );
3458 if ( rc ) goto leave;
3460 while (( dn = ri.ri_dels )) {
3461 op->o_req_dn = dn->dn;
3462 op->o_req_ndn = dn->dn;
3463 rs_reinit( &rs, REP_RESULT );
3465 op->o_tag = LDAP_REQ_DELETE;
3466 op->o_bd->be_delete( op, &rs );
3469 struct berval vals[2];
3471 vals[0] = query->q_uuid;
3472 BER_BVZERO( &vals[1] );
3473 mod.sml_op = LDAP_MOD_DELETE;
3475 mod.sml_desc = ad_queryId;
3476 mod.sml_type = ad_queryId->ad_cname;
3477 mod.sml_values = vals;
3478 mod.sml_nvalues = NULL;
3479 mod.sml_numvals = 1;
3480 mod.sml_next = NULL;
3482 op->o_tag = LDAP_REQ_MODIFY;
3483 op->orm_modlist = &mod;
3484 op->o_bd->be_modify( op, &rs );
3486 ri.ri_dels = dn->next;
3487 op->o_tmpfree( dn, op->o_tmpmemctx );
3491 /* reset our local heap, we're done with it */
3492 slap_sl_mem_create(SLAP_SLAB_SIZE, SLAP_SLAB_STACK, op->o_threadctx, 1 );
3501 struct re_s *rtask = arg;
3502 slap_overinst *on = rtask->arg;
3503 cache_manager *cm = on->on_bi.bi_private;
3504 query_manager *qm = cm->qm;
3505 Connection conn = {0};
3506 OperationBuffer opbuf;
3509 CachedQuery *query, *qprev;
3510 int return_val, pause = PCACHE_CC_PAUSED;
3511 QueryTemplate *templ;
3513 /* Don't expire anything when we're offline */
3514 if ( cm->cc_paused & PCACHE_CC_OFFLINE ) {
3515 pause = PCACHE_CC_OFFLINE;
3519 connection_fake_init( &conn, &opbuf, ctx );
3523 op->o_dn = cm->db.be_rootdn;
3524 op->o_ndn = cm->db.be_rootndn;
3528 for (templ = qm->templates; templ; templ=templ->qmnext) {
3530 if ( !templ->query_last ) continue;
3532 op->o_time = slap_get_time();
3533 if ( !templ->ttr ) {
3535 if ( templ->negttl && templ->negttl < ttl )
3536 ttl = templ->negttl;
3537 if ( templ->limitttl && templ->limitttl < ttl )
3538 ttl = templ->limitttl;
3539 /* The oldest timestamp that needs expiration checking */
3543 for ( query=templ->query_last; query; query=qprev ) {
3544 qprev = query->prev;
3545 if ( query->refresh_time && query->refresh_time < op->o_time ) {
3546 /* A refresh will extend the expiry if the query has been
3547 * referenced, but not if it's unreferenced. If the
3548 * expiration has been hit, then skip the refresh since
3549 * we're just going to discard the result anyway.
3551 if ( query->refcnt )
3552 query->expiry_time = op->o_time + templ->ttl;
3553 if ( query->expiry_time > op->o_time ) {
3554 refresh_query( op, query, on );
3559 if (query->expiry_time < op->o_time) {
3561 Debug( pcache_debug, "Lock CR index = %p\n",
3562 (void *) templ, 0, 0 );
3563 ldap_pvt_thread_rdwr_wlock(&templ->t_rwlock);
3564 if ( query == templ->query_last ) {
3566 remove_from_template(query, templ);
3567 Debug( pcache_debug, "TEMPLATE %p QUERIES-- %d\n",
3568 (void *) templ, templ->no_of_queries, 0 );
3569 Debug( pcache_debug, "Unlock CR index = %p\n",
3570 (void *) templ, 0, 0 );
3573 ldap_pvt_thread_rdwr_wunlock(&templ->t_rwlock);
3576 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
3577 remove_query(qm, query);
3578 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
3579 if ( BER_BVISNULL( &query->q_uuid ))
3582 return_val = remove_query_data(op, &query->q_uuid);
3583 Debug( pcache_debug, "STALE QUERY REMOVED, SIZE=%d\n",
3585 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
3586 cm->cur_entries -= return_val;
3587 cm->num_cached_queries--;
3588 Debug( pcache_debug, "STORED QUERIES = %lu\n",
3589 cm->num_cached_queries, 0, 0 );
3590 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
3591 Debug( pcache_debug,
3592 "STALE QUERY REMOVED, CACHE ="
3594 cm->cur_entries, 0, 0 );
3595 ldap_pvt_thread_rdwr_wlock( &query->rwlock );
3596 if ( query->bind_refcnt-- ) {
3601 ldap_pvt_thread_rdwr_wunlock( &query->rwlock );
3602 if ( rem ) free_query(query);
3603 ldap_pvt_thread_rdwr_wunlock(&templ->t_rwlock);
3604 } else if ( !templ->ttr && query->expiry_time > ttl ) {
3605 /* We don't need to check for refreshes, and this
3606 * query's expiry is too new, and all subsequent queries
3607 * will be newer yet. So stop looking.
3609 * If we have refreshes, then we always have to walk the
3610 * entire query list.
3618 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
3619 if ( ldap_pvt_runqueue_isrunning( &slapd_rq, rtask )) {
3620 ldap_pvt_runqueue_stoptask( &slapd_rq, rtask );
3622 /* If there were no queries, defer processing for a while */
3623 if ( cm->cc_paused != pause )
3624 cm->cc_paused = pause;
3625 ldap_pvt_runqueue_resched( &slapd_rq, rtask, pause );
3627 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
3632 #define MAX_ATTR_SETS 500
3645 static ConfigDriver pc_cf_gen;
3646 static ConfigLDAPadd pc_ldadd;
3647 static ConfigCfAdd pc_cfadd;
3649 static ConfigTable pccfg[] = {
3650 { "pcache", "backend> <max_entries> <numattrsets> <entry limit> "
3652 6, 6, 0, ARG_MAGIC|ARG_NO_DELETE|PC_MAIN, pc_cf_gen,
3653 "( OLcfgOvAt:2.1 NAME ( 'olcPcache' 'olcProxyCache' ) "
3654 "DESC 'Proxy Cache basic parameters' "
3655 "SYNTAX OMsDirectoryString SINGLE-VALUE )", NULL, NULL },
3656 { "pcacheAttrset", "index> <attributes...",
3657 2, 0, 0, ARG_MAGIC|PC_ATTR, pc_cf_gen,
3658 "( OLcfgOvAt:2.2 NAME ( 'olcPcacheAttrset' 'olcProxyAttrset' ) "
3659 "DESC 'A set of attributes to cache' "
3660 "SYNTAX OMsDirectoryString )", NULL, NULL },
3661 { "pcacheTemplate", "filter> <attrset-index> <TTL> <negTTL> "
3663 4, 7, 0, ARG_MAGIC|PC_TEMP, pc_cf_gen,
3664 "( OLcfgOvAt:2.3 NAME ( 'olcPcacheTemplate' 'olcProxyCacheTemplate' ) "
3665 "DESC 'Filter template, attrset, cache TTL, "
3666 "optional negative TTL, optional sizelimit TTL, "
3668 "SYNTAX OMsDirectoryString )", NULL, NULL },
3669 { "pcachePosition", "head|tail(default)",
3670 2, 2, 0, ARG_MAGIC|PC_RESP, pc_cf_gen,
3671 "( OLcfgOvAt:2.4 NAME 'olcPcachePosition' "
3672 "DESC 'Response callback position in overlay stack' "
3673 "SYNTAX OMsDirectoryString )", NULL, NULL },
3674 { "pcacheMaxQueries", "queries",
3675 2, 2, 0, ARG_INT|ARG_MAGIC|PC_QUERIES, pc_cf_gen,
3676 "( OLcfgOvAt:2.5 NAME ( 'olcPcacheMaxQueries' 'olcProxyCacheQueries' ) "
3677 "DESC 'Maximum number of queries to cache' "
3678 "SYNTAX OMsInteger )", NULL, NULL },
3679 { "pcachePersist", "TRUE|FALSE",
3680 2, 2, 0, ARG_ON_OFF|ARG_OFFSET, (void *)offsetof(cache_manager, save_queries),
3681 "( OLcfgOvAt:2.6 NAME ( 'olcPcachePersist' 'olcProxySaveQueries' ) "
3682 "DESC 'Save cached queries for hot restart' "
3683 "SYNTAX OMsBoolean )", NULL, NULL },
3684 { "pcacheValidate", "TRUE|FALSE",
3685 2, 2, 0, ARG_ON_OFF|ARG_OFFSET, (void *)offsetof(cache_manager, check_cacheability),
3686 "( OLcfgOvAt:2.7 NAME ( 'olcPcacheValidate' 'olcProxyCheckCacheability' ) "
3687 "DESC 'Check whether the results of a query are cacheable, e.g. for schema issues' "
3688 "SYNTAX OMsBoolean )", NULL, NULL },
3689 { "pcacheOffline", "TRUE|FALSE",
3690 2, 2, 0, ARG_ON_OFF|ARG_MAGIC|PC_OFFLINE, pc_cf_gen,
3691 "( OLcfgOvAt:2.8 NAME 'olcPcacheOffline' "
3692 "DESC 'Set cache to offline mode and disable expiration' "
3693 "SYNTAX OMsBoolean )", NULL, NULL },
3694 { "pcacheBind", "filter> <attrset-index> <TTR> <scope> <base",
3695 6, 6, 0, ARG_MAGIC|PC_BIND, pc_cf_gen,
3696 "( OLcfgOvAt:2.9 NAME 'olcPcacheBind' "
3697 "DESC 'Parameters for caching Binds' "
3698 "SYNTAX OMsDirectoryString )", NULL, NULL },
3699 { "pcache-", "private database args",
3700 1, 0, STRLENOF("pcache-"), ARG_MAGIC|PC_PRIVATE_DB, pc_cf_gen,
3703 /* Legacy keywords */
3704 { "proxycache", "backend> <max_entries> <numattrsets> <entry limit> "
3706 6, 6, 0, ARG_MAGIC|ARG_NO_DELETE|PC_MAIN, pc_cf_gen,
3708 { "proxyattrset", "index> <attributes...",
3709 2, 0, 0, ARG_MAGIC|PC_ATTR, pc_cf_gen,
3711 { "proxytemplate", "filter> <attrset-index> <TTL> <negTTL",
3712 4, 7, 0, ARG_MAGIC|PC_TEMP, pc_cf_gen,
3714 { "response-callback", "head|tail(default)",
3715 2, 2, 0, ARG_MAGIC|PC_RESP, pc_cf_gen,
3717 { "proxyCacheQueries", "queries",
3718 2, 2, 0, ARG_INT|ARG_MAGIC|PC_QUERIES, pc_cf_gen,
3720 { "proxySaveQueries", "TRUE|FALSE",
3721 2, 2, 0, ARG_ON_OFF|ARG_OFFSET, (void *)offsetof(cache_manager, save_queries),
3723 { "proxyCheckCacheability", "TRUE|FALSE",
3724 2, 2, 0, ARG_ON_OFF|ARG_OFFSET, (void *)offsetof(cache_manager, check_cacheability),
3727 { NULL, NULL, 0, 0, 0, ARG_IGNORED }
3730 static ConfigOCs pcocs[] = {
3731 { "( OLcfgOvOc:2.1 "
3732 "NAME 'olcPcacheConfig' "
3733 "DESC 'ProxyCache configuration' "
3734 "SUP olcOverlayConfig "
3735 "MUST ( olcPcache $ olcPcacheAttrset $ olcPcacheTemplate ) "
3736 "MAY ( olcPcachePosition $ olcPcacheMaxQueries $ olcPcachePersist $ "
3737 "olcPcacheValidate $ olcPcacheOffline $ olcPcacheBind ) )",
3738 Cft_Overlay, pccfg, NULL, pc_cfadd },
3739 { "( OLcfgOvOc:2.2 "
3740 "NAME 'olcPcacheDatabase' "
3741 "DESC 'Cache database configuration' "
3742 "AUXILIARY )", Cft_Misc, olcDatabaseDummy, pc_ldadd },
3746 static int pcache_db_open2( slap_overinst *on, ConfigReply *cr );
3749 pc_ldadd_cleanup( ConfigArgs *c )
3751 slap_overinst *on = c->ca_private;
3752 return pcache_db_open2( on, &c->reply );
3756 pc_ldadd( CfEntryInfo *p, Entry *e, ConfigArgs *ca )
3761 if ( p->ce_type != Cft_Overlay || !p->ce_bi ||
3762 p->ce_bi->bi_cf_ocs != pcocs )
3763 return LDAP_CONSTRAINT_VIOLATION;
3765 on = (slap_overinst *)p->ce_bi;
3766 cm = on->on_bi.bi_private;
3768 /* Defer open if this is an LDAPadd */
3769 if ( CONFIG_ONLINE_ADD( ca ))
3770 ca->cleanup = pc_ldadd_cleanup;
3772 cm->defer_db_open = 0;
3773 ca->ca_private = on;
3774 return LDAP_SUCCESS;
3778 pc_cfadd( Operation *op, SlapReply *rs, Entry *p, ConfigArgs *ca )
3780 CfEntryInfo *pe = p->e_private;
3781 slap_overinst *on = (slap_overinst *)pe->ce_bi;
3782 cache_manager *cm = on->on_bi.bi_private;
3785 /* FIXME: should not hardcode "olcDatabase" here */
3786 bv.bv_len = snprintf( ca->cr_msg, sizeof( ca->cr_msg ),
3787 "olcDatabase=" SLAP_X_ORDERED_FMT "%s",
3788 0, cm->db.bd_info->bi_type );
3789 if ( bv.bv_len >= sizeof( ca->cr_msg ) ) {
3792 bv.bv_val = ca->cr_msg;
3794 cm->defer_db_open = 0;
3796 /* We can only create this entry if the database is table-driven
3798 if ( cm->db.bd_info->bi_cf_ocs )
3799 config_build_entry( op, rs, pe, ca, &bv, cm->db.bd_info->bi_cf_ocs,
3806 pc_cf_gen( ConfigArgs *c )
3808 slap_overinst *on = (slap_overinst *)c->bi;
3809 cache_manager* cm = on->on_bi.bi_private;
3810 query_manager* qm = cm->qm;
3811 QueryTemplate* temp;
3812 AttributeName* attr_name;
3813 AttributeName* attrarray;
3814 const char* text=NULL;
3819 if ( c->op == SLAP_CONFIG_EMIT ) {
3823 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ), "%s %d %d %d %ld",
3824 cm->db.bd_info->bi_type, cm->max_entries, cm->numattrsets,
3825 cm->num_entries_limit, cm->cc_period );
3826 bv.bv_val = c->cr_msg;
3827 value_add_one( &c->rvalue_vals, &bv );
3830 for (i=0; i<cm->numattrsets; i++) {
3831 if ( !qm->attr_sets[i].count ) continue;
3833 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ), "%d", i );
3835 /* count the attr length */
3836 for ( attr_name = qm->attr_sets[i].attrs;
3837 attr_name->an_name.bv_val; attr_name++ )
3839 bv.bv_len += attr_name->an_name.bv_len + 1;
3840 if ( attr_name->an_desc &&
3841 ( attr_name->an_desc->ad_flags & SLAP_DESC_TEMPORARY ) ) {
3842 bv.bv_len += STRLENOF("undef:");
3846 bv.bv_val = ch_malloc( bv.bv_len+1 );
3847 ptr = lutil_strcopy( bv.bv_val, c->cr_msg );
3848 for ( attr_name = qm->attr_sets[i].attrs;
3849 attr_name->an_name.bv_val; attr_name++ ) {
3851 if ( attr_name->an_desc &&
3852 ( attr_name->an_desc->ad_flags & SLAP_DESC_TEMPORARY ) ) {
3853 ptr = lutil_strcopy( ptr, "undef:" );
3855 ptr = lutil_strcopy( ptr, attr_name->an_name.bv_val );
3857 ber_bvarray_add( &c->rvalue_vals, &bv );
3859 if ( !c->rvalue_vals )
3863 for (temp=qm->templates; temp; temp=temp->qmnext) {
3864 /* HEADS-UP: always print all;
3865 * if optional == 0, ignore */
3866 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ),
3867 " %d %ld %ld %ld %ld",
3868 temp->attr_set_index,
3873 bv.bv_len += temp->querystr.bv_len + 2;
3874 bv.bv_val = ch_malloc( bv.bv_len+1 );
3877 ptr = lutil_strcopy( ptr, temp->querystr.bv_val );
3879 strcpy( ptr, c->cr_msg );
3880 ber_bvarray_add( &c->rvalue_vals, &bv );
3882 if ( !c->rvalue_vals )
3886 for (temp=qm->templates; temp; temp=temp->qmnext) {
3887 if ( !temp->bindttr ) continue;
3888 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ),
3890 temp->attr_set_index,
3892 ldap_pvt_scope2str( temp->bindscope ));
3893 bv.bv_len += temp->bindbase.bv_len + temp->bindftemp.bv_len + 4;
3894 bv.bv_val = ch_malloc( bv.bv_len + 1 );
3897 ptr = lutil_strcopy( ptr, temp->bindftemp.bv_val );
3899 ptr = lutil_strcopy( ptr, c->cr_msg );
3901 ptr = lutil_strcopy( ptr, temp->bindbase.bv_val );
3904 ber_bvarray_add( &c->rvalue_vals, &bv );
3906 if ( !c->rvalue_vals )
3910 if ( cm->response_cb == PCACHE_RESPONSE_CB_HEAD ) {
3911 BER_BVSTR( &bv, "head" );
3913 BER_BVSTR( &bv, "tail" );
3915 value_add_one( &c->rvalue_vals, &bv );
3918 c->value_int = cm->max_queries;
3921 c->value_int = (cm->cc_paused & PCACHE_CC_OFFLINE) != 0;
3925 } else if ( c->op == LDAP_MOD_DELETE ) {
3928 case PC_ATTR: /* FIXME */
3933 cm->cc_paused &= ~PCACHE_CC_OFFLINE;
3934 /* If there were cached queries when we went offline,
3935 * restart the checker now.
3937 if ( cm->num_cached_queries ) {
3938 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
3940 ldap_pvt_runqueue_resched( &slapd_rq, cm->cc_arg, 0 );
3941 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
3951 if ( cm->numattrsets > 0 ) {
3952 snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"pcache\" directive already provided" );
3953 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3957 if ( lutil_atoi( &cm->numattrsets, c->argv[3] ) != 0 ) {
3958 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse num attrsets=\"%s\" (arg #3)",
3960 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3963 if ( cm->numattrsets <= 0 ) {
3964 snprintf( c->cr_msg, sizeof( c->cr_msg ), "numattrsets (arg #3) must be positive" );
3965 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3968 if ( cm->numattrsets > MAX_ATTR_SETS ) {
3969 snprintf( c->cr_msg, sizeof( c->cr_msg ), "numattrsets (arg #3) must be <= %d", MAX_ATTR_SETS );
3970 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3974 if ( !backend_db_init( c->argv[1], &cm->db, -1, NULL )) {
3975 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unknown backend type (arg #1)" );
3976 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3980 if ( lutil_atoi( &cm->max_entries, c->argv[2] ) != 0 ) {
3981 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse max entries=\"%s\" (arg #2)",
3983 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3986 if ( cm->max_entries <= 0 ) {
3987 snprintf( c->cr_msg, sizeof( c->cr_msg ), "max entries (arg #2) must be positive.\n" );
3988 Debug( LDAP_DEBUG_CONFIG, "%s: %s\n", c->log, c->cr_msg, 0 );
3992 if ( lutil_atoi( &cm->num_entries_limit, c->argv[4] ) != 0 ) {
3993 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse entry limit=\"%s\" (arg #4)",
3995 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3998 if ( cm->num_entries_limit <= 0 ) {
3999 snprintf( c->cr_msg, sizeof( c->cr_msg ), "entry limit (arg #4) must be positive" );
4000 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4003 if ( cm->num_entries_limit > cm->max_entries ) {
4004 snprintf( c->cr_msg, sizeof( c->cr_msg ), "entry limit (arg #4) must be less than max entries %d (arg #2)", cm->max_entries );
4005 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4009 if ( lutil_parse_time( c->argv[5], &t ) != 0 ) {
4010 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse period=\"%s\" (arg #5)",
4012 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4016 cm->cc_period = (time_t)t;
4017 Debug( pcache_debug,
4018 "Total # of attribute sets to be cached = %d.\n",
4019 cm->numattrsets, 0, 0 );
4020 qm->attr_sets = ( struct attr_set * )ch_calloc( cm->numattrsets,
4021 sizeof( struct attr_set ) );
4024 if ( cm->numattrsets == 0 ) {
4025 snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"pcache\" directive not provided yet" );
4026 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4029 if ( lutil_atoi( &num, c->argv[1] ) != 0 ) {
4030 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse attrset #=\"%s\"",
4032 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4036 if ( num < 0 || num >= cm->numattrsets ) {
4037 snprintf( c->cr_msg, sizeof( c->cr_msg ), "attrset index %d out of bounds (must be %s%d)",
4038 num, cm->numattrsets > 1 ? "0->" : "", cm->numattrsets - 1 );
4039 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4042 qm->attr_sets[num].flags |= PC_CONFIGURED;
4043 if ( c->argc == 2 ) {
4045 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4046 "need an explicit attr in attrlist; use \"*\" to indicate all attrs" );
4047 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4050 } else if ( c->argc == 3 ) {
4051 if ( strcmp( c->argv[2], LDAP_ALL_USER_ATTRIBUTES ) == 0 ) {
4052 qm->attr_sets[num].count = 1;
4053 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( 2,
4054 sizeof( AttributeName ) );
4055 BER_BVSTR( &qm->attr_sets[num].attrs[0].an_name, LDAP_ALL_USER_ATTRIBUTES );
4058 } else if ( strcmp( c->argv[2], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 ) {
4059 qm->attr_sets[num].count = 1;
4060 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( 2,
4061 sizeof( AttributeName ) );
4062 BER_BVSTR( &qm->attr_sets[num].attrs[0].an_name, LDAP_ALL_OPERATIONAL_ATTRIBUTES );
4065 } else if ( strcmp( c->argv[2], LDAP_NO_ATTRS ) == 0 ) {
4068 /* else: fallthru */
4070 } else if ( c->argc == 4 ) {
4071 if ( ( strcmp( c->argv[2], LDAP_ALL_USER_ATTRIBUTES ) == 0 && strcmp( c->argv[3], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 )
4072 || ( strcmp( c->argv[2], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 && strcmp( c->argv[3], LDAP_ALL_USER_ATTRIBUTES ) == 0 ) )
4074 qm->attr_sets[num].count = 2;
4075 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( 3,
4076 sizeof( AttributeName ) );
4077 BER_BVSTR( &qm->attr_sets[num].attrs[0].an_name, LDAP_ALL_USER_ATTRIBUTES );
4078 BER_BVSTR( &qm->attr_sets[num].attrs[1].an_name, LDAP_ALL_OPERATIONAL_ATTRIBUTES );
4081 /* else: fallthru */
4084 if ( c->argc > 2 ) {
4085 int all_user = 0, all_op = 0;
4087 qm->attr_sets[num].count = c->argc - 2;
4088 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( c->argc - 1,
4089 sizeof( AttributeName ) );
4090 attr_name = qm->attr_sets[num].attrs;
4091 for ( i = 2; i < c->argc; i++ ) {
4092 attr_name->an_desc = NULL;
4093 if ( strcmp( c->argv[i], LDAP_NO_ATTRS ) == 0 ) {
4094 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4095 "invalid attr #%d \"%s\" in attrlist",
4096 i - 2, c->argv[i] );
4097 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4098 ch_free( qm->attr_sets[num].attrs );
4099 qm->attr_sets[num].attrs = NULL;
4100 qm->attr_sets[num].count = 0;
4103 if ( strcmp( c->argv[i], LDAP_ALL_USER_ATTRIBUTES ) == 0 ) {
4105 BER_BVSTR( &attr_name->an_name, LDAP_ALL_USER_ATTRIBUTES );
4106 } else if ( strcmp( c->argv[i], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 ) {
4108 BER_BVSTR( &attr_name->an_name, LDAP_ALL_OPERATIONAL_ATTRIBUTES );
4110 if ( strncasecmp( c->argv[i], "undef:", STRLENOF("undef:") ) == 0 ) {
4112 ber_str2bv( c->argv[i] + STRLENOF("undef:"), 0, 0, &bv );
4113 attr_name->an_desc = slap_bv2tmp_ad( &bv, NULL );
4115 } else if ( slap_str2ad( c->argv[i], &attr_name->an_desc, &text ) ) {
4116 strcpy( c->cr_msg, text );
4117 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4118 ch_free( qm->attr_sets[num].attrs );
4119 qm->attr_sets[num].attrs = NULL;
4120 qm->attr_sets[num].count = 0;
4123 attr_name->an_name = attr_name->an_desc->ad_cname;
4125 attr_name->an_oc = NULL;
4126 attr_name->an_flags = 0;
4127 if ( attr_name->an_desc == slap_schema.si_ad_objectClass )
4128 qm->attr_sets[num].flags |= PC_GOT_OC;
4130 BER_BVZERO( &attr_name->an_name );
4133 /* warn if list contains both "*" and "+" */
4134 if ( i > 4 && all_user && all_op ) {
4135 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4136 "warning: attribute list contains \"*\" and \"+\"" );
4137 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4142 if ( cm->numattrsets == 0 ) {
4143 snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"pcache\" directive not provided yet" );
4144 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4147 if ( lutil_atoi( &i, c->argv[2] ) != 0 ) {
4148 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse template #=\"%s\"",
4150 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4154 if ( i < 0 || i >= cm->numattrsets ||
4155 !(qm->attr_sets[i].flags & PC_CONFIGURED )) {
4156 snprintf( c->cr_msg, sizeof( c->cr_msg ), "template index %d invalid (%s%d)",
4157 i, cm->numattrsets > 1 ? "0->" : "", cm->numattrsets - 1 );
4158 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4162 AttributeName *attrs;
4164 cnt = template_attrs( c->argv[1], &qm->attr_sets[i], &attrs, &text );
4166 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse template: %s",
4168 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4171 temp = ch_calloc( 1, sizeof( QueryTemplate ));
4172 temp->qmnext = qm->templates;
4173 qm->templates = temp;
4174 temp->t_attrs.attrs = attrs;
4175 temp->t_attrs.count = cnt;
4177 ldap_pvt_thread_rdwr_init( &temp->t_rwlock );
4178 temp->query = temp->query_last = NULL;
4179 if ( lutil_parse_time( c->argv[3], &t ) != 0 ) {
4180 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4181 "unable to parse template ttl=\"%s\"",
4183 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4185 ch_free( temp->t_attrs.attrs );
4189 temp->ttl = (time_t)t;
4190 temp->negttl = (time_t)0;
4191 temp->limitttl = (time_t)0;
4192 temp->ttr = (time_t)0;
4193 switch ( c->argc ) {
4195 if ( lutil_parse_time( c->argv[6], &t ) != 0 ) {
4196 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4197 "unable to parse template ttr=\"%s\"",
4199 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4202 temp->ttr = (time_t)t;
4206 if ( lutil_parse_time( c->argv[5], &t ) != 0 ) {
4207 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4208 "unable to parse template sizelimit ttl=\"%s\"",
4210 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4213 temp->limitttl = (time_t)t;
4217 if ( lutil_parse_time( c->argv[4], &t ) != 0 ) {
4218 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4219 "unable to parse template negative ttl=\"%s\"",
4221 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4224 temp->negttl = (time_t)t;
4228 temp->no_of_queries = 0;
4230 ber_str2bv( c->argv[1], 0, 1, &temp->querystr );
4231 Debug( pcache_debug, "Template:\n", 0, 0, 0 );
4232 Debug( pcache_debug, " query template: %s\n",
4233 temp->querystr.bv_val, 0, 0 );
4234 temp->attr_set_index = i;
4235 qm->attr_sets[i].flags |= PC_REFERENCED;
4236 temp->qtnext = qm->attr_sets[i].templates;
4237 qm->attr_sets[i].templates = temp;
4238 Debug( pcache_debug, " attributes: \n", 0, 0, 0 );
4239 if ( ( attrarray = qm->attr_sets[i].attrs ) != NULL ) {
4240 for ( i=0; attrarray[i].an_name.bv_val; i++ )
4241 Debug( pcache_debug, "\t%s\n",
4242 attrarray[i].an_name.bv_val, 0, 0 );
4246 if ( !qm->templates ) {
4247 snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"pcacheTemplate\" directive not provided yet" );
4248 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4251 if ( lutil_atoi( &i, c->argv[2] ) != 0 ) {
4252 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse Bind index #=\"%s\"",
4254 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4258 if ( i < 0 || i >= cm->numattrsets ||
4259 !(qm->attr_sets[i].flags & PC_CONFIGURED )) {
4260 snprintf( c->cr_msg, sizeof( c->cr_msg ), "Bind index %d invalid (%s%d)",
4261 i, cm->numattrsets > 1 ? "0->" : "", cm->numattrsets - 1 );
4262 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4265 { struct berval bv, tempbv;
4266 AttributeDescription **descs;
4268 ber_str2bv( c->argv[1], 0, 0, &bv );
4269 ndescs = ftemp_attrs( &bv, &tempbv, &descs, &text );
4271 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse template: %s",
4273 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4276 for ( temp = qm->templates; temp; temp=temp->qmnext ) {
4277 if ( temp->attr_set_index == i && bvmatch( &tempbv,
4281 ch_free( tempbv.bv_val );
4284 snprintf( c->cr_msg, sizeof( c->cr_msg ), "Bind template %s %d invalid",
4286 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4289 ber_dupbv( &temp->bindftemp, &bv );
4290 temp->bindfattrs = descs;
4291 temp->bindnattrs = ndescs;
4293 if ( lutil_parse_time( c->argv[3], &t ) != 0 ) {
4294 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4295 "unable to parse bind ttr=\"%s\"",
4297 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4299 ch_free( temp->bindfattrs );
4300 temp->bindfattrs = NULL;
4301 ch_free( temp->bindftemp.bv_val );
4302 BER_BVZERO( &temp->bindftemp );
4305 num = ldap_pvt_str2scope( c->argv[4] );
4307 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4308 "unable to parse bind scope=\"%s\"",
4310 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4314 struct berval dn, ndn;
4315 ber_str2bv( c->argv[5], 0, 0, &dn );
4316 rc = dnNormalize( 0, NULL, NULL, &dn, &ndn, NULL );
4318 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4319 "invalid bind baseDN=\"%s\"",
4321 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4324 if ( temp->bindbase.bv_val )
4325 ch_free( temp->bindbase.bv_val );
4326 temp->bindbase = ndn;
4329 /* convert the template into dummy filter */
4331 char *eq = temp->bindftemp.bv_val, *e2;
4334 while ((eq = strchr(eq, '=' ))) {
4339 bv.bv_len = temp->bindftemp.bv_len + i;
4340 bv.bv_val = ch_malloc( bv.bv_len + 1 );
4341 for ( e2 = bv.bv_val, eq = temp->bindftemp.bv_val;
4352 f = str2filter( bv.bv_val );
4354 ch_free( bv.bv_val );
4355 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4356 "unable to parse bindfilter=\"%s\"", bv.bv_val );
4357 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4358 ch_free( temp->bindbase.bv_val );
4359 BER_BVZERO( &temp->bindbase );
4362 if ( temp->bindfilter )
4363 filter_free( temp->bindfilter );
4364 if ( temp->bindfilterstr.bv_val )
4365 ch_free( temp->bindfilterstr.bv_val );
4366 temp->bindfilterstr = bv;
4367 temp->bindfilter = f;
4369 temp->bindttr = (time_t)t;
4370 temp->bindscope = num;
4371 cm->cache_binds = 1;
4375 if ( strcasecmp( c->argv[1], "head" ) == 0 ) {
4376 cm->response_cb = PCACHE_RESPONSE_CB_HEAD;
4378 } else if ( strcasecmp( c->argv[1], "tail" ) == 0 ) {
4379 cm->response_cb = PCACHE_RESPONSE_CB_TAIL;
4382 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unknown specifier" );
4383 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4388 if ( c->value_int <= 0 ) {
4389 snprintf( c->cr_msg, sizeof( c->cr_msg ), "max queries must be positive" );
4390 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4393 cm->max_queries = c->value_int;
4397 cm->cc_paused |= PCACHE_CC_OFFLINE;
4399 cm->cc_paused &= ~PCACHE_CC_OFFLINE;
4402 if ( cm->db.be_private == NULL ) {
4403 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4404 "private database must be defined before setting database specific options" );
4405 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4409 if ( cm->db.bd_info->bi_cf_ocs ) {
4412 char *argv0 = c->argv[ 0 ];
4414 c->argv[ 0 ] = &argv0[ STRLENOF( "pcache-" ) ];
4416 ct = config_find_keyword( cm->db.bd_info->bi_cf_ocs->co_table, c );
4418 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4419 "private database does not recognize specific option '%s'",
4421 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4425 c->table = cm->db.bd_info->bi_cf_ocs->co_type;
4427 c->bi = c->be->bd_info;
4429 rc = config_add_vals( ct, c );
4433 c->table = c2.table;
4436 c->argv[ 0 ] = argv0;
4438 } else if ( cm->db.be_config != NULL ) {
4439 char *argv0 = c->argv[ 0 ];
4441 c->argv[ 0 ] = &argv0[ STRLENOF( "pcache-" ) ];
4442 rc = cm->db.be_config( &cm->db, c->fname, c->lineno, c->argc, c->argv );
4443 c->argv[ 0 ] = argv0;
4446 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4447 "no means to set private database specific options" );
4448 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4453 rc = SLAP_CONF_UNKNOWN;
4469 slap_overinst *on = (slap_overinst *)be->bd_info;
4470 cache_manager* cm = on->on_bi.bi_private;
4472 /* Something for the cache database? */
4473 if ( cm->db.bd_info && cm->db.bd_info->bi_db_config )
4474 return cm->db.bd_info->bi_db_config( &cm->db, fname, lineno,
4476 return SLAP_CONF_UNKNOWN;
4484 slap_overinst *on = (slap_overinst *)be->bd_info;
4488 cm = (cache_manager *)ch_malloc(sizeof(cache_manager));
4489 on->on_bi.bi_private = cm;
4491 qm = (query_manager*)ch_malloc(sizeof(query_manager));
4494 SLAP_DBFLAGS(&cm->db) |= SLAP_DBFLAG_NO_SCHEMA_CHECK;
4495 cm->db.be_private = NULL;
4496 cm->db.bd_self = &cm->db;
4498 cm->numattrsets = 0;
4499 cm->num_entries_limit = 5;
4500 cm->num_cached_queries = 0;
4501 cm->max_entries = 0;
4502 cm->cur_entries = 0;
4503 cm->max_queries = 10000;
4504 cm->save_queries = 0;
4505 cm->check_cacheability = 0;
4506 cm->response_cb = PCACHE_RESPONSE_CB_TAIL;
4507 cm->defer_db_open = 1;
4508 cm->cache_binds = 0;
4509 cm->cc_period = 1000;
4512 #ifdef PCACHE_MONITOR
4513 cm->monitor_cb = NULL;
4514 #endif /* PCACHE_MONITOR */
4516 qm->attr_sets = NULL;
4517 qm->templates = NULL;
4519 qm->lru_bottom = NULL;
4521 qm->qcfunc = query_containment;
4522 qm->crfunc = cache_replacement;
4523 qm->addfunc = add_query;
4524 ldap_pvt_thread_mutex_init(&qm->lru_mutex);
4526 ldap_pvt_thread_mutex_init(&cm->cache_mutex);
4528 #ifndef PCACHE_MONITOR
4530 #else /* PCACHE_MONITOR */
4531 return pcache_monitor_db_init( be );
4532 #endif /* PCACHE_MONITOR */
4536 pcache_cachedquery_open_cb( Operation *op, SlapReply *rs )
4538 assert( op->o_tag == LDAP_REQ_SEARCH );
4540 if ( rs->sr_type == REP_SEARCH ) {
4543 a = attr_find( rs->sr_entry->e_attrs, ad_cachedQueryURL );
4547 assert( a->a_nvals != NULL );
4549 valsp = op->o_callback->sc_private;
4550 assert( *valsp == NULL );
4552 ber_bvarray_dup_x( valsp, a->a_nvals, op->o_tmpmemctx );
4560 pcache_cachedquery_count_cb( Operation *op, SlapReply *rs )
4562 assert( op->o_tag == LDAP_REQ_SEARCH );
4564 if ( rs->sr_type == REP_SEARCH ) {
4565 int *countp = (int *)op->o_callback->sc_private;
4578 cache_manager *cm = on->on_bi.bi_private;
4579 query_manager* qm = cm->qm;
4582 rc = backend_startup_one( &cm->db, cr );
4584 cm->defer_db_open = 0;
4587 /* There is no runqueue in TOOL mode */
4588 if (( slapMode & SLAP_SERVER_MODE ) && rc == 0 ) {
4589 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
4590 ldap_pvt_runqueue_insert( &slapd_rq, cm->cc_period,
4591 consistency_check, on,
4592 "pcache_consistency", cm->db.be_suffix[0].bv_val );
4593 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
4595 /* Cached database must have the rootdn */
4596 if ( BER_BVISNULL( &cm->db.be_rootndn )
4597 || BER_BVISEMPTY( &cm->db.be_rootndn ) )
4599 Debug( LDAP_DEBUG_ANY, "pcache_db_open(): "
4600 "underlying database of type \"%s\"\n"
4601 " serving naming context \"%s\"\n"
4602 " has no \"rootdn\", required by \"pcache\".\n",
4603 on->on_info->oi_orig->bi_type,
4604 cm->db.be_suffix[0].bv_val, 0 );
4608 if ( cm->save_queries ) {
4609 void *thrctx = ldap_pvt_thread_pool_context();
4610 Connection conn = { 0 };
4611 OperationBuffer opbuf;
4613 slap_callback cb = { 0 };
4614 SlapReply rs = { REP_RESULT };
4615 BerVarray vals = NULL;
4616 Filter f = { 0 }, f2 = { 0 };
4617 AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
4618 AttributeName attrs[ 2 ] = {{{ 0 }}};
4620 connection_fake_init2( &conn, &opbuf, thrctx, 0 );
4625 op->o_tag = LDAP_REQ_SEARCH;
4626 op->o_protocol = LDAP_VERSION3;
4627 cb.sc_response = pcache_cachedquery_open_cb;
4628 cb.sc_private = &vals;
4629 op->o_callback = &cb;
4630 op->o_time = slap_get_time();
4631 op->o_do_not_cache = 1;
4632 op->o_managedsait = SLAP_CONTROL_CRITICAL;
4634 op->o_dn = cm->db.be_rootdn;
4635 op->o_ndn = cm->db.be_rootndn;
4636 op->o_req_dn = cm->db.be_suffix[ 0 ];
4637 op->o_req_ndn = cm->db.be_nsuffix[ 0 ];
4639 op->ors_scope = LDAP_SCOPE_BASE;
4640 op->ors_deref = LDAP_DEREF_NEVER;
4642 op->ors_tlimit = SLAP_NO_LIMIT;
4643 op->ors_limit = NULL;
4644 ber_str2bv( "(pcacheQueryURL=*)", 0, 0, &op->ors_filterstr );
4645 f.f_choice = LDAP_FILTER_PRESENT;
4646 f.f_desc = ad_cachedQueryURL;
4647 op->ors_filter = &f;
4648 attrs[ 0 ].an_desc = ad_cachedQueryURL;
4649 attrs[ 0 ].an_name = ad_cachedQueryURL->ad_cname;
4650 op->ors_attrs = attrs;
4651 op->ors_attrsonly = 0;
4653 rc = op->o_bd->be_search( op, &rs );
4654 if ( rc == LDAP_SUCCESS && vals != NULL ) {
4657 for ( i = 0; !BER_BVISNULL( &vals[ i ] ); i++ ) {
4658 if ( url2query( vals[ i ].bv_val, op, qm ) == 0 ) {
4659 cm->num_cached_queries++;
4663 ber_bvarray_free_x( vals, op->o_tmpmemctx );
4666 /* count cached entries */
4667 f.f_choice = LDAP_FILTER_NOT;
4669 f2.f_choice = LDAP_FILTER_EQUALITY;
4671 f2.f_av_desc = slap_schema.si_ad_objectClass;
4672 BER_BVSTR( &f2.f_av_value, "glue" );
4673 ber_str2bv( "(!(objectClass=glue))", 0, 0, &op->ors_filterstr );
4675 op->ors_slimit = SLAP_NO_LIMIT;
4676 op->ors_scope = LDAP_SCOPE_SUBTREE;
4677 op->ors_attrs = slap_anlist_no_attrs;
4679 rs_reinit( &rs, REP_RESULT );
4680 op->o_callback->sc_response = pcache_cachedquery_count_cb;
4681 op->o_callback->sc_private = &rs.sr_nentries;
4683 rc = op->o_bd->be_search( op, &rs );
4685 cm->cur_entries = rs.sr_nentries;
4699 slap_overinst *on = (slap_overinst *)be->bd_info;
4700 cache_manager *cm = on->on_bi.bi_private;
4701 query_manager* qm = cm->qm;
4702 int i, ncf = 0, rf = 0, nrf = 0, rc = 0;
4704 /* check attr sets */
4705 for ( i = 0; i < cm->numattrsets; i++) {
4706 if ( !( qm->attr_sets[i].flags & PC_CONFIGURED ) ) {
4707 if ( qm->attr_sets[i].flags & PC_REFERENCED ) {
4708 Debug( LDAP_DEBUG_CONFIG, "pcache: attr set #%d not configured but referenced.\n", i, 0, 0 );
4712 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, attr set #%d not configured.\n", i, 0, 0 );
4716 } else if ( !( qm->attr_sets[i].flags & PC_REFERENCED ) ) {
4717 Debug( LDAP_DEBUG_CONFIG, "pcache: attr set #%d configured but not referenced.\n", i, 0, 0 );
4722 if ( ncf || rf || nrf ) {
4723 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, %d attr sets configured but not referenced.\n", nrf, 0, 0 );
4724 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, %d attr sets not configured.\n", ncf, 0, 0 );
4725 Debug( LDAP_DEBUG_CONFIG, "pcache: %d attr sets not configured but referenced.\n", rf, 0, 0 );
4732 /* need to inherit something from the original database... */
4733 cm->db.be_def_limit = be->be_def_limit;
4734 cm->db.be_limits = be->be_limits;
4735 cm->db.be_acl = be->be_acl;
4736 cm->db.be_dfltaccess = be->be_dfltaccess;
4738 if ( SLAP_DBMONITORING( be ) ) {
4739 SLAP_DBFLAGS( &cm->db ) |= SLAP_DBFLAG_MONITORING;
4742 SLAP_DBFLAGS( &cm->db ) &= ~SLAP_DBFLAG_MONITORING;
4745 if ( !cm->defer_db_open ) {
4746 rc = pcache_db_open2( on, cr );
4749 #ifdef PCACHE_MONITOR
4750 if ( rc == LDAP_SUCCESS ) {
4751 rc = pcache_monitor_db_open( be );
4753 #endif /* PCACHE_MONITOR */
4759 pcache_free_qbase( void *v )
4765 tavl_free( qb->scopes[i], NULL );
4775 slap_overinst *on = (slap_overinst *)be->bd_info;
4776 cache_manager *cm = on->on_bi.bi_private;
4777 query_manager *qm = cm->qm;
4781 /* stop the thread ... */
4783 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
4784 if ( ldap_pvt_runqueue_isrunning( &slapd_rq, cm->cc_arg ) ) {
4785 ldap_pvt_runqueue_stoptask( &slapd_rq, cm->cc_arg );
4787 ldap_pvt_runqueue_remove( &slapd_rq, cm->cc_arg );
4788 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
4791 if ( cm->save_queries ) {
4793 BerVarray vals = NULL;
4796 Connection conn = { 0 };
4797 OperationBuffer opbuf;
4799 slap_callback cb = { 0 };
4801 SlapReply rs = { REP_RESULT };
4802 Modifications mod = {{ 0 }};
4804 thrctx = ldap_pvt_thread_pool_context();
4806 connection_fake_init2( &conn, &opbuf, thrctx, 0 );
4809 mod.sml_numvals = 0;
4810 if ( qm->templates != NULL ) {
4811 for ( tm = qm->templates; tm != NULL; tm = tm->qmnext ) {
4812 for ( qc = tm->query; qc; qc = qc->next ) {
4815 if ( query2url( op, qc, &bv, 0 ) == 0 ) {
4816 ber_bvarray_add_x( &vals, &bv, op->o_tmpmemctx );
4824 op->o_dn = cm->db.be_rootdn;
4825 op->o_ndn = cm->db.be_rootndn;
4827 op->o_tag = LDAP_REQ_MODIFY;
4828 op->o_protocol = LDAP_VERSION3;
4829 cb.sc_response = slap_null_cb;
4830 op->o_callback = &cb;
4831 op->o_time = slap_get_time();
4832 op->o_do_not_cache = 1;
4833 op->o_managedsait = SLAP_CONTROL_CRITICAL;
4835 op->o_req_dn = op->o_bd->be_suffix[0];
4836 op->o_req_ndn = op->o_bd->be_nsuffix[0];
4838 mod.sml_op = LDAP_MOD_REPLACE;
4840 mod.sml_desc = ad_cachedQueryURL;
4841 mod.sml_type = ad_cachedQueryURL->ad_cname;
4842 mod.sml_values = vals;
4843 mod.sml_nvalues = NULL;
4844 mod.sml_next = NULL;
4845 Debug( pcache_debug,
4846 "%sSETTING CACHED QUERY URLS\n",
4847 vals == NULL ? "RE" : "", 0, 0 );
4849 op->orm_modlist = &mod;
4851 op->o_bd->be_modify( op, &rs );
4853 ber_bvarray_free_x( vals, op->o_tmpmemctx );
4856 /* cleanup stuff inherited from the original database... */
4857 cm->db.be_limits = NULL;
4858 cm->db.be_acl = NULL;
4861 if ( cm->db.bd_info->bi_db_close ) {
4862 rc = cm->db.bd_info->bi_db_close( &cm->db, NULL );
4864 while ( (tm = qm->templates) != NULL ) {
4865 CachedQuery *qc, *qn;
4866 qm->templates = tm->qmnext;
4867 for ( qc = tm->query; qc; qc = qn ) {
4871 avl_free( tm->qbase, pcache_free_qbase );
4872 free( tm->querystr.bv_val );
4873 free( tm->bindfattrs );
4874 free( tm->bindftemp.bv_val );
4875 free( tm->bindfilterstr.bv_val );
4876 free( tm->bindbase.bv_val );
4877 filter_free( tm->bindfilter );
4878 ldap_pvt_thread_rdwr_destroy( &tm->t_rwlock );
4879 free( tm->t_attrs.attrs );
4883 for ( i = 0; i < cm->numattrsets; i++ ) {
4886 /* Account of LDAP_NO_ATTRS */
4887 if ( !qm->attr_sets[i].count ) continue;
4889 for ( j = 0; !BER_BVISNULL( &qm->attr_sets[i].attrs[j].an_name ); j++ ) {
4890 if ( qm->attr_sets[i].attrs[j].an_desc &&
4891 ( qm->attr_sets[i].attrs[j].an_desc->ad_flags &
4892 SLAP_DESC_TEMPORARY ) ) {
4893 slap_sl_mfuncs.bmf_free( qm->attr_sets[i].attrs[j].an_desc, NULL );
4896 free( qm->attr_sets[i].attrs );
4898 free( qm->attr_sets );
4899 qm->attr_sets = NULL;
4901 #ifdef PCACHE_MONITOR
4902 if ( rc == LDAP_SUCCESS ) {
4903 rc = pcache_monitor_db_close( be );
4905 #endif /* PCACHE_MONITOR */
4916 slap_overinst *on = (slap_overinst *)be->bd_info;
4917 cache_manager *cm = on->on_bi.bi_private;
4918 query_manager *qm = cm->qm;
4920 if ( cm->db.be_private != NULL ) {
4921 backend_stopdown_one( &cm->db );
4924 ldap_pvt_thread_mutex_destroy( &qm->lru_mutex );
4925 ldap_pvt_thread_mutex_destroy( &cm->cache_mutex );
4929 #ifdef PCACHE_MONITOR
4930 pcache_monitor_db_destroy( be );
4931 #endif /* PCACHE_MONITOR */
4936 #ifdef PCACHE_CONTROL_PRIVDB
4938 Control ::= SEQUENCE {
4939 controlType LDAPOID,
4940 criticality BOOLEAN DEFAULT FALSE,
4941 controlValue OCTET STRING OPTIONAL }
4943 controlType ::= 1.3.6.1.4.1.4203.666.11.9.5.1
4945 * criticality must be TRUE; controlValue must be absent.
4953 if ( op->o_ctrlflag[ privDB_cid ] != SLAP_CONTROL_NONE ) {
4954 rs->sr_text = "privateDB control specified multiple times";
4955 return LDAP_PROTOCOL_ERROR;
4958 if ( !BER_BVISNULL( &ctrl->ldctl_value ) ) {
4959 rs->sr_text = "privateDB control value not absent";
4960 return LDAP_PROTOCOL_ERROR;
4963 if ( !ctrl->ldctl_iscritical ) {
4964 rs->sr_text = "privateDB control criticality required";
4965 return LDAP_PROTOCOL_ERROR;
4968 op->o_ctrlflag[ privDB_cid ] = SLAP_CONTROL_CRITICAL;
4970 return LDAP_SUCCESS;
4973 static char *extops[] = {
4974 LDAP_EXOP_MODIFY_PASSWD,
4977 #endif /* PCACHE_CONTROL_PRIVDB */
4979 static struct berval pcache_exop_MODIFY_PASSWD = BER_BVC( LDAP_EXOP_MODIFY_PASSWD );
4980 #ifdef PCACHE_EXOP_QUERY_DELETE
4981 static struct berval pcache_exop_QUERY_DELETE = BER_BVC( PCACHE_EXOP_QUERY_DELETE );
4983 #define LDAP_TAG_EXOP_QUERY_DELETE_BASE ((LBER_CLASS_CONTEXT|LBER_CONSTRUCTED) + 0)
4984 #define LDAP_TAG_EXOP_QUERY_DELETE_DN ((LBER_CLASS_CONTEXT|LBER_CONSTRUCTED) + 1)
4985 #define LDAP_TAG_EXOP_QUERY_DELETE_UUID ((LBER_CLASS_CONTEXT|LBER_CONSTRUCTED) + 2)
4988 ExtendedRequest ::= [APPLICATION 23] SEQUENCE {
4989 requestName [0] LDAPOID,
4990 requestValue [1] OCTET STRING OPTIONAL }
4992 requestName ::= 1.3.6.1.4.1.4203.666.11.9.6.1
4994 requestValue ::= SEQUENCE { CHOICE {
4996 entryDN [1] LDAPDN },
4997 queryID [2] OCTET STRING (SIZE(16))
4998 -- constrained to UUID }
5000 * Either baseDN or entryDN must be present, to allow database selection.
5002 * 1. if baseDN and queryID are present, then the query corresponding
5003 * to queryID is deleted;
5004 * 2. if baseDN is present and queryID is absent, then all queries
5006 * 3. if entryDN is present and queryID is absent, then all queries
5007 * corresponding to the queryID values present in entryDN are deleted;
5008 * 4. if entryDN and queryID are present, then all queries
5009 * corresponding to the queryID values present in entryDN are deleted,
5010 * but only if the value of queryID is contained in the entry;
5012 * Currently, only 1, 3 and 4 are implemented. 2 can be obtained by either
5013 * recursively deleting the database (ldapdelete -r) with PRIVDB control,
5014 * or by removing the database files.
5016 ExtendedResponse ::= [APPLICATION 24] SEQUENCE {
5017 COMPONENTS OF LDAPResult,
5018 responseName [10] LDAPOID OPTIONAL,
5019 responseValue [11] OCTET STRING OPTIONAL }
5021 * responseName and responseValue must be absent.
5025 * - on success, *tagp is either LDAP_TAG_EXOP_QUERY_DELETE_BASE
5026 * or LDAP_TAG_EXOP_QUERY_DELETE_DN.
5027 * - if ndn != NULL, it is set to the normalized DN in the request
5028 * corresponding to either the baseDN or the entryDN, according
5029 * to *tagp; memory is malloc'ed on the Operation's slab, and must
5030 * be freed by the caller.
5031 * - if uuid != NULL, it is set to point to the normalized UUID;
5032 * memory is malloc'ed on the Operation's slab, and must
5033 * be freed by the caller.
5036 pcache_parse_query_delete(
5040 struct berval *uuid,
5044 int rc = LDAP_SUCCESS;
5047 BerElementBuffer berbuf;
5048 BerElement *ber = (BerElement *)&berbuf;
5049 struct berval reqdata = BER_BVNULL;
5061 if ( in == NULL || in->bv_len == 0 ) {
5062 *text = "empty request data field in queryDelete exop";
5063 return LDAP_PROTOCOL_ERROR;
5066 ber_dupbv_x( &reqdata, in, ctx );
5068 /* ber_init2 uses reqdata directly, doesn't allocate new buffers */
5069 ber_init2( ber, &reqdata, 0 );
5071 tag = ber_scanf( ber, "{" /*}*/ );
5073 if ( tag == LBER_ERROR ) {
5074 Debug( LDAP_DEBUG_TRACE,
5075 "pcache_parse_query_delete: decoding error.\n",
5077 goto decoding_error;
5080 tag = ber_peek_tag( ber, &len );
5081 if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_BASE
5082 || tag == LDAP_TAG_EXOP_QUERY_DELETE_DN )
5086 if ( ndn != NULL ) {
5089 tag = ber_scanf( ber, "m", &dn );
5090 if ( tag == LBER_ERROR ) {
5091 Debug( LDAP_DEBUG_TRACE,
5092 "pcache_parse_query_delete: DN parse failed.\n",
5094 goto decoding_error;
5097 rc = dnNormalize( 0, NULL, NULL, &dn, ndn, ctx );
5098 if ( rc != LDAP_SUCCESS ) {
5099 *text = "invalid DN in queryDelete exop request data";
5104 tag = ber_scanf( ber, "x" /* "m" */ );
5105 if ( tag == LBER_DEFAULT ) {
5106 goto decoding_error;
5110 tag = ber_peek_tag( ber, &len );
5113 if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_UUID ) {
5114 if ( uuid != NULL ) {
5116 char uuidbuf[ LDAP_LUTIL_UUIDSTR_BUFSIZE ];
5118 tag = ber_scanf( ber, "m", &bv );
5119 if ( tag == LBER_ERROR ) {
5120 Debug( LDAP_DEBUG_TRACE,
5121 "pcache_parse_query_delete: UUID parse failed.\n",
5123 goto decoding_error;
5126 if ( bv.bv_len != 16 ) {
5127 Debug( LDAP_DEBUG_TRACE,
5128 "pcache_parse_query_delete: invalid UUID length %lu.\n",
5129 (unsigned long)bv.bv_len, 0, 0 );
5130 goto decoding_error;
5133 rc = lutil_uuidstr_from_normalized(
5134 bv.bv_val, bv.bv_len,
5135 uuidbuf, sizeof( uuidbuf ) );
5137 goto decoding_error;
5139 ber_str2bv( uuidbuf, rc, 1, uuid );
5143 tag = ber_skip_tag( ber, &len );
5144 if ( tag == LBER_DEFAULT ) {
5145 goto decoding_error;
5149 Debug( LDAP_DEBUG_TRACE,
5150 "pcache_parse_query_delete: invalid UUID length %lu.\n",
5151 (unsigned long)len, 0, 0 );
5152 goto decoding_error;
5156 tag = ber_peek_tag( ber, &len );
5159 if ( tag != LBER_DEFAULT || len != 0 ) {
5161 Debug( LDAP_DEBUG_TRACE,
5162 "pcache_parse_query_delete: decoding error\n",
5164 rc = LDAP_PROTOCOL_ERROR;
5165 *text = "queryDelete data decoding error";
5168 if ( ndn && !BER_BVISNULL( ndn ) ) {
5169 slap_sl_free( ndn->bv_val, ctx );
5173 if ( uuid && !BER_BVISNULL( uuid ) ) {
5174 slap_sl_free( uuid->bv_val, ctx );
5179 if ( !BER_BVISNULL( &reqdata ) ) {
5180 ber_memfree_x( reqdata.bv_val, ctx );
5187 pcache_exop_query_delete(
5191 BackendDB *bd = op->o_bd;
5193 struct berval uuid = BER_BVNULL,
5195 char buf[ SLAP_TEXT_BUFLEN ];
5197 ber_tag_t tag = LBER_DEFAULT;
5199 if ( LogTest( LDAP_DEBUG_STATS ) ) {
5203 rs->sr_err = pcache_parse_query_delete( op->ore_reqdata,
5204 &tag, &op->o_req_ndn, uuidp,
5205 &rs->sr_text, op->o_tmpmemctx );
5206 if ( rs->sr_err != LDAP_SUCCESS ) {
5210 if ( LogTest( LDAP_DEBUG_STATS ) ) {
5211 assert( !BER_BVISNULL( &op->o_req_ndn ) );
5212 len = snprintf( buf, sizeof( buf ), " dn=\"%s\"", op->o_req_ndn.bv_val );
5214 if ( !BER_BVISNULL( &uuid ) && len < sizeof( buf ) ) {
5215 snprintf( &buf[ len ], sizeof( buf ) - len, " pcacheQueryId=\"%s\"", uuid.bv_val );
5218 Debug( LDAP_DEBUG_STATS, "%s QUERY DELETE%s\n",
5219 op->o_log_prefix, buf, 0 );
5221 op->o_req_dn = op->o_req_ndn;
5223 op->o_bd = select_backend( &op->o_req_ndn, 0 );
5224 if ( op->o_bd == NULL ) {
5225 send_ldap_error( op, rs, LDAP_NO_SUCH_OBJECT,
5226 "no global superior knowledge" );
5228 rs->sr_err = backend_check_restrictions( op, rs,
5229 (struct berval *)&pcache_exop_QUERY_DELETE );
5230 if ( rs->sr_err != LDAP_SUCCESS ) {
5234 if ( op->o_bd->be_extended == NULL ) {
5235 send_ldap_error( op, rs, LDAP_UNAVAILABLE_CRITICAL_EXTENSION,
5236 "backend does not support extended operations" );
5240 op->o_bd->be_extended( op, rs );
5243 if ( !BER_BVISNULL( &op->o_req_ndn ) ) {
5244 op->o_tmpfree( op->o_req_ndn.bv_val, op->o_tmpmemctx );
5245 BER_BVZERO( &op->o_req_ndn );
5246 BER_BVZERO( &op->o_req_dn );
5249 if ( !BER_BVISNULL( &uuid ) ) {
5250 op->o_tmpfree( uuid.bv_val, op->o_tmpmemctx );
5257 #endif /* PCACHE_EXOP_QUERY_DELETE */
5260 pcache_op_extended( Operation *op, SlapReply *rs )
5262 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
5263 cache_manager *cm = on->on_bi.bi_private;
5265 #ifdef PCACHE_CONTROL_PRIVDB
5266 if ( op->o_ctrlflag[ privDB_cid ] == SLAP_CONTROL_CRITICAL ) {
5267 return pcache_op_privdb( op, rs );
5269 #endif /* PCACHE_CONTROL_PRIVDB */
5271 #ifdef PCACHE_EXOP_QUERY_DELETE
5272 if ( bvmatch( &op->ore_reqoid, &pcache_exop_QUERY_DELETE ) ) {
5273 struct berval uuid = BER_BVNULL;
5274 ber_tag_t tag = LBER_DEFAULT;
5276 rs->sr_err = pcache_parse_query_delete( op->ore_reqdata,
5277 &tag, NULL, &uuid, &rs->sr_text, op->o_tmpmemctx );
5278 assert( rs->sr_err == LDAP_SUCCESS );
5280 if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_DN ) {
5281 /* remove all queries related to the selected entry */
5282 rs->sr_err = pcache_remove_entry_queries_from_cache( op,
5283 cm, &op->o_req_ndn, &uuid );
5285 } else if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_BASE ) {
5286 if ( !BER_BVISNULL( &uuid ) ) {
5287 /* remove the selected query */
5288 rs->sr_err = pcache_remove_query_from_cache( op,
5292 /* TODO: remove all queries */
5293 rs->sr_err = LDAP_UNWILLING_TO_PERFORM;
5294 rs->sr_text = "deletion of all queries not implemented";
5298 op->o_tmpfree( uuid.bv_val, op->o_tmpmemctx );
5301 #endif /* PCACHE_EXOP_QUERY_DELETE */
5303 /* We only care if we're configured for Bind caching */
5304 if ( bvmatch( &op->ore_reqoid, &pcache_exop_MODIFY_PASSWD ) &&
5306 /* See if the local entry exists and has a password.
5307 * It's too much work to find the matching query, so
5308 * we just see if there's a hashed password to update.
5310 Operation op2 = *op;
5316 op2.o_dn = op->o_bd->be_rootdn;
5317 op2.o_ndn = op->o_bd->be_rootndn;
5318 rc = be_entry_get_rw( &op2, &op->o_req_ndn, NULL,
5319 slap_schema.si_ad_userPassword, 0, &e );
5320 if ( rc == LDAP_SUCCESS && e ) {
5321 /* See if a recognized password is hashed here */
5322 Attribute *a = attr_find( e->e_attrs,
5323 slap_schema.si_ad_userPassword );
5324 if ( a && a->a_vals[0].bv_val[0] == '{' &&
5325 lutil_passwd_scheme( a->a_vals[0].bv_val )) {
5328 be_entry_release_r( &op2, e );
5332 rc = overlay_op_walk( op, rs, op_extended, on->on_info,
5334 if ( rc == LDAP_SUCCESS ) {
5335 req_pwdexop_s *qpw = &op->oq_pwdexop;
5337 /* We don't care if it succeeds or not */
5338 pc_setpw( &op2, &qpw->rs_new, cm );
5343 return SLAP_CB_CONTINUE;
5347 pcache_entry_release( Operation *op, Entry *e, int rw )
5349 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
5350 cache_manager *cm = on->on_bi.bi_private;
5351 BackendDB *db = op->o_bd;
5355 rc = be_entry_release_rw( op, e, rw );
5360 #ifdef PCACHE_MONITOR
5363 pcache_monitor_update(
5369 cache_manager *cm = (cache_manager *) priv;
5370 query_manager *qm = cm->qm;
5373 BerVarray vals = NULL;
5375 attr_delete( &e->e_attrs, ad_cachedQueryURL );
5376 if ( ( SLAP_OPATTRS( rs->sr_attr_flags ) || ad_inlist( ad_cachedQueryURL, rs->sr_attrs ) )
5377 && qm->templates != NULL )
5381 for ( tm = qm->templates; tm != NULL; tm = tm->qmnext ) {
5382 for ( qc = tm->query; qc; qc = qc->next ) {
5385 if ( query2url( op, qc, &bv, 1 ) == 0 ) {
5386 ber_bvarray_add_x( &vals, &bv, op->o_tmpmemctx );
5392 if ( vals != NULL ) {
5393 attr_merge_normalize( e, ad_cachedQueryURL, vals, NULL );
5394 ber_bvarray_free_x( vals, op->o_tmpmemctx );
5400 char buf[ SLAP_TEXT_BUFLEN ];
5403 /* number of cached queries */
5404 a = attr_find( e->e_attrs, ad_numQueries );
5405 assert( a != NULL );
5408 bv.bv_len = snprintf( buf, sizeof( buf ), "%lu", cm->num_cached_queries );
5410 if ( a->a_nvals != a->a_vals ) {
5411 ber_bvreplace( &a->a_nvals[ 0 ], &bv );
5413 ber_bvreplace( &a->a_vals[ 0 ], &bv );
5415 /* number of cached entries */
5416 a = attr_find( e->e_attrs, ad_numEntries );
5417 assert( a != NULL );
5420 bv.bv_len = snprintf( buf, sizeof( buf ), "%d", cm->cur_entries );
5422 if ( a->a_nvals != a->a_vals ) {
5423 ber_bvreplace( &a->a_nvals[ 0 ], &bv );
5425 ber_bvreplace( &a->a_vals[ 0 ], &bv );
5428 return SLAP_CB_CONTINUE;
5432 pcache_monitor_free(
5436 struct berval values[ 2 ];
5437 Modification mod = { 0 };
5440 char textbuf[ SLAP_TEXT_BUFLEN ];
5444 /* NOTE: if slap_shutdown != 0, priv might have already been freed */
5447 /* Remove objectClass */
5448 mod.sm_op = LDAP_MOD_DELETE;
5449 mod.sm_desc = slap_schema.si_ad_objectClass;
5450 mod.sm_values = values;
5452 values[ 0 ] = oc_olmPCache->soc_cname;
5453 BER_BVZERO( &values[ 1 ] );
5455 rc = modify_delete_values( e, &mod, 1, &text,
5456 textbuf, sizeof( textbuf ) );
5457 /* don't care too much about return code... */
5460 mod.sm_values = NULL;
5461 mod.sm_desc = ad_cachedQueryURL;
5463 rc = modify_delete_values( e, &mod, 1, &text,
5464 textbuf, sizeof( textbuf ) );
5465 /* don't care too much about return code... */
5468 mod.sm_values = NULL;
5469 mod.sm_desc = ad_numQueries;
5471 rc = modify_delete_values( e, &mod, 1, &text,
5472 textbuf, sizeof( textbuf ) );
5473 /* don't care too much about return code... */
5476 mod.sm_values = NULL;
5477 mod.sm_desc = ad_numEntries;
5479 rc = modify_delete_values( e, &mod, 1, &text,
5480 textbuf, sizeof( textbuf ) );
5481 /* don't care too much about return code... */
5483 return SLAP_CB_CONTINUE;
5487 * call from within pcache_initialize()
5490 pcache_monitor_initialize( void )
5492 static int pcache_monitor_initialized = 0;
5494 if ( backend_info( "monitor" ) == NULL ) {
5498 if ( pcache_monitor_initialized++ ) {
5506 pcache_monitor_db_init( BackendDB *be )
5508 if ( pcache_monitor_initialize() == LDAP_SUCCESS ) {
5509 SLAP_DBFLAGS( be ) |= SLAP_DBFLAG_MONITORING;
5516 pcache_monitor_db_open( BackendDB *be )
5518 slap_overinst *on = (slap_overinst *)be->bd_info;
5519 cache_manager *cm = on->on_bi.bi_private;
5520 Attribute *a, *next;
5521 monitor_callback_t *cb = NULL;
5524 monitor_extra_t *mbe;
5525 struct berval dummy = BER_BVC( "" );
5527 if ( !SLAP_DBMONITORING( be ) ) {
5531 mi = backend_info( "monitor" );
5532 if ( !mi || !mi->bi_extra ) {
5533 SLAP_DBFLAGS( be ) ^= SLAP_DBFLAG_MONITORING;
5538 /* don't bother if monitor is not configured */
5539 if ( !mbe->is_configured() ) {
5540 static int warning = 0;
5542 if ( warning++ == 0 ) {
5543 Debug( LDAP_DEBUG_ANY, "pcache_monitor_db_open: "
5544 "monitoring disabled; "
5545 "configure monitor database to enable\n",
5552 /* alloc as many as required (plus 1 for objectClass) */
5553 a = attrs_alloc( 1 + 2 );
5559 a->a_desc = slap_schema.si_ad_objectClass;
5560 attr_valadd( a, &oc_olmPCache->soc_cname, NULL, 1 );
5564 struct berval bv = BER_BVC( "0" );
5566 next->a_desc = ad_numQueries;
5567 attr_valadd( next, &bv, NULL, 1 );
5568 next = next->a_next;
5570 next->a_desc = ad_numEntries;
5571 attr_valadd( next, &bv, NULL, 1 );
5572 next = next->a_next;
5575 cb = ch_calloc( sizeof( monitor_callback_t ), 1 );
5576 cb->mc_update = pcache_monitor_update;
5577 cb->mc_free = pcache_monitor_free;
5578 cb->mc_private = (void *)cm;
5580 /* make sure the database is registered; then add monitor attributes */
5581 BER_BVZERO( &cm->monitor_ndn );
5582 rc = mbe->register_overlay( be, on, &cm->monitor_ndn );
5584 rc = mbe->register_entry_attrs( &cm->monitor_ndn, a, cb,
5585 &dummy, -1, &dummy);
5601 /* store for cleanup */
5602 cm->monitor_cb = (void *)cb;
5604 /* we don't need to keep track of the attributes, because
5605 * bdb_monitor_free() takes care of everything */
5614 pcache_monitor_db_close( BackendDB *be )
5616 slap_overinst *on = (slap_overinst *)be->bd_info;
5617 cache_manager *cm = on->on_bi.bi_private;
5619 if ( cm->monitor_cb != NULL ) {
5620 BackendInfo *mi = backend_info( "monitor" );
5621 monitor_extra_t *mbe;
5623 if ( mi && &mi->bi_extra ) {
5625 mbe->unregister_entry_callback( &cm->monitor_ndn,
5626 (monitor_callback_t *)cm->monitor_cb,
5635 pcache_monitor_db_destroy( BackendDB *be )
5640 #endif /* PCACHE_MONITOR */
5642 static slap_overinst pcache;
5644 static char *obsolete_names[] = {
5649 #if SLAPD_OVER_PROXYCACHE == SLAPD_MOD_DYNAMIC
5651 #endif /* SLAPD_OVER_PROXYCACHE == SLAPD_MOD_DYNAMIC */
5656 struct berval debugbv = BER_BVC("pcache");
5660 code = slap_loglevel_get( &debugbv, &pcache_debug );
5665 #ifdef PCACHE_CONTROL_PRIVDB
5666 code = register_supported_control( PCACHE_CONTROL_PRIVDB,
5667 SLAP_CTRL_BIND|SLAP_CTRL_ACCESS|SLAP_CTRL_HIDE, extops,
5668 parse_privdb_ctrl, &privDB_cid );
5669 if ( code != LDAP_SUCCESS ) {
5670 Debug( LDAP_DEBUG_ANY,
5671 "pcache_initialize: failed to register control %s (%d)\n",
5672 PCACHE_CONTROL_PRIVDB, code, 0 );
5675 #endif /* PCACHE_CONTROL_PRIVDB */
5677 #ifdef PCACHE_EXOP_QUERY_DELETE
5678 code = load_extop2( (struct berval *)&pcache_exop_QUERY_DELETE,
5679 SLAP_EXOP_WRITES|SLAP_EXOP_HIDE, pcache_exop_query_delete,
5681 if ( code != LDAP_SUCCESS ) {
5682 Debug( LDAP_DEBUG_ANY,
5683 "pcache_initialize: unable to register queryDelete exop: %d.\n",
5687 #endif /* PCACHE_EXOP_QUERY_DELETE */
5689 argv[ 0 ] = "back-bdb/back-hdb monitor";
5694 for ( i = 0; s_oid[ i ].name; i++ ) {
5696 argv[ 1 ] = s_oid[ i ].name;
5697 argv[ 2 ] = s_oid[ i ].oid;
5699 if ( parse_oidm( &c, 0, NULL ) != 0 ) {
5700 Debug( LDAP_DEBUG_ANY, "pcache_initialize: "
5701 "unable to add objectIdentifier \"%s=%s\"\n",
5702 s_oid[ i ].name, s_oid[ i ].oid, 0 );
5707 for ( i = 0; s_ad[i].desc != NULL; i++ ) {
5708 code = register_at( s_ad[i].desc, s_ad[i].adp, 0 );
5710 Debug( LDAP_DEBUG_ANY,
5711 "pcache_initialize: register_at #%d failed\n", i, 0, 0 );
5714 (*s_ad[i].adp)->ad_type->sat_flags |= SLAP_AT_HIDE;
5717 for ( i = 0; s_oc[i].desc != NULL; i++ ) {
5718 code = register_oc( s_oc[i].desc, s_oc[i].ocp, 0 );
5720 Debug( LDAP_DEBUG_ANY,
5721 "pcache_initialize: register_oc #%d failed\n", i, 0, 0 );
5724 (*s_oc[i].ocp)->soc_flags |= SLAP_OC_HIDE;
5727 pcache.on_bi.bi_type = "pcache";
5728 pcache.on_bi.bi_obsolete_names = obsolete_names;
5729 pcache.on_bi.bi_db_init = pcache_db_init;
5730 pcache.on_bi.bi_db_config = pcache_db_config;
5731 pcache.on_bi.bi_db_open = pcache_db_open;
5732 pcache.on_bi.bi_db_close = pcache_db_close;
5733 pcache.on_bi.bi_db_destroy = pcache_db_destroy;
5735 pcache.on_bi.bi_op_search = pcache_op_search;
5736 pcache.on_bi.bi_op_bind = pcache_op_bind;
5737 #ifdef PCACHE_CONTROL_PRIVDB
5738 pcache.on_bi.bi_op_compare = pcache_op_privdb;
5739 pcache.on_bi.bi_op_modrdn = pcache_op_privdb;
5740 pcache.on_bi.bi_op_modify = pcache_op_privdb;
5741 pcache.on_bi.bi_op_add = pcache_op_privdb;
5742 pcache.on_bi.bi_op_delete = pcache_op_privdb;
5743 #endif /* PCACHE_CONTROL_PRIVDB */
5744 pcache.on_bi.bi_extended = pcache_op_extended;
5746 pcache.on_bi.bi_entry_release_rw = pcache_entry_release;
5747 pcache.on_bi.bi_chk_controls = pcache_chk_controls;
5749 pcache.on_bi.bi_cf_ocs = pcocs;
5751 code = config_register_schema( pccfg, pcocs );
5752 if ( code ) return code;
5754 return overlay_register( &pcache );
5757 #if SLAPD_OVER_PROXYCACHE == SLAPD_MOD_DYNAMIC
5758 int init_module(int argc, char *argv[]) {
5759 return pcache_initialize();
5763 #endif /* defined(SLAPD_OVER_PROXYCACHE) */