2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 2003-2009 The OpenLDAP Foundation.
5 * Portions Copyright 2003 IBM Corporation.
6 * Portions Copyright 2003-2009 Symas Corporation.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted only as authorized by the OpenLDAP
13 * A copy of this license is available in the file LICENSE in the
14 * top-level directory of the distribution or, alternatively, at
15 * <http://www.OpenLDAP.org/license.html>.
18 * This work was initially developed by Apurva Kumar for inclusion
19 * in OpenLDAP Software and subsequently rewritten by Howard Chu.
24 #ifdef SLAPD_OVER_PROXYCACHE
28 #include <ac/string.h>
36 #include "../back-monitor/back-monitor.h"
42 * Control that allows to access the private DB
43 * instead of the public one
45 #define PCACHE_CONTROL_PRIVDB "1.3.6.1.4.1.4203.666.11.9.5.1"
48 * Extended Operation that allows to remove a query from the cache
50 #define PCACHE_EXOP_QUERY_DELETE "1.3.6.1.4.1.4203.666.11.9.6.1"
55 #define PCACHE_MONITOR
58 /* query cache structs */
61 typedef struct Query_s {
62 Filter* filter; /* Search Filter */
63 struct berval base; /* Search Base */
64 int scope; /* Search scope */
67 struct query_template_s;
69 typedef struct Qbase_s {
70 Avlnode *scopes[4]; /* threaded AVL trees of cached queries */
75 /* struct representing a cached query */
76 typedef struct cached_query_s {
81 struct berval q_uuid; /* query identifier */
83 struct query_template_s *qtemp; /* template of the query */
84 time_t expiry_time; /* time till the query is considered invalid */
85 time_t refresh_time; /* time till the query is refreshed */
86 time_t bindref_time; /* time till the bind is refreshed */
87 unsigned long answerable_cnt; /* how many times it was answerable */
88 int refcnt; /* references since last refresh */
89 ldap_pvt_thread_mutex_t answerable_cnt_mutex;
90 struct cached_query_s *next; /* next query in the template */
91 struct cached_query_s *prev; /* previous query in the template */
92 struct cached_query_s *lru_up; /* previous query in the LRU list */
93 struct cached_query_s *lru_down; /* next query in the LRU list */
94 ldap_pvt_thread_rdwr_t rwlock;
100 * ldap:///<base>??<scope>?<filter>?x-uuid=<uid>,x-template=<template>,x-attrset=<attrset>,x-expiry=<expiry>,x-refresh=<refresh>
102 * <base> ::= CachedQuery.qbase->base
103 * <scope> ::= CachedQuery.scope
104 * <filter> ::= filter2bv(CachedQuery.filter)
105 * <uuid> ::= CachedQuery.q_uuid
106 * <attrset> ::= CachedQuery.qtemp->attr_set_index
107 * <expiry> ::= CachedQuery.expiry_time
108 * <refresh> ::= CachedQuery.refresh_time
110 * quick hack: parse URI, call add_query() and then fix
111 * CachedQuery.expiry_time and CachedQuery.q_uuid
113 * NOTE: if the <attrset> changes, all stored URLs will be invalidated.
117 * Represents a set of projected attributes.
121 struct query_template_s *templates;
122 AttributeName* attrs; /* specifies the set */
124 #define PC_CONFIGURED (0x1)
125 #define PC_REFERENCED (0x2)
126 #define PC_GOT_OC (0x4)
127 int count; /* number of attributes */
130 /* struct representing a query template
131 * e.g. template string = &(cn=)(mail=)
133 typedef struct query_template_s {
134 struct query_template_s *qtnext;
135 struct query_template_s *qmnext;
138 CachedQuery* query; /* most recent query cached for the template */
139 CachedQuery* query_last; /* oldest query cached for the template */
140 ldap_pvt_thread_rdwr_t t_rwlock; /* Rd/wr lock for accessing queries in the template */
141 struct berval querystr; /* Filter string corresponding to the QT */
142 struct berval bindbase; /* base DN for Bind request */
143 struct berval bindfilterstr; /* Filter string for Bind request */
144 struct berval bindftemp; /* bind filter template */
146 AttributeDescription **bindfattrs; /* attrs to substitute in ftemp */
148 int bindnattrs; /* number of bindfattrs */
150 int attr_set_index; /* determines the projected attributes */
151 int no_of_queries; /* Total number of queries in the template */
152 time_t ttl; /* TTL for the queries of this template */
153 time_t negttl; /* TTL for negative results */
154 time_t limitttl; /* TTL for sizelimit exceeding results */
155 time_t ttr; /* time to refresh */
156 time_t bindttr; /* TTR for cached binds */
157 struct attr_set t_attrs; /* filter attrs + attr_set */
165 } pc_caching_reason_t;
167 static const char *pc_caching_reason_str[] = {
176 struct query_manager_s;
178 /* prototypes for functions for 1) query containment
179 * 2) query addition, 3) cache replacement
181 typedef CachedQuery *(QCfunc)(Operation *op, struct query_manager_s*,
182 Query*, QueryTemplate*);
183 typedef CachedQuery *(AddQueryfunc)(Operation *op, struct query_manager_s*,
184 Query*, QueryTemplate*, pc_caching_reason_t, int wlock);
185 typedef void (CRfunc)(struct query_manager_s*, struct berval*);
187 /* LDAP query cache */
188 typedef struct query_manager_s {
189 struct attr_set* attr_sets; /* possible sets of projected attributes */
190 QueryTemplate* templates; /* cacheable templates */
192 CachedQuery* lru_top; /* top and bottom of LRU list */
193 CachedQuery* lru_bottom;
195 ldap_pvt_thread_mutex_t lru_mutex; /* mutex for accessing LRU list */
197 /* Query cache methods */
198 QCfunc *qcfunc; /* Query containment*/
199 CRfunc *crfunc; /* cache replacement */
200 AddQueryfunc *addfunc; /* add query */
203 /* LDAP query cache manager */
204 typedef struct cache_manager_s {
205 BackendDB db; /* underlying database */
206 unsigned long num_cached_queries; /* total number of cached queries */
207 unsigned long max_queries; /* upper bound on # of cached queries */
208 int save_queries; /* save cached queries across restarts */
209 int check_cacheability; /* check whether a query is cacheable */
210 int numattrsets; /* number of attribute sets */
211 int cur_entries; /* current number of entries cached */
212 int max_entries; /* max number of entries cached */
213 int num_entries_limit; /* max # of entries in a cacheable query */
215 char response_cb; /* install the response callback
216 * at the tail of the callback list */
217 #define PCACHE_RESPONSE_CB_HEAD 0
218 #define PCACHE_RESPONSE_CB_TAIL 1
219 char defer_db_open; /* defer open for online add */
220 char cache_binds; /* cache binds or just passthru */
222 time_t cc_period; /* interval between successive consistency checks (sec) */
223 #define PCACHE_CC_PAUSED 1
224 #define PCACHE_CC_OFFLINE 2
228 ldap_pvt_thread_mutex_t cache_mutex;
230 query_manager* qm; /* query cache managed by the cache manager */
232 #ifdef PCACHE_MONITOR
234 struct berval monitor_ndn;
235 #endif /* PCACHE_MONITOR */
238 #ifdef PCACHE_MONITOR
239 static int pcache_monitor_db_init( BackendDB *be );
240 static int pcache_monitor_db_open( BackendDB *be );
241 static int pcache_monitor_db_close( BackendDB *be );
242 static int pcache_monitor_db_destroy( BackendDB *be );
243 #endif /* PCACHE_MONITOR */
245 static int pcache_debug;
247 #ifdef PCACHE_CONTROL_PRIVDB
248 static int privDB_cid;
249 #endif /* PCACHE_CONTROL_PRIVDB */
251 static AttributeDescription *ad_queryId, *ad_cachedQueryURL;
253 #ifdef PCACHE_MONITOR
254 static AttributeDescription *ad_numQueries, *ad_numEntries;
255 static ObjectClass *oc_olmPCache;
256 #endif /* PCACHE_MONITOR */
262 { "PCacheOID", "1.3.6.1.4.1.4203.666.11.9.1" },
263 { "PCacheAttributes", "PCacheOID:1" },
264 { "PCacheObjectClasses", "PCacheOID:2" },
271 AttributeDescription **adp;
273 { "( PCacheAttributes:1 "
274 "NAME 'pcacheQueryID' "
275 "DESC 'ID of query the entry belongs to, formatted as a UUID' "
276 "EQUALITY octetStringMatch "
277 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.40{64} "
278 "NO-USER-MODIFICATION "
279 "USAGE directoryOperation )",
281 { "( PCacheAttributes:2 "
282 "NAME 'pcacheQueryURL' "
283 "DESC 'URI describing a cached query' "
284 "EQUALITY caseExactMatch "
285 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.15 "
286 "NO-USER-MODIFICATION "
287 "USAGE directoryOperation )",
288 &ad_cachedQueryURL },
289 #ifdef PCACHE_MONITOR
290 { "( PCacheAttributes:3 "
291 "NAME 'pcacheNumQueries' "
292 "DESC 'Number of cached queries' "
293 "EQUALITY integerMatch "
294 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.27 "
295 "NO-USER-MODIFICATION "
296 "USAGE directoryOperation )",
298 { "( PCacheAttributes:4 "
299 "NAME 'pcacheNumEntries' "
300 "DESC 'Number of cached entries' "
301 "EQUALITY integerMatch "
302 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.27 "
303 "NO-USER-MODIFICATION "
304 "USAGE directoryOperation )",
306 #endif /* PCACHE_MONITOR */
315 #ifdef PCACHE_MONITOR
316 /* augments an existing object, so it must be AUXILIARY */
317 { "( PCacheObjectClasses:1 "
318 "NAME ( 'olmPCache' ) "
322 "$ pcacheNumQueries "
323 "$ pcacheNumEntries "
326 #endif /* PCACHE_MONITOR */
335 struct berval *fstr );
342 QueryTemplate *templ,
343 pc_caching_reason_t why,
350 struct berval *query_uuid );
353 * Turn a cached query into its URL representation
356 query2url( Operation *op, CachedQuery *q, struct berval *urlbv, int dolock )
358 struct berval bv_scope,
360 char attrset_buf[ LDAP_PVT_INTTYPE_CHARS( unsigned long ) ],
361 expiry_buf[ LDAP_PVT_INTTYPE_CHARS( unsigned long ) ],
362 refresh_buf[ LDAP_PVT_INTTYPE_CHARS( unsigned long ) ],
363 answerable_buf[ LDAP_PVT_INTTYPE_CHARS( unsigned long ) ],
365 ber_len_t attrset_len,
371 ldap_pvt_thread_rdwr_rlock( &q->rwlock );
374 ldap_pvt_scope2bv( q->scope, &bv_scope );
375 filter2bv_x( op, q->filter, &bv_filter );
376 attrset_len = sprintf( attrset_buf,
377 "%lu", (unsigned long)q->qtemp->attr_set_index );
378 expiry_len = sprintf( expiry_buf,
379 "%lu", (unsigned long)q->expiry_time );
380 answerable_len = snprintf( answerable_buf, sizeof( answerable_buf ),
381 "%lu", q->answerable_cnt );
382 if ( q->refresh_time )
383 refresh_len = sprintf( refresh_buf,
384 "%lu", (unsigned long)q->refresh_time );
388 urlbv->bv_len = STRLENOF( "ldap:///" )
389 + q->qbase->base.bv_len
394 + STRLENOF( "?x-uuid=" )
396 + STRLENOF( ",x-attrset=" )
398 + STRLENOF( ",x-expiry=" )
400 + STRLENOF( ",x-answerable=" )
403 urlbv->bv_len += STRLENOF( ",x-refresh=" )
406 ptr = urlbv->bv_val = ber_memalloc_x( urlbv->bv_len + 1, op->o_tmpmemctx );
407 ptr = lutil_strcopy( ptr, "ldap:///" );
408 ptr = lutil_strcopy( ptr, q->qbase->base.bv_val );
409 ptr = lutil_strcopy( ptr, "??" );
410 ptr = lutil_strcopy( ptr, bv_scope.bv_val );
411 ptr = lutil_strcopy( ptr, "?" );
412 ptr = lutil_strcopy( ptr, bv_filter.bv_val );
413 ptr = lutil_strcopy( ptr, "?x-uuid=" );
414 ptr = lutil_strcopy( ptr, q->q_uuid.bv_val );
415 ptr = lutil_strcopy( ptr, ",x-attrset=" );
416 ptr = lutil_strcopy( ptr, attrset_buf );
417 ptr = lutil_strcopy( ptr, ",x-expiry=" );
418 ptr = lutil_strcopy( ptr, expiry_buf );
419 ptr = lutil_strcopy( ptr, ",x-answerable=" );
420 ptr = lutil_strcopy( ptr, answerable_buf );
422 ptr = lutil_strcopy( ptr, ",x-refresh=" );
423 ptr = lutil_strcopy( ptr, refresh_buf );
426 ber_memfree_x( bv_filter.bv_val, op->o_tmpmemctx );
429 ldap_pvt_thread_rdwr_runlock( &q->rwlock );
435 /* Find and record the empty filter clauses */
438 ftemp_attrs( struct berval *ftemp, struct berval *template,
439 AttributeDescription ***ret, const char **text )
445 AttributeDescription *ad;
446 AttributeDescription **descs = NULL;
449 temp2 = ch_malloc( ftemp->bv_len );
456 while ( *p1 == '(' || *p1 == '&' || *p1 == '|' || *p1 == ')' )
459 p2 = strchr( p1, '=' );
463 AC_MEMCPY( t1, p1, i );
467 if ( p2[-1] == '<' || p2[-1] == '>' ) p2--;
471 i = slap_bv2ad( &bv, &ad, text );
476 if ( *p2 == '<' || *p2 == '>' ) p2++;
477 if ( p2[1] != ')' ) {
479 while ( *p2 != ')' ) p2++;
484 descs = (AttributeDescription **)ch_realloc(descs,
485 (attr_cnt + 2)*sizeof(AttributeDescription *));
487 descs[attr_cnt++] = ad;
492 descs[attr_cnt] = NULL;
494 template->bv_val = temp2;
495 template->bv_len = t1 - temp2;
500 template_attrs( char *template, struct attr_set *set, AttributeName **ret,
511 AttributeDescription *ad;
512 AttributeName *attrs;
518 attrs = ch_calloc( set->count + 1, sizeof(AttributeName) );
519 for ( i=0; i < set->count; i++ )
520 attrs[i] = set->attrs[i];
522 alluser = an_find( attrs, slap_bv_all_user_attrs );
523 allop = an_find( attrs, slap_bv_all_operational_attrs );
526 while ( *p1 == '(' || *p1 == '&' || *p1 == '|' || *p1 == ')' ) p1++;
527 p2 = strchr( p1, '=' );
530 if ( p2[-1] == '<' || p2[-1] == '>' ) p2--;
534 i = slap_bv2ad( &bv, &ad, text );
541 if ( ad == slap_schema.si_ad_objectClass )
544 if ( is_at_operational(ad->ad_type)) {
548 } else if ( alluser ) {
551 if ( !ad_inlist( ad, attrs )) {
552 attrs = (AttributeName *)ch_realloc(attrs,
553 (attr_cnt + 2)*sizeof(AttributeName));
555 attrs[attr_cnt].an_desc = ad;
556 attrs[attr_cnt].an_name = ad->ad_cname;
557 attrs[attr_cnt].an_oc = NULL;
558 attrs[attr_cnt].an_flags = 0;
559 BER_BVZERO( &attrs[attr_cnt+1].an_name );
567 *text = "couldn't parse template";
570 if ( !got_oc && !( set->flags & PC_GOT_OC )) {
571 attrs = (AttributeName *)ch_realloc(attrs,
572 (attr_cnt + 2)*sizeof(AttributeName));
574 ad = slap_schema.si_ad_objectClass;
575 attrs[attr_cnt].an_desc = ad;
576 attrs[attr_cnt].an_name = ad->ad_cname;
577 attrs[attr_cnt].an_oc = NULL;
578 attrs[attr_cnt].an_flags = 0;
579 BER_BVZERO( &attrs[attr_cnt+1].an_name );
587 * Turn an URL representing a formerly cached query into a cached query,
588 * and try to cache it
599 LDAPURLDesc *lud = NULL;
601 tempstr = BER_BVNULL,
606 unsigned long answerable_cnt;
609 #define GOT_UUID 0x1U
610 #define GOT_ATTRSET 0x2U
611 #define GOT_EXPIRY 0x4U
612 #define GOT_ANSWERABLE 0x8U
613 #define GOT_REFRESH 0x10U
614 #define GOT_ALL (GOT_UUID|GOT_ATTRSET|GOT_EXPIRY|GOT_ANSWERABLE)
617 rc = ldap_url_parse( url, &lud );
618 if ( rc != LDAP_URL_SUCCESS ) {
622 /* non-allowed fields */
623 if ( lud->lud_host != NULL ) {
628 if ( lud->lud_attrs != NULL ) {
634 if ( strcmp( lud->lud_scheme, "ldap" ) != 0 ) {
639 /* required fields */
640 if ( lud->lud_dn == NULL || lud->lud_dn[ 0 ] == '\0' ) {
645 switch ( lud->lud_scope ) {
646 case LDAP_SCOPE_BASE:
647 case LDAP_SCOPE_ONELEVEL:
648 case LDAP_SCOPE_SUBTREE:
649 case LDAP_SCOPE_SUBORDINATE:
657 if ( lud->lud_filter == NULL || lud->lud_filter[ 0 ] == '\0' ) {
662 if ( lud->lud_exts == NULL ) {
667 for ( i = 0; lud->lud_exts[ i ] != NULL; i++ ) {
668 if ( strncmp( lud->lud_exts[ i ], "x-uuid=", STRLENOF( "x-uuid=" ) ) == 0 ) {
669 struct berval tmpUUID;
670 Syntax *syn_UUID = slap_schema.si_ad_entryUUID->ad_type->sat_syntax;
672 if ( got & GOT_UUID ) {
677 ber_str2bv( &lud->lud_exts[ i ][ STRLENOF( "x-uuid=" ) ], 0, 0, &tmpUUID );
678 rc = syn_UUID->ssyn_pretty( syn_UUID, &tmpUUID, &uuid, NULL );
679 if ( rc != LDAP_SUCCESS ) {
684 } else if ( strncmp( lud->lud_exts[ i ], "x-attrset=", STRLENOF( "x-attrset=" ) ) == 0 ) {
685 if ( got & GOT_ATTRSET ) {
690 rc = lutil_atoi( &attrset, &lud->lud_exts[ i ][ STRLENOF( "x-attrset=" ) ] );
696 } else if ( strncmp( lud->lud_exts[ i ], "x-expiry=", STRLENOF( "x-expiry=" ) ) == 0 ) {
699 if ( got & GOT_EXPIRY ) {
704 rc = lutil_atoul( &l, &lud->lud_exts[ i ][ STRLENOF( "x-expiry=" ) ] );
708 expiry_time = (time_t)l;
711 } else if ( strncmp( lud->lud_exts[ i ], "x-answerable=", STRLENOF( "x-answerable=" ) ) == 0 ) {
712 if ( got & GOT_ANSWERABLE ) {
717 rc = lutil_atoul( &answerable_cnt, &lud->lud_exts[ i ][ STRLENOF( "x-answerable=" ) ] );
721 got |= GOT_ANSWERABLE;
723 } else if ( strncmp( lud->lud_exts[ i ], "x-refresh=", STRLENOF( "x-refresh=" ) ) == 0 ) {
726 if ( got & GOT_REFRESH ) {
731 rc = lutil_atoul( &l, &lud->lud_exts[ i ][ STRLENOF( "x-refresh=" ) ] );
735 refresh_time = (time_t)l;
744 if ( got != GOT_ALL ) {
749 if ( !(got & GOT_REFRESH ))
752 /* ignore expired queries */
753 if ( expiry_time <= slap_get_time()) {
755 SlapReply rs2 = { 0 };
757 memset( &op2.oq_search, 0, sizeof( op2.oq_search ) );
759 (void)remove_query_data( &op2, &rs2, &uuid );
764 ber_str2bv( lud->lud_dn, 0, 0, &base );
765 rc = dnNormalize( 0, NULL, NULL, &base, &query.base, NULL );
766 if ( rc != LDAP_SUCCESS ) {
769 query.scope = lud->lud_scope;
770 query.filter = str2filter( lud->lud_filter );
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 ch_free( new_cached_query );
1603 new_cached_query = find_filter( op, qbase->scopes[query->scope],
1604 query->filter, first );
1605 filter_free( query->filter );
1606 query->filter = NULL;
1608 Debug( pcache_debug, "TEMPLATE %p QUERIES++ %d\n",
1609 (void *) templ, templ->no_of_queries, 0 );
1611 Debug( pcache_debug, "Unlock AQ index = %p \n",
1612 (void *) templ, 0, 0 );
1613 ldap_pvt_thread_rdwr_wunlock(&templ->t_rwlock);
1615 /* Adding on top of LRU list */
1617 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
1618 add_query_on_top(qm, new_cached_query);
1619 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1621 return rc == 0 ? new_cached_query : NULL;
1625 remove_from_template (CachedQuery* qc, QueryTemplate* template)
1627 if (!qc->prev && !qc->next) {
1628 template->query_last = template->query = NULL;
1629 } else if (qc->prev == NULL) {
1630 qc->next->prev = NULL;
1631 template->query = qc->next;
1632 } else if (qc->next == NULL) {
1633 qc->prev->next = NULL;
1634 template->query_last = qc->prev;
1636 qc->next->prev = qc->prev;
1637 qc->prev->next = qc->next;
1639 tavl_delete( &qc->qbase->scopes[qc->scope], qc, pcache_query_cmp );
1640 qc->qbase->queries--;
1641 if ( qc->qbase->queries == 0 ) {
1642 avl_delete( &template->qbase, qc->qbase, pcache_dn_cmp );
1643 ch_free( qc->qbase );
1647 template->no_of_queries--;
1650 /* remove bottom query of LRU list from the query cache */
1652 * NOTE: slight change in functionality.
1654 * - if result->bv_val is NULL, the query at the bottom of the LRU
1656 * - otherwise, the query whose UUID is *result is removed
1657 * - if not found, result->bv_val is zeroed
1660 cache_replacement(query_manager* qm, struct berval *result)
1662 CachedQuery* bottom;
1663 QueryTemplate *temp;
1665 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
1666 if ( BER_BVISNULL( result ) ) {
1667 bottom = qm->lru_bottom;
1670 Debug ( pcache_debug,
1671 "Cache replacement invoked without "
1672 "any query in LRU list\n", 0, 0, 0 );
1673 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1678 for ( bottom = qm->lru_bottom;
1680 bottom = bottom->lru_up )
1682 if ( bvmatch( result, &bottom->q_uuid ) ) {
1688 Debug ( pcache_debug,
1689 "Could not find query with uuid=\"%s\""
1690 "in LRU list\n", result->bv_val, 0, 0 );
1691 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1692 BER_BVZERO( result );
1697 temp = bottom->qtemp;
1698 remove_query(qm, bottom);
1699 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1701 *result = bottom->q_uuid;
1702 BER_BVZERO( &bottom->q_uuid );
1704 Debug( pcache_debug, "Lock CR index = %p\n", (void *) temp, 0, 0 );
1705 ldap_pvt_thread_rdwr_wlock(&temp->t_rwlock);
1706 remove_from_template(bottom, temp);
1707 Debug( pcache_debug, "TEMPLATE %p QUERIES-- %d\n",
1708 (void *) temp, temp->no_of_queries, 0 );
1709 Debug( pcache_debug, "Unlock CR index = %p\n", (void *) temp, 0, 0 );
1710 ldap_pvt_thread_rdwr_wunlock(&temp->t_rwlock);
1715 struct query_info *next;
1727 struct query_info *qi;
1730 if ( rs->sr_type != REP_SEARCH ) return 0;
1732 attr = attr_find( rs->sr_entry->e_attrs, ad_queryId );
1733 if ( attr == NULL ) return 0;
1735 count = attr->a_numvals;
1736 assert( count > 0 );
1737 qi = op->o_tmpalloc( sizeof( struct query_info ), op->o_tmpmemctx );
1738 qi->next = op->o_callback->sc_private;
1739 op->o_callback->sc_private = qi;
1740 ber_dupbv_x( &qi->xdn, &rs->sr_entry->e_nname, op->o_tmpmemctx );
1741 qi->del = ( count == 1 );
1750 struct berval *query_uuid )
1752 struct query_info *qi, *qnext;
1753 char filter_str[ LDAP_LUTIL_UUIDSTR_BUFSIZE + STRLENOF( "(pcacheQueryID=)" ) ];
1754 AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
1755 Filter filter = {LDAP_FILTER_EQUALITY};
1756 SlapReply sreply = {REP_RESULT};
1757 slap_callback cb = { NULL, remove_func, NULL, NULL };
1760 sreply.sr_entry = NULL;
1761 sreply.sr_nentries = 0;
1762 op->ors_filterstr.bv_len = snprintf(filter_str, sizeof(filter_str),
1763 "(%s=%s)", ad_queryId->ad_cname.bv_val, query_uuid->bv_val);
1764 filter.f_ava = &ava;
1765 filter.f_av_desc = ad_queryId;
1766 filter.f_av_value = *query_uuid;
1768 op->o_tag = LDAP_REQ_SEARCH;
1769 op->o_protocol = LDAP_VERSION3;
1770 op->o_callback = &cb;
1771 op->o_time = slap_get_time();
1772 op->o_do_not_cache = 1;
1774 op->o_req_dn = op->o_bd->be_suffix[0];
1775 op->o_req_ndn = op->o_bd->be_nsuffix[0];
1776 op->ors_scope = LDAP_SCOPE_SUBTREE;
1777 op->ors_deref = LDAP_DEREF_NEVER;
1778 op->ors_slimit = SLAP_NO_LIMIT;
1779 op->ors_tlimit = SLAP_NO_LIMIT;
1780 op->ors_limit = NULL;
1781 op->ors_filter = &filter;
1782 op->ors_filterstr.bv_val = filter_str;
1783 op->ors_filterstr.bv_len = strlen(filter_str);
1784 op->ors_attrs = NULL;
1785 op->ors_attrsonly = 0;
1787 op->o_bd->be_search( op, &sreply );
1789 for ( qi=cb.sc_private; qi; qi=qnext ) {
1792 op->o_req_dn = qi->xdn;
1793 op->o_req_ndn = qi->xdn;
1796 Debug( pcache_debug, "DELETING ENTRY TEMPLATE=%s\n",
1797 query_uuid->bv_val, 0, 0 );
1799 op->o_tag = LDAP_REQ_DELETE;
1801 if (op->o_bd->be_delete(op, &sreply) == LDAP_SUCCESS) {
1807 struct berval vals[2];
1809 vals[0] = *query_uuid;
1810 vals[1].bv_val = NULL;
1812 mod.sml_op = LDAP_MOD_DELETE;
1814 mod.sml_desc = ad_queryId;
1815 mod.sml_type = ad_queryId->ad_cname;
1816 mod.sml_values = vals;
1817 mod.sml_nvalues = NULL;
1818 mod.sml_numvals = 1;
1819 mod.sml_next = NULL;
1820 Debug( pcache_debug,
1821 "REMOVING TEMP ATTR : TEMPLATE=%s\n",
1822 query_uuid->bv_val, 0, 0 );
1824 op->orm_modlist = &mod;
1826 op->o_bd->be_modify( op, &sreply );
1828 op->o_tmpfree( qi->xdn.bv_val, op->o_tmpmemctx );
1829 op->o_tmpfree( qi, op->o_tmpmemctx );
1836 AttributeName* attrs,
1845 struct berval *fstr )
1847 AttributeDescription *ad;
1850 switch ( f->f_choice ) {
1851 case LDAP_FILTER_EQUALITY:
1853 len = STRLENOF( "(=)" ) + ad->ad_cname.bv_len;
1854 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s=)", ad->ad_cname.bv_val );
1855 assert( ret == len );
1856 fstr->bv_len += len;
1859 case LDAP_FILTER_GE:
1861 len = STRLENOF( "(>=)" ) + ad->ad_cname.bv_len;
1862 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s>=)", ad->ad_cname.bv_val);
1863 assert( ret == len );
1864 fstr->bv_len += len;
1867 case LDAP_FILTER_LE:
1869 len = STRLENOF( "(<=)" ) + ad->ad_cname.bv_len;
1870 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s<=)", ad->ad_cname.bv_val);
1871 assert( ret == len );
1872 fstr->bv_len += len;
1875 case LDAP_FILTER_APPROX:
1877 len = STRLENOF( "(~=)" ) + ad->ad_cname.bv_len;
1878 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s~=)", ad->ad_cname.bv_val);
1879 assert( ret == len );
1880 fstr->bv_len += len;
1883 case LDAP_FILTER_SUBSTRINGS:
1885 len = STRLENOF( "(=)" ) + ad->ad_cname.bv_len;
1886 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s=)", ad->ad_cname.bv_val );
1887 assert( ret == len );
1888 fstr->bv_len += len;
1891 case LDAP_FILTER_PRESENT:
1893 len = STRLENOF( "(=*)" ) + ad->ad_cname.bv_len;
1894 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s=*)", ad->ad_cname.bv_val );
1895 assert( ret == len );
1896 fstr->bv_len += len;
1899 case LDAP_FILTER_AND:
1900 case LDAP_FILTER_OR:
1901 case LDAP_FILTER_NOT: {
1903 fstr->bv_val[fstr->bv_len++] = '(';
1904 switch ( f->f_choice ) {
1905 case LDAP_FILTER_AND:
1906 fstr->bv_val[fstr->bv_len] = '&';
1908 case LDAP_FILTER_OR:
1909 fstr->bv_val[fstr->bv_len] = '|';
1911 case LDAP_FILTER_NOT:
1912 fstr->bv_val[fstr->bv_len] = '!';
1917 for ( f = f->f_list; f != NULL; f = f->f_next ) {
1918 rc = filter2template( op, f, fstr );
1921 fstr->bv_val[fstr->bv_len++] = ')';
1922 fstr->bv_val[fstr->bv_len] = '\0';
1928 /* a filter should at least have room for "()",
1929 * an "=" and for a 1-char attr */
1930 strcpy( fstr->bv_val, "(?=)" );
1931 fstr->bv_len += STRLENOF("(?=)");
1938 #define BI_HASHED 0x01
1939 #define BI_DIDCB 0x02
1940 #define BI_LOOKUP 0x04
1944 typedef struct bindinfo {
1945 cache_manager *bi_cm;
1947 QueryTemplate *bi_templ;
1948 struct search_info *bi_si;
1950 slap_callback bi_cb;
1953 struct search_info {
1956 QueryTemplate *qtemp;
1957 AttributeName* save_attrs; /* original attributes, saved for response */
1958 int swap_saved_attrs;
1963 int slimit_exceeded;
1964 pc_caching_reason_t caching_reason;
1970 remove_query_and_data(
1974 struct berval *uuid )
1976 query_manager* qm = cm->qm;
1978 qm->crfunc( qm, uuid );
1979 if ( !BER_BVISNULL( uuid ) ) {
1982 Debug( pcache_debug,
1983 "Removing query UUID %s\n",
1984 uuid->bv_val, 0, 0 );
1985 return_val = remove_query_data( op, rs, uuid );
1986 Debug( pcache_debug,
1987 "QUERY REMOVED, SIZE=%d\n",
1989 ldap_pvt_thread_mutex_lock( &cm->cache_mutex );
1990 cm->cur_entries -= return_val;
1991 cm->num_cached_queries--;
1992 Debug( pcache_debug,
1993 "STORED QUERIES = %lu\n",
1994 cm->num_cached_queries, 0, 0 );
1995 ldap_pvt_thread_mutex_unlock( &cm->cache_mutex );
1996 Debug( pcache_debug,
1997 "QUERY REMOVED, CACHE ="
1999 cm->cur_entries, 0, 0 );
2004 * Callback used to fetch queryId values based on entryUUID;
2005 * used by pcache_remove_entries_from_cache()
2008 fetch_queryId_cb( Operation *op, SlapReply *rs )
2012 /* only care about searchEntry responses */
2013 if ( rs->sr_type != REP_SEARCH ) {
2017 /* allow only one response per entryUUID */
2018 if ( op->o_callback->sc_private != NULL ) {
2024 /* copy all queryId values into callback's private data */
2025 a = attr_find( rs->sr_entry->e_attrs, ad_queryId );
2027 BerVarray vals = NULL;
2029 ber_bvarray_dup_x( &vals, a->a_nvals, op->o_tmpmemctx );
2030 op->o_callback->sc_private = (void *)vals;
2034 /* clear entry if required */
2035 if ( rs->sr_flags & REP_ENTRY_MUSTBEFREED ) {
2036 entry_free( rs->sr_entry );
2037 rs->sr_entry = NULL;
2038 rs->sr_flags ^= REP_ENTRY_MUSTBEFREED;
2045 * Call that allows to remove a set of entries from the cache,
2046 * by forcing the removal of all the related queries.
2049 pcache_remove_entries_from_cache(
2052 BerVarray entryUUIDs )
2054 Connection conn = { 0 };
2055 OperationBuffer opbuf;
2057 slap_callback sc = { 0 };
2058 SlapReply rs = { REP_RESULT };
2060 char filtbuf[ LDAP_LUTIL_UUIDSTR_BUFSIZE + STRLENOF( "(entryUUID=)" ) ];
2061 AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
2062 AttributeName attrs[ 2 ] = {{{ 0 }}};
2066 void *thrctx = ldap_pvt_thread_pool_context();
2068 connection_fake_init( &conn, &opbuf, thrctx );
2076 memset( &op->oq_search, 0, sizeof( op->oq_search ) );
2077 op->ors_scope = LDAP_SCOPE_SUBTREE;
2078 op->ors_deref = LDAP_DEREF_NEVER;
2079 f.f_choice = LDAP_FILTER_EQUALITY;
2081 ava.aa_desc = slap_schema.si_ad_entryUUID;
2082 op->ors_filter = &f;
2084 op->ors_tlimit = SLAP_NO_LIMIT;
2085 op->ors_limit = NULL;
2086 attrs[ 0 ].an_desc = ad_queryId;
2087 attrs[ 0 ].an_name = ad_queryId->ad_cname;
2088 op->ors_attrs = attrs;
2089 op->ors_attrsonly = 0;
2091 op->o_req_dn = cm->db.be_suffix[ 0 ];
2092 op->o_req_ndn = cm->db.be_nsuffix[ 0 ];
2094 op->o_tag = LDAP_REQ_SEARCH;
2095 op->o_protocol = LDAP_VERSION3;
2096 op->o_managedsait = SLAP_CONTROL_CRITICAL;
2098 op->o_dn = op->o_bd->be_rootdn;
2099 op->o_ndn = op->o_bd->be_rootndn;
2100 sc.sc_response = fetch_queryId_cb;
2101 op->o_callback = ≻
2103 for ( s = 0; !BER_BVISNULL( &entryUUIDs[ s ] ); s++ ) {
2104 BerVarray vals = NULL;
2106 op->ors_filterstr.bv_len = snprintf( filtbuf, sizeof( filtbuf ),
2107 "(entryUUID=%s)", entryUUIDs[ s ].bv_val );
2108 op->ors_filterstr.bv_val = filtbuf;
2109 ava.aa_value = entryUUIDs[ s ];
2111 rc = op->o_bd->be_search( op, &rs );
2112 if ( rc != LDAP_SUCCESS ) {
2116 vals = (BerVarray)op->o_callback->sc_private;
2117 if ( vals != NULL ) {
2120 for ( i = 0; !BER_BVISNULL( &vals[ i ] ); i++ ) {
2121 struct berval val = vals[ i ];
2123 remove_query_and_data( op, &rs, cm, &val );
2125 if ( !BER_BVISNULL( &val ) && val.bv_val != vals[ i ].bv_val ) {
2126 ch_free( val.bv_val );
2130 ber_bvarray_free_x( vals, op->o_tmpmemctx );
2131 op->o_callback->sc_private = NULL;
2139 * Call that allows to remove a query from the cache.
2142 pcache_remove_query_from_cache(
2145 struct berval *queryid )
2147 Operation op2 = *op;
2148 SlapReply rs2 = { 0 };
2152 /* remove the selected query */
2153 remove_query_and_data( &op2, &rs2, cm, queryid );
2155 return LDAP_SUCCESS;
2159 * Call that allows to remove a set of queries related to an entry
2160 * from the cache; if queryid is not null, the entry must belong to
2161 * the query indicated by queryid.
2164 pcache_remove_entry_queries_from_cache(
2168 struct berval *queryid )
2170 Connection conn = { 0 };
2171 OperationBuffer opbuf;
2173 slap_callback sc = { 0 };
2174 SlapReply rs = { REP_RESULT };
2176 char filter_str[ LDAP_LUTIL_UUIDSTR_BUFSIZE + STRLENOF( "(pcacheQueryID=)" ) ];
2177 AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
2178 AttributeName attrs[ 2 ] = {{{ 0 }}};
2181 BerVarray vals = NULL;
2184 void *thrctx = ldap_pvt_thread_pool_context();
2186 connection_fake_init( &conn, &opbuf, thrctx );
2194 memset( &op->oq_search, 0, sizeof( op->oq_search ) );
2195 op->ors_scope = LDAP_SCOPE_BASE;
2196 op->ors_deref = LDAP_DEREF_NEVER;
2197 if ( queryid == NULL || BER_BVISNULL( queryid ) ) {
2198 BER_BVSTR( &op->ors_filterstr, "(objectClass=*)" );
2199 f.f_choice = LDAP_FILTER_PRESENT;
2200 f.f_desc = slap_schema.si_ad_objectClass;
2203 op->ors_filterstr.bv_len = snprintf( filter_str,
2204 sizeof( filter_str ), "(%s=%s)",
2205 ad_queryId->ad_cname.bv_val, queryid->bv_val );
2206 f.f_choice = LDAP_FILTER_EQUALITY;
2208 f.f_av_desc = ad_queryId;
2209 f.f_av_value = *queryid;
2211 op->ors_filter = &f;
2213 op->ors_tlimit = SLAP_NO_LIMIT;
2214 op->ors_limit = NULL;
2215 attrs[ 0 ].an_desc = ad_queryId;
2216 attrs[ 0 ].an_name = ad_queryId->ad_cname;
2217 op->ors_attrs = attrs;
2218 op->ors_attrsonly = 0;
2220 op->o_req_dn = *ndn;
2221 op->o_req_ndn = *ndn;
2223 op->o_tag = LDAP_REQ_SEARCH;
2224 op->o_protocol = LDAP_VERSION3;
2225 op->o_managedsait = SLAP_CONTROL_CRITICAL;
2227 op->o_dn = op->o_bd->be_rootdn;
2228 op->o_ndn = op->o_bd->be_rootndn;
2229 sc.sc_response = fetch_queryId_cb;
2230 op->o_callback = ≻
2232 rc = op->o_bd->be_search( op, &rs );
2233 if ( rc != LDAP_SUCCESS ) {
2237 vals = (BerVarray)op->o_callback->sc_private;
2238 if ( vals != NULL ) {
2241 for ( i = 0; !BER_BVISNULL( &vals[ i ] ); i++ ) {
2242 struct berval val = vals[ i ];
2244 remove_query_and_data( op, &rs, cm, &val );
2246 if ( !BER_BVISNULL( &val ) && val.bv_val != vals[ i ].bv_val ) {
2247 ch_free( val.bv_val );
2251 ber_bvarray_free_x( vals, op->o_tmpmemctx );
2254 return LDAP_SUCCESS;
2261 struct berval *query_uuid )
2263 struct search_info *si = op->o_callback->sc_private;
2264 slap_overinst *on = si->on;
2265 cache_manager *cm = on->on_bi.bi_private;
2268 struct berval crp_uuid;
2269 char uuidbuf[ LDAP_LUTIL_UUIDSTR_BUFSIZE ];
2271 Connection conn = {0};
2272 OperationBuffer opbuf;
2273 void *thrctx = ldap_pvt_thread_pool_context();
2275 query_uuid->bv_len = lutil_uuidstr(uuidbuf, sizeof(uuidbuf));
2276 ber_str2bv(uuidbuf, query_uuid->bv_len, 1, query_uuid);
2278 connection_fake_init2( &conn, &opbuf, thrctx, 0 );
2279 op_tmp = &opbuf.ob_op;
2280 op_tmp->o_bd = &cm->db;
2281 op_tmp->o_dn = cm->db.be_rootdn;
2282 op_tmp->o_ndn = cm->db.be_rootndn;
2284 Debug( pcache_debug, "UUID for query being added = %s\n",
2287 for ( e=si->head; e; e=si->head ) {
2288 si->head = e->e_private;
2289 e->e_private = NULL;
2290 while ( cm->cur_entries > (cm->max_entries) ) {
2291 BER_BVZERO( &crp_uuid );
2292 remove_query_and_data( op_tmp, rs, cm, &crp_uuid );
2295 return_val = merge_entry(op_tmp, e, 0, query_uuid);
2296 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
2297 cm->cur_entries += return_val;
2298 Debug( pcache_debug,
2299 "ENTRY ADDED/MERGED, CACHED ENTRIES=%d\n",
2300 cm->cur_entries, 0, 0 );
2302 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
2309 pcache_op_cleanup( Operation *op, SlapReply *rs ) {
2310 slap_callback *cb = op->o_callback;
2311 struct search_info *si = cb->sc_private;
2312 slap_overinst *on = si->on;
2313 cache_manager *cm = on->on_bi.bi_private;
2314 query_manager* qm = cm->qm;
2316 if ( rs->sr_type == REP_SEARCH ) {
2319 /* don't return more entries than requested by the client */
2320 if ( si->slimit > 0 && rs->sr_nentries >= si->slimit ) {
2321 si->slimit_exceeded = 1;
2324 /* If we haven't exceeded the limit for this query,
2325 * build a chain of answers to store. If we hit the
2326 * limit, empty the chain and ignore the rest.
2329 /* check if the entry contains undefined
2330 * attributes/objectClasses (ITS#5680) */
2331 if ( cm->check_cacheability && test_filter( op, rs->sr_entry, si->query.filter ) != LDAP_COMPARE_TRUE ) {
2332 Debug( pcache_debug, "%s: query not cacheable because of schema issues in DN \"%s\"\n",
2333 op->o_log_prefix, rs->sr_entry->e_name.bv_val, 0 );
2337 /* check for malformed entries: attrs with no values */
2339 Attribute *a = rs->sr_entry->e_attrs;
2340 for (; a; a=a->a_next) {
2341 if ( !a->a_numvals ) {
2342 Debug( pcache_debug, "%s: query not cacheable because of attrs without values in DN \"%s\" (%s)\n",
2343 op->o_log_prefix, rs->sr_entry->e_name.bv_val,
2344 a->a_desc->ad_cname.bv_val );
2350 if ( si->count < si->max ) {
2352 e = entry_dup( rs->sr_entry );
2353 if ( !si->head ) si->head = e;
2354 if ( si->tail ) si->tail->e_private = e;
2361 for (;si->head; si->head=e) {
2362 e = si->head->e_private;
2363 si->head->e_private = NULL;
2364 entry_free(si->head);
2372 if ( rs->sr_type == REP_RESULT ||
2373 op->o_abandon || rs->sr_err == SLAPD_ABANDON )
2375 if ( si->swap_saved_attrs ) {
2376 rs->sr_attrs = si->save_attrs;
2377 op->ors_attrs = si->save_attrs;
2379 if ( (op->o_abandon || rs->sr_err == SLAPD_ABANDON) &&
2380 si->caching_reason == PC_IGNORE )
2382 filter_free( si->query.filter );
2384 /* duplicate query, free it */
2386 for (;si->head; si->head=e) {
2387 e = si->head->e_private;
2388 si->head->e_private = NULL;
2389 entry_free(si->head);
2392 op->o_callback = op->o_callback->sc_next;
2393 op->o_tmpfree( cb, op->o_tmpmemctx );
2394 } else if ( si->caching_reason != PC_IGNORE ) {
2395 CachedQuery *qc = qm->addfunc(op, qm, &si->query,
2396 si->qtemp, si->caching_reason, 1 );
2399 switch ( si->caching_reason ) {
2401 cache_entries( op, rs, &qc->q_uuid );
2403 si->pbi->bi_cq = qc;
2407 qc->q_sizelimit = rs->sr_nentries;
2417 ldap_pvt_thread_rdwr_wunlock(&qc->rwlock);
2418 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
2419 cm->num_cached_queries++;
2420 Debug( pcache_debug, "STORED QUERIES = %lu\n",
2421 cm->num_cached_queries, 0, 0 );
2422 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
2424 /* If the consistency checker suspended itself,
2427 if ( cm->cc_paused == PCACHE_CC_PAUSED ) {
2428 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
2429 if ( cm->cc_paused == PCACHE_CC_PAUSED ) {
2431 ldap_pvt_runqueue_resched( &slapd_rq, cm->cc_arg, 0 );
2433 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
2436 } else if ( si->count ) {
2437 /* duplicate query, free it */
2439 for (;si->head; si->head=e) {
2440 e = si->head->e_private;
2441 si->head->e_private = NULL;
2442 entry_free(si->head);
2447 filter_free( si->query.filter );
2451 return SLAP_CB_CONTINUE;
2459 struct search_info *si = op->o_callback->sc_private;
2461 if ( si->swap_saved_attrs ) {
2462 rs->sr_attrs = si->save_attrs;
2463 op->ors_attrs = si->save_attrs;
2466 if ( rs->sr_type == REP_SEARCH ) {
2467 /* don't return more entries than requested by the client */
2468 if ( si->slimit_exceeded ) {
2472 } else if ( rs->sr_type == REP_RESULT ) {
2475 if ( rs->sr_err == LDAP_SUCCESS ) {
2476 si->caching_reason = PC_POSITIVE;
2478 } else if ( rs->sr_err == LDAP_SIZELIMIT_EXCEEDED
2479 && si->qtemp->limitttl )
2483 si->caching_reason = PC_SIZELIMIT;
2484 for (;si->head; si->head=e) {
2485 e = si->head->e_private;
2486 si->head->e_private = NULL;
2487 entry_free(si->head);
2491 } else if ( si->qtemp->negttl && !si->count && !si->over &&
2492 rs->sr_err == LDAP_SUCCESS )
2494 si->caching_reason = PC_NEGATIVE;
2498 if ( si->slimit_exceeded ) {
2499 rs->sr_err = LDAP_SIZELIMIT_EXCEEDED;
2503 return SLAP_CB_CONTINUE;
2506 /* NOTE: this is a quick workaround to let pcache minimally interact
2507 * with pagedResults. A more articulated solutions would be to
2508 * perform the remote query without control and cache all results,
2509 * performing the pagedResults search only within the client
2510 * and the proxy. This requires pcache to understand pagedResults. */
2512 pcache_chk_controls(
2516 const char *non = "";
2517 const char *stripped = "";
2519 switch( op->o_pagedresults ) {
2520 case SLAP_CONTROL_NONCRITICAL:
2522 stripped = "; stripped";
2525 case SLAP_CONTROL_CRITICAL:
2526 Debug( pcache_debug, "%s: "
2527 "%scritical pagedResults control "
2528 "disabled with proxy cache%s.\n",
2529 op->o_log_prefix, non, stripped );
2531 slap_remove_control( op, rs, slap_cids.sc_pagedResults, NULL );
2535 rs->sr_err = SLAP_CB_CONTINUE;
2543 pc_setpw( Operation *op, struct berval *pwd, cache_manager *cm )
2545 struct berval vals[2];
2548 const char *text = NULL;
2549 BER_BVZERO( &vals[0] );
2550 slap_passwd_hash( pwd, &vals[0], &text );
2551 if ( BER_BVISEMPTY( &vals[0] )) {
2552 Debug( pcache_debug, "pc_setpw: hash failed %s\n",
2558 BER_BVZERO( &vals[1] );
2562 SlapReply sr = { REP_RESULT };
2563 slap_callback cb = { 0, slap_null_cb, 0, 0 };
2566 mod.sml_op = LDAP_MOD_REPLACE;
2568 mod.sml_desc = slap_schema.si_ad_userPassword;
2569 mod.sml_type = mod.sml_desc->ad_cname;
2570 mod.sml_values = vals;
2571 mod.sml_nvalues = NULL;
2572 mod.sml_numvals = 1;
2573 mod.sml_next = NULL;
2575 op->o_tag = LDAP_REQ_MODIFY;
2576 op->orm_modlist = &mod;
2578 op->o_dn = op->o_bd->be_rootdn;
2579 op->o_ndn = op->o_bd->be_rootndn;
2580 op->o_callback = &cb;
2581 Debug( pcache_debug, "pc_setpw: CACHING BIND for %s\n",
2582 op->o_req_dn.bv_val, 0, 0 );
2583 rc = op->o_bd->be_modify( op, &sr );
2584 ch_free( vals[0].bv_val );
2589 typedef struct bindcacheinfo {
2595 pc_bind_save( Operation *op, SlapReply *rs )
2597 if ( rs->sr_err == LDAP_SUCCESS ) {
2598 bindcacheinfo *bci = op->o_callback->sc_private;
2599 slap_overinst *on = bci->on;
2600 cache_manager *cm = on->on_bi.bi_private;
2602 Operation op2 = *op;
2603 if ( pc_setpw( &op2, &op->orb_cred, cm ) == LDAP_SUCCESS )
2604 bci->qc->bindref_time = op->o_time + bci->qc->qtemp->bindttr;
2606 return SLAP_CB_CONTINUE;
2610 pc_bind_attrs( Operation *op, Entry *e, QueryTemplate *temp,
2611 struct berval *fbv )
2614 struct berval *vals, pres = BER_BVC("*");
2618 vals = op->o_tmpalloc( temp->bindnattrs * sizeof( struct berval ),
2621 for ( i=0; i<temp->bindnattrs; i++ ) {
2622 a = attr_find( e->e_attrs, temp->bindfattrs[i] );
2623 if ( a && a->a_vals ) {
2624 vals[i] = a->a_vals[0];
2625 len += a->a_vals[0].bv_len;
2630 fbv->bv_len = len + temp->bindftemp.bv_len;
2631 fbv->bv_val = op->o_tmpalloc( fbv->bv_len + 1, op->o_tmpmemctx );
2633 p1 = temp->bindftemp.bv_val;
2638 if ( p1[0] == '=' && p1[1] == ')' ) {
2639 AC_MEMCPY( p2, vals[i].bv_val, vals[i].bv_len );
2640 p2 += vals[i].bv_len;
2646 op->o_tmpfree( vals, op->o_tmpmemctx );
2648 /* FIXME: are we sure str2filter_x can't fail?
2649 * caller needs to check */
2651 Filter *f = str2filter_x( op, fbv->bv_val );
2652 assert( f != NULL );
2657 /* Check if the requested entry is from the cache and has a valid
2658 * ttr and password hash
2661 pc_bind_search( Operation *op, SlapReply *rs )
2663 if ( rs->sr_type == REP_SEARCH ) {
2664 bindinfo *pbi = op->o_callback->sc_private;
2666 /* We only care if this is an already cached result and we're
2667 * below the refresh time, or we're offline.
2670 if (( pbi->bi_cm->cc_paused & PCACHE_CC_OFFLINE ) ||
2671 op->o_time < pbi->bi_cq->bindref_time ) {
2674 /* See if a recognized password is hashed here */
2675 a = attr_find( rs->sr_entry->e_attrs,
2676 slap_schema.si_ad_userPassword );
2677 if ( a && a->a_vals[0].bv_val[0] == '{' &&
2678 lutil_passwd_scheme( a->a_vals[0].bv_val ))
2679 pbi->bi_flags |= BI_HASHED;
2681 Debug( pcache_debug, "pc_bind_search: cache is stale, "
2682 "reftime: %ld, current time: %ld\n",
2683 pbi->bi_cq->bindref_time, op->o_time, 0 );
2685 } else if ( pbi->bi_si ) {
2686 /* This search result is going into the cache */
2690 filter_free( pbi->bi_si->query.filter );
2691 f = pc_bind_attrs( op, rs->sr_entry, pbi->bi_templ, &fbv );
2692 op->o_tmpfree( fbv.bv_val, op->o_tmpmemctx );
2693 pbi->bi_si->query.filter = filter_dup( f, NULL );
2694 filter_free_x( op, f, 1 );
2700 /* We always want pc_bind_search to run after the search handlers */
2702 pc_bind_resp( Operation *op, SlapReply *rs )
2704 bindinfo *pbi = op->o_callback->sc_private;
2705 if ( !( pbi->bi_flags & BI_DIDCB )) {
2706 slap_callback *sc = op->o_callback;
2707 while ( sc && sc->sc_response != pcache_response )
2710 sc = op->o_callback;
2711 pbi->bi_cb.sc_next = sc->sc_next;
2712 sc->sc_next = &pbi->bi_cb;
2713 pbi->bi_flags |= BI_DIDCB;
2715 return SLAP_CB_CONTINUE;
2718 #ifdef PCACHE_CONTROL_PRIVDB
2724 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
2725 cache_manager *cm = on->on_bi.bi_private;
2726 slap_callback *save_cb;
2729 /* skip if control is unset */
2730 if ( op->o_ctrlflag[ privDB_cid ] != SLAP_CONTROL_CRITICAL ) {
2731 return SLAP_CB_CONTINUE;
2734 /* The cache DB isn't open yet */
2735 if ( cm->defer_db_open ) {
2736 send_ldap_error( op, rs, LDAP_UNAVAILABLE,
2737 "pcachePrivDB: cacheDB not available" );
2741 /* FIXME: might be a little bit exaggerated... */
2742 if ( !be_isroot( op ) ) {
2743 save_cb = op->o_callback;
2744 op->o_callback = NULL;
2745 send_ldap_error( op, rs, LDAP_UNWILLING_TO_PERFORM,
2746 "pcachePrivDB: operation not allowed" );
2747 op->o_callback = save_cb;
2752 /* map tag to operation */
2753 type = slap_req2op( op->o_tag );
2754 if ( type != SLAP_OP_LAST ) {
2758 /* execute, if possible */
2759 func = &cm->db.be_bind;
2760 if ( func[ type ] != NULL ) {
2761 Operation op2 = *op;
2765 rc = func[ type ]( &op2, rs );
2766 if ( type == SLAP_OP_BIND && rc == LDAP_SUCCESS ) {
2767 op->o_conn->c_authz_cookie = cm->db.be_private;
2774 /* otherwise fall back to error */
2775 save_cb = op->o_callback;
2776 op->o_callback = NULL;
2777 send_ldap_error( op, rs, LDAP_UNWILLING_TO_PERFORM,
2778 "operation not supported with pcachePrivDB control" );
2779 op->o_callback = save_cb;
2783 #endif /* PCACHE_CONTROL_PRIVDB */
2790 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
2791 cache_manager *cm = on->on_bi.bi_private;
2792 QueryTemplate *temp;
2794 slap_callback cb = { 0 }, *sc;
2800 #ifdef PCACHE_CONTROL_PRIVDB
2801 if ( op->o_ctrlflag[ privDB_cid ] == SLAP_CONTROL_CRITICAL )
2802 return pcache_op_privdb( op, rs );
2803 #endif /* PCACHE_CONTROL_PRIVDB */
2805 /* Skip if we're not configured for Binds, or cache DB isn't open yet */
2806 if ( !cm->cache_binds || cm->defer_db_open )
2807 return SLAP_CB_CONTINUE;
2809 /* First find a matching template with Bind info */
2810 for ( temp=cm->qm->templates; temp; temp=temp->qmnext ) {
2811 if ( temp->bindttr && dnIsSuffix( &op->o_req_ndn, &temp->bindbase ))
2814 /* Didn't find a suitable template, just passthru */
2816 return SLAP_CB_CONTINUE;
2818 /* See if the entry is already locally cached. If so, we can
2819 * populate the query filter to retrieve the cached query. We
2820 * need to check the bindrefresh time in the query.
2823 op2.o_dn = op->o_bd->be_rootdn;
2824 op2.o_ndn = op->o_bd->be_rootndn;
2829 rc = be_entry_get_rw( &op2, &op->o_req_ndn, NULL, NULL, 0, &e );
2830 if ( rc == LDAP_SUCCESS && e ) {
2831 bi.bi_flags |= BI_LOOKUP;
2832 op2.ors_filter = pc_bind_attrs( op, e, temp, &op2.ors_filterstr );
2833 be_entry_release_r( &op2, e );
2835 op2.ors_filter = temp->bindfilter;
2836 op2.ors_filterstr = temp->bindfilterstr;
2839 op2.o_bd = op->o_bd;
2840 op2.o_tag = LDAP_REQ_SEARCH;
2841 op2.ors_scope = LDAP_SCOPE_BASE;
2842 op2.ors_deref = LDAP_DEREF_NEVER;
2844 op2.ors_tlimit = SLAP_NO_LIMIT;
2845 op2.ors_limit = NULL;
2846 op2.ors_attrs = cm->qm->attr_sets[temp->attr_set_index].attrs;
2847 op2.ors_attrsonly = 0;
2849 /* We want to invoke search at the same level of the stack
2850 * as we're already at...
2857 bi.bi_cb.sc_response = pc_bind_search;
2858 bi.bi_cb.sc_cleanup = NULL;
2859 bi.bi_cb.sc_private = &bi;
2860 cb.sc_private = &bi;
2861 cb.sc_response = pc_bind_resp;
2862 op2.o_callback = &cb;
2863 overlay_op_walk( &op2, rs, op_search, on->on_info, on );
2865 /* OK, just bind locally */
2866 if ( bi.bi_flags & BI_HASHED ) {
2867 BackendDB *be = op->o_bd;
2870 Debug( pcache_debug, "pcache_op_bind: CACHED BIND for %s\n",
2871 op->o_req_dn.bv_val, 0, 0 );
2873 if ( op->o_bd->be_bind( op, rs ) == LDAP_SUCCESS ) {
2874 op->o_conn->c_authz_cookie = cm->db.be_private;
2880 /* We have a cached query to work with */
2882 sc = op->o_tmpalloc( sizeof(slap_callback) + sizeof(bindcacheinfo),
2884 sc->sc_response = pc_bind_save;
2885 sc->sc_cleanup = NULL;
2886 sc->sc_private = sc+1;
2887 bci = sc->sc_private;
2888 sc->sc_next = op->o_callback;
2889 op->o_callback = sc;
2893 return SLAP_CB_CONTINUE;
2901 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
2902 cache_manager *cm = on->on_bi.bi_private;
2903 query_manager* qm = cm->qm;
2908 QueryTemplate *qtemp = NULL;
2909 bindinfo *pbi = NULL;
2912 CachedQuery *answerable = NULL;
2915 struct berval tempstr;
2917 #ifdef PCACHE_CONTROL_PRIVDB
2918 if ( op->o_ctrlflag[ privDB_cid ] == SLAP_CONTROL_CRITICAL ) {
2919 return pcache_op_privdb( op, rs );
2921 #endif /* PCACHE_CONTROL_PRIVDB */
2923 /* The cache DB isn't open yet */
2924 if ( cm->defer_db_open ) {
2925 send_ldap_error( op, rs, LDAP_UNAVAILABLE,
2926 "pcachePrivDB: cacheDB not available" );
2930 /* pickup runtime ACL changes */
2931 cm->db.be_acl = op->o_bd->be_acl;
2934 /* See if we're processing a Bind request */
2935 slap_callback *cb = op->o_callback;
2937 for ( ; cb; cb=cb->sc_next ) {
2938 if ( cb->sc_response == pc_bind_resp ) {
2939 pbi = cb->sc_private;
2945 /* FIXME: cannot cache/answer requests with pagedResults control */
2947 query.filter = op->ors_filter;
2950 query.base = pbi->bi_templ->bindbase;
2951 query.scope = pbi->bi_templ->bindscope;
2952 attr_set = pbi->bi_templ->attr_set_index;
2954 qtemp = pbi->bi_templ;
2955 if ( pbi->bi_flags & BI_LOOKUP )
2956 answerable = qm->qcfunc(op, qm, &query, qtemp);
2959 tempstr.bv_val = op->o_tmpalloc( op->ors_filterstr.bv_len+1,
2962 if ( filter2template( op, op->ors_filter, &tempstr ))
2964 op->o_tmpfree( tempstr.bv_val, op->o_tmpmemctx );
2965 return SLAP_CB_CONTINUE;
2968 Debug( pcache_debug, "query template of incoming query = %s\n",
2969 tempstr.bv_val, 0, 0 );
2972 attr_set = get_attr_set(op->ors_attrs, qm, cm->numattrsets);
2974 query.base = op->o_req_ndn;
2975 query.scope = op->ors_scope;
2977 /* check for query containment */
2978 if (attr_set > -1) {
2979 QueryTemplate *qt = qm->attr_sets[attr_set].templates;
2980 for (; qt; qt = qt->qtnext ) {
2981 /* find if template i can potentially answer tempstr */
2982 if ( ber_bvstrcasecmp( &qt->querystr, &tempstr ) != 0 )
2986 Debug( pcache_debug, "Entering QC, querystr = %s\n",
2987 op->ors_filterstr.bv_val, 0, 0 );
2988 answerable = qm->qcfunc(op, qm, &query, qt);
2990 /* if != NULL, rlocks qtemp->t_rwlock */
2995 op->o_tmpfree( tempstr.bv_val, op->o_tmpmemctx );
2999 BackendDB *save_bd = op->o_bd;
3001 ldap_pvt_thread_mutex_lock( &answerable->answerable_cnt_mutex );
3002 answerable->answerable_cnt++;
3003 /* we only care about refcnts if we're refreshing */
3004 if ( answerable->refresh_time )
3005 answerable->refcnt++;
3006 Debug( pcache_debug, "QUERY ANSWERABLE (answered %lu times)\n",
3007 answerable->answerable_cnt, 0, 0 );
3008 ldap_pvt_thread_mutex_unlock( &answerable->answerable_cnt_mutex );
3010 ldap_pvt_thread_rdwr_rlock(&answerable->rwlock);
3011 if ( BER_BVISNULL( &answerable->q_uuid )) {
3012 /* No entries cached, just an empty result set */
3014 send_ldap_result( op, rs );
3016 /* Let Bind know we used a cached query */
3018 pbi->bi_cq = answerable;
3021 if ( cm->response_cb == PCACHE_RESPONSE_CB_TAIL ) {
3023 /* The cached entry was already processed by any
3024 * other overlays, so don't let it get processed again.
3026 * This loop removes over_back_response from the stack.
3028 if ( overlay_callback_after_backover( op, &cb, 0) == 0 ) {
3029 slap_callback **scp;
3030 for ( scp = &op->o_callback; *scp != NULL;
3031 scp = &(*scp)->sc_next ) {
3032 if ( (*scp)->sc_next == &cb )
3037 i = cm->db.bd_info->bi_op_search( op, rs );
3039 ldap_pvt_thread_rdwr_runlock(&answerable->rwlock);
3040 /* locked by qtemp->qcfunc (query_containment) */
3041 ldap_pvt_thread_rdwr_runlock(&qtemp->t_rwlock);
3046 Debug( pcache_debug, "QUERY NOT ANSWERABLE\n", 0, 0, 0 );
3048 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
3049 if (cm->num_cached_queries >= cm->max_queries) {
3052 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
3054 if (op->ors_attrsonly)
3059 struct search_info *si;
3061 Debug( pcache_debug, "QUERY CACHEABLE\n", 0, 0, 0 );
3062 query.filter = filter_dup(op->ors_filter, NULL);
3064 cb = op->o_tmpalloc( sizeof(*cb) + sizeof(*si), op->o_tmpmemctx );
3065 cb->sc_response = pcache_response;
3066 cb->sc_cleanup = pcache_op_cleanup;
3067 cb->sc_private = (cb+1);
3068 si = cb->sc_private;
3072 si->max = cm->num_entries_limit ;
3076 si->slimit_exceeded = 0;
3077 si->caching_reason = PC_IGNORE;
3078 if ( op->ors_slimit > 0 && op->ors_slimit < cm->num_entries_limit ) {
3079 si->slimit = op->ors_slimit;
3080 op->ors_slimit = cm->num_entries_limit;
3084 si->swap_saved_attrs = 1;
3085 si->save_attrs = op->ors_attrs;
3090 op->ors_attrs = qtemp->t_attrs.attrs;
3092 if ( cm->response_cb == PCACHE_RESPONSE_CB_HEAD ) {
3093 cb->sc_next = op->o_callback;
3094 op->o_callback = cb;
3097 slap_callback **pcb;
3099 /* need to move the callback at the end, in case other
3100 * overlays are present, so that the final entry is
3101 * actually cached */
3103 for ( pcb = &op->o_callback; *pcb; pcb = &(*pcb)->sc_next );
3108 Debug( pcache_debug, "QUERY NOT CACHEABLE\n",
3112 return SLAP_CB_CONTINUE;
3117 AttributeName* attrs,
3125 for ( ; attrs[count].an_name.bv_val; count++ );
3128 /* recognize a single "*" or a "1.1" */
3131 attrs = slap_anlist_all_user_attributes;
3133 } else if ( count == 1 && bvmatch( &attrs[0].an_name, slap_bv_no_attrs ) ) {
3138 for ( i = 0; i < num; i++ ) {
3142 if ( count > qm->attr_sets[i].count ) {
3147 if ( !qm->attr_sets[i].count ) {
3153 for ( a2 = attrs; a2->an_name.bv_val; a2++ ) {
3154 if ( !an_find( qm->attr_sets[i].attrs, &a2->an_name ) ) {
3172 /* Refresh a cached query:
3173 * 1: Replay the query on the remote DB and merge each entry into
3174 * the local DB. Remember the DNs of each remote entry.
3175 * 2: Search the local DB for all entries matching this queryID.
3176 * Delete any entry whose DN is not in the list from (1).
3178 typedef struct dnlist {
3179 struct dnlist *next;
3184 typedef struct refresh_info {
3192 static dnlist *dnl_alloc( Operation *op, struct berval *bvdn )
3194 dnlist *dn = op->o_tmpalloc( sizeof(dnlist) + bvdn->bv_len + 1,
3196 dn->dn.bv_len = bvdn->bv_len;
3197 dn->dn.bv_val = (char *)(dn+1);
3198 AC_MEMCPY( dn->dn.bv_val, bvdn->bv_val, dn->dn.bv_len );
3199 dn->dn.bv_val[dn->dn.bv_len] = '\0';
3204 refresh_merge( Operation *op, SlapReply *rs )
3206 if ( rs->sr_type == REP_SEARCH ) {
3207 refresh_info *ri = op->o_callback->sc_private;
3208 BackendDB *be = op->o_bd;
3214 ocb = op->o_callback;
3215 /* Find local entry, merge */
3216 op->o_bd = ri->ri_be;
3217 rc = be_entry_get_rw( op, &rs->sr_entry->e_nname, NULL, NULL, 0, &e );
3218 if ( rc != LDAP_SUCCESS || e == NULL ) {
3219 /* No local entry, just add it. FIXME: we are not checking
3220 * the cache entry limit here
3222 merge_entry( op, rs->sr_entry, 1, &ri->ri_q->q_uuid );
3224 /* Entry exists, update it */
3227 Modifications *modlist, *mods = NULL;
3228 const char* text = NULL;
3229 char textbuf[SLAP_TEXT_BUFLEN];
3230 size_t textlen = sizeof(textbuf);
3231 slap_callback cb = { NULL, slap_null_cb, NULL, NULL };
3235 /* Get a copy of only the attrs we requested */
3236 for ( a=e->e_attrs; a; a=a->a_next ) {
3237 if ( ad_inlist( a->a_desc, rs->sr_attrs )) {
3238 *b = attr_alloc( a->a_desc );
3240 /* The actual values still belong to e */
3241 (*b)->a_flags |= SLAP_ATTR_DONT_FREE_VALS |
3242 SLAP_ATTR_DONT_FREE_DATA;
3243 b = &((*b)->a_next);
3247 slap_entry2mods( rs->sr_entry, &modlist, &text, textbuf, textlen );
3248 syncrepl_diff_entry( op, ne.e_attrs, rs->sr_entry->e_attrs,
3249 &mods, &modlist, 0 );
3250 be_entry_release_r( op, e );
3251 attrs_free( ne.e_attrs );
3252 slap_mods_free( modlist, 1 );
3253 /* mods is NULL if there are no changes */
3255 struct berval dn = op->o_req_dn;
3256 struct berval ndn = op->o_req_ndn;
3257 op->o_tag = LDAP_REQ_MODIFY;
3258 op->orm_modlist = mods;
3259 op->o_req_dn = rs->sr_entry->e_name;
3260 op->o_req_ndn = rs->sr_entry->e_nname;
3261 op->o_callback = &cb;
3262 op->o_bd->be_modify( op, rs );
3263 slap_mods_free( mods, 1 );
3265 op->o_req_ndn = ndn;
3269 /* Add DN to list */
3270 dnl = dnl_alloc( op, &rs->sr_entry->e_nname );
3272 if ( ri->ri_tail ) {
3273 ri->ri_tail->next = dnl;
3278 op->o_callback = ocb;
3284 refresh_purge( Operation *op, SlapReply *rs )
3286 if ( rs->sr_type == REP_SEARCH ) {
3287 refresh_info *ri = op->o_callback->sc_private;
3291 /* Did the entry exist on the remote? */
3292 for ( dn=&ri->ri_dns; *dn; dn = &(*dn)->next ) {
3293 if ( dn_match( &(*dn)->dn, &rs->sr_entry->e_nname )) {
3294 dnlist *dnext = (*dn)->next;
3295 op->o_tmpfree( *dn, op->o_tmpmemctx );
3301 /* No, so put it on the list to delete */
3304 dnlist *dnl = dnl_alloc( op, &rs->sr_entry->e_nname );
3305 dnl->next = ri->ri_dels;
3307 a = attr_find( rs->sr_entry->e_attrs, ad_queryId );
3308 /* If ours is the only queryId, delete entry */
3309 dnl->delete = ( a->a_numvals == 1 );
3316 refresh_query( Operation *op, SlapReply *rs, CachedQuery *query,
3319 slap_callback cb = { 0 };
3320 refresh_info ri = { 0 };
3321 char filter_str[ LDAP_LUTIL_UUIDSTR_BUFSIZE + STRLENOF( "(pcacheQueryID=)" ) ];
3322 AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
3323 Filter filter = {LDAP_FILTER_EQUALITY};
3324 AttributeName attrs[ 2 ] = {{{ 0 }}};
3328 ldap_pvt_thread_mutex_lock( &query->answerable_cnt_mutex );
3330 ldap_pvt_thread_mutex_unlock( &query->answerable_cnt_mutex );
3332 cb.sc_response = refresh_merge;
3333 cb.sc_private = &ri;
3336 ri.ri_be = op->o_bd;
3339 op->o_tag = LDAP_REQ_SEARCH;
3340 op->o_protocol = LDAP_VERSION3;
3341 op->o_callback = &cb;
3342 op->o_do_not_cache = 1;
3344 op->o_req_dn = query->qbase->base;
3345 op->o_req_ndn = query->qbase->base;
3346 op->ors_scope = query->scope;
3347 op->ors_slimit = SLAP_NO_LIMIT;
3348 op->ors_tlimit = SLAP_NO_LIMIT;
3349 op->ors_limit = NULL;
3350 op->ors_filter = query->filter;
3351 filter2bv_x( op, query->filter, &op->ors_filterstr );
3352 op->ors_attrs = query->qtemp->t_attrs.attrs;
3353 op->ors_attrsonly = 0;
3355 op->o_bd = on->on_info->oi_origdb;
3356 rc = op->o_bd->be_search( op, rs );
3358 op->o_bd = ri.ri_be;
3362 /* Get the DNs of all entries matching this query */
3363 cb.sc_response = refresh_purge;
3365 op->o_bd = ri.ri_be;
3366 op->o_req_dn = op->o_bd->be_suffix[0];
3367 op->o_req_ndn = op->o_bd->be_nsuffix[0];
3368 op->ors_scope = LDAP_SCOPE_SUBTREE;
3369 op->ors_deref = LDAP_DEREF_NEVER;
3370 op->ors_filterstr.bv_len = snprintf(filter_str, sizeof(filter_str),
3371 "(%s=%s)", ad_queryId->ad_cname.bv_val, query->q_uuid.bv_val);
3372 filter.f_ava = &ava;
3373 filter.f_av_desc = ad_queryId;
3374 filter.f_av_value = query->q_uuid;
3375 attrs[ 0 ].an_desc = ad_queryId;
3376 attrs[ 0 ].an_name = ad_queryId->ad_cname;
3377 op->ors_attrs = attrs;
3378 op->ors_attrsonly = 0;
3379 rs->sr_entry = NULL;
3380 rs->sr_nentries = 0;
3381 rc = op->o_bd->be_search( op, rs );
3382 if ( rc ) goto leave;
3384 while (( dn = ri.ri_dels )) {
3385 op->o_req_dn = dn->dn;
3386 op->o_req_ndn = dn->dn;
3388 op->o_tag = LDAP_REQ_DELETE;
3389 op->o_bd->be_delete( op, rs );
3392 struct berval vals[2];
3394 vals[0] = query->q_uuid;
3395 BER_BVZERO( &vals[1] );
3396 mod.sml_op = LDAP_MOD_DELETE;
3398 mod.sml_desc = ad_queryId;
3399 mod.sml_type = ad_queryId->ad_cname;
3400 mod.sml_values = vals;
3401 mod.sml_nvalues = NULL;
3402 mod.sml_numvals = 1;
3403 mod.sml_next = NULL;
3405 op->o_tag = LDAP_REQ_MODIFY;
3406 op->orm_modlist = &mod;
3407 op->o_bd->be_modify( op, rs );
3409 ri.ri_dels = dn->next;
3410 op->o_tmpfree( dn, op->o_tmpmemctx );
3414 /* reset our local heap, we're done with it */
3415 slap_sl_mem_create(SLAP_SLAB_SIZE, SLAP_SLAB_STACK, op->o_threadctx, 1 );
3424 struct re_s *rtask = arg;
3425 slap_overinst *on = rtask->arg;
3426 cache_manager *cm = on->on_bi.bi_private;
3427 query_manager *qm = cm->qm;
3428 Connection conn = {0};
3429 OperationBuffer opbuf;
3432 SlapReply rs = {REP_RESULT};
3433 CachedQuery *query, *qprev;
3434 int return_val, pause = PCACHE_CC_PAUSED;
3435 QueryTemplate *templ;
3437 /* Don't expire anything when we're offline */
3438 if ( cm->cc_paused & PCACHE_CC_OFFLINE ) {
3439 pause = PCACHE_CC_OFFLINE;
3443 connection_fake_init( &conn, &opbuf, ctx );
3447 op->o_dn = cm->db.be_rootdn;
3448 op->o_ndn = cm->db.be_rootndn;
3452 for (templ = qm->templates; templ; templ=templ->qmnext) {
3454 if ( !templ->query_last ) continue;
3456 op->o_time = slap_get_time();
3457 if ( !templ->ttr ) {
3459 if ( templ->negttl && templ->negttl < ttl )
3460 ttl = templ->negttl;
3461 if ( templ->limitttl && templ->limitttl < ttl )
3462 ttl = templ->limitttl;
3463 /* The oldest timestamp that needs expiration checking */
3467 for ( query=templ->query_last; query; query=qprev ) {
3468 qprev = query->prev;
3469 if ( query->refresh_time && query->refresh_time < op->o_time ) {
3470 /* A refresh will extend the expiry if the query has been
3471 * referenced, but not if it's unreferenced. If the
3472 * expiration has been hit, then skip the refresh since
3473 * we're just going to discard the result anyway.
3475 if ( query->refcnt )
3476 query->expiry_time = op->o_time + templ->ttl;
3477 if ( query->expiry_time > op->o_time ) {
3478 refresh_query( op, &rs, query, on );
3483 if (query->expiry_time < op->o_time) {
3485 Debug( pcache_debug, "Lock CR index = %p\n",
3486 (void *) templ, 0, 0 );
3487 ldap_pvt_thread_rdwr_wlock(&templ->t_rwlock);
3488 if ( query == templ->query_last ) {
3490 remove_from_template(query, templ);
3491 Debug( pcache_debug, "TEMPLATE %p QUERIES-- %d\n",
3492 (void *) templ, templ->no_of_queries, 0 );
3493 Debug( pcache_debug, "Unlock CR index = %p\n",
3494 (void *) templ, 0, 0 );
3496 ldap_pvt_thread_rdwr_wunlock(&templ->t_rwlock);
3500 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
3501 remove_query(qm, query);
3502 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
3503 if ( BER_BVISNULL( &query->q_uuid ))
3506 return_val = remove_query_data(op, &rs, &query->q_uuid);
3507 Debug( pcache_debug, "STALE QUERY REMOVED, SIZE=%d\n",
3509 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
3510 cm->cur_entries -= return_val;
3511 cm->num_cached_queries--;
3512 Debug( pcache_debug, "STORED QUERIES = %lu\n",
3513 cm->num_cached_queries, 0, 0 );
3514 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
3515 Debug( pcache_debug,
3516 "STALE QUERY REMOVED, CACHE ="
3518 cm->cur_entries, 0, 0 );
3520 } else if ( !templ->ttr && query->expiry_time > ttl ) {
3521 /* We don't need to check for refreshes, and this
3522 * query's expiry is too new, and all subsequent queries
3523 * will be newer yet. So stop looking.
3525 * If we have refreshes, then we always have to walk the
3526 * entire query list.
3534 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
3535 if ( ldap_pvt_runqueue_isrunning( &slapd_rq, rtask )) {
3536 ldap_pvt_runqueue_stoptask( &slapd_rq, rtask );
3538 /* If there were no queries, defer processing for a while */
3539 if ( cm->cc_paused != pause )
3540 cm->cc_paused = pause;
3541 ldap_pvt_runqueue_resched( &slapd_rq, rtask, pause );
3543 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
3548 #define MAX_ATTR_SETS 500
3561 static ConfigDriver pc_cf_gen;
3562 static ConfigLDAPadd pc_ldadd;
3563 static ConfigCfAdd pc_cfadd;
3565 static ConfigTable pccfg[] = {
3566 { "pcache", "backend> <max_entries> <numattrsets> <entry limit> "
3568 6, 6, 0, ARG_MAGIC|ARG_NO_DELETE|PC_MAIN, pc_cf_gen,
3569 "( OLcfgOvAt:2.1 NAME ( 'olcPcache' 'olcProxyCache' ) "
3570 "DESC 'Proxy Cache basic parameters' "
3571 "SYNTAX OMsDirectoryString SINGLE-VALUE )", NULL, NULL },
3572 { "pcacheAttrset", "index> <attributes...",
3573 2, 0, 0, ARG_MAGIC|PC_ATTR, pc_cf_gen,
3574 "( OLcfgOvAt:2.2 NAME ( 'olcPcacheAttrset' 'olcProxyAttrset' ) "
3575 "DESC 'A set of attributes to cache' "
3576 "SYNTAX OMsDirectoryString )", NULL, NULL },
3577 { "pcacheTemplate", "filter> <attrset-index> <TTL> <negTTL> "
3579 4, 7, 0, ARG_MAGIC|PC_TEMP, pc_cf_gen,
3580 "( OLcfgOvAt:2.3 NAME ( 'olcPcacheTemplate' 'olcProxyCacheTemplate' ) "
3581 "DESC 'Filter template, attrset, cache TTL, "
3582 "optional negative TTL, optional sizelimit TTL, "
3584 "SYNTAX OMsDirectoryString )", NULL, NULL },
3585 { "pcachePosition", "head|tail(default)",
3586 2, 2, 0, ARG_MAGIC|PC_RESP, pc_cf_gen,
3587 "( OLcfgOvAt:2.4 NAME 'olcPcachePosition' "
3588 "DESC 'Response callback position in overlay stack' "
3589 "SYNTAX OMsDirectoryString )", NULL, NULL },
3590 { "pcacheMaxQueries", "queries",
3591 2, 2, 0, ARG_INT|ARG_MAGIC|PC_QUERIES, pc_cf_gen,
3592 "( OLcfgOvAt:2.5 NAME ( 'olcPcacheMaxQueries' 'olcProxyCacheQueries' ) "
3593 "DESC 'Maximum number of queries to cache' "
3594 "SYNTAX OMsInteger )", NULL, NULL },
3595 { "pcachePersist", "TRUE|FALSE",
3596 2, 2, 0, ARG_ON_OFF|ARG_OFFSET, (void *)offsetof(cache_manager, save_queries),
3597 "( OLcfgOvAt:2.6 NAME ( 'olcPcachePersist' 'olcProxySaveQueries' ) "
3598 "DESC 'Save cached queries for hot restart' "
3599 "SYNTAX OMsBoolean )", NULL, NULL },
3600 { "pcacheValidate", "TRUE|FALSE",
3601 2, 2, 0, ARG_ON_OFF|ARG_OFFSET, (void *)offsetof(cache_manager, check_cacheability),
3602 "( OLcfgOvAt:2.7 NAME ( 'olcPcacheValidate' 'olcProxyCheckCacheability' ) "
3603 "DESC 'Check whether the results of a query are cacheable, e.g. for schema issues' "
3604 "SYNTAX OMsBoolean )", NULL, NULL },
3605 { "pcacheOffline", "TRUE|FALSE",
3606 2, 2, 0, ARG_ON_OFF|ARG_MAGIC|PC_OFFLINE, pc_cf_gen,
3607 "( OLcfgOvAt:2.8 NAME 'olcPcacheOffline' "
3608 "DESC 'Set cache to offline mode and disable expiration' "
3609 "SYNTAX OMsBoolean )", NULL, NULL },
3610 { "pcacheBind", "filter> <attrset-index> <TTR> <scope> <base",
3611 6, 6, 0, ARG_MAGIC|PC_BIND, pc_cf_gen,
3612 "( OLcfgOvAt:2.9 NAME 'olcPcacheBind' "
3613 "DESC 'Parameters for caching Binds' "
3614 "SYNTAX OMsDirectoryString )", NULL, NULL },
3615 { "pcache-", "private database args",
3616 1, 0, STRLENOF("pcache-"), ARG_MAGIC|PC_PRIVATE_DB, pc_cf_gen,
3619 /* Legacy keywords */
3620 { "proxycache", "backend> <max_entries> <numattrsets> <entry limit> "
3622 6, 6, 0, ARG_MAGIC|ARG_NO_DELETE|PC_MAIN, pc_cf_gen,
3624 { "proxyattrset", "index> <attributes...",
3625 2, 0, 0, ARG_MAGIC|PC_ATTR, pc_cf_gen,
3627 { "proxytemplate", "filter> <attrset-index> <TTL> <negTTL",
3628 4, 7, 0, ARG_MAGIC|PC_TEMP, pc_cf_gen,
3630 { "response-callback", "head|tail(default)",
3631 2, 2, 0, ARG_MAGIC|PC_RESP, pc_cf_gen,
3633 { "proxyCacheQueries", "queries",
3634 2, 2, 0, ARG_INT|ARG_MAGIC|PC_QUERIES, pc_cf_gen,
3636 { "proxySaveQueries", "TRUE|FALSE",
3637 2, 2, 0, ARG_ON_OFF|ARG_OFFSET, (void *)offsetof(cache_manager, save_queries),
3639 { "proxyCheckCacheability", "TRUE|FALSE",
3640 2, 2, 0, ARG_ON_OFF|ARG_OFFSET, (void *)offsetof(cache_manager, check_cacheability),
3643 { NULL, NULL, 0, 0, 0, ARG_IGNORED }
3646 static ConfigOCs pcocs[] = {
3647 { "( OLcfgOvOc:2.1 "
3648 "NAME 'olcPcacheConfig' "
3649 "DESC 'ProxyCache configuration' "
3650 "SUP olcOverlayConfig "
3651 "MUST ( olcPcache $ olcPcacheAttrset $ olcPcacheTemplate ) "
3652 "MAY ( olcPcachePosition $ olcPcacheMaxQueries $ olcPcachePersist $ "
3653 "olcPcacheValidate $ olcPcacheOffline $ olcPcacheBind ) )",
3654 Cft_Overlay, pccfg, NULL, pc_cfadd },
3655 { "( OLcfgOvOc:2.2 "
3656 "NAME 'olcPcacheDatabase' "
3657 "DESC 'Cache database configuration' "
3658 "AUXILIARY )", Cft_Misc, olcDatabaseDummy, pc_ldadd },
3662 static int pcache_db_open2( slap_overinst *on, ConfigReply *cr );
3665 pc_ldadd_cleanup( ConfigArgs *c )
3667 slap_overinst *on = c->ca_private;
3668 return pcache_db_open2( on, &c->reply );
3672 pc_ldadd( CfEntryInfo *p, Entry *e, ConfigArgs *ca )
3677 if ( p->ce_type != Cft_Overlay || !p->ce_bi ||
3678 p->ce_bi->bi_cf_ocs != pcocs )
3679 return LDAP_CONSTRAINT_VIOLATION;
3681 on = (slap_overinst *)p->ce_bi;
3682 cm = on->on_bi.bi_private;
3684 /* Defer open if this is an LDAPadd */
3685 if ( CONFIG_ONLINE_ADD( ca ))
3686 ca->cleanup = pc_ldadd_cleanup;
3688 cm->defer_db_open = 0;
3689 ca->ca_private = on;
3690 return LDAP_SUCCESS;
3694 pc_cfadd( Operation *op, SlapReply *rs, Entry *p, ConfigArgs *ca )
3696 CfEntryInfo *pe = p->e_private;
3697 slap_overinst *on = (slap_overinst *)pe->ce_bi;
3698 cache_manager *cm = on->on_bi.bi_private;
3701 /* FIXME: should not hardcode "olcDatabase" here */
3702 bv.bv_len = snprintf( ca->cr_msg, sizeof( ca->cr_msg ),
3703 "olcDatabase=" SLAP_X_ORDERED_FMT "%s",
3704 0, cm->db.bd_info->bi_type );
3705 if ( bv.bv_len >= sizeof( ca->cr_msg ) ) {
3708 bv.bv_val = ca->cr_msg;
3710 cm->defer_db_open = 0;
3712 /* We can only create this entry if the database is table-driven
3714 if ( cm->db.bd_info->bi_cf_ocs )
3715 config_build_entry( op, rs, pe, ca, &bv, cm->db.bd_info->bi_cf_ocs,
3722 pc_cf_gen( ConfigArgs *c )
3724 slap_overinst *on = (slap_overinst *)c->bi;
3725 cache_manager* cm = on->on_bi.bi_private;
3726 query_manager* qm = cm->qm;
3727 QueryTemplate* temp;
3728 AttributeName* attr_name;
3729 AttributeName* attrarray;
3730 const char* text=NULL;
3735 if ( c->op == SLAP_CONFIG_EMIT ) {
3739 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ), "%s %d %d %d %ld",
3740 cm->db.bd_info->bi_type, cm->max_entries, cm->numattrsets,
3741 cm->num_entries_limit, cm->cc_period );
3742 bv.bv_val = c->cr_msg;
3743 value_add_one( &c->rvalue_vals, &bv );
3746 for (i=0; i<cm->numattrsets; i++) {
3747 if ( !qm->attr_sets[i].count ) continue;
3749 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ), "%d", i );
3751 /* count the attr length */
3752 for ( attr_name = qm->attr_sets[i].attrs;
3753 attr_name->an_name.bv_val; attr_name++ )
3754 bv.bv_len += attr_name->an_name.bv_len + 1;
3756 bv.bv_val = ch_malloc( bv.bv_len+1 );
3757 ptr = lutil_strcopy( bv.bv_val, c->cr_msg );
3758 for ( attr_name = qm->attr_sets[i].attrs;
3759 attr_name->an_name.bv_val; attr_name++ ) {
3761 ptr = lutil_strcopy( ptr, attr_name->an_name.bv_val );
3763 ber_bvarray_add( &c->rvalue_vals, &bv );
3765 if ( !c->rvalue_vals )
3769 for (temp=qm->templates; temp; temp=temp->qmnext) {
3770 /* HEADS-UP: always print all;
3771 * if optional == 0, ignore */
3772 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ),
3773 " %d %ld %ld %ld %ld",
3774 temp->attr_set_index,
3779 bv.bv_len += temp->querystr.bv_len + 2;
3780 bv.bv_val = ch_malloc( bv.bv_len+1 );
3783 ptr = lutil_strcopy( ptr, temp->querystr.bv_val );
3785 strcpy( ptr, c->cr_msg );
3786 ber_bvarray_add( &c->rvalue_vals, &bv );
3788 if ( !c->rvalue_vals )
3792 for (temp=qm->templates; temp; temp=temp->qmnext) {
3793 if ( !temp->bindttr ) continue;
3794 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ),
3796 temp->attr_set_index,
3798 ldap_pvt_scope2str( temp->bindscope ));
3799 bv.bv_len += temp->bindbase.bv_len + temp->bindftemp.bv_len + 4;
3800 bv.bv_val = ch_malloc( bv.bv_len + 1 );
3803 ptr = lutil_strcopy( ptr, temp->bindftemp.bv_val );
3805 ptr = lutil_strcopy( ptr, c->cr_msg );
3807 ptr = lutil_strcopy( ptr, temp->bindbase.bv_val );
3810 ber_bvarray_add( &c->rvalue_vals, &bv );
3812 if ( !c->rvalue_vals )
3816 if ( cm->response_cb == PCACHE_RESPONSE_CB_HEAD ) {
3817 BER_BVSTR( &bv, "head" );
3819 BER_BVSTR( &bv, "tail" );
3821 value_add_one( &c->rvalue_vals, &bv );
3824 c->value_int = cm->max_queries;
3827 c->value_int = (cm->cc_paused & PCACHE_CC_OFFLINE) != 0;
3831 } else if ( c->op == LDAP_MOD_DELETE ) {
3834 case PC_ATTR: /* FIXME */
3839 cm->cc_paused &= ~PCACHE_CC_OFFLINE;
3840 /* If there were cached queries when we went offline,
3841 * restart the checker now.
3843 if ( cm->num_cached_queries ) {
3844 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
3846 ldap_pvt_runqueue_resched( &slapd_rq, cm->cc_arg, 0 );
3847 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
3857 if ( cm->numattrsets > 0 ) {
3858 snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"pcache\" directive already provided" );
3859 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3863 if ( lutil_atoi( &cm->numattrsets, c->argv[3] ) != 0 ) {
3864 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse num attrsets=\"%s\" (arg #3)",
3866 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3869 if ( cm->numattrsets <= 0 ) {
3870 snprintf( c->cr_msg, sizeof( c->cr_msg ), "numattrsets (arg #3) must be positive" );
3871 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3874 if ( cm->numattrsets > MAX_ATTR_SETS ) {
3875 snprintf( c->cr_msg, sizeof( c->cr_msg ), "numattrsets (arg #3) must be <= %d", MAX_ATTR_SETS );
3876 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3880 if ( !backend_db_init( c->argv[1], &cm->db, -1, NULL )) {
3881 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unknown backend type (arg #1)" );
3882 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3886 if ( lutil_atoi( &cm->max_entries, c->argv[2] ) != 0 ) {
3887 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse max entries=\"%s\" (arg #2)",
3889 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3892 if ( cm->max_entries <= 0 ) {
3893 snprintf( c->cr_msg, sizeof( c->cr_msg ), "max entries (arg #2) must be positive.\n" );
3894 Debug( LDAP_DEBUG_CONFIG, "%s: %s\n", c->log, c->cr_msg, 0 );
3898 if ( lutil_atoi( &cm->num_entries_limit, c->argv[4] ) != 0 ) {
3899 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse entry limit=\"%s\" (arg #4)",
3901 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3904 if ( cm->num_entries_limit <= 0 ) {
3905 snprintf( c->cr_msg, sizeof( c->cr_msg ), "entry limit (arg #4) must be positive" );
3906 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3909 if ( cm->num_entries_limit > cm->max_entries ) {
3910 snprintf( c->cr_msg, sizeof( c->cr_msg ), "entry limit (arg #4) must be less than max entries %d (arg #2)", cm->max_entries );
3911 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3915 if ( lutil_parse_time( c->argv[5], &t ) != 0 ) {
3916 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse period=\"%s\" (arg #5)",
3918 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3922 cm->cc_period = (time_t)t;
3923 Debug( pcache_debug,
3924 "Total # of attribute sets to be cached = %d.\n",
3925 cm->numattrsets, 0, 0 );
3926 qm->attr_sets = ( struct attr_set * )ch_calloc( cm->numattrsets,
3927 sizeof( struct attr_set ) );
3930 if ( cm->numattrsets == 0 ) {
3931 snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"pcache\" directive not provided yet" );
3932 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3935 if ( lutil_atoi( &num, c->argv[1] ) != 0 ) {
3936 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse attrset #=\"%s\"",
3938 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3942 if ( num < 0 || num >= cm->numattrsets ) {
3943 snprintf( c->cr_msg, sizeof( c->cr_msg ), "attrset index %d out of bounds (must be %s%d)",
3944 num, cm->numattrsets > 1 ? "0->" : "", cm->numattrsets - 1 );
3945 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3948 qm->attr_sets[num].flags |= PC_CONFIGURED;
3949 if ( c->argc == 2 ) {
3951 snprintf( c->cr_msg, sizeof( c->cr_msg ),
3952 "need an explicit attr in attrlist; use \"*\" to indicate all attrs" );
3953 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3956 } else if ( c->argc == 3 ) {
3957 if ( strcmp( c->argv[2], LDAP_ALL_USER_ATTRIBUTES ) == 0 ) {
3958 qm->attr_sets[num].count = 1;
3959 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( 2,
3960 sizeof( AttributeName ) );
3961 BER_BVSTR( &qm->attr_sets[num].attrs[0].an_name, LDAP_ALL_USER_ATTRIBUTES );
3964 } else if ( strcmp( c->argv[2], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 ) {
3965 qm->attr_sets[num].count = 1;
3966 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( 2,
3967 sizeof( AttributeName ) );
3968 BER_BVSTR( &qm->attr_sets[num].attrs[0].an_name, LDAP_ALL_OPERATIONAL_ATTRIBUTES );
3971 } else if ( strcmp( c->argv[2], LDAP_NO_ATTRS ) == 0 ) {
3974 /* else: fallthru */
3976 } else if ( c->argc == 4 ) {
3977 if ( ( strcmp( c->argv[2], LDAP_ALL_USER_ATTRIBUTES ) == 0 && strcmp( c->argv[3], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 )
3978 || ( strcmp( c->argv[2], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 && strcmp( c->argv[3], LDAP_ALL_USER_ATTRIBUTES ) == 0 ) )
3980 qm->attr_sets[num].count = 2;
3981 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( 3,
3982 sizeof( AttributeName ) );
3983 BER_BVSTR( &qm->attr_sets[num].attrs[0].an_name, LDAP_ALL_USER_ATTRIBUTES );
3984 BER_BVSTR( &qm->attr_sets[num].attrs[1].an_name, LDAP_ALL_OPERATIONAL_ATTRIBUTES );
3987 /* else: fallthru */
3990 if ( c->argc > 2 ) {
3991 int all_user = 0, all_op = 0;
3993 qm->attr_sets[num].count = c->argc - 2;
3994 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( c->argc - 1,
3995 sizeof( AttributeName ) );
3996 attr_name = qm->attr_sets[num].attrs;
3997 for ( i = 2; i < c->argc; i++ ) {
3998 attr_name->an_desc = NULL;
3999 if ( strcmp( c->argv[i], LDAP_NO_ATTRS ) == 0 ) {
4000 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4001 "invalid attr #%d \"%s\" in attrlist",
4002 i - 2, c->argv[i] );
4003 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4004 ch_free( qm->attr_sets[num].attrs );
4005 qm->attr_sets[num].attrs = NULL;
4006 qm->attr_sets[num].count = 0;
4009 if ( strcmp( c->argv[i], LDAP_ALL_USER_ATTRIBUTES ) == 0 ) {
4011 BER_BVSTR( &attr_name->an_name, LDAP_ALL_USER_ATTRIBUTES );
4012 } else if ( strcmp( c->argv[i], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 ) {
4014 BER_BVSTR( &attr_name->an_name, LDAP_ALL_OPERATIONAL_ATTRIBUTES );
4016 if ( slap_str2ad( c->argv[i], &attr_name->an_desc, &text ) ) {
4017 strcpy( c->cr_msg, text );
4018 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4019 ch_free( qm->attr_sets[num].attrs );
4020 qm->attr_sets[num].attrs = NULL;
4021 qm->attr_sets[num].count = 0;
4024 attr_name->an_name = attr_name->an_desc->ad_cname;
4026 attr_name->an_oc = NULL;
4027 attr_name->an_flags = 0;
4028 if ( attr_name->an_desc == slap_schema.si_ad_objectClass )
4029 qm->attr_sets[num].flags |= PC_GOT_OC;
4031 BER_BVZERO( &attr_name->an_name );
4034 /* warn if list contains both "*" and "+" */
4035 if ( i > 4 && all_user && all_op ) {
4036 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4037 "warning: attribute list contains \"*\" and \"+\"" );
4038 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4043 if ( cm->numattrsets == 0 ) {
4044 snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"pcache\" directive not provided yet" );
4045 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4048 if ( lutil_atoi( &i, c->argv[2] ) != 0 ) {
4049 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse template #=\"%s\"",
4051 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4055 if ( i < 0 || i >= cm->numattrsets ||
4056 !(qm->attr_sets[i].flags & PC_CONFIGURED )) {
4057 snprintf( c->cr_msg, sizeof( c->cr_msg ), "template index %d invalid (%s%d)",
4058 i, cm->numattrsets > 1 ? "0->" : "", cm->numattrsets - 1 );
4059 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4063 AttributeName *attrs;
4065 cnt = template_attrs( c->argv[1], &qm->attr_sets[i], &attrs, &text );
4067 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse template: %s",
4069 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4072 temp = ch_calloc( 1, sizeof( QueryTemplate ));
4073 temp->qmnext = qm->templates;
4074 qm->templates = temp;
4075 temp->t_attrs.attrs = attrs;
4076 temp->t_attrs.count = cnt;
4078 ldap_pvt_thread_rdwr_init( &temp->t_rwlock );
4079 temp->query = temp->query_last = NULL;
4080 if ( lutil_parse_time( c->argv[3], &t ) != 0 ) {
4081 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4082 "unable to parse template ttl=\"%s\"",
4084 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4086 ch_free( temp->t_attrs.attrs );
4090 temp->ttl = (time_t)t;
4091 temp->negttl = (time_t)0;
4092 temp->limitttl = (time_t)0;
4093 temp->ttr = (time_t)0;
4094 switch ( c->argc ) {
4096 if ( lutil_parse_time( c->argv[6], &t ) != 0 ) {
4097 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4098 "unable to parse template ttr=\"%s\"",
4100 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4103 temp->ttr = (time_t)t;
4107 if ( lutil_parse_time( c->argv[5], &t ) != 0 ) {
4108 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4109 "unable to parse template sizelimit ttl=\"%s\"",
4111 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4114 temp->limitttl = (time_t)t;
4118 if ( lutil_parse_time( c->argv[4], &t ) != 0 ) {
4119 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4120 "unable to parse template negative ttl=\"%s\"",
4122 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4125 temp->negttl = (time_t)t;
4129 temp->no_of_queries = 0;
4131 ber_str2bv( c->argv[1], 0, 1, &temp->querystr );
4132 Debug( pcache_debug, "Template:\n", 0, 0, 0 );
4133 Debug( pcache_debug, " query template: %s\n",
4134 temp->querystr.bv_val, 0, 0 );
4135 temp->attr_set_index = i;
4136 qm->attr_sets[i].flags |= PC_REFERENCED;
4137 temp->qtnext = qm->attr_sets[i].templates;
4138 qm->attr_sets[i].templates = temp;
4139 Debug( pcache_debug, " attributes: \n", 0, 0, 0 );
4140 if ( ( attrarray = qm->attr_sets[i].attrs ) != NULL ) {
4141 for ( i=0; attrarray[i].an_name.bv_val; i++ )
4142 Debug( pcache_debug, "\t%s\n",
4143 attrarray[i].an_name.bv_val, 0, 0 );
4147 if ( !qm->templates ) {
4148 snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"pcacheTemplate\" directive not provided yet" );
4149 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4152 if ( lutil_atoi( &i, c->argv[2] ) != 0 ) {
4153 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse Bind index #=\"%s\"",
4155 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4159 if ( i < 0 || i >= cm->numattrsets ||
4160 !(qm->attr_sets[i].flags & PC_CONFIGURED )) {
4161 snprintf( c->cr_msg, sizeof( c->cr_msg ), "Bind index %d invalid (%s%d)",
4162 i, cm->numattrsets > 1 ? "0->" : "", cm->numattrsets - 1 );
4163 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4166 { struct berval bv, tempbv;
4167 AttributeDescription **descs;
4169 ber_str2bv( c->argv[1], 0, 0, &bv );
4170 ndescs = ftemp_attrs( &bv, &tempbv, &descs, &text );
4172 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse template: %s",
4174 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4177 for ( temp = qm->templates; temp; temp=temp->qmnext ) {
4178 if ( temp->attr_set_index == i && bvmatch( &tempbv,
4182 ch_free( tempbv.bv_val );
4185 snprintf( c->cr_msg, sizeof( c->cr_msg ), "Bind template %s %d invalid",
4187 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4190 ber_dupbv( &temp->bindftemp, &bv );
4191 temp->bindfattrs = descs;
4192 temp->bindnattrs = ndescs;
4194 if ( lutil_parse_time( c->argv[3], &t ) != 0 ) {
4195 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4196 "unable to parse bind ttr=\"%s\"",
4198 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4200 ch_free( temp->bindfattrs );
4201 temp->bindfattrs = NULL;
4202 ch_free( temp->bindftemp.bv_val );
4203 BER_BVZERO( &temp->bindftemp );
4206 num = ldap_pvt_str2scope( c->argv[4] );
4208 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4209 "unable to parse bind scope=\"%s\"",
4211 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4215 struct berval dn, ndn;
4216 ber_str2bv( c->argv[5], 0, 0, &dn );
4217 rc = dnNormalize( 0, NULL, NULL, &dn, &ndn, NULL );
4219 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4220 "invalid bind baseDN=\"%s\"",
4222 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4225 if ( temp->bindbase.bv_val )
4226 ch_free( temp->bindbase.bv_val );
4227 temp->bindbase = ndn;
4230 /* convert the template into dummy filter */
4232 char *eq = temp->bindftemp.bv_val, *e2;
4235 while ((eq = strchr(eq, '=' ))) {
4240 bv.bv_len = temp->bindftemp.bv_len + i;
4241 bv.bv_val = ch_malloc( bv.bv_len + 1 );
4242 for ( e2 = bv.bv_val, eq = temp->bindftemp.bv_val;
4253 f = str2filter( bv.bv_val );
4255 ch_free( bv.bv_val );
4256 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4257 "unable to parse bindfilter=\"%s\"", bv.bv_val );
4258 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4259 ch_free( temp->bindbase.bv_val );
4260 BER_BVZERO( &temp->bindbase );
4263 if ( temp->bindfilter )
4264 filter_free( temp->bindfilter );
4265 if ( temp->bindfilterstr.bv_val )
4266 ch_free( temp->bindfilterstr.bv_val );
4267 temp->bindfilterstr = bv;
4268 temp->bindfilter = f;
4270 temp->bindttr = (time_t)t;
4271 temp->bindscope = num;
4272 cm->cache_binds = 1;
4276 if ( strcasecmp( c->argv[1], "head" ) == 0 ) {
4277 cm->response_cb = PCACHE_RESPONSE_CB_HEAD;
4279 } else if ( strcasecmp( c->argv[1], "tail" ) == 0 ) {
4280 cm->response_cb = PCACHE_RESPONSE_CB_TAIL;
4283 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unknown specifier" );
4284 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4289 if ( c->value_int <= 0 ) {
4290 snprintf( c->cr_msg, sizeof( c->cr_msg ), "max queries must be positive" );
4291 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4294 cm->max_queries = c->value_int;
4298 cm->cc_paused |= PCACHE_CC_OFFLINE;
4300 cm->cc_paused &= ~PCACHE_CC_OFFLINE;
4303 if ( cm->db.be_private == NULL ) {
4304 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4305 "private database must be defined before setting database specific options" );
4306 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4310 if ( cm->db.bd_info->bi_cf_ocs ) {
4313 char *argv0 = c->argv[ 0 ];
4315 c->argv[ 0 ] = &argv0[ STRLENOF( "pcache-" ) ];
4317 ct = config_find_keyword( cm->db.bd_info->bi_cf_ocs->co_table, c );
4319 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4320 "private database does not recognize specific option '%s'",
4322 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4326 c->table = cm->db.bd_info->bi_cf_ocs->co_type;
4328 c->bi = c->be->bd_info;
4330 rc = config_add_vals( ct, c );
4334 c->table = c2.table;
4337 c->argv[ 0 ] = argv0;
4339 } else if ( cm->db.be_config != NULL ) {
4340 char *argv0 = c->argv[ 0 ];
4342 c->argv[ 0 ] = &argv0[ STRLENOF( "pcache-" ) ];
4343 rc = cm->db.be_config( &cm->db, c->fname, c->lineno, c->argc, c->argv );
4344 c->argv[ 0 ] = argv0;
4347 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4348 "no means to set private database specific options" );
4349 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4354 rc = SLAP_CONF_UNKNOWN;
4370 slap_overinst *on = (slap_overinst *)be->bd_info;
4371 cache_manager* cm = on->on_bi.bi_private;
4373 /* Something for the cache database? */
4374 if ( cm->db.bd_info && cm->db.bd_info->bi_db_config )
4375 return cm->db.bd_info->bi_db_config( &cm->db, fname, lineno,
4377 return SLAP_CONF_UNKNOWN;
4385 slap_overinst *on = (slap_overinst *)be->bd_info;
4389 cm = (cache_manager *)ch_malloc(sizeof(cache_manager));
4390 on->on_bi.bi_private = cm;
4392 qm = (query_manager*)ch_malloc(sizeof(query_manager));
4395 SLAP_DBFLAGS(&cm->db) |= SLAP_DBFLAG_NO_SCHEMA_CHECK;
4396 cm->db.be_private = NULL;
4397 cm->db.bd_self = &cm->db;
4399 cm->numattrsets = 0;
4400 cm->num_entries_limit = 5;
4401 cm->num_cached_queries = 0;
4402 cm->max_entries = 0;
4403 cm->cur_entries = 0;
4404 cm->max_queries = 10000;
4405 cm->save_queries = 0;
4406 cm->check_cacheability = 0;
4407 cm->response_cb = PCACHE_RESPONSE_CB_TAIL;
4408 cm->defer_db_open = 1;
4409 cm->cache_binds = 0;
4410 cm->cc_period = 1000;
4413 #ifdef PCACHE_MONITOR
4414 cm->monitor_cb = NULL;
4415 #endif /* PCACHE_MONITOR */
4417 qm->attr_sets = NULL;
4418 qm->templates = NULL;
4420 qm->lru_bottom = NULL;
4422 qm->qcfunc = query_containment;
4423 qm->crfunc = cache_replacement;
4424 qm->addfunc = add_query;
4425 ldap_pvt_thread_mutex_init(&qm->lru_mutex);
4427 ldap_pvt_thread_mutex_init(&cm->cache_mutex);
4429 #ifndef PCACHE_MONITOR
4431 #else /* PCACHE_MONITOR */
4432 return pcache_monitor_db_init( be );
4433 #endif /* PCACHE_MONITOR */
4437 pcache_cachedquery_open_cb( Operation *op, SlapReply *rs )
4439 assert( op->o_tag == LDAP_REQ_SEARCH );
4441 if ( rs->sr_type == REP_SEARCH ) {
4444 a = attr_find( rs->sr_entry->e_attrs, ad_cachedQueryURL );
4448 assert( a->a_nvals != NULL );
4450 valsp = op->o_callback->sc_private;
4451 assert( *valsp == NULL );
4453 ber_bvarray_dup_x( valsp, a->a_nvals, op->o_tmpmemctx );
4461 pcache_cachedquery_count_cb( Operation *op, SlapReply *rs )
4463 assert( op->o_tag == LDAP_REQ_SEARCH );
4465 if ( rs->sr_type == REP_SEARCH ) {
4466 int *countp = (int *)op->o_callback->sc_private;
4479 cache_manager *cm = on->on_bi.bi_private;
4480 query_manager* qm = cm->qm;
4483 rc = backend_startup_one( &cm->db, cr );
4485 cm->defer_db_open = 0;
4488 /* There is no runqueue in TOOL mode */
4489 if (( slapMode & SLAP_SERVER_MODE ) && rc == 0 ) {
4490 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
4491 ldap_pvt_runqueue_insert( &slapd_rq, cm->cc_period,
4492 consistency_check, on,
4493 "pcache_consistency", cm->db.be_suffix[0].bv_val );
4494 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
4496 /* Cached database must have the rootdn */
4497 if ( BER_BVISNULL( &cm->db.be_rootndn )
4498 || BER_BVISEMPTY( &cm->db.be_rootndn ) )
4500 Debug( LDAP_DEBUG_ANY, "pcache_db_open(): "
4501 "underlying database of type \"%s\"\n"
4502 " serving naming context \"%s\"\n"
4503 " has no \"rootdn\", required by \"pcache\".\n",
4504 on->on_info->oi_orig->bi_type,
4505 cm->db.be_suffix[0].bv_val, 0 );
4509 if ( cm->save_queries ) {
4510 void *thrctx = ldap_pvt_thread_pool_context();
4511 Connection conn = { 0 };
4512 OperationBuffer opbuf;
4514 slap_callback cb = { 0 };
4515 SlapReply rs = { 0 };
4516 BerVarray vals = NULL;
4517 Filter f = { 0 }, f2 = { 0 };
4518 AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
4519 AttributeName attrs[ 2 ] = {{{ 0 }}};
4521 connection_fake_init2( &conn, &opbuf, thrctx, 0 );
4526 op->o_tag = LDAP_REQ_SEARCH;
4527 op->o_protocol = LDAP_VERSION3;
4528 cb.sc_response = pcache_cachedquery_open_cb;
4529 cb.sc_private = &vals;
4530 op->o_callback = &cb;
4531 op->o_time = slap_get_time();
4532 op->o_do_not_cache = 1;
4533 op->o_managedsait = SLAP_CONTROL_CRITICAL;
4535 op->o_dn = cm->db.be_rootdn;
4536 op->o_ndn = cm->db.be_rootndn;
4537 op->o_req_dn = cm->db.be_suffix[ 0 ];
4538 op->o_req_ndn = cm->db.be_nsuffix[ 0 ];
4540 op->ors_scope = LDAP_SCOPE_BASE;
4541 op->ors_deref = LDAP_DEREF_NEVER;
4543 op->ors_tlimit = SLAP_NO_LIMIT;
4544 op->ors_limit = NULL;
4545 ber_str2bv( "(pcacheQueryURL=*)", 0, 0, &op->ors_filterstr );
4546 f.f_choice = LDAP_FILTER_PRESENT;
4547 f.f_desc = ad_cachedQueryURL;
4548 op->ors_filter = &f;
4549 attrs[ 0 ].an_desc = ad_cachedQueryURL;
4550 attrs[ 0 ].an_name = ad_cachedQueryURL->ad_cname;
4551 op->ors_attrs = attrs;
4552 op->ors_attrsonly = 0;
4554 rc = op->o_bd->be_search( op, &rs );
4555 if ( rc == LDAP_SUCCESS && vals != NULL ) {
4558 for ( i = 0; !BER_BVISNULL( &vals[ i ] ); i++ ) {
4559 if ( url2query( vals[ i ].bv_val, op, qm ) == 0 ) {
4560 cm->num_cached_queries++;
4564 ber_bvarray_free_x( vals, op->o_tmpmemctx );
4567 /* count cached entries */
4568 f.f_choice = LDAP_FILTER_NOT;
4570 f2.f_choice = LDAP_FILTER_EQUALITY;
4572 f2.f_av_desc = slap_schema.si_ad_objectClass;
4573 BER_BVSTR( &f2.f_av_value, "glue" );
4574 ber_str2bv( "(!(objectClass=glue))", 0, 0, &op->ors_filterstr );
4576 op->ors_slimit = SLAP_NO_LIMIT;
4577 op->ors_scope = LDAP_SCOPE_SUBTREE;
4578 op->ors_attrs = slap_anlist_no_attrs;
4580 op->o_callback->sc_response = pcache_cachedquery_count_cb;
4582 op->o_callback->sc_private = &rs.sr_nentries;
4584 rc = op->o_bd->be_search( op, &rs );
4586 cm->cur_entries = rs.sr_nentries;
4600 slap_overinst *on = (slap_overinst *)be->bd_info;
4601 cache_manager *cm = on->on_bi.bi_private;
4602 query_manager* qm = cm->qm;
4603 int i, ncf = 0, rf = 0, nrf = 0, rc = 0;
4605 /* check attr sets */
4606 for ( i = 0; i < cm->numattrsets; i++) {
4607 if ( !( qm->attr_sets[i].flags & PC_CONFIGURED ) ) {
4608 if ( qm->attr_sets[i].flags & PC_REFERENCED ) {
4609 Debug( LDAP_DEBUG_CONFIG, "pcache: attr set #%d not configured but referenced.\n", i, 0, 0 );
4613 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, attr set #%d not configured.\n", i, 0, 0 );
4617 } else if ( !( qm->attr_sets[i].flags & PC_REFERENCED ) ) {
4618 Debug( LDAP_DEBUG_CONFIG, "pcache: attr set #%d configured but not referenced.\n", i, 0, 0 );
4623 if ( ncf || rf || nrf ) {
4624 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, %d attr sets configured but not referenced.\n", nrf, 0, 0 );
4625 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, %d attr sets not configured.\n", ncf, 0, 0 );
4626 Debug( LDAP_DEBUG_CONFIG, "pcache: %d attr sets not configured but referenced.\n", rf, 0, 0 );
4633 /* need to inherit something from the original database... */
4634 cm->db.be_def_limit = be->be_def_limit;
4635 cm->db.be_limits = be->be_limits;
4636 cm->db.be_acl = be->be_acl;
4637 cm->db.be_dfltaccess = be->be_dfltaccess;
4639 if ( SLAP_DBMONITORING( be ) ) {
4640 SLAP_DBFLAGS( &cm->db ) |= SLAP_DBFLAG_MONITORING;
4643 SLAP_DBFLAGS( &cm->db ) &= ~SLAP_DBFLAG_MONITORING;
4646 if ( !cm->defer_db_open ) {
4647 rc = pcache_db_open2( on, cr );
4650 #ifdef PCACHE_MONITOR
4651 if ( rc == LDAP_SUCCESS ) {
4652 rc = pcache_monitor_db_open( be );
4654 #endif /* PCACHE_MONITOR */
4660 pcache_free_qbase( void *v )
4666 tavl_free( qb->scopes[i], NULL );
4676 slap_overinst *on = (slap_overinst *)be->bd_info;
4677 cache_manager *cm = on->on_bi.bi_private;
4678 query_manager *qm = cm->qm;
4682 /* stop the thread ... */
4684 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
4685 if ( ldap_pvt_runqueue_isrunning( &slapd_rq, cm->cc_arg ) ) {
4686 ldap_pvt_runqueue_stoptask( &slapd_rq, cm->cc_arg );
4688 ldap_pvt_runqueue_remove( &slapd_rq, cm->cc_arg );
4689 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
4692 if ( cm->save_queries ) {
4694 BerVarray vals = NULL;
4697 Connection conn = { 0 };
4698 OperationBuffer opbuf;
4700 slap_callback cb = { 0 };
4702 SlapReply rs = { REP_RESULT };
4703 Modifications mod = {{ 0 }};
4705 thrctx = ldap_pvt_thread_pool_context();
4707 connection_fake_init2( &conn, &opbuf, thrctx, 0 );
4710 if ( qm->templates != NULL ) {
4711 for ( tm = qm->templates; tm != NULL; tm = tm->qmnext ) {
4712 for ( qc = tm->query; qc; qc = qc->next ) {
4715 if ( query2url( op, qc, &bv, 0 ) == 0 ) {
4716 ber_bvarray_add_x( &vals, &bv, op->o_tmpmemctx );
4723 op->o_dn = cm->db.be_rootdn;
4724 op->o_ndn = cm->db.be_rootndn;
4726 op->o_tag = LDAP_REQ_MODIFY;
4727 op->o_protocol = LDAP_VERSION3;
4728 cb.sc_response = slap_null_cb;
4729 op->o_callback = &cb;
4730 op->o_time = slap_get_time();
4731 op->o_do_not_cache = 1;
4732 op->o_managedsait = SLAP_CONTROL_CRITICAL;
4734 op->o_req_dn = op->o_bd->be_suffix[0];
4735 op->o_req_ndn = op->o_bd->be_nsuffix[0];
4737 mod.sml_op = LDAP_MOD_REPLACE;
4739 mod.sml_desc = ad_cachedQueryURL;
4740 mod.sml_type = ad_cachedQueryURL->ad_cname;
4741 mod.sml_values = vals;
4742 mod.sml_nvalues = NULL;
4743 mod.sml_numvals = 1;
4744 mod.sml_next = NULL;
4745 Debug( pcache_debug,
4746 "%sSETTING CACHED QUERY URLS\n",
4747 vals == NULL ? "RE" : "", 0, 0 );
4749 op->orm_modlist = &mod;
4751 op->o_bd->be_modify( op, &rs );
4753 ber_bvarray_free_x( vals, op->o_tmpmemctx );
4756 /* cleanup stuff inherited from the original database... */
4757 cm->db.be_limits = NULL;
4758 cm->db.be_acl = NULL;
4761 if ( cm->db.bd_info->bi_db_close ) {
4762 rc = cm->db.bd_info->bi_db_close( &cm->db, NULL );
4764 while ( (tm = qm->templates) != NULL ) {
4765 CachedQuery *qc, *qn;
4766 qm->templates = tm->qmnext;
4767 for ( qc = tm->query; qc; qc = qn ) {
4771 avl_free( tm->qbase, pcache_free_qbase );
4772 free( tm->querystr.bv_val );
4773 free( tm->bindfattrs );
4774 free( tm->bindftemp.bv_val );
4775 free( tm->bindfilterstr.bv_val );
4776 free( tm->bindbase.bv_val );
4777 filter_free( tm->bindfilter );
4778 ldap_pvt_thread_rdwr_destroy( &tm->t_rwlock );
4779 free( tm->t_attrs.attrs );
4783 for ( i=0; i<cm->numattrsets; i++ ) {
4784 free( qm->attr_sets[i].attrs );
4786 free( qm->attr_sets );
4787 qm->attr_sets = NULL;
4789 #ifdef PCACHE_MONITOR
4790 if ( rc == LDAP_SUCCESS ) {
4791 rc = pcache_monitor_db_close( be );
4793 #endif /* PCACHE_MONITOR */
4804 slap_overinst *on = (slap_overinst *)be->bd_info;
4805 cache_manager *cm = on->on_bi.bi_private;
4806 query_manager *qm = cm->qm;
4808 if ( cm->db.be_private != NULL ) {
4809 backend_stopdown_one( &cm->db );
4812 ldap_pvt_thread_mutex_destroy( &qm->lru_mutex );
4813 ldap_pvt_thread_mutex_destroy( &cm->cache_mutex );
4817 #ifdef PCACHE_MONITOR
4818 pcache_monitor_db_destroy( be );
4819 #endif /* PCACHE_MONITOR */
4824 #ifdef PCACHE_CONTROL_PRIVDB
4826 Control ::= SEQUENCE {
4827 controlType LDAPOID,
4828 criticality BOOLEAN DEFAULT FALSE,
4829 controlValue OCTET STRING OPTIONAL }
4831 controlType ::= 1.3.6.1.4.1.4203.666.11.9.5.1
4833 * criticality must be TRUE; controlValue must be absent.
4841 if ( op->o_ctrlflag[ privDB_cid ] != SLAP_CONTROL_NONE ) {
4842 rs->sr_text = "privateDB control specified multiple times";
4843 return LDAP_PROTOCOL_ERROR;
4846 if ( !BER_BVISNULL( &ctrl->ldctl_value ) ) {
4847 rs->sr_text = "privateDB control value not absent";
4848 return LDAP_PROTOCOL_ERROR;
4851 if ( !ctrl->ldctl_iscritical ) {
4852 rs->sr_text = "privateDB control criticality required";
4853 return LDAP_PROTOCOL_ERROR;
4856 op->o_ctrlflag[ privDB_cid ] = SLAP_CONTROL_CRITICAL;
4858 return LDAP_SUCCESS;
4861 static char *extops[] = {
4862 LDAP_EXOP_MODIFY_PASSWD,
4865 #endif /* PCACHE_CONTROL_PRIVDB */
4867 static struct berval pcache_exop_MODIFY_PASSWD = BER_BVC( LDAP_EXOP_MODIFY_PASSWD );
4868 #ifdef PCACHE_EXOP_QUERY_DELETE
4869 static struct berval pcache_exop_QUERY_DELETE = BER_BVC( PCACHE_EXOP_QUERY_DELETE );
4871 #define LDAP_TAG_EXOP_QUERY_DELETE_BASE ((LBER_CLASS_CONTEXT|LBER_CONSTRUCTED) + 0)
4872 #define LDAP_TAG_EXOP_QUERY_DELETE_DN ((LBER_CLASS_CONTEXT|LBER_CONSTRUCTED) + 1)
4873 #define LDAP_TAG_EXOP_QUERY_DELETE_UUID ((LBER_CLASS_CONTEXT|LBER_CONSTRUCTED) + 2)
4876 ExtendedRequest ::= [APPLICATION 23] SEQUENCE {
4877 requestName [0] LDAPOID,
4878 requestValue [1] OCTET STRING OPTIONAL }
4880 requestName ::= 1.3.6.1.4.1.4203.666.11.9.6.1
4882 requestValue ::= SEQUENCE { CHOICE {
4884 entryDN [1] LDAPDN },
4885 queryID [2] OCTET STRING (SIZE(16))
4886 -- constrained to UUID }
4888 * Either baseDN or entryDN must be present, to allow database selection.
4890 * 1. if baseDN and queryID are present, then the query corresponding
4891 * to queryID is deleted;
4892 * 2. if baseDN is present and queryID is absent, then all queries
4894 * 3. if entryDN is present and queryID is absent, then all queries
4895 * corresponding to the queryID values present in entryDN are deleted;
4896 * 4. if entryDN and queryID are present, then all queries
4897 * corresponding to the queryID values present in entryDN are deleted,
4898 * but only if the value of queryID is contained in the entry;
4900 * Currently, only 1, 3 and 4 are implemented. 2 can be obtained by either
4901 * recursively deleting the database (ldapdelete -r) with PRIVDB control,
4902 * or by removing the database files.
4904 ExtendedResponse ::= [APPLICATION 24] SEQUENCE {
4905 COMPONENTS OF LDAPResult,
4906 responseName [10] LDAPOID OPTIONAL,
4907 responseValue [11] OCTET STRING OPTIONAL }
4909 * responseName and responseValue must be absent.
4913 * - on success, *tagp is either LDAP_TAG_EXOP_QUERY_DELETE_BASE
4914 * or LDAP_TAG_EXOP_QUERY_DELETE_DN.
4915 * - if ndn != NULL, it is set to the normalized DN in the request
4916 * corresponding to either the baseDN or the entryDN, according
4917 * to *tagp; memory is malloc'ed on the Operation's slab, and must
4918 * be freed by the caller.
4919 * - if uuid != NULL, it is set to point to the normalized UUID;
4920 * memory is malloc'ed on the Operation's slab, and must
4921 * be freed by the caller.
4924 pcache_parse_query_delete(
4928 struct berval *uuid,
4932 int rc = LDAP_SUCCESS;
4935 BerElementBuffer berbuf;
4936 BerElement *ber = (BerElement *)&berbuf;
4937 struct berval reqdata = BER_BVNULL;
4949 if ( in == NULL || in->bv_len == 0 ) {
4950 *text = "empty request data field in queryDelete exop";
4951 return LDAP_PROTOCOL_ERROR;
4954 ber_dupbv_x( &reqdata, in, ctx );
4956 /* ber_init2 uses reqdata directly, doesn't allocate new buffers */
4957 ber_init2( ber, &reqdata, 0 );
4959 tag = ber_scanf( ber, "{" /*}*/ );
4961 if ( tag == LBER_ERROR ) {
4962 Debug( LDAP_DEBUG_TRACE,
4963 "pcache_parse_query_delete: decoding error.\n",
4965 goto decoding_error;
4968 tag = ber_peek_tag( ber, &len );
4969 if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_BASE
4970 || tag == LDAP_TAG_EXOP_QUERY_DELETE_DN )
4974 if ( ndn != NULL ) {
4977 tag = ber_scanf( ber, "m", &dn );
4978 if ( tag == LBER_ERROR ) {
4979 Debug( LDAP_DEBUG_TRACE,
4980 "pcache_parse_query_delete: DN parse failed.\n",
4982 goto decoding_error;
4985 rc = dnNormalize( 0, NULL, NULL, &dn, ndn, ctx );
4986 if ( rc != LDAP_SUCCESS ) {
4987 *text = "invalid DN in queryDelete exop request data";
4992 tag = ber_scanf( ber, "x" /* "m" */ );
4993 if ( tag == LBER_DEFAULT ) {
4994 goto decoding_error;
4998 tag = ber_peek_tag( ber, &len );
5001 if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_UUID ) {
5002 if ( uuid != NULL ) {
5004 char uuidbuf[ LDAP_LUTIL_UUIDSTR_BUFSIZE ];
5006 tag = ber_scanf( ber, "m", &bv );
5007 if ( tag == LBER_ERROR ) {
5008 Debug( LDAP_DEBUG_TRACE,
5009 "pcache_parse_query_delete: UUID parse failed.\n",
5011 goto decoding_error;
5014 if ( bv.bv_len != 16 ) {
5015 Debug( LDAP_DEBUG_TRACE,
5016 "pcache_parse_query_delete: invalid UUID length %lu.\n",
5017 (unsigned long)bv.bv_len, 0, 0 );
5018 goto decoding_error;
5021 rc = lutil_uuidstr_from_normalized(
5022 bv.bv_val, bv.bv_len,
5023 uuidbuf, sizeof( uuidbuf ) );
5025 goto decoding_error;
5027 ber_str2bv( uuidbuf, rc, 1, uuid );
5031 tag = ber_skip_tag( ber, &len );
5032 if ( tag == LBER_DEFAULT ) {
5033 goto decoding_error;
5037 Debug( LDAP_DEBUG_TRACE,
5038 "pcache_parse_query_delete: invalid UUID length %lu.\n",
5039 (unsigned long)len, 0, 0 );
5040 goto decoding_error;
5044 tag = ber_peek_tag( ber, &len );
5047 if ( tag != LBER_DEFAULT || len != 0 ) {
5049 Debug( LDAP_DEBUG_TRACE,
5050 "pcache_parse_query_delete: decoding error\n",
5052 rc = LDAP_PROTOCOL_ERROR;
5053 *text = "queryDelete data decoding error";
5056 if ( ndn && !BER_BVISNULL( ndn ) ) {
5057 slap_sl_free( ndn->bv_val, ctx );
5061 if ( uuid && !BER_BVISNULL( uuid ) ) {
5062 slap_sl_free( uuid->bv_val, ctx );
5067 if ( !BER_BVISNULL( &reqdata ) ) {
5068 ber_memfree_x( reqdata.bv_val, ctx );
5075 pcache_exop_query_delete(
5079 BackendDB *bd = op->o_bd;
5081 struct berval uuid = BER_BVNULL,
5083 char buf[ SLAP_TEXT_BUFLEN ];
5085 ber_tag_t tag = LBER_DEFAULT;
5087 if ( LogTest( LDAP_DEBUG_STATS ) ) {
5091 rs->sr_err = pcache_parse_query_delete( op->ore_reqdata,
5092 &tag, &op->o_req_ndn, uuidp,
5093 &rs->sr_text, op->o_tmpmemctx );
5094 if ( rs->sr_err != LDAP_SUCCESS ) {
5098 if ( LogTest( LDAP_DEBUG_STATS ) ) {
5099 assert( !BER_BVISNULL( &op->o_req_ndn ) );
5100 len = snprintf( buf, sizeof( buf ), " dn=\"%s\"", op->o_req_ndn.bv_val );
5102 if ( !BER_BVISNULL( &uuid ) && len < sizeof( buf ) ) {
5103 snprintf( &buf[ len ], sizeof( buf ) - len, " pcacheQueryId=\"%s\"", uuid.bv_val );
5106 Debug( LDAP_DEBUG_STATS, "%s QUERY DELETE%s\n",
5107 op->o_log_prefix, buf, 0 );
5109 op->o_req_dn = op->o_req_ndn;
5111 op->o_bd = select_backend( &op->o_req_ndn, 0 );
5112 rs->sr_err = backend_check_restrictions( op, rs,
5113 (struct berval *)&pcache_exop_QUERY_DELETE );
5114 if ( rs->sr_err != LDAP_SUCCESS ) {
5118 if ( op->o_bd->be_extended == NULL ) {
5119 send_ldap_error( op, rs, LDAP_UNAVAILABLE_CRITICAL_EXTENSION,
5120 "backend does not support extended operations" );
5124 op->o_bd->be_extended( op, rs );
5127 if ( !BER_BVISNULL( &op->o_req_ndn ) ) {
5128 op->o_tmpfree( op->o_req_ndn.bv_val, op->o_tmpmemctx );
5129 BER_BVZERO( &op->o_req_ndn );
5130 BER_BVZERO( &op->o_req_dn );
5133 if ( !BER_BVISNULL( &uuid ) ) {
5134 op->o_tmpfree( uuid.bv_val, op->o_tmpmemctx );
5141 #endif /* PCACHE_EXOP_QUERY_DELETE */
5144 pcache_op_extended( Operation *op, SlapReply *rs )
5146 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
5147 cache_manager *cm = on->on_bi.bi_private;
5149 #ifdef PCACHE_CONTROL_PRIVDB
5150 if ( op->o_ctrlflag[ privDB_cid ] == SLAP_CONTROL_CRITICAL ) {
5151 return pcache_op_privdb( op, rs );
5153 #endif /* PCACHE_CONTROL_PRIVDB */
5155 #ifdef PCACHE_EXOP_QUERY_DELETE
5156 if ( bvmatch( &op->ore_reqoid, &pcache_exop_QUERY_DELETE ) ) {
5157 struct berval uuid = BER_BVNULL;
5158 ber_tag_t tag = LBER_DEFAULT;
5160 rs->sr_err = pcache_parse_query_delete( op->ore_reqdata,
5161 &tag, NULL, &uuid, &rs->sr_text, op->o_tmpmemctx );
5162 assert( rs->sr_err == LDAP_SUCCESS );
5164 if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_DN ) {
5165 /* remove all queries related to the selected entry */
5166 rs->sr_err = pcache_remove_entry_queries_from_cache( op,
5167 cm, &op->o_req_ndn, &uuid );
5169 } else if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_BASE ) {
5170 if ( !BER_BVISNULL( &uuid ) ) {
5171 /* remove the selected query */
5172 rs->sr_err = pcache_remove_query_from_cache( op,
5176 /* TODO: remove all queries */
5177 rs->sr_err = LDAP_UNWILLING_TO_PERFORM;
5178 rs->sr_text = "deletion of all queries not implemented";
5182 op->o_tmpfree( uuid.bv_val, op->o_tmpmemctx );
5185 #endif /* PCACHE_EXOP_QUERY_DELETE */
5187 /* We only care if we're configured for Bind caching */
5188 if ( bvmatch( &op->ore_reqoid, &pcache_exop_MODIFY_PASSWD ) &&
5190 /* See if the local entry exists and has a password.
5191 * It's too much work to find the matching query, so
5192 * we just see if there's a hashed password to update.
5194 Operation op2 = *op;
5200 op2.o_dn = op->o_bd->be_rootdn;
5201 op2.o_ndn = op->o_bd->be_rootndn;
5202 rc = be_entry_get_rw( &op2, &op->o_req_ndn, NULL,
5203 slap_schema.si_ad_userPassword, 0, &e );
5204 if ( rc == LDAP_SUCCESS && e ) {
5205 /* See if a recognized password is hashed here */
5206 Attribute *a = attr_find( e->e_attrs,
5207 slap_schema.si_ad_userPassword );
5208 if ( a && a->a_vals[0].bv_val[0] == '{' &&
5209 lutil_passwd_scheme( a->a_vals[0].bv_val )) {
5212 be_entry_release_r( &op2, e );
5216 rc = overlay_op_walk( op, rs, op_extended, on->on_info,
5218 if ( rc == LDAP_SUCCESS ) {
5219 req_pwdexop_s *qpw = &op->oq_pwdexop;
5221 /* We don't care if it succeeds or not */
5222 pc_setpw( &op2, &qpw->rs_new, cm );
5227 return SLAP_CB_CONTINUE;
5231 pcache_entry_release( Operation *op, Entry *e, int rw )
5233 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
5234 cache_manager *cm = on->on_bi.bi_private;
5235 BackendDB *db = op->o_bd;
5239 rc = be_entry_release_rw( op, e, rw );
5244 #ifdef PCACHE_MONITOR
5247 pcache_monitor_update(
5253 cache_manager *cm = (cache_manager *) priv;
5254 query_manager *qm = cm->qm;
5257 BerVarray vals = NULL;
5259 attr_delete( &e->e_attrs, ad_cachedQueryURL );
5260 if ( ( SLAP_OPATTRS( rs->sr_attr_flags ) || ad_inlist( ad_cachedQueryURL, rs->sr_attrs ) )
5261 && qm->templates != NULL )
5265 for ( tm = qm->templates; tm != NULL; tm = tm->qmnext ) {
5266 for ( qc = tm->query; qc; qc = qc->next ) {
5269 if ( query2url( op, qc, &bv, 1 ) == 0 ) {
5270 ber_bvarray_add_x( &vals, &bv, op->o_tmpmemctx );
5276 if ( vals != NULL ) {
5277 attr_merge_normalize( e, ad_cachedQueryURL, vals, NULL );
5278 ber_bvarray_free_x( vals, op->o_tmpmemctx );
5284 char buf[ SLAP_TEXT_BUFLEN ];
5287 /* number of cached queries */
5288 a = attr_find( e->e_attrs, ad_numQueries );
5289 assert( a != NULL );
5292 bv.bv_len = snprintf( buf, sizeof( buf ), "%lu", cm->num_cached_queries );
5294 if ( a->a_nvals != a->a_vals ) {
5295 ber_bvreplace( &a->a_nvals[ 0 ], &bv );
5297 ber_bvreplace( &a->a_vals[ 0 ], &bv );
5299 /* number of cached entries */
5300 a = attr_find( e->e_attrs, ad_numEntries );
5301 assert( a != NULL );
5304 bv.bv_len = snprintf( buf, sizeof( buf ), "%d", cm->cur_entries );
5306 if ( a->a_nvals != a->a_vals ) {
5307 ber_bvreplace( &a->a_nvals[ 0 ], &bv );
5309 ber_bvreplace( &a->a_vals[ 0 ], &bv );
5312 return SLAP_CB_CONTINUE;
5316 pcache_monitor_free(
5320 struct berval values[ 2 ];
5321 Modification mod = { 0 };
5324 char textbuf[ SLAP_TEXT_BUFLEN ];
5328 /* NOTE: if slap_shutdown != 0, priv might have already been freed */
5331 /* Remove objectClass */
5332 mod.sm_op = LDAP_MOD_DELETE;
5333 mod.sm_desc = slap_schema.si_ad_objectClass;
5334 mod.sm_values = values;
5336 values[ 0 ] = oc_olmPCache->soc_cname;
5337 BER_BVZERO( &values[ 1 ] );
5339 rc = modify_delete_values( e, &mod, 1, &text,
5340 textbuf, sizeof( textbuf ) );
5341 /* don't care too much about return code... */
5344 mod.sm_values = NULL;
5345 mod.sm_desc = ad_cachedQueryURL;
5347 rc = modify_delete_values( e, &mod, 1, &text,
5348 textbuf, sizeof( textbuf ) );
5349 /* don't care too much about return code... */
5352 mod.sm_values = NULL;
5353 mod.sm_desc = ad_numQueries;
5355 rc = modify_delete_values( e, &mod, 1, &text,
5356 textbuf, sizeof( textbuf ) );
5357 /* don't care too much about return code... */
5360 mod.sm_values = NULL;
5361 mod.sm_desc = ad_numEntries;
5363 rc = modify_delete_values( e, &mod, 1, &text,
5364 textbuf, sizeof( textbuf ) );
5365 /* don't care too much about return code... */
5367 return SLAP_CB_CONTINUE;
5371 * call from within pcache_initialize()
5374 pcache_monitor_initialize( void )
5376 static int pcache_monitor_initialized = 0;
5378 if ( backend_info( "monitor" ) == NULL ) {
5382 if ( pcache_monitor_initialized++ ) {
5390 pcache_monitor_db_init( BackendDB *be )
5392 if ( pcache_monitor_initialize() == LDAP_SUCCESS ) {
5393 SLAP_DBFLAGS( be ) |= SLAP_DBFLAG_MONITORING;
5400 pcache_monitor_db_open( BackendDB *be )
5402 slap_overinst *on = (slap_overinst *)be->bd_info;
5403 cache_manager *cm = on->on_bi.bi_private;
5404 Attribute *a, *next;
5405 monitor_callback_t *cb = NULL;
5408 monitor_extra_t *mbe;
5409 struct berval dummy = BER_BVC( "" );
5411 if ( !SLAP_DBMONITORING( be ) ) {
5415 mi = backend_info( "monitor" );
5416 if ( !mi || !mi->bi_extra ) {
5417 SLAP_DBFLAGS( be ) ^= SLAP_DBFLAG_MONITORING;
5422 /* don't bother if monitor is not configured */
5423 if ( !mbe->is_configured() ) {
5424 static int warning = 0;
5426 if ( warning++ == 0 ) {
5427 Debug( LDAP_DEBUG_ANY, "pcache_monitor_db_open: "
5428 "monitoring disabled; "
5429 "configure monitor database to enable\n",
5436 /* alloc as many as required (plus 1 for objectClass) */
5437 a = attrs_alloc( 1 + 2 );
5443 a->a_desc = slap_schema.si_ad_objectClass;
5444 attr_valadd( a, &oc_olmPCache->soc_cname, NULL, 1 );
5448 struct berval bv = BER_BVC( "0" );
5450 next->a_desc = ad_numQueries;
5451 attr_valadd( next, &bv, NULL, 1 );
5452 next = next->a_next;
5454 next->a_desc = ad_numEntries;
5455 attr_valadd( next, &bv, NULL, 1 );
5456 next = next->a_next;
5459 cb = ch_calloc( sizeof( monitor_callback_t ), 1 );
5460 cb->mc_update = pcache_monitor_update;
5461 cb->mc_free = pcache_monitor_free;
5462 cb->mc_private = (void *)cm;
5464 /* make sure the database is registered; then add monitor attributes */
5465 BER_BVZERO( &cm->monitor_ndn );
5466 rc = mbe->register_overlay( be, on, &cm->monitor_ndn );
5468 rc = mbe->register_entry_attrs( &cm->monitor_ndn, a, cb,
5469 &dummy, -1, &dummy);
5485 /* store for cleanup */
5486 cm->monitor_cb = (void *)cb;
5488 /* we don't need to keep track of the attributes, because
5489 * bdb_monitor_free() takes care of everything */
5498 pcache_monitor_db_close( BackendDB *be )
5500 slap_overinst *on = (slap_overinst *)be->bd_info;
5501 cache_manager *cm = on->on_bi.bi_private;
5503 if ( cm->monitor_cb != NULL ) {
5504 BackendInfo *mi = backend_info( "monitor" );
5505 monitor_extra_t *mbe;
5507 if ( mi && &mi->bi_extra ) {
5509 mbe->unregister_entry_callback( NULL,
5510 (monitor_callback_t *)cm->monitor_cb,
5519 pcache_monitor_db_destroy( BackendDB *be )
5524 #endif /* PCACHE_MONITOR */
5526 static slap_overinst pcache;
5528 static char *obsolete_names[] = {
5533 #if SLAPD_OVER_PROXYCACHE == SLAPD_MOD_DYNAMIC
5535 #endif /* SLAPD_OVER_PROXYCACHE == SLAPD_MOD_DYNAMIC */
5540 struct berval debugbv = BER_BVC("pcache");
5544 code = slap_loglevel_get( &debugbv, &pcache_debug );
5549 #ifdef PCACHE_CONTROL_PRIVDB
5550 code = register_supported_control( PCACHE_CONTROL_PRIVDB,
5551 SLAP_CTRL_BIND|SLAP_CTRL_ACCESS|SLAP_CTRL_HIDE, extops,
5552 parse_privdb_ctrl, &privDB_cid );
5553 if ( code != LDAP_SUCCESS ) {
5554 Debug( LDAP_DEBUG_ANY,
5555 "pcache_initialize: failed to register control %s (%d)\n",
5556 PCACHE_CONTROL_PRIVDB, code, 0 );
5559 #endif /* PCACHE_CONTROL_PRIVDB */
5561 #ifdef PCACHE_EXOP_QUERY_DELETE
5562 code = load_extop2( (struct berval *)&pcache_exop_QUERY_DELETE,
5563 SLAP_EXOP_WRITES|SLAP_EXOP_HIDE, pcache_exop_query_delete,
5565 if ( code != LDAP_SUCCESS ) {
5566 Debug( LDAP_DEBUG_ANY,
5567 "pcache_initialize: unable to register queryDelete exop: %d.\n",
5571 #endif /* PCACHE_EXOP_QUERY_DELETE */
5573 argv[ 0 ] = "back-bdb/back-hdb monitor";
5578 for ( i = 0; s_oid[ i ].name; i++ ) {
5580 argv[ 1 ] = s_oid[ i ].name;
5581 argv[ 2 ] = s_oid[ i ].oid;
5583 if ( parse_oidm( &c, 0, NULL ) != 0 ) {
5584 Debug( LDAP_DEBUG_ANY, "pcache_initialize: "
5585 "unable to add objectIdentifier \"%s=%s\"\n",
5586 s_oid[ i ].name, s_oid[ i ].oid, 0 );
5591 for ( i = 0; s_ad[i].desc != NULL; i++ ) {
5592 code = register_at( s_ad[i].desc, s_ad[i].adp, 0 );
5594 Debug( LDAP_DEBUG_ANY,
5595 "pcache_initialize: register_at #%d failed\n", i, 0, 0 );
5598 (*s_ad[i].adp)->ad_type->sat_flags |= SLAP_AT_HIDE;
5601 for ( i = 0; s_oc[i].desc != NULL; i++ ) {
5602 code = register_oc( s_oc[i].desc, s_oc[i].ocp, 0 );
5604 Debug( LDAP_DEBUG_ANY,
5605 "pcache_initialize: register_oc #%d failed\n", i, 0, 0 );
5608 (*s_oc[i].ocp)->soc_flags |= SLAP_OC_HIDE;
5611 pcache.on_bi.bi_type = "pcache";
5612 pcache.on_bi.bi_obsolete_names = obsolete_names;
5613 pcache.on_bi.bi_db_init = pcache_db_init;
5614 pcache.on_bi.bi_db_config = pcache_db_config;
5615 pcache.on_bi.bi_db_open = pcache_db_open;
5616 pcache.on_bi.bi_db_close = pcache_db_close;
5617 pcache.on_bi.bi_db_destroy = pcache_db_destroy;
5619 pcache.on_bi.bi_op_search = pcache_op_search;
5620 pcache.on_bi.bi_op_bind = pcache_op_bind;
5621 #ifdef PCACHE_CONTROL_PRIVDB
5622 pcache.on_bi.bi_op_compare = pcache_op_privdb;
5623 pcache.on_bi.bi_op_modrdn = pcache_op_privdb;
5624 pcache.on_bi.bi_op_modify = pcache_op_privdb;
5625 pcache.on_bi.bi_op_add = pcache_op_privdb;
5626 pcache.on_bi.bi_op_delete = pcache_op_privdb;
5627 #endif /* PCACHE_CONTROL_PRIVDB */
5628 pcache.on_bi.bi_extended = pcache_op_extended;
5630 pcache.on_bi.bi_entry_release_rw = pcache_entry_release;
5631 pcache.on_bi.bi_chk_controls = pcache_chk_controls;
5633 pcache.on_bi.bi_cf_ocs = pcocs;
5635 code = config_register_schema( pccfg, pcocs );
5636 if ( code ) return code;
5638 return overlay_register( &pcache );
5641 #if SLAPD_OVER_PROXYCACHE == SLAPD_MOD_DYNAMIC
5642 int init_module(int argc, char *argv[]) {
5643 return pcache_initialize();
5647 #endif /* defined(SLAPD_OVER_PROXYCACHE) */