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