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_managedsait = SLAP_CONTROL_CRITICAL;
866 op->o_bd->be_modify( op, &sreply );
867 slap_mods_free( modlist, 1 );
868 } else if ( rc == LDAP_REFERRAL ||
869 rc == LDAP_NO_SUCH_OBJECT ) {
870 syncrepl_add_glue( op, e );
879 if ( op->ora_e == e )
880 be_entry_release_w( op, e );
887 /* Length-ordered sort on normalized DNs */
888 static int pcache_dn_cmp( const void *v1, const void *v2 )
890 const Qbase *q1 = v1, *q2 = v2;
892 int rc = q1->base.bv_len - q2->base.bv_len;
894 rc = strncmp( q1->base.bv_val, q2->base.bv_val, q1->base.bv_len );
898 static int lex_bvcmp( struct berval *bv1, struct berval *bv2 )
901 dif = bv1->bv_len - bv2->bv_len;
903 if ( dif > 0 ) len -= dif;
904 len = memcmp( bv1->bv_val, bv2->bv_val, len );
910 /* compare the current value in each filter */
911 static int pcache_filter_cmp( Filter *f1, Filter *f2 )
913 int rc, weight1, weight2;
915 switch( f1->f_choice ) {
916 case LDAP_FILTER_PRESENT:
919 case LDAP_FILTER_EQUALITY:
927 switch( f2->f_choice ) {
928 case LDAP_FILTER_PRESENT:
931 case LDAP_FILTER_EQUALITY:
939 rc = weight1 - weight2;
945 rc = lex_bvcmp( &f1->f_av_value, &f2->f_av_value );
948 if ( f1->f_choice == LDAP_FILTER_SUBSTRINGS ) {
950 if ( !BER_BVISNULL( &f1->f_sub_initial )) {
951 if ( !BER_BVISNULL( &f2->f_sub_initial )) {
952 rc = lex_bvcmp( &f1->f_sub_initial,
953 &f2->f_sub_initial );
957 } else if ( !BER_BVISNULL( &f2->f_sub_initial )) {
961 if ( f1->f_sub_any ) {
962 if ( f2->f_sub_any ) {
963 rc = lex_bvcmp( f1->f_sub_any,
968 } else if ( f2->f_sub_any ) {
972 if ( !BER_BVISNULL( &f1->f_sub_final )) {
973 if ( !BER_BVISNULL( &f2->f_sub_final )) {
974 rc = lex_bvcmp( &f1->f_sub_final,
979 } else if ( !BER_BVISNULL( &f2->f_sub_final )) {
983 rc = lex_bvcmp( &f1->f_mr_value,
997 while ( f1->f_choice == LDAP_FILTER_AND || f1->f_choice == LDAP_FILTER_OR )
999 while ( f2->f_choice == LDAP_FILTER_AND || f2->f_choice == LDAP_FILTER_OR )
1001 rc = pcache_filter_cmp( f1, f2 );
1009 /* compare filters in each query */
1010 static int pcache_query_cmp( const void *v1, const void *v2 )
1012 const CachedQuery *q1 = v1, *q2 =v2;
1013 return pcache_filter_cmp( q1->first, q2->first );
1016 /* add query on top of LRU list */
1018 add_query_on_top (query_manager* qm, CachedQuery* qc)
1020 CachedQuery* top = qm->lru_top;
1027 qm->lru_bottom = qc;
1031 Debug( pcache_debug, "Base of added query = %s\n",
1032 qc->qbase->base.bv_val, 0, 0 );
1035 /* remove_query from LRU list */
1038 remove_query (query_manager* qm, CachedQuery* qc)
1047 down = qc->lru_down;
1053 qm->lru_bottom = up;
1059 up->lru_down = down;
1061 qc->lru_up = qc->lru_down = NULL;
1064 /* find and remove string2 from string1
1065 * from start if position = 1,
1066 * from end if position = 3,
1067 * from anywhere if position = 2
1068 * string1 is overwritten if position = 2.
1072 find_and_remove(struct berval* ber1, struct berval* ber2, int position)
1076 if ( !ber2->bv_val )
1078 if ( !ber1->bv_val )
1081 switch( position ) {
1083 if ( ber1->bv_len >= ber2->bv_len && !memcmp( ber1->bv_val,
1084 ber2->bv_val, ber2->bv_len )) {
1086 ber1->bv_val += ber2->bv_len;
1087 ber1->bv_len -= ber2->bv_len;
1092 ber1->bv_val[ber1->bv_len] = '\0';
1093 temp = strstr( ber1->bv_val, ber2->bv_val );
1095 strcpy( temp, temp+ber2->bv_len );
1096 ber1->bv_len -= ber2->bv_len;
1102 if ( ber1->bv_len >= ber2->bv_len &&
1103 !memcmp( ber1->bv_val+ber1->bv_len-ber2->bv_len, ber2->bv_val,
1106 ber1->bv_len -= ber2->bv_len;
1114 static struct berval*
1115 merge_init_final(Operation *op, struct berval* init, struct berval* any,
1116 struct berval* final)
1118 struct berval* merged, *temp;
1119 int i, any_count, count;
1121 for (any_count=0; any && any[any_count].bv_val; any_count++)
1131 merged = (struct berval*)op->o_tmpalloc( (count+1)*sizeof(struct berval),
1136 ber_dupbv_x( temp, init, op->o_tmpmemctx );
1140 for (i=0; i<any_count; i++) {
1141 ber_dupbv_x( temp, any, op->o_tmpmemctx );
1146 ber_dupbv_x( temp, final, op->o_tmpmemctx );
1153 /* Each element in stored must be found in incoming. Incoming is overwritten.
1156 strings_containment(struct berval* stored, struct berval* incoming)
1158 struct berval* element;
1162 for ( element=stored; element->bv_val != NULL; element++ ) {
1163 for (j = k; incoming[j].bv_val != NULL; j++) {
1164 if (find_and_remove(&(incoming[j]), element, 2)) {
1181 substr_containment_substr(Operation *op, Filter* stored, Filter* incoming)
1185 struct berval init_incoming;
1186 struct berval final_incoming;
1187 struct berval *remaining_incoming = NULL;
1189 if ((!(incoming->f_sub_initial.bv_val) && (stored->f_sub_initial.bv_val))
1190 || (!(incoming->f_sub_final.bv_val) && (stored->f_sub_final.bv_val)))
1193 init_incoming = incoming->f_sub_initial;
1194 final_incoming = incoming->f_sub_final;
1196 if (find_and_remove(&init_incoming,
1197 &(stored->f_sub_initial), 1) && find_and_remove(&final_incoming,
1198 &(stored->f_sub_final), 3))
1200 if (stored->f_sub_any == NULL) {
1204 remaining_incoming = merge_init_final(op, &init_incoming,
1205 incoming->f_sub_any, &final_incoming);
1206 rc = strings_containment(stored->f_sub_any, remaining_incoming);
1207 ber_bvarray_free_x( remaining_incoming, op->o_tmpmemctx );
1214 substr_containment_equality(Operation *op, Filter* stored, Filter* incoming)
1216 struct berval incoming_val[2];
1219 incoming_val[1] = incoming->f_av_value;
1221 if (find_and_remove(incoming_val+1,
1222 &(stored->f_sub_initial), 1) && find_and_remove(incoming_val+1,
1223 &(stored->f_sub_final), 3)) {
1224 if (stored->f_sub_any == NULL){
1228 ber_dupbv_x( incoming_val, incoming_val+1, op->o_tmpmemctx );
1229 BER_BVZERO( incoming_val+1 );
1230 rc = strings_containment(stored->f_sub_any, incoming_val);
1231 op->o_tmpfree( incoming_val[0].bv_val, op->o_tmpmemctx );
1238 filter_first( Filter *f )
1240 while ( f->f_choice == LDAP_FILTER_OR || f->f_choice == LDAP_FILTER_AND )
1246 static CachedQuery *
1247 find_filter( Operation *op, Avlnode *root, Filter *inputf, Filter *first )
1251 MatchingRule* mrule = NULL;
1252 int res=0, eqpass= 0;
1255 CachedQuery cq, *qc;
1260 /* substring matches sort to the end, and we just have to
1261 * walk the entire list.
1263 if ( first->f_choice == LDAP_FILTER_SUBSTRINGS ) {
1264 ptr = tavl_end( root, 1 );
1265 dir = TAVL_DIR_LEFT;
1267 ptr = tavl_find3( root, &cq, pcache_query_cmp, &ret );
1268 dir = (first->f_choice == LDAP_FILTER_GE) ? TAVL_DIR_LEFT :
1277 /* an incoming substr query can only be satisfied by a cached
1280 if ( first->f_choice == LDAP_FILTER_SUBSTRINGS &&
1281 qc->first->f_choice != LDAP_FILTER_SUBSTRINGS )
1284 /* an incoming eq query can be satisfied by a cached eq or substr
1287 if ( first->f_choice == LDAP_FILTER_EQUALITY ) {
1288 if ( eqpass == 0 ) {
1289 if ( qc->first->f_choice != LDAP_FILTER_EQUALITY ) {
1290 nextpass: eqpass = 1;
1291 ptr = tavl_end( root, 1 );
1292 dir = TAVL_DIR_LEFT;
1296 if ( qc->first->f_choice != LDAP_FILTER_SUBSTRINGS )
1302 switch (fs->f_choice) {
1303 case LDAP_FILTER_EQUALITY:
1304 if (fi->f_choice == LDAP_FILTER_EQUALITY)
1305 mrule = fs->f_ava->aa_desc->ad_type->sat_equality;
1309 case LDAP_FILTER_GE:
1310 case LDAP_FILTER_LE:
1311 mrule = fs->f_ava->aa_desc->ad_type->sat_ordering;
1318 rc = value_match(&ret, fs->f_ava->aa_desc, mrule,
1319 SLAP_MR_VALUE_OF_ASSERTION_SYNTAX,
1320 &(fi->f_ava->aa_value),
1321 &(fs->f_ava->aa_value), &text);
1322 if (rc != LDAP_SUCCESS) {
1325 if ( fi==first && fi->f_choice==LDAP_FILTER_EQUALITY && ret )
1328 switch (fs->f_choice) {
1329 case LDAP_FILTER_OR:
1330 case LDAP_FILTER_AND:
1335 case LDAP_FILTER_SUBSTRINGS:
1336 /* check if the equality query can be
1337 * answered with cached substring query */
1338 if ((fi->f_choice == LDAP_FILTER_EQUALITY)
1339 && substr_containment_equality( op,
1342 /* check if the substring query can be
1343 * answered with cached substring query */
1344 if ((fi->f_choice ==LDAP_FILTER_SUBSTRINGS
1345 ) && substr_containment_substr( op,
1351 case LDAP_FILTER_PRESENT:
1356 case LDAP_FILTER_EQUALITY:
1362 case LDAP_FILTER_GE:
1363 if (mrule && ret >= 0)
1368 case LDAP_FILTER_LE:
1369 if (mrule && ret <= 0)
1374 case LDAP_FILTER_NOT:
1380 } while((res) && (fi != NULL) && (fs != NULL));
1384 ptr = tavl_next( ptr, dir );
1389 /* check whether query is contained in any of
1390 * the cached queries in template
1392 static CachedQuery *
1393 query_containment(Operation *op, query_manager *qm,
1395 QueryTemplate *templa)
1398 int depth = 0, tscope;
1399 Qbase qbase, *qbptr = NULL;
1402 if (query->filter != NULL) {
1405 Debug( pcache_debug, "Lock QC index = %p\n",
1406 (void *) templa, 0, 0 );
1407 qbase.base = query->base;
1409 first = filter_first( query->filter );
1411 ldap_pvt_thread_rdwr_rlock(&templa->t_rwlock);
1414 qbptr = avl_find( templa->qbase, &qbase, pcache_dn_cmp );
1416 tscope = query->scope;
1417 /* Find a matching scope:
1418 * match at depth 0 OK
1421 * subord at depth > 0 OK
1422 * subtree at any depth OK
1424 * subtree or subord at any depth OK
1426 * subtree or subord at any depth OK
1428 * subord at depth > 0 OK
1429 * subtree at any depth OK
1431 for ( tscope = 0 ; tscope <= LDAP_SCOPE_CHILDREN; tscope++ ) {
1432 switch ( query->scope ) {
1433 case LDAP_SCOPE_BASE:
1434 if ( tscope == LDAP_SCOPE_BASE && depth ) continue;
1435 if ( tscope == LDAP_SCOPE_ONE && depth != 1) continue;
1436 if ( tscope == LDAP_SCOPE_CHILDREN && !depth ) continue;
1438 case LDAP_SCOPE_ONE:
1439 if ( tscope == LDAP_SCOPE_BASE )
1440 tscope = LDAP_SCOPE_ONE;
1441 if ( tscope == LDAP_SCOPE_ONE && depth ) continue;
1442 if ( !depth ) break;
1443 if ( tscope < LDAP_SCOPE_SUBTREE )
1444 tscope = LDAP_SCOPE_SUBTREE;
1446 case LDAP_SCOPE_SUBTREE:
1447 if ( tscope < LDAP_SCOPE_SUBTREE )
1448 tscope = LDAP_SCOPE_SUBTREE;
1449 if ( tscope == LDAP_SCOPE_CHILDREN && !depth ) continue;
1451 case LDAP_SCOPE_CHILDREN:
1452 if ( tscope < LDAP_SCOPE_SUBTREE )
1453 tscope = LDAP_SCOPE_SUBTREE;
1456 if ( !qbptr->scopes[tscope] ) continue;
1459 qc = find_filter( op, qbptr->scopes[tscope],
1460 query->filter, first );
1462 if ( qc->q_sizelimit ) {
1463 ldap_pvt_thread_rdwr_runlock(&templa->t_rwlock);
1466 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
1467 if (qm->lru_top != qc) {
1468 remove_query(qm, qc);
1469 add_query_on_top(qm, qc);
1471 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1476 if ( be_issuffix( op->o_bd, &qbase.base ))
1479 dnParent( &qbase.base, &pdn );
1484 Debug( pcache_debug,
1485 "Not answerable: Unlock QC index=%p\n",
1486 (void *) templa, 0, 0 );
1487 ldap_pvt_thread_rdwr_runlock(&templa->t_rwlock);
1493 free_query (CachedQuery* qc)
1495 free(qc->q_uuid.bv_val);
1496 filter_free(qc->filter);
1497 ldap_pvt_thread_mutex_destroy(&qc->answerable_cnt_mutex);
1498 ldap_pvt_thread_rdwr_destroy( &qc->rwlock );
1499 memset(qc, 0, sizeof(*qc));
1504 /* Add query to query cache, the returned Query is locked for writing */
1505 static CachedQuery *
1510 QueryTemplate *templ,
1511 pc_caching_reason_t why,
1514 CachedQuery* new_cached_query = (CachedQuery*) ch_malloc(sizeof(CachedQuery));
1518 time_t ttl = 0, ttr = 0;
1521 new_cached_query->qtemp = templ;
1522 BER_BVZERO( &new_cached_query->q_uuid );
1523 new_cached_query->q_sizelimit = 0;
1525 now = slap_get_time();
1530 ttr = now + templ->ttr;
1534 ttl = templ->negttl;
1538 ttl = templ->limitttl;
1545 new_cached_query->expiry_time = now + ttl;
1546 new_cached_query->refresh_time = ttr;
1548 new_cached_query->answerable_cnt = 0;
1549 new_cached_query->refcnt = 1;
1550 ldap_pvt_thread_mutex_init(&new_cached_query->answerable_cnt_mutex);
1552 new_cached_query->lru_up = NULL;
1553 new_cached_query->lru_down = NULL;
1554 Debug( pcache_debug, "Added query expires at %ld (%s)\n",
1555 (long) new_cached_query->expiry_time,
1556 pc_caching_reason_str[ why ], 0 );
1558 new_cached_query->scope = query->scope;
1559 new_cached_query->filter = query->filter;
1560 new_cached_query->first = first = filter_first( query->filter );
1562 ldap_pvt_thread_rdwr_init(&new_cached_query->rwlock);
1564 ldap_pvt_thread_rdwr_wlock(&new_cached_query->rwlock);
1566 qb.base = query->base;
1568 /* Adding a query */
1569 Debug( pcache_debug, "Lock AQ index = %p\n",
1570 (void *) templ, 0, 0 );
1571 ldap_pvt_thread_rdwr_wlock(&templ->t_rwlock);
1572 qbase = avl_find( templ->qbase, &qb, pcache_dn_cmp );
1574 qbase = ch_calloc( 1, sizeof(Qbase) + qb.base.bv_len + 1 );
1575 qbase->base.bv_len = qb.base.bv_len;
1576 qbase->base.bv_val = (char *)(qbase+1);
1577 memcpy( qbase->base.bv_val, qb.base.bv_val, qb.base.bv_len );
1578 qbase->base.bv_val[qbase->base.bv_len] = '\0';
1579 avl_insert( &templ->qbase, qbase, pcache_dn_cmp, avl_dup_error );
1581 new_cached_query->next = templ->query;
1582 new_cached_query->prev = NULL;
1583 new_cached_query->qbase = qbase;
1584 rc = tavl_insert( &qbase->scopes[query->scope], new_cached_query,
1585 pcache_query_cmp, avl_dup_error );
1588 if (templ->query == NULL)
1589 templ->query_last = new_cached_query;
1591 templ->query->prev = new_cached_query;
1592 templ->query = new_cached_query;
1593 templ->no_of_queries++;
1595 ch_free( new_cached_query );
1596 new_cached_query = find_filter( op, qbase->scopes[query->scope],
1597 query->filter, first );
1598 filter_free( query->filter );
1599 query->filter = NULL;
1601 Debug( pcache_debug, "TEMPLATE %p QUERIES++ %d\n",
1602 (void *) templ, templ->no_of_queries, 0 );
1604 Debug( pcache_debug, "Unlock AQ index = %p \n",
1605 (void *) templ, 0, 0 );
1606 ldap_pvt_thread_rdwr_wunlock(&templ->t_rwlock);
1608 /* Adding on top of LRU list */
1610 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
1611 add_query_on_top(qm, new_cached_query);
1612 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1614 return rc == 0 ? new_cached_query : NULL;
1618 remove_from_template (CachedQuery* qc, QueryTemplate* template)
1620 if (!qc->prev && !qc->next) {
1621 template->query_last = template->query = NULL;
1622 } else if (qc->prev == NULL) {
1623 qc->next->prev = NULL;
1624 template->query = qc->next;
1625 } else if (qc->next == NULL) {
1626 qc->prev->next = NULL;
1627 template->query_last = qc->prev;
1629 qc->next->prev = qc->prev;
1630 qc->prev->next = qc->next;
1632 tavl_delete( &qc->qbase->scopes[qc->scope], qc, pcache_query_cmp );
1633 qc->qbase->queries--;
1634 if ( qc->qbase->queries == 0 ) {
1635 avl_delete( &template->qbase, qc->qbase, pcache_dn_cmp );
1636 ch_free( qc->qbase );
1640 template->no_of_queries--;
1643 /* remove bottom query of LRU list from the query cache */
1645 * NOTE: slight change in functionality.
1647 * - if result->bv_val is NULL, the query at the bottom of the LRU
1649 * - otherwise, the query whose UUID is *result is removed
1650 * - if not found, result->bv_val is zeroed
1653 cache_replacement(query_manager* qm, struct berval *result)
1655 CachedQuery* bottom;
1656 QueryTemplate *temp;
1658 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
1659 if ( BER_BVISNULL( result ) ) {
1660 bottom = qm->lru_bottom;
1663 Debug ( pcache_debug,
1664 "Cache replacement invoked without "
1665 "any query in LRU list\n", 0, 0, 0 );
1666 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1671 for ( bottom = qm->lru_bottom;
1673 bottom = bottom->lru_up )
1675 if ( bvmatch( result, &bottom->q_uuid ) ) {
1681 Debug ( pcache_debug,
1682 "Could not find query with uuid=\"%s\""
1683 "in LRU list\n", result->bv_val, 0, 0 );
1684 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1685 BER_BVZERO( result );
1690 temp = bottom->qtemp;
1691 remove_query(qm, bottom);
1692 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1694 *result = bottom->q_uuid;
1695 BER_BVZERO( &bottom->q_uuid );
1697 Debug( pcache_debug, "Lock CR index = %p\n", (void *) temp, 0, 0 );
1698 ldap_pvt_thread_rdwr_wlock(&temp->t_rwlock);
1699 remove_from_template(bottom, temp);
1700 Debug( pcache_debug, "TEMPLATE %p QUERIES-- %d\n",
1701 (void *) temp, temp->no_of_queries, 0 );
1702 Debug( pcache_debug, "Unlock CR index = %p\n", (void *) temp, 0, 0 );
1703 ldap_pvt_thread_rdwr_wunlock(&temp->t_rwlock);
1708 struct query_info *next;
1720 struct query_info *qi;
1723 if ( rs->sr_type != REP_SEARCH ) return 0;
1725 attr = attr_find( rs->sr_entry->e_attrs, ad_queryId );
1726 if ( attr == NULL ) return 0;
1728 count = attr->a_numvals;
1729 assert( count > 0 );
1730 qi = op->o_tmpalloc( sizeof( struct query_info ), op->o_tmpmemctx );
1731 qi->next = op->o_callback->sc_private;
1732 op->o_callback->sc_private = qi;
1733 ber_dupbv_x( &qi->xdn, &rs->sr_entry->e_nname, op->o_tmpmemctx );
1734 qi->del = ( count == 1 );
1743 struct berval *query_uuid )
1745 struct query_info *qi, *qnext;
1746 char filter_str[ LDAP_LUTIL_UUIDSTR_BUFSIZE + STRLENOF( "(pcacheQueryID=)" ) ];
1747 AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
1748 Filter filter = {LDAP_FILTER_EQUALITY};
1749 SlapReply sreply = {REP_RESULT};
1750 slap_callback cb = { NULL, remove_func, NULL, NULL };
1753 sreply.sr_entry = NULL;
1754 sreply.sr_nentries = 0;
1755 op->ors_filterstr.bv_len = snprintf(filter_str, sizeof(filter_str),
1756 "(%s=%s)", ad_queryId->ad_cname.bv_val, query_uuid->bv_val);
1757 filter.f_ava = &ava;
1758 filter.f_av_desc = ad_queryId;
1759 filter.f_av_value = *query_uuid;
1761 op->o_tag = LDAP_REQ_SEARCH;
1762 op->o_protocol = LDAP_VERSION3;
1763 op->o_callback = &cb;
1764 op->o_time = slap_get_time();
1765 op->o_do_not_cache = 1;
1767 op->o_req_dn = op->o_bd->be_suffix[0];
1768 op->o_req_ndn = op->o_bd->be_nsuffix[0];
1769 op->ors_scope = LDAP_SCOPE_SUBTREE;
1770 op->ors_deref = LDAP_DEREF_NEVER;
1771 op->ors_slimit = SLAP_NO_LIMIT;
1772 op->ors_tlimit = SLAP_NO_LIMIT;
1773 op->ors_limit = NULL;
1774 op->ors_filter = &filter;
1775 op->ors_filterstr.bv_val = filter_str;
1776 op->ors_filterstr.bv_len = strlen(filter_str);
1777 op->ors_attrs = NULL;
1778 op->ors_attrsonly = 0;
1780 op->o_bd->be_search( op, &sreply );
1782 for ( qi=cb.sc_private; qi; qi=qnext ) {
1785 op->o_req_dn = qi->xdn;
1786 op->o_req_ndn = qi->xdn;
1789 Debug( pcache_debug, "DELETING ENTRY TEMPLATE=%s\n",
1790 query_uuid->bv_val, 0, 0 );
1792 op->o_tag = LDAP_REQ_DELETE;
1794 if (op->o_bd->be_delete(op, &sreply) == LDAP_SUCCESS) {
1800 struct berval vals[2];
1802 vals[0] = *query_uuid;
1803 vals[1].bv_val = NULL;
1805 mod.sml_op = LDAP_MOD_DELETE;
1807 mod.sml_desc = ad_queryId;
1808 mod.sml_type = ad_queryId->ad_cname;
1809 mod.sml_values = vals;
1810 mod.sml_nvalues = NULL;
1811 mod.sml_numvals = 1;
1812 mod.sml_next = NULL;
1813 Debug( pcache_debug,
1814 "REMOVING TEMP ATTR : TEMPLATE=%s\n",
1815 query_uuid->bv_val, 0, 0 );
1817 op->orm_modlist = &mod;
1819 op->o_bd->be_modify( op, &sreply );
1821 op->o_tmpfree( qi->xdn.bv_val, op->o_tmpmemctx );
1822 op->o_tmpfree( qi, op->o_tmpmemctx );
1829 AttributeName* attrs,
1838 struct berval *fstr )
1840 AttributeDescription *ad;
1843 switch ( f->f_choice ) {
1844 case LDAP_FILTER_EQUALITY:
1846 len = STRLENOF( "(=)" ) + ad->ad_cname.bv_len;
1847 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s=)", ad->ad_cname.bv_val );
1848 assert( ret == len );
1849 fstr->bv_len += len;
1852 case LDAP_FILTER_GE:
1854 len = STRLENOF( "(>=)" ) + ad->ad_cname.bv_len;
1855 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s>=)", ad->ad_cname.bv_val);
1856 assert( ret == len );
1857 fstr->bv_len += len;
1860 case LDAP_FILTER_LE:
1862 len = STRLENOF( "(<=)" ) + ad->ad_cname.bv_len;
1863 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s<=)", ad->ad_cname.bv_val);
1864 assert( ret == len );
1865 fstr->bv_len += len;
1868 case LDAP_FILTER_APPROX:
1870 len = STRLENOF( "(~=)" ) + ad->ad_cname.bv_len;
1871 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s~=)", ad->ad_cname.bv_val);
1872 assert( ret == len );
1873 fstr->bv_len += len;
1876 case LDAP_FILTER_SUBSTRINGS:
1878 len = STRLENOF( "(=)" ) + ad->ad_cname.bv_len;
1879 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s=)", ad->ad_cname.bv_val );
1880 assert( ret == len );
1881 fstr->bv_len += len;
1884 case LDAP_FILTER_PRESENT:
1886 len = STRLENOF( "(=*)" ) + ad->ad_cname.bv_len;
1887 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s=*)", ad->ad_cname.bv_val );
1888 assert( ret == len );
1889 fstr->bv_len += len;
1892 case LDAP_FILTER_AND:
1893 case LDAP_FILTER_OR:
1894 case LDAP_FILTER_NOT: {
1896 fstr->bv_val[fstr->bv_len++] = '(';
1897 switch ( f->f_choice ) {
1898 case LDAP_FILTER_AND:
1899 fstr->bv_val[fstr->bv_len] = '&';
1901 case LDAP_FILTER_OR:
1902 fstr->bv_val[fstr->bv_len] = '|';
1904 case LDAP_FILTER_NOT:
1905 fstr->bv_val[fstr->bv_len] = '!';
1910 for ( f = f->f_list; f != NULL; f = f->f_next ) {
1911 rc = filter2template( op, f, fstr );
1914 fstr->bv_val[fstr->bv_len++] = ')';
1915 fstr->bv_val[fstr->bv_len] = '\0';
1921 /* a filter should at least have room for "()",
1922 * an "=" and for a 1-char attr */
1923 strcpy( fstr->bv_val, "(?=)" );
1924 fstr->bv_len += STRLENOF("(?=)");
1931 #define BI_HASHED 0x01
1932 #define BI_DIDCB 0x02
1933 #define BI_LOOKUP 0x04
1937 typedef struct bindinfo {
1938 cache_manager *bi_cm;
1940 QueryTemplate *bi_templ;
1941 struct search_info *bi_si;
1943 slap_callback bi_cb;
1946 struct search_info {
1949 QueryTemplate *qtemp;
1950 AttributeName* save_attrs; /* original attributes, saved for response */
1951 int swap_saved_attrs;
1956 int slimit_exceeded;
1957 pc_caching_reason_t caching_reason;
1963 remove_query_and_data(
1967 struct berval *uuid )
1969 query_manager* qm = cm->qm;
1971 qm->crfunc( qm, uuid );
1972 if ( !BER_BVISNULL( uuid ) ) {
1975 Debug( pcache_debug,
1976 "Removing query UUID %s\n",
1977 uuid->bv_val, 0, 0 );
1978 return_val = remove_query_data( op, rs, uuid );
1979 Debug( pcache_debug,
1980 "QUERY REMOVED, SIZE=%d\n",
1982 ldap_pvt_thread_mutex_lock( &cm->cache_mutex );
1983 cm->cur_entries -= return_val;
1984 cm->num_cached_queries--;
1985 Debug( pcache_debug,
1986 "STORED QUERIES = %lu\n",
1987 cm->num_cached_queries, 0, 0 );
1988 ldap_pvt_thread_mutex_unlock( &cm->cache_mutex );
1989 Debug( pcache_debug,
1990 "QUERY REMOVED, CACHE ="
1992 cm->cur_entries, 0, 0 );
1997 * Callback used to fetch queryId values based on entryUUID;
1998 * used by pcache_remove_entries_from_cache()
2001 fetch_queryId_cb( Operation *op, SlapReply *rs )
2005 /* only care about searchEntry responses */
2006 if ( rs->sr_type != REP_SEARCH ) {
2010 /* allow only one response per entryUUID */
2011 if ( op->o_callback->sc_private != NULL ) {
2017 /* copy all queryId values into callback's private data */
2018 a = attr_find( rs->sr_entry->e_attrs, ad_queryId );
2020 BerVarray vals = NULL;
2022 ber_bvarray_dup_x( &vals, a->a_nvals, op->o_tmpmemctx );
2023 op->o_callback->sc_private = (void *)vals;
2027 /* clear entry if required */
2028 if ( rs->sr_flags & REP_ENTRY_MUSTBEFREED ) {
2029 entry_free( rs->sr_entry );
2030 rs->sr_entry = NULL;
2031 rs->sr_flags ^= REP_ENTRY_MUSTBEFREED;
2038 * Call that allows to remove a set of entries from the cache,
2039 * by forcing the removal of all the related queries.
2042 pcache_remove_entries_from_cache(
2045 BerVarray entryUUIDs )
2047 Connection conn = { 0 };
2048 OperationBuffer opbuf;
2050 slap_callback sc = { 0 };
2051 SlapReply rs = { REP_RESULT };
2053 char filtbuf[ LDAP_LUTIL_UUIDSTR_BUFSIZE + STRLENOF( "(entryUUID=)" ) ];
2054 AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
2055 AttributeName attrs[ 2 ] = {{{ 0 }}};
2059 void *thrctx = ldap_pvt_thread_pool_context();
2061 connection_fake_init( &conn, &opbuf, thrctx );
2069 memset( &op->oq_search, 0, sizeof( op->oq_search ) );
2070 op->ors_scope = LDAP_SCOPE_SUBTREE;
2071 op->ors_deref = LDAP_DEREF_NEVER;
2072 f.f_choice = LDAP_FILTER_EQUALITY;
2074 ava.aa_desc = slap_schema.si_ad_entryUUID;
2075 op->ors_filter = &f;
2077 op->ors_tlimit = SLAP_NO_LIMIT;
2078 op->ors_limit = NULL;
2079 attrs[ 0 ].an_desc = ad_queryId;
2080 attrs[ 0 ].an_name = ad_queryId->ad_cname;
2081 op->ors_attrs = attrs;
2082 op->ors_attrsonly = 0;
2084 op->o_req_dn = cm->db.be_suffix[ 0 ];
2085 op->o_req_ndn = cm->db.be_nsuffix[ 0 ];
2087 op->o_tag = LDAP_REQ_SEARCH;
2088 op->o_protocol = LDAP_VERSION3;
2089 op->o_managedsait = SLAP_CONTROL_CRITICAL;
2091 op->o_dn = op->o_bd->be_rootdn;
2092 op->o_ndn = op->o_bd->be_rootndn;
2093 sc.sc_response = fetch_queryId_cb;
2094 op->o_callback = ≻
2096 for ( s = 0; !BER_BVISNULL( &entryUUIDs[ s ] ); s++ ) {
2097 BerVarray vals = NULL;
2099 op->ors_filterstr.bv_len = snprintf( filtbuf, sizeof( filtbuf ),
2100 "(entryUUID=%s)", entryUUIDs[ s ].bv_val );
2101 op->ors_filterstr.bv_val = filtbuf;
2102 ava.aa_value = entryUUIDs[ s ];
2104 rc = op->o_bd->be_search( op, &rs );
2105 if ( rc != LDAP_SUCCESS ) {
2109 vals = (BerVarray)op->o_callback->sc_private;
2110 if ( vals != NULL ) {
2113 for ( i = 0; !BER_BVISNULL( &vals[ i ] ); i++ ) {
2114 struct berval val = vals[ i ];
2116 remove_query_and_data( op, &rs, cm, &val );
2118 if ( !BER_BVISNULL( &val ) && val.bv_val != vals[ i ].bv_val ) {
2119 ch_free( val.bv_val );
2123 ber_bvarray_free_x( vals, op->o_tmpmemctx );
2124 op->o_callback->sc_private = NULL;
2132 * Call that allows to remove a query from the cache.
2135 pcache_remove_query_from_cache(
2138 struct berval *queryid )
2140 Operation op2 = *op;
2141 SlapReply rs2 = { 0 };
2145 /* remove the selected query */
2146 remove_query_and_data( &op2, &rs2, cm, queryid );
2148 return LDAP_SUCCESS;
2152 * Call that allows to remove a set of queries related to an entry
2153 * from the cache; if queryid is not null, the entry must belong to
2154 * the query indicated by queryid.
2157 pcache_remove_entry_queries_from_cache(
2161 struct berval *queryid )
2163 Connection conn = { 0 };
2164 OperationBuffer opbuf;
2166 slap_callback sc = { 0 };
2167 SlapReply rs = { REP_RESULT };
2169 char filter_str[ LDAP_LUTIL_UUIDSTR_BUFSIZE + STRLENOF( "(pcacheQueryID=)" ) ];
2170 AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
2171 AttributeName attrs[ 2 ] = {{{ 0 }}};
2174 BerVarray vals = NULL;
2177 void *thrctx = ldap_pvt_thread_pool_context();
2179 connection_fake_init( &conn, &opbuf, thrctx );
2187 memset( &op->oq_search, 0, sizeof( op->oq_search ) );
2188 op->ors_scope = LDAP_SCOPE_BASE;
2189 op->ors_deref = LDAP_DEREF_NEVER;
2190 if ( queryid == NULL || BER_BVISNULL( queryid ) ) {
2191 BER_BVSTR( &op->ors_filterstr, "(objectClass=*)" );
2192 f.f_choice = LDAP_FILTER_PRESENT;
2193 f.f_desc = slap_schema.si_ad_objectClass;
2196 op->ors_filterstr.bv_len = snprintf( filter_str,
2197 sizeof( filter_str ), "(%s=%s)",
2198 ad_queryId->ad_cname.bv_val, queryid->bv_val );
2199 f.f_choice = LDAP_FILTER_EQUALITY;
2201 f.f_av_desc = ad_queryId;
2202 f.f_av_value = *queryid;
2204 op->ors_filter = &f;
2206 op->ors_tlimit = SLAP_NO_LIMIT;
2207 op->ors_limit = NULL;
2208 attrs[ 0 ].an_desc = ad_queryId;
2209 attrs[ 0 ].an_name = ad_queryId->ad_cname;
2210 op->ors_attrs = attrs;
2211 op->ors_attrsonly = 0;
2213 op->o_req_dn = *ndn;
2214 op->o_req_ndn = *ndn;
2216 op->o_tag = LDAP_REQ_SEARCH;
2217 op->o_protocol = LDAP_VERSION3;
2218 op->o_managedsait = SLAP_CONTROL_CRITICAL;
2220 op->o_dn = op->o_bd->be_rootdn;
2221 op->o_ndn = op->o_bd->be_rootndn;
2222 sc.sc_response = fetch_queryId_cb;
2223 op->o_callback = ≻
2225 rc = op->o_bd->be_search( op, &rs );
2226 if ( rc != LDAP_SUCCESS ) {
2230 vals = (BerVarray)op->o_callback->sc_private;
2231 if ( vals != NULL ) {
2234 for ( i = 0; !BER_BVISNULL( &vals[ i ] ); i++ ) {
2235 struct berval val = vals[ i ];
2237 remove_query_and_data( op, &rs, cm, &val );
2239 if ( !BER_BVISNULL( &val ) && val.bv_val != vals[ i ].bv_val ) {
2240 ch_free( val.bv_val );
2244 ber_bvarray_free_x( vals, op->o_tmpmemctx );
2247 return LDAP_SUCCESS;
2254 struct berval *query_uuid )
2256 struct search_info *si = op->o_callback->sc_private;
2257 slap_overinst *on = si->on;
2258 cache_manager *cm = on->on_bi.bi_private;
2261 struct berval crp_uuid;
2262 char uuidbuf[ LDAP_LUTIL_UUIDSTR_BUFSIZE ];
2264 Connection conn = {0};
2265 OperationBuffer opbuf;
2266 void *thrctx = ldap_pvt_thread_pool_context();
2268 query_uuid->bv_len = lutil_uuidstr(uuidbuf, sizeof(uuidbuf));
2269 ber_str2bv(uuidbuf, query_uuid->bv_len, 1, query_uuid);
2271 connection_fake_init2( &conn, &opbuf, thrctx, 0 );
2272 op_tmp = &opbuf.ob_op;
2273 op_tmp->o_bd = &cm->db;
2274 op_tmp->o_dn = cm->db.be_rootdn;
2275 op_tmp->o_ndn = cm->db.be_rootndn;
2277 Debug( pcache_debug, "UUID for query being added = %s\n",
2280 for ( e=si->head; e; e=si->head ) {
2281 si->head = e->e_private;
2282 e->e_private = NULL;
2283 while ( cm->cur_entries > (cm->max_entries) ) {
2284 BER_BVZERO( &crp_uuid );
2285 remove_query_and_data( op_tmp, rs, cm, &crp_uuid );
2288 return_val = merge_entry(op_tmp, e, query_uuid);
2289 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
2290 cm->cur_entries += return_val;
2291 Debug( pcache_debug,
2292 "ENTRY ADDED/MERGED, CACHED ENTRIES=%d\n",
2293 cm->cur_entries, 0, 0 );
2295 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
2302 pcache_op_cleanup( Operation *op, SlapReply *rs ) {
2303 slap_callback *cb = op->o_callback;
2304 struct search_info *si = cb->sc_private;
2305 slap_overinst *on = si->on;
2306 cache_manager *cm = on->on_bi.bi_private;
2307 query_manager* qm = cm->qm;
2309 if ( rs->sr_type == REP_SEARCH ) {
2312 /* don't return more entries than requested by the client */
2313 if ( si->slimit > 0 && rs->sr_nentries >= si->slimit ) {
2314 si->slimit_exceeded = 1;
2317 /* If we haven't exceeded the limit for this query,
2318 * build a chain of answers to store. If we hit the
2319 * limit, empty the chain and ignore the rest.
2322 /* check if the entry contains undefined
2323 * attributes/objectClasses (ITS#5680) */
2324 if ( cm->check_cacheability && test_filter( op, rs->sr_entry, si->query.filter ) != LDAP_COMPARE_TRUE ) {
2325 Debug( pcache_debug, "%s: query not cacheable because of schema issues in DN \"%s\"\n",
2326 op->o_log_prefix, rs->sr_entry->e_name.bv_val, 0 );
2330 /* check for malformed entries: attrs with no values */
2332 Attribute *a = rs->sr_entry->e_attrs;
2333 for (; a; a=a->a_next) {
2334 if ( !a->a_numvals ) {
2335 Debug( pcache_debug, "%s: query not cacheable because of attrs without values in DN \"%s\" (%s)\n",
2336 op->o_log_prefix, rs->sr_entry->e_name.bv_val,
2337 a->a_desc->ad_cname.bv_val );
2343 if ( si->count < si->max ) {
2345 e = entry_dup( rs->sr_entry );
2346 if ( !si->head ) si->head = e;
2347 if ( si->tail ) si->tail->e_private = e;
2354 for (;si->head; si->head=e) {
2355 e = si->head->e_private;
2356 si->head->e_private = NULL;
2357 entry_free(si->head);
2365 if ( rs->sr_type == REP_RESULT ||
2366 op->o_abandon || rs->sr_err == SLAPD_ABANDON )
2368 if ( si->swap_saved_attrs ) {
2369 rs->sr_attrs = si->save_attrs;
2370 op->ors_attrs = si->save_attrs;
2372 if ( (op->o_abandon || rs->sr_err == SLAPD_ABANDON) &&
2373 si->caching_reason == PC_IGNORE )
2375 filter_free( si->query.filter );
2377 /* duplicate query, free it */
2379 for (;si->head; si->head=e) {
2380 e = si->head->e_private;
2381 si->head->e_private = NULL;
2382 entry_free(si->head);
2385 op->o_callback = op->o_callback->sc_next;
2386 op->o_tmpfree( cb, op->o_tmpmemctx );
2387 } else if ( si->caching_reason != PC_IGNORE ) {
2388 CachedQuery *qc = qm->addfunc(op, qm, &si->query,
2389 si->qtemp, si->caching_reason, 1 );
2392 switch ( si->caching_reason ) {
2394 cache_entries( op, rs, &qc->q_uuid );
2396 si->pbi->bi_cq = qc;
2400 qc->q_sizelimit = rs->sr_nentries;
2410 ldap_pvt_thread_rdwr_wunlock(&qc->rwlock);
2411 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
2412 cm->num_cached_queries++;
2413 Debug( pcache_debug, "STORED QUERIES = %lu\n",
2414 cm->num_cached_queries, 0, 0 );
2415 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
2417 /* If the consistency checker suspended itself,
2420 if ( cm->cc_paused == PCACHE_CC_PAUSED ) {
2421 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
2422 if ( cm->cc_paused == PCACHE_CC_PAUSED ) {
2424 ldap_pvt_runqueue_resched( &slapd_rq, cm->cc_arg, 0 );
2426 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
2429 } else if ( si->count ) {
2430 /* duplicate query, free it */
2432 for (;si->head; si->head=e) {
2433 e = si->head->e_private;
2434 si->head->e_private = NULL;
2435 entry_free(si->head);
2440 filter_free( si->query.filter );
2444 return SLAP_CB_CONTINUE;
2452 struct search_info *si = op->o_callback->sc_private;
2454 if ( si->swap_saved_attrs ) {
2455 rs->sr_attrs = si->save_attrs;
2456 op->ors_attrs = si->save_attrs;
2459 if ( rs->sr_type == REP_SEARCH ) {
2460 /* don't return more entries than requested by the client */
2461 if ( si->slimit_exceeded ) {
2465 } else if ( rs->sr_type == REP_RESULT ) {
2468 if ( rs->sr_err == LDAP_SUCCESS ) {
2469 si->caching_reason = PC_POSITIVE;
2471 } else if ( rs->sr_err == LDAP_SIZELIMIT_EXCEEDED
2472 && si->qtemp->limitttl )
2474 si->caching_reason = PC_SIZELIMIT;
2477 } else if ( si->qtemp->negttl && !si->count && !si->over &&
2478 rs->sr_err == LDAP_SUCCESS )
2480 si->caching_reason = PC_NEGATIVE;
2484 if ( si->slimit_exceeded ) {
2485 rs->sr_err = LDAP_SIZELIMIT_EXCEEDED;
2489 return SLAP_CB_CONTINUE;
2492 /* NOTE: this is a quick workaround to let pcache minimally interact
2493 * with pagedResults. A more articulated solutions would be to
2494 * perform the remote query without control and cache all results,
2495 * performing the pagedResults search only within the client
2496 * and the proxy. This requires pcache to understand pagedResults. */
2498 pcache_chk_controls(
2502 const char *non = "";
2503 const char *stripped = "";
2505 switch( op->o_pagedresults ) {
2506 case SLAP_CONTROL_NONCRITICAL:
2508 stripped = "; stripped";
2511 case SLAP_CONTROL_CRITICAL:
2512 Debug( pcache_debug, "%s: "
2513 "%scritical pagedResults control "
2514 "disabled with proxy cache%s.\n",
2515 op->o_log_prefix, non, stripped );
2517 slap_remove_control( op, rs, slap_cids.sc_pagedResults, NULL );
2521 rs->sr_err = SLAP_CB_CONTINUE;
2529 pc_setpw( Operation *op, struct berval *pwd, cache_manager *cm )
2531 struct berval vals[2];
2534 const char *text = NULL;
2535 BER_BVZERO( &vals[0] );
2536 slap_passwd_hash( pwd, &vals[0], &text );
2537 if ( BER_BVISEMPTY( &vals[0] )) {
2538 Debug( pcache_debug, "pc_setpw: hash failed %s\n",
2544 BER_BVZERO( &vals[1] );
2548 SlapReply sr = { REP_RESULT };
2549 slap_callback cb = { 0, slap_null_cb, 0, 0 };
2552 mod.sml_op = LDAP_MOD_REPLACE;
2554 mod.sml_desc = slap_schema.si_ad_userPassword;
2555 mod.sml_type = mod.sml_desc->ad_cname;
2556 mod.sml_values = vals;
2557 mod.sml_nvalues = NULL;
2558 mod.sml_numvals = 1;
2559 mod.sml_next = NULL;
2561 op->o_tag = LDAP_REQ_MODIFY;
2562 op->orm_modlist = &mod;
2564 op->o_dn = op->o_bd->be_rootdn;
2565 op->o_ndn = op->o_bd->be_rootndn;
2566 op->o_callback = &cb;
2567 Debug( pcache_debug, "pc_setpw: CACHING BIND for %s\n",
2568 op->o_req_dn.bv_val, 0, 0 );
2569 rc = op->o_bd->be_modify( op, &sr );
2570 ch_free( vals[0].bv_val );
2575 typedef struct bindcacheinfo {
2581 pc_bind_save( Operation *op, SlapReply *rs )
2583 if ( rs->sr_err == LDAP_SUCCESS ) {
2584 bindcacheinfo *bci = op->o_callback->sc_private;
2585 slap_overinst *on = bci->on;
2586 cache_manager *cm = on->on_bi.bi_private;
2588 Operation op2 = *op;
2589 if ( pc_setpw( &op2, &op->orb_cred, cm ) == LDAP_SUCCESS )
2590 bci->qc->bindref_time = op->o_time + bci->qc->qtemp->bindttr;
2592 return SLAP_CB_CONTINUE;
2596 pc_bind_attrs( Operation *op, Entry *e, QueryTemplate *temp,
2597 struct berval *fbv )
2600 struct berval *vals, pres = BER_BVC("*");
2604 vals = op->o_tmpalloc( temp->bindnattrs * sizeof( struct berval ),
2607 for ( i=0; i<temp->bindnattrs; i++ ) {
2608 a = attr_find( e->e_attrs, temp->bindfattrs[i] );
2609 if ( a && a->a_vals ) {
2610 vals[i] = a->a_vals[0];
2611 len += a->a_vals[0].bv_len;
2616 fbv->bv_len = len + temp->bindftemp.bv_len;
2617 fbv->bv_val = op->o_tmpalloc( fbv->bv_len + 1, op->o_tmpmemctx );
2619 p1 = temp->bindftemp.bv_val;
2624 if ( p1[0] == '=' && p1[1] == ')' ) {
2625 AC_MEMCPY( p2, vals[i].bv_val, vals[i].bv_len );
2626 p2 += vals[i].bv_len;
2632 op->o_tmpfree( vals, op->o_tmpmemctx );
2633 return str2filter_x( op, fbv->bv_val );
2636 /* Check if the requested entry is from the cache and has a valid
2637 * ttr and password hash
2640 pc_bind_search( Operation *op, SlapReply *rs )
2642 if ( rs->sr_type == REP_SEARCH ) {
2643 bindinfo *pbi = op->o_callback->sc_private;
2645 /* We only care if this is an already cached result and we're
2646 * below the refresh time, or we're offline.
2649 if (( pbi->bi_cm->cc_paused & PCACHE_CC_OFFLINE ) ||
2650 op->o_time < pbi->bi_cq->bindref_time ) {
2653 /* See if a recognized password is hashed here */
2654 a = attr_find( rs->sr_entry->e_attrs,
2655 slap_schema.si_ad_userPassword );
2656 if ( a && a->a_vals[0].bv_val[0] == '{' &&
2657 lutil_passwd_scheme( a->a_vals[0].bv_val ))
2658 pbi->bi_flags |= BI_HASHED;
2660 Debug( pcache_debug, "pc_bind_search: cache is stale, "
2661 "reftime: %ld, current time: %ld\n",
2662 pbi->bi_cq->bindref_time, op->o_time, 0 );
2664 } else if ( pbi->bi_si ) {
2665 /* This search result is going into the cache */
2669 filter_free( pbi->bi_si->query.filter );
2670 f = pc_bind_attrs( op, rs->sr_entry, pbi->bi_templ, &fbv );
2671 op->o_tmpfree( fbv.bv_val, op->o_tmpmemctx );
2672 pbi->bi_si->query.filter = filter_dup( f, NULL );
2673 filter_free_x( op, f, 1 );
2679 /* We always want pc_bind_search to run after the search handlers */
2681 pc_bind_resp( Operation *op, SlapReply *rs )
2683 bindinfo *pbi = op->o_callback->sc_private;
2684 if ( !( pbi->bi_flags & BI_DIDCB )) {
2685 slap_callback *sc = op->o_callback;
2686 while ( sc && sc->sc_response != pcache_response )
2689 sc = op->o_callback;
2690 pbi->bi_cb.sc_next = sc->sc_next;
2691 sc->sc_next = &pbi->bi_cb;
2692 pbi->bi_flags |= BI_DIDCB;
2694 return SLAP_CB_CONTINUE;
2697 #ifdef PCACHE_CONTROL_PRIVDB
2703 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
2704 cache_manager *cm = on->on_bi.bi_private;
2705 slap_callback *save_cb;
2708 /* skip if control is unset */
2709 if ( op->o_ctrlflag[ privDB_cid ] != SLAP_CONTROL_CRITICAL ) {
2710 return SLAP_CB_CONTINUE;
2713 /* The cache DB isn't open yet */
2714 if ( cm->defer_db_open ) {
2715 send_ldap_error( op, rs, LDAP_UNAVAILABLE,
2716 "pcachePrivDB: cacheDB not available" );
2720 /* FIXME: might be a little bit exaggerated... */
2721 if ( !be_isroot( op ) ) {
2722 save_cb = op->o_callback;
2723 op->o_callback = NULL;
2724 send_ldap_error( op, rs, LDAP_UNWILLING_TO_PERFORM,
2725 "pcachePrivDB: operation not allowed" );
2726 op->o_callback = save_cb;
2731 /* map tag to operation */
2732 type = slap_req2op( op->o_tag );
2733 if ( type != SLAP_OP_LAST ) {
2737 /* execute, if possible */
2738 func = &cm->db.be_bind;
2739 if ( func[ type ] != NULL ) {
2740 Operation op2 = *op;
2744 rc = func[ type ]( &op2, rs );
2745 if ( type == SLAP_OP_BIND && rc == LDAP_SUCCESS ) {
2746 op->o_conn->c_authz_cookie = cm->db.be_private;
2753 /* otherwise fall back to error */
2754 save_cb = op->o_callback;
2755 op->o_callback = NULL;
2756 send_ldap_error( op, rs, LDAP_UNWILLING_TO_PERFORM,
2757 "operation not supported with pcachePrivDB control" );
2758 op->o_callback = save_cb;
2762 #endif /* PCACHE_CONTROL_PRIVDB */
2769 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
2770 cache_manager *cm = on->on_bi.bi_private;
2771 QueryTemplate *temp;
2773 slap_callback cb = { 0 }, *sc;
2779 #ifdef PCACHE_CONTROL_PRIVDB
2780 if ( op->o_ctrlflag[ privDB_cid ] == SLAP_CONTROL_CRITICAL )
2781 return pcache_op_privdb( op, rs );
2782 #endif /* PCACHE_CONTROL_PRIVDB */
2784 /* Skip if we're not configured for Binds, or cache DB isn't open yet */
2785 if ( !cm->cache_binds || cm->defer_db_open )
2786 return SLAP_CB_CONTINUE;
2788 /* First find a matching template with Bind info */
2789 for ( temp=cm->qm->templates; temp; temp=temp->qmnext ) {
2790 if ( temp->bindttr && dnIsSuffix( &op->o_req_ndn, &temp->bindbase ))
2793 /* Didn't find a suitable template, just passthru */
2795 return SLAP_CB_CONTINUE;
2797 /* See if the entry is already locally cached. If so, we can
2798 * populate the query filter to retrieve the cached query. We
2799 * need to check the bindrefresh time in the query.
2802 op2.o_dn = op->o_bd->be_rootdn;
2803 op2.o_ndn = op->o_bd->be_rootndn;
2808 rc = be_entry_get_rw( &op2, &op->o_req_ndn, NULL, NULL, 0, &e );
2809 if ( rc == LDAP_SUCCESS && e ) {
2810 bi.bi_flags |= BI_LOOKUP;
2811 op2.ors_filter = pc_bind_attrs( op, e, temp, &op2.ors_filterstr );
2812 be_entry_release_r( &op2, e );
2814 op2.ors_filter = temp->bindfilter;
2815 op2.ors_filterstr = temp->bindfilterstr;
2818 op2.o_bd = op->o_bd;
2819 op2.o_tag = LDAP_REQ_SEARCH;
2820 op2.ors_scope = LDAP_SCOPE_BASE;
2821 op2.ors_deref = LDAP_DEREF_NEVER;
2823 op2.ors_tlimit = SLAP_NO_LIMIT;
2824 op2.ors_limit = NULL;
2825 op2.ors_attrs = cm->qm->attr_sets[temp->attr_set_index].attrs;
2826 op2.ors_attrsonly = 0;
2828 /* We want to invoke search at the same level of the stack
2829 * as we're already at...
2836 bi.bi_cb.sc_response = pc_bind_search;
2837 bi.bi_cb.sc_cleanup = NULL;
2838 bi.bi_cb.sc_private = &bi;
2839 cb.sc_private = &bi;
2840 cb.sc_response = pc_bind_resp;
2841 op2.o_callback = &cb;
2842 overlay_op_walk( &op2, rs, op_search, on->on_info, on );
2844 /* OK, just bind locally */
2845 if ( bi.bi_flags & BI_HASHED ) {
2846 BackendDB *be = op->o_bd;
2849 Debug( pcache_debug, "pcache_op_bind: CACHED BIND for %s\n",
2850 op->o_req_dn.bv_val, 0, 0 );
2852 if ( op->o_bd->be_bind( op, rs ) == LDAP_SUCCESS ) {
2853 op->o_conn->c_authz_cookie = cm->db.be_private;
2859 /* We have a cached query to work with */
2861 sc = op->o_tmpalloc( sizeof(slap_callback) + sizeof(bindcacheinfo),
2863 sc->sc_response = pc_bind_save;
2864 sc->sc_cleanup = NULL;
2865 sc->sc_private = sc+1;
2866 bci = sc->sc_private;
2867 sc->sc_next = op->o_callback;
2868 op->o_callback = sc;
2872 return SLAP_CB_CONTINUE;
2880 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
2881 cache_manager *cm = on->on_bi.bi_private;
2882 query_manager* qm = cm->qm;
2887 QueryTemplate *qtemp = NULL;
2888 bindinfo *pbi = NULL;
2891 CachedQuery *answerable = NULL;
2894 struct berval tempstr;
2896 #ifdef PCACHE_CONTROL_PRIVDB
2897 if ( op->o_ctrlflag[ privDB_cid ] == SLAP_CONTROL_CRITICAL ) {
2898 return pcache_op_privdb( op, rs );
2900 #endif /* PCACHE_CONTROL_PRIVDB */
2902 /* The cache DB isn't open yet */
2903 if ( cm->defer_db_open ) {
2904 send_ldap_error( op, rs, LDAP_UNAVAILABLE,
2905 "pcachePrivDB: cacheDB not available" );
2909 /* pickup runtime ACL changes */
2910 cm->db.be_acl = op->o_bd->be_acl;
2913 /* See if we're processing a Bind request */
2914 slap_callback *cb = op->o_callback;
2916 for ( ; cb; cb=cb->sc_next ) {
2917 if ( cb->sc_response == pc_bind_resp ) {
2918 pbi = cb->sc_private;
2924 /* FIXME: cannot cache/answer requests with pagedResults control */
2926 query.filter = op->ors_filter;
2929 query.base = pbi->bi_templ->bindbase;
2930 query.scope = pbi->bi_templ->bindscope;
2931 attr_set = pbi->bi_templ->attr_set_index;
2933 qtemp = pbi->bi_templ;
2934 if ( pbi->bi_flags & BI_LOOKUP )
2935 answerable = qm->qcfunc(op, qm, &query, qtemp);
2938 tempstr.bv_val = op->o_tmpalloc( op->ors_filterstr.bv_len+1,
2941 if ( filter2template( op, op->ors_filter, &tempstr ))
2943 op->o_tmpfree( tempstr.bv_val, op->o_tmpmemctx );
2944 return SLAP_CB_CONTINUE;
2947 Debug( pcache_debug, "query template of incoming query = %s\n",
2948 tempstr.bv_val, 0, 0 );
2951 attr_set = get_attr_set(op->ors_attrs, qm, cm->numattrsets);
2953 query.base = op->o_req_ndn;
2954 query.scope = op->ors_scope;
2956 /* check for query containment */
2957 if (attr_set > -1) {
2958 QueryTemplate *qt = qm->attr_sets[attr_set].templates;
2959 for (; qt; qt = qt->qtnext ) {
2960 /* find if template i can potentially answer tempstr */
2961 if ( ber_bvstrcasecmp( &qt->querystr, &tempstr ) != 0 )
2965 Debug( pcache_debug, "Entering QC, querystr = %s\n",
2966 op->ors_filterstr.bv_val, 0, 0 );
2967 answerable = qm->qcfunc(op, qm, &query, qt);
2969 /* if != NULL, rlocks qtemp->t_rwlock */
2974 op->o_tmpfree( tempstr.bv_val, op->o_tmpmemctx );
2978 BackendDB *save_bd = op->o_bd;
2980 ldap_pvt_thread_mutex_lock( &answerable->answerable_cnt_mutex );
2981 answerable->answerable_cnt++;
2982 /* we only care about refcnts if we're refreshing */
2983 if ( answerable->refresh_time )
2984 answerable->refcnt++;
2985 Debug( pcache_debug, "QUERY ANSWERABLE (answered %lu times)\n",
2986 answerable->answerable_cnt, 0, 0 );
2987 ldap_pvt_thread_mutex_unlock( &answerable->answerable_cnt_mutex );
2989 ldap_pvt_thread_rdwr_rlock(&answerable->rwlock);
2990 if ( BER_BVISNULL( &answerable->q_uuid )) {
2991 /* No entries cached, just an empty result set */
2993 send_ldap_result( op, rs );
2995 /* Let Bind know we used a cached query */
2997 pbi->bi_cq = answerable;
3001 if ( cm->response_cb == PCACHE_RESPONSE_CB_TAIL ) {
3002 /* The cached entry was already processed by any
3003 * other overlays, so don't let it get processed again.
3005 op->o_callback = NULL;
3008 i = cm->db.bd_info->bi_op_search( op, rs );
3010 ldap_pvt_thread_rdwr_runlock(&answerable->rwlock);
3011 /* locked by qtemp->qcfunc (query_containment) */
3012 ldap_pvt_thread_rdwr_runlock(&qtemp->t_rwlock);
3017 Debug( pcache_debug, "QUERY NOT ANSWERABLE\n", 0, 0, 0 );
3019 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
3020 if (cm->num_cached_queries >= cm->max_queries) {
3023 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
3025 if (op->ors_attrsonly)
3030 struct search_info *si;
3032 Debug( pcache_debug, "QUERY CACHEABLE\n", 0, 0, 0 );
3033 query.filter = filter_dup(op->ors_filter, NULL);
3035 cb = op->o_tmpalloc( sizeof(*cb) + sizeof(*si), op->o_tmpmemctx );
3036 cb->sc_response = pcache_response;
3037 cb->sc_cleanup = pcache_op_cleanup;
3038 cb->sc_private = (cb+1);
3039 si = cb->sc_private;
3043 si->max = cm->num_entries_limit ;
3047 si->slimit_exceeded = 0;
3048 si->caching_reason = PC_IGNORE;
3049 if ( op->ors_slimit > 0 && op->ors_slimit < cm->num_entries_limit ) {
3050 si->slimit = op->ors_slimit;
3051 op->ors_slimit = cm->num_entries_limit;
3055 si->swap_saved_attrs = 1;
3056 si->save_attrs = op->ors_attrs;
3061 op->ors_attrs = qtemp->t_attrs.attrs;
3063 if ( cm->response_cb == PCACHE_RESPONSE_CB_HEAD ) {
3064 cb->sc_next = op->o_callback;
3065 op->o_callback = cb;
3068 slap_callback **pcb;
3070 /* need to move the callback at the end, in case other
3071 * overlays are present, so that the final entry is
3072 * actually cached */
3074 for ( pcb = &op->o_callback; *pcb; pcb = &(*pcb)->sc_next );
3079 Debug( pcache_debug, "QUERY NOT CACHEABLE\n",
3083 return SLAP_CB_CONTINUE;
3088 AttributeName* attrs,
3096 for ( ; attrs[count].an_name.bv_val; count++ );
3099 /* recognize a single "*" or a "1.1" */
3102 attrs = slap_anlist_all_user_attributes;
3104 } else if ( count == 1 && bvmatch( &attrs[0].an_name, slap_bv_no_attrs ) ) {
3109 for ( i = 0; i < num; i++ ) {
3113 if ( count > qm->attr_sets[i].count ) {
3118 if ( !qm->attr_sets[i].count ) {
3124 for ( a2 = attrs; a2->an_name.bv_val; a2++ ) {
3125 if ( !an_find( qm->attr_sets[i].attrs, &a2->an_name ) ) {
3143 /* Refresh a cached query:
3144 * 1: Replay the query on the remote DB and merge each entry into
3145 * the local DB. Remember the DNs of each remote entry.
3146 * 2: Search the local DB for all entries matching this queryID.
3147 * Delete any entry whose DN is not in the list from (1).
3149 typedef struct dnlist {
3150 struct dnlist *next;
3155 typedef struct refresh_info {
3163 static dnlist *dnl_alloc( Operation *op, struct berval *bvdn )
3165 dnlist *dn = op->o_tmpalloc( sizeof(dnlist) + bvdn->bv_len + 1,
3167 dn->dn.bv_len = bvdn->bv_len;
3168 dn->dn.bv_val = (char *)(dn+1);
3169 AC_MEMCPY( dn->dn.bv_val, bvdn->bv_val, dn->dn.bv_len );
3170 dn->dn.bv_val[dn->dn.bv_len] = '\0';
3175 refresh_merge( Operation *op, SlapReply *rs )
3177 if ( rs->sr_type == REP_SEARCH ) {
3178 refresh_info *ri = op->o_callback->sc_private;
3179 BackendDB *be = op->o_bd;
3185 ocb = op->o_callback;
3186 /* Find local entry, merge */
3187 op->o_bd = ri->ri_be;
3188 rc = be_entry_get_rw( op, &rs->sr_entry->e_nname, NULL, NULL, 0, &e );
3189 if ( rc != LDAP_SUCCESS || e == NULL ) {
3190 /* No local entry, just add it. FIXME: we are not checking
3191 * the cache entry limit here
3193 merge_entry( op, rs->sr_entry, &ri->ri_q->q_uuid );
3195 /* Entry exists, update it */
3198 Modifications *modlist, *mods = NULL;
3199 const char* text = NULL;
3200 char textbuf[SLAP_TEXT_BUFLEN];
3201 size_t textlen = sizeof(textbuf);
3202 slap_callback cb = { NULL, slap_null_cb, NULL, NULL };
3206 /* Get a copy of only the attrs we requested */
3207 for ( a=e->e_attrs; a; a=a->a_next ) {
3208 if ( ad_inlist( a->a_desc, rs->sr_attrs )) {
3209 *b = attr_alloc( a->a_desc );
3211 /* The actual values still belong to e */
3212 (*b)->a_flags |= SLAP_ATTR_DONT_FREE_VALS |
3213 SLAP_ATTR_DONT_FREE_DATA;
3214 b = &((*b)->a_next);
3218 slap_entry2mods( rs->sr_entry, &modlist, &text, textbuf, textlen );
3219 syncrepl_diff_entry( op, ne.e_attrs, rs->sr_entry->e_attrs,
3220 &mods, &modlist, 0 );
3221 be_entry_release_r( op, e );
3222 attrs_free( ne.e_attrs );
3223 slap_mods_free( modlist, 1 );
3224 /* mods is NULL if there are no changes */
3226 struct berval dn = op->o_req_dn;
3227 struct berval ndn = op->o_req_ndn;
3228 op->o_tag = LDAP_REQ_MODIFY;
3229 op->orm_modlist = mods;
3230 op->o_req_dn = rs->sr_entry->e_name;
3231 op->o_req_ndn = rs->sr_entry->e_nname;
3232 op->o_callback = &cb;
3233 op->o_bd->be_modify( op, rs );
3234 slap_mods_free( mods, 1 );
3236 op->o_req_ndn = ndn;
3240 /* Add DN to list */
3241 dnl = dnl_alloc( op, &rs->sr_entry->e_nname );
3243 if ( ri->ri_tail ) {
3244 ri->ri_tail->next = dnl;
3249 op->o_callback = ocb;
3255 refresh_purge( Operation *op, SlapReply *rs )
3257 if ( rs->sr_type == REP_SEARCH ) {
3258 refresh_info *ri = op->o_callback->sc_private;
3262 /* Did the entry exist on the remote? */
3263 for ( dn=&ri->ri_dns; *dn; dn = &(*dn)->next ) {
3264 if ( dn_match( &(*dn)->dn, &rs->sr_entry->e_nname )) {
3265 dnlist *dnext = (*dn)->next;
3266 op->o_tmpfree( *dn, op->o_tmpmemctx );
3272 /* No, so put it on the list to delete */
3275 dnlist *dnl = dnl_alloc( op, &rs->sr_entry->e_nname );
3276 dnl->next = ri->ri_dels;
3278 a = attr_find( rs->sr_entry->e_attrs, ad_queryId );
3279 /* If ours is the only queryId, delete entry */
3280 dnl->delete = ( a->a_numvals == 1 );
3287 refresh_query( Operation *op, SlapReply *rs, CachedQuery *query,
3290 slap_callback cb = { 0 };
3291 refresh_info ri = { 0 };
3292 char filter_str[ LDAP_LUTIL_UUIDSTR_BUFSIZE + STRLENOF( "(pcacheQueryID=)" ) ];
3293 AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
3294 Filter filter = {LDAP_FILTER_EQUALITY};
3295 AttributeName attrs[ 2 ] = {{{ 0 }}};
3299 ldap_pvt_thread_mutex_lock( &query->answerable_cnt_mutex );
3301 ldap_pvt_thread_mutex_unlock( &query->answerable_cnt_mutex );
3303 cb.sc_response = refresh_merge;
3304 cb.sc_private = &ri;
3307 ri.ri_be = op->o_bd;
3310 op->o_tag = LDAP_REQ_SEARCH;
3311 op->o_protocol = LDAP_VERSION3;
3312 op->o_callback = &cb;
3313 op->o_do_not_cache = 1;
3315 op->o_req_dn = query->qbase->base;
3316 op->o_req_ndn = query->qbase->base;
3317 op->ors_scope = query->scope;
3318 op->ors_slimit = SLAP_NO_LIMIT;
3319 op->ors_tlimit = SLAP_NO_LIMIT;
3320 op->ors_limit = NULL;
3321 op->ors_filter = query->filter;
3322 filter2bv_x( op, query->filter, &op->ors_filterstr );
3323 op->ors_attrs = query->qtemp->t_attrs.attrs;
3324 op->ors_attrsonly = 0;
3326 op->o_bd = on->on_info->oi_origdb;
3327 rc = op->o_bd->be_search( op, rs );
3329 op->o_bd = ri.ri_be;
3333 /* Get the DNs of all entries matching this query */
3334 cb.sc_response = refresh_purge;
3336 op->o_bd = ri.ri_be;
3337 op->o_req_dn = op->o_bd->be_suffix[0];
3338 op->o_req_ndn = op->o_bd->be_nsuffix[0];
3339 op->ors_scope = LDAP_SCOPE_SUBTREE;
3340 op->ors_deref = LDAP_DEREF_NEVER;
3341 op->ors_filterstr.bv_len = snprintf(filter_str, sizeof(filter_str),
3342 "(%s=%s)", ad_queryId->ad_cname.bv_val, query->q_uuid.bv_val);
3343 filter.f_ava = &ava;
3344 filter.f_av_desc = ad_queryId;
3345 filter.f_av_value = query->q_uuid;
3346 attrs[ 0 ].an_desc = ad_queryId;
3347 attrs[ 0 ].an_name = ad_queryId->ad_cname;
3348 op->ors_attrs = attrs;
3349 op->ors_attrsonly = 0;
3350 rs->sr_entry = NULL;
3351 rs->sr_nentries = 0;
3352 rc = op->o_bd->be_search( op, rs );
3353 if ( rc ) goto leave;
3355 while (( dn = ri.ri_dels )) {
3356 op->o_req_dn = dn->dn;
3357 op->o_req_ndn = dn->dn;
3359 op->o_tag = LDAP_REQ_DELETE;
3360 op->o_bd->be_delete( op, rs );
3363 struct berval vals[2];
3365 vals[0] = query->q_uuid;
3366 BER_BVZERO( &vals[1] );
3367 mod.sml_op = LDAP_MOD_DELETE;
3369 mod.sml_desc = ad_queryId;
3370 mod.sml_type = ad_queryId->ad_cname;
3371 mod.sml_values = vals;
3372 mod.sml_nvalues = NULL;
3373 mod.sml_numvals = 1;
3374 mod.sml_next = NULL;
3376 op->o_tag = LDAP_REQ_MODIFY;
3377 op->orm_modlist = &mod;
3378 op->o_bd->be_modify( op, rs );
3380 ri.ri_dels = dn->next;
3381 op->o_tmpfree( dn, op->o_tmpmemctx );
3385 /* reset our local heap, we're done with it */
3386 slap_sl_mem_create(SLAP_SLAB_SIZE, SLAP_SLAB_STACK, op->o_threadctx, 1 );
3395 struct re_s *rtask = arg;
3396 slap_overinst *on = rtask->arg;
3397 cache_manager *cm = on->on_bi.bi_private;
3398 query_manager *qm = cm->qm;
3399 Connection conn = {0};
3400 OperationBuffer opbuf;
3403 SlapReply rs = {REP_RESULT};
3404 CachedQuery *query, *qprev;
3405 int return_val, pause = PCACHE_CC_PAUSED;
3406 QueryTemplate *templ;
3408 /* Don't expire anything when we're offline */
3409 if ( cm->cc_paused & PCACHE_CC_OFFLINE ) {
3410 pause = PCACHE_CC_OFFLINE;
3414 connection_fake_init( &conn, &opbuf, ctx );
3418 op->o_dn = cm->db.be_rootdn;
3419 op->o_ndn = cm->db.be_rootndn;
3423 for (templ = qm->templates; templ; templ=templ->qmnext) {
3425 if ( !templ->query_last ) continue;
3427 op->o_time = slap_get_time();
3428 if ( !templ->ttr ) {
3430 if ( templ->negttl && templ->negttl < ttl )
3431 ttl = templ->negttl;
3432 if ( templ->limitttl && templ->limitttl < ttl )
3433 ttl = templ->limitttl;
3434 /* The oldest timestamp that needs expiration checking */
3438 for ( query=templ->query_last; query; query=qprev ) {
3439 qprev = query->prev;
3440 if ( query->refresh_time && query->refresh_time < op->o_time ) {
3441 /* A refresh will extend the expiry if the query has been
3442 * referenced, but not if it's unreferenced. If the
3443 * expiration has been hit, then skip the refresh since
3444 * we're just going to discard the result anyway.
3446 if ( query->refcnt )
3447 query->expiry_time = op->o_time + templ->ttl;
3448 if ( query->expiry_time > op->o_time ) {
3449 refresh_query( op, &rs, query, on );
3454 if (query->expiry_time < op->o_time) {
3456 Debug( pcache_debug, "Lock CR index = %p\n",
3457 (void *) templ, 0, 0 );
3458 ldap_pvt_thread_rdwr_wlock(&templ->t_rwlock);
3459 if ( query == templ->query_last ) {
3461 remove_from_template(query, templ);
3462 Debug( pcache_debug, "TEMPLATE %p QUERIES-- %d\n",
3463 (void *) templ, templ->no_of_queries, 0 );
3464 Debug( pcache_debug, "Unlock CR index = %p\n",
3465 (void *) templ, 0, 0 );
3467 ldap_pvt_thread_rdwr_wunlock(&templ->t_rwlock);
3471 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
3472 remove_query(qm, query);
3473 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
3474 if ( BER_BVISNULL( &query->q_uuid ))
3477 return_val = remove_query_data(op, &rs, &query->q_uuid);
3478 Debug( pcache_debug, "STALE QUERY REMOVED, SIZE=%d\n",
3480 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
3481 cm->cur_entries -= return_val;
3482 cm->num_cached_queries--;
3483 Debug( pcache_debug, "STORED QUERIES = %lu\n",
3484 cm->num_cached_queries, 0, 0 );
3485 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
3486 Debug( pcache_debug,
3487 "STALE QUERY REMOVED, CACHE ="
3489 cm->cur_entries, 0, 0 );
3491 } else if ( !templ->ttr && query->expiry_time > ttl ) {
3492 /* We don't need to check for refreshes, and this
3493 * query's expiry is too new, and all subsequent queries
3494 * will be newer yet. So stop looking.
3496 * If we have refreshes, then we always have to walk the
3497 * entire query list.
3505 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
3506 if ( ldap_pvt_runqueue_isrunning( &slapd_rq, rtask )) {
3507 ldap_pvt_runqueue_stoptask( &slapd_rq, rtask );
3509 /* If there were no queries, defer processing for a while */
3510 if ( cm->cc_paused != pause )
3511 cm->cc_paused = pause;
3512 ldap_pvt_runqueue_resched( &slapd_rq, rtask, pause );
3514 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
3519 #define MAX_ATTR_SETS 500
3532 static ConfigDriver pc_cf_gen;
3533 static ConfigLDAPadd pc_ldadd;
3534 static ConfigCfAdd pc_cfadd;
3536 static ConfigTable pccfg[] = {
3537 { "pcache", "backend> <max_entries> <numattrsets> <entry limit> "
3539 6, 6, 0, ARG_MAGIC|ARG_NO_DELETE|PC_MAIN, pc_cf_gen,
3540 "( OLcfgOvAt:2.1 NAME ( 'olcPcache' 'olcProxyCache' ) "
3541 "DESC 'Proxy Cache basic parameters' "
3542 "SYNTAX OMsDirectoryString SINGLE-VALUE )", NULL, NULL },
3543 { "pcacheAttrset", "index> <attributes...",
3544 2, 0, 0, ARG_MAGIC|PC_ATTR, pc_cf_gen,
3545 "( OLcfgOvAt:2.2 NAME ( 'olcPcacheAttrset' 'olcProxyAttrset' ) "
3546 "DESC 'A set of attributes to cache' "
3547 "SYNTAX OMsDirectoryString )", NULL, NULL },
3548 { "pcacheTemplate", "filter> <attrset-index> <TTL> <negTTL> "
3550 4, 7, 0, ARG_MAGIC|PC_TEMP, pc_cf_gen,
3551 "( OLcfgOvAt:2.3 NAME ( 'olcPcacheTemplate' 'olcProxyCacheTemplate' ) "
3552 "DESC 'Filter template, attrset, cache TTL, "
3553 "optional negative TTL, optional sizelimit TTL, "
3555 "SYNTAX OMsDirectoryString )", NULL, NULL },
3556 { "pcachePosition", "head|tail(default)",
3557 2, 2, 0, ARG_MAGIC|PC_RESP, pc_cf_gen,
3558 "( OLcfgOvAt:2.4 NAME 'olcPcachePosition' "
3559 "DESC 'Response callback position in overlay stack' "
3560 "SYNTAX OMsDirectoryString )", NULL, NULL },
3561 { "pcacheMaxQueries", "queries",
3562 2, 2, 0, ARG_INT|ARG_MAGIC|PC_QUERIES, pc_cf_gen,
3563 "( OLcfgOvAt:2.5 NAME ( 'olcPcacheMaxQueries' 'olcProxyCacheQueries' ) "
3564 "DESC 'Maximum number of queries to cache' "
3565 "SYNTAX OMsInteger )", NULL, NULL },
3566 { "pcachePersist", "TRUE|FALSE",
3567 2, 2, 0, ARG_ON_OFF|ARG_OFFSET, (void *)offsetof(cache_manager, save_queries),
3568 "( OLcfgOvAt:2.6 NAME ( 'olcPcachePersist' 'olcProxySaveQueries' ) "
3569 "DESC 'Save cached queries for hot restart' "
3570 "SYNTAX OMsBoolean )", NULL, NULL },
3571 { "pcacheValidate", "TRUE|FALSE",
3572 2, 2, 0, ARG_ON_OFF|ARG_OFFSET, (void *)offsetof(cache_manager, check_cacheability),
3573 "( OLcfgOvAt:2.7 NAME ( 'olcPcacheValidate' 'olcProxyCheckCacheability' ) "
3574 "DESC 'Check whether the results of a query are cacheable, e.g. for schema issues' "
3575 "SYNTAX OMsBoolean )", NULL, NULL },
3576 { "pcacheOffline", "TRUE|FALSE",
3577 2, 2, 0, ARG_ON_OFF|ARG_MAGIC|PC_OFFLINE, pc_cf_gen,
3578 "( OLcfgOvAt:2.8 NAME 'olcPcacheOffline' "
3579 "DESC 'Set cache to offline mode and disable expiration' "
3580 "SYNTAX OMsBoolean )", NULL, NULL },
3581 { "pcacheBind", "filter> <attrset-index> <TTR> <scope> <base",
3582 6, 6, 0, ARG_MAGIC|PC_BIND, pc_cf_gen,
3583 "( OLcfgOvAt:2.9 NAME 'olcPcacheBind' "
3584 "DESC 'Parameters for caching Binds' "
3585 "SYNTAX OMsDirectoryString )", NULL, NULL },
3586 { "pcache-", "private database args",
3587 1, 0, STRLENOF("pcache-"), ARG_MAGIC|PC_PRIVATE_DB, pc_cf_gen,
3590 /* Legacy keywords */
3591 { "proxycache", "backend> <max_entries> <numattrsets> <entry limit> "
3593 6, 6, 0, ARG_MAGIC|ARG_NO_DELETE|PC_MAIN, pc_cf_gen,
3595 { "proxyattrset", "index> <attributes...",
3596 2, 0, 0, ARG_MAGIC|PC_ATTR, pc_cf_gen,
3598 { "proxytemplate", "filter> <attrset-index> <TTL> <negTTL",
3599 4, 7, 0, ARG_MAGIC|PC_TEMP, pc_cf_gen,
3601 { "response-callback", "head|tail(default)",
3602 2, 2, 0, ARG_MAGIC|PC_RESP, pc_cf_gen,
3604 { "proxyCacheQueries", "queries",
3605 2, 2, 0, ARG_INT|ARG_MAGIC|PC_QUERIES, pc_cf_gen,
3607 { "proxySaveQueries", "TRUE|FALSE",
3608 2, 2, 0, ARG_ON_OFF|ARG_OFFSET, (void *)offsetof(cache_manager, save_queries),
3610 { "proxyCheckCacheability", "TRUE|FALSE",
3611 2, 2, 0, ARG_ON_OFF|ARG_OFFSET, (void *)offsetof(cache_manager, check_cacheability),
3614 { NULL, NULL, 0, 0, 0, ARG_IGNORED }
3617 static ConfigOCs pcocs[] = {
3618 { "( OLcfgOvOc:2.1 "
3619 "NAME 'olcPcacheConfig' "
3620 "DESC 'ProxyCache configuration' "
3621 "SUP olcOverlayConfig "
3622 "MUST ( olcPcache $ olcPcacheAttrset $ olcPcacheTemplate ) "
3623 "MAY ( olcPcachePosition $ olcPcacheMaxQueries $ olcPcachePersist $ "
3624 "olcPcacheValidate $ olcPcacheOffline $ olcPcacheBind ) )",
3625 Cft_Overlay, pccfg, NULL, pc_cfadd },
3626 { "( OLcfgOvOc:2.2 "
3627 "NAME 'olcPcacheDatabase' "
3628 "DESC 'Cache database configuration' "
3629 "AUXILIARY )", Cft_Misc, olcDatabaseDummy, pc_ldadd },
3633 static int pcache_db_open2( slap_overinst *on, ConfigReply *cr );
3636 pc_ldadd_cleanup( ConfigArgs *c )
3638 slap_overinst *on = c->ca_private;
3639 return pcache_db_open2( on, &c->reply );
3643 pc_ldadd( CfEntryInfo *p, Entry *e, ConfigArgs *ca )
3648 if ( p->ce_type != Cft_Overlay || !p->ce_bi ||
3649 p->ce_bi->bi_cf_ocs != pcocs )
3650 return LDAP_CONSTRAINT_VIOLATION;
3652 on = (slap_overinst *)p->ce_bi;
3653 cm = on->on_bi.bi_private;
3655 /* Defer open if this is an LDAPadd */
3656 if ( CONFIG_ONLINE_ADD( ca ))
3657 ca->cleanup = pc_ldadd_cleanup;
3659 cm->defer_db_open = 0;
3660 ca->ca_private = on;
3661 return LDAP_SUCCESS;
3665 pc_cfadd( Operation *op, SlapReply *rs, Entry *p, ConfigArgs *ca )
3667 CfEntryInfo *pe = p->e_private;
3668 slap_overinst *on = (slap_overinst *)pe->ce_bi;
3669 cache_manager *cm = on->on_bi.bi_private;
3672 /* FIXME: should not hardcode "olcDatabase" here */
3673 bv.bv_len = snprintf( ca->cr_msg, sizeof( ca->cr_msg ),
3674 "olcDatabase=" SLAP_X_ORDERED_FMT "%s",
3675 0, cm->db.bd_info->bi_type );
3676 if ( bv.bv_len >= sizeof( ca->cr_msg ) ) {
3679 bv.bv_val = ca->cr_msg;
3681 cm->defer_db_open = 0;
3683 /* We can only create this entry if the database is table-driven
3685 if ( cm->db.bd_info->bi_cf_ocs )
3686 config_build_entry( op, rs, pe, ca, &bv, cm->db.bd_info->bi_cf_ocs,
3693 pc_cf_gen( ConfigArgs *c )
3695 slap_overinst *on = (slap_overinst *)c->bi;
3696 cache_manager* cm = on->on_bi.bi_private;
3697 query_manager* qm = cm->qm;
3698 QueryTemplate* temp;
3699 AttributeName* attr_name;
3700 AttributeName* attrarray;
3701 const char* text=NULL;
3706 if ( c->op == SLAP_CONFIG_EMIT ) {
3710 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ), "%s %d %d %d %ld",
3711 cm->db.bd_info->bi_type, cm->max_entries, cm->numattrsets,
3712 cm->num_entries_limit, cm->cc_period );
3713 bv.bv_val = c->cr_msg;
3714 value_add_one( &c->rvalue_vals, &bv );
3717 for (i=0; i<cm->numattrsets; i++) {
3718 if ( !qm->attr_sets[i].count ) continue;
3720 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ), "%d", i );
3722 /* count the attr length */
3723 for ( attr_name = qm->attr_sets[i].attrs;
3724 attr_name->an_name.bv_val; attr_name++ )
3725 bv.bv_len += attr_name->an_name.bv_len + 1;
3727 bv.bv_val = ch_malloc( bv.bv_len+1 );
3728 ptr = lutil_strcopy( bv.bv_val, c->cr_msg );
3729 for ( attr_name = qm->attr_sets[i].attrs;
3730 attr_name->an_name.bv_val; attr_name++ ) {
3732 ptr = lutil_strcopy( ptr, attr_name->an_name.bv_val );
3734 ber_bvarray_add( &c->rvalue_vals, &bv );
3736 if ( !c->rvalue_vals )
3740 for (temp=qm->templates; temp; temp=temp->qmnext) {
3741 /* HEADS-UP: always print all;
3742 * if optional == 0, ignore */
3743 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ),
3744 " %d %ld %ld %ld %ld",
3745 temp->attr_set_index,
3750 bv.bv_len += temp->querystr.bv_len + 2;
3751 bv.bv_val = ch_malloc( bv.bv_len+1 );
3754 ptr = lutil_strcopy( ptr, temp->querystr.bv_val );
3756 strcpy( ptr, c->cr_msg );
3757 ber_bvarray_add( &c->rvalue_vals, &bv );
3759 if ( !c->rvalue_vals )
3763 for (temp=qm->templates; temp; temp=temp->qmnext) {
3764 if ( !temp->bindttr ) continue;
3765 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ),
3767 temp->attr_set_index,
3769 ldap_pvt_scope2str( temp->bindscope ));
3770 bv.bv_len += temp->bindbase.bv_len + temp->bindftemp.bv_len + 4;
3771 bv.bv_val = ch_malloc( bv.bv_len + 1 );
3774 ptr = lutil_strcopy( ptr, temp->bindftemp.bv_val );
3776 ptr = lutil_strcopy( ptr, c->cr_msg );
3778 ptr = lutil_strcopy( ptr, temp->bindbase.bv_val );
3781 ber_bvarray_add( &c->rvalue_vals, &bv );
3783 if ( !c->rvalue_vals )
3787 if ( cm->response_cb == PCACHE_RESPONSE_CB_HEAD ) {
3788 BER_BVSTR( &bv, "head" );
3790 BER_BVSTR( &bv, "tail" );
3792 value_add_one( &c->rvalue_vals, &bv );
3795 c->value_int = cm->max_queries;
3798 c->value_int = (cm->cc_paused & PCACHE_CC_OFFLINE) != 0;
3802 } else if ( c->op == LDAP_MOD_DELETE ) {
3805 case PC_ATTR: /* FIXME */
3810 cm->cc_paused &= ~PCACHE_CC_OFFLINE;
3811 /* If there were cached queries when we went offline,
3812 * restart the checker now.
3814 if ( cm->num_cached_queries ) {
3815 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
3817 ldap_pvt_runqueue_resched( &slapd_rq, cm->cc_arg, 0 );
3818 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
3828 if ( cm->numattrsets > 0 ) {
3829 snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"pcache\" directive already provided" );
3830 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3834 if ( lutil_atoi( &cm->numattrsets, c->argv[3] ) != 0 ) {
3835 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse num attrsets=\"%s\" (arg #3)",
3837 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3840 if ( cm->numattrsets <= 0 ) {
3841 snprintf( c->cr_msg, sizeof( c->cr_msg ), "numattrsets (arg #3) must be positive" );
3842 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3845 if ( cm->numattrsets > MAX_ATTR_SETS ) {
3846 snprintf( c->cr_msg, sizeof( c->cr_msg ), "numattrsets (arg #3) must be <= %d", MAX_ATTR_SETS );
3847 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3851 if ( !backend_db_init( c->argv[1], &cm->db, -1, NULL )) {
3852 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unknown backend type (arg #1)" );
3853 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3857 if ( lutil_atoi( &cm->max_entries, c->argv[2] ) != 0 ) {
3858 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse max entries=\"%s\" (arg #2)",
3860 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3863 if ( cm->max_entries <= 0 ) {
3864 snprintf( c->cr_msg, sizeof( c->cr_msg ), "max entries (arg #2) must be positive.\n" );
3865 Debug( LDAP_DEBUG_CONFIG, "%s: %s\n", c->log, c->cr_msg, 0 );
3869 if ( lutil_atoi( &cm->num_entries_limit, c->argv[4] ) != 0 ) {
3870 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse entry limit=\"%s\" (arg #4)",
3872 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3875 if ( cm->num_entries_limit <= 0 ) {
3876 snprintf( c->cr_msg, sizeof( c->cr_msg ), "entry limit (arg #4) must be positive" );
3877 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3880 if ( cm->num_entries_limit > cm->max_entries ) {
3881 snprintf( c->cr_msg, sizeof( c->cr_msg ), "entry limit (arg #4) must be less than max entries %d (arg #2)", cm->max_entries );
3882 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3886 if ( lutil_parse_time( c->argv[5], &t ) != 0 ) {
3887 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse period=\"%s\" (arg #5)",
3889 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3893 cm->cc_period = (time_t)t;
3894 Debug( pcache_debug,
3895 "Total # of attribute sets to be cached = %d.\n",
3896 cm->numattrsets, 0, 0 );
3897 qm->attr_sets = ( struct attr_set * )ch_calloc( cm->numattrsets,
3898 sizeof( struct attr_set ) );
3901 if ( cm->numattrsets == 0 ) {
3902 snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"pcache\" directive not provided yet" );
3903 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3906 if ( lutil_atoi( &num, c->argv[1] ) != 0 ) {
3907 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse attrset #=\"%s\"",
3909 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3913 if ( num < 0 || num >= cm->numattrsets ) {
3914 snprintf( c->cr_msg, sizeof( c->cr_msg ), "attrset index %d out of bounds (must be %s%d)",
3915 num, cm->numattrsets > 1 ? "0->" : "", cm->numattrsets - 1 );
3916 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3919 qm->attr_sets[num].flags |= PC_CONFIGURED;
3920 if ( c->argc == 2 ) {
3922 snprintf( c->cr_msg, sizeof( c->cr_msg ),
3923 "need an explicit attr in attrlist; use \"*\" to indicate all attrs" );
3924 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3927 } else if ( c->argc == 3 ) {
3928 if ( strcmp( c->argv[2], LDAP_ALL_USER_ATTRIBUTES ) == 0 ) {
3929 qm->attr_sets[num].count = 1;
3930 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( 2,
3931 sizeof( AttributeName ) );
3932 BER_BVSTR( &qm->attr_sets[num].attrs[0].an_name, LDAP_ALL_USER_ATTRIBUTES );
3935 } else if ( strcmp( c->argv[2], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 ) {
3936 qm->attr_sets[num].count = 1;
3937 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( 2,
3938 sizeof( AttributeName ) );
3939 BER_BVSTR( &qm->attr_sets[num].attrs[0].an_name, LDAP_ALL_OPERATIONAL_ATTRIBUTES );
3942 } else if ( strcmp( c->argv[2], LDAP_NO_ATTRS ) == 0 ) {
3945 /* else: fallthru */
3947 } else if ( c->argc == 4 ) {
3948 if ( ( strcmp( c->argv[2], LDAP_ALL_USER_ATTRIBUTES ) == 0 && strcmp( c->argv[3], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 )
3949 || ( strcmp( c->argv[2], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 && strcmp( c->argv[3], LDAP_ALL_USER_ATTRIBUTES ) == 0 ) )
3951 qm->attr_sets[num].count = 2;
3952 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( 3,
3953 sizeof( AttributeName ) );
3954 BER_BVSTR( &qm->attr_sets[num].attrs[0].an_name, LDAP_ALL_USER_ATTRIBUTES );
3955 BER_BVSTR( &qm->attr_sets[num].attrs[1].an_name, LDAP_ALL_OPERATIONAL_ATTRIBUTES );
3958 /* else: fallthru */
3961 if ( c->argc > 2 ) {
3962 int all_user = 0, all_op = 0;
3964 qm->attr_sets[num].count = c->argc - 2;
3965 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( c->argc - 1,
3966 sizeof( AttributeName ) );
3967 attr_name = qm->attr_sets[num].attrs;
3968 for ( i = 2; i < c->argc; i++ ) {
3969 attr_name->an_desc = NULL;
3970 if ( strcmp( c->argv[i], LDAP_NO_ATTRS ) == 0 ) {
3971 snprintf( c->cr_msg, sizeof( c->cr_msg ),
3972 "invalid attr #%d \"%s\" in attrlist",
3973 i - 2, c->argv[i] );
3974 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3975 ch_free( qm->attr_sets[num].attrs );
3976 qm->attr_sets[num].attrs = NULL;
3977 qm->attr_sets[num].count = 0;
3980 if ( strcmp( c->argv[i], LDAP_ALL_USER_ATTRIBUTES ) == 0 ) {
3982 BER_BVSTR( &attr_name->an_name, LDAP_ALL_USER_ATTRIBUTES );
3983 } else if ( strcmp( c->argv[i], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 ) {
3985 BER_BVSTR( &attr_name->an_name, LDAP_ALL_OPERATIONAL_ATTRIBUTES );
3987 if ( slap_str2ad( c->argv[i], &attr_name->an_desc, &text ) ) {
3988 strcpy( c->cr_msg, text );
3989 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3990 ch_free( qm->attr_sets[num].attrs );
3991 qm->attr_sets[num].attrs = NULL;
3992 qm->attr_sets[num].count = 0;
3995 attr_name->an_name = attr_name->an_desc->ad_cname;
3997 attr_name->an_oc = NULL;
3998 attr_name->an_flags = 0;
3999 if ( attr_name->an_desc == slap_schema.si_ad_objectClass )
4000 qm->attr_sets[num].flags |= PC_GOT_OC;
4002 BER_BVZERO( &attr_name->an_name );
4005 /* warn if list contains both "*" and "+" */
4006 if ( i > 4 && all_user && all_op ) {
4007 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4008 "warning: attribute list contains \"*\" and \"+\"" );
4009 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4014 if ( cm->numattrsets == 0 ) {
4015 snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"pcache\" directive not provided yet" );
4016 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4019 if ( lutil_atoi( &i, c->argv[2] ) != 0 ) {
4020 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse template #=\"%s\"",
4022 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4026 if ( i < 0 || i >= cm->numattrsets ||
4027 !(qm->attr_sets[i].flags & PC_CONFIGURED )) {
4028 snprintf( c->cr_msg, sizeof( c->cr_msg ), "template index %d invalid (%s%d)",
4029 i, cm->numattrsets > 1 ? "0->" : "", cm->numattrsets - 1 );
4030 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4034 AttributeName *attrs;
4036 cnt = template_attrs( c->argv[1], &qm->attr_sets[i], &attrs, &text );
4038 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse template: %s",
4040 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4043 temp = ch_calloc( 1, sizeof( QueryTemplate ));
4044 temp->qmnext = qm->templates;
4045 qm->templates = temp;
4046 temp->t_attrs.attrs = attrs;
4047 temp->t_attrs.count = cnt;
4049 ldap_pvt_thread_rdwr_init( &temp->t_rwlock );
4050 temp->query = temp->query_last = NULL;
4051 if ( lutil_parse_time( c->argv[3], &t ) != 0 ) {
4052 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4053 "unable to parse template ttl=\"%s\"",
4055 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4057 ch_free( temp->t_attrs.attrs );
4061 temp->ttl = (time_t)t;
4062 temp->negttl = (time_t)0;
4063 temp->limitttl = (time_t)0;
4064 temp->ttr = (time_t)0;
4065 switch ( c->argc ) {
4067 if ( lutil_parse_time( c->argv[6], &t ) != 0 ) {
4068 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4069 "unable to parse template ttr=\"%s\"",
4071 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4074 temp->ttr = (time_t)t;
4078 if ( lutil_parse_time( c->argv[5], &t ) != 0 ) {
4079 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4080 "unable to parse template sizelimit ttl=\"%s\"",
4082 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4085 temp->limitttl = (time_t)t;
4089 if ( lutil_parse_time( c->argv[4], &t ) != 0 ) {
4090 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4091 "unable to parse template negative ttl=\"%s\"",
4093 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4096 temp->negttl = (time_t)t;
4100 temp->no_of_queries = 0;
4102 ber_str2bv( c->argv[1], 0, 1, &temp->querystr );
4103 Debug( pcache_debug, "Template:\n", 0, 0, 0 );
4104 Debug( pcache_debug, " query template: %s\n",
4105 temp->querystr.bv_val, 0, 0 );
4106 temp->attr_set_index = i;
4107 qm->attr_sets[i].flags |= PC_REFERENCED;
4108 temp->qtnext = qm->attr_sets[i].templates;
4109 qm->attr_sets[i].templates = temp;
4110 Debug( pcache_debug, " attributes: \n", 0, 0, 0 );
4111 if ( ( attrarray = qm->attr_sets[i].attrs ) != NULL ) {
4112 for ( i=0; attrarray[i].an_name.bv_val; i++ )
4113 Debug( pcache_debug, "\t%s\n",
4114 attrarray[i].an_name.bv_val, 0, 0 );
4118 if ( !qm->templates ) {
4119 snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"pcacheTemplate\" directive not provided yet" );
4120 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4123 if ( lutil_atoi( &i, c->argv[2] ) != 0 ) {
4124 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse Bind index #=\"%s\"",
4126 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4130 if ( i < 0 || i >= cm->numattrsets ||
4131 !(qm->attr_sets[i].flags & PC_CONFIGURED )) {
4132 snprintf( c->cr_msg, sizeof( c->cr_msg ), "Bind index %d invalid (%s%d)",
4133 i, cm->numattrsets > 1 ? "0->" : "", cm->numattrsets - 1 );
4134 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4137 { struct berval bv, tempbv;
4138 AttributeDescription **descs;
4140 ber_str2bv( c->argv[1], 0, 0, &bv );
4141 ndescs = ftemp_attrs( &bv, &tempbv, &descs, &text );
4143 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse template: %s",
4145 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4148 for ( temp = qm->templates; temp; temp=temp->qmnext ) {
4149 if ( temp->attr_set_index == i && bvmatch( &tempbv,
4153 ch_free( tempbv.bv_val );
4156 snprintf( c->cr_msg, sizeof( c->cr_msg ), "Bind template %s %d invalid",
4158 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4161 ber_dupbv( &temp->bindftemp, &bv );
4162 temp->bindfattrs = descs;
4163 temp->bindnattrs = ndescs;
4165 if ( lutil_parse_time( c->argv[3], &t ) != 0 ) {
4166 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4167 "unable to parse bind ttr=\"%s\"",
4169 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4171 ch_free( temp->bindfattrs );
4172 temp->bindfattrs = NULL;
4173 ch_free( temp->bindftemp.bv_val );
4174 BER_BVZERO( &temp->bindftemp );
4177 num = ldap_pvt_str2scope( c->argv[4] );
4179 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4180 "unable to parse bind scope=\"%s\"",
4182 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4186 struct berval dn, ndn;
4187 ber_str2bv( c->argv[5], 0, 0, &dn );
4188 rc = dnNormalize( 0, NULL, NULL, &dn, &ndn, NULL );
4190 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4191 "invalid bind baseDN=\"%s\"",
4193 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4196 if ( temp->bindbase.bv_val )
4197 ch_free( temp->bindbase.bv_val );
4198 temp->bindbase = ndn;
4201 /* convert the template into dummy filter */
4203 char *eq = temp->bindftemp.bv_val, *e2;
4206 while ((eq = strchr(eq, '=' ))) {
4211 bv.bv_len = temp->bindftemp.bv_len + i;
4212 bv.bv_val = ch_malloc( bv.bv_len + 1 );
4213 for ( e2 = bv.bv_val, eq = temp->bindftemp.bv_val;
4224 f = str2filter( bv.bv_val );
4226 ch_free( bv.bv_val );
4227 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4228 "unable to parse bindfilter=\"%s\"", bv.bv_val );
4229 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4230 ch_free( temp->bindbase.bv_val );
4231 BER_BVZERO( &temp->bindbase );
4234 if ( temp->bindfilter )
4235 filter_free( temp->bindfilter );
4236 if ( temp->bindfilterstr.bv_val )
4237 ch_free( temp->bindfilterstr.bv_val );
4238 temp->bindfilterstr = bv;
4239 temp->bindfilter = f;
4241 temp->bindttr = (time_t)t;
4242 temp->bindscope = num;
4243 cm->cache_binds = 1;
4247 if ( strcasecmp( c->argv[1], "head" ) == 0 ) {
4248 cm->response_cb = PCACHE_RESPONSE_CB_HEAD;
4250 } else if ( strcasecmp( c->argv[1], "tail" ) == 0 ) {
4251 cm->response_cb = PCACHE_RESPONSE_CB_TAIL;
4254 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unknown specifier" );
4255 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4260 if ( c->value_int <= 0 ) {
4261 snprintf( c->cr_msg, sizeof( c->cr_msg ), "max queries must be positive" );
4262 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4265 cm->max_queries = c->value_int;
4269 cm->cc_paused |= PCACHE_CC_OFFLINE;
4271 cm->cc_paused &= ~PCACHE_CC_OFFLINE;
4274 if ( cm->db.be_private == NULL ) {
4275 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4276 "private database must be defined before setting database specific options" );
4277 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4281 if ( cm->db.bd_info->bi_cf_ocs ) {
4284 char *argv0 = c->argv[ 0 ];
4286 c->argv[ 0 ] = &argv0[ STRLENOF( "pcache-" ) ];
4288 ct = config_find_keyword( cm->db.bd_info->bi_cf_ocs->co_table, c );
4290 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4291 "private database does not recognize specific option '%s'",
4293 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4297 c->table = cm->db.bd_info->bi_cf_ocs->co_type;
4299 c->bi = c->be->bd_info;
4301 rc = config_add_vals( ct, c );
4305 c->table = c2.table;
4308 c->argv[ 0 ] = argv0;
4310 } else if ( cm->db.be_config != NULL ) {
4311 char *argv0 = c->argv[ 0 ];
4313 c->argv[ 0 ] = &argv0[ STRLENOF( "pcache-" ) ];
4314 rc = cm->db.be_config( &cm->db, c->fname, c->lineno, c->argc, c->argv );
4315 c->argv[ 0 ] = argv0;
4318 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4319 "no means to set private database specific options" );
4320 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4325 rc = SLAP_CONF_UNKNOWN;
4341 slap_overinst *on = (slap_overinst *)be->bd_info;
4342 cache_manager* cm = on->on_bi.bi_private;
4344 /* Something for the cache database? */
4345 if ( cm->db.bd_info && cm->db.bd_info->bi_db_config )
4346 return cm->db.bd_info->bi_db_config( &cm->db, fname, lineno,
4348 return SLAP_CONF_UNKNOWN;
4356 slap_overinst *on = (slap_overinst *)be->bd_info;
4360 cm = (cache_manager *)ch_malloc(sizeof(cache_manager));
4361 on->on_bi.bi_private = cm;
4363 qm = (query_manager*)ch_malloc(sizeof(query_manager));
4366 SLAP_DBFLAGS(&cm->db) |= SLAP_DBFLAG_NO_SCHEMA_CHECK;
4367 cm->db.be_private = NULL;
4368 cm->db.bd_self = &cm->db;
4370 cm->numattrsets = 0;
4371 cm->num_entries_limit = 5;
4372 cm->num_cached_queries = 0;
4373 cm->max_entries = 0;
4374 cm->cur_entries = 0;
4375 cm->max_queries = 10000;
4376 cm->save_queries = 0;
4377 cm->check_cacheability = 0;
4378 cm->response_cb = PCACHE_RESPONSE_CB_TAIL;
4379 cm->defer_db_open = 1;
4380 cm->cache_binds = 0;
4381 cm->cc_period = 1000;
4384 #ifdef PCACHE_MONITOR
4385 cm->monitor_cb = NULL;
4386 #endif /* PCACHE_MONITOR */
4388 qm->attr_sets = NULL;
4389 qm->templates = NULL;
4391 qm->lru_bottom = NULL;
4393 qm->qcfunc = query_containment;
4394 qm->crfunc = cache_replacement;
4395 qm->addfunc = add_query;
4396 ldap_pvt_thread_mutex_init(&qm->lru_mutex);
4398 ldap_pvt_thread_mutex_init(&cm->cache_mutex);
4400 #ifndef PCACHE_MONITOR
4402 #else /* PCACHE_MONITOR */
4403 return pcache_monitor_db_init( be );
4404 #endif /* PCACHE_MONITOR */
4408 pcache_cachedquery_open_cb( Operation *op, SlapReply *rs )
4410 assert( op->o_tag == LDAP_REQ_SEARCH );
4412 if ( rs->sr_type == REP_SEARCH ) {
4415 a = attr_find( rs->sr_entry->e_attrs, ad_cachedQueryURL );
4419 assert( a->a_nvals != NULL );
4421 valsp = op->o_callback->sc_private;
4422 assert( *valsp == NULL );
4424 ber_bvarray_dup_x( valsp, a->a_nvals, op->o_tmpmemctx );
4432 pcache_cachedquery_count_cb( Operation *op, SlapReply *rs )
4434 assert( op->o_tag == LDAP_REQ_SEARCH );
4436 if ( rs->sr_type == REP_SEARCH ) {
4437 int *countp = (int *)op->o_callback->sc_private;
4450 cache_manager *cm = on->on_bi.bi_private;
4451 query_manager* qm = cm->qm;
4454 rc = backend_startup_one( &cm->db, cr );
4456 cm->defer_db_open = 0;
4459 /* There is no runqueue in TOOL mode */
4460 if (( slapMode & SLAP_SERVER_MODE ) && rc == 0 ) {
4461 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
4462 ldap_pvt_runqueue_insert( &slapd_rq, cm->cc_period,
4463 consistency_check, on,
4464 "pcache_consistency", cm->db.be_suffix[0].bv_val );
4465 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
4467 /* Cached database must have the rootdn */
4468 if ( BER_BVISNULL( &cm->db.be_rootndn )
4469 || BER_BVISEMPTY( &cm->db.be_rootndn ) )
4471 Debug( LDAP_DEBUG_ANY, "pcache_db_open(): "
4472 "underlying database of type \"%s\"\n"
4473 " serving naming context \"%s\"\n"
4474 " has no \"rootdn\", required by \"pcache\".\n",
4475 on->on_info->oi_orig->bi_type,
4476 cm->db.be_suffix[0].bv_val, 0 );
4480 if ( cm->save_queries ) {
4481 void *thrctx = ldap_pvt_thread_pool_context();
4482 Connection conn = { 0 };
4483 OperationBuffer opbuf;
4485 slap_callback cb = { 0 };
4486 SlapReply rs = { 0 };
4487 BerVarray vals = NULL;
4488 Filter f = { 0 }, f2 = { 0 };
4489 AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
4490 AttributeName attrs[ 2 ] = {{{ 0 }}};
4492 connection_fake_init( &conn, &opbuf, thrctx );
4497 op->o_tag = LDAP_REQ_SEARCH;
4498 op->o_protocol = LDAP_VERSION3;
4499 cb.sc_response = pcache_cachedquery_open_cb;
4500 cb.sc_private = &vals;
4501 op->o_callback = &cb;
4502 op->o_time = slap_get_time();
4503 op->o_do_not_cache = 1;
4504 op->o_managedsait = SLAP_CONTROL_CRITICAL;
4506 op->o_dn = cm->db.be_rootdn;
4507 op->o_ndn = cm->db.be_rootndn;
4508 op->o_req_dn = cm->db.be_suffix[ 0 ];
4509 op->o_req_ndn = cm->db.be_nsuffix[ 0 ];
4511 op->ors_scope = LDAP_SCOPE_BASE;
4512 op->ors_deref = LDAP_DEREF_NEVER;
4514 op->ors_tlimit = SLAP_NO_LIMIT;
4515 op->ors_limit = NULL;
4516 ber_str2bv( "(pcacheQueryURL=*)", 0, 0, &op->ors_filterstr );
4517 f.f_choice = LDAP_FILTER_PRESENT;
4518 f.f_desc = ad_cachedQueryURL;
4519 op->ors_filter = &f;
4520 attrs[ 0 ].an_desc = ad_cachedQueryURL;
4521 attrs[ 0 ].an_name = ad_cachedQueryURL->ad_cname;
4522 op->ors_attrs = attrs;
4523 op->ors_attrsonly = 0;
4525 rc = op->o_bd->be_search( op, &rs );
4526 if ( rc == LDAP_SUCCESS && vals != NULL ) {
4529 for ( i = 0; !BER_BVISNULL( &vals[ i ] ); i++ ) {
4530 if ( url2query( vals[ i ].bv_val, op, qm ) == 0 ) {
4531 cm->num_cached_queries++;
4535 ber_bvarray_free_x( vals, op->o_tmpmemctx );
4538 /* count cached entries */
4539 f.f_choice = LDAP_FILTER_NOT;
4541 f2.f_choice = LDAP_FILTER_EQUALITY;
4543 f2.f_av_desc = slap_schema.si_ad_objectClass;
4544 BER_BVSTR( &f2.f_av_value, "glue" );
4545 ber_str2bv( "(!(objectClass=glue))", 0, 0, &op->ors_filterstr );
4547 op->ors_slimit = SLAP_NO_LIMIT;
4548 op->ors_scope = LDAP_SCOPE_SUBTREE;
4549 op->ors_attrs = slap_anlist_no_attrs;
4551 op->o_callback->sc_response = pcache_cachedquery_count_cb;
4553 op->o_callback->sc_private = &rs.sr_nentries;
4555 rc = op->o_bd->be_search( op, &rs );
4557 cm->cur_entries = rs.sr_nentries;
4571 slap_overinst *on = (slap_overinst *)be->bd_info;
4572 cache_manager *cm = on->on_bi.bi_private;
4573 query_manager* qm = cm->qm;
4574 int i, ncf = 0, rf = 0, nrf = 0, rc = 0;
4576 /* check attr sets */
4577 for ( i = 0; i < cm->numattrsets; i++) {
4578 if ( !( qm->attr_sets[i].flags & PC_CONFIGURED ) ) {
4579 if ( qm->attr_sets[i].flags & PC_REFERENCED ) {
4580 Debug( LDAP_DEBUG_CONFIG, "pcache: attr set #%d not configured but referenced.\n", i, 0, 0 );
4584 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, attr set #%d not configured.\n", i, 0, 0 );
4588 } else if ( !( qm->attr_sets[i].flags & PC_REFERENCED ) ) {
4589 Debug( LDAP_DEBUG_CONFIG, "pcache: attr set #%d configured but not referenced.\n", i, 0, 0 );
4594 if ( ncf || rf || nrf ) {
4595 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, %d attr sets configured but not referenced.\n", nrf, 0, 0 );
4596 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, %d attr sets not configured.\n", ncf, 0, 0 );
4597 Debug( LDAP_DEBUG_CONFIG, "pcache: %d attr sets not configured but referenced.\n", rf, 0, 0 );
4604 /* need to inherit something from the original database... */
4605 cm->db.be_def_limit = be->be_def_limit;
4606 cm->db.be_limits = be->be_limits;
4607 cm->db.be_acl = be->be_acl;
4608 cm->db.be_dfltaccess = be->be_dfltaccess;
4610 if ( SLAP_DBMONITORING( be ) ) {
4611 SLAP_DBFLAGS( &cm->db ) |= SLAP_DBFLAG_MONITORING;
4614 SLAP_DBFLAGS( &cm->db ) &= ~SLAP_DBFLAG_MONITORING;
4617 if ( !cm->defer_db_open ) {
4618 rc = pcache_db_open2( on, cr );
4621 #ifdef PCACHE_MONITOR
4622 if ( rc == LDAP_SUCCESS ) {
4623 rc = pcache_monitor_db_open( be );
4625 #endif /* PCACHE_MONITOR */
4631 pcache_free_qbase( void *v )
4637 tavl_free( qb->scopes[i], NULL );
4647 slap_overinst *on = (slap_overinst *)be->bd_info;
4648 cache_manager *cm = on->on_bi.bi_private;
4649 query_manager *qm = cm->qm;
4653 /* stop the thread ... */
4655 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
4656 if ( ldap_pvt_runqueue_isrunning( &slapd_rq, cm->cc_arg ) ) {
4657 ldap_pvt_runqueue_stoptask( &slapd_rq, cm->cc_arg );
4659 ldap_pvt_runqueue_remove( &slapd_rq, cm->cc_arg );
4660 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
4663 if ( cm->save_queries ) {
4665 BerVarray vals = NULL;
4668 Connection conn = { 0 };
4669 OperationBuffer opbuf;
4671 slap_callback cb = { 0 };
4673 SlapReply rs = { REP_RESULT };
4674 Modifications mod = {{ 0 }};
4676 thrctx = ldap_pvt_thread_pool_context();
4678 connection_fake_init( &conn, &opbuf, thrctx );
4681 if ( qm->templates != NULL ) {
4682 for ( tm = qm->templates; tm != NULL; tm = tm->qmnext ) {
4683 for ( qc = tm->query; qc; qc = qc->next ) {
4686 if ( query2url( op, qc, &bv, 0 ) == 0 ) {
4687 ber_bvarray_add_x( &vals, &bv, op->o_tmpmemctx );
4694 op->o_dn = cm->db.be_rootdn;
4695 op->o_ndn = cm->db.be_rootndn;
4697 op->o_tag = LDAP_REQ_MODIFY;
4698 op->o_protocol = LDAP_VERSION3;
4699 cb.sc_response = slap_null_cb;
4700 op->o_callback = &cb;
4701 op->o_time = slap_get_time();
4702 op->o_do_not_cache = 1;
4703 op->o_managedsait = SLAP_CONTROL_CRITICAL;
4705 op->o_req_dn = op->o_bd->be_suffix[0];
4706 op->o_req_ndn = op->o_bd->be_nsuffix[0];
4708 mod.sml_op = LDAP_MOD_REPLACE;
4710 mod.sml_desc = ad_cachedQueryURL;
4711 mod.sml_type = ad_cachedQueryURL->ad_cname;
4712 mod.sml_values = vals;
4713 mod.sml_nvalues = NULL;
4714 mod.sml_numvals = 1;
4715 mod.sml_next = NULL;
4716 Debug( pcache_debug,
4717 "%sSETTING CACHED QUERY URLS\n",
4718 vals == NULL ? "RE" : "", 0, 0 );
4720 op->orm_modlist = &mod;
4722 op->o_bd->be_modify( op, &rs );
4724 ber_bvarray_free_x( vals, op->o_tmpmemctx );
4727 /* cleanup stuff inherited from the original database... */
4728 cm->db.be_limits = NULL;
4729 cm->db.be_acl = NULL;
4732 if ( cm->db.bd_info->bi_db_close ) {
4733 rc = cm->db.bd_info->bi_db_close( &cm->db, NULL );
4735 while ( (tm = qm->templates) != NULL ) {
4736 CachedQuery *qc, *qn;
4737 qm->templates = tm->qmnext;
4738 for ( qc = tm->query; qc; qc = qn ) {
4742 avl_free( tm->qbase, pcache_free_qbase );
4743 free( tm->querystr.bv_val );
4744 free( tm->bindfattrs );
4745 free( tm->bindftemp.bv_val );
4746 free( tm->bindfilterstr.bv_val );
4747 free( tm->bindbase.bv_val );
4748 filter_free( tm->bindfilter );
4749 ldap_pvt_thread_rdwr_destroy( &tm->t_rwlock );
4750 free( tm->t_attrs.attrs );
4754 for ( i=0; i<cm->numattrsets; i++ ) {
4755 free( qm->attr_sets[i].attrs );
4757 free( qm->attr_sets );
4758 qm->attr_sets = NULL;
4760 #ifdef PCACHE_MONITOR
4761 if ( rc == LDAP_SUCCESS ) {
4762 rc = pcache_monitor_db_close( be );
4764 #endif /* PCACHE_MONITOR */
4775 slap_overinst *on = (slap_overinst *)be->bd_info;
4776 cache_manager *cm = on->on_bi.bi_private;
4777 query_manager *qm = cm->qm;
4779 if ( cm->db.be_private != NULL ) {
4780 backend_stopdown_one( &cm->db );
4783 ldap_pvt_thread_mutex_destroy( &qm->lru_mutex );
4784 ldap_pvt_thread_mutex_destroy( &cm->cache_mutex );
4788 #ifdef PCACHE_MONITOR
4789 pcache_monitor_db_destroy( be );
4790 #endif /* PCACHE_MONITOR */
4795 #ifdef PCACHE_CONTROL_PRIVDB
4797 Control ::= SEQUENCE {
4798 controlType LDAPOID,
4799 criticality BOOLEAN DEFAULT FALSE,
4800 controlValue OCTET STRING OPTIONAL }
4802 controlType ::= 1.3.6.1.4.1.4203.666.11.9.5.1
4804 * criticality must be TRUE; controlValue must be absent.
4812 if ( op->o_ctrlflag[ privDB_cid ] != SLAP_CONTROL_NONE ) {
4813 rs->sr_text = "privateDB control specified multiple times";
4814 return LDAP_PROTOCOL_ERROR;
4817 if ( !BER_BVISNULL( &ctrl->ldctl_value ) ) {
4818 rs->sr_text = "privateDB control value not absent";
4819 return LDAP_PROTOCOL_ERROR;
4822 if ( !ctrl->ldctl_iscritical ) {
4823 rs->sr_text = "privateDB control criticality required";
4824 return LDAP_PROTOCOL_ERROR;
4827 op->o_ctrlflag[ privDB_cid ] = SLAP_CONTROL_CRITICAL;
4829 return LDAP_SUCCESS;
4832 static char *extops[] = {
4833 LDAP_EXOP_MODIFY_PASSWD,
4836 #endif /* PCACHE_CONTROL_PRIVDB */
4838 static struct berval pcache_exop_MODIFY_PASSWD = BER_BVC( LDAP_EXOP_MODIFY_PASSWD );
4839 #ifdef PCACHE_EXOP_QUERY_DELETE
4840 static struct berval pcache_exop_QUERY_DELETE = BER_BVC( PCACHE_EXOP_QUERY_DELETE );
4842 #define LDAP_TAG_EXOP_QUERY_DELETE_BASE ((LBER_CLASS_CONTEXT|LBER_CONSTRUCTED) + 0)
4843 #define LDAP_TAG_EXOP_QUERY_DELETE_DN ((LBER_CLASS_CONTEXT|LBER_CONSTRUCTED) + 1)
4844 #define LDAP_TAG_EXOP_QUERY_DELETE_UUID ((LBER_CLASS_CONTEXT|LBER_CONSTRUCTED) + 2)
4847 ExtendedRequest ::= [APPLICATION 23] SEQUENCE {
4848 requestName [0] LDAPOID,
4849 requestValue [1] OCTET STRING OPTIONAL }
4851 requestName ::= 1.3.6.1.4.1.4203.666.11.9.6.1
4853 requestValue ::= SEQUENCE { CHOICE {
4855 entryDN [1] LDAPDN },
4856 queryID [2] OCTET STRING (SIZE(16))
4857 -- constrained to UUID }
4859 * Either baseDN or entryDN must be present, to allow database selection.
4861 * 1. if baseDN and queryID are present, then the query corresponding
4862 * to queryID is deleted;
4863 * 2. if baseDN is present and queryID is absent, then all queries
4865 * 3. if entryDN is present and queryID is absent, then all queries
4866 * corresponding to the queryID values present in entryDN are deleted;
4867 * 4. if entryDN and queryID are present, then all queries
4868 * corresponding to the queryID values present in entryDN are deleted,
4869 * but only if the value of queryID is contained in the entry;
4871 * Currently, only 1, 3 and 4 are implemented. 2 can be obtained by either
4872 * recursively deleting the database (ldapdelete -r) with PRIVDB control,
4873 * or by removing the database files.
4875 ExtendedResponse ::= [APPLICATION 24] SEQUENCE {
4876 COMPONENTS OF LDAPResult,
4877 responseName [10] LDAPOID OPTIONAL,
4878 responseValue [11] OCTET STRING OPTIONAL }
4880 * responseName and responseValue must be absent.
4884 * - on success, *tagp is either LDAP_TAG_EXOP_QUERY_DELETE_BASE
4885 * or LDAP_TAG_EXOP_QUERY_DELETE_DN.
4886 * - if ndn != NULL, it is set to the normalized DN in the request
4887 * corresponding to either the baseDN or the entryDN, according
4888 * to *tagp; memory is malloc'ed on the Operation's slab, and must
4889 * be freed by the caller.
4890 * - if uuid != NULL, it is set to point to the normalized UUID;
4891 * memory is malloc'ed on the Operation's slab, and must
4892 * be freed by the caller.
4895 pcache_parse_query_delete(
4899 struct berval *uuid,
4903 int rc = LDAP_SUCCESS;
4906 BerElementBuffer berbuf;
4907 BerElement *ber = (BerElement *)&berbuf;
4908 struct berval reqdata = BER_BVNULL;
4920 if ( in == NULL || in->bv_len == 0 ) {
4921 *text = "empty request data field in queryDelete exop";
4922 return LDAP_PROTOCOL_ERROR;
4925 ber_dupbv_x( &reqdata, in, ctx );
4927 /* ber_init2 uses reqdata directly, doesn't allocate new buffers */
4928 ber_init2( ber, &reqdata, 0 );
4930 tag = ber_scanf( ber, "{" /*}*/ );
4932 if ( tag == LBER_ERROR ) {
4933 Debug( LDAP_DEBUG_TRACE,
4934 "pcache_parse_query_delete: decoding error.\n",
4936 goto decoding_error;
4939 tag = ber_peek_tag( ber, &len );
4940 if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_BASE
4941 || tag == LDAP_TAG_EXOP_QUERY_DELETE_DN )
4945 if ( ndn != NULL ) {
4948 tag = ber_scanf( ber, "m", &dn );
4949 if ( tag == LBER_ERROR ) {
4950 Debug( LDAP_DEBUG_TRACE,
4951 "pcache_parse_query_delete: DN parse failed.\n",
4953 goto decoding_error;
4956 rc = dnNormalize( 0, NULL, NULL, &dn, ndn, ctx );
4957 if ( rc != LDAP_SUCCESS ) {
4958 *text = "invalid DN in queryDelete exop request data";
4963 tag = ber_scanf( ber, "x" /* "m" */ );
4964 if ( tag == LBER_DEFAULT ) {
4965 goto decoding_error;
4969 tag = ber_peek_tag( ber, &len );
4972 if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_UUID ) {
4973 if ( uuid != NULL ) {
4975 char uuidbuf[ LDAP_LUTIL_UUIDSTR_BUFSIZE ];
4977 tag = ber_scanf( ber, "m", &bv );
4978 if ( tag == LBER_ERROR ) {
4979 Debug( LDAP_DEBUG_TRACE,
4980 "pcache_parse_query_delete: UUID parse failed.\n",
4982 goto decoding_error;
4985 if ( bv.bv_len != 16 ) {
4986 Debug( LDAP_DEBUG_TRACE,
4987 "pcache_parse_query_delete: invalid UUID length %lu.\n",
4988 (unsigned long)bv.bv_len, 0, 0 );
4989 goto decoding_error;
4992 rc = lutil_uuidstr_from_normalized(
4993 bv.bv_val, bv.bv_len,
4994 uuidbuf, sizeof( uuidbuf ) );
4996 goto decoding_error;
4998 ber_str2bv( uuidbuf, rc, 1, uuid );
5002 tag = ber_skip_tag( ber, &len );
5003 if ( tag == LBER_DEFAULT ) {
5004 goto decoding_error;
5008 Debug( LDAP_DEBUG_TRACE,
5009 "pcache_parse_query_delete: invalid UUID length %lu.\n",
5010 (unsigned long)len, 0, 0 );
5011 goto decoding_error;
5015 tag = ber_peek_tag( ber, &len );
5018 if ( tag != LBER_DEFAULT || len != 0 ) {
5020 Debug( LDAP_DEBUG_TRACE,
5021 "pcache_parse_query_delete: decoding error\n",
5023 rc = LDAP_PROTOCOL_ERROR;
5024 *text = "queryDelete data decoding error";
5027 if ( ndn && !BER_BVISNULL( ndn ) ) {
5028 slap_sl_free( ndn->bv_val, ctx );
5032 if ( uuid && !BER_BVISNULL( uuid ) ) {
5033 slap_sl_free( uuid->bv_val, ctx );
5038 if ( !BER_BVISNULL( &reqdata ) ) {
5039 ber_memfree_x( reqdata.bv_val, ctx );
5046 pcache_exop_query_delete(
5050 BackendDB *bd = op->o_bd;
5052 struct berval uuid = BER_BVNULL,
5054 char buf[ SLAP_TEXT_BUFLEN ];
5056 ber_tag_t tag = LBER_DEFAULT;
5058 if ( LogTest( LDAP_DEBUG_STATS ) ) {
5062 rs->sr_err = pcache_parse_query_delete( op->ore_reqdata,
5063 &tag, &op->o_req_ndn, uuidp,
5064 &rs->sr_text, op->o_tmpmemctx );
5065 if ( rs->sr_err != LDAP_SUCCESS ) {
5069 if ( LogTest( LDAP_DEBUG_STATS ) ) {
5070 assert( !BER_BVISNULL( &op->o_req_ndn ) );
5071 len = snprintf( buf, sizeof( buf ), " dn=\"%s\"", op->o_req_ndn.bv_val );
5073 if ( !BER_BVISNULL( &uuid ) && len < sizeof( buf ) ) {
5074 snprintf( &buf[ len ], sizeof( buf ) - len, " pcacheQueryId=\"%s\"", uuid.bv_val );
5077 Debug( LDAP_DEBUG_STATS, "%s QUERY DELETE%s\n",
5078 op->o_log_prefix, buf, 0 );
5080 op->o_req_dn = op->o_req_ndn;
5082 op->o_bd = select_backend( &op->o_req_ndn, 0 );
5083 rs->sr_err = backend_check_restrictions( op, rs,
5084 (struct berval *)&pcache_exop_QUERY_DELETE );
5085 if ( rs->sr_err != LDAP_SUCCESS ) {
5089 if ( op->o_bd->be_extended == NULL ) {
5090 send_ldap_error( op, rs, LDAP_UNAVAILABLE_CRITICAL_EXTENSION,
5091 "backend does not support extended operations" );
5095 op->o_bd->be_extended( op, rs );
5098 if ( !BER_BVISNULL( &op->o_req_ndn ) ) {
5099 op->o_tmpfree( op->o_req_ndn.bv_val, op->o_tmpmemctx );
5100 BER_BVZERO( &op->o_req_ndn );
5101 BER_BVZERO( &op->o_req_dn );
5104 if ( !BER_BVISNULL( &uuid ) ) {
5105 op->o_tmpfree( uuid.bv_val, op->o_tmpmemctx );
5112 #endif /* PCACHE_EXOP_QUERY_DELETE */
5115 pcache_op_extended( Operation *op, SlapReply *rs )
5117 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
5118 cache_manager *cm = on->on_bi.bi_private;
5120 #ifdef PCACHE_CONTROL_PRIVDB
5121 if ( op->o_ctrlflag[ privDB_cid ] == SLAP_CONTROL_CRITICAL ) {
5122 return pcache_op_privdb( op, rs );
5124 #endif /* PCACHE_CONTROL_PRIVDB */
5126 #ifdef PCACHE_EXOP_QUERY_DELETE
5127 if ( bvmatch( &op->ore_reqoid, &pcache_exop_QUERY_DELETE ) ) {
5128 struct berval uuid = BER_BVNULL;
5129 ber_tag_t tag = LBER_DEFAULT;
5131 rs->sr_err = pcache_parse_query_delete( op->ore_reqdata,
5132 &tag, NULL, &uuid, &rs->sr_text, op->o_tmpmemctx );
5133 assert( rs->sr_err == LDAP_SUCCESS );
5135 if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_DN ) {
5136 /* remove all queries related to the selected entry */
5137 rs->sr_err = pcache_remove_entry_queries_from_cache( op,
5138 cm, &op->o_req_ndn, &uuid );
5140 } else if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_BASE ) {
5141 if ( !BER_BVISNULL( &uuid ) ) {
5142 /* remove the selected query */
5143 rs->sr_err = pcache_remove_query_from_cache( op,
5147 /* TODO: remove all queries */
5148 rs->sr_err = LDAP_UNWILLING_TO_PERFORM;
5149 rs->sr_text = "deletion of all queries not implemented";
5153 op->o_tmpfree( uuid.bv_val, op->o_tmpmemctx );
5156 #endif /* PCACHE_EXOP_QUERY_DELETE */
5158 /* We only care if we're configured for Bind caching */
5159 if ( bvmatch( &op->ore_reqoid, &pcache_exop_MODIFY_PASSWD ) &&
5161 /* See if the local entry exists and has a password.
5162 * It's too much work to find the matching query, so
5163 * we just see if there's a hashed password to update.
5165 Operation op2 = *op;
5171 op2.o_dn = op->o_bd->be_rootdn;
5172 op2.o_ndn = op->o_bd->be_rootndn;
5173 rc = be_entry_get_rw( &op2, &op->o_req_ndn, NULL,
5174 slap_schema.si_ad_userPassword, 0, &e );
5175 if ( rc == LDAP_SUCCESS && e ) {
5176 /* See if a recognized password is hashed here */
5177 Attribute *a = attr_find( e->e_attrs,
5178 slap_schema.si_ad_userPassword );
5179 if ( a && a->a_vals[0].bv_val[0] == '{' &&
5180 lutil_passwd_scheme( a->a_vals[0].bv_val )) {
5183 be_entry_release_r( &op2, e );
5187 rc = overlay_op_walk( op, rs, op_extended, on->on_info,
5189 if ( rc == LDAP_SUCCESS ) {
5190 req_pwdexop_s *qpw = &op->oq_pwdexop;
5192 /* We don't care if it succeeds or not */
5193 pc_setpw( &op2, &qpw->rs_new, cm );
5198 return SLAP_CB_CONTINUE;
5201 #ifdef PCACHE_MONITOR
5204 pcache_monitor_update(
5210 cache_manager *cm = (cache_manager *) priv;
5211 query_manager *qm = cm->qm;
5214 BerVarray vals = NULL;
5216 attr_delete( &e->e_attrs, ad_cachedQueryURL );
5217 if ( ( SLAP_OPATTRS( rs->sr_attr_flags ) || ad_inlist( ad_cachedQueryURL, rs->sr_attrs ) )
5218 && qm->templates != NULL )
5222 for ( tm = qm->templates; tm != NULL; tm = tm->qmnext ) {
5223 for ( qc = tm->query; qc; qc = qc->next ) {
5226 if ( query2url( op, qc, &bv, 1 ) == 0 ) {
5227 ber_bvarray_add_x( &vals, &bv, op->o_tmpmemctx );
5233 if ( vals != NULL ) {
5234 attr_merge_normalize( e, ad_cachedQueryURL, vals, NULL );
5235 ber_bvarray_free_x( vals, op->o_tmpmemctx );
5241 char buf[ SLAP_TEXT_BUFLEN ];
5244 /* number of cached queries */
5245 a = attr_find( e->e_attrs, ad_numQueries );
5246 assert( a != NULL );
5249 bv.bv_len = snprintf( buf, sizeof( buf ), "%lu", cm->num_cached_queries );
5251 if ( a->a_nvals != a->a_vals ) {
5252 ber_bvreplace( &a->a_nvals[ 0 ], &bv );
5254 ber_bvreplace( &a->a_vals[ 0 ], &bv );
5256 /* number of cached entries */
5257 a = attr_find( e->e_attrs, ad_numEntries );
5258 assert( a != NULL );
5261 bv.bv_len = snprintf( buf, sizeof( buf ), "%d", cm->cur_entries );
5263 if ( a->a_nvals != a->a_vals ) {
5264 ber_bvreplace( &a->a_nvals[ 0 ], &bv );
5266 ber_bvreplace( &a->a_vals[ 0 ], &bv );
5269 return SLAP_CB_CONTINUE;
5273 pcache_monitor_free(
5277 struct berval values[ 2 ];
5278 Modification mod = { 0 };
5281 char textbuf[ SLAP_TEXT_BUFLEN ];
5285 /* NOTE: if slap_shutdown != 0, priv might have already been freed */
5288 /* Remove objectClass */
5289 mod.sm_op = LDAP_MOD_DELETE;
5290 mod.sm_desc = slap_schema.si_ad_objectClass;
5291 mod.sm_values = values;
5293 values[ 0 ] = oc_olmPCache->soc_cname;
5294 BER_BVZERO( &values[ 1 ] );
5296 rc = modify_delete_values( e, &mod, 1, &text,
5297 textbuf, sizeof( textbuf ) );
5298 /* don't care too much about return code... */
5301 mod.sm_values = NULL;
5302 mod.sm_desc = ad_cachedQueryURL;
5304 rc = modify_delete_values( e, &mod, 1, &text,
5305 textbuf, sizeof( textbuf ) );
5306 /* don't care too much about return code... */
5309 mod.sm_values = NULL;
5310 mod.sm_desc = ad_numQueries;
5312 rc = modify_delete_values( e, &mod, 1, &text,
5313 textbuf, sizeof( textbuf ) );
5314 /* don't care too much about return code... */
5317 mod.sm_values = NULL;
5318 mod.sm_desc = ad_numEntries;
5320 rc = modify_delete_values( e, &mod, 1, &text,
5321 textbuf, sizeof( textbuf ) );
5322 /* don't care too much about return code... */
5324 return SLAP_CB_CONTINUE;
5328 * call from within pcache_initialize()
5331 pcache_monitor_initialize( void )
5333 static int pcache_monitor_initialized = 0;
5335 if ( backend_info( "monitor" ) == NULL ) {
5339 if ( pcache_monitor_initialized++ ) {
5347 pcache_monitor_db_init( BackendDB *be )
5349 if ( pcache_monitor_initialize() == LDAP_SUCCESS ) {
5350 SLAP_DBFLAGS( be ) |= SLAP_DBFLAG_MONITORING;
5357 pcache_monitor_db_open( BackendDB *be )
5359 slap_overinst *on = (slap_overinst *)be->bd_info;
5360 cache_manager *cm = on->on_bi.bi_private;
5361 Attribute *a, *next;
5362 monitor_callback_t *cb = NULL;
5365 monitor_extra_t *mbe;
5366 struct berval dummy = BER_BVC( "" );
5368 if ( !SLAP_DBMONITORING( be ) ) {
5372 mi = backend_info( "monitor" );
5373 if ( !mi || !mi->bi_extra ) {
5374 SLAP_DBFLAGS( be ) ^= SLAP_DBFLAG_MONITORING;
5379 /* don't bother if monitor is not configured */
5380 if ( !mbe->is_configured() ) {
5381 static int warning = 0;
5383 if ( warning++ == 0 ) {
5384 Debug( LDAP_DEBUG_ANY, "pcache_monitor_db_open: "
5385 "monitoring disabled; "
5386 "configure monitor database to enable\n",
5393 /* alloc as many as required (plus 1 for objectClass) */
5394 a = attrs_alloc( 1 + 2 );
5400 a->a_desc = slap_schema.si_ad_objectClass;
5401 attr_valadd( a, &oc_olmPCache->soc_cname, NULL, 1 );
5405 struct berval bv = BER_BVC( "0" );
5407 next->a_desc = ad_numQueries;
5408 attr_valadd( next, &bv, NULL, 1 );
5409 next = next->a_next;
5411 next->a_desc = ad_numEntries;
5412 attr_valadd( next, &bv, NULL, 1 );
5413 next = next->a_next;
5416 cb = ch_calloc( sizeof( monitor_callback_t ), 1 );
5417 cb->mc_update = pcache_monitor_update;
5418 cb->mc_free = pcache_monitor_free;
5419 cb->mc_private = (void *)cm;
5421 /* make sure the database is registered; then add monitor attributes */
5422 BER_BVZERO( &cm->monitor_ndn );
5423 rc = mbe->register_overlay( be, on, &cm->monitor_ndn );
5425 rc = mbe->register_entry_attrs( &cm->monitor_ndn, a, cb,
5426 &dummy, -1, &dummy);
5442 /* store for cleanup */
5443 cm->monitor_cb = (void *)cb;
5445 /* we don't need to keep track of the attributes, because
5446 * bdb_monitor_free() takes care of everything */
5455 pcache_monitor_db_close( BackendDB *be )
5457 slap_overinst *on = (slap_overinst *)be->bd_info;
5458 cache_manager *cm = on->on_bi.bi_private;
5460 if ( cm->monitor_cb != NULL ) {
5461 BackendInfo *mi = backend_info( "monitor" );
5462 monitor_extra_t *mbe;
5464 if ( mi && &mi->bi_extra ) {
5466 mbe->unregister_entry_callback( NULL,
5467 (monitor_callback_t *)cm->monitor_cb,
5476 pcache_monitor_db_destroy( BackendDB *be )
5481 #endif /* PCACHE_MONITOR */
5483 static slap_overinst pcache;
5485 static char *obsolete_names[] = {
5490 #if SLAPD_OVER_PROXYCACHE == SLAPD_MOD_DYNAMIC
5492 #endif /* SLAPD_OVER_PROXYCACHE == SLAPD_MOD_DYNAMIC */
5497 struct berval debugbv = BER_BVC("pcache");
5501 code = slap_loglevel_get( &debugbv, &pcache_debug );
5506 #ifdef PCACHE_CONTROL_PRIVDB
5507 code = register_supported_control( PCACHE_CONTROL_PRIVDB,
5508 SLAP_CTRL_BIND|SLAP_CTRL_ACCESS|SLAP_CTRL_HIDE, extops,
5509 parse_privdb_ctrl, &privDB_cid );
5510 if ( code != LDAP_SUCCESS ) {
5511 Debug( LDAP_DEBUG_ANY,
5512 "pcache_initialize: failed to register control %s (%d)\n",
5513 PCACHE_CONTROL_PRIVDB, code, 0 );
5516 #endif /* PCACHE_CONTROL_PRIVDB */
5518 #ifdef PCACHE_EXOP_QUERY_DELETE
5519 code = load_extop2( (struct berval *)&pcache_exop_QUERY_DELETE,
5520 SLAP_EXOP_WRITES|SLAP_EXOP_HIDE, pcache_exop_query_delete,
5522 if ( code != LDAP_SUCCESS ) {
5523 Debug( LDAP_DEBUG_ANY,
5524 "pcache_initialize: unable to register queryDelete exop: %d.\n",
5528 #endif /* PCACHE_EXOP_QUERY_DELETE */
5530 argv[ 0 ] = "back-bdb/back-hdb monitor";
5535 for ( i = 0; s_oid[ i ].name; i++ ) {
5537 argv[ 1 ] = s_oid[ i ].name;
5538 argv[ 2 ] = s_oid[ i ].oid;
5540 if ( parse_oidm( &c, 0, NULL ) != 0 ) {
5541 Debug( LDAP_DEBUG_ANY, "pcache_initialize: "
5542 "unable to add objectIdentifier \"%s=%s\"\n",
5543 s_oid[ i ].name, s_oid[ i ].oid, 0 );
5548 for ( i = 0; s_ad[i].desc != NULL; i++ ) {
5549 code = register_at( s_ad[i].desc, s_ad[i].adp, 0 );
5551 Debug( LDAP_DEBUG_ANY,
5552 "pcache_initialize: register_at #%d failed\n", i, 0, 0 );
5555 (*s_ad[i].adp)->ad_type->sat_flags |= SLAP_AT_HIDE;
5558 for ( i = 0; s_oc[i].desc != NULL; i++ ) {
5559 code = register_oc( s_oc[i].desc, s_oc[i].ocp, 0 );
5561 Debug( LDAP_DEBUG_ANY,
5562 "pcache_initialize: register_oc #%d failed\n", i, 0, 0 );
5565 (*s_oc[i].ocp)->soc_flags |= SLAP_OC_HIDE;
5568 pcache.on_bi.bi_type = "pcache";
5569 pcache.on_bi.bi_obsolete_names = obsolete_names;
5570 pcache.on_bi.bi_db_init = pcache_db_init;
5571 pcache.on_bi.bi_db_config = pcache_db_config;
5572 pcache.on_bi.bi_db_open = pcache_db_open;
5573 pcache.on_bi.bi_db_close = pcache_db_close;
5574 pcache.on_bi.bi_db_destroy = pcache_db_destroy;
5576 pcache.on_bi.bi_op_search = pcache_op_search;
5577 pcache.on_bi.bi_op_bind = pcache_op_bind;
5578 #ifdef PCACHE_CONTROL_PRIVDB
5579 pcache.on_bi.bi_op_compare = pcache_op_privdb;
5580 pcache.on_bi.bi_op_modrdn = pcache_op_privdb;
5581 pcache.on_bi.bi_op_modify = pcache_op_privdb;
5582 pcache.on_bi.bi_op_add = pcache_op_privdb;
5583 pcache.on_bi.bi_op_delete = pcache_op_privdb;
5584 #endif /* PCACHE_CONTROL_PRIVDB */
5585 pcache.on_bi.bi_extended = pcache_op_extended;
5587 pcache.on_bi.bi_chk_controls = pcache_chk_controls;
5589 pcache.on_bi.bi_cf_ocs = pcocs;
5591 code = config_register_schema( pccfg, pcocs );
5592 if ( code ) return code;
5594 return overlay_register( &pcache );
5597 #if SLAPD_OVER_PROXYCACHE == SLAPD_MOD_DYNAMIC
5598 int init_module(int argc, char *argv[]) {
5599 return pcache_initialize();
5603 #endif /* defined(SLAPD_OVER_PROXYCACHE) */