2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 2003-2006 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>
37 /* query cache structs */
40 typedef struct Query_s {
41 Filter* filter; /* Search Filter */
42 AttributeName* attrs; /* Projected attributes */
43 AttributeName* save_attrs; /* original attributes, saved for response */
44 struct berval base; /* Search Base */
45 int scope; /* Search scope */
48 /* struct representing a cached query */
49 typedef struct cached_query_s {
50 Query query; /* LDAP query */
51 struct berval q_uuid; /* query identifier */
52 int template_id; /* template of the query */
53 time_t expiry_time; /* time till the query is considered valid */
54 struct cached_query_s *next; /* next query in the template */
55 struct cached_query_s *prev; /* previous query in the template */
56 struct cached_query_s *lru_up; /* previous query in the LRU list */
57 struct cached_query_s *lru_down; /* next query in the LRU list */
60 /* struct representing a query template
61 * e.g. template string = &(cn=)(mail=)
63 typedef struct query_template_s {
64 struct berval querystr; /* Filter string corresponding to the QT */
65 int attr_set_index; /* determines the projected attributes */
67 CachedQuery* query; /* most recent query cached for the template */
68 CachedQuery* query_last; /* oldest query cached for the template */
70 int no_of_queries; /* Total number of queries in the template */
71 time_t ttl; /* TTL for the queries of this template */
72 ldap_pvt_thread_rdwr_t t_rwlock; /* Rd/wr lock for accessing queries in the template */
76 * Represents a set of projected attributes.
81 #define PC_CONFIGURED (0x1)
82 #define PC_REFERENCED (0x2)
83 #define PC_GOT_OC (0x4)
84 AttributeName* attrs; /* specifies the set */
85 int count; /* number of attributes */
88 struct query_manager_s;
90 /* prototypes for functions for 1) query containment
91 * 2) query addition, 3) cache replacement
93 typedef int (QCfunc)(Operation *op, struct query_manager_s*, Query*, int );
94 typedef void (AddQueryfunc)(struct query_manager_s*, Query*, int, struct berval*);
95 typedef void (CRfunc)(struct query_manager_s*, struct berval * );
97 /* LDAP query cache */
98 typedef struct query_manager_s {
99 struct attr_set* attr_sets; /* possible sets of projected attributes */
100 QueryTemplate* templates; /* cacheable templates */
102 CachedQuery* lru_top; /* top and bottom of LRU list */
103 CachedQuery* lru_bottom;
105 ldap_pvt_thread_mutex_t lru_mutex; /* mutex for accessing LRU list */
107 /* Query cache methods */
108 QCfunc *qcfunc; /* Query containment*/
109 CRfunc *crfunc; /* cache replacement */
110 AddQueryfunc *addfunc; /* add query */
113 /* LDAP query cache manager */
114 typedef struct cache_manager_s {
115 BackendDB db; /* underlying database */
116 unsigned long num_cached_queries; /* total number of cached queries */
117 unsigned long max_queries; /* upper bound on # of cached queries */
118 int numattrsets; /* number of attribute sets */
119 int numtemplates; /* number of cacheable templates */
120 int cur_entries; /* current number of entries cached */
121 int max_entries; /* max number of entries cached */
122 int num_entries_limit; /* max # of entries in a cacheable query */
124 char response_cb; /* install the response callback
125 * at the tail of the callback list */
126 #define PCACHE_RESPONSE_CB_HEAD 0
127 #define PCACHE_RESPONSE_CB_TAIL 1
129 time_t cc_period; /* interval between successive consistency checks (sec) */
133 ldap_pvt_thread_mutex_t cache_mutex;
134 ldap_pvt_thread_mutex_t remove_mutex;
136 query_manager* qm; /* query cache managed by the cache manager */
139 static AttributeDescription *ad_queryid;
140 static char *queryid_schema = "( 1.3.6.1.4.1.4203.666.1.12 NAME 'queryid' "
141 "DESC 'list of queries the entry belongs to' "
142 "EQUALITY octetStringMatch "
143 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.40{64} "
144 "NO-USER-MODIFICATION USAGE directoryOperation )";
146 /* Return 1 for an added entry, else 0 */
151 struct berval* query_uuid )
154 Modifications* modlist = NULL;
155 const char* text = NULL;
157 char textbuf[SLAP_TEXT_BUFLEN];
158 size_t textlen = sizeof(textbuf);
160 SlapReply sreply = {REP_RESULT};
162 slap_callback cb = { NULL, slap_null_cb, NULL, NULL };
167 /* add queryid attribute */
168 attr_merge_one( e, ad_queryid, query_uuid, NULL );
170 /* append the attribute list from the fetched entry */
171 e->e_attrs->a_next = attr;
173 op->o_tag = LDAP_REQ_ADD;
174 op->o_protocol = LDAP_VERSION3;
175 op->o_callback = &cb;
176 op->o_time = slap_get_time();
177 op->o_do_not_cache = 1;
180 op->o_req_dn = e->e_name;
181 op->o_req_ndn = e->e_nname;
182 rc = op->o_bd->be_add( op, &sreply );
184 if ( rc != LDAP_SUCCESS ) {
185 if ( rc == LDAP_ALREADY_EXISTS ) {
186 slap_entry2mods( e, &modlist, &text, textbuf, textlen );
187 modlist->sml_op = LDAP_MOD_ADD;
188 op->o_tag = LDAP_REQ_MODIFY;
189 op->orm_modlist = modlist;
190 op->o_bd->be_modify( op, &sreply );
191 slap_mods_free( modlist, 1 );
192 } else if ( rc == LDAP_REFERRAL ||
193 rc == LDAP_NO_SUCH_OBJECT ) {
194 syncrepl_add_glue( op, e );
203 be_entry_release_w( op, e );
210 /* compare base and scope of incoming and cached queries */
211 static int base_scope_compare(
212 struct berval* ndn_stored,
213 struct berval* ndn_incoming,
217 struct berval pdn_incoming = BER_BVNULL;
219 if (scope_stored < scope_incoming)
222 if ( !dnIsSuffix(ndn_incoming, ndn_stored))
225 switch(scope_stored) {
226 case LDAP_SCOPE_BASE:
227 return (ndn_incoming->bv_len == ndn_stored->bv_len);
229 case LDAP_SCOPE_ONELEVEL:
230 switch(scope_incoming){
231 case LDAP_SCOPE_BASE:
232 dnParent(ndn_incoming, &pdn_incoming);
233 return (pdn_incoming.bv_len == ndn_stored->bv_len);
235 case LDAP_SCOPE_ONELEVEL:
236 return (ndn_incoming->bv_len == ndn_stored->bv_len);
241 case LDAP_SCOPE_SUBTREE:
250 /* add query on top of LRU list */
252 add_query_on_top (query_manager* qm, CachedQuery* qc)
254 CachedQuery* top = qm->lru_top;
255 Query* q = (Query*)qc;
266 Debug( LDAP_DEBUG_TRACE, "Base of added query = %s\n",
267 q->base.bv_val, 0, 0 );
270 /* remove_query from LRU list */
273 remove_query (query_manager* qm, CachedQuery* qc)
296 qc->lru_up = qc->lru_down = NULL;
299 /* find and remove string2 from string1
300 * from start if position = 1,
301 * from end if position = 3,
302 * from anywhere if position = 2
303 * string1 is overwritten if position = 2.
307 find_and_remove(struct berval* ber1, struct berval* ber2, int position)
318 if ( ber1->bv_len >= ber2->bv_len && !memcmp( ber1->bv_val,
319 ber2->bv_val, ber2->bv_len )) {
321 ber1->bv_val += ber2->bv_len;
322 ber1->bv_len -= ber2->bv_len;
327 ber1->bv_val[ber1->bv_len] = '\0';
328 temp = strstr( ber1->bv_val, ber2->bv_val );
330 strcpy( temp, temp+ber2->bv_len );
331 ber1->bv_len -= ber2->bv_len;
337 if ( ber1->bv_len >= ber2->bv_len &&
338 !memcmp( ber1->bv_val+ber1->bv_len-ber2->bv_len, ber2->bv_val,
341 ber1->bv_len -= ber2->bv_len;
349 static struct berval*
350 merge_init_final(Operation *op, struct berval* init, struct berval* any,
351 struct berval* final)
353 struct berval* merged, *temp;
354 int i, any_count, count;
356 for (any_count=0; any && any[any_count].bv_val; any_count++)
366 merged = (struct berval*)op->o_tmpalloc( (count+1)*sizeof(struct berval),
371 ber_dupbv_x( temp, init, op->o_tmpmemctx );
375 for (i=0; i<any_count; i++) {
376 ber_dupbv_x( temp, any, op->o_tmpmemctx );
381 ber_dupbv_x( temp, final, op->o_tmpmemctx );
388 /* Each element in stored must be found in incoming. Incoming is overwritten.
391 strings_containment(struct berval* stored, struct berval* incoming)
393 struct berval* element;
397 for ( element=stored; element->bv_val != NULL; element++ ) {
398 for (j = k; incoming[j].bv_val != NULL; j++) {
399 if (find_and_remove(&(incoming[j]), element, 2)) {
416 substr_containment_substr(Operation *op, Filter* stored, Filter* incoming)
421 struct berval init_incoming;
422 struct berval final_incoming;
423 struct berval *remaining_incoming = NULL;
425 if ((!(incoming->f_sub_initial.bv_val) && (stored->f_sub_initial.bv_val))
426 || (!(incoming->f_sub_final.bv_val) && (stored->f_sub_final.bv_val)))
429 init_incoming = incoming->f_sub_initial;
430 final_incoming = incoming->f_sub_final;
432 if (find_and_remove(&init_incoming,
433 &(stored->f_sub_initial), 1) && find_and_remove(&final_incoming,
434 &(stored->f_sub_final), 3))
436 if (stored->f_sub_any == NULL) {
440 remaining_incoming = merge_init_final(op, &init_incoming,
441 incoming->f_sub_any, &final_incoming);
442 rc = strings_containment(stored->f_sub_any, remaining_incoming);
443 ber_bvarray_free_x( remaining_incoming, op->o_tmpmemctx );
450 substr_containment_equality(Operation *op, Filter* stored, Filter* incoming)
452 struct berval incoming_val[2];
455 incoming_val[1] = incoming->f_av_value;
457 if (find_and_remove(incoming_val+1,
458 &(stored->f_sub_initial), 1) && find_and_remove(incoming_val+1,
459 &(stored->f_sub_final), 3)) {
460 if (stored->f_sub_any == NULL){
464 ber_dupbv_x( incoming_val, incoming_val+1, op->o_tmpmemctx );
465 BER_BVZERO( incoming_val+1 );
466 rc = strings_containment(stored->f_sub_any, incoming_val);
467 op->o_tmpfree( incoming_val[0].bv_val, op->o_tmpmemctx );
473 /* check whether query is contained in any of
474 * the cached queries in template template_index
477 query_containment(Operation *op, query_manager *qm,
481 QueryTemplate* templa= qm->templates;
484 Filter* inputf = query->filter;
485 struct berval* base = &(query->base);
486 int scope = query->scope;
493 MatchingRule* mrule = NULL;
494 if (inputf != NULL) {
495 Debug( LDAP_DEBUG_TRACE, "Lock QC index = %d\n",
496 template_index, 0, 0 );
497 ldap_pvt_thread_rdwr_rlock(&(templa[template_index].t_rwlock));
498 for(qc=templa[template_index].query; qc != NULL; qc= qc->next) {
500 if(base_scope_compare(&(q->base), base, q->scope, scope)) {
505 switch (fs->f_choice) {
506 case LDAP_FILTER_EQUALITY:
507 if (fi->f_choice == LDAP_FILTER_EQUALITY)
508 mrule = fs->f_ava->aa_desc->ad_type->sat_equality;
514 mrule = fs->f_ava->aa_desc->ad_type->sat_ordering;
520 rc = value_match(&ret, fs->f_ava->aa_desc, mrule,
521 SLAP_MR_VALUE_OF_ASSERTION_SYNTAX,
522 &(fi->f_ava->aa_value),
523 &(fs->f_ava->aa_value), &text);
524 if (rc != LDAP_SUCCESS) {
525 ldap_pvt_thread_rdwr_runlock(&(templa[template_index].t_rwlock));
526 Debug( LDAP_DEBUG_TRACE,
527 "Unlock: Exiting QC index=%d\n",
528 template_index, 0, 0 );
532 switch (fs->f_choice) {
534 case LDAP_FILTER_AND:
539 case LDAP_FILTER_SUBSTRINGS:
540 /* check if the equality query can be
541 * answered with cached substring query */
542 if ((fi->f_choice == LDAP_FILTER_EQUALITY)
543 && substr_containment_equality( op,
546 /* check if the substring query can be
547 * answered with cached substring query */
548 if ((fi->f_choice ==LDAP_FILTER_SUBSTRINGS
549 ) && substr_containment_substr( op,
555 case LDAP_FILTER_PRESENT:
560 case LDAP_FILTER_EQUALITY:
578 case LDAP_FILTER_NOT:
584 } while((res) && (fi != NULL) && (fs != NULL));
587 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
588 if (qm->lru_top != qc) {
589 remove_query(qm, qc);
590 add_query_on_top(qm, qc);
592 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
597 Debug( LDAP_DEBUG_TRACE,
598 "Not answerable: Unlock QC index=%d\n",
599 template_index, 0, 0 );
600 ldap_pvt_thread_rdwr_runlock(&(templa[template_index].t_rwlock));
606 free_query (CachedQuery* qc)
608 Query* q = (Query*)qc;
611 free(qc->q_uuid.bv_val);
612 filter_free(q->filter);
613 free (q->base.bv_val);
619 /* Add query to query cache */
620 static void add_query(
626 CachedQuery* new_cached_query = (CachedQuery*) ch_malloc(sizeof(CachedQuery));
627 QueryTemplate* templ = (qm->templates)+template_index;
629 new_cached_query->template_id = template_index;
630 new_cached_query->q_uuid = *uuid;
631 new_cached_query->lru_up = NULL;
632 new_cached_query->lru_down = NULL;
633 new_cached_query->expiry_time = slap_get_time() + templ->ttl;
634 Debug( LDAP_DEBUG_TRACE, "Added query expires at %ld\n",
635 (long) new_cached_query->expiry_time, 0, 0 );
636 new_query = (Query*)new_cached_query;
638 ber_dupbv(&new_query->base, &query->base);
639 new_query->scope = query->scope;
640 new_query->filter = query->filter;
641 new_query->attrs = query->attrs;
644 Debug( LDAP_DEBUG_TRACE, "Lock AQ index = %d\n",
645 template_index, 0, 0 );
646 ldap_pvt_thread_rdwr_wlock(&templ->t_rwlock);
647 if (templ->query == NULL)
648 templ->query_last = new_cached_query;
650 templ->query->prev = new_cached_query;
651 new_cached_query->next = templ->query;
652 new_cached_query->prev = NULL;
653 templ->query = new_cached_query;
654 templ->no_of_queries++;
655 Debug( LDAP_DEBUG_TRACE, "TEMPLATE %d QUERIES++ %d\n",
656 template_index, templ->no_of_queries, 0 );
658 Debug( LDAP_DEBUG_TRACE, "Unlock AQ index = %d \n",
659 template_index, 0, 0 );
660 ldap_pvt_thread_rdwr_wunlock(&templ->t_rwlock);
662 /* Adding on top of LRU list */
663 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
664 add_query_on_top(qm, new_cached_query);
665 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
669 remove_from_template (CachedQuery* qc, QueryTemplate* template)
671 if (!qc->prev && !qc->next) {
672 template->query_last = template->query = NULL;
673 } else if (qc->prev == NULL) {
674 qc->next->prev = NULL;
675 template->query = qc->next;
676 } else if (qc->next == NULL) {
677 qc->prev->next = NULL;
678 template->query_last = qc->prev;
680 qc->next->prev = qc->prev;
681 qc->prev->next = qc->next;
684 template->no_of_queries--;
687 /* remove bottom query of LRU list from the query cache */
688 static void cache_replacement(query_manager* qm, struct berval *result)
693 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
694 bottom = qm->lru_bottom;
696 result->bv_val = NULL;
700 Debug ( LDAP_DEBUG_TRACE,
701 "Cache replacement invoked without "
702 "any query in LRU list\n", 0, 0, 0 );
703 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
707 temp_id = bottom->template_id;
708 remove_query(qm, bottom);
709 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
711 *result = bottom->q_uuid;
712 bottom->q_uuid.bv_val = NULL;
714 Debug( LDAP_DEBUG_TRACE, "Lock CR index = %d\n", temp_id, 0, 0 );
715 ldap_pvt_thread_rdwr_wlock(&(qm->templates[temp_id].t_rwlock));
716 remove_from_template(bottom, (qm->templates+temp_id));
717 Debug( LDAP_DEBUG_TRACE, "TEMPLATE %d QUERIES-- %d\n",
718 temp_id, qm->templates[temp_id].no_of_queries, 0 );
719 Debug( LDAP_DEBUG_TRACE, "Unlock CR index = %d\n", temp_id, 0, 0 );
720 ldap_pvt_thread_rdwr_wunlock(&(qm->templates[temp_id].t_rwlock));
725 struct query_info *next;
737 struct query_info *qi;
740 if ( rs->sr_type != REP_SEARCH ) return 0;
742 for (attr = rs->sr_entry->e_attrs; attr!= NULL; attr = attr->a_next) {
743 if (attr->a_desc == ad_queryid) {
744 for (count=0; attr->a_vals[count].bv_val; count++)
749 if ( count == 0 ) return 0;
750 qi = op->o_tmpalloc( sizeof( struct query_info ), op->o_tmpmemctx );
751 qi->next = op->o_callback->sc_private;
752 op->o_callback->sc_private = qi;
753 ber_dupbv_x( &qi->xdn, &rs->sr_entry->e_nname, op->o_tmpmemctx );
754 qi->del = ( count == 1 );
763 struct berval* query_uuid)
765 struct query_info *qi, *qnext;
767 #ifdef LDAP_COMP_MATCH
768 AttributeAssertion ava = { NULL, BER_BVNULL, NULL };
770 AttributeAssertion ava = { NULL, BER_BVNULL };
772 Filter filter = {LDAP_FILTER_EQUALITY};
773 SlapReply sreply = {REP_RESULT};
774 slap_callback cb = { NULL, remove_func, NULL, NULL };
777 sreply.sr_entry = NULL;
778 sreply.sr_nentries = 0;
779 op->ors_filterstr.bv_len = snprintf(filter_str, sizeof(filter_str),
780 "(%s=%s)", ad_queryid->ad_cname.bv_val, query_uuid->bv_val);
782 filter.f_av_desc = ad_queryid;
783 filter.f_av_value = *query_uuid;
785 op->o_tag = LDAP_REQ_SEARCH;
786 op->o_protocol = LDAP_VERSION3;
787 op->o_callback = &cb;
788 op->o_time = slap_get_time();
789 op->o_do_not_cache = 1;
791 op->o_req_dn = op->o_bd->be_suffix[0];
792 op->o_req_ndn = op->o_bd->be_nsuffix[0];
793 op->ors_scope = LDAP_SCOPE_SUBTREE;
794 op->ors_deref = LDAP_DEREF_NEVER;
795 op->ors_slimit = SLAP_NO_LIMIT;
796 op->ors_tlimit = SLAP_NO_LIMIT;
797 op->ors_filter = &filter;
798 op->ors_filterstr.bv_val = filter_str;
799 op->ors_filterstr.bv_len = strlen(filter_str);
800 op->ors_attrs = NULL;
801 op->ors_attrsonly = 0;
803 op->o_bd->be_search( op, &sreply );
805 for ( qi=cb.sc_private; qi; qi=qnext ) {
808 op->o_req_dn = qi->xdn;
809 op->o_req_ndn = qi->xdn;
812 Debug( LDAP_DEBUG_TRACE, "DELETING ENTRY TEMPLATE=%s\n",
813 query_uuid->bv_val, 0, 0 );
815 op->o_tag = LDAP_REQ_DELETE;
817 if (op->o_bd->be_delete(op, &sreply) == LDAP_SUCCESS) {
822 struct berval vals[2];
824 vals[0] = *query_uuid;
825 vals[1].bv_val = NULL;
827 mod.sml_op = LDAP_MOD_DELETE;
829 mod.sml_desc = ad_queryid;
830 mod.sml_type = ad_queryid->ad_cname;
831 mod.sml_values = vals;
832 mod.sml_nvalues = NULL;
834 Debug( LDAP_DEBUG_TRACE,
835 "REMOVING TEMP ATTR : TEMPLATE=%s\n",
836 query_uuid->bv_val, 0, 0 );
838 op->orm_modlist = &mod;
840 op->o_bd->be_modify( op, &sreply );
842 op->o_tmpfree( qi->xdn.bv_val, op->o_tmpmemctx );
843 op->o_tmpfree( qi, op->o_tmpmemctx );
850 AttributeName* attrs,
860 AttributeName** filter_attrs,
864 AttributeDescription *ad;
866 switch ( f->f_choice ) {
867 case LDAP_FILTER_EQUALITY:
869 sprintf( fstr->bv_val+fstr->bv_len, "(%s=)", ad->ad_cname.bv_val );
870 fstr->bv_len += ad->ad_cname.bv_len + ( sizeof("(=)") - 1 );
875 sprintf( fstr->bv_val+fstr->bv_len, "(%s>=)", ad->ad_cname.bv_val);
876 fstr->bv_len += ad->ad_cname.bv_len + ( sizeof("(>=)") - 1 );
881 sprintf( fstr->bv_val+fstr->bv_len, "(%s<=)", ad->ad_cname.bv_val);
882 fstr->bv_len += ad->ad_cname.bv_len + ( sizeof("(<=)") - 1 );
885 case LDAP_FILTER_APPROX:
887 sprintf( fstr->bv_val+fstr->bv_len, "(%s~=)", ad->ad_cname.bv_val);
888 fstr->bv_len += ad->ad_cname.bv_len + ( sizeof("(~=)") - 1 );
891 case LDAP_FILTER_SUBSTRINGS:
893 sprintf( fstr->bv_val+fstr->bv_len, "(%s=)", ad->ad_cname.bv_val );
894 fstr->bv_len += ad->ad_cname.bv_len + ( sizeof("(=)") - 1 );
897 case LDAP_FILTER_PRESENT:
899 sprintf( fstr->bv_val+fstr->bv_len, "(%s=*)", ad->ad_cname.bv_val );
900 fstr->bv_len += ad->ad_cname.bv_len + ( sizeof("(=*)") - 1 );
903 case LDAP_FILTER_AND:
905 case LDAP_FILTER_NOT: {
907 sprintf( fstr->bv_val+fstr->bv_len, "(%c",
908 f->f_choice == LDAP_FILTER_AND ? '&' :
909 f->f_choice == LDAP_FILTER_OR ? '|' : '!' );
910 fstr->bv_len += sizeof("(%") - 1;
912 for ( f = f->f_list; f != NULL; f = f->f_next ) {
913 rc = filter2template( op, f, fstr, filter_attrs, filter_cnt,
917 sprintf( fstr->bv_val+fstr->bv_len, ")" );
918 fstr->bv_len += sizeof(")") - 1;
924 strcpy( fstr->bv_val, "(?=?)" );
925 fstr->bv_len += sizeof("(?=?)")-1;
929 *filter_attrs = (AttributeName *)op->o_tmprealloc(*filter_attrs,
930 (*filter_cnt + 2)*sizeof(AttributeName), op->o_tmpmemctx);
932 (*filter_attrs)[*filter_cnt].an_desc = ad;
933 (*filter_attrs)[*filter_cnt].an_name = ad->ad_cname;
934 (*filter_attrs)[*filter_cnt].an_oc = NULL;
935 (*filter_attrs)[*filter_cnt].an_oc_exclude = 0;
936 BER_BVZERO( &(*filter_attrs)[*filter_cnt+1].an_name );
938 if ( ad == slap_schema.si_ad_objectClass )
957 struct berval *query_uuid)
959 struct search_info *si = op->o_callback->sc_private;
960 slap_overinst *on = si->on;
961 cache_manager *cm = on->on_bi.bi_private;
962 query_manager* qm = cm->qm;
965 struct berval crp_uuid;
966 char uuidbuf[ LDAP_LUTIL_UUIDSTR_BUFSIZE ];
967 Operation op_tmp = *op;
969 query_uuid->bv_len = lutil_uuidstr(uuidbuf, sizeof(uuidbuf));
970 ber_str2bv(uuidbuf, query_uuid->bv_len, 1, query_uuid);
972 op_tmp.o_bd = &cm->db;
973 op_tmp.o_dn = cm->db.be_rootdn;
974 op_tmp.o_ndn = cm->db.be_rootndn;
976 Debug( LDAP_DEBUG_TRACE, "UUID for query being added = %s\n",
979 for ( e=si->head; e; e=si->head ) {
980 si->head = e->e_private;
982 Debug( LDAP_DEBUG_NONE, "LOCKING REMOVE MUTEX\n", 0, 0, 0 );
983 ldap_pvt_thread_mutex_lock(&cm->remove_mutex);
984 Debug( LDAP_DEBUG_NONE, "LOCKED REMOVE MUTEX\n", 0, 0, 0);
985 while ( cm->cur_entries > (cm->max_entries) ) {
986 qm->crfunc(qm, &crp_uuid);
987 if (crp_uuid.bv_val) {
988 Debug( LDAP_DEBUG_TRACE,
989 "Removing query UUID %s\n",
990 crp_uuid.bv_val, 0, 0 );
991 return_val = remove_query_data(&op_tmp, rs, &crp_uuid);
992 Debug( LDAP_DEBUG_TRACE,
993 "QUERY REMOVED, SIZE=%d\n",
995 ldap_pvt_thread_mutex_lock(
997 cm->cur_entries -= return_val;
998 cm->num_cached_queries--;
999 Debug( LDAP_DEBUG_TRACE,
1000 "STORED QUERIES = %lu\n",
1001 cm->num_cached_queries, 0, 0 );
1002 ldap_pvt_thread_mutex_unlock(
1004 Debug( LDAP_DEBUG_TRACE,
1005 "QUERY REMOVED, CACHE ="
1007 cm->cur_entries, 0, 0 );
1011 return_val = merge_entry(&op_tmp, e, query_uuid);
1012 ldap_pvt_thread_mutex_unlock(&cm->remove_mutex);
1013 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
1014 cm->cur_entries += return_val;
1015 Debug( LDAP_DEBUG_TRACE,
1016 "ENTRY ADDED/MERGED, CACHED ENTRIES=%d\n",
1017 cm->cur_entries, 0, 0 );
1019 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
1021 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
1022 cm->num_cached_queries++;
1023 Debug( LDAP_DEBUG_TRACE, "STORED QUERIES = %lu\n",
1024 cm->num_cached_queries, 0, 0 );
1025 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
1035 struct search_info *si = op->o_callback->sc_private;
1036 slap_overinst *on = si->on;
1037 cache_manager *cm = on->on_bi.bi_private;
1038 query_manager* qm = cm->qm;
1041 if ( rs->sr_type == REP_SEARCH ) {
1043 /* If we haven't exceeded the limit for this query,
1044 * build a chain of answers to store. If we hit the
1045 * limit, empty the chain and ignore the rest.
1048 if ( si->count < si->max ) {
1050 e = entry_dup( rs->sr_entry );
1051 if ( !si->head ) si->head = e;
1052 if ( si->tail ) si->tail->e_private = e;
1057 for (;si->head; si->head=e) {
1058 e = si->head->e_private;
1059 si->head->e_private = NULL;
1060 entry_free(si->head);
1065 if ( si->query.save_attrs != NULL ) {
1066 rs->sr_attrs = si->query.save_attrs;
1067 op->ors_attrs = si->query.save_attrs;
1068 si->query.save_attrs = NULL;
1071 } else if ( rs->sr_type == REP_RESULT ) {
1072 if ( si->count && cache_entries( op, rs, &uuid ) == 0 ) {
1073 qm->addfunc(qm, &si->query, si->template_id, &uuid);
1074 /* If the consistency checker suspended itself,
1077 if ( cm->cc_paused ) {
1078 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
1079 if ( cm->cc_paused ) {
1081 ldap_pvt_runqueue_resched( &slapd_rq, cm->cc_arg, 0 );
1083 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
1086 free( si->query.attrs );
1087 filter_free( si->query.filter );
1091 op->o_callback->sc_cleanup = slap_freeself_cb;
1093 return SLAP_CB_CONTINUE;
1099 AttributeName** new_attrs,
1100 struct attr_set *attrs,
1101 AttributeName* filter_attrs,
1111 /* duplicate attrs */
1112 count = attrs->count + fattr_cnt;
1113 if ( !fattr_got_oc && !(attrs->flags & PC_GOT_OC)) {
1118 *new_attrs = (AttributeName*)ch_malloc((count+1)*
1119 sizeof(AttributeName));
1120 for (i=0; i<attrs->count; i++) {
1121 (*new_attrs)[i].an_name = attrs->attrs[i].an_name;
1122 (*new_attrs)[i].an_desc = attrs->attrs[i].an_desc;
1124 BER_BVZERO( &(*new_attrs)[i].an_name );
1125 alluser = an_find(*new_attrs, &AllUser);
1126 allop = an_find(*new_attrs, &AllOper);
1129 for ( i=0; i<fattr_cnt; i++ ) {
1130 if ( an_find(*new_attrs, &filter_attrs[i].an_name ))
1132 if ( is_at_operational(filter_attrs[i].an_desc->ad_type) ) {
1137 (*new_attrs)[j].an_name = filter_attrs[i].an_name;
1138 (*new_attrs)[j].an_desc = filter_attrs[i].an_desc;
1139 (*new_attrs)[j].an_oc = NULL;
1140 (*new_attrs)[j].an_oc_exclude = 0;
1144 (*new_attrs)[j].an_name = slap_schema.si_ad_objectClass->ad_cname;
1145 (*new_attrs)[j].an_desc = slap_schema.si_ad_objectClass;
1146 (*new_attrs)[j].an_oc = NULL;
1147 (*new_attrs)[j].an_oc_exclude = 0;
1150 BER_BVZERO( &(*new_attrs)[j].an_name );
1153 /* NOTE: this is a quick workaround to let pcache minimally interact
1154 * with pagedResults. A more articulated solutions would be to
1155 * perform the remote query without control and cache all results,
1156 * performing the pagedResults search only within the client
1157 * and the proxy. This requires pcache to understand pagedResults. */
1159 pcache_chk_controls(
1163 const char *non = "";
1164 const char *stripped = "";
1166 switch( op->o_pagedresults ) {
1167 case SLAP_CONTROL_NONCRITICAL:
1169 stripped = "; stripped";
1172 case SLAP_CONTROL_CRITICAL:
1173 Debug( LDAP_DEBUG_TRACE, "%s: "
1174 "%scritical pagedResults control "
1175 "disabled with proxy cache%s.\n",
1176 op->o_log_prefix, non, stripped );
1178 slap_remove_control( op, rs, slap_cids.sc_pagedResults, NULL );
1182 rs->sr_err = SLAP_CB_CONTINUE;
1194 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
1195 cache_manager *cm = on->on_bi.bi_private;
1196 query_manager* qm = cm->qm;
1202 AttributeName *filter_attrs = NULL;
1207 int template_id = -1;
1211 int fattr_got_oc = 0;
1212 int oc_attr_absent = 1;
1214 struct berval tempstr;
1216 tempstr.bv_val = op->o_tmpalloc( op->ors_filterstr.bv_len+1, op->o_tmpmemctx );
1218 if ( filter2template( op, op->ors_filter, &tempstr, &filter_attrs,
1219 &fattr_cnt, &fattr_got_oc )) {
1220 op->o_tmpfree( tempstr.bv_val, op->o_tmpmemctx );
1221 return SLAP_CB_CONTINUE;
1224 Debug( LDAP_DEBUG_TRACE, "query template of incoming query = %s\n",
1225 tempstr.bv_val, 0, 0 );
1227 /* FIXME: cannot cache/answer requests with pagedResults control */
1231 attr_set = get_attr_set(op->ors_attrs, qm, cm->numattrsets);
1233 query.filter = op->ors_filter;
1234 query.attrs = op->ors_attrs;
1235 query.save_attrs = NULL;
1236 query.base = op->o_req_ndn;
1237 query.scope = op->ors_scope;
1239 /* check for query containment */
1240 if (attr_set > -1) {
1241 QueryTemplate *qt = qm->templates;
1242 for (i=0; i<cm->numtemplates; i++, qt++) {
1243 /* find if template i can potentially answer tempstr */
1244 if ( qt->attr_set_index != attr_set ||
1245 qt->querystr.bv_len != tempstr.bv_len ||
1246 strcasecmp( qt->querystr.bv_val, tempstr.bv_val ))
1250 Debug( LDAP_DEBUG_NONE, "Entering QC, querystr = %s\n",
1251 op->ors_filterstr.bv_val, 0, 0 );
1252 answerable = (*(qm->qcfunc))(op, qm, &query, i);
1258 op->o_tmpfree( tempstr.bv_val, op->o_tmpmemctx );
1260 query.save_attrs = op->ors_attrs;
1264 /* Need to clear the callbacks of the original operation,
1265 * in case there are other overlays */
1266 BackendDB *save_bd = op->o_bd;
1267 slap_callback *save_cb = op->o_callback;
1269 Debug( LDAP_DEBUG_TRACE, "QUERY ANSWERABLE\n", 0, 0, 0 );
1270 op->o_tmpfree( filter_attrs, op->o_tmpmemctx );
1271 ldap_pvt_thread_rdwr_runlock(&qm->templates[i].t_rwlock);
1273 op->o_callback = NULL;
1274 i = cm->db.bd_info->bi_op_search( op, rs );
1276 op->o_callback = save_cb;
1280 Debug( LDAP_DEBUG_TRACE, "QUERY NOT ANSWERABLE\n", 0, 0, 0 );
1282 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
1283 if (cm->num_cached_queries >= cm->max_queries) {
1286 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
1290 struct search_info *si;
1292 Debug( LDAP_DEBUG_TRACE, "QUERY CACHEABLE\n", 0, 0, 0 );
1293 query.filter = str2filter(op->ors_filterstr.bv_val);
1294 add_filter_attrs(op, &query.attrs, &qm->attr_sets[attr_set],
1295 filter_attrs, fattr_cnt, fattr_got_oc);
1297 op->ors_attrs = query.attrs;
1299 cb = op->o_tmpalloc( sizeof(*cb) + sizeof(*si), op->o_tmpmemctx);
1300 cb->sc_response = pcache_response;
1301 cb->sc_cleanup = NULL;
1302 cb->sc_private = (cb+1);
1303 si = cb->sc_private;
1306 si->template_id = template_id;
1307 si->max = cm->num_entries_limit ;
1313 if ( cm->response_cb == PCACHE_RESPONSE_CB_HEAD ) {
1314 cb->sc_next = op->o_callback;
1315 op->o_callback = cb;
1318 slap_callback **pcb;
1320 /* need to move the callback at the end, in case other
1321 * overlays are present, so that the final entry is
1322 * actually cached */
1324 for ( pcb = &op->o_callback; *pcb; pcb = &(*pcb)->sc_next );
1329 Debug( LDAP_DEBUG_TRACE, "QUERY NOT CACHEABLE\n",
1333 op->o_tmpfree( filter_attrs, op->o_tmpmemctx );
1335 return SLAP_CB_CONTINUE;
1340 AttributeName* attrs,
1348 for ( ; attrs[count].an_name.bv_val; count++ );
1351 for (i=0; i<num; i++) {
1355 if ( count > qm->attr_sets[i].count )
1358 if ( !qm->attr_sets[i].count )
1362 for ( a2 = attrs; a2->an_name.bv_val; a2++ ) {
1363 if ( !an_find( qm->attr_sets[i].attrs, &a2->an_name )) {
1381 struct re_s *rtask = arg;
1382 slap_overinst *on = rtask->arg;
1383 cache_manager *cm = on->on_bi.bi_private;
1384 query_manager *qm = cm->qm;
1385 Connection conn = {0};
1386 OperationBuffer opbuf;
1389 SlapReply rs = {REP_RESULT};
1390 CachedQuery* query, *query_prev;
1391 int i, return_val, pause = 1;
1392 QueryTemplate* templ;
1394 op = (Operation *) &opbuf;
1395 connection_fake_init( &conn, op, ctx );
1398 op->o_dn = cm->db.be_rootdn;
1399 op->o_ndn = cm->db.be_rootndn;
1403 for (i=0; qm->templates[i].querystr.bv_val; i++) {
1404 templ = qm->templates + i;
1405 query = templ->query_last;
1406 if ( query ) pause = 0;
1407 op->o_time = slap_get_time();
1408 ldap_pvt_thread_mutex_lock(&cm->remove_mutex);
1409 while (query && (query->expiry_time < op->o_time)) {
1410 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
1411 remove_query(qm, query);
1412 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1413 Debug( LDAP_DEBUG_TRACE, "Lock CR index = %d\n",
1415 ldap_pvt_thread_rdwr_wlock(&templ->t_rwlock);
1416 remove_from_template(query, templ);
1417 Debug( LDAP_DEBUG_TRACE, "TEMPLATE %d QUERIES-- %d\n",
1418 i, templ->no_of_queries, 0 );
1419 Debug( LDAP_DEBUG_TRACE, "Unlock CR index = %d\n",
1421 ldap_pvt_thread_rdwr_wunlock(&templ->t_rwlock);
1422 return_val = remove_query_data(op, &rs, &query->q_uuid);
1423 Debug( LDAP_DEBUG_TRACE, "STALE QUERY REMOVED, SIZE=%d\n",
1425 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
1426 cm->cur_entries -= return_val;
1427 cm->num_cached_queries--;
1428 Debug( LDAP_DEBUG_TRACE, "STORED QUERIES = %lu\n",
1429 cm->num_cached_queries, 0, 0 );
1430 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
1431 Debug( LDAP_DEBUG_TRACE,
1432 "STALE QUERY REMOVED, CACHE ="
1434 cm->cur_entries, 0, 0 );
1436 query = query->prev;
1437 free_query(query_prev);
1439 ldap_pvt_thread_mutex_unlock(&cm->remove_mutex);
1441 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
1442 if ( ldap_pvt_runqueue_isrunning( &slapd_rq, rtask )) {
1443 ldap_pvt_runqueue_stoptask( &slapd_rq, rtask );
1445 /* If there were no queries, defer processing for a while */
1446 cm->cc_paused = pause;
1447 ldap_pvt_runqueue_resched( &slapd_rq, rtask, pause );
1449 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
1454 #define MAX_ATTR_SETS 500
1463 static ConfigDriver pc_cf_gen;
1464 static ConfigLDAPadd pc_ldadd;
1465 static ConfigCfAdd pc_cfadd;
1467 static ConfigTable pccfg[] = {
1468 { "proxycache", "backend> <max_entries> <numattrsets> <entry limit> "
1470 6, 6, 0, ARG_MAGIC|ARG_NO_DELETE|PC_MAIN, pc_cf_gen,
1471 "( OLcfgOvAt:2.1 NAME 'olcProxyCache' "
1472 "DESC 'ProxyCache basic parameters' "
1473 "SYNTAX OMsDirectoryString SINGLE-VALUE )", NULL, NULL },
1474 { "proxyattrset", "index> <attributes...",
1475 2, 0, 0, ARG_MAGIC|PC_ATTR, pc_cf_gen,
1476 "( OLcfgOvAt:2.2 NAME 'olcProxyAttrset' "
1477 "DESC 'A set of attributes to cache' "
1478 "SYNTAX OMsDirectoryString )", NULL, NULL },
1479 { "proxytemplate", "filter> <attrset-index> <TTL",
1480 4, 4, 0, ARG_MAGIC|PC_TEMP, pc_cf_gen,
1481 "( OLcfgOvAt:2.3 NAME 'olcProxyTemplate' "
1482 "DESC 'Filter template, attrset, and cache TTL' "
1483 "SYNTAX OMsDirectoryString )", NULL, NULL },
1484 { "response-callback", "head|tail(default)",
1485 2, 2, 0, ARG_MAGIC|PC_RESP, pc_cf_gen,
1486 "( OLcfgOvAt:2.4 NAME 'olcProxyResponseCB' "
1487 "DESC 'Response callback position in overlay stack' "
1488 "SYNTAX OMsDirectoryString )", NULL, NULL },
1489 { NULL, NULL, 0, 0, 0, ARG_IGNORED }
1492 static ConfigOCs pcocs[] = {
1493 { "( OLcfgOvOc:2.1 "
1494 "NAME 'olcPcacheConfig' "
1495 "DESC 'ProxyCache configuration' "
1496 "SUP olcOverlayConfig "
1497 "MUST ( olcProxyCache $ olcProxyAttrset $ olcProxyTemplate ) "
1498 "MAY olcProxyResponseCB )", Cft_Overlay, pccfg, NULL, pc_cfadd },
1499 { "( OLcfgOvOc:2.2 "
1500 "NAME 'olcPcacheDatabase' "
1501 "DESC 'Cache database configuration' "
1502 "AUXILIARY )", Cft_Misc, pccfg, pc_ldadd },
1507 pc_ldadd( CfEntryInfo *p, Entry *e, ConfigArgs *ca )
1512 if ( p->ce_type != Cft_Overlay || !p->ce_bi ||
1513 p->ce_bi->bi_cf_ocs != pcocs )
1514 return LDAP_CONSTRAINT_VIOLATION;
1516 on = (slap_overinst *)p->ce_bi;
1517 cm = on->on_bi.bi_private;
1519 return LDAP_SUCCESS;
1523 pc_cfadd( Operation *op, SlapReply *rs, Entry *p, ConfigArgs *ca )
1525 CfEntryInfo *pe = p->e_private;
1526 slap_overinst *on = (slap_overinst *)pe->ce_bi;
1527 cache_manager *cm = on->on_bi.bi_private;
1530 /* FIXME: should not hardcode "olcDatabase" here */
1531 bv.bv_len = sprintf( ca->msg, "olcDatabase=%s", cm->db.bd_info->bi_type );
1532 bv.bv_val = ca->msg;
1535 /* We can only create this entry if the database is table-driven
1537 if ( cm->db.bd_info->bi_cf_ocs )
1538 config_build_entry( op, rs, pe, ca, &bv, cm->db.bd_info->bi_cf_ocs,
1545 pc_cf_gen( ConfigArgs *c )
1547 slap_overinst *on = (slap_overinst *)c->bi;
1548 cache_manager* cm = on->on_bi.bi_private;
1549 query_manager* qm = cm->qm;
1550 QueryTemplate* temp;
1551 AttributeName* attr_name;
1552 AttributeName* attrarray;
1553 const char* text=NULL;
1558 if ( c->op == SLAP_CONFIG_EMIT ) {
1562 bv.bv_len = snprintf( c->msg, sizeof( c->msg ), "%s %d %d %d %ld",
1563 cm->db.bd_info->bi_type, cm->max_entries, cm->numattrsets,
1564 cm->num_entries_limit, cm->cc_period );
1566 value_add_one( &c->rvalue_vals, &bv );
1569 for (i=0; i<cm->numattrsets; i++) {
1570 if ( !qm->attr_sets[i].count ) continue;
1572 bv.bv_len = snprintf( c->msg, sizeof( c->msg ), "%d", i );
1574 /* count the attr length */
1575 for ( attr_name = qm->attr_sets[i].attrs;
1576 attr_name->an_name.bv_val; attr_name++ )
1577 bv.bv_len += attr_name->an_name.bv_len + 1;
1579 bv.bv_val = ch_malloc( bv.bv_len+1 );
1580 ptr = lutil_strcopy( bv.bv_val, c->msg );
1581 for ( attr_name = qm->attr_sets[i].attrs;
1582 attr_name->an_name.bv_val; attr_name++ ) {
1584 ptr = lutil_strcopy( ptr, attr_name->an_name.bv_val );
1586 ber_bvarray_add( &c->rvalue_vals, &bv );
1588 if ( !c->rvalue_vals )
1592 for (i=0; i<cm->numtemplates; i++) {
1593 bv.bv_len = snprintf( c->msg, sizeof( c->msg ), " %d %ld",
1594 qm->templates[i].attr_set_index,
1595 qm->templates[i].ttl );
1596 bv.bv_len += qm->templates[i].querystr.bv_len + 2;
1597 bv.bv_val = ch_malloc( bv.bv_len+1 );
1600 ptr = lutil_strcopy( ptr, qm->templates[i].querystr.bv_val );
1602 strcpy( ptr, c->msg );
1603 ber_bvarray_add( &c->rvalue_vals, &bv );
1605 if ( !c->rvalue_vals )
1609 if ( cm->response_cb == PCACHE_RESPONSE_CB_HEAD ) {
1610 BER_BVSTR( &bv, "head" );
1612 BER_BVSTR( &bv, "tail" );
1614 value_add_one( &c->rvalue_vals, &bv );
1618 } else if ( c->op == LDAP_MOD_DELETE ) {
1619 return 1; /* FIXME */
1631 if ( cm->numattrsets > 0 ) {
1632 snprintf( c->msg, sizeof( c->msg ), "\"proxycache\" directive already provided" );
1633 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->msg, 0 );
1637 if ( lutil_atoi( &cm->numattrsets, c->argv[3] ) != 0 ) {
1638 snprintf( c->msg, sizeof( c->msg ), "unable to parse num attrsets=\"%s\" (arg #3)",
1640 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->msg, 0 );
1643 if ( cm->numattrsets <= 0 ) {
1644 snprintf( c->msg, sizeof( c->msg ), "numattrsets (arg #3) must be positive" );
1645 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->msg, 0 );
1648 if ( cm->numattrsets > MAX_ATTR_SETS ) {
1649 snprintf( c->msg, sizeof( c->msg ), "numattrsets (arg #3) must be <= %d", MAX_ATTR_SETS );
1650 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->msg, 0 );
1654 if ( !backend_db_init( c->argv[1], &cm->db )) {
1655 snprintf( c->msg, sizeof( c->msg ), "unknown backend type (arg #1)" );
1656 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->msg, 0 );
1660 if ( lutil_atoi( &cm->max_entries, c->argv[2] ) != 0 ) {
1661 snprintf( c->msg, sizeof( c->msg ), "unable to parse max entries=\"%s\" (arg #2)",
1663 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->msg, 0 );
1666 if ( cm->max_entries <= 0 ) {
1667 snprintf( c->msg, sizeof( c->msg ), "max entries (arg #2) must be positive.\n" );
1668 Debug( LDAP_DEBUG_CONFIG, "%s: %s\n", c->log, c->msg, 0 );
1672 if ( lutil_atoi( &cm->num_entries_limit, c->argv[4] ) != 0 ) {
1673 snprintf( c->msg, sizeof( c->msg ), "unable to parse entry limit=\"%s\" (arg #4)",
1675 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->msg, 0 );
1678 if ( cm->num_entries_limit <= 0 ) {
1679 snprintf( c->msg, sizeof( c->msg ), "entry limit (arg #4) must be positive" );
1680 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->msg, 0 );
1683 if ( cm->num_entries_limit > cm->max_entries ) {
1684 snprintf( c->msg, sizeof( c->msg ), "entry limit (arg #4) must be less than max entries %d (arg #2)", cm->max_entries );
1685 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->msg, 0 );
1689 if ( lutil_parse_time( c->argv[5], &t ) != 0 ) {
1690 snprintf( c->msg, sizeof( c->msg ), "unable to parse period=\"%s\" (arg #5)",
1692 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->msg, 0 );
1695 cm->cc_period = (time_t)t;
1696 Debug( LDAP_DEBUG_TRACE,
1697 "Total # of attribute sets to be cached = %d.\n",
1698 cm->numattrsets, 0, 0 );
1699 qm->attr_sets = ( struct attr_set * )ch_calloc( cm->numattrsets,
1700 sizeof( struct attr_set ) );
1703 if ( cm->numattrsets == 0 ) {
1704 snprintf( c->msg, sizeof( c->msg ), "\"proxycache\" directive not provided yet" );
1705 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->msg, 0 );
1708 if ( lutil_atoi( &num, c->argv[1] ) != 0 ) {
1709 snprintf( c->msg, sizeof( c->msg ), "unable to parse attrset #=\"%s\"",
1711 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->msg, 0 );
1715 if ( num < 0 || num >= cm->numattrsets ) {
1716 snprintf( c->msg, sizeof( c->msg ), "attrset index %d out of bounds (must be %s%d)",
1717 num, cm->numattrsets > 1 ? "0->" : "", cm->numattrsets - 1 );
1718 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->msg, 0 );
1721 qm->attr_sets[num].flags |= PC_CONFIGURED;
1722 if ( c->argc > 2 && strcmp( c->argv[2], "*" ) ) {
1723 qm->attr_sets[num].count = c->argc - 2;
1724 qm->attr_sets[num].attrs = (AttributeName*)ch_malloc(
1725 (c->argc-1) * sizeof( AttributeName ));
1726 attr_name = qm->attr_sets[num].attrs;
1727 for ( i = 2; i < c->argc; i++ ) {
1728 attr_name->an_desc = NULL;
1729 if ( slap_str2ad( c->argv[i],
1730 &attr_name->an_desc, &text ) )
1732 strcpy( c->msg, text );
1733 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->msg, 0 );
1734 ch_free( qm->attr_sets[num].attrs );
1735 qm->attr_sets[num].attrs = NULL;
1736 qm->attr_sets[num].count = 0;
1739 attr_name->an_name = attr_name->an_desc->ad_cname;
1740 attr_name->an_oc = NULL;
1741 attr_name->an_oc_exclude = 0;
1742 if ( attr_name->an_desc == slap_schema.si_ad_objectClass )
1743 qm->attr_sets[num].flags |= PC_GOT_OC;
1745 BER_BVZERO( &attr_name->an_name );
1750 if ( cm->numattrsets == 0 ) {
1751 snprintf( c->msg, sizeof( c->msg ), "\"proxycache\" directive not provided yet" );
1752 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->msg, 0 );
1755 if ( lutil_atoi( &i, c->argv[2] ) != 0 ) {
1756 snprintf( c->msg, sizeof( c->msg ), "unable to parse template #=\"%s\"",
1758 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->msg, 0 );
1762 if ( i < 0 || i >= cm->numattrsets ) {
1763 snprintf( c->msg, sizeof( c->msg ), "template index %d invalid (%s%d)",
1764 i, cm->numattrsets > 1 ? "0->" : "", cm->numattrsets - 1 );
1765 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->msg, 0 );
1768 num = cm->numtemplates;
1769 qm->templates = ( QueryTemplate* )ch_realloc( qm->templates,
1770 ( num + 2 ) * sizeof( QueryTemplate ));
1771 temp = qm->templates + num;
1772 ldap_pvt_thread_rdwr_init( &temp->t_rwlock );
1773 temp->query = temp->query_last = NULL;
1774 if ( lutil_parse_time( c->argv[3], &t ) != 0 ) {
1775 snprintf( c->msg, sizeof( c->msg ), "unable to parse template ttl=\"%s\"",
1777 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->msg, 0 );
1780 temp->ttl = (time_t)t;
1782 temp->no_of_queries = 0;
1784 ber_str2bv( c->argv[1], 0, 1, &temp->querystr );
1785 Debug( LDAP_DEBUG_TRACE, "Template:\n", 0, 0, 0 );
1786 Debug( LDAP_DEBUG_TRACE, " query template: %s\n",
1787 temp->querystr.bv_val, 0, 0 );
1788 temp->attr_set_index = i;
1789 qm->attr_sets[i].flags |= PC_REFERENCED;
1790 Debug( LDAP_DEBUG_TRACE, " attributes: \n", 0, 0, 0 );
1791 if ( ( attrarray = qm->attr_sets[i].attrs ) != NULL ) {
1792 for ( i=0; attrarray[i].an_name.bv_val; i++ )
1793 Debug( LDAP_DEBUG_TRACE, "\t%s\n",
1794 attrarray[i].an_name.bv_val, 0, 0 );
1797 temp->querystr.bv_val = NULL;
1801 if ( strcasecmp( c->argv[1], "head" ) == 0 ) {
1802 cm->response_cb = PCACHE_RESPONSE_CB_HEAD;
1804 } else if ( strcasecmp( c->argv[1], "tail" ) == 0 ) {
1805 cm->response_cb = PCACHE_RESPONSE_CB_TAIL;
1808 snprintf( c->msg, sizeof( c->msg ), "unknown specifier" );
1809 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->msg, 0 );
1826 slap_overinst *on = (slap_overinst *)be->bd_info;
1827 cache_manager* cm = on->on_bi.bi_private;
1829 /* Something for the cache database? */
1830 if ( cm->db.bd_info && cm->db.bd_info->bi_db_config )
1831 return cm->db.bd_info->bi_db_config( &cm->db, fname, lineno,
1833 return SLAP_CONF_UNKNOWN;
1841 slap_overinst *on = (slap_overinst *)be->bd_info;
1845 cm = (cache_manager *)ch_malloc(sizeof(cache_manager));
1846 on->on_bi.bi_private = cm;
1848 qm = (query_manager*)ch_malloc(sizeof(query_manager));
1851 SLAP_DBFLAGS(&cm->db) |= SLAP_DBFLAG_NO_SCHEMA_CHECK;
1852 cm->db.be_private = NULL;
1853 cm->db.be_pcl_mutexp = &cm->db.be_pcl_mutex;
1855 cm->numattrsets = 0;
1856 cm->numtemplates = 0;
1857 cm->num_entries_limit = 5;
1858 cm->num_cached_queries = 0;
1859 cm->max_entries = 0;
1860 cm->cur_entries = 0;
1861 cm->max_queries = 10000;
1862 cm->response_cb = PCACHE_RESPONSE_CB_TAIL;
1863 cm->cc_period = 1000;
1866 qm->attr_sets = NULL;
1867 qm->templates = NULL;
1869 qm->lru_bottom = NULL;
1871 qm->qcfunc = query_containment;
1872 qm->crfunc = cache_replacement;
1873 qm->addfunc = add_query;
1874 ldap_pvt_thread_mutex_init(&qm->lru_mutex);
1876 ldap_pvt_thread_mutex_init(&cm->cache_mutex);
1877 ldap_pvt_thread_mutex_init(&cm->remove_mutex);
1886 slap_overinst *on = (slap_overinst *)be->bd_info;
1887 cache_manager *cm = on->on_bi.bi_private;
1888 query_manager* qm = cm->qm;
1889 int i, ncf = 0, rf = 0, nrf = 0, rc = 0;
1891 /* check attr sets */
1892 for ( i = 0; i < cm->numattrsets; i++) {
1893 if ( !( qm->attr_sets[i].flags & PC_CONFIGURED ) ) {
1894 if ( qm->attr_sets[i].flags & PC_REFERENCED ) {
1895 Debug( LDAP_DEBUG_CONFIG, "pcache: attr set #%d not configured but referenced.\n", i, 0, 0 );
1899 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, attr set #%d not configured.\n", i, 0, 0 );
1903 } else if ( !( qm->attr_sets[i].flags & PC_REFERENCED ) ) {
1904 Debug( LDAP_DEBUG_CONFIG, "pcache: attr set #%d configured but not referenced.\n", i, 0, 0 );
1909 if ( ncf || rf || nrf ) {
1910 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, %d attr sets configured but not referenced.\n", nrf, 0, 0 );
1911 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, %d attr sets not configured.\n", ncf, 0, 0 );
1912 Debug( LDAP_DEBUG_CONFIG, "pcache: %d attr sets not configured but referenced.\n", rf, 0, 0 );
1919 /* need to inherit something from the original database... */
1920 cm->db.be_def_limit = be->be_def_limit;
1921 cm->db.be_limits = be->be_limits;
1922 cm->db.be_acl = be->be_acl;
1923 cm->db.be_dfltaccess = be->be_dfltaccess;
1925 rc = backend_startup_one( &cm->db );
1927 /* There is no runqueue in TOOL mode */
1928 if ( slapMode & SLAP_SERVER_MODE ) {
1929 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
1930 ldap_pvt_runqueue_insert( &slapd_rq, cm->cc_period,
1931 consistency_check, on,
1932 "pcache_consistency", be->be_suffix[0].bv_val );
1933 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
1935 /* Cached database must have the rootdn */
1936 if ( BER_BVISNULL( &cm->db.be_rootndn )
1937 || BER_BVISEMPTY( &cm->db.be_rootndn ) )
1939 Debug( LDAP_DEBUG_ANY, "pcache_db_open(): "
1940 "underlying database of type \"%s\"\n"
1941 " serving naming context \"%s\"\n"
1942 " has no \"rootdn\", required by \"proxycache\".\n",
1943 on->on_info->oi_orig->bi_type,
1944 cm->db.be_suffix[0].bv_val, 0 );
1957 slap_overinst *on = (slap_overinst *)be->bd_info;
1958 cache_manager *cm = on->on_bi.bi_private;
1959 query_manager *qm = cm->qm;
1962 /* cleanup stuff inherited from the original database... */
1963 cm->db.be_limits = NULL;
1964 cm->db.be_acl = NULL;
1966 if ( cm->db.bd_info->bi_db_close ) {
1967 rc = cm->db.bd_info->bi_db_close( &cm->db );
1969 for ( i=0; i<cm->numtemplates; i++ ) {
1970 CachedQuery *qc, *qn;
1971 for ( qc = qm->templates[i].query; qc; qc = qn ) {
1975 free( qm->templates[i].querystr.bv_val );
1976 ldap_pvt_thread_rdwr_destroy( &qm->templates[i].t_rwlock );
1978 free( qm->templates );
1979 qm->templates = NULL;
1981 for ( i=0; i<cm->numattrsets; i++ ) {
1982 free( qm->attr_sets[i].attrs );
1984 free( qm->attr_sets );
1985 qm->attr_sets = NULL;
1995 slap_overinst *on = (slap_overinst *)be->bd_info;
1996 cache_manager *cm = on->on_bi.bi_private;
1997 query_manager *qm = cm->qm;
1999 /* cleanup stuff inherited from the original database... */
2000 cm->db.be_suffix = NULL;
2001 cm->db.be_nsuffix = NULL;
2002 BER_BVZERO( &cm->db.be_rootdn );
2003 BER_BVZERO( &cm->db.be_rootndn );
2004 BER_BVZERO( &cm->db.be_rootpw );
2005 /* FIXME: there might be more... */
2007 if ( cm->db.be_private != NULL ) {
2008 backend_destroy_one( &cm->db, 0 );
2011 ldap_pvt_thread_mutex_destroy( &qm->lru_mutex );
2012 ldap_pvt_thread_mutex_destroy( &cm->cache_mutex );
2013 ldap_pvt_thread_mutex_destroy( &cm->remove_mutex );
2020 static slap_overinst pcache;
2022 static char *obsolete_names[] = {
2027 int pcache_initialize()
2029 LDAPAttributeType *at;
2033 at = ldap_str2attributetype( queryid_schema, &code, &err,
2034 LDAP_SCHEMA_ALLOW_ALL );
2036 Debug( LDAP_DEBUG_ANY,
2037 "pcache_initialize: ldap_str2attributetype failed %s %s\n",
2038 ldap_scherr2str(code), err, 0 );
2041 code = at_add( at, 0, NULL, &err );
2043 slap_str2ad( at->at_names[0], &ad_queryid, &err );
2047 Debug( LDAP_DEBUG_ANY,
2048 "pcache_initialize: at_add failed %s %s\n",
2049 scherr2str(code), err, 0 );
2053 pcache.on_bi.bi_type = "pcache";
2054 pcache.on_bi.bi_obsolete_names = obsolete_names;
2055 pcache.on_bi.bi_db_init = pcache_db_init;
2056 pcache.on_bi.bi_db_config = pcache_db_config;
2057 pcache.on_bi.bi_db_open = pcache_db_open;
2058 pcache.on_bi.bi_db_close = pcache_db_close;
2059 pcache.on_bi.bi_db_destroy = pcache_db_destroy;
2061 pcache.on_bi.bi_op_search = pcache_op_search;
2063 pcache.on_bi.bi_chk_controls = pcache_chk_controls;
2065 pcache.on_bi.bi_cf_ocs = pcocs;
2067 code = config_register_schema( pccfg, pcocs );
2068 if ( code ) return code;
2070 return overlay_register( &pcache );
2073 #if SLAPD_OVER_PROXYCACHE == SLAPD_MOD_DYNAMIC
2074 int init_module(int argc, char *argv[]) {
2075 return pcache_initialize();
2079 #endif /* defined(SLAPD_OVER_PROXYCACHE) */