2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 2003-2009 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 unsigned long answerable_cnt; /* how many times it was answerable */
88 int refcnt; /* references since last refresh */
89 ldap_pvt_thread_mutex_t answerable_cnt_mutex;
90 struct cached_query_s *next; /* next query in the template */
91 struct cached_query_s *prev; /* previous query in the template */
92 struct cached_query_s *lru_up; /* previous query in the LRU list */
93 struct cached_query_s *lru_down; /* next query in the LRU list */
94 ldap_pvt_thread_rdwr_t rwlock;
100 * ldap:///<base>??<scope>?<filter>?x-uuid=<uid>,x-template=<template>,x-attrset=<attrset>,x-expiry=<expiry>,x-refresh=<refresh>
102 * <base> ::= CachedQuery.qbase->base
103 * <scope> ::= CachedQuery.scope
104 * <filter> ::= filter2bv(CachedQuery.filter)
105 * <uuid> ::= CachedQuery.q_uuid
106 * <attrset> ::= CachedQuery.qtemp->attr_set_index
107 * <expiry> ::= CachedQuery.expiry_time
108 * <refresh> ::= CachedQuery.refresh_time
110 * quick hack: parse URI, call add_query() and then fix
111 * CachedQuery.expiry_time and CachedQuery.q_uuid
113 * NOTE: if the <attrset> changes, all stored URLs will be invalidated.
117 * Represents a set of projected attributes.
121 struct query_template_s *templates;
122 AttributeName* attrs; /* specifies the set */
124 #define PC_CONFIGURED (0x1)
125 #define PC_REFERENCED (0x2)
126 #define PC_GOT_OC (0x4)
127 int count; /* number of attributes */
130 /* struct representing a query template
131 * e.g. template string = &(cn=)(mail=)
133 typedef struct query_template_s {
134 struct query_template_s *qtnext;
135 struct query_template_s *qmnext;
138 CachedQuery* query; /* most recent query cached for the template */
139 CachedQuery* query_last; /* oldest query cached for the template */
140 ldap_pvt_thread_rdwr_t t_rwlock; /* Rd/wr lock for accessing queries in the template */
141 struct berval querystr; /* Filter string corresponding to the QT */
142 struct berval bindbase; /* base DN for Bind request */
143 struct berval bindfilterstr; /* Filter string for Bind request */
144 struct berval bindftemp; /* bind filter template */
146 AttributeDescription **bindfattrs; /* attrs to substitute in ftemp */
148 int bindnattrs; /* number of bindfattrs */
150 int attr_set_index; /* determines the projected attributes */
151 int no_of_queries; /* Total number of queries in the template */
152 time_t ttl; /* TTL for the queries of this template */
153 time_t negttl; /* TTL for negative results */
154 time_t limitttl; /* TTL for sizelimit exceeding results */
155 time_t ttr; /* time to refresh */
156 time_t bindttr; /* TTR for cached binds */
157 struct attr_set t_attrs; /* filter attrs + attr_set */
165 } pc_caching_reason_t;
167 static const char *pc_caching_reason_str[] = {
176 struct query_manager_s;
178 /* prototypes for functions for 1) query containment
179 * 2) query addition, 3) cache replacement
181 typedef CachedQuery *(QCfunc)(Operation *op, struct query_manager_s*,
182 Query*, QueryTemplate*);
183 typedef CachedQuery *(AddQueryfunc)(Operation *op, struct query_manager_s*,
184 Query*, QueryTemplate*, pc_caching_reason_t, int wlock);
185 typedef void (CRfunc)(struct query_manager_s*, struct berval*);
187 /* LDAP query cache */
188 typedef struct query_manager_s {
189 struct attr_set* attr_sets; /* possible sets of projected attributes */
190 QueryTemplate* templates; /* cacheable templates */
192 CachedQuery* lru_top; /* top and bottom of LRU list */
193 CachedQuery* lru_bottom;
195 ldap_pvt_thread_mutex_t lru_mutex; /* mutex for accessing LRU list */
197 /* Query cache methods */
198 QCfunc *qcfunc; /* Query containment*/
199 CRfunc *crfunc; /* cache replacement */
200 AddQueryfunc *addfunc; /* add query */
203 /* LDAP query cache manager */
204 typedef struct cache_manager_s {
205 BackendDB db; /* underlying database */
206 unsigned long num_cached_queries; /* total number of cached queries */
207 unsigned long max_queries; /* upper bound on # of cached queries */
208 int save_queries; /* save cached queries across restarts */
209 int check_cacheability; /* check whether a query is cacheable */
210 int numattrsets; /* number of attribute sets */
211 int cur_entries; /* current number of entries cached */
212 int max_entries; /* max number of entries cached */
213 int num_entries_limit; /* max # of entries in a cacheable query */
215 char response_cb; /* install the response callback
216 * at the tail of the callback list */
217 #define PCACHE_RESPONSE_CB_HEAD 0
218 #define PCACHE_RESPONSE_CB_TAIL 1
219 char defer_db_open; /* defer open for online add */
220 char cache_binds; /* cache binds or just passthru */
222 time_t cc_period; /* interval between successive consistency checks (sec) */
223 #define PCACHE_CC_PAUSED 1
224 #define PCACHE_CC_OFFLINE 2
228 ldap_pvt_thread_mutex_t cache_mutex;
230 query_manager* qm; /* query cache managed by the cache manager */
232 #ifdef PCACHE_MONITOR
234 struct berval monitor_ndn;
235 #endif /* PCACHE_MONITOR */
238 #ifdef PCACHE_MONITOR
239 static int pcache_monitor_db_init( BackendDB *be );
240 static int pcache_monitor_db_open( BackendDB *be );
241 static int pcache_monitor_db_close( BackendDB *be );
242 static int pcache_monitor_db_destroy( BackendDB *be );
243 #endif /* PCACHE_MONITOR */
245 static int pcache_debug;
247 #ifdef PCACHE_CONTROL_PRIVDB
248 static int privDB_cid;
249 #endif /* PCACHE_CONTROL_PRIVDB */
251 static AttributeDescription *ad_queryId, *ad_cachedQueryURL;
253 #ifdef PCACHE_MONITOR
254 static AttributeDescription *ad_numQueries, *ad_numEntries;
255 static ObjectClass *oc_olmPCache;
256 #endif /* PCACHE_MONITOR */
262 { "PCacheOID", "1.3.6.1.4.1.4203.666.11.9.1" },
263 { "PCacheAttributes", "PCacheOID:1" },
264 { "PCacheObjectClasses", "PCacheOID:2" },
271 AttributeDescription **adp;
273 { "( PCacheAttributes:1 "
274 "NAME 'pcacheQueryID' "
275 "DESC 'ID of query the entry belongs to, formatted as a UUID' "
276 "EQUALITY octetStringMatch "
277 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.40{64} "
278 "NO-USER-MODIFICATION "
279 "USAGE directoryOperation )",
281 { "( PCacheAttributes:2 "
282 "NAME 'pcacheQueryURL' "
283 "DESC 'URI describing a cached query' "
284 "EQUALITY caseExactMatch "
285 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.15 "
286 "NO-USER-MODIFICATION "
287 "USAGE directoryOperation )",
288 &ad_cachedQueryURL },
289 #ifdef PCACHE_MONITOR
290 { "( PCacheAttributes:3 "
291 "NAME 'pcacheNumQueries' "
292 "DESC 'Number of cached queries' "
293 "EQUALITY integerMatch "
294 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.27 "
295 "NO-USER-MODIFICATION "
296 "USAGE directoryOperation )",
298 { "( PCacheAttributes:4 "
299 "NAME 'pcacheNumEntries' "
300 "DESC 'Number of cached entries' "
301 "EQUALITY integerMatch "
302 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.27 "
303 "NO-USER-MODIFICATION "
304 "USAGE directoryOperation )",
306 #endif /* PCACHE_MONITOR */
315 #ifdef PCACHE_MONITOR
316 /* augments an existing object, so it must be AUXILIARY */
317 { "( PCacheObjectClasses:1 "
318 "NAME ( 'olmPCache' ) "
322 "$ pcacheNumQueries "
323 "$ pcacheNumEntries "
326 #endif /* PCACHE_MONITOR */
335 struct berval *fstr );
342 QueryTemplate *templ,
343 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 );
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 rc = syn_UUID->ssyn_pretty( syn_UUID, &tmpUUID, &uuid, NULL );
679 if ( rc != LDAP_SUCCESS ) {
684 } else if ( strncmp( lud->lud_exts[ i ], "x-attrset=", STRLENOF( "x-attrset=" ) ) == 0 ) {
685 if ( got & GOT_ATTRSET ) {
690 rc = lutil_atoi( &attrset, &lud->lud_exts[ i ][ STRLENOF( "x-attrset=" ) ] );
696 } else if ( strncmp( lud->lud_exts[ i ], "x-expiry=", STRLENOF( "x-expiry=" ) ) == 0 ) {
699 if ( got & GOT_EXPIRY ) {
704 rc = lutil_atoul( &l, &lud->lud_exts[ i ][ STRLENOF( "x-expiry=" ) ] );
708 expiry_time = (time_t)l;
711 } else if ( strncmp( lud->lud_exts[ i ], "x-answerable=", STRLENOF( "x-answerable=" ) ) == 0 ) {
712 if ( got & GOT_ANSWERABLE ) {
717 rc = lutil_atoul( &answerable_cnt, &lud->lud_exts[ i ][ STRLENOF( "x-answerable=" ) ] );
721 got |= GOT_ANSWERABLE;
723 } else if ( strncmp( lud->lud_exts[ i ], "x-refresh=", STRLENOF( "x-refresh=" ) ) == 0 ) {
726 if ( got & GOT_REFRESH ) {
731 rc = lutil_atoul( &l, &lud->lud_exts[ i ][ STRLENOF( "x-refresh=" ) ] );
735 refresh_time = (time_t)l;
744 if ( got != GOT_ALL ) {
749 if ( !(got & GOT_REFRESH ))
752 /* ignore expired queries */
753 if ( expiry_time <= slap_get_time()) {
755 SlapReply rs2 = { 0 };
757 memset( &op2.oq_search, 0, sizeof( op2.oq_search ) );
759 (void)remove_query_data( &op2, &rs2, &uuid );
764 ber_str2bv( lud->lud_dn, 0, 0, &base );
765 rc = dnNormalize( 0, NULL, NULL, &base, &query.base, NULL );
766 if ( rc != LDAP_SUCCESS ) {
769 query.scope = lud->lud_scope;
770 query.filter = str2filter( lud->lud_filter );
772 tempstr.bv_val = ch_malloc( strlen( lud->lud_filter ) + 1 );
774 if ( filter2template( op, query.filter, &tempstr ) ) {
775 ch_free( tempstr.bv_val );
780 /* check for query containment */
781 qt = qm->attr_sets[attrset].templates;
782 for ( ; qt; qt = qt->qtnext ) {
783 /* find if template i can potentially answer tempstr */
784 if ( bvmatch( &qt->querystr, &tempstr ) ) {
794 cq = add_query( op, qm, &query, qt, PC_POSITIVE, 0 );
796 cq->expiry_time = expiry_time;
797 cq->refresh_time = refresh_time;
799 cq->answerable_cnt = answerable_cnt;
802 /* it's now into cq->filter */
812 if ( query.filter != NULL ) filter_free( query.filter );
813 if ( !BER_BVISNULL( &tempstr ) ) ch_free( tempstr.bv_val );
814 if ( !BER_BVISNULL( &query.base ) ) ch_free( query.base.bv_val );
815 if ( !BER_BVISNULL( &uuid ) ) ch_free( uuid.bv_val );
816 if ( lud != NULL ) ldap_free_urldesc( lud );
821 /* Return 1 for an added entry, else 0 */
826 struct berval* query_uuid )
829 Modifications* modlist = NULL;
830 const char* text = NULL;
832 char textbuf[SLAP_TEXT_BUFLEN];
833 size_t textlen = sizeof(textbuf);
835 SlapReply sreply = {REP_RESULT};
837 slap_callback cb = { NULL, slap_null_cb, NULL, NULL };
842 /* add queryId attribute */
843 attr_merge_one( e, ad_queryId, query_uuid, NULL );
845 /* append the attribute list from the fetched entry */
846 e->e_attrs->a_next = attr;
848 op->o_tag = LDAP_REQ_ADD;
849 op->o_protocol = LDAP_VERSION3;
850 op->o_callback = &cb;
851 op->o_time = slap_get_time();
852 op->o_do_not_cache = 1;
855 op->o_req_dn = e->e_name;
856 op->o_req_ndn = e->e_nname;
857 rc = op->o_bd->be_add( op, &sreply );
859 if ( rc != LDAP_SUCCESS ) {
860 if ( rc == LDAP_ALREADY_EXISTS ) {
861 slap_entry2mods( e, &modlist, &text, textbuf, textlen );
862 modlist->sml_op = LDAP_MOD_ADD;
863 op->o_tag = LDAP_REQ_MODIFY;
864 op->orm_modlist = modlist;
865 op->o_bd->be_modify( op, &sreply );
866 slap_mods_free( modlist, 1 );
867 } else if ( rc == LDAP_REFERRAL ||
868 rc == LDAP_NO_SUCH_OBJECT ) {
869 syncrepl_add_glue( op, e );
878 if ( op->ora_e == e )
879 be_entry_release_w( op, e );
886 /* Length-ordered sort on normalized DNs */
887 static int pcache_dn_cmp( const void *v1, const void *v2 )
889 const Qbase *q1 = v1, *q2 = v2;
891 int rc = q1->base.bv_len - q2->base.bv_len;
893 rc = strncmp( q1->base.bv_val, q2->base.bv_val, q1->base.bv_len );
897 static int lex_bvcmp( struct berval *bv1, struct berval *bv2 )
900 dif = bv1->bv_len - bv2->bv_len;
902 if ( dif > 0 ) len -= dif;
903 len = memcmp( bv1->bv_val, bv2->bv_val, len );
909 /* compare the current value in each filter */
910 static int pcache_filter_cmp( Filter *f1, Filter *f2 )
912 int rc, weight1, weight2;
914 switch( f1->f_choice ) {
915 case LDAP_FILTER_PRESENT:
918 case LDAP_FILTER_EQUALITY:
926 switch( f2->f_choice ) {
927 case LDAP_FILTER_PRESENT:
930 case LDAP_FILTER_EQUALITY:
938 rc = weight1 - weight2;
944 rc = lex_bvcmp( &f1->f_av_value, &f2->f_av_value );
947 if ( f1->f_choice == LDAP_FILTER_SUBSTRINGS ) {
949 if ( !BER_BVISNULL( &f1->f_sub_initial )) {
950 if ( !BER_BVISNULL( &f2->f_sub_initial )) {
951 rc = lex_bvcmp( &f1->f_sub_initial,
952 &f2->f_sub_initial );
956 } else if ( !BER_BVISNULL( &f2->f_sub_initial )) {
960 if ( f1->f_sub_any ) {
961 if ( f2->f_sub_any ) {
962 rc = lex_bvcmp( f1->f_sub_any,
967 } else if ( f2->f_sub_any ) {
971 if ( !BER_BVISNULL( &f1->f_sub_final )) {
972 if ( !BER_BVISNULL( &f2->f_sub_final )) {
973 rc = lex_bvcmp( &f1->f_sub_final,
978 } else if ( !BER_BVISNULL( &f2->f_sub_final )) {
982 rc = lex_bvcmp( &f1->f_mr_value,
996 while ( f1->f_choice == LDAP_FILTER_AND || f1->f_choice == LDAP_FILTER_OR )
998 while ( f2->f_choice == LDAP_FILTER_AND || f2->f_choice == LDAP_FILTER_OR )
1000 rc = pcache_filter_cmp( f1, f2 );
1008 /* compare filters in each query */
1009 static int pcache_query_cmp( const void *v1, const void *v2 )
1011 const CachedQuery *q1 = v1, *q2 =v2;
1012 return pcache_filter_cmp( q1->first, q2->first );
1015 /* add query on top of LRU list */
1017 add_query_on_top (query_manager* qm, CachedQuery* qc)
1019 CachedQuery* top = qm->lru_top;
1026 qm->lru_bottom = qc;
1030 Debug( pcache_debug, "Base of added query = %s\n",
1031 qc->qbase->base.bv_val, 0, 0 );
1034 /* remove_query from LRU list */
1037 remove_query (query_manager* qm, CachedQuery* qc)
1046 down = qc->lru_down;
1052 qm->lru_bottom = up;
1058 up->lru_down = down;
1060 qc->lru_up = qc->lru_down = NULL;
1063 /* find and remove string2 from string1
1064 * from start if position = 1,
1065 * from end if position = 3,
1066 * from anywhere if position = 2
1067 * string1 is overwritten if position = 2.
1071 find_and_remove(struct berval* ber1, struct berval* ber2, int position)
1075 if ( !ber2->bv_val )
1077 if ( !ber1->bv_val )
1080 switch( position ) {
1082 if ( ber1->bv_len >= ber2->bv_len && !memcmp( ber1->bv_val,
1083 ber2->bv_val, ber2->bv_len )) {
1085 ber1->bv_val += ber2->bv_len;
1086 ber1->bv_len -= ber2->bv_len;
1091 ber1->bv_val[ber1->bv_len] = '\0';
1092 temp = strstr( ber1->bv_val, ber2->bv_val );
1094 strcpy( temp, temp+ber2->bv_len );
1095 ber1->bv_len -= ber2->bv_len;
1101 if ( ber1->bv_len >= ber2->bv_len &&
1102 !memcmp( ber1->bv_val+ber1->bv_len-ber2->bv_len, ber2->bv_val,
1105 ber1->bv_len -= ber2->bv_len;
1113 static struct berval*
1114 merge_init_final(Operation *op, struct berval* init, struct berval* any,
1115 struct berval* final)
1117 struct berval* merged, *temp;
1118 int i, any_count, count;
1120 for (any_count=0; any && any[any_count].bv_val; any_count++)
1130 merged = (struct berval*)op->o_tmpalloc( (count+1)*sizeof(struct berval),
1135 ber_dupbv_x( temp, init, op->o_tmpmemctx );
1139 for (i=0; i<any_count; i++) {
1140 ber_dupbv_x( temp, any, op->o_tmpmemctx );
1145 ber_dupbv_x( temp, final, op->o_tmpmemctx );
1152 /* Each element in stored must be found in incoming. Incoming is overwritten.
1155 strings_containment(struct berval* stored, struct berval* incoming)
1157 struct berval* element;
1161 for ( element=stored; element->bv_val != NULL; element++ ) {
1162 for (j = k; incoming[j].bv_val != NULL; j++) {
1163 if (find_and_remove(&(incoming[j]), element, 2)) {
1180 substr_containment_substr(Operation *op, Filter* stored, Filter* incoming)
1184 struct berval init_incoming;
1185 struct berval final_incoming;
1186 struct berval *remaining_incoming = NULL;
1188 if ((!(incoming->f_sub_initial.bv_val) && (stored->f_sub_initial.bv_val))
1189 || (!(incoming->f_sub_final.bv_val) && (stored->f_sub_final.bv_val)))
1192 init_incoming = incoming->f_sub_initial;
1193 final_incoming = incoming->f_sub_final;
1195 if (find_and_remove(&init_incoming,
1196 &(stored->f_sub_initial), 1) && find_and_remove(&final_incoming,
1197 &(stored->f_sub_final), 3))
1199 if (stored->f_sub_any == NULL) {
1203 remaining_incoming = merge_init_final(op, &init_incoming,
1204 incoming->f_sub_any, &final_incoming);
1205 rc = strings_containment(stored->f_sub_any, remaining_incoming);
1206 ber_bvarray_free_x( remaining_incoming, op->o_tmpmemctx );
1213 substr_containment_equality(Operation *op, Filter* stored, Filter* incoming)
1215 struct berval incoming_val[2];
1218 incoming_val[1] = incoming->f_av_value;
1220 if (find_and_remove(incoming_val+1,
1221 &(stored->f_sub_initial), 1) && find_and_remove(incoming_val+1,
1222 &(stored->f_sub_final), 3)) {
1223 if (stored->f_sub_any == NULL){
1227 ber_dupbv_x( incoming_val, incoming_val+1, op->o_tmpmemctx );
1228 BER_BVZERO( incoming_val+1 );
1229 rc = strings_containment(stored->f_sub_any, incoming_val);
1230 op->o_tmpfree( incoming_val[0].bv_val, op->o_tmpmemctx );
1237 filter_first( Filter *f )
1239 while ( f->f_choice == LDAP_FILTER_OR || f->f_choice == LDAP_FILTER_AND )
1245 static CachedQuery *
1246 find_filter( Operation *op, Avlnode *root, Filter *inputf, Filter *first )
1250 MatchingRule* mrule = NULL;
1251 int res=0, eqpass= 0;
1254 CachedQuery cq, *qc;
1259 /* substring matches sort to the end, and we just have to
1260 * walk the entire list.
1262 if ( first->f_choice == LDAP_FILTER_SUBSTRINGS ) {
1263 ptr = tavl_end( root, 1 );
1264 dir = TAVL_DIR_LEFT;
1266 ptr = tavl_find3( root, &cq, pcache_query_cmp, &ret );
1267 dir = (first->f_choice == LDAP_FILTER_GE) ? TAVL_DIR_LEFT :
1276 /* an incoming substr query can only be satisfied by a cached
1279 if ( first->f_choice == LDAP_FILTER_SUBSTRINGS &&
1280 qc->first->f_choice != LDAP_FILTER_SUBSTRINGS )
1283 /* an incoming eq query can be satisfied by a cached eq or substr
1286 if ( first->f_choice == LDAP_FILTER_EQUALITY ) {
1287 if ( eqpass == 0 ) {
1288 if ( qc->first->f_choice != LDAP_FILTER_EQUALITY ) {
1289 nextpass: eqpass = 1;
1290 ptr = tavl_end( root, 1 );
1291 dir = TAVL_DIR_LEFT;
1295 if ( qc->first->f_choice != LDAP_FILTER_SUBSTRINGS )
1301 switch (fs->f_choice) {
1302 case LDAP_FILTER_EQUALITY:
1303 if (fi->f_choice == LDAP_FILTER_EQUALITY)
1304 mrule = fs->f_ava->aa_desc->ad_type->sat_equality;
1308 case LDAP_FILTER_GE:
1309 case LDAP_FILTER_LE:
1310 mrule = fs->f_ava->aa_desc->ad_type->sat_ordering;
1317 rc = value_match(&ret, fs->f_ava->aa_desc, mrule,
1318 SLAP_MR_VALUE_OF_ASSERTION_SYNTAX,
1319 &(fi->f_ava->aa_value),
1320 &(fs->f_ava->aa_value), &text);
1321 if (rc != LDAP_SUCCESS) {
1324 if ( fi==first && fi->f_choice==LDAP_FILTER_EQUALITY && ret )
1327 switch (fs->f_choice) {
1328 case LDAP_FILTER_OR:
1329 case LDAP_FILTER_AND:
1334 case LDAP_FILTER_SUBSTRINGS:
1335 /* check if the equality query can be
1336 * answered with cached substring query */
1337 if ((fi->f_choice == LDAP_FILTER_EQUALITY)
1338 && substr_containment_equality( op,
1341 /* check if the substring query can be
1342 * answered with cached substring query */
1343 if ((fi->f_choice ==LDAP_FILTER_SUBSTRINGS
1344 ) && substr_containment_substr( op,
1350 case LDAP_FILTER_PRESENT:
1355 case LDAP_FILTER_EQUALITY:
1361 case LDAP_FILTER_GE:
1362 if (mrule && ret >= 0)
1367 case LDAP_FILTER_LE:
1368 if (mrule && ret <= 0)
1373 case LDAP_FILTER_NOT:
1379 } while((res) && (fi != NULL) && (fs != NULL));
1383 ptr = tavl_next( ptr, dir );
1388 /* check whether query is contained in any of
1389 * the cached queries in template
1391 static CachedQuery *
1392 query_containment(Operation *op, query_manager *qm,
1394 QueryTemplate *templa)
1397 int depth = 0, tscope;
1398 Qbase qbase, *qbptr = NULL;
1401 if (query->filter != NULL) {
1404 Debug( pcache_debug, "Lock QC index = %p\n",
1405 (void *) templa, 0, 0 );
1406 qbase.base = query->base;
1408 first = filter_first( query->filter );
1410 ldap_pvt_thread_rdwr_rlock(&templa->t_rwlock);
1413 qbptr = avl_find( templa->qbase, &qbase, pcache_dn_cmp );
1415 tscope = query->scope;
1416 /* Find a matching scope:
1417 * match at depth 0 OK
1420 * subord at depth > 0 OK
1421 * subtree at any depth OK
1423 * subtree or subord at any depth OK
1425 * subtree or subord at any depth OK
1427 * subord at depth > 0 OK
1428 * subtree at any depth OK
1430 for ( tscope = 0 ; tscope <= LDAP_SCOPE_CHILDREN; tscope++ ) {
1431 switch ( query->scope ) {
1432 case LDAP_SCOPE_BASE:
1433 if ( tscope == LDAP_SCOPE_BASE && depth ) continue;
1434 if ( tscope == LDAP_SCOPE_ONE && depth != 1) continue;
1435 if ( tscope == LDAP_SCOPE_CHILDREN && !depth ) continue;
1437 case LDAP_SCOPE_ONE:
1438 if ( tscope == LDAP_SCOPE_BASE )
1439 tscope = LDAP_SCOPE_ONE;
1440 if ( tscope == LDAP_SCOPE_ONE && depth ) continue;
1441 if ( !depth ) break;
1442 if ( tscope < LDAP_SCOPE_SUBTREE )
1443 tscope = LDAP_SCOPE_SUBTREE;
1445 case LDAP_SCOPE_SUBTREE:
1446 if ( tscope < LDAP_SCOPE_SUBTREE )
1447 tscope = LDAP_SCOPE_SUBTREE;
1448 if ( tscope == LDAP_SCOPE_CHILDREN && !depth ) continue;
1450 case LDAP_SCOPE_CHILDREN:
1451 if ( tscope < LDAP_SCOPE_SUBTREE )
1452 tscope = LDAP_SCOPE_SUBTREE;
1455 if ( !qbptr->scopes[tscope] ) continue;
1458 qc = find_filter( op, qbptr->scopes[tscope],
1459 query->filter, first );
1461 if ( qc->q_sizelimit ) {
1462 ldap_pvt_thread_rdwr_runlock(&templa->t_rwlock);
1465 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
1466 if (qm->lru_top != qc) {
1467 remove_query(qm, qc);
1468 add_query_on_top(qm, qc);
1470 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1475 if ( be_issuffix( op->o_bd, &qbase.base ))
1478 dnParent( &qbase.base, &pdn );
1483 Debug( pcache_debug,
1484 "Not answerable: Unlock QC index=%p\n",
1485 (void *) templa, 0, 0 );
1486 ldap_pvt_thread_rdwr_runlock(&templa->t_rwlock);
1492 free_query (CachedQuery* qc)
1494 free(qc->q_uuid.bv_val);
1495 filter_free(qc->filter);
1496 ldap_pvt_thread_mutex_destroy(&qc->answerable_cnt_mutex);
1497 ldap_pvt_thread_rdwr_destroy( &qc->rwlock );
1498 memset(qc, 0, sizeof(*qc));
1503 /* Add query to query cache, the returned Query is locked for writing */
1504 static CachedQuery *
1509 QueryTemplate *templ,
1510 pc_caching_reason_t why,
1513 CachedQuery* new_cached_query = (CachedQuery*) ch_malloc(sizeof(CachedQuery));
1517 time_t ttl = 0, ttr = 0;
1520 new_cached_query->qtemp = templ;
1521 BER_BVZERO( &new_cached_query->q_uuid );
1522 new_cached_query->q_sizelimit = 0;
1524 now = slap_get_time();
1529 ttr = now + templ->ttr;
1533 ttl = templ->negttl;
1537 ttl = templ->limitttl;
1544 new_cached_query->expiry_time = now + ttl;
1545 new_cached_query->refresh_time = ttr;
1547 new_cached_query->answerable_cnt = 0;
1548 new_cached_query->refcnt = 1;
1549 ldap_pvt_thread_mutex_init(&new_cached_query->answerable_cnt_mutex);
1551 new_cached_query->lru_up = NULL;
1552 new_cached_query->lru_down = NULL;
1553 Debug( pcache_debug, "Added query expires at %ld (%s)\n",
1554 (long) new_cached_query->expiry_time,
1555 pc_caching_reason_str[ why ], 0 );
1557 new_cached_query->scope = query->scope;
1558 new_cached_query->filter = query->filter;
1559 new_cached_query->first = first = filter_first( query->filter );
1561 ldap_pvt_thread_rdwr_init(&new_cached_query->rwlock);
1563 ldap_pvt_thread_rdwr_wlock(&new_cached_query->rwlock);
1565 qb.base = query->base;
1567 /* Adding a query */
1568 Debug( pcache_debug, "Lock AQ index = %p\n",
1569 (void *) templ, 0, 0 );
1570 ldap_pvt_thread_rdwr_wlock(&templ->t_rwlock);
1571 qbase = avl_find( templ->qbase, &qb, pcache_dn_cmp );
1573 qbase = ch_calloc( 1, sizeof(Qbase) + qb.base.bv_len + 1 );
1574 qbase->base.bv_len = qb.base.bv_len;
1575 qbase->base.bv_val = (char *)(qbase+1);
1576 memcpy( qbase->base.bv_val, qb.base.bv_val, qb.base.bv_len );
1577 qbase->base.bv_val[qbase->base.bv_len] = '\0';
1578 avl_insert( &templ->qbase, qbase, pcache_dn_cmp, avl_dup_error );
1580 new_cached_query->next = templ->query;
1581 new_cached_query->prev = NULL;
1582 new_cached_query->qbase = qbase;
1583 rc = tavl_insert( &qbase->scopes[query->scope], new_cached_query,
1584 pcache_query_cmp, avl_dup_error );
1587 if (templ->query == NULL)
1588 templ->query_last = new_cached_query;
1590 templ->query->prev = new_cached_query;
1591 templ->query = new_cached_query;
1592 templ->no_of_queries++;
1594 ch_free( new_cached_query );
1595 new_cached_query = find_filter( op, qbase->scopes[query->scope],
1596 query->filter, first );
1597 filter_free( query->filter );
1598 query->filter = NULL;
1600 Debug( pcache_debug, "TEMPLATE %p QUERIES++ %d\n",
1601 (void *) templ, templ->no_of_queries, 0 );
1603 Debug( pcache_debug, "Unlock AQ index = %p \n",
1604 (void *) templ, 0, 0 );
1605 ldap_pvt_thread_rdwr_wunlock(&templ->t_rwlock);
1607 /* Adding on top of LRU list */
1609 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
1610 add_query_on_top(qm, new_cached_query);
1611 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1613 return rc == 0 ? new_cached_query : NULL;
1617 remove_from_template (CachedQuery* qc, QueryTemplate* template)
1619 if (!qc->prev && !qc->next) {
1620 template->query_last = template->query = NULL;
1621 } else if (qc->prev == NULL) {
1622 qc->next->prev = NULL;
1623 template->query = qc->next;
1624 } else if (qc->next == NULL) {
1625 qc->prev->next = NULL;
1626 template->query_last = qc->prev;
1628 qc->next->prev = qc->prev;
1629 qc->prev->next = qc->next;
1631 tavl_delete( &qc->qbase->scopes[qc->scope], qc, pcache_query_cmp );
1632 qc->qbase->queries--;
1633 if ( qc->qbase->queries == 0 ) {
1634 avl_delete( &template->qbase, qc->qbase, pcache_dn_cmp );
1635 ch_free( qc->qbase );
1639 template->no_of_queries--;
1642 /* remove bottom query of LRU list from the query cache */
1644 * NOTE: slight change in functionality.
1646 * - if result->bv_val is NULL, the query at the bottom of the LRU
1648 * - otherwise, the query whose UUID is *result is removed
1649 * - if not found, result->bv_val is zeroed
1652 cache_replacement(query_manager* qm, struct berval *result)
1654 CachedQuery* bottom;
1655 QueryTemplate *temp;
1657 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
1658 if ( BER_BVISNULL( result ) ) {
1659 bottom = qm->lru_bottom;
1662 Debug ( pcache_debug,
1663 "Cache replacement invoked without "
1664 "any query in LRU list\n", 0, 0, 0 );
1665 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1670 for ( bottom = qm->lru_bottom;
1672 bottom = bottom->lru_up )
1674 if ( bvmatch( result, &bottom->q_uuid ) ) {
1680 Debug ( pcache_debug,
1681 "Could not find query with uuid=\"%s\""
1682 "in LRU list\n", result->bv_val, 0, 0 );
1683 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1684 BER_BVZERO( result );
1689 temp = bottom->qtemp;
1690 remove_query(qm, bottom);
1691 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1693 *result = bottom->q_uuid;
1694 BER_BVZERO( &bottom->q_uuid );
1696 Debug( pcache_debug, "Lock CR index = %p\n", (void *) temp, 0, 0 );
1697 ldap_pvt_thread_rdwr_wlock(&temp->t_rwlock);
1698 remove_from_template(bottom, temp);
1699 Debug( pcache_debug, "TEMPLATE %p QUERIES-- %d\n",
1700 (void *) temp, temp->no_of_queries, 0 );
1701 Debug( pcache_debug, "Unlock CR index = %p\n", (void *) temp, 0, 0 );
1702 ldap_pvt_thread_rdwr_wunlock(&temp->t_rwlock);
1707 struct query_info *next;
1719 struct query_info *qi;
1722 if ( rs->sr_type != REP_SEARCH ) return 0;
1724 attr = attr_find( rs->sr_entry->e_attrs, ad_queryId );
1725 if ( attr == NULL ) return 0;
1727 count = attr->a_numvals;
1728 assert( count > 0 );
1729 qi = op->o_tmpalloc( sizeof( struct query_info ), op->o_tmpmemctx );
1730 qi->next = op->o_callback->sc_private;
1731 op->o_callback->sc_private = qi;
1732 ber_dupbv_x( &qi->xdn, &rs->sr_entry->e_nname, op->o_tmpmemctx );
1733 qi->del = ( count == 1 );
1742 struct berval *query_uuid )
1744 struct query_info *qi, *qnext;
1745 char filter_str[ LDAP_LUTIL_UUIDSTR_BUFSIZE + STRLENOF( "(pcacheQueryID=)" ) ];
1746 AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
1747 Filter filter = {LDAP_FILTER_EQUALITY};
1748 SlapReply sreply = {REP_RESULT};
1749 slap_callback cb = { NULL, remove_func, NULL, NULL };
1752 sreply.sr_entry = NULL;
1753 sreply.sr_nentries = 0;
1754 op->ors_filterstr.bv_len = snprintf(filter_str, sizeof(filter_str),
1755 "(%s=%s)", ad_queryId->ad_cname.bv_val, query_uuid->bv_val);
1756 filter.f_ava = &ava;
1757 filter.f_av_desc = ad_queryId;
1758 filter.f_av_value = *query_uuid;
1760 op->o_tag = LDAP_REQ_SEARCH;
1761 op->o_protocol = LDAP_VERSION3;
1762 op->o_callback = &cb;
1763 op->o_time = slap_get_time();
1764 op->o_do_not_cache = 1;
1766 op->o_req_dn = op->o_bd->be_suffix[0];
1767 op->o_req_ndn = op->o_bd->be_nsuffix[0];
1768 op->ors_scope = LDAP_SCOPE_SUBTREE;
1769 op->ors_deref = LDAP_DEREF_NEVER;
1770 op->ors_slimit = SLAP_NO_LIMIT;
1771 op->ors_tlimit = SLAP_NO_LIMIT;
1772 op->ors_limit = NULL;
1773 op->ors_filter = &filter;
1774 op->ors_filterstr.bv_val = filter_str;
1775 op->ors_filterstr.bv_len = strlen(filter_str);
1776 op->ors_attrs = NULL;
1777 op->ors_attrsonly = 0;
1779 op->o_bd->be_search( op, &sreply );
1781 for ( qi=cb.sc_private; qi; qi=qnext ) {
1784 op->o_req_dn = qi->xdn;
1785 op->o_req_ndn = qi->xdn;
1788 Debug( pcache_debug, "DELETING ENTRY TEMPLATE=%s\n",
1789 query_uuid->bv_val, 0, 0 );
1791 op->o_tag = LDAP_REQ_DELETE;
1793 if (op->o_bd->be_delete(op, &sreply) == LDAP_SUCCESS) {
1799 struct berval vals[2];
1801 vals[0] = *query_uuid;
1802 vals[1].bv_val = NULL;
1804 mod.sml_op = LDAP_MOD_DELETE;
1806 mod.sml_desc = ad_queryId;
1807 mod.sml_type = ad_queryId->ad_cname;
1808 mod.sml_values = vals;
1809 mod.sml_nvalues = NULL;
1810 mod.sml_numvals = 1;
1811 mod.sml_next = NULL;
1812 Debug( pcache_debug,
1813 "REMOVING TEMP ATTR : TEMPLATE=%s\n",
1814 query_uuid->bv_val, 0, 0 );
1816 op->orm_modlist = &mod;
1818 op->o_bd->be_modify( op, &sreply );
1820 op->o_tmpfree( qi->xdn.bv_val, op->o_tmpmemctx );
1821 op->o_tmpfree( qi, op->o_tmpmemctx );
1828 AttributeName* attrs,
1837 struct berval *fstr )
1839 AttributeDescription *ad;
1842 switch ( f->f_choice ) {
1843 case LDAP_FILTER_EQUALITY:
1845 len = STRLENOF( "(=)" ) + ad->ad_cname.bv_len;
1846 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s=)", ad->ad_cname.bv_val );
1847 assert( ret == len );
1848 fstr->bv_len += len;
1851 case LDAP_FILTER_GE:
1853 len = STRLENOF( "(>=)" ) + ad->ad_cname.bv_len;
1854 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s>=)", ad->ad_cname.bv_val);
1855 assert( ret == len );
1856 fstr->bv_len += len;
1859 case LDAP_FILTER_LE:
1861 len = STRLENOF( "(<=)" ) + ad->ad_cname.bv_len;
1862 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s<=)", ad->ad_cname.bv_val);
1863 assert( ret == len );
1864 fstr->bv_len += len;
1867 case LDAP_FILTER_APPROX:
1869 len = STRLENOF( "(~=)" ) + ad->ad_cname.bv_len;
1870 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s~=)", ad->ad_cname.bv_val);
1871 assert( ret == len );
1872 fstr->bv_len += len;
1875 case LDAP_FILTER_SUBSTRINGS:
1877 len = STRLENOF( "(=)" ) + ad->ad_cname.bv_len;
1878 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s=)", ad->ad_cname.bv_val );
1879 assert( ret == len );
1880 fstr->bv_len += len;
1883 case LDAP_FILTER_PRESENT:
1885 len = STRLENOF( "(=*)" ) + ad->ad_cname.bv_len;
1886 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s=*)", ad->ad_cname.bv_val );
1887 assert( ret == len );
1888 fstr->bv_len += len;
1891 case LDAP_FILTER_AND:
1892 case LDAP_FILTER_OR:
1893 case LDAP_FILTER_NOT: {
1895 fstr->bv_val[fstr->bv_len++] = '(';
1896 switch ( f->f_choice ) {
1897 case LDAP_FILTER_AND:
1898 fstr->bv_val[fstr->bv_len] = '&';
1900 case LDAP_FILTER_OR:
1901 fstr->bv_val[fstr->bv_len] = '|';
1903 case LDAP_FILTER_NOT:
1904 fstr->bv_val[fstr->bv_len] = '!';
1909 for ( f = f->f_list; f != NULL; f = f->f_next ) {
1910 rc = filter2template( op, f, fstr );
1913 fstr->bv_val[fstr->bv_len++] = ')';
1914 fstr->bv_val[fstr->bv_len] = '\0';
1920 /* a filter should at least have room for "()",
1921 * an "=" and for a 1-char attr */
1922 strcpy( fstr->bv_val, "(?=)" );
1923 fstr->bv_len += STRLENOF("(?=)");
1930 #define BI_HASHED 0x01
1931 #define BI_DIDCB 0x02
1932 #define BI_LOOKUP 0x04
1936 typedef struct bindinfo {
1937 cache_manager *bi_cm;
1939 QueryTemplate *bi_templ;
1940 struct search_info *bi_si;
1942 slap_callback bi_cb;
1945 struct search_info {
1948 QueryTemplate *qtemp;
1949 AttributeName* save_attrs; /* original attributes, saved for response */
1950 int swap_saved_attrs;
1955 int slimit_exceeded;
1956 pc_caching_reason_t caching_reason;
1962 remove_query_and_data(
1966 struct berval *uuid )
1968 query_manager* qm = cm->qm;
1970 qm->crfunc( qm, uuid );
1971 if ( !BER_BVISNULL( uuid ) ) {
1974 Debug( pcache_debug,
1975 "Removing query UUID %s\n",
1976 uuid->bv_val, 0, 0 );
1977 return_val = remove_query_data( op, rs, uuid );
1978 Debug( pcache_debug,
1979 "QUERY REMOVED, SIZE=%d\n",
1981 ldap_pvt_thread_mutex_lock( &cm->cache_mutex );
1982 cm->cur_entries -= return_val;
1983 cm->num_cached_queries--;
1984 Debug( pcache_debug,
1985 "STORED QUERIES = %lu\n",
1986 cm->num_cached_queries, 0, 0 );
1987 ldap_pvt_thread_mutex_unlock( &cm->cache_mutex );
1988 Debug( pcache_debug,
1989 "QUERY REMOVED, CACHE ="
1991 cm->cur_entries, 0, 0 );
1996 * Callback used to fetch queryId values based on entryUUID;
1997 * used by pcache_remove_entries_from_cache()
2000 fetch_queryId_cb( Operation *op, SlapReply *rs )
2004 /* only care about searchEntry responses */
2005 if ( rs->sr_type != REP_SEARCH ) {
2009 /* allow only one response per entryUUID */
2010 if ( op->o_callback->sc_private != NULL ) {
2016 /* copy all queryId values into callback's private data */
2017 a = attr_find( rs->sr_entry->e_attrs, ad_queryId );
2019 BerVarray vals = NULL;
2021 ber_bvarray_dup_x( &vals, a->a_nvals, op->o_tmpmemctx );
2022 op->o_callback->sc_private = (void *)vals;
2026 /* clear entry if required */
2027 if ( rs->sr_flags & REP_ENTRY_MUSTBEFREED ) {
2028 entry_free( rs->sr_entry );
2029 rs->sr_entry = NULL;
2030 rs->sr_flags ^= REP_ENTRY_MUSTBEFREED;
2037 * Call that allows to remove a set of entries from the cache,
2038 * by forcing the removal of all the related queries.
2041 pcache_remove_entries_from_cache(
2044 BerVarray entryUUIDs )
2046 Connection conn = { 0 };
2047 OperationBuffer opbuf;
2049 slap_callback sc = { 0 };
2050 SlapReply rs = { REP_RESULT };
2052 char filtbuf[ LDAP_LUTIL_UUIDSTR_BUFSIZE + STRLENOF( "(entryUUID=)" ) ];
2053 AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
2054 AttributeName attrs[ 2 ] = {{{ 0 }}};
2058 void *thrctx = ldap_pvt_thread_pool_context();
2060 connection_fake_init( &conn, &opbuf, thrctx );
2068 memset( &op->oq_search, 0, sizeof( op->oq_search ) );
2069 op->ors_scope = LDAP_SCOPE_SUBTREE;
2070 op->ors_deref = LDAP_DEREF_NEVER;
2071 f.f_choice = LDAP_FILTER_EQUALITY;
2073 ava.aa_desc = slap_schema.si_ad_entryUUID;
2074 op->ors_filter = &f;
2076 op->ors_tlimit = SLAP_NO_LIMIT;
2077 op->ors_limit = NULL;
2078 attrs[ 0 ].an_desc = ad_queryId;
2079 attrs[ 0 ].an_name = ad_queryId->ad_cname;
2080 op->ors_attrs = attrs;
2081 op->ors_attrsonly = 0;
2083 op->o_req_dn = cm->db.be_suffix[ 0 ];
2084 op->o_req_ndn = cm->db.be_nsuffix[ 0 ];
2086 op->o_tag = LDAP_REQ_SEARCH;
2087 op->o_protocol = LDAP_VERSION3;
2088 op->o_managedsait = SLAP_CONTROL_CRITICAL;
2090 op->o_dn = op->o_bd->be_rootdn;
2091 op->o_ndn = op->o_bd->be_rootndn;
2092 sc.sc_response = fetch_queryId_cb;
2093 op->o_callback = ≻
2095 for ( s = 0; !BER_BVISNULL( &entryUUIDs[ s ] ); s++ ) {
2096 BerVarray vals = NULL;
2098 op->ors_filterstr.bv_len = snprintf( filtbuf, sizeof( filtbuf ),
2099 "(entryUUID=%s)", entryUUIDs[ s ].bv_val );
2100 op->ors_filterstr.bv_val = filtbuf;
2101 ava.aa_value = entryUUIDs[ s ];
2103 rc = op->o_bd->be_search( op, &rs );
2104 if ( rc != LDAP_SUCCESS ) {
2108 vals = (BerVarray)op->o_callback->sc_private;
2109 if ( vals != NULL ) {
2112 for ( i = 0; !BER_BVISNULL( &vals[ i ] ); i++ ) {
2113 struct berval val = vals[ i ];
2115 remove_query_and_data( op, &rs, cm, &val );
2117 if ( !BER_BVISNULL( &val ) && val.bv_val != vals[ i ].bv_val ) {
2118 ch_free( val.bv_val );
2122 ber_bvarray_free_x( vals, op->o_tmpmemctx );
2123 op->o_callback->sc_private = NULL;
2131 * Call that allows to remove a query from the cache.
2134 pcache_remove_query_from_cache(
2137 struct berval *queryid )
2139 Operation op2 = *op;
2140 SlapReply rs2 = { 0 };
2144 /* remove the selected query */
2145 remove_query_and_data( &op2, &rs2, cm, queryid );
2147 return LDAP_SUCCESS;
2151 * Call that allows to remove a set of queries related to an entry
2152 * from the cache; if queryid is not null, the entry must belong to
2153 * the query indicated by queryid.
2156 pcache_remove_entry_queries_from_cache(
2160 struct berval *queryid )
2162 Connection conn = { 0 };
2163 OperationBuffer opbuf;
2165 slap_callback sc = { 0 };
2166 SlapReply rs = { REP_RESULT };
2168 char filter_str[ LDAP_LUTIL_UUIDSTR_BUFSIZE + STRLENOF( "(pcacheQueryID=)" ) ];
2169 AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
2170 AttributeName attrs[ 2 ] = {{{ 0 }}};
2173 BerVarray vals = NULL;
2176 void *thrctx = ldap_pvt_thread_pool_context();
2178 connection_fake_init( &conn, &opbuf, thrctx );
2186 memset( &op->oq_search, 0, sizeof( op->oq_search ) );
2187 op->ors_scope = LDAP_SCOPE_BASE;
2188 op->ors_deref = LDAP_DEREF_NEVER;
2189 if ( queryid == NULL || BER_BVISNULL( queryid ) ) {
2190 BER_BVSTR( &op->ors_filterstr, "(objectClass=*)" );
2191 f.f_choice = LDAP_FILTER_PRESENT;
2192 f.f_desc = slap_schema.si_ad_objectClass;
2195 op->ors_filterstr.bv_len = snprintf( filter_str,
2196 sizeof( filter_str ), "(%s=%s)",
2197 ad_queryId->ad_cname.bv_val, queryid->bv_val );
2198 f.f_choice = LDAP_FILTER_EQUALITY;
2200 f.f_av_desc = ad_queryId;
2201 f.f_av_value = *queryid;
2203 op->ors_filter = &f;
2205 op->ors_tlimit = SLAP_NO_LIMIT;
2206 op->ors_limit = NULL;
2207 attrs[ 0 ].an_desc = ad_queryId;
2208 attrs[ 0 ].an_name = ad_queryId->ad_cname;
2209 op->ors_attrs = attrs;
2210 op->ors_attrsonly = 0;
2212 op->o_req_dn = *ndn;
2213 op->o_req_ndn = *ndn;
2215 op->o_tag = LDAP_REQ_SEARCH;
2216 op->o_protocol = LDAP_VERSION3;
2217 op->o_managedsait = SLAP_CONTROL_CRITICAL;
2219 op->o_dn = op->o_bd->be_rootdn;
2220 op->o_ndn = op->o_bd->be_rootndn;
2221 sc.sc_response = fetch_queryId_cb;
2222 op->o_callback = ≻
2224 rc = op->o_bd->be_search( op, &rs );
2225 if ( rc != LDAP_SUCCESS ) {
2229 vals = (BerVarray)op->o_callback->sc_private;
2230 if ( vals != NULL ) {
2233 for ( i = 0; !BER_BVISNULL( &vals[ i ] ); i++ ) {
2234 struct berval val = vals[ i ];
2236 remove_query_and_data( op, &rs, cm, &val );
2238 if ( !BER_BVISNULL( &val ) && val.bv_val != vals[ i ].bv_val ) {
2239 ch_free( val.bv_val );
2243 ber_bvarray_free_x( vals, op->o_tmpmemctx );
2246 return LDAP_SUCCESS;
2253 struct berval *query_uuid )
2255 struct search_info *si = op->o_callback->sc_private;
2256 slap_overinst *on = si->on;
2257 cache_manager *cm = on->on_bi.bi_private;
2260 struct berval crp_uuid;
2261 char uuidbuf[ LDAP_LUTIL_UUIDSTR_BUFSIZE ];
2263 Connection conn = {0};
2264 OperationBuffer opbuf;
2265 void *thrctx = ldap_pvt_thread_pool_context();
2267 query_uuid->bv_len = lutil_uuidstr(uuidbuf, sizeof(uuidbuf));
2268 ber_str2bv(uuidbuf, query_uuid->bv_len, 1, query_uuid);
2270 connection_fake_init2( &conn, &opbuf, thrctx, 0 );
2271 op_tmp = &opbuf.ob_op;
2272 op_tmp->o_bd = &cm->db;
2273 op_tmp->o_dn = cm->db.be_rootdn;
2274 op_tmp->o_ndn = cm->db.be_rootndn;
2276 Debug( pcache_debug, "UUID for query being added = %s\n",
2279 for ( e=si->head; e; e=si->head ) {
2280 si->head = e->e_private;
2281 e->e_private = NULL;
2282 while ( cm->cur_entries > (cm->max_entries) ) {
2283 BER_BVZERO( &crp_uuid );
2284 remove_query_and_data( op_tmp, rs, cm, &crp_uuid );
2287 return_val = merge_entry(op_tmp, e, query_uuid);
2288 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
2289 cm->cur_entries += return_val;
2290 Debug( pcache_debug,
2291 "ENTRY ADDED/MERGED, CACHED ENTRIES=%d\n",
2292 cm->cur_entries, 0, 0 );
2294 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
2301 pcache_op_cleanup( Operation *op, SlapReply *rs ) {
2302 slap_callback *cb = op->o_callback;
2303 struct search_info *si = cb->sc_private;
2304 slap_overinst *on = si->on;
2305 cache_manager *cm = on->on_bi.bi_private;
2306 query_manager* qm = cm->qm;
2308 if ( rs->sr_type == REP_SEARCH ) {
2311 /* don't return more entries than requested by the client */
2312 if ( si->slimit > 0 && rs->sr_nentries >= si->slimit ) {
2313 si->slimit_exceeded = 1;
2316 /* If we haven't exceeded the limit for this query,
2317 * build a chain of answers to store. If we hit the
2318 * limit, empty the chain and ignore the rest.
2321 /* check if the entry contains undefined
2322 * attributes/objectClasses (ITS#5680) */
2323 if ( cm->check_cacheability && test_filter( op, rs->sr_entry, si->query.filter ) != LDAP_COMPARE_TRUE ) {
2324 Debug( pcache_debug, "%s: query not cacheable because of schema issues in DN \"%s\"\n",
2325 op->o_log_prefix, rs->sr_entry->e_name.bv_val, 0 );
2329 /* check for malformed entries: attrs with no values */
2331 Attribute *a = rs->sr_entry->e_attrs;
2332 for (; a; a=a->a_next) {
2333 if ( !a->a_numvals ) {
2334 Debug( pcache_debug, "%s: query not cacheable because of attrs without values in DN \"%s\" (%s)\n",
2335 op->o_log_prefix, rs->sr_entry->e_name.bv_val,
2336 a->a_desc->ad_cname.bv_val );
2342 if ( si->count < si->max ) {
2344 e = entry_dup( rs->sr_entry );
2345 if ( !si->head ) si->head = e;
2346 if ( si->tail ) si->tail->e_private = e;
2353 for (;si->head; si->head=e) {
2354 e = si->head->e_private;
2355 si->head->e_private = NULL;
2356 entry_free(si->head);
2364 if ( rs->sr_type == REP_RESULT ||
2365 op->o_abandon || rs->sr_err == SLAPD_ABANDON )
2367 if ( si->swap_saved_attrs ) {
2368 rs->sr_attrs = si->save_attrs;
2369 op->ors_attrs = si->save_attrs;
2371 if ( (op->o_abandon || rs->sr_err == SLAPD_ABANDON) &&
2372 si->caching_reason == PC_IGNORE )
2374 filter_free( si->query.filter );
2376 /* duplicate query, free it */
2378 for (;si->head; si->head=e) {
2379 e = si->head->e_private;
2380 si->head->e_private = NULL;
2381 entry_free(si->head);
2384 op->o_callback = op->o_callback->sc_next;
2385 op->o_tmpfree( cb, op->o_tmpmemctx );
2386 } else if ( si->caching_reason != PC_IGNORE ) {
2387 CachedQuery *qc = qm->addfunc(op, qm, &si->query,
2388 si->qtemp, si->caching_reason, 1 );
2391 switch ( si->caching_reason ) {
2393 cache_entries( op, rs, &qc->q_uuid );
2395 si->pbi->bi_cq = qc;
2399 qc->q_sizelimit = rs->sr_nentries;
2409 ldap_pvt_thread_rdwr_wunlock(&qc->rwlock);
2410 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
2411 cm->num_cached_queries++;
2412 Debug( pcache_debug, "STORED QUERIES = %lu\n",
2413 cm->num_cached_queries, 0, 0 );
2414 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
2416 /* If the consistency checker suspended itself,
2419 if ( cm->cc_paused == PCACHE_CC_PAUSED ) {
2420 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
2421 if ( cm->cc_paused == PCACHE_CC_PAUSED ) {
2423 ldap_pvt_runqueue_resched( &slapd_rq, cm->cc_arg, 0 );
2425 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
2428 } else if ( si->count ) {
2429 /* duplicate query, free it */
2431 for (;si->head; si->head=e) {
2432 e = si->head->e_private;
2433 si->head->e_private = NULL;
2434 entry_free(si->head);
2439 filter_free( si->query.filter );
2443 return SLAP_CB_CONTINUE;
2451 struct search_info *si = op->o_callback->sc_private;
2453 if ( si->swap_saved_attrs ) {
2454 rs->sr_attrs = si->save_attrs;
2455 op->ors_attrs = si->save_attrs;
2458 if ( rs->sr_type == REP_SEARCH ) {
2459 /* don't return more entries than requested by the client */
2460 if ( si->slimit_exceeded ) {
2464 } else if ( rs->sr_type == REP_RESULT ) {
2467 if ( rs->sr_err == LDAP_SUCCESS ) {
2468 si->caching_reason = PC_POSITIVE;
2470 } else if ( rs->sr_err == LDAP_SIZELIMIT_EXCEEDED
2471 && si->qtemp->limitttl )
2473 si->caching_reason = PC_SIZELIMIT;
2476 } else if ( si->qtemp->negttl && !si->count && !si->over &&
2477 rs->sr_err == LDAP_SUCCESS )
2479 si->caching_reason = PC_NEGATIVE;
2483 if ( si->slimit_exceeded ) {
2484 rs->sr_err = LDAP_SIZELIMIT_EXCEEDED;
2488 return SLAP_CB_CONTINUE;
2491 /* NOTE: this is a quick workaround to let pcache minimally interact
2492 * with pagedResults. A more articulated solutions would be to
2493 * perform the remote query without control and cache all results,
2494 * performing the pagedResults search only within the client
2495 * and the proxy. This requires pcache to understand pagedResults. */
2497 pcache_chk_controls(
2501 const char *non = "";
2502 const char *stripped = "";
2504 switch( op->o_pagedresults ) {
2505 case SLAP_CONTROL_NONCRITICAL:
2507 stripped = "; stripped";
2510 case SLAP_CONTROL_CRITICAL:
2511 Debug( pcache_debug, "%s: "
2512 "%scritical pagedResults control "
2513 "disabled with proxy cache%s.\n",
2514 op->o_log_prefix, non, stripped );
2516 slap_remove_control( op, rs, slap_cids.sc_pagedResults, NULL );
2520 rs->sr_err = SLAP_CB_CONTINUE;
2528 pc_setpw( Operation *op, struct berval *pwd, cache_manager *cm )
2530 struct berval vals[2];
2533 const char *text = NULL;
2534 BER_BVZERO( &vals[0] );
2535 slap_passwd_hash( pwd, &vals[0], &text );
2536 if ( BER_BVISEMPTY( &vals[0] )) {
2537 Debug( pcache_debug, "pc_setpw: hash failed %s\n",
2543 BER_BVZERO( &vals[1] );
2547 SlapReply sr = { REP_RESULT };
2548 slap_callback cb = { 0, slap_null_cb, 0, 0 };
2551 mod.sml_op = LDAP_MOD_REPLACE;
2553 mod.sml_desc = slap_schema.si_ad_userPassword;
2554 mod.sml_type = mod.sml_desc->ad_cname;
2555 mod.sml_values = vals;
2556 mod.sml_nvalues = NULL;
2557 mod.sml_numvals = 1;
2558 mod.sml_next = NULL;
2560 op->o_tag = LDAP_REQ_MODIFY;
2561 op->orm_modlist = &mod;
2563 op->o_dn = op->o_bd->be_rootdn;
2564 op->o_ndn = op->o_bd->be_rootndn;
2565 op->o_callback = &cb;
2566 Debug( pcache_debug, "pc_setpw: CACHING BIND for %s\n",
2567 op->o_req_dn.bv_val, 0, 0 );
2568 rc = op->o_bd->be_modify( op, &sr );
2569 ch_free( vals[0].bv_val );
2574 typedef struct bindcacheinfo {
2580 pc_bind_save( Operation *op, SlapReply *rs )
2582 if ( rs->sr_err == LDAP_SUCCESS ) {
2583 bindcacheinfo *bci = op->o_callback->sc_private;
2584 slap_overinst *on = bci->on;
2585 cache_manager *cm = on->on_bi.bi_private;
2587 Operation op2 = *op;
2588 if ( pc_setpw( &op2, &op->orb_cred, cm ) == LDAP_SUCCESS )
2589 bci->qc->bindref_time = op->o_time + bci->qc->qtemp->bindttr;
2591 return SLAP_CB_CONTINUE;
2595 pc_bind_attrs( Operation *op, Entry *e, QueryTemplate *temp,
2596 struct berval *fbv )
2599 struct berval *vals, pres = BER_BVC("*");
2603 vals = op->o_tmpalloc( temp->bindnattrs * sizeof( struct berval ),
2606 for ( i=0; i<temp->bindnattrs; i++ ) {
2607 a = attr_find( e->e_attrs, temp->bindfattrs[i] );
2608 if ( a && a->a_vals ) {
2609 vals[i] = a->a_vals[0];
2610 len += a->a_vals[0].bv_len;
2615 fbv->bv_len = len + temp->bindftemp.bv_len;
2616 fbv->bv_val = op->o_tmpalloc( fbv->bv_len + 1, op->o_tmpmemctx );
2618 p1 = temp->bindftemp.bv_val;
2623 if ( p1[0] == '=' && p1[1] == ')' ) {
2624 AC_MEMCPY( p2, vals[i].bv_val, vals[i].bv_len );
2625 p2 += vals[i].bv_len;
2631 op->o_tmpfree( vals, op->o_tmpmemctx );
2632 return str2filter_x( op, fbv->bv_val );
2635 /* Check if the requested entry is from the cache and has a valid
2636 * ttr and password hash
2639 pc_bind_search( Operation *op, SlapReply *rs )
2641 if ( rs->sr_type == REP_SEARCH ) {
2642 bindinfo *pbi = op->o_callback->sc_private;
2644 /* We only care if this is an already cached result and we're
2645 * below the refresh time, or we're offline.
2648 if (( pbi->bi_cm->cc_paused & PCACHE_CC_OFFLINE ) ||
2649 op->o_time < pbi->bi_cq->bindref_time ) {
2652 /* See if a recognized password is hashed here */
2653 a = attr_find( rs->sr_entry->e_attrs,
2654 slap_schema.si_ad_userPassword );
2655 if ( a && a->a_vals[0].bv_val[0] == '{' &&
2656 lutil_passwd_scheme( a->a_vals[0].bv_val ))
2657 pbi->bi_flags |= BI_HASHED;
2659 Debug( pcache_debug, "pc_bind_search: cache is stale, "
2660 "reftime: %ld, current time: %ld\n",
2661 pbi->bi_cq->bindref_time, op->o_time, 0 );
2663 } else if ( pbi->bi_si ) {
2664 /* This search result is going into the cache */
2668 filter_free( pbi->bi_si->query.filter );
2669 f = pc_bind_attrs( op, rs->sr_entry, pbi->bi_templ, &fbv );
2670 op->o_tmpfree( fbv.bv_val, op->o_tmpmemctx );
2671 pbi->bi_si->query.filter = filter_dup( f, NULL );
2672 filter_free_x( op, f, 1 );
2678 /* We always want pc_bind_search to run after the search handlers */
2680 pc_bind_resp( Operation *op, SlapReply *rs )
2682 bindinfo *pbi = op->o_callback->sc_private;
2683 if ( !( pbi->bi_flags & BI_DIDCB )) {
2684 slap_callback *sc = op->o_callback;
2685 while ( sc && sc->sc_response != pcache_response )
2688 sc = op->o_callback;
2689 pbi->bi_cb.sc_next = sc->sc_next;
2690 sc->sc_next = &pbi->bi_cb;
2691 pbi->bi_flags |= BI_DIDCB;
2693 return SLAP_CB_CONTINUE;
2696 #ifdef PCACHE_CONTROL_PRIVDB
2702 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
2703 cache_manager *cm = on->on_bi.bi_private;
2704 slap_callback *save_cb;
2707 /* skip if control is unset */
2708 if ( op->o_ctrlflag[ privDB_cid ] != SLAP_CONTROL_CRITICAL ) {
2709 return SLAP_CB_CONTINUE;
2712 /* The cache DB isn't open yet */
2713 if ( cm->defer_db_open ) {
2714 send_ldap_error( op, rs, LDAP_UNAVAILABLE,
2715 "pcachePrivDB: cacheDB not available" );
2719 /* FIXME: might be a little bit exaggerated... */
2720 if ( !be_isroot( op ) ) {
2721 save_cb = op->o_callback;
2722 op->o_callback = NULL;
2723 send_ldap_error( op, rs, LDAP_UNWILLING_TO_PERFORM,
2724 "pcachePrivDB: operation not allowed" );
2725 op->o_callback = save_cb;
2730 /* map tag to operation */
2731 type = slap_req2op( op->o_tag );
2732 if ( type != SLAP_OP_LAST ) {
2736 /* execute, if possible */
2737 func = &cm->db.be_bind;
2738 if ( func[ type ] != NULL ) {
2739 Operation op2 = *op;
2743 rc = func[ type ]( &op2, rs );
2744 if ( type == SLAP_OP_BIND && rc == LDAP_SUCCESS ) {
2745 op->o_conn->c_authz_cookie = cm->db.be_private;
2752 /* otherwise fall back to error */
2753 save_cb = op->o_callback;
2754 op->o_callback = NULL;
2755 send_ldap_error( op, rs, LDAP_UNWILLING_TO_PERFORM,
2756 "operation not supported with pcachePrivDB control" );
2757 op->o_callback = save_cb;
2761 #endif /* PCACHE_CONTROL_PRIVDB */
2768 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
2769 cache_manager *cm = on->on_bi.bi_private;
2770 QueryTemplate *temp;
2772 slap_callback cb = { 0 }, *sc;
2778 #ifdef PCACHE_CONTROL_PRIVDB
2779 if ( op->o_ctrlflag[ privDB_cid ] == SLAP_CONTROL_CRITICAL )
2780 return pcache_op_privdb( op, rs );
2781 #endif /* PCACHE_CONTROL_PRIVDB */
2783 /* Skip if we're not configured for Binds, or cache DB isn't open yet */
2784 if ( !cm->cache_binds || cm->defer_db_open )
2785 return SLAP_CB_CONTINUE;
2787 /* First find a matching template with Bind info */
2788 for ( temp=cm->qm->templates; temp; temp=temp->qmnext ) {
2789 if ( temp->bindttr && dnIsSuffix( &op->o_req_ndn, &temp->bindbase ))
2792 /* Didn't find a suitable template, just passthru */
2794 return SLAP_CB_CONTINUE;
2796 /* See if the entry is already locally cached. If so, we can
2797 * populate the query filter to retrieve the cached query. We
2798 * need to check the bindrefresh time in the query.
2801 op2.o_dn = op->o_bd->be_rootdn;
2802 op2.o_ndn = op->o_bd->be_rootndn;
2807 rc = be_entry_get_rw( &op2, &op->o_req_ndn, NULL, NULL, 0, &e );
2808 if ( rc == LDAP_SUCCESS && e ) {
2809 bi.bi_flags |= BI_LOOKUP;
2810 op2.ors_filter = pc_bind_attrs( op, e, temp, &op2.ors_filterstr );
2811 be_entry_release_r( &op2, e );
2813 op2.ors_filter = temp->bindfilter;
2814 op2.ors_filterstr = temp->bindfilterstr;
2817 op2.o_bd = op->o_bd;
2818 op2.o_tag = LDAP_REQ_SEARCH;
2819 op2.ors_scope = LDAP_SCOPE_BASE;
2820 op2.ors_deref = LDAP_DEREF_NEVER;
2822 op2.ors_tlimit = SLAP_NO_LIMIT;
2823 op2.ors_limit = NULL;
2824 op2.ors_attrs = cm->qm->attr_sets[temp->attr_set_index].attrs;
2825 op2.ors_attrsonly = 0;
2827 /* We want to invoke search at the same level of the stack
2828 * as we're already at...
2835 bi.bi_cb.sc_response = pc_bind_search;
2836 bi.bi_cb.sc_cleanup = NULL;
2837 bi.bi_cb.sc_private = &bi;
2838 cb.sc_private = &bi;
2839 cb.sc_response = pc_bind_resp;
2840 op2.o_callback = &cb;
2841 overlay_op_walk( &op2, rs, op_search, on->on_info, on );
2843 /* OK, just bind locally */
2844 if ( bi.bi_flags & BI_HASHED ) {
2845 BackendDB *be = op->o_bd;
2848 Debug( pcache_debug, "pcache_op_bind: CACHED BIND for %s\n",
2849 op->o_req_dn.bv_val, 0, 0 );
2851 if ( op->o_bd->be_bind( op, rs ) == LDAP_SUCCESS ) {
2852 op->o_conn->c_authz_cookie = cm->db.be_private;
2858 /* We have a cached query to work with */
2860 sc = op->o_tmpalloc( sizeof(slap_callback) + sizeof(bindcacheinfo),
2862 sc->sc_response = pc_bind_save;
2863 sc->sc_cleanup = NULL;
2864 sc->sc_private = sc+1;
2865 bci = sc->sc_private;
2866 sc->sc_next = op->o_callback;
2867 op->o_callback = sc;
2871 return SLAP_CB_CONTINUE;
2879 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
2880 cache_manager *cm = on->on_bi.bi_private;
2881 query_manager* qm = cm->qm;
2886 QueryTemplate *qtemp = NULL;
2887 bindinfo *pbi = NULL;
2890 CachedQuery *answerable = NULL;
2893 struct berval tempstr;
2895 #ifdef PCACHE_CONTROL_PRIVDB
2896 if ( op->o_ctrlflag[ privDB_cid ] == SLAP_CONTROL_CRITICAL ) {
2897 return pcache_op_privdb( op, rs );
2899 #endif /* PCACHE_CONTROL_PRIVDB */
2901 /* The cache DB isn't open yet */
2902 if ( cm->defer_db_open ) {
2903 send_ldap_error( op, rs, LDAP_UNAVAILABLE,
2904 "pcachePrivDB: cacheDB not available" );
2908 /* pickup runtime ACL changes */
2909 cm->db.be_acl = op->o_bd->be_acl;
2912 /* See if we're processing a Bind request */
2913 slap_callback *cb = op->o_callback;
2915 for ( ; cb; cb=cb->sc_next ) {
2916 if ( cb->sc_response == pc_bind_resp ) {
2917 pbi = cb->sc_private;
2923 /* FIXME: cannot cache/answer requests with pagedResults control */
2925 query.filter = op->ors_filter;
2928 query.base = pbi->bi_templ->bindbase;
2929 query.scope = pbi->bi_templ->bindscope;
2930 attr_set = pbi->bi_templ->attr_set_index;
2932 qtemp = pbi->bi_templ;
2933 if ( pbi->bi_flags & BI_LOOKUP )
2934 answerable = qm->qcfunc(op, qm, &query, qtemp);
2937 tempstr.bv_val = op->o_tmpalloc( op->ors_filterstr.bv_len+1,
2940 if ( filter2template( op, op->ors_filter, &tempstr ))
2942 op->o_tmpfree( tempstr.bv_val, op->o_tmpmemctx );
2943 return SLAP_CB_CONTINUE;
2946 Debug( pcache_debug, "query template of incoming query = %s\n",
2947 tempstr.bv_val, 0, 0 );
2950 attr_set = get_attr_set(op->ors_attrs, qm, cm->numattrsets);
2952 query.base = op->o_req_ndn;
2953 query.scope = op->ors_scope;
2955 /* check for query containment */
2956 if (attr_set > -1) {
2957 QueryTemplate *qt = qm->attr_sets[attr_set].templates;
2958 for (; qt; qt = qt->qtnext ) {
2959 /* find if template i can potentially answer tempstr */
2960 if ( ber_bvstrcasecmp( &qt->querystr, &tempstr ) != 0 )
2964 Debug( pcache_debug, "Entering QC, querystr = %s\n",
2965 op->ors_filterstr.bv_val, 0, 0 );
2966 answerable = qm->qcfunc(op, qm, &query, qt);
2968 /* if != NULL, rlocks qtemp->t_rwlock */
2973 op->o_tmpfree( tempstr.bv_val, op->o_tmpmemctx );
2977 BackendDB *save_bd = op->o_bd;
2979 ldap_pvt_thread_mutex_lock( &answerable->answerable_cnt_mutex );
2980 answerable->answerable_cnt++;
2981 /* we only care about refcnts if we're refreshing */
2982 if ( answerable->refresh_time )
2983 answerable->refcnt++;
2984 Debug( pcache_debug, "QUERY ANSWERABLE (answered %lu times)\n",
2985 answerable->answerable_cnt, 0, 0 );
2986 ldap_pvt_thread_mutex_unlock( &answerable->answerable_cnt_mutex );
2988 ldap_pvt_thread_rdwr_rlock(&answerable->rwlock);
2989 if ( BER_BVISNULL( &answerable->q_uuid )) {
2990 /* No entries cached, just an empty result set */
2992 send_ldap_result( op, rs );
2994 /* Let Bind know we used a cached query */
2996 pbi->bi_cq = answerable;
3000 if ( cm->response_cb == PCACHE_RESPONSE_CB_TAIL ) {
3001 /* The cached entry was already processed by any
3002 * other overlays, so don't let it get processed again.
3004 op->o_callback = NULL;
3007 i = cm->db.bd_info->bi_op_search( op, rs );
3009 ldap_pvt_thread_rdwr_runlock(&answerable->rwlock);
3010 /* locked by qtemp->qcfunc (query_containment) */
3011 ldap_pvt_thread_rdwr_runlock(&qtemp->t_rwlock);
3016 Debug( pcache_debug, "QUERY NOT ANSWERABLE\n", 0, 0, 0 );
3018 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
3019 if (cm->num_cached_queries >= cm->max_queries) {
3022 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
3024 if (op->ors_attrsonly)
3029 struct search_info *si;
3031 Debug( pcache_debug, "QUERY CACHEABLE\n", 0, 0, 0 );
3032 query.filter = filter_dup(op->ors_filter, NULL);
3034 cb = op->o_tmpalloc( sizeof(*cb) + sizeof(*si), op->o_tmpmemctx );
3035 cb->sc_response = pcache_response;
3036 cb->sc_cleanup = pcache_op_cleanup;
3037 cb->sc_private = (cb+1);
3038 si = cb->sc_private;
3042 si->max = cm->num_entries_limit ;
3046 si->slimit_exceeded = 0;
3047 si->caching_reason = PC_IGNORE;
3048 if ( op->ors_slimit > 0 && op->ors_slimit < cm->num_entries_limit ) {
3049 si->slimit = op->ors_slimit;
3050 op->ors_slimit = cm->num_entries_limit;
3054 si->swap_saved_attrs = 1;
3055 si->save_attrs = op->ors_attrs;
3060 op->ors_attrs = qtemp->t_attrs.attrs;
3062 if ( cm->response_cb == PCACHE_RESPONSE_CB_HEAD ) {
3063 cb->sc_next = op->o_callback;
3064 op->o_callback = cb;
3067 slap_callback **pcb;
3069 /* need to move the callback at the end, in case other
3070 * overlays are present, so that the final entry is
3071 * actually cached */
3073 for ( pcb = &op->o_callback; *pcb; pcb = &(*pcb)->sc_next );
3078 Debug( pcache_debug, "QUERY NOT CACHEABLE\n",
3082 return SLAP_CB_CONTINUE;
3087 AttributeName* attrs,
3095 for ( ; attrs[count].an_name.bv_val; count++ );
3098 /* recognize a single "*" or a "1.1" */
3101 attrs = slap_anlist_all_user_attributes;
3103 } else if ( count == 1 && bvmatch( &attrs[0].an_name, slap_bv_no_attrs ) ) {
3108 for ( i = 0; i < num; i++ ) {
3112 if ( count > qm->attr_sets[i].count ) {
3117 if ( !qm->attr_sets[i].count ) {
3123 for ( a2 = attrs; a2->an_name.bv_val; a2++ ) {
3124 if ( !an_find( qm->attr_sets[i].attrs, &a2->an_name ) ) {
3142 /* Refresh a cached query:
3143 * 1: Replay the query on the remote DB and merge each entry into
3144 * the local DB. Remember the DNs of each remote entry.
3145 * 2: Search the local DB for all entries matching this queryID.
3146 * Delete any entry whose DN is not in the list from (1).
3148 typedef struct dnlist {
3149 struct dnlist *next;
3154 typedef struct refresh_info {
3162 static dnlist *dnl_alloc( Operation *op, struct berval *bvdn )
3164 dnlist *dn = op->o_tmpalloc( sizeof(dnlist) + bvdn->bv_len + 1,
3166 dn->dn.bv_len = bvdn->bv_len;
3167 dn->dn.bv_val = (char *)(dn+1);
3168 AC_MEMCPY( dn->dn.bv_val, bvdn->bv_val, dn->dn.bv_len );
3169 dn->dn.bv_val[dn->dn.bv_len] = '\0';
3174 refresh_merge( Operation *op, SlapReply *rs )
3176 if ( rs->sr_type == REP_SEARCH ) {
3177 refresh_info *ri = op->o_callback->sc_private;
3178 BackendDB *be = op->o_bd;
3184 ocb = op->o_callback;
3185 /* Find local entry, merge */
3186 op->o_bd = ri->ri_be;
3187 rc = be_entry_get_rw( op, &rs->sr_entry->e_nname, NULL, NULL, 0, &e );
3188 if ( rc != LDAP_SUCCESS || e == NULL ) {
3189 /* No local entry, just add it. FIXME: we are not checking
3190 * the cache entry limit here
3192 merge_entry( op, rs->sr_entry, &ri->ri_q->q_uuid );
3194 /* Entry exists, update it */
3197 Modifications *modlist, *mods = NULL;
3198 const char* text = NULL;
3199 char textbuf[SLAP_TEXT_BUFLEN];
3200 size_t textlen = sizeof(textbuf);
3201 slap_callback cb = { NULL, slap_null_cb, NULL, NULL };
3205 /* Get a copy of only the attrs we requested */
3206 for ( a=e->e_attrs; a; a=a->a_next ) {
3207 if ( ad_inlist( a->a_desc, rs->sr_attrs )) {
3208 *b = attr_alloc( a->a_desc );
3210 /* The actual values still belong to e */
3211 (*b)->a_flags |= SLAP_ATTR_DONT_FREE_VALS |
3212 SLAP_ATTR_DONT_FREE_DATA;
3213 b = &((*b)->a_next);
3217 slap_entry2mods( rs->sr_entry, &modlist, &text, textbuf, textlen );
3218 syncrepl_diff_entry( op, ne.e_attrs, rs->sr_entry->e_attrs,
3219 &mods, &modlist, 0 );
3220 be_entry_release_r( op, e );
3221 attrs_free( ne.e_attrs );
3222 slap_mods_free( modlist, 1 );
3223 /* mods is NULL if there are no changes */
3225 struct berval dn = op->o_req_dn;
3226 struct berval ndn = op->o_req_ndn;
3227 op->o_tag = LDAP_REQ_MODIFY;
3228 op->orm_modlist = mods;
3229 op->o_req_dn = rs->sr_entry->e_name;
3230 op->o_req_ndn = rs->sr_entry->e_nname;
3231 op->o_callback = &cb;
3232 op->o_bd->be_modify( op, rs );
3233 slap_mods_free( mods, 1 );
3235 op->o_req_ndn = ndn;
3239 /* Add DN to list */
3240 dnl = dnl_alloc( op, &rs->sr_entry->e_nname );
3242 if ( ri->ri_tail ) {
3243 ri->ri_tail->next = dnl;
3248 op->o_callback = ocb;
3254 refresh_purge( Operation *op, SlapReply *rs )
3256 if ( rs->sr_type == REP_SEARCH ) {
3257 refresh_info *ri = op->o_callback->sc_private;
3261 /* Did the entry exist on the remote? */
3262 for ( dn=&ri->ri_dns; *dn; dn = &(*dn)->next ) {
3263 if ( dn_match( &(*dn)->dn, &rs->sr_entry->e_nname )) {
3264 dnlist *dnext = (*dn)->next;
3265 op->o_tmpfree( *dn, op->o_tmpmemctx );
3271 /* No, so put it on the list to delete */
3274 dnlist *dnl = dnl_alloc( op, &rs->sr_entry->e_nname );
3275 dnl->next = ri->ri_dels;
3277 a = attr_find( rs->sr_entry->e_attrs, ad_queryId );
3278 /* If ours is the only queryId, delete entry */
3279 dnl->delete = ( a->a_numvals == 1 );
3286 refresh_query( Operation *op, SlapReply *rs, CachedQuery *query,
3289 slap_callback cb = { 0 };
3290 refresh_info ri = { 0 };
3291 char filter_str[ LDAP_LUTIL_UUIDSTR_BUFSIZE + STRLENOF( "(pcacheQueryID=)" ) ];
3292 AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
3293 Filter filter = {LDAP_FILTER_EQUALITY};
3294 AttributeName attrs[ 2 ] = {{{ 0 }}};
3298 ldap_pvt_thread_mutex_lock( &query->answerable_cnt_mutex );
3300 ldap_pvt_thread_mutex_unlock( &query->answerable_cnt_mutex );
3302 cb.sc_response = refresh_merge;
3303 cb.sc_private = &ri;
3306 ri.ri_be = op->o_bd;
3309 op->o_tag = LDAP_REQ_SEARCH;
3310 op->o_protocol = LDAP_VERSION3;
3311 op->o_callback = &cb;
3312 op->o_do_not_cache = 1;
3314 op->o_req_dn = query->qbase->base;
3315 op->o_req_ndn = query->qbase->base;
3316 op->ors_scope = query->scope;
3317 op->ors_slimit = SLAP_NO_LIMIT;
3318 op->ors_tlimit = SLAP_NO_LIMIT;
3319 op->ors_limit = NULL;
3320 op->ors_filter = query->filter;
3321 filter2bv_x( op, query->filter, &op->ors_filterstr );
3322 op->ors_attrs = query->qtemp->t_attrs.attrs;
3323 op->ors_attrsonly = 0;
3325 op->o_bd = on->on_info->oi_origdb;
3326 rc = op->o_bd->be_search( op, rs );
3328 op->o_bd = ri.ri_be;
3332 /* Get the DNs of all entries matching this query */
3333 cb.sc_response = refresh_purge;
3335 op->o_bd = ri.ri_be;
3336 op->o_req_dn = op->o_bd->be_suffix[0];
3337 op->o_req_ndn = op->o_bd->be_nsuffix[0];
3338 op->ors_scope = LDAP_SCOPE_SUBTREE;
3339 op->ors_deref = LDAP_DEREF_NEVER;
3340 op->ors_filterstr.bv_len = snprintf(filter_str, sizeof(filter_str),
3341 "(%s=%s)", ad_queryId->ad_cname.bv_val, query->q_uuid.bv_val);
3342 filter.f_ava = &ava;
3343 filter.f_av_desc = ad_queryId;
3344 filter.f_av_value = query->q_uuid;
3345 attrs[ 0 ].an_desc = ad_queryId;
3346 attrs[ 0 ].an_name = ad_queryId->ad_cname;
3347 op->ors_attrs = attrs;
3348 op->ors_attrsonly = 0;
3349 rs->sr_entry = NULL;
3350 rs->sr_nentries = 0;
3351 rc = op->o_bd->be_search( op, rs );
3352 if ( rc ) goto leave;
3354 while (( dn = ri.ri_dels )) {
3355 op->o_req_dn = dn->dn;
3356 op->o_req_ndn = dn->dn;
3358 op->o_tag = LDAP_REQ_DELETE;
3359 op->o_bd->be_delete( op, rs );
3362 struct berval vals[2];
3364 vals[0] = query->q_uuid;
3365 BER_BVZERO( &vals[1] );
3366 mod.sml_op = LDAP_MOD_DELETE;
3368 mod.sml_desc = ad_queryId;
3369 mod.sml_type = ad_queryId->ad_cname;
3370 mod.sml_values = vals;
3371 mod.sml_nvalues = NULL;
3372 mod.sml_numvals = 1;
3373 mod.sml_next = NULL;
3375 op->o_tag = LDAP_REQ_MODIFY;
3376 op->orm_modlist = &mod;
3377 op->o_bd->be_modify( op, rs );
3379 ri.ri_dels = dn->next;
3380 op->o_tmpfree( dn, op->o_tmpmemctx );
3384 /* reset our local heap, we're done with it */
3385 slap_sl_mem_create(SLAP_SLAB_SIZE, SLAP_SLAB_STACK, op->o_threadctx, 1 );
3394 struct re_s *rtask = arg;
3395 slap_overinst *on = rtask->arg;
3396 cache_manager *cm = on->on_bi.bi_private;
3397 query_manager *qm = cm->qm;
3398 Connection conn = {0};
3399 OperationBuffer opbuf;
3402 SlapReply rs = {REP_RESULT};
3403 CachedQuery *query, *qprev;
3404 int return_val, pause = PCACHE_CC_PAUSED;
3405 QueryTemplate *templ;
3407 /* Don't expire anything when we're offline */
3408 if ( cm->cc_paused & PCACHE_CC_OFFLINE ) {
3409 pause = PCACHE_CC_OFFLINE;
3413 connection_fake_init( &conn, &opbuf, ctx );
3417 op->o_dn = cm->db.be_rootdn;
3418 op->o_ndn = cm->db.be_rootndn;
3422 for (templ = qm->templates; templ; templ=templ->qmnext) {
3424 if ( !templ->query_last ) continue;
3426 op->o_time = slap_get_time();
3427 if ( !templ->ttr ) {
3429 if ( templ->negttl && templ->negttl < ttl )
3430 ttl = templ->negttl;
3431 if ( templ->limitttl && templ->limitttl < ttl )
3432 ttl = templ->limitttl;
3433 /* The oldest timestamp that needs expiration checking */
3437 for ( query=templ->query_last; query; query=qprev ) {
3438 qprev = query->prev;
3439 if ( query->refresh_time && query->refresh_time < op->o_time ) {
3440 /* A refresh will extend the expiry if the query has been
3441 * referenced, but not if it's unreferenced. If the
3442 * expiration has been hit, then skip the refresh since
3443 * we're just going to discard the result anyway.
3445 if ( query->refcnt )
3446 query->expiry_time = op->o_time + templ->ttl;
3447 if ( query->expiry_time > op->o_time ) {
3448 refresh_query( op, &rs, query, on );
3453 if (query->expiry_time < op->o_time) {
3455 Debug( pcache_debug, "Lock CR index = %p\n",
3456 (void *) templ, 0, 0 );
3457 ldap_pvt_thread_rdwr_wlock(&templ->t_rwlock);
3458 if ( query == templ->query_last ) {
3460 remove_from_template(query, templ);
3461 Debug( pcache_debug, "TEMPLATE %p QUERIES-- %d\n",
3462 (void *) templ, templ->no_of_queries, 0 );
3463 Debug( pcache_debug, "Unlock CR index = %p\n",
3464 (void *) templ, 0, 0 );
3466 ldap_pvt_thread_rdwr_wunlock(&templ->t_rwlock);
3470 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
3471 remove_query(qm, query);
3472 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
3473 if ( BER_BVISNULL( &query->q_uuid ))
3476 return_val = remove_query_data(op, &rs, &query->q_uuid);
3477 Debug( pcache_debug, "STALE QUERY REMOVED, SIZE=%d\n",
3479 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
3480 cm->cur_entries -= return_val;
3481 cm->num_cached_queries--;
3482 Debug( pcache_debug, "STORED QUERIES = %lu\n",
3483 cm->num_cached_queries, 0, 0 );
3484 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
3485 Debug( pcache_debug,
3486 "STALE QUERY REMOVED, CACHE ="
3488 cm->cur_entries, 0, 0 );
3490 } else if ( !templ->ttr && query->expiry_time > ttl ) {
3491 /* We don't need to check for refreshes, and this
3492 * query's expiry is too new, and all subsequent queries
3493 * will be newer yet. So stop looking.
3495 * If we have refreshes, then we always have to walk the
3496 * entire query list.
3504 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
3505 if ( ldap_pvt_runqueue_isrunning( &slapd_rq, rtask )) {
3506 ldap_pvt_runqueue_stoptask( &slapd_rq, rtask );
3508 /* If there were no queries, defer processing for a while */
3509 if ( cm->cc_paused != pause )
3510 cm->cc_paused = pause;
3511 ldap_pvt_runqueue_resched( &slapd_rq, rtask, pause );
3513 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
3518 #define MAX_ATTR_SETS 500
3531 static ConfigDriver pc_cf_gen;
3532 static ConfigLDAPadd pc_ldadd;
3533 static ConfigCfAdd pc_cfadd;
3535 static ConfigTable pccfg[] = {
3536 { "pcache", "backend> <max_entries> <numattrsets> <entry limit> "
3538 6, 6, 0, ARG_MAGIC|ARG_NO_DELETE|PC_MAIN, pc_cf_gen,
3539 "( OLcfgOvAt:2.1 NAME ( 'olcPcache' 'olcProxyCache' ) "
3540 "DESC 'Proxy Cache basic parameters' "
3541 "SYNTAX OMsDirectoryString SINGLE-VALUE )", NULL, NULL },
3542 { "pcacheAttrset", "index> <attributes...",
3543 2, 0, 0, ARG_MAGIC|PC_ATTR, pc_cf_gen,
3544 "( OLcfgOvAt:2.2 NAME ( 'olcPcacheAttrset' 'olcProxyAttrset' ) "
3545 "DESC 'A set of attributes to cache' "
3546 "SYNTAX OMsDirectoryString )", NULL, NULL },
3547 { "pcacheTemplate", "filter> <attrset-index> <TTL> <negTTL> "
3549 4, 7, 0, ARG_MAGIC|PC_TEMP, pc_cf_gen,
3550 "( OLcfgOvAt:2.3 NAME ( 'olcPcacheTemplate' 'olcProxyCacheTemplate' ) "
3551 "DESC 'Filter template, attrset, cache TTL, "
3552 "optional negative TTL, optional sizelimit TTL, "
3554 "SYNTAX OMsDirectoryString )", NULL, NULL },
3555 { "pcachePosition", "head|tail(default)",
3556 2, 2, 0, ARG_MAGIC|PC_RESP, pc_cf_gen,
3557 "( OLcfgOvAt:2.4 NAME 'olcPcachePosition' "
3558 "DESC 'Response callback position in overlay stack' "
3559 "SYNTAX OMsDirectoryString )", NULL, NULL },
3560 { "pcacheMaxQueries", "queries",
3561 2, 2, 0, ARG_INT|ARG_MAGIC|PC_QUERIES, pc_cf_gen,
3562 "( OLcfgOvAt:2.5 NAME ( 'olcPcacheMaxQueries' 'olcProxyCacheQueries' ) "
3563 "DESC 'Maximum number of queries to cache' "
3564 "SYNTAX OMsInteger )", NULL, NULL },
3565 { "pcachePersist", "TRUE|FALSE",
3566 2, 2, 0, ARG_ON_OFF|ARG_OFFSET, (void *)offsetof(cache_manager, save_queries),
3567 "( OLcfgOvAt:2.6 NAME ( 'olcPcachePersist' 'olcProxySaveQueries' ) "
3568 "DESC 'Save cached queries for hot restart' "
3569 "SYNTAX OMsBoolean )", NULL, NULL },
3570 { "pcacheValidate", "TRUE|FALSE",
3571 2, 2, 0, ARG_ON_OFF|ARG_OFFSET, (void *)offsetof(cache_manager, check_cacheability),
3572 "( OLcfgOvAt:2.7 NAME ( 'olcPcacheValidate' 'olcProxyCheckCacheability' ) "
3573 "DESC 'Check whether the results of a query are cacheable, e.g. for schema issues' "
3574 "SYNTAX OMsBoolean )", NULL, NULL },
3575 { "pcacheOffline", "TRUE|FALSE",
3576 2, 2, 0, ARG_ON_OFF|ARG_MAGIC|PC_OFFLINE, pc_cf_gen,
3577 "( OLcfgOvAt:2.8 NAME 'olcPcacheOffline' "
3578 "DESC 'Set cache to offline mode and disable expiration' "
3579 "SYNTAX OMsBoolean )", NULL, NULL },
3580 { "pcacheBind", "filter> <attrset-index> <TTR> <scope> <base",
3581 6, 6, 0, ARG_MAGIC|PC_BIND, pc_cf_gen,
3582 "( OLcfgOvAt:2.9 NAME 'olcPcacheBind' "
3583 "DESC 'Parameters for caching Binds' "
3584 "SYNTAX OMsDirectoryString )", NULL, NULL },
3585 { "pcache-", "private database args",
3586 1, 0, STRLENOF("pcache-"), ARG_MAGIC|PC_PRIVATE_DB, pc_cf_gen,
3589 /* Legacy keywords */
3590 { "proxycache", "backend> <max_entries> <numattrsets> <entry limit> "
3592 6, 6, 0, ARG_MAGIC|ARG_NO_DELETE|PC_MAIN, pc_cf_gen,
3594 { "proxyattrset", "index> <attributes...",
3595 2, 0, 0, ARG_MAGIC|PC_ATTR, pc_cf_gen,
3597 { "proxytemplate", "filter> <attrset-index> <TTL> <negTTL",
3598 4, 7, 0, ARG_MAGIC|PC_TEMP, pc_cf_gen,
3600 { "response-callback", "head|tail(default)",
3601 2, 2, 0, ARG_MAGIC|PC_RESP, pc_cf_gen,
3603 { "proxyCacheQueries", "queries",
3604 2, 2, 0, ARG_INT|ARG_MAGIC|PC_QUERIES, pc_cf_gen,
3606 { "proxySaveQueries", "TRUE|FALSE",
3607 2, 2, 0, ARG_ON_OFF|ARG_OFFSET, (void *)offsetof(cache_manager, save_queries),
3609 { "proxyCheckCacheability", "TRUE|FALSE",
3610 2, 2, 0, ARG_ON_OFF|ARG_OFFSET, (void *)offsetof(cache_manager, check_cacheability),
3613 { NULL, NULL, 0, 0, 0, ARG_IGNORED }
3616 static ConfigOCs pcocs[] = {
3617 { "( OLcfgOvOc:2.1 "
3618 "NAME 'olcPcacheConfig' "
3619 "DESC 'ProxyCache configuration' "
3620 "SUP olcOverlayConfig "
3621 "MUST ( olcPcache $ olcPcacheAttrset $ olcPcacheTemplate ) "
3622 "MAY ( olcPcachePosition $ olcPcacheMaxQueries $ olcPcachePersist $ "
3623 "olcPcacheValidate $ olcPcacheOffline $ olcPcacheBind ) )",
3624 Cft_Overlay, pccfg, NULL, pc_cfadd },
3625 { "( OLcfgOvOc:2.2 "
3626 "NAME 'olcPcacheDatabase' "
3627 "DESC 'Cache database configuration' "
3628 "AUXILIARY )", Cft_Misc, olcDatabaseDummy, pc_ldadd },
3632 static int pcache_db_open2( slap_overinst *on, ConfigReply *cr );
3635 pc_ldadd_cleanup( ConfigArgs *c )
3637 slap_overinst *on = c->ca_private;
3638 return pcache_db_open2( on, &c->reply );
3642 pc_ldadd( CfEntryInfo *p, Entry *e, ConfigArgs *ca )
3647 if ( p->ce_type != Cft_Overlay || !p->ce_bi ||
3648 p->ce_bi->bi_cf_ocs != pcocs )
3649 return LDAP_CONSTRAINT_VIOLATION;
3651 on = (slap_overinst *)p->ce_bi;
3652 cm = on->on_bi.bi_private;
3654 /* Defer open if this is an LDAPadd */
3655 if ( CONFIG_ONLINE_ADD( ca ))
3656 ca->cleanup = pc_ldadd_cleanup;
3658 cm->defer_db_open = 0;
3659 ca->ca_private = on;
3660 return LDAP_SUCCESS;
3664 pc_cfadd( Operation *op, SlapReply *rs, Entry *p, ConfigArgs *ca )
3666 CfEntryInfo *pe = p->e_private;
3667 slap_overinst *on = (slap_overinst *)pe->ce_bi;
3668 cache_manager *cm = on->on_bi.bi_private;
3671 /* FIXME: should not hardcode "olcDatabase" here */
3672 bv.bv_len = snprintf( ca->cr_msg, sizeof( ca->cr_msg ),
3673 "olcDatabase=" SLAP_X_ORDERED_FMT "%s",
3674 0, cm->db.bd_info->bi_type );
3675 if ( bv.bv_len >= sizeof( ca->cr_msg ) ) {
3678 bv.bv_val = ca->cr_msg;
3680 cm->defer_db_open = 0;
3682 /* We can only create this entry if the database is table-driven
3684 if ( cm->db.bd_info->bi_cf_ocs )
3685 config_build_entry( op, rs, pe, ca, &bv, cm->db.bd_info->bi_cf_ocs,
3692 pc_cf_gen( ConfigArgs *c )
3694 slap_overinst *on = (slap_overinst *)c->bi;
3695 cache_manager* cm = on->on_bi.bi_private;
3696 query_manager* qm = cm->qm;
3697 QueryTemplate* temp;
3698 AttributeName* attr_name;
3699 AttributeName* attrarray;
3700 const char* text=NULL;
3705 if ( c->op == SLAP_CONFIG_EMIT ) {
3709 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ), "%s %d %d %d %ld",
3710 cm->db.bd_info->bi_type, cm->max_entries, cm->numattrsets,
3711 cm->num_entries_limit, cm->cc_period );
3712 bv.bv_val = c->cr_msg;
3713 value_add_one( &c->rvalue_vals, &bv );
3716 for (i=0; i<cm->numattrsets; i++) {
3717 if ( !qm->attr_sets[i].count ) continue;
3719 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ), "%d", i );
3721 /* count the attr length */
3722 for ( attr_name = qm->attr_sets[i].attrs;
3723 attr_name->an_name.bv_val; attr_name++ )
3724 bv.bv_len += attr_name->an_name.bv_len + 1;
3726 bv.bv_val = ch_malloc( bv.bv_len+1 );
3727 ptr = lutil_strcopy( bv.bv_val, c->cr_msg );
3728 for ( attr_name = qm->attr_sets[i].attrs;
3729 attr_name->an_name.bv_val; attr_name++ ) {
3731 ptr = lutil_strcopy( ptr, attr_name->an_name.bv_val );
3733 ber_bvarray_add( &c->rvalue_vals, &bv );
3735 if ( !c->rvalue_vals )
3739 for (temp=qm->templates; temp; temp=temp->qmnext) {
3740 /* HEADS-UP: always print all;
3741 * if optional == 0, ignore */
3742 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ),
3743 " %d %ld %ld %ld %ld",
3744 temp->attr_set_index,
3749 bv.bv_len += temp->querystr.bv_len + 2;
3750 bv.bv_val = ch_malloc( bv.bv_len+1 );
3753 ptr = lutil_strcopy( ptr, temp->querystr.bv_val );
3755 strcpy( ptr, c->cr_msg );
3756 ber_bvarray_add( &c->rvalue_vals, &bv );
3758 if ( !c->rvalue_vals )
3762 for (temp=qm->templates; temp; temp=temp->qmnext) {
3763 if ( !temp->bindttr ) continue;
3764 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ),
3766 temp->attr_set_index,
3768 ldap_pvt_scope2str( temp->bindscope ));
3769 bv.bv_len += temp->bindbase.bv_len + temp->bindftemp.bv_len + 4;
3770 bv.bv_val = ch_malloc( bv.bv_len + 1 );
3773 ptr = lutil_strcopy( ptr, temp->bindftemp.bv_val );
3775 ptr = lutil_strcopy( ptr, c->cr_msg );
3777 ptr = lutil_strcopy( ptr, temp->bindbase.bv_val );
3780 ber_bvarray_add( &c->rvalue_vals, &bv );
3782 if ( !c->rvalue_vals )
3786 if ( cm->response_cb == PCACHE_RESPONSE_CB_HEAD ) {
3787 BER_BVSTR( &bv, "head" );
3789 BER_BVSTR( &bv, "tail" );
3791 value_add_one( &c->rvalue_vals, &bv );
3794 c->value_int = cm->max_queries;
3797 c->value_int = (cm->cc_paused & PCACHE_CC_OFFLINE) != 0;
3801 } else if ( c->op == LDAP_MOD_DELETE ) {
3804 case PC_ATTR: /* FIXME */
3809 cm->cc_paused &= ~PCACHE_CC_OFFLINE;
3810 /* If there were cached queries when we went offline,
3811 * restart the checker now.
3813 if ( cm->num_cached_queries ) {
3814 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
3816 ldap_pvt_runqueue_resched( &slapd_rq, cm->cc_arg, 0 );
3817 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
3827 if ( cm->numattrsets > 0 ) {
3828 snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"pcache\" directive already provided" );
3829 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3833 if ( lutil_atoi( &cm->numattrsets, c->argv[3] ) != 0 ) {
3834 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse num attrsets=\"%s\" (arg #3)",
3836 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3839 if ( cm->numattrsets <= 0 ) {
3840 snprintf( c->cr_msg, sizeof( c->cr_msg ), "numattrsets (arg #3) must be positive" );
3841 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3844 if ( cm->numattrsets > MAX_ATTR_SETS ) {
3845 snprintf( c->cr_msg, sizeof( c->cr_msg ), "numattrsets (arg #3) must be <= %d", MAX_ATTR_SETS );
3846 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3850 if ( !backend_db_init( c->argv[1], &cm->db, -1, NULL )) {
3851 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unknown backend type (arg #1)" );
3852 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3856 if ( lutil_atoi( &cm->max_entries, c->argv[2] ) != 0 ) {
3857 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse max entries=\"%s\" (arg #2)",
3859 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3862 if ( cm->max_entries <= 0 ) {
3863 snprintf( c->cr_msg, sizeof( c->cr_msg ), "max entries (arg #2) must be positive.\n" );
3864 Debug( LDAP_DEBUG_CONFIG, "%s: %s\n", c->log, c->cr_msg, 0 );
3868 if ( lutil_atoi( &cm->num_entries_limit, c->argv[4] ) != 0 ) {
3869 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse entry limit=\"%s\" (arg #4)",
3871 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3874 if ( cm->num_entries_limit <= 0 ) {
3875 snprintf( c->cr_msg, sizeof( c->cr_msg ), "entry limit (arg #4) must be positive" );
3876 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3879 if ( cm->num_entries_limit > cm->max_entries ) {
3880 snprintf( c->cr_msg, sizeof( c->cr_msg ), "entry limit (arg #4) must be less than max entries %d (arg #2)", cm->max_entries );
3881 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3885 if ( lutil_parse_time( c->argv[5], &t ) != 0 ) {
3886 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse period=\"%s\" (arg #5)",
3888 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3892 cm->cc_period = (time_t)t;
3893 Debug( pcache_debug,
3894 "Total # of attribute sets to be cached = %d.\n",
3895 cm->numattrsets, 0, 0 );
3896 qm->attr_sets = ( struct attr_set * )ch_calloc( cm->numattrsets,
3897 sizeof( struct attr_set ) );
3900 if ( cm->numattrsets == 0 ) {
3901 snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"pcache\" directive not provided yet" );
3902 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3905 if ( lutil_atoi( &num, c->argv[1] ) != 0 ) {
3906 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse attrset #=\"%s\"",
3908 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3912 if ( num < 0 || num >= cm->numattrsets ) {
3913 snprintf( c->cr_msg, sizeof( c->cr_msg ), "attrset index %d out of bounds (must be %s%d)",
3914 num, cm->numattrsets > 1 ? "0->" : "", cm->numattrsets - 1 );
3915 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3918 qm->attr_sets[num].flags |= PC_CONFIGURED;
3919 if ( c->argc == 2 ) {
3921 snprintf( c->cr_msg, sizeof( c->cr_msg ),
3922 "need an explicit attr in attrlist; use \"*\" to indicate all attrs" );
3923 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3926 } else if ( c->argc == 3 ) {
3927 if ( strcmp( c->argv[2], LDAP_ALL_USER_ATTRIBUTES ) == 0 ) {
3928 qm->attr_sets[num].count = 1;
3929 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( 2,
3930 sizeof( AttributeName ) );
3931 BER_BVSTR( &qm->attr_sets[num].attrs[0].an_name, LDAP_ALL_USER_ATTRIBUTES );
3934 } else if ( strcmp( c->argv[2], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 ) {
3935 qm->attr_sets[num].count = 1;
3936 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( 2,
3937 sizeof( AttributeName ) );
3938 BER_BVSTR( &qm->attr_sets[num].attrs[0].an_name, LDAP_ALL_OPERATIONAL_ATTRIBUTES );
3941 } else if ( strcmp( c->argv[2], LDAP_NO_ATTRS ) == 0 ) {
3944 /* else: fallthru */
3946 } else if ( c->argc == 4 ) {
3947 if ( ( strcmp( c->argv[2], LDAP_ALL_USER_ATTRIBUTES ) == 0 && strcmp( c->argv[3], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 )
3948 || ( strcmp( c->argv[2], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 && strcmp( c->argv[3], LDAP_ALL_USER_ATTRIBUTES ) == 0 ) )
3950 qm->attr_sets[num].count = 2;
3951 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( 3,
3952 sizeof( AttributeName ) );
3953 BER_BVSTR( &qm->attr_sets[num].attrs[0].an_name, LDAP_ALL_USER_ATTRIBUTES );
3954 BER_BVSTR( &qm->attr_sets[num].attrs[1].an_name, LDAP_ALL_OPERATIONAL_ATTRIBUTES );
3957 /* else: fallthru */
3960 if ( c->argc > 2 ) {
3961 int all_user = 0, all_op = 0;
3963 qm->attr_sets[num].count = c->argc - 2;
3964 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( c->argc - 1,
3965 sizeof( AttributeName ) );
3966 attr_name = qm->attr_sets[num].attrs;
3967 for ( i = 2; i < c->argc; i++ ) {
3968 attr_name->an_desc = NULL;
3969 if ( strcmp( c->argv[i], LDAP_NO_ATTRS ) == 0 ) {
3970 snprintf( c->cr_msg, sizeof( c->cr_msg ),
3971 "invalid attr #%d \"%s\" in attrlist",
3972 i - 2, c->argv[i] );
3973 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3974 ch_free( qm->attr_sets[num].attrs );
3975 qm->attr_sets[num].attrs = NULL;
3976 qm->attr_sets[num].count = 0;
3979 if ( strcmp( c->argv[i], LDAP_ALL_USER_ATTRIBUTES ) == 0 ) {
3981 BER_BVSTR( &attr_name->an_name, LDAP_ALL_USER_ATTRIBUTES );
3982 } else if ( strcmp( c->argv[i], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 ) {
3984 BER_BVSTR( &attr_name->an_name, LDAP_ALL_OPERATIONAL_ATTRIBUTES );
3986 if ( slap_str2ad( c->argv[i], &attr_name->an_desc, &text ) ) {
3987 strcpy( c->cr_msg, text );
3988 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3989 ch_free( qm->attr_sets[num].attrs );
3990 qm->attr_sets[num].attrs = NULL;
3991 qm->attr_sets[num].count = 0;
3994 attr_name->an_name = attr_name->an_desc->ad_cname;
3996 attr_name->an_oc = NULL;
3997 attr_name->an_flags = 0;
3998 if ( attr_name->an_desc == slap_schema.si_ad_objectClass )
3999 qm->attr_sets[num].flags |= PC_GOT_OC;
4001 BER_BVZERO( &attr_name->an_name );
4004 /* warn if list contains both "*" and "+" */
4005 if ( i > 4 && all_user && all_op ) {
4006 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4007 "warning: attribute list contains \"*\" and \"+\"" );
4008 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4013 if ( cm->numattrsets == 0 ) {
4014 snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"pcache\" directive not provided yet" );
4015 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4018 if ( lutil_atoi( &i, c->argv[2] ) != 0 ) {
4019 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse template #=\"%s\"",
4021 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4025 if ( i < 0 || i >= cm->numattrsets ||
4026 !(qm->attr_sets[i].flags & PC_CONFIGURED )) {
4027 snprintf( c->cr_msg, sizeof( c->cr_msg ), "template index %d invalid (%s%d)",
4028 i, cm->numattrsets > 1 ? "0->" : "", cm->numattrsets - 1 );
4029 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4033 AttributeName *attrs;
4035 cnt = template_attrs( c->argv[1], &qm->attr_sets[i], &attrs, &text );
4037 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse template: %s",
4039 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4042 temp = ch_calloc( 1, sizeof( QueryTemplate ));
4043 temp->qmnext = qm->templates;
4044 qm->templates = temp;
4045 temp->t_attrs.attrs = attrs;
4046 temp->t_attrs.count = cnt;
4048 ldap_pvt_thread_rdwr_init( &temp->t_rwlock );
4049 temp->query = temp->query_last = NULL;
4050 if ( lutil_parse_time( c->argv[3], &t ) != 0 ) {
4051 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4052 "unable to parse template ttl=\"%s\"",
4054 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4056 ch_free( temp->t_attrs.attrs );
4060 temp->ttl = (time_t)t;
4061 temp->negttl = (time_t)0;
4062 temp->limitttl = (time_t)0;
4063 temp->ttr = (time_t)0;
4064 switch ( c->argc ) {
4066 if ( lutil_parse_time( c->argv[6], &t ) != 0 ) {
4067 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4068 "unable to parse template ttr=\"%s\"",
4070 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4073 temp->ttr = (time_t)t;
4077 if ( lutil_parse_time( c->argv[5], &t ) != 0 ) {
4078 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4079 "unable to parse template sizelimit ttl=\"%s\"",
4081 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4084 temp->limitttl = (time_t)t;
4088 if ( lutil_parse_time( c->argv[4], &t ) != 0 ) {
4089 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4090 "unable to parse template negative ttl=\"%s\"",
4092 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4095 temp->negttl = (time_t)t;
4099 temp->no_of_queries = 0;
4101 ber_str2bv( c->argv[1], 0, 1, &temp->querystr );
4102 Debug( pcache_debug, "Template:\n", 0, 0, 0 );
4103 Debug( pcache_debug, " query template: %s\n",
4104 temp->querystr.bv_val, 0, 0 );
4105 temp->attr_set_index = i;
4106 qm->attr_sets[i].flags |= PC_REFERENCED;
4107 temp->qtnext = qm->attr_sets[i].templates;
4108 qm->attr_sets[i].templates = temp;
4109 Debug( pcache_debug, " attributes: \n", 0, 0, 0 );
4110 if ( ( attrarray = qm->attr_sets[i].attrs ) != NULL ) {
4111 for ( i=0; attrarray[i].an_name.bv_val; i++ )
4112 Debug( pcache_debug, "\t%s\n",
4113 attrarray[i].an_name.bv_val, 0, 0 );
4117 if ( !qm->templates ) {
4118 snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"pcacheTemplate\" directive not provided yet" );
4119 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4122 if ( lutil_atoi( &i, c->argv[2] ) != 0 ) {
4123 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse Bind index #=\"%s\"",
4125 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4129 if ( i < 0 || i >= cm->numattrsets ||
4130 !(qm->attr_sets[i].flags & PC_CONFIGURED )) {
4131 snprintf( c->cr_msg, sizeof( c->cr_msg ), "Bind index %d invalid (%s%d)",
4132 i, cm->numattrsets > 1 ? "0->" : "", cm->numattrsets - 1 );
4133 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4136 { struct berval bv, tempbv;
4137 AttributeDescription **descs;
4139 ber_str2bv( c->argv[1], 0, 0, &bv );
4140 ndescs = ftemp_attrs( &bv, &tempbv, &descs, &text );
4142 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse template: %s",
4144 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4147 for ( temp = qm->templates; temp; temp=temp->qmnext ) {
4148 if ( temp->attr_set_index == i && bvmatch( &tempbv,
4152 ch_free( tempbv.bv_val );
4155 snprintf( c->cr_msg, sizeof( c->cr_msg ), "Bind template %s %d invalid",
4157 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4160 ber_dupbv( &temp->bindftemp, &bv );
4161 temp->bindfattrs = descs;
4162 temp->bindnattrs = ndescs;
4164 if ( lutil_parse_time( c->argv[3], &t ) != 0 ) {
4165 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4166 "unable to parse bind ttr=\"%s\"",
4168 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4170 ch_free( temp->bindfattrs );
4171 temp->bindfattrs = NULL;
4172 ch_free( temp->bindftemp.bv_val );
4173 BER_BVZERO( &temp->bindftemp );
4176 num = ldap_pvt_str2scope( c->argv[4] );
4178 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4179 "unable to parse bind scope=\"%s\"",
4181 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4185 struct berval dn, ndn;
4186 ber_str2bv( c->argv[5], 0, 0, &dn );
4187 rc = dnNormalize( 0, NULL, NULL, &dn, &ndn, NULL );
4189 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4190 "invalid bind baseDN=\"%s\"",
4192 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4195 if ( temp->bindbase.bv_val )
4196 ch_free( temp->bindbase.bv_val );
4197 temp->bindbase = ndn;
4200 /* convert the template into dummy filter */
4202 char *eq = temp->bindftemp.bv_val, *e2;
4205 while ((eq = strchr(eq, '=' ))) {
4210 bv.bv_len = temp->bindftemp.bv_len + i;
4211 bv.bv_val = ch_malloc( bv.bv_len + 1 );
4212 for ( e2 = bv.bv_val, eq = temp->bindftemp.bv_val;
4223 f = str2filter( bv.bv_val );
4225 ch_free( bv.bv_val );
4226 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4227 "unable to parse bindfilter=\"%s\"", bv.bv_val );
4228 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4229 ch_free( temp->bindbase.bv_val );
4230 BER_BVZERO( &temp->bindbase );
4233 if ( temp->bindfilter )
4234 filter_free( temp->bindfilter );
4235 if ( temp->bindfilterstr.bv_val )
4236 ch_free( temp->bindfilterstr.bv_val );
4237 temp->bindfilterstr = bv;
4238 temp->bindfilter = f;
4240 temp->bindttr = (time_t)t;
4241 temp->bindscope = num;
4242 cm->cache_binds = 1;
4246 if ( strcasecmp( c->argv[1], "head" ) == 0 ) {
4247 cm->response_cb = PCACHE_RESPONSE_CB_HEAD;
4249 } else if ( strcasecmp( c->argv[1], "tail" ) == 0 ) {
4250 cm->response_cb = PCACHE_RESPONSE_CB_TAIL;
4253 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unknown specifier" );
4254 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4259 if ( c->value_int <= 0 ) {
4260 snprintf( c->cr_msg, sizeof( c->cr_msg ), "max queries must be positive" );
4261 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4264 cm->max_queries = c->value_int;
4268 cm->cc_paused |= PCACHE_CC_OFFLINE;
4270 cm->cc_paused &= ~PCACHE_CC_OFFLINE;
4273 if ( cm->db.be_private == NULL ) {
4274 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4275 "private database must be defined before setting database specific options" );
4276 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4280 if ( cm->db.bd_info->bi_cf_ocs ) {
4283 char *argv0 = c->argv[ 0 ];
4285 c->argv[ 0 ] = &argv0[ STRLENOF( "pcache-" ) ];
4287 ct = config_find_keyword( cm->db.bd_info->bi_cf_ocs->co_table, c );
4289 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4290 "private database does not recognize specific option '%s'",
4292 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4296 c->table = cm->db.bd_info->bi_cf_ocs->co_type;
4298 c->bi = c->be->bd_info;
4300 rc = config_add_vals( ct, c );
4304 c->table = c2.table;
4307 c->argv[ 0 ] = argv0;
4309 } else if ( cm->db.be_config != NULL ) {
4310 char *argv0 = c->argv[ 0 ];
4312 c->argv[ 0 ] = &argv0[ STRLENOF( "pcache-" ) ];
4313 rc = cm->db.be_config( &cm->db, c->fname, c->lineno, c->argc, c->argv );
4314 c->argv[ 0 ] = argv0;
4317 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4318 "no means to set private database specific options" );
4319 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4324 rc = SLAP_CONF_UNKNOWN;
4340 slap_overinst *on = (slap_overinst *)be->bd_info;
4341 cache_manager* cm = on->on_bi.bi_private;
4343 /* Something for the cache database? */
4344 if ( cm->db.bd_info && cm->db.bd_info->bi_db_config )
4345 return cm->db.bd_info->bi_db_config( &cm->db, fname, lineno,
4347 return SLAP_CONF_UNKNOWN;
4355 slap_overinst *on = (slap_overinst *)be->bd_info;
4359 cm = (cache_manager *)ch_malloc(sizeof(cache_manager));
4360 on->on_bi.bi_private = cm;
4362 qm = (query_manager*)ch_malloc(sizeof(query_manager));
4365 SLAP_DBFLAGS(&cm->db) |= SLAP_DBFLAG_NO_SCHEMA_CHECK;
4366 cm->db.be_private = NULL;
4367 cm->db.bd_self = &cm->db;
4369 cm->numattrsets = 0;
4370 cm->num_entries_limit = 5;
4371 cm->num_cached_queries = 0;
4372 cm->max_entries = 0;
4373 cm->cur_entries = 0;
4374 cm->max_queries = 10000;
4375 cm->save_queries = 0;
4376 cm->check_cacheability = 0;
4377 cm->response_cb = PCACHE_RESPONSE_CB_TAIL;
4378 cm->defer_db_open = 1;
4379 cm->cc_period = 1000;
4383 qm->attr_sets = NULL;
4384 qm->templates = NULL;
4386 qm->lru_bottom = NULL;
4388 qm->qcfunc = query_containment;
4389 qm->crfunc = cache_replacement;
4390 qm->addfunc = add_query;
4391 ldap_pvt_thread_mutex_init(&qm->lru_mutex);
4393 ldap_pvt_thread_mutex_init(&cm->cache_mutex);
4395 #ifndef PCACHE_MONITOR
4397 #else /* PCACHE_MONITOR */
4398 return pcache_monitor_db_init( be );
4399 #endif /* PCACHE_MONITOR */
4403 pcache_cachedquery_open_cb( Operation *op, SlapReply *rs )
4405 assert( op->o_tag == LDAP_REQ_SEARCH );
4407 if ( rs->sr_type == REP_SEARCH ) {
4410 a = attr_find( rs->sr_entry->e_attrs, ad_cachedQueryURL );
4414 assert( a->a_nvals != NULL );
4416 valsp = op->o_callback->sc_private;
4417 assert( *valsp == NULL );
4419 ber_bvarray_dup_x( valsp, a->a_nvals, op->o_tmpmemctx );
4427 pcache_cachedquery_count_cb( Operation *op, SlapReply *rs )
4429 assert( op->o_tag == LDAP_REQ_SEARCH );
4431 if ( rs->sr_type == REP_SEARCH ) {
4432 int *countp = (int *)op->o_callback->sc_private;
4445 cache_manager *cm = on->on_bi.bi_private;
4446 query_manager* qm = cm->qm;
4449 rc = backend_startup_one( &cm->db, cr );
4451 cm->defer_db_open = 0;
4454 /* There is no runqueue in TOOL mode */
4455 if (( slapMode & SLAP_SERVER_MODE ) && rc == 0 ) {
4456 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
4457 ldap_pvt_runqueue_insert( &slapd_rq, cm->cc_period,
4458 consistency_check, on,
4459 "pcache_consistency", cm->db.be_suffix[0].bv_val );
4460 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
4462 /* Cached database must have the rootdn */
4463 if ( BER_BVISNULL( &cm->db.be_rootndn )
4464 || BER_BVISEMPTY( &cm->db.be_rootndn ) )
4466 Debug( LDAP_DEBUG_ANY, "pcache_db_open(): "
4467 "underlying database of type \"%s\"\n"
4468 " serving naming context \"%s\"\n"
4469 " has no \"rootdn\", required by \"pcache\".\n",
4470 on->on_info->oi_orig->bi_type,
4471 cm->db.be_suffix[0].bv_val, 0 );
4475 if ( cm->save_queries ) {
4476 void *thrctx = ldap_pvt_thread_pool_context();
4477 Connection conn = { 0 };
4478 OperationBuffer opbuf;
4480 slap_callback cb = { 0 };
4481 SlapReply rs = { 0 };
4482 BerVarray vals = NULL;
4483 Filter f = { 0 }, f2 = { 0 };
4484 AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
4485 AttributeName attrs[ 2 ] = {{{ 0 }}};
4487 connection_fake_init( &conn, &opbuf, thrctx );
4492 op->o_tag = LDAP_REQ_SEARCH;
4493 op->o_protocol = LDAP_VERSION3;
4494 cb.sc_response = pcache_cachedquery_open_cb;
4495 cb.sc_private = &vals;
4496 op->o_callback = &cb;
4497 op->o_time = slap_get_time();
4498 op->o_do_not_cache = 1;
4499 op->o_managedsait = SLAP_CONTROL_CRITICAL;
4501 op->o_dn = cm->db.be_rootdn;
4502 op->o_ndn = cm->db.be_rootndn;
4503 op->o_req_dn = cm->db.be_suffix[ 0 ];
4504 op->o_req_ndn = cm->db.be_nsuffix[ 0 ];
4506 op->ors_scope = LDAP_SCOPE_BASE;
4507 op->ors_deref = LDAP_DEREF_NEVER;
4509 op->ors_tlimit = SLAP_NO_LIMIT;
4510 op->ors_limit = NULL;
4511 ber_str2bv( "(pcacheQueryURL=*)", 0, 0, &op->ors_filterstr );
4512 f.f_choice = LDAP_FILTER_PRESENT;
4513 f.f_desc = ad_cachedQueryURL;
4514 op->ors_filter = &f;
4515 attrs[ 0 ].an_desc = ad_cachedQueryURL;
4516 attrs[ 0 ].an_name = ad_cachedQueryURL->ad_cname;
4517 op->ors_attrs = attrs;
4518 op->ors_attrsonly = 0;
4520 rc = op->o_bd->be_search( op, &rs );
4521 if ( rc == LDAP_SUCCESS && vals != NULL ) {
4524 for ( i = 0; !BER_BVISNULL( &vals[ i ] ); i++ ) {
4525 if ( url2query( vals[ i ].bv_val, op, qm ) == 0 ) {
4526 cm->num_cached_queries++;
4530 ber_bvarray_free_x( vals, op->o_tmpmemctx );
4533 /* count cached entries */
4534 f.f_choice = LDAP_FILTER_NOT;
4536 f2.f_choice = LDAP_FILTER_EQUALITY;
4538 f2.f_av_desc = slap_schema.si_ad_objectClass;
4539 BER_BVSTR( &f2.f_av_value, "glue" );
4540 ber_str2bv( "(!(objectClass=glue))", 0, 0, &op->ors_filterstr );
4542 op->ors_slimit = SLAP_NO_LIMIT;
4543 op->ors_scope = LDAP_SCOPE_SUBTREE;
4544 op->ors_attrs = slap_anlist_no_attrs;
4546 op->o_callback->sc_response = pcache_cachedquery_count_cb;
4548 op->o_callback->sc_private = &rs.sr_nentries;
4550 rc = op->o_bd->be_search( op, &rs );
4552 cm->cur_entries = rs.sr_nentries;
4566 slap_overinst *on = (slap_overinst *)be->bd_info;
4567 cache_manager *cm = on->on_bi.bi_private;
4568 query_manager* qm = cm->qm;
4569 int i, ncf = 0, rf = 0, nrf = 0, rc = 0;
4571 /* check attr sets */
4572 for ( i = 0; i < cm->numattrsets; i++) {
4573 if ( !( qm->attr_sets[i].flags & PC_CONFIGURED ) ) {
4574 if ( qm->attr_sets[i].flags & PC_REFERENCED ) {
4575 Debug( LDAP_DEBUG_CONFIG, "pcache: attr set #%d not configured but referenced.\n", i, 0, 0 );
4579 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, attr set #%d not configured.\n", i, 0, 0 );
4583 } else if ( !( qm->attr_sets[i].flags & PC_REFERENCED ) ) {
4584 Debug( LDAP_DEBUG_CONFIG, "pcache: attr set #%d configured but not referenced.\n", i, 0, 0 );
4589 if ( ncf || rf || nrf ) {
4590 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, %d attr sets configured but not referenced.\n", nrf, 0, 0 );
4591 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, %d attr sets not configured.\n", ncf, 0, 0 );
4592 Debug( LDAP_DEBUG_CONFIG, "pcache: %d attr sets not configured but referenced.\n", rf, 0, 0 );
4599 /* need to inherit something from the original database... */
4600 cm->db.be_def_limit = be->be_def_limit;
4601 cm->db.be_limits = be->be_limits;
4602 cm->db.be_acl = be->be_acl;
4603 cm->db.be_dfltaccess = be->be_dfltaccess;
4605 if ( SLAP_DBMONITORING( be ) ) {
4606 SLAP_DBFLAGS( &cm->db ) |= SLAP_DBFLAG_MONITORING;
4609 SLAP_DBFLAGS( &cm->db ) &= ~SLAP_DBFLAG_MONITORING;
4612 if ( !cm->defer_db_open ) {
4613 rc = pcache_db_open2( on, cr );
4616 #ifdef PCACHE_MONITOR
4617 if ( rc == LDAP_SUCCESS ) {
4618 rc = pcache_monitor_db_open( be );
4620 #endif /* PCACHE_MONITOR */
4626 pcache_free_qbase( void *v )
4632 tavl_free( qb->scopes[i], NULL );
4642 slap_overinst *on = (slap_overinst *)be->bd_info;
4643 cache_manager *cm = on->on_bi.bi_private;
4644 query_manager *qm = cm->qm;
4648 /* stop the thread ... */
4650 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
4651 if ( ldap_pvt_runqueue_isrunning( &slapd_rq, cm->cc_arg ) ) {
4652 ldap_pvt_runqueue_stoptask( &slapd_rq, cm->cc_arg );
4654 ldap_pvt_runqueue_remove( &slapd_rq, cm->cc_arg );
4655 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
4658 if ( cm->save_queries ) {
4660 BerVarray vals = NULL;
4663 Connection conn = { 0 };
4664 OperationBuffer opbuf;
4666 slap_callback cb = { 0 };
4668 SlapReply rs = { REP_RESULT };
4669 Modifications mod = {{ 0 }};
4671 thrctx = ldap_pvt_thread_pool_context();
4673 connection_fake_init( &conn, &opbuf, thrctx );
4676 if ( qm->templates != NULL ) {
4677 for ( tm = qm->templates; tm != NULL; tm = tm->qmnext ) {
4678 for ( qc = tm->query; qc; qc = qc->next ) {
4681 if ( query2url( op, qc, &bv, 0 ) == 0 ) {
4682 ber_bvarray_add_x( &vals, &bv, op->o_tmpmemctx );
4689 op->o_dn = cm->db.be_rootdn;
4690 op->o_ndn = cm->db.be_rootndn;
4692 op->o_tag = LDAP_REQ_MODIFY;
4693 op->o_protocol = LDAP_VERSION3;
4694 cb.sc_response = slap_null_cb;
4695 op->o_callback = &cb;
4696 op->o_time = slap_get_time();
4697 op->o_do_not_cache = 1;
4698 op->o_managedsait = SLAP_CONTROL_CRITICAL;
4700 op->o_req_dn = op->o_bd->be_suffix[0];
4701 op->o_req_ndn = op->o_bd->be_nsuffix[0];
4703 mod.sml_op = LDAP_MOD_REPLACE;
4705 mod.sml_desc = ad_cachedQueryURL;
4706 mod.sml_type = ad_cachedQueryURL->ad_cname;
4707 mod.sml_values = vals;
4708 mod.sml_nvalues = NULL;
4709 mod.sml_numvals = 1;
4710 mod.sml_next = NULL;
4711 Debug( pcache_debug,
4712 "%sSETTING CACHED QUERY URLS\n",
4713 vals == NULL ? "RE" : "", 0, 0 );
4715 op->orm_modlist = &mod;
4717 op->o_bd->be_modify( op, &rs );
4719 ber_bvarray_free_x( vals, op->o_tmpmemctx );
4722 /* cleanup stuff inherited from the original database... */
4723 cm->db.be_limits = NULL;
4724 cm->db.be_acl = NULL;
4727 if ( cm->db.bd_info->bi_db_close ) {
4728 rc = cm->db.bd_info->bi_db_close( &cm->db, NULL );
4730 while ( (tm = qm->templates) != NULL ) {
4731 CachedQuery *qc, *qn;
4732 qm->templates = tm->qmnext;
4733 for ( qc = tm->query; qc; qc = qn ) {
4737 avl_free( tm->qbase, pcache_free_qbase );
4738 free( tm->querystr.bv_val );
4739 free( tm->bindfattrs );
4740 free( tm->bindftemp.bv_val );
4741 free( tm->bindfilterstr.bv_val );
4742 free( tm->bindbase.bv_val );
4743 filter_free( tm->bindfilter );
4744 ldap_pvt_thread_rdwr_destroy( &tm->t_rwlock );
4745 free( tm->t_attrs.attrs );
4749 for ( i=0; i<cm->numattrsets; i++ ) {
4750 free( qm->attr_sets[i].attrs );
4752 free( qm->attr_sets );
4753 qm->attr_sets = NULL;
4755 #ifdef PCACHE_MONITOR
4756 if ( rc == LDAP_SUCCESS ) {
4757 rc = pcache_monitor_db_close( be );
4759 #endif /* PCACHE_MONITOR */
4770 slap_overinst *on = (slap_overinst *)be->bd_info;
4771 cache_manager *cm = on->on_bi.bi_private;
4772 query_manager *qm = cm->qm;
4774 if ( cm->db.be_private != NULL ) {
4775 backend_stopdown_one( &cm->db );
4778 ldap_pvt_thread_mutex_destroy( &qm->lru_mutex );
4779 ldap_pvt_thread_mutex_destroy( &cm->cache_mutex );
4783 #ifdef PCACHE_MONITOR
4784 pcache_monitor_db_destroy( be );
4785 #endif /* PCACHE_MONITOR */
4790 #ifdef PCACHE_CONTROL_PRIVDB
4792 Control ::= SEQUENCE {
4793 controlType LDAPOID,
4794 criticality BOOLEAN DEFAULT FALSE,
4795 controlValue OCTET STRING OPTIONAL }
4797 controlType ::= 1.3.6.1.4.1.4203.666.11.9.5.1
4799 * criticality must be TRUE; controlValue must be absent.
4807 if ( op->o_ctrlflag[ privDB_cid ] != SLAP_CONTROL_NONE ) {
4808 rs->sr_text = "privateDB control specified multiple times";
4809 return LDAP_PROTOCOL_ERROR;
4812 if ( !BER_BVISNULL( &ctrl->ldctl_value ) ) {
4813 rs->sr_text = "privateDB control value not absent";
4814 return LDAP_PROTOCOL_ERROR;
4817 if ( !ctrl->ldctl_iscritical ) {
4818 rs->sr_text = "privateDB control criticality required";
4819 return LDAP_PROTOCOL_ERROR;
4822 op->o_ctrlflag[ privDB_cid ] = SLAP_CONTROL_CRITICAL;
4824 return LDAP_SUCCESS;
4827 static char *extops[] = {
4828 LDAP_EXOP_MODIFY_PASSWD,
4831 #endif /* PCACHE_CONTROL_PRIVDB */
4833 static struct berval pcache_exop_MODIFY_PASSWD = BER_BVC( LDAP_EXOP_MODIFY_PASSWD );
4834 #ifdef PCACHE_EXOP_QUERY_DELETE
4835 static struct berval pcache_exop_QUERY_DELETE = BER_BVC( PCACHE_EXOP_QUERY_DELETE );
4837 #define LDAP_TAG_EXOP_QUERY_DELETE_BASE ((LBER_CLASS_CONTEXT|LBER_CONSTRUCTED) + 0)
4838 #define LDAP_TAG_EXOP_QUERY_DELETE_DN ((LBER_CLASS_CONTEXT|LBER_CONSTRUCTED) + 1)
4839 #define LDAP_TAG_EXOP_QUERY_DELETE_UUID ((LBER_CLASS_CONTEXT|LBER_CONSTRUCTED) + 2)
4842 ExtendedRequest ::= [APPLICATION 23] SEQUENCE {
4843 requestName [0] LDAPOID,
4844 requestValue [1] OCTET STRING OPTIONAL }
4846 requestName ::= 1.3.6.1.4.1.4203.666.11.9.6.1
4848 requestValue ::= SEQUENCE { CHOICE {
4850 entryDN [1] LDAPDN },
4851 queryID [2] OCTET STRING (SIZE(16))
4852 -- constrained to UUID }
4854 * Either baseDN or entryDN must be present, to allow database selection.
4856 * 1. if baseDN and queryID are present, then the query corresponding
4857 * to queryID is deleted;
4858 * 2. if baseDN is present and queryID is absent, then all queries
4860 * 3. if entryDN is present and queryID is absent, then all queries
4861 * corresponding to the queryID values present in entryDN are deleted;
4862 * 4. if entryDN and queryID are present, then all queries
4863 * corresponding to the queryID values present in entryDN are deleted,
4864 * but only if the value of queryID is contained in the entry;
4866 * Currently, only 1, 3 and 4 are implemented. 2 can be obtained by either
4867 * recursively deleting the database (ldapdelete -r) with PRIVDB control,
4868 * or by removing the database files.
4870 ExtendedResponse ::= [APPLICATION 24] SEQUENCE {
4871 COMPONENTS OF LDAPResult,
4872 responseName [10] LDAPOID OPTIONAL,
4873 responseValue [11] OCTET STRING OPTIONAL }
4875 * responseName and responseValue must be absent.
4879 * - on success, *tagp is either LDAP_TAG_EXOP_QUERY_DELETE_BASE
4880 * or LDAP_TAG_EXOP_QUERY_DELETE_DN.
4881 * - if ndn != NULL, it is set to the normalized DN in the request
4882 * corresponding to either the baseDN or the entryDN, according
4883 * to *tagp; memory is malloc'ed on the Operation's slab, and must
4884 * be freed by the caller.
4885 * - if uuid != NULL, it is set to point to the normalized UUID;
4886 * memory is malloc'ed on the Operation's slab, and must
4887 * be freed by the caller.
4890 pcache_parse_query_delete(
4894 struct berval *uuid,
4898 int rc = LDAP_SUCCESS;
4901 BerElementBuffer berbuf;
4902 BerElement *ber = (BerElement *)&berbuf;
4903 struct berval reqdata = BER_BVNULL;
4915 if ( in == NULL || in->bv_len == 0 ) {
4916 *text = "empty request data field in queryDelete exop";
4917 return LDAP_PROTOCOL_ERROR;
4920 ber_dupbv_x( &reqdata, in, ctx );
4922 /* ber_init2 uses reqdata directly, doesn't allocate new buffers */
4923 ber_init2( ber, &reqdata, 0 );
4925 tag = ber_scanf( ber, "{" /*}*/ );
4927 if ( tag == LBER_ERROR ) {
4928 Debug( LDAP_DEBUG_TRACE,
4929 "pcache_parse_query_delete: decoding error.\n",
4931 goto decoding_error;
4934 tag = ber_peek_tag( ber, &len );
4935 if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_BASE
4936 || tag == LDAP_TAG_EXOP_QUERY_DELETE_DN )
4940 if ( ndn != NULL ) {
4943 tag = ber_scanf( ber, "m", &dn );
4944 if ( tag == LBER_ERROR ) {
4945 Debug( LDAP_DEBUG_TRACE,
4946 "pcache_parse_query_delete: DN parse failed.\n",
4948 goto decoding_error;
4951 rc = dnNormalize( 0, NULL, NULL, &dn, ndn, ctx );
4952 if ( rc != LDAP_SUCCESS ) {
4953 *text = "invalid DN in queryDelete exop request data";
4958 tag = ber_scanf( ber, "x" /* "m" */ );
4959 if ( tag == LBER_DEFAULT ) {
4960 goto decoding_error;
4964 tag = ber_peek_tag( ber, &len );
4967 if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_UUID ) {
4968 if ( uuid != NULL ) {
4970 char uuidbuf[ LDAP_LUTIL_UUIDSTR_BUFSIZE ];
4972 tag = ber_scanf( ber, "m", &bv );
4973 if ( tag == LBER_ERROR ) {
4974 Debug( LDAP_DEBUG_TRACE,
4975 "pcache_parse_query_delete: UUID parse failed.\n",
4977 goto decoding_error;
4980 if ( bv.bv_len != 16 ) {
4981 Debug( LDAP_DEBUG_TRACE,
4982 "pcache_parse_query_delete: invalid UUID length %lu.\n",
4983 (unsigned long)bv.bv_len, 0, 0 );
4984 goto decoding_error;
4987 rc = lutil_uuidstr_from_normalized(
4988 bv.bv_val, bv.bv_len,
4989 uuidbuf, sizeof( uuidbuf ) );
4991 goto decoding_error;
4993 ber_str2bv( uuidbuf, rc, 1, uuid );
4997 tag = ber_skip_tag( ber, &len );
4998 if ( tag == LBER_DEFAULT ) {
4999 goto decoding_error;
5003 Debug( LDAP_DEBUG_TRACE,
5004 "pcache_parse_query_delete: invalid UUID length %lu.\n",
5005 (unsigned long)len, 0, 0 );
5006 goto decoding_error;
5010 tag = ber_peek_tag( ber, &len );
5013 if ( tag != LBER_DEFAULT || len != 0 ) {
5015 Debug( LDAP_DEBUG_TRACE,
5016 "pcache_parse_query_delete: decoding error\n",
5018 rc = LDAP_PROTOCOL_ERROR;
5019 *text = "queryDelete data decoding error";
5022 if ( ndn && !BER_BVISNULL( ndn ) ) {
5023 slap_sl_free( ndn->bv_val, ctx );
5027 if ( uuid && !BER_BVISNULL( uuid ) ) {
5028 slap_sl_free( uuid->bv_val, ctx );
5033 if ( !BER_BVISNULL( &reqdata ) ) {
5034 ber_memfree_x( reqdata.bv_val, ctx );
5041 pcache_exop_query_delete(
5045 BackendDB *bd = op->o_bd;
5047 struct berval uuid = BER_BVNULL,
5049 char buf[ SLAP_TEXT_BUFLEN ];
5051 ber_tag_t tag = LBER_DEFAULT;
5053 if ( LogTest( LDAP_DEBUG_STATS ) ) {
5057 rs->sr_err = pcache_parse_query_delete( op->ore_reqdata,
5058 &tag, &op->o_req_ndn, uuidp,
5059 &rs->sr_text, op->o_tmpmemctx );
5060 if ( rs->sr_err != LDAP_SUCCESS ) {
5064 if ( LogTest( LDAP_DEBUG_STATS ) ) {
5065 assert( !BER_BVISNULL( &op->o_req_ndn ) );
5066 len = snprintf( buf, sizeof( buf ), " dn=\"%s\"", op->o_req_ndn.bv_val );
5068 if ( !BER_BVISNULL( &uuid ) && len < sizeof( buf ) ) {
5069 snprintf( &buf[ len ], sizeof( buf ) - len, " pcacheQueryId=\"%s\"", uuid.bv_val );
5072 Debug( LDAP_DEBUG_STATS, "%s QUERY DELETE%s\n",
5073 op->o_log_prefix, buf, 0 );
5075 op->o_req_dn = op->o_req_ndn;
5077 op->o_bd = select_backend( &op->o_req_ndn, 0 );
5078 rs->sr_err = backend_check_restrictions( op, rs,
5079 (struct berval *)&pcache_exop_QUERY_DELETE );
5080 if ( rs->sr_err != LDAP_SUCCESS ) {
5084 if ( op->o_bd->be_extended == NULL ) {
5085 send_ldap_error( op, rs, LDAP_UNAVAILABLE_CRITICAL_EXTENSION,
5086 "backend does not support extended operations" );
5090 op->o_bd->be_extended( op, rs );
5093 if ( !BER_BVISNULL( &op->o_req_ndn ) ) {
5094 op->o_tmpfree( op->o_req_ndn.bv_val, op->o_tmpmemctx );
5095 BER_BVZERO( &op->o_req_ndn );
5096 BER_BVZERO( &op->o_req_dn );
5099 if ( !BER_BVISNULL( &uuid ) ) {
5100 op->o_tmpfree( uuid.bv_val, op->o_tmpmemctx );
5107 #endif /* PCACHE_EXOP_QUERY_DELETE */
5110 pcache_op_extended( Operation *op, SlapReply *rs )
5112 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
5113 cache_manager *cm = on->on_bi.bi_private;
5115 #ifdef PCACHE_CONTROL_PRIVDB
5116 if ( op->o_ctrlflag[ privDB_cid ] == SLAP_CONTROL_CRITICAL ) {
5117 return pcache_op_privdb( op, rs );
5119 #endif /* PCACHE_CONTROL_PRIVDB */
5121 #ifdef PCACHE_EXOP_QUERY_DELETE
5122 if ( bvmatch( &op->ore_reqoid, &pcache_exop_QUERY_DELETE ) ) {
5123 struct berval uuid = BER_BVNULL;
5124 ber_tag_t tag = LBER_DEFAULT;
5126 rs->sr_err = pcache_parse_query_delete( op->ore_reqdata,
5127 &tag, NULL, &uuid, &rs->sr_text, op->o_tmpmemctx );
5128 assert( rs->sr_err == LDAP_SUCCESS );
5130 if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_DN ) {
5131 /* remove all queries related to the selected entry */
5132 rs->sr_err = pcache_remove_entry_queries_from_cache( op,
5133 cm, &op->o_req_ndn, &uuid );
5135 } else if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_BASE ) {
5136 if ( !BER_BVISNULL( &uuid ) ) {
5137 /* remove the selected query */
5138 rs->sr_err = pcache_remove_query_from_cache( op,
5142 /* TODO: remove all queries */
5143 rs->sr_err = LDAP_UNWILLING_TO_PERFORM;
5144 rs->sr_text = "deletion of all queries not implemented";
5148 op->o_tmpfree( uuid.bv_val, op->o_tmpmemctx );
5151 #endif /* PCACHE_EXOP_QUERY_DELETE */
5153 /* We only care if we're configured for Bind caching */
5154 if ( bvmatch( &op->ore_reqoid, &pcache_exop_MODIFY_PASSWD ) &&
5156 /* See if the local entry exists and has a password.
5157 * It's too much work to find the matching query, so
5158 * we just see if there's a hashed password to update.
5160 Operation op2 = *op;
5166 op2.o_dn = op->o_bd->be_rootdn;
5167 op2.o_ndn = op->o_bd->be_rootndn;
5168 rc = be_entry_get_rw( &op2, &op->o_req_ndn, NULL,
5169 slap_schema.si_ad_userPassword, 0, &e );
5170 if ( rc == LDAP_SUCCESS && e ) {
5171 /* See if a recognized password is hashed here */
5172 Attribute *a = attr_find( e->e_attrs,
5173 slap_schema.si_ad_userPassword );
5174 if ( a && a->a_vals[0].bv_val[0] == '{' &&
5175 lutil_passwd_scheme( a->a_vals[0].bv_val )) {
5178 be_entry_release_r( &op2, e );
5182 rc = overlay_op_walk( op, rs, op_extended, on->on_info,
5184 if ( rc == LDAP_SUCCESS ) {
5185 req_pwdexop_s *qpw = &op->oq_pwdexop;
5187 /* We don't care if it succeeds or not */
5188 pc_setpw( &op2, &qpw->rs_new, cm );
5193 return SLAP_CB_CONTINUE;
5196 #ifdef PCACHE_MONITOR
5199 pcache_monitor_update(
5205 cache_manager *cm = (cache_manager *) priv;
5206 query_manager *qm = cm->qm;
5209 BerVarray vals = NULL;
5211 attr_delete( &e->e_attrs, ad_cachedQueryURL );
5212 if ( ( SLAP_OPATTRS( rs->sr_attr_flags ) || ad_inlist( ad_cachedQueryURL, rs->sr_attrs ) )
5213 && qm->templates != NULL )
5217 for ( tm = qm->templates; tm != NULL; tm = tm->qmnext ) {
5218 for ( qc = tm->query; qc; qc = qc->next ) {
5221 if ( query2url( op, qc, &bv, 1 ) == 0 ) {
5222 ber_bvarray_add_x( &vals, &bv, op->o_tmpmemctx );
5228 if ( vals != NULL ) {
5229 attr_merge_normalize( e, ad_cachedQueryURL, vals, NULL );
5230 ber_bvarray_free_x( vals, op->o_tmpmemctx );
5236 char buf[ SLAP_TEXT_BUFLEN ];
5239 /* number of cached queries */
5240 a = attr_find( e->e_attrs, ad_numQueries );
5241 assert( a != NULL );
5244 bv.bv_len = snprintf( buf, sizeof( buf ), "%lu", cm->num_cached_queries );
5246 if ( a->a_nvals != a->a_vals ) {
5247 ber_bvreplace( &a->a_nvals[ 0 ], &bv );
5249 ber_bvreplace( &a->a_vals[ 0 ], &bv );
5251 /* number of cached entries */
5252 a = attr_find( e->e_attrs, ad_numEntries );
5253 assert( a != NULL );
5256 bv.bv_len = snprintf( buf, sizeof( buf ), "%d", cm->cur_entries );
5258 if ( a->a_nvals != a->a_vals ) {
5259 ber_bvreplace( &a->a_nvals[ 0 ], &bv );
5261 ber_bvreplace( &a->a_vals[ 0 ], &bv );
5264 return SLAP_CB_CONTINUE;
5268 pcache_monitor_free(
5272 struct berval values[ 2 ];
5273 Modification mod = { 0 };
5276 char textbuf[ SLAP_TEXT_BUFLEN ];
5280 /* NOTE: if slap_shutdown != 0, priv might have already been freed */
5283 /* Remove objectClass */
5284 mod.sm_op = LDAP_MOD_DELETE;
5285 mod.sm_desc = slap_schema.si_ad_objectClass;
5286 mod.sm_values = values;
5288 values[ 0 ] = oc_olmPCache->soc_cname;
5289 BER_BVZERO( &values[ 1 ] );
5291 rc = modify_delete_values( e, &mod, 1, &text,
5292 textbuf, sizeof( textbuf ) );
5293 /* don't care too much about return code... */
5296 mod.sm_values = NULL;
5297 mod.sm_desc = ad_cachedQueryURL;
5299 rc = modify_delete_values( e, &mod, 1, &text,
5300 textbuf, sizeof( textbuf ) );
5301 /* don't care too much about return code... */
5304 mod.sm_values = NULL;
5305 mod.sm_desc = ad_numQueries;
5307 rc = modify_delete_values( e, &mod, 1, &text,
5308 textbuf, sizeof( textbuf ) );
5309 /* don't care too much about return code... */
5312 mod.sm_values = NULL;
5313 mod.sm_desc = ad_numEntries;
5315 rc = modify_delete_values( e, &mod, 1, &text,
5316 textbuf, sizeof( textbuf ) );
5317 /* don't care too much about return code... */
5319 return SLAP_CB_CONTINUE;
5323 * call from within pcache_initialize()
5326 pcache_monitor_initialize( void )
5328 static int pcache_monitor_initialized = 0;
5330 if ( backend_info( "monitor" ) == NULL ) {
5334 if ( pcache_monitor_initialized++ ) {
5342 pcache_monitor_db_init( BackendDB *be )
5344 if ( pcache_monitor_initialize() == LDAP_SUCCESS ) {
5345 SLAP_DBFLAGS( be ) |= SLAP_DBFLAG_MONITORING;
5352 pcache_monitor_db_open( BackendDB *be )
5354 slap_overinst *on = (slap_overinst *)be->bd_info;
5355 cache_manager *cm = on->on_bi.bi_private;
5356 Attribute *a, *next;
5357 monitor_callback_t *cb = NULL;
5360 monitor_extra_t *mbe;
5361 struct berval dummy = BER_BVC( "" );
5363 if ( !SLAP_DBMONITORING( be ) ) {
5367 mi = backend_info( "monitor" );
5368 if ( !mi || !mi->bi_extra ) {
5369 SLAP_DBFLAGS( be ) ^= SLAP_DBFLAG_MONITORING;
5374 /* don't bother if monitor is not configured */
5375 if ( !mbe->is_configured() ) {
5376 static int warning = 0;
5378 if ( warning++ == 0 ) {
5379 Debug( LDAP_DEBUG_ANY, "pcache_monitor_db_open: "
5380 "monitoring disabled; "
5381 "configure monitor database to enable\n",
5388 /* alloc as many as required (plus 1 for objectClass) */
5389 a = attrs_alloc( 1 + 2 );
5395 a->a_desc = slap_schema.si_ad_objectClass;
5396 attr_valadd( a, &oc_olmPCache->soc_cname, NULL, 1 );
5400 struct berval bv = BER_BVC( "0" );
5402 next->a_desc = ad_numQueries;
5403 attr_valadd( next, &bv, NULL, 1 );
5404 next = next->a_next;
5406 next->a_desc = ad_numEntries;
5407 attr_valadd( next, &bv, NULL, 1 );
5408 next = next->a_next;
5411 cb = ch_calloc( sizeof( monitor_callback_t ), 1 );
5412 cb->mc_update = pcache_monitor_update;
5413 cb->mc_free = pcache_monitor_free;
5414 cb->mc_private = (void *)cm;
5416 /* make sure the database is registered; then add monitor attributes */
5417 BER_BVZERO( &cm->monitor_ndn );
5418 rc = mbe->register_overlay( be, on, &cm->monitor_ndn );
5420 rc = mbe->register_entry_attrs( &cm->monitor_ndn, a, cb,
5421 &dummy, -1, &dummy);
5437 /* store for cleanup */
5438 cm->monitor_cb = (void *)cb;
5440 /* we don't need to keep track of the attributes, because
5441 * bdb_monitor_free() takes care of everything */
5450 pcache_monitor_db_close( BackendDB *be )
5452 slap_overinst *on = (slap_overinst *)be->bd_info;
5453 cache_manager *cm = on->on_bi.bi_private;
5455 if ( cm->monitor_cb != NULL ) {
5456 BackendInfo *mi = backend_info( "monitor" );
5457 monitor_extra_t *mbe;
5459 if ( mi && &mi->bi_extra ) {
5461 mbe->unregister_entry_callback( NULL,
5462 (monitor_callback_t *)cm->monitor_cb,
5471 pcache_monitor_db_destroy( BackendDB *be )
5476 #endif /* PCACHE_MONITOR */
5478 static slap_overinst pcache;
5480 static char *obsolete_names[] = {
5485 #if SLAPD_OVER_PROXYCACHE == SLAPD_MOD_DYNAMIC
5487 #endif /* SLAPD_OVER_PROXYCACHE == SLAPD_MOD_DYNAMIC */
5492 struct berval debugbv = BER_BVC("pcache");
5496 code = slap_loglevel_get( &debugbv, &pcache_debug );
5501 #ifdef PCACHE_CONTROL_PRIVDB
5502 code = register_supported_control( PCACHE_CONTROL_PRIVDB,
5503 SLAP_CTRL_BIND|SLAP_CTRL_ACCESS|SLAP_CTRL_HIDE, extops,
5504 parse_privdb_ctrl, &privDB_cid );
5505 if ( code != LDAP_SUCCESS ) {
5506 Debug( LDAP_DEBUG_ANY,
5507 "pcache_initialize: failed to register control %s (%d)\n",
5508 PCACHE_CONTROL_PRIVDB, code, 0 );
5511 #endif /* PCACHE_CONTROL_PRIVDB */
5513 #ifdef PCACHE_EXOP_QUERY_DELETE
5514 code = load_extop2( (struct berval *)&pcache_exop_QUERY_DELETE,
5515 SLAP_EXOP_WRITES|SLAP_EXOP_HIDE, pcache_exop_query_delete,
5517 if ( code != LDAP_SUCCESS ) {
5518 Debug( LDAP_DEBUG_ANY,
5519 "pcache_initialize: unable to register queryDelete exop: %d.\n",
5523 #endif /* PCACHE_EXOP_QUERY_DELETE */
5525 argv[ 0 ] = "back-bdb/back-hdb monitor";
5530 for ( i = 0; s_oid[ i ].name; i++ ) {
5532 argv[ 1 ] = s_oid[ i ].name;
5533 argv[ 2 ] = s_oid[ i ].oid;
5535 if ( parse_oidm( &c, 0, NULL ) != 0 ) {
5536 Debug( LDAP_DEBUG_ANY, "pcache_initialize: "
5537 "unable to add objectIdentifier \"%s=%s\"\n",
5538 s_oid[ i ].name, s_oid[ i ].oid, 0 );
5543 for ( i = 0; s_ad[i].desc != NULL; i++ ) {
5544 code = register_at( s_ad[i].desc, s_ad[i].adp, 0 );
5546 Debug( LDAP_DEBUG_ANY,
5547 "pcache_initialize: register_at #%d failed\n", i, 0, 0 );
5550 (*s_ad[i].adp)->ad_type->sat_flags |= SLAP_AT_HIDE;
5553 for ( i = 0; s_oc[i].desc != NULL; i++ ) {
5554 code = register_oc( s_oc[i].desc, s_oc[i].ocp, 0 );
5556 Debug( LDAP_DEBUG_ANY,
5557 "pcache_initialize: register_oc #%d failed\n", i, 0, 0 );
5560 (*s_oc[i].ocp)->soc_flags |= SLAP_OC_HIDE;
5563 pcache.on_bi.bi_type = "pcache";
5564 pcache.on_bi.bi_obsolete_names = obsolete_names;
5565 pcache.on_bi.bi_db_init = pcache_db_init;
5566 pcache.on_bi.bi_db_config = pcache_db_config;
5567 pcache.on_bi.bi_db_open = pcache_db_open;
5568 pcache.on_bi.bi_db_close = pcache_db_close;
5569 pcache.on_bi.bi_db_destroy = pcache_db_destroy;
5571 pcache.on_bi.bi_op_search = pcache_op_search;
5572 pcache.on_bi.bi_op_bind = pcache_op_bind;
5573 #ifdef PCACHE_CONTROL_PRIVDB
5574 pcache.on_bi.bi_op_compare = pcache_op_privdb;
5575 pcache.on_bi.bi_op_modrdn = pcache_op_privdb;
5576 pcache.on_bi.bi_op_modify = pcache_op_privdb;
5577 pcache.on_bi.bi_op_add = pcache_op_privdb;
5578 pcache.on_bi.bi_op_delete = pcache_op_privdb;
5579 #endif /* PCACHE_CONTROL_PRIVDB */
5580 pcache.on_bi.bi_extended = pcache_op_extended;
5582 pcache.on_bi.bi_chk_controls = pcache_chk_controls;
5584 pcache.on_bi.bi_cf_ocs = pcocs;
5586 code = config_register_schema( pccfg, pcocs );
5587 if ( code ) return code;
5589 return overlay_register( &pcache );
5592 #if SLAPD_OVER_PROXYCACHE == SLAPD_MOD_DYNAMIC
5593 int init_module(int argc, char *argv[]) {
5594 return pcache_initialize();
5598 #endif /* defined(SLAPD_OVER_PROXYCACHE) */