git.sur5r.net Git - openldap/blob - servers/slapd/overlays/pcache.c

   1 /* $OpenLDAP$ */
   2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   3  *
   4  * Copyright 2003-2007 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 /* query cache structs */
  39 /* query */
  40
  41 typedef struct Query_s {
  42         Filter*         filter;         /* Search Filter */
  43         struct berval   base;           /* Search Base */
  44         int             scope;          /* Search scope */
  45 } Query;
  46
  47 struct query_template_s;
  48
  49 typedef struct Qbase_s {
  50         Avlnode *scopes[4];             /* threaded AVL trees of cached queries */
  51         struct berval base;
  52         int queries;
  53 } Qbase;
  54
  55 /* struct representing a cached query */
  56 typedef struct cached_query_s {
  57         Filter                                  *filter;
  58         Filter                                  *first;
  59         Qbase                                   *qbase;
  60         int                                             scope;
  61         struct berval                   q_uuid;         /* query identifier */
  62         struct query_template_s         *qtemp; /* template of the query */
  63         time_t                          expiry_time;    /* time till the query is considered valid */
  64         struct cached_query_s           *next;          /* next query in the template */
  65         struct cached_query_s           *prev;          /* previous query in the template */
  66         struct cached_query_s           *lru_up;        /* previous query in the LRU list */
  67         struct cached_query_s           *lru_down;      /* next query in the LRU list */
  68 } CachedQuery;
  69
  70 /*
  71  * URL representation:
  72  *
  73  * ldap:///<base>??<scope>?<filter>?x-uuid=<uid>,x-template=<template>,x-attrset=<attrset>,x-expiry=<expiry>
  74  *
  75  * <base> ::= CachedQuery.qbase->base
  76  * <scope> ::= CachedQuery.scope
  77  * <filter> ::= filter2bv(CachedQuery.filter)
  78  * <uuid> ::= CachedQuery.q_uuid
  79  * <template> ::= CachedQuery.qtemp->querystr           [FIXME: better give it an ID?]
  80  * <attrset> ::= CachedQuery.qtemp->attr_set_index      [FIXME: better give it an ID?]
  81  * <expiry> ::= CachedQuery.expiry_time
  82  *
  83  * quick hack: parse URI, call add_query() and then fix
  84  * CachedQuery.expiry_time and CachedQuery.q_uuid
  85  */
  86
  87 /*
  88  * Represents a set of projected attributes.
  89  */
  90
  91 struct attr_set {
  92         struct query_template_s *templates;
  93         AttributeName*  attrs;          /* specifies the set */
  94         unsigned        flags;
  95 #define PC_CONFIGURED   (0x1)
  96 #define PC_REFERENCED   (0x2)
  97 #define PC_GOT_OC               (0x4)
  98         int             count;          /* number of attributes */
  99 };
 100
 101 /* struct representing a query template
 102  * e.g. template string = &(cn=)(mail=)
 103  */
 104 typedef struct query_template_s {
 105         struct query_template_s *qtnext;
 106         struct query_template_s *qmnext;
 107
 108         Avlnode*                qbase;
 109         CachedQuery*    query;          /* most recent query cached for the template */
 110         CachedQuery*    query_last;     /* oldest query cached for the template */
 111         ldap_pvt_thread_rdwr_t t_rwlock; /* Rd/wr lock for accessing queries in the template */
 112         struct berval   querystr;       /* Filter string corresponding to the QT */
 113
 114         int             attr_set_index; /* determines the projected attributes */
 115         int             no_of_queries;  /* Total number of queries in the template */
 116         time_t          ttl;            /* TTL for the queries of this template */
 117         time_t          negttl;         /* TTL for negative results */
 118         struct attr_set t_attrs;        /* filter attrs + attr_set */
 119 } QueryTemplate;
 120
 121 struct query_manager_s;
 122
 123 /* prototypes for functions for 1) query containment
 124  * 2) query addition, 3) cache replacement
 125  */
 126 typedef CachedQuery *   (QCfunc)(Operation *op, struct query_manager_s*, Query*, QueryTemplate*);
 127 typedef CachedQuery *   (AddQueryfunc)(Operation *op, struct query_manager_s*, Query*, QueryTemplate*, int positive);
 128 typedef void    (CRfunc)(struct query_manager_s*, struct berval * );
 129
 130 /* LDAP query cache */
 131 typedef struct query_manager_s {
 132         struct attr_set*        attr_sets;              /* possible sets of projected attributes */
 133         QueryTemplate*          templates;              /* cacheable templates */
 134
 135         CachedQuery*            lru_top;                /* top and bottom of LRU list */
 136         CachedQuery*            lru_bottom;
 137
 138         ldap_pvt_thread_mutex_t         lru_mutex;      /* mutex for accessing LRU list */
 139
 140         /* Query cache methods */
 141         QCfunc                  *qcfunc;                        /* Query containment*/
 142         CRfunc                  *crfunc;                        /* cache replacement */
 143         AddQueryfunc    *addfunc;                       /* add query */
 144 } query_manager;
 145
 146 /* LDAP query cache manager */
 147 typedef struct cache_manager_s {
 148         BackendDB       db;     /* underlying database */
 149         unsigned long   num_cached_queries;             /* total number of cached queries */
 150         unsigned long   max_queries;                    /* upper bound on # of cached queries */
 151         int             save_queries;                   /* save cached queries across restarts */
 152         int     numattrsets;                    /* number of attribute sets */
 153         int     cur_entries;                    /* current number of entries cached */
 154         int     max_entries;                    /* max number of entries cached */
 155         int     num_entries_limit;              /* max # of entries in a cacheable query */
 156
 157         char    response_cb;                    /* install the response callback
 158                                                  * at the tail of the callback list */
 159 #define PCACHE_RESPONSE_CB_HEAD 0
 160 #define PCACHE_RESPONSE_CB_TAIL 1
 161
 162         time_t  cc_period;              /* interval between successive consistency checks (sec) */
 163         int     cc_paused;
 164         void    *cc_arg;
 165
 166         ldap_pvt_thread_mutex_t         cache_mutex;
 167
 168         query_manager*   qm;    /* query cache managed by the cache manager */
 169 } cache_manager;
 170
 171 static int pcache_debug;
 172
 173 static AttributeDescription *ad_queryid, *ad_cachedQueryURL;
 174 static struct {
 175         char    *desc;
 176         AttributeDescription **adp;
 177 } as[] = {
 178         { "( 1.3.6.1.4.1.4203.666.1.12 NAME 'queryid' "
 179                 "DESC 'list of queries the entry belongs to' "
 180                 "EQUALITY octetStringMatch "
 181                 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.40{64} "
 182                 "NO-USER-MODIFICATION USAGE directoryOperation )",
 183                 &ad_queryid },
 184         { "(1.3.6.1.4.1.4203.666.1.999999 NAME 'cachedQueryURL' "
 185                 "DESC 'URI describing a cached query' "
 186                 "EQUALITY caseExactMatch "
 187                 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.15 "
 188                 "NO-USER-MODIFICATION USAGE directoryOperation )",
 189                 &ad_cachedQueryURL },
 190         { NULL }
 191 };
 192
 193 static int
 194 filter2template(
 195         Operation               *op,
 196         Filter                  *f,
 197         struct                  berval *fstr,
 198         AttributeName**         filter_attrs,
 199         int*                    filter_cnt,
 200         int*                    filter_got_oc );
 201
 202 static CachedQuery *
 203 add_query(
 204         Operation *op,
 205         query_manager* qm,
 206         Query* query,
 207         QueryTemplate *templ,
 208         int positive);
 209
 210 /*
 211  * Turn a cached query into its URL representation
 212  */
 213 static int
 214 query2url( CachedQuery *q, struct berval *urlbv )
 215 {
 216         struct berval   bv_scope,
 217                         bv_filter;
 218         char            attrset_buf[ 32 ],
 219                         expiry_buf[ 32 ],
 220                         *ptr;
 221         ber_len_t       attrset_len,
 222                         expiry_len;
 223
 224         ldap_pvt_scope2bv( q->scope, &bv_scope );
 225         filter2bv( q->filter, &bv_filter );
 226         attrset_len = snprintf( attrset_buf, sizeof( attrset_buf ),
 227                 "%lu", (unsigned long)q->qtemp->attr_set_index );
 228         expiry_len = snprintf( expiry_buf, sizeof( expiry_buf ),
 229                 "%lu", (unsigned long)q->expiry_time );
 230
 231         urlbv->bv_len = STRLENOF( "ldap:///" )
 232                 + q->qbase->base.bv_len
 233                 + STRLENOF( "??" )
 234                 + bv_scope.bv_len
 235                 + STRLENOF( "?" )
 236                 + bv_filter.bv_len
 237                 + STRLENOF( "?x-uuid=" )
 238                 + q->q_uuid.bv_len
 239                 + STRLENOF( ",x-attrset=" )
 240                 + attrset_len
 241                 + STRLENOF( ",x-expiry=" )
 242                 + expiry_len;
 243         ptr = urlbv->bv_val = ch_malloc( urlbv->bv_len + 1 );
 244         ptr = lutil_strcopy( ptr, "ldap:///" );
 245         ptr = lutil_strcopy( ptr, q->qbase->base.bv_val );
 246         ptr = lutil_strcopy( ptr, "??" );
 247         ptr = lutil_strcopy( ptr, bv_scope.bv_val );
 248         ptr = lutil_strcopy( ptr, "?" );
 249         ptr = lutil_strcopy( ptr, bv_filter.bv_val );
 250         ptr = lutil_strcopy( ptr, "?x-uuid=" );
 251         ptr = lutil_strcopy( ptr, q->q_uuid.bv_val );
 252         ptr = lutil_strcopy( ptr, ",x-attrset=" );
 253         ptr = lutil_strcopy( ptr, attrset_buf );
 254         ptr = lutil_strcopy( ptr, ",x-expiry=" );
 255         ptr = lutil_strcopy( ptr, expiry_buf );
 256
 257         ber_memfree( bv_filter.bv_val );
 258
 259         return 0;
 260 }
 261
 262 /*
 263  * Turn an URL representing a formerly cached query into a cached query,
 264  * and try to cache it
 265  */
 266 static int
 267 url2query(
 268         char            *url,
 269         Operation       *op,
 270         query_manager   *qm )
 271 {
 272         Query           query = { 0 };
 273         QueryTemplate   *qt;
 274         CachedQuery     *cq;
 275         LDAPURLDesc     *lud = NULL;
 276         struct berval   base,
 277                         tempstr = BER_BVNULL,
 278                         uuid;
 279         int             attrset;
 280         time_t          expiry_time;
 281         int             i,
 282                         got_uuid = 0,
 283                         got_attrset = 0,
 284                         got_expiry = 0,
 285                         rc = 0;
 286
 287         rc = ldap_url_parse( url, &lud );
 288         if ( rc != LDAP_URL_SUCCESS ) {
 289                 return -1;
 290         }
 291
 292         /* non-allowed fields */
 293         if ( lud->lud_host != NULL ) {
 294                 rc = 1;
 295                 goto error;
 296         }
 297
 298         if ( lud->lud_attrs != NULL ) {
 299                 rc = 1;
 300                 goto error;
 301         }
 302
 303         /* be pedantic */
 304         if ( strcmp( lud->lud_scheme, "ldap" ) != 0 ) {
 305                 rc = 1;
 306                 goto error;
 307         }
 308
 309         /* required fields */
 310         if ( lud->lud_dn == NULL || lud->lud_dn[ 0 ] == '\0' ) {
 311                 rc = 1;
 312                 goto error;
 313         }
 314
 315         switch ( lud->lud_scope ) {
 316         case LDAP_SCOPE_BASE:
 317         case LDAP_SCOPE_ONELEVEL:
 318         case LDAP_SCOPE_SUBTREE:
 319         case LDAP_SCOPE_SUBORDINATE:
 320                 break;
 321
 322         default:
 323                 rc = 1;
 324                 goto error;
 325         }
 326
 327         if ( lud->lud_filter == NULL || lud->lud_filter[ 0 ] == '\0' ) {
 328                 rc = 1;
 329                 goto error;
 330         }
 331
 332         if ( lud->lud_exts == NULL ) {
 333                 rc = 1;
 334                 goto error;
 335         }
 336
 337         for ( i = 0; lud->lud_exts[ i ] != NULL; i++ ) {
 338                 if ( strncmp( lud->lud_exts[ i ], "x-uuid=", STRLENOF( "x-uuid=" ) ) == 0 ) {
 339                         ber_str2bv( &lud->lud_exts[ i ][ STRLENOF( "x-uuid=" ) ], 0, 0, &uuid );
 340                         if ( rc ) {
 341                                 goto error;
 342                         }
 343                         got_uuid = 1;
 344
 345                 } else if ( strncmp( lud->lud_exts[ i ], "x-attrset=", STRLENOF( "x-attrset=" ) ) == 0 ) {
 346                         rc = lutil_atoi( &attrset, &lud->lud_exts[ i ][ STRLENOF( "x-attrset=" ) ] );
 347                         if ( rc ) {
 348                                 goto error;
 349                         }
 350                         got_attrset = 1;
 351
 352                 } else if ( strncmp( lud->lud_exts[ i ], "x-expiry=", STRLENOF( "x-expiry=" ) ) == 0 ) {
 353                         unsigned long l;
 354
 355                         rc = lutil_atoul( &l, &lud->lud_exts[ i ][ STRLENOF( "x-expiry=" ) ] );
 356                         if ( rc ) {
 357                                 goto error;
 358                         }
 359                         expiry_time = (time_t)l;
 360                         got_expiry = 1;
 361
 362                         /* ignore expired queries */
 363                         if ( expiry_time <= slap_get_time()) {
 364                                 rc = 0;
 365                                 goto error;
 366                         }
 367
 368                 } else {
 369                         rc = -1;
 370                         goto error;
 371                 }
 372         }
 373
 374         if ( !got_uuid ) {
 375                 rc = 1;
 376                 goto error;
 377         }
 378
 379         if ( !got_attrset ) {
 380                 rc = 1;
 381                 goto error;
 382         }
 383
 384         if ( !got_expiry ) {
 385                 rc = 1;
 386                 goto error;
 387         }
 388
 389         ber_str2bv( lud->lud_dn, 0, 0, &base );
 390         rc = dnNormalize( 0, NULL, NULL, &base, &query.base, NULL );
 391         if ( rc != LDAP_SUCCESS ) {
 392                 goto error;
 393         }
 394         query.scope = lud->lud_scope;
 395         query.filter = str2filter( lud->lud_filter );
 396
 397         tempstr.bv_val = ch_malloc( strlen( lud->lud_filter ) + 1 );
 398         tempstr.bv_len = 0;
 399         if ( filter2template( op, query.filter, &tempstr, NULL, NULL, NULL ) ) {
 400                 ch_free( tempstr.bv_val );
 401                 rc = -1;
 402                 goto error;
 403         }
 404
 405         /* check for query containment */
 406         qt = qm->attr_sets[attrset].templates;
 407         for ( ; qt; qt = qt->qtnext ) {
 408                 /* find if template i can potentially answer tempstr */
 409                 if ( bvmatch( &qt->querystr, &tempstr ) ) {
 410                         break;
 411                 }
 412         }
 413
 414         if ( qt == NULL ) {
 415                 rc = 1;
 416                 goto error;
 417         }
 418
 419
 420         cq = add_query( op, qm, &query, qt, 1 );
 421         if ( cq != NULL ) {
 422                 cq->expiry_time = expiry_time;
 423                 ber_dupbv( &cq->q_uuid, &uuid );
 424                 /* it's now into cq->filter */
 425                 query.filter = NULL;
 426
 427         } else {
 428                 rc = 1;
 429         }
 430
 431 error:;
 432         if ( query.filter != NULL ) filter_free( query.filter );
 433         if ( !BER_BVISNULL( &tempstr ) ) ch_free( tempstr.bv_val );
 434         if ( !BER_BVISNULL( &query.base ) ) ch_free( query.base.bv_val );
 435         if ( lud != NULL ) ldap_free_urldesc( lud );
 436
 437         return rc;
 438 }
 439
 440 /* Return 1 for an added entry, else 0 */
 441 static int
 442 merge_entry(
 443         Operation               *op,
 444         Entry                   *e,
 445         struct berval*          query_uuid )
 446 {
 447         int             rc;
 448         Modifications* modlist = NULL;
 449         const char*     text = NULL;
 450         Attribute               *attr;
 451         char                    textbuf[SLAP_TEXT_BUFLEN];
 452         size_t                  textlen = sizeof(textbuf);
 453
 454         SlapReply sreply = {REP_RESULT};
 455
 456         slap_callback cb = { NULL, slap_null_cb, NULL, NULL };
 457
 458         attr = e->e_attrs;
 459         e->e_attrs = NULL;
 460
 461         /* add queryid attribute */
 462         attr_merge_one( e, ad_queryid, query_uuid, NULL );
 463
 464         /* append the attribute list from the fetched entry */
 465         e->e_attrs->a_next = attr;
 466
 467         op->o_tag = LDAP_REQ_ADD;
 468         op->o_protocol = LDAP_VERSION3;
 469         op->o_callback = &cb;
 470         op->o_time = slap_get_time();
 471         op->o_do_not_cache = 1;
 472
 473         op->ora_e = e;
 474         op->o_req_dn = e->e_name;
 475         op->o_req_ndn = e->e_nname;
 476         rc = op->o_bd->be_add( op, &sreply );
 477
 478         if ( rc != LDAP_SUCCESS ) {
 479                 if ( rc == LDAP_ALREADY_EXISTS ) {
 480                         slap_entry2mods( e, &modlist, &text, textbuf, textlen );
 481                         modlist->sml_op = LDAP_MOD_ADD;
 482                         op->o_tag = LDAP_REQ_MODIFY;
 483                         op->orm_modlist = modlist;
 484                         op->o_bd->be_modify( op, &sreply );
 485                         slap_mods_free( modlist, 1 );
 486                 } else if ( rc == LDAP_REFERRAL ||
 487                                         rc == LDAP_NO_SUCH_OBJECT ) {
 488                         syncrepl_add_glue( op, e );
 489                         e = NULL;
 490                         rc = 1;
 491                 }
 492                 if ( e ) {
 493                         entry_free( e );
 494                         rc = 0;
 495                 }
 496         } else {
 497                 if ( op->ora_e == e )
 498                         be_entry_release_w( op, e );
 499                 rc = 1;
 500         }
 501
 502         return rc;
 503 }
 504
 505 /* Length-ordered sort on normalized DNs */
 506 static int pcache_dn_cmp( const void *v1, const void *v2 )
 507 {
 508         const Qbase *q1 = v1, *q2 = v2;
 509
 510         int rc = q1->base.bv_len - q2->base.bv_len;
 511         if ( rc == 0 )
 512                 rc = strncmp( q1->base.bv_val, q2->base.bv_val, q1->base.bv_len );
 513         return rc;
 514 }
 515
 516 static int lex_bvcmp( struct berval *bv1, struct berval *bv2 )
 517 {
 518         int len, dif;
 519         dif = bv1->bv_len - bv2->bv_len;
 520         len = bv1->bv_len;
 521         if ( dif > 0 ) len -= dif;
 522         len = memcmp( bv1->bv_val, bv2->bv_val, len );
 523         if ( !len )
 524                 len = dif;
 525         return len;
 526 }
 527
 528 /* compare the first value in each filter */
 529 static int pcache_filter_cmp( const void *v1, const void *v2 )
 530 {
 531         const CachedQuery *q1 = v1, *q2 =v2;
 532         int rc, weight1, weight2;
 533
 534         switch( q1->first->f_choice ) {
 535         case LDAP_FILTER_PRESENT:
 536                 weight1 = 0;
 537                 break;
 538         case LDAP_FILTER_EQUALITY:
 539         case LDAP_FILTER_GE:
 540         case LDAP_FILTER_LE:
 541                 weight1 = 1;
 542                 break;
 543         default:
 544                 weight1 = 2;
 545         }
 546         switch( q2->first->f_choice ) {
 547         case LDAP_FILTER_PRESENT:
 548                 weight2 = 0;
 549                 break;
 550         case LDAP_FILTER_EQUALITY:
 551         case LDAP_FILTER_GE:
 552         case LDAP_FILTER_LE:
 553                 weight2 = 1;
 554                 break;
 555         default:
 556                 weight2 = 2;
 557         }
 558         rc = weight1 - weight2;
 559         if ( !rc ) {
 560                 switch( weight1 ) {
 561                 case 0: return 0;
 562                 case 1:
 563                         rc = lex_bvcmp( &q1->first->f_av_value, &q2->first->f_av_value );
 564                         break;
 565                 case 2:
 566                         if ( q1->first->f_choice == LDAP_FILTER_SUBSTRINGS ) {
 567                                 rc = 0;
 568                                 if ( !BER_BVISNULL( &q1->first->f_sub_initial )) {
 569                                         if ( !BER_BVISNULL( &q2->first->f_sub_initial )) {
 570                                                 rc = lex_bvcmp( &q1->first->f_sub_initial,
 571                                                         &q2->first->f_sub_initial );
 572                                         } else {
 573                                                 rc = 1;
 574                                         }
 575                                 } else if ( !BER_BVISNULL( &q2->first->f_sub_initial )) {
 576                                         rc = -1;
 577                                 }
 578                                 if ( rc ) break;
 579                                 if ( q1->first->f_sub_any ) {
 580                                         if ( q2->first->f_sub_any ) {
 581                                                 rc = lex_bvcmp( q1->first->f_sub_any,
 582                                                         q2->first->f_sub_any );
 583                                         } else {
 584                                                 rc = 1;
 585                                         }
 586                                 } else if ( q2->first->f_sub_any ) {
 587                                         rc = -1;
 588                                 }
 589                                 if ( rc ) break;
 590                                 if ( !BER_BVISNULL( &q1->first->f_sub_final )) {
 591                                         if ( !BER_BVISNULL( &q2->first->f_sub_final )) {
 592                                                 rc = lex_bvcmp( &q1->first->f_sub_final,
 593                                                         &q2->first->f_sub_final );
 594                                         } else {
 595                                                 rc = 1;
 596                                         }
 597                                 } else if ( !BER_BVISNULL( &q2->first->f_sub_final )) {
 598                                         rc = -1;
 599                                 }
 600                         } else {
 601                                 rc = lex_bvcmp( &q1->first->f_mr_value,
 602                                         &q2->first->f_mr_value );
 603                         }
 604                         break;
 605                 }
 606         }
 607
 608         return rc;
 609 }
 610
 611 /* add query on top of LRU list */
 612 static void
 613 add_query_on_top (query_manager* qm, CachedQuery* qc)
 614 {
 615         CachedQuery* top = qm->lru_top;
 616
 617         qm->lru_top = qc;
 618
 619         if (top)
 620                 top->lru_up = qc;
 621         else
 622                 qm->lru_bottom = qc;
 623
 624         qc->lru_down = top;
 625         qc->lru_up = NULL;
 626         Debug( pcache_debug, "Base of added query = %s\n",
 627                         qc->qbase->base.bv_val, 0, 0 );
 628 }
 629
 630 /* remove_query from LRU list */
 631
 632 static void
 633 remove_query (query_manager* qm, CachedQuery* qc)
 634 {
 635         CachedQuery* up;
 636         CachedQuery* down;
 637
 638         if (!qc)
 639                 return;
 640
 641         up = qc->lru_up;
 642         down = qc->lru_down;
 643
 644         if (!up)
 645                 qm->lru_top = down;
 646
 647         if (!down)
 648                 qm->lru_bottom = up;
 649
 650         if (down)
 651                 down->lru_up = up;
 652
 653         if (up)
 654                 up->lru_down = down;
 655
 656         qc->lru_up = qc->lru_down = NULL;
 657 }
 658
 659 /* find and remove string2 from string1
 660  * from start if position = 1,
 661  * from end if position = 3,
 662  * from anywhere if position = 2
 663  * string1 is overwritten if position = 2.
 664  */
 665
 666 static int
 667 find_and_remove(struct berval* ber1, struct berval* ber2, int position)
 668 {
 669         int ret=0;
 670
 671         if ( !ber2->bv_val )
 672                 return 1;
 673         if ( !ber1->bv_val )
 674                 return 0;
 675
 676         switch( position ) {
 677         case 1:
 678                 if ( ber1->bv_len >= ber2->bv_len && !memcmp( ber1->bv_val,
 679                         ber2->bv_val, ber2->bv_len )) {
 680                         ret = 1;
 681                         ber1->bv_val += ber2->bv_len;
 682                         ber1->bv_len -= ber2->bv_len;
 683                 }
 684                 break;
 685         case 2: {
 686                 char *temp;
 687                 ber1->bv_val[ber1->bv_len] = '\0';
 688                 temp = strstr( ber1->bv_val, ber2->bv_val );
 689                 if ( temp ) {
 690                         strcpy( temp, temp+ber2->bv_len );
 691                         ber1->bv_len -= ber2->bv_len;
 692                         ret = 1;
 693                 }
 694                 break;
 695                 }
 696         case 3:
 697                 if ( ber1->bv_len >= ber2->bv_len &&
 698                         !memcmp( ber1->bv_val+ber1->bv_len-ber2->bv_len, ber2->bv_val,
 699                                 ber2->bv_len )) {
 700                         ret = 1;
 701                         ber1->bv_len -= ber2->bv_len;
 702                 }
 703                 break;
 704         }
 705         return ret;
 706 }
 707
 708
 709 static struct berval*
 710 merge_init_final(Operation *op, struct berval* init, struct berval* any,
 711         struct berval* final)
 712 {
 713         struct berval* merged, *temp;
 714         int i, any_count, count;
 715
 716         for (any_count=0; any && any[any_count].bv_val; any_count++)
 717                 ;
 718
 719         count = any_count;
 720
 721         if (init->bv_val)
 722                 count++;
 723         if (final->bv_val)
 724                 count++;
 725
 726         merged = (struct berval*)op->o_tmpalloc( (count+1)*sizeof(struct berval),
 727                 op->o_tmpmemctx );
 728         temp = merged;
 729
 730         if (init->bv_val) {
 731                 ber_dupbv_x( temp, init, op->o_tmpmemctx );
 732                 temp++;
 733         }
 734
 735         for (i=0; i<any_count; i++) {
 736                 ber_dupbv_x( temp, any, op->o_tmpmemctx );
 737                 temp++; any++;
 738         }
 739
 740         if (final->bv_val){
 741                 ber_dupbv_x( temp, final, op->o_tmpmemctx );
 742                 temp++;
 743         }
 744         BER_BVZERO( temp );
 745         return merged;
 746 }
 747
 748 /* Each element in stored must be found in incoming. Incoming is overwritten.
 749  */
 750 static int
 751 strings_containment(struct berval* stored, struct berval* incoming)
 752 {
 753         struct berval* element;
 754         int k=0;
 755         int j, rc = 0;
 756
 757         for ( element=stored; element->bv_val != NULL; element++ ) {
 758                 for (j = k; incoming[j].bv_val != NULL; j++) {
 759                         if (find_and_remove(&(incoming[j]), element, 2)) {
 760                                 k = j;
 761                                 rc = 1;
 762                                 break;
 763                         }
 764                         rc = 0;
 765                 }
 766                 if ( rc ) {
 767                         continue;
 768                 } else {
 769                         return 0;
 770                 }
 771         }
 772         return 1;
 773 }
 774
 775 static int
 776 substr_containment_substr(Operation *op, Filter* stored, Filter* incoming)
 777 {
 778         int rc = 0;
 779
 780         struct berval init_incoming;
 781         struct berval final_incoming;
 782         struct berval *remaining_incoming = NULL;
 783
 784         if ((!(incoming->f_sub_initial.bv_val) && (stored->f_sub_initial.bv_val))
 785            || (!(incoming->f_sub_final.bv_val) && (stored->f_sub_final.bv_val)))
 786                 return 0;
 787
 788         init_incoming = incoming->f_sub_initial;
 789         final_incoming =  incoming->f_sub_final;
 790
 791         if (find_and_remove(&init_incoming,
 792                         &(stored->f_sub_initial), 1) && find_and_remove(&final_incoming,
 793                         &(stored->f_sub_final), 3))
 794         {
 795                 if (stored->f_sub_any == NULL) {
 796                         rc = 1;
 797                         goto final;
 798                 }
 799                 remaining_incoming = merge_init_final(op, &init_incoming,
 800                                                 incoming->f_sub_any, &final_incoming);
 801                 rc = strings_containment(stored->f_sub_any, remaining_incoming);
 802                 ber_bvarray_free_x( remaining_incoming, op->o_tmpmemctx );
 803         }
 804 final:
 805         return rc;
 806 }
 807
 808 static int
 809 substr_containment_equality(Operation *op, Filter* stored, Filter* incoming)
 810 {
 811         struct berval incoming_val[2];
 812         int rc = 0;
 813
 814         incoming_val[1] = incoming->f_av_value;
 815
 816         if (find_and_remove(incoming_val+1,
 817                         &(stored->f_sub_initial), 1) && find_and_remove(incoming_val+1,
 818                         &(stored->f_sub_final), 3)) {
 819                 if (stored->f_sub_any == NULL){
 820                         rc = 1;
 821                         goto final;
 822                 }
 823                 ber_dupbv_x( incoming_val, incoming_val+1, op->o_tmpmemctx );
 824                 BER_BVZERO( incoming_val+1 );
 825                 rc = strings_containment(stored->f_sub_any, incoming_val);
 826                 op->o_tmpfree( incoming_val[0].bv_val, op->o_tmpmemctx );
 827         }
 828 final:
 829         return rc;
 830 }
 831
 832 static Filter *
 833 filter_first( Filter *f )
 834 {
 835         while ( f->f_choice == LDAP_FILTER_OR || f->f_choice == LDAP_FILTER_AND )
 836                 f = f->f_and;
 837         return f;
 838 }
 839
 840
 841 static CachedQuery *
 842 find_filter( Operation *op, Avlnode *root, Filter *inputf, Filter *first )
 843 {
 844         Filter* fs;
 845         Filter* fi;
 846         MatchingRule* mrule = NULL;
 847         int res=0, eqpass= 0;
 848         int ret, rc, dir;
 849         Avlnode *ptr;
 850         CachedQuery cq, *qc;
 851
 852         cq.filter = inputf;
 853         cq.first = first;
 854
 855         /* substring matches sort to the end, and we just have to
 856          * walk the entire list.
 857          */
 858         if ( first->f_choice == LDAP_FILTER_SUBSTRINGS ) {
 859                 ptr = tavl_end( root, 1 );
 860                 dir = TAVL_DIR_LEFT;
 861         } else {
 862                 ptr = tavl_find3( root, &cq, pcache_filter_cmp, &ret );
 863                 dir = (first->f_choice == LDAP_FILTER_GE) ? TAVL_DIR_LEFT :
 864                         TAVL_DIR_RIGHT;
 865         }
 866
 867         while (ptr) {
 868                 qc = ptr->avl_data;
 869                 fi = inputf;
 870                 fs = qc->filter;
 871
 872                 /* an incoming substr query can only be satisfied by a cached
 873                  * substr query.
 874                  */
 875                 if ( first->f_choice == LDAP_FILTER_SUBSTRINGS &&
 876                         qc->first->f_choice != LDAP_FILTER_SUBSTRINGS )
 877                         break;
 878
 879                 /* an incoming eq query can be satisfied by a cached eq or substr
 880                  * query
 881                  */
 882                 if ( first->f_choice == LDAP_FILTER_EQUALITY ) {
 883                         if ( eqpass == 0 ) {
 884                                 if ( qc->first->f_choice != LDAP_FILTER_EQUALITY ) {
 885 nextpass:                       eqpass = 1;
 886                                         ptr = tavl_end( root, 1 );
 887                                         dir = TAVL_DIR_LEFT;
 888                                         continue;
 889                                 }
 890                         } else {
 891                                 if ( qc->first->f_choice != LDAP_FILTER_SUBSTRINGS )
 892                                         break;
 893                         }
 894                 }
 895                 do {
 896                         res=0;
 897                         switch (fs->f_choice) {
 898                         case LDAP_FILTER_EQUALITY:
 899                                 if (fi->f_choice == LDAP_FILTER_EQUALITY)
 900                                         mrule = fs->f_ava->aa_desc->ad_type->sat_equality;
 901                                 else
 902                                         ret = 1;
 903                                 break;
 904                         case LDAP_FILTER_GE:
 905                         case LDAP_FILTER_LE:
 906                                 mrule = fs->f_ava->aa_desc->ad_type->sat_ordering;
 907                                 break;
 908                         default:
 909                                 mrule = NULL;
 910                         }
 911                         if (mrule) {
 912                                 const char *text;
 913                                 rc = value_match(&ret, fs->f_ava->aa_desc, mrule,
 914                                         SLAP_MR_VALUE_OF_ASSERTION_SYNTAX,
 915                                         &(fi->f_ava->aa_value),
 916                                         &(fs->f_ava->aa_value), &text);
 917                                 if (rc != LDAP_SUCCESS) {
 918                                         return NULL;
 919                                 }
 920                                 if ( fi==first && fi->f_choice==LDAP_FILTER_EQUALITY && ret )
 921                                         goto nextpass;
 922                         }
 923                         switch (fs->f_choice) {
 924                         case LDAP_FILTER_OR:
 925                         case LDAP_FILTER_AND:
 926                                 fs = fs->f_and;
 927                                 fi = fi->f_and;
 928                                 res=1;
 929                                 break;
 930                         case LDAP_FILTER_SUBSTRINGS:
 931                                 /* check if the equality query can be
 932                                 * answered with cached substring query */
 933                                 if ((fi->f_choice == LDAP_FILTER_EQUALITY)
 934                                         && substr_containment_equality( op,
 935                                         fs, fi))
 936                                         res=1;
 937                                 /* check if the substring query can be
 938                                 * answered with cached substring query */
 939                                 if ((fi->f_choice ==LDAP_FILTER_SUBSTRINGS
 940                                         ) && substr_containment_substr( op,
 941                                         fs, fi))
 942                                         res= 1;
 943                                 fs=fs->f_next;
 944                                 fi=fi->f_next;
 945                                 break;
 946                         case LDAP_FILTER_PRESENT:
 947                                 res=1;
 948                                 fs=fs->f_next;
 949                                 fi=fi->f_next;
 950                                 break;
 951                         case LDAP_FILTER_EQUALITY:
 952                                 if (ret == 0)
 953                                         res = 1;
 954                                 fs=fs->f_next;
 955                                 fi=fi->f_next;
 956                                 break;
 957                         case LDAP_FILTER_GE:
 958                                 if (mrule && ret >= 0)
 959                                         res = 1;
 960                                 fs=fs->f_next;
 961                                 fi=fi->f_next;
 962                                 break;
 963                         case LDAP_FILTER_LE:
 964                                 if (mrule && ret <= 0)
 965                                         res = 1;
 966                                 fs=fs->f_next;
 967                                 fi=fi->f_next;
 968                                 break;
 969                         case LDAP_FILTER_NOT:
 970                                 res=0;
 971                                 break;
 972                         default:
 973                                 break;
 974                         }
 975                 } while((res) && (fi != NULL) && (fs != NULL));
 976
 977                 if ( res )
 978                         return qc;
 979                 ptr = tavl_next( ptr, dir );
 980         }
 981         return NULL;
 982 }
 983
 984 /* check whether query is contained in any of
 985  * the cached queries in template
 986  */
 987 static CachedQuery *
 988 query_containment(Operation *op, query_manager *qm,
 989                   Query *query,
 990                   QueryTemplate *templa)
 991 {
 992         CachedQuery* qc;
 993         int depth = 0, tscope;
 994         Qbase qbase, *qbptr = NULL;
 995         struct berval pdn;
 996
 997         if (query->filter != NULL) {
 998                 Filter *first;
 999
1000                 Debug( pcache_debug, "Lock QC index = %p\n",
1001                                 (void *) templa, 0, 0 );
1002                 qbase.base = query->base;
1003
1004                 first = filter_first( query->filter );
1005
1006                 ldap_pvt_thread_rdwr_rlock(&templa->t_rwlock);
1007                 for( ;; ) {
1008                         /* Find the base */
1009                         qbptr = avl_find( templa->qbase, &qbase, pcache_dn_cmp );
1010                         if ( qbptr ) {
1011                                 tscope = query->scope;
1012                                 /* Find a matching scope:
1013                                  * match at depth 0 OK
1014                                  * scope is BASE,
1015                                  *      one at depth 1 OK
1016                                  *  subord at depth > 0 OK
1017                                  *      subtree at any depth OK
1018                                  * scope is ONE,
1019                                  *  subtree or subord at any depth OK
1020                                  * scope is SUBORD,
1021                                  *  subtree or subord at any depth OK
1022                                  * scope is SUBTREE,
1023                                  *  subord at depth > 0 OK
1024                                  *  subtree at any depth OK
1025                                  */
1026                                 for ( tscope = 0 ; tscope <= LDAP_SCOPE_CHILDREN; tscope++ ) {
1027                                         switch ( query->scope ) {
1028                                         case LDAP_SCOPE_BASE:
1029                                                 if ( tscope == LDAP_SCOPE_BASE && depth ) continue;
1030                                                 if ( tscope == LDAP_SCOPE_ONE && depth != 1) continue;
1031                                                 if ( tscope == LDAP_SCOPE_CHILDREN && !depth ) continue;
1032                                                 break;
1033                                         case LDAP_SCOPE_ONE:
1034                                                 if ( tscope == LDAP_SCOPE_BASE )
1035                                                         tscope = LDAP_SCOPE_ONE;
1036                                                 if ( tscope == LDAP_SCOPE_ONE && depth ) continue;
1037                                                 if ( !depth ) break;
1038                                                 if ( tscope < LDAP_SCOPE_SUBTREE )
1039                                                         tscope = LDAP_SCOPE_SUBTREE;
1040                                                 break;
1041                                         case LDAP_SCOPE_SUBTREE:
1042                                                 if ( tscope < LDAP_SCOPE_SUBTREE )
1043                                                         tscope = LDAP_SCOPE_SUBTREE;
1044                                                 if ( tscope == LDAP_SCOPE_CHILDREN && !depth ) continue;
1045                                                 break;
1046                                         case LDAP_SCOPE_CHILDREN:
1047                                                 if ( tscope < LDAP_SCOPE_SUBTREE )
1048                                                         tscope = LDAP_SCOPE_SUBTREE;
1049                                                 break;
1050                                         }
1051                                         if ( !qbptr->scopes[tscope] ) continue;
1052
1053                                         /* Find filter */
1054                                         qc = find_filter( op, qbptr->scopes[tscope],
1055                                                         query->filter, first );
1056                                         if ( qc ) {
1057                                                 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
1058                                                 if (qm->lru_top != qc) {
1059                                                         remove_query(qm, qc);
1060                                                         add_query_on_top(qm, qc);
1061                                                 }
1062                                                 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1063                                                 return qc;
1064                                         }
1065                                 }
1066                         }
1067                         if ( be_issuffix( op->o_bd, &qbase.base ))
1068                                 break;
1069                         /* Up a level */
1070                         dnParent( &qbase.base, &pdn );
1071                         qbase.base = pdn;
1072                         depth++;
1073                 }
1074
1075                 Debug( pcache_debug,
1076                         "Not answerable: Unlock QC index=%p\n",
1077                         (void *) templa, 0, 0 );
1078                 ldap_pvt_thread_rdwr_runlock(&templa->t_rwlock);
1079         }
1080         return NULL;
1081 }
1082
1083 static void
1084 free_query (CachedQuery* qc)
1085 {
1086         free(qc->q_uuid.bv_val);
1087         filter_free(qc->filter);
1088         free(qc);
1089 }
1090
1091
1092 /* Add query to query cache */
1093 static CachedQuery *
1094 add_query(
1095         Operation *op,
1096         query_manager* qm,
1097         Query* query,
1098         QueryTemplate *templ,
1099         int positive)
1100 {
1101         CachedQuery* new_cached_query = (CachedQuery*) ch_malloc(sizeof(CachedQuery));
1102         Qbase *qbase, qb;
1103         Filter *first;
1104         int rc;
1105
1106         new_cached_query->qtemp = templ;
1107         BER_BVZERO( &new_cached_query->q_uuid );
1108         if ( positive ) {
1109                 new_cached_query->expiry_time = slap_get_time() + templ->ttl;
1110         } else {
1111                 new_cached_query->expiry_time = slap_get_time() + templ->negttl;
1112         }
1113         new_cached_query->lru_up = NULL;
1114         new_cached_query->lru_down = NULL;
1115         Debug( pcache_debug, "Added query expires at %ld\n",
1116                         (long) new_cached_query->expiry_time, 0, 0 );
1117
1118         new_cached_query->scope = query->scope;
1119         new_cached_query->filter = query->filter;
1120         new_cached_query->first = first = filter_first( query->filter );
1121
1122         qb.base = query->base;
1123
1124         /* Adding a query    */
1125         Debug( pcache_debug, "Lock AQ index = %p\n",
1126                         (void *) templ, 0, 0 );
1127         ldap_pvt_thread_rdwr_wlock(&templ->t_rwlock);
1128         qbase = avl_find( templ->qbase, &qb, pcache_dn_cmp );
1129         if ( !qbase ) {
1130                 qbase = ch_calloc( 1, sizeof(Qbase) + qb.base.bv_len + 1 );
1131                 qbase->base.bv_len = qb.base.bv_len;
1132                 qbase->base.bv_val = (char *)(qbase+1);
1133                 memcpy( qbase->base.bv_val, qb.base.bv_val, qb.base.bv_len );
1134                 qbase->base.bv_val[qbase->base.bv_len] = '\0';
1135                 avl_insert( &templ->qbase, qbase, pcache_dn_cmp, avl_dup_error );
1136         }
1137         new_cached_query->next = templ->query;
1138         new_cached_query->prev = NULL;
1139         new_cached_query->qbase = qbase;
1140         rc = tavl_insert( &qbase->scopes[query->scope], new_cached_query,
1141                 pcache_filter_cmp, avl_dup_error );
1142         if ( rc == 0 ) {
1143                 qbase->queries++;
1144                 if (templ->query == NULL)
1145                         templ->query_last = new_cached_query;
1146                 else
1147                         templ->query->prev = new_cached_query;
1148                 templ->query = new_cached_query;
1149                 templ->no_of_queries++;
1150         } else {
1151                 ch_free( new_cached_query );
1152                 new_cached_query = find_filter( op, qbase->scopes[query->scope],
1153                                                         query->filter, first );
1154                 filter_free( query->filter );
1155         }
1156         Debug( pcache_debug, "TEMPLATE %p QUERIES++ %d\n",
1157                         (void *) templ, templ->no_of_queries, 0 );
1158
1159         Debug( pcache_debug, "Unlock AQ index = %p \n",
1160                         (void *) templ, 0, 0 );
1161         ldap_pvt_thread_rdwr_wunlock(&templ->t_rwlock);
1162
1163         /* Adding on top of LRU list  */
1164         if ( rc == 0 ) {
1165                 ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
1166                 add_query_on_top(qm, new_cached_query);
1167                 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1168         }
1169         return rc == 0 ? new_cached_query : NULL;
1170 }
1171
1172 static void
1173 remove_from_template (CachedQuery* qc, QueryTemplate* template)
1174 {
1175         if (!qc->prev && !qc->next) {
1176                 template->query_last = template->query = NULL;
1177         } else if (qc->prev == NULL) {
1178                 qc->next->prev = NULL;
1179                 template->query = qc->next;
1180         } else if (qc->next == NULL) {
1181                 qc->prev->next = NULL;
1182                 template->query_last = qc->prev;
1183         } else {
1184                 qc->next->prev = qc->prev;
1185                 qc->prev->next = qc->next;
1186         }
1187         tavl_delete( &qc->qbase->scopes[qc->scope], qc, pcache_filter_cmp );
1188         qc->qbase->queries--;
1189         if ( qc->qbase->queries == 0 ) {
1190                 avl_delete( &template->qbase, qc->qbase, pcache_dn_cmp );
1191                 ch_free( qc->qbase );
1192                 qc->qbase = NULL;
1193         }
1194
1195         template->no_of_queries--;
1196 }
1197
1198 /* remove bottom query of LRU list from the query cache */
1199 static void cache_replacement(query_manager* qm, struct berval *result)
1200 {
1201         CachedQuery* bottom;
1202         QueryTemplate *temp;
1203
1204         ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
1205         bottom = qm->lru_bottom;
1206
1207         result->bv_val = NULL;
1208         result->bv_len = 0;
1209
1210         if (!bottom) {
1211                 Debug ( pcache_debug,
1212                         "Cache replacement invoked without "
1213                         "any query in LRU list\n", 0, 0, 0 );
1214                 ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1215                 return;
1216         }
1217
1218         temp = bottom->qtemp;
1219         remove_query(qm, bottom);
1220         ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1221
1222         *result = bottom->q_uuid;
1223         bottom->q_uuid.bv_val = NULL;
1224
1225         Debug( pcache_debug, "Lock CR index = %p\n", (void *) temp, 0, 0 );
1226         ldap_pvt_thread_rdwr_wlock(&temp->t_rwlock);
1227         remove_from_template(bottom, temp);
1228         Debug( pcache_debug, "TEMPLATE %p QUERIES-- %d\n",
1229                 (void *) temp, temp->no_of_queries, 0 );
1230         Debug( pcache_debug, "Unlock CR index = %p\n", (void *) temp, 0, 0 );
1231         ldap_pvt_thread_rdwr_wunlock(&temp->t_rwlock);
1232         free_query(bottom);
1233 }
1234
1235 struct query_info {
1236         struct query_info *next;
1237         struct berval xdn;
1238         int del;
1239 };
1240
1241 static int
1242 remove_func (
1243         Operation       *op,
1244         SlapReply       *rs
1245 )
1246 {
1247         Attribute *attr;
1248         struct query_info *qi;
1249         int count = 0;
1250
1251         if ( rs->sr_type != REP_SEARCH ) return 0;
1252
1253         for (attr = rs->sr_entry->e_attrs; attr!= NULL; attr = attr->a_next) {
1254                 if (attr->a_desc == ad_queryid) {
1255                         for (count=0; attr->a_vals[count].bv_val; count++)
1256                                 ;
1257                         break;
1258                 }
1259         }
1260         if ( count == 0 ) return 0;
1261         qi = op->o_tmpalloc( sizeof( struct query_info ), op->o_tmpmemctx );
1262         qi->next = op->o_callback->sc_private;
1263         op->o_callback->sc_private = qi;
1264         ber_dupbv_x( &qi->xdn, &rs->sr_entry->e_nname, op->o_tmpmemctx );
1265         qi->del = ( count == 1 );
1266
1267         return 0;
1268 }
1269
1270 static int
1271 remove_query_data (
1272         Operation       *op,
1273         SlapReply       *rs,
1274         struct berval* query_uuid)
1275 {
1276         struct query_info       *qi, *qnext;
1277         char                    filter_str[64];
1278 #ifdef LDAP_COMP_MATCH
1279         AttributeAssertion      ava = { NULL, BER_BVNULL, NULL };
1280 #else
1281         AttributeAssertion      ava = { NULL, BER_BVNULL };
1282 #endif
1283         Filter                  filter = {LDAP_FILTER_EQUALITY};
1284         SlapReply               sreply = {REP_RESULT};
1285         slap_callback cb = { NULL, remove_func, NULL, NULL };
1286         int deleted = 0;
1287
1288         sreply.sr_entry = NULL;
1289         sreply.sr_nentries = 0;
1290         op->ors_filterstr.bv_len = snprintf(filter_str, sizeof(filter_str),
1291                 "(%s=%s)", ad_queryid->ad_cname.bv_val, query_uuid->bv_val);
1292         filter.f_ava = &ava;
1293         filter.f_av_desc = ad_queryid;
1294         filter.f_av_value = *query_uuid;
1295
1296         op->o_tag = LDAP_REQ_SEARCH;
1297         op->o_protocol = LDAP_VERSION3;
1298         op->o_callback = &cb;
1299         op->o_time = slap_get_time();
1300         op->o_do_not_cache = 1;
1301
1302         op->o_req_dn = op->o_bd->be_suffix[0];
1303         op->o_req_ndn = op->o_bd->be_nsuffix[0];
1304         op->ors_scope = LDAP_SCOPE_SUBTREE;
1305         op->ors_deref = LDAP_DEREF_NEVER;
1306         op->ors_slimit = SLAP_NO_LIMIT;
1307         op->ors_tlimit = SLAP_NO_LIMIT;
1308         op->ors_filter = &filter;
1309         op->ors_filterstr.bv_val = filter_str;
1310         op->ors_filterstr.bv_len = strlen(filter_str);
1311         op->ors_attrs = NULL;
1312         op->ors_attrsonly = 0;
1313
1314         op->o_bd->be_search( op, &sreply );
1315
1316         for ( qi=cb.sc_private; qi; qi=qnext ) {
1317                 qnext = qi->next;
1318
1319                 op->o_req_dn = qi->xdn;
1320                 op->o_req_ndn = qi->xdn;
1321
1322                 if ( qi->del) {
1323                         Debug( pcache_debug, "DELETING ENTRY TEMPLATE=%s\n",
1324                                 query_uuid->bv_val, 0, 0 );
1325
1326                         op->o_tag = LDAP_REQ_DELETE;
1327
1328                         if (op->o_bd->be_delete(op, &sreply) == LDAP_SUCCESS) {
1329                                 deleted++;
1330                         }
1331                 } else {
1332                         Modifications mod;
1333                         struct berval vals[2];
1334
1335                         vals[0] = *query_uuid;
1336                         vals[1].bv_val = NULL;
1337                         vals[1].bv_len = 0;
1338                         mod.sml_op = LDAP_MOD_DELETE;
1339                         mod.sml_flags = 0;
1340                         mod.sml_desc = ad_queryid;
1341                         mod.sml_type = ad_queryid->ad_cname;
1342                         mod.sml_values = vals;
1343                         mod.sml_nvalues = NULL;
1344                         mod.sml_next = NULL;
1345                         Debug( pcache_debug,
1346                                 "REMOVING TEMP ATTR : TEMPLATE=%s\n",
1347                                 query_uuid->bv_val, 0, 0 );
1348
1349                         op->orm_modlist = &mod;
1350
1351                         op->o_bd->be_modify( op, &sreply );
1352                 }
1353                 op->o_tmpfree( qi->xdn.bv_val, op->o_tmpmemctx );
1354                 op->o_tmpfree( qi, op->o_tmpmemctx );
1355         }
1356         return deleted;
1357 }
1358
1359 static int
1360 get_attr_set(
1361         AttributeName* attrs,
1362         query_manager* qm,
1363         int num
1364 );
1365
1366 static int
1367 filter2template(
1368         Operation               *op,
1369         Filter                  *f,
1370         struct                  berval *fstr,
1371         AttributeName**         filter_attrs,
1372         int*                    filter_cnt,
1373         int*                    filter_got_oc )
1374 {
1375         AttributeDescription *ad;
1376
1377         switch ( f->f_choice ) {
1378         case LDAP_FILTER_EQUALITY:
1379                 ad = f->f_av_desc;
1380                 sprintf( fstr->bv_val+fstr->bv_len, "(%s=)", ad->ad_cname.bv_val );
1381                 fstr->bv_len += ad->ad_cname.bv_len + ( sizeof("(=)") - 1 );
1382                 break;
1383
1384         case LDAP_FILTER_GE:
1385                 ad = f->f_av_desc;
1386                 sprintf( fstr->bv_val+fstr->bv_len, "(%s>=)", ad->ad_cname.bv_val);
1387                 fstr->bv_len += ad->ad_cname.bv_len + ( sizeof("(>=)") - 1 );
1388                 break;
1389
1390         case LDAP_FILTER_LE:
1391                 ad = f->f_av_desc;
1392                 sprintf( fstr->bv_val+fstr->bv_len, "(%s<=)", ad->ad_cname.bv_val);
1393                 fstr->bv_len += ad->ad_cname.bv_len + ( sizeof("(<=)") - 1 );
1394                 break;
1395
1396         case LDAP_FILTER_APPROX:
1397                 ad = f->f_av_desc;
1398                 sprintf( fstr->bv_val+fstr->bv_len, "(%s~=)", ad->ad_cname.bv_val);
1399                 fstr->bv_len += ad->ad_cname.bv_len + ( sizeof("(~=)") - 1 );
1400                 break;
1401
1402         case LDAP_FILTER_SUBSTRINGS:
1403                 ad = f->f_sub_desc;
1404                 sprintf( fstr->bv_val+fstr->bv_len, "(%s=)", ad->ad_cname.bv_val );
1405                 fstr->bv_len += ad->ad_cname.bv_len + ( sizeof("(=)") - 1 );
1406                 break;
1407
1408         case LDAP_FILTER_PRESENT:
1409                 ad = f->f_desc;
1410                 sprintf( fstr->bv_val+fstr->bv_len, "(%s=*)", ad->ad_cname.bv_val );
1411                 fstr->bv_len += ad->ad_cname.bv_len + ( sizeof("(=*)") - 1 );
1412                 break;
1413
1414         case LDAP_FILTER_AND:
1415         case LDAP_FILTER_OR:
1416         case LDAP_FILTER_NOT: {
1417                 int rc = 0;
1418                 sprintf( fstr->bv_val+fstr->bv_len, "(%c",
1419                         f->f_choice == LDAP_FILTER_AND ? '&' :
1420                         f->f_choice == LDAP_FILTER_OR ? '|' : '!' );
1421                 fstr->bv_len += sizeof("(%") - 1;
1422
1423                 for ( f = f->f_list; f != NULL; f = f->f_next ) {
1424                         rc = filter2template( op, f, fstr, filter_attrs, filter_cnt,
1425                                 filter_got_oc );
1426                         if ( rc ) break;
1427                 }
1428                 sprintf( fstr->bv_val+fstr->bv_len, ")" );
1429                 fstr->bv_len += sizeof(")") - 1;
1430
1431                 return rc;
1432                 }
1433
1434         default:
1435                 strcpy( fstr->bv_val, "(?=?)" );
1436                 fstr->bv_len += sizeof("(?=?)")-1;
1437                 return -1;
1438         }
1439
1440         if ( filter_attrs != NULL ) {
1441                 *filter_attrs = (AttributeName *)op->o_tmprealloc(*filter_attrs,
1442                                 (*filter_cnt + 2)*sizeof(AttributeName), op->o_tmpmemctx);
1443
1444                 (*filter_attrs)[*filter_cnt].an_desc = ad;
1445                 (*filter_attrs)[*filter_cnt].an_name = ad->ad_cname;
1446                 (*filter_attrs)[*filter_cnt].an_oc = NULL;
1447                 (*filter_attrs)[*filter_cnt].an_oc_exclude = 0;
1448                 BER_BVZERO( &(*filter_attrs)[*filter_cnt+1].an_name );
1449                 (*filter_cnt)++;
1450                 if ( ad == slap_schema.si_ad_objectClass )
1451                         *filter_got_oc = 1;
1452         }
1453
1454         return 0;
1455 }
1456
1457 struct search_info {
1458         slap_overinst *on;
1459         Query query;
1460         QueryTemplate *qtemp;
1461         AttributeName*  save_attrs;     /* original attributes, saved for response */
1462         int max;
1463         int over;
1464         int count;
1465         Entry *head, *tail;
1466 };
1467
1468 static int
1469 cache_entries(
1470         Operation       *op,
1471         SlapReply       *rs,
1472         struct berval *query_uuid)
1473 {
1474         struct search_info *si = op->o_callback->sc_private;
1475         slap_overinst *on = si->on;
1476         cache_manager *cm = on->on_bi.bi_private;
1477         query_manager*          qm = cm->qm;
1478         int             return_val = 0;
1479         Entry           *e;
1480         struct berval   crp_uuid;
1481         char            uuidbuf[ LDAP_LUTIL_UUIDSTR_BUFSIZE ];
1482         Operation op_tmp = *op;
1483
1484         query_uuid->bv_len = lutil_uuidstr(uuidbuf, sizeof(uuidbuf));
1485         ber_str2bv(uuidbuf, query_uuid->bv_len, 1, query_uuid);
1486
1487         op_tmp.o_bd = &cm->db;
1488         op_tmp.o_dn = cm->db.be_rootdn;
1489         op_tmp.o_ndn = cm->db.be_rootndn;
1490
1491         Debug( pcache_debug, "UUID for query being added = %s\n",
1492                         uuidbuf, 0, 0 );
1493
1494         for ( e=si->head; e; e=si->head ) {
1495                 si->head = e->e_private;
1496                 e->e_private = NULL;
1497                 while ( cm->cur_entries > (cm->max_entries) ) {
1498                                 qm->crfunc(qm, &crp_uuid);
1499                                 if (crp_uuid.bv_val) {
1500                                         Debug( pcache_debug,
1501                                                 "Removing query UUID %s\n",
1502                                                 crp_uuid.bv_val, 0, 0 );
1503                                         return_val = remove_query_data(&op_tmp, rs, &crp_uuid);
1504                                         Debug( pcache_debug,
1505                                                 "QUERY REMOVED, SIZE=%d\n",
1506                                                 return_val, 0, 0);
1507                                         ldap_pvt_thread_mutex_lock(
1508                                                         &cm->cache_mutex );
1509                                         cm->cur_entries -= return_val;
1510                                         cm->num_cached_queries--;
1511                                         Debug( pcache_debug,
1512                                                 "STORED QUERIES = %lu\n",
1513                                                 cm->num_cached_queries, 0, 0 );
1514                                         ldap_pvt_thread_mutex_unlock(
1515                                                         &cm->cache_mutex );
1516                                         Debug( pcache_debug,
1517                                                 "QUERY REMOVED, CACHE ="
1518                                                 "%d entries\n",
1519                                                 cm->cur_entries, 0, 0 );
1520                                 }
1521                 }
1522
1523                 return_val = merge_entry(&op_tmp, e, query_uuid);
1524                 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
1525                 cm->cur_entries += return_val;
1526                 Debug( pcache_debug,
1527                         "ENTRY ADDED/MERGED, CACHED ENTRIES=%d\n",
1528                         cm->cur_entries, 0, 0 );
1529                 return_val = 0;
1530                 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
1531         }
1532
1533         return return_val;
1534 }
1535
1536 static int
1537 pcache_op_cleanup( Operation *op, SlapReply *rs ) {
1538         slap_callback   *cb = op->o_callback;
1539         struct search_info *si = cb->sc_private;
1540         if ( si->save_attrs != NULL ) {
1541                 rs->sr_attrs = si->save_attrs;
1542                 op->ors_attrs = si->save_attrs;
1543         }
1544         op->o_callback = op->o_callback->sc_next;
1545         op->o_tmpfree( cb, op->o_tmpmemctx );
1546         return SLAP_CB_CONTINUE;
1547 }
1548
1549 static int
1550 pcache_response(
1551         Operation       *op,
1552         SlapReply       *rs )
1553 {
1554         struct search_info *si = op->o_callback->sc_private;
1555         slap_overinst *on = si->on;
1556         cache_manager *cm = on->on_bi.bi_private;
1557         query_manager*          qm = cm->qm;
1558
1559         if ( si->save_attrs != NULL ) {
1560                 rs->sr_attrs = si->save_attrs;
1561                 op->ors_attrs = si->save_attrs;
1562         }
1563
1564         if ( rs->sr_type == REP_SEARCH ) {
1565                 Entry *e;
1566                 /* If we haven't exceeded the limit for this query,
1567                  * build a chain of answers to store. If we hit the
1568                  * limit, empty the chain and ignore the rest.
1569                  */
1570                 if ( !si->over ) {
1571                         if ( si->count < si->max ) {
1572                                 si->count++;
1573                                 e = entry_dup( rs->sr_entry );
1574                                 if ( !si->head ) si->head = e;
1575                                 if ( si->tail ) si->tail->e_private = e;
1576                                 si->tail = e;
1577                         } else {
1578                                 si->over = 1;
1579                                 si->count = 0;
1580                                 for (;si->head; si->head=e) {
1581                                         e = si->head->e_private;
1582                                         si->head->e_private = NULL;
1583                                         entry_free(si->head);
1584                                 }
1585                                 si->tail = NULL;
1586                         }
1587                 }
1588
1589         } else if ( rs->sr_type == REP_RESULT ) {
1590                 if ( si->count ||
1591                         ( si->qtemp->negttl && !si->count && !si->over &&
1592                                 rs->sr_err == LDAP_SUCCESS )) {
1593                         CachedQuery *qc = qm->addfunc(op, qm, &si->query, si->qtemp,
1594                                 si->count);
1595
1596                         if ( qc != NULL ) {
1597                                 if ( si->count )
1598                                         cache_entries( op, rs, &qc->q_uuid );
1599                                 ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
1600                                 cm->num_cached_queries++;
1601                                 Debug( pcache_debug, "STORED QUERIES = %lu\n",
1602                                                 cm->num_cached_queries, 0, 0 );
1603                                 ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
1604
1605                                 /* If the consistency checker suspended itself,
1606                                  * wake it back up
1607                                  */
1608                                 if ( cm->cc_paused ) {
1609                                         ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
1610                                         if ( cm->cc_paused ) {
1611                                                 cm->cc_paused = 0;
1612                                                 ldap_pvt_runqueue_resched( &slapd_rq, cm->cc_arg, 0 );
1613                                         }
1614                                         ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
1615                                 }
1616                         } else if ( si->count ) {
1617                                 /* duplicate query, free it */
1618                                 Entry *e;
1619                                 for (;si->head; si->head=e) {
1620                                         e = si->head->e_private;
1621                                         si->head->e_private = NULL;
1622                                         entry_free(si->head);
1623                                 }
1624                         }
1625                 } else {
1626                         filter_free( si->query.filter );
1627                 }
1628
1629                 op->o_callback->sc_cleanup = pcache_op_cleanup;
1630         }
1631         return SLAP_CB_CONTINUE;
1632 }
1633
1634 static void
1635 add_filter_attrs(
1636         Operation *op,
1637         AttributeName** new_attrs,
1638         struct attr_set *attrs,
1639         AttributeName* filter_attrs,
1640         int fattr_cnt,
1641         int fattr_got_oc)
1642 {
1643         int alluser = 0;
1644         int allop = 0;
1645         int i, j;
1646         int count;
1647         int addoc = 0;
1648
1649         /* duplicate attrs */
1650         count = attrs->count + fattr_cnt;
1651         if ( !fattr_got_oc && !(attrs->flags & PC_GOT_OC)) {
1652                 addoc = 1;
1653                 count++;
1654         }
1655
1656         *new_attrs = (AttributeName*)ch_calloc( count + 1,
1657                 sizeof(AttributeName) );
1658         for (i=0; i<attrs->count; i++) {
1659                 (*new_attrs)[i].an_name = attrs->attrs[i].an_name;
1660                 (*new_attrs)[i].an_desc = attrs->attrs[i].an_desc;
1661         }
1662         BER_BVZERO( &(*new_attrs)[i].an_name );
1663         alluser = an_find(*new_attrs, &AllUser);
1664         allop = an_find(*new_attrs, &AllOper);
1665
1666         j = i;
1667         for ( i=0; i<fattr_cnt; i++ ) {
1668                 if ( an_find(*new_attrs, &filter_attrs[i].an_name ) ) {
1669                         continue;
1670                 }
1671                 if ( is_at_operational(filter_attrs[i].an_desc->ad_type) ) {
1672                         if ( allop ) {
1673                                 continue;
1674                         }
1675                 } else if ( alluser ) {
1676                         continue;
1677                 }
1678                 (*new_attrs)[j].an_name = filter_attrs[i].an_name;
1679                 (*new_attrs)[j].an_desc = filter_attrs[i].an_desc;
1680                 (*new_attrs)[j].an_oc = NULL;
1681                 (*new_attrs)[j].an_oc_exclude = 0;
1682                 j++;
1683         }
1684         if ( addoc ) {
1685                 (*new_attrs)[j].an_name = slap_schema.si_ad_objectClass->ad_cname;
1686                 (*new_attrs)[j].an_desc = slap_schema.si_ad_objectClass;
1687                 (*new_attrs)[j].an_oc = NULL;
1688                 (*new_attrs)[j].an_oc_exclude = 0;
1689                 j++;
1690         }
1691         BER_BVZERO( &(*new_attrs)[j].an_name );
1692 }
1693
1694 /* NOTE: this is a quick workaround to let pcache minimally interact
1695  * with pagedResults.  A more articulated solutions would be to
1696  * perform the remote query without control and cache all results,
1697  * performing the pagedResults search only within the client
1698  * and the proxy.  This requires pcache to understand pagedResults. */
1699 static int
1700 pcache_chk_controls(
1701         Operation       *op,
1702         SlapReply       *rs )
1703 {
1704         const char      *non = "";
1705         const char      *stripped = "";
1706
1707         switch( op->o_pagedresults ) {
1708         case SLAP_CONTROL_NONCRITICAL:
1709                 non = "non-";
1710                 stripped = "; stripped";
1711                 /* fallthru */
1712
1713         case SLAP_CONTROL_CRITICAL:
1714                 Debug( pcache_debug, "%s: "
1715                         "%scritical pagedResults control "
1716                         "disabled with proxy cache%s.\n",
1717                         op->o_log_prefix, non, stripped );
1718
1719                 slap_remove_control( op, rs, slap_cids.sc_pagedResults, NULL );
1720                 break;
1721
1722         default:
1723                 rs->sr_err = SLAP_CB_CONTINUE;
1724                 break;
1725         }
1726
1727         return rs->sr_err;
1728 }
1729
1730 static int
1731 pcache_op_search(
1732         Operation       *op,
1733         SlapReply       *rs )
1734 {
1735         slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
1736         cache_manager *cm = on->on_bi.bi_private;
1737         query_manager*          qm = cm->qm;
1738
1739         int i = -1;
1740
1741         AttributeName   *filter_attrs = NULL;
1742
1743         Query           query;
1744         QueryTemplate   *qtemp = NULL;
1745
1746         int             attr_set = -1;
1747         CachedQuery     *answerable = NULL;
1748         int             cacheable = 0;
1749         int             fattr_cnt=0;
1750         int             fattr_got_oc = 0;
1751
1752         struct berval tempstr;
1753
1754         tempstr.bv_val = op->o_tmpalloc( op->ors_filterstr.bv_len+1, op->o_tmpmemctx );
1755         tempstr.bv_len = 0;
1756         if ( filter2template( op, op->ors_filter, &tempstr, &filter_attrs,
1757                 &fattr_cnt, &fattr_got_oc )) {
1758                 op->o_tmpfree( tempstr.bv_val, op->o_tmpmemctx );
1759                 return SLAP_CB_CONTINUE;
1760         }
1761
1762         Debug( pcache_debug, "query template of incoming query = %s\n",
1763                                         tempstr.bv_val, 0, 0 );
1764
1765         /* FIXME: cannot cache/answer requests with pagedResults control */
1766
1767         /* find attr set */
1768         attr_set = get_attr_set(op->ors_attrs, qm, cm->numattrsets);
1769
1770         query.filter = op->ors_filter;
1771         query.base = op->o_req_ndn;
1772         query.scope = op->ors_scope;
1773
1774         /* check for query containment */
1775         if (attr_set > -1) {
1776                 QueryTemplate *qt = qm->attr_sets[attr_set].templates;
1777                 for (; qt; qt = qt->qtnext ) {
1778                         /* find if template i can potentially answer tempstr */
1779                         if (qt->querystr.bv_len != tempstr.bv_len ||
1780                                 strcasecmp( qt->querystr.bv_val, tempstr.bv_val ))
1781                                 continue;
1782                         cacheable = 1;
1783                         qtemp = qt;
1784                         Debug( pcache_debug, "Entering QC, querystr = %s\n",
1785                                         op->ors_filterstr.bv_val, 0, 0 );
1786                         answerable = (*(qm->qcfunc))(op, qm, &query, qt);
1787
1788                         if (answerable)
1789                                 break;
1790                 }
1791         }
1792         op->o_tmpfree( tempstr.bv_val, op->o_tmpmemctx );
1793
1794         if (answerable) {
1795                 /* Need to clear the callbacks of the original operation,
1796                  * in case there are other overlays */
1797                 BackendDB       *save_bd = op->o_bd;
1798                 slap_callback   *save_cb = op->o_callback;
1799
1800                 Debug( pcache_debug, "QUERY ANSWERABLE\n", 0, 0, 0 );
1801                 op->o_tmpfree( filter_attrs, op->o_tmpmemctx );
1802                 if ( BER_BVISNULL( &answerable->q_uuid )) {
1803                         /* No entries cached, just an empty result set */
1804                         i = rs->sr_err = 0;
1805                         send_ldap_result( op, rs );
1806                 } else {
1807                         op->o_bd = &cm->db;
1808                         op->o_callback = NULL;
1809                         i = cm->db.bd_info->bi_op_search( op, rs );
1810                 }
1811                 ldap_pvt_thread_rdwr_runlock(&qtemp->t_rwlock);
1812                 op->o_bd = save_bd;
1813                 op->o_callback = save_cb;
1814                 return i;
1815         }
1816
1817         Debug( pcache_debug, "QUERY NOT ANSWERABLE\n", 0, 0, 0 );
1818
1819         ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
1820         if (cm->num_cached_queries >= cm->max_queries) {
1821                 cacheable = 0;
1822         }
1823         ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
1824
1825         if (op->ors_attrsonly)
1826                 cacheable = 0;
1827
1828         if (cacheable) {
1829                 slap_callback           *cb;
1830                 struct search_info      *si;
1831
1832                 Debug( pcache_debug, "QUERY CACHEABLE\n", 0, 0, 0 );
1833                 query.filter = filter_dup(op->ors_filter, NULL);
1834                 ldap_pvt_thread_rdwr_wlock(&qtemp->t_rwlock);
1835                 if ( !qtemp->t_attrs.count ) {
1836                         add_filter_attrs(op, &qtemp->t_attrs.attrs,
1837                                 &qm->attr_sets[attr_set],
1838                                 filter_attrs, fattr_cnt, fattr_got_oc);
1839                 }
1840                 ldap_pvt_thread_rdwr_wunlock(&qtemp->t_rwlock);
1841
1842                 cb = op->o_tmpalloc( sizeof(*cb) + sizeof(*si), op->o_tmpmemctx );
1843                 cb->sc_response = pcache_response;
1844                 cb->sc_cleanup = NULL;
1845                 cb->sc_private = (cb+1);
1846                 si = cb->sc_private;
1847                 si->on = on;
1848                 si->query = query;
1849                 si->qtemp = qtemp;
1850                 si->max = cm->num_entries_limit ;
1851                 si->over = 0;
1852                 si->count = 0;
1853                 si->head = NULL;
1854                 si->tail = NULL;
1855                 si->save_attrs = op->ors_attrs;
1856
1857                 op->ors_attrs = qtemp->t_attrs.attrs;
1858
1859                 if ( cm->response_cb == PCACHE_RESPONSE_CB_HEAD ) {
1860                         cb->sc_next = op->o_callback;
1861                         op->o_callback = cb;
1862
1863                 } else {
1864                         slap_callback           **pcb;
1865
1866                         /* need to move the callback at the end, in case other
1867                          * overlays are present, so that the final entry is
1868                          * actually cached */
1869                         cb->sc_next = NULL;
1870                         for ( pcb = &op->o_callback; *pcb; pcb = &(*pcb)->sc_next );
1871                         *pcb = cb;
1872                 }
1873
1874         } else {
1875                 Debug( pcache_debug, "QUERY NOT CACHEABLE\n",
1876                                         0, 0, 0);
1877         }
1878
1879         op->o_tmpfree( filter_attrs, op->o_tmpmemctx );
1880
1881         return SLAP_CB_CONTINUE;
1882 }
1883
1884 static int
1885 get_attr_set(
1886         AttributeName* attrs,
1887         query_manager* qm,
1888         int num )
1889 {
1890         int i;
1891         int count = 0;
1892
1893         if ( attrs ) {
1894                 for ( ; attrs[count].an_name.bv_val; count++ );
1895         }
1896
1897         /* recognize a single "*" or a "1.1" */
1898         if ( count == 0 ) {
1899                 count = 1;
1900                 attrs = slap_anlist_all_user_attributes;
1901
1902         } else if ( count == 1 && strcmp( attrs[0].an_name.bv_val, LDAP_NO_ATTRS ) == 0 ) {
1903                 count = 0;
1904                 attrs = NULL;
1905         }
1906
1907         for ( i = 0; i < num; i++ ) {
1908                 AttributeName *a2;
1909                 int found = 1;
1910
1911                 if ( count > qm->attr_sets[i].count ) {
1912                         continue;
1913                 }
1914
1915                 if ( !count ) {
1916                         if ( !qm->attr_sets[i].count ) {
1917                                 break;
1918                         }
1919                         continue;
1920                 }
1921
1922                 for ( a2 = attrs; a2->an_name.bv_val; a2++ ) {
1923                         if ( !an_find( qm->attr_sets[i].attrs, &a2->an_name ) ) {
1924                                 found = 0;
1925                                 break;
1926                         }
1927                 }
1928
1929                 if ( found ) {
1930                         break;
1931                 }
1932         }
1933
1934         if ( i == num ) {
1935                 i = -1;
1936         }
1937
1938         return i;
1939 }
1940
1941 static void*
1942 consistency_check(
1943         void *ctx,
1944         void *arg )
1945 {
1946         struct re_s *rtask = arg;
1947         slap_overinst *on = rtask->arg;
1948         cache_manager *cm = on->on_bi.bi_private;
1949         query_manager *qm = cm->qm;
1950         Connection conn = {0};
1951         OperationBuffer opbuf;
1952         Operation *op;
1953
1954         SlapReply rs = {REP_RESULT};
1955         CachedQuery* query;
1956         int return_val, pause = 1;
1957         QueryTemplate* templ;
1958
1959         connection_fake_init( &conn, &opbuf, ctx );
1960         op = &opbuf.ob_op;
1961
1962         op->o_bd = &cm->db;
1963         op->o_dn = cm->db.be_rootdn;
1964         op->o_ndn = cm->db.be_rootndn;
1965
1966         cm->cc_arg = arg;
1967
1968         for (templ = qm->templates; templ; templ=templ->qmnext) {
1969                 query = templ->query_last;
1970                 if ( query ) pause = 0;
1971                 op->o_time = slap_get_time();
1972                 while (query && (query->expiry_time < op->o_time)) {
1973                         int rem = 0;
1974                         Debug( pcache_debug, "Lock CR index = %p\n",
1975                                         (void *) templ, 0, 0 );
1976                         ldap_pvt_thread_rdwr_wlock(&templ->t_rwlock);
1977                         if ( query == templ->query_last ) {
1978                                 rem = 1;
1979                                 remove_from_template(query, templ);
1980                                 Debug( pcache_debug, "TEMPLATE %p QUERIES-- %d\n",
1981                                                 (void *) templ, templ->no_of_queries, 0 );
1982                                 Debug( pcache_debug, "Unlock CR index = %p\n",
1983                                                 (void *) templ, 0, 0 );
1984                         }
1985                         ldap_pvt_thread_rdwr_wunlock(&templ->t_rwlock);
1986                         if ( !rem ) {
1987                                 query = templ->query_last;
1988                                 continue;
1989                         }
1990                         ldap_pvt_thread_mutex_lock(&qm->lru_mutex);
1991                         remove_query(qm, query);
1992                         ldap_pvt_thread_mutex_unlock(&qm->lru_mutex);
1993                         if ( BER_BVISNULL( &query->q_uuid ))
1994                                 return_val = 0;
1995                         else
1996                                 return_val = remove_query_data(op, &rs, &query->q_uuid);
1997                         Debug( pcache_debug, "STALE QUERY REMOVED, SIZE=%d\n",
1998                                                 return_val, 0, 0 );
1999                         ldap_pvt_thread_mutex_lock(&cm->cache_mutex);
2000                         cm->cur_entries -= return_val;
2001                         cm->num_cached_queries--;
2002                         Debug( pcache_debug, "STORED QUERIES = %lu\n",
2003                                         cm->num_cached_queries, 0, 0 );
2004                         ldap_pvt_thread_mutex_unlock(&cm->cache_mutex);
2005                         Debug( pcache_debug,
2006                                 "STALE QUERY REMOVED, CACHE ="
2007                                 "%d entries\n",
2008                                 cm->cur_entries, 0, 0 );
2009                         free_query(query);
2010                         query = templ->query_last;
2011                 }
2012         }
2013         ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
2014         if ( ldap_pvt_runqueue_isrunning( &slapd_rq, rtask )) {
2015                 ldap_pvt_runqueue_stoptask( &slapd_rq, rtask );
2016         }
2017         /* If there were no queries, defer processing for a while */
2018         cm->cc_paused = pause;
2019         ldap_pvt_runqueue_resched( &slapd_rq, rtask, pause );
2020
2021         ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
2022         return NULL;
2023 }
2024
2025
2026 #define MAX_ATTR_SETS 500
2027
2028 enum {
2029         PC_MAIN = 1,
2030         PC_ATTR,
2031         PC_TEMP,
2032         PC_RESP,
2033         PC_QUERIES
2034 };
2035
2036 static ConfigDriver pc_cf_gen;
2037 static ConfigLDAPadd pc_ldadd;
2038 static ConfigCfAdd pc_cfadd;
2039
2040 static ConfigTable pccfg[] = {
2041         { "proxycache", "backend> <max_entries> <numattrsets> <entry limit> "
2042                                 "<cycle_time",
2043                 6, 6, 0, ARG_MAGIC|ARG_NO_DELETE|PC_MAIN, pc_cf_gen,
2044                 "( OLcfgOvAt:2.1 NAME 'olcProxyCache' "
2045                         "DESC 'ProxyCache basic parameters' "
2046                         "SYNTAX OMsDirectoryString SINGLE-VALUE )", NULL, NULL },
2047         { "proxyattrset", "index> <attributes...",
2048                 2, 0, 0, ARG_MAGIC|PC_ATTR, pc_cf_gen,
2049                 "( OLcfgOvAt:2.2 NAME 'olcProxyAttrset' "
2050                         "DESC 'A set of attributes to cache' "
2051                         "SYNTAX OMsDirectoryString )", NULL, NULL },
2052         { "proxytemplate", "filter> <attrset-index> <TTL> <negTTL",
2053                 4, 5, 0, ARG_MAGIC|PC_TEMP, pc_cf_gen,
2054                 "( OLcfgOvAt:2.3 NAME 'olcProxyTemplate' "
2055                         "DESC 'Filter template, attrset, cache TTL, optional negative TTL' "
2056                         "SYNTAX OMsDirectoryString )", NULL, NULL },
2057         { "response-callback", "head|tail(default)",
2058                 2, 2, 0, ARG_MAGIC|PC_RESP, pc_cf_gen,
2059                 "( OLcfgOvAt:2.4 NAME 'olcProxyResponseCB' "
2060                         "DESC 'Response callback position in overlay stack' "
2061                         "SYNTAX OMsDirectoryString )", NULL, NULL },
2062         { "proxyCacheQueries", "queries",
2063                 2, 2, 0, ARG_INT|ARG_MAGIC|PC_QUERIES, pc_cf_gen,
2064                 "( OLcfgOvAt:2.5 NAME 'olcProxyCacheQueries' "
2065                         "DESC 'Maximum number of queries to cache' "
2066                         "SYNTAX OMsInteger )", NULL, NULL },
2067         { "proxySaveQueries", "TRUE|FALSE",
2068                 2, 2, 0, ARG_ON_OFF|ARG_OFFSET, (void *)offsetof(cache_manager, save_queries),
2069                 "( OLcfgOvAt:2.6 NAME 'olcProxySaveQueries' "
2070                         "DESC 'Save cached queries for hot restart' "
2071                         "SYNTAX OMsBoolean )", NULL, NULL },
2072
2073         { NULL, NULL, 0, 0, 0, ARG_IGNORED }
2074 };
2075
2076 static ConfigOCs pcocs[] = {
2077         { "( OLcfgOvOc:2.1 "
2078                 "NAME 'olcPcacheConfig' "
2079                 "DESC 'ProxyCache configuration' "
2080                 "SUP olcOverlayConfig "
2081                 "MUST ( olcProxyCache $ olcProxyAttrset $ olcProxyTemplate ) "
2082                 "MAY ( olcProxyResponseCB $ olcProxyCacheQueries $ olcProxySaveQueries ) )",
2083                 Cft_Overlay, pccfg, NULL, pc_cfadd },
2084         { "( OLcfgOvOc:2.2 "
2085                 "NAME 'olcPcacheDatabase' "
2086                 "DESC 'Cache database configuration' "
2087                 "AUXILIARY )", Cft_Misc, pccfg, pc_ldadd },
2088         { NULL, 0, NULL }
2089 };
2090
2091 static int
2092 pc_ldadd( CfEntryInfo *p, Entry *e, ConfigArgs *ca )
2093 {
2094         slap_overinst *on;
2095         cache_manager *cm;
2096
2097         if ( p->ce_type != Cft_Overlay || !p->ce_bi ||
2098                 p->ce_bi->bi_cf_ocs != pcocs )
2099                 return LDAP_CONSTRAINT_VIOLATION;
2100
2101         on = (slap_overinst *)p->ce_bi;
2102         cm = on->on_bi.bi_private;
2103         ca->be = &cm->db;
2104         return LDAP_SUCCESS;
2105 }
2106
2107 static int
2108 pc_cfadd( Operation *op, SlapReply *rs, Entry *p, ConfigArgs *ca )
2109 {
2110         CfEntryInfo *pe = p->e_private;
2111         slap_overinst *on = (slap_overinst *)pe->ce_bi;
2112         cache_manager *cm = on->on_bi.bi_private;
2113         struct berval bv;
2114
2115         /* FIXME: should not hardcode "olcDatabase" here */
2116         bv.bv_len = sprintf( ca->cr_msg, "olcDatabase=%s", cm->db.bd_info->bi_type );
2117         bv.bv_val = ca->cr_msg;
2118         ca->be = &cm->db;
2119
2120         /* We can only create this entry if the database is table-driven
2121          */
2122         if ( cm->db.bd_info->bi_cf_ocs )
2123                 config_build_entry( op, rs, pe, ca, &bv, cm->db.bd_info->bi_cf_ocs,
2124                         &pcocs[1] );
2125
2126         return 0;
2127 }
2128
2129 static int
2130 pc_cf_gen( ConfigArgs *c )
2131 {
2132         slap_overinst   *on = (slap_overinst *)c->bi;
2133         cache_manager*  cm = on->on_bi.bi_private;
2134         query_manager*  qm = cm->qm;
2135         QueryTemplate*  temp;
2136         AttributeName*  attr_name;
2137         AttributeName*  attrarray;
2138         const char*     text=NULL;
2139         int             i, num, rc = 0;
2140         char            *ptr;
2141         unsigned long   t;
2142
2143         if ( c->op == SLAP_CONFIG_EMIT ) {
2144                 struct berval bv;
2145                 switch( c->type ) {
2146                 case PC_MAIN:
2147                         bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ), "%s %d %d %d %ld",
2148                                 cm->db.bd_info->bi_type, cm->max_entries, cm->numattrsets,
2149                                 cm->num_entries_limit, cm->cc_period );
2150                         bv.bv_val = c->cr_msg;
2151                         value_add_one( &c->rvalue_vals, &bv );
2152                         break;
2153                 case PC_ATTR:
2154                         for (i=0; i<cm->numattrsets; i++) {
2155                                 if ( !qm->attr_sets[i].count ) continue;
2156
2157                                 bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ), "%d", i );
2158
2159                                 /* count the attr length */
2160                                 for ( attr_name = qm->attr_sets[i].attrs;
2161                                         attr_name->an_name.bv_val; attr_name++ )
2162                                         bv.bv_len += attr_name->an_name.bv_len + 1;
2163
2164                                 bv.bv_val = ch_malloc( bv.bv_len+1 );
2165                                 ptr = lutil_strcopy( bv.bv_val, c->cr_msg );
2166                                 for ( attr_name = qm->attr_sets[i].attrs;
2167                                         attr_name->an_name.bv_val; attr_name++ ) {
2168                                         *ptr++ = ' ';
2169                                         ptr = lutil_strcopy( ptr, attr_name->an_name.bv_val );
2170                                 }
2171                                 ber_bvarray_add( &c->rvalue_vals, &bv );
2172                         }
2173                         if ( !c->rvalue_vals )
2174                                 rc = 1;
2175                         break;
2176                 case PC_TEMP:
2177                         for (temp=qm->templates; temp; temp=temp->qmnext) {
2178                                 if ( temp->negttl ) {
2179                                         bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ),
2180                                                 " %d %ld %ld",
2181                                                 temp->attr_set_index,
2182                                                 temp->ttl,
2183                                                 temp->negttl );
2184                                 } else {
2185                                         bv.bv_len = snprintf( c->cr_msg, sizeof( c->cr_msg ), " %d %ld",
2186                                                 temp->attr_set_index,
2187                                                 temp->ttl );
2188                                 }
2189                                 bv.bv_len += temp->querystr.bv_len + 2;
2190                                 bv.bv_val = ch_malloc( bv.bv_len+1 );
2191                                 ptr = bv.bv_val;
2192                                 *ptr++ = '"';
2193                                 ptr = lutil_strcopy( ptr, temp->querystr.bv_val );
2194                                 *ptr++ = '"';
2195                                 strcpy( ptr, c->cr_msg );
2196                                 ber_bvarray_add( &c->rvalue_vals, &bv );
2197                         }
2198                         if ( !c->rvalue_vals )
2199                                 rc = 1;
2200                         break;
2201                 case PC_RESP:
2202                         if ( cm->response_cb == PCACHE_RESPONSE_CB_HEAD ) {
2203                                 BER_BVSTR( &bv, "head" );
2204                         } else {
2205                                 BER_BVSTR( &bv, "tail" );
2206                         }
2207                         value_add_one( &c->rvalue_vals, &bv );
2208                         break;
2209                 case PC_QUERIES:
2210                         c->value_int = cm->max_queries;
2211                         break;
2212                 }
2213                 return rc;
2214         } else if ( c->op == LDAP_MOD_DELETE ) {
2215                 return 1;       /* FIXME */
2216 #if 0
2217                 switch( c->type ) {
2218                 case PC_ATTR:
2219                 case PC_TEMP:
2220                 }
2221                 return rc;
2222 #endif
2223         }
2224
2225         switch( c->type ) {
2226         case PC_MAIN:
2227                 if ( cm->numattrsets > 0 ) {
2228                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"proxycache\" directive already provided" );
2229                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2230                         return( 1 );
2231                 }
2232
2233                 if ( lutil_atoi( &cm->numattrsets, c->argv[3] ) != 0 ) {
2234                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse num attrsets=\"%s\" (arg #3)",
2235                                 c->argv[3] );
2236                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2237                         return( 1 );
2238                 }
2239                 if ( cm->numattrsets <= 0 ) {
2240                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "numattrsets (arg #3) must be positive" );
2241                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2242                         return( 1 );
2243                 }
2244                 if ( cm->numattrsets > MAX_ATTR_SETS ) {
2245                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "numattrsets (arg #3) must be <= %d", MAX_ATTR_SETS );
2246                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2247                         return( 1 );
2248                 }
2249
2250                 if ( !backend_db_init( c->argv[1], &cm->db, -1, NULL )) {
2251                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "unknown backend type (arg #1)" );
2252                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2253                         return( 1 );
2254                 }
2255
2256                 if ( lutil_atoi( &cm->max_entries, c->argv[2] ) != 0 ) {
2257                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse max entries=\"%s\" (arg #2)",
2258                                 c->argv[2] );
2259                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2260                         return( 1 );
2261                 }
2262                 if ( cm->max_entries <= 0 ) {
2263                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "max entries (arg #2) must be positive.\n" );
2264                         Debug( LDAP_DEBUG_CONFIG, "%s: %s\n", c->log, c->cr_msg, 0 );
2265                         return( 1 );
2266                 }
2267
2268                 if ( lutil_atoi( &cm->num_entries_limit, c->argv[4] ) != 0 ) {
2269                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse entry limit=\"%s\" (arg #4)",
2270                                 c->argv[4] );
2271                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2272                         return( 1 );
2273                 }
2274                 if ( cm->num_entries_limit <= 0 ) {
2275                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "entry limit (arg #4) must be positive" );
2276                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2277                         return( 1 );
2278                 }
2279                 if ( cm->num_entries_limit > cm->max_entries ) {
2280                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "entry limit (arg #4) must be less than max entries %d (arg #2)", cm->max_entries );
2281                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2282                         return( 1 );
2283                 }
2284
2285                 if ( lutil_parse_time( c->argv[5], &t ) != 0 ) {
2286                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse period=\"%s\" (arg #5)",
2287                                 c->argv[5] );
2288                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2289                         return( 1 );
2290                 }
2291                 cm->cc_period = (time_t)t;
2292                 Debug( pcache_debug,
2293                                 "Total # of attribute sets to be cached = %d.\n",
2294                                 cm->numattrsets, 0, 0 );
2295                 qm->attr_sets = ( struct attr_set * )ch_calloc( cm->numattrsets,
2296                                                 sizeof( struct attr_set ) );
2297                 break;
2298         case PC_ATTR:
2299                 if ( cm->numattrsets == 0 ) {
2300                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"proxycache\" directive not provided yet" );
2301                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2302                         return( 1 );
2303                 }
2304                 if ( lutil_atoi( &num, c->argv[1] ) != 0 ) {
2305                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse attrset #=\"%s\"",
2306                                 c->argv[1] );
2307                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2308                         return( 1 );
2309                 }
2310
2311                 if ( num < 0 || num >= cm->numattrsets ) {
2312                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "attrset index %d out of bounds (must be %s%d)",
2313                                 num, cm->numattrsets > 1 ? "0->" : "", cm->numattrsets - 1 );
2314                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2315                         return 1;
2316                 }
2317                 qm->attr_sets[num].flags |= PC_CONFIGURED;
2318                 if ( c->argc == 2 ) {
2319                         /* assume "1.1" */
2320                         snprintf( c->cr_msg, sizeof( c->cr_msg ),
2321                                 "need an explicit attr in attrlist; use \"*\" to indicate all attrs" );
2322                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2323                         return 1;
2324
2325                 } else if ( c->argc == 3 ) {
2326                         if ( strcmp( c->argv[2], LDAP_ALL_USER_ATTRIBUTES ) == 0 ) {
2327                                 qm->attr_sets[num].count = 1;
2328                                 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( 2,
2329                                         sizeof( AttributeName ) );
2330                                 BER_BVSTR( &qm->attr_sets[num].attrs[0].an_name, LDAP_ALL_USER_ATTRIBUTES );
2331                                 break;
2332
2333                         } else if ( strcmp( c->argv[2], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 ) {
2334                                 qm->attr_sets[num].count = 1;
2335                                 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( 2,
2336                                         sizeof( AttributeName ) );
2337                                 BER_BVSTR( &qm->attr_sets[num].attrs[0].an_name, LDAP_ALL_OPERATIONAL_ATTRIBUTES );
2338                                 break;
2339
2340                         } else if ( strcmp( c->argv[2], LDAP_NO_ATTRS ) == 0 ) {
2341                                 break;
2342                         }
2343                         /* else: fallthru */
2344
2345                 } else if ( c->argc == 4 ) {
2346                         if ( ( strcmp( c->argv[2], LDAP_ALL_USER_ATTRIBUTES ) == 0 && strcmp( c->argv[3], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 )
2347                                 || ( strcmp( c->argv[2], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 && strcmp( c->argv[3], LDAP_ALL_USER_ATTRIBUTES ) == 0 ) )
2348                         {
2349                                 qm->attr_sets[num].count = 2;
2350                                 qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( 3,
2351                                         sizeof( AttributeName ) );
2352                                 BER_BVSTR( &qm->attr_sets[num].attrs[0].an_name, LDAP_ALL_USER_ATTRIBUTES );
2353                                 BER_BVSTR( &qm->attr_sets[num].attrs[1].an_name, LDAP_ALL_OPERATIONAL_ATTRIBUTES );
2354                                 break;
2355                         }
2356                         /* else: fallthru */
2357                 }
2358
2359                 if ( c->argc > 2 ) {
2360                         int all_user = 0, all_op = 0;
2361
2362                         qm->attr_sets[num].count = c->argc - 2;
2363                         qm->attr_sets[num].attrs = (AttributeName*)ch_calloc( c->argc - 1,
2364                                 sizeof( AttributeName ) );
2365                         attr_name = qm->attr_sets[num].attrs;
2366                         for ( i = 2; i < c->argc; i++ ) {
2367                                 attr_name->an_desc = NULL;
2368                                 if ( strcmp( c->argv[i], LDAP_NO_ATTRS ) == 0 ) {
2369                                         snprintf( c->cr_msg, sizeof( c->cr_msg ),
2370                                                 "invalid attr #%d \"%s\" in attrlist",
2371                                                 i - 2, c->argv[i] );
2372                                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2373                                         ch_free( qm->attr_sets[num].attrs );
2374                                         qm->attr_sets[num].attrs = NULL;
2375                                         qm->attr_sets[num].count = 0;
2376                                         return 1;
2377                                 }
2378                                 if ( strcmp( c->argv[i], LDAP_ALL_USER_ATTRIBUTES ) == 0 ) {
2379                                         all_user = 1;
2380                                         BER_BVSTR( &attr_name->an_name, LDAP_ALL_USER_ATTRIBUTES );
2381                                 } else if ( strcmp( c->argv[i], LDAP_ALL_OPERATIONAL_ATTRIBUTES ) == 0 ) {
2382                                         all_op = 1;
2383                                         BER_BVSTR( &attr_name->an_name, LDAP_ALL_OPERATIONAL_ATTRIBUTES );
2384                                 } else {
2385                                         if ( slap_str2ad( c->argv[i], &attr_name->an_desc, &text ) ) {
2386                                                 strcpy( c->cr_msg, text );
2387                                                 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2388                                                 ch_free( qm->attr_sets[num].attrs );
2389                                                 qm->attr_sets[num].attrs = NULL;
2390                                                 qm->attr_sets[num].count = 0;
2391                                                 return 1;
2392                                         }
2393                                         attr_name->an_name = attr_name->an_desc->ad_cname;
2394                                 }
2395                                 attr_name->an_oc = NULL;
2396                                 attr_name->an_oc_exclude = 0;
2397                                 if ( attr_name->an_desc == slap_schema.si_ad_objectClass )
2398                                         qm->attr_sets[num].flags |= PC_GOT_OC;
2399                                 attr_name++;
2400                                 BER_BVZERO( &attr_name->an_name );
2401                         }
2402
2403                         /* warn if list contains both "*" and "+" */
2404                         if ( i > 4 && all_user && all_op ) {
2405                                 snprintf( c->cr_msg, sizeof( c->cr_msg ),
2406                                         "warning: attribute list contains \"*\" and \"+\"" );
2407                                 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2408                         }
2409                 }
2410                 break;
2411         case PC_TEMP:
2412                 if ( cm->numattrsets == 0 ) {
2413                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "\"proxycache\" directive not provided yet" );
2414                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2415                         return( 1 );
2416                 }
2417                 if ( lutil_atoi( &i, c->argv[2] ) != 0 ) {
2418                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse template #=\"%s\"",
2419                                 c->argv[2] );
2420                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2421                         return( 1 );
2422                 }
2423
2424                 if ( i < 0 || i >= cm->numattrsets ||
2425                         !(qm->attr_sets[i].flags & PC_CONFIGURED )) {
2426                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "template index %d invalid (%s%d)",
2427                                 i, cm->numattrsets > 1 ? "0->" : "", cm->numattrsets - 1 );
2428                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2429                         return 1;
2430                 }
2431                 temp = ch_calloc( 1, sizeof( QueryTemplate ));
2432                 temp->qmnext = qm->templates;
2433                 qm->templates = temp;
2434                 ldap_pvt_thread_rdwr_init( &temp->t_rwlock );
2435                 temp->query = temp->query_last = NULL;
2436                 if ( lutil_parse_time( c->argv[3], &t ) != 0 ) {
2437                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "unable to parse template ttl=\"%s\"",
2438                                 c->argv[3] );
2439                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2440                         return( 1 );
2441                 }
2442                 temp->ttl = (time_t)t;
2443                 if ( c->argc == 5 ) {
2444                         if ( lutil_parse_time( c->argv[4], &t ) != 0 ) {
2445                                 snprintf( c->cr_msg, sizeof( c->cr_msg ),
2446                                         "unable to parse template negttl=\"%s\"",
2447                                         c->argv[4] );
2448                                 Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2449                                         return( 1 );
2450                         }
2451                         temp->negttl = (time_t)t;
2452                 } else {
2453                         temp->negttl = 0;
2454                 }
2455
2456                 temp->no_of_queries = 0;
2457
2458                 ber_str2bv( c->argv[1], 0, 1, &temp->querystr );
2459                 Debug( pcache_debug, "Template:\n", 0, 0, 0 );
2460                 Debug( pcache_debug, "  query template: %s\n",
2461                                 temp->querystr.bv_val, 0, 0 );
2462                 temp->attr_set_index = i;
2463                 qm->attr_sets[i].flags |= PC_REFERENCED;
2464                 temp->qtnext = qm->attr_sets[i].templates;
2465                 qm->attr_sets[i].templates = temp;
2466                 Debug( pcache_debug, "  attributes: \n", 0, 0, 0 );
2467                 if ( ( attrarray = qm->attr_sets[i].attrs ) != NULL ) {
2468                         for ( i=0; attrarray[i].an_name.bv_val; i++ )
2469                                 Debug( pcache_debug, "\t%s\n",
2470                                         attrarray[i].an_name.bv_val, 0, 0 );
2471                 }
2472                 break;
2473         case PC_RESP:
2474                 if ( strcasecmp( c->argv[1], "head" ) == 0 ) {
2475                         cm->response_cb = PCACHE_RESPONSE_CB_HEAD;
2476
2477                 } else if ( strcasecmp( c->argv[1], "tail" ) == 0 ) {
2478                         cm->response_cb = PCACHE_RESPONSE_CB_TAIL;
2479
2480                 } else {
2481                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "unknown specifier" );
2482                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2483                         return 1;
2484                 }
2485                 break;
2486         case PC_QUERIES:
2487                 if ( c->value_int <= 0 ) {
2488                         snprintf( c->cr_msg, sizeof( c->cr_msg ), "max queries must be positive" );
2489                         Debug( LDAP_DEBUG_CONFIG, "%s: %s.\n", c->log, c->cr_msg, 0 );
2490                         return( 1 );
2491                 }
2492                 cm->max_queries = c->value_int;
2493                 break;
2494         }
2495         return rc;
2496 }
2497
2498 static int
2499 pcache_db_config(
2500         BackendDB       *be,
2501         const char      *fname,
2502         int             lineno,
2503         int             argc,
2504         char            **argv
2505 )
2506 {
2507         slap_overinst   *on = (slap_overinst *)be->bd_info;
2508         cache_manager*  cm = on->on_bi.bi_private;
2509
2510         /* Something for the cache database? */
2511         if ( cm->db.bd_info && cm->db.bd_info->bi_db_config )
2512                 return cm->db.bd_info->bi_db_config( &cm->db, fname, lineno,
2513                         argc, argv );
2514         return SLAP_CONF_UNKNOWN;
2515 }
2516
2517 static int
2518 pcache_db_init(
2519         BackendDB *be,
2520         ConfigReply *cr)
2521 {
2522         slap_overinst *on = (slap_overinst *)be->bd_info;
2523         cache_manager *cm;
2524         query_manager *qm;
2525
2526         cm = (cache_manager *)ch_malloc(sizeof(cache_manager));
2527         on->on_bi.bi_private = cm;
2528
2529         qm = (query_manager*)ch_malloc(sizeof(query_manager));
2530
2531         cm->db = *be;
2532         SLAP_DBFLAGS(&cm->db) |= SLAP_DBFLAG_NO_SCHEMA_CHECK;
2533         cm->db.be_private = NULL;
2534         cm->db.be_pcl_mutexp = &cm->db.be_pcl_mutex;
2535         cm->qm = qm;
2536         cm->numattrsets = 0;
2537         cm->num_entries_limit = 5;
2538         cm->num_cached_queries = 0;
2539         cm->max_entries = 0;
2540         cm->cur_entries = 0;
2541         cm->max_queries = 10000;
2542         cm->save_queries = 0;
2543         cm->response_cb = PCACHE_RESPONSE_CB_TAIL;
2544         cm->cc_period = 1000;
2545         cm->cc_paused = 0;
2546
2547         qm->attr_sets = NULL;
2548         qm->templates = NULL;
2549         qm->lru_top = NULL;
2550         qm->lru_bottom = NULL;
2551
2552         qm->qcfunc = query_containment;
2553         qm->crfunc = cache_replacement;
2554         qm->addfunc = add_query;
2555         ldap_pvt_thread_mutex_init(&qm->lru_mutex);
2556
2557         ldap_pvt_thread_mutex_init(&cm->cache_mutex);
2558         return 0;
2559 }
2560
2561 static int
2562 pcache_cachedquery_open_cb( Operation *op, SlapReply *rs )
2563 {
2564         assert( op->o_tag == LDAP_REQ_SEARCH );
2565
2566         if ( rs->sr_type == REP_SEARCH ) {
2567                 Attribute       *a;
2568
2569                 a = attr_find( rs->sr_entry->e_attrs, ad_cachedQueryURL );
2570                 if ( a != NULL ) {
2571                         BerVarray       *valsp;
2572
2573                         assert( a->a_nvals != NULL );
2574
2575                         valsp = op->o_callback->sc_private;
2576                         assert( *valsp == NULL );
2577
2578                         ber_bvarray_dup_x( valsp, a->a_nvals, op->o_tmpmemctx );
2579                 }
2580         }
2581
2582         return 0;
2583 }
2584
2585 static int
2586 pcache_db_open(
2587         BackendDB *be,
2588         ConfigReply *cr )
2589 {
2590         slap_overinst   *on = (slap_overinst *)be->bd_info;
2591         cache_manager   *cm = on->on_bi.bi_private;
2592         query_manager*  qm = cm->qm;
2593         int             i, ncf = 0, rf = 0, nrf = 0, rc = 0;
2594
2595         /* check attr sets */
2596         for ( i = 0; i < cm->numattrsets; i++) {
2597                 if ( !( qm->attr_sets[i].flags & PC_CONFIGURED ) ) {
2598                         if ( qm->attr_sets[i].flags & PC_REFERENCED ) {
2599                                 Debug( LDAP_DEBUG_CONFIG, "pcache: attr set #%d not configured but referenced.\n", i, 0, 0 );
2600                                 rf++;
2601
2602                         } else {
2603                                 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, attr set #%d not configured.\n", i, 0, 0 );
2604                         }
2605                         ncf++;
2606
2607                 } else if ( !( qm->attr_sets[i].flags & PC_REFERENCED ) ) {
2608                         Debug( LDAP_DEBUG_CONFIG, "pcache: attr set #%d configured but not referenced.\n", i, 0, 0 );
2609                         nrf++;
2610                 }
2611         }
2612
2613         if ( ncf || rf || nrf ) {
2614                 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, %d attr sets configured but not referenced.\n", nrf, 0, 0 );
2615                 Debug( LDAP_DEBUG_CONFIG, "pcache: warning, %d attr sets not configured.\n", ncf, 0, 0 );
2616                 Debug( LDAP_DEBUG_CONFIG, "pcache: %d attr sets not configured but referenced.\n", rf, 0, 0 );
2617
2618                 if ( rf > 0 ) {
2619                         return 1;
2620                 }
2621         }
2622
2623         /* need to inherit something from the original database... */
2624         cm->db.be_def_limit = be->be_def_limit;
2625         cm->db.be_limits = be->be_limits;
2626         cm->db.be_acl = be->be_acl;
2627         cm->db.be_dfltaccess = be->be_dfltaccess;
2628
2629         if ( SLAP_DBMONITORING( be ) ) {
2630                 SLAP_DBFLAGS( &cm->db ) |= SLAP_DBFLAG_MONITORING;
2631
2632         } else {
2633                 SLAP_DBFLAGS( &cm->db ) &= ~SLAP_DBFLAG_MONITORING;
2634         }
2635
2636         rc = backend_startup_one( &cm->db, NULL );
2637
2638         /* There is no runqueue in TOOL mode */
2639         if ( slapMode & SLAP_SERVER_MODE ) {
2640                 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
2641                 ldap_pvt_runqueue_insert( &slapd_rq, cm->cc_period,
2642                         consistency_check, on,
2643                         "pcache_consistency", be->be_suffix[0].bv_val );
2644                 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
2645
2646                 /* Cached database must have the rootdn */
2647                 if ( BER_BVISNULL( &cm->db.be_rootndn )
2648                                 || BER_BVISEMPTY( &cm->db.be_rootndn ) )
2649                 {
2650                         Debug( LDAP_DEBUG_ANY, "pcache_db_open(): "
2651                                 "underlying database of type \"%s\"\n"
2652                                 "    serving naming context \"%s\"\n"
2653                                 "    has no \"rootdn\", required by \"proxycache\".\n",
2654                                 on->on_info->oi_orig->bi_type,
2655                                 cm->db.be_suffix[0].bv_val, 0 );
2656                         return 1;
2657                 }
2658
2659                 if ( cm->save_queries ) {
2660                         void            *thrctx = ldap_pvt_thread_pool_context();
2661                         Connection      conn = { 0 };
2662                         OperationBuffer opbuf;
2663                         Operation       *op;
2664                         slap_callback   cb = { 0 };
2665                         SlapReply       rs = { 0 };
2666                         BerVarray       vals = NULL;
2667                         AttributeName   attrs[ 2 ] = { 0 };
2668
2669                         connection_fake_init( &conn, &opbuf, thrctx );
2670                         op = &opbuf.ob_op;
2671
2672                         op->o_bd = &cm->db;
2673
2674                         op->o_tag = LDAP_REQ_SEARCH;
2675                         op->o_protocol = LDAP_VERSION3;
2676                         cb.sc_response = pcache_cachedquery_open_cb;
2677                         cb.sc_private = &vals;
2678                         op->o_callback = &cb;
2679                         op->o_time = slap_get_time();
2680                         op->o_do_not_cache = 1;
2681                         op->o_managedsait = SLAP_CONTROL_CRITICAL;
2682
2683                         op->o_dn = cm->db.be_rootdn;
2684                         op->o_ndn = cm->db.be_rootndn;
2685                         op->o_req_dn = cm->db.be_suffix[ 0 ];
2686                         op->o_req_ndn = cm->db.be_nsuffix[ 0 ];
2687
2688                         op->ors_scope = LDAP_SCOPE_BASE;
2689                         op->ors_deref = LDAP_DEREF_NEVER;
2690                         op->ors_slimit = 1;
2691                         op->ors_tlimit = SLAP_NO_LIMIT;
2692                         ber_str2bv( "(cachedQueryURL=*)", 0, 0, &op->ors_filterstr );
2693                         op->ors_filter = str2filter_x( op, op->ors_filterstr.bv_val );
2694                         if ( op->ors_filter != NULL ) {
2695                                 attrs[ 0 ].an_desc = ad_cachedQueryURL;
2696                                 attrs[ 0 ].an_name = ad_cachedQueryURL->ad_cname;
2697                                 op->ors_attrs = attrs;
2698                                 op->ors_attrsonly = 0;
2699
2700                                 rc = op->o_bd->be_search( op, &rs );
2701                                 if ( rc == LDAP_SUCCESS && vals != NULL ) {
2702                                         int     i;
2703
2704                                         for ( i = 0; !BER_BVISNULL( &vals[ i ] ); i++ ) {
2705                                                 if ( url2query( vals[ i ].bv_val, op, qm ) == 0 ) {
2706                                                         cm->num_cached_queries++;
2707                                                 }
2708                                         }
2709
2710                                         ber_bvarray_free_x( vals, op->o_tmpmemctx );
2711                                 }
2712
2713                                 filter_free_x( op, op->ors_filter );
2714                         }
2715
2716                         /* ignore errors */
2717                         rc = 0;
2718                 }
2719         }
2720
2721         return rc;
2722 }
2723
2724 static void
2725 pcache_free_qbase( void *v )
2726 {
2727         Qbase *qb = v;
2728         int i;
2729
2730         for (i=0; i<3; i++)
2731                 tavl_free( qb->scopes[i], NULL );
2732         ch_free( qb );
2733 }
2734
2735 static int
2736 pcache_db_close(
2737         BackendDB *be,
2738         ConfigReply *cr
2739 )
2740 {
2741         slap_overinst *on = (slap_overinst *)be->bd_info;
2742         cache_manager *cm = on->on_bi.bi_private;
2743         query_manager *qm = cm->qm;
2744         QueryTemplate *tm;
2745         int i, rc = 0;
2746
2747         if ( cm->save_queries && qm->templates != NULL ) {
2748                 CachedQuery     *qc;
2749                 BerVarray       vals = NULL;
2750
2751                 for ( tm = qm->templates; tm != NULL; tm = tm->qmnext ) {
2752                         for ( qc = tm->query; qc; qc = qc->next ) {
2753                                 struct berval   bv;
2754
2755                                 if ( query2url( qc, &bv ) == 0 ) {
2756                                         ber_bvarray_add( &vals, &bv );
2757                                 }
2758                         }
2759                 }
2760
2761                 if ( vals != NULL ) {
2762                         void            *thrctx = ldap_pvt_thread_pool_context();
2763                         Connection      conn = { 0 };
2764                         OperationBuffer opbuf;
2765                         Operation       *op;
2766                         slap_callback   cb = { 0 };
2767
2768                         SlapReply       rs = { REP_RESULT };
2769                         Modifications   mod = { 0 };
2770
2771                         connection_fake_init( &conn, &opbuf, thrctx );
2772                         op = &opbuf.ob_op;
2773
2774                         op->o_bd = &cm->db;
2775                         op->o_dn = cm->db.be_rootdn;
2776                         op->o_ndn = cm->db.be_rootndn;
2777
2778                         op->o_tag = LDAP_REQ_MODIFY;
2779                         op->o_protocol = LDAP_VERSION3;
2780                         cb.sc_response = slap_null_cb;
2781                         op->o_callback = &cb;
2782                         op->o_time = slap_get_time();
2783                         op->o_do_not_cache = 1;
2784                         op->o_managedsait = SLAP_CONTROL_CRITICAL;
2785
2786                         op->o_req_dn = op->o_bd->be_suffix[0];
2787                         op->o_req_ndn = op->o_bd->be_nsuffix[0];
2788
2789                         mod.sml_op = LDAP_MOD_REPLACE;
2790                         mod.sml_flags = 0;
2791                         mod.sml_desc = ad_cachedQueryURL;
2792                         mod.sml_type = ad_cachedQueryURL->ad_cname;
2793                         mod.sml_values = vals;
2794                         mod.sml_nvalues = NULL;
2795                         mod.sml_next = NULL;
2796                         Debug( pcache_debug,
2797                                 "SETTING CACHED QUERY URLS\n",
2798                                 0, 0, 0 );
2799
2800                         op->orm_modlist = &mod;
2801
2802                         op->o_bd->be_modify( op, &rs );
2803
2804                         ber_bvarray_free( vals );
2805                 }
2806         }
2807
2808         /* cleanup stuff inherited from the original database... */
2809         cm->db.be_limits = NULL;
2810         cm->db.be_acl = NULL;
2811
2812         /* stop the thread ... */
2813         if ( cm->cc_arg ) {
2814                 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
2815                 if ( ldap_pvt_runqueue_isrunning( &slapd_rq, cm->cc_arg ) ) {
2816                         ldap_pvt_runqueue_stoptask( &slapd_rq, cm->cc_arg );
2817                 }
2818                 ldap_pvt_runqueue_remove( &slapd_rq, cm->cc_arg );
2819                 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
2820         }
2821
2822         if ( cm->db.bd_info->bi_db_close ) {
2823                 rc = cm->db.bd_info->bi_db_close( &cm->db, NULL );
2824         }
2825         while ( (tm = qm->templates) != NULL ) {
2826                 CachedQuery *qc, *qn;
2827                 qm->templates = tm->qmnext;
2828                 for ( qc = tm->query; qc; qc = qn ) {
2829                         qn = qc->next;
2830                         free_query( qc );
2831                 }
2832                 avl_free( tm->qbase, pcache_free_qbase );
2833                 free( tm->querystr.bv_val );
2834                 ldap_pvt_thread_rdwr_destroy( &tm->t_rwlock );
2835                 free( tm->t_attrs.attrs );
2836                 free( tm );
2837         }
2838
2839         for ( i=0; i<cm->numattrsets; i++ ) {
2840                 free( qm->attr_sets[i].attrs );
2841         }
2842         free( qm->attr_sets );
2843         qm->attr_sets = NULL;
2844
2845         return rc;
2846 }
2847
2848 static int
2849 pcache_db_destroy(
2850         BackendDB *be,
2851         ConfigReply *cr
2852 )
2853 {
2854         slap_overinst *on = (slap_overinst *)be->bd_info;
2855         cache_manager *cm = on->on_bi.bi_private;
2856         query_manager *qm = cm->qm;
2857
2858         if ( cm->db.be_private != NULL ) {
2859                 backend_stopdown_one( &cm->db );
2860         }
2861
2862         ldap_pvt_thread_mutex_destroy( &qm->lru_mutex );
2863         ldap_pvt_thread_mutex_destroy( &cm->cache_mutex );
2864         free( qm );
2865         free( cm );
2866
2867         return 0;
2868 }
2869
2870 static slap_overinst pcache;
2871
2872 static char *obsolete_names[] = {
2873         "proxycache",
2874         NULL
2875 };
2876
2877 int pcache_initialize()
2878 {
2879         int i, code;
2880         struct berval debugbv = BER_BVC("pcache");
2881
2882         code = slap_loglevel_get( &debugbv, &pcache_debug );
2883         if ( code ) {
2884                 return code;
2885         }
2886
2887         for ( i = 0; as[i].desc != NULL; i++ ) {
2888                 code = register_at( as[i].desc, as[i].adp, 0 );
2889                 if ( code ) {
2890                         Debug( LDAP_DEBUG_ANY,
2891                                 "pcache_initialize: register_at #%d failed\n", i, 0, 0 );
2892                         return code;
2893                 }
2894         }
2895
2896         pcache.on_bi.bi_type = "pcache";
2897         pcache.on_bi.bi_obsolete_names = obsolete_names;
2898         pcache.on_bi.bi_db_init = pcache_db_init;
2899         pcache.on_bi.bi_db_config = pcache_db_config;
2900         pcache.on_bi.bi_db_open = pcache_db_open;
2901         pcache.on_bi.bi_db_close = pcache_db_close;
2902         pcache.on_bi.bi_db_destroy = pcache_db_destroy;
2903
2904         pcache.on_bi.bi_op_search = pcache_op_search;
2905
2906         pcache.on_bi.bi_chk_controls = pcache_chk_controls;
2907
2908         pcache.on_bi.bi_cf_ocs = pcocs;
2909
2910         code = config_register_schema( pccfg, pcocs );
2911         if ( code ) return code;
2912
2913         return overlay_register( &pcache );
2914 }
2915
2916 #if SLAPD_OVER_PROXYCACHE == SLAPD_MOD_DYNAMIC
2917 int init_module(int argc, char *argv[]) {
2918         return pcache_initialize();
2919 }
2920 #endif
2921
2922 #endif  /* defined(SLAPD_OVER_PROXYCACHE) */