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 time_t negttl; /* TTL for negative results */
73 ldap_pvt_thread_rdwr_t t_rwlock; /* Rd/wr lock for accessing queries in the template */
77 * Represents a set of projected attributes.
82 #define PC_CONFIGURED (0x1)
83 #define PC_REFERENCED (0x2)
84 #define PC_GOT_OC (0x4)
85 AttributeName* attrs; /* specifies the set */
86 int count; /* number of attributes */
89 struct query_manager_s;
91 /* prototypes for functions for 1) query containment
92 * 2) query addition, 3) cache replacement
94 typedef CachedQuery * (QCfunc)(Operation *op, struct query_manager_s*, Query*, int );
95 typedef void (AddQueryfunc)(struct query_manager_s*, Query*, int, struct berval*);
96 typedef void (CRfunc)(struct query_manager_s*, struct berval * );
98 /* LDAP query cache */
99 typedef struct query_manager_s {
100 struct attr_set* attr_sets; /* possible sets of projected attributes */
101 QueryTemplate* templates; /* cacheable templates */
103 CachedQuery* lru_top; /* top and bottom of LRU list */
104 CachedQuery* lru_bottom;
106 ldap_pvt_thread_mutex_t lru_mutex; /* mutex for accessing LRU list */
108 /* Query cache methods */
109 QCfunc *qcfunc; /* Query containment*/
110 CRfunc *crfunc; /* cache replacement */
111 AddQueryfunc *addfunc; /* add query */
114 /* LDAP query cache manager */
115 typedef struct cache_manager_s {
116 BackendDB db; /* underlying database */
117 unsigned long num_cached_queries; /* total number of cached queries */
118 unsigned long max_queries; /* upper bound on # of cached queries */
119 int numattrsets; /* number of attribute sets */
120 int numtemplates; /* number of cacheable templates */
121 int cur_entries; /* current number of entries cached */
122 int max_entries; /* max number of entries cached */
123 int num_entries_limit; /* max # of entries in a cacheable query */
125 char response_cb; /* install the response callback
126 * at the tail of the callback list */
127 #define PCACHE_RESPONSE_CB_HEAD 0
128 #define PCACHE_RESPONSE_CB_TAIL 1
130 time_t cc_period; /* interval between successive consistency checks (sec) */
134 ldap_pvt_thread_mutex_t cache_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_CACHE, "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_CACHE, "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_CACHE,
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_CACHE,
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;
631 new_cached_query->q_uuid = *uuid;
632 new_cached_query->expiry_time = slap_get_time() + templ->ttl;
634 BER_BVZERO( &new_cached_query->q_uuid );
635 new_cached_query->expiry_time = slap_get_time() + templ->negttl;
637 new_cached_query->lru_up = NULL;
638 new_cached_query->lru_down = NULL;
639 Debug( LDAP_DEBUG_CACHE, "Added query expires at %ld\n",
640 (long) new_cached_query->expiry_time, 0, 0 );
641 new_query = (Query*)new_cached_query;
643 ber_dupbv(&new_query->base, &query->base);
644 new_query->scope = query->scope;
645 new_query->filter = query->filter;
646 new_query->attrs = query->attrs;
649 Debug( LDAP_DEBUG_CACHE, "Lock AQ index = %d\n",
650 template_index, 0, 0 );
651 ldap_pvt_thread_rdwr_wlock(&templ->t_rwlock);
652 if (templ->query == NULL)
653 templ->query_last = new_cached_query;
655 templ->query->prev = new_cached_query;
656 new_cached_query->next = templ->query;
657 new_cached_query->prev = NULL;
658 templ->query = new_cached_query;
659 templ->no_of_queries++;
660 Debug( LDAP_DEBUG_CACHE, "TEMPLATE %d QUERIES++ %d\n",
661 template_index, templ->no_of_queries, 0 );
663 Debug( LDAP_DEBUG_CACHE, "Unlock AQ index = %d \n",
664 template_index, 0, 0 );
665 ldap_pvt_thread_rdwr_wunlock(&templ->t_rwlock);
667 /* Adding on top of LRU list */
668 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
669 add_query_on_top(qm, new_cached_query);
670 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
674 remove_from_template (CachedQuery* qc, QueryTemplate* template)
676 if (!qc->prev && !qc->next) {
677 template->query_last = template->query = NULL;
678 } else if (qc->prev == NULL) {
679 qc->next->prev = NULL;
680 template->query = qc->next;
681 } else if (qc->next == NULL) {
682 qc->prev->next = NULL;
683 template->query_last = qc->prev;
685 qc->next->prev = qc->prev;
686 qc->prev->next = qc->next;
689 template->no_of_queries--;
692 /* remove bottom query of LRU list from the query cache */
693 static void cache_replacement(query_manager* qm, struct berval *result)
698 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
699 bottom = qm->lru_bottom;
701 result->bv_val = NULL;
705 Debug ( LDAP_DEBUG_CACHE,
706 "Cache replacement invoked without "
707 "any query in LRU list\n", 0, 0, 0 );
708 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
712 temp_id = bottom->template_id;
713 remove_query(qm, bottom);
714 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
716 *result = bottom->q_uuid;
717 bottom->q_uuid.bv_val = NULL;
719 Debug( LDAP_DEBUG_CACHE, "Lock CR index = %d\n", temp_id, 0, 0 );
720 ldap_pvt_thread_rdwr_wlock(&(qm->templates[temp_id].t_rwlock));
721 remove_from_template(bottom, (qm->templates+temp_id));
722 Debug( LDAP_DEBUG_CACHE, "TEMPLATE %d QUERIES-- %d\n",
723 temp_id, qm->templates[temp_id].no_of_queries, 0 );
724 Debug( LDAP_DEBUG_CACHE, "Unlock CR index = %d\n", temp_id, 0, 0 );
725 ldap_pvt_thread_rdwr_wunlock(&(qm->templates[temp_id].t_rwlock));
730 struct query_info *next;
742 struct query_info *qi;
745 if ( rs->sr_type != REP_SEARCH ) return 0;
747 for (attr = rs->sr_entry->e_attrs; attr!= NULL; attr = attr->a_next) {
748 if (attr->a_desc == ad_queryid) {
749 for (count=0; attr->a_vals[count].bv_val; count++)
754 if ( count == 0 ) return 0;
755 qi = op->o_tmpalloc( sizeof( struct query_info ), op->o_tmpmemctx );
756 qi->next = op->o_callback->sc_private;
757 op->o_callback->sc_private = qi;
758 ber_dupbv_x( &qi->xdn, &rs->sr_entry->e_nname, op->o_tmpmemctx );
759 qi->del = ( count == 1 );
768 struct berval* query_uuid)
770 struct query_info *qi, *qnext;
772 #ifdef LDAP_COMP_MATCH
773 AttributeAssertion ava = { NULL, BER_BVNULL, NULL };
775 AttributeAssertion ava = { NULL, BER_BVNULL };
777 Filter filter = {LDAP_FILTER_EQUALITY};
778 SlapReply sreply = {REP_RESULT};
779 slap_callback cb = { NULL, remove_func, NULL, NULL };
782 sreply.sr_entry = NULL;
783 sreply.sr_nentries = 0;
784 op->ors_filterstr.bv_len = snprintf(filter_str, sizeof(filter_str),
785 "(%s=%s)", ad_queryid->ad_cname.bv_val, query_uuid->bv_val);
787 filter.f_av_desc = ad_queryid;
788 filter.f_av_value = *query_uuid;
790 op->o_tag = LDAP_REQ_SEARCH;
791 op->o_protocol = LDAP_VERSION3;
792 op->o_callback = &cb;
793 op->o_time = slap_get_time();
794 op->o_do_not_cache = 1;
796 op->o_req_dn = op->o_bd->be_suffix[0];
797 op->o_req_ndn = op->o_bd->be_nsuffix[0];
798 op->ors_scope = LDAP_SCOPE_SUBTREE;
799 op->ors_deref = LDAP_DEREF_NEVER;
800 op->ors_slimit = SLAP_NO_LIMIT;
801 op->ors_tlimit = SLAP_NO_LIMIT;
802 op->ors_filter = &filter;
803 op->ors_filterstr.bv_val = filter_str;
804 op->ors_filterstr.bv_len = strlen(filter_str);
805 op->ors_attrs = NULL;
806 op->ors_attrsonly = 0;
808 op->o_bd->be_search( op, &sreply );
810 for ( qi=cb.sc_private; qi; qi=qnext ) {
813 op->o_req_dn = qi->xdn;
814 op->o_req_ndn = qi->xdn;
817 Debug( LDAP_DEBUG_CACHE, "DELETING ENTRY TEMPLATE=%s\n",
818 query_uuid->bv_val, 0, 0 );
820 op->o_tag = LDAP_REQ_DELETE;
822 if (op->o_bd->be_delete(op, &sreply) == LDAP_SUCCESS) {
827 struct berval vals[2];
829 vals[0] = *query_uuid;
830 vals[1].bv_val = NULL;
832 mod.sml_op = LDAP_MOD_DELETE;
834 mod.sml_desc = ad_queryid;
835 mod.sml_type = ad_queryid->ad_cname;
836 mod.sml_values = vals;
837 mod.sml_nvalues = NULL;
839 Debug( LDAP_DEBUG_CACHE,
840 "REMOVING TEMP ATTR : TEMPLATE=%s\n",
841 query_uuid->bv_val, 0, 0 );
843 op->orm_modlist = &mod;
845 op->o_bd->be_modify( op, &sreply );
847 op->o_tmpfree( qi->xdn.bv_val, op->o_tmpmemctx );
848 op->o_tmpfree( qi, op->o_tmpmemctx );
855 AttributeName* attrs,
865 AttributeName** filter_attrs,
869 AttributeDescription *ad;
871 switch ( f->f_choice ) {
872 case LDAP_FILTER_EQUALITY:
874 sprintf( fstr->bv_val+fstr->bv_len, "(%s=)", ad->ad_cname.bv_val );
875 fstr->bv_len += ad->ad_cname.bv_len + ( sizeof("(=)") - 1 );
880 sprintf( fstr->bv_val+fstr->bv_len, "(%s>=)", ad->ad_cname.bv_val);
881 fstr->bv_len += ad->ad_cname.bv_len + ( sizeof("(>=)") - 1 );
886 sprintf( fstr->bv_val+fstr->bv_len, "(%s<=)", ad->ad_cname.bv_val);
887 fstr->bv_len += ad->ad_cname.bv_len + ( sizeof("(<=)") - 1 );
890 case LDAP_FILTER_APPROX:
892 sprintf( fstr->bv_val+fstr->bv_len, "(%s~=)", ad->ad_cname.bv_val);
893 fstr->bv_len += ad->ad_cname.bv_len + ( sizeof("(~=)") - 1 );
896 case LDAP_FILTER_SUBSTRINGS:
898 sprintf( fstr->bv_val+fstr->bv_len, "(%s=)", ad->ad_cname.bv_val );
899 fstr->bv_len += ad->ad_cname.bv_len + ( sizeof("(=)") - 1 );
902 case LDAP_FILTER_PRESENT:
904 sprintf( fstr->bv_val+fstr->bv_len, "(%s=*)", ad->ad_cname.bv_val );
905 fstr->bv_len += ad->ad_cname.bv_len + ( sizeof("(=*)") - 1 );
908 case LDAP_FILTER_AND:
910 case LDAP_FILTER_NOT: {
912 sprintf( fstr->bv_val+fstr->bv_len, "(%c",
913 f->f_choice == LDAP_FILTER_AND ? '&' :
914 f->f_choice == LDAP_FILTER_OR ? '|' : '!' );
915 fstr->bv_len += sizeof("(%") - 1;
917 for ( f = f->f_list; f != NULL; f = f->f_next ) {
918 rc = filter2template( op, f, fstr, filter_attrs, filter_cnt,
922 sprintf( fstr->bv_val+fstr->bv_len, ")" );
923 fstr->bv_len += sizeof(")") - 1;
929 strcpy( fstr->bv_val, "(?=?)" );
930 fstr->bv_len += sizeof("(?=?)")-1;
934 *filter_attrs = (AttributeName *)op->o_tmprealloc(*filter_attrs,
935 (*filter_cnt + 2)*sizeof(AttributeName), op->o_tmpmemctx);
937 (*filter_attrs)[*filter_cnt].an_desc = ad;
938 (*filter_attrs)[*filter_cnt].an_name = ad->ad_cname;
939 (*filter_attrs)[*filter_cnt].an_oc = NULL;
940 (*filter_attrs)[*filter_cnt].an_oc_exclude = 0;
941 BER_BVZERO( &(*filter_attrs)[*filter_cnt+1].an_name );
943 if ( ad == slap_schema.si_ad_objectClass )
962 struct berval *query_uuid)
964 struct search_info *si = op->o_callback->sc_private;
965 slap_overinst *on = si->on;
966 cache_manager *cm = on->on_bi.bi_private;
967 query_manager* qm = cm->qm;
970 struct berval crp_uuid;
971 char uuidbuf[ LDAP_LUTIL_UUIDSTR_BUFSIZE ];
972 Operation op_tmp = *op;
974 query_uuid->bv_len = lutil_uuidstr(uuidbuf, sizeof(uuidbuf));
975 ber_str2bv(uuidbuf, query_uuid->bv_len, 1, query_uuid);
977 op_tmp.o_bd = &cm->db;
978 op_tmp.o_dn = cm->db.be_rootdn;
979 op_tmp.o_ndn = cm->db.be_rootndn;
981 Debug( LDAP_DEBUG_CACHE, "UUID for query being added = %s\n",
984 for ( e=si->head; e; e=si->head ) {
985 si->head = e->e_private;
987 while ( cm->cur_entries > (cm->max_entries) ) {
988 qm->crfunc(qm, &crp_uuid);
989 if (crp_uuid.bv_val) {
990 Debug( LDAP_DEBUG_CACHE,
991 "Removing query UUID %s\n",
992 crp_uuid.bv_val, 0, 0 );
993 return_val = remove_query_data(&op_tmp, rs, &crp_uuid);
994 Debug( LDAP_DEBUG_CACHE,
995 "QUERY REMOVED, SIZE=%d\n",
997 ldap_pvt_thread_mutex_lock(
999 cm->cur_entries -= return_val;
1000 cm->num_cached_queries--;
1001 Debug( LDAP_DEBUG_CACHE,
1002 "STORED QUERIES = %lu\n",
1003 cm->num_cached_queries, 0, 0 );
1004 ldap_pvt_thread_mutex_unlock(
1006 Debug( LDAP_DEBUG_CACHE,
1007 "QUERY REMOVED, CACHE ="
1009 cm->cur_entries, 0, 0 );
1013 return_val = merge_entry(&op_tmp, e, query_uuid);
1014 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
1015 cm->cur_entries += return_val;
1016 Debug( LDAP_DEBUG_CACHE,
1017 "ENTRY ADDED/MERGED, CACHED ENTRIES=%d\n",
1018 cm->cur_entries, 0, 0 );
1020 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
1031 struct search_info *si = op->o_callback->sc_private;
1032 slap_overinst *on = si->on;
1033 cache_manager *cm = on->on_bi.bi_private;
1034 query_manager* qm = cm->qm;
1037 if ( si->query.save_attrs != NULL ) {
1038 rs->sr_attrs = si->query.save_attrs;
1039 op->ors_attrs = si->query.save_attrs;
1040 si->query.save_attrs = NULL;
1043 if ( rs->sr_type == REP_SEARCH ) {
1045 /* If we haven't exceeded the limit for this query,
1046 * build a chain of answers to store. If we hit the
1047 * limit, empty the chain and ignore the rest.
1050 if ( si->count < si->max ) {
1052 e = entry_dup( rs->sr_entry );
1053 if ( !si->head ) si->head = e;
1054 if ( si->tail ) si->tail->e_private = e;
1059 for (;si->head; si->head=e) {
1060 e = si->head->e_private;
1061 si->head->e_private = NULL;
1062 entry_free(si->head);
1068 } else if ( rs->sr_type == REP_RESULT ) {
1069 QueryTemplate* templ = (qm->templates)+si->template_id;
1070 if (( si->count && cache_entries( op, rs, &uuid ) == 0 ) ||
1071 ( !si->count && templ->negttl && rs->sr_err == LDAP_SUCCESS )) {
1072 qm->addfunc(qm, &si->query, si->template_id,
1073 si->count ? &uuid : NULL);
1075 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
1076 cm->num_cached_queries++;
1077 Debug( LDAP_DEBUG_CACHE, "STORED QUERIES = %lu\n",
1078 cm->num_cached_queries, 0, 0 );
1079 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
1081 /* If the consistency checker suspended itself,
1084 if ( cm->cc_paused ) {
1085 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
1086 if ( cm->cc_paused ) {
1088 ldap_pvt_runqueue_resched( &slapd_rq, cm->cc_arg, 0 );
1090 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
1093 free( si->query.attrs );
1094 filter_free( si->query.filter );
1098 op->o_callback->sc_cleanup = slap_freeself_cb;
1100 return SLAP_CB_CONTINUE;
1106 AttributeName** new_attrs,
1107 struct attr_set *attrs,
1108 AttributeName* filter_attrs,
1118 /* duplicate attrs */
1119 count = attrs->count + fattr_cnt;
1120 if ( !fattr_got_oc && !(attrs->flags & PC_GOT_OC)) {
1125 *new_attrs = (AttributeName*)ch_malloc((count+1)*
1126 sizeof(AttributeName));
1127 for (i=0; i<attrs->count; i++) {
1128 (*new_attrs)[i].an_name = attrs->attrs[i].an_name;
1129 (*new_attrs)[i].an_desc = attrs->attrs[i].an_desc;
1131 BER_BVZERO( &(*new_attrs)[i].an_name );
1132 alluser = an_find(*new_attrs, &AllUser);
1133 allop = an_find(*new_attrs, &AllOper);
1136 for ( i=0; i<fattr_cnt; i++ ) {
1137 if ( an_find(*new_attrs, &filter_attrs[i].an_name ))
1139 if ( is_at_operational(filter_attrs[i].an_desc->ad_type) ) {
1144 (*new_attrs)[j].an_name = filter_attrs[i].an_name;
1145 (*new_attrs)[j].an_desc = filter_attrs[i].an_desc;
1146 (*new_attrs)[j].an_oc = NULL;
1147 (*new_attrs)[j].an_oc_exclude = 0;
1151 (*new_attrs)[j].an_name = slap_schema.si_ad_objectClass->ad_cname;
1152 (*new_attrs)[j].an_desc = slap_schema.si_ad_objectClass;
1153 (*new_attrs)[j].an_oc = NULL;
1154 (*new_attrs)[j].an_oc_exclude = 0;
1157 BER_BVZERO( &(*new_attrs)[j].an_name );
1160 /* NOTE: this is a quick workaround to let pcache minimally interact
1161 * with pagedResults. A more articulated solutions would be to
1162 * perform the remote query without control and cache all results,
1163 * performing the pagedResults search only within the client
1164 * and the proxy. This requires pcache to understand pagedResults. */
1166 pcache_chk_controls(
1170 const char *non = "";
1171 const char *stripped = "";
1173 switch( op->o_pagedresults ) {
1174 case SLAP_CONTROL_NONCRITICAL:
1176 stripped = "; stripped";
1179 case SLAP_CONTROL_CRITICAL:
1180 Debug( LDAP_DEBUG_CACHE, "%s: "
1181 "%scritical pagedResults control "
1182 "disabled with proxy cache%s.\n",
1183 op->o_log_prefix, non, stripped );
1185 slap_remove_control( op, rs, slap_cids.sc_pagedResults, NULL );
1189 rs->sr_err = SLAP_CB_CONTINUE;
1201 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
1202 cache_manager *cm = on->on_bi.bi_private;
1203 query_manager* qm = cm->qm;
1209 AttributeName *filter_attrs = NULL;
1214 int template_id = -1;
1215 CachedQuery *answerable = NULL;
1218 int fattr_got_oc = 0;
1219 int oc_attr_absent = 1;
1221 struct berval tempstr;
1223 tempstr.bv_val = op->o_tmpalloc( op->ors_filterstr.bv_len+1, op->o_tmpmemctx );
1225 if ( filter2template( op, op->ors_filter, &tempstr, &filter_attrs,
1226 &fattr_cnt, &fattr_got_oc )) {
1227 op->o_tmpfree( tempstr.bv_val, op->o_tmpmemctx );
1228 return SLAP_CB_CONTINUE;
1231 Debug( LDAP_DEBUG_CACHE, "query template of incoming query = %s\n",
1232 tempstr.bv_val, 0, 0 );
1234 /* FIXME: cannot cache/answer requests with pagedResults control */
1238 attr_set = get_attr_set(op->ors_attrs, qm, cm->numattrsets);
1240 query.filter = op->ors_filter;
1241 query.attrs = op->ors_attrs;
1242 query.save_attrs = NULL;
1243 query.base = op->o_req_ndn;
1244 query.scope = op->ors_scope;
1246 /* check for query containment */
1247 if (attr_set > -1) {
1248 QueryTemplate *qt = qm->templates;
1249 for (i=0; i<cm->numtemplates; i++, qt++) {
1250 /* find if template i can potentially answer tempstr */
1251 if ( qt->attr_set_index != attr_set ||
1252 qt->querystr.bv_len != tempstr.bv_len ||
1253 strcasecmp( qt->querystr.bv_val, tempstr.bv_val ))
1257 Debug( LDAP_DEBUG_NONE, "Entering QC, querystr = %s\n",
1258 op->ors_filterstr.bv_val, 0, 0 );
1259 answerable = (*(qm->qcfunc))(op, qm, &query, i);
1265 op->o_tmpfree( tempstr.bv_val, op->o_tmpmemctx );
1267 query.save_attrs = op->ors_attrs;
1271 /* Need to clear the callbacks of the original operation,
1272 * in case there are other overlays */
1273 BackendDB *save_bd = op->o_bd;
1274 slap_callback *save_cb = op->o_callback;
1276 Debug( LDAP_DEBUG_CACHE, "QUERY ANSWERABLE\n", 0, 0, 0 );
1277 op->o_tmpfree( filter_attrs, op->o_tmpmemctx );
1278 ldap_pvt_thread_rdwr_runlock(&qm->templates[i].t_rwlock);
1279 if ( BER_BVISNULL( &answerable->q_uuid )) {
1280 /* No entries cached, just an empty result set */
1282 send_ldap_result( op, rs );
1285 op->o_callback = NULL;
1286 i = cm->db.bd_info->bi_op_search( op, rs );
1289 op->o_callback = save_cb;
1293 Debug( LDAP_DEBUG_CACHE, "QUERY NOT ANSWERABLE\n", 0, 0, 0 );
1295 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
1296 if (cm->num_cached_queries >= cm->max_queries) {
1299 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
1303 struct search_info *si;
1305 Debug( LDAP_DEBUG_CACHE, "QUERY CACHEABLE\n", 0, 0, 0 );
1306 query.filter = filter_dup(op->ors_filter, NULL);
1307 add_filter_attrs(op, &query.attrs, &qm->attr_sets[attr_set],
1308 filter_attrs, fattr_cnt, fattr_got_oc);
1310 op->ors_attrs = query.attrs;
1312 cb = op->o_tmpalloc( sizeof(*cb) + sizeof(*si), op->o_tmpmemctx);
1313 cb->sc_response = pcache_response;
1314 cb->sc_cleanup = NULL;
1315 cb->sc_private = (cb+1);
1316 si = cb->sc_private;
1319 si->template_id = template_id;
1320 si->max = cm->num_entries_limit ;
1326 if ( cm->response_cb == PCACHE_RESPONSE_CB_HEAD ) {
1327 cb->sc_next = op->o_callback;
1328 op->o_callback = cb;
1331 slap_callback **pcb;
1333 /* need to move the callback at the end, in case other
1334 * overlays are present, so that the final entry is
1335 * actually cached */
1337 for ( pcb = &op->o_callback; *pcb; pcb = &(*pcb)->sc_next );
1342 Debug( LDAP_DEBUG_CACHE, "QUERY NOT CACHEABLE\n",
1346 op->o_tmpfree( filter_attrs, op->o_tmpmemctx );
1348 return SLAP_CB_CONTINUE;
1353 AttributeName* attrs,
1361 for ( ; attrs[count].an_name.bv_val; count++ );
1364 for (i=0; i<num; i++) {
1368 if ( count > qm->attr_sets[i].count )
1371 if ( !qm->attr_sets[i].count )
1375 for ( a2 = attrs; a2->an_name.bv_val; a2++ ) {
1376 if ( !an_find( qm->attr_sets[i].attrs, &a2->an_name )) {
1394 struct re_s *rtask = arg;
1395 slap_overinst *on = rtask->arg;
1396 cache_manager *cm = on->on_bi.bi_private;
1397 query_manager *qm = cm->qm;
1398 Connection conn = {0};
1399 OperationBuffer opbuf;
1402 SlapReply rs = {REP_RESULT};
1403 CachedQuery* query, *query_prev;
1404 int i, return_val, pause = 1;
1405 QueryTemplate* templ;
1407 op = (Operation *) &opbuf;
1408 connection_fake_init( &conn, op, ctx );
1411 op->o_dn = cm->db.be_rootdn;
1412 op->o_ndn = cm->db.be_rootndn;
1416 for (i=0; qm->templates[i].querystr.bv_val; i++) {
1417 templ = qm->templates + i;
1418 query = templ->query_last;
1419 if ( query ) pause = 0;
1420 op->o_time = slap_get_time();
1421 while (query && (query->expiry_time < op->o_time)) {
1422 Debug( LDAP_DEBUG_CACHE, "Lock CR index = %d\n",
1424 ldap_pvt_thread_rdwr_wlock(&templ->t_rwlock);
1425 remove_from_template(query, templ);
1426 Debug( LDAP_DEBUG_CACHE, "TEMPLATE %d QUERIES-- %d\n",
1427 i, templ->no_of_queries, 0 );
1428 Debug( LDAP_DEBUG_CACHE, "Unlock CR index = %d\n",
1430 ldap_pvt_thread_rdwr_wunlock(&templ->t_rwlock);
1431 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
1432 remove_query(qm, query);
1433 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1434 if ( BER_BVISNULL( &query->q_uuid ))
1437 return_val = remove_query_data(op, &rs, &query->q_uuid);
1438 Debug( LDAP_DEBUG_CACHE, "STALE QUERY REMOVED, SIZE=%d\n",
1440 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
1441 cm->cur_entries -= return_val;
1442 cm->num_cached_queries--;
1443 Debug( LDAP_DEBUG_CACHE, "STORED QUERIES = %lu\n",
1444 cm->num_cached_queries, 0, 0 );
1445 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
1446 Debug( LDAP_DEBUG_CACHE,
1447 "STALE QUERY REMOVED, CACHE ="
1449 cm->cur_entries, 0, 0 );
1451 query = query->prev;
1452 free_query(query_prev);
1455 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
1456 if ( ldap_pvt_runqueue_isrunning( &slapd_rq, rtask )) {
1457 ldap_pvt_runqueue_stoptask( &slapd_rq, rtask );
1459 /* If there were no queries, defer processing for a while */
1460 cm->cc_paused = pause;
1461 ldap_pvt_runqueue_resched( &slapd_rq, rtask, pause );
1463 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
1468 #define MAX_ATTR_SETS 500
1478 static ConfigDriver pc_cf_gen;
1479 static ConfigLDAPadd pc_ldadd;
1480 static ConfigCfAdd pc_cfadd;
1482 static ConfigTable pccfg[] = {
1483 { "proxycache", "backend> <max_entries> <numattrsets> <entry limit> "
1485 6, 6, 0, ARG_MAGIC|ARG_NO_DELETE|PC_MAIN, pc_cf_gen,
1486 "( OLcfgOvAt:2.1 NAME 'olcProxyCache' "
1487 "DESC 'ProxyCache basic parameters' "
1488 "SYNTAX OMsDirectoryString SINGLE-VALUE )", NULL, NULL },
1489 { "proxyattrset", "index> <attributes...",
1490 2, 0, 0, ARG_MAGIC|PC_ATTR, pc_cf_gen,
1491 "( OLcfgOvAt:2.2 NAME 'olcProxyAttrset' "
1492 "DESC 'A set of attributes to cache' "
1493 "SYNTAX OMsDirectoryString )", NULL, NULL },
1494 { "proxytemplate", "filter> <attrset-index> <TTL> <negTTL",
1495 4, 5, 0, ARG_MAGIC|PC_TEMP, pc_cf_gen,
1496 "( OLcfgOvAt:2.3 NAME 'olcProxyTemplate' "
1497 "DESC 'Filter template, attrset, cache TTL, optional negative TTL' "
1498 "SYNTAX OMsDirectoryString )", NULL, NULL },
1499 { "response-callback", "head|tail(default)",
1500 2, 2, 0, ARG_MAGIC|PC_RESP, pc_cf_gen,
1501 "( OLcfgOvAt:2.4 NAME 'olcProxyResponseCB' "
1502 "DESC 'Response callback position in overlay stack' "
1503 "SYNTAX OMsDirectoryString )", NULL, NULL },
1504 { "proxyCacheQueries", "queries",
1505 2, 2, 0, ARG_INT|ARG_MAGIC|PC_QUERIES, pc_cf_gen,
1506 "( OLcfgOvAt:2.5 NAME 'olcProxyCacheQueries' "
1507 "DESC 'Maximum number of queries to cache' "
1508 "SYNTAX OMsInteger )", NULL, NULL },
1510 { NULL, NULL, 0, 0, 0, ARG_IGNORED }
1513 static ConfigOCs pcocs[] = {
1514 { "( OLcfgOvOc:2.1 "
1515 "NAME 'olcPcacheConfig' "
1516 "DESC 'ProxyCache configuration' "
1517 "SUP olcOverlayConfig "
1518 "MUST ( olcProxyCache $ olcProxyAttrset $ olcProxyTemplate ) "
1519 "MAY ( olcProxyResponseCB $ olcProxyCacheQueries ) )", Cft_Overlay, pccfg, NULL, pc_cfadd },
1520 { "( OLcfgOvOc:2.2 "
1521 "NAME 'olcPcacheDatabase' "
1522 "DESC 'Cache database configuration' "
1523 "AUXILIARY )", Cft_Misc, pccfg, pc_ldadd },
1528 pc_ldadd( CfEntryInfo *p, Entry *e, ConfigArgs *ca )
1533 if ( p->ce_type != Cft_Overlay || !p->ce_bi ||
1534 p->ce_bi->bi_cf_ocs != pcocs )
1535 return LDAP_CONSTRAINT_VIOLATION;
1537 on = (slap_overinst *)p->ce_bi;
1538 cm = on->on_bi.bi_private;
1540 return LDAP_SUCCESS;
1544 pc_cfadd( Operation *op, SlapReply *rs, Entry *p, ConfigArgs *ca )
1546 CfEntryInfo *pe = p->e_private;
1547 slap_overinst *on = (slap_overinst *)pe->ce_bi;
1548 cache_manager *cm = on->on_bi.bi_private;
1551 /* FIXME: should not hardcode "olcDatabase" here */
1552 bv.bv_len = sprintf( ca->msg, "olcDatabase=%s", cm->db.bd_info->bi_type );
1553 bv.bv_val = ca->msg;
1556 /* We can only create this entry if the database is table-driven
1558 if ( cm->db.bd_info->bi_cf_ocs )
1559 config_build_entry( op, rs, pe, ca, &bv, cm->db.bd_info->bi_cf_ocs,
1566 pc_cf_gen( ConfigArgs *c )
1568 slap_overinst *on = (slap_overinst *)c->bi;
1569 cache_manager* cm = on->on_bi.bi_private;
1570 query_manager* qm = cm->qm;
1571 QueryTemplate* temp;
1572 AttributeName* attr_name;
1573 AttributeName* attrarray;
1574 const char* text=NULL;
1579 if ( c->op == SLAP_CONFIG_EMIT ) {
1583 bv.bv_len = snprintf( c->msg, sizeof( c->msg ), "%s %d %d %d %ld",
1584 cm->db.bd_info->bi_type, cm->max_entries, cm->numattrsets,
1585 cm->num_entries_limit, cm->cc_period );
1587 value_add_one( &c->rvalue_vals, &bv );
1590 for (i=0; i<cm->numattrsets; i++) {
1591 if ( !qm->attr_sets[i].count ) continue;
1593 bv.bv_len = snprintf( c->msg, sizeof( c->msg ), "%d", i );
1595 /* count the attr length */
1596 for ( attr_name = qm->attr_sets[i].attrs;
1597 attr_name->an_name.bv_val; attr_name++ )
1598 bv.bv_len += attr_name->an_name.bv_len + 1;
1600 bv.bv_val = ch_malloc( bv.bv_len+1 );
1601 ptr = lutil_strcopy( bv.bv_val, c->msg );
1602 for ( attr_name = qm->attr_sets[i].attrs;
1603 attr_name->an_name.bv_val; attr_name++ ) {
1605 ptr = lutil_strcopy( ptr, attr_name->an_name.bv_val );
1607 ber_bvarray_add( &c->rvalue_vals, &bv );
1609 if ( !c->rvalue_vals )
1613 for (i=0; i<cm->numtemplates; i++) {
1614 if ( qm->templates[i].negttl ) {
1615 bv.bv_len = snprintf( c->msg, sizeof( c->msg ),
1617 qm->templates[i].attr_set_index,
1618 qm->templates[i].ttl,
1619 qm->templates[i].negttl );
1621 bv.bv_len = snprintf( c->msg, sizeof( c->msg ), " %d %ld",
1622 qm->templates[i].attr_set_index,
1623 qm->templates[i].ttl );
1625 bv.bv_len += qm->templates[i].querystr.bv_len + 2;
1626 bv.bv_val = ch_malloc( bv.bv_len+1 );
1629 ptr = lutil_strcopy( ptr, qm->templates[i].querystr.bv_val );
1631 strcpy( ptr, c->msg );
1632 ber_bvarray_add( &c->rvalue_vals, &bv );
1634 if ( !c->rvalue_vals )
1638 if ( cm->response_cb == PCACHE_RESPONSE_CB_HEAD ) {
1639 BER_BVSTR( &bv, "head" );
1641 BER_BVSTR( &bv, "tail" );
1643 value_add_one( &c->rvalue_vals, &bv );
1646 c->value_int = cm->max_queries;
1650 } else if ( c->op == LDAP_MOD_DELETE ) {
1651 return 1; /* FIXME */
1663 if ( cm->numattrsets > 0 ) {
1664 snprintf( c->msg, sizeof( c->msg ), "\"proxycache\" directive already provided" );
1665 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->msg, 0 );
1669 if ( lutil_atoi( &cm->numattrsets, c->argv[3] ) != 0 ) {
1670 snprintf( c->msg, sizeof( c->msg ), "unable to parse num attrsets=\"%s\" (arg #3)",
1672 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->msg, 0 );
1675 if ( cm->numattrsets <= 0 ) {
1676 snprintf( c->msg, sizeof( c->msg ), "numattrsets (arg #3) must be positive" );
1677 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->msg, 0 );
1680 if ( cm->numattrsets > MAX_ATTR_SETS ) {
1681 snprintf( c->msg, sizeof( c->msg ), "numattrsets (arg #3) must be <= %d", MAX_ATTR_SETS );
1682 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->msg, 0 );
1686 if ( !backend_db_init( c->argv[1], &cm->db )) {
1687 snprintf( c->msg, sizeof( c->msg ), "unknown backend type (arg #1)" );
1688 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->msg, 0 );
1692 if ( lutil_atoi( &cm->max_entries, c->argv[2] ) != 0 ) {
1693 snprintf( c->msg, sizeof( c->msg ), "unable to parse max entries=\"%s\" (arg #2)",
1695 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->msg, 0 );
1698 if ( cm->max_entries <= 0 ) {
1699 snprintf( c->msg, sizeof( c->msg ), "max entries (arg #2) must be positive.\n" );
1700 Debug( LDAP_DEBUG_CONFIG, "%s: %s\n", c->log, c->msg, 0 );
1704 if ( lutil_atoi( &cm->num_entries_limit, c->argv[4] ) != 0 ) {
1705 snprintf( c->msg, sizeof( c->msg ), "unable to parse entry limit=\"%s\" (arg #4)",
1707 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->msg, 0 );
1710 if ( cm->num_entries_limit <= 0 ) {
1711 snprintf( c->msg, sizeof( c->msg ), "entry limit (arg #4) must be positive" );
1712 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->msg, 0 );
1715 if ( cm->num_entries_limit > cm->max_entries ) {
1716 snprintf( c->msg, sizeof( c->msg ), "entry limit (arg #4) must be less than max entries %d (arg #2)", cm->max_entries );
1717 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->msg, 0 );
1721 if ( lutil_parse_time( c->argv[5], &t ) != 0 ) {
1722 snprintf( c->msg, sizeof( c->msg ), "unable to parse period=\"%s\" (arg #5)",
1724 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->msg, 0 );
1727 cm->cc_period = (time_t)t;
1728 Debug( LDAP_DEBUG_CACHE,
1729 "Total # of attribute sets to be cached = %d.\n",
1730 cm->numattrsets, 0, 0 );
1731 qm->attr_sets = ( struct attr_set * )ch_calloc( cm->numattrsets,
1732 sizeof( struct attr_set ) );
1735 if ( cm->numattrsets == 0 ) {
1736 snprintf( c->msg, sizeof( c->msg ), "\"proxycache\" directive not provided yet" );
1737 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->msg, 0 );
1740 if ( lutil_atoi( &num, c->argv[1] ) != 0 ) {
1741 snprintf( c->msg, sizeof( c->msg ), "unable to parse attrset #=\"%s\"",
1743 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->msg, 0 );
1747 if ( num < 0 || num >= cm->numattrsets ) {
1748 snprintf( c->msg, sizeof( c->msg ), "attrset index %d out of bounds (must be %s%d)",
1749 num, cm->numattrsets > 1 ? "0->" : "", cm->numattrsets - 1 );
1750 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->msg, 0 );
1753 qm->attr_sets[num].flags |= PC_CONFIGURED;
1754 if ( c->argc > 2 && strcmp( c->argv[2], "*" ) ) {
1755 qm->attr_sets[num].count = c->argc - 2;
1756 qm->attr_sets[num].attrs = (AttributeName*)ch_malloc(
1757 (c->argc-1) * sizeof( AttributeName ));
1758 attr_name = qm->attr_sets[num].attrs;
1759 for ( i = 2; i < c->argc; i++ ) {
1760 attr_name->an_desc = NULL;
1761 if ( slap_str2ad( c->argv[i],
1762 &attr_name->an_desc, &text ) )
1764 strcpy( c->msg, text );
1765 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->msg, 0 );
1766 ch_free( qm->attr_sets[num].attrs );
1767 qm->attr_sets[num].attrs = NULL;
1768 qm->attr_sets[num].count = 0;
1771 attr_name->an_name = attr_name->an_desc->ad_cname;
1772 attr_name->an_oc = NULL;
1773 attr_name->an_oc_exclude = 0;
1774 if ( attr_name->an_desc == slap_schema.si_ad_objectClass )
1775 qm->attr_sets[num].flags |= PC_GOT_OC;
1777 BER_BVZERO( &attr_name->an_name );
1782 if ( cm->numattrsets == 0 ) {
1783 snprintf( c->msg, sizeof( c->msg ), "\"proxycache\" directive not provided yet" );
1784 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->msg, 0 );
1787 if ( lutil_atoi( &i, c->argv[2] ) != 0 ) {
1788 snprintf( c->msg, sizeof( c->msg ), "unable to parse template #=\"%s\"",
1790 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->msg, 0 );
1794 if ( i < 0 || i >= cm->numattrsets ) {
1795 snprintf( c->msg, sizeof( c->msg ), "template index %d invalid (%s%d)",
1796 i, cm->numattrsets > 1 ? "0->" : "", cm->numattrsets - 1 );
1797 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->msg, 0 );
1800 num = cm->numtemplates;
1801 qm->templates = ( QueryTemplate* )ch_realloc( qm->templates,
1802 ( num + 2 ) * sizeof( QueryTemplate ));
1803 temp = qm->templates + num;
1804 ldap_pvt_thread_rdwr_init( &temp->t_rwlock );
1805 temp->query = temp->query_last = NULL;
1806 if ( lutil_parse_time( c->argv[3], &t ) != 0 ) {
1807 snprintf( c->msg, sizeof( c->msg ), "unable to parse template ttl=\"%s\"",
1809 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->msg, 0 );
1812 temp->ttl = (time_t)t;
1813 if ( c->argc == 5 ) {
1814 if ( lutil_parse_time( c->argv[4], &t ) != 0 ) {
1815 snprintf( c->msg, sizeof( c->msg ),
1816 "unable to parse template negttl=\"%s\"",
1818 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->msg, 0 );
1821 temp->negttl = (time_t)t;
1826 temp->no_of_queries = 0;
1828 ber_str2bv( c->argv[1], 0, 1, &temp->querystr );
1829 Debug( LDAP_DEBUG_CACHE, "Template:\n", 0, 0, 0 );
1830 Debug( LDAP_DEBUG_CACHE, " query template: %s\n",
1831 temp->querystr.bv_val, 0, 0 );
1832 temp->attr_set_index = i;
1833 qm->attr_sets[i].flags |= PC_REFERENCED;
1834 Debug( LDAP_DEBUG_CACHE, " attributes: \n", 0, 0, 0 );
1835 if ( ( attrarray = qm->attr_sets[i].attrs ) != NULL ) {
1836 for ( i=0; attrarray[i].an_name.bv_val; i++ )
1837 Debug( LDAP_DEBUG_CACHE, "\t%s\n",
1838 attrarray[i].an_name.bv_val, 0, 0 );
1841 temp->querystr.bv_val = NULL;
1845 if ( strcasecmp( c->argv[1], "head" ) == 0 ) {
1846 cm->response_cb = PCACHE_RESPONSE_CB_HEAD;
1848 } else if ( strcasecmp( c->argv[1], "tail" ) == 0 ) {
1849 cm->response_cb = PCACHE_RESPONSE_CB_TAIL;
1852 snprintf( c->msg, sizeof( c->msg ), "unknown specifier" );
1853 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->msg, 0 );
1858 if ( c->value_int <= 0 ) {
1859 snprintf( c->msg, sizeof( c->msg ), "max queries must be positive" );
1860 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->msg, 0 );
1863 cm->max_queries = c->value_int;
1878 slap_overinst *on = (slap_overinst *)be->bd_info;
1879 cache_manager* cm = on->on_bi.bi_private;
1881 /* Something for the cache database? */
1882 if ( cm->db.bd_info && cm->db.bd_info->bi_db_config )
1883 return cm->db.bd_info->bi_db_config( &cm->db, fname, lineno,
1885 return SLAP_CONF_UNKNOWN;
1893 slap_overinst *on = (slap_overinst *)be->bd_info;
1897 cm = (cache_manager *)ch_malloc(sizeof(cache_manager));
1898 on->on_bi.bi_private = cm;
1900 qm = (query_manager*)ch_malloc(sizeof(query_manager));
1903 SLAP_DBFLAGS(&cm->db) |= SLAP_DBFLAG_NO_SCHEMA_CHECK;
1904 cm->db.be_private = NULL;
1905 cm->db.be_pcl_mutexp = &cm->db.be_pcl_mutex;
1907 cm->numattrsets = 0;
1908 cm->numtemplates = 0;
1909 cm->num_entries_limit = 5;
1910 cm->num_cached_queries = 0;
1911 cm->max_entries = 0;
1912 cm->cur_entries = 0;
1913 cm->max_queries = 10000;
1914 cm->response_cb = PCACHE_RESPONSE_CB_TAIL;
1915 cm->cc_period = 1000;
1918 qm->attr_sets = NULL;
1919 qm->templates = NULL;
1921 qm->lru_bottom = NULL;
1923 qm->qcfunc = query_containment;
1924 qm->crfunc = cache_replacement;
1925 qm->addfunc = add_query;
1926 ldap_pvt_thread_mutex_init(&qm->lru_mutex);
1928 ldap_pvt_thread_mutex_init(&cm->cache_mutex);
1937 slap_overinst *on = (slap_overinst *)be->bd_info;
1938 cache_manager *cm = on->on_bi.bi_private;
1939 query_manager* qm = cm->qm;
1940 int i, ncf = 0, rf = 0, nrf = 0, rc = 0;
1942 /* check attr sets */
1943 for ( i = 0; i < cm->numattrsets; i++) {
1944 if ( !( qm->attr_sets[i].flags & PC_CONFIGURED ) ) {
1945 if ( qm->attr_sets[i].flags & PC_REFERENCED ) {
1946 Debug( LDAP_DEBUG_CONFIG, "pcache: attr set #%d not configured but referenced.\n", i, 0, 0 );
1950 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, attr set #%d not configured.\n", i, 0, 0 );
1954 } else if ( !( qm->attr_sets[i].flags & PC_REFERENCED ) ) {
1955 Debug( LDAP_DEBUG_CONFIG, "pcache: attr set #%d configured but not referenced.\n", i, 0, 0 );
1960 if ( ncf || rf || nrf ) {
1961 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, %d attr sets configured but not referenced.\n", nrf, 0, 0 );
1962 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, %d attr sets not configured.\n", ncf, 0, 0 );
1963 Debug( LDAP_DEBUG_CONFIG, "pcache: %d attr sets not configured but referenced.\n", rf, 0, 0 );
1970 /* need to inherit something from the original database... */
1971 cm->db.be_def_limit = be->be_def_limit;
1972 cm->db.be_limits = be->be_limits;
1973 cm->db.be_acl = be->be_acl;
1974 cm->db.be_dfltaccess = be->be_dfltaccess;
1976 rc = backend_startup_one( &cm->db );
1978 /* There is no runqueue in TOOL mode */
1979 if ( slapMode & SLAP_SERVER_MODE ) {
1980 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
1981 ldap_pvt_runqueue_insert( &slapd_rq, cm->cc_period,
1982 consistency_check, on,
1983 "pcache_consistency", be->be_suffix[0].bv_val );
1984 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
1986 /* Cached database must have the rootdn */
1987 if ( BER_BVISNULL( &cm->db.be_rootndn )
1988 || BER_BVISEMPTY( &cm->db.be_rootndn ) )
1990 Debug( LDAP_DEBUG_ANY, "pcache_db_open(): "
1991 "underlying database of type \"%s\"\n"
1992 " serving naming context \"%s\"\n"
1993 " has no \"rootdn\", required by \"proxycache\".\n",
1994 on->on_info->oi_orig->bi_type,
1995 cm->db.be_suffix[0].bv_val, 0 );
2008 slap_overinst *on = (slap_overinst *)be->bd_info;
2009 cache_manager *cm = on->on_bi.bi_private;
2010 query_manager *qm = cm->qm;
2013 /* cleanup stuff inherited from the original database... */
2014 cm->db.be_limits = NULL;
2015 cm->db.be_acl = NULL;
2017 if ( cm->db.bd_info->bi_db_close ) {
2018 rc = cm->db.bd_info->bi_db_close( &cm->db );
2020 for ( i=0; i<cm->numtemplates; i++ ) {
2021 CachedQuery *qc, *qn;
2022 for ( qc = qm->templates[i].query; qc; qc = qn ) {
2026 free( qm->templates[i].querystr.bv_val );
2027 ldap_pvt_thread_rdwr_destroy( &qm->templates[i].t_rwlock );
2029 free( qm->templates );
2030 qm->templates = NULL;
2032 for ( i=0; i<cm->numattrsets; i++ ) {
2033 free( qm->attr_sets[i].attrs );
2035 free( qm->attr_sets );
2036 qm->attr_sets = NULL;
2046 slap_overinst *on = (slap_overinst *)be->bd_info;
2047 cache_manager *cm = on->on_bi.bi_private;
2048 query_manager *qm = cm->qm;
2050 /* cleanup stuff inherited from the original database... */
2051 cm->db.be_suffix = NULL;
2052 cm->db.be_nsuffix = NULL;
2053 BER_BVZERO( &cm->db.be_rootdn );
2054 BER_BVZERO( &cm->db.be_rootndn );
2055 BER_BVZERO( &cm->db.be_rootpw );
2056 /* FIXME: there might be more... */
2058 if ( cm->db.be_private != NULL ) {
2059 backend_destroy_one( &cm->db, 0 );
2062 ldap_pvt_thread_mutex_destroy( &qm->lru_mutex );
2063 ldap_pvt_thread_mutex_destroy( &cm->cache_mutex );
2070 static slap_overinst pcache;
2072 static char *obsolete_names[] = {
2077 int pcache_initialize()
2079 LDAPAttributeType *at;
2083 at = ldap_str2attributetype( queryid_schema, &code, &err,
2084 LDAP_SCHEMA_ALLOW_ALL );
2086 Debug( LDAP_DEBUG_ANY,
2087 "pcache_initialize: ldap_str2attributetype failed %s %s\n",
2088 ldap_scherr2str(code), err, 0 );
2091 code = at_add( at, 0, NULL, &err );
2093 slap_str2ad( at->at_names[0], &ad_queryid, &err );
2097 Debug( LDAP_DEBUG_ANY,
2098 "pcache_initialize: at_add failed %s %s\n",
2099 scherr2str(code), err, 0 );
2103 pcache.on_bi.bi_type = "pcache";
2104 pcache.on_bi.bi_obsolete_names = obsolete_names;
2105 pcache.on_bi.bi_db_init = pcache_db_init;
2106 pcache.on_bi.bi_db_config = pcache_db_config;
2107 pcache.on_bi.bi_db_open = pcache_db_open;
2108 pcache.on_bi.bi_db_close = pcache_db_close;
2109 pcache.on_bi.bi_db_destroy = pcache_db_destroy;
2111 pcache.on_bi.bi_op_search = pcache_op_search;
2113 pcache.on_bi.bi_chk_controls = pcache_chk_controls;
2115 pcache.on_bi.bi_cf_ocs = pcocs;
2117 code = config_register_schema( pccfg, pcocs );
2118 if ( code ) return code;
2120 return overlay_register( &pcache );
2123 #if SLAPD_OVER_PROXYCACHE == SLAPD_MOD_DYNAMIC
2124 int init_module(int argc, char *argv[]) {
2125 return pcache_initialize();
2129 #endif /* defined(SLAPD_OVER_PROXYCACHE) */