2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 2003-2011 The OpenLDAP Foundation.
5 * Portions Copyright 2003 IBM Corporation.
6 * Portions Copyright 2003-2009 Symas Corporation.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted only as authorized by the OpenLDAP
13 * A copy of this license is available in the file LICENSE in the
14 * top-level directory of the distribution or, alternatively, at
15 * <http://www.OpenLDAP.org/license.html>.
18 * This work was initially developed by Apurva Kumar for inclusion
19 * in OpenLDAP Software and subsequently rewritten by Howard Chu.
24 #ifdef SLAPD_OVER_PROXYCACHE
28 #include <ac/string.h>
36 #include "../back-monitor/back-monitor.h"
42 * Control that allows to access the private DB
43 * instead of the public one
45 #define PCACHE_CONTROL_PRIVDB "1.3.6.1.4.1.4203.666.11.9.5.1"
48 * Extended Operation that allows to remove a query from the cache
50 #define PCACHE_EXOP_QUERY_DELETE "1.3.6.1.4.1.4203.666.11.9.6.1"
55 #define PCACHE_MONITOR
58 /* query cache structs */
61 typedef struct Query_s {
62 Filter* filter; /* Search Filter */
63 struct berval base; /* Search Base */
64 int scope; /* Search scope */
67 struct query_template_s;
69 typedef struct Qbase_s {
70 Avlnode *scopes[4]; /* threaded AVL trees of cached queries */
75 /* struct representing a cached query */
76 typedef struct cached_query_s {
81 struct berval q_uuid; /* query identifier */
83 struct query_template_s *qtemp; /* template of the query */
84 time_t expiry_time; /* time till the query is considered invalid */
85 time_t refresh_time; /* time till the query is refreshed */
86 time_t bindref_time; /* time till the bind is refreshed */
87 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,
349 struct berval *query_uuid );
352 * Turn a cached query into its URL representation
355 query2url( Operation *op, CachedQuery *q, struct berval *urlbv, int dolock )
357 struct berval bv_scope,
359 char attrset_buf[ LDAP_PVT_INTTYPE_CHARS( unsigned long ) ],
360 expiry_buf[ LDAP_PVT_INTTYPE_CHARS( unsigned long ) ],
361 refresh_buf[ LDAP_PVT_INTTYPE_CHARS( unsigned long ) ],
362 answerable_buf[ LDAP_PVT_INTTYPE_CHARS( unsigned long ) ],
364 ber_len_t attrset_len,
370 ldap_pvt_thread_rdwr_rlock( &q->rwlock );
373 ldap_pvt_scope2bv( q->scope, &bv_scope );
374 filter2bv_x( op, q->filter, &bv_filter );
375 attrset_len = sprintf( attrset_buf,
376 "%lu", (unsigned long)q->qtemp->attr_set_index );
377 expiry_len = sprintf( expiry_buf,
378 "%lu", (unsigned long)q->expiry_time );
379 answerable_len = snprintf( answerable_buf, sizeof( answerable_buf ),
380 "%lu", q->answerable_cnt );
381 if ( q->refresh_time )
382 refresh_len = sprintf( refresh_buf,
383 "%lu", (unsigned long)q->refresh_time );
387 urlbv->bv_len = STRLENOF( "ldap:///" )
388 + q->qbase->base.bv_len
393 + STRLENOF( "?x-uuid=" )
395 + STRLENOF( ",x-attrset=" )
397 + STRLENOF( ",x-expiry=" )
399 + STRLENOF( ",x-answerable=" )
402 urlbv->bv_len += STRLENOF( ",x-refresh=" )
405 ptr = urlbv->bv_val = ber_memalloc_x( urlbv->bv_len + 1, op->o_tmpmemctx );
406 ptr = lutil_strcopy( ptr, "ldap:///" );
407 ptr = lutil_strcopy( ptr, q->qbase->base.bv_val );
408 ptr = lutil_strcopy( ptr, "??" );
409 ptr = lutil_strcopy( ptr, bv_scope.bv_val );
410 ptr = lutil_strcopy( ptr, "?" );
411 ptr = lutil_strcopy( ptr, bv_filter.bv_val );
412 ptr = lutil_strcopy( ptr, "?x-uuid=" );
413 ptr = lutil_strcopy( ptr, q->q_uuid.bv_val );
414 ptr = lutil_strcopy( ptr, ",x-attrset=" );
415 ptr = lutil_strcopy( ptr, attrset_buf );
416 ptr = lutil_strcopy( ptr, ",x-expiry=" );
417 ptr = lutil_strcopy( ptr, expiry_buf );
418 ptr = lutil_strcopy( ptr, ",x-answerable=" );
419 ptr = lutil_strcopy( ptr, answerable_buf );
421 ptr = lutil_strcopy( ptr, ",x-refresh=" );
422 ptr = lutil_strcopy( ptr, refresh_buf );
425 ber_memfree_x( bv_filter.bv_val, op->o_tmpmemctx );
428 ldap_pvt_thread_rdwr_runlock( &q->rwlock );
434 /* Find and record the empty filter clauses */
437 ftemp_attrs( struct berval *ftemp, struct berval *template,
438 AttributeDescription ***ret, const char **text )
444 AttributeDescription *ad;
445 AttributeDescription **descs = NULL;
448 temp2 = ch_malloc( ftemp->bv_len );
455 while ( *p1 == '(' || *p1 == '&' || *p1 == '|' || *p1 == ')' )
458 p2 = strchr( p1, '=' );
462 AC_MEMCPY( t1, p1, i );
466 if ( p2[-1] == '<' || p2[-1] == '>' ) p2--;
470 i = slap_bv2ad( &bv, &ad, text );
475 if ( *p2 == '<' || *p2 == '>' ) p2++;
476 if ( p2[1] != ')' ) {
478 while ( *p2 != ')' ) p2++;
483 descs = (AttributeDescription **)ch_realloc(descs,
484 (attr_cnt + 2)*sizeof(AttributeDescription *));
486 descs[attr_cnt++] = ad;
491 descs[attr_cnt] = NULL;
493 template->bv_val = temp2;
494 template->bv_len = t1 - temp2;
499 template_attrs( char *template, struct attr_set *set, AttributeName **ret,
510 AttributeDescription *ad;
511 AttributeName *attrs;
517 attrs = ch_calloc( set->count + 1, sizeof(AttributeName) );
518 for ( i=0; i < set->count; i++ )
519 attrs[i] = set->attrs[i];
521 alluser = an_find( attrs, slap_bv_all_user_attrs );
522 allop = an_find( attrs, slap_bv_all_operational_attrs );
525 while ( *p1 == '(' || *p1 == '&' || *p1 == '|' || *p1 == ')' ) p1++;
526 p2 = strchr( p1, '=' );
529 if ( p2[-1] == '<' || p2[-1] == '>' ) p2--;
533 i = slap_bv2ad( &bv, &ad, text );
540 if ( ad == slap_schema.si_ad_objectClass )
543 if ( is_at_operational(ad->ad_type)) {
547 } else if ( alluser ) {
550 if ( !ad_inlist( ad, attrs )) {
551 attrs = (AttributeName *)ch_realloc(attrs,
552 (attr_cnt + 2)*sizeof(AttributeName));
554 attrs[attr_cnt].an_desc = ad;
555 attrs[attr_cnt].an_name = ad->ad_cname;
556 attrs[attr_cnt].an_oc = NULL;
557 attrs[attr_cnt].an_flags = 0;
558 BER_BVZERO( &attrs[attr_cnt+1].an_name );
566 *text = "couldn't parse template";
569 if ( !got_oc && !( set->flags & PC_GOT_OC )) {
570 attrs = (AttributeName *)ch_realloc(attrs,
571 (attr_cnt + 2)*sizeof(AttributeName));
573 ad = slap_schema.si_ad_objectClass;
574 attrs[attr_cnt].an_desc = ad;
575 attrs[attr_cnt].an_name = ad->ad_cname;
576 attrs[attr_cnt].an_oc = NULL;
577 attrs[attr_cnt].an_flags = 0;
578 BER_BVZERO( &attrs[attr_cnt+1].an_name );
586 * Turn an URL representing a formerly cached query into a cached query,
587 * and try to cache it
598 LDAPURLDesc *lud = NULL;
600 tempstr = BER_BVNULL,
605 unsigned long answerable_cnt;
608 #define GOT_UUID 0x1U
609 #define GOT_ATTRSET 0x2U
610 #define GOT_EXPIRY 0x4U
611 #define GOT_ANSWERABLE 0x8U
612 #define GOT_REFRESH 0x10U
613 #define GOT_ALL (GOT_UUID|GOT_ATTRSET|GOT_EXPIRY|GOT_ANSWERABLE)
616 rc = ldap_url_parse( url, &lud );
617 if ( rc != LDAP_URL_SUCCESS ) {
621 /* non-allowed fields */
622 if ( lud->lud_host != NULL ) {
627 if ( lud->lud_attrs != NULL ) {
633 if ( strcmp( lud->lud_scheme, "ldap" ) != 0 ) {
638 /* required fields */
639 if ( lud->lud_dn == NULL || lud->lud_dn[ 0 ] == '\0' ) {
644 switch ( lud->lud_scope ) {
645 case LDAP_SCOPE_BASE:
646 case LDAP_SCOPE_ONELEVEL:
647 case LDAP_SCOPE_SUBTREE:
648 case LDAP_SCOPE_SUBORDINATE:
656 if ( lud->lud_filter == NULL || lud->lud_filter[ 0 ] == '\0' ) {
661 if ( lud->lud_exts == NULL ) {
666 for ( i = 0; lud->lud_exts[ i ] != NULL; i++ ) {
667 if ( strncmp( lud->lud_exts[ i ], "x-uuid=", STRLENOF( "x-uuid=" ) ) == 0 ) {
668 struct berval tmpUUID;
669 Syntax *syn_UUID = slap_schema.si_ad_entryUUID->ad_type->sat_syntax;
671 if ( got & GOT_UUID ) {
676 ber_str2bv( &lud->lud_exts[ i ][ STRLENOF( "x-uuid=" ) ], 0, 0, &tmpUUID );
677 if ( !BER_BVISEMPTY( &tmpUUID ) ) {
678 rc = syn_UUID->ssyn_pretty( syn_UUID, &tmpUUID, &uuid, NULL );
679 if ( rc != LDAP_SUCCESS ) {
685 } else if ( strncmp( lud->lud_exts[ i ], "x-attrset=", STRLENOF( "x-attrset=" ) ) == 0 ) {
686 if ( got & GOT_ATTRSET ) {
691 rc = lutil_atoi( &attrset, &lud->lud_exts[ i ][ STRLENOF( "x-attrset=" ) ] );
697 } else if ( strncmp( lud->lud_exts[ i ], "x-expiry=", STRLENOF( "x-expiry=" ) ) == 0 ) {
700 if ( got & GOT_EXPIRY ) {
705 rc = lutil_atoul( &l, &lud->lud_exts[ i ][ STRLENOF( "x-expiry=" ) ] );
709 expiry_time = (time_t)l;
712 } else if ( strncmp( lud->lud_exts[ i ], "x-answerable=", STRLENOF( "x-answerable=" ) ) == 0 ) {
713 if ( got & GOT_ANSWERABLE ) {
718 rc = lutil_atoul( &answerable_cnt, &lud->lud_exts[ i ][ STRLENOF( "x-answerable=" ) ] );
722 got |= GOT_ANSWERABLE;
724 } else if ( strncmp( lud->lud_exts[ i ], "x-refresh=", STRLENOF( "x-refresh=" ) ) == 0 ) {
727 if ( got & GOT_REFRESH ) {
732 rc = lutil_atoul( &l, &lud->lud_exts[ i ][ STRLENOF( "x-refresh=" ) ] );
736 refresh_time = (time_t)l;
745 if ( got != GOT_ALL ) {
750 if ( !(got & GOT_REFRESH ))
753 /* ignore expired queries */
754 if ( expiry_time <= slap_get_time()) {
757 memset( &op2.oq_search, 0, sizeof( op2.oq_search ) );
759 (void)remove_query_data( &op2, &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 rs_reinit( &sreply, REP_RESULT );
869 slap_entry2mods( e, &modlist, &text, textbuf, textlen );
870 modlist->sml_op = LDAP_MOD_ADD;
871 op->o_tag = LDAP_REQ_MODIFY;
872 op->orm_modlist = modlist;
873 op->o_managedsait = SLAP_CONTROL_CRITICAL;
874 op->o_bd->be_modify( op, &sreply );
875 slap_mods_free( modlist, 1 );
876 } else if ( rc == LDAP_REFERRAL ||
877 rc == LDAP_NO_SUCH_OBJECT ) {
878 syncrepl_add_glue( op, e );
887 if ( op->ora_e == e )
895 /* Length-ordered sort on normalized DNs */
896 static int pcache_dn_cmp( const void *v1, const void *v2 )
898 const Qbase *q1 = v1, *q2 = v2;
900 int rc = q1->base.bv_len - q2->base.bv_len;
902 rc = strncmp( q1->base.bv_val, q2->base.bv_val, q1->base.bv_len );
906 static int lex_bvcmp( struct berval *bv1, struct berval *bv2 )
909 dif = bv1->bv_len - bv2->bv_len;
911 if ( dif > 0 ) len -= dif;
912 len = memcmp( bv1->bv_val, bv2->bv_val, len );
918 /* compare the current value in each filter */
919 static int pcache_filter_cmp( Filter *f1, Filter *f2 )
921 int rc, weight1, weight2;
923 switch( f1->f_choice ) {
924 case LDAP_FILTER_PRESENT:
927 case LDAP_FILTER_EQUALITY:
935 switch( f2->f_choice ) {
936 case LDAP_FILTER_PRESENT:
939 case LDAP_FILTER_EQUALITY:
947 rc = weight1 - weight2;
953 rc = lex_bvcmp( &f1->f_av_value, &f2->f_av_value );
956 if ( f1->f_choice == LDAP_FILTER_SUBSTRINGS ) {
958 if ( !BER_BVISNULL( &f1->f_sub_initial )) {
959 if ( !BER_BVISNULL( &f2->f_sub_initial )) {
960 rc = lex_bvcmp( &f1->f_sub_initial,
961 &f2->f_sub_initial );
965 } else if ( !BER_BVISNULL( &f2->f_sub_initial )) {
969 if ( f1->f_sub_any ) {
970 if ( f2->f_sub_any ) {
971 rc = lex_bvcmp( f1->f_sub_any,
976 } else if ( f2->f_sub_any ) {
980 if ( !BER_BVISNULL( &f1->f_sub_final )) {
981 if ( !BER_BVISNULL( &f2->f_sub_final )) {
982 rc = lex_bvcmp( &f1->f_sub_final,
987 } else if ( !BER_BVISNULL( &f2->f_sub_final )) {
991 rc = lex_bvcmp( &f1->f_mr_value,
1005 while ( f1->f_choice == LDAP_FILTER_AND || f1->f_choice == LDAP_FILTER_OR )
1007 while ( f2->f_choice == LDAP_FILTER_AND || f2->f_choice == LDAP_FILTER_OR )
1009 rc = pcache_filter_cmp( f1, f2 );
1017 /* compare filters in each query */
1018 static int pcache_query_cmp( const void *v1, const void *v2 )
1020 const CachedQuery *q1 = v1, *q2 =v2;
1021 return pcache_filter_cmp( q1->first, q2->first );
1024 /* add query on top of LRU list */
1026 add_query_on_top (query_manager* qm, CachedQuery* qc)
1028 CachedQuery* top = qm->lru_top;
1035 qm->lru_bottom = qc;
1039 Debug( pcache_debug, "Base of added query = %s\n",
1040 qc->qbase->base.bv_val, 0, 0 );
1043 /* remove_query from LRU list */
1046 remove_query (query_manager* qm, CachedQuery* qc)
1055 down = qc->lru_down;
1061 qm->lru_bottom = up;
1067 up->lru_down = down;
1069 qc->lru_up = qc->lru_down = NULL;
1072 /* find and remove string2 from string1
1073 * from start if position = 1,
1074 * from end if position = 3,
1075 * from anywhere if position = 2
1076 * string1 is overwritten if position = 2.
1080 find_and_remove(struct berval* ber1, struct berval* ber2, int position)
1084 if ( !ber2->bv_val )
1086 if ( !ber1->bv_val )
1089 switch( position ) {
1091 if ( ber1->bv_len >= ber2->bv_len && !memcmp( ber1->bv_val,
1092 ber2->bv_val, ber2->bv_len )) {
1094 ber1->bv_val += ber2->bv_len;
1095 ber1->bv_len -= ber2->bv_len;
1100 ber1->bv_val[ber1->bv_len] = '\0';
1101 temp = strstr( ber1->bv_val, ber2->bv_val );
1103 strcpy( temp, temp+ber2->bv_len );
1104 ber1->bv_len -= ber2->bv_len;
1110 if ( ber1->bv_len >= ber2->bv_len &&
1111 !memcmp( ber1->bv_val+ber1->bv_len-ber2->bv_len, ber2->bv_val,
1114 ber1->bv_len -= ber2->bv_len;
1122 static struct berval*
1123 merge_init_final(Operation *op, struct berval* init, struct berval* any,
1124 struct berval* final)
1126 struct berval* merged, *temp;
1127 int i, any_count, count;
1129 for (any_count=0; any && any[any_count].bv_val; any_count++)
1139 merged = (struct berval*)op->o_tmpalloc( (count+1)*sizeof(struct berval),
1144 ber_dupbv_x( temp, init, op->o_tmpmemctx );
1148 for (i=0; i<any_count; i++) {
1149 ber_dupbv_x( temp, any, op->o_tmpmemctx );
1154 ber_dupbv_x( temp, final, op->o_tmpmemctx );
1161 /* Each element in stored must be found in incoming. Incoming is overwritten.
1164 strings_containment(struct berval* stored, struct berval* incoming)
1166 struct berval* element;
1170 for ( element=stored; element->bv_val != NULL; element++ ) {
1171 for (j = k; incoming[j].bv_val != NULL; j++) {
1172 if (find_and_remove(&(incoming[j]), element, 2)) {
1189 substr_containment_substr(Operation *op, Filter* stored, Filter* incoming)
1193 struct berval init_incoming;
1194 struct berval final_incoming;
1195 struct berval *remaining_incoming = NULL;
1197 if ((!(incoming->f_sub_initial.bv_val) && (stored->f_sub_initial.bv_val))
1198 || (!(incoming->f_sub_final.bv_val) && (stored->f_sub_final.bv_val)))
1201 init_incoming = incoming->f_sub_initial;
1202 final_incoming = incoming->f_sub_final;
1204 if (find_and_remove(&init_incoming,
1205 &(stored->f_sub_initial), 1) && find_and_remove(&final_incoming,
1206 &(stored->f_sub_final), 3))
1208 if (stored->f_sub_any == NULL) {
1212 remaining_incoming = merge_init_final(op, &init_incoming,
1213 incoming->f_sub_any, &final_incoming);
1214 rc = strings_containment(stored->f_sub_any, remaining_incoming);
1215 ber_bvarray_free_x( remaining_incoming, op->o_tmpmemctx );
1222 substr_containment_equality(Operation *op, Filter* stored, Filter* incoming)
1224 struct berval incoming_val[2];
1227 incoming_val[1] = incoming->f_av_value;
1229 if (find_and_remove(incoming_val+1,
1230 &(stored->f_sub_initial), 1) && find_and_remove(incoming_val+1,
1231 &(stored->f_sub_final), 3)) {
1232 if (stored->f_sub_any == NULL){
1236 ber_dupbv_x( incoming_val, incoming_val+1, op->o_tmpmemctx );
1237 BER_BVZERO( incoming_val+1 );
1238 rc = strings_containment(stored->f_sub_any, incoming_val);
1239 op->o_tmpfree( incoming_val[0].bv_val, op->o_tmpmemctx );
1246 filter_first( Filter *f )
1248 while ( f->f_choice == LDAP_FILTER_OR || f->f_choice == LDAP_FILTER_AND )
1254 static CachedQuery *
1255 find_filter( Operation *op, Avlnode *root, Filter *inputf, Filter *first )
1259 MatchingRule* mrule = NULL;
1260 int res=0, eqpass= 0;
1263 CachedQuery cq, *qc;
1268 /* substring matches sort to the end, and we just have to
1269 * walk the entire list.
1271 if ( first->f_choice == LDAP_FILTER_SUBSTRINGS ) {
1272 ptr = tavl_end( root, 1 );
1273 dir = TAVL_DIR_LEFT;
1275 ptr = tavl_find3( root, &cq, pcache_query_cmp, &ret );
1276 dir = (first->f_choice == LDAP_FILTER_GE) ? TAVL_DIR_LEFT :
1285 /* an incoming substr query can only be satisfied by a cached
1288 if ( first->f_choice == LDAP_FILTER_SUBSTRINGS &&
1289 qc->first->f_choice != LDAP_FILTER_SUBSTRINGS )
1292 /* an incoming eq query can be satisfied by a cached eq or substr
1295 if ( first->f_choice == LDAP_FILTER_EQUALITY ) {
1296 if ( eqpass == 0 ) {
1297 if ( qc->first->f_choice != LDAP_FILTER_EQUALITY ) {
1298 nextpass: eqpass = 1;
1299 ptr = tavl_end( root, 1 );
1300 dir = TAVL_DIR_LEFT;
1304 if ( qc->first->f_choice != LDAP_FILTER_SUBSTRINGS )
1310 switch (fs->f_choice) {
1311 case LDAP_FILTER_EQUALITY:
1312 if (fi->f_choice == LDAP_FILTER_EQUALITY)
1313 mrule = fs->f_ava->aa_desc->ad_type->sat_equality;
1317 case LDAP_FILTER_GE:
1318 case LDAP_FILTER_LE:
1319 mrule = fs->f_ava->aa_desc->ad_type->sat_ordering;
1326 rc = value_match(&ret, fs->f_ava->aa_desc, mrule,
1327 SLAP_MR_VALUE_OF_ASSERTION_SYNTAX,
1328 &(fi->f_ava->aa_value),
1329 &(fs->f_ava->aa_value), &text);
1330 if (rc != LDAP_SUCCESS) {
1333 if ( fi==first && fi->f_choice==LDAP_FILTER_EQUALITY && ret )
1336 switch (fs->f_choice) {
1337 case LDAP_FILTER_OR:
1338 case LDAP_FILTER_AND:
1343 case LDAP_FILTER_SUBSTRINGS:
1344 /* check if the equality query can be
1345 * answered with cached substring query */
1346 if ((fi->f_choice == LDAP_FILTER_EQUALITY)
1347 && substr_containment_equality( op,
1350 /* check if the substring query can be
1351 * answered with cached substring query */
1352 if ((fi->f_choice ==LDAP_FILTER_SUBSTRINGS
1353 ) && substr_containment_substr( op,
1359 case LDAP_FILTER_PRESENT:
1364 case LDAP_FILTER_EQUALITY:
1370 case LDAP_FILTER_GE:
1371 if (mrule && ret >= 0)
1376 case LDAP_FILTER_LE:
1377 if (mrule && ret <= 0)
1382 case LDAP_FILTER_NOT:
1388 } while((res) && (fi != NULL) && (fs != NULL));
1392 ptr = tavl_next( ptr, dir );
1397 /* check whether query is contained in any of
1398 * the cached queries in template
1400 static CachedQuery *
1401 query_containment(Operation *op, query_manager *qm,
1403 QueryTemplate *templa)
1406 int depth = 0, tscope;
1407 Qbase qbase, *qbptr = NULL;
1410 if (query->filter != NULL) {
1413 Debug( pcache_debug, "Lock QC index = %p\n",
1414 (void *) templa, 0, 0 );
1415 qbase.base = query->base;
1417 first = filter_first( query->filter );
1419 ldap_pvt_thread_rdwr_rlock(&templa->t_rwlock);
1422 qbptr = avl_find( templa->qbase, &qbase, pcache_dn_cmp );
1424 tscope = query->scope;
1425 /* Find a matching scope:
1426 * match at depth 0 OK
1429 * subord at depth > 0 OK
1430 * subtree at any depth OK
1432 * subtree or subord at any depth OK
1434 * subtree or subord at any depth OK
1436 * subord at depth > 0 OK
1437 * subtree at any depth OK
1439 for ( tscope = 0 ; tscope <= LDAP_SCOPE_CHILDREN; tscope++ ) {
1440 switch ( query->scope ) {
1441 case LDAP_SCOPE_BASE:
1442 if ( tscope == LDAP_SCOPE_BASE && depth ) continue;
1443 if ( tscope == LDAP_SCOPE_ONE && depth != 1) continue;
1444 if ( tscope == LDAP_SCOPE_CHILDREN && !depth ) continue;
1446 case LDAP_SCOPE_ONE:
1447 if ( tscope == LDAP_SCOPE_BASE )
1448 tscope = LDAP_SCOPE_ONE;
1449 if ( tscope == LDAP_SCOPE_ONE && depth ) continue;
1450 if ( !depth ) break;
1451 if ( tscope < LDAP_SCOPE_SUBTREE )
1452 tscope = LDAP_SCOPE_SUBTREE;
1454 case LDAP_SCOPE_SUBTREE:
1455 if ( tscope < LDAP_SCOPE_SUBTREE )
1456 tscope = LDAP_SCOPE_SUBTREE;
1457 if ( tscope == LDAP_SCOPE_CHILDREN && !depth ) continue;
1459 case LDAP_SCOPE_CHILDREN:
1460 if ( tscope < LDAP_SCOPE_SUBTREE )
1461 tscope = LDAP_SCOPE_SUBTREE;
1464 if ( !qbptr->scopes[tscope] ) continue;
1467 qc = find_filter( op, qbptr->scopes[tscope],
1468 query->filter, first );
1470 if ( qc->q_sizelimit ) {
1471 ldap_pvt_thread_rdwr_runlock(&templa->t_rwlock);
1474 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
1475 if (qm->lru_top != qc) {
1476 remove_query(qm, qc);
1477 add_query_on_top(qm, qc);
1479 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1484 if ( be_issuffix( op->o_bd, &qbase.base ))
1487 dnParent( &qbase.base, &pdn );
1492 Debug( pcache_debug,
1493 "Not answerable: Unlock QC index=%p\n",
1494 (void *) templa, 0, 0 );
1495 ldap_pvt_thread_rdwr_runlock(&templa->t_rwlock);
1501 free_query (CachedQuery* qc)
1503 free(qc->q_uuid.bv_val);
1504 filter_free(qc->filter);
1505 ldap_pvt_thread_mutex_destroy(&qc->answerable_cnt_mutex);
1506 ldap_pvt_thread_rdwr_destroy( &qc->rwlock );
1507 memset(qc, 0, sizeof(*qc));
1512 /* Add query to query cache, the returned Query is locked for writing */
1513 static CachedQuery *
1518 QueryTemplate *templ,
1519 pc_caching_reason_t why,
1522 CachedQuery* new_cached_query = (CachedQuery*) ch_malloc(sizeof(CachedQuery));
1526 time_t ttl = 0, ttr = 0;
1529 new_cached_query->qtemp = templ;
1530 BER_BVZERO( &new_cached_query->q_uuid );
1531 new_cached_query->q_sizelimit = 0;
1533 now = slap_get_time();
1538 ttr = now + templ->ttr;
1542 ttl = templ->negttl;
1546 ttl = templ->limitttl;
1553 new_cached_query->expiry_time = now + ttl;
1554 new_cached_query->refresh_time = ttr;
1556 new_cached_query->answerable_cnt = 0;
1557 new_cached_query->refcnt = 1;
1558 ldap_pvt_thread_mutex_init(&new_cached_query->answerable_cnt_mutex);
1560 new_cached_query->lru_up = NULL;
1561 new_cached_query->lru_down = NULL;
1562 Debug( pcache_debug, "Added query expires at %ld (%s)\n",
1563 (long) new_cached_query->expiry_time,
1564 pc_caching_reason_str[ why ], 0 );
1566 new_cached_query->scope = query->scope;
1567 new_cached_query->filter = query->filter;
1568 new_cached_query->first = first = filter_first( query->filter );
1570 ldap_pvt_thread_rdwr_init(&new_cached_query->rwlock);
1572 ldap_pvt_thread_rdwr_wlock(&new_cached_query->rwlock);
1574 qb.base = query->base;
1576 /* Adding a query */
1577 Debug( pcache_debug, "Lock AQ index = %p\n",
1578 (void *) templ, 0, 0 );
1579 ldap_pvt_thread_rdwr_wlock(&templ->t_rwlock);
1580 qbase = avl_find( templ->qbase, &qb, pcache_dn_cmp );
1582 qbase = ch_calloc( 1, sizeof(Qbase) + qb.base.bv_len + 1 );
1583 qbase->base.bv_len = qb.base.bv_len;
1584 qbase->base.bv_val = (char *)(qbase+1);
1585 memcpy( qbase->base.bv_val, qb.base.bv_val, qb.base.bv_len );
1586 qbase->base.bv_val[qbase->base.bv_len] = '\0';
1587 avl_insert( &templ->qbase, qbase, pcache_dn_cmp, avl_dup_error );
1589 new_cached_query->next = templ->query;
1590 new_cached_query->prev = NULL;
1591 new_cached_query->qbase = qbase;
1592 rc = tavl_insert( &qbase->scopes[query->scope], new_cached_query,
1593 pcache_query_cmp, avl_dup_error );
1596 if (templ->query == NULL)
1597 templ->query_last = new_cached_query;
1599 templ->query->prev = new_cached_query;
1600 templ->query = new_cached_query;
1601 templ->no_of_queries++;
1603 ldap_pvt_thread_mutex_destroy(&new_cached_query->answerable_cnt_mutex);
1605 ldap_pvt_thread_rdwr_wunlock(&new_cached_query->rwlock);
1606 ldap_pvt_thread_rdwr_destroy( &new_cached_query->rwlock );
1607 ch_free( new_cached_query );
1608 new_cached_query = find_filter( op, qbase->scopes[query->scope],
1609 query->filter, first );
1610 filter_free( query->filter );
1611 query->filter = NULL;
1613 Debug( pcache_debug, "TEMPLATE %p QUERIES++ %d\n",
1614 (void *) templ, templ->no_of_queries, 0 );
1616 Debug( pcache_debug, "Unlock AQ index = %p \n",
1617 (void *) templ, 0, 0 );
1618 ldap_pvt_thread_rdwr_wunlock(&templ->t_rwlock);
1620 /* Adding on top of LRU list */
1622 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
1623 add_query_on_top(qm, new_cached_query);
1624 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1626 return rc == 0 ? new_cached_query : NULL;
1630 remove_from_template (CachedQuery* qc, QueryTemplate* template)
1632 if (!qc->prev && !qc->next) {
1633 template->query_last = template->query = NULL;
1634 } else if (qc->prev == NULL) {
1635 qc->next->prev = NULL;
1636 template->query = qc->next;
1637 } else if (qc->next == NULL) {
1638 qc->prev->next = NULL;
1639 template->query_last = qc->prev;
1641 qc->next->prev = qc->prev;
1642 qc->prev->next = qc->next;
1644 tavl_delete( &qc->qbase->scopes[qc->scope], qc, pcache_query_cmp );
1645 qc->qbase->queries--;
1646 if ( qc->qbase->queries == 0 ) {
1647 avl_delete( &template->qbase, qc->qbase, pcache_dn_cmp );
1648 ch_free( qc->qbase );
1652 template->no_of_queries--;
1655 /* remove bottom query of LRU list from the query cache */
1657 * NOTE: slight change in functionality.
1659 * - if result->bv_val is NULL, the query at the bottom of the LRU
1661 * - otherwise, the query whose UUID is *result is removed
1662 * - if not found, result->bv_val is zeroed
1665 cache_replacement(query_manager* qm, struct berval *result)
1667 CachedQuery* bottom;
1668 QueryTemplate *temp;
1670 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
1671 if ( BER_BVISNULL( result ) ) {
1672 bottom = qm->lru_bottom;
1675 Debug ( pcache_debug,
1676 "Cache replacement invoked without "
1677 "any query in LRU list\n", 0, 0, 0 );
1678 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1683 for ( bottom = qm->lru_bottom;
1685 bottom = bottom->lru_up )
1687 if ( bvmatch( result, &bottom->q_uuid ) ) {
1693 Debug ( pcache_debug,
1694 "Could not find query with uuid=\"%s\""
1695 "in LRU list\n", result->bv_val, 0, 0 );
1696 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1697 BER_BVZERO( result );
1702 temp = bottom->qtemp;
1703 remove_query(qm, bottom);
1704 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1706 *result = bottom->q_uuid;
1707 BER_BVZERO( &bottom->q_uuid );
1709 Debug( pcache_debug, "Lock CR index = %p\n", (void *) temp, 0, 0 );
1710 ldap_pvt_thread_rdwr_wlock(&temp->t_rwlock);
1711 remove_from_template(bottom, temp);
1712 Debug( pcache_debug, "TEMPLATE %p QUERIES-- %d\n",
1713 (void *) temp, temp->no_of_queries, 0 );
1714 Debug( pcache_debug, "Unlock CR index = %p\n", (void *) temp, 0, 0 );
1715 ldap_pvt_thread_rdwr_wunlock(&temp->t_rwlock);
1720 struct query_info *next;
1732 struct query_info *qi;
1735 if ( rs->sr_type != REP_SEARCH ) return 0;
1737 attr = attr_find( rs->sr_entry->e_attrs, ad_queryId );
1738 if ( attr == NULL ) return 0;
1740 count = attr->a_numvals;
1741 assert( count > 0 );
1742 qi = op->o_tmpalloc( sizeof( struct query_info ), op->o_tmpmemctx );
1743 qi->next = op->o_callback->sc_private;
1744 op->o_callback->sc_private = qi;
1745 ber_dupbv_x( &qi->xdn, &rs->sr_entry->e_nname, op->o_tmpmemctx );
1746 qi->del = ( count == 1 );
1754 struct berval *query_uuid )
1756 struct query_info *qi, *qnext;
1757 char filter_str[ LDAP_LUTIL_UUIDSTR_BUFSIZE + STRLENOF( "(pcacheQueryID=)" ) ];
1758 AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
1759 Filter filter = {LDAP_FILTER_EQUALITY};
1760 SlapReply sreply = {REP_RESULT};
1761 slap_callback cb = { NULL, remove_func, NULL, NULL };
1764 op->ors_filterstr.bv_len = snprintf(filter_str, sizeof(filter_str),
1765 "(%s=%s)", ad_queryId->ad_cname.bv_val, query_uuid->bv_val);
1766 filter.f_ava = &ava;
1767 filter.f_av_desc = ad_queryId;
1768 filter.f_av_value = *query_uuid;
1770 op->o_tag = LDAP_REQ_SEARCH;
1771 op->o_protocol = LDAP_VERSION3;
1772 op->o_callback = &cb;
1773 op->o_time = slap_get_time();
1774 op->o_do_not_cache = 1;
1776 op->o_req_dn = op->o_bd->be_suffix[0];
1777 op->o_req_ndn = op->o_bd->be_nsuffix[0];
1778 op->ors_scope = LDAP_SCOPE_SUBTREE;
1779 op->ors_deref = LDAP_DEREF_NEVER;
1780 op->ors_slimit = SLAP_NO_LIMIT;
1781 op->ors_tlimit = SLAP_NO_LIMIT;
1782 op->ors_limit = NULL;
1783 op->ors_filter = &filter;
1784 op->ors_filterstr.bv_val = filter_str;
1785 op->ors_filterstr.bv_len = strlen(filter_str);
1786 op->ors_attrs = NULL;
1787 op->ors_attrsonly = 0;
1789 op->o_bd->be_search( op, &sreply );
1791 for ( qi=cb.sc_private; qi; qi=qnext ) {
1794 op->o_req_dn = qi->xdn;
1795 op->o_req_ndn = qi->xdn;
1796 rs_reinit( &sreply, REP_RESULT );
1799 Debug( pcache_debug, "DELETING ENTRY TEMPLATE=%s\n",
1800 query_uuid->bv_val, 0, 0 );
1802 op->o_tag = LDAP_REQ_DELETE;
1804 if (op->o_bd->be_delete(op, &sreply) == LDAP_SUCCESS) {
1810 struct berval vals[2];
1812 vals[0] = *query_uuid;
1813 vals[1].bv_val = NULL;
1815 mod.sml_op = LDAP_MOD_DELETE;
1817 mod.sml_desc = ad_queryId;
1818 mod.sml_type = ad_queryId->ad_cname;
1819 mod.sml_values = vals;
1820 mod.sml_nvalues = NULL;
1821 mod.sml_numvals = 1;
1822 mod.sml_next = NULL;
1823 Debug( pcache_debug,
1824 "REMOVING TEMP ATTR : TEMPLATE=%s\n",
1825 query_uuid->bv_val, 0, 0 );
1827 op->orm_modlist = &mod;
1829 op->o_bd->be_modify( op, &sreply );
1831 op->o_tmpfree( qi->xdn.bv_val, op->o_tmpmemctx );
1832 op->o_tmpfree( qi, op->o_tmpmemctx );
1839 AttributeName* attrs,
1848 struct berval *fstr )
1850 AttributeDescription *ad;
1853 switch ( f->f_choice ) {
1854 case LDAP_FILTER_EQUALITY:
1856 len = STRLENOF( "(=)" ) + ad->ad_cname.bv_len;
1857 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s=)", ad->ad_cname.bv_val );
1858 assert( ret == len );
1859 fstr->bv_len += len;
1862 case LDAP_FILTER_GE:
1864 len = STRLENOF( "(>=)" ) + ad->ad_cname.bv_len;
1865 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s>=)", ad->ad_cname.bv_val);
1866 assert( ret == len );
1867 fstr->bv_len += len;
1870 case LDAP_FILTER_LE:
1872 len = STRLENOF( "(<=)" ) + ad->ad_cname.bv_len;
1873 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s<=)", ad->ad_cname.bv_val);
1874 assert( ret == len );
1875 fstr->bv_len += len;
1878 case LDAP_FILTER_APPROX:
1880 len = STRLENOF( "(~=)" ) + ad->ad_cname.bv_len;
1881 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s~=)", ad->ad_cname.bv_val);
1882 assert( ret == len );
1883 fstr->bv_len += len;
1886 case LDAP_FILTER_SUBSTRINGS:
1888 len = STRLENOF( "(=)" ) + ad->ad_cname.bv_len;
1889 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s=)", ad->ad_cname.bv_val );
1890 assert( ret == len );
1891 fstr->bv_len += len;
1894 case LDAP_FILTER_PRESENT:
1896 len = STRLENOF( "(=*)" ) + ad->ad_cname.bv_len;
1897 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s=*)", ad->ad_cname.bv_val );
1898 assert( ret == len );
1899 fstr->bv_len += len;
1902 case LDAP_FILTER_AND:
1903 case LDAP_FILTER_OR:
1904 case LDAP_FILTER_NOT: {
1906 fstr->bv_val[fstr->bv_len++] = '(';
1907 switch ( f->f_choice ) {
1908 case LDAP_FILTER_AND:
1909 fstr->bv_val[fstr->bv_len] = '&';
1911 case LDAP_FILTER_OR:
1912 fstr->bv_val[fstr->bv_len] = '|';
1914 case LDAP_FILTER_NOT:
1915 fstr->bv_val[fstr->bv_len] = '!';
1920 for ( f = f->f_list; f != NULL; f = f->f_next ) {
1921 rc = filter2template( op, f, fstr );
1924 fstr->bv_val[fstr->bv_len++] = ')';
1925 fstr->bv_val[fstr->bv_len] = '\0';
1931 /* a filter should at least have room for "()",
1932 * an "=" and for a 1-char attr */
1933 strcpy( fstr->bv_val, "(?=)" );
1934 fstr->bv_len += STRLENOF("(?=)");
1941 #define BI_HASHED 0x01
1942 #define BI_DIDCB 0x02
1943 #define BI_LOOKUP 0x04
1947 typedef struct bindinfo {
1948 cache_manager *bi_cm;
1950 QueryTemplate *bi_templ;
1951 struct search_info *bi_si;
1953 slap_callback bi_cb;
1956 struct search_info {
1959 QueryTemplate *qtemp;
1960 AttributeName* save_attrs; /* original attributes, saved for response */
1961 int swap_saved_attrs;
1966 int slimit_exceeded;
1967 pc_caching_reason_t caching_reason;
1973 remove_query_and_data(
1976 struct berval *uuid )
1978 query_manager* qm = cm->qm;
1980 qm->crfunc( qm, uuid );
1981 if ( !BER_BVISNULL( uuid ) ) {
1984 Debug( pcache_debug,
1985 "Removing query UUID %s\n",
1986 uuid->bv_val, 0, 0 );
1987 return_val = remove_query_data( op, uuid );
1988 Debug( pcache_debug,
1989 "QUERY REMOVED, SIZE=%d\n",
1991 ldap_pvt_thread_mutex_lock( &cm->cache_mutex );
1992 cm->cur_entries -= return_val;
1993 cm->num_cached_queries--;
1994 Debug( pcache_debug,
1995 "STORED QUERIES = %lu\n",
1996 cm->num_cached_queries, 0, 0 );
1997 ldap_pvt_thread_mutex_unlock( &cm->cache_mutex );
1998 Debug( pcache_debug,
1999 "QUERY REMOVED, CACHE ="
2001 cm->cur_entries, 0, 0 );
2006 * Callback used to fetch queryId values based on entryUUID;
2007 * used by pcache_remove_entries_from_cache()
2010 fetch_queryId_cb( Operation *op, SlapReply *rs )
2014 /* only care about searchEntry responses */
2015 if ( rs->sr_type != REP_SEARCH ) {
2019 /* allow only one response per entryUUID */
2020 if ( op->o_callback->sc_private != NULL ) {
2026 /* copy all queryId values into callback's private data */
2027 a = attr_find( rs->sr_entry->e_attrs, ad_queryId );
2029 BerVarray vals = NULL;
2031 ber_bvarray_dup_x( &vals, a->a_nvals, op->o_tmpmemctx );
2032 op->o_callback->sc_private = (void *)vals;
2036 /* clear entry if required */
2037 rs_flush_entry( op, rs, (slap_overinst *) op->o_bd->bd_info );
2043 * Call that allows to remove a set of entries from the cache,
2044 * by forcing the removal of all the related queries.
2047 pcache_remove_entries_from_cache(
2050 BerVarray entryUUIDs )
2052 Connection conn = { 0 };
2053 OperationBuffer opbuf;
2055 slap_callback sc = { 0 };
2057 char filtbuf[ LDAP_LUTIL_UUIDSTR_BUFSIZE + STRLENOF( "(entryUUID=)" ) ];
2058 AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
2059 AttributeName attrs[ 2 ] = {{{ 0 }}};
2063 void *thrctx = ldap_pvt_thread_pool_context();
2065 connection_fake_init( &conn, &opbuf, thrctx );
2073 memset( &op->oq_search, 0, sizeof( op->oq_search ) );
2074 op->ors_scope = LDAP_SCOPE_SUBTREE;
2075 op->ors_deref = LDAP_DEREF_NEVER;
2076 f.f_choice = LDAP_FILTER_EQUALITY;
2078 ava.aa_desc = slap_schema.si_ad_entryUUID;
2079 op->ors_filter = &f;
2081 op->ors_tlimit = SLAP_NO_LIMIT;
2082 op->ors_limit = NULL;
2083 attrs[ 0 ].an_desc = ad_queryId;
2084 attrs[ 0 ].an_name = ad_queryId->ad_cname;
2085 op->ors_attrs = attrs;
2086 op->ors_attrsonly = 0;
2088 op->o_req_dn = cm->db.be_suffix[ 0 ];
2089 op->o_req_ndn = cm->db.be_nsuffix[ 0 ];
2091 op->o_tag = LDAP_REQ_SEARCH;
2092 op->o_protocol = LDAP_VERSION3;
2093 op->o_managedsait = SLAP_CONTROL_CRITICAL;
2095 op->o_dn = op->o_bd->be_rootdn;
2096 op->o_ndn = op->o_bd->be_rootndn;
2097 sc.sc_response = fetch_queryId_cb;
2098 op->o_callback = ≻
2100 for ( s = 0; !BER_BVISNULL( &entryUUIDs[ s ] ); s++ ) {
2101 BerVarray vals = NULL;
2102 SlapReply rs = { REP_RESULT };
2104 op->ors_filterstr.bv_len = snprintf( filtbuf, sizeof( filtbuf ),
2105 "(entryUUID=%s)", entryUUIDs[ s ].bv_val );
2106 op->ors_filterstr.bv_val = filtbuf;
2107 ava.aa_value = entryUUIDs[ s ];
2109 rc = op->o_bd->be_search( op, &rs );
2110 if ( rc != LDAP_SUCCESS ) {
2114 vals = (BerVarray)op->o_callback->sc_private;
2115 if ( vals != NULL ) {
2118 for ( i = 0; !BER_BVISNULL( &vals[ i ] ); i++ ) {
2119 struct berval val = vals[ i ];
2121 remove_query_and_data( op, cm, &val );
2123 if ( !BER_BVISNULL( &val ) && val.bv_val != vals[ i ].bv_val ) {
2124 ch_free( val.bv_val );
2128 ber_bvarray_free_x( vals, op->o_tmpmemctx );
2129 op->o_callback->sc_private = NULL;
2137 * Call that allows to remove a query from the cache.
2140 pcache_remove_query_from_cache(
2143 struct berval *queryid )
2145 Operation op2 = *op;
2149 /* remove the selected query */
2150 remove_query_and_data( &op2, cm, queryid );
2152 return LDAP_SUCCESS;
2156 * Call that allows to remove a set of queries related to an entry
2157 * from the cache; if queryid is not null, the entry must belong to
2158 * the query indicated by queryid.
2161 pcache_remove_entry_queries_from_cache(
2165 struct berval *queryid )
2167 Connection conn = { 0 };
2168 OperationBuffer opbuf;
2170 slap_callback sc = { 0 };
2171 SlapReply rs = { REP_RESULT };
2173 char filter_str[ LDAP_LUTIL_UUIDSTR_BUFSIZE + STRLENOF( "(pcacheQueryID=)" ) ];
2174 AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
2175 AttributeName attrs[ 2 ] = {{{ 0 }}};
2178 BerVarray vals = NULL;
2181 void *thrctx = ldap_pvt_thread_pool_context();
2183 connection_fake_init( &conn, &opbuf, thrctx );
2191 memset( &op->oq_search, 0, sizeof( op->oq_search ) );
2192 op->ors_scope = LDAP_SCOPE_BASE;
2193 op->ors_deref = LDAP_DEREF_NEVER;
2194 if ( queryid == NULL || BER_BVISNULL( queryid ) ) {
2195 BER_BVSTR( &op->ors_filterstr, "(objectClass=*)" );
2196 f.f_choice = LDAP_FILTER_PRESENT;
2197 f.f_desc = slap_schema.si_ad_objectClass;
2200 op->ors_filterstr.bv_len = snprintf( filter_str,
2201 sizeof( filter_str ), "(%s=%s)",
2202 ad_queryId->ad_cname.bv_val, queryid->bv_val );
2203 f.f_choice = LDAP_FILTER_EQUALITY;
2205 f.f_av_desc = ad_queryId;
2206 f.f_av_value = *queryid;
2208 op->ors_filter = &f;
2210 op->ors_tlimit = SLAP_NO_LIMIT;
2211 op->ors_limit = NULL;
2212 attrs[ 0 ].an_desc = ad_queryId;
2213 attrs[ 0 ].an_name = ad_queryId->ad_cname;
2214 op->ors_attrs = attrs;
2215 op->ors_attrsonly = 0;
2217 op->o_req_dn = *ndn;
2218 op->o_req_ndn = *ndn;
2220 op->o_tag = LDAP_REQ_SEARCH;
2221 op->o_protocol = LDAP_VERSION3;
2222 op->o_managedsait = SLAP_CONTROL_CRITICAL;
2224 op->o_dn = op->o_bd->be_rootdn;
2225 op->o_ndn = op->o_bd->be_rootndn;
2226 sc.sc_response = fetch_queryId_cb;
2227 op->o_callback = ≻
2229 rc = op->o_bd->be_search( op, &rs );
2230 if ( rc != LDAP_SUCCESS ) {
2234 vals = (BerVarray)op->o_callback->sc_private;
2235 if ( vals != NULL ) {
2238 for ( i = 0; !BER_BVISNULL( &vals[ i ] ); i++ ) {
2239 struct berval val = vals[ i ];
2241 remove_query_and_data( op, cm, &val );
2243 if ( !BER_BVISNULL( &val ) && val.bv_val != vals[ i ].bv_val ) {
2244 ch_free( val.bv_val );
2248 ber_bvarray_free_x( vals, op->o_tmpmemctx );
2251 return LDAP_SUCCESS;
2257 struct berval *query_uuid )
2259 struct search_info *si = op->o_callback->sc_private;
2260 slap_overinst *on = si->on;
2261 cache_manager *cm = on->on_bi.bi_private;
2264 struct berval crp_uuid;
2265 char uuidbuf[ LDAP_LUTIL_UUIDSTR_BUFSIZE ];
2267 Connection conn = {0};
2268 OperationBuffer opbuf;
2269 void *thrctx = ldap_pvt_thread_pool_context();
2271 query_uuid->bv_len = lutil_uuidstr(uuidbuf, sizeof(uuidbuf));
2272 ber_str2bv(uuidbuf, query_uuid->bv_len, 1, query_uuid);
2274 connection_fake_init2( &conn, &opbuf, thrctx, 0 );
2275 op_tmp = &opbuf.ob_op;
2276 op_tmp->o_bd = &cm->db;
2277 op_tmp->o_dn = cm->db.be_rootdn;
2278 op_tmp->o_ndn = cm->db.be_rootndn;
2280 Debug( pcache_debug, "UUID for query being added = %s\n",
2283 for ( e=si->head; e; e=si->head ) {
2284 si->head = e->e_private;
2285 e->e_private = NULL;
2286 while ( cm->cur_entries > (cm->max_entries) ) {
2287 BER_BVZERO( &crp_uuid );
2288 remove_query_and_data( op_tmp, cm, &crp_uuid );
2291 return_val = merge_entry(op_tmp, e, 0, query_uuid);
2292 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
2293 cm->cur_entries += return_val;
2294 Debug( pcache_debug,
2295 "ENTRY ADDED/MERGED, CACHED ENTRIES=%d\n",
2296 cm->cur_entries, 0, 0 );
2298 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
2305 pcache_op_cleanup( Operation *op, SlapReply *rs ) {
2306 slap_callback *cb = op->o_callback;
2307 struct search_info *si = cb->sc_private;
2308 slap_overinst *on = si->on;
2309 cache_manager *cm = on->on_bi.bi_private;
2310 query_manager* qm = cm->qm;
2312 if ( rs->sr_type == REP_SEARCH ) {
2315 /* don't return more entries than requested by the client */
2316 if ( si->slimit > 0 && rs->sr_nentries >= si->slimit ) {
2317 si->slimit_exceeded = 1;
2320 /* If we haven't exceeded the limit for this query,
2321 * build a chain of answers to store. If we hit the
2322 * limit, empty the chain and ignore the rest.
2325 /* check if the entry contains undefined
2326 * attributes/objectClasses (ITS#5680) */
2327 if ( cm->check_cacheability && test_filter( op, rs->sr_entry, si->query.filter ) != LDAP_COMPARE_TRUE ) {
2328 Debug( pcache_debug, "%s: query not cacheable because of schema issues in DN \"%s\"\n",
2329 op->o_log_prefix, rs->sr_entry->e_name.bv_val, 0 );
2333 /* check for malformed entries: attrs with no values */
2335 Attribute *a = rs->sr_entry->e_attrs;
2336 for (; a; a=a->a_next) {
2337 if ( !a->a_numvals ) {
2338 Debug( pcache_debug, "%s: query not cacheable because of attrs without values in DN \"%s\" (%s)\n",
2339 op->o_log_prefix, rs->sr_entry->e_name.bv_val,
2340 a->a_desc->ad_cname.bv_val );
2346 if ( si->count < si->max ) {
2348 e = entry_dup( rs->sr_entry );
2349 if ( !si->head ) si->head = e;
2350 if ( si->tail ) si->tail->e_private = e;
2357 for (;si->head; si->head=e) {
2358 e = si->head->e_private;
2359 si->head->e_private = NULL;
2360 entry_free(si->head);
2368 if ( rs->sr_type == REP_RESULT ||
2369 op->o_abandon || rs->sr_err == SLAPD_ABANDON )
2371 if ( si->swap_saved_attrs ) {
2372 rs->sr_attrs = si->save_attrs;
2373 op->ors_attrs = si->save_attrs;
2375 if ( (op->o_abandon || rs->sr_err == SLAPD_ABANDON) &&
2376 si->caching_reason == PC_IGNORE )
2378 filter_free( si->query.filter );
2380 /* duplicate query, free it */
2382 for (;si->head; si->head=e) {
2383 e = si->head->e_private;
2384 si->head->e_private = NULL;
2385 entry_free(si->head);
2389 } else if ( si->caching_reason != PC_IGNORE ) {
2390 CachedQuery *qc = qm->addfunc(op, qm, &si->query,
2391 si->qtemp, si->caching_reason, 1 );
2394 switch ( si->caching_reason ) {
2396 cache_entries( op, &qc->q_uuid );
2398 si->pbi->bi_cq = qc;
2402 qc->q_sizelimit = rs->sr_nentries;
2412 ldap_pvt_thread_rdwr_wunlock(&qc->rwlock);
2413 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
2414 cm->num_cached_queries++;
2415 Debug( pcache_debug, "STORED QUERIES = %lu\n",
2416 cm->num_cached_queries, 0, 0 );
2417 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
2419 /* If the consistency checker suspended itself,
2422 if ( cm->cc_paused == PCACHE_CC_PAUSED ) {
2423 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
2424 if ( cm->cc_paused == PCACHE_CC_PAUSED ) {
2426 ldap_pvt_runqueue_resched( &slapd_rq, cm->cc_arg, 0 );
2428 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
2431 } else if ( si->count ) {
2432 /* duplicate query, free it */
2434 for (;si->head; si->head=e) {
2435 e = si->head->e_private;
2436 si->head->e_private = NULL;
2437 entry_free(si->head);
2442 filter_free( si->query.filter );
2445 op->o_callback = op->o_callback->sc_next;
2446 op->o_tmpfree( cb, op->o_tmpmemctx );
2449 return SLAP_CB_CONTINUE;
2457 struct search_info *si = op->o_callback->sc_private;
2459 if ( si->swap_saved_attrs ) {
2460 rs->sr_attrs = si->save_attrs;
2461 op->ors_attrs = si->save_attrs;
2464 if ( rs->sr_type == REP_SEARCH ) {
2465 /* don't return more entries than requested by the client */
2466 if ( si->slimit_exceeded ) {
2470 } else if ( rs->sr_type == REP_RESULT ) {
2473 if ( rs->sr_err == LDAP_SUCCESS ) {
2474 si->caching_reason = PC_POSITIVE;
2476 } else if ( rs->sr_err == LDAP_SIZELIMIT_EXCEEDED
2477 && si->qtemp->limitttl )
2481 si->caching_reason = PC_SIZELIMIT;
2482 for (;si->head; si->head=e) {
2483 e = si->head->e_private;
2484 si->head->e_private = NULL;
2485 entry_free(si->head);
2489 } else if ( si->qtemp->negttl && !si->count && !si->over &&
2490 rs->sr_err == LDAP_SUCCESS )
2492 si->caching_reason = PC_NEGATIVE;
2496 if ( si->slimit_exceeded ) {
2497 rs->sr_err = LDAP_SIZELIMIT_EXCEEDED;
2501 return SLAP_CB_CONTINUE;
2504 /* NOTE: this is a quick workaround to let pcache minimally interact
2505 * with pagedResults. A more articulated solutions would be to
2506 * perform the remote query without control and cache all results,
2507 * performing the pagedResults search only within the client
2508 * and the proxy. This requires pcache to understand pagedResults. */
2510 pcache_chk_controls(
2514 const char *non = "";
2515 const char *stripped = "";
2517 switch( op->o_pagedresults ) {
2518 case SLAP_CONTROL_NONCRITICAL:
2520 stripped = "; stripped";
2523 case SLAP_CONTROL_CRITICAL:
2524 Debug( pcache_debug, "%s: "
2525 "%scritical pagedResults control "
2526 "disabled with proxy cache%s.\n",
2527 op->o_log_prefix, non, stripped );
2529 slap_remove_control( op, rs, slap_cids.sc_pagedResults, NULL );
2533 rs->sr_err = SLAP_CB_CONTINUE;
2541 pc_setpw( Operation *op, struct berval *pwd, cache_manager *cm )
2543 struct berval vals[2];
2546 const char *text = NULL;
2547 BER_BVZERO( &vals[0] );
2548 slap_passwd_hash( pwd, &vals[0], &text );
2549 if ( BER_BVISEMPTY( &vals[0] )) {
2550 Debug( pcache_debug, "pc_setpw: hash failed %s\n",
2556 BER_BVZERO( &vals[1] );
2560 SlapReply sr = { REP_RESULT };
2561 slap_callback cb = { 0, slap_null_cb, 0, 0 };
2564 mod.sml_op = LDAP_MOD_REPLACE;
2566 mod.sml_desc = slap_schema.si_ad_userPassword;
2567 mod.sml_type = mod.sml_desc->ad_cname;
2568 mod.sml_values = vals;
2569 mod.sml_nvalues = NULL;
2570 mod.sml_numvals = 1;
2571 mod.sml_next = NULL;
2573 op->o_tag = LDAP_REQ_MODIFY;
2574 op->orm_modlist = &mod;
2576 op->o_dn = op->o_bd->be_rootdn;
2577 op->o_ndn = op->o_bd->be_rootndn;
2578 op->o_callback = &cb;
2579 Debug( pcache_debug, "pc_setpw: CACHING BIND for %s\n",
2580 op->o_req_dn.bv_val, 0, 0 );
2581 rc = op->o_bd->be_modify( op, &sr );
2582 ch_free( vals[0].bv_val );
2587 typedef struct bindcacheinfo {
2593 pc_bind_save( Operation *op, SlapReply *rs )
2595 if ( rs->sr_err == LDAP_SUCCESS ) {
2596 bindcacheinfo *bci = op->o_callback->sc_private;
2597 slap_overinst *on = bci->on;
2598 cache_manager *cm = on->on_bi.bi_private;
2600 Operation op2 = *op;
2601 if ( pc_setpw( &op2, &op->orb_cred, cm ) == LDAP_SUCCESS )
2602 bci->qc->bindref_time = op->o_time + bci->qc->qtemp->bindttr;
2604 return SLAP_CB_CONTINUE;
2608 pc_bind_attrs( Operation *op, Entry *e, QueryTemplate *temp,
2609 struct berval *fbv )
2612 struct berval *vals, pres = BER_BVC("*");
2616 vals = op->o_tmpalloc( temp->bindnattrs * sizeof( struct berval ),
2619 for ( i=0; i<temp->bindnattrs; i++ ) {
2620 a = attr_find( e->e_attrs, temp->bindfattrs[i] );
2621 if ( a && a->a_vals ) {
2622 vals[i] = a->a_vals[0];
2623 len += a->a_vals[0].bv_len;
2628 fbv->bv_len = len + temp->bindftemp.bv_len;
2629 fbv->bv_val = op->o_tmpalloc( fbv->bv_len + 1, op->o_tmpmemctx );
2631 p1 = temp->bindftemp.bv_val;
2636 if ( p1[0] == '=' && p1[1] == ')' ) {
2637 AC_MEMCPY( p2, vals[i].bv_val, vals[i].bv_len );
2638 p2 += vals[i].bv_len;
2644 op->o_tmpfree( vals, op->o_tmpmemctx );
2646 /* FIXME: are we sure str2filter_x can't fail?
2647 * caller needs to check */
2649 Filter *f = str2filter_x( op, fbv->bv_val );
2650 assert( f != NULL );
2655 /* Check if the requested entry is from the cache and has a valid
2656 * ttr and password hash
2659 pc_bind_search( Operation *op, SlapReply *rs )
2661 if ( rs->sr_type == REP_SEARCH ) {
2662 bindinfo *pbi = op->o_callback->sc_private;
2664 /* We only care if this is an already cached result and we're
2665 * below the refresh time, or we're offline.
2668 if (( pbi->bi_cm->cc_paused & PCACHE_CC_OFFLINE ) ||
2669 op->o_time < pbi->bi_cq->bindref_time ) {
2672 /* See if a recognized password is hashed here */
2673 a = attr_find( rs->sr_entry->e_attrs,
2674 slap_schema.si_ad_userPassword );
2675 if ( a && a->a_vals[0].bv_val[0] == '{' &&
2676 lutil_passwd_scheme( a->a_vals[0].bv_val ))
2677 pbi->bi_flags |= BI_HASHED;
2679 Debug( pcache_debug, "pc_bind_search: cache is stale, "
2680 "reftime: %ld, current time: %ld\n",
2681 pbi->bi_cq->bindref_time, op->o_time, 0 );
2683 } else if ( pbi->bi_si ) {
2684 /* This search result is going into the cache */
2688 filter_free( pbi->bi_si->query.filter );
2689 f = pc_bind_attrs( op, rs->sr_entry, pbi->bi_templ, &fbv );
2690 op->o_tmpfree( fbv.bv_val, op->o_tmpmemctx );
2691 pbi->bi_si->query.filter = filter_dup( f, NULL );
2692 filter_free_x( op, f, 1 );
2698 /* We always want pc_bind_search to run after the search handlers */
2700 pc_bind_resp( Operation *op, SlapReply *rs )
2702 bindinfo *pbi = op->o_callback->sc_private;
2703 if ( !( pbi->bi_flags & BI_DIDCB )) {
2704 slap_callback *sc = op->o_callback;
2705 while ( sc && sc->sc_response != pcache_response )
2708 sc = op->o_callback;
2709 pbi->bi_cb.sc_next = sc->sc_next;
2710 sc->sc_next = &pbi->bi_cb;
2711 pbi->bi_flags |= BI_DIDCB;
2713 return SLAP_CB_CONTINUE;
2716 #ifdef PCACHE_CONTROL_PRIVDB
2722 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
2723 cache_manager *cm = on->on_bi.bi_private;
2724 slap_callback *save_cb;
2727 /* skip if control is unset */
2728 if ( op->o_ctrlflag[ privDB_cid ] != SLAP_CONTROL_CRITICAL ) {
2729 return SLAP_CB_CONTINUE;
2732 /* The cache DB isn't open yet */
2733 if ( cm->defer_db_open ) {
2734 send_ldap_error( op, rs, LDAP_UNAVAILABLE,
2735 "pcachePrivDB: cacheDB not available" );
2739 /* FIXME: might be a little bit exaggerated... */
2740 if ( !be_isroot( op ) ) {
2741 save_cb = op->o_callback;
2742 op->o_callback = NULL;
2743 send_ldap_error( op, rs, LDAP_UNWILLING_TO_PERFORM,
2744 "pcachePrivDB: operation not allowed" );
2745 op->o_callback = save_cb;
2750 /* map tag to operation */
2751 type = slap_req2op( op->o_tag );
2752 if ( type != SLAP_OP_LAST ) {
2756 /* execute, if possible */
2757 func = &cm->db.be_bind;
2758 if ( func[ type ] != NULL ) {
2759 Operation op2 = *op;
2763 rc = func[ type ]( &op2, rs );
2764 if ( type == SLAP_OP_BIND && rc == LDAP_SUCCESS ) {
2765 op->o_conn->c_authz_cookie = cm->db.be_private;
2772 /* otherwise fall back to error */
2773 save_cb = op->o_callback;
2774 op->o_callback = NULL;
2775 send_ldap_error( op, rs, LDAP_UNWILLING_TO_PERFORM,
2776 "operation not supported with pcachePrivDB control" );
2777 op->o_callback = save_cb;
2781 #endif /* PCACHE_CONTROL_PRIVDB */
2788 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
2789 cache_manager *cm = on->on_bi.bi_private;
2790 QueryTemplate *temp;
2792 slap_callback cb = { 0 }, *sc;
2798 #ifdef PCACHE_CONTROL_PRIVDB
2799 if ( op->o_ctrlflag[ privDB_cid ] == SLAP_CONTROL_CRITICAL )
2800 return pcache_op_privdb( op, rs );
2801 #endif /* PCACHE_CONTROL_PRIVDB */
2803 /* Skip if we're not configured for Binds, or cache DB isn't open yet */
2804 if ( !cm->cache_binds || cm->defer_db_open )
2805 return SLAP_CB_CONTINUE;
2807 /* First find a matching template with Bind info */
2808 for ( temp=cm->qm->templates; temp; temp=temp->qmnext ) {
2809 if ( temp->bindttr && dnIsSuffix( &op->o_req_ndn, &temp->bindbase ))
2812 /* Didn't find a suitable template, just passthru */
2814 return SLAP_CB_CONTINUE;
2816 /* See if the entry is already locally cached. If so, we can
2817 * populate the query filter to retrieve the cached query. We
2818 * need to check the bindrefresh time in the query.
2821 op2.o_dn = op->o_bd->be_rootdn;
2822 op2.o_ndn = op->o_bd->be_rootndn;
2827 rc = be_entry_get_rw( &op2, &op->o_req_ndn, NULL, NULL, 0, &e );
2828 if ( rc == LDAP_SUCCESS && e ) {
2829 bi.bi_flags |= BI_LOOKUP;
2830 op2.ors_filter = pc_bind_attrs( op, e, temp, &op2.ors_filterstr );
2831 be_entry_release_r( &op2, e );
2833 op2.ors_filter = temp->bindfilter;
2834 op2.ors_filterstr = temp->bindfilterstr;
2837 op2.o_bd = op->o_bd;
2838 op2.o_tag = LDAP_REQ_SEARCH;
2839 op2.ors_scope = LDAP_SCOPE_BASE;
2840 op2.ors_deref = LDAP_DEREF_NEVER;
2842 op2.ors_tlimit = SLAP_NO_LIMIT;
2843 op2.ors_limit = NULL;
2844 op2.ors_attrs = cm->qm->attr_sets[temp->attr_set_index].attrs;
2845 op2.ors_attrsonly = 0;
2847 /* We want to invoke search at the same level of the stack
2848 * as we're already at...
2855 bi.bi_cb.sc_response = pc_bind_search;
2856 bi.bi_cb.sc_cleanup = NULL;
2857 bi.bi_cb.sc_private = &bi;
2858 cb.sc_private = &bi;
2859 cb.sc_response = pc_bind_resp;
2860 op2.o_callback = &cb;
2861 overlay_op_walk( &op2, rs, op_search, on->on_info, on );
2863 /* OK, just bind locally */
2864 if ( bi.bi_flags & BI_HASHED ) {
2865 BackendDB *be = op->o_bd;
2868 Debug( pcache_debug, "pcache_op_bind: CACHED BIND for %s\n",
2869 op->o_req_dn.bv_val, 0, 0 );
2871 if ( op->o_bd->be_bind( op, rs ) == LDAP_SUCCESS ) {
2872 op->o_conn->c_authz_cookie = cm->db.be_private;
2878 /* We have a cached query to work with */
2880 sc = op->o_tmpalloc( sizeof(slap_callback) + sizeof(bindcacheinfo),
2882 sc->sc_response = pc_bind_save;
2883 sc->sc_cleanup = NULL;
2884 sc->sc_private = sc+1;
2885 bci = sc->sc_private;
2886 sc->sc_next = op->o_callback;
2887 op->o_callback = sc;
2891 return SLAP_CB_CONTINUE;
2899 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
2900 cache_manager *cm = on->on_bi.bi_private;
2901 query_manager* qm = cm->qm;
2906 QueryTemplate *qtemp = NULL;
2907 bindinfo *pbi = NULL;
2910 CachedQuery *answerable = NULL;
2913 struct berval tempstr;
2915 #ifdef PCACHE_CONTROL_PRIVDB
2916 if ( op->o_ctrlflag[ privDB_cid ] == SLAP_CONTROL_CRITICAL ) {
2917 return pcache_op_privdb( op, rs );
2919 #endif /* PCACHE_CONTROL_PRIVDB */
2921 /* The cache DB isn't open yet */
2922 if ( cm->defer_db_open ) {
2923 send_ldap_error( op, rs, LDAP_UNAVAILABLE,
2924 "pcachePrivDB: cacheDB not available" );
2928 /* pickup runtime ACL changes */
2929 cm->db.be_acl = op->o_bd->be_acl;
2932 /* See if we're processing a Bind request */
2933 slap_callback *cb = op->o_callback;
2935 for ( ; cb; cb=cb->sc_next ) {
2936 if ( cb->sc_response == pc_bind_resp ) {
2937 pbi = cb->sc_private;
2943 /* FIXME: cannot cache/answer requests with pagedResults control */
2945 query.filter = op->ors_filter;
2948 query.base = pbi->bi_templ->bindbase;
2949 query.scope = pbi->bi_templ->bindscope;
2950 attr_set = pbi->bi_templ->attr_set_index;
2952 qtemp = pbi->bi_templ;
2953 if ( pbi->bi_flags & BI_LOOKUP )
2954 answerable = qm->qcfunc(op, qm, &query, qtemp);
2957 tempstr.bv_val = op->o_tmpalloc( op->ors_filterstr.bv_len+1,
2960 if ( filter2template( op, op->ors_filter, &tempstr ))
2962 op->o_tmpfree( tempstr.bv_val, op->o_tmpmemctx );
2963 return SLAP_CB_CONTINUE;
2966 Debug( pcache_debug, "query template of incoming query = %s\n",
2967 tempstr.bv_val, 0, 0 );
2970 attr_set = get_attr_set(op->ors_attrs, qm, cm->numattrsets);
2972 query.base = op->o_req_ndn;
2973 query.scope = op->ors_scope;
2975 /* check for query containment */
2976 if (attr_set > -1) {
2977 QueryTemplate *qt = qm->attr_sets[attr_set].templates;
2978 for (; qt; qt = qt->qtnext ) {
2979 /* find if template i can potentially answer tempstr */
2980 if ( ber_bvstrcasecmp( &qt->querystr, &tempstr ) != 0 )
2984 Debug( pcache_debug, "Entering QC, querystr = %s\n",
2985 op->ors_filterstr.bv_val, 0, 0 );
2986 answerable = qm->qcfunc(op, qm, &query, qt);
2988 /* if != NULL, rlocks qtemp->t_rwlock */
2993 op->o_tmpfree( tempstr.bv_val, op->o_tmpmemctx );
2997 BackendDB *save_bd = op->o_bd;
2999 ldap_pvt_thread_mutex_lock( &answerable->answerable_cnt_mutex );
3000 answerable->answerable_cnt++;
3001 /* we only care about refcnts if we're refreshing */
3002 if ( answerable->refresh_time )
3003 answerable->refcnt++;
3004 Debug( pcache_debug, "QUERY ANSWERABLE (answered %lu times)\n",
3005 answerable->answerable_cnt, 0, 0 );
3006 ldap_pvt_thread_mutex_unlock( &answerable->answerable_cnt_mutex );
3008 ldap_pvt_thread_rdwr_rlock(&answerable->rwlock);
3009 if ( BER_BVISNULL( &answerable->q_uuid )) {
3010 /* No entries cached, just an empty result set */
3012 send_ldap_result( op, rs );
3014 /* Let Bind know we used a cached query */
3016 pbi->bi_cq = answerable;
3019 if ( cm->response_cb == PCACHE_RESPONSE_CB_TAIL ) {
3021 /* The cached entry was already processed by any
3022 * other overlays, so don't let it get processed again.
3024 * This loop removes over_back_response from the stack.
3026 if ( overlay_callback_after_backover( op, &cb, 0) == 0 ) {
3027 slap_callback **scp;
3028 for ( scp = &op->o_callback; *scp != NULL;
3029 scp = &(*scp)->sc_next ) {
3030 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[i].an_name.bv_val; i++ ) {
3126 /* only count valid attribute names
3127 * (searches ignore others, this overlay does the same) */
3128 if ( attrs[i].an_desc ) {
3134 /* recognize default or explicit single "*" */
3136 ( i == 1 && bvmatch( &attrs[0].an_name, slap_bv_all_user_attrs ) ) )
3139 attrs = slap_anlist_all_user_attributes;
3141 /* recognize implicit (no valid attributes) or explicit single "1.1" */
3142 } else if ( count == 0 ||
3143 ( i == 1 && bvmatch( &attrs[0].an_name, slap_bv_no_attrs ) ) )
3149 for ( i = 0; i < num; i++ ) {
3153 if ( count > qm->attr_sets[i].count ) {
3158 if ( !qm->attr_sets[i].count ) {
3164 for ( a2 = attrs; a2->an_name.bv_val; a2++ ) {
3165 if ( !a2->an_desc && !bvmatch( &a2->an_name, slap_bv_all_user_attrs ) ) continue;
3167 if ( !an_find( qm->attr_sets[i].attrs, &a2->an_name ) ) {
3185 /* Refresh a cached query:
3186 * 1: Replay the query on the remote DB and merge each entry into
3187 * the local DB. Remember the DNs of each remote entry.
3188 * 2: Search the local DB for all entries matching this queryID.
3189 * Delete any entry whose DN is not in the list from (1).
3191 typedef struct dnlist {
3192 struct dnlist *next;
3197 typedef struct refresh_info {
3205 static dnlist *dnl_alloc( Operation *op, struct berval *bvdn )
3207 dnlist *dn = op->o_tmpalloc( sizeof(dnlist) + bvdn->bv_len + 1,
3209 dn->dn.bv_len = bvdn->bv_len;
3210 dn->dn.bv_val = (char *)(dn+1);
3211 AC_MEMCPY( dn->dn.bv_val, bvdn->bv_val, dn->dn.bv_len );
3212 dn->dn.bv_val[dn->dn.bv_len] = '\0';
3217 refresh_merge( Operation *op, SlapReply *rs )
3219 if ( rs->sr_type == REP_SEARCH ) {
3220 refresh_info *ri = op->o_callback->sc_private;
3226 ocb = op->o_callback;
3227 /* Find local entry, merge */
3228 op->o_bd = ri->ri_be;
3229 rc = be_entry_get_rw( op, &rs->sr_entry->e_nname, NULL, NULL, 0, &e );
3230 if ( rc != LDAP_SUCCESS || e == NULL ) {
3231 /* No local entry, just add it. FIXME: we are not checking
3232 * the cache entry limit here
3234 merge_entry( op, rs->sr_entry, 1, &ri->ri_q->q_uuid );
3236 /* Entry exists, update it */
3239 Modifications *modlist, *mods = NULL;
3240 const char* text = NULL;
3241 char textbuf[SLAP_TEXT_BUFLEN];
3242 size_t textlen = sizeof(textbuf);
3243 slap_callback cb = { NULL, slap_null_cb, NULL, NULL };
3247 /* Get a copy of only the attrs we requested */
3248 for ( a=e->e_attrs; a; a=a->a_next ) {
3249 if ( ad_inlist( a->a_desc, rs->sr_attrs )) {
3250 *b = attr_alloc( a->a_desc );
3252 /* The actual values still belong to e */
3253 (*b)->a_flags |= SLAP_ATTR_DONT_FREE_VALS |
3254 SLAP_ATTR_DONT_FREE_DATA;
3255 b = &((*b)->a_next);
3259 slap_entry2mods( rs->sr_entry, &modlist, &text, textbuf, textlen );
3260 syncrepl_diff_entry( op, ne.e_attrs, rs->sr_entry->e_attrs,
3261 &mods, &modlist, 0 );
3262 be_entry_release_r( op, e );
3263 attrs_free( ne.e_attrs );
3264 slap_mods_free( modlist, 1 );
3265 /* mods is NULL if there are no changes */
3267 SlapReply rs2 = { REP_RESULT };
3268 struct berval dn = op->o_req_dn;
3269 struct berval ndn = op->o_req_ndn;
3270 op->o_tag = LDAP_REQ_MODIFY;
3271 op->orm_modlist = mods;
3272 op->o_req_dn = rs->sr_entry->e_name;
3273 op->o_req_ndn = rs->sr_entry->e_nname;
3274 op->o_callback = &cb;
3275 op->o_bd->be_modify( op, &rs2 );
3276 rs->sr_err = rs2.sr_err;
3277 rs_assert_done( &rs2 );
3278 slap_mods_free( mods, 1 );
3280 op->o_req_ndn = ndn;
3284 /* Add DN to list */
3285 dnl = dnl_alloc( op, &rs->sr_entry->e_nname );
3287 if ( ri->ri_tail ) {
3288 ri->ri_tail->next = dnl;
3293 op->o_callback = ocb;
3299 refresh_purge( Operation *op, SlapReply *rs )
3301 if ( rs->sr_type == REP_SEARCH ) {
3302 refresh_info *ri = op->o_callback->sc_private;
3306 /* Did the entry exist on the remote? */
3307 for ( dn=&ri->ri_dns; *dn; dn = &(*dn)->next ) {
3308 if ( dn_match( &(*dn)->dn, &rs->sr_entry->e_nname )) {
3309 dnlist *dnext = (*dn)->next;
3310 op->o_tmpfree( *dn, op->o_tmpmemctx );
3316 /* No, so put it on the list to delete */
3319 dnlist *dnl = dnl_alloc( op, &rs->sr_entry->e_nname );
3320 dnl->next = ri->ri_dels;
3322 a = attr_find( rs->sr_entry->e_attrs, ad_queryId );
3323 /* If ours is the only queryId, delete entry */
3324 dnl->delete = ( a->a_numvals == 1 );
3331 refresh_query( Operation *op, CachedQuery *query, slap_overinst *on )
3333 SlapReply rs = {REP_RESULT};
3334 slap_callback cb = { 0 };
3335 refresh_info ri = { 0 };
3336 char filter_str[ LDAP_LUTIL_UUIDSTR_BUFSIZE + STRLENOF( "(pcacheQueryID=)" ) ];
3337 AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
3338 Filter filter = {LDAP_FILTER_EQUALITY};
3339 AttributeName attrs[ 2 ] = {{{ 0 }}};
3343 ldap_pvt_thread_mutex_lock( &query->answerable_cnt_mutex );
3345 ldap_pvt_thread_mutex_unlock( &query->answerable_cnt_mutex );
3347 cb.sc_response = refresh_merge;
3348 cb.sc_private = &ri;
3351 ri.ri_be = op->o_bd;
3354 op->o_tag = LDAP_REQ_SEARCH;
3355 op->o_protocol = LDAP_VERSION3;
3356 op->o_callback = &cb;
3357 op->o_do_not_cache = 1;
3359 op->o_req_dn = query->qbase->base;
3360 op->o_req_ndn = query->qbase->base;
3361 op->ors_scope = query->scope;
3362 op->ors_slimit = SLAP_NO_LIMIT;
3363 op->ors_tlimit = SLAP_NO_LIMIT;
3364 op->ors_limit = NULL;
3365 op->ors_filter = query->filter;
3366 filter2bv_x( op, query->filter, &op->ors_filterstr );
3367 op->ors_attrs = query->qtemp->t_attrs.attrs;
3368 op->ors_attrsonly = 0;
3370 op->o_bd = on->on_info->oi_origdb;
3371 rc = op->o_bd->be_search( op, &rs );
3373 op->o_bd = ri.ri_be;
3377 /* Get the DNs of all entries matching this query */
3378 cb.sc_response = refresh_purge;
3380 op->o_bd = ri.ri_be;
3381 op->o_req_dn = op->o_bd->be_suffix[0];
3382 op->o_req_ndn = op->o_bd->be_nsuffix[0];
3383 op->ors_scope = LDAP_SCOPE_SUBTREE;
3384 op->ors_deref = LDAP_DEREF_NEVER;
3385 op->ors_filterstr.bv_len = snprintf(filter_str, sizeof(filter_str),
3386 "(%s=%s)", ad_queryId->ad_cname.bv_val, query->q_uuid.bv_val);
3387 filter.f_ava = &ava;
3388 filter.f_av_desc = ad_queryId;
3389 filter.f_av_value = query->q_uuid;
3390 attrs[ 0 ].an_desc = ad_queryId;
3391 attrs[ 0 ].an_name = ad_queryId->ad_cname;
3392 op->ors_attrs = attrs;
3393 op->ors_attrsonly = 0;
3394 rs_reinit( &rs, REP_RESULT );
3395 rc = op->o_bd->be_search( op, &rs );
3396 if ( rc ) goto leave;
3398 while (( dn = ri.ri_dels )) {
3399 op->o_req_dn = dn->dn;
3400 op->o_req_ndn = dn->dn;
3401 rs_reinit( &rs, REP_RESULT );
3403 op->o_tag = LDAP_REQ_DELETE;
3404 op->o_bd->be_delete( op, &rs );
3407 struct berval vals[2];
3409 vals[0] = query->q_uuid;
3410 BER_BVZERO( &vals[1] );
3411 mod.sml_op = LDAP_MOD_DELETE;
3413 mod.sml_desc = ad_queryId;
3414 mod.sml_type = ad_queryId->ad_cname;
3415 mod.sml_values = vals;
3416 mod.sml_nvalues = NULL;
3417 mod.sml_numvals = 1;
3418 mod.sml_next = NULL;
3420 op->o_tag = LDAP_REQ_MODIFY;
3421 op->orm_modlist = &mod;
3422 op->o_bd->be_modify( op, &rs );
3424 ri.ri_dels = dn->next;
3425 op->o_tmpfree( dn, op->o_tmpmemctx );
3429 /* reset our local heap, we're done with it */
3430 slap_sl_mem_create(SLAP_SLAB_SIZE, SLAP_SLAB_STACK, op->o_threadctx, 1 );
3439 struct re_s *rtask = arg;
3440 slap_overinst *on = rtask->arg;
3441 cache_manager *cm = on->on_bi.bi_private;
3442 query_manager *qm = cm->qm;
3443 Connection conn = {0};
3444 OperationBuffer opbuf;
3447 CachedQuery *query, *qprev;
3448 int return_val, pause = PCACHE_CC_PAUSED;
3449 QueryTemplate *templ;
3451 /* Don't expire anything when we're offline */
3452 if ( cm->cc_paused & PCACHE_CC_OFFLINE ) {
3453 pause = PCACHE_CC_OFFLINE;
3457 connection_fake_init( &conn, &opbuf, ctx );
3461 op->o_dn = cm->db.be_rootdn;
3462 op->o_ndn = cm->db.be_rootndn;
3466 for (templ = qm->templates; templ; templ=templ->qmnext) {
3468 if ( !templ->query_last ) continue;
3470 op->o_time = slap_get_time();
3471 if ( !templ->ttr ) {
3473 if ( templ->negttl && templ->negttl < ttl )
3474 ttl = templ->negttl;
3475 if ( templ->limitttl && templ->limitttl < ttl )
3476 ttl = templ->limitttl;
3477 /* The oldest timestamp that needs expiration checking */
3481 for ( query=templ->query_last; query; query=qprev ) {
3482 qprev = query->prev;
3483 if ( query->refresh_time && query->refresh_time < op->o_time ) {
3484 /* A refresh will extend the expiry if the query has been
3485 * referenced, but not if it's unreferenced. If the
3486 * expiration has been hit, then skip the refresh since
3487 * we're just going to discard the result anyway.
3489 if ( query->refcnt )
3490 query->expiry_time = op->o_time + templ->ttl;
3491 if ( query->expiry_time > op->o_time ) {
3492 refresh_query( op, query, on );
3497 if (query->expiry_time < op->o_time) {
3499 Debug( pcache_debug, "Lock CR index = %p\n",
3500 (void *) templ, 0, 0 );
3501 ldap_pvt_thread_rdwr_wlock(&templ->t_rwlock);
3502 if ( query == templ->query_last ) {
3504 remove_from_template(query, templ);
3505 Debug( pcache_debug, "TEMPLATE %p QUERIES-- %d\n",
3506 (void *) templ, templ->no_of_queries, 0 );
3507 Debug( pcache_debug, "Unlock CR index = %p\n",
3508 (void *) templ, 0, 0 );
3510 ldap_pvt_thread_rdwr_wunlock(&templ->t_rwlock);
3514 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
3515 remove_query(qm, query);
3516 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
3517 if ( BER_BVISNULL( &query->q_uuid ))
3520 return_val = remove_query_data(op, &query->q_uuid);
3521 Debug( pcache_debug, "STALE QUERY REMOVED, SIZE=%d\n",
3523 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
3524 cm->cur_entries -= return_val;
3525 cm->num_cached_queries--;
3526 Debug( pcache_debug, "STORED QUERIES = %lu\n",
3527 cm->num_cached_queries, 0, 0 );
3528 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
3529 Debug( pcache_debug,
3530 "STALE QUERY REMOVED, CACHE ="
3532 cm->cur_entries, 0, 0 );
3534 } else if ( !templ->ttr && query->expiry_time > ttl ) {
3535 /* We don't need to check for refreshes, and this
3536 * query's expiry is too new, and all subsequent queries
3537 * will be newer yet. So stop looking.
3539 * If we have refreshes, then we always have to walk the
3540 * entire query list.
3548 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
3549 if ( ldap_pvt_runqueue_isrunning( &slapd_rq, rtask )) {
3550 ldap_pvt_runqueue_stoptask( &slapd_rq, rtask );
3552 /* If there were no queries, defer processing for a while */
3553 if ( cm->cc_paused != pause )
3554 cm->cc_paused = pause;
3555 ldap_pvt_runqueue_resched( &slapd_rq, rtask, pause );
3557 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
3562 #define MAX_ATTR_SETS 500
3575 static ConfigDriver pc_cf_gen;
3576 static ConfigLDAPadd pc_ldadd;
3577 static ConfigCfAdd pc_cfadd;
3579 static ConfigTable pccfg[] = {
3580 { "pcache", "backend> <max_entries> <numattrsets> <entry limit> "
3582 6, 6, 0, ARG_MAGIC|ARG_NO_DELETE|PC_MAIN, pc_cf_gen,
3583 "( OLcfgOvAt:2.1 NAME ( 'olcPcache' 'olcProxyCache' ) "
3584 "DESC 'Proxy Cache basic parameters' "
3585 "SYNTAX OMsDirectoryString SINGLE-VALUE )", NULL, NULL },
3586 { "pcacheAttrset", "index> <attributes...",
3587 2, 0, 0, ARG_MAGIC|PC_ATTR, pc_cf_gen,
3588 "( OLcfgOvAt:2.2 NAME ( 'olcPcacheAttrset' 'olcProxyAttrset' ) "
3589 "DESC 'A set of attributes to cache' "
3590 "SYNTAX OMsDirectoryString )", NULL, NULL },
3591 { "pcacheTemplate", "filter> <attrset-index> <TTL> <negTTL> "
3593 4, 7, 0, ARG_MAGIC|PC_TEMP, pc_cf_gen,
3594 "( OLcfgOvAt:2.3 NAME ( 'olcPcacheTemplate' 'olcProxyCacheTemplate' ) "
3595 "DESC 'Filter template, attrset, cache TTL, "
3596 "optional negative TTL, optional sizelimit TTL, "
3598 "SYNTAX OMsDirectoryString )", NULL, NULL },
3599 { "pcachePosition", "head|tail(default)",
3600 2, 2, 0, ARG_MAGIC|PC_RESP, pc_cf_gen,
3601 "( OLcfgOvAt:2.4 NAME 'olcPcachePosition' "
3602 "DESC 'Response callback position in overlay stack' "
3603 "SYNTAX OMsDirectoryString )", NULL, NULL },
3604 { "pcacheMaxQueries", "queries",
3605 2, 2, 0, ARG_INT|ARG_MAGIC|PC_QUERIES, pc_cf_gen,
3606 "( OLcfgOvAt:2.5 NAME ( 'olcPcacheMaxQueries' 'olcProxyCacheQueries' ) "
3607 "DESC 'Maximum number of queries to cache' "
3608 "SYNTAX OMsInteger )", NULL, NULL },
3609 { "pcachePersist", "TRUE|FALSE",
3610 2, 2, 0, ARG_ON_OFF|ARG_OFFSET, (void *)offsetof(cache_manager, save_queries),
3611 "( OLcfgOvAt:2.6 NAME ( 'olcPcachePersist' 'olcProxySaveQueries' ) "
3612 "DESC 'Save cached queries for hot restart' "
3613 "SYNTAX OMsBoolean )", NULL, NULL },
3614 { "pcacheValidate", "TRUE|FALSE",
3615 2, 2, 0, ARG_ON_OFF|ARG_OFFSET, (void *)offsetof(cache_manager, check_cacheability),
3616 "( OLcfgOvAt:2.7 NAME ( 'olcPcacheValidate' 'olcProxyCheckCacheability' ) "
3617 "DESC 'Check whether the results of a query are cacheable, e.g. for schema issues' "
3618 "SYNTAX OMsBoolean )", NULL, NULL },
3619 { "pcacheOffline", "TRUE|FALSE",
3620 2, 2, 0, ARG_ON_OFF|ARG_MAGIC|PC_OFFLINE, pc_cf_gen,
3621 "( OLcfgOvAt:2.8 NAME 'olcPcacheOffline' "
3622 "DESC 'Set cache to offline mode and disable expiration' "
3623 "SYNTAX OMsBoolean )", NULL, NULL },
3624 { "pcacheBind", "filter> <attrset-index> <TTR> <scope> <base",
3625 6, 6, 0, ARG_MAGIC|PC_BIND, pc_cf_gen,
3626 "( OLcfgOvAt:2.9 NAME 'olcPcacheBind' "
3627 "DESC 'Parameters for caching Binds' "
3628 "SYNTAX OMsDirectoryString )", NULL, NULL },
3629 { "pcache-", "private database args",
3630 1, 0, STRLENOF("pcache-"), ARG_MAGIC|PC_PRIVATE_DB, pc_cf_gen,
3633 /* Legacy keywords */
3634 { "proxycache", "backend> <max_entries> <numattrsets> <entry limit> "
3636 6, 6, 0, ARG_MAGIC|ARG_NO_DELETE|PC_MAIN, pc_cf_gen,
3638 { "proxyattrset", "index> <attributes...",
3639 2, 0, 0, ARG_MAGIC|PC_ATTR, pc_cf_gen,
3641 { "proxytemplate", "filter> <attrset-index> <TTL> <negTTL",
3642 4, 7, 0, ARG_MAGIC|PC_TEMP, pc_cf_gen,
3644 { "response-callback", "head|tail(default)",
3645 2, 2, 0, ARG_MAGIC|PC_RESP, pc_cf_gen,
3647 { "proxyCacheQueries", "queries",
3648 2, 2, 0, ARG_INT|ARG_MAGIC|PC_QUERIES, pc_cf_gen,
3650 { "proxySaveQueries", "TRUE|FALSE",
3651 2, 2, 0, ARG_ON_OFF|ARG_OFFSET, (void *)offsetof(cache_manager, save_queries),
3653 { "proxyCheckCacheability", "TRUE|FALSE",
3654 2, 2, 0, ARG_ON_OFF|ARG_OFFSET, (void *)offsetof(cache_manager, check_cacheability),
3657 { NULL, NULL, 0, 0, 0, ARG_IGNORED }
3660 static ConfigOCs pcocs[] = {
3661 { "( OLcfgOvOc:2.1 "
3662 "NAME 'olcPcacheConfig' "
3663 "DESC 'ProxyCache configuration' "
3664 "SUP olcOverlayConfig "
3665 "MUST ( olcPcache $ olcPcacheAttrset $ olcPcacheTemplate ) "
3666 "MAY ( olcPcachePosition $ olcPcacheMaxQueries $ olcPcachePersist $ "
3667 "olcPcacheValidate $ olcPcacheOffline $ olcPcacheBind ) )",
3668 Cft_Overlay, pccfg, NULL, pc_cfadd },
3669 { "( OLcfgOvOc:2.2 "
3670 "NAME 'olcPcacheDatabase' "
3671 "DESC 'Cache database configuration' "
3672 "AUXILIARY )", Cft_Misc, olcDatabaseDummy, pc_ldadd },
3676 static int pcache_db_open2( slap_overinst *on, ConfigReply *cr );
3679 pc_ldadd_cleanup( ConfigArgs *c )
3681 slap_overinst *on = c->ca_private;
3682 return pcache_db_open2( on, &c->reply );
3686 pc_ldadd( CfEntryInfo *p, Entry *e, ConfigArgs *ca )
3691 if ( p->ce_type != Cft_Overlay || !p->ce_bi ||
3692 p->ce_bi->bi_cf_ocs != pcocs )
3693 return LDAP_CONSTRAINT_VIOLATION;
3695 on = (slap_overinst *)p->ce_bi;
3696 cm = on->on_bi.bi_private;
3698 /* Defer open if this is an LDAPadd */
3699 if ( CONFIG_ONLINE_ADD( ca ))
3700 ca->cleanup = pc_ldadd_cleanup;
3702 cm->defer_db_open = 0;
3703 ca->ca_private = on;
3704 return LDAP_SUCCESS;
3708 pc_cfadd( Operation *op, SlapReply *rs, Entry *p, ConfigArgs *ca )
3710 CfEntryInfo *pe = p->e_private;
3711 slap_overinst *on = (slap_overinst *)pe->ce_bi;
3712 cache_manager *cm = on->on_bi.bi_private;
3715 /* FIXME: should not hardcode "olcDatabase" here */
3716 bv.bv_len = snprintf( ca->cr_msg, sizeof( ca->cr_msg ),
3717 "olcDatabase=" SLAP_X_ORDERED_FMT "%s",
3718 0, cm->db.bd_info->bi_type );
3719 if ( bv.bv_len >= sizeof( ca->cr_msg ) ) {
3722 bv.bv_val = ca->cr_msg;
3724 cm->defer_db_open = 0;
3726 /* We can only create this entry if the database is table-driven
3728 if ( cm->db.bd_info->bi_cf_ocs )
3729 config_build_entry( op, rs, pe, ca, &bv, cm->db.bd_info->bi_cf_ocs,
3736 pc_cf_gen( ConfigArgs *c )
3738 slap_overinst *on = (slap_overinst *)c->bi;
3739 cache_manager* cm = on->on_bi.bi_private;
3740 query_manager* qm = cm->qm;
3741 QueryTemplate* temp;
3742 AttributeName* attr_name;
3743 AttributeName* attrarray;
3744 const char* text=NULL;
3749 if ( c->op == SLAP_CONFIG_EMIT ) {
3753 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ), "%s %d %d %d %ld",
3754 cm->db.bd_info->bi_type, cm->max_entries, cm->numattrsets,
3755 cm->num_entries_limit, cm->cc_period );
3756 bv.bv_val = c->cr_msg;
3757 value_add_one( &c->rvalue_vals, &bv );
3760 for (i=0; i<cm->numattrsets; i++) {
3761 if ( !qm->attr_sets[i].count ) continue;
3763 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ), "%d", i );
3765 /* count the attr length */
3766 for ( attr_name = qm->attr_sets[i].attrs;
3767 attr_name->an_name.bv_val; attr_name++ )
3769 bv.bv_len += attr_name->an_name.bv_len + 1;
3770 if ( attr_name->an_desc->ad_flags & SLAP_DESC_TEMPORARY ) {
3771 bv.bv_len += STRLENOF("undef:");
3775 bv.bv_val = ch_malloc( bv.bv_len+1 );
3776 ptr = lutil_strcopy( bv.bv_val, c->cr_msg );
3777 for ( attr_name = qm->attr_sets[i].attrs;
3778 attr_name->an_name.bv_val; attr_name++ ) {
3780 if ( attr_name->an_desc->ad_flags & SLAP_DESC_TEMPORARY ) {
3781 ptr = lutil_strcopy( ptr, "undef:" );
3783 ptr = lutil_strcopy( ptr, attr_name->an_name.bv_val );
3785 ber_bvarray_add( &c->rvalue_vals, &bv );
3787 if ( !c->rvalue_vals )
3791 for (temp=qm->templates; temp; temp=temp->qmnext) {
3792 /* HEADS-UP: always print all;
3793 * if optional == 0, ignore */
3794 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ),
3795 " %d %ld %ld %ld %ld",
3796 temp->attr_set_index,
3801 bv.bv_len += temp->querystr.bv_len + 2;
3802 bv.bv_val = ch_malloc( bv.bv_len+1 );
3805 ptr = lutil_strcopy( ptr, temp->querystr.bv_val );
3807 strcpy( ptr, c->cr_msg );
3808 ber_bvarray_add( &c->rvalue_vals, &bv );
3810 if ( !c->rvalue_vals )
3814 for (temp=qm->templates; temp; temp=temp->qmnext) {
3815 if ( !temp->bindttr ) continue;
3816 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ),
3818 temp->attr_set_index,
3820 ldap_pvt_scope2str( temp->bindscope ));
3821 bv.bv_len += temp->bindbase.bv_len + temp->bindftemp.bv_len + 4;
3822 bv.bv_val = ch_malloc( bv.bv_len + 1 );
3825 ptr = lutil_strcopy( ptr, temp->bindftemp.bv_val );
3827 ptr = lutil_strcopy( ptr, c->cr_msg );
3829 ptr = lutil_strcopy( ptr, temp->bindbase.bv_val );
3832 ber_bvarray_add( &c->rvalue_vals, &bv );
3834 if ( !c->rvalue_vals )
3838 if ( cm->response_cb == PCACHE_RESPONSE_CB_HEAD ) {
3839 BER_BVSTR( &bv, "head" );
3841 BER_BVSTR( &bv, "tail" );
3843 value_add_one( &c->rvalue_vals, &bv );
3846 c->value_int = cm->max_queries;
3849 c->value_int = (cm->cc_paused & PCACHE_CC_OFFLINE) != 0;
3853 } else if ( c->op == LDAP_MOD_DELETE ) {
3856 case PC_ATTR: /* FIXME */
3861 cm->cc_paused &= ~PCACHE_CC_OFFLINE;
3862 /* If there were cached queries when we went offline,
3863 * restart the checker now.
3865 if ( cm->num_cached_queries ) {
3866 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
3868 ldap_pvt_runqueue_resched( &slapd_rq, cm->cc_arg, 0 );
3869 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
3879 if ( cm->numattrsets > 0 ) {
3880 snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"pcache\" directive already provided" );
3881 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3885 if ( lutil_atoi( &cm->numattrsets, c->argv[3] ) != 0 ) {
3886 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse num attrsets=\"%s\" (arg #3)",
3888 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3891 if ( cm->numattrsets <= 0 ) {
3892 snprintf( c->cr_msg, sizeof( c->cr_msg ), "numattrsets (arg #3) must be positive" );
3893 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3896 if ( cm->numattrsets > MAX_ATTR_SETS ) {
3897 snprintf( c->cr_msg, sizeof( c->cr_msg ), "numattrsets (arg #3) must be <= %d", MAX_ATTR_SETS );
3898 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3902 if ( !backend_db_init( c->argv[1], &cm->db, -1, NULL )) {
3903 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unknown backend type (arg #1)" );
3904 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3908 if ( lutil_atoi( &cm->max_entries, c->argv[2] ) != 0 ) {
3909 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse max entries=\"%s\" (arg #2)",
3911 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3914 if ( cm->max_entries <= 0 ) {
3915 snprintf( c->cr_msg, sizeof( c->cr_msg ), "max entries (arg #2) must be positive.\n" );
3916 Debug( LDAP_DEBUG_CONFIG, "%s: %s\n", c->log, c->cr_msg, 0 );
3920 if ( lutil_atoi( &cm->num_entries_limit, c->argv[4] ) != 0 ) {
3921 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse entry limit=\"%s\" (arg #4)",
3923 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3926 if ( cm->num_entries_limit <= 0 ) {
3927 snprintf( c->cr_msg, sizeof( c->cr_msg ), "entry limit (arg #4) must be positive" );
3928 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3931 if ( cm->num_entries_limit > cm->max_entries ) {
3932 snprintf( c->cr_msg, sizeof( c->cr_msg ), "entry limit (arg #4) must be less than max entries %d (arg #2)", cm->max_entries );
3933 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3937 if ( lutil_parse_time( c->argv[5], &t ) != 0 ) {
3938 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse period=\"%s\" (arg #5)",
3940 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3944 cm->cc_period = (time_t)t;
3945 Debug( pcache_debug,
3946 "Total # of attribute sets to be cached = %d.\n",
3947 cm->numattrsets, 0, 0 );
3948 qm->attr_sets = ( struct attr_set * )ch_calloc( cm->numattrsets,
3949 sizeof( struct attr_set ) );
3952 if ( cm->numattrsets == 0 ) {
3953 snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"pcache\" directive not provided yet" );
3954 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3957 if ( lutil_atoi( &num, c->argv[1] ) != 0 ) {
3958 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse attrset #=\"%s\"",
3960 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3964 if ( num < 0 || num >= cm->numattrsets ) {
3965 snprintf( c->cr_msg, sizeof( c->cr_msg ), "attrset index %d out of bounds (must be %s%d)",
3966 num, cm->numattrsets > 1 ? "0->" : "", cm->numattrsets - 1 );
3967 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3970 qm->attr_sets[num].flags |= PC_CONFIGURED;
3971 if ( c->argc == 2 ) {
3973 snprintf( c->cr_msg, sizeof( c->cr_msg ),
3974 "need an explicit attr in attrlist; use \"*\" to indicate all attrs" );
3975 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3978 } else if ( c->argc == 3 ) {
3979 if ( strcmp( c->argv[2], LDAP_ALL_USER_ATTRIBUTES ) == 0 ) {
3980 qm->attr_sets[num].count = 1;
3981 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( 2,
3982 sizeof( AttributeName ) );
3983 BER_BVSTR( &qm->attr_sets[num].attrs[0].an_name, LDAP_ALL_USER_ATTRIBUTES );
3986 } else if ( strcmp( c->argv[2], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 ) {
3987 qm->attr_sets[num].count = 1;
3988 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( 2,
3989 sizeof( AttributeName ) );
3990 BER_BVSTR( &qm->attr_sets[num].attrs[0].an_name, LDAP_ALL_OPERATIONAL_ATTRIBUTES );
3993 } else if ( strcmp( c->argv[2], LDAP_NO_ATTRS ) == 0 ) {
3996 /* else: fallthru */
3998 } else if ( c->argc == 4 ) {
3999 if ( ( strcmp( c->argv[2], LDAP_ALL_USER_ATTRIBUTES ) == 0 && strcmp( c->argv[3], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 )
4000 || ( strcmp( c->argv[2], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 && strcmp( c->argv[3], LDAP_ALL_USER_ATTRIBUTES ) == 0 ) )
4002 qm->attr_sets[num].count = 2;
4003 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( 3,
4004 sizeof( AttributeName ) );
4005 BER_BVSTR( &qm->attr_sets[num].attrs[0].an_name, LDAP_ALL_USER_ATTRIBUTES );
4006 BER_BVSTR( &qm->attr_sets[num].attrs[1].an_name, LDAP_ALL_OPERATIONAL_ATTRIBUTES );
4009 /* else: fallthru */
4012 if ( c->argc > 2 ) {
4013 int all_user = 0, all_op = 0;
4015 qm->attr_sets[num].count = c->argc - 2;
4016 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( c->argc - 1,
4017 sizeof( AttributeName ) );
4018 attr_name = qm->attr_sets[num].attrs;
4019 for ( i = 2; i < c->argc; i++ ) {
4020 attr_name->an_desc = NULL;
4021 if ( strcmp( c->argv[i], LDAP_NO_ATTRS ) == 0 ) {
4022 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4023 "invalid attr #%d \"%s\" in attrlist",
4024 i - 2, c->argv[i] );
4025 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4026 ch_free( qm->attr_sets[num].attrs );
4027 qm->attr_sets[num].attrs = NULL;
4028 qm->attr_sets[num].count = 0;
4031 if ( strcmp( c->argv[i], LDAP_ALL_USER_ATTRIBUTES ) == 0 ) {
4033 BER_BVSTR( &attr_name->an_name, LDAP_ALL_USER_ATTRIBUTES );
4034 } else if ( strcmp( c->argv[i], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 ) {
4036 BER_BVSTR( &attr_name->an_name, LDAP_ALL_OPERATIONAL_ATTRIBUTES );
4038 if ( strncasecmp( c->argv[i], "undef:", STRLENOF("undef:") ) == 0 ) {
4040 ber_str2bv( c->argv[i] + STRLENOF("undef:"), 0, 0, &bv );
4041 attr_name->an_desc = slap_bv2tmp_ad( &bv, NULL );
4043 } else if ( slap_str2ad( c->argv[i], &attr_name->an_desc, &text ) ) {
4044 strcpy( c->cr_msg, text );
4045 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4046 ch_free( qm->attr_sets[num].attrs );
4047 qm->attr_sets[num].attrs = NULL;
4048 qm->attr_sets[num].count = 0;
4051 attr_name->an_name = attr_name->an_desc->ad_cname;
4053 attr_name->an_oc = NULL;
4054 attr_name->an_flags = 0;
4055 if ( attr_name->an_desc == slap_schema.si_ad_objectClass )
4056 qm->attr_sets[num].flags |= PC_GOT_OC;
4058 BER_BVZERO( &attr_name->an_name );
4061 /* warn if list contains both "*" and "+" */
4062 if ( i > 4 && all_user && all_op ) {
4063 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4064 "warning: attribute list contains \"*\" and \"+\"" );
4065 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4070 if ( cm->numattrsets == 0 ) {
4071 snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"pcache\" directive not provided yet" );
4072 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4075 if ( lutil_atoi( &i, c->argv[2] ) != 0 ) {
4076 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse template #=\"%s\"",
4078 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4082 if ( i < 0 || i >= cm->numattrsets ||
4083 !(qm->attr_sets[i].flags & PC_CONFIGURED )) {
4084 snprintf( c->cr_msg, sizeof( c->cr_msg ), "template index %d invalid (%s%d)",
4085 i, cm->numattrsets > 1 ? "0->" : "", cm->numattrsets - 1 );
4086 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4090 AttributeName *attrs;
4092 cnt = template_attrs( c->argv[1], &qm->attr_sets[i], &attrs, &text );
4094 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse template: %s",
4096 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4099 temp = ch_calloc( 1, sizeof( QueryTemplate ));
4100 temp->qmnext = qm->templates;
4101 qm->templates = temp;
4102 temp->t_attrs.attrs = attrs;
4103 temp->t_attrs.count = cnt;
4105 ldap_pvt_thread_rdwr_init( &temp->t_rwlock );
4106 temp->query = temp->query_last = NULL;
4107 if ( lutil_parse_time( c->argv[3], &t ) != 0 ) {
4108 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4109 "unable to parse template ttl=\"%s\"",
4111 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4113 ch_free( temp->t_attrs.attrs );
4117 temp->ttl = (time_t)t;
4118 temp->negttl = (time_t)0;
4119 temp->limitttl = (time_t)0;
4120 temp->ttr = (time_t)0;
4121 switch ( c->argc ) {
4123 if ( lutil_parse_time( c->argv[6], &t ) != 0 ) {
4124 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4125 "unable to parse template ttr=\"%s\"",
4127 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4130 temp->ttr = (time_t)t;
4134 if ( lutil_parse_time( c->argv[5], &t ) != 0 ) {
4135 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4136 "unable to parse template sizelimit ttl=\"%s\"",
4138 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4141 temp->limitttl = (time_t)t;
4145 if ( lutil_parse_time( c->argv[4], &t ) != 0 ) {
4146 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4147 "unable to parse template negative ttl=\"%s\"",
4149 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4152 temp->negttl = (time_t)t;
4156 temp->no_of_queries = 0;
4158 ber_str2bv( c->argv[1], 0, 1, &temp->querystr );
4159 Debug( pcache_debug, "Template:\n", 0, 0, 0 );
4160 Debug( pcache_debug, " query template: %s\n",
4161 temp->querystr.bv_val, 0, 0 );
4162 temp->attr_set_index = i;
4163 qm->attr_sets[i].flags |= PC_REFERENCED;
4164 temp->qtnext = qm->attr_sets[i].templates;
4165 qm->attr_sets[i].templates = temp;
4166 Debug( pcache_debug, " attributes: \n", 0, 0, 0 );
4167 if ( ( attrarray = qm->attr_sets[i].attrs ) != NULL ) {
4168 for ( i=0; attrarray[i].an_name.bv_val; i++ )
4169 Debug( pcache_debug, "\t%s\n",
4170 attrarray[i].an_name.bv_val, 0, 0 );
4174 if ( !qm->templates ) {
4175 snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"pcacheTemplate\" directive not provided yet" );
4176 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4179 if ( lutil_atoi( &i, c->argv[2] ) != 0 ) {
4180 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse Bind index #=\"%s\"",
4182 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4186 if ( i < 0 || i >= cm->numattrsets ||
4187 !(qm->attr_sets[i].flags & PC_CONFIGURED )) {
4188 snprintf( c->cr_msg, sizeof( c->cr_msg ), "Bind index %d invalid (%s%d)",
4189 i, cm->numattrsets > 1 ? "0->" : "", cm->numattrsets - 1 );
4190 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4193 { struct berval bv, tempbv;
4194 AttributeDescription **descs;
4196 ber_str2bv( c->argv[1], 0, 0, &bv );
4197 ndescs = ftemp_attrs( &bv, &tempbv, &descs, &text );
4199 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse template: %s",
4201 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4204 for ( temp = qm->templates; temp; temp=temp->qmnext ) {
4205 if ( temp->attr_set_index == i && bvmatch( &tempbv,
4209 ch_free( tempbv.bv_val );
4212 snprintf( c->cr_msg, sizeof( c->cr_msg ), "Bind template %s %d invalid",
4214 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4217 ber_dupbv( &temp->bindftemp, &bv );
4218 temp->bindfattrs = descs;
4219 temp->bindnattrs = ndescs;
4221 if ( lutil_parse_time( c->argv[3], &t ) != 0 ) {
4222 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4223 "unable to parse bind ttr=\"%s\"",
4225 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4227 ch_free( temp->bindfattrs );
4228 temp->bindfattrs = NULL;
4229 ch_free( temp->bindftemp.bv_val );
4230 BER_BVZERO( &temp->bindftemp );
4233 num = ldap_pvt_str2scope( c->argv[4] );
4235 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4236 "unable to parse bind scope=\"%s\"",
4238 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4242 struct berval dn, ndn;
4243 ber_str2bv( c->argv[5], 0, 0, &dn );
4244 rc = dnNormalize( 0, NULL, NULL, &dn, &ndn, NULL );
4246 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4247 "invalid bind baseDN=\"%s\"",
4249 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4252 if ( temp->bindbase.bv_val )
4253 ch_free( temp->bindbase.bv_val );
4254 temp->bindbase = ndn;
4257 /* convert the template into dummy filter */
4259 char *eq = temp->bindftemp.bv_val, *e2;
4262 while ((eq = strchr(eq, '=' ))) {
4267 bv.bv_len = temp->bindftemp.bv_len + i;
4268 bv.bv_val = ch_malloc( bv.bv_len + 1 );
4269 for ( e2 = bv.bv_val, eq = temp->bindftemp.bv_val;
4280 f = str2filter( bv.bv_val );
4282 ch_free( bv.bv_val );
4283 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4284 "unable to parse bindfilter=\"%s\"", bv.bv_val );
4285 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4286 ch_free( temp->bindbase.bv_val );
4287 BER_BVZERO( &temp->bindbase );
4290 if ( temp->bindfilter )
4291 filter_free( temp->bindfilter );
4292 if ( temp->bindfilterstr.bv_val )
4293 ch_free( temp->bindfilterstr.bv_val );
4294 temp->bindfilterstr = bv;
4295 temp->bindfilter = f;
4297 temp->bindttr = (time_t)t;
4298 temp->bindscope = num;
4299 cm->cache_binds = 1;
4303 if ( strcasecmp( c->argv[1], "head" ) == 0 ) {
4304 cm->response_cb = PCACHE_RESPONSE_CB_HEAD;
4306 } else if ( strcasecmp( c->argv[1], "tail" ) == 0 ) {
4307 cm->response_cb = PCACHE_RESPONSE_CB_TAIL;
4310 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unknown specifier" );
4311 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4316 if ( c->value_int <= 0 ) {
4317 snprintf( c->cr_msg, sizeof( c->cr_msg ), "max queries must be positive" );
4318 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4321 cm->max_queries = c->value_int;
4325 cm->cc_paused |= PCACHE_CC_OFFLINE;
4327 cm->cc_paused &= ~PCACHE_CC_OFFLINE;
4330 if ( cm->db.be_private == NULL ) {
4331 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4332 "private database must be defined before setting database specific options" );
4333 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4337 if ( cm->db.bd_info->bi_cf_ocs ) {
4340 char *argv0 = c->argv[ 0 ];
4342 c->argv[ 0 ] = &argv0[ STRLENOF( "pcache-" ) ];
4344 ct = config_find_keyword( cm->db.bd_info->bi_cf_ocs->co_table, c );
4346 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4347 "private database does not recognize specific option '%s'",
4349 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4353 c->table = cm->db.bd_info->bi_cf_ocs->co_type;
4355 c->bi = c->be->bd_info;
4357 rc = config_add_vals( ct, c );
4361 c->table = c2.table;
4364 c->argv[ 0 ] = argv0;
4366 } else if ( cm->db.be_config != NULL ) {
4367 char *argv0 = c->argv[ 0 ];
4369 c->argv[ 0 ] = &argv0[ STRLENOF( "pcache-" ) ];
4370 rc = cm->db.be_config( &cm->db, c->fname, c->lineno, c->argc, c->argv );
4371 c->argv[ 0 ] = argv0;
4374 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4375 "no means to set private database specific options" );
4376 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4381 rc = SLAP_CONF_UNKNOWN;
4397 slap_overinst *on = (slap_overinst *)be->bd_info;
4398 cache_manager* cm = on->on_bi.bi_private;
4400 /* Something for the cache database? */
4401 if ( cm->db.bd_info && cm->db.bd_info->bi_db_config )
4402 return cm->db.bd_info->bi_db_config( &cm->db, fname, lineno,
4404 return SLAP_CONF_UNKNOWN;
4412 slap_overinst *on = (slap_overinst *)be->bd_info;
4416 cm = (cache_manager *)ch_malloc(sizeof(cache_manager));
4417 on->on_bi.bi_private = cm;
4419 qm = (query_manager*)ch_malloc(sizeof(query_manager));
4422 SLAP_DBFLAGS(&cm->db) |= SLAP_DBFLAG_NO_SCHEMA_CHECK;
4423 cm->db.be_private = NULL;
4424 cm->db.bd_self = &cm->db;
4426 cm->numattrsets = 0;
4427 cm->num_entries_limit = 5;
4428 cm->num_cached_queries = 0;
4429 cm->max_entries = 0;
4430 cm->cur_entries = 0;
4431 cm->max_queries = 10000;
4432 cm->save_queries = 0;
4433 cm->check_cacheability = 0;
4434 cm->response_cb = PCACHE_RESPONSE_CB_TAIL;
4435 cm->defer_db_open = 1;
4436 cm->cache_binds = 0;
4437 cm->cc_period = 1000;
4440 #ifdef PCACHE_MONITOR
4441 cm->monitor_cb = NULL;
4442 #endif /* PCACHE_MONITOR */
4444 qm->attr_sets = NULL;
4445 qm->templates = NULL;
4447 qm->lru_bottom = NULL;
4449 qm->qcfunc = query_containment;
4450 qm->crfunc = cache_replacement;
4451 qm->addfunc = add_query;
4452 ldap_pvt_thread_mutex_init(&qm->lru_mutex);
4454 ldap_pvt_thread_mutex_init(&cm->cache_mutex);
4456 #ifndef PCACHE_MONITOR
4458 #else /* PCACHE_MONITOR */
4459 return pcache_monitor_db_init( be );
4460 #endif /* PCACHE_MONITOR */
4464 pcache_cachedquery_open_cb( Operation *op, SlapReply *rs )
4466 assert( op->o_tag == LDAP_REQ_SEARCH );
4468 if ( rs->sr_type == REP_SEARCH ) {
4471 a = attr_find( rs->sr_entry->e_attrs, ad_cachedQueryURL );
4475 assert( a->a_nvals != NULL );
4477 valsp = op->o_callback->sc_private;
4478 assert( *valsp == NULL );
4480 ber_bvarray_dup_x( valsp, a->a_nvals, op->o_tmpmemctx );
4488 pcache_cachedquery_count_cb( Operation *op, SlapReply *rs )
4490 assert( op->o_tag == LDAP_REQ_SEARCH );
4492 if ( rs->sr_type == REP_SEARCH ) {
4493 int *countp = (int *)op->o_callback->sc_private;
4506 cache_manager *cm = on->on_bi.bi_private;
4507 query_manager* qm = cm->qm;
4510 rc = backend_startup_one( &cm->db, cr );
4512 cm->defer_db_open = 0;
4515 /* There is no runqueue in TOOL mode */
4516 if (( slapMode & SLAP_SERVER_MODE ) && rc == 0 ) {
4517 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
4518 ldap_pvt_runqueue_insert( &slapd_rq, cm->cc_period,
4519 consistency_check, on,
4520 "pcache_consistency", cm->db.be_suffix[0].bv_val );
4521 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
4523 /* Cached database must have the rootdn */
4524 if ( BER_BVISNULL( &cm->db.be_rootndn )
4525 || BER_BVISEMPTY( &cm->db.be_rootndn ) )
4527 Debug( LDAP_DEBUG_ANY, "pcache_db_open(): "
4528 "underlying database of type \"%s\"\n"
4529 " serving naming context \"%s\"\n"
4530 " has no \"rootdn\", required by \"pcache\".\n",
4531 on->on_info->oi_orig->bi_type,
4532 cm->db.be_suffix[0].bv_val, 0 );
4536 if ( cm->save_queries ) {
4537 void *thrctx = ldap_pvt_thread_pool_context();
4538 Connection conn = { 0 };
4539 OperationBuffer opbuf;
4541 slap_callback cb = { 0 };
4542 SlapReply rs = { REP_RESULT };
4543 BerVarray vals = NULL;
4544 Filter f = { 0 }, f2 = { 0 };
4545 AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
4546 AttributeName attrs[ 2 ] = {{{ 0 }}};
4548 connection_fake_init2( &conn, &opbuf, thrctx, 0 );
4553 op->o_tag = LDAP_REQ_SEARCH;
4554 op->o_protocol = LDAP_VERSION3;
4555 cb.sc_response = pcache_cachedquery_open_cb;
4556 cb.sc_private = &vals;
4557 op->o_callback = &cb;
4558 op->o_time = slap_get_time();
4559 op->o_do_not_cache = 1;
4560 op->o_managedsait = SLAP_CONTROL_CRITICAL;
4562 op->o_dn = cm->db.be_rootdn;
4563 op->o_ndn = cm->db.be_rootndn;
4564 op->o_req_dn = cm->db.be_suffix[ 0 ];
4565 op->o_req_ndn = cm->db.be_nsuffix[ 0 ];
4567 op->ors_scope = LDAP_SCOPE_BASE;
4568 op->ors_deref = LDAP_DEREF_NEVER;
4570 op->ors_tlimit = SLAP_NO_LIMIT;
4571 op->ors_limit = NULL;
4572 ber_str2bv( "(pcacheQueryURL=*)", 0, 0, &op->ors_filterstr );
4573 f.f_choice = LDAP_FILTER_PRESENT;
4574 f.f_desc = ad_cachedQueryURL;
4575 op->ors_filter = &f;
4576 attrs[ 0 ].an_desc = ad_cachedQueryURL;
4577 attrs[ 0 ].an_name = ad_cachedQueryURL->ad_cname;
4578 op->ors_attrs = attrs;
4579 op->ors_attrsonly = 0;
4581 rc = op->o_bd->be_search( op, &rs );
4582 if ( rc == LDAP_SUCCESS && vals != NULL ) {
4585 for ( i = 0; !BER_BVISNULL( &vals[ i ] ); i++ ) {
4586 if ( url2query( vals[ i ].bv_val, op, qm ) == 0 ) {
4587 cm->num_cached_queries++;
4591 ber_bvarray_free_x( vals, op->o_tmpmemctx );
4594 /* count cached entries */
4595 f.f_choice = LDAP_FILTER_NOT;
4597 f2.f_choice = LDAP_FILTER_EQUALITY;
4599 f2.f_av_desc = slap_schema.si_ad_objectClass;
4600 BER_BVSTR( &f2.f_av_value, "glue" );
4601 ber_str2bv( "(!(objectClass=glue))", 0, 0, &op->ors_filterstr );
4603 op->ors_slimit = SLAP_NO_LIMIT;
4604 op->ors_scope = LDAP_SCOPE_SUBTREE;
4605 op->ors_attrs = slap_anlist_no_attrs;
4607 rs_reinit( &rs, REP_RESULT );
4608 op->o_callback->sc_response = pcache_cachedquery_count_cb;
4609 op->o_callback->sc_private = &rs.sr_nentries;
4611 rc = op->o_bd->be_search( op, &rs );
4613 cm->cur_entries = rs.sr_nentries;
4627 slap_overinst *on = (slap_overinst *)be->bd_info;
4628 cache_manager *cm = on->on_bi.bi_private;
4629 query_manager* qm = cm->qm;
4630 int i, ncf = 0, rf = 0, nrf = 0, rc = 0;
4632 /* check attr sets */
4633 for ( i = 0; i < cm->numattrsets; i++) {
4634 if ( !( qm->attr_sets[i].flags & PC_CONFIGURED ) ) {
4635 if ( qm->attr_sets[i].flags & PC_REFERENCED ) {
4636 Debug( LDAP_DEBUG_CONFIG, "pcache: attr set #%d not configured but referenced.\n", i, 0, 0 );
4640 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, attr set #%d not configured.\n", i, 0, 0 );
4644 } else if ( !( qm->attr_sets[i].flags & PC_REFERENCED ) ) {
4645 Debug( LDAP_DEBUG_CONFIG, "pcache: attr set #%d configured but not referenced.\n", i, 0, 0 );
4650 if ( ncf || rf || nrf ) {
4651 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, %d attr sets configured but not referenced.\n", nrf, 0, 0 );
4652 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, %d attr sets not configured.\n", ncf, 0, 0 );
4653 Debug( LDAP_DEBUG_CONFIG, "pcache: %d attr sets not configured but referenced.\n", rf, 0, 0 );
4660 /* need to inherit something from the original database... */
4661 cm->db.be_def_limit = be->be_def_limit;
4662 cm->db.be_limits = be->be_limits;
4663 cm->db.be_acl = be->be_acl;
4664 cm->db.be_dfltaccess = be->be_dfltaccess;
4666 if ( SLAP_DBMONITORING( be ) ) {
4667 SLAP_DBFLAGS( &cm->db ) |= SLAP_DBFLAG_MONITORING;
4670 SLAP_DBFLAGS( &cm->db ) &= ~SLAP_DBFLAG_MONITORING;
4673 if ( !cm->defer_db_open ) {
4674 rc = pcache_db_open2( on, cr );
4677 #ifdef PCACHE_MONITOR
4678 if ( rc == LDAP_SUCCESS ) {
4679 rc = pcache_monitor_db_open( be );
4681 #endif /* PCACHE_MONITOR */
4687 pcache_free_qbase( void *v )
4693 tavl_free( qb->scopes[i], NULL );
4703 slap_overinst *on = (slap_overinst *)be->bd_info;
4704 cache_manager *cm = on->on_bi.bi_private;
4705 query_manager *qm = cm->qm;
4709 /* stop the thread ... */
4711 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
4712 if ( ldap_pvt_runqueue_isrunning( &slapd_rq, cm->cc_arg ) ) {
4713 ldap_pvt_runqueue_stoptask( &slapd_rq, cm->cc_arg );
4715 ldap_pvt_runqueue_remove( &slapd_rq, cm->cc_arg );
4716 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
4719 if ( cm->save_queries ) {
4721 BerVarray vals = NULL;
4724 Connection conn = { 0 };
4725 OperationBuffer opbuf;
4727 slap_callback cb = { 0 };
4729 SlapReply rs = { REP_RESULT };
4730 Modifications mod = {{ 0 }};
4732 thrctx = ldap_pvt_thread_pool_context();
4734 connection_fake_init2( &conn, &opbuf, thrctx, 0 );
4737 mod.sml_numvals = 0;
4738 if ( qm->templates != NULL ) {
4739 for ( tm = qm->templates; tm != NULL; tm = tm->qmnext ) {
4740 for ( qc = tm->query; qc; qc = qc->next ) {
4743 if ( query2url( op, qc, &bv, 0 ) == 0 ) {
4744 ber_bvarray_add_x( &vals, &bv, op->o_tmpmemctx );
4752 op->o_dn = cm->db.be_rootdn;
4753 op->o_ndn = cm->db.be_rootndn;
4755 op->o_tag = LDAP_REQ_MODIFY;
4756 op->o_protocol = LDAP_VERSION3;
4757 cb.sc_response = slap_null_cb;
4758 op->o_callback = &cb;
4759 op->o_time = slap_get_time();
4760 op->o_do_not_cache = 1;
4761 op->o_managedsait = SLAP_CONTROL_CRITICAL;
4763 op->o_req_dn = op->o_bd->be_suffix[0];
4764 op->o_req_ndn = op->o_bd->be_nsuffix[0];
4766 mod.sml_op = LDAP_MOD_REPLACE;
4768 mod.sml_desc = ad_cachedQueryURL;
4769 mod.sml_type = ad_cachedQueryURL->ad_cname;
4770 mod.sml_values = vals;
4771 mod.sml_nvalues = NULL;
4772 mod.sml_next = NULL;
4773 Debug( pcache_debug,
4774 "%sSETTING CACHED QUERY URLS\n",
4775 vals == NULL ? "RE" : "", 0, 0 );
4777 op->orm_modlist = &mod;
4779 op->o_bd->be_modify( op, &rs );
4781 ber_bvarray_free_x( vals, op->o_tmpmemctx );
4784 /* cleanup stuff inherited from the original database... */
4785 cm->db.be_limits = NULL;
4786 cm->db.be_acl = NULL;
4789 if ( cm->db.bd_info->bi_db_close ) {
4790 rc = cm->db.bd_info->bi_db_close( &cm->db, NULL );
4792 while ( (tm = qm->templates) != NULL ) {
4793 CachedQuery *qc, *qn;
4794 qm->templates = tm->qmnext;
4795 for ( qc = tm->query; qc; qc = qn ) {
4799 avl_free( tm->qbase, pcache_free_qbase );
4800 free( tm->querystr.bv_val );
4801 free( tm->bindfattrs );
4802 free( tm->bindftemp.bv_val );
4803 free( tm->bindfilterstr.bv_val );
4804 free( tm->bindbase.bv_val );
4805 filter_free( tm->bindfilter );
4806 ldap_pvt_thread_rdwr_destroy( &tm->t_rwlock );
4807 free( tm->t_attrs.attrs );
4811 for ( i = 0; i < cm->numattrsets; i++ ) {
4813 for ( j = 0; !BER_BVISNULL( &qm->attr_sets[i].attrs[j].an_name ); j++ ) {
4814 if ( qm->attr_sets[i].attrs[j].an_desc->ad_flags & SLAP_DESC_TEMPORARY ) {
4815 slap_sl_mfuncs.bmf_free( qm->attr_sets[i].attrs[j].an_desc, NULL );
4818 free( qm->attr_sets[i].attrs );
4820 free( qm->attr_sets );
4821 qm->attr_sets = NULL;
4823 #ifdef PCACHE_MONITOR
4824 if ( rc == LDAP_SUCCESS ) {
4825 rc = pcache_monitor_db_close( be );
4827 #endif /* PCACHE_MONITOR */
4838 slap_overinst *on = (slap_overinst *)be->bd_info;
4839 cache_manager *cm = on->on_bi.bi_private;
4840 query_manager *qm = cm->qm;
4842 if ( cm->db.be_private != NULL ) {
4843 backend_stopdown_one( &cm->db );
4846 ldap_pvt_thread_mutex_destroy( &qm->lru_mutex );
4847 ldap_pvt_thread_mutex_destroy( &cm->cache_mutex );
4851 #ifdef PCACHE_MONITOR
4852 pcache_monitor_db_destroy( be );
4853 #endif /* PCACHE_MONITOR */
4858 #ifdef PCACHE_CONTROL_PRIVDB
4860 Control ::= SEQUENCE {
4861 controlType LDAPOID,
4862 criticality BOOLEAN DEFAULT FALSE,
4863 controlValue OCTET STRING OPTIONAL }
4865 controlType ::= 1.3.6.1.4.1.4203.666.11.9.5.1
4867 * criticality must be TRUE; controlValue must be absent.
4875 if ( op->o_ctrlflag[ privDB_cid ] != SLAP_CONTROL_NONE ) {
4876 rs->sr_text = "privateDB control specified multiple times";
4877 return LDAP_PROTOCOL_ERROR;
4880 if ( !BER_BVISNULL( &ctrl->ldctl_value ) ) {
4881 rs->sr_text = "privateDB control value not absent";
4882 return LDAP_PROTOCOL_ERROR;
4885 if ( !ctrl->ldctl_iscritical ) {
4886 rs->sr_text = "privateDB control criticality required";
4887 return LDAP_PROTOCOL_ERROR;
4890 op->o_ctrlflag[ privDB_cid ] = SLAP_CONTROL_CRITICAL;
4892 return LDAP_SUCCESS;
4895 static char *extops[] = {
4896 LDAP_EXOP_MODIFY_PASSWD,
4899 #endif /* PCACHE_CONTROL_PRIVDB */
4901 static struct berval pcache_exop_MODIFY_PASSWD = BER_BVC( LDAP_EXOP_MODIFY_PASSWD );
4902 #ifdef PCACHE_EXOP_QUERY_DELETE
4903 static struct berval pcache_exop_QUERY_DELETE = BER_BVC( PCACHE_EXOP_QUERY_DELETE );
4905 #define LDAP_TAG_EXOP_QUERY_DELETE_BASE ((LBER_CLASS_CONTEXT|LBER_CONSTRUCTED) + 0)
4906 #define LDAP_TAG_EXOP_QUERY_DELETE_DN ((LBER_CLASS_CONTEXT|LBER_CONSTRUCTED) + 1)
4907 #define LDAP_TAG_EXOP_QUERY_DELETE_UUID ((LBER_CLASS_CONTEXT|LBER_CONSTRUCTED) + 2)
4910 ExtendedRequest ::= [APPLICATION 23] SEQUENCE {
4911 requestName [0] LDAPOID,
4912 requestValue [1] OCTET STRING OPTIONAL }
4914 requestName ::= 1.3.6.1.4.1.4203.666.11.9.6.1
4916 requestValue ::= SEQUENCE { CHOICE {
4918 entryDN [1] LDAPDN },
4919 queryID [2] OCTET STRING (SIZE(16))
4920 -- constrained to UUID }
4922 * Either baseDN or entryDN must be present, to allow database selection.
4924 * 1. if baseDN and queryID are present, then the query corresponding
4925 * to queryID is deleted;
4926 * 2. if baseDN is present and queryID is absent, then all queries
4928 * 3. if entryDN is present and queryID is absent, then all queries
4929 * corresponding to the queryID values present in entryDN are deleted;
4930 * 4. if entryDN and queryID are present, then all queries
4931 * corresponding to the queryID values present in entryDN are deleted,
4932 * but only if the value of queryID is contained in the entry;
4934 * Currently, only 1, 3 and 4 are implemented. 2 can be obtained by either
4935 * recursively deleting the database (ldapdelete -r) with PRIVDB control,
4936 * or by removing the database files.
4938 ExtendedResponse ::= [APPLICATION 24] SEQUENCE {
4939 COMPONENTS OF LDAPResult,
4940 responseName [10] LDAPOID OPTIONAL,
4941 responseValue [11] OCTET STRING OPTIONAL }
4943 * responseName and responseValue must be absent.
4947 * - on success, *tagp is either LDAP_TAG_EXOP_QUERY_DELETE_BASE
4948 * or LDAP_TAG_EXOP_QUERY_DELETE_DN.
4949 * - if ndn != NULL, it is set to the normalized DN in the request
4950 * corresponding to either the baseDN or the entryDN, according
4951 * to *tagp; memory is malloc'ed on the Operation's slab, and must
4952 * be freed by the caller.
4953 * - if uuid != NULL, it is set to point to the normalized UUID;
4954 * memory is malloc'ed on the Operation's slab, and must
4955 * be freed by the caller.
4958 pcache_parse_query_delete(
4962 struct berval *uuid,
4966 int rc = LDAP_SUCCESS;
4969 BerElementBuffer berbuf;
4970 BerElement *ber = (BerElement *)&berbuf;
4971 struct berval reqdata = BER_BVNULL;
4983 if ( in == NULL || in->bv_len == 0 ) {
4984 *text = "empty request data field in queryDelete exop";
4985 return LDAP_PROTOCOL_ERROR;
4988 ber_dupbv_x( &reqdata, in, ctx );
4990 /* ber_init2 uses reqdata directly, doesn't allocate new buffers */
4991 ber_init2( ber, &reqdata, 0 );
4993 tag = ber_scanf( ber, "{" /*}*/ );
4995 if ( tag == LBER_ERROR ) {
4996 Debug( LDAP_DEBUG_TRACE,
4997 "pcache_parse_query_delete: decoding error.\n",
4999 goto decoding_error;
5002 tag = ber_peek_tag( ber, &len );
5003 if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_BASE
5004 || tag == LDAP_TAG_EXOP_QUERY_DELETE_DN )
5008 if ( ndn != NULL ) {
5011 tag = ber_scanf( ber, "m", &dn );
5012 if ( tag == LBER_ERROR ) {
5013 Debug( LDAP_DEBUG_TRACE,
5014 "pcache_parse_query_delete: DN parse failed.\n",
5016 goto decoding_error;
5019 rc = dnNormalize( 0, NULL, NULL, &dn, ndn, ctx );
5020 if ( rc != LDAP_SUCCESS ) {
5021 *text = "invalid DN in queryDelete exop request data";
5026 tag = ber_scanf( ber, "x" /* "m" */ );
5027 if ( tag == LBER_DEFAULT ) {
5028 goto decoding_error;
5032 tag = ber_peek_tag( ber, &len );
5035 if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_UUID ) {
5036 if ( uuid != NULL ) {
5038 char uuidbuf[ LDAP_LUTIL_UUIDSTR_BUFSIZE ];
5040 tag = ber_scanf( ber, "m", &bv );
5041 if ( tag == LBER_ERROR ) {
5042 Debug( LDAP_DEBUG_TRACE,
5043 "pcache_parse_query_delete: UUID parse failed.\n",
5045 goto decoding_error;
5048 if ( bv.bv_len != 16 ) {
5049 Debug( LDAP_DEBUG_TRACE,
5050 "pcache_parse_query_delete: invalid UUID length %lu.\n",
5051 (unsigned long)bv.bv_len, 0, 0 );
5052 goto decoding_error;
5055 rc = lutil_uuidstr_from_normalized(
5056 bv.bv_val, bv.bv_len,
5057 uuidbuf, sizeof( uuidbuf ) );
5059 goto decoding_error;
5061 ber_str2bv( uuidbuf, rc, 1, uuid );
5065 tag = ber_skip_tag( ber, &len );
5066 if ( tag == LBER_DEFAULT ) {
5067 goto decoding_error;
5071 Debug( LDAP_DEBUG_TRACE,
5072 "pcache_parse_query_delete: invalid UUID length %lu.\n",
5073 (unsigned long)len, 0, 0 );
5074 goto decoding_error;
5078 tag = ber_peek_tag( ber, &len );
5081 if ( tag != LBER_DEFAULT || len != 0 ) {
5083 Debug( LDAP_DEBUG_TRACE,
5084 "pcache_parse_query_delete: decoding error\n",
5086 rc = LDAP_PROTOCOL_ERROR;
5087 *text = "queryDelete data decoding error";
5090 if ( ndn && !BER_BVISNULL( ndn ) ) {
5091 slap_sl_free( ndn->bv_val, ctx );
5095 if ( uuid && !BER_BVISNULL( uuid ) ) {
5096 slap_sl_free( uuid->bv_val, ctx );
5101 if ( !BER_BVISNULL( &reqdata ) ) {
5102 ber_memfree_x( reqdata.bv_val, ctx );
5109 pcache_exop_query_delete(
5113 BackendDB *bd = op->o_bd;
5115 struct berval uuid = BER_BVNULL,
5117 char buf[ SLAP_TEXT_BUFLEN ];
5119 ber_tag_t tag = LBER_DEFAULT;
5121 if ( LogTest( LDAP_DEBUG_STATS ) ) {
5125 rs->sr_err = pcache_parse_query_delete( op->ore_reqdata,
5126 &tag, &op->o_req_ndn, uuidp,
5127 &rs->sr_text, op->o_tmpmemctx );
5128 if ( rs->sr_err != LDAP_SUCCESS ) {
5132 if ( LogTest( LDAP_DEBUG_STATS ) ) {
5133 assert( !BER_BVISNULL( &op->o_req_ndn ) );
5134 len = snprintf( buf, sizeof( buf ), " dn=\"%s\"", op->o_req_ndn.bv_val );
5136 if ( !BER_BVISNULL( &uuid ) && len < sizeof( buf ) ) {
5137 snprintf( &buf[ len ], sizeof( buf ) - len, " pcacheQueryId=\"%s\"", uuid.bv_val );
5140 Debug( LDAP_DEBUG_STATS, "%s QUERY DELETE%s\n",
5141 op->o_log_prefix, buf, 0 );
5143 op->o_req_dn = op->o_req_ndn;
5145 op->o_bd = select_backend( &op->o_req_ndn, 0 );
5146 if ( op->o_bd == NULL ) {
5147 send_ldap_error( op, rs, LDAP_NO_SUCH_OBJECT,
5148 "no global superior knowledge" );
5150 rs->sr_err = backend_check_restrictions( op, rs,
5151 (struct berval *)&pcache_exop_QUERY_DELETE );
5152 if ( rs->sr_err != LDAP_SUCCESS ) {
5156 if ( op->o_bd->be_extended == NULL ) {
5157 send_ldap_error( op, rs, LDAP_UNAVAILABLE_CRITICAL_EXTENSION,
5158 "backend does not support extended operations" );
5162 op->o_bd->be_extended( op, rs );
5165 if ( !BER_BVISNULL( &op->o_req_ndn ) ) {
5166 op->o_tmpfree( op->o_req_ndn.bv_val, op->o_tmpmemctx );
5167 BER_BVZERO( &op->o_req_ndn );
5168 BER_BVZERO( &op->o_req_dn );
5171 if ( !BER_BVISNULL( &uuid ) ) {
5172 op->o_tmpfree( uuid.bv_val, op->o_tmpmemctx );
5179 #endif /* PCACHE_EXOP_QUERY_DELETE */
5182 pcache_op_extended( Operation *op, SlapReply *rs )
5184 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
5185 cache_manager *cm = on->on_bi.bi_private;
5187 #ifdef PCACHE_CONTROL_PRIVDB
5188 if ( op->o_ctrlflag[ privDB_cid ] == SLAP_CONTROL_CRITICAL ) {
5189 return pcache_op_privdb( op, rs );
5191 #endif /* PCACHE_CONTROL_PRIVDB */
5193 #ifdef PCACHE_EXOP_QUERY_DELETE
5194 if ( bvmatch( &op->ore_reqoid, &pcache_exop_QUERY_DELETE ) ) {
5195 struct berval uuid = BER_BVNULL;
5196 ber_tag_t tag = LBER_DEFAULT;
5198 rs->sr_err = pcache_parse_query_delete( op->ore_reqdata,
5199 &tag, NULL, &uuid, &rs->sr_text, op->o_tmpmemctx );
5200 assert( rs->sr_err == LDAP_SUCCESS );
5202 if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_DN ) {
5203 /* remove all queries related to the selected entry */
5204 rs->sr_err = pcache_remove_entry_queries_from_cache( op,
5205 cm, &op->o_req_ndn, &uuid );
5207 } else if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_BASE ) {
5208 if ( !BER_BVISNULL( &uuid ) ) {
5209 /* remove the selected query */
5210 rs->sr_err = pcache_remove_query_from_cache( op,
5214 /* TODO: remove all queries */
5215 rs->sr_err = LDAP_UNWILLING_TO_PERFORM;
5216 rs->sr_text = "deletion of all queries not implemented";
5220 op->o_tmpfree( uuid.bv_val, op->o_tmpmemctx );
5223 #endif /* PCACHE_EXOP_QUERY_DELETE */
5225 /* We only care if we're configured for Bind caching */
5226 if ( bvmatch( &op->ore_reqoid, &pcache_exop_MODIFY_PASSWD ) &&
5228 /* See if the local entry exists and has a password.
5229 * It's too much work to find the matching query, so
5230 * we just see if there's a hashed password to update.
5232 Operation op2 = *op;
5238 op2.o_dn = op->o_bd->be_rootdn;
5239 op2.o_ndn = op->o_bd->be_rootndn;
5240 rc = be_entry_get_rw( &op2, &op->o_req_ndn, NULL,
5241 slap_schema.si_ad_userPassword, 0, &e );
5242 if ( rc == LDAP_SUCCESS && e ) {
5243 /* See if a recognized password is hashed here */
5244 Attribute *a = attr_find( e->e_attrs,
5245 slap_schema.si_ad_userPassword );
5246 if ( a && a->a_vals[0].bv_val[0] == '{' &&
5247 lutil_passwd_scheme( a->a_vals[0].bv_val )) {
5250 be_entry_release_r( &op2, e );
5254 rc = overlay_op_walk( op, rs, op_extended, on->on_info,
5256 if ( rc == LDAP_SUCCESS ) {
5257 req_pwdexop_s *qpw = &op->oq_pwdexop;
5259 /* We don't care if it succeeds or not */
5260 pc_setpw( &op2, &qpw->rs_new, cm );
5265 return SLAP_CB_CONTINUE;
5269 pcache_entry_release( Operation *op, Entry *e, int rw )
5271 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
5272 cache_manager *cm = on->on_bi.bi_private;
5273 BackendDB *db = op->o_bd;
5277 rc = be_entry_release_rw( op, e, rw );
5282 #ifdef PCACHE_MONITOR
5285 pcache_monitor_update(
5291 cache_manager *cm = (cache_manager *) priv;
5292 query_manager *qm = cm->qm;
5295 BerVarray vals = NULL;
5297 attr_delete( &e->e_attrs, ad_cachedQueryURL );
5298 if ( ( SLAP_OPATTRS( rs->sr_attr_flags ) || ad_inlist( ad_cachedQueryURL, rs->sr_attrs ) )
5299 && qm->templates != NULL )
5303 for ( tm = qm->templates; tm != NULL; tm = tm->qmnext ) {
5304 for ( qc = tm->query; qc; qc = qc->next ) {
5307 if ( query2url( op, qc, &bv, 1 ) == 0 ) {
5308 ber_bvarray_add_x( &vals, &bv, op->o_tmpmemctx );
5314 if ( vals != NULL ) {
5315 attr_merge_normalize( e, ad_cachedQueryURL, vals, NULL );
5316 ber_bvarray_free_x( vals, op->o_tmpmemctx );
5322 char buf[ SLAP_TEXT_BUFLEN ];
5325 /* number of cached queries */
5326 a = attr_find( e->e_attrs, ad_numQueries );
5327 assert( a != NULL );
5330 bv.bv_len = snprintf( buf, sizeof( buf ), "%lu", cm->num_cached_queries );
5332 if ( a->a_nvals != a->a_vals ) {
5333 ber_bvreplace( &a->a_nvals[ 0 ], &bv );
5335 ber_bvreplace( &a->a_vals[ 0 ], &bv );
5337 /* number of cached entries */
5338 a = attr_find( e->e_attrs, ad_numEntries );
5339 assert( a != NULL );
5342 bv.bv_len = snprintf( buf, sizeof( buf ), "%d", cm->cur_entries );
5344 if ( a->a_nvals != a->a_vals ) {
5345 ber_bvreplace( &a->a_nvals[ 0 ], &bv );
5347 ber_bvreplace( &a->a_vals[ 0 ], &bv );
5350 return SLAP_CB_CONTINUE;
5354 pcache_monitor_free(
5358 struct berval values[ 2 ];
5359 Modification mod = { 0 };
5362 char textbuf[ SLAP_TEXT_BUFLEN ];
5366 /* NOTE: if slap_shutdown != 0, priv might have already been freed */
5369 /* Remove objectClass */
5370 mod.sm_op = LDAP_MOD_DELETE;
5371 mod.sm_desc = slap_schema.si_ad_objectClass;
5372 mod.sm_values = values;
5374 values[ 0 ] = oc_olmPCache->soc_cname;
5375 BER_BVZERO( &values[ 1 ] );
5377 rc = modify_delete_values( e, &mod, 1, &text,
5378 textbuf, sizeof( textbuf ) );
5379 /* don't care too much about return code... */
5382 mod.sm_values = NULL;
5383 mod.sm_desc = ad_cachedQueryURL;
5385 rc = modify_delete_values( e, &mod, 1, &text,
5386 textbuf, sizeof( textbuf ) );
5387 /* don't care too much about return code... */
5390 mod.sm_values = NULL;
5391 mod.sm_desc = ad_numQueries;
5393 rc = modify_delete_values( e, &mod, 1, &text,
5394 textbuf, sizeof( textbuf ) );
5395 /* don't care too much about return code... */
5398 mod.sm_values = NULL;
5399 mod.sm_desc = ad_numEntries;
5401 rc = modify_delete_values( e, &mod, 1, &text,
5402 textbuf, sizeof( textbuf ) );
5403 /* don't care too much about return code... */
5405 return SLAP_CB_CONTINUE;
5409 * call from within pcache_initialize()
5412 pcache_monitor_initialize( void )
5414 static int pcache_monitor_initialized = 0;
5416 if ( backend_info( "monitor" ) == NULL ) {
5420 if ( pcache_monitor_initialized++ ) {
5428 pcache_monitor_db_init( BackendDB *be )
5430 if ( pcache_monitor_initialize() == LDAP_SUCCESS ) {
5431 SLAP_DBFLAGS( be ) |= SLAP_DBFLAG_MONITORING;
5438 pcache_monitor_db_open( BackendDB *be )
5440 slap_overinst *on = (slap_overinst *)be->bd_info;
5441 cache_manager *cm = on->on_bi.bi_private;
5442 Attribute *a, *next;
5443 monitor_callback_t *cb = NULL;
5446 monitor_extra_t *mbe;
5447 struct berval dummy = BER_BVC( "" );
5449 if ( !SLAP_DBMONITORING( be ) ) {
5453 mi = backend_info( "monitor" );
5454 if ( !mi || !mi->bi_extra ) {
5455 SLAP_DBFLAGS( be ) ^= SLAP_DBFLAG_MONITORING;
5460 /* don't bother if monitor is not configured */
5461 if ( !mbe->is_configured() ) {
5462 static int warning = 0;
5464 if ( warning++ == 0 ) {
5465 Debug( LDAP_DEBUG_ANY, "pcache_monitor_db_open: "
5466 "monitoring disabled; "
5467 "configure monitor database to enable\n",
5474 /* alloc as many as required (plus 1 for objectClass) */
5475 a = attrs_alloc( 1 + 2 );
5481 a->a_desc = slap_schema.si_ad_objectClass;
5482 attr_valadd( a, &oc_olmPCache->soc_cname, NULL, 1 );
5486 struct berval bv = BER_BVC( "0" );
5488 next->a_desc = ad_numQueries;
5489 attr_valadd( next, &bv, NULL, 1 );
5490 next = next->a_next;
5492 next->a_desc = ad_numEntries;
5493 attr_valadd( next, &bv, NULL, 1 );
5494 next = next->a_next;
5497 cb = ch_calloc( sizeof( monitor_callback_t ), 1 );
5498 cb->mc_update = pcache_monitor_update;
5499 cb->mc_free = pcache_monitor_free;
5500 cb->mc_private = (void *)cm;
5502 /* make sure the database is registered; then add monitor attributes */
5503 BER_BVZERO( &cm->monitor_ndn );
5504 rc = mbe->register_overlay( be, on, &cm->monitor_ndn );
5506 rc = mbe->register_entry_attrs( &cm->monitor_ndn, a, cb,
5507 &dummy, -1, &dummy);
5523 /* store for cleanup */
5524 cm->monitor_cb = (void *)cb;
5526 /* we don't need to keep track of the attributes, because
5527 * bdb_monitor_free() takes care of everything */
5536 pcache_monitor_db_close( BackendDB *be )
5538 slap_overinst *on = (slap_overinst *)be->bd_info;
5539 cache_manager *cm = on->on_bi.bi_private;
5541 if ( cm->monitor_cb != NULL ) {
5542 BackendInfo *mi = backend_info( "monitor" );
5543 monitor_extra_t *mbe;
5545 if ( mi && &mi->bi_extra ) {
5547 mbe->unregister_entry_callback( &cm->monitor_ndn,
5548 (monitor_callback_t *)cm->monitor_cb,
5557 pcache_monitor_db_destroy( BackendDB *be )
5562 #endif /* PCACHE_MONITOR */
5564 static slap_overinst pcache;
5566 static char *obsolete_names[] = {
5571 #if SLAPD_OVER_PROXYCACHE == SLAPD_MOD_DYNAMIC
5573 #endif /* SLAPD_OVER_PROXYCACHE == SLAPD_MOD_DYNAMIC */
5578 struct berval debugbv = BER_BVC("pcache");
5582 code = slap_loglevel_get( &debugbv, &pcache_debug );
5587 #ifdef PCACHE_CONTROL_PRIVDB
5588 code = register_supported_control( PCACHE_CONTROL_PRIVDB,
5589 SLAP_CTRL_BIND|SLAP_CTRL_ACCESS|SLAP_CTRL_HIDE, extops,
5590 parse_privdb_ctrl, &privDB_cid );
5591 if ( code != LDAP_SUCCESS ) {
5592 Debug( LDAP_DEBUG_ANY,
5593 "pcache_initialize: failed to register control %s (%d)\n",
5594 PCACHE_CONTROL_PRIVDB, code, 0 );
5597 #endif /* PCACHE_CONTROL_PRIVDB */
5599 #ifdef PCACHE_EXOP_QUERY_DELETE
5600 code = load_extop2( (struct berval *)&pcache_exop_QUERY_DELETE,
5601 SLAP_EXOP_WRITES|SLAP_EXOP_HIDE, pcache_exop_query_delete,
5603 if ( code != LDAP_SUCCESS ) {
5604 Debug( LDAP_DEBUG_ANY,
5605 "pcache_initialize: unable to register queryDelete exop: %d.\n",
5609 #endif /* PCACHE_EXOP_QUERY_DELETE */
5611 argv[ 0 ] = "back-bdb/back-hdb monitor";
5616 for ( i = 0; s_oid[ i ].name; i++ ) {
5618 argv[ 1 ] = s_oid[ i ].name;
5619 argv[ 2 ] = s_oid[ i ].oid;
5621 if ( parse_oidm( &c, 0, NULL ) != 0 ) {
5622 Debug( LDAP_DEBUG_ANY, "pcache_initialize: "
5623 "unable to add objectIdentifier \"%s=%s\"\n",
5624 s_oid[ i ].name, s_oid[ i ].oid, 0 );
5629 for ( i = 0; s_ad[i].desc != NULL; i++ ) {
5630 code = register_at( s_ad[i].desc, s_ad[i].adp, 0 );
5632 Debug( LDAP_DEBUG_ANY,
5633 "pcache_initialize: register_at #%d failed\n", i, 0, 0 );
5636 (*s_ad[i].adp)->ad_type->sat_flags |= SLAP_AT_HIDE;
5639 for ( i = 0; s_oc[i].desc != NULL; i++ ) {
5640 code = register_oc( s_oc[i].desc, s_oc[i].ocp, 0 );
5642 Debug( LDAP_DEBUG_ANY,
5643 "pcache_initialize: register_oc #%d failed\n", i, 0, 0 );
5646 (*s_oc[i].ocp)->soc_flags |= SLAP_OC_HIDE;
5649 pcache.on_bi.bi_type = "pcache";
5650 pcache.on_bi.bi_obsolete_names = obsolete_names;
5651 pcache.on_bi.bi_db_init = pcache_db_init;
5652 pcache.on_bi.bi_db_config = pcache_db_config;
5653 pcache.on_bi.bi_db_open = pcache_db_open;
5654 pcache.on_bi.bi_db_close = pcache_db_close;
5655 pcache.on_bi.bi_db_destroy = pcache_db_destroy;
5657 pcache.on_bi.bi_op_search = pcache_op_search;
5658 pcache.on_bi.bi_op_bind = pcache_op_bind;
5659 #ifdef PCACHE_CONTROL_PRIVDB
5660 pcache.on_bi.bi_op_compare = pcache_op_privdb;
5661 pcache.on_bi.bi_op_modrdn = pcache_op_privdb;
5662 pcache.on_bi.bi_op_modify = pcache_op_privdb;
5663 pcache.on_bi.bi_op_add = pcache_op_privdb;
5664 pcache.on_bi.bi_op_delete = pcache_op_privdb;
5665 #endif /* PCACHE_CONTROL_PRIVDB */
5666 pcache.on_bi.bi_extended = pcache_op_extended;
5668 pcache.on_bi.bi_entry_release_rw = pcache_entry_release;
5669 pcache.on_bi.bi_chk_controls = pcache_chk_controls;
5671 pcache.on_bi.bi_cf_ocs = pcocs;
5673 code = config_register_schema( pccfg, pcocs );
5674 if ( code ) return code;
5676 return overlay_register( &pcache );
5679 #if SLAPD_OVER_PROXYCACHE == SLAPD_MOD_DYNAMIC
5680 int init_module(int argc, char *argv[]) {
5681 return pcache_initialize();
5685 #endif /* defined(SLAPD_OVER_PROXYCACHE) */