2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 2003-2010 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 );
771 if ( query.filter == NULL ) {
776 tempstr.bv_val = ch_malloc( strlen( lud->lud_filter ) + 1 );
778 if ( filter2template( op, query.filter, &tempstr ) ) {
779 ch_free( tempstr.bv_val );
784 /* check for query containment */
785 qt = qm->attr_sets[attrset].templates;
786 for ( ; qt; qt = qt->qtnext ) {
787 /* find if template i can potentially answer tempstr */
788 if ( bvmatch( &qt->querystr, &tempstr ) ) {
798 cq = add_query( op, qm, &query, qt, PC_POSITIVE, 0 );
800 cq->expiry_time = expiry_time;
801 cq->refresh_time = refresh_time;
803 cq->answerable_cnt = answerable_cnt;
806 /* it's now into cq->filter */
816 if ( query.filter != NULL ) filter_free( query.filter );
817 if ( !BER_BVISNULL( &tempstr ) ) ch_free( tempstr.bv_val );
818 if ( !BER_BVISNULL( &query.base ) ) ch_free( query.base.bv_val );
819 if ( !BER_BVISNULL( &uuid ) ) ch_free( uuid.bv_val );
820 if ( lud != NULL ) ldap_free_urldesc( lud );
825 /* Return 1 for an added entry, else 0 */
831 struct berval* query_uuid )
834 Modifications* modlist = NULL;
835 const char* text = NULL;
837 char textbuf[SLAP_TEXT_BUFLEN];
838 size_t textlen = sizeof(textbuf);
840 SlapReply sreply = {REP_RESULT};
842 slap_callback cb = { NULL, slap_null_cb, NULL, NULL };
849 /* add queryId attribute */
850 attr_merge_one( e, ad_queryId, query_uuid, NULL );
852 /* append the attribute list from the fetched entry */
853 e->e_attrs->a_next = attr;
855 op->o_tag = LDAP_REQ_ADD;
856 op->o_protocol = LDAP_VERSION3;
857 op->o_callback = &cb;
858 op->o_time = slap_get_time();
859 op->o_do_not_cache = 1;
862 op->o_req_dn = e->e_name;
863 op->o_req_ndn = e->e_nname;
864 rc = op->o_bd->be_add( op, &sreply );
866 if ( rc != LDAP_SUCCESS ) {
867 if ( rc == LDAP_ALREADY_EXISTS ) {
868 slap_entry2mods( e, &modlist, &text, textbuf, textlen );
869 modlist->sml_op = LDAP_MOD_ADD;
870 op->o_tag = LDAP_REQ_MODIFY;
871 op->orm_modlist = modlist;
872 op->o_managedsait = SLAP_CONTROL_CRITICAL;
873 op->o_bd->be_modify( op, &sreply );
874 slap_mods_free( modlist, 1 );
875 } else if ( rc == LDAP_REFERRAL ||
876 rc == LDAP_NO_SUCH_OBJECT ) {
877 syncrepl_add_glue( op, e );
886 if ( op->ora_e == e )
894 /* Length-ordered sort on normalized DNs */
895 static int pcache_dn_cmp( const void *v1, const void *v2 )
897 const Qbase *q1 = v1, *q2 = v2;
899 int rc = q1->base.bv_len - q2->base.bv_len;
901 rc = strncmp( q1->base.bv_val, q2->base.bv_val, q1->base.bv_len );
905 static int lex_bvcmp( struct berval *bv1, struct berval *bv2 )
908 dif = bv1->bv_len - bv2->bv_len;
910 if ( dif > 0 ) len -= dif;
911 len = memcmp( bv1->bv_val, bv2->bv_val, len );
917 /* compare the current value in each filter */
918 static int pcache_filter_cmp( Filter *f1, Filter *f2 )
920 int rc, weight1, weight2;
922 switch( f1->f_choice ) {
923 case LDAP_FILTER_PRESENT:
926 case LDAP_FILTER_EQUALITY:
934 switch( f2->f_choice ) {
935 case LDAP_FILTER_PRESENT:
938 case LDAP_FILTER_EQUALITY:
946 rc = weight1 - weight2;
952 rc = lex_bvcmp( &f1->f_av_value, &f2->f_av_value );
955 if ( f1->f_choice == LDAP_FILTER_SUBSTRINGS ) {
957 if ( !BER_BVISNULL( &f1->f_sub_initial )) {
958 if ( !BER_BVISNULL( &f2->f_sub_initial )) {
959 rc = lex_bvcmp( &f1->f_sub_initial,
960 &f2->f_sub_initial );
964 } else if ( !BER_BVISNULL( &f2->f_sub_initial )) {
968 if ( f1->f_sub_any ) {
969 if ( f2->f_sub_any ) {
970 rc = lex_bvcmp( f1->f_sub_any,
975 } else if ( f2->f_sub_any ) {
979 if ( !BER_BVISNULL( &f1->f_sub_final )) {
980 if ( !BER_BVISNULL( &f2->f_sub_final )) {
981 rc = lex_bvcmp( &f1->f_sub_final,
986 } else if ( !BER_BVISNULL( &f2->f_sub_final )) {
990 rc = lex_bvcmp( &f1->f_mr_value,
1004 while ( f1->f_choice == LDAP_FILTER_AND || f1->f_choice == LDAP_FILTER_OR )
1006 while ( f2->f_choice == LDAP_FILTER_AND || f2->f_choice == LDAP_FILTER_OR )
1008 rc = pcache_filter_cmp( f1, f2 );
1016 /* compare filters in each query */
1017 static int pcache_query_cmp( const void *v1, const void *v2 )
1019 const CachedQuery *q1 = v1, *q2 =v2;
1020 return pcache_filter_cmp( q1->first, q2->first );
1023 /* add query on top of LRU list */
1025 add_query_on_top (query_manager* qm, CachedQuery* qc)
1027 CachedQuery* top = qm->lru_top;
1034 qm->lru_bottom = qc;
1038 Debug( pcache_debug, "Base of added query = %s\n",
1039 qc->qbase->base.bv_val, 0, 0 );
1042 /* remove_query from LRU list */
1045 remove_query (query_manager* qm, CachedQuery* qc)
1054 down = qc->lru_down;
1060 qm->lru_bottom = up;
1066 up->lru_down = down;
1068 qc->lru_up = qc->lru_down = NULL;
1071 /* find and remove string2 from string1
1072 * from start if position = 1,
1073 * from end if position = 3,
1074 * from anywhere if position = 2
1075 * string1 is overwritten if position = 2.
1079 find_and_remove(struct berval* ber1, struct berval* ber2, int position)
1083 if ( !ber2->bv_val )
1085 if ( !ber1->bv_val )
1088 switch( position ) {
1090 if ( ber1->bv_len >= ber2->bv_len && !memcmp( ber1->bv_val,
1091 ber2->bv_val, ber2->bv_len )) {
1093 ber1->bv_val += ber2->bv_len;
1094 ber1->bv_len -= ber2->bv_len;
1099 ber1->bv_val[ber1->bv_len] = '\0';
1100 temp = strstr( ber1->bv_val, ber2->bv_val );
1102 strcpy( temp, temp+ber2->bv_len );
1103 ber1->bv_len -= ber2->bv_len;
1109 if ( ber1->bv_len >= ber2->bv_len &&
1110 !memcmp( ber1->bv_val+ber1->bv_len-ber2->bv_len, ber2->bv_val,
1113 ber1->bv_len -= ber2->bv_len;
1121 static struct berval*
1122 merge_init_final(Operation *op, struct berval* init, struct berval* any,
1123 struct berval* final)
1125 struct berval* merged, *temp;
1126 int i, any_count, count;
1128 for (any_count=0; any && any[any_count].bv_val; any_count++)
1138 merged = (struct berval*)op->o_tmpalloc( (count+1)*sizeof(struct berval),
1143 ber_dupbv_x( temp, init, op->o_tmpmemctx );
1147 for (i=0; i<any_count; i++) {
1148 ber_dupbv_x( temp, any, op->o_tmpmemctx );
1153 ber_dupbv_x( temp, final, op->o_tmpmemctx );
1160 /* Each element in stored must be found in incoming. Incoming is overwritten.
1163 strings_containment(struct berval* stored, struct berval* incoming)
1165 struct berval* element;
1169 for ( element=stored; element->bv_val != NULL; element++ ) {
1170 for (j = k; incoming[j].bv_val != NULL; j++) {
1171 if (find_and_remove(&(incoming[j]), element, 2)) {
1188 substr_containment_substr(Operation *op, Filter* stored, Filter* incoming)
1192 struct berval init_incoming;
1193 struct berval final_incoming;
1194 struct berval *remaining_incoming = NULL;
1196 if ((!(incoming->f_sub_initial.bv_val) && (stored->f_sub_initial.bv_val))
1197 || (!(incoming->f_sub_final.bv_val) && (stored->f_sub_final.bv_val)))
1200 init_incoming = incoming->f_sub_initial;
1201 final_incoming = incoming->f_sub_final;
1203 if (find_and_remove(&init_incoming,
1204 &(stored->f_sub_initial), 1) && find_and_remove(&final_incoming,
1205 &(stored->f_sub_final), 3))
1207 if (stored->f_sub_any == NULL) {
1211 remaining_incoming = merge_init_final(op, &init_incoming,
1212 incoming->f_sub_any, &final_incoming);
1213 rc = strings_containment(stored->f_sub_any, remaining_incoming);
1214 ber_bvarray_free_x( remaining_incoming, op->o_tmpmemctx );
1221 substr_containment_equality(Operation *op, Filter* stored, Filter* incoming)
1223 struct berval incoming_val[2];
1226 incoming_val[1] = incoming->f_av_value;
1228 if (find_and_remove(incoming_val+1,
1229 &(stored->f_sub_initial), 1) && find_and_remove(incoming_val+1,
1230 &(stored->f_sub_final), 3)) {
1231 if (stored->f_sub_any == NULL){
1235 ber_dupbv_x( incoming_val, incoming_val+1, op->o_tmpmemctx );
1236 BER_BVZERO( incoming_val+1 );
1237 rc = strings_containment(stored->f_sub_any, incoming_val);
1238 op->o_tmpfree( incoming_val[0].bv_val, op->o_tmpmemctx );
1245 filter_first( Filter *f )
1247 while ( f->f_choice == LDAP_FILTER_OR || f->f_choice == LDAP_FILTER_AND )
1253 static CachedQuery *
1254 find_filter( Operation *op, Avlnode *root, Filter *inputf, Filter *first )
1258 MatchingRule* mrule = NULL;
1259 int res=0, eqpass= 0;
1262 CachedQuery cq, *qc;
1267 /* substring matches sort to the end, and we just have to
1268 * walk the entire list.
1270 if ( first->f_choice == LDAP_FILTER_SUBSTRINGS ) {
1271 ptr = tavl_end( root, 1 );
1272 dir = TAVL_DIR_LEFT;
1274 ptr = tavl_find3( root, &cq, pcache_query_cmp, &ret );
1275 dir = (first->f_choice == LDAP_FILTER_GE) ? TAVL_DIR_LEFT :
1284 /* an incoming substr query can only be satisfied by a cached
1287 if ( first->f_choice == LDAP_FILTER_SUBSTRINGS &&
1288 qc->first->f_choice != LDAP_FILTER_SUBSTRINGS )
1291 /* an incoming eq query can be satisfied by a cached eq or substr
1294 if ( first->f_choice == LDAP_FILTER_EQUALITY ) {
1295 if ( eqpass == 0 ) {
1296 if ( qc->first->f_choice != LDAP_FILTER_EQUALITY ) {
1297 nextpass: eqpass = 1;
1298 ptr = tavl_end( root, 1 );
1299 dir = TAVL_DIR_LEFT;
1303 if ( qc->first->f_choice != LDAP_FILTER_SUBSTRINGS )
1309 switch (fs->f_choice) {
1310 case LDAP_FILTER_EQUALITY:
1311 if (fi->f_choice == LDAP_FILTER_EQUALITY)
1312 mrule = fs->f_ava->aa_desc->ad_type->sat_equality;
1316 case LDAP_FILTER_GE:
1317 case LDAP_FILTER_LE:
1318 mrule = fs->f_ava->aa_desc->ad_type->sat_ordering;
1325 rc = value_match(&ret, fs->f_ava->aa_desc, mrule,
1326 SLAP_MR_VALUE_OF_ASSERTION_SYNTAX,
1327 &(fi->f_ava->aa_value),
1328 &(fs->f_ava->aa_value), &text);
1329 if (rc != LDAP_SUCCESS) {
1332 if ( fi==first && fi->f_choice==LDAP_FILTER_EQUALITY && ret )
1335 switch (fs->f_choice) {
1336 case LDAP_FILTER_OR:
1337 case LDAP_FILTER_AND:
1342 case LDAP_FILTER_SUBSTRINGS:
1343 /* check if the equality query can be
1344 * answered with cached substring query */
1345 if ((fi->f_choice == LDAP_FILTER_EQUALITY)
1346 && substr_containment_equality( op,
1349 /* check if the substring query can be
1350 * answered with cached substring query */
1351 if ((fi->f_choice ==LDAP_FILTER_SUBSTRINGS
1352 ) && substr_containment_substr( op,
1358 case LDAP_FILTER_PRESENT:
1363 case LDAP_FILTER_EQUALITY:
1369 case LDAP_FILTER_GE:
1370 if (mrule && ret >= 0)
1375 case LDAP_FILTER_LE:
1376 if (mrule && ret <= 0)
1381 case LDAP_FILTER_NOT:
1387 } while((res) && (fi != NULL) && (fs != NULL));
1391 ptr = tavl_next( ptr, dir );
1396 /* check whether query is contained in any of
1397 * the cached queries in template
1399 static CachedQuery *
1400 query_containment(Operation *op, query_manager *qm,
1402 QueryTemplate *templa)
1405 int depth = 0, tscope;
1406 Qbase qbase, *qbptr = NULL;
1409 if (query->filter != NULL) {
1412 Debug( pcache_debug, "Lock QC index = %p\n",
1413 (void *) templa, 0, 0 );
1414 qbase.base = query->base;
1416 first = filter_first( query->filter );
1418 ldap_pvt_thread_rdwr_rlock(&templa->t_rwlock);
1421 qbptr = avl_find( templa->qbase, &qbase, pcache_dn_cmp );
1423 tscope = query->scope;
1424 /* Find a matching scope:
1425 * match at depth 0 OK
1428 * subord at depth > 0 OK
1429 * subtree at any depth OK
1431 * subtree or subord at any depth OK
1433 * subtree or subord at any depth OK
1435 * subord at depth > 0 OK
1436 * subtree at any depth OK
1438 for ( tscope = 0 ; tscope <= LDAP_SCOPE_CHILDREN; tscope++ ) {
1439 switch ( query->scope ) {
1440 case LDAP_SCOPE_BASE:
1441 if ( tscope == LDAP_SCOPE_BASE && depth ) continue;
1442 if ( tscope == LDAP_SCOPE_ONE && depth != 1) continue;
1443 if ( tscope == LDAP_SCOPE_CHILDREN && !depth ) continue;
1445 case LDAP_SCOPE_ONE:
1446 if ( tscope == LDAP_SCOPE_BASE )
1447 tscope = LDAP_SCOPE_ONE;
1448 if ( tscope == LDAP_SCOPE_ONE && depth ) continue;
1449 if ( !depth ) break;
1450 if ( tscope < LDAP_SCOPE_SUBTREE )
1451 tscope = LDAP_SCOPE_SUBTREE;
1453 case LDAP_SCOPE_SUBTREE:
1454 if ( tscope < LDAP_SCOPE_SUBTREE )
1455 tscope = LDAP_SCOPE_SUBTREE;
1456 if ( tscope == LDAP_SCOPE_CHILDREN && !depth ) continue;
1458 case LDAP_SCOPE_CHILDREN:
1459 if ( tscope < LDAP_SCOPE_SUBTREE )
1460 tscope = LDAP_SCOPE_SUBTREE;
1463 if ( !qbptr->scopes[tscope] ) continue;
1466 qc = find_filter( op, qbptr->scopes[tscope],
1467 query->filter, first );
1469 if ( qc->q_sizelimit ) {
1470 ldap_pvt_thread_rdwr_runlock(&templa->t_rwlock);
1473 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
1474 if (qm->lru_top != qc) {
1475 remove_query(qm, qc);
1476 add_query_on_top(qm, qc);
1478 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1483 if ( be_issuffix( op->o_bd, &qbase.base ))
1486 dnParent( &qbase.base, &pdn );
1491 Debug( pcache_debug,
1492 "Not answerable: Unlock QC index=%p\n",
1493 (void *) templa, 0, 0 );
1494 ldap_pvt_thread_rdwr_runlock(&templa->t_rwlock);
1500 free_query (CachedQuery* qc)
1502 free(qc->q_uuid.bv_val);
1503 filter_free(qc->filter);
1504 ldap_pvt_thread_mutex_destroy(&qc->answerable_cnt_mutex);
1505 ldap_pvt_thread_rdwr_destroy( &qc->rwlock );
1506 memset(qc, 0, sizeof(*qc));
1511 /* Add query to query cache, the returned Query is locked for writing */
1512 static CachedQuery *
1517 QueryTemplate *templ,
1518 pc_caching_reason_t why,
1521 CachedQuery* new_cached_query = (CachedQuery*) ch_malloc(sizeof(CachedQuery));
1525 time_t ttl = 0, ttr = 0;
1528 new_cached_query->qtemp = templ;
1529 BER_BVZERO( &new_cached_query->q_uuid );
1530 new_cached_query->q_sizelimit = 0;
1532 now = slap_get_time();
1537 ttr = now + templ->ttr;
1541 ttl = templ->negttl;
1545 ttl = templ->limitttl;
1552 new_cached_query->expiry_time = now + ttl;
1553 new_cached_query->refresh_time = ttr;
1555 new_cached_query->answerable_cnt = 0;
1556 new_cached_query->refcnt = 1;
1557 ldap_pvt_thread_mutex_init(&new_cached_query->answerable_cnt_mutex);
1559 new_cached_query->lru_up = NULL;
1560 new_cached_query->lru_down = NULL;
1561 Debug( pcache_debug, "Added query expires at %ld (%s)\n",
1562 (long) new_cached_query->expiry_time,
1563 pc_caching_reason_str[ why ], 0 );
1565 new_cached_query->scope = query->scope;
1566 new_cached_query->filter = query->filter;
1567 new_cached_query->first = first = filter_first( query->filter );
1569 ldap_pvt_thread_rdwr_init(&new_cached_query->rwlock);
1571 ldap_pvt_thread_rdwr_wlock(&new_cached_query->rwlock);
1573 qb.base = query->base;
1575 /* Adding a query */
1576 Debug( pcache_debug, "Lock AQ index = %p\n",
1577 (void *) templ, 0, 0 );
1578 ldap_pvt_thread_rdwr_wlock(&templ->t_rwlock);
1579 qbase = avl_find( templ->qbase, &qb, pcache_dn_cmp );
1581 qbase = ch_calloc( 1, sizeof(Qbase) + qb.base.bv_len + 1 );
1582 qbase->base.bv_len = qb.base.bv_len;
1583 qbase->base.bv_val = (char *)(qbase+1);
1584 memcpy( qbase->base.bv_val, qb.base.bv_val, qb.base.bv_len );
1585 qbase->base.bv_val[qbase->base.bv_len] = '\0';
1586 avl_insert( &templ->qbase, qbase, pcache_dn_cmp, avl_dup_error );
1588 new_cached_query->next = templ->query;
1589 new_cached_query->prev = NULL;
1590 new_cached_query->qbase = qbase;
1591 rc = tavl_insert( &qbase->scopes[query->scope], new_cached_query,
1592 pcache_query_cmp, avl_dup_error );
1595 if (templ->query == NULL)
1596 templ->query_last = new_cached_query;
1598 templ->query->prev = new_cached_query;
1599 templ->query = new_cached_query;
1600 templ->no_of_queries++;
1602 ldap_pvt_thread_mutex_destroy(&new_cached_query->answerable_cnt_mutex);
1603 ldap_pvt_thread_rdwr_destroy( &new_cached_query->rwlock );
1604 ch_free( new_cached_query );
1605 new_cached_query = find_filter( op, qbase->scopes[query->scope],
1606 query->filter, first );
1607 filter_free( query->filter );
1608 query->filter = NULL;
1610 Debug( pcache_debug, "TEMPLATE %p QUERIES++ %d\n",
1611 (void *) templ, templ->no_of_queries, 0 );
1613 Debug( pcache_debug, "Unlock AQ index = %p \n",
1614 (void *) templ, 0, 0 );
1615 ldap_pvt_thread_rdwr_wunlock(&templ->t_rwlock);
1617 /* Adding on top of LRU list */
1619 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
1620 add_query_on_top(qm, new_cached_query);
1621 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1623 return rc == 0 ? new_cached_query : NULL;
1627 remove_from_template (CachedQuery* qc, QueryTemplate* template)
1629 if (!qc->prev && !qc->next) {
1630 template->query_last = template->query = NULL;
1631 } else if (qc->prev == NULL) {
1632 qc->next->prev = NULL;
1633 template->query = qc->next;
1634 } else if (qc->next == NULL) {
1635 qc->prev->next = NULL;
1636 template->query_last = qc->prev;
1638 qc->next->prev = qc->prev;
1639 qc->prev->next = qc->next;
1641 tavl_delete( &qc->qbase->scopes[qc->scope], qc, pcache_query_cmp );
1642 qc->qbase->queries--;
1643 if ( qc->qbase->queries == 0 ) {
1644 avl_delete( &template->qbase, qc->qbase, pcache_dn_cmp );
1645 ch_free( qc->qbase );
1649 template->no_of_queries--;
1652 /* remove bottom query of LRU list from the query cache */
1654 * NOTE: slight change in functionality.
1656 * - if result->bv_val is NULL, the query at the bottom of the LRU
1658 * - otherwise, the query whose UUID is *result is removed
1659 * - if not found, result->bv_val is zeroed
1662 cache_replacement(query_manager* qm, struct berval *result)
1664 CachedQuery* bottom;
1665 QueryTemplate *temp;
1667 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
1668 if ( BER_BVISNULL( result ) ) {
1669 bottom = qm->lru_bottom;
1672 Debug ( pcache_debug,
1673 "Cache replacement invoked without "
1674 "any query in LRU list\n", 0, 0, 0 );
1675 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1680 for ( bottom = qm->lru_bottom;
1682 bottom = bottom->lru_up )
1684 if ( bvmatch( result, &bottom->q_uuid ) ) {
1690 Debug ( pcache_debug,
1691 "Could not find query with uuid=\"%s\""
1692 "in LRU list\n", result->bv_val, 0, 0 );
1693 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1694 BER_BVZERO( result );
1699 temp = bottom->qtemp;
1700 remove_query(qm, bottom);
1701 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1703 *result = bottom->q_uuid;
1704 BER_BVZERO( &bottom->q_uuid );
1706 Debug( pcache_debug, "Lock CR index = %p\n", (void *) temp, 0, 0 );
1707 ldap_pvt_thread_rdwr_wlock(&temp->t_rwlock);
1708 remove_from_template(bottom, temp);
1709 Debug( pcache_debug, "TEMPLATE %p QUERIES-- %d\n",
1710 (void *) temp, temp->no_of_queries, 0 );
1711 Debug( pcache_debug, "Unlock CR index = %p\n", (void *) temp, 0, 0 );
1712 ldap_pvt_thread_rdwr_wunlock(&temp->t_rwlock);
1717 struct query_info *next;
1729 struct query_info *qi;
1732 if ( rs->sr_type != REP_SEARCH ) return 0;
1734 attr = attr_find( rs->sr_entry->e_attrs, ad_queryId );
1735 if ( attr == NULL ) return 0;
1737 count = attr->a_numvals;
1738 assert( count > 0 );
1739 qi = op->o_tmpalloc( sizeof( struct query_info ), op->o_tmpmemctx );
1740 qi->next = op->o_callback->sc_private;
1741 op->o_callback->sc_private = qi;
1742 ber_dupbv_x( &qi->xdn, &rs->sr_entry->e_nname, op->o_tmpmemctx );
1743 qi->del = ( count == 1 );
1752 struct berval *query_uuid )
1754 struct query_info *qi, *qnext;
1755 char filter_str[ LDAP_LUTIL_UUIDSTR_BUFSIZE + STRLENOF( "(pcacheQueryID=)" ) ];
1756 AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
1757 Filter filter = {LDAP_FILTER_EQUALITY};
1758 SlapReply sreply = {REP_RESULT};
1759 slap_callback cb = { NULL, remove_func, NULL, NULL };
1762 sreply.sr_entry = NULL;
1763 sreply.sr_nentries = 0;
1764 op->ors_filterstr.bv_len = snprintf(filter_str, sizeof(filter_str),
1765 "(%s=%s)", ad_queryId->ad_cname.bv_val, query_uuid->bv_val);
1766 filter.f_ava = &ava;
1767 filter.f_av_desc = ad_queryId;
1768 filter.f_av_value = *query_uuid;
1770 op->o_tag = LDAP_REQ_SEARCH;
1771 op->o_protocol = LDAP_VERSION3;
1772 op->o_callback = &cb;
1773 op->o_time = slap_get_time();
1774 op->o_do_not_cache = 1;
1776 op->o_req_dn = op->o_bd->be_suffix[0];
1777 op->o_req_ndn = op->o_bd->be_nsuffix[0];
1778 op->ors_scope = LDAP_SCOPE_SUBTREE;
1779 op->ors_deref = LDAP_DEREF_NEVER;
1780 op->ors_slimit = SLAP_NO_LIMIT;
1781 op->ors_tlimit = SLAP_NO_LIMIT;
1782 op->ors_limit = NULL;
1783 op->ors_filter = &filter;
1784 op->ors_filterstr.bv_val = filter_str;
1785 op->ors_filterstr.bv_len = strlen(filter_str);
1786 op->ors_attrs = NULL;
1787 op->ors_attrsonly = 0;
1789 op->o_bd->be_search( op, &sreply );
1791 for ( qi=cb.sc_private; qi; qi=qnext ) {
1794 op->o_req_dn = qi->xdn;
1795 op->o_req_ndn = qi->xdn;
1798 Debug( pcache_debug, "DELETING ENTRY TEMPLATE=%s\n",
1799 query_uuid->bv_val, 0, 0 );
1801 op->o_tag = LDAP_REQ_DELETE;
1803 if (op->o_bd->be_delete(op, &sreply) == LDAP_SUCCESS) {
1809 struct berval vals[2];
1811 vals[0] = *query_uuid;
1812 vals[1].bv_val = NULL;
1814 mod.sml_op = LDAP_MOD_DELETE;
1816 mod.sml_desc = ad_queryId;
1817 mod.sml_type = ad_queryId->ad_cname;
1818 mod.sml_values = vals;
1819 mod.sml_nvalues = NULL;
1820 mod.sml_numvals = 1;
1821 mod.sml_next = NULL;
1822 Debug( pcache_debug,
1823 "REMOVING TEMP ATTR : TEMPLATE=%s\n",
1824 query_uuid->bv_val, 0, 0 );
1826 op->orm_modlist = &mod;
1828 op->o_bd->be_modify( op, &sreply );
1830 op->o_tmpfree( qi->xdn.bv_val, op->o_tmpmemctx );
1831 op->o_tmpfree( qi, op->o_tmpmemctx );
1838 AttributeName* attrs,
1847 struct berval *fstr )
1849 AttributeDescription *ad;
1852 switch ( f->f_choice ) {
1853 case LDAP_FILTER_EQUALITY:
1855 len = STRLENOF( "(=)" ) + ad->ad_cname.bv_len;
1856 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s=)", ad->ad_cname.bv_val );
1857 assert( ret == len );
1858 fstr->bv_len += len;
1861 case LDAP_FILTER_GE:
1863 len = STRLENOF( "(>=)" ) + ad->ad_cname.bv_len;
1864 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s>=)", ad->ad_cname.bv_val);
1865 assert( ret == len );
1866 fstr->bv_len += len;
1869 case LDAP_FILTER_LE:
1871 len = STRLENOF( "(<=)" ) + ad->ad_cname.bv_len;
1872 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s<=)", ad->ad_cname.bv_val);
1873 assert( ret == len );
1874 fstr->bv_len += len;
1877 case LDAP_FILTER_APPROX:
1879 len = STRLENOF( "(~=)" ) + ad->ad_cname.bv_len;
1880 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s~=)", ad->ad_cname.bv_val);
1881 assert( ret == len );
1882 fstr->bv_len += len;
1885 case LDAP_FILTER_SUBSTRINGS:
1887 len = STRLENOF( "(=)" ) + ad->ad_cname.bv_len;
1888 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s=)", ad->ad_cname.bv_val );
1889 assert( ret == len );
1890 fstr->bv_len += len;
1893 case LDAP_FILTER_PRESENT:
1895 len = STRLENOF( "(=*)" ) + ad->ad_cname.bv_len;
1896 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s=*)", ad->ad_cname.bv_val );
1897 assert( ret == len );
1898 fstr->bv_len += len;
1901 case LDAP_FILTER_AND:
1902 case LDAP_FILTER_OR:
1903 case LDAP_FILTER_NOT: {
1905 fstr->bv_val[fstr->bv_len++] = '(';
1906 switch ( f->f_choice ) {
1907 case LDAP_FILTER_AND:
1908 fstr->bv_val[fstr->bv_len] = '&';
1910 case LDAP_FILTER_OR:
1911 fstr->bv_val[fstr->bv_len] = '|';
1913 case LDAP_FILTER_NOT:
1914 fstr->bv_val[fstr->bv_len] = '!';
1919 for ( f = f->f_list; f != NULL; f = f->f_next ) {
1920 rc = filter2template( op, f, fstr );
1923 fstr->bv_val[fstr->bv_len++] = ')';
1924 fstr->bv_val[fstr->bv_len] = '\0';
1930 /* a filter should at least have room for "()",
1931 * an "=" and for a 1-char attr */
1932 strcpy( fstr->bv_val, "(?=)" );
1933 fstr->bv_len += STRLENOF("(?=)");
1940 #define BI_HASHED 0x01
1941 #define BI_DIDCB 0x02
1942 #define BI_LOOKUP 0x04
1946 typedef struct bindinfo {
1947 cache_manager *bi_cm;
1949 QueryTemplate *bi_templ;
1950 struct search_info *bi_si;
1952 slap_callback bi_cb;
1955 struct search_info {
1958 QueryTemplate *qtemp;
1959 AttributeName* save_attrs; /* original attributes, saved for response */
1960 int swap_saved_attrs;
1965 int slimit_exceeded;
1966 pc_caching_reason_t caching_reason;
1972 remove_query_and_data(
1976 struct berval *uuid )
1978 query_manager* qm = cm->qm;
1980 qm->crfunc( qm, uuid );
1981 if ( !BER_BVISNULL( uuid ) ) {
1984 Debug( pcache_debug,
1985 "Removing query UUID %s\n",
1986 uuid->bv_val, 0, 0 );
1987 return_val = remove_query_data( op, rs, uuid );
1988 Debug( pcache_debug,
1989 "QUERY REMOVED, SIZE=%d\n",
1991 ldap_pvt_thread_mutex_lock( &cm->cache_mutex );
1992 cm->cur_entries -= return_val;
1993 cm->num_cached_queries--;
1994 Debug( pcache_debug,
1995 "STORED QUERIES = %lu\n",
1996 cm->num_cached_queries, 0, 0 );
1997 ldap_pvt_thread_mutex_unlock( &cm->cache_mutex );
1998 Debug( pcache_debug,
1999 "QUERY REMOVED, CACHE ="
2001 cm->cur_entries, 0, 0 );
2006 * Callback used to fetch queryId values based on entryUUID;
2007 * used by pcache_remove_entries_from_cache()
2010 fetch_queryId_cb( Operation *op, SlapReply *rs )
2014 /* only care about searchEntry responses */
2015 if ( rs->sr_type != REP_SEARCH ) {
2019 /* allow only one response per entryUUID */
2020 if ( op->o_callback->sc_private != NULL ) {
2026 /* copy all queryId values into callback's private data */
2027 a = attr_find( rs->sr_entry->e_attrs, ad_queryId );
2029 BerVarray vals = NULL;
2031 ber_bvarray_dup_x( &vals, a->a_nvals, op->o_tmpmemctx );
2032 op->o_callback->sc_private = (void *)vals;
2036 /* clear entry if required */
2037 if ( rs->sr_flags & REP_ENTRY_MUSTBEFREED ) {
2038 entry_free( rs->sr_entry );
2039 rs->sr_entry = NULL;
2040 rs->sr_flags ^= REP_ENTRY_MUSTBEFREED;
2047 * Call that allows to remove a set of entries from the cache,
2048 * by forcing the removal of all the related queries.
2051 pcache_remove_entries_from_cache(
2054 BerVarray entryUUIDs )
2056 Connection conn = { 0 };
2057 OperationBuffer opbuf;
2059 slap_callback sc = { 0 };
2060 SlapReply rs = { REP_RESULT };
2062 char filtbuf[ LDAP_LUTIL_UUIDSTR_BUFSIZE + STRLENOF( "(entryUUID=)" ) ];
2063 AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
2064 AttributeName attrs[ 2 ] = {{{ 0 }}};
2068 void *thrctx = ldap_pvt_thread_pool_context();
2070 connection_fake_init( &conn, &opbuf, thrctx );
2078 memset( &op->oq_search, 0, sizeof( op->oq_search ) );
2079 op->ors_scope = LDAP_SCOPE_SUBTREE;
2080 op->ors_deref = LDAP_DEREF_NEVER;
2081 f.f_choice = LDAP_FILTER_EQUALITY;
2083 ava.aa_desc = slap_schema.si_ad_entryUUID;
2084 op->ors_filter = &f;
2086 op->ors_tlimit = SLAP_NO_LIMIT;
2087 op->ors_limit = NULL;
2088 attrs[ 0 ].an_desc = ad_queryId;
2089 attrs[ 0 ].an_name = ad_queryId->ad_cname;
2090 op->ors_attrs = attrs;
2091 op->ors_attrsonly = 0;
2093 op->o_req_dn = cm->db.be_suffix[ 0 ];
2094 op->o_req_ndn = cm->db.be_nsuffix[ 0 ];
2096 op->o_tag = LDAP_REQ_SEARCH;
2097 op->o_protocol = LDAP_VERSION3;
2098 op->o_managedsait = SLAP_CONTROL_CRITICAL;
2100 op->o_dn = op->o_bd->be_rootdn;
2101 op->o_ndn = op->o_bd->be_rootndn;
2102 sc.sc_response = fetch_queryId_cb;
2103 op->o_callback = ≻
2105 for ( s = 0; !BER_BVISNULL( &entryUUIDs[ s ] ); s++ ) {
2106 BerVarray vals = NULL;
2108 op->ors_filterstr.bv_len = snprintf( filtbuf, sizeof( filtbuf ),
2109 "(entryUUID=%s)", entryUUIDs[ s ].bv_val );
2110 op->ors_filterstr.bv_val = filtbuf;
2111 ava.aa_value = entryUUIDs[ s ];
2113 rc = op->o_bd->be_search( op, &rs );
2114 if ( rc != LDAP_SUCCESS ) {
2118 vals = (BerVarray)op->o_callback->sc_private;
2119 if ( vals != NULL ) {
2122 for ( i = 0; !BER_BVISNULL( &vals[ i ] ); i++ ) {
2123 struct berval val = vals[ i ];
2125 remove_query_and_data( op, &rs, cm, &val );
2127 if ( !BER_BVISNULL( &val ) && val.bv_val != vals[ i ].bv_val ) {
2128 ch_free( val.bv_val );
2132 ber_bvarray_free_x( vals, op->o_tmpmemctx );
2133 op->o_callback->sc_private = NULL;
2141 * Call that allows to remove a query from the cache.
2144 pcache_remove_query_from_cache(
2147 struct berval *queryid )
2149 Operation op2 = *op;
2150 SlapReply rs2 = { 0 };
2154 /* remove the selected query */
2155 remove_query_and_data( &op2, &rs2, cm, queryid );
2157 return LDAP_SUCCESS;
2161 * Call that allows to remove a set of queries related to an entry
2162 * from the cache; if queryid is not null, the entry must belong to
2163 * the query indicated by queryid.
2166 pcache_remove_entry_queries_from_cache(
2170 struct berval *queryid )
2172 Connection conn = { 0 };
2173 OperationBuffer opbuf;
2175 slap_callback sc = { 0 };
2176 SlapReply rs = { REP_RESULT };
2178 char filter_str[ LDAP_LUTIL_UUIDSTR_BUFSIZE + STRLENOF( "(pcacheQueryID=)" ) ];
2179 AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
2180 AttributeName attrs[ 2 ] = {{{ 0 }}};
2183 BerVarray vals = NULL;
2186 void *thrctx = ldap_pvt_thread_pool_context();
2188 connection_fake_init( &conn, &opbuf, thrctx );
2196 memset( &op->oq_search, 0, sizeof( op->oq_search ) );
2197 op->ors_scope = LDAP_SCOPE_BASE;
2198 op->ors_deref = LDAP_DEREF_NEVER;
2199 if ( queryid == NULL || BER_BVISNULL( queryid ) ) {
2200 BER_BVSTR( &op->ors_filterstr, "(objectClass=*)" );
2201 f.f_choice = LDAP_FILTER_PRESENT;
2202 f.f_desc = slap_schema.si_ad_objectClass;
2205 op->ors_filterstr.bv_len = snprintf( filter_str,
2206 sizeof( filter_str ), "(%s=%s)",
2207 ad_queryId->ad_cname.bv_val, queryid->bv_val );
2208 f.f_choice = LDAP_FILTER_EQUALITY;
2210 f.f_av_desc = ad_queryId;
2211 f.f_av_value = *queryid;
2213 op->ors_filter = &f;
2215 op->ors_tlimit = SLAP_NO_LIMIT;
2216 op->ors_limit = NULL;
2217 attrs[ 0 ].an_desc = ad_queryId;
2218 attrs[ 0 ].an_name = ad_queryId->ad_cname;
2219 op->ors_attrs = attrs;
2220 op->ors_attrsonly = 0;
2222 op->o_req_dn = *ndn;
2223 op->o_req_ndn = *ndn;
2225 op->o_tag = LDAP_REQ_SEARCH;
2226 op->o_protocol = LDAP_VERSION3;
2227 op->o_managedsait = SLAP_CONTROL_CRITICAL;
2229 op->o_dn = op->o_bd->be_rootdn;
2230 op->o_ndn = op->o_bd->be_rootndn;
2231 sc.sc_response = fetch_queryId_cb;
2232 op->o_callback = ≻
2234 rc = op->o_bd->be_search( op, &rs );
2235 if ( rc != LDAP_SUCCESS ) {
2239 vals = (BerVarray)op->o_callback->sc_private;
2240 if ( vals != NULL ) {
2243 for ( i = 0; !BER_BVISNULL( &vals[ i ] ); i++ ) {
2244 struct berval val = vals[ i ];
2246 remove_query_and_data( op, &rs, cm, &val );
2248 if ( !BER_BVISNULL( &val ) && val.bv_val != vals[ i ].bv_val ) {
2249 ch_free( val.bv_val );
2253 ber_bvarray_free_x( vals, op->o_tmpmemctx );
2256 return LDAP_SUCCESS;
2263 struct berval *query_uuid )
2265 struct search_info *si = op->o_callback->sc_private;
2266 slap_overinst *on = si->on;
2267 cache_manager *cm = on->on_bi.bi_private;
2270 struct berval crp_uuid;
2271 char uuidbuf[ LDAP_LUTIL_UUIDSTR_BUFSIZE ];
2273 Connection conn = {0};
2274 OperationBuffer opbuf;
2275 void *thrctx = ldap_pvt_thread_pool_context();
2277 query_uuid->bv_len = lutil_uuidstr(uuidbuf, sizeof(uuidbuf));
2278 ber_str2bv(uuidbuf, query_uuid->bv_len, 1, query_uuid);
2280 connection_fake_init2( &conn, &opbuf, thrctx, 0 );
2281 op_tmp = &opbuf.ob_op;
2282 op_tmp->o_bd = &cm->db;
2283 op_tmp->o_dn = cm->db.be_rootdn;
2284 op_tmp->o_ndn = cm->db.be_rootndn;
2286 Debug( pcache_debug, "UUID for query being added = %s\n",
2289 for ( e=si->head; e; e=si->head ) {
2290 si->head = e->e_private;
2291 e->e_private = NULL;
2292 while ( cm->cur_entries > (cm->max_entries) ) {
2293 BER_BVZERO( &crp_uuid );
2294 remove_query_and_data( op_tmp, rs, cm, &crp_uuid );
2297 return_val = merge_entry(op_tmp, e, 0, query_uuid);
2298 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
2299 cm->cur_entries += return_val;
2300 Debug( pcache_debug,
2301 "ENTRY ADDED/MERGED, CACHED ENTRIES=%d\n",
2302 cm->cur_entries, 0, 0 );
2304 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
2311 pcache_op_cleanup( Operation *op, SlapReply *rs ) {
2312 slap_callback *cb = op->o_callback;
2313 struct search_info *si = cb->sc_private;
2314 slap_overinst *on = si->on;
2315 cache_manager *cm = on->on_bi.bi_private;
2316 query_manager* qm = cm->qm;
2318 if ( rs->sr_type == REP_SEARCH ) {
2321 /* don't return more entries than requested by the client */
2322 if ( si->slimit > 0 && rs->sr_nentries >= si->slimit ) {
2323 si->slimit_exceeded = 1;
2326 /* If we haven't exceeded the limit for this query,
2327 * build a chain of answers to store. If we hit the
2328 * limit, empty the chain and ignore the rest.
2331 /* check if the entry contains undefined
2332 * attributes/objectClasses (ITS#5680) */
2333 if ( cm->check_cacheability && test_filter( op, rs->sr_entry, si->query.filter ) != LDAP_COMPARE_TRUE ) {
2334 Debug( pcache_debug, "%s: query not cacheable because of schema issues in DN \"%s\"\n",
2335 op->o_log_prefix, rs->sr_entry->e_name.bv_val, 0 );
2339 /* check for malformed entries: attrs with no values */
2341 Attribute *a = rs->sr_entry->e_attrs;
2342 for (; a; a=a->a_next) {
2343 if ( !a->a_numvals ) {
2344 Debug( pcache_debug, "%s: query not cacheable because of attrs without values in DN \"%s\" (%s)\n",
2345 op->o_log_prefix, rs->sr_entry->e_name.bv_val,
2346 a->a_desc->ad_cname.bv_val );
2352 if ( si->count < si->max ) {
2354 e = entry_dup( rs->sr_entry );
2355 if ( !si->head ) si->head = e;
2356 if ( si->tail ) si->tail->e_private = e;
2363 for (;si->head; si->head=e) {
2364 e = si->head->e_private;
2365 si->head->e_private = NULL;
2366 entry_free(si->head);
2374 if ( rs->sr_type == REP_RESULT ||
2375 op->o_abandon || rs->sr_err == SLAPD_ABANDON )
2377 if ( si->swap_saved_attrs ) {
2378 rs->sr_attrs = si->save_attrs;
2379 op->ors_attrs = si->save_attrs;
2381 if ( (op->o_abandon || rs->sr_err == SLAPD_ABANDON) &&
2382 si->caching_reason == PC_IGNORE )
2384 filter_free( si->query.filter );
2386 /* duplicate query, free it */
2388 for (;si->head; si->head=e) {
2389 e = si->head->e_private;
2390 si->head->e_private = NULL;
2391 entry_free(si->head);
2395 } else if ( si->caching_reason != PC_IGNORE ) {
2396 CachedQuery *qc = qm->addfunc(op, qm, &si->query,
2397 si->qtemp, si->caching_reason, 1 );
2400 switch ( si->caching_reason ) {
2402 cache_entries( op, rs, &qc->q_uuid );
2404 si->pbi->bi_cq = qc;
2408 qc->q_sizelimit = rs->sr_nentries;
2418 ldap_pvt_thread_rdwr_wunlock(&qc->rwlock);
2419 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
2420 cm->num_cached_queries++;
2421 Debug( pcache_debug, "STORED QUERIES = %lu\n",
2422 cm->num_cached_queries, 0, 0 );
2423 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
2425 /* If the consistency checker suspended itself,
2428 if ( cm->cc_paused == PCACHE_CC_PAUSED ) {
2429 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
2430 if ( cm->cc_paused == PCACHE_CC_PAUSED ) {
2432 ldap_pvt_runqueue_resched( &slapd_rq, cm->cc_arg, 0 );
2434 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
2437 } else if ( si->count ) {
2438 /* duplicate query, free it */
2440 for (;si->head; si->head=e) {
2441 e = si->head->e_private;
2442 si->head->e_private = NULL;
2443 entry_free(si->head);
2448 filter_free( si->query.filter );
2451 op->o_callback = op->o_callback->sc_next;
2452 op->o_tmpfree( cb, op->o_tmpmemctx );
2455 return SLAP_CB_CONTINUE;
2463 struct search_info *si = op->o_callback->sc_private;
2465 if ( si->swap_saved_attrs ) {
2466 rs->sr_attrs = si->save_attrs;
2467 op->ors_attrs = si->save_attrs;
2470 if ( rs->sr_type == REP_SEARCH ) {
2471 /* don't return more entries than requested by the client */
2472 if ( si->slimit_exceeded ) {
2476 } else if ( rs->sr_type == REP_RESULT ) {
2479 if ( rs->sr_err == LDAP_SUCCESS ) {
2480 si->caching_reason = PC_POSITIVE;
2482 } else if ( rs->sr_err == LDAP_SIZELIMIT_EXCEEDED
2483 && si->qtemp->limitttl )
2487 si->caching_reason = PC_SIZELIMIT;
2488 for (;si->head; si->head=e) {
2489 e = si->head->e_private;
2490 si->head->e_private = NULL;
2491 entry_free(si->head);
2495 } else if ( si->qtemp->negttl && !si->count && !si->over &&
2496 rs->sr_err == LDAP_SUCCESS )
2498 si->caching_reason = PC_NEGATIVE;
2502 if ( si->slimit_exceeded ) {
2503 rs->sr_err = LDAP_SIZELIMIT_EXCEEDED;
2507 return SLAP_CB_CONTINUE;
2510 /* NOTE: this is a quick workaround to let pcache minimally interact
2511 * with pagedResults. A more articulated solutions would be to
2512 * perform the remote query without control and cache all results,
2513 * performing the pagedResults search only within the client
2514 * and the proxy. This requires pcache to understand pagedResults. */
2516 pcache_chk_controls(
2520 const char *non = "";
2521 const char *stripped = "";
2523 switch( op->o_pagedresults ) {
2524 case SLAP_CONTROL_NONCRITICAL:
2526 stripped = "; stripped";
2529 case SLAP_CONTROL_CRITICAL:
2530 Debug( pcache_debug, "%s: "
2531 "%scritical pagedResults control "
2532 "disabled with proxy cache%s.\n",
2533 op->o_log_prefix, non, stripped );
2535 slap_remove_control( op, rs, slap_cids.sc_pagedResults, NULL );
2539 rs->sr_err = SLAP_CB_CONTINUE;
2547 pc_setpw( Operation *op, struct berval *pwd, cache_manager *cm )
2549 struct berval vals[2];
2552 const char *text = NULL;
2553 BER_BVZERO( &vals[0] );
2554 slap_passwd_hash( pwd, &vals[0], &text );
2555 if ( BER_BVISEMPTY( &vals[0] )) {
2556 Debug( pcache_debug, "pc_setpw: hash failed %s\n",
2562 BER_BVZERO( &vals[1] );
2566 SlapReply sr = { REP_RESULT };
2567 slap_callback cb = { 0, slap_null_cb, 0, 0 };
2570 mod.sml_op = LDAP_MOD_REPLACE;
2572 mod.sml_desc = slap_schema.si_ad_userPassword;
2573 mod.sml_type = mod.sml_desc->ad_cname;
2574 mod.sml_values = vals;
2575 mod.sml_nvalues = NULL;
2576 mod.sml_numvals = 1;
2577 mod.sml_next = NULL;
2579 op->o_tag = LDAP_REQ_MODIFY;
2580 op->orm_modlist = &mod;
2582 op->o_dn = op->o_bd->be_rootdn;
2583 op->o_ndn = op->o_bd->be_rootndn;
2584 op->o_callback = &cb;
2585 Debug( pcache_debug, "pc_setpw: CACHING BIND for %s\n",
2586 op->o_req_dn.bv_val, 0, 0 );
2587 rc = op->o_bd->be_modify( op, &sr );
2588 ch_free( vals[0].bv_val );
2593 typedef struct bindcacheinfo {
2599 pc_bind_save( Operation *op, SlapReply *rs )
2601 if ( rs->sr_err == LDAP_SUCCESS ) {
2602 bindcacheinfo *bci = op->o_callback->sc_private;
2603 slap_overinst *on = bci->on;
2604 cache_manager *cm = on->on_bi.bi_private;
2606 Operation op2 = *op;
2607 if ( pc_setpw( &op2, &op->orb_cred, cm ) == LDAP_SUCCESS )
2608 bci->qc->bindref_time = op->o_time + bci->qc->qtemp->bindttr;
2610 return SLAP_CB_CONTINUE;
2614 pc_bind_attrs( Operation *op, Entry *e, QueryTemplate *temp,
2615 struct berval *fbv )
2618 struct berval *vals, pres = BER_BVC("*");
2622 vals = op->o_tmpalloc( temp->bindnattrs * sizeof( struct berval ),
2625 for ( i=0; i<temp->bindnattrs; i++ ) {
2626 a = attr_find( e->e_attrs, temp->bindfattrs[i] );
2627 if ( a && a->a_vals ) {
2628 vals[i] = a->a_vals[0];
2629 len += a->a_vals[0].bv_len;
2634 fbv->bv_len = len + temp->bindftemp.bv_len;
2635 fbv->bv_val = op->o_tmpalloc( fbv->bv_len + 1, op->o_tmpmemctx );
2637 p1 = temp->bindftemp.bv_val;
2642 if ( p1[0] == '=' && p1[1] == ')' ) {
2643 AC_MEMCPY( p2, vals[i].bv_val, vals[i].bv_len );
2644 p2 += vals[i].bv_len;
2650 op->o_tmpfree( vals, op->o_tmpmemctx );
2652 /* FIXME: are we sure str2filter_x can't fail?
2653 * caller needs to check */
2655 Filter *f = str2filter_x( op, fbv->bv_val );
2656 assert( f != NULL );
2661 /* Check if the requested entry is from the cache and has a valid
2662 * ttr and password hash
2665 pc_bind_search( Operation *op, SlapReply *rs )
2667 if ( rs->sr_type == REP_SEARCH ) {
2668 bindinfo *pbi = op->o_callback->sc_private;
2670 /* We only care if this is an already cached result and we're
2671 * below the refresh time, or we're offline.
2674 if (( pbi->bi_cm->cc_paused & PCACHE_CC_OFFLINE ) ||
2675 op->o_time < pbi->bi_cq->bindref_time ) {
2678 /* See if a recognized password is hashed here */
2679 a = attr_find( rs->sr_entry->e_attrs,
2680 slap_schema.si_ad_userPassword );
2681 if ( a && a->a_vals[0].bv_val[0] == '{' &&
2682 lutil_passwd_scheme( a->a_vals[0].bv_val ))
2683 pbi->bi_flags |= BI_HASHED;
2685 Debug( pcache_debug, "pc_bind_search: cache is stale, "
2686 "reftime: %ld, current time: %ld\n",
2687 pbi->bi_cq->bindref_time, op->o_time, 0 );
2689 } else if ( pbi->bi_si ) {
2690 /* This search result is going into the cache */
2694 filter_free( pbi->bi_si->query.filter );
2695 f = pc_bind_attrs( op, rs->sr_entry, pbi->bi_templ, &fbv );
2696 op->o_tmpfree( fbv.bv_val, op->o_tmpmemctx );
2697 pbi->bi_si->query.filter = filter_dup( f, NULL );
2698 filter_free_x( op, f, 1 );
2704 /* We always want pc_bind_search to run after the search handlers */
2706 pc_bind_resp( Operation *op, SlapReply *rs )
2708 bindinfo *pbi = op->o_callback->sc_private;
2709 if ( !( pbi->bi_flags & BI_DIDCB )) {
2710 slap_callback *sc = op->o_callback;
2711 while ( sc && sc->sc_response != pcache_response )
2714 sc = op->o_callback;
2715 pbi->bi_cb.sc_next = sc->sc_next;
2716 sc->sc_next = &pbi->bi_cb;
2717 pbi->bi_flags |= BI_DIDCB;
2719 return SLAP_CB_CONTINUE;
2722 #ifdef PCACHE_CONTROL_PRIVDB
2728 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
2729 cache_manager *cm = on->on_bi.bi_private;
2730 slap_callback *save_cb;
2733 /* skip if control is unset */
2734 if ( op->o_ctrlflag[ privDB_cid ] != SLAP_CONTROL_CRITICAL ) {
2735 return SLAP_CB_CONTINUE;
2738 /* The cache DB isn't open yet */
2739 if ( cm->defer_db_open ) {
2740 send_ldap_error( op, rs, LDAP_UNAVAILABLE,
2741 "pcachePrivDB: cacheDB not available" );
2745 /* FIXME: might be a little bit exaggerated... */
2746 if ( !be_isroot( op ) ) {
2747 save_cb = op->o_callback;
2748 op->o_callback = NULL;
2749 send_ldap_error( op, rs, LDAP_UNWILLING_TO_PERFORM,
2750 "pcachePrivDB: operation not allowed" );
2751 op->o_callback = save_cb;
2756 /* map tag to operation */
2757 type = slap_req2op( op->o_tag );
2758 if ( type != SLAP_OP_LAST ) {
2762 /* execute, if possible */
2763 func = &cm->db.be_bind;
2764 if ( func[ type ] != NULL ) {
2765 Operation op2 = *op;
2769 rc = func[ type ]( &op2, rs );
2770 if ( type == SLAP_OP_BIND && rc == LDAP_SUCCESS ) {
2771 op->o_conn->c_authz_cookie = cm->db.be_private;
2778 /* otherwise fall back to error */
2779 save_cb = op->o_callback;
2780 op->o_callback = NULL;
2781 send_ldap_error( op, rs, LDAP_UNWILLING_TO_PERFORM,
2782 "operation not supported with pcachePrivDB control" );
2783 op->o_callback = save_cb;
2787 #endif /* PCACHE_CONTROL_PRIVDB */
2794 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
2795 cache_manager *cm = on->on_bi.bi_private;
2796 QueryTemplate *temp;
2798 slap_callback cb = { 0 }, *sc;
2804 #ifdef PCACHE_CONTROL_PRIVDB
2805 if ( op->o_ctrlflag[ privDB_cid ] == SLAP_CONTROL_CRITICAL )
2806 return pcache_op_privdb( op, rs );
2807 #endif /* PCACHE_CONTROL_PRIVDB */
2809 /* Skip if we're not configured for Binds, or cache DB isn't open yet */
2810 if ( !cm->cache_binds || cm->defer_db_open )
2811 return SLAP_CB_CONTINUE;
2813 /* First find a matching template with Bind info */
2814 for ( temp=cm->qm->templates; temp; temp=temp->qmnext ) {
2815 if ( temp->bindttr && dnIsSuffix( &op->o_req_ndn, &temp->bindbase ))
2818 /* Didn't find a suitable template, just passthru */
2820 return SLAP_CB_CONTINUE;
2822 /* See if the entry is already locally cached. If so, we can
2823 * populate the query filter to retrieve the cached query. We
2824 * need to check the bindrefresh time in the query.
2827 op2.o_dn = op->o_bd->be_rootdn;
2828 op2.o_ndn = op->o_bd->be_rootndn;
2833 rc = be_entry_get_rw( &op2, &op->o_req_ndn, NULL, NULL, 0, &e );
2834 if ( rc == LDAP_SUCCESS && e ) {
2835 bi.bi_flags |= BI_LOOKUP;
2836 op2.ors_filter = pc_bind_attrs( op, e, temp, &op2.ors_filterstr );
2837 be_entry_release_r( &op2, e );
2839 op2.ors_filter = temp->bindfilter;
2840 op2.ors_filterstr = temp->bindfilterstr;
2843 op2.o_bd = op->o_bd;
2844 op2.o_tag = LDAP_REQ_SEARCH;
2845 op2.ors_scope = LDAP_SCOPE_BASE;
2846 op2.ors_deref = LDAP_DEREF_NEVER;
2848 op2.ors_tlimit = SLAP_NO_LIMIT;
2849 op2.ors_limit = NULL;
2850 op2.ors_attrs = cm->qm->attr_sets[temp->attr_set_index].attrs;
2851 op2.ors_attrsonly = 0;
2853 /* We want to invoke search at the same level of the stack
2854 * as we're already at...
2861 bi.bi_cb.sc_response = pc_bind_search;
2862 bi.bi_cb.sc_cleanup = NULL;
2863 bi.bi_cb.sc_private = &bi;
2864 cb.sc_private = &bi;
2865 cb.sc_response = pc_bind_resp;
2866 op2.o_callback = &cb;
2867 overlay_op_walk( &op2, rs, op_search, on->on_info, on );
2869 /* OK, just bind locally */
2870 if ( bi.bi_flags & BI_HASHED ) {
2871 BackendDB *be = op->o_bd;
2874 Debug( pcache_debug, "pcache_op_bind: CACHED BIND for %s\n",
2875 op->o_req_dn.bv_val, 0, 0 );
2877 if ( op->o_bd->be_bind( op, rs ) == LDAP_SUCCESS ) {
2878 op->o_conn->c_authz_cookie = cm->db.be_private;
2884 /* We have a cached query to work with */
2886 sc = op->o_tmpalloc( sizeof(slap_callback) + sizeof(bindcacheinfo),
2888 sc->sc_response = pc_bind_save;
2889 sc->sc_cleanup = NULL;
2890 sc->sc_private = sc+1;
2891 bci = sc->sc_private;
2892 sc->sc_next = op->o_callback;
2893 op->o_callback = sc;
2897 return SLAP_CB_CONTINUE;
2905 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
2906 cache_manager *cm = on->on_bi.bi_private;
2907 query_manager* qm = cm->qm;
2912 QueryTemplate *qtemp = NULL;
2913 bindinfo *pbi = NULL;
2916 CachedQuery *answerable = NULL;
2919 struct berval tempstr;
2921 #ifdef PCACHE_CONTROL_PRIVDB
2922 if ( op->o_ctrlflag[ privDB_cid ] == SLAP_CONTROL_CRITICAL ) {
2923 return pcache_op_privdb( op, rs );
2925 #endif /* PCACHE_CONTROL_PRIVDB */
2927 /* The cache DB isn't open yet */
2928 if ( cm->defer_db_open ) {
2929 send_ldap_error( op, rs, LDAP_UNAVAILABLE,
2930 "pcachePrivDB: cacheDB not available" );
2934 /* pickup runtime ACL changes */
2935 cm->db.be_acl = op->o_bd->be_acl;
2938 /* See if we're processing a Bind request */
2939 slap_callback *cb = op->o_callback;
2941 for ( ; cb; cb=cb->sc_next ) {
2942 if ( cb->sc_response == pc_bind_resp ) {
2943 pbi = cb->sc_private;
2949 /* FIXME: cannot cache/answer requests with pagedResults control */
2951 query.filter = op->ors_filter;
2954 query.base = pbi->bi_templ->bindbase;
2955 query.scope = pbi->bi_templ->bindscope;
2956 attr_set = pbi->bi_templ->attr_set_index;
2958 qtemp = pbi->bi_templ;
2959 if ( pbi->bi_flags & BI_LOOKUP )
2960 answerable = qm->qcfunc(op, qm, &query, qtemp);
2963 tempstr.bv_val = op->o_tmpalloc( op->ors_filterstr.bv_len+1,
2966 if ( filter2template( op, op->ors_filter, &tempstr ))
2968 op->o_tmpfree( tempstr.bv_val, op->o_tmpmemctx );
2969 return SLAP_CB_CONTINUE;
2972 Debug( pcache_debug, "query template of incoming query = %s\n",
2973 tempstr.bv_val, 0, 0 );
2976 attr_set = get_attr_set(op->ors_attrs, qm, cm->numattrsets);
2978 query.base = op->o_req_ndn;
2979 query.scope = op->ors_scope;
2981 /* check for query containment */
2982 if (attr_set > -1) {
2983 QueryTemplate *qt = qm->attr_sets[attr_set].templates;
2984 for (; qt; qt = qt->qtnext ) {
2985 /* find if template i can potentially answer tempstr */
2986 if ( ber_bvstrcasecmp( &qt->querystr, &tempstr ) != 0 )
2990 Debug( pcache_debug, "Entering QC, querystr = %s\n",
2991 op->ors_filterstr.bv_val, 0, 0 );
2992 answerable = qm->qcfunc(op, qm, &query, qt);
2994 /* if != NULL, rlocks qtemp->t_rwlock */
2999 op->o_tmpfree( tempstr.bv_val, op->o_tmpmemctx );
3003 BackendDB *save_bd = op->o_bd;
3005 ldap_pvt_thread_mutex_lock( &answerable->answerable_cnt_mutex );
3006 answerable->answerable_cnt++;
3007 /* we only care about refcnts if we're refreshing */
3008 if ( answerable->refresh_time )
3009 answerable->refcnt++;
3010 Debug( pcache_debug, "QUERY ANSWERABLE (answered %lu times)\n",
3011 answerable->answerable_cnt, 0, 0 );
3012 ldap_pvt_thread_mutex_unlock( &answerable->answerable_cnt_mutex );
3014 ldap_pvt_thread_rdwr_rlock(&answerable->rwlock);
3015 if ( BER_BVISNULL( &answerable->q_uuid )) {
3016 /* No entries cached, just an empty result set */
3018 send_ldap_result( op, rs );
3020 /* Let Bind know we used a cached query */
3022 pbi->bi_cq = answerable;
3025 if ( cm->response_cb == PCACHE_RESPONSE_CB_TAIL ) {
3027 /* The cached entry was already processed by any
3028 * other overlays, so don't let it get processed again.
3030 * This loop removes over_back_response from the stack.
3032 if ( overlay_callback_after_backover( op, &cb, 0) == 0 ) {
3033 slap_callback **scp;
3034 for ( scp = &op->o_callback; *scp != NULL;
3035 scp = &(*scp)->sc_next ) {
3036 if ( (*scp)->sc_next == &cb ) {
3043 i = cm->db.bd_info->bi_op_search( op, rs );
3045 ldap_pvt_thread_rdwr_runlock(&answerable->rwlock);
3046 /* locked by qtemp->qcfunc (query_containment) */
3047 ldap_pvt_thread_rdwr_runlock(&qtemp->t_rwlock);
3052 Debug( pcache_debug, "QUERY NOT ANSWERABLE\n", 0, 0, 0 );
3054 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
3055 if (cm->num_cached_queries >= cm->max_queries) {
3058 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
3060 if (op->ors_attrsonly)
3065 struct search_info *si;
3067 Debug( pcache_debug, "QUERY CACHEABLE\n", 0, 0, 0 );
3068 query.filter = filter_dup(op->ors_filter, NULL);
3070 cb = op->o_tmpalloc( sizeof(*cb) + sizeof(*si), op->o_tmpmemctx );
3071 cb->sc_response = pcache_response;
3072 cb->sc_cleanup = pcache_op_cleanup;
3073 cb->sc_private = (cb+1);
3074 si = cb->sc_private;
3078 si->max = cm->num_entries_limit ;
3082 si->slimit_exceeded = 0;
3083 si->caching_reason = PC_IGNORE;
3084 if ( op->ors_slimit > 0 && op->ors_slimit < cm->num_entries_limit ) {
3085 si->slimit = op->ors_slimit;
3086 op->ors_slimit = cm->num_entries_limit;
3090 si->swap_saved_attrs = 1;
3091 si->save_attrs = op->ors_attrs;
3096 op->ors_attrs = qtemp->t_attrs.attrs;
3098 if ( cm->response_cb == PCACHE_RESPONSE_CB_HEAD ) {
3099 cb->sc_next = op->o_callback;
3100 op->o_callback = cb;
3103 slap_callback **pcb;
3105 /* need to move the callback at the end, in case other
3106 * overlays are present, so that the final entry is
3107 * actually cached */
3109 for ( pcb = &op->o_callback; *pcb; pcb = &(*pcb)->sc_next );
3114 Debug( pcache_debug, "QUERY NOT CACHEABLE\n",
3118 return SLAP_CB_CONTINUE;
3123 AttributeName* attrs,
3131 for ( ; attrs[i].an_name.bv_val; i++ ) {
3132 /* only count valid attribute names
3133 * (searches ignore others, this overlay does the same) */
3134 if ( attrs[i].an_desc ) {
3140 /* recognize default or explicit single "*" */
3142 ( i == 1 && bvmatch( &attrs[0].an_name, slap_bv_all_user_attrs ) ) )
3145 attrs = slap_anlist_all_user_attributes;
3147 /* recognize implicit (no valid attributes) or explicit single "1.1" */
3148 } else if ( count == 0 ||
3149 ( i == 1 && bvmatch( &attrs[0].an_name, slap_bv_no_attrs ) ) )
3155 for ( i = 0; i < num; i++ ) {
3159 if ( count > qm->attr_sets[i].count ) {
3164 if ( !qm->attr_sets[i].count ) {
3170 for ( a2 = attrs; a2->an_name.bv_val; a2++ ) {
3171 if ( !a2->an_desc && !bvmatch( &a2->an_name, slap_bv_all_user_attrs ) ) continue;
3173 if ( !an_find( qm->attr_sets[i].attrs, &a2->an_name ) ) {
3191 /* Refresh a cached query:
3192 * 1: Replay the query on the remote DB and merge each entry into
3193 * the local DB. Remember the DNs of each remote entry.
3194 * 2: Search the local DB for all entries matching this queryID.
3195 * Delete any entry whose DN is not in the list from (1).
3197 typedef struct dnlist {
3198 struct dnlist *next;
3203 typedef struct refresh_info {
3211 static dnlist *dnl_alloc( Operation *op, struct berval *bvdn )
3213 dnlist *dn = op->o_tmpalloc( sizeof(dnlist) + bvdn->bv_len + 1,
3215 dn->dn.bv_len = bvdn->bv_len;
3216 dn->dn.bv_val = (char *)(dn+1);
3217 AC_MEMCPY( dn->dn.bv_val, bvdn->bv_val, dn->dn.bv_len );
3218 dn->dn.bv_val[dn->dn.bv_len] = '\0';
3223 refresh_merge( Operation *op, SlapReply *rs )
3225 if ( rs->sr_type == REP_SEARCH ) {
3226 refresh_info *ri = op->o_callback->sc_private;
3227 BackendDB *be = op->o_bd;
3233 ocb = op->o_callback;
3234 /* Find local entry, merge */
3235 op->o_bd = ri->ri_be;
3236 rc = be_entry_get_rw( op, &rs->sr_entry->e_nname, NULL, NULL, 0, &e );
3237 if ( rc != LDAP_SUCCESS || e == NULL ) {
3238 /* No local entry, just add it. FIXME: we are not checking
3239 * the cache entry limit here
3241 merge_entry( op, rs->sr_entry, 1, &ri->ri_q->q_uuid );
3243 /* Entry exists, update it */
3246 Modifications *modlist, *mods = NULL;
3247 const char* text = NULL;
3248 char textbuf[SLAP_TEXT_BUFLEN];
3249 size_t textlen = sizeof(textbuf);
3250 slap_callback cb = { NULL, slap_null_cb, NULL, NULL };
3254 /* Get a copy of only the attrs we requested */
3255 for ( a=e->e_attrs; a; a=a->a_next ) {
3256 if ( ad_inlist( a->a_desc, rs->sr_attrs )) {
3257 *b = attr_alloc( a->a_desc );
3259 /* The actual values still belong to e */
3260 (*b)->a_flags |= SLAP_ATTR_DONT_FREE_VALS |
3261 SLAP_ATTR_DONT_FREE_DATA;
3262 b = &((*b)->a_next);
3266 slap_entry2mods( rs->sr_entry, &modlist, &text, textbuf, textlen );
3267 syncrepl_diff_entry( op, ne.e_attrs, rs->sr_entry->e_attrs,
3268 &mods, &modlist, 0 );
3269 be_entry_release_r( op, e );
3270 attrs_free( ne.e_attrs );
3271 slap_mods_free( modlist, 1 );
3272 /* mods is NULL if there are no changes */
3274 struct berval dn = op->o_req_dn;
3275 struct berval ndn = op->o_req_ndn;
3276 op->o_tag = LDAP_REQ_MODIFY;
3277 op->orm_modlist = mods;
3278 op->o_req_dn = rs->sr_entry->e_name;
3279 op->o_req_ndn = rs->sr_entry->e_nname;
3280 op->o_callback = &cb;
3281 op->o_bd->be_modify( op, rs );
3282 slap_mods_free( mods, 1 );
3284 op->o_req_ndn = ndn;
3288 /* Add DN to list */
3289 dnl = dnl_alloc( op, &rs->sr_entry->e_nname );
3291 if ( ri->ri_tail ) {
3292 ri->ri_tail->next = dnl;
3297 op->o_callback = ocb;
3303 refresh_purge( Operation *op, SlapReply *rs )
3305 if ( rs->sr_type == REP_SEARCH ) {
3306 refresh_info *ri = op->o_callback->sc_private;
3310 /* Did the entry exist on the remote? */
3311 for ( dn=&ri->ri_dns; *dn; dn = &(*dn)->next ) {
3312 if ( dn_match( &(*dn)->dn, &rs->sr_entry->e_nname )) {
3313 dnlist *dnext = (*dn)->next;
3314 op->o_tmpfree( *dn, op->o_tmpmemctx );
3320 /* No, so put it on the list to delete */
3323 dnlist *dnl = dnl_alloc( op, &rs->sr_entry->e_nname );
3324 dnl->next = ri->ri_dels;
3326 a = attr_find( rs->sr_entry->e_attrs, ad_queryId );
3327 /* If ours is the only queryId, delete entry */
3328 dnl->delete = ( a->a_numvals == 1 );
3335 refresh_query( Operation *op, SlapReply *rs, CachedQuery *query,
3338 slap_callback cb = { 0 };
3339 refresh_info ri = { 0 };
3340 char filter_str[ LDAP_LUTIL_UUIDSTR_BUFSIZE + STRLENOF( "(pcacheQueryID=)" ) ];
3341 AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
3342 Filter filter = {LDAP_FILTER_EQUALITY};
3343 AttributeName attrs[ 2 ] = {{{ 0 }}};
3347 ldap_pvt_thread_mutex_lock( &query->answerable_cnt_mutex );
3349 ldap_pvt_thread_mutex_unlock( &query->answerable_cnt_mutex );
3351 cb.sc_response = refresh_merge;
3352 cb.sc_private = &ri;
3355 ri.ri_be = op->o_bd;
3358 op->o_tag = LDAP_REQ_SEARCH;
3359 op->o_protocol = LDAP_VERSION3;
3360 op->o_callback = &cb;
3361 op->o_do_not_cache = 1;
3363 op->o_req_dn = query->qbase->base;
3364 op->o_req_ndn = query->qbase->base;
3365 op->ors_scope = query->scope;
3366 op->ors_slimit = SLAP_NO_LIMIT;
3367 op->ors_tlimit = SLAP_NO_LIMIT;
3368 op->ors_limit = NULL;
3369 op->ors_filter = query->filter;
3370 filter2bv_x( op, query->filter, &op->ors_filterstr );
3371 op->ors_attrs = query->qtemp->t_attrs.attrs;
3372 op->ors_attrsonly = 0;
3374 op->o_bd = on->on_info->oi_origdb;
3375 rc = op->o_bd->be_search( op, rs );
3377 op->o_bd = ri.ri_be;
3381 /* Get the DNs of all entries matching this query */
3382 cb.sc_response = refresh_purge;
3384 op->o_bd = ri.ri_be;
3385 op->o_req_dn = op->o_bd->be_suffix[0];
3386 op->o_req_ndn = op->o_bd->be_nsuffix[0];
3387 op->ors_scope = LDAP_SCOPE_SUBTREE;
3388 op->ors_deref = LDAP_DEREF_NEVER;
3389 op->ors_filterstr.bv_len = snprintf(filter_str, sizeof(filter_str),
3390 "(%s=%s)", ad_queryId->ad_cname.bv_val, query->q_uuid.bv_val);
3391 filter.f_ava = &ava;
3392 filter.f_av_desc = ad_queryId;
3393 filter.f_av_value = query->q_uuid;
3394 attrs[ 0 ].an_desc = ad_queryId;
3395 attrs[ 0 ].an_name = ad_queryId->ad_cname;
3396 op->ors_attrs = attrs;
3397 op->ors_attrsonly = 0;
3398 rs->sr_entry = NULL;
3399 rs->sr_nentries = 0;
3400 rc = op->o_bd->be_search( op, rs );
3401 if ( rc ) goto leave;
3403 while (( dn = ri.ri_dels )) {
3404 op->o_req_dn = dn->dn;
3405 op->o_req_ndn = dn->dn;
3407 op->o_tag = LDAP_REQ_DELETE;
3408 op->o_bd->be_delete( op, rs );
3411 struct berval vals[2];
3413 vals[0] = query->q_uuid;
3414 BER_BVZERO( &vals[1] );
3415 mod.sml_op = LDAP_MOD_DELETE;
3417 mod.sml_desc = ad_queryId;
3418 mod.sml_type = ad_queryId->ad_cname;
3419 mod.sml_values = vals;
3420 mod.sml_nvalues = NULL;
3421 mod.sml_numvals = 1;
3422 mod.sml_next = NULL;
3424 op->o_tag = LDAP_REQ_MODIFY;
3425 op->orm_modlist = &mod;
3426 op->o_bd->be_modify( op, rs );
3428 ri.ri_dels = dn->next;
3429 op->o_tmpfree( dn, op->o_tmpmemctx );
3433 /* reset our local heap, we're done with it */
3434 slap_sl_mem_create(SLAP_SLAB_SIZE, SLAP_SLAB_STACK, op->o_threadctx, 1 );
3443 struct re_s *rtask = arg;
3444 slap_overinst *on = rtask->arg;
3445 cache_manager *cm = on->on_bi.bi_private;
3446 query_manager *qm = cm->qm;
3447 Connection conn = {0};
3448 OperationBuffer opbuf;
3451 SlapReply rs = {REP_RESULT};
3452 CachedQuery *query, *qprev;
3453 int return_val, pause = PCACHE_CC_PAUSED;
3454 QueryTemplate *templ;
3456 /* Don't expire anything when we're offline */
3457 if ( cm->cc_paused & PCACHE_CC_OFFLINE ) {
3458 pause = PCACHE_CC_OFFLINE;
3462 connection_fake_init( &conn, &opbuf, ctx );
3466 op->o_dn = cm->db.be_rootdn;
3467 op->o_ndn = cm->db.be_rootndn;
3471 for (templ = qm->templates; templ; templ=templ->qmnext) {
3473 if ( !templ->query_last ) continue;
3475 op->o_time = slap_get_time();
3476 if ( !templ->ttr ) {
3478 if ( templ->negttl && templ->negttl < ttl )
3479 ttl = templ->negttl;
3480 if ( templ->limitttl && templ->limitttl < ttl )
3481 ttl = templ->limitttl;
3482 /* The oldest timestamp that needs expiration checking */
3486 for ( query=templ->query_last; query; query=qprev ) {
3487 qprev = query->prev;
3488 if ( query->refresh_time && query->refresh_time < op->o_time ) {
3489 /* A refresh will extend the expiry if the query has been
3490 * referenced, but not if it's unreferenced. If the
3491 * expiration has been hit, then skip the refresh since
3492 * we're just going to discard the result anyway.
3494 if ( query->refcnt )
3495 query->expiry_time = op->o_time + templ->ttl;
3496 if ( query->expiry_time > op->o_time ) {
3497 refresh_query( op, &rs, query, on );
3502 if (query->expiry_time < op->o_time) {
3504 Debug( pcache_debug, "Lock CR index = %p\n",
3505 (void *) templ, 0, 0 );
3506 ldap_pvt_thread_rdwr_wlock(&templ->t_rwlock);
3507 if ( query == templ->query_last ) {
3509 remove_from_template(query, templ);
3510 Debug( pcache_debug, "TEMPLATE %p QUERIES-- %d\n",
3511 (void *) templ, templ->no_of_queries, 0 );
3512 Debug( pcache_debug, "Unlock CR index = %p\n",
3513 (void *) templ, 0, 0 );
3515 ldap_pvt_thread_rdwr_wunlock(&templ->t_rwlock);
3519 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
3520 remove_query(qm, query);
3521 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
3522 if ( BER_BVISNULL( &query->q_uuid ))
3525 return_val = remove_query_data(op, &rs, &query->q_uuid);
3526 Debug( pcache_debug, "STALE QUERY REMOVED, SIZE=%d\n",
3528 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
3529 cm->cur_entries -= return_val;
3530 cm->num_cached_queries--;
3531 Debug( pcache_debug, "STORED QUERIES = %lu\n",
3532 cm->num_cached_queries, 0, 0 );
3533 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
3534 Debug( pcache_debug,
3535 "STALE QUERY REMOVED, CACHE ="
3537 cm->cur_entries, 0, 0 );
3539 } else if ( !templ->ttr && query->expiry_time > ttl ) {
3540 /* We don't need to check for refreshes, and this
3541 * query's expiry is too new, and all subsequent queries
3542 * will be newer yet. So stop looking.
3544 * If we have refreshes, then we always have to walk the
3545 * entire query list.
3553 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
3554 if ( ldap_pvt_runqueue_isrunning( &slapd_rq, rtask )) {
3555 ldap_pvt_runqueue_stoptask( &slapd_rq, rtask );
3557 /* If there were no queries, defer processing for a while */
3558 if ( cm->cc_paused != pause )
3559 cm->cc_paused = pause;
3560 ldap_pvt_runqueue_resched( &slapd_rq, rtask, pause );
3562 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
3567 #define MAX_ATTR_SETS 500
3580 static ConfigDriver pc_cf_gen;
3581 static ConfigLDAPadd pc_ldadd;
3582 static ConfigCfAdd pc_cfadd;
3584 static ConfigTable pccfg[] = {
3585 { "pcache", "backend> <max_entries> <numattrsets> <entry limit> "
3587 6, 6, 0, ARG_MAGIC|ARG_NO_DELETE|PC_MAIN, pc_cf_gen,
3588 "( OLcfgOvAt:2.1 NAME ( 'olcPcache' 'olcProxyCache' ) "
3589 "DESC 'Proxy Cache basic parameters' "
3590 "SYNTAX OMsDirectoryString SINGLE-VALUE )", NULL, NULL },
3591 { "pcacheAttrset", "index> <attributes...",
3592 2, 0, 0, ARG_MAGIC|PC_ATTR, pc_cf_gen,
3593 "( OLcfgOvAt:2.2 NAME ( 'olcPcacheAttrset' 'olcProxyAttrset' ) "
3594 "DESC 'A set of attributes to cache' "
3595 "SYNTAX OMsDirectoryString )", NULL, NULL },
3596 { "pcacheTemplate", "filter> <attrset-index> <TTL> <negTTL> "
3598 4, 7, 0, ARG_MAGIC|PC_TEMP, pc_cf_gen,
3599 "( OLcfgOvAt:2.3 NAME ( 'olcPcacheTemplate' 'olcProxyCacheTemplate' ) "
3600 "DESC 'Filter template, attrset, cache TTL, "
3601 "optional negative TTL, optional sizelimit TTL, "
3603 "SYNTAX OMsDirectoryString )", NULL, NULL },
3604 { "pcachePosition", "head|tail(default)",
3605 2, 2, 0, ARG_MAGIC|PC_RESP, pc_cf_gen,
3606 "( OLcfgOvAt:2.4 NAME 'olcPcachePosition' "
3607 "DESC 'Response callback position in overlay stack' "
3608 "SYNTAX OMsDirectoryString )", NULL, NULL },
3609 { "pcacheMaxQueries", "queries",
3610 2, 2, 0, ARG_INT|ARG_MAGIC|PC_QUERIES, pc_cf_gen,
3611 "( OLcfgOvAt:2.5 NAME ( 'olcPcacheMaxQueries' 'olcProxyCacheQueries' ) "
3612 "DESC 'Maximum number of queries to cache' "
3613 "SYNTAX OMsInteger )", NULL, NULL },
3614 { "pcachePersist", "TRUE|FALSE",
3615 2, 2, 0, ARG_ON_OFF|ARG_OFFSET, (void *)offsetof(cache_manager, save_queries),
3616 "( OLcfgOvAt:2.6 NAME ( 'olcPcachePersist' 'olcProxySaveQueries' ) "
3617 "DESC 'Save cached queries for hot restart' "
3618 "SYNTAX OMsBoolean )", NULL, NULL },
3619 { "pcacheValidate", "TRUE|FALSE",
3620 2, 2, 0, ARG_ON_OFF|ARG_OFFSET, (void *)offsetof(cache_manager, check_cacheability),
3621 "( OLcfgOvAt:2.7 NAME ( 'olcPcacheValidate' 'olcProxyCheckCacheability' ) "
3622 "DESC 'Check whether the results of a query are cacheable, e.g. for schema issues' "
3623 "SYNTAX OMsBoolean )", NULL, NULL },
3624 { "pcacheOffline", "TRUE|FALSE",
3625 2, 2, 0, ARG_ON_OFF|ARG_MAGIC|PC_OFFLINE, pc_cf_gen,
3626 "( OLcfgOvAt:2.8 NAME 'olcPcacheOffline' "
3627 "DESC 'Set cache to offline mode and disable expiration' "
3628 "SYNTAX OMsBoolean )", NULL, NULL },
3629 { "pcacheBind", "filter> <attrset-index> <TTR> <scope> <base",
3630 6, 6, 0, ARG_MAGIC|PC_BIND, pc_cf_gen,
3631 "( OLcfgOvAt:2.9 NAME 'olcPcacheBind' "
3632 "DESC 'Parameters for caching Binds' "
3633 "SYNTAX OMsDirectoryString )", NULL, NULL },
3634 { "pcache-", "private database args",
3635 1, 0, STRLENOF("pcache-"), ARG_MAGIC|PC_PRIVATE_DB, pc_cf_gen,
3638 /* Legacy keywords */
3639 { "proxycache", "backend> <max_entries> <numattrsets> <entry limit> "
3641 6, 6, 0, ARG_MAGIC|ARG_NO_DELETE|PC_MAIN, pc_cf_gen,
3643 { "proxyattrset", "index> <attributes...",
3644 2, 0, 0, ARG_MAGIC|PC_ATTR, pc_cf_gen,
3646 { "proxytemplate", "filter> <attrset-index> <TTL> <negTTL",
3647 4, 7, 0, ARG_MAGIC|PC_TEMP, pc_cf_gen,
3649 { "response-callback", "head|tail(default)",
3650 2, 2, 0, ARG_MAGIC|PC_RESP, pc_cf_gen,
3652 { "proxyCacheQueries", "queries",
3653 2, 2, 0, ARG_INT|ARG_MAGIC|PC_QUERIES, pc_cf_gen,
3655 { "proxySaveQueries", "TRUE|FALSE",
3656 2, 2, 0, ARG_ON_OFF|ARG_OFFSET, (void *)offsetof(cache_manager, save_queries),
3658 { "proxyCheckCacheability", "TRUE|FALSE",
3659 2, 2, 0, ARG_ON_OFF|ARG_OFFSET, (void *)offsetof(cache_manager, check_cacheability),
3662 { NULL, NULL, 0, 0, 0, ARG_IGNORED }
3665 static ConfigOCs pcocs[] = {
3666 { "( OLcfgOvOc:2.1 "
3667 "NAME 'olcPcacheConfig' "
3668 "DESC 'ProxyCache configuration' "
3669 "SUP olcOverlayConfig "
3670 "MUST ( olcPcache $ olcPcacheAttrset $ olcPcacheTemplate ) "
3671 "MAY ( olcPcachePosition $ olcPcacheMaxQueries $ olcPcachePersist $ "
3672 "olcPcacheValidate $ olcPcacheOffline $ olcPcacheBind ) )",
3673 Cft_Overlay, pccfg, NULL, pc_cfadd },
3674 { "( OLcfgOvOc:2.2 "
3675 "NAME 'olcPcacheDatabase' "
3676 "DESC 'Cache database configuration' "
3677 "AUXILIARY )", Cft_Misc, olcDatabaseDummy, pc_ldadd },
3681 static int pcache_db_open2( slap_overinst *on, ConfigReply *cr );
3684 pc_ldadd_cleanup( ConfigArgs *c )
3686 slap_overinst *on = c->ca_private;
3687 return pcache_db_open2( on, &c->reply );
3691 pc_ldadd( CfEntryInfo *p, Entry *e, ConfigArgs *ca )
3696 if ( p->ce_type != Cft_Overlay || !p->ce_bi ||
3697 p->ce_bi->bi_cf_ocs != pcocs )
3698 return LDAP_CONSTRAINT_VIOLATION;
3700 on = (slap_overinst *)p->ce_bi;
3701 cm = on->on_bi.bi_private;
3703 /* Defer open if this is an LDAPadd */
3704 if ( CONFIG_ONLINE_ADD( ca ))
3705 ca->cleanup = pc_ldadd_cleanup;
3707 cm->defer_db_open = 0;
3708 ca->ca_private = on;
3709 return LDAP_SUCCESS;
3713 pc_cfadd( Operation *op, SlapReply *rs, Entry *p, ConfigArgs *ca )
3715 CfEntryInfo *pe = p->e_private;
3716 slap_overinst *on = (slap_overinst *)pe->ce_bi;
3717 cache_manager *cm = on->on_bi.bi_private;
3720 /* FIXME: should not hardcode "olcDatabase" here */
3721 bv.bv_len = snprintf( ca->cr_msg, sizeof( ca->cr_msg ),
3722 "olcDatabase=" SLAP_X_ORDERED_FMT "%s",
3723 0, cm->db.bd_info->bi_type );
3724 if ( bv.bv_len >= sizeof( ca->cr_msg ) ) {
3727 bv.bv_val = ca->cr_msg;
3729 cm->defer_db_open = 0;
3731 /* We can only create this entry if the database is table-driven
3733 if ( cm->db.bd_info->bi_cf_ocs )
3734 config_build_entry( op, rs, pe, ca, &bv, cm->db.bd_info->bi_cf_ocs,
3741 pc_cf_gen( ConfigArgs *c )
3743 slap_overinst *on = (slap_overinst *)c->bi;
3744 cache_manager* cm = on->on_bi.bi_private;
3745 query_manager* qm = cm->qm;
3746 QueryTemplate* temp;
3747 AttributeName* attr_name;
3748 AttributeName* attrarray;
3749 const char* text=NULL;
3754 if ( c->op == SLAP_CONFIG_EMIT ) {
3758 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ), "%s %d %d %d %ld",
3759 cm->db.bd_info->bi_type, cm->max_entries, cm->numattrsets,
3760 cm->num_entries_limit, cm->cc_period );
3761 bv.bv_val = c->cr_msg;
3762 value_add_one( &c->rvalue_vals, &bv );
3765 for (i=0; i<cm->numattrsets; i++) {
3766 if ( !qm->attr_sets[i].count ) continue;
3768 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ), "%d", i );
3770 /* count the attr length */
3771 for ( attr_name = qm->attr_sets[i].attrs;
3772 attr_name->an_name.bv_val; attr_name++ )
3773 bv.bv_len += attr_name->an_name.bv_len + 1;
3775 bv.bv_val = ch_malloc( bv.bv_len+1 );
3776 ptr = lutil_strcopy( bv.bv_val, c->cr_msg );
3777 for ( attr_name = qm->attr_sets[i].attrs;
3778 attr_name->an_name.bv_val; attr_name++ ) {
3780 ptr = lutil_strcopy( ptr, attr_name->an_name.bv_val );
3782 ber_bvarray_add( &c->rvalue_vals, &bv );
3784 if ( !c->rvalue_vals )
3788 for (temp=qm->templates; temp; temp=temp->qmnext) {
3789 /* HEADS-UP: always print all;
3790 * if optional == 0, ignore */
3791 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ),
3792 " %d %ld %ld %ld %ld",
3793 temp->attr_set_index,
3798 bv.bv_len += temp->querystr.bv_len + 2;
3799 bv.bv_val = ch_malloc( bv.bv_len+1 );
3802 ptr = lutil_strcopy( ptr, temp->querystr.bv_val );
3804 strcpy( ptr, c->cr_msg );
3805 ber_bvarray_add( &c->rvalue_vals, &bv );
3807 if ( !c->rvalue_vals )
3811 for (temp=qm->templates; temp; temp=temp->qmnext) {
3812 if ( !temp->bindttr ) continue;
3813 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ),
3815 temp->attr_set_index,
3817 ldap_pvt_scope2str( temp->bindscope ));
3818 bv.bv_len += temp->bindbase.bv_len + temp->bindftemp.bv_len + 4;
3819 bv.bv_val = ch_malloc( bv.bv_len + 1 );
3822 ptr = lutil_strcopy( ptr, temp->bindftemp.bv_val );
3824 ptr = lutil_strcopy( ptr, c->cr_msg );
3826 ptr = lutil_strcopy( ptr, temp->bindbase.bv_val );
3829 ber_bvarray_add( &c->rvalue_vals, &bv );
3831 if ( !c->rvalue_vals )
3835 if ( cm->response_cb == PCACHE_RESPONSE_CB_HEAD ) {
3836 BER_BVSTR( &bv, "head" );
3838 BER_BVSTR( &bv, "tail" );
3840 value_add_one( &c->rvalue_vals, &bv );
3843 c->value_int = cm->max_queries;
3846 c->value_int = (cm->cc_paused & PCACHE_CC_OFFLINE) != 0;
3850 } else if ( c->op == LDAP_MOD_DELETE ) {
3853 case PC_ATTR: /* FIXME */
3858 cm->cc_paused &= ~PCACHE_CC_OFFLINE;
3859 /* If there were cached queries when we went offline,
3860 * restart the checker now.
3862 if ( cm->num_cached_queries ) {
3863 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
3865 ldap_pvt_runqueue_resched( &slapd_rq, cm->cc_arg, 0 );
3866 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
3876 if ( cm->numattrsets > 0 ) {
3877 snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"pcache\" directive already provided" );
3878 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3882 if ( lutil_atoi( &cm->numattrsets, c->argv[3] ) != 0 ) {
3883 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse num attrsets=\"%s\" (arg #3)",
3885 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3888 if ( cm->numattrsets <= 0 ) {
3889 snprintf( c->cr_msg, sizeof( c->cr_msg ), "numattrsets (arg #3) must be positive" );
3890 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3893 if ( cm->numattrsets > MAX_ATTR_SETS ) {
3894 snprintf( c->cr_msg, sizeof( c->cr_msg ), "numattrsets (arg #3) must be <= %d", MAX_ATTR_SETS );
3895 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3899 if ( !backend_db_init( c->argv[1], &cm->db, -1, NULL )) {
3900 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unknown backend type (arg #1)" );
3901 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3905 if ( lutil_atoi( &cm->max_entries, c->argv[2] ) != 0 ) {
3906 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse max entries=\"%s\" (arg #2)",
3908 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3911 if ( cm->max_entries <= 0 ) {
3912 snprintf( c->cr_msg, sizeof( c->cr_msg ), "max entries (arg #2) must be positive.\n" );
3913 Debug( LDAP_DEBUG_CONFIG, "%s: %s\n", c->log, c->cr_msg, 0 );
3917 if ( lutil_atoi( &cm->num_entries_limit, c->argv[4] ) != 0 ) {
3918 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse entry limit=\"%s\" (arg #4)",
3920 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3923 if ( cm->num_entries_limit <= 0 ) {
3924 snprintf( c->cr_msg, sizeof( c->cr_msg ), "entry limit (arg #4) must be positive" );
3925 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3928 if ( cm->num_entries_limit > cm->max_entries ) {
3929 snprintf( c->cr_msg, sizeof( c->cr_msg ), "entry limit (arg #4) must be less than max entries %d (arg #2)", cm->max_entries );
3930 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3934 if ( lutil_parse_time( c->argv[5], &t ) != 0 ) {
3935 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse period=\"%s\" (arg #5)",
3937 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3941 cm->cc_period = (time_t)t;
3942 Debug( pcache_debug,
3943 "Total # of attribute sets to be cached = %d.\n",
3944 cm->numattrsets, 0, 0 );
3945 qm->attr_sets = ( struct attr_set * )ch_calloc( cm->numattrsets,
3946 sizeof( struct attr_set ) );
3949 if ( cm->numattrsets == 0 ) {
3950 snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"pcache\" directive not provided yet" );
3951 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3954 if ( lutil_atoi( &num, c->argv[1] ) != 0 ) {
3955 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse attrset #=\"%s\"",
3957 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3961 if ( num < 0 || num >= cm->numattrsets ) {
3962 snprintf( c->cr_msg, sizeof( c->cr_msg ), "attrset index %d out of bounds (must be %s%d)",
3963 num, cm->numattrsets > 1 ? "0->" : "", cm->numattrsets - 1 );
3964 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3967 qm->attr_sets[num].flags |= PC_CONFIGURED;
3968 if ( c->argc == 2 ) {
3970 snprintf( c->cr_msg, sizeof( c->cr_msg ),
3971 "need an explicit attr in attrlist; use \"*\" to indicate all attrs" );
3972 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3975 } else if ( c->argc == 3 ) {
3976 if ( strcmp( c->argv[2], LDAP_ALL_USER_ATTRIBUTES ) == 0 ) {
3977 qm->attr_sets[num].count = 1;
3978 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( 2,
3979 sizeof( AttributeName ) );
3980 BER_BVSTR( &qm->attr_sets[num].attrs[0].an_name, LDAP_ALL_USER_ATTRIBUTES );
3983 } else if ( strcmp( c->argv[2], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 ) {
3984 qm->attr_sets[num].count = 1;
3985 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( 2,
3986 sizeof( AttributeName ) );
3987 BER_BVSTR( &qm->attr_sets[num].attrs[0].an_name, LDAP_ALL_OPERATIONAL_ATTRIBUTES );
3990 } else if ( strcmp( c->argv[2], LDAP_NO_ATTRS ) == 0 ) {
3993 /* else: fallthru */
3995 } else if ( c->argc == 4 ) {
3996 if ( ( strcmp( c->argv[2], LDAP_ALL_USER_ATTRIBUTES ) == 0 && strcmp( c->argv[3], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 )
3997 || ( strcmp( c->argv[2], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 && strcmp( c->argv[3], LDAP_ALL_USER_ATTRIBUTES ) == 0 ) )
3999 qm->attr_sets[num].count = 2;
4000 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( 3,
4001 sizeof( AttributeName ) );
4002 BER_BVSTR( &qm->attr_sets[num].attrs[0].an_name, LDAP_ALL_USER_ATTRIBUTES );
4003 BER_BVSTR( &qm->attr_sets[num].attrs[1].an_name, LDAP_ALL_OPERATIONAL_ATTRIBUTES );
4006 /* else: fallthru */
4009 if ( c->argc > 2 ) {
4010 int all_user = 0, all_op = 0;
4012 qm->attr_sets[num].count = c->argc - 2;
4013 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( c->argc - 1,
4014 sizeof( AttributeName ) );
4015 attr_name = qm->attr_sets[num].attrs;
4016 for ( i = 2; i < c->argc; i++ ) {
4017 attr_name->an_desc = NULL;
4018 if ( strcmp( c->argv[i], LDAP_NO_ATTRS ) == 0 ) {
4019 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4020 "invalid attr #%d \"%s\" in attrlist",
4021 i - 2, c->argv[i] );
4022 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4023 ch_free( qm->attr_sets[num].attrs );
4024 qm->attr_sets[num].attrs = NULL;
4025 qm->attr_sets[num].count = 0;
4028 if ( strcmp( c->argv[i], LDAP_ALL_USER_ATTRIBUTES ) == 0 ) {
4030 BER_BVSTR( &attr_name->an_name, LDAP_ALL_USER_ATTRIBUTES );
4031 } else if ( strcmp( c->argv[i], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 ) {
4033 BER_BVSTR( &attr_name->an_name, LDAP_ALL_OPERATIONAL_ATTRIBUTES );
4035 if ( slap_str2ad( c->argv[i], &attr_name->an_desc, &text ) ) {
4036 strcpy( c->cr_msg, text );
4037 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4038 ch_free( qm->attr_sets[num].attrs );
4039 qm->attr_sets[num].attrs = NULL;
4040 qm->attr_sets[num].count = 0;
4043 attr_name->an_name = attr_name->an_desc->ad_cname;
4045 attr_name->an_oc = NULL;
4046 attr_name->an_flags = 0;
4047 if ( attr_name->an_desc == slap_schema.si_ad_objectClass )
4048 qm->attr_sets[num].flags |= PC_GOT_OC;
4050 BER_BVZERO( &attr_name->an_name );
4053 /* warn if list contains both "*" and "+" */
4054 if ( i > 4 && all_user && all_op ) {
4055 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4056 "warning: attribute list contains \"*\" and \"+\"" );
4057 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4062 if ( cm->numattrsets == 0 ) {
4063 snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"pcache\" directive not provided yet" );
4064 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4067 if ( lutil_atoi( &i, c->argv[2] ) != 0 ) {
4068 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse template #=\"%s\"",
4070 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4074 if ( i < 0 || i >= cm->numattrsets ||
4075 !(qm->attr_sets[i].flags & PC_CONFIGURED )) {
4076 snprintf( c->cr_msg, sizeof( c->cr_msg ), "template index %d invalid (%s%d)",
4077 i, cm->numattrsets > 1 ? "0->" : "", cm->numattrsets - 1 );
4078 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4082 AttributeName *attrs;
4084 cnt = template_attrs( c->argv[1], &qm->attr_sets[i], &attrs, &text );
4086 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse template: %s",
4088 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4091 temp = ch_calloc( 1, sizeof( QueryTemplate ));
4092 temp->qmnext = qm->templates;
4093 qm->templates = temp;
4094 temp->t_attrs.attrs = attrs;
4095 temp->t_attrs.count = cnt;
4097 ldap_pvt_thread_rdwr_init( &temp->t_rwlock );
4098 temp->query = temp->query_last = NULL;
4099 if ( lutil_parse_time( c->argv[3], &t ) != 0 ) {
4100 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4101 "unable to parse template ttl=\"%s\"",
4103 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4105 ch_free( temp->t_attrs.attrs );
4109 temp->ttl = (time_t)t;
4110 temp->negttl = (time_t)0;
4111 temp->limitttl = (time_t)0;
4112 temp->ttr = (time_t)0;
4113 switch ( c->argc ) {
4115 if ( lutil_parse_time( c->argv[6], &t ) != 0 ) {
4116 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4117 "unable to parse template ttr=\"%s\"",
4119 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4122 temp->ttr = (time_t)t;
4126 if ( lutil_parse_time( c->argv[5], &t ) != 0 ) {
4127 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4128 "unable to parse template sizelimit ttl=\"%s\"",
4130 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4133 temp->limitttl = (time_t)t;
4137 if ( lutil_parse_time( c->argv[4], &t ) != 0 ) {
4138 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4139 "unable to parse template negative ttl=\"%s\"",
4141 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4144 temp->negttl = (time_t)t;
4148 temp->no_of_queries = 0;
4150 ber_str2bv( c->argv[1], 0, 1, &temp->querystr );
4151 Debug( pcache_debug, "Template:\n", 0, 0, 0 );
4152 Debug( pcache_debug, " query template: %s\n",
4153 temp->querystr.bv_val, 0, 0 );
4154 temp->attr_set_index = i;
4155 qm->attr_sets[i].flags |= PC_REFERENCED;
4156 temp->qtnext = qm->attr_sets[i].templates;
4157 qm->attr_sets[i].templates = temp;
4158 Debug( pcache_debug, " attributes: \n", 0, 0, 0 );
4159 if ( ( attrarray = qm->attr_sets[i].attrs ) != NULL ) {
4160 for ( i=0; attrarray[i].an_name.bv_val; i++ )
4161 Debug( pcache_debug, "\t%s\n",
4162 attrarray[i].an_name.bv_val, 0, 0 );
4166 if ( !qm->templates ) {
4167 snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"pcacheTemplate\" directive not provided yet" );
4168 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4171 if ( lutil_atoi( &i, c->argv[2] ) != 0 ) {
4172 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse Bind index #=\"%s\"",
4174 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4178 if ( i < 0 || i >= cm->numattrsets ||
4179 !(qm->attr_sets[i].flags & PC_CONFIGURED )) {
4180 snprintf( c->cr_msg, sizeof( c->cr_msg ), "Bind index %d invalid (%s%d)",
4181 i, cm->numattrsets > 1 ? "0->" : "", cm->numattrsets - 1 );
4182 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4185 { struct berval bv, tempbv;
4186 AttributeDescription **descs;
4188 ber_str2bv( c->argv[1], 0, 0, &bv );
4189 ndescs = ftemp_attrs( &bv, &tempbv, &descs, &text );
4191 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse template: %s",
4193 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4196 for ( temp = qm->templates; temp; temp=temp->qmnext ) {
4197 if ( temp->attr_set_index == i && bvmatch( &tempbv,
4201 ch_free( tempbv.bv_val );
4204 snprintf( c->cr_msg, sizeof( c->cr_msg ), "Bind template %s %d invalid",
4206 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4209 ber_dupbv( &temp->bindftemp, &bv );
4210 temp->bindfattrs = descs;
4211 temp->bindnattrs = ndescs;
4213 if ( lutil_parse_time( c->argv[3], &t ) != 0 ) {
4214 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4215 "unable to parse bind ttr=\"%s\"",
4217 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4219 ch_free( temp->bindfattrs );
4220 temp->bindfattrs = NULL;
4221 ch_free( temp->bindftemp.bv_val );
4222 BER_BVZERO( &temp->bindftemp );
4225 num = ldap_pvt_str2scope( c->argv[4] );
4227 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4228 "unable to parse bind scope=\"%s\"",
4230 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4234 struct berval dn, ndn;
4235 ber_str2bv( c->argv[5], 0, 0, &dn );
4236 rc = dnNormalize( 0, NULL, NULL, &dn, &ndn, NULL );
4238 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4239 "invalid bind baseDN=\"%s\"",
4241 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4244 if ( temp->bindbase.bv_val )
4245 ch_free( temp->bindbase.bv_val );
4246 temp->bindbase = ndn;
4249 /* convert the template into dummy filter */
4251 char *eq = temp->bindftemp.bv_val, *e2;
4254 while ((eq = strchr(eq, '=' ))) {
4259 bv.bv_len = temp->bindftemp.bv_len + i;
4260 bv.bv_val = ch_malloc( bv.bv_len + 1 );
4261 for ( e2 = bv.bv_val, eq = temp->bindftemp.bv_val;
4272 f = str2filter( bv.bv_val );
4274 ch_free( bv.bv_val );
4275 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4276 "unable to parse bindfilter=\"%s\"", bv.bv_val );
4277 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4278 ch_free( temp->bindbase.bv_val );
4279 BER_BVZERO( &temp->bindbase );
4282 if ( temp->bindfilter )
4283 filter_free( temp->bindfilter );
4284 if ( temp->bindfilterstr.bv_val )
4285 ch_free( temp->bindfilterstr.bv_val );
4286 temp->bindfilterstr = bv;
4287 temp->bindfilter = f;
4289 temp->bindttr = (time_t)t;
4290 temp->bindscope = num;
4291 cm->cache_binds = 1;
4295 if ( strcasecmp( c->argv[1], "head" ) == 0 ) {
4296 cm->response_cb = PCACHE_RESPONSE_CB_HEAD;
4298 } else if ( strcasecmp( c->argv[1], "tail" ) == 0 ) {
4299 cm->response_cb = PCACHE_RESPONSE_CB_TAIL;
4302 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unknown specifier" );
4303 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4308 if ( c->value_int <= 0 ) {
4309 snprintf( c->cr_msg, sizeof( c->cr_msg ), "max queries must be positive" );
4310 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4313 cm->max_queries = c->value_int;
4317 cm->cc_paused |= PCACHE_CC_OFFLINE;
4319 cm->cc_paused &= ~PCACHE_CC_OFFLINE;
4322 if ( cm->db.be_private == NULL ) {
4323 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4324 "private database must be defined before setting database specific options" );
4325 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4329 if ( cm->db.bd_info->bi_cf_ocs ) {
4332 char *argv0 = c->argv[ 0 ];
4334 c->argv[ 0 ] = &argv0[ STRLENOF( "pcache-" ) ];
4336 ct = config_find_keyword( cm->db.bd_info->bi_cf_ocs->co_table, c );
4338 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4339 "private database does not recognize specific option '%s'",
4341 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4345 c->table = cm->db.bd_info->bi_cf_ocs->co_type;
4347 c->bi = c->be->bd_info;
4349 rc = config_add_vals( ct, c );
4353 c->table = c2.table;
4356 c->argv[ 0 ] = argv0;
4358 } else if ( cm->db.be_config != NULL ) {
4359 char *argv0 = c->argv[ 0 ];
4361 c->argv[ 0 ] = &argv0[ STRLENOF( "pcache-" ) ];
4362 rc = cm->db.be_config( &cm->db, c->fname, c->lineno, c->argc, c->argv );
4363 c->argv[ 0 ] = argv0;
4366 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4367 "no means to set private database specific options" );
4368 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4373 rc = SLAP_CONF_UNKNOWN;
4389 slap_overinst *on = (slap_overinst *)be->bd_info;
4390 cache_manager* cm = on->on_bi.bi_private;
4392 /* Something for the cache database? */
4393 if ( cm->db.bd_info && cm->db.bd_info->bi_db_config )
4394 return cm->db.bd_info->bi_db_config( &cm->db, fname, lineno,
4396 return SLAP_CONF_UNKNOWN;
4404 slap_overinst *on = (slap_overinst *)be->bd_info;
4408 cm = (cache_manager *)ch_malloc(sizeof(cache_manager));
4409 on->on_bi.bi_private = cm;
4411 qm = (query_manager*)ch_malloc(sizeof(query_manager));
4414 SLAP_DBFLAGS(&cm->db) |= SLAP_DBFLAG_NO_SCHEMA_CHECK;
4415 cm->db.be_private = NULL;
4416 cm->db.bd_self = &cm->db;
4418 cm->numattrsets = 0;
4419 cm->num_entries_limit = 5;
4420 cm->num_cached_queries = 0;
4421 cm->max_entries = 0;
4422 cm->cur_entries = 0;
4423 cm->max_queries = 10000;
4424 cm->save_queries = 0;
4425 cm->check_cacheability = 0;
4426 cm->response_cb = PCACHE_RESPONSE_CB_TAIL;
4427 cm->defer_db_open = 1;
4428 cm->cache_binds = 0;
4429 cm->cc_period = 1000;
4432 #ifdef PCACHE_MONITOR
4433 cm->monitor_cb = NULL;
4434 #endif /* PCACHE_MONITOR */
4436 qm->attr_sets = NULL;
4437 qm->templates = NULL;
4439 qm->lru_bottom = NULL;
4441 qm->qcfunc = query_containment;
4442 qm->crfunc = cache_replacement;
4443 qm->addfunc = add_query;
4444 ldap_pvt_thread_mutex_init(&qm->lru_mutex);
4446 ldap_pvt_thread_mutex_init(&cm->cache_mutex);
4448 #ifndef PCACHE_MONITOR
4450 #else /* PCACHE_MONITOR */
4451 return pcache_monitor_db_init( be );
4452 #endif /* PCACHE_MONITOR */
4456 pcache_cachedquery_open_cb( Operation *op, SlapReply *rs )
4458 assert( op->o_tag == LDAP_REQ_SEARCH );
4460 if ( rs->sr_type == REP_SEARCH ) {
4463 a = attr_find( rs->sr_entry->e_attrs, ad_cachedQueryURL );
4467 assert( a->a_nvals != NULL );
4469 valsp = op->o_callback->sc_private;
4470 assert( *valsp == NULL );
4472 ber_bvarray_dup_x( valsp, a->a_nvals, op->o_tmpmemctx );
4480 pcache_cachedquery_count_cb( Operation *op, SlapReply *rs )
4482 assert( op->o_tag == LDAP_REQ_SEARCH );
4484 if ( rs->sr_type == REP_SEARCH ) {
4485 int *countp = (int *)op->o_callback->sc_private;
4498 cache_manager *cm = on->on_bi.bi_private;
4499 query_manager* qm = cm->qm;
4502 rc = backend_startup_one( &cm->db, cr );
4504 cm->defer_db_open = 0;
4507 /* There is no runqueue in TOOL mode */
4508 if (( slapMode & SLAP_SERVER_MODE ) && rc == 0 ) {
4509 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
4510 ldap_pvt_runqueue_insert( &slapd_rq, cm->cc_period,
4511 consistency_check, on,
4512 "pcache_consistency", cm->db.be_suffix[0].bv_val );
4513 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
4515 /* Cached database must have the rootdn */
4516 if ( BER_BVISNULL( &cm->db.be_rootndn )
4517 || BER_BVISEMPTY( &cm->db.be_rootndn ) )
4519 Debug( LDAP_DEBUG_ANY, "pcache_db_open(): "
4520 "underlying database of type \"%s\"\n"
4521 " serving naming context \"%s\"\n"
4522 " has no \"rootdn\", required by \"pcache\".\n",
4523 on->on_info->oi_orig->bi_type,
4524 cm->db.be_suffix[0].bv_val, 0 );
4528 if ( cm->save_queries ) {
4529 void *thrctx = ldap_pvt_thread_pool_context();
4530 Connection conn = { 0 };
4531 OperationBuffer opbuf;
4533 slap_callback cb = { 0 };
4534 SlapReply rs = { 0 };
4535 BerVarray vals = NULL;
4536 Filter f = { 0 }, f2 = { 0 };
4537 AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
4538 AttributeName attrs[ 2 ] = {{{ 0 }}};
4540 connection_fake_init2( &conn, &opbuf, thrctx, 0 );
4545 op->o_tag = LDAP_REQ_SEARCH;
4546 op->o_protocol = LDAP_VERSION3;
4547 cb.sc_response = pcache_cachedquery_open_cb;
4548 cb.sc_private = &vals;
4549 op->o_callback = &cb;
4550 op->o_time = slap_get_time();
4551 op->o_do_not_cache = 1;
4552 op->o_managedsait = SLAP_CONTROL_CRITICAL;
4554 op->o_dn = cm->db.be_rootdn;
4555 op->o_ndn = cm->db.be_rootndn;
4556 op->o_req_dn = cm->db.be_suffix[ 0 ];
4557 op->o_req_ndn = cm->db.be_nsuffix[ 0 ];
4559 op->ors_scope = LDAP_SCOPE_BASE;
4560 op->ors_deref = LDAP_DEREF_NEVER;
4562 op->ors_tlimit = SLAP_NO_LIMIT;
4563 op->ors_limit = NULL;
4564 ber_str2bv( "(pcacheQueryURL=*)", 0, 0, &op->ors_filterstr );
4565 f.f_choice = LDAP_FILTER_PRESENT;
4566 f.f_desc = ad_cachedQueryURL;
4567 op->ors_filter = &f;
4568 attrs[ 0 ].an_desc = ad_cachedQueryURL;
4569 attrs[ 0 ].an_name = ad_cachedQueryURL->ad_cname;
4570 op->ors_attrs = attrs;
4571 op->ors_attrsonly = 0;
4573 rc = op->o_bd->be_search( op, &rs );
4574 if ( rc == LDAP_SUCCESS && vals != NULL ) {
4577 for ( i = 0; !BER_BVISNULL( &vals[ i ] ); i++ ) {
4578 if ( url2query( vals[ i ].bv_val, op, qm ) == 0 ) {
4579 cm->num_cached_queries++;
4583 ber_bvarray_free_x( vals, op->o_tmpmemctx );
4586 /* count cached entries */
4587 f.f_choice = LDAP_FILTER_NOT;
4589 f2.f_choice = LDAP_FILTER_EQUALITY;
4591 f2.f_av_desc = slap_schema.si_ad_objectClass;
4592 BER_BVSTR( &f2.f_av_value, "glue" );
4593 ber_str2bv( "(!(objectClass=glue))", 0, 0, &op->ors_filterstr );
4595 op->ors_slimit = SLAP_NO_LIMIT;
4596 op->ors_scope = LDAP_SCOPE_SUBTREE;
4597 op->ors_attrs = slap_anlist_no_attrs;
4599 op->o_callback->sc_response = pcache_cachedquery_count_cb;
4601 op->o_callback->sc_private = &rs.sr_nentries;
4603 rc = op->o_bd->be_search( op, &rs );
4605 cm->cur_entries = rs.sr_nentries;
4619 slap_overinst *on = (slap_overinst *)be->bd_info;
4620 cache_manager *cm = on->on_bi.bi_private;
4621 query_manager* qm = cm->qm;
4622 int i, ncf = 0, rf = 0, nrf = 0, rc = 0;
4624 /* check attr sets */
4625 for ( i = 0; i < cm->numattrsets; i++) {
4626 if ( !( qm->attr_sets[i].flags & PC_CONFIGURED ) ) {
4627 if ( qm->attr_sets[i].flags & PC_REFERENCED ) {
4628 Debug( LDAP_DEBUG_CONFIG, "pcache: attr set #%d not configured but referenced.\n", i, 0, 0 );
4632 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, attr set #%d not configured.\n", i, 0, 0 );
4636 } else if ( !( qm->attr_sets[i].flags & PC_REFERENCED ) ) {
4637 Debug( LDAP_DEBUG_CONFIG, "pcache: attr set #%d configured but not referenced.\n", i, 0, 0 );
4642 if ( ncf || rf || nrf ) {
4643 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, %d attr sets configured but not referenced.\n", nrf, 0, 0 );
4644 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, %d attr sets not configured.\n", ncf, 0, 0 );
4645 Debug( LDAP_DEBUG_CONFIG, "pcache: %d attr sets not configured but referenced.\n", rf, 0, 0 );
4652 /* need to inherit something from the original database... */
4653 cm->db.be_def_limit = be->be_def_limit;
4654 cm->db.be_limits = be->be_limits;
4655 cm->db.be_acl = be->be_acl;
4656 cm->db.be_dfltaccess = be->be_dfltaccess;
4658 if ( SLAP_DBMONITORING( be ) ) {
4659 SLAP_DBFLAGS( &cm->db ) |= SLAP_DBFLAG_MONITORING;
4662 SLAP_DBFLAGS( &cm->db ) &= ~SLAP_DBFLAG_MONITORING;
4665 if ( !cm->defer_db_open ) {
4666 rc = pcache_db_open2( on, cr );
4669 #ifdef PCACHE_MONITOR
4670 if ( rc == LDAP_SUCCESS ) {
4671 rc = pcache_monitor_db_open( be );
4673 #endif /* PCACHE_MONITOR */
4679 pcache_free_qbase( void *v )
4685 tavl_free( qb->scopes[i], NULL );
4695 slap_overinst *on = (slap_overinst *)be->bd_info;
4696 cache_manager *cm = on->on_bi.bi_private;
4697 query_manager *qm = cm->qm;
4701 /* stop the thread ... */
4703 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
4704 if ( ldap_pvt_runqueue_isrunning( &slapd_rq, cm->cc_arg ) ) {
4705 ldap_pvt_runqueue_stoptask( &slapd_rq, cm->cc_arg );
4707 ldap_pvt_runqueue_remove( &slapd_rq, cm->cc_arg );
4708 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
4711 if ( cm->save_queries ) {
4713 BerVarray vals = NULL;
4716 Connection conn = { 0 };
4717 OperationBuffer opbuf;
4719 slap_callback cb = { 0 };
4721 SlapReply rs = { REP_RESULT };
4722 Modifications mod = {{ 0 }};
4724 thrctx = ldap_pvt_thread_pool_context();
4726 connection_fake_init2( &conn, &opbuf, thrctx, 0 );
4729 if ( qm->templates != NULL ) {
4730 for ( tm = qm->templates; tm != NULL; tm = tm->qmnext ) {
4731 for ( qc = tm->query; qc; qc = qc->next ) {
4734 if ( query2url( op, qc, &bv, 0 ) == 0 ) {
4735 ber_bvarray_add_x( &vals, &bv, op->o_tmpmemctx );
4742 op->o_dn = cm->db.be_rootdn;
4743 op->o_ndn = cm->db.be_rootndn;
4745 op->o_tag = LDAP_REQ_MODIFY;
4746 op->o_protocol = LDAP_VERSION3;
4747 cb.sc_response = slap_null_cb;
4748 op->o_callback = &cb;
4749 op->o_time = slap_get_time();
4750 op->o_do_not_cache = 1;
4751 op->o_managedsait = SLAP_CONTROL_CRITICAL;
4753 op->o_req_dn = op->o_bd->be_suffix[0];
4754 op->o_req_ndn = op->o_bd->be_nsuffix[0];
4756 mod.sml_op = LDAP_MOD_REPLACE;
4758 mod.sml_desc = ad_cachedQueryURL;
4759 mod.sml_type = ad_cachedQueryURL->ad_cname;
4760 mod.sml_values = vals;
4761 mod.sml_nvalues = NULL;
4762 mod.sml_numvals = 1;
4763 mod.sml_next = NULL;
4764 Debug( pcache_debug,
4765 "%sSETTING CACHED QUERY URLS\n",
4766 vals == NULL ? "RE" : "", 0, 0 );
4768 op->orm_modlist = &mod;
4770 op->o_bd->be_modify( op, &rs );
4772 ber_bvarray_free_x( vals, op->o_tmpmemctx );
4775 /* cleanup stuff inherited from the original database... */
4776 cm->db.be_limits = NULL;
4777 cm->db.be_acl = NULL;
4780 if ( cm->db.bd_info->bi_db_close ) {
4781 rc = cm->db.bd_info->bi_db_close( &cm->db, NULL );
4783 while ( (tm = qm->templates) != NULL ) {
4784 CachedQuery *qc, *qn;
4785 qm->templates = tm->qmnext;
4786 for ( qc = tm->query; qc; qc = qn ) {
4790 avl_free( tm->qbase, pcache_free_qbase );
4791 free( tm->querystr.bv_val );
4792 free( tm->bindfattrs );
4793 free( tm->bindftemp.bv_val );
4794 free( tm->bindfilterstr.bv_val );
4795 free( tm->bindbase.bv_val );
4796 filter_free( tm->bindfilter );
4797 ldap_pvt_thread_rdwr_destroy( &tm->t_rwlock );
4798 free( tm->t_attrs.attrs );
4802 for ( i=0; i<cm->numattrsets; i++ ) {
4803 free( qm->attr_sets[i].attrs );
4805 free( qm->attr_sets );
4806 qm->attr_sets = NULL;
4808 #ifdef PCACHE_MONITOR
4809 if ( rc == LDAP_SUCCESS ) {
4810 rc = pcache_monitor_db_close( be );
4812 #endif /* PCACHE_MONITOR */
4823 slap_overinst *on = (slap_overinst *)be->bd_info;
4824 cache_manager *cm = on->on_bi.bi_private;
4825 query_manager *qm = cm->qm;
4827 if ( cm->db.be_private != NULL ) {
4828 backend_stopdown_one( &cm->db );
4831 ldap_pvt_thread_mutex_destroy( &qm->lru_mutex );
4832 ldap_pvt_thread_mutex_destroy( &cm->cache_mutex );
4836 #ifdef PCACHE_MONITOR
4837 pcache_monitor_db_destroy( be );
4838 #endif /* PCACHE_MONITOR */
4843 #ifdef PCACHE_CONTROL_PRIVDB
4845 Control ::= SEQUENCE {
4846 controlType LDAPOID,
4847 criticality BOOLEAN DEFAULT FALSE,
4848 controlValue OCTET STRING OPTIONAL }
4850 controlType ::= 1.3.6.1.4.1.4203.666.11.9.5.1
4852 * criticality must be TRUE; controlValue must be absent.
4860 if ( op->o_ctrlflag[ privDB_cid ] != SLAP_CONTROL_NONE ) {
4861 rs->sr_text = "privateDB control specified multiple times";
4862 return LDAP_PROTOCOL_ERROR;
4865 if ( !BER_BVISNULL( &ctrl->ldctl_value ) ) {
4866 rs->sr_text = "privateDB control value not absent";
4867 return LDAP_PROTOCOL_ERROR;
4870 if ( !ctrl->ldctl_iscritical ) {
4871 rs->sr_text = "privateDB control criticality required";
4872 return LDAP_PROTOCOL_ERROR;
4875 op->o_ctrlflag[ privDB_cid ] = SLAP_CONTROL_CRITICAL;
4877 return LDAP_SUCCESS;
4880 static char *extops[] = {
4881 LDAP_EXOP_MODIFY_PASSWD,
4884 #endif /* PCACHE_CONTROL_PRIVDB */
4886 static struct berval pcache_exop_MODIFY_PASSWD = BER_BVC( LDAP_EXOP_MODIFY_PASSWD );
4887 #ifdef PCACHE_EXOP_QUERY_DELETE
4888 static struct berval pcache_exop_QUERY_DELETE = BER_BVC( PCACHE_EXOP_QUERY_DELETE );
4890 #define LDAP_TAG_EXOP_QUERY_DELETE_BASE ((LBER_CLASS_CONTEXT|LBER_CONSTRUCTED) + 0)
4891 #define LDAP_TAG_EXOP_QUERY_DELETE_DN ((LBER_CLASS_CONTEXT|LBER_CONSTRUCTED) + 1)
4892 #define LDAP_TAG_EXOP_QUERY_DELETE_UUID ((LBER_CLASS_CONTEXT|LBER_CONSTRUCTED) + 2)
4895 ExtendedRequest ::= [APPLICATION 23] SEQUENCE {
4896 requestName [0] LDAPOID,
4897 requestValue [1] OCTET STRING OPTIONAL }
4899 requestName ::= 1.3.6.1.4.1.4203.666.11.9.6.1
4901 requestValue ::= SEQUENCE { CHOICE {
4903 entryDN [1] LDAPDN },
4904 queryID [2] OCTET STRING (SIZE(16))
4905 -- constrained to UUID }
4907 * Either baseDN or entryDN must be present, to allow database selection.
4909 * 1. if baseDN and queryID are present, then the query corresponding
4910 * to queryID is deleted;
4911 * 2. if baseDN is present and queryID is absent, then all queries
4913 * 3. if entryDN is present and queryID is absent, then all queries
4914 * corresponding to the queryID values present in entryDN are deleted;
4915 * 4. if entryDN and queryID are present, then all queries
4916 * corresponding to the queryID values present in entryDN are deleted,
4917 * but only if the value of queryID is contained in the entry;
4919 * Currently, only 1, 3 and 4 are implemented. 2 can be obtained by either
4920 * recursively deleting the database (ldapdelete -r) with PRIVDB control,
4921 * or by removing the database files.
4923 ExtendedResponse ::= [APPLICATION 24] SEQUENCE {
4924 COMPONENTS OF LDAPResult,
4925 responseName [10] LDAPOID OPTIONAL,
4926 responseValue [11] OCTET STRING OPTIONAL }
4928 * responseName and responseValue must be absent.
4932 * - on success, *tagp is either LDAP_TAG_EXOP_QUERY_DELETE_BASE
4933 * or LDAP_TAG_EXOP_QUERY_DELETE_DN.
4934 * - if ndn != NULL, it is set to the normalized DN in the request
4935 * corresponding to either the baseDN or the entryDN, according
4936 * to *tagp; memory is malloc'ed on the Operation's slab, and must
4937 * be freed by the caller.
4938 * - if uuid != NULL, it is set to point to the normalized UUID;
4939 * memory is malloc'ed on the Operation's slab, and must
4940 * be freed by the caller.
4943 pcache_parse_query_delete(
4947 struct berval *uuid,
4951 int rc = LDAP_SUCCESS;
4954 BerElementBuffer berbuf;
4955 BerElement *ber = (BerElement *)&berbuf;
4956 struct berval reqdata = BER_BVNULL;
4968 if ( in == NULL || in->bv_len == 0 ) {
4969 *text = "empty request data field in queryDelete exop";
4970 return LDAP_PROTOCOL_ERROR;
4973 ber_dupbv_x( &reqdata, in, ctx );
4975 /* ber_init2 uses reqdata directly, doesn't allocate new buffers */
4976 ber_init2( ber, &reqdata, 0 );
4978 tag = ber_scanf( ber, "{" /*}*/ );
4980 if ( tag == LBER_ERROR ) {
4981 Debug( LDAP_DEBUG_TRACE,
4982 "pcache_parse_query_delete: decoding error.\n",
4984 goto decoding_error;
4987 tag = ber_peek_tag( ber, &len );
4988 if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_BASE
4989 || tag == LDAP_TAG_EXOP_QUERY_DELETE_DN )
4993 if ( ndn != NULL ) {
4996 tag = ber_scanf( ber, "m", &dn );
4997 if ( tag == LBER_ERROR ) {
4998 Debug( LDAP_DEBUG_TRACE,
4999 "pcache_parse_query_delete: DN parse failed.\n",
5001 goto decoding_error;
5004 rc = dnNormalize( 0, NULL, NULL, &dn, ndn, ctx );
5005 if ( rc != LDAP_SUCCESS ) {
5006 *text = "invalid DN in queryDelete exop request data";
5011 tag = ber_scanf( ber, "x" /* "m" */ );
5012 if ( tag == LBER_DEFAULT ) {
5013 goto decoding_error;
5017 tag = ber_peek_tag( ber, &len );
5020 if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_UUID ) {
5021 if ( uuid != NULL ) {
5023 char uuidbuf[ LDAP_LUTIL_UUIDSTR_BUFSIZE ];
5025 tag = ber_scanf( ber, "m", &bv );
5026 if ( tag == LBER_ERROR ) {
5027 Debug( LDAP_DEBUG_TRACE,
5028 "pcache_parse_query_delete: UUID parse failed.\n",
5030 goto decoding_error;
5033 if ( bv.bv_len != 16 ) {
5034 Debug( LDAP_DEBUG_TRACE,
5035 "pcache_parse_query_delete: invalid UUID length %lu.\n",
5036 (unsigned long)bv.bv_len, 0, 0 );
5037 goto decoding_error;
5040 rc = lutil_uuidstr_from_normalized(
5041 bv.bv_val, bv.bv_len,
5042 uuidbuf, sizeof( uuidbuf ) );
5044 goto decoding_error;
5046 ber_str2bv( uuidbuf, rc, 1, uuid );
5050 tag = ber_skip_tag( ber, &len );
5051 if ( tag == LBER_DEFAULT ) {
5052 goto decoding_error;
5056 Debug( LDAP_DEBUG_TRACE,
5057 "pcache_parse_query_delete: invalid UUID length %lu.\n",
5058 (unsigned long)len, 0, 0 );
5059 goto decoding_error;
5063 tag = ber_peek_tag( ber, &len );
5066 if ( tag != LBER_DEFAULT || len != 0 ) {
5068 Debug( LDAP_DEBUG_TRACE,
5069 "pcache_parse_query_delete: decoding error\n",
5071 rc = LDAP_PROTOCOL_ERROR;
5072 *text = "queryDelete data decoding error";
5075 if ( ndn && !BER_BVISNULL( ndn ) ) {
5076 slap_sl_free( ndn->bv_val, ctx );
5080 if ( uuid && !BER_BVISNULL( uuid ) ) {
5081 slap_sl_free( uuid->bv_val, ctx );
5086 if ( !BER_BVISNULL( &reqdata ) ) {
5087 ber_memfree_x( reqdata.bv_val, ctx );
5094 pcache_exop_query_delete(
5098 BackendDB *bd = op->o_bd;
5100 struct berval uuid = BER_BVNULL,
5102 char buf[ SLAP_TEXT_BUFLEN ];
5104 ber_tag_t tag = LBER_DEFAULT;
5106 if ( LogTest( LDAP_DEBUG_STATS ) ) {
5110 rs->sr_err = pcache_parse_query_delete( op->ore_reqdata,
5111 &tag, &op->o_req_ndn, uuidp,
5112 &rs->sr_text, op->o_tmpmemctx );
5113 if ( rs->sr_err != LDAP_SUCCESS ) {
5117 if ( LogTest( LDAP_DEBUG_STATS ) ) {
5118 assert( !BER_BVISNULL( &op->o_req_ndn ) );
5119 len = snprintf( buf, sizeof( buf ), " dn=\"%s\"", op->o_req_ndn.bv_val );
5121 if ( !BER_BVISNULL( &uuid ) && len < sizeof( buf ) ) {
5122 snprintf( &buf[ len ], sizeof( buf ) - len, " pcacheQueryId=\"%s\"", uuid.bv_val );
5125 Debug( LDAP_DEBUG_STATS, "%s QUERY DELETE%s\n",
5126 op->o_log_prefix, buf, 0 );
5128 op->o_req_dn = op->o_req_ndn;
5130 op->o_bd = select_backend( &op->o_req_ndn, 0 );
5131 if ( op->o_bd == NULL ) {
5132 send_ldap_error( op, rs, LDAP_NO_SUCH_OBJECT,
5133 "no global superior knowledge" );
5135 rs->sr_err = backend_check_restrictions( op, rs,
5136 (struct berval *)&pcache_exop_QUERY_DELETE );
5137 if ( rs->sr_err != LDAP_SUCCESS ) {
5141 if ( op->o_bd->be_extended == NULL ) {
5142 send_ldap_error( op, rs, LDAP_UNAVAILABLE_CRITICAL_EXTENSION,
5143 "backend does not support extended operations" );
5147 op->o_bd->be_extended( op, rs );
5150 if ( !BER_BVISNULL( &op->o_req_ndn ) ) {
5151 op->o_tmpfree( op->o_req_ndn.bv_val, op->o_tmpmemctx );
5152 BER_BVZERO( &op->o_req_ndn );
5153 BER_BVZERO( &op->o_req_dn );
5156 if ( !BER_BVISNULL( &uuid ) ) {
5157 op->o_tmpfree( uuid.bv_val, op->o_tmpmemctx );
5164 #endif /* PCACHE_EXOP_QUERY_DELETE */
5167 pcache_op_extended( Operation *op, SlapReply *rs )
5169 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
5170 cache_manager *cm = on->on_bi.bi_private;
5172 #ifdef PCACHE_CONTROL_PRIVDB
5173 if ( op->o_ctrlflag[ privDB_cid ] == SLAP_CONTROL_CRITICAL ) {
5174 return pcache_op_privdb( op, rs );
5176 #endif /* PCACHE_CONTROL_PRIVDB */
5178 #ifdef PCACHE_EXOP_QUERY_DELETE
5179 if ( bvmatch( &op->ore_reqoid, &pcache_exop_QUERY_DELETE ) ) {
5180 struct berval uuid = BER_BVNULL;
5181 ber_tag_t tag = LBER_DEFAULT;
5183 rs->sr_err = pcache_parse_query_delete( op->ore_reqdata,
5184 &tag, NULL, &uuid, &rs->sr_text, op->o_tmpmemctx );
5185 assert( rs->sr_err == LDAP_SUCCESS );
5187 if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_DN ) {
5188 /* remove all queries related to the selected entry */
5189 rs->sr_err = pcache_remove_entry_queries_from_cache( op,
5190 cm, &op->o_req_ndn, &uuid );
5192 } else if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_BASE ) {
5193 if ( !BER_BVISNULL( &uuid ) ) {
5194 /* remove the selected query */
5195 rs->sr_err = pcache_remove_query_from_cache( op,
5199 /* TODO: remove all queries */
5200 rs->sr_err = LDAP_UNWILLING_TO_PERFORM;
5201 rs->sr_text = "deletion of all queries not implemented";
5205 op->o_tmpfree( uuid.bv_val, op->o_tmpmemctx );
5208 #endif /* PCACHE_EXOP_QUERY_DELETE */
5210 /* We only care if we're configured for Bind caching */
5211 if ( bvmatch( &op->ore_reqoid, &pcache_exop_MODIFY_PASSWD ) &&
5213 /* See if the local entry exists and has a password.
5214 * It's too much work to find the matching query, so
5215 * we just see if there's a hashed password to update.
5217 Operation op2 = *op;
5223 op2.o_dn = op->o_bd->be_rootdn;
5224 op2.o_ndn = op->o_bd->be_rootndn;
5225 rc = be_entry_get_rw( &op2, &op->o_req_ndn, NULL,
5226 slap_schema.si_ad_userPassword, 0, &e );
5227 if ( rc == LDAP_SUCCESS && e ) {
5228 /* See if a recognized password is hashed here */
5229 Attribute *a = attr_find( e->e_attrs,
5230 slap_schema.si_ad_userPassword );
5231 if ( a && a->a_vals[0].bv_val[0] == '{' &&
5232 lutil_passwd_scheme( a->a_vals[0].bv_val )) {
5235 be_entry_release_r( &op2, e );
5239 rc = overlay_op_walk( op, rs, op_extended, on->on_info,
5241 if ( rc == LDAP_SUCCESS ) {
5242 req_pwdexop_s *qpw = &op->oq_pwdexop;
5244 /* We don't care if it succeeds or not */
5245 pc_setpw( &op2, &qpw->rs_new, cm );
5250 return SLAP_CB_CONTINUE;
5254 pcache_entry_release( Operation *op, Entry *e, int rw )
5256 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
5257 cache_manager *cm = on->on_bi.bi_private;
5258 BackendDB *db = op->o_bd;
5262 rc = be_entry_release_rw( op, e, rw );
5267 #ifdef PCACHE_MONITOR
5270 pcache_monitor_update(
5276 cache_manager *cm = (cache_manager *) priv;
5277 query_manager *qm = cm->qm;
5280 BerVarray vals = NULL;
5282 attr_delete( &e->e_attrs, ad_cachedQueryURL );
5283 if ( ( SLAP_OPATTRS( rs->sr_attr_flags ) || ad_inlist( ad_cachedQueryURL, rs->sr_attrs ) )
5284 && qm->templates != NULL )
5288 for ( tm = qm->templates; tm != NULL; tm = tm->qmnext ) {
5289 for ( qc = tm->query; qc; qc = qc->next ) {
5292 if ( query2url( op, qc, &bv, 1 ) == 0 ) {
5293 ber_bvarray_add_x( &vals, &bv, op->o_tmpmemctx );
5299 if ( vals != NULL ) {
5300 attr_merge_normalize( e, ad_cachedQueryURL, vals, NULL );
5301 ber_bvarray_free_x( vals, op->o_tmpmemctx );
5307 char buf[ SLAP_TEXT_BUFLEN ];
5310 /* number of cached queries */
5311 a = attr_find( e->e_attrs, ad_numQueries );
5312 assert( a != NULL );
5315 bv.bv_len = snprintf( buf, sizeof( buf ), "%lu", cm->num_cached_queries );
5317 if ( a->a_nvals != a->a_vals ) {
5318 ber_bvreplace( &a->a_nvals[ 0 ], &bv );
5320 ber_bvreplace( &a->a_vals[ 0 ], &bv );
5322 /* number of cached entries */
5323 a = attr_find( e->e_attrs, ad_numEntries );
5324 assert( a != NULL );
5327 bv.bv_len = snprintf( buf, sizeof( buf ), "%d", cm->cur_entries );
5329 if ( a->a_nvals != a->a_vals ) {
5330 ber_bvreplace( &a->a_nvals[ 0 ], &bv );
5332 ber_bvreplace( &a->a_vals[ 0 ], &bv );
5335 return SLAP_CB_CONTINUE;
5339 pcache_monitor_free(
5343 struct berval values[ 2 ];
5344 Modification mod = { 0 };
5347 char textbuf[ SLAP_TEXT_BUFLEN ];
5351 /* NOTE: if slap_shutdown != 0, priv might have already been freed */
5354 /* Remove objectClass */
5355 mod.sm_op = LDAP_MOD_DELETE;
5356 mod.sm_desc = slap_schema.si_ad_objectClass;
5357 mod.sm_values = values;
5359 values[ 0 ] = oc_olmPCache->soc_cname;
5360 BER_BVZERO( &values[ 1 ] );
5362 rc = modify_delete_values( e, &mod, 1, &text,
5363 textbuf, sizeof( textbuf ) );
5364 /* don't care too much about return code... */
5367 mod.sm_values = NULL;
5368 mod.sm_desc = ad_cachedQueryURL;
5370 rc = modify_delete_values( e, &mod, 1, &text,
5371 textbuf, sizeof( textbuf ) );
5372 /* don't care too much about return code... */
5375 mod.sm_values = NULL;
5376 mod.sm_desc = ad_numQueries;
5378 rc = modify_delete_values( e, &mod, 1, &text,
5379 textbuf, sizeof( textbuf ) );
5380 /* don't care too much about return code... */
5383 mod.sm_values = NULL;
5384 mod.sm_desc = ad_numEntries;
5386 rc = modify_delete_values( e, &mod, 1, &text,
5387 textbuf, sizeof( textbuf ) );
5388 /* don't care too much about return code... */
5390 return SLAP_CB_CONTINUE;
5394 * call from within pcache_initialize()
5397 pcache_monitor_initialize( void )
5399 static int pcache_monitor_initialized = 0;
5401 if ( backend_info( "monitor" ) == NULL ) {
5405 if ( pcache_monitor_initialized++ ) {
5413 pcache_monitor_db_init( BackendDB *be )
5415 if ( pcache_monitor_initialize() == LDAP_SUCCESS ) {
5416 SLAP_DBFLAGS( be ) |= SLAP_DBFLAG_MONITORING;
5423 pcache_monitor_db_open( BackendDB *be )
5425 slap_overinst *on = (slap_overinst *)be->bd_info;
5426 cache_manager *cm = on->on_bi.bi_private;
5427 Attribute *a, *next;
5428 monitor_callback_t *cb = NULL;
5431 monitor_extra_t *mbe;
5432 struct berval dummy = BER_BVC( "" );
5434 if ( !SLAP_DBMONITORING( be ) ) {
5438 mi = backend_info( "monitor" );
5439 if ( !mi || !mi->bi_extra ) {
5440 SLAP_DBFLAGS( be ) ^= SLAP_DBFLAG_MONITORING;
5445 /* don't bother if monitor is not configured */
5446 if ( !mbe->is_configured() ) {
5447 static int warning = 0;
5449 if ( warning++ == 0 ) {
5450 Debug( LDAP_DEBUG_ANY, "pcache_monitor_db_open: "
5451 "monitoring disabled; "
5452 "configure monitor database to enable\n",
5459 /* alloc as many as required (plus 1 for objectClass) */
5460 a = attrs_alloc( 1 + 2 );
5466 a->a_desc = slap_schema.si_ad_objectClass;
5467 attr_valadd( a, &oc_olmPCache->soc_cname, NULL, 1 );
5471 struct berval bv = BER_BVC( "0" );
5473 next->a_desc = ad_numQueries;
5474 attr_valadd( next, &bv, NULL, 1 );
5475 next = next->a_next;
5477 next->a_desc = ad_numEntries;
5478 attr_valadd( next, &bv, NULL, 1 );
5479 next = next->a_next;
5482 cb = ch_calloc( sizeof( monitor_callback_t ), 1 );
5483 cb->mc_update = pcache_monitor_update;
5484 cb->mc_free = pcache_monitor_free;
5485 cb->mc_private = (void *)cm;
5487 /* make sure the database is registered; then add monitor attributes */
5488 BER_BVZERO( &cm->monitor_ndn );
5489 rc = mbe->register_overlay( be, on, &cm->monitor_ndn );
5491 rc = mbe->register_entry_attrs( &cm->monitor_ndn, a, cb,
5492 &dummy, -1, &dummy);
5508 /* store for cleanup */
5509 cm->monitor_cb = (void *)cb;
5511 /* we don't need to keep track of the attributes, because
5512 * bdb_monitor_free() takes care of everything */
5521 pcache_monitor_db_close( BackendDB *be )
5523 slap_overinst *on = (slap_overinst *)be->bd_info;
5524 cache_manager *cm = on->on_bi.bi_private;
5526 if ( cm->monitor_cb != NULL ) {
5527 BackendInfo *mi = backend_info( "monitor" );
5528 monitor_extra_t *mbe;
5530 if ( mi && &mi->bi_extra ) {
5532 mbe->unregister_entry_callback( NULL,
5533 (monitor_callback_t *)cm->monitor_cb,
5542 pcache_monitor_db_destroy( BackendDB *be )
5547 #endif /* PCACHE_MONITOR */
5549 static slap_overinst pcache;
5551 static char *obsolete_names[] = {
5556 #if SLAPD_OVER_PROXYCACHE == SLAPD_MOD_DYNAMIC
5558 #endif /* SLAPD_OVER_PROXYCACHE == SLAPD_MOD_DYNAMIC */
5563 struct berval debugbv = BER_BVC("pcache");
5567 code = slap_loglevel_get( &debugbv, &pcache_debug );
5572 #ifdef PCACHE_CONTROL_PRIVDB
5573 code = register_supported_control( PCACHE_CONTROL_PRIVDB,
5574 SLAP_CTRL_BIND|SLAP_CTRL_ACCESS|SLAP_CTRL_HIDE, extops,
5575 parse_privdb_ctrl, &privDB_cid );
5576 if ( code != LDAP_SUCCESS ) {
5577 Debug( LDAP_DEBUG_ANY,
5578 "pcache_initialize: failed to register control %s (%d)\n",
5579 PCACHE_CONTROL_PRIVDB, code, 0 );
5582 #endif /* PCACHE_CONTROL_PRIVDB */
5584 #ifdef PCACHE_EXOP_QUERY_DELETE
5585 code = load_extop2( (struct berval *)&pcache_exop_QUERY_DELETE,
5586 SLAP_EXOP_WRITES|SLAP_EXOP_HIDE, pcache_exop_query_delete,
5588 if ( code != LDAP_SUCCESS ) {
5589 Debug( LDAP_DEBUG_ANY,
5590 "pcache_initialize: unable to register queryDelete exop: %d.\n",
5594 #endif /* PCACHE_EXOP_QUERY_DELETE */
5596 argv[ 0 ] = "back-bdb/back-hdb monitor";
5601 for ( i = 0; s_oid[ i ].name; i++ ) {
5603 argv[ 1 ] = s_oid[ i ].name;
5604 argv[ 2 ] = s_oid[ i ].oid;
5606 if ( parse_oidm( &c, 0, NULL ) != 0 ) {
5607 Debug( LDAP_DEBUG_ANY, "pcache_initialize: "
5608 "unable to add objectIdentifier \"%s=%s\"\n",
5609 s_oid[ i ].name, s_oid[ i ].oid, 0 );
5614 for ( i = 0; s_ad[i].desc != NULL; i++ ) {
5615 code = register_at( s_ad[i].desc, s_ad[i].adp, 0 );
5617 Debug( LDAP_DEBUG_ANY,
5618 "pcache_initialize: register_at #%d failed\n", i, 0, 0 );
5621 (*s_ad[i].adp)->ad_type->sat_flags |= SLAP_AT_HIDE;
5624 for ( i = 0; s_oc[i].desc != NULL; i++ ) {
5625 code = register_oc( s_oc[i].desc, s_oc[i].ocp, 0 );
5627 Debug( LDAP_DEBUG_ANY,
5628 "pcache_initialize: register_oc #%d failed\n", i, 0, 0 );
5631 (*s_oc[i].ocp)->soc_flags |= SLAP_OC_HIDE;
5634 pcache.on_bi.bi_type = "pcache";
5635 pcache.on_bi.bi_obsolete_names = obsolete_names;
5636 pcache.on_bi.bi_db_init = pcache_db_init;
5637 pcache.on_bi.bi_db_config = pcache_db_config;
5638 pcache.on_bi.bi_db_open = pcache_db_open;
5639 pcache.on_bi.bi_db_close = pcache_db_close;
5640 pcache.on_bi.bi_db_destroy = pcache_db_destroy;
5642 pcache.on_bi.bi_op_search = pcache_op_search;
5643 pcache.on_bi.bi_op_bind = pcache_op_bind;
5644 #ifdef PCACHE_CONTROL_PRIVDB
5645 pcache.on_bi.bi_op_compare = pcache_op_privdb;
5646 pcache.on_bi.bi_op_modrdn = pcache_op_privdb;
5647 pcache.on_bi.bi_op_modify = pcache_op_privdb;
5648 pcache.on_bi.bi_op_add = pcache_op_privdb;
5649 pcache.on_bi.bi_op_delete = pcache_op_privdb;
5650 #endif /* PCACHE_CONTROL_PRIVDB */
5651 pcache.on_bi.bi_extended = pcache_op_extended;
5653 pcache.on_bi.bi_entry_release_rw = pcache_entry_release;
5654 pcache.on_bi.bi_chk_controls = pcache_chk_controls;
5656 pcache.on_bi.bi_cf_ocs = pcocs;
5658 code = config_register_schema( pccfg, pcocs );
5659 if ( code ) return code;
5661 return overlay_register( &pcache );
5664 #if SLAPD_OVER_PROXYCACHE == SLAPD_MOD_DYNAMIC
5665 int init_module(int argc, char *argv[]) {
5666 return pcache_initialize();
5670 #endif /* defined(SLAPD_OVER_PROXYCACHE) */