?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Patrick Welche <prlw1@cam.ac.uk>
[netbsd-mini2440.git] / external / bsd / openldap / dist / servers / slapd / overlays / pcache.c
bloba9d6ecbffe6da954346c46d98b63c47e0d9d3176
1 /* $OpenLDAP: pkg/ldap/servers/slapd/overlays/pcache.c,v 1.88.2.17 2008/07/08 21:09:37 quanah Exp $ */
2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
3 *
4 * Copyright 2003-2008 The OpenLDAP Foundation.
5 * Portions Copyright 2003 IBM Corporation.
6 * Portions Copyright 2003 Symas Corporation.
7 * All rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted only as authorized by the OpenLDAP
11 * Public License.
12 *
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>.
16 */
17 /* ACKNOWLEDGEMENTS:
18 * This work was initially developed by Apurva Kumar for inclusion
19 * in OpenLDAP Software and subsequently rewritten by Howard Chu.
20 */
21
22 #include "portable.h"
23
24 #ifdef SLAPD_OVER_PROXYCACHE
25
26 #include <stdio.h>
27
28 #include <ac/string.h>
29 #include <ac/time.h>
30
31 #include "slap.h"
32 #include "lutil.h"
33 #include "ldap_rq.h"
34 #include "avl.h"
35
36 #include "config.h"
37
38 #ifdef LDAP_DEVEL
39 /*
40 * Control that allows to access the private DB
41 * instead of the public one
42 */
43 #define PCACHE_CONTROL_PRIVDB "1.3.6.1.4.1.4203.666.11.9.5.1"
44
45 /*
46 * Extended Operation that allows to remove a query from the cache
47 */
48 #define PCACHE_EXOP_QUERY_DELETE "1.3.6.1.4.1.4203.666.11.9.6.1"
49 #endif
50
51 /* query cache structs */
52 /* query */
53
54 typedef struct Query_s {
55 Filter* filter; /* Search Filter */
56 struct berval base; /* Search Base */
57 int scope; /* Search scope */
58 } Query;
59
60 struct query_template_s;
61
62 typedef struct Qbase_s {
63 Avlnode *scopes[4]; /* threaded AVL trees of cached queries */
64 struct berval base;
65 int queries;
66 } Qbase;
67
68 /* struct representing a cached query */
69 typedef struct cached_query_s {
70 Filter *filter;
71 Filter *first;
72 Qbase *qbase;
73 int scope;
74 struct berval q_uuid; /* query identifier */
75 int q_sizelimit;
76 struct query_template_s *qtemp; /* template of the query */
77 time_t expiry_time; /* time till the query is considered valid */
78 struct cached_query_s *next; /* next query in the template */
79 struct cached_query_s *prev; /* previous query in the template */
80 struct cached_query_s *lru_up; /* previous query in the LRU list */
81 struct cached_query_s *lru_down; /* next query in the LRU list */
82 ldap_pvt_thread_rdwr_t rwlock;
83 } CachedQuery;
84
85 /*
86 * URL representation:
87 *
88 * ldap:///<base>??<scope>?<filter>?x-uuid=<uid>,x-template=<template>,x-attrset=<attrset>,x-expiry=<expiry>
89 *
90 * <base> ::= CachedQuery.qbase->base
91 * <scope> ::= CachedQuery.scope
92 * <filter> ::= filter2bv(CachedQuery.filter)
93 * <uuid> ::= CachedQuery.q_uuid
94 * <attrset> ::= CachedQuery.qtemp->attr_set_index
95 * <expiry> ::= CachedQuery.expiry_time
96 *
97 * quick hack: parse URI, call add_query() and then fix
98 * CachedQuery.expiry_time and CachedQuery.q_uuid
99 */
100
101 /*
102 * Represents a set of projected attributes.
103 */
104
105 struct attr_set {
106 struct query_template_s *templates;
107 AttributeName* attrs; /* specifies the set */
108 unsigned flags;
109 #define PC_CONFIGURED (0x1)
110 #define PC_REFERENCED (0x2)
111 #define PC_GOT_OC (0x4)
112 int count; /* number of attributes */
113 };
114
115 /* struct representing a query template
116 * e.g. template string = &(cn=)(mail=)
117 */
118 typedef struct query_template_s {
119 struct query_template_s *qtnext;
120 struct query_template_s *qmnext;
121
122 Avlnode* qbase;
123 CachedQuery* query; /* most recent query cached for the template */
124 CachedQuery* query_last; /* oldest query cached for the template */
125 ldap_pvt_thread_rdwr_t t_rwlock; /* Rd/wr lock for accessing queries in the template */
126 struct berval querystr; /* Filter string corresponding to the QT */
127
128 int attr_set_index; /* determines the projected attributes */
129 int no_of_queries; /* Total number of queries in the template */
130 time_t ttl; /* TTL for the queries of this template */
131 time_t negttl; /* TTL for negative results */
132 time_t limitttl; /* TTL for sizelimit exceeding results */
133 struct attr_set t_attrs; /* filter attrs + attr_set */
134 } QueryTemplate;
135
136 typedef enum {
137 PC_IGNORE = 0,
138 PC_POSITIVE,
139 PC_NEGATIVE,
140 PC_SIZELIMIT
141 } pc_caching_reason_t;
142
143 static const char *pc_caching_reason_str[] = {
144 "IGNORE",
145 "POSITIVE",
146 "NEGATIVE",
147 "SIZELIMIT",
148
149 NULL
150 };
151
152 struct query_manager_s;
153
154 /* prototypes for functions for 1) query containment
155 * 2) query addition, 3) cache replacement
156 */
157 typedef CachedQuery *(QCfunc)(Operation *op, struct query_manager_s*,
158 Query*, QueryTemplate*);
159 typedef CachedQuery *(AddQueryfunc)(Operation *op, struct query_manager_s*,
160 Query*, QueryTemplate*, pc_caching_reason_t, int wlock);
161 typedef void (CRfunc)(struct query_manager_s*, struct berval*);
162
163 /* LDAP query cache */
164 typedef struct query_manager_s {
165 struct attr_set* attr_sets; /* possible sets of projected attributes */
166 QueryTemplate* templates; /* cacheable templates */
167
168 CachedQuery* lru_top; /* top and bottom of LRU list */
169 CachedQuery* lru_bottom;
170
171 ldap_pvt_thread_mutex_t lru_mutex; /* mutex for accessing LRU list */
172
173 /* Query cache methods */
174 QCfunc *qcfunc; /* Query containment*/
175 CRfunc *crfunc; /* cache replacement */
176 AddQueryfunc *addfunc; /* add query */
177 } query_manager;
178
179 /* LDAP query cache manager */
180 typedef struct cache_manager_s {
181 BackendDB db; /* underlying database */
182 unsigned long num_cached_queries; /* total number of cached queries */
183 unsigned long max_queries; /* upper bound on # of cached queries */
184 int save_queries; /* save cached queries across restarts */
185 int numattrsets; /* number of attribute sets */
186 int cur_entries; /* current number of entries cached */
187 int max_entries; /* max number of entries cached */
188 int num_entries_limit; /* max # of entries in a cacheable query */
189
190 char response_cb; /* install the response callback
191 * at the tail of the callback list */
192 #define PCACHE_RESPONSE_CB_HEAD 0
193 #define PCACHE_RESPONSE_CB_TAIL 1
194 char defer_db_open; /* defer open for online add */
195
196 time_t cc_period; /* interval between successive consistency checks (sec) */
197 int cc_paused;
198 void *cc_arg;
199
200 ldap_pvt_thread_mutex_t cache_mutex;
201
202 query_manager* qm; /* query cache managed by the cache manager */
203 } cache_manager;
204
205 static int pcache_debug;
206
207 #ifdef PCACHE_CONTROL_PRIVDB
208 static int privDB_cid;
209 #endif /* PCACHE_CONTROL_PRIVDB */
210
211 static AttributeDescription *ad_queryId, *ad_cachedQueryURL;
212 static struct {
213 char *desc;
214 AttributeDescription **adp;
215 } as[] = {
216 { "( 1.3.6.1.4.1.4203.666.11.9.1.1 "
217 "NAME 'queryId' "
218 "DESC 'ID of query the entry belongs to, formatted as a UUID' "
219 "EQUALITY octetStringMatch "
220 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.40{64} "
221 "NO-USER-MODIFICATION "
222 "USAGE directoryOperation )",
223 &ad_queryId },
224 { "( 1.3.6.1.4.1.4203.666.11.9.1.2 "
225 "NAME 'cachedQueryURL' "
226 "DESC 'URI describing a cached query' "
227 "EQUALITY caseExactMatch "
228 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.15 "
229 "NO-USER-MODIFICATION "
230 "USAGE directoryOperation )",
231 &ad_cachedQueryURL },
232 { NULL }
233 };
234
235 static int
236 filter2template(
237 Operation *op,
238 Filter *f,
239 struct berval *fstr,
240 AttributeName** filter_attrs,
241 int* filter_cnt,
242 int* filter_got_oc );
243
244 static CachedQuery *
245 add_query(
246 Operation *op,
247 query_manager* qm,
248 Query* query,
249 QueryTemplate *templ,
250 pc_caching_reason_t why,
251 int wlock);
252
253 static int
254 remove_query_data(
255 Operation *op,
256 SlapReply *rs,
257 struct berval *query_uuid );
258
259 /*
260 * Turn a cached query into its URL representation
261 */
262 static int
263 query2url( Operation *op, CachedQuery *q, struct berval *urlbv )
264 {
265 struct berval bv_scope,
266 bv_filter;
267 char attrset_buf[ 32 ],
268 expiry_buf[ 32 ],
269 *ptr;
270 ber_len_t attrset_len,
271 expiry_len;
272
273 ldap_pvt_scope2bv( q->scope, &bv_scope );
274 filter2bv_x( op, q->filter, &bv_filter );
275 attrset_len = snprintf( attrset_buf, sizeof( attrset_buf ),
276 "%lu", (unsigned long)q->qtemp->attr_set_index );
277 expiry_len = snprintf( expiry_buf, sizeof( expiry_buf ),
278 "%lu", (unsigned long)q->expiry_time );
279
280 urlbv->bv_len = STRLENOF( "ldap:///" )
281 + q->qbase->base.bv_len
282 + STRLENOF( "??" )
283 + bv_scope.bv_len
284 + STRLENOF( "?" )
285 + bv_filter.bv_len
286 + STRLENOF( "?x-uuid=" )
287 + q->q_uuid.bv_len
288 + STRLENOF( ",x-attrset=" )
289 + attrset_len
290 + STRLENOF( ",x-expiry=" )
291 + expiry_len;
292 ptr = urlbv->bv_val = ber_memalloc_x( urlbv->bv_len + 1, op->o_tmpmemctx );
293 ptr = lutil_strcopy( ptr, "ldap:///" );
294 ptr = lutil_strcopy( ptr, q->qbase->base.bv_val );
295 ptr = lutil_strcopy( ptr, "??" );
296 ptr = lutil_strcopy( ptr, bv_scope.bv_val );
297 ptr = lutil_strcopy( ptr, "?" );
298 ptr = lutil_strcopy( ptr, bv_filter.bv_val );
299 ptr = lutil_strcopy( ptr, "?x-uuid=" );
300 ptr = lutil_strcopy( ptr, q->q_uuid.bv_val );
301 ptr = lutil_strcopy( ptr, ",x-attrset=" );
302 ptr = lutil_strcopy( ptr, attrset_buf );
303 ptr = lutil_strcopy( ptr, ",x-expiry=" );
304 ptr = lutil_strcopy( ptr, expiry_buf );
305
306 ber_memfree_x( bv_filter.bv_val, op->o_tmpmemctx );
307
308 return 0;
309 }
310
311 /*
312 * Turn an URL representing a formerly cached query into a cached query,
313 * and try to cache it
314 */
315 static int
316 url2query(
317 char *url,
318 Operation *op,
319 query_manager *qm )
320 {
321 Query query = { 0 };
322 QueryTemplate *qt;
323 CachedQuery *cq;
324 LDAPURLDesc *lud = NULL;
325 struct berval base,
326 tempstr = BER_BVNULL,
327 uuid;
328 int attrset;
329 time_t expiry_time;
330 int i,
331 got_uuid = 0,
332 got_attrset = 0,
333 got_expiry = 0,
334 rc = 0;
335
336 rc = ldap_url_parse( url, &lud );
337 if ( rc != LDAP_URL_SUCCESS ) {
338 return -1;
339 }
340
341 /* non-allowed fields */
342 if ( lud->lud_host != NULL ) {
343 rc = 1;
344 goto error;
345 }
346
347 if ( lud->lud_attrs != NULL ) {
348 rc = 1;
349 goto error;
350 }
351
352 /* be pedantic */
353 if ( strcmp( lud->lud_scheme, "ldap" ) != 0 ) {
354 rc = 1;
355 goto error;
356 }
357
358 /* required fields */
359 if ( lud->lud_dn == NULL || lud->lud_dn[ 0 ] == '\0' ) {
360 rc = 1;
361 goto error;
362 }
363
364 switch ( lud->lud_scope ) {
365 case LDAP_SCOPE_BASE:
366 case LDAP_SCOPE_ONELEVEL:
367 case LDAP_SCOPE_SUBTREE:
368 case LDAP_SCOPE_SUBORDINATE:
369 break;
370
371 default:
372 rc = 1;
373 goto error;
374 }
375
376 if ( lud->lud_filter == NULL || lud->lud_filter[ 0 ] == '\0' ) {
377 rc = 1;
378 goto error;
379 }
380
381 if ( lud->lud_exts == NULL ) {
382 rc = 1;
383 goto error;
384 }
385
386 for ( i = 0; lud->lud_exts[ i ] != NULL; i++ ) {
387 if ( strncmp( lud->lud_exts[ i ], "x-uuid=", STRLENOF( "x-uuid=" ) ) == 0 ) {
388 struct berval tmpUUID;
389 Syntax *syn_UUID = slap_schema.si_ad_entryUUID->ad_type->sat_syntax;
390
391 ber_str2bv( &lud->lud_exts[ i ][ STRLENOF( "x-uuid=" ) ], 0, 0, &tmpUUID );
392 rc = syn_UUID->ssyn_pretty( syn_UUID, &tmpUUID, &uuid, NULL );
393 if ( rc != LDAP_SUCCESS ) {
394 goto error;
395 }
396 got_uuid = 1;
397
398 } else if ( strncmp( lud->lud_exts[ i ], "x-attrset=", STRLENOF( "x-attrset=" ) ) == 0 ) {
399 rc = lutil_atoi( &attrset, &lud->lud_exts[ i ][ STRLENOF( "x-attrset=" ) ] );
400 if ( rc ) {
401 goto error;
402 }
403 got_attrset = 1;
404
405 } else if ( strncmp( lud->lud_exts[ i ], "x-expiry=", STRLENOF( "x-expiry=" ) ) == 0 ) {
406 unsigned long l;
407
408 rc = lutil_atoul( &l, &lud->lud_exts[ i ][ STRLENOF( "x-expiry=" ) ] );
409 if ( rc ) {
410 goto error;
411 }
412 expiry_time = (time_t)l;
413 got_expiry = 1;
414
415 } else {
416 rc = -1;
417 goto error;
418 }
419 }
420
421 if ( !got_uuid ) {
422 rc = 1;
423 goto error;
424 }
425
426 if ( !got_attrset ) {
427 rc = 1;
428 goto error;
429 }
430
431 if ( !got_expiry ) {
432 rc = 1;
433 goto error;
434 }
435
436 /* ignore expired queries */
437 if ( expiry_time <= slap_get_time()) {
438 Operation op2 = *op;
439 SlapReply rs2 = { 0 };
440
441 memset( &op2.oq_search, 0, sizeof( op2.oq_search ) );
442
443 (void)remove_query_data( &op2, &rs2, &uuid );
444
445 rc = 0;
446
447 } else {
448 ber_str2bv( lud->lud_dn, 0, 0, &base );
449 rc = dnNormalize( 0, NULL, NULL, &base, &query.base, NULL );
450 if ( rc != LDAP_SUCCESS ) {
451 goto error;
452 }
453 query.scope = lud->lud_scope;
454 query.filter = str2filter( lud->lud_filter );
455
456 tempstr.bv_val = ch_malloc( strlen( lud->lud_filter ) + 1 );
457 tempstr.bv_len = 0;
458 if ( filter2template( op, query.filter, &tempstr, NULL, NULL, NULL ) ) {
459 ch_free( tempstr.bv_val );
460 rc = -1;
461 goto error;
462 }
463
464 /* check for query containment */
465 qt = qm->attr_sets[attrset].templates;
466 for ( ; qt; qt = qt->qtnext ) {
467 /* find if template i can potentially answer tempstr */
468 if ( bvmatch( &qt->querystr, &tempstr ) ) {
469 break;
470 }
471 }
472
473 if ( qt == NULL ) {
474 rc = 1;
475 goto error;
476 }
477
478 cq = add_query( op, qm, &query, qt, PC_POSITIVE, 0 );
479 if ( cq != NULL ) {
480 cq->expiry_time = expiry_time;
481 cq->q_uuid = uuid;
482
483 /* it's now into cq->filter */
484 BER_BVZERO( &uuid );
485 query.filter = NULL;
486
487 } else {
488 rc = 1;
489 }
490 }
491
492 error:;
493 if ( query.filter != NULL ) filter_free( query.filter );
494 if ( !BER_BVISNULL( &tempstr ) ) ch_free( tempstr.bv_val );
495 if ( !BER_BVISNULL( &query.base ) ) ch_free( query.base.bv_val );
496 if ( !BER_BVISNULL( &uuid ) ) ch_free( uuid.bv_val );
497 if ( lud != NULL ) ldap_free_urldesc( lud );
498
499 return rc;
500 }
501
502 /* Return 1 for an added entry, else 0 */
503 static int
504 merge_entry(
505 Operation *op,
506 Entry *e,
507 struct berval* query_uuid )
508 {
509 int rc;
510 Modifications* modlist = NULL;
511 const char* text = NULL;
512 Attribute *attr;
513 char textbuf[SLAP_TEXT_BUFLEN];
514 size_t textlen = sizeof(textbuf);
515
516 SlapReply sreply = {REP_RESULT};
517
518 slap_callback cb = { NULL, slap_null_cb, NULL, NULL };
519
520 attr = e->e_attrs;
521 e->e_attrs = NULL;
522
523 /* add queryId attribute */
524 attr_merge_one( e, ad_queryId, query_uuid, NULL );
525
526 /* append the attribute list from the fetched entry */
527 e->e_attrs->a_next = attr;
528
529 op->o_tag = LDAP_REQ_ADD;
530 op->o_protocol = LDAP_VERSION3;
531 op->o_callback = &cb;
532 op->o_time = slap_get_time();
533 op->o_do_not_cache = 1;
534
535 op->ora_e = e;
536 op->o_req_dn = e->e_name;
537 op->o_req_ndn = e->e_nname;
538 rc = op->o_bd->be_add( op, &sreply );
539
540 if ( rc != LDAP_SUCCESS ) {
541 if ( rc == LDAP_ALREADY_EXISTS ) {
542 slap_entry2mods( e, &modlist, &text, textbuf, textlen );
543 modlist->sml_op = LDAP_MOD_ADD;
544 op->o_tag = LDAP_REQ_MODIFY;
545 op->orm_modlist = modlist;
546 op->o_bd->be_modify( op, &sreply );
547 slap_mods_free( modlist, 1 );
548 } else if ( rc == LDAP_REFERRAL ||
549 rc == LDAP_NO_SUCH_OBJECT ) {
550 syncrepl_add_glue( op, e );
551 e = NULL;
552 rc = 1;
553 }
554 if ( e ) {
555 entry_free( e );
556 rc = 0;
557 }
558 } else {
559 if ( op->ora_e == e )
560 be_entry_release_w( op, e );
561 rc = 1;
562 }
563
564 return rc;
565 }
566
567 /* Length-ordered sort on normalized DNs */
568 static int pcache_dn_cmp( const void *v1, const void *v2 )
569 {
570 const Qbase *q1 = v1, *q2 = v2;
571
572 int rc = q1->base.bv_len - q2->base.bv_len;
573 if ( rc == 0 )
574 rc = strncmp( q1->base.bv_val, q2->base.bv_val, q1->base.bv_len );
575 return rc;
576 }
577
578 static int lex_bvcmp( struct berval *bv1, struct berval *bv2 )
579 {
580 int len, dif;
581 dif = bv1->bv_len - bv2->bv_len;
582 len = bv1->bv_len;
583 if ( dif > 0 ) len -= dif;
584 len = memcmp( bv1->bv_val, bv2->bv_val, len );
585 if ( !len )
586 len = dif;
587 return len;
588 }
589
590 /* compare the first value in each filter */
591 static int pcache_filter_cmp( const void *v1, const void *v2 )
592 {
593 const CachedQuery *q1 = v1, *q2 =v2;
594 int rc, weight1, weight2;
595
596 switch( q1->first->f_choice ) {
597 case LDAP_FILTER_PRESENT:
598 weight1 = 0;
599 break;
600 case LDAP_FILTER_EQUALITY:
601 case LDAP_FILTER_GE:
602 case LDAP_FILTER_LE:
603 weight1 = 1;
604 break;
605 default:
606 weight1 = 2;
607 }
608 switch( q2->first->f_choice ) {
609 case LDAP_FILTER_PRESENT:
610 weight2 = 0;
611 break;
612 case LDAP_FILTER_EQUALITY:
613 case LDAP_FILTER_GE:
614 case LDAP_FILTER_LE:
615 weight2 = 1;
616 break;
617 default:
618 weight2 = 2;
619 }
620 rc = weight1 - weight2;
621 if ( !rc ) {
622 switch( weight1 ) {
623 case 0: return 0;
624 case 1:
625 rc = lex_bvcmp( &q1->first->f_av_value, &q2->first->f_av_value );
626 break;
627 case 2:
628 if ( q1->first->f_choice == LDAP_FILTER_SUBSTRINGS ) {
629 rc = 0;
630 if ( !BER_BVISNULL( &q1->first->f_sub_initial )) {
631 if ( !BER_BVISNULL( &q2->first->f_sub_initial )) {
632 rc = lex_bvcmp( &q1->first->f_sub_initial,
633 &q2->first->f_sub_initial );
634 } else {
635 rc = 1;
636 }
637 } else if ( !BER_BVISNULL( &q2->first->f_sub_initial )) {
638 rc = -1;
639 }
640 if ( rc ) break;
641 if ( q1->first->f_sub_any ) {
642 if ( q2->first->f_sub_any ) {
643 rc = lex_bvcmp( q1->first->f_sub_any,
644 q2->first->f_sub_any );
645 } else {
646 rc = 1;
647 }
648 } else if ( q2->first->f_sub_any ) {
649 rc = -1;
650 }
651 if ( rc ) break;
652 if ( !BER_BVISNULL( &q1->first->f_sub_final )) {
653 if ( !BER_BVISNULL( &q2->first->f_sub_final )) {
654 rc = lex_bvcmp( &q1->first->f_sub_final,
655 &q2->first->f_sub_final );
656 } else {
657 rc = 1;
658 }
659 } else if ( !BER_BVISNULL( &q2->first->f_sub_final )) {
660 rc = -1;
661 }
662 } else {
663 rc = lex_bvcmp( &q1->first->f_mr_value,
664 &q2->first->f_mr_value );
665 }
666 break;
667 }
668 }
669
670 return rc;
671 }
672
673 /* add query on top of LRU list */
674 static void
675 add_query_on_top (query_manager* qm, CachedQuery* qc)
676 {
677 CachedQuery* top = qm->lru_top;
678
679 qm->lru_top = qc;
680
681 if (top)
682 top->lru_up = qc;
683 else
684 qm->lru_bottom = qc;
685
686 qc->lru_down = top;
687 qc->lru_up = NULL;
688 Debug( pcache_debug, "Base of added query = %s\n",
689 qc->qbase->base.bv_val, 0, 0 );
690 }
691
692 /* remove_query from LRU list */
693
694 static void
695 remove_query (query_manager* qm, CachedQuery* qc)
696 {
697 CachedQuery* up;
698 CachedQuery* down;
699
700 if (!qc)
701 return;
702
703 up = qc->lru_up;
704 down = qc->lru_down;
705
706 if (!up)
707 qm->lru_top = down;
708
709 if (!down)
710 qm->lru_bottom = up;
711
712 if (down)
713 down->lru_up = up;
714
715 if (up)
716 up->lru_down = down;
717
718 qc->lru_up = qc->lru_down = NULL;
719 }
720
721 /* find and remove string2 from string1
722 * from start if position = 1,
723 * from end if position = 3,
724 * from anywhere if position = 2
725 * string1 is overwritten if position = 2.
726 */
727
728 static int
729 find_and_remove(struct berval* ber1, struct berval* ber2, int position)
730 {
731 int ret=0;
732
733 if ( !ber2->bv_val )
734 return 1;
735 if ( !ber1->bv_val )
736 return 0;
737
738 switch( position ) {
739 case 1:
740 if ( ber1->bv_len >= ber2->bv_len && !memcmp( ber1->bv_val,
741 ber2->bv_val, ber2->bv_len )) {
742 ret = 1;
743 ber1->bv_val += ber2->bv_len;
744 ber1->bv_len -= ber2->bv_len;
745 }
746 break;
747 case 2: {
748 char *temp;
749 ber1->bv_val[ber1->bv_len] = '\0';
750 temp = strstr( ber1->bv_val, ber2->bv_val );
751 if ( temp ) {
752 strcpy( temp, temp+ber2->bv_len );
753 ber1->bv_len -= ber2->bv_len;
754 ret = 1;
755 }
756 break;
757 }
758 case 3:
759 if ( ber1->bv_len >= ber2->bv_len &&
760 !memcmp( ber1->bv_val+ber1->bv_len-ber2->bv_len, ber2->bv_val,
761 ber2->bv_len )) {
762 ret = 1;
763 ber1->bv_len -= ber2->bv_len;
764 }
765 break;
766 }
767 return ret;
768 }
769
770
771 static struct berval*
772 merge_init_final(Operation *op, struct berval* init, struct berval* any,
773 struct berval* final)
774 {
775 struct berval* merged, *temp;
776 int i, any_count, count;
777
778 for (any_count=0; any && any[any_count].bv_val; any_count++)
779 ;
780
781 count = any_count;
782
783 if (init->bv_val)
784 count++;
785 if (final->bv_val)
786 count++;
787
788 merged = (struct berval*)op->o_tmpalloc( (count+1)*sizeof(struct berval),
789 op->o_tmpmemctx );
790 temp = merged;
791
792 if (init->bv_val) {
793 ber_dupbv_x( temp, init, op->o_tmpmemctx );
794 temp++;
795 }
796
797 for (i=0; i<any_count; i++) {
798 ber_dupbv_x( temp, any, op->o_tmpmemctx );
799 temp++; any++;
800 }
801
802 if (final->bv_val){
803 ber_dupbv_x( temp, final, op->o_tmpmemctx );
804 temp++;
805 }
806 BER_BVZERO( temp );
807 return merged;
808 }
809
810 /* Each element in stored must be found in incoming. Incoming is overwritten.
811 */
812 static int
813 strings_containment(struct berval* stored, struct berval* incoming)
814 {
815 struct berval* element;
816 int k=0;
817 int j, rc = 0;
818
819 for ( element=stored; element->bv_val != NULL; element++ ) {
820 for (j = k; incoming[j].bv_val != NULL; j++) {
821 if (find_and_remove(&(incoming[j]), element, 2)) {
822 k = j;
823 rc = 1;
824 break;
825 }
826 rc = 0;
827 }
828 if ( rc ) {
829 continue;
830 } else {
831 return 0;
832 }
833 }
834 return 1;
835 }
836
837 static int
838 substr_containment_substr(Operation *op, Filter* stored, Filter* incoming)
839 {
840 int rc = 0;
841
842 struct berval init_incoming;
843 struct berval final_incoming;
844 struct berval *remaining_incoming = NULL;
845
846 if ((!(incoming->f_sub_initial.bv_val) && (stored->f_sub_initial.bv_val))
847 || (!(incoming->f_sub_final.bv_val) && (stored->f_sub_final.bv_val)))
848 return 0;
849
850 init_incoming = incoming->f_sub_initial;
851 final_incoming = incoming->f_sub_final;
852
853 if (find_and_remove(&init_incoming,
854 &(stored->f_sub_initial), 1) && find_and_remove(&final_incoming,
855 &(stored->f_sub_final), 3))
856 {
857 if (stored->f_sub_any == NULL) {
858 rc = 1;
859 goto final;
860 }
861 remaining_incoming = merge_init_final(op, &init_incoming,
862 incoming->f_sub_any, &final_incoming);
863 rc = strings_containment(stored->f_sub_any, remaining_incoming);
864 ber_bvarray_free_x( remaining_incoming, op->o_tmpmemctx );
865 }
866 final:
867 return rc;
868 }
869
870 static int
871 substr_containment_equality(Operation *op, Filter* stored, Filter* incoming)
872 {
873 struct berval incoming_val[2];
874 int rc = 0;
875
876 incoming_val[1] = incoming->f_av_value;
877
878 if (find_and_remove(incoming_val+1,
879 &(stored->f_sub_initial), 1) && find_and_remove(incoming_val+1,
880 &(stored->f_sub_final), 3)) {
881 if (stored->f_sub_any == NULL){
882 rc = 1;
883 goto final;
884 }
885 ber_dupbv_x( incoming_val, incoming_val+1, op->o_tmpmemctx );
886 BER_BVZERO( incoming_val+1 );
887 rc = strings_containment(stored->f_sub_any, incoming_val);
888 op->o_tmpfree( incoming_val[0].bv_val, op->o_tmpmemctx );
889 }
890 final:
891 return rc;
892 }
893
894 static Filter *
895 filter_first( Filter *f )
896 {
897 while ( f->f_choice == LDAP_FILTER_OR || f->f_choice == LDAP_FILTER_AND )
898 f = f->f_and;
899 return f;
900 }
901
902
903 static CachedQuery *
904 find_filter( Operation *op, Avlnode *root, Filter *inputf, Filter *first )
905 {
906 Filter* fs;
907 Filter* fi;
908 MatchingRule* mrule = NULL;
909 int res=0, eqpass= 0;
910 int ret, rc, dir;
911 Avlnode *ptr;
912 CachedQuery cq, *qc;
913
914 cq.filter = inputf;
915 cq.first = first;
916
917 /* substring matches sort to the end, and we just have to
918 * walk the entire list.
919 */
920 if ( first->f_choice == LDAP_FILTER_SUBSTRINGS ) {
921 ptr = tavl_end( root, 1 );
922 dir = TAVL_DIR_LEFT;
923 } else {
924 ptr = tavl_find3( root, &cq, pcache_filter_cmp, &ret );
925 dir = (first->f_choice == LDAP_FILTER_GE) ? TAVL_DIR_LEFT :
926 TAVL_DIR_RIGHT;
927 }
928
929 while (ptr) {
930 qc = ptr->avl_data;
931 fi = inputf;
932 fs = qc->filter;
933
934 /* an incoming substr query can only be satisfied by a cached
935 * substr query.
936 */
937 if ( first->f_choice == LDAP_FILTER_SUBSTRINGS &&
938 qc->first->f_choice != LDAP_FILTER_SUBSTRINGS )
939 break;
940
941 /* an incoming eq query can be satisfied by a cached eq or substr
942 * query
943 */
944 if ( first->f_choice == LDAP_FILTER_EQUALITY ) {
945 if ( eqpass == 0 ) {
946 if ( qc->first->f_choice != LDAP_FILTER_EQUALITY ) {
947 nextpass: eqpass = 1;
948 ptr = tavl_end( root, 1 );
949 dir = TAVL_DIR_LEFT;
950 continue;
951 }
952 } else {
953 if ( qc->first->f_choice != LDAP_FILTER_SUBSTRINGS )
954 break;
955 }
956 }
957 do {
958 res=0;
959 switch (fs->f_choice) {
960 case LDAP_FILTER_EQUALITY:
961 if (fi->f_choice == LDAP_FILTER_EQUALITY)
962 mrule = fs->f_ava->aa_desc->ad_type->sat_equality;
963 else
964 ret = 1;
965 break;
966 case LDAP_FILTER_GE:
967 case LDAP_FILTER_LE:
968 mrule = fs->f_ava->aa_desc->ad_type->sat_ordering;
969 break;
970 default:
971 mrule = NULL;
972 }
973 if (mrule) {
974 const char *text;
975 rc = value_match(&ret, fs->f_ava->aa_desc, mrule,
976 SLAP_MR_VALUE_OF_ASSERTION_SYNTAX,
977 &(fi->f_ava->aa_value),
978 &(fs->f_ava->aa_value), &text);
979 if (rc != LDAP_SUCCESS) {
980 return NULL;
981 }
982 if ( fi==first && fi->f_choice==LDAP_FILTER_EQUALITY && ret )
983 goto nextpass;
984 }
985 switch (fs->f_choice) {
986 case LDAP_FILTER_OR:
987 case LDAP_FILTER_AND:
988 fs = fs->f_and;
989 fi = fi->f_and;
990 res=1;
991 break;
992 case LDAP_FILTER_SUBSTRINGS:
993 /* check if the equality query can be
994 * answered with cached substring query */
995 if ((fi->f_choice == LDAP_FILTER_EQUALITY)
996 && substr_containment_equality( op,
997 fs, fi))
998 res=1;
999 /* check if the substring query can be
1000 * answered with cached substring query */
1001 if ((fi->f_choice ==LDAP_FILTER_SUBSTRINGS
1002 ) && substr_containment_substr( op,
1003 fs, fi))
1004 res= 1;
1005 fs=fs->f_next;
1006 fi=fi->f_next;
1007 break;
1008 case LDAP_FILTER_PRESENT:
1009 res=1;
1010 fs=fs->f_next;
1011 fi=fi->f_next;
1012 break;
1013 case LDAP_FILTER_EQUALITY:
1014 if (ret == 0)
1015 res = 1;
1016 fs=fs->f_next;
1017 fi=fi->f_next;
1018 break;
1019 case LDAP_FILTER_GE:
1020 if (mrule && ret >= 0)
1021 res = 1;
1022 fs=fs->f_next;
1023 fi=fi->f_next;
1024 break;
1025 case LDAP_FILTER_LE:
1026 if (mrule && ret <= 0)
1027 res = 1;
1028 fs=fs->f_next;
1029 fi=fi->f_next;
1030 break;
1031 case LDAP_FILTER_NOT:
1032 res=0;
1033 break;
1034 default:
1035 break;
1036 }
1037 } while((res) && (fi != NULL) && (fs != NULL));
1038
1039 if ( res )
1040 return qc;
1041 ptr = tavl_next( ptr, dir );
1042 }
1043 return NULL;
1044 }
1045
1046 /* check whether query is contained in any of
1047 * the cached queries in template
1048 */
1049 static CachedQuery *
1050 query_containment(Operation *op, query_manager *qm,
1051 Query *query,
1052 QueryTemplate *templa)
1053 {
1054 CachedQuery* qc;
1055 int depth = 0, tscope;
1056 Qbase qbase, *qbptr = NULL;
1057 struct berval pdn;
1058
1059 if (query->filter != NULL) {
1060 Filter *first;
1061
1062 Debug( pcache_debug, "Lock QC index = %p\n",
1063 (void *) templa, 0, 0 );
1064 qbase.base = query->base;
1065
1066 first = filter_first( query->filter );
1067
1068 ldap_pvt_thread_rdwr_rlock(&templa->t_rwlock);
1069 for( ;; ) {
1070 /* Find the base */
1071 qbptr = avl_find( templa->qbase, &qbase, pcache_dn_cmp );
1072 if ( qbptr ) {
1073 tscope = query->scope;
1074 /* Find a matching scope:
1075 * match at depth 0 OK
1076 * scope is BASE,
1077 * one at depth 1 OK
1078 * subord at depth > 0 OK
1079 * subtree at any depth OK
1080 * scope is ONE,
1081 * subtree or subord at any depth OK
1082 * scope is SUBORD,
1083 * subtree or subord at any depth OK
1084 * scope is SUBTREE,
1085 * subord at depth > 0 OK
1086 * subtree at any depth OK
1087 */
1088 for ( tscope = 0 ; tscope <= LDAP_SCOPE_CHILDREN; tscope++ ) {
1089 switch ( query->scope ) {
1090 case LDAP_SCOPE_BASE:
1091 if ( tscope == LDAP_SCOPE_BASE && depth ) continue;
1092 if ( tscope == LDAP_SCOPE_ONE && depth != 1) continue;
1093 if ( tscope == LDAP_SCOPE_CHILDREN && !depth ) continue;
1094 break;
1095 case LDAP_SCOPE_ONE:
1096 if ( tscope == LDAP_SCOPE_BASE )
1097 tscope = LDAP_SCOPE_ONE;
1098 if ( tscope == LDAP_SCOPE_ONE && depth ) continue;
1099 if ( !depth ) break;
1100 if ( tscope < LDAP_SCOPE_SUBTREE )
1101 tscope = LDAP_SCOPE_SUBTREE;
1102 break;
1103 case LDAP_SCOPE_SUBTREE:
1104 if ( tscope < LDAP_SCOPE_SUBTREE )
1105 tscope = LDAP_SCOPE_SUBTREE;
1106 if ( tscope == LDAP_SCOPE_CHILDREN && !depth ) continue;
1107 break;
1108 case LDAP_SCOPE_CHILDREN:
1109 if ( tscope < LDAP_SCOPE_SUBTREE )
1110 tscope = LDAP_SCOPE_SUBTREE;
1111 break;
1112 }
1113 if ( !qbptr->scopes[tscope] ) continue;
1114
1115 /* Find filter */
1116 qc = find_filter( op, qbptr->scopes[tscope],
1117 query->filter, first );
1118 if ( qc ) {
1119 if ( qc->q_sizelimit ) {
1120 ldap_pvt_thread_rdwr_runlock(&templa->t_rwlock);
1121 return NULL;
1122 }
1123 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
1124 if (qm->lru_top != qc) {
1125 remove_query(qm, qc);
1126 add_query_on_top(qm, qc);
1127 }
1128 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1129 return qc;
1130 }
1131 }
1132 }
1133 if ( be_issuffix( op->o_bd, &qbase.base ))
1134 break;
1135 /* Up a level */
1136 dnParent( &qbase.base, &pdn );
1137 qbase.base = pdn;
1138 depth++;
1139 }
1140
1141 Debug( pcache_debug,
1142 "Not answerable: Unlock QC index=%p\n",
1143 (void *) templa, 0, 0 );
1144 ldap_pvt_thread_rdwr_runlock(&templa->t_rwlock);
1145 }
1146 return NULL;
1147 }
1148
1149 static void
1150 free_query (CachedQuery* qc)
1151 {
1152 free(qc->q_uuid.bv_val);
1153 filter_free(qc->filter);
1154 free(qc);
1155 }
1156
1157
1158 /* Add query to query cache, the returned Query is locked for writing */
1159 static CachedQuery *
1160 add_query(
1161 Operation *op,
1162 query_manager* qm,
1163 Query* query,
1164 QueryTemplate *templ,
1165 pc_caching_reason_t why,
1166 int wlock)
1167 {
1168 CachedQuery* new_cached_query = (CachedQuery*) ch_malloc(sizeof(CachedQuery));
1169 Qbase *qbase, qb;
1170 Filter *first;
1171 int rc;
1172 time_t ttl = 0;;
1173
1174 new_cached_query->qtemp = templ;
1175 BER_BVZERO( &new_cached_query->q_uuid );
1176 new_cached_query->q_sizelimit = 0;
1177
1178 switch ( why ) {
1179 case PC_POSITIVE:
1180 ttl = templ->ttl;
1181 break;
1182
1183 case PC_NEGATIVE:
1184 ttl = templ->negttl;
1185 break;
1186
1187 case PC_SIZELIMIT:
1188 ttl = templ->limitttl;
1189 break;
1190
1191 default:
1192 assert( 0 );
1193 break;
1194 }
1195 new_cached_query->expiry_time = slap_get_time() + ttl;
1196 new_cached_query->lru_up = NULL;
1197 new_cached_query->lru_down = NULL;
1198 Debug( pcache_debug, "Added query expires at %ld (%s)\n",
1199 (long) new_cached_query->expiry_time,
1200 pc_caching_reason_str[ why ], 0 );
1201
1202 new_cached_query->scope = query->scope;
1203 new_cached_query->filter = query->filter;
1204 new_cached_query->first = first = filter_first( query->filter );
1205
1206 ldap_pvt_thread_rdwr_init(&new_cached_query->rwlock);
1207 if (wlock)
1208 ldap_pvt_thread_rdwr_wlock(&new_cached_query->rwlock);
1209
1210 qb.base = query->base;
1211
1212 /* Adding a query */
1213 Debug( pcache_debug, "Lock AQ index = %p\n",
1214 (void *) templ, 0, 0 );
1215 ldap_pvt_thread_rdwr_wlock(&templ->t_rwlock);
1216 qbase = avl_find( templ->qbase, &qb, pcache_dn_cmp );
1217 if ( !qbase ) {
1218 qbase = ch_calloc( 1, sizeof(Qbase) + qb.base.bv_len + 1 );
1219 qbase->base.bv_len = qb.base.bv_len;
1220 qbase->base.bv_val = (char *)(qbase+1);
1221 memcpy( qbase->base.bv_val, qb.base.bv_val, qb.base.bv_len );
1222 qbase->base.bv_val[qbase->base.bv_len] = '\0';
1223 avl_insert( &templ->qbase, qbase, pcache_dn_cmp, avl_dup_error );
1224 }
1225 new_cached_query->next = templ->query;
1226 new_cached_query->prev = NULL;
1227 new_cached_query->qbase = qbase;
1228 rc = tavl_insert( &qbase->scopes[query->scope], new_cached_query,
1229 pcache_filter_cmp, avl_dup_error );
1230 if ( rc == 0 ) {
1231 qbase->queries++;
1232 if (templ->query == NULL)
1233 templ->query_last = new_cached_query;
1234 else
1235 templ->query->prev = new_cached_query;
1236 templ->query = new_cached_query;
1237 templ->no_of_queries++;
1238 } else {
1239 ch_free( new_cached_query );
1240 new_cached_query = find_filter( op, qbase->scopes[query->scope],
1241 query->filter, first );
1242 filter_free( query->filter );
1243 }
1244 Debug( pcache_debug, "TEMPLATE %p QUERIES++ %d\n",
1245 (void *) templ, templ->no_of_queries, 0 );
1246
1247 Debug( pcache_debug, "Unlock AQ index = %p \n",
1248 (void *) templ, 0, 0 );
1249 ldap_pvt_thread_rdwr_wunlock(&templ->t_rwlock);
1250
1251 /* Adding on top of LRU list */
1252 if ( rc == 0 ) {
1253 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
1254 add_query_on_top(qm, new_cached_query);
1255 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1256 }
1257 return rc == 0 ? new_cached_query : NULL;
1258 }
1259
1260 static void
1261 remove_from_template (CachedQuery* qc, QueryTemplate* template)
1262 {
1263 if (!qc->prev && !qc->next) {
1264 template->query_last = template->query = NULL;
1265 } else if (qc->prev == NULL) {
1266 qc->next->prev = NULL;
1267 template->query = qc->next;
1268 } else if (qc->next == NULL) {
1269 qc->prev->next = NULL;
1270 template->query_last = qc->prev;
1271 } else {
1272 qc->next->prev = qc->prev;
1273 qc->prev->next = qc->next;
1274 }
1275 tavl_delete( &qc->qbase->scopes[qc->scope], qc, pcache_filter_cmp );
1276 qc->qbase->queries--;
1277 if ( qc->qbase->queries == 0 ) {
1278 avl_delete( &template->qbase, qc->qbase, pcache_dn_cmp );
1279 ch_free( qc->qbase );
1280 qc->qbase = NULL;
1281 }
1282
1283 template->no_of_queries--;
1284 }
1285
1286 /* remove bottom query of LRU list from the query cache */
1287 /*
1288 * NOTE: slight change in functionality.
1289 *
1290 * - if result->bv_val is NULL, the query at the bottom of the LRU
1291 * is removed
1292 * - otherwise, the query whose UUID is *result is removed
1293 * - if not found, result->bv_val is zeroed
1294 */
1295 static void
1296 cache_replacement(query_manager* qm, struct berval *result)
1297 {
1298 CachedQuery* bottom;
1299 QueryTemplate *temp;
1300
1301 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
1302 if ( BER_BVISNULL( result ) ) {
1303 bottom = qm->lru_bottom;
1304
1305 if (!bottom) {
1306 Debug ( pcache_debug,
1307 "Cache replacement invoked without "
1308 "any query in LRU list\n", 0, 0, 0 );
1309 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1310 return;
1311 }
1312
1313 } else {
1314 for ( bottom = qm->lru_bottom;
1315 bottom != NULL;
1316 bottom = bottom->lru_up )
1317 {
1318 if ( bvmatch( result, &bottom->q_uuid ) ) {
1319 break;
1320 }
1321 }
1322
1323 if ( !bottom ) {
1324 Debug ( pcache_debug,
1325 "Could not find query with uuid=\"%s\""
1326 "in LRU list\n", result->bv_val, 0, 0 );
1327 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1328 BER_BVZERO( result );
1329 return;
1330 }
1331 }
1332
1333 temp = bottom->qtemp;
1334 remove_query(qm, bottom);
1335 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1336
1337 *result = bottom->q_uuid;
1338 BER_BVZERO( &bottom->q_uuid );
1339
1340 Debug( pcache_debug, "Lock CR index = %p\n", (void *) temp, 0, 0 );
1341 ldap_pvt_thread_rdwr_wlock(&temp->t_rwlock);
1342 remove_from_template(bottom, temp);
1343 Debug( pcache_debug, "TEMPLATE %p QUERIES-- %d\n",
1344 (void *) temp, temp->no_of_queries, 0 );
1345 Debug( pcache_debug, "Unlock CR index = %p\n", (void *) temp, 0, 0 );
1346 ldap_pvt_thread_rdwr_wunlock(&temp->t_rwlock);
1347 free_query(bottom);
1348 }
1349
1350 struct query_info {
1351 struct query_info *next;
1352 struct berval xdn;
1353 int del;
1354 };
1355
1356 static int
1357 remove_func (
1358 Operation *op,
1359 SlapReply *rs
1360 )
1361 {
1362 Attribute *attr;
1363 struct query_info *qi;
1364 int count = 0;
1365
1366 if ( rs->sr_type != REP_SEARCH ) return 0;
1367
1368 attr = attr_find( rs->sr_entry->e_attrs, ad_queryId );
1369 if ( attr == NULL ) return 0;
1370
1371 count = attr->a_numvals;
1372 assert( count > 0 );
1373 qi = op->o_tmpalloc( sizeof( struct query_info ), op->o_tmpmemctx );
1374 qi->next = op->o_callback->sc_private;
1375 op->o_callback->sc_private = qi;
1376 ber_dupbv_x( &qi->xdn, &rs->sr_entry->e_nname, op->o_tmpmemctx );
1377 qi->del = ( count == 1 );
1378
1379 return 0;
1380 }
1381
1382 static int
1383 remove_query_data(
1384 Operation *op,
1385 SlapReply *rs,
1386 struct berval *query_uuid )
1387 {
1388 struct query_info *qi, *qnext;
1389 char filter_str[ LDAP_LUTIL_UUIDSTR_BUFSIZE + STRLENOF( "(queryId=)" ) ];
1390 AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
1391 Filter filter = {LDAP_FILTER_EQUALITY};
1392 SlapReply sreply = {REP_RESULT};
1393 slap_callback cb = { NULL, remove_func, NULL, NULL };
1394 int deleted = 0;
1395
1396 sreply.sr_entry = NULL;
1397 sreply.sr_nentries = 0;
1398 op->ors_filterstr.bv_len = snprintf(filter_str, sizeof(filter_str),
1399 "(%s=%s)", ad_queryId->ad_cname.bv_val, query_uuid->bv_val);
1400 filter.f_ava = &ava;
1401 filter.f_av_desc = ad_queryId;
1402 filter.f_av_value = *query_uuid;
1403
1404 op->o_tag = LDAP_REQ_SEARCH;
1405 op->o_protocol = LDAP_VERSION3;
1406 op->o_callback = &cb;
1407 op->o_time = slap_get_time();
1408 op->o_do_not_cache = 1;
1409
1410 op->o_req_dn = op->o_bd->be_suffix[0];
1411 op->o_req_ndn = op->o_bd->be_nsuffix[0];
1412 op->ors_scope = LDAP_SCOPE_SUBTREE;
1413 op->ors_deref = LDAP_DEREF_NEVER;
1414 op->ors_slimit = SLAP_NO_LIMIT;
1415 op->ors_tlimit = SLAP_NO_LIMIT;
1416 op->ors_filter = &filter;
1417 op->ors_filterstr.bv_val = filter_str;
1418 op->ors_filterstr.bv_len = strlen(filter_str);
1419 op->ors_attrs = NULL;
1420 op->ors_attrsonly = 0;
1421
1422 op->o_bd->be_search( op, &sreply );
1423
1424 for ( qi=cb.sc_private; qi; qi=qnext ) {
1425 qnext = qi->next;
1426
1427 op->o_req_dn = qi->xdn;
1428 op->o_req_ndn = qi->xdn;
1429
1430 if ( qi->del ) {
1431 Debug( pcache_debug, "DELETING ENTRY TEMPLATE=%s\n",
1432 query_uuid->bv_val, 0, 0 );
1433
1434 op->o_tag = LDAP_REQ_DELETE;
1435
1436 if (op->o_bd->be_delete(op, &sreply) == LDAP_SUCCESS) {
1437 deleted++;
1438 }
1439
1440 } else {
1441 Modifications mod;
1442 struct berval vals[2];
1443
1444 vals[0] = *query_uuid;
1445 vals[1].bv_val = NULL;
1446 vals[1].bv_len = 0;
1447 mod.sml_op = LDAP_MOD_DELETE;
1448 mod.sml_flags = 0;
1449 mod.sml_desc = ad_queryId;
1450 mod.sml_type = ad_queryId->ad_cname;
1451 mod.sml_values = vals;
1452 mod.sml_nvalues = NULL;
1453 mod.sml_numvals = 1;
1454 mod.sml_next = NULL;
1455 Debug( pcache_debug,
1456 "REMOVING TEMP ATTR : TEMPLATE=%s\n",
1457 query_uuid->bv_val, 0, 0 );
1458
1459 op->orm_modlist = &mod;
1460
1461 op->o_bd->be_modify( op, &sreply );
1462 }
1463 op->o_tmpfree( qi->xdn.bv_val, op->o_tmpmemctx );
1464 op->o_tmpfree( qi, op->o_tmpmemctx );
1465 }
1466 return deleted;
1467 }
1468
1469 static int
1470 get_attr_set(
1471 AttributeName* attrs,
1472 query_manager* qm,
1473 int num
1474 );
1475
1476 static int
1477 filter2template(
1478 Operation *op,
1479 Filter *f,
1480 struct berval *fstr,
1481 AttributeName** filter_attrs,
1482 int* filter_cnt,
1483 int* filter_got_oc )
1484 {
1485 AttributeDescription *ad;
1486 int len, ret;
1487
1488 switch ( f->f_choice ) {
1489 case LDAP_FILTER_EQUALITY:
1490 ad = f->f_av_desc;
1491 len = STRLENOF( "(=)" ) + ad->ad_cname.bv_len;
1492 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s=)", ad->ad_cname.bv_val );
1493 assert( ret == len );
1494 fstr->bv_len += len;
1495 break;
1496
1497 case LDAP_FILTER_GE:
1498 ad = f->f_av_desc;
1499 len = STRLENOF( "(>=)" ) + ad->ad_cname.bv_len;
1500 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s>=)", ad->ad_cname.bv_val);
1501 assert( ret == len );
1502 fstr->bv_len += len;
1503 break;
1504
1505 case LDAP_FILTER_LE:
1506 ad = f->f_av_desc;
1507 len = STRLENOF( "(<=)" ) + ad->ad_cname.bv_len;
1508 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s<=)", ad->ad_cname.bv_val);
1509 assert( ret == len );
1510 fstr->bv_len += len;
1511 break;
1512
1513 case LDAP_FILTER_APPROX:
1514 ad = f->f_av_desc;
1515 len = STRLENOF( "(~=)" ) + ad->ad_cname.bv_len;
1516 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s~=)", ad->ad_cname.bv_val);
1517 assert( ret == len );
1518 fstr->bv_len += len;
1519 break;
1520
1521 case LDAP_FILTER_SUBSTRINGS:
1522 ad = f->f_sub_desc;
1523 len = STRLENOF( "(=)" ) + ad->ad_cname.bv_len;
1524 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s=)", ad->ad_cname.bv_val );
1525 assert( ret == len );
1526 fstr->bv_len += len;
1527 break;
1528
1529 case LDAP_FILTER_PRESENT:
1530 ad = f->f_desc;
1531 len = STRLENOF( "(=*)" ) + ad->ad_cname.bv_len;
1532 ret = snprintf( fstr->bv_val+fstr->bv_len, len + 1, "(%s=*)", ad->ad_cname.bv_val );
1533 assert( ret == len );
1534 fstr->bv_len += len;
1535 break;
1536
1537 case LDAP_FILTER_AND:
1538 case LDAP_FILTER_OR:
1539 case LDAP_FILTER_NOT: {
1540 int rc = 0;
1541 fstr->bv_val[fstr->bv_len++] = '(';
1542 switch ( f->f_choice ) {
1543 case LDAP_FILTER_AND:
1544 fstr->bv_val[fstr->bv_len] = '&';
1545 break;
1546 case LDAP_FILTER_OR:
1547 fstr->bv_val[fstr->bv_len] = '|';
1548 break;
1549 case LDAP_FILTER_NOT:
1550 fstr->bv_val[fstr->bv_len] = '!';
1551 break;
1552 }
1553 fstr->bv_len++;
1554
1555 for ( f = f->f_list; f != NULL; f = f->f_next ) {
1556 rc = filter2template( op, f, fstr, filter_attrs, filter_cnt,
1557 filter_got_oc );
1558 if ( rc ) break;
1559 }
1560 fstr->bv_val[fstr->bv_len++] = ')';
1561 fstr->bv_val[fstr->bv_len] = '\0';
1562
1563 return rc;
1564 }
1565
1566 default:
1567 /* a filter should at least have room for "()",
1568 * an "=" and for a 1-char attr */
1569 strcpy( fstr->bv_val, "(?=)" );
1570 fstr->bv_len += STRLENOF("(?=)");
1571 return -1;
1572 }
1573
1574 if ( filter_attrs != NULL ) {
1575 *filter_attrs = (AttributeName *)op->o_tmprealloc(*filter_attrs,
1576 (*filter_cnt + 2)*sizeof(AttributeName), op->o_tmpmemctx);
1577
1578 (*filter_attrs)[*filter_cnt].an_desc = ad;
1579 (*filter_attrs)[*filter_cnt].an_name = ad->ad_cname;
1580 (*filter_attrs)[*filter_cnt].an_oc = NULL;
1581 (*filter_attrs)[*filter_cnt].an_oc_exclude = 0;
1582 BER_BVZERO( &(*filter_attrs)[*filter_cnt+1].an_name );
1583 (*filter_cnt)++;
1584 if ( ad == slap_schema.si_ad_objectClass )
1585 *filter_got_oc = 1;
1586 }
1587
1588 return 0;
1589 }
1590
1591 struct search_info {
1592 slap_overinst *on;
1593 Query query;
1594 QueryTemplate *qtemp;
1595 AttributeName* save_attrs; /* original attributes, saved for response */
1596 int max;
1597 int over;
1598 int count;
1599 int slimit;
1600 int slimit_exceeded;
1601 pc_caching_reason_t caching_reason;
1602 Entry *head, *tail;
1603 };
1604
1605 static void
1606 remove_query_and_data(
1607 Operation *op,
1608 SlapReply *rs,
1609 cache_manager *cm,
1610 struct berval *uuid )
1611 {
1612 query_manager* qm = cm->qm;
1613
1614 qm->crfunc( qm, uuid );
1615 if ( !BER_BVISNULL( uuid ) ) {
1616 int return_val;
1617
1618 Debug( pcache_debug,
1619 "Removing query UUID %s\n",
1620 uuid->bv_val, 0, 0 );
1621 return_val = remove_query_data( op, rs, uuid );
1622 Debug( pcache_debug,
1623 "QUERY REMOVED, SIZE=%d\n",
1624 return_val, 0, 0);
1625 ldap_pvt_thread_mutex_lock( &cm->cache_mutex );
1626 cm->cur_entries -= return_val;
1627 cm->num_cached_queries--;
1628 Debug( pcache_debug,
1629 "STORED QUERIES = %lu\n",
1630 cm->num_cached_queries, 0, 0 );
1631 ldap_pvt_thread_mutex_unlock( &cm->cache_mutex );
1632 Debug( pcache_debug,
1633 "QUERY REMOVED, CACHE ="
1634 "%d entries\n",
1635 cm->cur_entries, 0, 0 );
1636 }
1637 }
1638
1639 /*
1640 * Callback used to fetch queryId values based on entryUUID;
1641 * used by pcache_remove_entries_from_cache()
1642 */
1643 static int
1644 fetch_queryId_cb( Operation *op, SlapReply *rs )
1645 {
1646 int rc = 0;
1647
1648 /* only care about searchEntry responses */
1649 if ( rs->sr_type != REP_SEARCH ) {
1650 return 0;
1651 }
1652
1653 /* allow only one response per entryUUID */
1654 if ( op->o_callback->sc_private != NULL ) {
1655 rc = 1;
1656
1657 } else {
1658 Attribute *a;
1659
1660 /* copy all queryId values into callback's private data */
1661 a = attr_find( rs->sr_entry->e_attrs, ad_queryId );
1662 if ( a != NULL ) {
1663 BerVarray vals = NULL;
1664
1665 ber_bvarray_dup_x( &vals, a->a_nvals, op->o_tmpmemctx );
1666 op->o_callback->sc_private = (void *)vals;
1667 }
1668 }
1669
1670 /* clear entry if required */
1671 if ( rs->sr_flags & REP_ENTRY_MUSTBEFREED ) {
1672 entry_free( rs->sr_entry );
1673 rs->sr_entry = NULL;
1674 rs->sr_flags ^= REP_ENTRY_MUSTBEFREED;
1675 }
1676
1677 return rc;
1678 }
1679
1680 /*
1681 * Call that allows to remove a set of entries from the cache,
1682 * by forcing the removal of all the related queries.
1683 */
1684 int
1685 pcache_remove_entries_from_cache(
1686 Operation *op,
1687 cache_manager *cm,
1688 BerVarray entryUUIDs )
1689 {
1690 Connection conn = { 0 };
1691 OperationBuffer opbuf;
1692 Operation op2;
1693 slap_callback sc = { 0 };
1694 SlapReply rs = { REP_RESULT };
1695 Filter f = { 0 };
1696 char filtbuf[ LDAP_LUTIL_UUIDSTR_BUFSIZE + STRLENOF( "(entryUUID=)" ) ];
1697 AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
1698 AttributeName attrs[ 2 ] = { 0 };
1699 int s, rc;
1700
1701 if ( op == NULL ) {
1702 void *thrctx = ldap_pvt_thread_pool_context();
1703
1704 connection_fake_init( &conn, &opbuf, thrctx );
1705 op = &opbuf.ob_op;
1706
1707 } else {
1708 op2 = *op;
1709 op = &op2;
1710 }
1711
1712 memset( &op->oq_search, 0, sizeof( op->oq_search ) );
1713 op->ors_scope = LDAP_SCOPE_SUBTREE;
1714 op->ors_deref = LDAP_DEREF_NEVER;
1715 f.f_choice = LDAP_FILTER_EQUALITY;
1716 f.f_ava = &ava;
1717 ava.aa_desc = slap_schema.si_ad_entryUUID;
1718 op->ors_filter = &f;
1719 op->ors_slimit = 1;
1720 op->ors_tlimit = SLAP_NO_LIMIT;
1721 attrs[ 0 ].an_desc = ad_queryId;
1722 attrs[ 0 ].an_name = ad_queryId->ad_cname;
1723 op->ors_attrs = attrs;
1724 op->ors_attrsonly = 0;
1725
1726 op->o_req_dn = cm->db.be_suffix[ 0 ];
1727 op->o_req_ndn = cm->db.be_nsuffix[ 0 ];
1728
1729 op->o_tag = LDAP_REQ_SEARCH;
1730 op->o_protocol = LDAP_VERSION3;
1731 op->o_managedsait = SLAP_CONTROL_CRITICAL;
1732 op->o_bd = &cm->db;
1733 op->o_dn = op->o_bd->be_rootdn;
1734 op->o_ndn = op->o_bd->be_rootndn;
1735 sc.sc_response = fetch_queryId_cb;
1736 op->o_callback = &sc;
1737
1738 for ( s = 0; !BER_BVISNULL( &entryUUIDs[ s ] ); s++ ) {
1739 BerVarray vals = NULL;
1740
1741 op->ors_filterstr.bv_len = snprintf( filtbuf, sizeof( filtbuf ),
1742 "(entryUUID=%s)", entryUUIDs[ s ].bv_val );
1743 op->ors_filterstr.bv_val = filtbuf;
1744 ava.aa_value = entryUUIDs[ s ];
1745
1746 rc = op->o_bd->be_search( op, &rs );
1747 if ( rc != LDAP_SUCCESS ) {
1748 continue;
1749 }
1750
1751 vals = (BerVarray)op->o_callback->sc_private;
1752 if ( vals != NULL ) {
1753 int i;
1754
1755 for ( i = 0; !BER_BVISNULL( &vals[ i ] ); i++ ) {
1756 struct berval val = vals[ i ];
1757
1758 remove_query_and_data( op, &rs, cm, &val );
1759
1760 if ( !BER_BVISNULL( &val ) && val.bv_val != vals[ i ].bv_val ) {
1761 ch_free( val.bv_val );
1762 }
1763 }
1764
1765 ber_bvarray_free_x( vals, op->o_tmpmemctx );
1766 op->o_callback->sc_private = NULL;
1767 }
1768 }
1769
1770 return 0;
1771 }
1772
1773 /*
1774 * Call that allows to remove a query from the cache.
1775 */
1776 int
1777 pcache_remove_query_from_cache(
1778 Operation *op,
1779 cache_manager *cm,
1780 struct berval *queryid )
1781 {
1782 Operation op2 = *op;
1783 SlapReply rs2 = { 0 };
1784
1785 op2.o_bd = &cm->db;
1786
1787 /* remove the selected query */
1788 remove_query_and_data( &op2, &rs2, cm, queryid );
1789
1790 return LDAP_SUCCESS;
1791 }
1792
1793 /*
1794 * Call that allows to remove a set of queries related to an entry
1795 * from the cache; if queryid is not null, the entry must belong to
1796 * the query indicated by queryid.
1797 */
1798 int
1799 pcache_remove_entry_queries_from_cache(
1800 Operation *op,
1801 cache_manager *cm,
1802 struct berval *ndn,
1803 struct berval *queryid )
1804 {
1805 Connection conn = { 0 };
1806 OperationBuffer opbuf;
1807 Operation op2;
1808 slap_callback sc = { 0 };
1809 SlapReply rs = { REP_RESULT };
1810 Filter f = { 0 };
1811 char filter_str[ LDAP_LUTIL_UUIDSTR_BUFSIZE + STRLENOF( "(queryId=)" ) ];
1812 AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
1813 AttributeName attrs[ 2 ] = { 0 };
1814 int rc;
1815
1816 BerVarray vals = NULL;
1817
1818 if ( op == NULL ) {
1819 void *thrctx = ldap_pvt_thread_pool_context();
1820
1821 connection_fake_init( &conn, &opbuf, thrctx );
1822 op = &opbuf.ob_op;
1823
1824 } else {
1825 op2 = *op;
1826 op = &op2;
1827 }
1828
1829 memset( &op->oq_search, 0, sizeof( op->oq_search ) );
1830 op->ors_scope = LDAP_SCOPE_BASE;
1831 op->ors_deref = LDAP_DEREF_NEVER;
1832 if ( queryid == NULL || BER_BVISNULL( queryid ) ) {
1833 BER_BVSTR( &op->ors_filterstr, "(objectClass=*)" );
1834 f.f_choice = LDAP_FILTER_PRESENT;
1835 f.f_desc = slap_schema.si_ad_objectClass;
1836
1837 } else {
1838 op->ors_filterstr.bv_len = snprintf( filter_str,
1839 sizeof( filter_str ), "(%s=%s)",
1840 ad_queryId->ad_cname.bv_val, queryid->bv_val );
1841 f.f_choice = LDAP_FILTER_EQUALITY;
1842 f.f_ava = &ava;
1843 f.f_av_desc = ad_queryId;
1844 f.f_av_value = *queryid;
1845 }
1846 op->ors_filter = &f;
1847 op->ors_slimit = 1;
1848 op->ors_tlimit = SLAP_NO_LIMIT;
1849 attrs[ 0 ].an_desc = ad_queryId;
1850 attrs[ 0 ].an_name = ad_queryId->ad_cname;
1851 op->ors_attrs = attrs;
1852 op->ors_attrsonly = 0;
1853
1854 op->o_req_dn = *ndn;
1855 op->o_req_ndn = *ndn;
1856
1857 op->o_tag = LDAP_REQ_SEARCH;
1858 op->o_protocol = LDAP_VERSION3;
1859 op->o_managedsait = SLAP_CONTROL_CRITICAL;
1860 op->o_bd = &cm->db;
1861 op->o_dn = op->o_bd->be_rootdn;
1862 op->o_ndn = op->o_bd->be_rootndn;
1863 sc.sc_response = fetch_queryId_cb;
1864 op->o_callback = &sc;
1865
1866 rc = op->o_bd->be_search( op, &rs );
1867 if ( rc != LDAP_SUCCESS ) {
1868 return rc;
1869 }
1870
1871 vals = (BerVarray)op->o_callback->sc_private;
1872 if ( vals != NULL ) {
1873 int i;
1874
1875 for ( i = 0; !BER_BVISNULL( &vals[ i ] ); i++ ) {
1876 struct berval val = vals[ i ];
1877
1878 remove_query_and_data( op, &rs, cm, &val );
1879
1880 if ( !BER_BVISNULL( &val ) && val.bv_val != vals[ i ].bv_val ) {
1881 ch_free( val.bv_val );
1882 }
1883 }
1884
1885 ber_bvarray_free_x( vals, op->o_tmpmemctx );
1886 }
1887
1888 return LDAP_SUCCESS;
1889 }
1890
1891 static int
1892 cache_entries(
1893 Operation *op,
1894 SlapReply *rs,
1895 struct berval *query_uuid )
1896 {
1897 struct search_info *si = op->o_callback->sc_private;
1898 slap_overinst *on = si->on;
1899 cache_manager *cm = on->on_bi.bi_private;
1900 int return_val = 0;
1901 Entry *e;
1902 struct berval crp_uuid;
1903 char uuidbuf[ LDAP_LUTIL_UUIDSTR_BUFSIZE ];
1904 Operation *op_tmp;
1905 Connection conn = {0};
1906 OperationBuffer opbuf;
1907 void *thrctx = ldap_pvt_thread_pool_context();
1908
1909 query_uuid->bv_len = lutil_uuidstr(uuidbuf, sizeof(uuidbuf));
1910 ber_str2bv(uuidbuf, query_uuid->bv_len, 1, query_uuid);
1911
1912 connection_fake_init2( &conn, &opbuf, thrctx, 0 );
1913 op_tmp = &opbuf.ob_op;
1914 op_tmp->o_bd = &cm->db;
1915 op_tmp->o_dn = cm->db.be_rootdn;
1916 op_tmp->o_ndn = cm->db.be_rootndn;
1917
1918 Debug( pcache_debug, "UUID for query being added = %s\n",
1919 uuidbuf, 0, 0 );
1920
1921 for ( e=si->head; e; e=si->head ) {
1922 si->head = e->e_private;
1923 e->e_private = NULL;
1924 while ( cm->cur_entries > (cm->max_entries) ) {
1925 BER_BVZERO( &crp_uuid );
1926 remove_query_and_data( op_tmp, rs, cm, &crp_uuid );
1927 }
1928
1929 return_val = merge_entry(op_tmp, e, query_uuid);
1930 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
1931 cm->cur_entries += return_val;
1932 Debug( pcache_debug,
1933 "ENTRY ADDED/MERGED, CACHED ENTRIES=%d\n",
1934 cm->cur_entries, 0, 0 );
1935 return_val = 0;
1936 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
1937 }
1938
1939 return return_val;
1940 }
1941
1942 static int
1943 pcache_op_cleanup( Operation *op, SlapReply *rs ) {
1944 slap_callback *cb = op->o_callback;
1945 struct search_info *si = cb->sc_private;
1946 slap_overinst *on = si->on;
1947 cache_manager *cm = on->on_bi.bi_private;
1948 query_manager* qm = cm->qm;
1949
1950 if ( rs->sr_type == REP_SEARCH ) {
1951 Entry *e;
1952
1953 /* don't return more entries than requested by the client */
1954 if ( si->slimit && rs->sr_nentries >= si->slimit ) {
1955 si->slimit_exceeded = 1;
1956 }
1957
1958 /* If we haven't exceeded the limit for this query,
1959 * build a chain of answers to store. If we hit the
1960 * limit, empty the chain and ignore the rest.
1961 */
1962 if ( !si->over ) {
1963 if ( si->count < si->max ) {
1964 si->count++;
1965 e = entry_dup( rs->sr_entry );
1966 if ( !si->head ) si->head = e;
1967 if ( si->tail ) si->tail->e_private = e;
1968 si->tail = e;
1969
1970 } else {
1971 si->over = 1;
1972 si->count = 0;
1973 for (;si->head; si->head=e) {
1974 e = si->head->e_private;
1975 si->head->e_private = NULL;
1976 entry_free(si->head);
1977 }
1978 si->tail = NULL;
1979 }
1980 }
1981
1982 }
1983
1984 if ( rs->sr_type == REP_RESULT ||
1985 op->o_abandon || rs->sr_err == SLAPD_ABANDON )
1986 {
1987 if ( si->save_attrs != NULL ) {
1988 rs->sr_attrs = si->save_attrs;
1989 op->ors_attrs = si->save_attrs;
1990 }
1991 if ( (op->o_abandon || rs->sr_err == SLAPD_ABANDON) &&
1992 si->caching_reason == PC_IGNORE ) {
1993 filter_free( si->query.filter );
1994 if ( si->count ) {
1995 /* duplicate query, free it */
1996 Entry *e;
1997 for (;si->head; si->head=e) {
1998 e = si->head->e_private;
1999 si->head->e_private = NULL;
2000 entry_free(si->head);
2001 }
2002 }
2003 op->o_callback = op->o_callback->sc_next;
2004 op->o_tmpfree( cb, op->o_tmpmemctx );
2005 } else if ( si->caching_reason != PC_IGNORE ) {
2006 CachedQuery *qc = qm->addfunc(op, qm, &si->query,
2007 si->qtemp, si->caching_reason, 1 );
2008
2009 if ( qc != NULL ) {
2010 switch ( si->caching_reason ) {
2011 case PC_POSITIVE:
2012 cache_entries( op, rs, &qc->q_uuid );
2013 break;
2014
2015 case PC_SIZELIMIT:
2016 qc->q_sizelimit = rs->sr_nentries;
2017 break;
2018
2019 case PC_NEGATIVE:
2020 break;
2021
2022 default:
2023 assert( 0 );
2024 break;
2025 }
2026 ldap_pvt_thread_rdwr_wunlock(&qc->rwlock);
2027 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
2028 cm->num_cached_queries++;
2029 Debug( pcache_debug, "STORED QUERIES = %lu\n",
2030 cm->num_cached_queries, 0, 0 );
2031 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
2032
2033 /* If the consistency checker suspended itself,
2034 * wake it back up
2035 */
2036 if ( cm->cc_paused ) {
2037 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
2038 if ( cm->cc_paused ) {
2039 cm->cc_paused = 0;
2040 ldap_pvt_runqueue_resched( &slapd_rq, cm->cc_arg, 0 );
2041 }
2042 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
2043 }
2044
2045 } else if ( si->count ) {
2046 /* duplicate query, free it */
2047 Entry *e;
2048 for (;si->head; si->head=e) {
2049 e = si->head->e_private;
2050 si->head->e_private = NULL;
2051 entry_free(si->head);
2052 }
2053 }
2054
2055 } else {
2056 filter_free( si->query.filter );
2057 }
2058 }
2059
2060 return SLAP_CB_CONTINUE;
2061 }
2062
2063 static int
2064 pcache_response(
2065 Operation *op,
2066 SlapReply *rs )
2067 {
2068 struct search_info *si = op->o_callback->sc_private;
2069
2070 if ( si->save_attrs != NULL ) {
2071 rs->sr_attrs = si->save_attrs;
2072 op->ors_attrs = si->save_attrs;
2073 }
2074
2075 if ( rs->sr_type == REP_SEARCH ) {
2076 /* don't return more entries than requested by the client */
2077 if ( si->slimit_exceeded ) {
2078 return 0;
2079 }
2080
2081 } else if ( rs->sr_type == REP_RESULT ) {
2082
2083 if ( si->count ) {
2084 if ( rs->sr_err == LDAP_SUCCESS ) {
2085 si->caching_reason = PC_POSITIVE;
2086
2087 } else if ( rs->sr_err == LDAP_SIZELIMIT_EXCEEDED
2088 && si->qtemp->limitttl )
2089 {
2090 si->caching_reason = PC_SIZELIMIT;
2091 }
2092
2093 } else if ( si->qtemp->negttl && !si->count && !si->over &&
2094 rs->sr_err == LDAP_SUCCESS )
2095 {
2096 si->caching_reason = PC_NEGATIVE;
2097 }
2098
2099
2100 if ( si->slimit_exceeded ) {
2101 rs->sr_err = LDAP_SIZELIMIT_EXCEEDED;
2102 }
2103 }
2104
2105 return SLAP_CB_CONTINUE;
2106 }
2107
2108 static int
2109 add_filter_attrs(
2110 Operation *op,
2111 AttributeName** new_attrs,
2112 struct attr_set *attrs,
2113 AttributeName* filter_attrs,
2114 int fattr_cnt,
2115 int fattr_got_oc)
2116 {
2117 int alluser = 0;
2118 int allop = 0;
2119 int i, j;
2120 int count;
2121 int addoc = 0;
2122
2123 /* duplicate attrs */
2124 count = attrs->count + fattr_cnt;
2125 if ( !fattr_got_oc && !(attrs->flags & PC_GOT_OC)) {
2126 addoc = 1;
2127 count++;
2128 }
2129
2130 *new_attrs = (AttributeName*)ch_calloc( count + 1,
2131 sizeof(AttributeName) );
2132 for (i=0; i<attrs->count; i++) {
2133 (*new_attrs)[i].an_name = attrs->attrs[i].an_name;
2134 (*new_attrs)[i].an_desc = attrs->attrs[i].an_desc;
2135 }
2136 BER_BVZERO( &(*new_attrs)[i].an_name );
2137 alluser = an_find(*new_attrs, &AllUser);
2138 allop = an_find(*new_attrs, &AllOper);
2139
2140 j = i;
2141 for ( i=0; i<fattr_cnt; i++ ) {
2142 if ( an_find(*new_attrs, &filter_attrs[i].an_name ) ) {
2143 continue;
2144 }
2145 if ( is_at_operational(filter_attrs[i].an_desc->ad_type) ) {
2146 if ( allop ) {
2147 continue;
2148 }
2149 } else if ( alluser ) {
2150 continue;
2151 }
2152 (*new_attrs)[j].an_name = filter_attrs[i].an_name;
2153 (*new_attrs)[j].an_desc = filter_attrs[i].an_desc;
2154 (*new_attrs)[j].an_oc = NULL;
2155 (*new_attrs)[j].an_oc_exclude = 0;
2156 j++;
2157 }
2158 if ( addoc ) {
2159 (*new_attrs)[j].an_name = slap_schema.si_ad_objectClass->ad_cname;
2160 (*new_attrs)[j].an_desc = slap_schema.si_ad_objectClass;
2161 (*new_attrs)[j].an_oc = NULL;
2162 (*new_attrs)[j].an_oc_exclude = 0;
2163 j++;
2164 }
2165 BER_BVZERO( &(*new_attrs)[j].an_name );
2166
2167 return count;
2168 }
2169
2170 /* NOTE: this is a quick workaround to let pcache minimally interact
2171 * with pagedResults. A more articulated solutions would be to
2172 * perform the remote query without control and cache all results,
2173 * performing the pagedResults search only within the client
2174 * and the proxy. This requires pcache to understand pagedResults. */
2175 static int
2176 pcache_chk_controls(
2177 Operation *op,
2178 SlapReply *rs )
2179 {
2180 const char *non = "";
2181 const char *stripped = "";
2182
2183 switch( op->o_pagedresults ) {
2184 case SLAP_CONTROL_NONCRITICAL:
2185 non = "non-";
2186 stripped = "; stripped";
2187 /* fallthru */
2188
2189 case SLAP_CONTROL_CRITICAL:
2190 Debug( pcache_debug, "%s: "
2191 "%scritical pagedResults control "
2192 "disabled with proxy cache%s.\n",
2193 op->o_log_prefix, non, stripped );
2194
2195 slap_remove_control( op, rs, slap_cids.sc_pagedResults, NULL );
2196 break;
2197
2198 default:
2199 rs->sr_err = SLAP_CB_CONTINUE;
2200 break;
2201 }
2202
2203 return rs->sr_err;
2204 }
2205
2206 #ifdef PCACHE_CONTROL_PRIVDB
2207 static int
2208 pcache_op_privdb(
2209 Operation *op,
2210 SlapReply *rs )
2211 {
2212 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
2213 cache_manager *cm = on->on_bi.bi_private;
2214 slap_callback *save_cb;
2215 slap_op_t type;
2216
2217 /* skip if control is unset */
2218 if ( op->o_ctrlflag[ privDB_cid ] != SLAP_CONTROL_CRITICAL ) {
2219 return SLAP_CB_CONTINUE;
2220 }
2221
2222 /* The cache DB isn't open yet */
2223 if ( cm->defer_db_open ) {
2224 send_ldap_error( op, rs, LDAP_UNAVAILABLE,
2225 "pcachePrivDB: cacheDB not available" );
2226 return rs->sr_err;
2227 }
2228
2229 /* FIXME: might be a little bit exaggerated... */
2230 if ( !be_isroot( op ) ) {
2231 save_cb = op->o_callback;
2232 op->o_callback = NULL;
2233 send_ldap_error( op, rs, LDAP_UNWILLING_TO_PERFORM,
2234 "pcachePrivDB: operation not allowed" );
2235 op->o_callback = save_cb;
2236
2237 return rs->sr_err;
2238 }
2239
2240 /* map tag to operation */
2241 type = slap_req2op( op->o_tag );
2242 if ( type != SLAP_OP_LAST ) {
2243 BI_op_func **func;
2244 int rc;
2245
2246 /* execute, if possible */
2247 func = &cm->db.be_bind;
2248 if ( func[ type ] != NULL ) {
2249 Operation op2 = *op;
2250
2251 op2.o_bd = &cm->db;
2252
2253 rc = func[ type ]( &op2, rs );
2254 if ( type == SLAP_OP_BIND && rc == LDAP_SUCCESS ) {
2255 op->o_conn->c_authz_cookie = cm->db.be_private;
2256 }
2257 }
2258 }
2259
2260 /* otherwise fall back to error */
2261 save_cb = op->o_callback;
2262 op->o_callback = NULL;
2263 send_ldap_error( op, rs, LDAP_UNWILLING_TO_PERFORM,
2264 "operation not supported with pcachePrivDB control" );
2265 op->o_callback = save_cb;
2266
2267 return rs->sr_err;
2268 }
2269 #endif /* PCACHE_CONTROL_PRIVDB */
2270
2271 static int
2272 pcache_op_search(
2273 Operation *op,
2274 SlapReply *rs )
2275 {
2276 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
2277 cache_manager *cm = on->on_bi.bi_private;
2278 query_manager* qm = cm->qm;
2279
2280 int i = -1;
2281
2282 AttributeName *filter_attrs = NULL;
2283
2284 Query query;
2285 QueryTemplate *qtemp = NULL;
2286
2287 int attr_set = -1;
2288 CachedQuery *answerable = NULL;
2289 int cacheable = 0;
2290 int fattr_cnt=0;
2291 int fattr_got_oc = 0;
2292
2293 struct berval tempstr;
2294
2295 #ifdef PCACHE_CONTROL_PRIVDB
2296 if ( op->o_ctrlflag[ privDB_cid ] == SLAP_CONTROL_CRITICAL ) {
2297 return pcache_op_privdb( op, rs );
2298 }
2299 #endif /* PCACHE_CONTROL_PRIVDB */
2300
2301 /* The cache DB isn't open yet */
2302 if ( cm->defer_db_open ) {
2303 send_ldap_error( op, rs, LDAP_UNAVAILABLE,
2304 "pcachePrivDB: cacheDB not available" );
2305 return rs->sr_err;
2306 }
2307
2308 tempstr.bv_val = op->o_tmpalloc( op->ors_filterstr.bv_len+1, op->o_tmpmemctx );
2309 tempstr.bv_len = 0;
2310 if ( filter2template( op, op->ors_filter, &tempstr, &filter_attrs,
2311 &fattr_cnt, &fattr_got_oc )) {
2312 op->o_tmpfree( tempstr.bv_val, op->o_tmpmemctx );
2313 return SLAP_CB_CONTINUE;
2314 }
2315
2316 Debug( pcache_debug, "query template of incoming query = %s\n",
2317 tempstr.bv_val, 0, 0 );
2318
2319 /* FIXME: cannot cache/answer requests with pagedResults control */
2320
2321 /* find attr set */
2322 attr_set = get_attr_set(op->ors_attrs, qm, cm->numattrsets);
2323
2324 query.filter = op->ors_filter;
2325 query.base = op->o_req_ndn;
2326 query.scope = op->ors_scope;
2327
2328 /* check for query containment */
2329 if (attr_set > -1) {
2330 QueryTemplate *qt = qm->attr_sets[attr_set].templates;
2331 for (; qt; qt = qt->qtnext ) {
2332 /* find if template i can potentially answer tempstr */
2333 if (qt->querystr.bv_len != tempstr.bv_len ||
2334 strcasecmp( qt->querystr.bv_val, tempstr.bv_val ))
2335 continue;
2336 cacheable = 1;
2337 qtemp = qt;
2338 Debug( pcache_debug, "Entering QC, querystr = %s\n",
2339 op->ors_filterstr.bv_val, 0, 0 );
2340 answerable = (*(qm->qcfunc))(op, qm, &query, qt);
2341
2342 if (answerable)
2343 break;
2344 }
2345 }
2346 op->o_tmpfree( tempstr.bv_val, op->o_tmpmemctx );
2347
2348 if (answerable) {
2349 /* Need to clear the callbacks of the original operation,
2350 * in case there are other overlays */
2351 BackendDB *save_bd = op->o_bd;
2352 slap_callback *save_cb = op->o_callback;
2353
2354 Debug( pcache_debug, "QUERY ANSWERABLE\n", 0, 0, 0 );
2355 op->o_tmpfree( filter_attrs, op->o_tmpmemctx );
2356 ldap_pvt_thread_rdwr_rlock(&answerable->rwlock);
2357 if ( BER_BVISNULL( &answerable->q_uuid )) {
2358 /* No entries cached, just an empty result set */
2359 i = rs->sr_err = 0;
2360 send_ldap_result( op, rs );
2361 } else {
2362 op->o_bd = &cm->db;
2363 op->o_callback = NULL;
2364 i = cm->db.bd_info->bi_op_search( op, rs );
2365 }
2366 ldap_pvt_thread_rdwr_runlock(&answerable->rwlock);
2367 ldap_pvt_thread_rdwr_runlock(&qtemp->t_rwlock);
2368 op->o_bd = save_bd;
2369 op->o_callback = save_cb;
2370 return i;
2371 }
2372
2373 Debug( pcache_debug, "QUERY NOT ANSWERABLE\n", 0, 0, 0 );
2374
2375 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
2376 if (cm->num_cached_queries >= cm->max_queries) {
2377 cacheable = 0;
2378 }
2379 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
2380
2381 if (op->ors_attrsonly)
2382 cacheable = 0;
2383
2384 if (cacheable) {
2385 slap_callback *cb;
2386 struct search_info *si;
2387
2388 Debug( pcache_debug, "QUERY CACHEABLE\n", 0, 0, 0 );
2389 query.filter = filter_dup(op->ors_filter, NULL);
2390 ldap_pvt_thread_rdwr_wlock(&qtemp->t_rwlock);
2391 if ( !qtemp->t_attrs.count ) {
2392 qtemp->t_attrs.count = add_filter_attrs(op,
2393 &qtemp->t_attrs.attrs,
2394 &qm->attr_sets[attr_set],
2395 filter_attrs, fattr_cnt, fattr_got_oc);
2396 }
2397 ldap_pvt_thread_rdwr_wunlock(&qtemp->t_rwlock);
2398
2399 cb = op->o_tmpalloc( sizeof(*cb) + sizeof(*si), op->o_tmpmemctx );
2400 cb->sc_response = pcache_response;
2401 cb->sc_cleanup = pcache_op_cleanup;
2402 cb->sc_private = (cb+1);
2403 si = cb->sc_private;
2404 si->on = on;
2405 si->query = query;
2406 si->qtemp = qtemp;
2407 si->max = cm->num_entries_limit ;
2408 si->over = 0;
2409 si->count = 0;
2410 si->slimit = 0;
2411 si->slimit_exceeded = 0;
2412 si->caching_reason = PC_IGNORE;
2413 if ( op->ors_slimit && op->ors_slimit < cm->num_entries_limit ) {
2414 si->slimit = op->ors_slimit;
2415 op->ors_slimit = cm->num_entries_limit;
2416 }
2417 si->head = NULL;
2418 si->tail = NULL;
2419 si->save_attrs = op->ors_attrs;
2420
2421 op->ors_attrs = qtemp->t_attrs.attrs;
2422
2423 if ( cm->response_cb == PCACHE_RESPONSE_CB_HEAD ) {
2424 cb->sc_next = op->o_callback;
2425 op->o_callback = cb;
2426
2427 } else {
2428 slap_callback **pcb;
2429
2430 /* need to move the callback at the end, in case other
2431 * overlays are present, so that the final entry is
2432 * actually cached */
2433 cb->sc_next = NULL;
2434 for ( pcb = &op->o_callback; *pcb; pcb = &(*pcb)->sc_next );
2435 *pcb = cb;
2436 }
2437
2438 } else {
2439 Debug( pcache_debug, "QUERY NOT CACHEABLE\n",
2440 0, 0, 0);
2441 }
2442
2443 op->o_tmpfree( filter_attrs, op->o_tmpmemctx );
2444
2445 return SLAP_CB_CONTINUE;
2446 }
2447
2448 static int
2449 get_attr_set(
2450 AttributeName* attrs,
2451 query_manager* qm,
2452 int num )
2453 {
2454 int i;
2455 int count = 0;
2456
2457 if ( attrs ) {
2458 for ( ; attrs[count].an_name.bv_val; count++ );
2459 }
2460
2461 /* recognize a single "*" or a "1.1" */
2462 if ( count == 0 ) {
2463 count = 1;
2464 attrs = slap_anlist_all_user_attributes;
2465
2466 } else if ( count == 1 && strcmp( attrs[0].an_name.bv_val, LDAP_NO_ATTRS ) == 0 ) {
2467 count = 0;
2468 attrs = NULL;
2469 }
2470
2471 for ( i = 0; i < num; i++ ) {
2472 AttributeName *a2;
2473 int found = 1;
2474
2475 if ( count > qm->attr_sets[i].count ) {
2476 continue;
2477 }
2478
2479 if ( !count ) {
2480 if ( !qm->attr_sets[i].count ) {
2481 break;
2482 }
2483 continue;
2484 }
2485
2486 for ( a2 = attrs; a2->an_name.bv_val; a2++ ) {
2487 if ( !an_find( qm->attr_sets[i].attrs, &a2->an_name ) ) {
2488 found = 0;
2489 break;
2490 }
2491 }
2492
2493 if ( found ) {
2494 break;
2495 }
2496 }
2497
2498 if ( i == num ) {
2499 i = -1;
2500 }
2501
2502 return i;
2503 }
2504
2505 static void*
2506 consistency_check(
2507 void *ctx,
2508 void *arg )
2509 {
2510 struct re_s *rtask = arg;
2511 slap_overinst *on = rtask->arg;
2512 cache_manager *cm = on->on_bi.bi_private;
2513 query_manager *qm = cm->qm;
2514 Connection conn = {0};
2515 OperationBuffer opbuf;
2516 Operation *op;
2517
2518 SlapReply rs = {REP_RESULT};
2519 CachedQuery* query;
2520 int return_val, pause = 1;
2521 QueryTemplate* templ;
2522
2523 connection_fake_init( &conn, &opbuf, ctx );
2524 op = &opbuf.ob_op;
2525
2526 op->o_bd = &cm->db;
2527 op->o_dn = cm->db.be_rootdn;
2528 op->o_ndn = cm->db.be_rootndn;
2529
2530 cm->cc_arg = arg;
2531
2532 for (templ = qm->templates; templ; templ=templ->qmnext) {
2533 query = templ->query_last;
2534 if ( query ) pause = 0;
2535 op->o_time = slap_get_time();
2536 while (query && (query->expiry_time < op->o_time)) {
2537 int rem = 0;
2538 Debug( pcache_debug, "Lock CR index = %p\n",
2539 (void *) templ, 0, 0 );
2540 ldap_pvt_thread_rdwr_wlock(&templ->t_rwlock);
2541 if ( query == templ->query_last ) {
2542 rem = 1;
2543 remove_from_template(query, templ);
2544 Debug( pcache_debug, "TEMPLATE %p QUERIES-- %d\n",
2545 (void *) templ, templ->no_of_queries, 0 );
2546 Debug( pcache_debug, "Unlock CR index = %p\n",
2547 (void *) templ, 0, 0 );
2548 }
2549 ldap_pvt_thread_rdwr_wunlock(&templ->t_rwlock);
2550 if ( !rem ) {
2551 query = templ->query_last;
2552 continue;
2553 }
2554 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
2555 remove_query(qm, query);
2556 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
2557 if ( BER_BVISNULL( &query->q_uuid ))
2558 return_val = 0;
2559 else
2560 return_val = remove_query_data(op, &rs, &query->q_uuid);
2561 Debug( pcache_debug, "STALE QUERY REMOVED, SIZE=%d\n",
2562 return_val, 0, 0 );
2563 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
2564 cm->cur_entries -= return_val;
2565 cm->num_cached_queries--;
2566 Debug( pcache_debug, "STORED QUERIES = %lu\n",
2567 cm->num_cached_queries, 0, 0 );
2568 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
2569 Debug( pcache_debug,
2570 "STALE QUERY REMOVED, CACHE ="
2571 "%d entries\n",
2572 cm->cur_entries, 0, 0 );
2573 free_query(query);
2574 query = templ->query_last;
2575 }
2576 }
2577 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
2578 if ( ldap_pvt_runqueue_isrunning( &slapd_rq, rtask )) {
2579 ldap_pvt_runqueue_stoptask( &slapd_rq, rtask );
2580 }
2581 /* If there were no queries, defer processing for a while */
2582 cm->cc_paused = pause;
2583 ldap_pvt_runqueue_resched( &slapd_rq, rtask, pause );
2584
2585 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
2586 return NULL;
2587 }
2588
2589
2590 #define MAX_ATTR_SETS 500
2591
2592 enum {
2593 PC_MAIN = 1,
2594 PC_ATTR,
2595 PC_TEMP,
2596 PC_RESP,
2597 PC_QUERIES
2598 };
2599
2600 static ConfigDriver pc_cf_gen;
2601 static ConfigLDAPadd pc_ldadd;
2602 static ConfigCfAdd pc_cfadd;
2603
2604 static ConfigTable pccfg[] = {
2605 { "proxycache", "backend> <max_entries> <numattrsets> <entry limit> "
2606 "<cycle_time",
2607 6, 6, 0, ARG_MAGIC|ARG_NO_DELETE|PC_MAIN, pc_cf_gen,
2608 "( OLcfgOvAt:2.1 NAME 'olcProxyCache' "
2609 "DESC 'ProxyCache basic parameters' "
2610 "SYNTAX OMsDirectoryString SINGLE-VALUE )", NULL, NULL },
2611 { "proxyattrset", "index> <attributes...",
2612 2, 0, 0, ARG_MAGIC|PC_ATTR, pc_cf_gen,
2613 "( OLcfgOvAt:2.2 NAME 'olcProxyAttrset' "
2614 "DESC 'A set of attributes to cache' "
2615 "SYNTAX OMsDirectoryString )", NULL, NULL },
2616 { "proxytemplate", "filter> <attrset-index> <TTL> <negTTL",
2617 4, 6, 0, ARG_MAGIC|PC_TEMP, pc_cf_gen,
2618 "( OLcfgOvAt:2.3 NAME 'olcProxyTemplate' "
2619 "DESC 'Filter template, attrset, cache TTL, "
2620 "optional negative TTL, optional sizelimit TTL' "
2621 "SYNTAX OMsDirectoryString )", NULL, NULL },
2622 { "response-callback", "head|tail(default)",
2623 2, 2, 0, ARG_MAGIC|PC_RESP, pc_cf_gen,
2624 "( OLcfgOvAt:2.4 NAME 'olcProxyResponseCB' "
2625 "DESC 'Response callback position in overlay stack' "
2626 "SYNTAX OMsDirectoryString )", NULL, NULL },
2627 { "proxyCacheQueries", "queries",
2628 2, 2, 0, ARG_INT|ARG_MAGIC|PC_QUERIES, pc_cf_gen,
2629 "( OLcfgOvAt:2.5 NAME 'olcProxyCacheQueries' "
2630 "DESC 'Maximum number of queries to cache' "
2631 "SYNTAX OMsInteger )", NULL, NULL },
2632 { "proxySaveQueries", "TRUE|FALSE",
2633 2, 2, 0, ARG_ON_OFF|ARG_OFFSET, (void *)offsetof(cache_manager, save_queries),
2634 "( OLcfgOvAt:2.6 NAME 'olcProxySaveQueries' "
2635 "DESC 'Save cached queries for hot restart' "
2636 "SYNTAX OMsBoolean )", NULL, NULL },
2637
2638 { NULL, NULL, 0, 0, 0, ARG_IGNORED }
2639 };
2640
2641 /* Need to no-op this keyword for dynamic config */
2642 static ConfigTable pcdummy[] = {
2643 { "", "", 0, 0, 0, ARG_IGNORED,
2644 NULL, "( OLcfgGlAt:13 NAME 'olcDatabase' "
2645 "DESC 'The backend type for a database instance' "
2646 "SUP olcBackend SINGLE-VALUE X-ORDERED 'SIBLINGS' )", NULL, NULL },
2647 { NULL, NULL, 0, 0, 0, ARG_IGNORED }
2648 };
2649
2650 static ConfigOCs pcocs[] = {
2651 { "( OLcfgOvOc:2.1 "
2652 "NAME 'olcPcacheConfig' "
2653 "DESC 'ProxyCache configuration' "
2654 "SUP olcOverlayConfig "
2655 "MUST ( olcProxyCache $ olcProxyAttrset $ olcProxyTemplate ) "
2656 "MAY ( olcProxyResponseCB $ olcProxyCacheQueries $ olcProxySaveQueries ) )",
2657 Cft_Overlay, pccfg, NULL, pc_cfadd },
2658 { "( OLcfgOvOc:2.2 "
2659 "NAME 'olcPcacheDatabase' "
2660 "DESC 'Cache database configuration' "
2661 "AUXILIARY )", Cft_Misc, pcdummy, pc_ldadd },
2662 { NULL, 0, NULL }
2663 };
2664
2665 static int pcache_db_open2( slap_overinst *on, ConfigReply *cr );
2666
2667 static int
2668 pc_ldadd_cleanup( ConfigArgs *c )
2669 {
2670 slap_overinst *on = c->ca_private;
2671 return pcache_db_open2( on, &c->reply );
2672 }
2673
2674 static int
2675 pc_ldadd( CfEntryInfo *p, Entry *e, ConfigArgs *ca )
2676 {
2677 slap_overinst *on;
2678 cache_manager *cm;
2679
2680 if ( p->ce_type != Cft_Overlay || !p->ce_bi ||
2681 p->ce_bi->bi_cf_ocs != pcocs )
2682 return LDAP_CONSTRAINT_VIOLATION;
2683
2684 on = (slap_overinst *)p->ce_bi;
2685 cm = on->on_bi.bi_private;
2686 ca->be = &cm->db;
2687 /* Defer open if this is an LDAPadd */
2688 if ( CONFIG_ONLINE_ADD( ca ))
2689 ca->cleanup = pc_ldadd_cleanup;
2690 else
2691 cm->defer_db_open = 0;
2692 ca->ca_private = on;
2693 return LDAP_SUCCESS;
2694 }
2695
2696 static int
2697 pc_cfadd( Operation *op, SlapReply *rs, Entry *p, ConfigArgs *ca )
2698 {
2699 CfEntryInfo *pe = p->e_private;
2700 slap_overinst *on = (slap_overinst *)pe->ce_bi;
2701 cache_manager *cm = on->on_bi.bi_private;
2702 struct berval bv;
2703
2704 /* FIXME: should not hardcode "olcDatabase" here */
2705 bv.bv_len = snprintf( ca->cr_msg, sizeof( ca->cr_msg ),
2706 "olcDatabase=%s", cm->db.bd_info->bi_type );
2707 if ( bv.bv_len < 0 || bv.bv_len >= sizeof( ca->cr_msg ) ) {
2708 return -1;
2709 }
2710 bv.bv_val = ca->cr_msg;
2711 ca->be = &cm->db;
2712 cm->defer_db_open = 0;
2713
2714 /* We can only create this entry if the database is table-driven
2715 */
2716 if ( cm->db.bd_info->bi_cf_ocs )
2717 config_build_entry( op, rs, pe, ca, &bv, cm->db.bd_info->bi_cf_ocs,
2718 &pcocs[1] );
2719
2720 return 0;
2721 }
2722
2723 static int
2724 pc_cf_gen( ConfigArgs *c )
2725 {
2726 slap_overinst *on = (slap_overinst *)c->bi;
2727 cache_manager* cm = on->on_bi.bi_private;
2728 query_manager* qm = cm->qm;
2729 QueryTemplate* temp;
2730 AttributeName* attr_name;
2731 AttributeName* attrarray;
2732 const char* text=NULL;
2733 int i, num, rc = 0;
2734 char *ptr;
2735 unsigned long t;
2736
2737 if ( c->op == SLAP_CONFIG_EMIT ) {
2738 struct berval bv;
2739 switch( c->type ) {
2740 case PC_MAIN:
2741 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ), "%s %d %d %d %ld",
2742 cm->db.bd_info->bi_type, cm->max_entries, cm->numattrsets,
2743 cm->num_entries_limit, cm->cc_period );
2744 bv.bv_val = c->cr_msg;
2745 value_add_one( &c->rvalue_vals, &bv );
2746 break;
2747 case PC_ATTR:
2748 for (i=0; i<cm->numattrsets; i++) {
2749 if ( !qm->attr_sets[i].count ) continue;
2750
2751 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ), "%d", i );
2752
2753 /* count the attr length */
2754 for ( attr_name = qm->attr_sets[i].attrs;
2755 attr_name->an_name.bv_val; attr_name++ )
2756 bv.bv_len += attr_name->an_name.bv_len + 1;
2757
2758 bv.bv_val = ch_malloc( bv.bv_len+1 );
2759 ptr = lutil_strcopy( bv.bv_val, c->cr_msg );
2760 for ( attr_name = qm->attr_sets[i].attrs;
2761 attr_name->an_name.bv_val; attr_name++ ) {
2762 *ptr++ = ' ';
2763 ptr = lutil_strcopy( ptr, attr_name->an_name.bv_val );
2764 }
2765 ber_bvarray_add( &c->rvalue_vals, &bv );
2766 }
2767 if ( !c->rvalue_vals )
2768 rc = 1;
2769 break;
2770 case PC_TEMP:
2771 for (temp=qm->templates; temp; temp=temp->qmnext) {
2772 /* HEADS-UP: always print all;
2773 * if optional == 0, ignore */
2774 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ),
2775 " %d %ld %ld %ld",
2776 temp->attr_set_index,
2777 temp->ttl,
2778 temp->negttl,
2779 temp->limitttl );
2780 bv.bv_len += temp->querystr.bv_len + 2;
2781 bv.bv_val = ch_malloc( bv.bv_len+1 );
2782 ptr = bv.bv_val;
2783 *ptr++ = '"';
2784 ptr = lutil_strcopy( ptr, temp->querystr.bv_val );
2785 *ptr++ = '"';
2786 strcpy( ptr, c->cr_msg );
2787 ber_bvarray_add( &c->rvalue_vals, &bv );
2788 }
2789 if ( !c->rvalue_vals )
2790 rc = 1;
2791 break;
2792 case PC_RESP:
2793 if ( cm->response_cb == PCACHE_RESPONSE_CB_HEAD ) {
2794 BER_BVSTR( &bv, "head" );
2795 } else {
2796 BER_BVSTR( &bv, "tail" );
2797 }
2798 value_add_one( &c->rvalue_vals, &bv );
2799 break;
2800 case PC_QUERIES:
2801 c->value_int = cm->max_queries;
2802 break;
2803 }
2804 return rc;
2805 } else if ( c->op == LDAP_MOD_DELETE ) {
2806 return 1; /* FIXME */
2807 #if 0
2808 switch( c->type ) {
2809 case PC_ATTR:
2810 case PC_TEMP:
2811 }
2812 return rc;
2813 #endif
2814 }
2815
2816 switch( c->type ) {
2817 case PC_MAIN:
2818 if ( cm->numattrsets > 0 ) {
2819 snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"proxycache\" directive already provided" );
2820 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2821 return( 1 );
2822 }
2823
2824 if ( lutil_atoi( &cm->numattrsets, c->argv[3] ) != 0 ) {
2825 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse num attrsets=\"%s\" (arg #3)",
2826 c->argv[3] );
2827 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2828 return( 1 );
2829 }
2830 if ( cm->numattrsets <= 0 ) {
2831 snprintf( c->cr_msg, sizeof( c->cr_msg ), "numattrsets (arg #3) must be positive" );
2832 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2833 return( 1 );
2834 }
2835 if ( cm->numattrsets > MAX_ATTR_SETS ) {
2836 snprintf( c->cr_msg, sizeof( c->cr_msg ), "numattrsets (arg #3) must be <= %d", MAX_ATTR_SETS );
2837 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2838 return( 1 );
2839 }
2840
2841 if ( !backend_db_init( c->argv[1], &cm->db, -1, NULL )) {
2842 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unknown backend type (arg #1)" );
2843 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2844 return( 1 );
2845 }
2846
2847 if ( lutil_atoi( &cm->max_entries, c->argv[2] ) != 0 ) {
2848 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse max entries=\"%s\" (arg #2)",
2849 c->argv[2] );
2850 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2851 return( 1 );
2852 }
2853 if ( cm->max_entries <= 0 ) {
2854 snprintf( c->cr_msg, sizeof( c->cr_msg ), "max entries (arg #2) must be positive.\n" );
2855 Debug( LDAP_DEBUG_CONFIG, "%s: %s\n", c->log, c->cr_msg, 0 );
2856 return( 1 );
2857 }
2858
2859 if ( lutil_atoi( &cm->num_entries_limit, c->argv[4] ) != 0 ) {
2860 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse entry limit=\"%s\" (arg #4)",
2861 c->argv[4] );
2862 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2863 return( 1 );
2864 }
2865 if ( cm->num_entries_limit <= 0 ) {
2866 snprintf( c->cr_msg, sizeof( c->cr_msg ), "entry limit (arg #4) must be positive" );
2867 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2868 return( 1 );
2869 }
2870 if ( cm->num_entries_limit > cm->max_entries ) {
2871 snprintf( c->cr_msg, sizeof( c->cr_msg ), "entry limit (arg #4) must be less than max entries %d (arg #2)", cm->max_entries );
2872 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2873 return( 1 );
2874 }
2875
2876 if ( lutil_parse_time( c->argv[5], &t ) != 0 ) {
2877 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse period=\"%s\" (arg #5)",
2878 c->argv[5] );
2879 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2880 return( 1 );
2881 }
2882
2883 cm->cc_period = (time_t)t;
2884 Debug( pcache_debug,
2885 "Total # of attribute sets to be cached = %d.\n",
2886 cm->numattrsets, 0, 0 );
2887 qm->attr_sets = ( struct attr_set * )ch_calloc( cm->numattrsets,
2888 sizeof( struct attr_set ) );
2889 break;
2890 case PC_ATTR:
2891 if ( cm->numattrsets == 0 ) {
2892 snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"proxycache\" directive not provided yet" );
2893 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2894 return( 1 );
2895 }
2896 if ( lutil_atoi( &num, c->argv[1] ) != 0 ) {
2897 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse attrset #=\"%s\"",
2898 c->argv[1] );
2899 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2900 return( 1 );
2901 }
2902
2903 if ( num < 0 || num >= cm->numattrsets ) {
2904 snprintf( c->cr_msg, sizeof( c->cr_msg ), "attrset index %d out of bounds (must be %s%d)",
2905 num, cm->numattrsets > 1 ? "0->" : "", cm->numattrsets - 1 );
2906 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2907 return 1;
2908 }
2909 qm->attr_sets[num].flags |= PC_CONFIGURED;
2910 if ( c->argc == 2 ) {
2911 /* assume "1.1" */
2912 snprintf( c->cr_msg, sizeof( c->cr_msg ),
2913 "need an explicit attr in attrlist; use \"*\" to indicate all attrs" );
2914 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2915 return 1;
2916
2917 } else if ( c->argc == 3 ) {
2918 if ( strcmp( c->argv[2], LDAP_ALL_USER_ATTRIBUTES ) == 0 ) {
2919 qm->attr_sets[num].count = 1;
2920 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( 2,
2921 sizeof( AttributeName ) );
2922 BER_BVSTR( &qm->attr_sets[num].attrs[0].an_name, LDAP_ALL_USER_ATTRIBUTES );
2923 break;
2924
2925 } else if ( strcmp( c->argv[2], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 ) {
2926 qm->attr_sets[num].count = 1;
2927 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( 2,
2928 sizeof( AttributeName ) );
2929 BER_BVSTR( &qm->attr_sets[num].attrs[0].an_name, LDAP_ALL_OPERATIONAL_ATTRIBUTES );
2930 break;
2931
2932 } else if ( strcmp( c->argv[2], LDAP_NO_ATTRS ) == 0 ) {
2933 break;
2934 }
2935 /* else: fallthru */
2936
2937 } else if ( c->argc == 4 ) {
2938 if ( ( strcmp( c->argv[2], LDAP_ALL_USER_ATTRIBUTES ) == 0 && strcmp( c->argv[3], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 )
2939 || ( strcmp( c->argv[2], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 && strcmp( c->argv[3], LDAP_ALL_USER_ATTRIBUTES ) == 0 ) )
2940 {
2941 qm->attr_sets[num].count = 2;
2942 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( 3,
2943 sizeof( AttributeName ) );
2944 BER_BVSTR( &qm->attr_sets[num].attrs[0].an_name, LDAP_ALL_USER_ATTRIBUTES );
2945 BER_BVSTR( &qm->attr_sets[num].attrs[1].an_name, LDAP_ALL_OPERATIONAL_ATTRIBUTES );
2946 break;
2947 }
2948 /* else: fallthru */
2949 }
2950
2951 if ( c->argc > 2 ) {
2952 int all_user = 0, all_op = 0;
2953
2954 qm->attr_sets[num].count = c->argc - 2;
2955 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( c->argc - 1,
2956 sizeof( AttributeName ) );
2957 attr_name = qm->attr_sets[num].attrs;
2958 for ( i = 2; i < c->argc; i++ ) {
2959 attr_name->an_desc = NULL;
2960 if ( strcmp( c->argv[i], LDAP_NO_ATTRS ) == 0 ) {
2961 snprintf( c->cr_msg, sizeof( c->cr_msg ),
2962 "invalid attr #%d \"%s\" in attrlist",
2963 i - 2, c->argv[i] );
2964 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2965 ch_free( qm->attr_sets[num].attrs );
2966 qm->attr_sets[num].attrs = NULL;
2967 qm->attr_sets[num].count = 0;
2968 return 1;
2969 }
2970 if ( strcmp( c->argv[i], LDAP_ALL_USER_ATTRIBUTES ) == 0 ) {
2971 all_user = 1;
2972 BER_BVSTR( &attr_name->an_name, LDAP_ALL_USER_ATTRIBUTES );
2973 } else if ( strcmp( c->argv[i], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 ) {
2974 all_op = 1;
2975 BER_BVSTR( &attr_name->an_name, LDAP_ALL_OPERATIONAL_ATTRIBUTES );
2976 } else {
2977 if ( slap_str2ad( c->argv[i], &attr_name->an_desc, &text ) ) {
2978 strcpy( c->cr_msg, text );
2979 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2980 ch_free( qm->attr_sets[num].attrs );
2981 qm->attr_sets[num].attrs = NULL;
2982 qm->attr_sets[num].count = 0;
2983 return 1;
2984 }
2985 attr_name->an_name = attr_name->an_desc->ad_cname;
2986 }
2987 attr_name->an_oc = NULL;
2988 attr_name->an_oc_exclude = 0;
2989 if ( attr_name->an_desc == slap_schema.si_ad_objectClass )
2990 qm->attr_sets[num].flags |= PC_GOT_OC;
2991 attr_name++;
2992 BER_BVZERO( &attr_name->an_name );
2993 }
2994
2995 /* warn if list contains both "*" and "+" */
2996 if ( i > 4 && all_user && all_op ) {
2997 snprintf( c->cr_msg, sizeof( c->cr_msg ),
2998 "warning: attribute list contains \"*\" and \"+\"" );
2999 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3000 }
3001 }
3002 break;
3003 case PC_TEMP:
3004 if ( cm->numattrsets == 0 ) {
3005 snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"proxycache\" directive not provided yet" );
3006 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3007 return( 1 );
3008 }
3009 if ( lutil_atoi( &i, c->argv[2] ) != 0 ) {
3010 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse template #=\"%s\"",
3011 c->argv[2] );
3012 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3013 return( 1 );
3014 }
3015
3016 if ( i < 0 || i >= cm->numattrsets ||
3017 !(qm->attr_sets[i].flags & PC_CONFIGURED )) {
3018 snprintf( c->cr_msg, sizeof( c->cr_msg ), "template index %d invalid (%s%d)",
3019 i, cm->numattrsets > 1 ? "0->" : "", cm->numattrsets - 1 );
3020 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3021 return 1;
3022 }
3023 temp = ch_calloc( 1, sizeof( QueryTemplate ));
3024 temp->qmnext = qm->templates;
3025 qm->templates = temp;
3026 ldap_pvt_thread_rdwr_init( &temp->t_rwlock );
3027 temp->query = temp->query_last = NULL;
3028 if ( lutil_parse_time( c->argv[3], &t ) != 0 ) {
3029 snprintf( c->cr_msg, sizeof( c->cr_msg ),
3030 "unable to parse template ttl=\"%s\"",
3031 c->argv[3] );
3032 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3033 return( 1 );
3034 }
3035 temp->ttl = (time_t)t;
3036 temp->negttl = (time_t)0;
3037 temp->limitttl = (time_t)0;
3038 switch ( c->argc ) {
3039 case 6:
3040 if ( lutil_parse_time( c->argv[5], &t ) != 0 ) {
3041 snprintf( c->cr_msg, sizeof( c->cr_msg ),
3042 "unable to parse template sizelimit ttl=\"%s\"",
3043 c->argv[5] );
3044 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3045 return( 1 );
3046 }
3047 temp->limitttl = (time_t)t;
3048 /* fallthru */
3049
3050 case 5:
3051 if ( lutil_parse_time( c->argv[4], &t ) != 0 ) {
3052 snprintf( c->cr_msg, sizeof( c->cr_msg ),
3053 "unable to parse template negative ttl=\"%s\"",
3054 c->argv[4] );
3055 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3056 return( 1 );
3057 }
3058 temp->negttl = (time_t)t;
3059 break;
3060 }
3061
3062 temp->no_of_queries = 0;
3063
3064 ber_str2bv( c->argv[1], 0, 1, &temp->querystr );
3065 Debug( pcache_debug, "Template:\n", 0, 0, 0 );
3066 Debug( pcache_debug, " query template: %s\n",
3067 temp->querystr.bv_val, 0, 0 );
3068 temp->attr_set_index = i;
3069 qm->attr_sets[i].flags |= PC_REFERENCED;
3070 temp->qtnext = qm->attr_sets[i].templates;
3071 qm->attr_sets[i].templates = temp;
3072 Debug( pcache_debug, " attributes: \n", 0, 0, 0 );
3073 if ( ( attrarray = qm->attr_sets[i].attrs ) != NULL ) {
3074 for ( i=0; attrarray[i].an_name.bv_val; i++ )
3075 Debug( pcache_debug, "\t%s\n",
3076 attrarray[i].an_name.bv_val, 0, 0 );
3077 }
3078 break;
3079 case PC_RESP:
3080 if ( strcasecmp( c->argv[1], "head" ) == 0 ) {
3081 cm->response_cb = PCACHE_RESPONSE_CB_HEAD;
3082
3083 } else if ( strcasecmp( c->argv[1], "tail" ) == 0 ) {
3084 cm->response_cb = PCACHE_RESPONSE_CB_TAIL;
3085
3086 } else {
3087 snprintf( c->cr_msg, sizeof( c->cr_msg ), "unknown specifier" );
3088 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3089 return 1;
3090 }
3091 break;
3092 case PC_QUERIES:
3093 if ( c->value_int <= 0 ) {
3094 snprintf( c->cr_msg, sizeof( c->cr_msg ), "max queries must be positive" );
3095 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
3096 return( 1 );
3097 }
3098 cm->max_queries = c->value_int;
3099 break;
3100 }
3101 return rc;
3102 }
3103
3104 static int
3105 pcache_db_config(
3106 BackendDB *be,
3107 const char *fname,
3108 int lineno,
3109 int argc,
3110 char **argv
3111 )
3112 {
3113 slap_overinst *on = (slap_overinst *)be->bd_info;
3114 cache_manager* cm = on->on_bi.bi_private;
3115
3116 /* Something for the cache database? */
3117 if ( cm->db.bd_info && cm->db.bd_info->bi_db_config )
3118 return cm->db.bd_info->bi_db_config( &cm->db, fname, lineno,
3119 argc, argv );
3120 return SLAP_CONF_UNKNOWN;
3121 }
3122
3123 static int
3124 pcache_db_init(
3125 BackendDB *be,
3126 ConfigReply *cr)
3127 {
3128 slap_overinst *on = (slap_overinst *)be->bd_info;
3129 cache_manager *cm;
3130 query_manager *qm;
3131
3132 cm = (cache_manager *)ch_malloc(sizeof(cache_manager));
3133 on->on_bi.bi_private = cm;
3134
3135 qm = (query_manager*)ch_malloc(sizeof(query_manager));
3136
3137 cm->db = *be;
3138 SLAP_DBFLAGS(&cm->db) |= SLAP_DBFLAG_NO_SCHEMA_CHECK;
3139 cm->db.be_private = NULL;
3140 cm->db.be_pcl_mutexp = &cm->db.be_pcl_mutex;
3141 cm->qm = qm;
3142 cm->numattrsets = 0;
3143 cm->num_entries_limit = 5;
3144 cm->num_cached_queries = 0;
3145 cm->max_entries = 0;
3146 cm->cur_entries = 0;
3147 cm->max_queries = 10000;
3148 cm->save_queries = 0;
3149 cm->response_cb = PCACHE_RESPONSE_CB_TAIL;
3150 cm->defer_db_open = 1;
3151 cm->cc_period = 1000;
3152 cm->cc_paused = 0;
3153 cm->cc_arg = NULL;
3154
3155 qm->attr_sets = NULL;
3156 qm->templates = NULL;
3157 qm->lru_top = NULL;
3158 qm->lru_bottom = NULL;
3159
3160 qm->qcfunc = query_containment;
3161 qm->crfunc = cache_replacement;
3162 qm->addfunc = add_query;
3163 ldap_pvt_thread_mutex_init(&qm->lru_mutex);
3164
3165 ldap_pvt_thread_mutex_init(&cm->cache_mutex);
3166 return 0;
3167 }
3168
3169 static int
3170 pcache_cachedquery_open_cb( Operation *op, SlapReply *rs )
3171 {
3172 assert( op->o_tag == LDAP_REQ_SEARCH );
3173
3174 if ( rs->sr_type == REP_SEARCH ) {
3175 Attribute *a;
3176
3177 a = attr_find( rs->sr_entry->e_attrs, ad_cachedQueryURL );
3178 if ( a != NULL ) {
3179 BerVarray *valsp;
3180
3181 assert( a->a_nvals != NULL );
3182
3183 valsp = op->o_callback->sc_private;
3184 assert( *valsp == NULL );
3185
3186 ber_bvarray_dup_x( valsp, a->a_nvals, op->o_tmpmemctx );
3187 }
3188 }
3189
3190 return 0;
3191 }
3192
3193 static int
3194 pcache_cachedquery_count_cb( Operation *op, SlapReply *rs )
3195 {
3196 assert( op->o_tag == LDAP_REQ_SEARCH );
3197
3198 if ( rs->sr_type == REP_SEARCH ) {
3199 int *countp = (int *)op->o_callback->sc_private;
3200
3201 (*countp)++;
3202 }
3203
3204 return 0;
3205 }
3206
3207 static int
3208 pcache_db_open2(
3209 slap_overinst *on,
3210 ConfigReply *cr )
3211 {
3212 cache_manager *cm = on->on_bi.bi_private;
3213 query_manager* qm = cm->qm;
3214 int rc;
3215
3216 rc = backend_startup_one( &cm->db, cr );
3217 if ( rc == 0 ) {
3218 cm->defer_db_open = 0;
3219 }
3220
3221 /* There is no runqueue in TOOL mode */
3222 if (( slapMode & SLAP_SERVER_MODE ) && rc == 0 ) {
3223 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
3224 ldap_pvt_runqueue_insert( &slapd_rq, cm->cc_period,
3225 consistency_check, on,
3226 "pcache_consistency", cm->db.be_suffix[0].bv_val );
3227 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
3228
3229 /* Cached database must have the rootdn */
3230 if ( BER_BVISNULL( &cm->db.be_rootndn )
3231 || BER_BVISEMPTY( &cm->db.be_rootndn ) )
3232 {
3233 Debug( LDAP_DEBUG_ANY, "pcache_db_open(): "
3234 "underlying database of type \"%s\"\n"
3235 " serving naming context \"%s\"\n"
3236 " has no \"rootdn\", required by \"proxycache\".\n",
3237 on->on_info->oi_orig->bi_type,
3238 cm->db.be_suffix[0].bv_val, 0 );
3239 return 1;
3240 }
3241
3242 if ( cm->save_queries ) {
3243 void *thrctx = ldap_pvt_thread_pool_context();
3244 Connection conn = { 0 };
3245 OperationBuffer opbuf;
3246 Operation *op;
3247 slap_callback cb = { 0 };
3248 SlapReply rs = { 0 };
3249 BerVarray vals = NULL;
3250 Filter f = { 0 }, f2 = { 0 };
3251 AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
3252 AttributeName attrs[ 2 ] = { 0 };
3253
3254 connection_fake_init( &conn, &opbuf, thrctx );
3255 op = &opbuf.ob_op;
3256
3257 op->o_bd = &cm->db;
3258
3259 op->o_tag = LDAP_REQ_SEARCH;
3260 op->o_protocol = LDAP_VERSION3;
3261 cb.sc_response = pcache_cachedquery_open_cb;
3262 cb.sc_private = &vals;
3263 op->o_callback = &cb;
3264 op->o_time = slap_get_time();
3265 op->o_do_not_cache = 1;
3266 op->o_managedsait = SLAP_CONTROL_CRITICAL;
3267
3268 op->o_dn = cm->db.be_rootdn;
3269 op->o_ndn = cm->db.be_rootndn;
3270 op->o_req_dn = cm->db.be_suffix[ 0 ];
3271 op->o_req_ndn = cm->db.be_nsuffix[ 0 ];
3272
3273 op->ors_scope = LDAP_SCOPE_BASE;
3274 op->ors_deref = LDAP_DEREF_NEVER;
3275 op->ors_slimit = 1;
3276 op->ors_tlimit = SLAP_NO_LIMIT;
3277 ber_str2bv( "(cachedQueryURL=*)", 0, 0, &op->ors_filterstr );
3278 f.f_choice = LDAP_FILTER_PRESENT;
3279 f.f_desc = ad_cachedQueryURL;
3280 op->ors_filter = &f;
3281 attrs[ 0 ].an_desc = ad_cachedQueryURL;
3282 attrs[ 0 ].an_name = ad_cachedQueryURL->ad_cname;
3283 op->ors_attrs = attrs;
3284 op->ors_attrsonly = 0;
3285
3286 rc = op->o_bd->be_search( op, &rs );
3287 if ( rc == LDAP_SUCCESS && vals != NULL ) {
3288 int i;
3289
3290 for ( i = 0; !BER_BVISNULL( &vals[ i ] ); i++ ) {
3291 if ( url2query( vals[ i ].bv_val, op, qm ) == 0 ) {
3292 cm->num_cached_queries++;
3293 }
3294 }
3295
3296 ber_bvarray_free_x( vals, op->o_tmpmemctx );
3297 }
3298
3299 /* count cached entries */
3300 f.f_choice = LDAP_FILTER_NOT;
3301 f.f_not = &f2;
3302 f2.f_choice = LDAP_FILTER_EQUALITY;
3303 f2.f_ava = &ava;
3304 f2.f_av_desc = slap_schema.si_ad_objectClass;
3305 BER_BVSTR( &f2.f_av_value, "glue" );
3306 ber_str2bv( "(!(objectClass=glue))", 0, 0, &op->ors_filterstr );
3307
3308 op->ors_slimit = SLAP_NO_LIMIT;
3309 op->ors_scope = LDAP_SCOPE_SUBTREE;
3310 op->ors_attrs = slap_anlist_no_attrs;
3311
3312 op->o_callback->sc_response = pcache_cachedquery_count_cb;
3313 rs.sr_nentries = 0;
3314 op->o_callback->sc_private = &rs.sr_nentries;
3315
3316 rc = op->o_bd->be_search( op, &rs );
3317
3318 cm->cur_entries = rs.sr_nentries;
3319
3320 /* ignore errors */
3321 rc = 0;
3322 }
3323 }
3324 return rc;
3325 }
3326
3327 static int
3328 pcache_db_open(
3329 BackendDB *be,
3330 ConfigReply *cr )
3331 {
3332 slap_overinst *on = (slap_overinst *)be->bd_info;
3333 cache_manager *cm = on->on_bi.bi_private;
3334 query_manager* qm = cm->qm;
3335 int i, ncf = 0, rf = 0, nrf = 0, rc = 0;
3336
3337 /* check attr sets */
3338 for ( i = 0; i < cm->numattrsets; i++) {
3339 if ( !( qm->attr_sets[i].flags & PC_CONFIGURED ) ) {
3340 if ( qm->attr_sets[i].flags & PC_REFERENCED ) {
3341 Debug( LDAP_DEBUG_CONFIG, "pcache: attr set #%d not configured but referenced.\n", i, 0, 0 );
3342 rf++;
3343
3344 } else {
3345 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, attr set #%d not configured.\n", i, 0, 0 );
3346 }
3347 ncf++;
3348
3349 } else if ( !( qm->attr_sets[i].flags & PC_REFERENCED ) ) {
3350 Debug( LDAP_DEBUG_CONFIG, "pcache: attr set #%d configured but not referenced.\n", i, 0, 0 );
3351 nrf++;
3352 }
3353 }
3354
3355 if ( ncf || rf || nrf ) {
3356 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, %d attr sets configured but not referenced.\n", nrf, 0, 0 );
3357 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, %d attr sets not configured.\n", ncf, 0, 0 );
3358 Debug( LDAP_DEBUG_CONFIG, "pcache: %d attr sets not configured but referenced.\n", rf, 0, 0 );
3359
3360 if ( rf > 0 ) {
3361 return 1;
3362 }
3363 }
3364
3365 /* need to inherit something from the original database... */
3366 cm->db.be_def_limit = be->be_def_limit;
3367 cm->db.be_limits = be->be_limits;
3368 cm->db.be_acl = be->be_acl;
3369 cm->db.be_dfltaccess = be->be_dfltaccess;
3370
3371 if ( SLAP_DBMONITORING( be ) ) {
3372 SLAP_DBFLAGS( &cm->db ) |= SLAP_DBFLAG_MONITORING;
3373
3374 } else {
3375 SLAP_DBFLAGS( &cm->db ) &= ~SLAP_DBFLAG_MONITORING;
3376 }
3377
3378 if ( !cm->defer_db_open )
3379 rc = pcache_db_open2( on, cr );
3380
3381 return rc;
3382 }
3383
3384 static void
3385 pcache_free_qbase( void *v )
3386 {
3387 Qbase *qb = v;
3388 int i;
3389
3390 for (i=0; i<3; i++)
3391 tavl_free( qb->scopes[i], NULL );
3392 ch_free( qb );
3393 }
3394
3395 static int
3396 pcache_db_close(
3397 BackendDB *be,
3398 ConfigReply *cr
3399 )
3400 {
3401 slap_overinst *on = (slap_overinst *)be->bd_info;
3402 cache_manager *cm = on->on_bi.bi_private;
3403 query_manager *qm = cm->qm;
3404 QueryTemplate *tm;
3405 int i, rc = 0;
3406
3407 if ( cm->save_queries ) {
3408 CachedQuery *qc;
3409 BerVarray vals = NULL;
3410
3411 void *thrctx;
3412 Connection conn = { 0 };
3413 OperationBuffer opbuf;
3414 Operation *op;
3415 slap_callback cb = { 0 };
3416
3417 SlapReply rs = { REP_RESULT };
3418 Modifications mod = { 0 };
3419
3420 thrctx = ldap_pvt_thread_pool_context();
3421
3422 connection_fake_init( &conn, &opbuf, thrctx );
3423 op = &opbuf.ob_op;
3424
3425 if ( qm->templates != NULL ) {
3426 for ( tm = qm->templates; tm != NULL; tm = tm->qmnext ) {
3427 for ( qc = tm->query; qc; qc = qc->next ) {
3428 struct berval bv;
3429
3430 if ( query2url( op, qc, &bv ) == 0 ) {
3431 ber_bvarray_add_x( &vals, &bv, op->o_tmpmemctx );
3432 }
3433 }
3434 }
3435 }
3436
3437 op->o_bd = &cm->db;
3438 op->o_dn = cm->db.be_rootdn;
3439 op->o_ndn = cm->db.be_rootndn;
3440
3441 op->o_tag = LDAP_REQ_MODIFY;
3442 op->o_protocol = LDAP_VERSION3;
3443 cb.sc_response = slap_null_cb;
3444 op->o_callback = &cb;
3445 op->o_time = slap_get_time();
3446 op->o_do_not_cache = 1;
3447 op->o_managedsait = SLAP_CONTROL_CRITICAL;
3448
3449 op->o_req_dn = op->o_bd->be_suffix[0];
3450 op->o_req_ndn = op->o_bd->be_nsuffix[0];
3451
3452 mod.sml_op = LDAP_MOD_REPLACE;
3453 mod.sml_flags = 0;
3454 mod.sml_desc = ad_cachedQueryURL;
3455 mod.sml_type = ad_cachedQueryURL->ad_cname;
3456 mod.sml_values = vals;
3457 mod.sml_nvalues = NULL;
3458 mod.sml_numvals = 1;
3459 mod.sml_next = NULL;
3460 Debug( pcache_debug,
3461 "%sSETTING CACHED QUERY URLS\n",
3462 vals == NULL ? "RE" : "", 0, 0 );
3463
3464 op->orm_modlist = &mod;
3465
3466 op->o_bd->be_modify( op, &rs );
3467
3468 ber_bvarray_free_x( vals, op->o_tmpmemctx );
3469 }
3470
3471 /* cleanup stuff inherited from the original database... */
3472 cm->db.be_limits = NULL;
3473 cm->db.be_acl = NULL;
3474
3475 /* stop the thread ... */
3476 if ( cm->cc_arg ) {
3477 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
3478 if ( ldap_pvt_runqueue_isrunning( &slapd_rq, cm->cc_arg ) ) {
3479 ldap_pvt_runqueue_stoptask( &slapd_rq, cm->cc_arg );
3480 }
3481 ldap_pvt_runqueue_remove( &slapd_rq, cm->cc_arg );
3482 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
3483 }
3484
3485 if ( cm->db.bd_info->bi_db_close ) {
3486 rc = cm->db.bd_info->bi_db_close( &cm->db, NULL );
3487 }
3488 while ( (tm = qm->templates) != NULL ) {
3489 CachedQuery *qc, *qn;
3490 qm->templates = tm->qmnext;
3491 for ( qc = tm->query; qc; qc = qn ) {
3492 qn = qc->next;
3493 free_query( qc );
3494 }
3495 avl_free( tm->qbase, pcache_free_qbase );
3496 free( tm->querystr.bv_val );
3497 ldap_pvt_thread_rdwr_destroy( &tm->t_rwlock );
3498 free( tm->t_attrs.attrs );
3499 free( tm );
3500 }
3501
3502 for ( i=0; i<cm->numattrsets; i++ ) {
3503 free( qm->attr_sets[i].attrs );
3504 }
3505 free( qm->attr_sets );
3506 qm->attr_sets = NULL;
3507
3508 return rc;
3509 }
3510
3511 static int
3512 pcache_db_destroy(
3513 BackendDB *be,
3514 ConfigReply *cr
3515 )
3516 {
3517 slap_overinst *on = (slap_overinst *)be->bd_info;
3518 cache_manager *cm = on->on_bi.bi_private;
3519 query_manager *qm = cm->qm;
3520
3521 if ( cm->db.be_private != NULL ) {
3522 backend_stopdown_one( &cm->db );
3523 }
3524
3525 ldap_pvt_thread_mutex_destroy( &qm->lru_mutex );
3526 ldap_pvt_thread_mutex_destroy( &cm->cache_mutex );
3527 free( qm );
3528 free( cm );
3529
3530 return 0;
3531 }
3532
3533 #ifdef PCACHE_CONTROL_PRIVDB
3534 /*
3535 Control ::= SEQUENCE {
3536 controlType LDAPOID,
3537 criticality BOOLEAN DEFAULT FALSE,
3538 controlValue OCTET STRING OPTIONAL }
3539
3540 controlType ::= 1.3.6.1.4.1.4203.666.11.9.5.1
3541
3542 * criticality must be TRUE; controlValue must be absent.
3543 */
3544 static int
3545 parse_privdb_ctrl(
3546 Operation *op,
3547 SlapReply *rs,
3548 LDAPControl *ctrl )
3549 {
3550 if ( op->o_ctrlflag[ privDB_cid ] != SLAP_CONTROL_NONE ) {
3551 rs->sr_text = "privateDB control specified multiple times";
3552 return LDAP_PROTOCOL_ERROR;
3553 }
3554
3555 if ( !BER_BVISNULL( &ctrl->ldctl_value ) ) {
3556 rs->sr_text = "privateDB control value not absent";
3557 return LDAP_PROTOCOL_ERROR;
3558 }
3559
3560 if ( !ctrl->ldctl_iscritical ) {
3561 rs->sr_text = "privateDB control criticality required";
3562 return LDAP_PROTOCOL_ERROR;
3563 }
3564
3565 op->o_ctrlflag[ privDB_cid ] = SLAP_CONTROL_CRITICAL;
3566
3567 return LDAP_SUCCESS;
3568 }
3569
3570 static char *extops[] = {
3571 LDAP_EXOP_MODIFY_PASSWD,
3572 NULL
3573 };
3574 #endif /* PCACHE_CONTROL_PRIVDB */
3575
3576 #ifdef PCACHE_EXOP_QUERY_DELETE
3577 static struct berval pcache_exop_QUERY_DELETE = BER_BVC( PCACHE_EXOP_QUERY_DELETE );
3578
3579 #define LDAP_TAG_EXOP_QUERY_DELETE_BASE ((LBER_CLASS_CONTEXT|LBER_CONSTRUCTED) + 0)
3580 #define LDAP_TAG_EXOP_QUERY_DELETE_DN ((LBER_CLASS_CONTEXT|LBER_CONSTRUCTED) + 1)
3581 #define LDAP_TAG_EXOP_QUERY_DELETE_UUID ((LBER_CLASS_CONTEXT|LBER_CONSTRUCTED) + 2)
3582
3583 /*
3584 ExtendedRequest ::= [APPLICATION 23] SEQUENCE {
3585 requestName [0] LDAPOID,
3586 requestValue [1] OCTET STRING OPTIONAL }
3587
3588 requestName ::= 1.3.6.1.4.1.4203.666.11.9.6.1
3589
3590 requestValue ::= SEQUENCE { CHOICE {
3591 baseDN [0] LDAPDN
3592 entryDN [1] LDAPDN },
3593 queryID [2] OCTET STRING (SIZE(16))
3594 -- constrained to UUID }
3595
3596 * Either baseDN or entryDN must be present, to allow database selection.
3597 *
3598 * 1. if baseDN and queryID are present, then the query corresponding
3599 * to queryID is deleted;
3600 * 2. if baseDN is present and queryID is absent, then all queries
3601 * are deleted;
3602 * 3. if entryDN is present and queryID is absent, then all queries
3603 * corresponding to the queryID values present in entryDN are deleted;
3604 * 4. if entryDN and queryID are present, then all queries
3605 * corresponding to the queryID values present in entryDN are deleted,
3606 * but only if the value of queryID is contained in the entry;
3607 *
3608 * Currently, only 1, 3 and 4 are implemented. 2 can be obtained by either
3609 * recursively deleting the database (ldapdelete -r) with PRIVDB control,
3610 * or by removing the database files.
3611
3612 ExtendedResponse ::= [APPLICATION 24] SEQUENCE {
3613 COMPONENTS OF LDAPResult,
3614 responseName [10] LDAPOID OPTIONAL,
3615 responseValue [11] OCTET STRING OPTIONAL }
3616
3617 * responseName and responseValue must be absent.
3618 */
3619
3620 /*
3621 * - on success, *tagp is either LDAP_TAG_EXOP_QUERY_DELETE_BASE
3622 * or LDAP_TAG_EXOP_QUERY_DELETE_DN.
3623 * - if ndn != NULL, it is set to the normalized DN in the request
3624 * corresponding to either the baseDN or the entryDN, according
3625 * to *tagp; memory is malloc'ed on the Operation's slab, and must
3626 * be freed by the caller.
3627 * - if uuid != NULL, it is set to point to the normalized UUID;
3628 * memory is malloc'ed on the Operation's slab, and must
3629 * be freed by the caller.
3630 */
3631 static int
3632 pcache_parse_query_delete(
3633 struct berval *in,
3634 ber_tag_t *tagp,
3635 struct berval *ndn,
3636 struct berval *uuid,
3637 const char **text,
3638 void *ctx )
3639 {
3640 int rc = LDAP_SUCCESS;
3641 ber_tag_t tag;
3642 ber_len_t len = -1;
3643 BerElementBuffer berbuf;
3644 BerElement *ber = (BerElement *)&berbuf;
3645 struct berval reqdata = BER_BVNULL;
3646
3647 *text = NULL;
3648
3649 if ( ndn ) {
3650 BER_BVZERO( ndn );
3651 }
3652
3653 if ( uuid ) {
3654 BER_BVZERO( uuid );
3655 }
3656
3657 if ( in == NULL || in->bv_len == 0 ) {
3658 *text = "empty request data field in queryDelete exop";
3659 return LDAP_PROTOCOL_ERROR;
3660 }
3661
3662 ber_dupbv_x( &reqdata, in, ctx );
3663
3664 /* ber_init2 uses reqdata directly, doesn't allocate new buffers */
3665 ber_init2( ber, &reqdata, 0 );
3666
3667 tag = ber_scanf( ber, "{" /*}*/ );
3668
3669 if ( tag == LBER_ERROR ) {
3670 Debug( LDAP_DEBUG_TRACE,
3671 "pcache_parse_query_delete: decoding error.\n",
3672 0, 0, 0 );
3673 goto decoding_error;
3674 }
3675
3676 tag = ber_peek_tag( ber, &len );
3677 if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_BASE
3678 || tag == LDAP_TAG_EXOP_QUERY_DELETE_DN )
3679 {
3680 *tagp = tag;
3681
3682 if ( ndn != NULL ) {
3683 struct berval dn;
3684
3685 tag = ber_scanf( ber, "m", &dn );
3686 if ( tag == LBER_ERROR ) {
3687 Debug( LDAP_DEBUG_TRACE,
3688 "pcache_parse_query_delete: DN parse failed.\n",
3689 0, 0, 0 );
3690 goto decoding_error;
3691 }
3692
3693 rc = dnNormalize( 0, NULL, NULL, &dn, ndn, ctx );
3694 if ( rc != LDAP_SUCCESS ) {
3695 *text = "invalid DN in queryDelete exop request data";
3696 goto done;
3697 }
3698
3699 } else {
3700 tag = ber_scanf( ber, "x" /* "m" */ );
3701 if ( tag == LBER_DEFAULT ) {
3702 goto decoding_error;
3703 }
3704 }
3705
3706 tag = ber_peek_tag( ber, &len );
3707 }
3708
3709 if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_UUID ) {
3710 if ( uuid != NULL ) {
3711 struct berval bv;
3712 char uuidbuf[ LDAP_LUTIL_UUIDSTR_BUFSIZE ];
3713
3714 tag = ber_scanf( ber, "m", &bv );
3715 if ( tag == LBER_ERROR ) {
3716 Debug( LDAP_DEBUG_TRACE,
3717 "pcache_parse_query_delete: UUID parse failed.\n",
3718 0, 0, 0 );
3719 goto decoding_error;
3720 }
3721
3722 if ( bv.bv_len != 16 ) {
3723 Debug( LDAP_DEBUG_TRACE,
3724 "pcache_parse_query_delete: invalid UUID length %lu.\n",
3725 (unsigned long)bv.bv_len, 0, 0 );
3726 goto decoding_error;
3727 }
3728
3729 rc = lutil_uuidstr_from_normalized(
3730 bv.bv_val, bv.bv_len,
3731 uuidbuf, sizeof( uuidbuf ) );
3732 if ( rc == -1 ) {
3733 goto decoding_error;
3734 }
3735 ber_str2bv( uuidbuf, rc, 1, uuid );
3736 rc = LDAP_SUCCESS;
3737
3738 } else {
3739 tag = ber_skip_tag( ber, &len );
3740 if ( tag == LBER_DEFAULT ) {
3741 goto decoding_error;
3742 }
3743
3744 if ( len != 16 ) {
3745 Debug( LDAP_DEBUG_TRACE,
3746 "pcache_parse_query_delete: invalid UUID length %lu.\n",
3747 (unsigned long)len, 0, 0 );
3748 goto decoding_error;
3749 }
3750 }
3751
3752 tag = ber_peek_tag( ber, &len );
3753 }
3754
3755 if ( tag != LBER_DEFAULT || len != 0 ) {
3756 decoding_error:;
3757 Debug( LDAP_DEBUG_TRACE,
3758 "pcache_parse_query_delete: decoding error\n",
3759 0, 0, 0 );
3760 rc = LDAP_PROTOCOL_ERROR;
3761 *text = "queryDelete data decoding error";
3762
3763 done:;
3764 if ( ndn && !BER_BVISNULL( ndn ) ) {
3765 slap_sl_free( ndn->bv_val, ctx );
3766 BER_BVZERO( ndn );
3767 }
3768
3769 if ( uuid && !BER_BVISNULL( uuid ) ) {
3770 slap_sl_free( uuid->bv_val, ctx );
3771 BER_BVZERO( uuid );
3772 }
3773 }
3774
3775 if ( !BER_BVISNULL( &reqdata ) ) {
3776 ber_memfree_x( reqdata.bv_val, ctx );
3777 }
3778
3779 return rc;
3780 }
3781
3782 static int
3783 pcache_exop_query_delete(
3784 Operation *op,
3785 SlapReply *rs )
3786 {
3787 BackendDB *bd = op->o_bd;
3788
3789 struct berval uuid = BER_BVNULL,
3790 *uuidp = NULL;
3791 char buf[ SLAP_TEXT_BUFLEN ] = { '\0' };
3792 int len = 0;
3793 ber_tag_t tag = LBER_DEFAULT;
3794
3795 if ( LogTest( LDAP_DEBUG_STATS ) ) {
3796 uuidp = &uuid;
3797 }
3798
3799 rs->sr_err = pcache_parse_query_delete( op->ore_reqdata,
3800 &tag, &op->o_req_ndn, uuidp,
3801 &rs->sr_text, op->o_tmpmemctx );
3802 if ( rs->sr_err != LDAP_SUCCESS ) {
3803 return rs->sr_err;
3804 }
3805
3806 if ( LogTest( LDAP_DEBUG_STATS ) ) {
3807 assert( !BER_BVISNULL( &op->o_req_ndn ) );
3808 len = snprintf( buf, sizeof( buf ), " dn=\"%s\"", op->o_req_ndn.bv_val );
3809
3810 if ( !BER_BVISNULL( &uuid ) ) {
3811 snprintf( &buf[ len ], sizeof( buf ) - len, " queryId=\"%s\"", uuid.bv_val );
3812 }
3813
3814 Debug( LDAP_DEBUG_STATS, "%s QUERY DELETE%s\n",
3815 op->o_log_prefix, buf, 0 );
3816 }
3817 op->o_req_dn = op->o_req_ndn;
3818
3819 op->o_bd = select_backend( &op->o_req_ndn, 0 );
3820 rs->sr_err = backend_check_restrictions( op, rs,
3821 (struct berval *)&pcache_exop_QUERY_DELETE );
3822 if ( rs->sr_err != LDAP_SUCCESS ) {
3823 goto done;
3824 }
3825
3826 if ( op->o_bd->be_extended == NULL ) {
3827 send_ldap_error( op, rs, LDAP_UNAVAILABLE_CRITICAL_EXTENSION,
3828 "backend does not support extended operations" );
3829 goto done;
3830 }
3831
3832 op->o_bd->be_extended( op, rs );
3833
3834 done:;
3835 if ( !BER_BVISNULL( &op->o_req_ndn ) ) {
3836 op->o_tmpfree( op->o_req_ndn.bv_val, op->o_tmpmemctx );
3837 BER_BVZERO( &op->o_req_ndn );
3838 BER_BVZERO( &op->o_req_dn );
3839 }
3840
3841 if ( !BER_BVISNULL( &uuid ) ) {
3842 op->o_tmpfree( uuid.bv_val, op->o_tmpmemctx );
3843 }
3844
3845 op->o_bd = bd;
3846
3847 return rs->sr_err;
3848 }
3849
3850 static int
3851 pcache_op_extended( Operation *op, SlapReply *rs )
3852 {
3853 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
3854 cache_manager *cm = on->on_bi.bi_private;
3855
3856 #ifdef PCACHE_CONTROL_PRIVDB
3857 if ( op->o_ctrlflag[ privDB_cid ] == SLAP_CONTROL_CRITICAL ) {
3858 return pcache_op_privdb( op, rs );
3859 }
3860 #endif /* PCACHE_CONTROL_PRIVDB */
3861
3862 if ( bvmatch( &op->ore_reqoid, &pcache_exop_QUERY_DELETE ) ) {
3863 struct berval uuid = BER_BVNULL;
3864 ber_tag_t tag = LBER_DEFAULT;
3865
3866 rs->sr_err = pcache_parse_query_delete( op->ore_reqdata,
3867 &tag, NULL, &uuid, &rs->sr_text, op->o_tmpmemctx );
3868 assert( rs->sr_err == LDAP_SUCCESS );
3869
3870 if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_DN ) {
3871 /* remove all queries related to the selected entry */
3872 rs->sr_err = pcache_remove_entry_queries_from_cache( op,
3873 cm, &op->o_req_ndn, &uuid );
3874
3875 } else if ( tag == LDAP_TAG_EXOP_QUERY_DELETE_BASE ) {
3876 if ( !BER_BVISNULL( &uuid ) ) {
3877 /* remove the selected query */
3878 rs->sr_err = pcache_remove_query_from_cache( op,
3879 cm, &uuid );
3880
3881 } else {
3882 /* TODO: remove all queries */
3883 rs->sr_err = LDAP_UNWILLING_TO_PERFORM;
3884 rs->sr_text = "deletion of all queries not implemented";
3885 }
3886 }
3887
3888 op->o_tmpfree( uuid.bv_val, op->o_tmpmemctx );
3889 }
3890
3891 return rs->sr_err;
3892 }
3893 #endif /* PCACHE_EXOP_QUERY_DELETE */
3894
3895 static slap_overinst pcache;
3896
3897 static char *obsolete_names[] = {
3898 "proxycache",
3899 NULL
3900 };
3901
3902 #if SLAPD_OVER_PROXYCACHE == SLAPD_MOD_DYNAMIC
3903 static
3904 #endif /* SLAPD_OVER_PROXYCACHE == SLAPD_MOD_DYNAMIC */
3905 int
3906 pcache_initialize()
3907 {
3908 int i, code;
3909 struct berval debugbv = BER_BVC("pcache");
3910
3911 code = slap_loglevel_get( &debugbv, &pcache_debug );
3912 if ( code ) {
3913 return code;
3914 }
3915
3916 #ifdef PCACHE_CONTROL_PRIVDB
3917 code = register_supported_control( PCACHE_CONTROL_PRIVDB,
3918 SLAP_CTRL_BIND|SLAP_CTRL_ACCESS|SLAP_CTRL_HIDE, extops,
3919 parse_privdb_ctrl, &privDB_cid );
3920 if ( code != LDAP_SUCCESS ) {
3921 Debug( LDAP_DEBUG_ANY,
3922 "pcache_initialize: failed to register control %s (%d)\n",
3923 PCACHE_CONTROL_PRIVDB, code, 0 );
3924 return code;
3925 }
3926 #endif /* PCACHE_CONTROL_PRIVDB */
3927
3928 #ifdef PCACHE_EXOP_QUERY_DELETE
3929 code = load_extop2( (struct berval *)&pcache_exop_QUERY_DELETE,
3930 SLAP_EXOP_WRITES|SLAP_EXOP_HIDE, pcache_exop_query_delete,
3931 0 );
3932 if ( code != LDAP_SUCCESS ) {
3933 Debug( LDAP_DEBUG_ANY,
3934 "pcache_initialize: unable to register queryDelete exop: %d.\n",
3935 code, 0, 0 );
3936 return code;
3937 }
3938 #endif /* PCACHE_EXOP_QUERY_DELETE */
3939
3940 for ( i = 0; as[i].desc != NULL; i++ ) {
3941 code = register_at( as[i].desc, as[i].adp, 0 );
3942 if ( code ) {
3943 Debug( LDAP_DEBUG_ANY,
3944 "pcache_initialize: register_at #%d failed\n", i, 0, 0 );
3945 return code;
3946 }
3947 (*as[i].adp)->ad_type->sat_flags |= SLAP_AT_HIDE;
3948 }
3949
3950 pcache.on_bi.bi_type = "pcache";
3951 pcache.on_bi.bi_obsolete_names = obsolete_names;
3952 pcache.on_bi.bi_db_init = pcache_db_init;
3953 pcache.on_bi.bi_db_config = pcache_db_config;
3954 pcache.on_bi.bi_db_open = pcache_db_open;
3955 pcache.on_bi.bi_db_close = pcache_db_close;
3956 pcache.on_bi.bi_db_destroy = pcache_db_destroy;
3957
3958 pcache.on_bi.bi_op_search = pcache_op_search;
3959 #ifdef PCACHE_CONTROL_PRIVDB
3960 pcache.on_bi.bi_op_bind = pcache_op_privdb;
3961 pcache.on_bi.bi_op_compare = pcache_op_privdb;
3962 pcache.on_bi.bi_op_modrdn = pcache_op_privdb;
3963 pcache.on_bi.bi_op_modify = pcache_op_privdb;
3964 pcache.on_bi.bi_op_add = pcache_op_privdb;
3965 pcache.on_bi.bi_op_delete = pcache_op_privdb;
3966 #endif /* PCACHE_CONTROL_PRIVDB */
3967 #ifdef PCACHE_EXOP_QUERY_DELETE
3968 pcache.on_bi.bi_extended = pcache_op_extended;
3969 #elif defined( PCACHE_CONTROL_PRIVDB )
3970 pcache.on_bi.bi_extended = pcache_op_privdb;
3971 #endif
3972
3973 pcache.on_bi.bi_chk_controls = pcache_chk_controls;
3974
3975 pcache.on_bi.bi_cf_ocs = pcocs;
3976
3977 code = config_register_schema( pccfg, pcocs );
3978 if ( code ) return code;
3979
3980 {
3981 const char *text;
3982 code = slap_str2ad( "olcDatabase", &pcdummy[0].ad, &text );
3983 if ( code ) return code;
3984 }
3985 return overlay_register( &pcache );
3986 }
3987
3988 #if SLAPD_OVER_PROXYCACHE == SLAPD_MOD_DYNAMIC
3989 int init_module(int argc, char *argv[]) {
3990 return pcache_initialize();
3991 }
3992 #endif
3993
3994 #endif /* defined(SLAPD_OVER_PROXYCACHE) */
NetBSD on the FriendlyARM MINI2440