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 rc = syn_UUID->ssyn_pretty( syn_UUID, &tmpUUID, &uuid, NULL );
678 if ( rc != LDAP_SUCCESS ) {
683 } else if ( strncmp( lud->lud_exts[ i ], "x-attrset=", STRLENOF( "x-attrset=" ) ) == 0 ) {
684 if ( got & GOT_ATTRSET ) {
689 rc = lutil_atoi( &attrset, &lud->lud_exts[ i ][ STRLENOF( "x-attrset=" ) ] );
695 } else if ( strncmp( lud->lud_exts[ i ], "x-expiry=", STRLENOF( "x-expiry=" ) ) == 0 ) {
698 if ( got & GOT_EXPIRY ) {
703 rc = lutil_atoul( &l, &lud->lud_exts[ i ][ STRLENOF( "x-expiry=" ) ] );
707 expiry_time = (time_t)l;
710 } else if ( strncmp( lud->lud_exts[ i ], "x-answerable=", STRLENOF( "x-answerable=" ) ) == 0 ) {
711 if ( got & GOT_ANSWERABLE ) {
716 rc = lutil_atoul( &answerable_cnt, &lud->lud_exts[ i ][ STRLENOF( "x-answerable=" ) ] );
720 got |= GOT_ANSWERABLE;
722 } else if ( strncmp( lud->lud_exts[ i ], "x-refresh=", STRLENOF( "x-refresh=" ) ) == 0 ) {
725 if ( got & GOT_REFRESH ) {
730 rc = lutil_atoul( &l, &lud->lud_exts[ i ][ STRLENOF( "x-refresh=" ) ] );
734 refresh_time = (time_t)l;
743 if ( got != GOT_ALL ) {
748 if ( !(got & GOT_REFRESH ))
751 /* ignore expired queries */
752 if ( expiry_time <= slap_get_time()) {
755 memset( &op2.oq_search, 0, sizeof( op2.oq_search ) );
757 (void)remove_query_data( &op2, &uuid );
762 ber_str2bv( lud->lud_dn, 0, 0, &base );
763 rc = dnNormalize( 0, NULL, NULL, &base, &query.base, NULL );
764 if ( rc != LDAP_SUCCESS ) {
767 query.scope = lud->lud_scope;
768 query.filter = str2filter( lud->lud_filter );
769 if ( query.filter == NULL ) {
774 tempstr.bv_val = ch_malloc( strlen( lud->lud_filter ) + 1 );
776 if ( filter2template( op, query.filter, &tempstr ) ) {
777 ch_free( tempstr.bv_val );
782 /* check for query containment */
783 qt = qm->attr_sets[attrset].templates;
784 for ( ; qt; qt = qt->qtnext ) {
785 /* find if template i can potentially answer tempstr */
786 if ( bvmatch( &qt->querystr, &tempstr ) ) {
796 cq = add_query( op, qm, &query, qt, PC_POSITIVE, 0 );
798 cq->expiry_time = expiry_time;
799 cq->refresh_time = refresh_time;
801 cq->answerable_cnt = answerable_cnt;
804 /* it's now into cq->filter */
814 if ( query.filter != NULL ) filter_free( query.filter );
815 if ( !BER_BVISNULL( &tempstr ) ) ch_free( tempstr.bv_val );
816 if ( !BER_BVISNULL( &query.base ) ) ch_free( query.base.bv_val );
817 if ( !BER_BVISNULL( &uuid ) ) ch_free( uuid.bv_val );
818 if ( lud != NULL ) ldap_free_urldesc( lud );
823 /* Return 1 for an added entry, else 0 */
829 struct berval* query_uuid )
832 Modifications* modlist = NULL;
833 const char* text = NULL;
835 char textbuf[SLAP_TEXT_BUFLEN];
836 size_t textlen = sizeof(textbuf);
838 SlapReply sreply = {REP_RESULT};
840 slap_callback cb = { NULL, slap_null_cb, NULL, NULL };
847 /* add queryId attribute */
848 attr_merge_one( e, ad_queryId, query_uuid, NULL );
850 /* append the attribute list from the fetched entry */
851 e->e_attrs->a_next = attr;
853 op->o_tag = LDAP_REQ_ADD;
854 op->o_protocol = LDAP_VERSION3;
855 op->o_callback = &cb;
856 op->o_time = slap_get_time();
857 op->o_do_not_cache = 1;
860 op->o_req_dn = e->e_name;
861 op->o_req_ndn = e->e_nname;
862 rc = op->o_bd->be_add( op, &sreply );
864 if ( rc != LDAP_SUCCESS ) {
865 if ( rc == LDAP_ALREADY_EXISTS ) {
866 rs_reinit( &sreply, REP_RESULT );
867 slap_entry2mods( e, &modlist, &text, textbuf, textlen );
868 modlist->sml_op = LDAP_MOD_ADD;
869 op->o_tag = LDAP_REQ_MODIFY;
870 op->orm_modlist = modlist;
871 op->o_managedsait = SLAP_CONTROL_CRITICAL;
872 op->o_bd->be_modify( op, &sreply );
873 slap_mods_free( modlist, 1 );
874 } else if ( rc == LDAP_REFERRAL ||
875 rc == LDAP_NO_SUCH_OBJECT ) {
876 syncrepl_add_glue( op, e );
885 if ( op->ora_e == e )
893 /* Length-ordered sort on normalized DNs */
894 static int pcache_dn_cmp( const void *v1, const void *v2 )
896 const Qbase *q1 = v1, *q2 = v2;
898 int rc = q1->base.bv_len - q2->base.bv_len;
900 rc = strncmp( q1->base.bv_val, q2->base.bv_val, q1->base.bv_len );
904 static int lex_bvcmp( struct berval *bv1, struct berval *bv2 )
907 dif = bv1->bv_len - bv2->bv_len;
909 if ( dif > 0 ) len -= dif;
910 len = memcmp( bv1->bv_val, bv2->bv_val, len );
916 /* compare the current value in each filter */
917 static int pcache_filter_cmp( Filter *f1, Filter *f2 )
919 int rc, weight1, weight2;
921 switch( f1->f_choice ) {
922 case LDAP_FILTER_PRESENT:
925 case LDAP_FILTER_EQUALITY:
933 switch( f2->f_choice ) {
934 case LDAP_FILTER_PRESENT:
937 case LDAP_FILTER_EQUALITY:
945 rc = weight1 - weight2;
951 rc = lex_bvcmp( &f1->f_av_value, &f2->f_av_value );
954 if ( f1->f_choice == LDAP_FILTER_SUBSTRINGS ) {
956 if ( !BER_BVISNULL( &f1->f_sub_initial )) {
957 if ( !BER_BVISNULL( &f2->f_sub_initial )) {
958 rc = lex_bvcmp( &f1->f_sub_initial,
959 &f2->f_sub_initial );
963 } else if ( !BER_BVISNULL( &f2->f_sub_initial )) {
967 if ( f1->f_sub_any ) {
968 if ( f2->f_sub_any ) {
969 rc = lex_bvcmp( f1->f_sub_any,
974 } else if ( f2->f_sub_any ) {
978 if ( !BER_BVISNULL( &f1->f_sub_final )) {
979 if ( !BER_BVISNULL( &f2->f_sub_final )) {
980 rc = lex_bvcmp( &f1->f_sub_final,
985 } else if ( !BER_BVISNULL( &f2->f_sub_final )) {
989 rc = lex_bvcmp( &f1->f_mr_value,
1003 while ( f1->f_choice == LDAP_FILTER_AND || f1->f_choice == LDAP_FILTER_OR )
1005 while ( f2->f_choice == LDAP_FILTER_AND || f2->f_choice == LDAP_FILTER_OR )
1007 rc = pcache_filter_cmp( f1, f2 );
1015 /* compare filters in each query */
1016 static int pcache_query_cmp( const void *v1, const void *v2 )
1018 const CachedQuery *q1 = v1, *q2 =v2;
1019 return pcache_filter_cmp( q1->first, q2->first );
1022 /* add query on top of LRU list */
1024 add_query_on_top (query_manager* qm, CachedQuery* qc)
1026 CachedQuery* top = qm->lru_top;
1033 qm->lru_bottom = qc;
1037 Debug( pcache_debug, "Base of added query = %s\n",
1038 qc->qbase->base.bv_val, 0, 0 );
1041 /* remove_query from LRU list */
1044 remove_query (query_manager* qm, CachedQuery* qc)
1053 down = qc->lru_down;
1059 qm->lru_bottom = up;
1065 up->lru_down = down;
1067 qc->lru_up = qc->lru_down = NULL;
1070 /* find and remove string2 from string1
1071 * from start if position = 1,
1072 * from end if position = 3,
1073 * from anywhere if position = 2
1074 * string1 is overwritten if position = 2.
1078 find_and_remove(struct berval* ber1, struct berval* ber2, int position)
1082 if ( !ber2->bv_val )
1084 if ( !ber1->bv_val )
1087 switch( position ) {
1089 if ( ber1->bv_len >= ber2->bv_len && !memcmp( ber1->bv_val,
1090 ber2->bv_val, ber2->bv_len )) {
1092 ber1->bv_val += ber2->bv_len;
1093 ber1->bv_len -= ber2->bv_len;
1098 ber1->bv_val[ber1->bv_len] = '\0';
1099 temp = strstr( ber1->bv_val, ber2->bv_val );
1101 strcpy( temp, temp+ber2->bv_len );
1102 ber1->bv_len -= ber2->bv_len;
1108 if ( ber1->bv_len >= ber2->bv_len &&
1109 !memcmp( ber1->bv_val+ber1->bv_len-ber2->bv_len, ber2->bv_val,
1112 ber1->bv_len -= ber2->bv_len;
1120 static struct berval*
1121 merge_init_final(Operation *op, struct berval* init, struct berval* any,
1122 struct berval* final)
1124 struct berval* merged, *temp;
1125 int i, any_count, count;
1127 for (any_count=0; any && any[any_count].bv_val; any_count++)
1137 merged = (struct berval*)op->o_tmpalloc( (count+1)*sizeof(struct berval),
1142 ber_dupbv_x( temp, init, op->o_tmpmemctx );
1146 for (i=0; i<any_count; i++) {
1147 ber_dupbv_x( temp, any, op->o_tmpmemctx );
1152 ber_dupbv_x( temp, final, op->o_tmpmemctx );
1159 /* Each element in stored must be found in incoming. Incoming is overwritten.
1162 strings_containment(struct berval* stored, struct berval* incoming)
1164 struct berval* element;
1168 for ( element=stored; element->bv_val != NULL; element++ ) {
1169 for (j = k; incoming[j].bv_val != NULL; j++) {
1170 if (find_and_remove(&(incoming[j]), element, 2)) {
1187 substr_containment_substr(Operation *op, Filter* stored, Filter* incoming)
1191 struct berval init_incoming;
1192 struct berval final_incoming;
1193 struct berval *remaining_incoming = NULL;
1195 if ((!(incoming->f_sub_initial.bv_val) && (stored->f_sub_initial.bv_val))
1196 || (!(incoming->f_sub_final.bv_val) && (stored->f_sub_final.bv_val)))
1199 init_incoming = incoming->f_sub_initial;
1200 final_incoming = incoming->f_sub_final;
1202 if (find_and_remove(&init_incoming,
1203 &(stored->f_sub_initial), 1) && find_and_remove(&final_incoming,
1204 &(stored->f_sub_final), 3))
1206 if (stored->f_sub_any == NULL) {
1210 remaining_incoming = merge_init_final(op, &init_incoming,
1211 incoming->f_sub_any, &final_incoming);
1212 rc = strings_containment(stored->f_sub_any, remaining_incoming);
1213 ber_bvarray_free_x( remaining_incoming, op->o_tmpmemctx );
1220 substr_containment_equality(Operation *op, Filter* stored, Filter* incoming)
1222 struct berval incoming_val[2];
1225 incoming_val[1] = incoming->f_av_value;
1227 if (find_and_remove(incoming_val+1,
1228 &(stored->f_sub_initial), 1) && find_and_remove(incoming_val+1,
1229 &(stored->f_sub_final), 3)) {
1230 if (stored->f_sub_any == NULL){
1234 ber_dupbv_x( incoming_val, incoming_val+1, op->o_tmpmemctx );
1235 BER_BVZERO( incoming_val+1 );
1236 rc = strings_containment(stored->f_sub_any, incoming_val);
1237 op->o_tmpfree( incoming_val[0].bv_val, op->o_tmpmemctx );
1244 filter_first( Filter *f )
1246 while ( f->f_choice == LDAP_FILTER_OR || f->f_choice == LDAP_FILTER_AND )
1252 static CachedQuery *
1253 find_filter( Operation *op, Avlnode *root, Filter *inputf, Filter *first )
1257 MatchingRule* mrule = NULL;
1258 int res=0, eqpass= 0;
1261 CachedQuery cq, *qc;
1266 /* substring matches sort to the end, and we just have to
1267 * walk the entire list.
1269 if ( first->f_choice == LDAP_FILTER_SUBSTRINGS ) {
1270 ptr = tavl_end( root, 1 );
1271 dir = TAVL_DIR_LEFT;
1273 ptr = tavl_find3( root, &cq, pcache_query_cmp, &ret );
1274 dir = (first->f_choice == LDAP_FILTER_GE) ? TAVL_DIR_LEFT :
1283 /* an incoming substr query can only be satisfied by a cached
1286 if ( first->f_choice == LDAP_FILTER_SUBSTRINGS &&
1287 qc->first->f_choice != LDAP_FILTER_SUBSTRINGS )
1290 /* an incoming eq query can be satisfied by a cached eq or substr
1293 if ( first->f_choice == LDAP_FILTER_EQUALITY ) {
1294 if ( eqpass == 0 ) {
1295 if ( qc->first->f_choice != LDAP_FILTER_EQUALITY ) {
1296 nextpass: eqpass = 1;
1297 ptr = tavl_end( root, 1 );
1298 dir = TAVL_DIR_LEFT;
1302 if ( qc->first->f_choice != LDAP_FILTER_SUBSTRINGS )
1308 switch (fs->f_choice) {
1309 case LDAP_FILTER_EQUALITY:
1310 if (fi->f_choice == LDAP_FILTER_EQUALITY)
1311 mrule = fs->f_ava->aa_desc->ad_type->sat_equality;
1315 case LDAP_FILTER_GE:
1316 case LDAP_FILTER_LE:
1317 mrule = fs->f_ava->aa_desc->ad_type->sat_ordering;
1324 rc = value_match(&ret, fs->f_ava->aa_desc, mrule,
1325 SLAP_MR_VALUE_OF_ASSERTION_SYNTAX,
1326 &(fi->f_ava->aa_value),
1327 &(fs->f_ava->aa_value), &text);
1328 if (rc != LDAP_SUCCESS) {
1331 if ( fi==first && fi->f_choice==LDAP_FILTER_EQUALITY && ret )
1334 switch (fs->f_choice) {
1335 case LDAP_FILTER_OR:
1336 case LDAP_FILTER_AND:
1341 case LDAP_FILTER_SUBSTRINGS:
1342 /* check if the equality query can be
1343 * answered with cached substring query */
1344 if ((fi->f_choice == LDAP_FILTER_EQUALITY)
1345 && substr_containment_equality( op,
1348 /* check if the substring query can be
1349 * answered with cached substring query */
1350 if ((fi->f_choice ==LDAP_FILTER_SUBSTRINGS
1351 ) && substr_containment_substr( op,
1357 case LDAP_FILTER_PRESENT:
1362 case LDAP_FILTER_EQUALITY:
1368 case LDAP_FILTER_GE:
1369 if (mrule && ret >= 0)
1374 case LDAP_FILTER_LE:
1375 if (mrule && ret <= 0)
1380 case LDAP_FILTER_NOT:
1386 } while((res) && (fi != NULL) && (fs != NULL));
1390 ptr = tavl_next( ptr, dir );
1395 /* check whether query is contained in any of
1396 * the cached queries in template
1398 static CachedQuery *
1399 query_containment(Operation *op, query_manager *qm,
1401 QueryTemplate *templa)
1404 int depth = 0, tscope;
1405 Qbase qbase, *qbptr = NULL;
1408 if (query->filter != NULL) {
1411 Debug( pcache_debug, "Lock QC index = %p\n",
1412 (void *) templa, 0, 0 );
1413 qbase.base = query->base;
1415 first = filter_first( query->filter );
1417 ldap_pvt_thread_rdwr_rlock(&templa->t_rwlock);
1420 qbptr = avl_find( templa->qbase, &qbase, pcache_dn_cmp );
1422 tscope = query->scope;
1423 /* Find a matching scope:
1424 * match at depth 0 OK
1427 * subord at depth > 0 OK
1428 * subtree at any depth OK
1430 * subtree or subord at any depth OK
1432 * subtree or subord at any depth OK
1434 * subord at depth > 0 OK
1435 * subtree at any depth OK
1437 for ( tscope = 0 ; tscope <= LDAP_SCOPE_CHILDREN; tscope++ ) {
1438 switch ( query->scope ) {
1439 case LDAP_SCOPE_BASE:
1440 if ( tscope == LDAP_SCOPE_BASE && depth ) continue;
1441 if ( tscope == LDAP_SCOPE_ONE && depth != 1) continue;
1442 if ( tscope == LDAP_SCOPE_CHILDREN && !depth ) continue;
1444 case LDAP_SCOPE_ONE:
1445 if ( tscope == LDAP_SCOPE_BASE )
1446 tscope = LDAP_SCOPE_ONE;
1447 if ( tscope == LDAP_SCOPE_ONE && depth ) continue;
1448 if ( !depth ) break;
1449 if ( tscope < LDAP_SCOPE_SUBTREE )
1450 tscope = LDAP_SCOPE_SUBTREE;
1452 case LDAP_SCOPE_SUBTREE:
1453 if ( tscope < LDAP_SCOPE_SUBTREE )
1454 tscope = LDAP_SCOPE_SUBTREE;
1455 if ( tscope == LDAP_SCOPE_CHILDREN && !depth ) continue;
1457 case LDAP_SCOPE_CHILDREN:
1458 if ( tscope < LDAP_SCOPE_SUBTREE )
1459 tscope = LDAP_SCOPE_SUBTREE;
1462 if ( !qbptr->scopes[tscope] ) continue;
1465 qc = find_filter( op, qbptr->scopes[tscope],
1466 query->filter, first );
1468 if ( qc->q_sizelimit ) {
1469 ldap_pvt_thread_rdwr_runlock(&templa->t_rwlock);
1472 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
1473 if (qm->lru_top != qc) {
1474 remove_query(qm, qc);
1475 add_query_on_top(qm, qc);
1477 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1482 if ( be_issuffix( op->o_bd, &qbase.base ))
1485 dnParent( &qbase.base, &pdn );
1490 Debug( pcache_debug,
1491 "Not answerable: Unlock QC index=%p\n",
1492 (void *) templa, 0, 0 );
1493 ldap_pvt_thread_rdwr_runlock(&templa->t_rwlock);
1499 free_query (CachedQuery* qc)
1501 free(qc->q_uuid.bv_val);
1502 filter_free(qc->filter);
1503 ldap_pvt_thread_mutex_destroy(&qc->answerable_cnt_mutex);
1504 ldap_pvt_thread_rdwr_destroy( &qc->rwlock );
1505 memset(qc, 0, sizeof(*qc));
1510 /* Add query to query cache, the returned Query is locked for writing */
1511 static CachedQuery *
1516 QueryTemplate *templ,
1517 pc_caching_reason_t why,
1520 CachedQuery* new_cached_query = (CachedQuery*) ch_malloc(sizeof(CachedQuery));
1524 time_t ttl = 0, ttr = 0;
1527 new_cached_query->qtemp = templ;
1528 BER_BVZERO( &new_cached_query->q_uuid );
1529 new_cached_query->q_sizelimit = 0;
1531 now = slap_get_time();
1536 ttr = now + templ->ttr;
1540 ttl = templ->negttl;
1544 ttl = templ->limitttl;
1551 new_cached_query->expiry_time = now + ttl;
1552 new_cached_query->refresh_time = ttr;
1554 new_cached_query->answerable_cnt = 0;
1555 new_cached_query->refcnt = 1;
1556 ldap_pvt_thread_mutex_init(&new_cached_query->answerable_cnt_mutex);
1558 new_cached_query->lru_up = NULL;
1559 new_cached_query->lru_down = NULL;
1560 Debug( pcache_debug, "Added query expires at %ld (%s)\n",
1561 (long) new_cached_query->expiry_time,
1562 pc_caching_reason_str[ why ], 0 );
1564 new_cached_query->scope = query->scope;
1565 new_cached_query->filter = query->filter;
1566 new_cached_query->first = first = filter_first( query->filter );
1568 ldap_pvt_thread_rdwr_init(&new_cached_query->rwlock);
1570 ldap_pvt_thread_rdwr_wlock(&new_cached_query->rwlock);
1572 qb.base = query->base;
1574 /* Adding a query */
1575 Debug( pcache_debug, "Lock AQ index = %p\n",
1576 (void *) templ, 0, 0 );
1577 ldap_pvt_thread_rdwr_wlock(&templ->t_rwlock);
1578 qbase = avl_find( templ->qbase, &qb, pcache_dn_cmp );
1580 qbase = ch_calloc( 1, sizeof(Qbase) + qb.base.bv_len + 1 );
1581 qbase->base.bv_len = qb.base.bv_len;
1582 qbase->base.bv_val = (char *)(qbase+1);
1583 memcpy( qbase->base.bv_val, qb.base.bv_val, qb.base.bv_len );
1584 qbase->base.bv_val[qbase->base.bv_len] = '\0';
1585 avl_insert( &templ->qbase, qbase, pcache_dn_cmp, avl_dup_error );
1587 new_cached_query->next = templ->query;
1588 new_cached_query->prev = NULL;
1589 new_cached_query->qbase = qbase;
1590 rc = tavl_insert( &qbase->scopes[query->scope], new_cached_query,
1591 pcache_query_cmp, avl_dup_error );
1594 if (templ->query == NULL)
1595 templ->query_last = new_cached_query;
1597 templ->query->prev = new_cached_query;
1598 templ->query = new_cached_query;
1599 templ->no_of_queries++;
1601 ldap_pvt_thread_mutex_destroy(&new_cached_query->answerable_cnt_mutex);
1602 ldap_pvt_thread_rdwr_destroy( &new_cached_query->rwlock );
1603 ch_free( new_cached_query );
1604 new_cached_query = find_filter( op, qbase->scopes[query->scope],
1605 query->filter, first );
1606 filter_free( query->filter );
1607 query->filter = NULL;
1609 Debug( pcache_debug, "TEMPLATE %p QUERIES++ %d\n",
1610 (void *) templ, templ->no_of_queries, 0 );
1612 Debug( pcache_debug, "Unlock AQ index = %p \n",
1613 (void *) templ, 0, 0 );
1614 ldap_pvt_thread_rdwr_wunlock(&templ->t_rwlock);
1616 /* Adding on top of LRU list */
1618 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
1619 add_query_on_top(qm, new_cached_query);
1620 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1622 return rc == 0 ? new_cached_query : NULL;
1626 remove_from_template (CachedQuery* qc, QueryTemplate* template)
1628 if (!qc->prev && !qc->next) {
1629 template->query_last = template->query = NULL;
1630 } else if (qc->prev == NULL) {
1631 qc->next->prev = NULL;
1632 template->query = qc->next;
1633 } else if (qc->next == NULL) {
1634 qc->prev->next = NULL;
1635 template->query_last = qc->prev;
1637 qc->next->prev = qc->prev;
1638 qc->prev->next = qc->next;
1640 tavl_delete( &qc->qbase->scopes[qc->scope], qc, pcache_query_cmp );
1641 qc->qbase->queries--;
1642 if ( qc->qbase->queries == 0 ) {
1643 avl_delete( &template->qbase, qc->qbase, pcache_dn_cmp );
1644 ch_free( qc->qbase );
1648 template->no_of_queries--;
1651 /* remove bottom query of LRU list from the query cache */
1653 * NOTE: slight change in functionality.
1655 * - if result->bv_val is NULL, the query at the bottom of the LRU
1657 * - otherwise, the query whose UUID is *result is removed
1658 * - if not found, result->bv_val is zeroed
1661 cache_replacement(query_manager* qm, struct berval *result)
1663 CachedQuery* bottom;
1664 QueryTemplate *temp;
1666 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
1667 if ( BER_BVISNULL( result ) ) {
1668 bottom = qm->lru_bottom;
1671 Debug ( pcache_debug,
1672 "Cache replacement invoked without "
1673 "any query in LRU list\n", 0, 0, 0 );
1674 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1679 for ( bottom = qm->lru_bottom;
1681 bottom = bottom->lru_up )
1683 if ( bvmatch( result, &bottom->q_uuid ) ) {
1689 Debug ( pcache_debug,
1690 "Could not find query with uuid=\"%s\""
1691 "in LRU list\n", result->bv_val, 0, 0 );
1692 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1693 BER_BVZERO( result );
1698 temp = bottom->qtemp;
1699 remove_query(qm, bottom);
1700 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1702 *result = bottom->q_uuid;
1703 BER_BVZERO( &bottom->q_uuid );
1705 Debug( pcache_debug, "Lock CR index = %p\n", (void *) temp, 0, 0 );
1706 ldap_pvt_thread_rdwr_wlock(&temp->t_rwlock);
1707 remove_from_template(bottom, temp);
1708 Debug( pcache_debug, "TEMPLATE %p QUERIES-- %d\n",
1709 (void *) temp, temp->no_of_queries, 0 );
1710 Debug( pcache_debug, "Unlock CR index = %p\n", (void *) temp, 0, 0 );
1711 ldap_pvt_thread_rdwr_wunlock(&temp->t_rwlock);
1716 struct query_info *next;
1728 struct query_info *qi;
1731 if ( rs->sr_type != REP_SEARCH ) return 0;
1733 attr = attr_find( rs->sr_entry->e_attrs, ad_queryId );
1734 if ( attr == NULL ) return 0;
1736 count = attr->a_numvals;
1737 assert( count > 0 );
1738 qi = op->o_tmpalloc( sizeof( struct query_info ), op->o_tmpmemctx );
1739 qi->next = op->o_callback->sc_private;
1740 op->o_callback->sc_private = qi;
1741 ber_dupbv_x( &qi->xdn, &rs->sr_entry->e_nname, op->o_tmpmemctx );
1742 qi->del = ( count == 1 );
1750 struct berval *query_uuid )
1752 struct query_info *qi, *qnext;
1753 char filter_str[ LDAP_LUTIL_UUIDSTR_BUFSIZE + STRLENOF( "(pcacheQueryID=)" ) ];
1754 AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
1755 Filter filter = {LDAP_FILTER_EQUALITY};
1756 SlapReply sreply = {REP_RESULT};
1757 slap_callback cb = { NULL, remove_func, NULL, NULL };
1760 op->ors_filterstr.bv_len = snprintf(filter_str, sizeof(filter_str),
1761 "(%s=%s)", ad_queryId->ad_cname.bv_val, query_uuid->bv_val);
1762 filter.f_ava = &ava;
1763 filter.f_av_desc = ad_queryId;
1764 filter.f_av_value = *query_uuid;
1766 op->o_tag = LDAP_REQ_SEARCH;
1767 op->o_protocol = LDAP_VERSION3;
1768 op->o_callback = &cb;
1769 op->o_time = slap_get_time();
1770 op->o_do_not_cache = 1;
1772 op->o_req_dn = op->o_bd->be_suffix[0];
1773 op->o_req_ndn = op->o_bd->be_nsuffix[0];
1774 op->ors_scope = LDAP_SCOPE_SUBTREE;
1775 op->ors_deref = LDAP_DEREF_NEVER;
1776 op->ors_slimit = SLAP_NO_LIMIT;
1777 op->ors_tlimit = SLAP_NO_LIMIT;
1778 op->ors_limit = NULL;
1779 op->ors_filter = &filter;
1780 op->ors_filterstr.bv_val = filter_str;
1781 op->ors_filterstr.bv_len = strlen(filter_str);
1782 op->ors_attrs = NULL;
1783 op->ors_attrsonly = 0;
1785 op->o_bd->be_search( op, &sreply );
1787 for ( qi=cb.sc_private; qi; qi=qnext ) {
1790 op->o_req_dn = qi->xdn;
1791 op->o_req_ndn = qi->xdn;
1792 rs_reinit( &sreply, REP_RESULT );
1795 Debug( pcache_debug, "DELETING ENTRY TEMPLATE=%s\n",
1796 query_uuid->bv_val, 0, 0 );
1798 op->o_tag = LDAP_REQ_DELETE;
1800 if (op->o_bd->be_delete(op, &sreply) == LDAP_SUCCESS) {
1806 struct berval vals[2];
1808 vals[0] = *query_uuid;
1809 vals[1].bv_val = NULL;
1811 mod.sml_op = LDAP_MOD_DELETE;
1813 mod.sml_desc = ad_queryId;
1814 mod.sml_type = ad_queryId->ad_cname;
1815 mod.sml_values = vals;
1816 mod.sml_nvalues = NULL;
1817 mod.sml_numvals = 1;
1818 mod.sml_next = NULL;
1819 Debug( pcache_debug,
1820 "REMOVING TEMP ATTR : TEMPLATE=%s\n",
1821 query_uuid->bv_val, 0, 0 );
1823 op->orm_modlist = &mod;
1825 op->o_bd->be_modify( op, &sreply );
1827 op->o_tmpfree( qi->xdn.bv_val, op->o_tmpmemctx );
1828 op->o_tmpfree( qi, op->o_tmpmemctx );
1835 AttributeName* attrs,
1844 struct berval *fstr )
1846 AttributeDescription *ad;
1849 switch ( f->f_choice ) {
1850 case LDAP_FILTER_EQUALITY:
1852 len = STRLENOF( "(=)" ) + ad->ad_cname.bv_len;
1853 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s=)", ad->ad_cname.bv_val );
1854 assert( ret == len );
1855 fstr->bv_len += len;
1858 case LDAP_FILTER_GE:
1860 len = STRLENOF( "(>=)" ) + ad->ad_cname.bv_len;
1861 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s>=)", ad->ad_cname.bv_val);
1862 assert( ret == len );
1863 fstr->bv_len += len;
1866 case LDAP_FILTER_LE:
1868 len = STRLENOF( "(<=)" ) + ad->ad_cname.bv_len;
1869 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s<=)", ad->ad_cname.bv_val);
1870 assert( ret == len );
1871 fstr->bv_len += len;
1874 case LDAP_FILTER_APPROX:
1876 len = STRLENOF( "(~=)" ) + ad->ad_cname.bv_len;
1877 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s~=)", ad->ad_cname.bv_val);
1878 assert( ret == len );
1879 fstr->bv_len += len;
1882 case LDAP_FILTER_SUBSTRINGS:
1884 len = STRLENOF( "(=)" ) + ad->ad_cname.bv_len;
1885 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s=)", ad->ad_cname.bv_val );
1886 assert( ret == len );
1887 fstr->bv_len += len;
1890 case LDAP_FILTER_PRESENT:
1892 len = STRLENOF( "(=*)" ) + ad->ad_cname.bv_len;
1893 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s=*)", ad->ad_cname.bv_val );
1894 assert( ret == len );
1895 fstr->bv_len += len;
1898 case LDAP_FILTER_AND:
1899 case LDAP_FILTER_OR:
1900 case LDAP_FILTER_NOT: {
1902 fstr->bv_val[fstr->bv_len++] = '(';
1903 switch ( f->f_choice ) {
1904 case LDAP_FILTER_AND:
1905 fstr->bv_val[fstr->bv_len] = '&';
1907 case LDAP_FILTER_OR:
1908 fstr->bv_val[fstr->bv_len] = '|';
1910 case LDAP_FILTER_NOT:
1911 fstr->bv_val[fstr->bv_len] = '!';
1916 for ( f = f->f_list; f != NULL; f = f->f_next ) {
1917 rc = filter2template( op, f, fstr );
1920 fstr->bv_val[fstr->bv_len++] = ')';
1921 fstr->bv_val[fstr->bv_len] = '\0';
1927 /* a filter should at least have room for "()",
1928 * an "=" and for a 1-char attr */
1929 strcpy( fstr->bv_val, "(?=)" );
1930 fstr->bv_len += STRLENOF("(?=)");
1937 #define BI_HASHED 0x01
1938 #define BI_DIDCB 0x02
1939 #define BI_LOOKUP 0x04
1943 typedef struct bindinfo {
1944 cache_manager *bi_cm;
1946 QueryTemplate *bi_templ;
1947 struct search_info *bi_si;
1949 slap_callback bi_cb;
1952 struct search_info {
1955 QueryTemplate *qtemp;
1956 AttributeName* save_attrs; /* original attributes, saved for response */
1957 int swap_saved_attrs;
1962 int slimit_exceeded;
1963 pc_caching_reason_t caching_reason;
1969 remove_query_and_data(
1972 struct berval *uuid )
1974 query_manager* qm = cm->qm;
1976 qm->crfunc( qm, uuid );
1977 if ( !BER_BVISNULL( uuid ) ) {
1980 Debug( pcache_debug,
1981 "Removing query UUID %s\n",
1982 uuid->bv_val, 0, 0 );
1983 return_val = remove_query_data( op, uuid );
1984 Debug( pcache_debug,
1985 "QUERY REMOVED, SIZE=%d\n",
1987 ldap_pvt_thread_mutex_lock( &cm->cache_mutex );
1988 cm->cur_entries -= return_val;
1989 cm->num_cached_queries--;
1990 Debug( pcache_debug,
1991 "STORED QUERIES = %lu\n",
1992 cm->num_cached_queries, 0, 0 );
1993 ldap_pvt_thread_mutex_unlock( &cm->cache_mutex );
1994 Debug( pcache_debug,
1995 "QUERY REMOVED, CACHE ="
1997 cm->cur_entries, 0, 0 );
2002 * Callback used to fetch queryId values based on entryUUID;
2003 * used by pcache_remove_entries_from_cache()
2006 fetch_queryId_cb( Operation *op, SlapReply *rs )
2010 /* only care about searchEntry responses */
2011 if ( rs->sr_type != REP_SEARCH ) {
2015 /* allow only one response per entryUUID */
2016 if ( op->o_callback->sc_private != NULL ) {
2022 /* copy all queryId values into callback's private data */
2023 a = attr_find( rs->sr_entry->e_attrs, ad_queryId );
2025 BerVarray vals = NULL;
2027 ber_bvarray_dup_x( &vals, a->a_nvals, op->o_tmpmemctx );
2028 op->o_callback->sc_private = (void *)vals;
2032 /* clear entry if required */
2033 rs_flush_entry( op, rs, (slap_overinst *) op->o_bd->bd_info );
2039 * Call that allows to remove a set of entries from the cache,
2040 * by forcing the removal of all the related queries.
2043 pcache_remove_entries_from_cache(
2046 BerVarray entryUUIDs )
2048 Connection conn = { 0 };
2049 OperationBuffer opbuf;
2051 slap_callback sc = { 0 };
2053 char filtbuf[ LDAP_LUTIL_UUIDSTR_BUFSIZE + STRLENOF( "(entryUUID=)" ) ];
2054 AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
2055 AttributeName attrs[ 2 ] = {{{ 0 }}};
2059 void *thrctx = ldap_pvt_thread_pool_context();
2061 connection_fake_init( &conn, &opbuf, thrctx );
2069 memset( &op->oq_search, 0, sizeof( op->oq_search ) );
2070 op->ors_scope = LDAP_SCOPE_SUBTREE;
2071 op->ors_deref = LDAP_DEREF_NEVER;
2072 f.f_choice = LDAP_FILTER_EQUALITY;
2074 ava.aa_desc = slap_schema.si_ad_entryUUID;
2075 op->ors_filter = &f;
2077 op->ors_tlimit = SLAP_NO_LIMIT;
2078 op->ors_limit = NULL;
2079 attrs[ 0 ].an_desc = ad_queryId;
2080 attrs[ 0 ].an_name = ad_queryId->ad_cname;
2081 op->ors_attrs = attrs;
2082 op->ors_attrsonly = 0;
2084 op->o_req_dn = cm->db.be_suffix[ 0 ];
2085 op->o_req_ndn = cm->db.be_nsuffix[ 0 ];
2087 op->o_tag = LDAP_REQ_SEARCH;
2088 op->o_protocol = LDAP_VERSION3;
2089 op->o_managedsait = SLAP_CONTROL_CRITICAL;
2091 op->o_dn = op->o_bd->be_rootdn;
2092 op->o_ndn = op->o_bd->be_rootndn;
2093 sc.sc_response = fetch_queryId_cb;
2094 op->o_callback = ≻
2096 for ( s = 0; !BER_BVISNULL( &entryUUIDs[ s ] ); s++ ) {
2097 BerVarray vals = NULL;
2098 SlapReply rs = { REP_RESULT };
2100 op->ors_filterstr.bv_len = snprintf( filtbuf, sizeof( filtbuf ),
2101 "(entryUUID=%s)", entryUUIDs[ s ].bv_val );
2102 op->ors_filterstr.bv_val = filtbuf;
2103 ava.aa_value = entryUUIDs[ s ];
2105 rc = op->o_bd->be_search( op, &rs );
2106 if ( rc != LDAP_SUCCESS ) {
2110 vals = (BerVarray)op->o_callback->sc_private;
2111 if ( vals != NULL ) {
2114 for ( i = 0; !BER_BVISNULL( &vals[ i ] ); i++ ) {
2115 struct berval val = vals[ i ];
2117 remove_query_and_data( op, cm, &val );
2119 if ( !BER_BVISNULL( &val ) && val.bv_val != vals[ i ].bv_val ) {
2120 ch_free( val.bv_val );
2124 ber_bvarray_free_x( vals, op->o_tmpmemctx );
2125 op->o_callback->sc_private = NULL;
2133 * Call that allows to remove a query from the cache.
2136 pcache_remove_query_from_cache(
2139 struct berval *queryid )
2141 Operation op2 = *op;
2145 /* remove the selected query */
2146 remove_query_and_data( &op2, cm, queryid );
2148 return LDAP_SUCCESS;
2152 * Call that allows to remove a set of queries related to an entry
2153 * from the cache; if queryid is not null, the entry must belong to
2154 * the query indicated by queryid.
2157 pcache_remove_entry_queries_from_cache(
2161 struct berval *queryid )
2163 Connection conn = { 0 };
2164 OperationBuffer opbuf;
2166 slap_callback sc = { 0 };
2167 SlapReply rs = { REP_RESULT };
2169 char filter_str[ LDAP_LUTIL_UUIDSTR_BUFSIZE + STRLENOF( "(pcacheQueryID=)" ) ];
2170 AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
2171 AttributeName attrs[ 2 ] = {{{ 0 }}};
2174 BerVarray vals = NULL;
2177 void *thrctx = ldap_pvt_thread_pool_context();
2179 connection_fake_init( &conn, &opbuf, thrctx );
2187 memset( &op->oq_search, 0, sizeof( op->oq_search ) );
2188 op->ors_scope = LDAP_SCOPE_BASE;
2189 op->ors_deref = LDAP_DEREF_NEVER;
2190 if ( queryid == NULL || BER_BVISNULL( queryid ) ) {
2191 BER_BVSTR( &op->ors_filterstr, "(objectClass=*)" );
2192 f.f_choice = LDAP_FILTER_PRESENT;
2193 f.f_desc = slap_schema.si_ad_objectClass;
2196 op->ors_filterstr.bv_len = snprintf( filter_str,
2197 sizeof( filter_str ), "(%s=%s)",
2198 ad_queryId->ad_cname.bv_val, queryid->bv_val );
2199 f.f_choice = LDAP_FILTER_EQUALITY;
2201 f.f_av_desc = ad_queryId;
2202 f.f_av_value = *queryid;
2204 op->ors_filter = &f;
2206 op->ors_tlimit = SLAP_NO_LIMIT;
2207 op->ors_limit = NULL;
2208 attrs[ 0 ].an_desc = ad_queryId;
2209 attrs[ 0 ].an_name = ad_queryId->ad_cname;
2210 op->ors_attrs = attrs;
2211 op->ors_attrsonly = 0;
2213 op->o_req_dn = *ndn;
2214 op->o_req_ndn = *ndn;
2216 op->o_tag = LDAP_REQ_SEARCH;
2217 op->o_protocol = LDAP_VERSION3;
2218 op->o_managedsait = SLAP_CONTROL_CRITICAL;
2220 op->o_dn = op->o_bd->be_rootdn;
2221 op->o_ndn = op->o_bd->be_rootndn;
2222 sc.sc_response = fetch_queryId_cb;
2223 op->o_callback = ≻
2225 rc = op->o_bd->be_search( op, &rs );
2226 if ( rc != LDAP_SUCCESS ) {
2230 vals = (BerVarray)op->o_callback->sc_private;
2231 if ( vals != NULL ) {
2234 for ( i = 0; !BER_BVISNULL( &vals[ i ] ); i++ ) {
2235 struct berval val = vals[ i ];
2237 remove_query_and_data( op, cm, &val );
2239 if ( !BER_BVISNULL( &val ) && val.bv_val != vals[ i ].bv_val ) {
2240 ch_free( val.bv_val );
2244 ber_bvarray_free_x( vals, op->o_tmpmemctx );
2247 return LDAP_SUCCESS;
2253 struct berval *query_uuid )
2255 struct search_info *si = op->o_callback->sc_private;
2256 slap_overinst *on = si->on;
2257 cache_manager *cm = on->on_bi.bi_private;
2260 struct berval crp_uuid;
2261 char uuidbuf[ LDAP_LUTIL_UUIDSTR_BUFSIZE ];
2263 Connection conn = {0};
2264 OperationBuffer opbuf;
2265 void *thrctx = ldap_pvt_thread_pool_context();
2267 query_uuid->bv_len = lutil_uuidstr(uuidbuf, sizeof(uuidbuf));
2268 ber_str2bv(uuidbuf, query_uuid->bv_len, 1, query_uuid);
2270 connection_fake_init2( &conn, &opbuf, thrctx, 0 );
2271 op_tmp = &opbuf.ob_op;
2272 op_tmp->o_bd = &cm->db;
2273 op_tmp->o_dn = cm->db.be_rootdn;
2274 op_tmp->o_ndn = cm->db.be_rootndn;
2276 Debug( pcache_debug, "UUID for query being added = %s\n",
2279 for ( e=si->head; e; e=si->head ) {
2280 si->head = e->e_private;
2281 e->e_private = NULL;
2282 while ( cm->cur_entries > (cm->max_entries) ) {
2283 BER_BVZERO( &crp_uuid );
2284 remove_query_and_data( op_tmp, cm, &crp_uuid );
2287 return_val = merge_entry(op_tmp, e, 0, query_uuid);
2288 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
2289 cm->cur_entries += return_val;
2290 Debug( pcache_debug,
2291 "ENTRY ADDED/MERGED, CACHED ENTRIES=%d\n",
2292 cm->cur_entries, 0, 0 );
2294 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
2301 pcache_op_cleanup( Operation *op, SlapReply *rs ) {
2302 slap_callback *cb = op->o_callback;
2303 struct search_info *si = cb->sc_private;
2304 slap_overinst *on = si->on;
2305 cache_manager *cm = on->on_bi.bi_private;
2306 query_manager* qm = cm->qm;
2308 if ( rs->sr_type == REP_SEARCH ) {
2311 /* don't return more entries than requested by the client */
2312 if ( si->slimit > 0 && rs->sr_nentries >= si->slimit ) {
2313 si->slimit_exceeded = 1;
2316 /* If we haven't exceeded the limit for this query,
2317 * build a chain of answers to store. If we hit the
2318 * limit, empty the chain and ignore the rest.
2321 /* check if the entry contains undefined
2322 * attributes/objectClasses (ITS#5680) */
2323 if ( cm->check_cacheability && test_filter( op, rs->sr_entry, si->query.filter ) != LDAP_COMPARE_TRUE ) {
2324 Debug( pcache_debug, "%s: query not cacheable because of schema issues in DN \"%s\"\n",
2325 op->o_log_prefix, rs->sr_entry->e_name.bv_val, 0 );
2329 /* check for malformed entries: attrs with no values */
2331 Attribute *a = rs->sr_entry->e_attrs;
2332 for (; a; a=a->a_next) {
2333 if ( !a->a_numvals ) {
2334 Debug( pcache_debug, "%s: query not cacheable because of attrs without values in DN \"%s\" (%s)\n",
2335 op->o_log_prefix, rs->sr_entry->e_name.bv_val,
2336 a->a_desc->ad_cname.bv_val );
2342 if ( si->count < si->max ) {
2344 e = entry_dup( rs->sr_entry );
2345 if ( !si->head ) si->head = e;
2346 if ( si->tail ) si->tail->e_private = e;
2353 for (;si->head; si->head=e) {
2354 e = si->head->e_private;
2355 si->head->e_private = NULL;
2356 entry_free(si->head);
2364 if ( rs->sr_type == REP_RESULT ||
2365 op->o_abandon || rs->sr_err == SLAPD_ABANDON )
2367 if ( si->swap_saved_attrs ) {
2368 rs->sr_attrs = si->save_attrs;
2369 op->ors_attrs = si->save_attrs;
2371 if ( (op->o_abandon || rs->sr_err == SLAPD_ABANDON) &&
2372 si->caching_reason == PC_IGNORE )
2374 filter_free( si->query.filter );
2376 /* duplicate query, free it */
2378 for (;si->head; si->head=e) {
2379 e = si->head->e_private;
2380 si->head->e_private = NULL;
2381 entry_free(si->head);
2385 } else if ( si->caching_reason != PC_IGNORE ) {
2386 CachedQuery *qc = qm->addfunc(op, qm, &si->query,
2387 si->qtemp, si->caching_reason, 1 );
2390 switch ( si->caching_reason ) {
2392 cache_entries( op, &qc->q_uuid );
2394 si->pbi->bi_cq = qc;
2398 qc->q_sizelimit = rs->sr_nentries;
2408 ldap_pvt_thread_rdwr_wunlock(&qc->rwlock);
2409 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
2410 cm->num_cached_queries++;
2411 Debug( pcache_debug, "STORED QUERIES = %lu\n",
2412 cm->num_cached_queries, 0, 0 );
2413 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
2415 /* If the consistency checker suspended itself,
2418 if ( cm->cc_paused == PCACHE_CC_PAUSED ) {
2419 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
2420 if ( cm->cc_paused == PCACHE_CC_PAUSED ) {
2422 ldap_pvt_runqueue_resched( &slapd_rq, cm->cc_arg, 0 );
2424 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
2427 } else if ( si->count ) {
2428 /* duplicate query, free it */
2430 for (;si->head; si->head=e) {
2431 e = si->head->e_private;
2432 si->head->e_private = NULL;
2433 entry_free(si->head);
2438 filter_free( si->query.filter );
2441 op->o_callback = op->o_callback->sc_next;
2442 op->o_tmpfree( cb, op->o_tmpmemctx );
2445 return SLAP_CB_CONTINUE;
2453 struct search_info *si = op->o_callback->sc_private;
2455 if ( si->swap_saved_attrs ) {
2456 rs->sr_attrs = si->save_attrs;
2457 op->ors_attrs = si->save_attrs;
2460 if ( rs->sr_type == REP_SEARCH ) {
2461 /* don't return more entries than requested by the client */
2462 if ( si->slimit_exceeded ) {
2466 } else if ( rs->sr_type == REP_RESULT ) {
2469 if ( rs->sr_err == LDAP_SUCCESS ) {
2470 si->caching_reason = PC_POSITIVE;
2472 } else if ( rs->sr_err == LDAP_SIZELIMIT_EXCEEDED
2473 && si->qtemp->limitttl )
2477 si->caching_reason = PC_SIZELIMIT;
2478 for (;si->head; si->head=e) {
2479 e = si->head->e_private;
2480 si->head->e_private = NULL;
2481 entry_free(si->head);
2485 } else if ( si->qtemp->negttl && !si->count && !si->over &&
2486 rs->sr_err == LDAP_SUCCESS )
2488 si->caching_reason = PC_NEGATIVE;
2492 if ( si->slimit_exceeded ) {
2493 rs->sr_err = LDAP_SIZELIMIT_EXCEEDED;
2497 return SLAP_CB_CONTINUE;
2500 /* NOTE: this is a quick workaround to let pcache minimally interact
2501 * with pagedResults. A more articulated solutions would be to
2502 * perform the remote query without control and cache all results,
2503 * performing the pagedResults search only within the client
2504 * and the proxy. This requires pcache to understand pagedResults. */
2506 pcache_chk_controls(
2510 const char *non = "";
2511 const char *stripped = "";
2513 switch( op->o_pagedresults ) {
2514 case SLAP_CONTROL_NONCRITICAL:
2516 stripped = "; stripped";
2519 case SLAP_CONTROL_CRITICAL:
2520 Debug( pcache_debug, "%s: "
2521 "%scritical pagedResults control "
2522 "disabled with proxy cache%s.\n",
2523 op->o_log_prefix, non, stripped );
2525 slap_remove_control( op, rs, slap_cids.sc_pagedResults, NULL );
2529 rs->sr_err = SLAP_CB_CONTINUE;
2537 pc_setpw( Operation *op, struct berval *pwd, cache_manager *cm )
2539 struct berval vals[2];
2542 const char *text = NULL;
2543 BER_BVZERO( &vals[0] );
2544 slap_passwd_hash( pwd, &vals[0], &text );
2545 if ( BER_BVISEMPTY( &vals[0] )) {
2546 Debug( pcache_debug, "pc_setpw: hash failed %s\n",
2552 BER_BVZERO( &vals[1] );
2556 SlapReply sr = { REP_RESULT };
2557 slap_callback cb = { 0, slap_null_cb, 0, 0 };
2560 mod.sml_op = LDAP_MOD_REPLACE;
2562 mod.sml_desc = slap_schema.si_ad_userPassword;
2563 mod.sml_type = mod.sml_desc->ad_cname;
2564 mod.sml_values = vals;
2565 mod.sml_nvalues = NULL;
2566 mod.sml_numvals = 1;
2567 mod.sml_next = NULL;
2569 op->o_tag = LDAP_REQ_MODIFY;
2570 op->orm_modlist = &mod;
2572 op->o_dn = op->o_bd->be_rootdn;
2573 op->o_ndn = op->o_bd->be_rootndn;
2574 op->o_callback = &cb;
2575 Debug( pcache_debug, "pc_setpw: CACHING BIND for %s\n",
2576 op->o_req_dn.bv_val, 0, 0 );
2577 rc = op->o_bd->be_modify( op, &sr );
2578 ch_free( vals[0].bv_val );
2583 typedef struct bindcacheinfo {
2589 pc_bind_save( Operation *op, SlapReply *rs )
2591 if ( rs->sr_err == LDAP_SUCCESS ) {
2592 bindcacheinfo *bci = op->o_callback->sc_private;
2593 slap_overinst *on = bci->on;
2594 cache_manager *cm = on->on_bi.bi_private;
2596 Operation op2 = *op;
2597 if ( pc_setpw( &op2, &op->orb_cred, cm ) == LDAP_SUCCESS )
2598 bci->qc->bindref_time = op->o_time + bci->qc->qtemp->bindttr;
2600 return SLAP_CB_CONTINUE;
2604 pc_bind_attrs( Operation *op, Entry *e, QueryTemplate *temp,
2605 struct berval *fbv )
2608 struct berval *vals, pres = BER_BVC("*");
2612 vals = op->o_tmpalloc( temp->bindnattrs * sizeof( struct berval ),
2615 for ( i=0; i<temp->bindnattrs; i++ ) {
2616 a = attr_find( e->e_attrs, temp->bindfattrs[i] );
2617 if ( a && a->a_vals ) {
2618 vals[i] = a->a_vals[0];
2619 len += a->a_vals[0].bv_len;
2624 fbv->bv_len = len + temp->bindftemp.bv_len;
2625 fbv->bv_val = op->o_tmpalloc( fbv->bv_len + 1, op->o_tmpmemctx );
2627 p1 = temp->bindftemp.bv_val;
2632 if ( p1[0] == '=' && p1[1] == ')' ) {
2633 AC_MEMCPY( p2, vals[i].bv_val, vals[i].bv_len );
2634 p2 += vals[i].bv_len;
2640 op->o_tmpfree( vals, op->o_tmpmemctx );
2642 /* FIXME: are we sure str2filter_x can't fail?
2643 * caller needs to check */
2645 Filter *f = str2filter_x( op, fbv->bv_val );
2646 assert( f != NULL );
2651 /* Check if the requested entry is from the cache and has a valid
2652 * ttr and password hash
2655 pc_bind_search( Operation *op, SlapReply *rs )
2657 if ( rs->sr_type == REP_SEARCH ) {
2658 bindinfo *pbi = op->o_callback->sc_private;
2660 /* We only care if this is an already cached result and we're
2661 * below the refresh time, or we're offline.
2664 if (( pbi->bi_cm->cc_paused & PCACHE_CC_OFFLINE ) ||
2665 op->o_time < pbi->bi_cq->bindref_time ) {
2668 /* See if a recognized password is hashed here */
2669 a = attr_find( rs->sr_entry->e_attrs,
2670 slap_schema.si_ad_userPassword );
2671 if ( a && a->a_vals[0].bv_val[0] == '{' &&
2672 lutil_passwd_scheme( a->a_vals[0].bv_val ))
2673 pbi->bi_flags |= BI_HASHED;
2675 Debug( pcache_debug, "pc_bind_search: cache is stale, "
2676 "reftime: %ld, current time: %ld\n",
2677 pbi->bi_cq->bindref_time, op->o_time, 0 );
2679 } else if ( pbi->bi_si ) {
2680 /* This search result is going into the cache */
2684 filter_free( pbi->bi_si->query.filter );
2685 f = pc_bind_attrs( op, rs->sr_entry, pbi->bi_templ, &fbv );
2686 op->o_tmpfree( fbv.bv_val, op->o_tmpmemctx );
2687 pbi->bi_si->query.filter = filter_dup( f, NULL );
2688 filter_free_x( op, f, 1 );
2694 /* We always want pc_bind_search to run after the search handlers */
2696 pc_bind_resp( Operation *op, SlapReply *rs )
2698 bindinfo *pbi = op->o_callback->sc_private;
2699 if ( !( pbi->bi_flags & BI_DIDCB )) {
2700 slap_callback *sc = op->o_callback;
2701 while ( sc && sc->sc_response != pcache_response )
2704 sc = op->o_callback;
2705 pbi->bi_cb.sc_next = sc->sc_next;
2706 sc->sc_next = &pbi->bi_cb;
2707 pbi->bi_flags |= BI_DIDCB;
2709 return SLAP_CB_CONTINUE;
2712 #ifdef PCACHE_CONTROL_PRIVDB
2718 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
2719 cache_manager *cm = on->on_bi.bi_private;
2720 slap_callback *save_cb;
2723 /* skip if control is unset */
2724 if ( op->o_ctrlflag[ privDB_cid ] != SLAP_CONTROL_CRITICAL ) {
2725 return SLAP_CB_CONTINUE;
2728 /* The cache DB isn't open yet */
2729 if ( cm->defer_db_open ) {
2730 send_ldap_error( op, rs, LDAP_UNAVAILABLE,
2731 "pcachePrivDB: cacheDB not available" );
2735 /* FIXME: might be a little bit exaggerated... */
2736 if ( !be_isroot( op ) ) {
2737 save_cb = op->o_callback;
2738 op->o_callback = NULL;
2739 send_ldap_error( op, rs, LDAP_UNWILLING_TO_PERFORM,
2740 "pcachePrivDB: operation not allowed" );
2741 op->o_callback = save_cb;
2746 /* map tag to operation */
2747 type = slap_req2op( op->o_tag );
2748 if ( type != SLAP_OP_LAST ) {
2752 /* execute, if possible */
2753 func = &cm->db.be_bind;
2754 if ( func[ type ] != NULL ) {
2755 Operation op2 = *op;
2759 rc = func[ type ]( &op2, rs );
2760 if ( type == SLAP_OP_BIND && rc == LDAP_SUCCESS ) {
2761 op->o_conn->c_authz_cookie = cm->db.be_private;
2768 /* otherwise fall back to error */
2769 save_cb = op->o_callback;
2770 op->o_callback = NULL;
2771 send_ldap_error( op, rs, LDAP_UNWILLING_TO_PERFORM,
2772 "operation not supported with pcachePrivDB control" );
2773 op->o_callback = save_cb;
2777 #endif /* PCACHE_CONTROL_PRIVDB */
2784 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
2785 cache_manager *cm = on->on_bi.bi_private;
2786 QueryTemplate *temp;
2788 slap_callback cb = { 0 }, *sc;
2794 #ifdef PCACHE_CONTROL_PRIVDB
2795 if ( op->o_ctrlflag[ privDB_cid ] == SLAP_CONTROL_CRITICAL )
2796 return pcache_op_privdb( op, rs );
2797 #endif /* PCACHE_CONTROL_PRIVDB */
2799 /* Skip if we're not configured for Binds, or cache DB isn't open yet */
2800 if ( !cm->cache_binds || cm->defer_db_open )
2801 return SLAP_CB_CONTINUE;
2803 /* First find a matching template with Bind info */
2804 for ( temp=cm->qm->templates; temp; temp=temp->qmnext ) {
2805 if ( temp->bindttr && dnIsSuffix( &op->o_req_ndn, &temp->bindbase ))
2808 /* Didn't find a suitable template, just passthru */
2810 return SLAP_CB_CONTINUE;
2812 /* See if the entry is already locally cached. If so, we can
2813 * populate the query filter to retrieve the cached query. We
2814 * need to check the bindrefresh time in the query.
2817 op2.o_dn = op->o_bd->be_rootdn;
2818 op2.o_ndn = op->o_bd->be_rootndn;
2823 rc = be_entry_get_rw( &op2, &op->o_req_ndn, NULL, NULL, 0, &e );
2824 if ( rc == LDAP_SUCCESS && e ) {
2825 bi.bi_flags |= BI_LOOKUP;
2826 op2.ors_filter = pc_bind_attrs( op, e, temp, &op2.ors_filterstr );
2827 be_entry_release_r( &op2, e );
2829 op2.ors_filter = temp->bindfilter;
2830 op2.ors_filterstr = temp->bindfilterstr;
2833 op2.o_bd = op->o_bd;
2834 op2.o_tag = LDAP_REQ_SEARCH;
2835 op2.ors_scope = LDAP_SCOPE_BASE;
2836 op2.ors_deref = LDAP_DEREF_NEVER;
2838 op2.ors_tlimit = SLAP_NO_LIMIT;
2839 op2.ors_limit = NULL;
2840 op2.ors_attrs = cm->qm->attr_sets[temp->attr_set_index].attrs;
2841 op2.ors_attrsonly = 0;
2843 /* We want to invoke search at the same level of the stack
2844 * as we're already at...
2851 bi.bi_cb.sc_response = pc_bind_search;
2852 bi.bi_cb.sc_cleanup = NULL;
2853 bi.bi_cb.sc_private = &bi;
2854 cb.sc_private = &bi;
2855 cb.sc_response = pc_bind_resp;
2856 op2.o_callback = &cb;
2857 overlay_op_walk( &op2, rs, op_search, on->on_info, on );
2859 /* OK, just bind locally */
2860 if ( bi.bi_flags & BI_HASHED ) {
2861 BackendDB *be = op->o_bd;
2864 Debug( pcache_debug, "pcache_op_bind: CACHED BIND for %s\n",
2865 op->o_req_dn.bv_val, 0, 0 );
2867 if ( op->o_bd->be_bind( op, rs ) == LDAP_SUCCESS ) {
2868 op->o_conn->c_authz_cookie = cm->db.be_private;
2874 /* We have a cached query to work with */
2876 sc = op->o_tmpalloc( sizeof(slap_callback) + sizeof(bindcacheinfo),
2878 sc->sc_response = pc_bind_save;
2879 sc->sc_cleanup = NULL;
2880 sc->sc_private = sc+1;
2881 bci = sc->sc_private;
2882 sc->sc_next = op->o_callback;
2883 op->o_callback = sc;
2887 return SLAP_CB_CONTINUE;
2895 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
2896 cache_manager *cm = on->on_bi.bi_private;
2897 query_manager* qm = cm->qm;
2902 QueryTemplate *qtemp = NULL;
2903 bindinfo *pbi = NULL;
2906 CachedQuery *answerable = NULL;
2909 struct berval tempstr;
2911 #ifdef PCACHE_CONTROL_PRIVDB
2912 if ( op->o_ctrlflag[ privDB_cid ] == SLAP_CONTROL_CRITICAL ) {
2913 return pcache_op_privdb( op, rs );
2915 #endif /* PCACHE_CONTROL_PRIVDB */
2917 /* The cache DB isn't open yet */
2918 if ( cm->defer_db_open ) {
2919 send_ldap_error( op, rs, LDAP_UNAVAILABLE,
2920 "pcachePrivDB: cacheDB not available" );
2924 /* pickup runtime ACL changes */
2925 cm->db.be_acl = op->o_bd->be_acl;
2928 /* See if we're processing a Bind request */
2929 slap_callback *cb = op->o_callback;
2931 for ( ; cb; cb=cb->sc_next ) {
2932 if ( cb->sc_response == pc_bind_resp ) {
2933 pbi = cb->sc_private;
2939 /* FIXME: cannot cache/answer requests with pagedResults control */
2941 query.filter = op->ors_filter;
2944 query.base = pbi->bi_templ->bindbase;
2945 query.scope = pbi->bi_templ->bindscope;
2946 attr_set = pbi->bi_templ->attr_set_index;
2948 qtemp = pbi->bi_templ;
2949 if ( pbi->bi_flags & BI_LOOKUP )
2950 answerable = qm->qcfunc(op, qm, &query, qtemp);
2953 tempstr.bv_val = op->o_tmpalloc( op->ors_filterstr.bv_len+1,
2956 if ( filter2template( op, op->ors_filter, &tempstr ))
2958 op->o_tmpfree( tempstr.bv_val, op->o_tmpmemctx );
2959 return SLAP_CB_CONTINUE;
2962 Debug( pcache_debug, "query template of incoming query = %s\n",
2963 tempstr.bv_val, 0, 0 );
2966 attr_set = get_attr_set(op->ors_attrs, qm, cm->numattrsets);
2968 query.base = op->o_req_ndn;
2969 query.scope = op->ors_scope;
2971 /* check for query containment */
2972 if (attr_set > -1) {
2973 QueryTemplate *qt = qm->attr_sets[attr_set].templates;
2974 for (; qt; qt = qt->qtnext ) {
2975 /* find if template i can potentially answer tempstr */
2976 if ( ber_bvstrcasecmp( &qt->querystr, &tempstr ) != 0 )
2980 Debug( pcache_debug, "Entering QC, querystr = %s\n",
2981 op->ors_filterstr.bv_val, 0, 0 );
2982 answerable = qm->qcfunc(op, qm, &query, qt);
2984 /* if != NULL, rlocks qtemp->t_rwlock */
2989 op->o_tmpfree( tempstr.bv_val, op->o_tmpmemctx );
2993 BackendDB *save_bd = op->o_bd;
2995 ldap_pvt_thread_mutex_lock( &answerable->answerable_cnt_mutex );
2996 answerable->answerable_cnt++;
2997 /* we only care about refcnts if we're refreshing */
2998 if ( answerable->refresh_time )
2999 answerable->refcnt++;
3000 Debug( pcache_debug, "QUERY ANSWERABLE (answered %lu times)\n",
3001 answerable->answerable_cnt, 0, 0 );
3002 ldap_pvt_thread_mutex_unlock( &answerable->answerable_cnt_mutex );
3004 ldap_pvt_thread_rdwr_rlock(&answerable->rwlock);
3005 if ( BER_BVISNULL( &answerable->q_uuid )) {
3006 /* No entries cached, just an empty result set */
3008 send_ldap_result( op, rs );
3010 /* Let Bind know we used a cached query */
3012 pbi->bi_cq = answerable;
3015 if ( cm->response_cb == PCACHE_RESPONSE_CB_TAIL ) {
3017 /* The cached entry was already processed by any
3018 * other overlays, so don't let it get processed again.
3020 * This loop removes over_back_response from the stack.
3022 if ( overlay_callback_after_backover( op, &cb, 0) == 0 ) {
3023 slap_callback **scp;
3024 for ( scp = &op->o_callback; *scp != NULL;
3025 scp = &(*scp)->sc_next ) {
3026 if ( (*scp)->sc_next == &cb ) {
3033 i = cm->db.bd_info->bi_op_search( op, rs );
3035 ldap_pvt_thread_rdwr_runlock(&answerable->rwlock);
3036 /* locked by qtemp->qcfunc (query_containment) */
3037 ldap_pvt_thread_rdwr_runlock(&qtemp->t_rwlock);
3042 Debug( pcache_debug, "QUERY NOT ANSWERABLE\n", 0, 0, 0 );
3044 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
3045 if (cm->num_cached_queries >= cm->max_queries) {
3048 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
3050 if (op->ors_attrsonly)
3055 struct search_info *si;
3057 Debug( pcache_debug, "QUERY CACHEABLE\n", 0, 0, 0 );
3058 query.filter = filter_dup(op->ors_filter, NULL);
3060 cb = op->o_tmpalloc( sizeof(*cb) + sizeof(*si), op->o_tmpmemctx );
3061 cb->sc_response = pcache_response;
3062 cb->sc_cleanup = pcache_op_cleanup;
3063 cb->sc_private = (cb+1);
3064 si = cb->sc_private;
3068 si->max = cm->num_entries_limit ;
3072 si->slimit_exceeded = 0;
3073 si->caching_reason = PC_IGNORE;
3074 if ( op->ors_slimit > 0 && op->ors_slimit < cm->num_entries_limit ) {
3075 si->slimit = op->ors_slimit;
3076 op->ors_slimit = cm->num_entries_limit;
3080 si->swap_saved_attrs = 1;
3081 si->save_attrs = op->ors_attrs;
3086 op->ors_attrs = qtemp->t_attrs.attrs;
3088 if ( cm->response_cb == PCACHE_RESPONSE_CB_HEAD ) {
3089 cb->sc_next = op->o_callback;
3090 op->o_callback = cb;
3093 slap_callback **pcb;
3095 /* need to move the callback at the end, in case other
3096 * overlays are present, so that the final entry is
3097 * actually cached */
3099 for ( pcb = &op->o_callback; *pcb; pcb = &(*pcb)->sc_next );
3104 Debug( pcache_debug, "QUERY NOT CACHEABLE\n",
3108 return SLAP_CB_CONTINUE;
3113 AttributeName* attrs,
3121 for ( ; attrs[i].an_name.bv_val; i++ ) {
3122 /* only count valid attribute names
3123 * (searches ignore others, this overlay does the same) */
3124 if ( attrs[i].an_desc ) {
3130 /* recognize default or explicit single "*" */
3132 ( i == 1 && bvmatch( &attrs[0].an_name, slap_bv_all_user_attrs ) ) )
3135 attrs = slap_anlist_all_user_attributes;
3137 /* recognize implicit (no valid attributes) or explicit single "1.1" */
3138 } else if ( count == 0 ||
3139 ( i == 1 && bvmatch( &attrs[0].an_name, slap_bv_no_attrs ) ) )
3145 for ( i = 0; i < num; i++ ) {
3149 if ( count > qm->attr_sets[i].count ) {
3154 if ( !qm->attr_sets[i].count ) {
3160 for ( a2 = attrs; a2->an_name.bv_val; a2++ ) {
3161 if ( !a2->an_desc && !bvmatch( &a2->an_name, slap_bv_all_user_attrs ) ) continue;
3163 if ( !an_find( qm->attr_sets[i].attrs, &a2->an_name ) ) {
3181 /* Refresh a cached query:
3182 * 1: Replay the query on the remote DB and merge each entry into
3183 * the local DB. Remember the DNs of each remote entry.
3184 * 2: Search the local DB for all entries matching this queryID.
3185 * Delete any entry whose DN is not in the list from (1).
3187 typedef struct dnlist {
3188 struct dnlist *next;
3193 typedef struct refresh_info {
3201 static dnlist *dnl_alloc( Operation *op, struct berval *bvdn )
3203 dnlist *dn = op->o_tmpalloc( sizeof(dnlist) + bvdn->bv_len + 1,
3205 dn->dn.bv_len = bvdn->bv_len;
3206 dn->dn.bv_val = (char *)(dn+1);
3207 AC_MEMCPY( dn->dn.bv_val, bvdn->bv_val, dn->dn.bv_len );
3208 dn->dn.bv_val[dn->dn.bv_len] = '\0';
3213 refresh_merge( Operation *op, SlapReply *rs )
3215 if ( rs->sr_type == REP_SEARCH ) {
3216 refresh_info *ri = op->o_callback->sc_private;
3222 ocb = op->o_callback;
3223 /* Find local entry, merge */
3224 op->o_bd = ri->ri_be;
3225 rc = be_entry_get_rw( op, &rs->sr_entry->e_nname, NULL, NULL, 0, &e );
3226 if ( rc != LDAP_SUCCESS || e == NULL ) {
3227 /* No local entry, just add it. FIXME: we are not checking
3228 * the cache entry limit here
3230 merge_entry( op, rs->sr_entry, 1, &ri->ri_q->q_uuid );
3232 /* Entry exists, update it */
3235 Modifications *modlist, *mods = NULL;
3236 const char* text = NULL;
3237 char textbuf[SLAP_TEXT_BUFLEN];
3238 size_t textlen = sizeof(textbuf);
3239 slap_callback cb = { NULL, slap_null_cb, NULL, NULL };
3243 /* Get a copy of only the attrs we requested */
3244 for ( a=e->e_attrs; a; a=a->a_next ) {
3245 if ( ad_inlist( a->a_desc, rs->sr_attrs )) {
3246 *b = attr_alloc( a->a_desc );
3248 /* The actual values still belong to e */
3249 (*b)->a_flags |= SLAP_ATTR_DONT_FREE_VALS |
3250 SLAP_ATTR_DONT_FREE_DATA;
3251 b = &((*b)->a_next);
3255 slap_entry2mods( rs->sr_entry, &modlist, &text, textbuf, textlen );
3256 syncrepl_diff_entry( op, ne.e_attrs, rs->sr_entry->e_attrs,
3257 &mods, &modlist, 0 );
3258 be_entry_release_r( op, e );
3259 attrs_free( ne.e_attrs );
3260 slap_mods_free( modlist, 1 );
3261 /* mods is NULL if there are no changes */
3263 SlapReply rs2 = { REP_RESULT };
3264 struct berval dn = op->o_req_dn;
3265 struct berval ndn = op->o_req_ndn;
3266 op->o_tag = LDAP_REQ_MODIFY;
3267 op->orm_modlist = mods;
3268 op->o_req_dn = rs->sr_entry->e_name;
3269 op->o_req_ndn = rs->sr_entry->e_nname;
3270 op->o_callback = &cb;
3271 op->o_bd->be_modify( op, &rs2 );
3272 rs->sr_err = rs2.sr_err;
3273 rs_assert_done( &rs2 );
3274 slap_mods_free( mods, 1 );
3276 op->o_req_ndn = ndn;
3280 /* Add DN to list */
3281 dnl = dnl_alloc( op, &rs->sr_entry->e_nname );
3283 if ( ri->ri_tail ) {
3284 ri->ri_tail->next = dnl;
3289 op->o_callback = ocb;
3295 refresh_purge( Operation *op, SlapReply *rs )
3297 if ( rs->sr_type == REP_SEARCH ) {
3298 refresh_info *ri = op->o_callback->sc_private;
3302 /* Did the entry exist on the remote? */
3303 for ( dn=&ri->ri_dns; *dn; dn = &(*dn)->next ) {
3304 if ( dn_match( &(*dn)->dn, &rs->sr_entry->e_nname )) {
3305 dnlist *dnext = (*dn)->next;
3306 op->o_tmpfree( *dn, op->o_tmpmemctx );
3312 /* No, so put it on the list to delete */
3315 dnlist *dnl = dnl_alloc( op, &rs->sr_entry->e_nname );
3316 dnl->next = ri->ri_dels;
3318 a = attr_find( rs->sr_entry->e_attrs, ad_queryId );
3319 /* If ours is the only queryId, delete entry */
3320 dnl->delete = ( a->a_numvals == 1 );
3327 refresh_query( Operation *op, CachedQuery *query, slap_overinst *on )
3329 SlapReply rs = {REP_RESULT};
3330 slap_callback cb = { 0 };
3331 refresh_info ri = { 0 };
3332 char filter_str[ LDAP_LUTIL_UUIDSTR_BUFSIZE + STRLENOF( "(pcacheQueryID=)" ) ];
3333 AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
3334 Filter filter = {LDAP_FILTER_EQUALITY};
3335 AttributeName attrs[ 2 ] = {{{ 0 }}};
3339 ldap_pvt_thread_mutex_lock( &query->answerable_cnt_mutex );
3341 ldap_pvt_thread_mutex_unlock( &query->answerable_cnt_mutex );
3343 cb.sc_response = refresh_merge;
3344 cb.sc_private = &ri;
3347 ri.ri_be = op->o_bd;
3350 op->o_tag = LDAP_REQ_SEARCH;
3351 op->o_protocol = LDAP_VERSION3;
3352 op->o_callback = &cb;
3353 op->o_do_not_cache = 1;
3355 op->o_req_dn = query->qbase->base;
3356 op->o_req_ndn = query->qbase->base;
3357 op->ors_scope = query->scope;
3358 op->ors_slimit = SLAP_NO_LIMIT;
3359 op->ors_tlimit = SLAP_NO_LIMIT;
3360 op->ors_limit = NULL;
3361 op->ors_filter = query->filter;
3362 filter2bv_x( op, query->filter, &op->ors_filterstr );
3363 op->ors_attrs = query->qtemp->t_attrs.attrs;
3364 op->ors_attrsonly = 0;
3366 op->o_bd = on->on_info->oi_origdb;
3367 rc = op->o_bd->be_search( op, &rs );
3369 op->o_bd = ri.ri_be;
3373 /* Get the DNs of all entries matching this query */
3374 cb.sc_response = refresh_purge;
3376 op->o_bd = ri.ri_be;
3377 op->o_req_dn = op->o_bd->be_suffix[0];
3378 op->o_req_ndn = op->o_bd->be_nsuffix[0];
3379 op->ors_scope = LDAP_SCOPE_SUBTREE;
3380 op->ors_deref = LDAP_DEREF_NEVER;
3381 op->ors_filterstr.bv_len = snprintf(filter_str, sizeof(filter_str),
3382 "(%s=%s)", ad_queryId->ad_cname.bv_val, query->q_uuid.bv_val);
3383 filter.f_ava = &ava;
3384 filter.f_av_desc = ad_queryId;
3385 filter.f_av_value = query->q_uuid;
3386 attrs[ 0 ].an_desc = ad_queryId;
3387 attrs[ 0 ].an_name = ad_queryId->ad_cname;
3388 op->ors_attrs = attrs;
3389 op->ors_attrsonly = 0;
3390 rs_reinit( &rs, REP_RESULT );
3391 rc = op->o_bd->be_search( op, &rs );
3392 if ( rc ) goto leave;
3394 while (( dn = ri.ri_dels )) {
3395 op->o_req_dn = dn->dn;
3396 op->o_req_ndn = dn->dn;
3397 rs_reinit( &rs, REP_RESULT );
3399 op->o_tag = LDAP_REQ_DELETE;
3400 op->o_bd->be_delete( op, &rs );
3403 struct berval vals[2];
3405 vals[0] = query->q_uuid;
3406 BER_BVZERO( &vals[1] );
3407 mod.sml_op = LDAP_MOD_DELETE;
3409 mod.sml_desc = ad_queryId;
3410 mod.sml_type = ad_queryId->ad_cname;
3411 mod.sml_values = vals;
3412 mod.sml_nvalues = NULL;
3413 mod.sml_numvals = 1;
3414 mod.sml_next = NULL;
3416 op->o_tag = LDAP_REQ_MODIFY;
3417 op->orm_modlist = &mod;
3418 op->o_bd->be_modify( op, &rs );
3420 ri.ri_dels = dn->next;
3421 op->o_tmpfree( dn, op->o_tmpmemctx );
3425 /* reset our local heap, we're done with it */
3426 slap_sl_mem_create(SLAP_SLAB_SIZE, SLAP_SLAB_STACK, op->o_threadctx, 1 );
3435 struct re_s *rtask = arg;
3436 slap_overinst *on = rtask->arg;
3437 cache_manager *cm = on->on_bi.bi_private;
3438 query_manager *qm = cm->qm;
3439 Connection conn = {0};
3440 OperationBuffer opbuf;
3443 CachedQuery *query, *qprev;
3444 int return_val, pause = PCACHE_CC_PAUSED;
3445 QueryTemplate *templ;
3447 /* Don't expire anything when we're offline */
3448 if ( cm->cc_paused & PCACHE_CC_OFFLINE ) {
3449 pause = PCACHE_CC_OFFLINE;
3453 connection_fake_init( &conn, &opbuf, ctx );
3457 op->o_dn = cm->db.be_rootdn;
3458 op->o_ndn = cm->db.be_rootndn;
3462 for (templ = qm->templates; templ; templ=templ->qmnext) {
3464 if ( !templ->query_last ) continue;
3466 op->o_time = slap_get_time();
3467 if ( !templ->ttr ) {
3469 if ( templ->negttl && templ->negttl < ttl )
3470 ttl = templ->negttl;
3471 if ( templ->limitttl && templ->limitttl < ttl )
3472 ttl = templ->limitttl;
3473 /* The oldest timestamp that needs expiration checking */
3477 for ( query=templ->query_last; query; query=qprev ) {
3478 qprev = query->prev;
3479 if ( query->refresh_time && query->refresh_time < op->o_time ) {
3480 /* A refresh will extend the expiry if the query has been
3481 * referenced, but not if it's unreferenced. If the
3482 * expiration has been hit, then skip the refresh since
3483 * we're just going to discard the result anyway.
3485 if ( query->refcnt )
3486 query->expiry_time = op->o_time + templ->ttl;
3487 if ( query->expiry_time > op->o_time ) {
3488 refresh_query( op, query, on );
3493 if (query->expiry_time < op->o_time) {
3495 Debug( pcache_debug, "Lock CR index = %p\n",
3496 (void *) templ, 0, 0 );
3497 ldap_pvt_thread_rdwr_wlock(&templ->t_rwlock);
3498 if ( query == templ->query_last ) {
3500 remove_from_template(query, templ);
3501 Debug( pcache_debug, "TEMPLATE %p QUERIES-- %d\n",
3502 (void *) templ, templ->no_of_queries, 0 );
3503 Debug( pcache_debug, "Unlock CR index = %p\n",
3504 (void *) templ, 0, 0 );
3506 ldap_pvt_thread_rdwr_wunlock(&templ->t_rwlock);
3510 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
3511 remove_query(qm, query);
3512 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
3513 if ( BER_BVISNULL( &query->q_uuid ))
3516 return_val = remove_query_data(op, &query->q_uuid);
3517 Debug( pcache_debug, "STALE QUERY REMOVED, SIZE=%d\n",
3519 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
3520 cm->cur_entries -= return_val;
3521 cm->num_cached_queries--;
3522 Debug( pcache_debug, "STORED QUERIES = %lu\n",
3523 cm->num_cached_queries, 0, 0 );
3524 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
3525 Debug( pcache_debug,
3526 "STALE QUERY REMOVED, CACHE ="
3528 cm->cur_entries, 0, 0 );
3530 } else if ( !templ->ttr && query->expiry_time > ttl ) {
3531 /* We don't need to check for refreshes, and this
3532 * query's expiry is too new, and all subsequent queries
3533 * will be newer yet. So stop looking.
3535 * If we have refreshes, then we always have to walk the
3536 * entire query list.
3544 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
3545 if ( ldap_pvt_runqueue_isrunning( &slapd_rq, rtask )) {
3546 ldap_pvt_runqueue_stoptask( &slapd_rq, rtask );
3548 /* If there were no queries, defer processing for a while */
3549 if ( cm->cc_paused != pause )
3550 cm->cc_paused = pause;
3551 ldap_pvt_runqueue_resched( &slapd_rq, rtask, pause );
3553 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
3558 #define MAX_ATTR_SETS 500
3571 static ConfigDriver pc_cf_gen;
3572 static ConfigLDAPadd pc_ldadd;
3573 static ConfigCfAdd pc_cfadd;
3575 static ConfigTable pccfg[] = {
3576 { "pcache", "backend> <max_entries> <numattrsets> <entry limit> "
3578 6, 6, 0, ARG_MAGIC|ARG_NO_DELETE|PC_MAIN, pc_cf_gen,
3579 "( OLcfgOvAt:2.1 NAME ( 'olcPcache' 'olcProxyCache' ) "
3580 "DESC 'Proxy Cache basic parameters' "
3581 "SYNTAX OMsDirectoryString SINGLE-VALUE )", NULL, NULL },
3582 { "pcacheAttrset", "index> <attributes...",
3583 2, 0, 0, ARG_MAGIC|PC_ATTR, pc_cf_gen,
3584 "( OLcfgOvAt:2.2 NAME ( 'olcPcacheAttrset' 'olcProxyAttrset' ) "
3585 "DESC 'A set of attributes to cache' "
3586 "SYNTAX OMsDirectoryString )", NULL, NULL },
3587 { "pcacheTemplate", "filter> <attrset-index> <TTL> <negTTL> "
3589 4, 7, 0, ARG_MAGIC|PC_TEMP, pc_cf_gen,
3590 "( OLcfgOvAt:2.3 NAME ( 'olcPcacheTemplate' 'olcProxyCacheTemplate' ) "
3591 "DESC 'Filter template, attrset, cache TTL, "
3592 "optional negative TTL, optional sizelimit TTL, "
3594 "SYNTAX OMsDirectoryString )", NULL, NULL },
3595 { "pcachePosition", "head|tail(default)",
3596 2, 2, 0, ARG_MAGIC|PC_RESP, pc_cf_gen,
3597 "( OLcfgOvAt:2.4 NAME 'olcPcachePosition' "
3598 "DESC 'Response callback position in overlay stack' "
3599 "SYNTAX OMsDirectoryString )", NULL, NULL },
3600 { "pcacheMaxQueries", "queries",
3601 2, 2, 0, ARG_INT|ARG_MAGIC|PC_QUERIES, pc_cf_gen,
3602 "( OLcfgOvAt:2.5 NAME ( 'olcPcacheMaxQueries' 'olcProxyCacheQueries' ) "
3603 "DESC 'Maximum number of queries to cache' "
3604 "SYNTAX OMsInteger )", NULL, NULL },
3605 { "pcachePersist", "TRUE|FALSE",
3606 2, 2, 0, ARG_ON_OFF|ARG_OFFSET, (void *)offsetof(cache_manager, save_queries),
3607 "( OLcfgOvAt:2.6 NAME ( 'olcPcachePersist' 'olcProxySaveQueries' ) "
3608 "DESC 'Save cached queries for hot restart' "
3609 "SYNTAX OMsBoolean )", NULL, NULL },
3610 { "pcacheValidate", "TRUE|FALSE",
3611 2, 2, 0, ARG_ON_OFF|ARG_OFFSET, (void *)offsetof(cache_manager, check_cacheability),
3612 "( OLcfgOvAt:2.7 NAME ( 'olcPcacheValidate' 'olcProxyCheckCacheability' ) "
3613 "DESC 'Check whether the results of a query are cacheable, e.g. for schema issues' "
3614 "SYNTAX OMsBoolean )", NULL, NULL },
3615 { "pcacheOffline", "TRUE|FALSE",
3616 2, 2, 0, ARG_ON_OFF|ARG_MAGIC|PC_OFFLINE, pc_cf_gen,
3617 "( OLcfgOvAt:2.8 NAME 'olcPcacheOffline' "
3618 "DESC 'Set cache to offline mode and disable expiration' "
3619 "SYNTAX OMsBoolean )", NULL, NULL },
3620 { "pcacheBind", "filter> <attrset-index> <TTR> <scope> <base",
3621 6, 6, 0, ARG_MAGIC|PC_BIND, pc_cf_gen,
3622 "( OLcfgOvAt:2.9 NAME 'olcPcacheBind' "
3623 "DESC 'Parameters for caching Binds' "
3624 "SYNTAX OMsDirectoryString )", NULL, NULL },
3625 { "pcache-", "private database args",
3626 1, 0, STRLENOF("pcache-"), ARG_MAGIC|PC_PRIVATE_DB, pc_cf_gen,
3629 /* Legacy keywords */
3630 { "proxycache", "backend> <max_entries> <numattrsets> <entry limit> "
3632 6, 6, 0, ARG_MAGIC|ARG_NO_DELETE|PC_MAIN, pc_cf_gen,
3634 { "proxyattrset", "index> <attributes...",
3635 2, 0, 0, ARG_MAGIC|PC_ATTR, pc_cf_gen,
3637 { "proxytemplate", "filter> <attrset-index> <TTL> <negTTL",
3638 4, 7, 0, ARG_MAGIC|PC_TEMP, pc_cf_gen,
3640 { "response-callback", "head|tail(default)",
3641 2, 2, 0, ARG_MAGIC|PC_RESP, pc_cf_gen,
3643 { "proxyCacheQueries", "queries",
3644 2, 2, 0, ARG_INT|ARG_MAGIC|PC_QUERIES, pc_cf_gen,
3646 { "proxySaveQueries", "TRUE|FALSE",
3647 2, 2, 0, ARG_ON_OFF|ARG_OFFSET, (void *)offsetof(cache_manager, save_queries),
3649 { "proxyCheckCacheability", "TRUE|FALSE",
3650 2, 2, 0, ARG_ON_OFF|ARG_OFFSET, (void *)offsetof(cache_manager, check_cacheability),
3653 { NULL, NULL, 0, 0, 0, ARG_IGNORED }
3656 static ConfigOCs pcocs[] = {
3657 { "( OLcfgOvOc:2.1 "
3658 "NAME 'olcPcacheConfig' "
3659 "DESC 'ProxyCache configuration' "
3660 "SUP olcOverlayConfig "
3661 "MUST ( olcPcache $ olcPcacheAttrset $ olcPcacheTemplate ) "
3662 "MAY ( olcPcachePosition $ olcPcacheMaxQueries $ olcPcachePersist $ "
3663 "olcPcacheValidate $ olcPcacheOffline $ olcPcacheBind ) )",
3664 Cft_Overlay, pccfg, NULL, pc_cfadd },
3665 { "( OLcfgOvOc:2.2 "
3666 "NAME 'olcPcacheDatabase' "
3667 "DESC 'Cache database configuration' "
3668 "AUXILIARY )", Cft_Misc, olcDatabaseDummy, pc_ldadd },
3672 static int pcache_db_open2( slap_overinst *on, ConfigReply *cr );
3675 pc_ldadd_cleanup( ConfigArgs *c )
3677 slap_overinst *on = c->ca_private;
3678 return pcache_db_open2( on, &c->reply );
3682 pc_ldadd( CfEntryInfo *p, Entry *e, ConfigArgs *ca )
3687 if ( p->ce_type != Cft_Overlay || !p->ce_bi ||
3688 p->ce_bi->bi_cf_ocs != pcocs )
3689 return LDAP_CONSTRAINT_VIOLATION;
3691 on = (slap_overinst *)p->ce_bi;
3692 cm = on->on_bi.bi_private;
3694 /* Defer open if this is an LDAPadd */
3695 if ( CONFIG_ONLINE_ADD( ca ))
3696 ca->cleanup = pc_ldadd_cleanup;
3698 cm->defer_db_open = 0;
3699 ca->ca_private = on;
3700 return LDAP_SUCCESS;
3704 pc_cfadd( Operation *op, SlapReply *rs, Entry *p, ConfigArgs *ca )
3706 CfEntryInfo *pe = p->e_private;
3707 slap_overinst *on = (slap_overinst *)pe->ce_bi;
3708 cache_manager *cm = on->on_bi.bi_private;
3711 /* FIXME: should not hardcode "olcDatabase" here */
3712 bv.bv_len = snprintf( ca->cr_msg, sizeof( ca->cr_msg ),
3713 "olcDatabase=" SLAP_X_ORDERED_FMT "%s",
3714 0, cm->db.bd_info->bi_type );
3715 if ( bv.bv_len >= sizeof( ca->cr_msg ) ) {
3718 bv.bv_val = ca->cr_msg;
3720 cm->defer_db_open = 0;
3722 /* We can only create this entry if the database is table-driven
3724 if ( cm->db.bd_info->bi_cf_ocs )
3725 config_build_entry( op, rs, pe, ca, &bv, cm->db.bd_info->bi_cf_ocs,
3732 pc_cf_gen( ConfigArgs *c )
3734 slap_overinst *on = (slap_overinst *)c->bi;
3735 cache_manager* cm = on->on_bi.bi_private;
3736 query_manager* qm = cm->qm;
3737 QueryTemplate* temp;
3738 AttributeName* attr_name;
3739 AttributeName* attrarray;
3740 const char* text=NULL;
3745 if ( c->op == SLAP_CONFIG_EMIT ) {
3749 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ), "%s %d %d %d %ld",
3750 cm->db.bd_info->bi_type, cm->max_entries, cm->numattrsets,
3751 cm->num_entries_limit, cm->cc_period );
3752 bv.bv_val = c->cr_msg;
3753 value_add_one( &c->rvalue_vals, &bv );
3756 for (i=0; i<cm->numattrsets; i++) {
3757 if ( !qm->attr_sets[i].count ) continue;
3759 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ), "%d", i );
3761 /* count the attr length */
3762 for ( attr_name = qm->attr_sets[i].attrs;
3763 attr_name->an_name.bv_val; attr_name++ )
3764 bv.bv_len += attr_name->an_name.bv_len + 1;
3766 bv.bv_val = ch_malloc( bv.bv_len+1 );
3767 ptr = lutil_strcopy( bv.bv_val, c->cr_msg );
3768 for ( attr_name = qm->attr_sets[i].attrs;
3769 attr_name->an_name.bv_val; attr_name++ ) {
3771 ptr = lutil_strcopy( ptr, attr_name->an_name.bv_val );
3773 ber_bvarray_add( &c->rvalue_vals, &bv );
3775 if ( !c->rvalue_vals )
3779 for (temp=qm->templates; temp; temp=temp->qmnext) {
3780 /* HEADS-UP: always print all;
3781 * if optional == 0, ignore */
3782 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ),
3783 " %d %ld %ld %ld %ld",
3784 temp->attr_set_index,
3789 bv.bv_len += temp->querystr.bv_len + 2;
3790 bv.bv_val = ch_malloc( bv.bv_len+1 );
3793 ptr = lutil_strcopy( ptr, temp->querystr.bv_val );
3795 strcpy( ptr, c->cr_msg );
3796 ber_bvarray_add( &c->rvalue_vals, &bv );
3798 if ( !c->rvalue_vals )
3802 for (temp=qm->templates; temp; temp=temp->qmnext) {
3803 if ( !temp->bindttr ) continue;
3804 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ),
3806 temp->attr_set_index,
3808 ldap_pvt_scope2str( temp->bindscope ));
3809 bv.bv_len += temp->bindbase.bv_len + temp->bindftemp.bv_len + 4;
3810 bv.bv_val = ch_malloc( bv.bv_len + 1 );
3813 ptr = lutil_strcopy( ptr, temp->bindftemp.bv_val );
3815 ptr = lutil_strcopy( ptr, c->cr_msg );
3817 ptr = lutil_strcopy( ptr, temp->bindbase.bv_val );
3820 ber_bvarray_add( &c->rvalue_vals, &bv );
3822 if ( !c->rvalue_vals )
3826 if ( cm->response_cb == PCACHE_RESPONSE_CB_HEAD ) {
3827 BER_BVSTR( &bv, "head" );
3829 BER_BVSTR( &bv, "tail" );
3831 value_add_one( &c->rvalue_vals, &bv );
3834 c->value_int = cm->max_queries;
3837 c->value_int = (cm->cc_paused & PCACHE_CC_OFFLINE) != 0;
3841 } else if ( c->op == LDAP_MOD_DELETE ) {
3844 case PC_ATTR: /* FIXME */
3849 cm->cc_paused &= ~PCACHE_CC_OFFLINE;
3850 /* If there were cached queries when we went offline,
3851 * restart the checker now.
3853 if ( cm->num_cached_queries ) {
3854 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
3856 ldap_pvt_runqueue_resched( &slapd_rq, cm->cc_arg, 0 );
3857 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
3867 if ( cm->numattrsets > 0 ) {
3868 snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"pcache\" directive already provided" );
3869 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3873 if ( lutil_atoi( &cm->numattrsets, c->argv[3] ) != 0 ) {
3874 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse num attrsets=\"%s\" (arg #3)",
3876 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3879 if ( cm->numattrsets <= 0 ) {
3880 snprintf( c->cr_msg, sizeof( c->cr_msg ), "numattrsets (arg #3) must be positive" );
3881 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3884 if ( cm->numattrsets > MAX_ATTR_SETS ) {
3885 snprintf( c->cr_msg, sizeof( c->cr_msg ), "numattrsets (arg #3) must be <= %d", MAX_ATTR_SETS );
3886 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3890 if ( !backend_db_init( c->argv[1], &cm->db, -1, NULL )) {
3891 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unknown backend type (arg #1)" );
3892 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3896 if ( lutil_atoi( &cm->max_entries, c->argv[2] ) != 0 ) {
3897 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse max entries=\"%s\" (arg #2)",
3899 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3902 if ( cm->max_entries <= 0 ) {
3903 snprintf( c->cr_msg, sizeof( c->cr_msg ), "max entries (arg #2) must be positive.\n" );
3904 Debug( LDAP_DEBUG_CONFIG, "%s: %s\n", c->log, c->cr_msg, 0 );
3908 if ( lutil_atoi( &cm->num_entries_limit, c->argv[4] ) != 0 ) {
3909 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse entry limit=\"%s\" (arg #4)",
3911 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3914 if ( cm->num_entries_limit <= 0 ) {
3915 snprintf( c->cr_msg, sizeof( c->cr_msg ), "entry limit (arg #4) must be positive" );
3916 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3919 if ( cm->num_entries_limit > cm->max_entries ) {
3920 snprintf( c->cr_msg, sizeof( c->cr_msg ), "entry limit (arg #4) must be less than max entries %d (arg #2)", cm->max_entries );
3921 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3925 if ( lutil_parse_time( c->argv[5], &t ) != 0 ) {
3926 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse period=\"%s\" (arg #5)",
3928 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3932 cm->cc_period = (time_t)t;
3933 Debug( pcache_debug,
3934 "Total # of attribute sets to be cached = %d.\n",
3935 cm->numattrsets, 0, 0 );
3936 qm->attr_sets = ( struct attr_set * )ch_calloc( cm->numattrsets,
3937 sizeof( struct attr_set ) );
3940 if ( cm->numattrsets == 0 ) {
3941 snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"pcache\" directive not provided yet" );
3942 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3945 if ( lutil_atoi( &num, c->argv[1] ) != 0 ) {
3946 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse attrset #=\"%s\"",
3948 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3952 if ( num < 0 || num >= cm->numattrsets ) {
3953 snprintf( c->cr_msg, sizeof( c->cr_msg ), "attrset index %d out of bounds (must be %s%d)",
3954 num, cm->numattrsets > 1 ? "0->" : "", cm->numattrsets - 1 );
3955 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3958 qm->attr_sets[num].flags |= PC_CONFIGURED;
3959 if ( c->argc == 2 ) {
3961 snprintf( c->cr_msg, sizeof( c->cr_msg ),
3962 "need an explicit attr in attrlist; use \"*\" to indicate all attrs" );
3963 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3966 } else if ( c->argc == 3 ) {
3967 if ( strcmp( c->argv[2], LDAP_ALL_USER_ATTRIBUTES ) == 0 ) {
3968 qm->attr_sets[num].count = 1;
3969 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( 2,
3970 sizeof( AttributeName ) );
3971 BER_BVSTR( &qm->attr_sets[num].attrs[0].an_name, LDAP_ALL_USER_ATTRIBUTES );
3974 } else if ( strcmp( c->argv[2], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 ) {
3975 qm->attr_sets[num].count = 1;
3976 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( 2,
3977 sizeof( AttributeName ) );
3978 BER_BVSTR( &qm->attr_sets[num].attrs[0].an_name, LDAP_ALL_OPERATIONAL_ATTRIBUTES );
3981 } else if ( strcmp( c->argv[2], LDAP_NO_ATTRS ) == 0 ) {
3984 /* else: fallthru */
3986 } else if ( c->argc == 4 ) {
3987 if ( ( strcmp( c->argv[2], LDAP_ALL_USER_ATTRIBUTES ) == 0 && strcmp( c->argv[3], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 )
3988 || ( strcmp( c->argv[2], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 && strcmp( c->argv[3], LDAP_ALL_USER_ATTRIBUTES ) == 0 ) )
3990 qm->attr_sets[num].count = 2;
3991 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( 3,
3992 sizeof( AttributeName ) );
3993 BER_BVSTR( &qm->attr_sets[num].attrs[0].an_name, LDAP_ALL_USER_ATTRIBUTES );
3994 BER_BVSTR( &qm->attr_sets[num].attrs[1].an_name, LDAP_ALL_OPERATIONAL_ATTRIBUTES );
3997 /* else: fallthru */
4000 if ( c->argc > 2 ) {
4001 int all_user = 0, all_op = 0;
4003 qm->attr_sets[num].count = c->argc - 2;
4004 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( c->argc - 1,
4005 sizeof( AttributeName ) );
4006 attr_name = qm->attr_sets[num].attrs;
4007 for ( i = 2; i < c->argc; i++ ) {
4008 attr_name->an_desc = NULL;
4009 if ( strcmp( c->argv[i], LDAP_NO_ATTRS ) == 0 ) {
4010 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4011 "invalid attr #%d \"%s\" in attrlist",
4012 i - 2, c->argv[i] );
4013 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4014 ch_free( qm->attr_sets[num].attrs );
4015 qm->attr_sets[num].attrs = NULL;
4016 qm->attr_sets[num].count = 0;
4019 if ( strcmp( c->argv[i], LDAP_ALL_USER_ATTRIBUTES ) == 0 ) {
4021 BER_BVSTR( &attr_name->an_name, LDAP_ALL_USER_ATTRIBUTES );
4022 } else if ( strcmp( c->argv[i], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 ) {
4024 BER_BVSTR( &attr_name->an_name, LDAP_ALL_OPERATIONAL_ATTRIBUTES );
4026 if ( slap_str2ad( c->argv[i], &attr_name->an_desc, &text ) ) {
4027 strcpy( c->cr_msg, text );
4028 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4029 ch_free( qm->attr_sets[num].attrs );
4030 qm->attr_sets[num].attrs = NULL;
4031 qm->attr_sets[num].count = 0;
4034 attr_name->an_name = attr_name->an_desc->ad_cname;
4036 attr_name->an_oc = NULL;
4037 attr_name->an_flags = 0;
4038 if ( attr_name->an_desc == slap_schema.si_ad_objectClass )
4039 qm->attr_sets[num].flags |= PC_GOT_OC;
4041 BER_BVZERO( &attr_name->an_name );
4044 /* warn if list contains both "*" and "+" */
4045 if ( i > 4 && all_user && all_op ) {
4046 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4047 "warning: attribute list contains \"*\" and \"+\"" );
4048 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4053 if ( cm->numattrsets == 0 ) {
4054 snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"pcache\" directive not provided yet" );
4055 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4058 if ( lutil_atoi( &i, c->argv[2] ) != 0 ) {
4059 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse template #=\"%s\"",
4061 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4065 if ( i < 0 || i >= cm->numattrsets ||
4066 !(qm->attr_sets[i].flags & PC_CONFIGURED )) {
4067 snprintf( c->cr_msg, sizeof( c->cr_msg ), "template index %d invalid (%s%d)",
4068 i, cm->numattrsets > 1 ? "0->" : "", cm->numattrsets - 1 );
4069 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4073 AttributeName *attrs;
4075 cnt = template_attrs( c->argv[1], &qm->attr_sets[i], &attrs, &text );
4077 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse template: %s",
4079 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4082 temp = ch_calloc( 1, sizeof( QueryTemplate ));
4083 temp->qmnext = qm->templates;
4084 qm->templates = temp;
4085 temp->t_attrs.attrs = attrs;
4086 temp->t_attrs.count = cnt;
4088 ldap_pvt_thread_rdwr_init( &temp->t_rwlock );
4089 temp->query = temp->query_last = NULL;
4090 if ( lutil_parse_time( c->argv[3], &t ) != 0 ) {
4091 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4092 "unable to parse template ttl=\"%s\"",
4094 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4096 ch_free( temp->t_attrs.attrs );
4100 temp->ttl = (time_t)t;
4101 temp->negttl = (time_t)0;
4102 temp->limitttl = (time_t)0;
4103 temp->ttr = (time_t)0;
4104 switch ( c->argc ) {
4106 if ( lutil_parse_time( c->argv[6], &t ) != 0 ) {
4107 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4108 "unable to parse template ttr=\"%s\"",
4110 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4113 temp->ttr = (time_t)t;
4117 if ( lutil_parse_time( c->argv[5], &t ) != 0 ) {
4118 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4119 "unable to parse template sizelimit ttl=\"%s\"",
4121 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4124 temp->limitttl = (time_t)t;
4128 if ( lutil_parse_time( c->argv[4], &t ) != 0 ) {
4129 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4130 "unable to parse template negative ttl=\"%s\"",
4132 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4135 temp->negttl = (time_t)t;
4139 temp->no_of_queries = 0;
4141 ber_str2bv( c->argv[1], 0, 1, &temp->querystr );
4142 Debug( pcache_debug, "Template:\n", 0, 0, 0 );
4143 Debug( pcache_debug, " query template: %s\n",
4144 temp->querystr.bv_val, 0, 0 );
4145 temp->attr_set_index = i;
4146 qm->attr_sets[i].flags |= PC_REFERENCED;
4147 temp->qtnext = qm->attr_sets[i].templates;
4148 qm->attr_sets[i].templates = temp;
4149 Debug( pcache_debug, " attributes: \n", 0, 0, 0 );
4150 if ( ( attrarray = qm->attr_sets[i].attrs ) != NULL ) {
4151 for ( i=0; attrarray[i].an_name.bv_val; i++ )
4152 Debug( pcache_debug, "\t%s\n",
4153 attrarray[i].an_name.bv_val, 0, 0 );
4157 if ( !qm->templates ) {
4158 snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"pcacheTemplate\" directive not provided yet" );
4159 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4162 if ( lutil_atoi( &i, c->argv[2] ) != 0 ) {
4163 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse Bind index #=\"%s\"",
4165 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4169 if ( i < 0 || i >= cm->numattrsets ||
4170 !(qm->attr_sets[i].flags & PC_CONFIGURED )) {
4171 snprintf( c->cr_msg, sizeof( c->cr_msg ), "Bind index %d invalid (%s%d)",
4172 i, cm->numattrsets > 1 ? "0->" : "", cm->numattrsets - 1 );
4173 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4176 { struct berval bv, tempbv;
4177 AttributeDescription **descs;
4179 ber_str2bv( c->argv[1], 0, 0, &bv );
4180 ndescs = ftemp_attrs( &bv, &tempbv, &descs, &text );
4182 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse template: %s",
4184 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4187 for ( temp = qm->templates; temp; temp=temp->qmnext ) {
4188 if ( temp->attr_set_index == i && bvmatch( &tempbv,
4192 ch_free( tempbv.bv_val );
4195 snprintf( c->cr_msg, sizeof( c->cr_msg ), "Bind template %s %d invalid",
4197 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4200 ber_dupbv( &temp->bindftemp, &bv );
4201 temp->bindfattrs = descs;
4202 temp->bindnattrs = ndescs;
4204 if ( lutil_parse_time( c->argv[3], &t ) != 0 ) {
4205 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4206 "unable to parse bind ttr=\"%s\"",
4208 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4210 ch_free( temp->bindfattrs );
4211 temp->bindfattrs = NULL;
4212 ch_free( temp->bindftemp.bv_val );
4213 BER_BVZERO( &temp->bindftemp );
4216 num = ldap_pvt_str2scope( c->argv[4] );
4218 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4219 "unable to parse bind scope=\"%s\"",
4221 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4225 struct berval dn, ndn;
4226 ber_str2bv( c->argv[5], 0, 0, &dn );
4227 rc = dnNormalize( 0, NULL, NULL, &dn, &ndn, NULL );
4229 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4230 "invalid bind baseDN=\"%s\"",
4232 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4235 if ( temp->bindbase.bv_val )
4236 ch_free( temp->bindbase.bv_val );
4237 temp->bindbase = ndn;
4240 /* convert the template into dummy filter */
4242 char *eq = temp->bindftemp.bv_val, *e2;
4245 while ((eq = strchr(eq, '=' ))) {
4250 bv.bv_len = temp->bindftemp.bv_len + i;
4251 bv.bv_val = ch_malloc( bv.bv_len + 1 );
4252 for ( e2 = bv.bv_val, eq = temp->bindftemp.bv_val;
4263 f = str2filter( bv.bv_val );
4265 ch_free( bv.bv_val );
4266 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4267 "unable to parse bindfilter=\"%s\"", bv.bv_val );
4268 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4269 ch_free( temp->bindbase.bv_val );
4270 BER_BVZERO( &temp->bindbase );
4273 if ( temp->bindfilter )
4274 filter_free( temp->bindfilter );
4275 if ( temp->bindfilterstr.bv_val )
4276 ch_free( temp->bindfilterstr.bv_val );
4277 temp->bindfilterstr = bv;
4278 temp->bindfilter = f;
4280 temp->bindttr = (time_t)t;
4281 temp->bindscope = num;
4282 cm->cache_binds = 1;
4286 if ( strcasecmp( c->argv[1], "head" ) == 0 ) {
4287 cm->response_cb = PCACHE_RESPONSE_CB_HEAD;
4289 } else if ( strcasecmp( c->argv[1], "tail" ) == 0 ) {
4290 cm->response_cb = PCACHE_RESPONSE_CB_TAIL;
4293 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unknown specifier" );
4294 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4299 if ( c->value_int <= 0 ) {
4300 snprintf( c->cr_msg, sizeof( c->cr_msg ), "max queries must be positive" );
4301 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4304 cm->max_queries = c->value_int;
4308 cm->cc_paused |= PCACHE_CC_OFFLINE;
4310 cm->cc_paused &= ~PCACHE_CC_OFFLINE;
4313 if ( cm->db.be_private == NULL ) {
4314 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4315 "private database must be defined before setting database specific options" );
4316 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4320 if ( cm->db.bd_info->bi_cf_ocs ) {
4323 char *argv0 = c->argv[ 0 ];
4325 c->argv[ 0 ] = &argv0[ STRLENOF( "pcache-" ) ];
4327 ct = config_find_keyword( cm->db.bd_info->bi_cf_ocs->co_table, c );
4329 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4330 "private database does not recognize specific option '%s'",
4332 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4336 c->table = cm->db.bd_info->bi_cf_ocs->co_type;
4338 c->bi = c->be->bd_info;
4340 rc = config_add_vals( ct, c );
4344 c->table = c2.table;
4347 c->argv[ 0 ] = argv0;
4349 } else if ( cm->db.be_config != NULL ) {
4350 char *argv0 = c->argv[ 0 ];
4352 c->argv[ 0 ] = &argv0[ STRLENOF( "pcache-" ) ];
4353 rc = cm->db.be_config( &cm->db, c->fname, c->lineno, c->argc, c->argv );
4354 c->argv[ 0 ] = argv0;
4357 snprintf( c->cr_msg, sizeof( c->cr_msg ),
4358 "no means to set private database specific options" );
4359 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
4364 rc = SLAP_CONF_UNKNOWN;
4380 slap_overinst *on = (slap_overinst *)be->bd_info;
4381 cache_manager* cm = on->on_bi.bi_private;
4383 /* Something for the cache database? */
4384 if ( cm->db.bd_info && cm->db.bd_info->bi_db_config )
4385 return cm->db.bd_info->bi_db_config( &cm->db, fname, lineno,
4387 return SLAP_CONF_UNKNOWN;
4395 slap_overinst *on = (slap_overinst *)be->bd_info;
4399 cm = (cache_manager *)ch_malloc(sizeof(cache_manager));
4400 on->on_bi.bi_private = cm;
4402 qm = (query_manager*)ch_malloc(sizeof(query_manager));
4405 SLAP_DBFLAGS(&cm->db) |= SLAP_DBFLAG_NO_SCHEMA_CHECK;
4406 cm->db.be_private = NULL;
4407 cm->db.bd_self = &cm->db;
4409 cm->numattrsets = 0;
4410 cm->num_entries_limit = 5;
4411 cm->num_cached_queries = 0;
4412 cm->max_entries = 0;
4413 cm->cur_entries = 0;
4414 cm->max_queries = 10000;
4415 cm->save_queries = 0;
4416 cm->check_cacheability = 0;
4417 cm->response_cb = PCACHE_RESPONSE_CB_TAIL;
4418 cm->defer_db_open = 1;
4419 cm->cache_binds = 0;
4420 cm->cc_period = 1000;
4423 #ifdef PCACHE_MONITOR
4424 cm->monitor_cb = NULL;
4425 #endif /* PCACHE_MONITOR */
4427 qm->attr_sets = NULL;
4428 qm->templates = NULL;
4430 qm->lru_bottom = NULL;
4432 qm->qcfunc = query_containment;
4433 qm->crfunc = cache_replacement;
4434 qm->addfunc = add_query;
4435 ldap_pvt_thread_mutex_init(&qm->lru_mutex);
4437 ldap_pvt_thread_mutex_init(&cm->cache_mutex);
4439 #ifndef PCACHE_MONITOR
4441 #else /* PCACHE_MONITOR */
4442 return pcache_monitor_db_init( be );
4443 #endif /* PCACHE_MONITOR */
4447 pcache_cachedquery_open_cb( Operation *op, SlapReply *rs )
4449 assert( op->o_tag == LDAP_REQ_SEARCH );
4451 if ( rs->sr_type == REP_SEARCH ) {
4454 a = attr_find( rs->sr_entry->e_attrs, ad_cachedQueryURL );
4458 assert( a->a_nvals != NULL );
4460 valsp = op->o_callback->sc_private;
4461 assert( *valsp == NULL );
4463 ber_bvarray_dup_x( valsp, a->a_nvals, op->o_tmpmemctx );
4471 pcache_cachedquery_count_cb( Operation *op, SlapReply *rs )
4473 assert( op->o_tag == LDAP_REQ_SEARCH );
4475 if ( rs->sr_type == REP_SEARCH ) {
4476 int *countp = (int *)op->o_callback->sc_private;
4489 cache_manager *cm = on->on_bi.bi_private;
4490 query_manager* qm = cm->qm;
4493 rc = backend_startup_one( &cm->db, cr );
4495 cm->defer_db_open = 0;
4498 /* There is no runqueue in TOOL mode */
4499 if (( slapMode & SLAP_SERVER_MODE ) && rc == 0 ) {
4500 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
4501 ldap_pvt_runqueue_insert( &slapd_rq, cm->cc_period,
4502 consistency_check, on,
4503 "pcache_consistency", cm->db.be_suffix[0].bv_val );
4504 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
4506 /* Cached database must have the rootdn */
4507 if ( BER_BVISNULL( &cm->db.be_rootndn )
4508 || BER_BVISEMPTY( &cm->db.be_rootndn ) )
4510 Debug( LDAP_DEBUG_ANY, "pcache_db_open(): "
4511 "underlying database of type \"%s\"\n"
4512 " serving naming context \"%s\"\n"
4513 " has no \"rootdn\", required by \"pcache\".\n",
4514 on->on_info->oi_orig->bi_type,
4515 cm->db.be_suffix[0].bv_val, 0 );
4519 if ( cm->save_queries ) {
4520 void *thrctx = ldap_pvt_thread_pool_context();
4521 Connection conn = { 0 };
4522 OperationBuffer opbuf;
4524 slap_callback cb = { 0 };
4525 SlapReply rs = { REP_RESULT };
4526 BerVarray vals = NULL;
4527 Filter f = { 0 }, f2 = { 0 };
4528 AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
4529 AttributeName attrs[ 2 ] = {{{ 0 }}};
4531 connection_fake_init2( &conn, &opbuf, thrctx, 0 );
4536 op->o_tag = LDAP_REQ_SEARCH;
4537 op->o_protocol = LDAP_VERSION3;
4538 cb.sc_response = pcache_cachedquery_open_cb;
4539 cb.sc_private = &vals;
4540 op->o_callback = &cb;
4541 op->o_time = slap_get_time();
4542 op->o_do_not_cache = 1;
4543 op->o_managedsait = SLAP_CONTROL_CRITICAL;
4545 op->o_dn = cm->db.be_rootdn;
4546 op->o_ndn = cm->db.be_rootndn;
4547 op->o_req_dn = cm->db.be_suffix[ 0 ];
4548 op->o_req_ndn = cm->db.be_nsuffix[ 0 ];
4550 op->ors_scope = LDAP_SCOPE_BASE;
4551 op->ors_deref = LDAP_DEREF_NEVER;
4553 op->ors_tlimit = SLAP_NO_LIMIT;
4554 op->ors_limit = NULL;
4555 ber_str2bv( "(pcacheQueryURL=*)", 0, 0, &op->ors_filterstr );
4556 f.f_choice = LDAP_FILTER_PRESENT;
4557 f.f_desc = ad_cachedQueryURL;
4558 op->ors_filter = &f;
4559 attrs[ 0 ].an_desc = ad_cachedQueryURL;
4560 attrs[ 0 ].an_name = ad_cachedQueryURL->ad_cname;
4561 op->ors_attrs = attrs;
4562 op->ors_attrsonly = 0;
4564 rc = op->o_bd->be_search( op, &rs );
4565 if ( rc == LDAP_SUCCESS && vals != NULL ) {
4568 for ( i = 0; !BER_BVISNULL( &vals[ i ] ); i++ ) {
4569 if ( url2query( vals[ i ].bv_val, op, qm ) == 0 ) {
4570 cm->num_cached_queries++;
4574 ber_bvarray_free_x( vals, op->o_tmpmemctx );
4577 /* count cached entries */
4578 f.f_choice = LDAP_FILTER_NOT;
4580 f2.f_choice = LDAP_FILTER_EQUALITY;
4582 f2.f_av_desc = slap_schema.si_ad_objectClass;
4583 BER_BVSTR( &f2.f_av_value, "glue" );
4584 ber_str2bv( "(!(objectClass=glue))", 0, 0, &op->ors_filterstr );
4586 op->ors_slimit = SLAP_NO_LIMIT;
4587 op->ors_scope = LDAP_SCOPE_SUBTREE;
4588 op->ors_attrs = slap_anlist_no_attrs;
4590 rs_reinit( &rs, REP_RESULT );
4591 op->o_callback->sc_response = pcache_cachedquery_count_cb;
4592 op->o_callback->sc_private = &rs.sr_nentries;
4594 rc = op->o_bd->be_search( op, &rs );
4596 cm->cur_entries = rs.sr_nentries;
4610 slap_overinst *on = (slap_overinst *)be->bd_info;
4611 cache_manager *cm = on->on_bi.bi_private;
4612 query_manager* qm = cm->qm;
4613 int i, ncf = 0, rf = 0, nrf = 0, rc = 0;
4615 /* check attr sets */
4616 for ( i = 0; i < cm->numattrsets; i++) {
4617 if ( !( qm->attr_sets[i].flags & PC_CONFIGURED ) ) {
4618 if ( qm->attr_sets[i].flags & PC_REFERENCED ) {
4619 Debug( LDAP_DEBUG_CONFIG, "pcache: attr set #%d not configured but referenced.\n", i, 0, 0 );
4623 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, attr set #%d not configured.\n", i, 0, 0 );
4627 } else if ( !( qm->attr_sets[i].flags & PC_REFERENCED ) ) {
4628 Debug( LDAP_DEBUG_CONFIG, "pcache: attr set #%d configured but not referenced.\n", i, 0, 0 );
4633 if ( ncf || rf || nrf ) {
4634 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, %d attr sets configured but not referenced.\n", nrf, 0, 0 );
4635 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, %d attr sets not configured.\n", ncf, 0, 0 );
4636 Debug( LDAP_DEBUG_CONFIG, "pcache: %d attr sets not configured but referenced.\n", rf, 0, 0 );
4643 /* need to inherit something from the original database... */
4644 cm->db.be_def_limit = be->be_def_limit;
4645 cm->db.be_limits = be->be_limits;
4646 cm->db.be_acl = be->be_acl;
4647 cm->db.be_dfltaccess = be->be_dfltaccess;
4649 if ( SLAP_DBMONITORING( be ) ) {
4650 SLAP_DBFLAGS( &cm->db ) |= SLAP_DBFLAG_MONITORING;
4653 SLAP_DBFLAGS( &cm->db ) &= ~SLAP_DBFLAG_MONITORING;
4656 if ( !cm->defer_db_open ) {
4657 rc = pcache_db_open2( on, cr );
4660 #ifdef PCACHE_MONITOR
4661 if ( rc == LDAP_SUCCESS ) {
4662 rc = pcache_monitor_db_open( be );
4664 #endif /* PCACHE_MONITOR */
4670 pcache_free_qbase( void *v )
4676 tavl_free( qb->scopes[i], NULL );
4686 slap_overinst *on = (slap_overinst *)be->bd_info;
4687 cache_manager *cm = on->on_bi.bi_private;
4688 query_manager *qm = cm->qm;
4692 /* stop the thread ... */
4694 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
4695 if ( ldap_pvt_runqueue_isrunning( &slapd_rq, cm->cc_arg ) ) {
4696 ldap_pvt_runqueue_stoptask( &slapd_rq, cm->cc_arg );
4698 ldap_pvt_runqueue_remove( &slapd_rq, cm->cc_arg );
4699 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
4702 if ( cm->save_queries ) {
4704 BerVarray vals = NULL;
4707 Connection conn = { 0 };
4708 OperationBuffer opbuf;
4710 slap_callback cb = { 0 };
4712 SlapReply rs = { REP_RESULT };
4713 Modifications mod = {{ 0 }};
4715 thrctx = ldap_pvt_thread_pool_context();
4717 connection_fake_init2( &conn, &opbuf, thrctx, 0 );
4720 if ( qm->templates != NULL ) {
4721 for ( tm = qm->templates; tm != NULL; tm = tm->qmnext ) {
4722 for ( qc = tm->query; qc; qc = qc->next ) {
4725 if ( query2url( op, qc, &bv, 0 ) == 0 ) {
4726 ber_bvarray_add_x( &vals, &bv, op->o_tmpmemctx );
4733 op->o_dn = cm->db.be_rootdn;
4734 op->o_ndn = cm->db.be_rootndn;
4736 op->o_tag = LDAP_REQ_MODIFY;
4737 op->o_protocol = LDAP_VERSION3;
4738 cb.sc_response = slap_null_cb;
4739 op->o_callback = &cb;
4740 op->o_time = slap_get_time();
4741 op->o_do_not_cache = 1;
4742 op->o_managedsait = SLAP_CONTROL_CRITICAL;
4744 op->o_req_dn = op->o_bd->be_suffix[0];
4745 op->o_req_ndn = op->o_bd->be_nsuffix[0];
4747 mod.sml_op = LDAP_MOD_REPLACE;
4749 mod.sml_desc = ad_cachedQueryURL;
4750 mod.sml_type = ad_cachedQueryURL->ad_cname;
4751 mod.sml_values = vals;
4752 mod.sml_nvalues = NULL;
4753 mod.sml_numvals = 1;
4754 mod.sml_next = NULL;
4755 Debug( pcache_debug,
4756 "%sSETTING CACHED QUERY URLS\n",
4757 vals == NULL ? "RE" : "", 0, 0 );
4759 op->orm_modlist = &mod;
4761 op->o_bd->be_modify( op, &rs );
4763 ber_bvarray_free_x( vals, op->o_tmpmemctx );
4766 /* cleanup stuff inherited from the original database... */
4767 cm->db.be_limits = NULL;
4768 cm->db.be_acl = NULL;
4771 if ( cm->db.bd_info->bi_db_close ) {
4772 rc = cm->db.bd_info->bi_db_close( &cm->db, NULL );
4774 while ( (tm = qm->templates) != NULL ) {
4775 CachedQuery *qc, *qn;
4776 qm->templates = tm->qmnext;
4777 for ( qc = tm->query; qc; qc = qn ) {
4781 avl_free( tm->qbase, pcache_free_qbase );
4782 free( tm->querystr.bv_val );
4783 free( tm->bindfattrs );
4784 free( tm->bindftemp.bv_val );
4785 free( tm->bindfilterstr.bv_val );
4786 free( tm->bindbase.bv_val );
4787 filter_free( tm->bindfilter );
4788 ldap_pvt_thread_rdwr_destroy( &tm->t_rwlock );
4789 free( tm->t_attrs.attrs );
4793 for ( i=0; i<cm->numattrsets; i++ ) {
4794 free( qm->attr_sets[i].attrs );
4796 free( qm->attr_sets );
4797 qm->attr_sets = NULL;
4799 #ifdef PCACHE_MONITOR
4800 if ( rc == LDAP_SUCCESS ) {
4801 rc = pcache_monitor_db_close( be );
4803 #endif /* PCACHE_MONITOR */
4814 slap_overinst *on = (slap_overinst *)be->bd_info;
4815 cache_manager *cm = on->on_bi.bi_private;
4816 query_manager *qm = cm->qm;
4818 if ( cm->db.be_private != NULL ) {
4819 backend_stopdown_one( &cm->db );
4822 ldap_pvt_thread_mutex_destroy( &qm->lru_mutex );
4823 ldap_pvt_thread_mutex_destroy( &cm->cache_mutex );
4827 #ifdef PCACHE_MONITOR
4828 pcache_monitor_db_destroy( be );
4829 #endif /* PCACHE_MONITOR */
4834 #ifdef PCACHE_CONTROL_PRIVDB
4836 Control ::= SEQUENCE {
4837 controlType LDAPOID,
4838 criticality BOOLEAN DEFAULT FALSE,
4839 controlValue OCTET STRING OPTIONAL }
4841 controlType ::= 1.3.6.1.4.1.4203.666.11.9.5.1
4843 * criticality must be TRUE; controlValue must be absent.
4851 if ( op->o_ctrlflag[ privDB_cid ] != SLAP_CONTROL_NONE ) {
4852 rs->sr_text = "privateDB control specified multiple times";
4853 return LDAP_PROTOCOL_ERROR;
4856 if ( !BER_BVISNULL( &ctrl->ldctl_value ) ) {
4857 rs->sr_text = "privateDB control value not absent";
4858 return LDAP_PROTOCOL_ERROR;
4861 if ( !ctrl->ldctl_iscritical ) {
4862 rs->sr_text = "privateDB control criticality required";
4863 return LDAP_PROTOCOL_ERROR;
4866 op->o_ctrlflag[ privDB_cid ] = SLAP_CONTROL_CRITICAL;
4868 return LDAP_SUCCESS;
4871 static char *extops[] = {
4872 LDAP_EXOP_MODIFY_PASSWD,
4875 #endif /* PCACHE_CONTROL_PRIVDB */
4877 static struct berval pcache_exop_MODIFY_PASSWD = BER_BVC( LDAP_EXOP_MODIFY_PASSWD );
4878 #ifdef PCACHE_EXOP_QUERY_DELETE
4879 static struct berval pcache_exop_QUERY_DELETE = BER_BVC( PCACHE_EXOP_QUERY_DELETE );
4881 #define LDAP_TAG_EXOP_QUERY_DELETE_BASE ((LBER_CLASS_CONTEXT|LBER_CONSTRUCTED) + 0)
4882 #define LDAP_TAG_EXOP_QUERY_DELETE_DN ((LBER_CLASS_CONTEXT|LBER_CONSTRUCTED) + 1)
4883 #define LDAP_TAG_EXOP_QUERY_DELETE_UUID ((LBER_CLASS_CONTEXT|LBER_CONSTRUCTED) + 2)
4886 ExtendedRequest ::= [APPLICATION 23] SEQUENCE {
4887 requestName [0] LDAPOID,
4888 requestValue [1] OCTET STRING OPTIONAL }
4890 requestName ::= 1.3.6.1.4.1.4203.666.11.9.6.1
4892 requestValue ::= SEQUENCE { CHOICE {
4894 entryDN [1] LDAPDN },
4895 queryID [2] OCTET STRING (SIZE(16))
4896 -- constrained to UUID }
4898 * Either baseDN or entryDN must be present, to allow database selection.
4900 * 1. if baseDN and queryID are present, then the query corresponding
4901 * to queryID is deleted;
4902 * 2. if baseDN is present and queryID is absent, then all queries
4904 * 3. if entryDN is present and queryID is absent, then all queries
4905 * corresponding to the queryID values present in entryDN are deleted;
4906 * 4. if entryDN and queryID are present, then all queries
4907 * corresponding to the queryID values present in entryDN are deleted,
4908 * but only if the value of queryID is contained in the entry;
4910 * Currently, only 1, 3 and 4 are implemented. 2 can be obtained by either
4911 * recursively deleting the database (ldapdelete -r) with PRIVDB control,
4912 * or by removing the database files.
4914 ExtendedResponse ::= [APPLICATION 24] SEQUENCE {
4915 COMPONENTS OF LDAPResult,
4916 responseName [10] LDAPOID OPTIONAL,
4917 responseValue [11] OCTET STRING OPTIONAL }
4919 * responseName and responseValue must be absent.
4923 * - on success, *tagp is either LDAP_TAG_EXOP_QUERY_DELETE_BASE
4924 * or LDAP_TAG_EXOP_QUERY_DELETE_DN.
4925 * - if ndn != NULL, it is set to the normalized DN in the request
4926 * corresponding to either the baseDN or the entryDN, according
4927 * to *tagp; memory is malloc'ed on the Operation's slab, and must
4928 * be freed by the caller.
4929 * - if uuid != NULL, it is set to point to the normalized UUID;
4930 * memory is malloc'ed on the Operation's slab, and must
4931 * be freed by the caller.
4934 pcache_parse_query_delete(
4938 struct berval *uuid,
4942 int rc = LDAP_SUCCESS;
4945 BerElementBuffer berbuf;
4946 BerElement *ber = (BerElement *)&berbuf;
4947 struct berval reqdata = BER_BVNULL;
4959 if ( in == NULL || in->bv_len == 0 ) {
4960 *text = "empty request data field in queryDelete exop";
4961 return LDAP_PROTOCOL_ERROR;
4964 ber_dupbv_x( &reqdata, in, ctx );
4966 /* ber_init2 uses reqdata directly, doesn't allocate new buffers */
4967 ber_init2( ber, &reqdata, 0 );
4969 tag = ber_scanf( ber, "{" /*}*/ );
4971 if ( tag == LBER_ERROR ) {
4972 Debug( LDAP_DEBUG_TRACE,
4973 "pcache_parse_query_delete: decoding error.\n",
4975 goto decoding_error;
4978 tag = ber_peek_tag( ber, &len );
4979 if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_BASE
4980 || tag == LDAP_TAG_EXOP_QUERY_DELETE_DN )
4984 if ( ndn != NULL ) {
4987 tag = ber_scanf( ber, "m", &dn );
4988 if ( tag == LBER_ERROR ) {
4989 Debug( LDAP_DEBUG_TRACE,
4990 "pcache_parse_query_delete: DN parse failed.\n",
4992 goto decoding_error;
4995 rc = dnNormalize( 0, NULL, NULL, &dn, ndn, ctx );
4996 if ( rc != LDAP_SUCCESS ) {
4997 *text = "invalid DN in queryDelete exop request data";
5002 tag = ber_scanf( ber, "x" /* "m" */ );
5003 if ( tag == LBER_DEFAULT ) {
5004 goto decoding_error;
5008 tag = ber_peek_tag( ber, &len );
5011 if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_UUID ) {
5012 if ( uuid != NULL ) {
5014 char uuidbuf[ LDAP_LUTIL_UUIDSTR_BUFSIZE ];
5016 tag = ber_scanf( ber, "m", &bv );
5017 if ( tag == LBER_ERROR ) {
5018 Debug( LDAP_DEBUG_TRACE,
5019 "pcache_parse_query_delete: UUID parse failed.\n",
5021 goto decoding_error;
5024 if ( bv.bv_len != 16 ) {
5025 Debug( LDAP_DEBUG_TRACE,
5026 "pcache_parse_query_delete: invalid UUID length %lu.\n",
5027 (unsigned long)bv.bv_len, 0, 0 );
5028 goto decoding_error;
5031 rc = lutil_uuidstr_from_normalized(
5032 bv.bv_val, bv.bv_len,
5033 uuidbuf, sizeof( uuidbuf ) );
5035 goto decoding_error;
5037 ber_str2bv( uuidbuf, rc, 1, uuid );
5041 tag = ber_skip_tag( ber, &len );
5042 if ( tag == LBER_DEFAULT ) {
5043 goto decoding_error;
5047 Debug( LDAP_DEBUG_TRACE,
5048 "pcache_parse_query_delete: invalid UUID length %lu.\n",
5049 (unsigned long)len, 0, 0 );
5050 goto decoding_error;
5054 tag = ber_peek_tag( ber, &len );
5057 if ( tag != LBER_DEFAULT || len != 0 ) {
5059 Debug( LDAP_DEBUG_TRACE,
5060 "pcache_parse_query_delete: decoding error\n",
5062 rc = LDAP_PROTOCOL_ERROR;
5063 *text = "queryDelete data decoding error";
5066 if ( ndn && !BER_BVISNULL( ndn ) ) {
5067 slap_sl_free( ndn->bv_val, ctx );
5071 if ( uuid && !BER_BVISNULL( uuid ) ) {
5072 slap_sl_free( uuid->bv_val, ctx );
5077 if ( !BER_BVISNULL( &reqdata ) ) {
5078 ber_memfree_x( reqdata.bv_val, ctx );
5085 pcache_exop_query_delete(
5089 BackendDB *bd = op->o_bd;
5091 struct berval uuid = BER_BVNULL,
5093 char buf[ SLAP_TEXT_BUFLEN ];
5095 ber_tag_t tag = LBER_DEFAULT;
5097 if ( LogTest( LDAP_DEBUG_STATS ) ) {
5101 rs->sr_err = pcache_parse_query_delete( op->ore_reqdata,
5102 &tag, &op->o_req_ndn, uuidp,
5103 &rs->sr_text, op->o_tmpmemctx );
5104 if ( rs->sr_err != LDAP_SUCCESS ) {
5108 if ( LogTest( LDAP_DEBUG_STATS ) ) {
5109 assert( !BER_BVISNULL( &op->o_req_ndn ) );
5110 len = snprintf( buf, sizeof( buf ), " dn=\"%s\"", op->o_req_ndn.bv_val );
5112 if ( !BER_BVISNULL( &uuid ) && len < sizeof( buf ) ) {
5113 snprintf( &buf[ len ], sizeof( buf ) - len, " pcacheQueryId=\"%s\"", uuid.bv_val );
5116 Debug( LDAP_DEBUG_STATS, "%s QUERY DELETE%s\n",
5117 op->o_log_prefix, buf, 0 );
5119 op->o_req_dn = op->o_req_ndn;
5121 op->o_bd = select_backend( &op->o_req_ndn, 0 );
5122 if ( op->o_bd == NULL ) {
5123 send_ldap_error( op, rs, LDAP_NO_SUCH_OBJECT,
5124 "no global superior knowledge" );
5126 rs->sr_err = backend_check_restrictions( op, rs,
5127 (struct berval *)&pcache_exop_QUERY_DELETE );
5128 if ( rs->sr_err != LDAP_SUCCESS ) {
5132 if ( op->o_bd->be_extended == NULL ) {
5133 send_ldap_error( op, rs, LDAP_UNAVAILABLE_CRITICAL_EXTENSION,
5134 "backend does not support extended operations" );
5138 op->o_bd->be_extended( op, rs );
5141 if ( !BER_BVISNULL( &op->o_req_ndn ) ) {
5142 op->o_tmpfree( op->o_req_ndn.bv_val, op->o_tmpmemctx );
5143 BER_BVZERO( &op->o_req_ndn );
5144 BER_BVZERO( &op->o_req_dn );
5147 if ( !BER_BVISNULL( &uuid ) ) {
5148 op->o_tmpfree( uuid.bv_val, op->o_tmpmemctx );
5155 #endif /* PCACHE_EXOP_QUERY_DELETE */
5158 pcache_op_extended( Operation *op, SlapReply *rs )
5160 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
5161 cache_manager *cm = on->on_bi.bi_private;
5163 #ifdef PCACHE_CONTROL_PRIVDB
5164 if ( op->o_ctrlflag[ privDB_cid ] == SLAP_CONTROL_CRITICAL ) {
5165 return pcache_op_privdb( op, rs );
5167 #endif /* PCACHE_CONTROL_PRIVDB */
5169 #ifdef PCACHE_EXOP_QUERY_DELETE
5170 if ( bvmatch( &op->ore_reqoid, &pcache_exop_QUERY_DELETE ) ) {
5171 struct berval uuid = BER_BVNULL;
5172 ber_tag_t tag = LBER_DEFAULT;
5174 rs->sr_err = pcache_parse_query_delete( op->ore_reqdata,
5175 &tag, NULL, &uuid, &rs->sr_text, op->o_tmpmemctx );
5176 assert( rs->sr_err == LDAP_SUCCESS );
5178 if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_DN ) {
5179 /* remove all queries related to the selected entry */
5180 rs->sr_err = pcache_remove_entry_queries_from_cache( op,
5181 cm, &op->o_req_ndn, &uuid );
5183 } else if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_BASE ) {
5184 if ( !BER_BVISNULL( &uuid ) ) {
5185 /* remove the selected query */
5186 rs->sr_err = pcache_remove_query_from_cache( op,
5190 /* TODO: remove all queries */
5191 rs->sr_err = LDAP_UNWILLING_TO_PERFORM;
5192 rs->sr_text = "deletion of all queries not implemented";
5196 op->o_tmpfree( uuid.bv_val, op->o_tmpmemctx );
5199 #endif /* PCACHE_EXOP_QUERY_DELETE */
5201 /* We only care if we're configured for Bind caching */
5202 if ( bvmatch( &op->ore_reqoid, &pcache_exop_MODIFY_PASSWD ) &&
5204 /* See if the local entry exists and has a password.
5205 * It's too much work to find the matching query, so
5206 * we just see if there's a hashed password to update.
5208 Operation op2 = *op;
5214 op2.o_dn = op->o_bd->be_rootdn;
5215 op2.o_ndn = op->o_bd->be_rootndn;
5216 rc = be_entry_get_rw( &op2, &op->o_req_ndn, NULL,
5217 slap_schema.si_ad_userPassword, 0, &e );
5218 if ( rc == LDAP_SUCCESS && e ) {
5219 /* See if a recognized password is hashed here */
5220 Attribute *a = attr_find( e->e_attrs,
5221 slap_schema.si_ad_userPassword );
5222 if ( a && a->a_vals[0].bv_val[0] == '{' &&
5223 lutil_passwd_scheme( a->a_vals[0].bv_val )) {
5226 be_entry_release_r( &op2, e );
5230 rc = overlay_op_walk( op, rs, op_extended, on->on_info,
5232 if ( rc == LDAP_SUCCESS ) {
5233 req_pwdexop_s *qpw = &op->oq_pwdexop;
5235 /* We don't care if it succeeds or not */
5236 pc_setpw( &op2, &qpw->rs_new, cm );
5241 return SLAP_CB_CONTINUE;
5245 pcache_entry_release( Operation *op, Entry *e, int rw )
5247 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
5248 cache_manager *cm = on->on_bi.bi_private;
5249 BackendDB *db = op->o_bd;
5253 rc = be_entry_release_rw( op, e, rw );
5258 #ifdef PCACHE_MONITOR
5261 pcache_monitor_update(
5267 cache_manager *cm = (cache_manager *) priv;
5268 query_manager *qm = cm->qm;
5271 BerVarray vals = NULL;
5273 attr_delete( &e->e_attrs, ad_cachedQueryURL );
5274 if ( ( SLAP_OPATTRS( rs->sr_attr_flags ) || ad_inlist( ad_cachedQueryURL, rs->sr_attrs ) )
5275 && qm->templates != NULL )
5279 for ( tm = qm->templates; tm != NULL; tm = tm->qmnext ) {
5280 for ( qc = tm->query; qc; qc = qc->next ) {
5283 if ( query2url( op, qc, &bv, 1 ) == 0 ) {
5284 ber_bvarray_add_x( &vals, &bv, op->o_tmpmemctx );
5290 if ( vals != NULL ) {
5291 attr_merge_normalize( e, ad_cachedQueryURL, vals, NULL );
5292 ber_bvarray_free_x( vals, op->o_tmpmemctx );
5298 char buf[ SLAP_TEXT_BUFLEN ];
5301 /* number of cached queries */
5302 a = attr_find( e->e_attrs, ad_numQueries );
5303 assert( a != NULL );
5306 bv.bv_len = snprintf( buf, sizeof( buf ), "%lu", cm->num_cached_queries );
5308 if ( a->a_nvals != a->a_vals ) {
5309 ber_bvreplace( &a->a_nvals[ 0 ], &bv );
5311 ber_bvreplace( &a->a_vals[ 0 ], &bv );
5313 /* number of cached entries */
5314 a = attr_find( e->e_attrs, ad_numEntries );
5315 assert( a != NULL );
5318 bv.bv_len = snprintf( buf, sizeof( buf ), "%d", cm->cur_entries );
5320 if ( a->a_nvals != a->a_vals ) {
5321 ber_bvreplace( &a->a_nvals[ 0 ], &bv );
5323 ber_bvreplace( &a->a_vals[ 0 ], &bv );
5326 return SLAP_CB_CONTINUE;
5330 pcache_monitor_free(
5334 struct berval values[ 2 ];
5335 Modification mod = { 0 };
5338 char textbuf[ SLAP_TEXT_BUFLEN ];
5342 /* NOTE: if slap_shutdown != 0, priv might have already been freed */
5345 /* Remove objectClass */
5346 mod.sm_op = LDAP_MOD_DELETE;
5347 mod.sm_desc = slap_schema.si_ad_objectClass;
5348 mod.sm_values = values;
5350 values[ 0 ] = oc_olmPCache->soc_cname;
5351 BER_BVZERO( &values[ 1 ] );
5353 rc = modify_delete_values( e, &mod, 1, &text,
5354 textbuf, sizeof( textbuf ) );
5355 /* don't care too much about return code... */
5358 mod.sm_values = NULL;
5359 mod.sm_desc = ad_cachedQueryURL;
5361 rc = modify_delete_values( e, &mod, 1, &text,
5362 textbuf, sizeof( textbuf ) );
5363 /* don't care too much about return code... */
5366 mod.sm_values = NULL;
5367 mod.sm_desc = ad_numQueries;
5369 rc = modify_delete_values( e, &mod, 1, &text,
5370 textbuf, sizeof( textbuf ) );
5371 /* don't care too much about return code... */
5374 mod.sm_values = NULL;
5375 mod.sm_desc = ad_numEntries;
5377 rc = modify_delete_values( e, &mod, 1, &text,
5378 textbuf, sizeof( textbuf ) );
5379 /* don't care too much about return code... */
5381 return SLAP_CB_CONTINUE;
5385 * call from within pcache_initialize()
5388 pcache_monitor_initialize( void )
5390 static int pcache_monitor_initialized = 0;
5392 if ( backend_info( "monitor" ) == NULL ) {
5396 if ( pcache_monitor_initialized++ ) {
5404 pcache_monitor_db_init( BackendDB *be )
5406 if ( pcache_monitor_initialize() == LDAP_SUCCESS ) {
5407 SLAP_DBFLAGS( be ) |= SLAP_DBFLAG_MONITORING;
5414 pcache_monitor_db_open( BackendDB *be )
5416 slap_overinst *on = (slap_overinst *)be->bd_info;
5417 cache_manager *cm = on->on_bi.bi_private;
5418 Attribute *a, *next;
5419 monitor_callback_t *cb = NULL;
5422 monitor_extra_t *mbe;
5423 struct berval dummy = BER_BVC( "" );
5425 if ( !SLAP_DBMONITORING( be ) ) {
5429 mi = backend_info( "monitor" );
5430 if ( !mi || !mi->bi_extra ) {
5431 SLAP_DBFLAGS( be ) ^= SLAP_DBFLAG_MONITORING;
5436 /* don't bother if monitor is not configured */
5437 if ( !mbe->is_configured() ) {
5438 static int warning = 0;
5440 if ( warning++ == 0 ) {
5441 Debug( LDAP_DEBUG_ANY, "pcache_monitor_db_open: "
5442 "monitoring disabled; "
5443 "configure monitor database to enable\n",
5450 /* alloc as many as required (plus 1 for objectClass) */
5451 a = attrs_alloc( 1 + 2 );
5457 a->a_desc = slap_schema.si_ad_objectClass;
5458 attr_valadd( a, &oc_olmPCache->soc_cname, NULL, 1 );
5462 struct berval bv = BER_BVC( "0" );
5464 next->a_desc = ad_numQueries;
5465 attr_valadd( next, &bv, NULL, 1 );
5466 next = next->a_next;
5468 next->a_desc = ad_numEntries;
5469 attr_valadd( next, &bv, NULL, 1 );
5470 next = next->a_next;
5473 cb = ch_calloc( sizeof( monitor_callback_t ), 1 );
5474 cb->mc_update = pcache_monitor_update;
5475 cb->mc_free = pcache_monitor_free;
5476 cb->mc_private = (void *)cm;
5478 /* make sure the database is registered; then add monitor attributes */
5479 BER_BVZERO( &cm->monitor_ndn );
5480 rc = mbe->register_overlay( be, on, &cm->monitor_ndn );
5482 rc = mbe->register_entry_attrs( &cm->monitor_ndn, a, cb,
5483 &dummy, -1, &dummy);
5499 /* store for cleanup */
5500 cm->monitor_cb = (void *)cb;
5502 /* we don't need to keep track of the attributes, because
5503 * bdb_monitor_free() takes care of everything */
5512 pcache_monitor_db_close( BackendDB *be )
5514 slap_overinst *on = (slap_overinst *)be->bd_info;
5515 cache_manager *cm = on->on_bi.bi_private;
5517 if ( cm->monitor_cb != NULL ) {
5518 BackendInfo *mi = backend_info( "monitor" );
5519 monitor_extra_t *mbe;
5521 if ( mi && &mi->bi_extra ) {
5523 mbe->unregister_entry_callback( NULL,
5524 (monitor_callback_t *)cm->monitor_cb,
5533 pcache_monitor_db_destroy( BackendDB *be )
5538 #endif /* PCACHE_MONITOR */
5540 static slap_overinst pcache;
5542 static char *obsolete_names[] = {
5547 #if SLAPD_OVER_PROXYCACHE == SLAPD_MOD_DYNAMIC
5549 #endif /* SLAPD_OVER_PROXYCACHE == SLAPD_MOD_DYNAMIC */
5554 struct berval debugbv = BER_BVC("pcache");
5558 code = slap_loglevel_get( &debugbv, &pcache_debug );
5563 #ifdef PCACHE_CONTROL_PRIVDB
5564 code = register_supported_control( PCACHE_CONTROL_PRIVDB,
5565 SLAP_CTRL_BIND|SLAP_CTRL_ACCESS|SLAP_CTRL_HIDE, extops,
5566 parse_privdb_ctrl, &privDB_cid );
5567 if ( code != LDAP_SUCCESS ) {
5568 Debug( LDAP_DEBUG_ANY,
5569 "pcache_initialize: failed to register control %s (%d)\n",
5570 PCACHE_CONTROL_PRIVDB, code, 0 );
5573 #endif /* PCACHE_CONTROL_PRIVDB */
5575 #ifdef PCACHE_EXOP_QUERY_DELETE
5576 code = load_extop2( (struct berval *)&pcache_exop_QUERY_DELETE,
5577 SLAP_EXOP_WRITES|SLAP_EXOP_HIDE, pcache_exop_query_delete,
5579 if ( code != LDAP_SUCCESS ) {
5580 Debug( LDAP_DEBUG_ANY,
5581 "pcache_initialize: unable to register queryDelete exop: %d.\n",
5585 #endif /* PCACHE_EXOP_QUERY_DELETE */
5587 argv[ 0 ] = "back-bdb/back-hdb monitor";
5592 for ( i = 0; s_oid[ i ].name; i++ ) {
5594 argv[ 1 ] = s_oid[ i ].name;
5595 argv[ 2 ] = s_oid[ i ].oid;
5597 if ( parse_oidm( &c, 0, NULL ) != 0 ) {
5598 Debug( LDAP_DEBUG_ANY, "pcache_initialize: "
5599 "unable to add objectIdentifier \"%s=%s\"\n",
5600 s_oid[ i ].name, s_oid[ i ].oid, 0 );
5605 for ( i = 0; s_ad[i].desc != NULL; i++ ) {
5606 code = register_at( s_ad[i].desc, s_ad[i].adp, 0 );
5608 Debug( LDAP_DEBUG_ANY,
5609 "pcache_initialize: register_at #%d failed\n", i, 0, 0 );
5612 (*s_ad[i].adp)->ad_type->sat_flags |= SLAP_AT_HIDE;
5615 for ( i = 0; s_oc[i].desc != NULL; i++ ) {
5616 code = register_oc( s_oc[i].desc, s_oc[i].ocp, 0 );
5618 Debug( LDAP_DEBUG_ANY,
5619 "pcache_initialize: register_oc #%d failed\n", i, 0, 0 );
5622 (*s_oc[i].ocp)->soc_flags |= SLAP_OC_HIDE;
5625 pcache.on_bi.bi_type = "pcache";
5626 pcache.on_bi.bi_obsolete_names = obsolete_names;
5627 pcache.on_bi.bi_db_init = pcache_db_init;
5628 pcache.on_bi.bi_db_config = pcache_db_config;
5629 pcache.on_bi.bi_db_open = pcache_db_open;
5630 pcache.on_bi.bi_db_close = pcache_db_close;
5631 pcache.on_bi.bi_db_destroy = pcache_db_destroy;
5633 pcache.on_bi.bi_op_search = pcache_op_search;
5634 pcache.on_bi.bi_op_bind = pcache_op_bind;
5635 #ifdef PCACHE_CONTROL_PRIVDB
5636 pcache.on_bi.bi_op_compare = pcache_op_privdb;
5637 pcache.on_bi.bi_op_modrdn = pcache_op_privdb;
5638 pcache.on_bi.bi_op_modify = pcache_op_privdb;
5639 pcache.on_bi.bi_op_add = pcache_op_privdb;
5640 pcache.on_bi.bi_op_delete = pcache_op_privdb;
5641 #endif /* PCACHE_CONTROL_PRIVDB */
5642 pcache.on_bi.bi_extended = pcache_op_extended;
5644 pcache.on_bi.bi_entry_release_rw = pcache_entry_release;
5645 pcache.on_bi.bi_chk_controls = pcache_chk_controls;
5647 pcache.on_bi.bi_cf_ocs = pcocs;
5649 code = config_register_schema( pccfg, pcocs );
5650 if ( code ) return code;
5652 return overlay_register( &pcache );
5655 #if SLAPD_OVER_PROXYCACHE == SLAPD_MOD_DYNAMIC
5656 int init_module(int argc, char *argv[]) {
5657 return pcache_initialize();
5661 #endif /* defined(SLAPD_OVER_PROXYCACHE) */