2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 2003-2007 The OpenLDAP Foundation.
5 * Portions Copyright 2003 IBM Corporation.
6 * Portions Copyright 2003 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>
38 /* query cache structs */
41 typedef struct Query_s {
42 Filter* filter; /* Search Filter */
43 struct berval base; /* Search Base */
44 int scope; /* Search scope */
47 struct query_template_s;
49 typedef struct Qbase_s {
50 Avlnode *scopes[4]; /* threaded AVL trees of cached queries */
55 /* struct representing a cached query */
56 typedef struct cached_query_s {
61 struct berval q_uuid; /* query identifier */
62 struct query_template_s *qtemp; /* template of the query */
63 time_t expiry_time; /* time till the query is considered valid */
64 struct cached_query_s *next; /* next query in the template */
65 struct cached_query_s *prev; /* previous query in the template */
66 struct cached_query_s *lru_up; /* previous query in the LRU list */
67 struct cached_query_s *lru_down; /* next query in the LRU list */
73 * ldap:///<base>??<scope>?<filter>?x-uuid=<uid>,x-template=<template>,x-attrset=<attrset>,x-expiry=<expiry>
75 * <base> ::= CachedQuery.qbase->base
76 * <scope> ::= CachedQuery.scope
77 * <filter> ::= filter2bv(CachedQuery.filter)
78 * <uuid> ::= CachedQuery.q_uuid
79 * <template> ::= CachedQuery.qtemp->querystr [FIXME: better give it an ID?]
80 * <attrset> ::= CachedQuery.qtemp->attr_set_index [FIXME: better give it an ID?]
81 * <expiry> ::= CachedQuery.expiry_time
83 * quick hack: parse URI, call add_query() and then fix
84 * CachedQuery.expiry_time and CachedQuery.q_uuid
88 * Represents a set of projected attributes.
92 struct query_template_s *templates;
93 AttributeName* attrs; /* specifies the set */
95 #define PC_CONFIGURED (0x1)
96 #define PC_REFERENCED (0x2)
97 #define PC_GOT_OC (0x4)
98 int count; /* number of attributes */
101 /* struct representing a query template
102 * e.g. template string = &(cn=)(mail=)
104 typedef struct query_template_s {
105 struct query_template_s *qtnext;
106 struct query_template_s *qmnext;
109 CachedQuery* query; /* most recent query cached for the template */
110 CachedQuery* query_last; /* oldest query cached for the template */
111 ldap_pvt_thread_rdwr_t t_rwlock; /* Rd/wr lock for accessing queries in the template */
112 struct berval querystr; /* Filter string corresponding to the QT */
114 int attr_set_index; /* determines the projected attributes */
115 int no_of_queries; /* Total number of queries in the template */
116 time_t ttl; /* TTL for the queries of this template */
117 time_t negttl; /* TTL for negative results */
118 struct attr_set t_attrs; /* filter attrs + attr_set */
121 struct query_manager_s;
123 /* prototypes for functions for 1) query containment
124 * 2) query addition, 3) cache replacement
126 typedef CachedQuery * (QCfunc)(Operation *op, struct query_manager_s*, Query*, QueryTemplate*);
127 typedef CachedQuery * (AddQueryfunc)(Operation *op, struct query_manager_s*, Query*, QueryTemplate*, int positive);
128 typedef void (CRfunc)(struct query_manager_s*, struct berval * );
130 /* LDAP query cache */
131 typedef struct query_manager_s {
132 struct attr_set* attr_sets; /* possible sets of projected attributes */
133 QueryTemplate* templates; /* cacheable templates */
135 CachedQuery* lru_top; /* top and bottom of LRU list */
136 CachedQuery* lru_bottom;
138 ldap_pvt_thread_mutex_t lru_mutex; /* mutex for accessing LRU list */
140 /* Query cache methods */
141 QCfunc *qcfunc; /* Query containment*/
142 CRfunc *crfunc; /* cache replacement */
143 AddQueryfunc *addfunc; /* add query */
146 /* LDAP query cache manager */
147 typedef struct cache_manager_s {
148 BackendDB db; /* underlying database */
149 unsigned long num_cached_queries; /* total number of cached queries */
150 unsigned long max_queries; /* upper bound on # of cached queries */
151 int save_queries; /* save cached queries across restarts */
152 int numattrsets; /* number of attribute sets */
153 int cur_entries; /* current number of entries cached */
154 int max_entries; /* max number of entries cached */
155 int num_entries_limit; /* max # of entries in a cacheable query */
157 char response_cb; /* install the response callback
158 * at the tail of the callback list */
159 #define PCACHE_RESPONSE_CB_HEAD 0
160 #define PCACHE_RESPONSE_CB_TAIL 1
162 time_t cc_period; /* interval between successive consistency checks (sec) */
166 ldap_pvt_thread_mutex_t cache_mutex;
168 query_manager* qm; /* query cache managed by the cache manager */
171 static int pcache_debug;
173 static AttributeDescription *ad_queryid, *ad_cachedQueryURL;
176 AttributeDescription **adp;
178 { "( 1.3.6.1.4.1.4203.666.1.12 NAME 'queryid' "
179 "DESC 'list of queries the entry belongs to' "
180 "EQUALITY octetStringMatch "
181 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.40{64} "
182 "NO-USER-MODIFICATION USAGE directoryOperation )",
184 { "(1.3.6.1.4.1.4203.666.1.999999 NAME 'cachedQueryURL' "
185 "DESC 'URI describing a cached query' "
186 "EQUALITY caseExactMatch "
187 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.15 "
188 "NO-USER-MODIFICATION USAGE directoryOperation )",
189 &ad_cachedQueryURL },
198 AttributeName** filter_attrs,
200 int* filter_got_oc );
207 QueryTemplate *templ,
211 * Turn a cached query into its URL representation
214 query2url( CachedQuery *q, struct berval *urlbv )
216 struct berval bv_scope,
218 char attrset_buf[ 32 ],
221 ber_len_t attrset_len,
224 ldap_pvt_scope2bv( q->scope, &bv_scope );
225 filter2bv( q->filter, &bv_filter );
226 attrset_len = snprintf( attrset_buf, sizeof( attrset_buf ),
227 "%lu", (unsigned long)q->qtemp->attr_set_index );
228 expiry_len = snprintf( expiry_buf, sizeof( expiry_buf ),
229 "%lu", (unsigned long)q->expiry_time );
231 urlbv->bv_len = STRLENOF( "ldap:///" )
232 + q->qbase->base.bv_len
237 + STRLENOF( "?x-uuid=" )
239 + STRLENOF( ",x-attrset=" )
241 + STRLENOF( ",x-expiry=" )
243 ptr = urlbv->bv_val = ch_malloc( urlbv->bv_len + 1 );
244 ptr = lutil_strcopy( ptr, "ldap:///" );
245 ptr = lutil_strcopy( ptr, q->qbase->base.bv_val );
246 ptr = lutil_strcopy( ptr, "??" );
247 ptr = lutil_strcopy( ptr, bv_scope.bv_val );
248 ptr = lutil_strcopy( ptr, "?" );
249 ptr = lutil_strcopy( ptr, bv_filter.bv_val );
250 ptr = lutil_strcopy( ptr, "?x-uuid=" );
251 ptr = lutil_strcopy( ptr, q->q_uuid.bv_val );
252 ptr = lutil_strcopy( ptr, ",x-attrset=" );
253 ptr = lutil_strcopy( ptr, attrset_buf );
254 ptr = lutil_strcopy( ptr, ",x-expiry=" );
255 ptr = lutil_strcopy( ptr, expiry_buf );
257 ber_memfree( bv_filter.bv_val );
263 * Turn an URL representing a formerly cached query into a cached query,
264 * and try to cache it
275 LDAPURLDesc *lud = NULL;
277 tempstr = BER_BVNULL,
287 rc = ldap_url_parse( url, &lud );
288 if ( rc != LDAP_URL_SUCCESS ) {
292 /* non-allowed fields */
293 if ( lud->lud_host != NULL ) {
298 if ( lud->lud_attrs != NULL ) {
304 if ( strcmp( lud->lud_scheme, "ldap" ) != 0 ) {
309 /* required fields */
310 if ( lud->lud_dn == NULL || lud->lud_dn[ 0 ] == '\0' ) {
315 switch ( lud->lud_scope ) {
316 case LDAP_SCOPE_BASE:
317 case LDAP_SCOPE_ONELEVEL:
318 case LDAP_SCOPE_SUBTREE:
319 case LDAP_SCOPE_SUBORDINATE:
327 if ( lud->lud_filter == NULL || lud->lud_filter[ 0 ] == '\0' ) {
332 if ( lud->lud_exts == NULL ) {
337 for ( i = 0; lud->lud_exts[ i ] != NULL; i++ ) {
338 if ( strncmp( lud->lud_exts[ i ], "x-uuid=", STRLENOF( "x-uuid=" ) ) == 0 ) {
339 ber_str2bv( &lud->lud_exts[ i ][ STRLENOF( "x-uuid=" ) ], 0, 0, &uuid );
345 } else if ( strncmp( lud->lud_exts[ i ], "x-attrset=", STRLENOF( "x-attrset=" ) ) == 0 ) {
346 rc = lutil_atoi( &attrset, &lud->lud_exts[ i ][ STRLENOF( "x-attrset=" ) ] );
352 } else if ( strncmp( lud->lud_exts[ i ], "x-expiry=", STRLENOF( "x-expiry=" ) ) == 0 ) {
355 rc = lutil_atoul( &l, &lud->lud_exts[ i ][ STRLENOF( "x-expiry=" ) ] );
359 expiry_time = (time_t)l;
362 /* ignore expired queries */
363 if ( expiry_time <= slap_get_time()) {
379 if ( !got_attrset ) {
389 ber_str2bv( lud->lud_dn, 0, 0, &base );
390 rc = dnNormalize( 0, NULL, NULL, &base, &query.base, NULL );
391 if ( rc != LDAP_SUCCESS ) {
394 query.scope = lud->lud_scope;
395 query.filter = str2filter( lud->lud_filter );
397 tempstr.bv_val = ch_malloc( strlen( lud->lud_filter ) + 1 );
399 if ( filter2template( op, query.filter, &tempstr, NULL, NULL, NULL ) ) {
400 ch_free( tempstr.bv_val );
405 /* check for query containment */
406 qt = qm->attr_sets[attrset].templates;
407 for ( ; qt; qt = qt->qtnext ) {
408 /* find if template i can potentially answer tempstr */
409 if ( bvmatch( &qt->querystr, &tempstr ) ) {
420 cq = add_query( op, qm, &query, qt, 1 );
422 cq->expiry_time = expiry_time;
423 ber_dupbv( &cq->q_uuid, &uuid );
424 /* it's now into cq->filter */
432 if ( query.filter != NULL ) filter_free( query.filter );
433 if ( !BER_BVISNULL( &tempstr ) ) ch_free( tempstr.bv_val );
434 if ( !BER_BVISNULL( &query.base ) ) ch_free( query.base.bv_val );
435 if ( lud != NULL ) ldap_free_urldesc( lud );
440 /* Return 1 for an added entry, else 0 */
445 struct berval* query_uuid )
448 Modifications* modlist = NULL;
449 const char* text = NULL;
451 char textbuf[SLAP_TEXT_BUFLEN];
452 size_t textlen = sizeof(textbuf);
454 SlapReply sreply = {REP_RESULT};
456 slap_callback cb = { NULL, slap_null_cb, NULL, NULL };
461 /* add queryid attribute */
462 attr_merge_one( e, ad_queryid, query_uuid, NULL );
464 /* append the attribute list from the fetched entry */
465 e->e_attrs->a_next = attr;
467 op->o_tag = LDAP_REQ_ADD;
468 op->o_protocol = LDAP_VERSION3;
469 op->o_callback = &cb;
470 op->o_time = slap_get_time();
471 op->o_do_not_cache = 1;
474 op->o_req_dn = e->e_name;
475 op->o_req_ndn = e->e_nname;
476 rc = op->o_bd->be_add( op, &sreply );
478 if ( rc != LDAP_SUCCESS ) {
479 if ( rc == LDAP_ALREADY_EXISTS ) {
480 slap_entry2mods( e, &modlist, &text, textbuf, textlen );
481 modlist->sml_op = LDAP_MOD_ADD;
482 op->o_tag = LDAP_REQ_MODIFY;
483 op->orm_modlist = modlist;
484 op->o_bd->be_modify( op, &sreply );
485 slap_mods_free( modlist, 1 );
486 } else if ( rc == LDAP_REFERRAL ||
487 rc == LDAP_NO_SUCH_OBJECT ) {
488 syncrepl_add_glue( op, e );
497 if ( op->ora_e == e )
498 be_entry_release_w( op, e );
505 /* Length-ordered sort on normalized DNs */
506 static int pcache_dn_cmp( const void *v1, const void *v2 )
508 const Qbase *q1 = v1, *q2 = v2;
510 int rc = q1->base.bv_len - q2->base.bv_len;
512 rc = strncmp( q1->base.bv_val, q2->base.bv_val, q1->base.bv_len );
516 static int lex_bvcmp( struct berval *bv1, struct berval *bv2 )
519 dif = bv1->bv_len - bv2->bv_len;
521 if ( dif > 0 ) len -= dif;
522 len = memcmp( bv1->bv_val, bv2->bv_val, len );
528 /* compare the first value in each filter */
529 static int pcache_filter_cmp( const void *v1, const void *v2 )
531 const CachedQuery *q1 = v1, *q2 =v2;
532 int rc, weight1, weight2;
534 switch( q1->first->f_choice ) {
535 case LDAP_FILTER_PRESENT:
538 case LDAP_FILTER_EQUALITY:
546 switch( q2->first->f_choice ) {
547 case LDAP_FILTER_PRESENT:
550 case LDAP_FILTER_EQUALITY:
558 rc = weight1 - weight2;
563 rc = lex_bvcmp( &q1->first->f_av_value, &q2->first->f_av_value );
566 if ( q1->first->f_choice == LDAP_FILTER_SUBSTRINGS ) {
568 if ( !BER_BVISNULL( &q1->first->f_sub_initial )) {
569 if ( !BER_BVISNULL( &q2->first->f_sub_initial )) {
570 rc = lex_bvcmp( &q1->first->f_sub_initial,
571 &q2->first->f_sub_initial );
575 } else if ( !BER_BVISNULL( &q2->first->f_sub_initial )) {
579 if ( q1->first->f_sub_any ) {
580 if ( q2->first->f_sub_any ) {
581 rc = lex_bvcmp( q1->first->f_sub_any,
582 q2->first->f_sub_any );
586 } else if ( q2->first->f_sub_any ) {
590 if ( !BER_BVISNULL( &q1->first->f_sub_final )) {
591 if ( !BER_BVISNULL( &q2->first->f_sub_final )) {
592 rc = lex_bvcmp( &q1->first->f_sub_final,
593 &q2->first->f_sub_final );
597 } else if ( !BER_BVISNULL( &q2->first->f_sub_final )) {
601 rc = lex_bvcmp( &q1->first->f_mr_value,
602 &q2->first->f_mr_value );
611 /* add query on top of LRU list */
613 add_query_on_top (query_manager* qm, CachedQuery* qc)
615 CachedQuery* top = qm->lru_top;
626 Debug( pcache_debug, "Base of added query = %s\n",
627 qc->qbase->base.bv_val, 0, 0 );
630 /* remove_query from LRU list */
633 remove_query (query_manager* qm, CachedQuery* qc)
656 qc->lru_up = qc->lru_down = NULL;
659 /* find and remove string2 from string1
660 * from start if position = 1,
661 * from end if position = 3,
662 * from anywhere if position = 2
663 * string1 is overwritten if position = 2.
667 find_and_remove(struct berval* ber1, struct berval* ber2, int position)
678 if ( ber1->bv_len >= ber2->bv_len && !memcmp( ber1->bv_val,
679 ber2->bv_val, ber2->bv_len )) {
681 ber1->bv_val += ber2->bv_len;
682 ber1->bv_len -= ber2->bv_len;
687 ber1->bv_val[ber1->bv_len] = '\0';
688 temp = strstr( ber1->bv_val, ber2->bv_val );
690 strcpy( temp, temp+ber2->bv_len );
691 ber1->bv_len -= ber2->bv_len;
697 if ( ber1->bv_len >= ber2->bv_len &&
698 !memcmp( ber1->bv_val+ber1->bv_len-ber2->bv_len, ber2->bv_val,
701 ber1->bv_len -= ber2->bv_len;
709 static struct berval*
710 merge_init_final(Operation *op, struct berval* init, struct berval* any,
711 struct berval* final)
713 struct berval* merged, *temp;
714 int i, any_count, count;
716 for (any_count=0; any && any[any_count].bv_val; any_count++)
726 merged = (struct berval*)op->o_tmpalloc( (count+1)*sizeof(struct berval),
731 ber_dupbv_x( temp, init, op->o_tmpmemctx );
735 for (i=0; i<any_count; i++) {
736 ber_dupbv_x( temp, any, op->o_tmpmemctx );
741 ber_dupbv_x( temp, final, op->o_tmpmemctx );
748 /* Each element in stored must be found in incoming. Incoming is overwritten.
751 strings_containment(struct berval* stored, struct berval* incoming)
753 struct berval* element;
757 for ( element=stored; element->bv_val != NULL; element++ ) {
758 for (j = k; incoming[j].bv_val != NULL; j++) {
759 if (find_and_remove(&(incoming[j]), element, 2)) {
776 substr_containment_substr(Operation *op, Filter* stored, Filter* incoming)
780 struct berval init_incoming;
781 struct berval final_incoming;
782 struct berval *remaining_incoming = NULL;
784 if ((!(incoming->f_sub_initial.bv_val) && (stored->f_sub_initial.bv_val))
785 || (!(incoming->f_sub_final.bv_val) && (stored->f_sub_final.bv_val)))
788 init_incoming = incoming->f_sub_initial;
789 final_incoming = incoming->f_sub_final;
791 if (find_and_remove(&init_incoming,
792 &(stored->f_sub_initial), 1) && find_and_remove(&final_incoming,
793 &(stored->f_sub_final), 3))
795 if (stored->f_sub_any == NULL) {
799 remaining_incoming = merge_init_final(op, &init_incoming,
800 incoming->f_sub_any, &final_incoming);
801 rc = strings_containment(stored->f_sub_any, remaining_incoming);
802 ber_bvarray_free_x( remaining_incoming, op->o_tmpmemctx );
809 substr_containment_equality(Operation *op, Filter* stored, Filter* incoming)
811 struct berval incoming_val[2];
814 incoming_val[1] = incoming->f_av_value;
816 if (find_and_remove(incoming_val+1,
817 &(stored->f_sub_initial), 1) && find_and_remove(incoming_val+1,
818 &(stored->f_sub_final), 3)) {
819 if (stored->f_sub_any == NULL){
823 ber_dupbv_x( incoming_val, incoming_val+1, op->o_tmpmemctx );
824 BER_BVZERO( incoming_val+1 );
825 rc = strings_containment(stored->f_sub_any, incoming_val);
826 op->o_tmpfree( incoming_val[0].bv_val, op->o_tmpmemctx );
833 filter_first( Filter *f )
835 while ( f->f_choice == LDAP_FILTER_OR || f->f_choice == LDAP_FILTER_AND )
842 find_filter( Operation *op, Avlnode *root, Filter *inputf, Filter *first )
846 MatchingRule* mrule = NULL;
847 int res=0, eqpass= 0;
855 /* substring matches sort to the end, and we just have to
856 * walk the entire list.
858 if ( first->f_choice == LDAP_FILTER_SUBSTRINGS ) {
859 ptr = tavl_end( root, 1 );
862 ptr = tavl_find3( root, &cq, pcache_filter_cmp, &ret );
863 dir = (first->f_choice == LDAP_FILTER_GE) ? TAVL_DIR_LEFT :
872 /* an incoming substr query can only be satisfied by a cached
875 if ( first->f_choice == LDAP_FILTER_SUBSTRINGS &&
876 qc->first->f_choice != LDAP_FILTER_SUBSTRINGS )
879 /* an incoming eq query can be satisfied by a cached eq or substr
882 if ( first->f_choice == LDAP_FILTER_EQUALITY ) {
884 if ( qc->first->f_choice != LDAP_FILTER_EQUALITY ) {
885 nextpass: eqpass = 1;
886 ptr = tavl_end( root, 1 );
891 if ( qc->first->f_choice != LDAP_FILTER_SUBSTRINGS )
897 switch (fs->f_choice) {
898 case LDAP_FILTER_EQUALITY:
899 if (fi->f_choice == LDAP_FILTER_EQUALITY)
900 mrule = fs->f_ava->aa_desc->ad_type->sat_equality;
906 mrule = fs->f_ava->aa_desc->ad_type->sat_ordering;
913 rc = value_match(&ret, fs->f_ava->aa_desc, mrule,
914 SLAP_MR_VALUE_OF_ASSERTION_SYNTAX,
915 &(fi->f_ava->aa_value),
916 &(fs->f_ava->aa_value), &text);
917 if (rc != LDAP_SUCCESS) {
920 if ( fi==first && fi->f_choice==LDAP_FILTER_EQUALITY && ret )
923 switch (fs->f_choice) {
925 case LDAP_FILTER_AND:
930 case LDAP_FILTER_SUBSTRINGS:
931 /* check if the equality query can be
932 * answered with cached substring query */
933 if ((fi->f_choice == LDAP_FILTER_EQUALITY)
934 && substr_containment_equality( op,
937 /* check if the substring query can be
938 * answered with cached substring query */
939 if ((fi->f_choice ==LDAP_FILTER_SUBSTRINGS
940 ) && substr_containment_substr( op,
946 case LDAP_FILTER_PRESENT:
951 case LDAP_FILTER_EQUALITY:
958 if (mrule && ret >= 0)
964 if (mrule && ret <= 0)
969 case LDAP_FILTER_NOT:
975 } while((res) && (fi != NULL) && (fs != NULL));
979 ptr = tavl_next( ptr, dir );
984 /* check whether query is contained in any of
985 * the cached queries in template
988 query_containment(Operation *op, query_manager *qm,
990 QueryTemplate *templa)
993 int depth = 0, tscope;
994 Qbase qbase, *qbptr = NULL;
997 if (query->filter != NULL) {
1000 Debug( pcache_debug, "Lock QC index = %p\n",
1001 (void *) templa, 0, 0 );
1002 qbase.base = query->base;
1004 first = filter_first( query->filter );
1006 ldap_pvt_thread_rdwr_rlock(&templa->t_rwlock);
1009 qbptr = avl_find( templa->qbase, &qbase, pcache_dn_cmp );
1011 tscope = query->scope;
1012 /* Find a matching scope:
1013 * match at depth 0 OK
1016 * subord at depth > 0 OK
1017 * subtree at any depth OK
1019 * subtree or subord at any depth OK
1021 * subtree or subord at any depth OK
1023 * subord at depth > 0 OK
1024 * subtree at any depth OK
1026 for ( tscope = 0 ; tscope <= LDAP_SCOPE_CHILDREN; tscope++ ) {
1027 switch ( query->scope ) {
1028 case LDAP_SCOPE_BASE:
1029 if ( tscope == LDAP_SCOPE_BASE && depth ) continue;
1030 if ( tscope == LDAP_SCOPE_ONE && depth != 1) continue;
1031 if ( tscope == LDAP_SCOPE_CHILDREN && !depth ) continue;
1033 case LDAP_SCOPE_ONE:
1034 if ( tscope == LDAP_SCOPE_BASE )
1035 tscope = LDAP_SCOPE_ONE;
1036 if ( tscope == LDAP_SCOPE_ONE && depth ) continue;
1037 if ( !depth ) break;
1038 if ( tscope < LDAP_SCOPE_SUBTREE )
1039 tscope = LDAP_SCOPE_SUBTREE;
1041 case LDAP_SCOPE_SUBTREE:
1042 if ( tscope < LDAP_SCOPE_SUBTREE )
1043 tscope = LDAP_SCOPE_SUBTREE;
1044 if ( tscope == LDAP_SCOPE_CHILDREN && !depth ) continue;
1046 case LDAP_SCOPE_CHILDREN:
1047 if ( tscope < LDAP_SCOPE_SUBTREE )
1048 tscope = LDAP_SCOPE_SUBTREE;
1051 if ( !qbptr->scopes[tscope] ) continue;
1054 qc = find_filter( op, qbptr->scopes[tscope],
1055 query->filter, first );
1057 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
1058 if (qm->lru_top != qc) {
1059 remove_query(qm, qc);
1060 add_query_on_top(qm, qc);
1062 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1067 if ( be_issuffix( op->o_bd, &qbase.base ))
1070 dnParent( &qbase.base, &pdn );
1075 Debug( pcache_debug,
1076 "Not answerable: Unlock QC index=%p\n",
1077 (void *) templa, 0, 0 );
1078 ldap_pvt_thread_rdwr_runlock(&templa->t_rwlock);
1084 free_query (CachedQuery* qc)
1086 free(qc->q_uuid.bv_val);
1087 filter_free(qc->filter);
1092 /* Add query to query cache */
1093 static CachedQuery *
1098 QueryTemplate *templ,
1101 CachedQuery* new_cached_query = (CachedQuery*) ch_malloc(sizeof(CachedQuery));
1106 new_cached_query->qtemp = templ;
1107 BER_BVZERO( &new_cached_query->q_uuid );
1109 new_cached_query->expiry_time = slap_get_time() + templ->ttl;
1111 new_cached_query->expiry_time = slap_get_time() + templ->negttl;
1113 new_cached_query->lru_up = NULL;
1114 new_cached_query->lru_down = NULL;
1115 Debug( pcache_debug, "Added query expires at %ld\n",
1116 (long) new_cached_query->expiry_time, 0, 0 );
1118 new_cached_query->scope = query->scope;
1119 new_cached_query->filter = query->filter;
1120 new_cached_query->first = first = filter_first( query->filter );
1122 qb.base = query->base;
1124 /* Adding a query */
1125 Debug( pcache_debug, "Lock AQ index = %p\n",
1126 (void *) templ, 0, 0 );
1127 ldap_pvt_thread_rdwr_wlock(&templ->t_rwlock);
1128 qbase = avl_find( templ->qbase, &qb, pcache_dn_cmp );
1130 qbase = ch_calloc( 1, sizeof(Qbase) + qb.base.bv_len + 1 );
1131 qbase->base.bv_len = qb.base.bv_len;
1132 qbase->base.bv_val = (char *)(qbase+1);
1133 memcpy( qbase->base.bv_val, qb.base.bv_val, qb.base.bv_len );
1134 qbase->base.bv_val[qbase->base.bv_len] = '\0';
1135 avl_insert( &templ->qbase, qbase, pcache_dn_cmp, avl_dup_error );
1137 new_cached_query->next = templ->query;
1138 new_cached_query->prev = NULL;
1139 new_cached_query->qbase = qbase;
1140 rc = tavl_insert( &qbase->scopes[query->scope], new_cached_query,
1141 pcache_filter_cmp, avl_dup_error );
1144 if (templ->query == NULL)
1145 templ->query_last = new_cached_query;
1147 templ->query->prev = new_cached_query;
1148 templ->query = new_cached_query;
1149 templ->no_of_queries++;
1151 ch_free( new_cached_query );
1152 new_cached_query = find_filter( op, qbase->scopes[query->scope],
1153 query->filter, first );
1154 filter_free( query->filter );
1156 Debug( pcache_debug, "TEMPLATE %p QUERIES++ %d\n",
1157 (void *) templ, templ->no_of_queries, 0 );
1159 Debug( pcache_debug, "Unlock AQ index = %p \n",
1160 (void *) templ, 0, 0 );
1161 ldap_pvt_thread_rdwr_wunlock(&templ->t_rwlock);
1163 /* Adding on top of LRU list */
1165 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
1166 add_query_on_top(qm, new_cached_query);
1167 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1169 return rc == 0 ? new_cached_query : NULL;
1173 remove_from_template (CachedQuery* qc, QueryTemplate* template)
1175 if (!qc->prev && !qc->next) {
1176 template->query_last = template->query = NULL;
1177 } else if (qc->prev == NULL) {
1178 qc->next->prev = NULL;
1179 template->query = qc->next;
1180 } else if (qc->next == NULL) {
1181 qc->prev->next = NULL;
1182 template->query_last = qc->prev;
1184 qc->next->prev = qc->prev;
1185 qc->prev->next = qc->next;
1187 tavl_delete( &qc->qbase->scopes[qc->scope], qc, pcache_filter_cmp );
1188 qc->qbase->queries--;
1189 if ( qc->qbase->queries == 0 ) {
1190 avl_delete( &template->qbase, qc->qbase, pcache_dn_cmp );
1191 ch_free( qc->qbase );
1195 template->no_of_queries--;
1198 /* remove bottom query of LRU list from the query cache */
1200 * NOTE: slight change in functionality.
1202 * - if result->bv_val is NULL, the query at the bottom of the LRU
1204 * - otherwise, the query whose UUID is *result is removed
1205 * - if not found, result->bv_val is zeroed
1208 cache_replacement(query_manager* qm, struct berval *result)
1210 CachedQuery* bottom;
1211 QueryTemplate *temp;
1213 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
1214 if ( BER_BVISNULL( result ) ) {
1215 bottom = qm->lru_bottom;
1218 Debug ( pcache_debug,
1219 "Cache replacement invoked without "
1220 "any query in LRU list\n", 0, 0, 0 );
1221 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1226 for ( bottom = qm->lru_bottom;
1228 bottom = bottom->lru_up )
1230 if ( bvmatch( result, &bottom->q_uuid ) ) {
1236 Debug ( pcache_debug,
1237 "Could not find query with uuid=\"%s\""
1238 "in LRU list\n", result->bv_val, 0, 0 );
1239 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1240 BER_BVZERO( result );
1245 temp = bottom->qtemp;
1246 remove_query(qm, bottom);
1247 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1249 *result = bottom->q_uuid;
1250 bottom->q_uuid.bv_val = NULL;
1252 Debug( pcache_debug, "Lock CR index = %p\n", (void *) temp, 0, 0 );
1253 ldap_pvt_thread_rdwr_wlock(&temp->t_rwlock);
1254 remove_from_template(bottom, temp);
1255 Debug( pcache_debug, "TEMPLATE %p QUERIES-- %d\n",
1256 (void *) temp, temp->no_of_queries, 0 );
1257 Debug( pcache_debug, "Unlock CR index = %p\n", (void *) temp, 0, 0 );
1258 ldap_pvt_thread_rdwr_wunlock(&temp->t_rwlock);
1263 struct query_info *next;
1275 struct query_info *qi;
1278 if ( rs->sr_type != REP_SEARCH ) return 0;
1280 attr = attr_find( rs->sr_entry->e_attrs, ad_queryid );
1281 if ( attr == NULL ) return 0;
1283 for ( count = 0; !BER_BVISNULL( &attr->a_vals[count] ); count++ )
1285 assert( count > 0 );
1286 qi = op->o_tmpalloc( sizeof( struct query_info ), op->o_tmpmemctx );
1287 qi->next = op->o_callback->sc_private;
1288 op->o_callback->sc_private = qi;
1289 ber_dupbv_x( &qi->xdn, &rs->sr_entry->e_nname, op->o_tmpmemctx );
1290 qi->del = ( count == 1 );
1299 struct berval* query_uuid)
1301 struct query_info *qi, *qnext;
1302 char filter_str[64];
1303 #ifdef LDAP_COMP_MATCH
1304 AttributeAssertion ava = { NULL, BER_BVNULL, NULL };
1306 AttributeAssertion ava = { NULL, BER_BVNULL };
1308 Filter filter = {LDAP_FILTER_EQUALITY};
1309 SlapReply sreply = {REP_RESULT};
1310 slap_callback cb = { NULL, remove_func, NULL, NULL };
1313 sreply.sr_entry = NULL;
1314 sreply.sr_nentries = 0;
1315 op->ors_filterstr.bv_len = snprintf(filter_str, sizeof(filter_str),
1316 "(%s=%s)", ad_queryid->ad_cname.bv_val, query_uuid->bv_val);
1317 filter.f_ava = &ava;
1318 filter.f_av_desc = ad_queryid;
1319 filter.f_av_value = *query_uuid;
1321 op->o_tag = LDAP_REQ_SEARCH;
1322 op->o_protocol = LDAP_VERSION3;
1323 op->o_callback = &cb;
1324 op->o_time = slap_get_time();
1325 op->o_do_not_cache = 1;
1327 op->o_req_dn = op->o_bd->be_suffix[0];
1328 op->o_req_ndn = op->o_bd->be_nsuffix[0];
1329 op->ors_scope = LDAP_SCOPE_SUBTREE;
1330 op->ors_deref = LDAP_DEREF_NEVER;
1331 op->ors_slimit = SLAP_NO_LIMIT;
1332 op->ors_tlimit = SLAP_NO_LIMIT;
1333 op->ors_filter = &filter;
1334 op->ors_filterstr.bv_val = filter_str;
1335 op->ors_filterstr.bv_len = strlen(filter_str);
1336 op->ors_attrs = NULL;
1337 op->ors_attrsonly = 0;
1339 op->o_bd->be_search( op, &sreply );
1341 for ( qi=cb.sc_private; qi; qi=qnext ) {
1344 op->o_req_dn = qi->xdn;
1345 op->o_req_ndn = qi->xdn;
1348 Debug( pcache_debug, "DELETING ENTRY TEMPLATE=%s\n",
1349 query_uuid->bv_val, 0, 0 );
1351 op->o_tag = LDAP_REQ_DELETE;
1353 if (op->o_bd->be_delete(op, &sreply) == LDAP_SUCCESS) {
1358 struct berval vals[2];
1360 vals[0] = *query_uuid;
1361 vals[1].bv_val = NULL;
1363 mod.sml_op = LDAP_MOD_DELETE;
1365 mod.sml_desc = ad_queryid;
1366 mod.sml_type = ad_queryid->ad_cname;
1367 mod.sml_values = vals;
1368 mod.sml_nvalues = NULL;
1369 mod.sml_next = NULL;
1370 Debug( pcache_debug,
1371 "REMOVING TEMP ATTR : TEMPLATE=%s\n",
1372 query_uuid->bv_val, 0, 0 );
1374 op->orm_modlist = &mod;
1376 op->o_bd->be_modify( op, &sreply );
1378 op->o_tmpfree( qi->xdn.bv_val, op->o_tmpmemctx );
1379 op->o_tmpfree( qi, op->o_tmpmemctx );
1386 AttributeName* attrs,
1395 struct berval *fstr,
1396 AttributeName** filter_attrs,
1398 int* filter_got_oc )
1400 AttributeDescription *ad;
1402 switch ( f->f_choice ) {
1403 case LDAP_FILTER_EQUALITY:
1405 sprintf( fstr->bv_val+fstr->bv_len, "(%s=)", ad->ad_cname.bv_val );
1406 fstr->bv_len += ad->ad_cname.bv_len + ( sizeof("(=)") - 1 );
1409 case LDAP_FILTER_GE:
1411 sprintf( fstr->bv_val+fstr->bv_len, "(%s>=)", ad->ad_cname.bv_val);
1412 fstr->bv_len += ad->ad_cname.bv_len + ( sizeof("(>=)") - 1 );
1415 case LDAP_FILTER_LE:
1417 sprintf( fstr->bv_val+fstr->bv_len, "(%s<=)", ad->ad_cname.bv_val);
1418 fstr->bv_len += ad->ad_cname.bv_len + ( sizeof("(<=)") - 1 );
1421 case LDAP_FILTER_APPROX:
1423 sprintf( fstr->bv_val+fstr->bv_len, "(%s~=)", ad->ad_cname.bv_val);
1424 fstr->bv_len += ad->ad_cname.bv_len + ( sizeof("(~=)") - 1 );
1427 case LDAP_FILTER_SUBSTRINGS:
1429 sprintf( fstr->bv_val+fstr->bv_len, "(%s=)", ad->ad_cname.bv_val );
1430 fstr->bv_len += ad->ad_cname.bv_len + ( sizeof("(=)") - 1 );
1433 case LDAP_FILTER_PRESENT:
1435 sprintf( fstr->bv_val+fstr->bv_len, "(%s=*)", ad->ad_cname.bv_val );
1436 fstr->bv_len += ad->ad_cname.bv_len + ( sizeof("(=*)") - 1 );
1439 case LDAP_FILTER_AND:
1440 case LDAP_FILTER_OR:
1441 case LDAP_FILTER_NOT: {
1443 sprintf( fstr->bv_val+fstr->bv_len, "(%c",
1444 f->f_choice == LDAP_FILTER_AND ? '&' :
1445 f->f_choice == LDAP_FILTER_OR ? '|' : '!' );
1446 fstr->bv_len += sizeof("(%") - 1;
1448 for ( f = f->f_list; f != NULL; f = f->f_next ) {
1449 rc = filter2template( op, f, fstr, filter_attrs, filter_cnt,
1453 sprintf( fstr->bv_val+fstr->bv_len, ")" );
1454 fstr->bv_len += sizeof(")") - 1;
1460 strcpy( fstr->bv_val, "(?=?)" );
1461 fstr->bv_len += sizeof("(?=?)")-1;
1465 if ( filter_attrs != NULL ) {
1466 *filter_attrs = (AttributeName *)op->o_tmprealloc(*filter_attrs,
1467 (*filter_cnt + 2)*sizeof(AttributeName), op->o_tmpmemctx);
1469 (*filter_attrs)[*filter_cnt].an_desc = ad;
1470 (*filter_attrs)[*filter_cnt].an_name = ad->ad_cname;
1471 (*filter_attrs)[*filter_cnt].an_oc = NULL;
1472 (*filter_attrs)[*filter_cnt].an_oc_exclude = 0;
1473 BER_BVZERO( &(*filter_attrs)[*filter_cnt+1].an_name );
1475 if ( ad == slap_schema.si_ad_objectClass )
1482 struct search_info {
1485 QueryTemplate *qtemp;
1486 AttributeName* save_attrs; /* original attributes, saved for response */
1494 remove_query_and_data(
1498 struct berval *uuid )
1500 query_manager* qm = cm->qm;
1502 qm->crfunc( qm, uuid );
1503 if ( !BER_BVISNULL( uuid ) ) {
1506 Debug( pcache_debug,
1507 "Removing query UUID %s\n",
1508 uuid->bv_val, 0, 0 );
1509 return_val = remove_query_data( op, rs, uuid );
1510 Debug( pcache_debug,
1511 "QUERY REMOVED, SIZE=%d\n",
1513 ldap_pvt_thread_mutex_lock( &cm->cache_mutex );
1514 cm->cur_entries -= return_val;
1515 cm->num_cached_queries--;
1516 Debug( pcache_debug,
1517 "STORED QUERIES = %lu\n",
1518 cm->num_cached_queries, 0, 0 );
1519 ldap_pvt_thread_mutex_unlock( &cm->cache_mutex );
1520 Debug( pcache_debug,
1521 "QUERY REMOVED, CACHE ="
1523 cm->cur_entries, 0, 0 );
1528 * Callback used to fetch queryid values based on entryUUID;
1529 * used by pcache_remove_entries_from_cache()
1532 fetch_queryid_cb( Operation *op, SlapReply *rs )
1536 /* only care about searchEntry responses */
1537 if ( rs->sr_type != REP_SEARCH ) {
1541 /* allow only one response per entryUUID */
1542 if ( op->o_callback->sc_private != NULL ) {
1548 /* copy all queryid values into callback's private data */
1549 a = attr_find( rs->sr_entry->e_attrs, ad_queryid );
1551 BerVarray vals = NULL;
1553 ber_bvarray_dup_x( &vals, a->a_nvals, op->o_tmpmemctx );
1554 op->o_callback->sc_private = (void *)vals;
1558 /* clear entry if required */
1559 if ( rs->sr_flags & REP_ENTRY_MUSTBEFREED ) {
1560 entry_free( rs->sr_entry );
1561 rs->sr_entry = NULL;
1562 rs->sr_flags ^= REP_ENTRY_MUSTBEFREED;
1569 * Call that allows to remove an entry from the cache, by forcing
1570 * the removal of all the related queries.
1573 pcache_remove_entries_from_cache(
1577 void *thrctx = ldap_pvt_thread_pool_context();
1579 Connection conn = { 0 };
1580 OperationBuffer opbuf;
1582 slap_callback sc = { 0 };
1583 SlapReply rs = { REP_RESULT };
1585 char filtbuf[ LDAP_LUTIL_UUIDSTR_BUFSIZE + STRLENOF( "(entryUUID=)" ) ];
1586 #ifdef LDAP_COMP_MATCH
1587 AttributeAssertion ava = { NULL, BER_BVNULL, NULL };
1589 AttributeAssertion ava = { NULL, BER_BVNULL };
1591 AttributeName attrs[ 2 ] = { 0 };
1594 connection_fake_init( &conn, &opbuf, thrctx );
1597 memset( &op->oq_search, 0, sizeof( op->oq_search ) );
1598 op->ors_scope = LDAP_SCOPE_SUBTREE;
1599 op->ors_deref = LDAP_DEREF_NEVER;
1600 f.f_choice = LDAP_FILTER_EQUALITY;
1602 ava.aa_desc = slap_schema.si_ad_entryUUID;
1603 op->ors_filter = &f;
1605 op->ors_tlimit = SLAP_NO_LIMIT;
1606 attrs[ 0 ].an_desc = ad_queryid;
1607 attrs[ 0 ].an_name = ad_queryid->ad_cname;
1608 op->ors_attrs = attrs;
1609 op->ors_attrsonly = 0;
1611 op->o_req_dn = cm->db.be_suffix[ 0 ];
1612 op->o_req_ndn = cm->db.be_nsuffix[ 0 ];
1614 op->o_tag = LDAP_REQ_SEARCH;
1615 op->o_protocol = LDAP_VERSION3;
1616 op->o_managedsait = SLAP_CONTROL_CRITICAL;
1618 op->o_dn = op->o_bd->be_rootdn;
1619 op->o_ndn = op->o_bd->be_rootndn;
1620 sc.sc_response = fetch_queryid_cb;
1621 op->o_callback = ≻
1623 for ( s = 0; !BER_BVISNULL( &UUIDs[ s ] ); s++ ) {
1624 BerVarray vals = NULL;
1627 op->ors_filterstr.bv_len = snprintf( filtbuf, sizeof( filtbuf ),
1628 "(entryUUID=%s)", UUIDs[ s ].bv_val );
1629 op->ors_filterstr.bv_val = filtbuf;
1630 ava.aa_value = UUIDs[ s ];
1632 rc = op->o_bd->be_search( op, &rs );
1633 if ( rc != LDAP_SUCCESS ) {
1637 vals = (BerVarray)op->o_callback->sc_private;
1638 if ( vals != NULL ) {
1639 for ( i = 0; !BER_BVISNULL( &vals[ i ] ); i++ ) {
1640 struct berval val = vals[ i ];
1642 remove_query_and_data( op, &rs, cm, &val );
1644 if ( !BER_BVISNULL( &val ) && val.bv_val != vals[ i ].bv_val ) {
1645 ch_free( val.bv_val );
1649 ber_bvarray_free_x( vals, op->o_tmpmemctx );
1650 op->o_callback->sc_private = NULL;
1661 struct berval *query_uuid)
1663 struct search_info *si = op->o_callback->sc_private;
1664 slap_overinst *on = si->on;
1665 cache_manager *cm = on->on_bi.bi_private;
1666 query_manager* qm = cm->qm;
1669 struct berval crp_uuid;
1670 char uuidbuf[ LDAP_LUTIL_UUIDSTR_BUFSIZE ];
1671 Operation op_tmp = *op;
1673 query_uuid->bv_len = lutil_uuidstr(uuidbuf, sizeof(uuidbuf));
1674 ber_str2bv(uuidbuf, query_uuid->bv_len, 1, query_uuid);
1676 op_tmp.o_bd = &cm->db;
1677 op_tmp.o_dn = cm->db.be_rootdn;
1678 op_tmp.o_ndn = cm->db.be_rootndn;
1680 Debug( pcache_debug, "UUID for query being added = %s\n",
1683 for ( e=si->head; e; e=si->head ) {
1684 si->head = e->e_private;
1685 e->e_private = NULL;
1686 while ( cm->cur_entries > (cm->max_entries) ) {
1687 BER_BVZERO( &crp_uuid );
1688 remove_query_and_data( &op_tmp, rs, cm, &crp_uuid );
1691 return_val = merge_entry(&op_tmp, e, query_uuid);
1692 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
1693 cm->cur_entries += return_val;
1694 Debug( pcache_debug,
1695 "ENTRY ADDED/MERGED, CACHED ENTRIES=%d\n",
1696 cm->cur_entries, 0, 0 );
1698 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
1705 pcache_op_cleanup( Operation *op, SlapReply *rs ) {
1706 slap_callback *cb = op->o_callback;
1707 struct search_info *si = cb->sc_private;
1708 if ( si->save_attrs != NULL ) {
1709 rs->sr_attrs = si->save_attrs;
1710 op->ors_attrs = si->save_attrs;
1712 op->o_callback = op->o_callback->sc_next;
1713 op->o_tmpfree( cb, op->o_tmpmemctx );
1714 return SLAP_CB_CONTINUE;
1722 struct search_info *si = op->o_callback->sc_private;
1723 slap_overinst *on = si->on;
1724 cache_manager *cm = on->on_bi.bi_private;
1725 query_manager* qm = cm->qm;
1727 if ( si->save_attrs != NULL ) {
1728 rs->sr_attrs = si->save_attrs;
1729 op->ors_attrs = si->save_attrs;
1732 if ( rs->sr_type == REP_SEARCH ) {
1734 /* If we haven't exceeded the limit for this query,
1735 * build a chain of answers to store. If we hit the
1736 * limit, empty the chain and ignore the rest.
1739 if ( si->count < si->max ) {
1741 e = entry_dup( rs->sr_entry );
1742 if ( !si->head ) si->head = e;
1743 if ( si->tail ) si->tail->e_private = e;
1748 for (;si->head; si->head=e) {
1749 e = si->head->e_private;
1750 si->head->e_private = NULL;
1751 entry_free(si->head);
1757 } else if ( rs->sr_type == REP_RESULT ) {
1759 ( si->qtemp->negttl && !si->count && !si->over &&
1760 rs->sr_err == LDAP_SUCCESS )) {
1761 CachedQuery *qc = qm->addfunc(op, qm, &si->query, si->qtemp,
1766 cache_entries( op, rs, &qc->q_uuid );
1767 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
1768 cm->num_cached_queries++;
1769 Debug( pcache_debug, "STORED QUERIES = %lu\n",
1770 cm->num_cached_queries, 0, 0 );
1771 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
1773 /* If the consistency checker suspended itself,
1776 if ( cm->cc_paused ) {
1777 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
1778 if ( cm->cc_paused ) {
1780 ldap_pvt_runqueue_resched( &slapd_rq, cm->cc_arg, 0 );
1782 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
1784 } else if ( si->count ) {
1785 /* duplicate query, free it */
1787 for (;si->head; si->head=e) {
1788 e = si->head->e_private;
1789 si->head->e_private = NULL;
1790 entry_free(si->head);
1794 filter_free( si->query.filter );
1797 op->o_callback->sc_cleanup = pcache_op_cleanup;
1799 return SLAP_CB_CONTINUE;
1805 AttributeName** new_attrs,
1806 struct attr_set *attrs,
1807 AttributeName* filter_attrs,
1817 /* duplicate attrs */
1818 count = attrs->count + fattr_cnt;
1819 if ( !fattr_got_oc && !(attrs->flags & PC_GOT_OC)) {
1824 *new_attrs = (AttributeName*)ch_calloc( count + 1,
1825 sizeof(AttributeName) );
1826 for (i=0; i<attrs->count; i++) {
1827 (*new_attrs)[i].an_name = attrs->attrs[i].an_name;
1828 (*new_attrs)[i].an_desc = attrs->attrs[i].an_desc;
1830 BER_BVZERO( &(*new_attrs)[i].an_name );
1831 alluser = an_find(*new_attrs, &AllUser);
1832 allop = an_find(*new_attrs, &AllOper);
1835 for ( i=0; i<fattr_cnt; i++ ) {
1836 if ( an_find(*new_attrs, &filter_attrs[i].an_name ) ) {
1839 if ( is_at_operational(filter_attrs[i].an_desc->ad_type) ) {
1843 } else if ( alluser ) {
1846 (*new_attrs)[j].an_name = filter_attrs[i].an_name;
1847 (*new_attrs)[j].an_desc = filter_attrs[i].an_desc;
1848 (*new_attrs)[j].an_oc = NULL;
1849 (*new_attrs)[j].an_oc_exclude = 0;
1853 (*new_attrs)[j].an_name = slap_schema.si_ad_objectClass->ad_cname;
1854 (*new_attrs)[j].an_desc = slap_schema.si_ad_objectClass;
1855 (*new_attrs)[j].an_oc = NULL;
1856 (*new_attrs)[j].an_oc_exclude = 0;
1859 BER_BVZERO( &(*new_attrs)[j].an_name );
1864 /* NOTE: this is a quick workaround to let pcache minimally interact
1865 * with pagedResults. A more articulated solutions would be to
1866 * perform the remote query without control and cache all results,
1867 * performing the pagedResults search only within the client
1868 * and the proxy. This requires pcache to understand pagedResults. */
1870 pcache_chk_controls(
1874 const char *non = "";
1875 const char *stripped = "";
1877 switch( op->o_pagedresults ) {
1878 case SLAP_CONTROL_NONCRITICAL:
1880 stripped = "; stripped";
1883 case SLAP_CONTROL_CRITICAL:
1884 Debug( pcache_debug, "%s: "
1885 "%scritical pagedResults control "
1886 "disabled with proxy cache%s.\n",
1887 op->o_log_prefix, non, stripped );
1889 slap_remove_control( op, rs, slap_cids.sc_pagedResults, NULL );
1893 rs->sr_err = SLAP_CB_CONTINUE;
1905 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
1906 cache_manager *cm = on->on_bi.bi_private;
1907 query_manager* qm = cm->qm;
1911 AttributeName *filter_attrs = NULL;
1914 QueryTemplate *qtemp = NULL;
1917 CachedQuery *answerable = NULL;
1920 int fattr_got_oc = 0;
1922 struct berval tempstr;
1924 tempstr.bv_val = op->o_tmpalloc( op->ors_filterstr.bv_len+1, op->o_tmpmemctx );
1926 if ( filter2template( op, op->ors_filter, &tempstr, &filter_attrs,
1927 &fattr_cnt, &fattr_got_oc )) {
1928 op->o_tmpfree( tempstr.bv_val, op->o_tmpmemctx );
1929 return SLAP_CB_CONTINUE;
1932 Debug( pcache_debug, "query template of incoming query = %s\n",
1933 tempstr.bv_val, 0, 0 );
1935 /* FIXME: cannot cache/answer requests with pagedResults control */
1938 attr_set = get_attr_set(op->ors_attrs, qm, cm->numattrsets);
1940 query.filter = op->ors_filter;
1941 query.base = op->o_req_ndn;
1942 query.scope = op->ors_scope;
1944 /* check for query containment */
1945 if (attr_set > -1) {
1946 QueryTemplate *qt = qm->attr_sets[attr_set].templates;
1947 for (; qt; qt = qt->qtnext ) {
1948 /* find if template i can potentially answer tempstr */
1949 if (qt->querystr.bv_len != tempstr.bv_len ||
1950 strcasecmp( qt->querystr.bv_val, tempstr.bv_val ))
1954 Debug( pcache_debug, "Entering QC, querystr = %s\n",
1955 op->ors_filterstr.bv_val, 0, 0 );
1956 answerable = (*(qm->qcfunc))(op, qm, &query, qt);
1962 op->o_tmpfree( tempstr.bv_val, op->o_tmpmemctx );
1965 /* Need to clear the callbacks of the original operation,
1966 * in case there are other overlays */
1967 BackendDB *save_bd = op->o_bd;
1968 slap_callback *save_cb = op->o_callback;
1970 Debug( pcache_debug, "QUERY ANSWERABLE\n", 0, 0, 0 );
1971 op->o_tmpfree( filter_attrs, op->o_tmpmemctx );
1972 if ( BER_BVISNULL( &answerable->q_uuid )) {
1973 /* No entries cached, just an empty result set */
1975 send_ldap_result( op, rs );
1978 op->o_callback = NULL;
1979 i = cm->db.bd_info->bi_op_search( op, rs );
1981 ldap_pvt_thread_rdwr_runlock(&qtemp->t_rwlock);
1983 op->o_callback = save_cb;
1987 Debug( pcache_debug, "QUERY NOT ANSWERABLE\n", 0, 0, 0 );
1989 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
1990 if (cm->num_cached_queries >= cm->max_queries) {
1993 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
1995 if (op->ors_attrsonly)
2000 struct search_info *si;
2002 Debug( pcache_debug, "QUERY CACHEABLE\n", 0, 0, 0 );
2003 query.filter = filter_dup(op->ors_filter, NULL);
2004 ldap_pvt_thread_rdwr_wlock(&qtemp->t_rwlock);
2005 if ( !qtemp->t_attrs.count ) {
2006 qtemp->t_attrs.count = add_filter_attrs(op,
2007 &qtemp->t_attrs.attrs,
2008 &qm->attr_sets[attr_set],
2009 filter_attrs, fattr_cnt, fattr_got_oc);
2011 ldap_pvt_thread_rdwr_wunlock(&qtemp->t_rwlock);
2013 cb = op->o_tmpalloc( sizeof(*cb) + sizeof(*si), op->o_tmpmemctx );
2014 cb->sc_response = pcache_response;
2015 cb->sc_cleanup = NULL;
2016 cb->sc_private = (cb+1);
2017 si = cb->sc_private;
2021 si->max = cm->num_entries_limit ;
2026 si->save_attrs = op->ors_attrs;
2028 op->ors_attrs = qtemp->t_attrs.attrs;
2030 if ( cm->response_cb == PCACHE_RESPONSE_CB_HEAD ) {
2031 cb->sc_next = op->o_callback;
2032 op->o_callback = cb;
2035 slap_callback **pcb;
2037 /* need to move the callback at the end, in case other
2038 * overlays are present, so that the final entry is
2039 * actually cached */
2041 for ( pcb = &op->o_callback; *pcb; pcb = &(*pcb)->sc_next );
2046 Debug( pcache_debug, "QUERY NOT CACHEABLE\n",
2050 op->o_tmpfree( filter_attrs, op->o_tmpmemctx );
2052 return SLAP_CB_CONTINUE;
2057 AttributeName* attrs,
2065 for ( ; attrs[count].an_name.bv_val; count++ );
2068 /* recognize a single "*" or a "1.1" */
2071 attrs = slap_anlist_all_user_attributes;
2073 } else if ( count == 1 && strcmp( attrs[0].an_name.bv_val, LDAP_NO_ATTRS ) == 0 ) {
2078 for ( i = 0; i < num; i++ ) {
2082 if ( count > qm->attr_sets[i].count ) {
2087 if ( !qm->attr_sets[i].count ) {
2093 for ( a2 = attrs; a2->an_name.bv_val; a2++ ) {
2094 if ( !an_find( qm->attr_sets[i].attrs, &a2->an_name ) ) {
2117 struct re_s *rtask = arg;
2118 slap_overinst *on = rtask->arg;
2119 cache_manager *cm = on->on_bi.bi_private;
2120 query_manager *qm = cm->qm;
2121 Connection conn = {0};
2122 OperationBuffer opbuf;
2125 SlapReply rs = {REP_RESULT};
2127 int return_val, pause = 1;
2128 QueryTemplate* templ;
2130 connection_fake_init( &conn, &opbuf, ctx );
2134 op->o_dn = cm->db.be_rootdn;
2135 op->o_ndn = cm->db.be_rootndn;
2139 for (templ = qm->templates; templ; templ=templ->qmnext) {
2140 query = templ->query_last;
2141 if ( query ) pause = 0;
2142 op->o_time = slap_get_time();
2143 while (query && (query->expiry_time < op->o_time)) {
2145 Debug( pcache_debug, "Lock CR index = %p\n",
2146 (void *) templ, 0, 0 );
2147 ldap_pvt_thread_rdwr_wlock(&templ->t_rwlock);
2148 if ( query == templ->query_last ) {
2150 remove_from_template(query, templ);
2151 Debug( pcache_debug, "TEMPLATE %p QUERIES-- %d\n",
2152 (void *) templ, templ->no_of_queries, 0 );
2153 Debug( pcache_debug, "Unlock CR index = %p\n",
2154 (void *) templ, 0, 0 );
2156 ldap_pvt_thread_rdwr_wunlock(&templ->t_rwlock);
2158 query = templ->query_last;
2161 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
2162 remove_query(qm, query);
2163 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
2164 if ( BER_BVISNULL( &query->q_uuid ))
2167 return_val = remove_query_data(op, &rs, &query->q_uuid);
2168 Debug( pcache_debug, "STALE QUERY REMOVED, SIZE=%d\n",
2170 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
2171 cm->cur_entries -= return_val;
2172 cm->num_cached_queries--;
2173 Debug( pcache_debug, "STORED QUERIES = %lu\n",
2174 cm->num_cached_queries, 0, 0 );
2175 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
2176 Debug( pcache_debug,
2177 "STALE QUERY REMOVED, CACHE ="
2179 cm->cur_entries, 0, 0 );
2181 query = templ->query_last;
2184 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
2185 if ( ldap_pvt_runqueue_isrunning( &slapd_rq, rtask )) {
2186 ldap_pvt_runqueue_stoptask( &slapd_rq, rtask );
2188 /* If there were no queries, defer processing for a while */
2189 cm->cc_paused = pause;
2190 ldap_pvt_runqueue_resched( &slapd_rq, rtask, pause );
2192 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
2197 #define MAX_ATTR_SETS 500
2207 static ConfigDriver pc_cf_gen;
2208 static ConfigLDAPadd pc_ldadd;
2209 static ConfigCfAdd pc_cfadd;
2211 static ConfigTable pccfg[] = {
2212 { "proxycache", "backend> <max_entries> <numattrsets> <entry limit> "
2214 6, 6, 0, ARG_MAGIC|ARG_NO_DELETE|PC_MAIN, pc_cf_gen,
2215 "( OLcfgOvAt:2.1 NAME 'olcProxyCache' "
2216 "DESC 'ProxyCache basic parameters' "
2217 "SYNTAX OMsDirectoryString SINGLE-VALUE )", NULL, NULL },
2218 { "proxyattrset", "index> <attributes...",
2219 2, 0, 0, ARG_MAGIC|PC_ATTR, pc_cf_gen,
2220 "( OLcfgOvAt:2.2 NAME 'olcProxyAttrset' "
2221 "DESC 'A set of attributes to cache' "
2222 "SYNTAX OMsDirectoryString )", NULL, NULL },
2223 { "proxytemplate", "filter> <attrset-index> <TTL> <negTTL",
2224 4, 5, 0, ARG_MAGIC|PC_TEMP, pc_cf_gen,
2225 "( OLcfgOvAt:2.3 NAME 'olcProxyTemplate' "
2226 "DESC 'Filter template, attrset, cache TTL, optional negative TTL' "
2227 "SYNTAX OMsDirectoryString )", NULL, NULL },
2228 { "response-callback", "head|tail(default)",
2229 2, 2, 0, ARG_MAGIC|PC_RESP, pc_cf_gen,
2230 "( OLcfgOvAt:2.4 NAME 'olcProxyResponseCB' "
2231 "DESC 'Response callback position in overlay stack' "
2232 "SYNTAX OMsDirectoryString )", NULL, NULL },
2233 { "proxyCacheQueries", "queries",
2234 2, 2, 0, ARG_INT|ARG_MAGIC|PC_QUERIES, pc_cf_gen,
2235 "( OLcfgOvAt:2.5 NAME 'olcProxyCacheQueries' "
2236 "DESC 'Maximum number of queries to cache' "
2237 "SYNTAX OMsInteger )", NULL, NULL },
2238 { "proxySaveQueries", "TRUE|FALSE",
2239 2, 2, 0, ARG_ON_OFF|ARG_OFFSET, (void *)offsetof(cache_manager, save_queries),
2240 "( OLcfgOvAt:2.6 NAME 'olcProxySaveQueries' "
2241 "DESC 'Save cached queries for hot restart' "
2242 "SYNTAX OMsBoolean )", NULL, NULL },
2244 { NULL, NULL, 0, 0, 0, ARG_IGNORED }
2247 static ConfigOCs pcocs[] = {
2248 { "( OLcfgOvOc:2.1 "
2249 "NAME 'olcPcacheConfig' "
2250 "DESC 'ProxyCache configuration' "
2251 "SUP olcOverlayConfig "
2252 "MUST ( olcProxyCache $ olcProxyAttrset $ olcProxyTemplate ) "
2253 "MAY ( olcProxyResponseCB $ olcProxyCacheQueries $ olcProxySaveQueries ) )",
2254 Cft_Overlay, pccfg, NULL, pc_cfadd },
2255 { "( OLcfgOvOc:2.2 "
2256 "NAME 'olcPcacheDatabase' "
2257 "DESC 'Cache database configuration' "
2258 "AUXILIARY )", Cft_Misc, pccfg, pc_ldadd },
2263 pc_ldadd( CfEntryInfo *p, Entry *e, ConfigArgs *ca )
2268 if ( p->ce_type != Cft_Overlay || !p->ce_bi ||
2269 p->ce_bi->bi_cf_ocs != pcocs )
2270 return LDAP_CONSTRAINT_VIOLATION;
2272 on = (slap_overinst *)p->ce_bi;
2273 cm = on->on_bi.bi_private;
2275 return LDAP_SUCCESS;
2279 pc_cfadd( Operation *op, SlapReply *rs, Entry *p, ConfigArgs *ca )
2281 CfEntryInfo *pe = p->e_private;
2282 slap_overinst *on = (slap_overinst *)pe->ce_bi;
2283 cache_manager *cm = on->on_bi.bi_private;
2286 /* FIXME: should not hardcode "olcDatabase" here */
2287 bv.bv_len = sprintf( ca->cr_msg, "olcDatabase=%s", cm->db.bd_info->bi_type );
2288 bv.bv_val = ca->cr_msg;
2291 /* We can only create this entry if the database is table-driven
2293 if ( cm->db.bd_info->bi_cf_ocs )
2294 config_build_entry( op, rs, pe, ca, &bv, cm->db.bd_info->bi_cf_ocs,
2301 pc_cf_gen( ConfigArgs *c )
2303 slap_overinst *on = (slap_overinst *)c->bi;
2304 cache_manager* cm = on->on_bi.bi_private;
2305 query_manager* qm = cm->qm;
2306 QueryTemplate* temp;
2307 AttributeName* attr_name;
2308 AttributeName* attrarray;
2309 const char* text=NULL;
2314 if ( c->op == SLAP_CONFIG_EMIT ) {
2318 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ), "%s %d %d %d %ld",
2319 cm->db.bd_info->bi_type, cm->max_entries, cm->numattrsets,
2320 cm->num_entries_limit, cm->cc_period );
2321 bv.bv_val = c->cr_msg;
2322 value_add_one( &c->rvalue_vals, &bv );
2325 for (i=0; i<cm->numattrsets; i++) {
2326 if ( !qm->attr_sets[i].count ) continue;
2328 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ), "%d", i );
2330 /* count the attr length */
2331 for ( attr_name = qm->attr_sets[i].attrs;
2332 attr_name->an_name.bv_val; attr_name++ )
2333 bv.bv_len += attr_name->an_name.bv_len + 1;
2335 bv.bv_val = ch_malloc( bv.bv_len+1 );
2336 ptr = lutil_strcopy( bv.bv_val, c->cr_msg );
2337 for ( attr_name = qm->attr_sets[i].attrs;
2338 attr_name->an_name.bv_val; attr_name++ ) {
2340 ptr = lutil_strcopy( ptr, attr_name->an_name.bv_val );
2342 ber_bvarray_add( &c->rvalue_vals, &bv );
2344 if ( !c->rvalue_vals )
2348 for (temp=qm->templates; temp; temp=temp->qmnext) {
2349 if ( temp->negttl ) {
2350 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ),
2352 temp->attr_set_index,
2356 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ), " %d %ld",
2357 temp->attr_set_index,
2360 bv.bv_len += temp->querystr.bv_len + 2;
2361 bv.bv_val = ch_malloc( bv.bv_len+1 );
2364 ptr = lutil_strcopy( ptr, temp->querystr.bv_val );
2366 strcpy( ptr, c->cr_msg );
2367 ber_bvarray_add( &c->rvalue_vals, &bv );
2369 if ( !c->rvalue_vals )
2373 if ( cm->response_cb == PCACHE_RESPONSE_CB_HEAD ) {
2374 BER_BVSTR( &bv, "head" );
2376 BER_BVSTR( &bv, "tail" );
2378 value_add_one( &c->rvalue_vals, &bv );
2381 c->value_int = cm->max_queries;
2385 } else if ( c->op == LDAP_MOD_DELETE ) {
2386 return 1; /* FIXME */
2398 if ( cm->numattrsets > 0 ) {
2399 snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"proxycache\" directive already provided" );
2400 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2404 if ( lutil_atoi( &cm->numattrsets, c->argv[3] ) != 0 ) {
2405 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse num attrsets=\"%s\" (arg #3)",
2407 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2410 if ( cm->numattrsets <= 0 ) {
2411 snprintf( c->cr_msg, sizeof( c->cr_msg ), "numattrsets (arg #3) must be positive" );
2412 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2415 if ( cm->numattrsets > MAX_ATTR_SETS ) {
2416 snprintf( c->cr_msg, sizeof( c->cr_msg ), "numattrsets (arg #3) must be <= %d", MAX_ATTR_SETS );
2417 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2421 if ( !backend_db_init( c->argv[1], &cm->db, -1, NULL )) {
2422 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unknown backend type (arg #1)" );
2423 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2427 if ( lutil_atoi( &cm->max_entries, c->argv[2] ) != 0 ) {
2428 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse max entries=\"%s\" (arg #2)",
2430 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2433 if ( cm->max_entries <= 0 ) {
2434 snprintf( c->cr_msg, sizeof( c->cr_msg ), "max entries (arg #2) must be positive.\n" );
2435 Debug( LDAP_DEBUG_CONFIG, "%s: %s\n", c->log, c->cr_msg, 0 );
2439 if ( lutil_atoi( &cm->num_entries_limit, c->argv[4] ) != 0 ) {
2440 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse entry limit=\"%s\" (arg #4)",
2442 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2445 if ( cm->num_entries_limit <= 0 ) {
2446 snprintf( c->cr_msg, sizeof( c->cr_msg ), "entry limit (arg #4) must be positive" );
2447 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2450 if ( cm->num_entries_limit > cm->max_entries ) {
2451 snprintf( c->cr_msg, sizeof( c->cr_msg ), "entry limit (arg #4) must be less than max entries %d (arg #2)", cm->max_entries );
2452 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2456 if ( lutil_parse_time( c->argv[5], &t ) != 0 ) {
2457 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse period=\"%s\" (arg #5)",
2459 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2462 cm->cc_period = (time_t)t;
2463 Debug( pcache_debug,
2464 "Total # of attribute sets to be cached = %d.\n",
2465 cm->numattrsets, 0, 0 );
2466 qm->attr_sets = ( struct attr_set * )ch_calloc( cm->numattrsets,
2467 sizeof( struct attr_set ) );
2470 if ( cm->numattrsets == 0 ) {
2471 snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"proxycache\" directive not provided yet" );
2472 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2475 if ( lutil_atoi( &num, c->argv[1] ) != 0 ) {
2476 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse attrset #=\"%s\"",
2478 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2482 if ( num < 0 || num >= cm->numattrsets ) {
2483 snprintf( c->cr_msg, sizeof( c->cr_msg ), "attrset index %d out of bounds (must be %s%d)",
2484 num, cm->numattrsets > 1 ? "0->" : "", cm->numattrsets - 1 );
2485 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2488 qm->attr_sets[num].flags |= PC_CONFIGURED;
2489 if ( c->argc == 2 ) {
2491 snprintf( c->cr_msg, sizeof( c->cr_msg ),
2492 "need an explicit attr in attrlist; use \"*\" to indicate all attrs" );
2493 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2496 } else if ( c->argc == 3 ) {
2497 if ( strcmp( c->argv[2], LDAP_ALL_USER_ATTRIBUTES ) == 0 ) {
2498 qm->attr_sets[num].count = 1;
2499 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( 2,
2500 sizeof( AttributeName ) );
2501 BER_BVSTR( &qm->attr_sets[num].attrs[0].an_name, LDAP_ALL_USER_ATTRIBUTES );
2504 } else if ( strcmp( c->argv[2], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 ) {
2505 qm->attr_sets[num].count = 1;
2506 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( 2,
2507 sizeof( AttributeName ) );
2508 BER_BVSTR( &qm->attr_sets[num].attrs[0].an_name, LDAP_ALL_OPERATIONAL_ATTRIBUTES );
2511 } else if ( strcmp( c->argv[2], LDAP_NO_ATTRS ) == 0 ) {
2514 /* else: fallthru */
2516 } else if ( c->argc == 4 ) {
2517 if ( ( strcmp( c->argv[2], LDAP_ALL_USER_ATTRIBUTES ) == 0 && strcmp( c->argv[3], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 )
2518 || ( strcmp( c->argv[2], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 && strcmp( c->argv[3], LDAP_ALL_USER_ATTRIBUTES ) == 0 ) )
2520 qm->attr_sets[num].count = 2;
2521 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( 3,
2522 sizeof( AttributeName ) );
2523 BER_BVSTR( &qm->attr_sets[num].attrs[0].an_name, LDAP_ALL_USER_ATTRIBUTES );
2524 BER_BVSTR( &qm->attr_sets[num].attrs[1].an_name, LDAP_ALL_OPERATIONAL_ATTRIBUTES );
2527 /* else: fallthru */
2530 if ( c->argc > 2 ) {
2531 int all_user = 0, all_op = 0;
2533 qm->attr_sets[num].count = c->argc - 2;
2534 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( c->argc - 1,
2535 sizeof( AttributeName ) );
2536 attr_name = qm->attr_sets[num].attrs;
2537 for ( i = 2; i < c->argc; i++ ) {
2538 attr_name->an_desc = NULL;
2539 if ( strcmp( c->argv[i], LDAP_NO_ATTRS ) == 0 ) {
2540 snprintf( c->cr_msg, sizeof( c->cr_msg ),
2541 "invalid attr #%d \"%s\" in attrlist",
2542 i - 2, c->argv[i] );
2543 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2544 ch_free( qm->attr_sets[num].attrs );
2545 qm->attr_sets[num].attrs = NULL;
2546 qm->attr_sets[num].count = 0;
2549 if ( strcmp( c->argv[i], LDAP_ALL_USER_ATTRIBUTES ) == 0 ) {
2551 BER_BVSTR( &attr_name->an_name, LDAP_ALL_USER_ATTRIBUTES );
2552 } else if ( strcmp( c->argv[i], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 ) {
2554 BER_BVSTR( &attr_name->an_name, LDAP_ALL_OPERATIONAL_ATTRIBUTES );
2556 if ( slap_str2ad( c->argv[i], &attr_name->an_desc, &text ) ) {
2557 strcpy( c->cr_msg, text );
2558 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2559 ch_free( qm->attr_sets[num].attrs );
2560 qm->attr_sets[num].attrs = NULL;
2561 qm->attr_sets[num].count = 0;
2564 attr_name->an_name = attr_name->an_desc->ad_cname;
2566 attr_name->an_oc = NULL;
2567 attr_name->an_oc_exclude = 0;
2568 if ( attr_name->an_desc == slap_schema.si_ad_objectClass )
2569 qm->attr_sets[num].flags |= PC_GOT_OC;
2571 BER_BVZERO( &attr_name->an_name );
2574 /* warn if list contains both "*" and "+" */
2575 if ( i > 4 && all_user && all_op ) {
2576 snprintf( c->cr_msg, sizeof( c->cr_msg ),
2577 "warning: attribute list contains \"*\" and \"+\"" );
2578 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2583 if ( cm->numattrsets == 0 ) {
2584 snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"proxycache\" directive not provided yet" );
2585 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2588 if ( lutil_atoi( &i, c->argv[2] ) != 0 ) {
2589 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse template #=\"%s\"",
2591 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2595 if ( i < 0 || i >= cm->numattrsets ||
2596 !(qm->attr_sets[i].flags & PC_CONFIGURED )) {
2597 snprintf( c->cr_msg, sizeof( c->cr_msg ), "template index %d invalid (%s%d)",
2598 i, cm->numattrsets > 1 ? "0->" : "", cm->numattrsets - 1 );
2599 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2602 temp = ch_calloc( 1, sizeof( QueryTemplate ));
2603 temp->qmnext = qm->templates;
2604 qm->templates = temp;
2605 ldap_pvt_thread_rdwr_init( &temp->t_rwlock );
2606 temp->query = temp->query_last = NULL;
2607 if ( lutil_parse_time( c->argv[3], &t ) != 0 ) {
2608 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse template ttl=\"%s\"",
2610 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2613 temp->ttl = (time_t)t;
2614 if ( c->argc == 5 ) {
2615 if ( lutil_parse_time( c->argv[4], &t ) != 0 ) {
2616 snprintf( c->cr_msg, sizeof( c->cr_msg ),
2617 "unable to parse template negttl=\"%s\"",
2619 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2622 temp->negttl = (time_t)t;
2627 temp->no_of_queries = 0;
2629 ber_str2bv( c->argv[1], 0, 1, &temp->querystr );
2630 Debug( pcache_debug, "Template:\n", 0, 0, 0 );
2631 Debug( pcache_debug, " query template: %s\n",
2632 temp->querystr.bv_val, 0, 0 );
2633 temp->attr_set_index = i;
2634 qm->attr_sets[i].flags |= PC_REFERENCED;
2635 temp->qtnext = qm->attr_sets[i].templates;
2636 qm->attr_sets[i].templates = temp;
2637 Debug( pcache_debug, " attributes: \n", 0, 0, 0 );
2638 if ( ( attrarray = qm->attr_sets[i].attrs ) != NULL ) {
2639 for ( i=0; attrarray[i].an_name.bv_val; i++ )
2640 Debug( pcache_debug, "\t%s\n",
2641 attrarray[i].an_name.bv_val, 0, 0 );
2645 if ( strcasecmp( c->argv[1], "head" ) == 0 ) {
2646 cm->response_cb = PCACHE_RESPONSE_CB_HEAD;
2648 } else if ( strcasecmp( c->argv[1], "tail" ) == 0 ) {
2649 cm->response_cb = PCACHE_RESPONSE_CB_TAIL;
2652 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unknown specifier" );
2653 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2658 if ( c->value_int <= 0 ) {
2659 snprintf( c->cr_msg, sizeof( c->cr_msg ), "max queries must be positive" );
2660 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2663 cm->max_queries = c->value_int;
2678 slap_overinst *on = (slap_overinst *)be->bd_info;
2679 cache_manager* cm = on->on_bi.bi_private;
2681 /* Something for the cache database? */
2682 if ( cm->db.bd_info && cm->db.bd_info->bi_db_config )
2683 return cm->db.bd_info->bi_db_config( &cm->db, fname, lineno,
2685 return SLAP_CONF_UNKNOWN;
2693 slap_overinst *on = (slap_overinst *)be->bd_info;
2697 cm = (cache_manager *)ch_malloc(sizeof(cache_manager));
2698 on->on_bi.bi_private = cm;
2700 qm = (query_manager*)ch_malloc(sizeof(query_manager));
2703 SLAP_DBFLAGS(&cm->db) |= SLAP_DBFLAG_NO_SCHEMA_CHECK;
2704 cm->db.be_private = NULL;
2705 cm->db.be_pcl_mutexp = &cm->db.be_pcl_mutex;
2707 cm->numattrsets = 0;
2708 cm->num_entries_limit = 5;
2709 cm->num_cached_queries = 0;
2710 cm->max_entries = 0;
2711 cm->cur_entries = 0;
2712 cm->max_queries = 10000;
2713 cm->save_queries = 0;
2714 cm->response_cb = PCACHE_RESPONSE_CB_TAIL;
2715 cm->cc_period = 1000;
2718 qm->attr_sets = NULL;
2719 qm->templates = NULL;
2721 qm->lru_bottom = NULL;
2723 qm->qcfunc = query_containment;
2724 qm->crfunc = cache_replacement;
2725 qm->addfunc = add_query;
2726 ldap_pvt_thread_mutex_init(&qm->lru_mutex);
2728 ldap_pvt_thread_mutex_init(&cm->cache_mutex);
2733 pcache_cachedquery_open_cb( Operation *op, SlapReply *rs )
2735 assert( op->o_tag == LDAP_REQ_SEARCH );
2737 if ( rs->sr_type == REP_SEARCH ) {
2740 a = attr_find( rs->sr_entry->e_attrs, ad_cachedQueryURL );
2744 assert( a->a_nvals != NULL );
2746 valsp = op->o_callback->sc_private;
2747 assert( *valsp == NULL );
2749 ber_bvarray_dup_x( valsp, a->a_nvals, op->o_tmpmemctx );
2761 slap_overinst *on = (slap_overinst *)be->bd_info;
2762 cache_manager *cm = on->on_bi.bi_private;
2763 query_manager* qm = cm->qm;
2764 int i, ncf = 0, rf = 0, nrf = 0, rc = 0;
2766 /* check attr sets */
2767 for ( i = 0; i < cm->numattrsets; i++) {
2768 if ( !( qm->attr_sets[i].flags & PC_CONFIGURED ) ) {
2769 if ( qm->attr_sets[i].flags & PC_REFERENCED ) {
2770 Debug( LDAP_DEBUG_CONFIG, "pcache: attr set #%d not configured but referenced.\n", i, 0, 0 );
2774 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, attr set #%d not configured.\n", i, 0, 0 );
2778 } else if ( !( qm->attr_sets[i].flags & PC_REFERENCED ) ) {
2779 Debug( LDAP_DEBUG_CONFIG, "pcache: attr set #%d configured but not referenced.\n", i, 0, 0 );
2784 if ( ncf || rf || nrf ) {
2785 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, %d attr sets configured but not referenced.\n", nrf, 0, 0 );
2786 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, %d attr sets not configured.\n", ncf, 0, 0 );
2787 Debug( LDAP_DEBUG_CONFIG, "pcache: %d attr sets not configured but referenced.\n", rf, 0, 0 );
2794 /* need to inherit something from the original database... */
2795 cm->db.be_def_limit = be->be_def_limit;
2796 cm->db.be_limits = be->be_limits;
2797 cm->db.be_acl = be->be_acl;
2798 cm->db.be_dfltaccess = be->be_dfltaccess;
2800 if ( SLAP_DBMONITORING( be ) ) {
2801 SLAP_DBFLAGS( &cm->db ) |= SLAP_DBFLAG_MONITORING;
2804 SLAP_DBFLAGS( &cm->db ) &= ~SLAP_DBFLAG_MONITORING;
2807 rc = backend_startup_one( &cm->db, NULL );
2809 /* There is no runqueue in TOOL mode */
2810 if ( slapMode & SLAP_SERVER_MODE ) {
2811 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
2812 ldap_pvt_runqueue_insert( &slapd_rq, cm->cc_period,
2813 consistency_check, on,
2814 "pcache_consistency", be->be_suffix[0].bv_val );
2815 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
2817 /* Cached database must have the rootdn */
2818 if ( BER_BVISNULL( &cm->db.be_rootndn )
2819 || BER_BVISEMPTY( &cm->db.be_rootndn ) )
2821 Debug( LDAP_DEBUG_ANY, "pcache_db_open(): "
2822 "underlying database of type \"%s\"\n"
2823 " serving naming context \"%s\"\n"
2824 " has no \"rootdn\", required by \"proxycache\".\n",
2825 on->on_info->oi_orig->bi_type,
2826 cm->db.be_suffix[0].bv_val, 0 );
2830 if ( cm->save_queries ) {
2831 void *thrctx = ldap_pvt_thread_pool_context();
2832 Connection conn = { 0 };
2833 OperationBuffer opbuf;
2835 slap_callback cb = { 0 };
2836 SlapReply rs = { 0 };
2837 BerVarray vals = NULL;
2838 AttributeName attrs[ 2 ] = { 0 };
2840 connection_fake_init( &conn, &opbuf, thrctx );
2845 op->o_tag = LDAP_REQ_SEARCH;
2846 op->o_protocol = LDAP_VERSION3;
2847 cb.sc_response = pcache_cachedquery_open_cb;
2848 cb.sc_private = &vals;
2849 op->o_callback = &cb;
2850 op->o_time = slap_get_time();
2851 op->o_do_not_cache = 1;
2852 op->o_managedsait = SLAP_CONTROL_CRITICAL;
2854 op->o_dn = cm->db.be_rootdn;
2855 op->o_ndn = cm->db.be_rootndn;
2856 op->o_req_dn = cm->db.be_suffix[ 0 ];
2857 op->o_req_ndn = cm->db.be_nsuffix[ 0 ];
2859 op->ors_scope = LDAP_SCOPE_BASE;
2860 op->ors_deref = LDAP_DEREF_NEVER;
2862 op->ors_tlimit = SLAP_NO_LIMIT;
2863 ber_str2bv( "(cachedQueryURL=*)", 0, 0, &op->ors_filterstr );
2864 op->ors_filter = str2filter_x( op, op->ors_filterstr.bv_val );
2865 if ( op->ors_filter != NULL ) {
2866 attrs[ 0 ].an_desc = ad_cachedQueryURL;
2867 attrs[ 0 ].an_name = ad_cachedQueryURL->ad_cname;
2868 op->ors_attrs = attrs;
2869 op->ors_attrsonly = 0;
2871 rc = op->o_bd->be_search( op, &rs );
2872 if ( rc == LDAP_SUCCESS && vals != NULL ) {
2875 for ( i = 0; !BER_BVISNULL( &vals[ i ] ); i++ ) {
2876 if ( url2query( vals[ i ].bv_val, op, qm ) == 0 ) {
2877 cm->num_cached_queries++;
2881 ber_bvarray_free_x( vals, op->o_tmpmemctx );
2884 filter_free_x( op, op->ors_filter );
2896 pcache_free_qbase( void *v )
2902 tavl_free( qb->scopes[i], NULL );
2912 slap_overinst *on = (slap_overinst *)be->bd_info;
2913 cache_manager *cm = on->on_bi.bi_private;
2914 query_manager *qm = cm->qm;
2918 if ( cm->save_queries && qm->templates != NULL ) {
2920 BerVarray vals = NULL;
2922 for ( tm = qm->templates; tm != NULL; tm = tm->qmnext ) {
2923 for ( qc = tm->query; qc; qc = qc->next ) {
2926 if ( query2url( qc, &bv ) == 0 ) {
2927 ber_bvarray_add( &vals, &bv );
2932 if ( vals != NULL ) {
2933 void *thrctx = ldap_pvt_thread_pool_context();
2934 Connection conn = { 0 };
2935 OperationBuffer opbuf;
2937 slap_callback cb = { 0 };
2939 SlapReply rs = { REP_RESULT };
2940 Modifications mod = { 0 };
2942 connection_fake_init( &conn, &opbuf, thrctx );
2946 op->o_dn = cm->db.be_rootdn;
2947 op->o_ndn = cm->db.be_rootndn;
2949 op->o_tag = LDAP_REQ_MODIFY;
2950 op->o_protocol = LDAP_VERSION3;
2951 cb.sc_response = slap_null_cb;
2952 op->o_callback = &cb;
2953 op->o_time = slap_get_time();
2954 op->o_do_not_cache = 1;
2955 op->o_managedsait = SLAP_CONTROL_CRITICAL;
2957 op->o_req_dn = op->o_bd->be_suffix[0];
2958 op->o_req_ndn = op->o_bd->be_nsuffix[0];
2960 mod.sml_op = LDAP_MOD_REPLACE;
2962 mod.sml_desc = ad_cachedQueryURL;
2963 mod.sml_type = ad_cachedQueryURL->ad_cname;
2964 mod.sml_values = vals;
2965 mod.sml_nvalues = NULL;
2966 mod.sml_next = NULL;
2967 Debug( pcache_debug,
2968 "SETTING CACHED QUERY URLS\n",
2971 op->orm_modlist = &mod;
2973 op->o_bd->be_modify( op, &rs );
2975 ber_bvarray_free( vals );
2979 /* cleanup stuff inherited from the original database... */
2980 cm->db.be_limits = NULL;
2981 cm->db.be_acl = NULL;
2983 /* stop the thread ... */
2985 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
2986 if ( ldap_pvt_runqueue_isrunning( &slapd_rq, cm->cc_arg ) ) {
2987 ldap_pvt_runqueue_stoptask( &slapd_rq, cm->cc_arg );
2989 ldap_pvt_runqueue_remove( &slapd_rq, cm->cc_arg );
2990 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
2993 if ( cm->db.bd_info->bi_db_close ) {
2994 rc = cm->db.bd_info->bi_db_close( &cm->db, NULL );
2996 while ( (tm = qm->templates) != NULL ) {
2997 CachedQuery *qc, *qn;
2998 qm->templates = tm->qmnext;
2999 for ( qc = tm->query; qc; qc = qn ) {
3003 avl_free( tm->qbase, pcache_free_qbase );
3004 free( tm->querystr.bv_val );
3005 ldap_pvt_thread_rdwr_destroy( &tm->t_rwlock );
3006 free( tm->t_attrs.attrs );
3010 for ( i=0; i<cm->numattrsets; i++ ) {
3011 free( qm->attr_sets[i].attrs );
3013 free( qm->attr_sets );
3014 qm->attr_sets = NULL;
3025 slap_overinst *on = (slap_overinst *)be->bd_info;
3026 cache_manager *cm = on->on_bi.bi_private;
3027 query_manager *qm = cm->qm;
3029 if ( cm->db.be_private != NULL ) {
3030 backend_stopdown_one( &cm->db );
3033 ldap_pvt_thread_mutex_destroy( &qm->lru_mutex );
3034 ldap_pvt_thread_mutex_destroy( &cm->cache_mutex );
3041 static slap_overinst pcache;
3043 static char *obsolete_names[] = {
3048 int pcache_initialize()
3051 struct berval debugbv = BER_BVC("pcache");
3053 code = slap_loglevel_get( &debugbv, &pcache_debug );
3058 for ( i = 0; as[i].desc != NULL; i++ ) {
3059 code = register_at( as[i].desc, as[i].adp, 0 );
3061 Debug( LDAP_DEBUG_ANY,
3062 "pcache_initialize: register_at #%d failed\n", i, 0, 0 );
3067 pcache.on_bi.bi_type = "pcache";
3068 pcache.on_bi.bi_obsolete_names = obsolete_names;
3069 pcache.on_bi.bi_db_init = pcache_db_init;
3070 pcache.on_bi.bi_db_config = pcache_db_config;
3071 pcache.on_bi.bi_db_open = pcache_db_open;
3072 pcache.on_bi.bi_db_close = pcache_db_close;
3073 pcache.on_bi.bi_db_destroy = pcache_db_destroy;
3075 pcache.on_bi.bi_op_search = pcache_op_search;
3077 pcache.on_bi.bi_chk_controls = pcache_chk_controls;
3079 pcache.on_bi.bi_cf_ocs = pcocs;
3081 code = config_register_schema( pccfg, pcocs );
3082 if ( code ) return code;
3084 return overlay_register( &pcache );
3087 #if SLAPD_OVER_PROXYCACHE == SLAPD_MOD_DYNAMIC
3088 int init_module(int argc, char *argv[]) {
3089 return pcache_initialize();
3093 #endif /* defined(SLAPD_OVER_PROXYCACHE) */